1.1.19 • Published 6 months ago

kitres v1.1.19

Weekly downloads
-
License
ISC
Repository
github
Last release
6 months ago

README do Projeto

Este repositório contém exemplos de código para vários módulos e componentes de um projeto. O projeto inclui funcionalidades relacionadas à manipulação de conexões de banco de dados, recursos, revisões e catálogos.

Estrutura do Projeto

O projeto consiste nos seguintes arquivos e módulos principais:

core.ts

O arquivo core.ts define as configurações de conexão com o banco de dados PostgreSQL e exporta uma instância configurada da classe PgCore.

// Importar os módulos necessários
import { Client, ClientConfig, Pool } from "pg";
import { PgCore } from "kitres";

// Opções de conexão com o PostgreSQL
let opts: ClientConfig = {
    host: "127.0.0.1",
    port: 5432,
    user: "postgres",
    database: "postgres",
    password: "1234"
};

// Exportar a instância configurada do PgCore
export const pgCore: PgCore = new PgCore(  () => new Pool( opts ));

resource.ts

O arquivo resource.ts define uma instância de Resource e configura um recurso usando a configuração pgCore.

// Importar os módulos necessários
import { Resource } from "kitres/src/core/resource";
import { pgCore } from "./core";
import { DataDoc } from "./var/catalog";
import { cataloger } from "./cataloger";

// Criar e configurar uma instância de Resource
export const resource: Resource<DataDoc> = new Resource<DataDoc>(pgCore, {
    catalogReload: false
});

// Usar o catalogador com o recurso
resource.use(cataloger);

revision.ts

O arquivo revision.ts define uma instância de RevisionCore e realiza operações relacionadas a revisões.

// Importar os módulos necessários
import { pgCore } from "./core";
import { RevisionCore, AppVersion } from "kitres";
import Path from "path";

//Iniciar o gerenciador de versão
export const VERSION = new AppVersion({
    readonly: false,
    project: Path.join(__dirname,  "/path/of/root/project" )
})

// Criar e configurar uma instância de RevisionCore
export const revControl = new RevisionCore(pgCore, {
    dirname: Path.join(__dirname, "./var/revision/patches/"),
    schema: "kitres_core",
    VERSION: VERSION
});

// Registrar eventos de revisão
revControl.on("log", (level, message) => {
    console.log(level, message);
});

// Coletar e configurar revisões
revControl.collect();
revControl.setup((error, block) => {
    if (error) console.log(error);
    console.log("Aplicação da revisão bem-sucedida!");
});

catalog.ts

O arquivo catalog.ts define uma instância de Cataloger e lida com a geração de catálogo após revisões.

// Importar os módulos necessários
import { pgCore } from "./core";
import * as Path from "path";
import { revControl } from "./revision";
import { Cataloger } from "kitres";
import { DataDoc } from "./var/catalog";

// Criar e configurar uma instância de Cataloger
export const cataloger: Cataloger<DataDoc> = new Cataloger(pgCore, {
    caseMethodType: "pascalCase",
    className: "DataDoc",
    location: Path.join(__dirname, "./var/catalog/_index"),
    schemas: ["public", "schema1"],
    object:[ "EntryOf", "TableOf", "ViewOf", "ReferenceOf", "RelationOf" ],
});

// Gerar catálogo após revisão
revControl.on("revision", error => {
    if (error) return;
    cataloger.generateCatalog(error1 => {
        if (error1) console.log(error1);
        console.log("Documento gerado com sucesso");
    });
});

res/functions.resolve.ts

O arquivo res/functions.resolve.ts demonstra o uso de funções de recurso após uma revisão.

// Importar os módulos necessários
import { revControl } from "../revision";
import { resource } from "../resource";
import { Result } from "kitres";

// Executar função de recurso após revisão
revControl.once("revision", (error, blocks) => {
    if (error) return;
    resource.call.public.my_function({
        param1: {}, //param value
        param2: "para-valoues",
        param3: SQL.jsonb( [] ), //Param value
        param4: SQL.varchar( null ) //Param value
    }, {
        onResult(error: Error, result?: Result<any, any>): any {
            if (error) return console.error(error);
            console.log(result.rows);
        }
    }).body();
});

res/table.ts

O arquivo res/table.ts demonstra consultas em tabelas e visualizações usando recursos e SQL após uma revisão.

// Importar os módulos necessários
import { pgCore } from "../core";
import { DataDoc, TableOf } from "../var/catalog";
import { revControl } from "../revision";
import { resource } from "../resource";
import { Result, sql, TableDoc, ViewDoc } from "kitres";

// Realizar consultas em tabelas e visualizações após revisão
revControl.once("revision", (error, blocks) => {
    if (error) return;

    // Consultar tabelas usando recurso
    resource.with.public.my_table.select({}, {
        onResult(error: Error, result?: Result<TableDoc<DataDoc, "public", "my_table">, any>) {
            if (error) return;
            result?.rows.forEach(value => {
                console.log(JSON.stringify(value));
            });
        }
    });

    // Consultar tabelas usando SQL
    pgCore.query<TableOf<"kitres_core", "script"> & TableOf<"kitres_core", "patch">, any>(sql`
        select * 
        from kitres_core.script s
        inner join kitres_core.patch p on s.script_patch_id = p.patch_id
    `, {
        onResult(error: Error, result?: Result<TableOf<"kitres_core", "script"> & TableOf<"kitres_core", "patch">, any>) {
            result.rows.forEach(value => {
                delete value["script_sql"];
                console.log(JSON.stringify(value));
            });
        }
    });

    // Consultar visualização usando recurso
    resource.with.kitres_core.vscript.select("patch_id", "script_sql")({}, {
        onResult(error: Error, result?: Result<ViewDoc<DataDoc, "kitres_core", "vscript">, any>): any {
            console.log(result?.rows);
        }
    });
});

Conclusão

Este README fornece uma visão geral dos principais módulos e componentes no projeto, destacando suas funcionalidades e interações. Consulte o código-fonte para obter detalhes mais detalhados sobre a implementação.

Para mais informações, perguntas ou contribuições, sinta-se à vontade para entrar em contato com os mantenedores do projeto.

1.1.15-1

7 months ago

1.1.9

7 months ago

1.1.8

7 months ago

1.1.7

7 months ago

1.1.6

7 months ago

1.1.5

7 months ago

1.1.4

9 months ago

1.1.3

9 months ago

1.1.2

9 months ago

1.1.12

7 months ago

1.1.11

7 months ago

1.1.10

7 months ago

1.1.16

6 months ago

1.1.15

7 months ago

1.1.13

7 months ago

1.1.19

6 months ago

1.1.18

6 months ago

1.1.17

6 months ago

1.1.5-1

7 months ago

1.0.134

10 months ago

1.0.136

10 months ago

1.0.135

10 months ago

1.0.137

10 months ago

1.1.1

10 months ago

1.1.0

10 months ago

1.0.101

1 year ago

1.0.100

1 year ago

1.0.106

1 year ago

1.0.103

1 year ago

1.0.102

1 year ago

1.0.105

1 year ago

1.0.104

1 year ago

1.0.132

11 months ago

1.0.131

11 months ago

1.0.133

11 months ago

1.0.130

11 months ago

1.0.121

11 months ago

1.0.120

11 months ago

1.0.123

11 months ago

1.0.122

11 months ago

1.0.129

11 months ago

1.0.128

11 months ago

1.0.125

11 months ago

1.0.124

11 months ago

1.0.127

11 months ago

1.0.126

11 months ago

1.0.110

1 year ago

1.0.112

1 year ago

1.0.111

1 year ago

1.0.118

11 months ago

1.0.117

11 months ago

1.0.119

11 months ago

1.0.114

12 months ago

1.0.113

1 year ago

1.0.116

12 months ago

1.0.95

1 year ago

1.0.94

1 year ago

1.0.99

1 year ago

1.0.98

1 year ago

1.0.97

1 year ago

1.0.96

1 year ago

1.0.80

1 year ago

1.0.84

1 year ago

1.0.83

1 year ago

1.0.82

1 year ago

1.0.81

1 year ago

1.0.88

1 year ago

1.0.87

1 year ago

1.0.86

1 year ago

1.0.85

1 year ago

1.0.89

1 year ago

1.0.91

1 year ago

1.0.90

1 year ago

1.0.92

1 year ago

1.0.77

1 year ago

1.0.79

1 year ago

1.0.20

1 year ago

1.0.16

1 year ago

1.0.10

2 years ago

1.0.9

2 years ago

1.0.8

2 years ago

1.0.3

2 years ago

1.0.2

2 years ago

1.0.1

2 years ago

1.0.0-3

2 years ago

1.0.0-2

2 years ago

1.0.0-1

2 years ago

1.0.0

2 years ago