@restura/core 1.9.2 → 2.0.0

package/dist/index.d.ts

@@ -1,44 +1,22 @@
-import { TransportTargetOptions, SerializerFn, DestinationStream } from 'pino';
-import { z } from 'zod';
 import { UUID } from 'crypto';
 import * as express from 'express';
 import { IncomingHttpHeaders } from 'http2';
+import { z } from 'zod';
 import { QueryResultRow, QueryConfigValues, QueryResult, PoolConfig, Pool, ClientConfig, Client } from 'pg';
 import peg from 'pegjs';
 
-type LogFunction = {
-    (msg: string, ...args: unknown[]): void;
-    (msg: unknown): void;
-};
-declare const logger: {
-    level: "fatal" | "error" | "warn" | "info" | "debug" | "silly" | "trace";
-    fatal: LogFunction;
-    error: LogFunction;
-    warn: LogFunction;
-    info: LogFunction;
-    debug: LogFunction;
-    silly: LogFunction;
-    trace: LogFunction;
-};
-
-type ErrorSerializerFactory = (baseSerializer: SerializerFn) => SerializerFn;
-declare const loggerConfigSchema: z.ZodObject<{
-    level: z.ZodDefault<z.ZodEnum<{
-        fatal: "fatal";
-        error: "error";
-        warn: "warn";
-        info: "info";
-        debug: "debug";
-        silly: "silly";
-        trace: "trace";
-    }>>;
-    transports: z.ZodOptional<z.ZodArray<z.ZodCustom<TransportTargetOptions<Record<string, any>>, TransportTargetOptions<Record<string, any>>>>>;
-    serializers: z.ZodOptional<z.ZodObject<{
-        err: z.ZodOptional<z.ZodCustom<ErrorSerializerFactory, ErrorSerializerFactory>>;
-    }, z.core.$strip>>;
-    stream: z.ZodOptional<z.ZodCustom<DestinationStream, DestinationStream>>;
-}, z.core.$strip>;
-type LoggerConfigSchema = z.infer<typeof loggerConfigSchema>;
+type LogLevel = 'fatal' | 'error' | 'warn' | 'info' | 'debug' | 'trace';
+interface ResturaLogger {
+    readonly level: LogLevel;
+    fatal(msg: unknown, ...args: unknown[]): void;
+    error(msg: unknown, ...args: unknown[]): void;
+    warn(msg: unknown, ...args: unknown[]): void;
+    info(msg: unknown, ...args: unknown[]): void;
+    debug(msg: unknown, ...args: unknown[]): void;
+    trace(msg: unknown, ...args: unknown[]): void;
+}
+declare const logger: ResturaLogger;
+declare function setLogger(impl: ResturaLogger): void;
 
 /**
  * @deprecated This is used for passing around until we finally get to the sending externally
@@ -394,6 +372,73 @@ declare const customRouteSchema: z.ZodObject<{
 }, z.core.$strict>;
 type CustomRouteData = z.infer<typeof customRouteSchema>;
 type RouteData = CustomRouteData | StandardRouteData;
+declare const columnDataSchema: z.ZodObject<{
+    name: z.ZodString;
+    type: z.ZodUnion<readonly [z.ZodEnum<{
+        SMALLINT: "SMALLINT";
+        INTEGER: "INTEGER";
+        BIGINT: "BIGINT";
+        DECIMAL: "DECIMAL";
+        NUMERIC: "NUMERIC";
+        REAL: "REAL";
+        "DOUBLE PRECISION": "DOUBLE PRECISION";
+        SERIAL: "SERIAL";
+        BIGSERIAL: "BIGSERIAL";
+    }>, z.ZodEnum<{
+        CHAR: "CHAR";
+        VARCHAR: "VARCHAR";
+        TEXT: "TEXT";
+        BYTEA: "BYTEA";
+    }>, z.ZodEnum<{
+        DATE: "DATE";
+        TIMESTAMP: "TIMESTAMP";
+        TIMESTAMPTZ: "TIMESTAMPTZ";
+        TIME: "TIME";
+        INTERVAL: "INTERVAL";
+    }>, z.ZodEnum<{
+        JSON: "JSON";
+        JSONB: "JSONB";
+    }>, z.ZodEnum<{
+        SMALLINT: "SMALLINT";
+        INTEGER: "INTEGER";
+        BIGINT: "BIGINT";
+        DECIMAL: "DECIMAL";
+        BOOLEAN: "BOOLEAN";
+        TINYINT: "TINYINT";
+        MEDIUMINT: "MEDIUMINT";
+        FLOAT: "FLOAT";
+        DOUBLE: "DOUBLE";
+    }>, z.ZodEnum<{
+        CHAR: "CHAR";
+        VARCHAR: "VARCHAR";
+        TEXT: "TEXT";
+        JSON: "JSON";
+        TINYTEXT: "TINYTEXT";
+        TINYBLOB: "TINYBLOB";
+        BLOB: "BLOB";
+        MEDIUMTEXT: "MEDIUMTEXT";
+        MEDIUMBLOB: "MEDIUMBLOB";
+        LONGTEXT: "LONGTEXT";
+        LONGBLOB: "LONGBLOB";
+        ENUM: "ENUM";
+    }>, z.ZodEnum<{
+        DATE: "DATE";
+        TIMESTAMP: "TIMESTAMP";
+        TIME: "TIME";
+        DATETIME: "DATETIME";
+    }>]>;
+    isNullable: z.ZodBoolean;
+    roles: z.ZodArray<z.ZodString>;
+    scopes: z.ZodArray<z.ZodString>;
+    comment: z.ZodOptional<z.ZodString>;
+    default: z.ZodOptional<z.ZodString>;
+    value: z.ZodOptional<z.ZodString>;
+    isPrimary: z.ZodOptional<z.ZodBoolean>;
+    isUnique: z.ZodOptional<z.ZodBoolean>;
+    hasAutoIncrement: z.ZodOptional<z.ZodBoolean>;
+    length: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>;
+type ColumnData = z.infer<typeof columnDataSchema>;
 declare const tableDataSchema: z.ZodObject<{
     name: z.ZodString;
     columns: z.ZodArray<z.ZodObject<{
@@ -1016,7 +1061,9 @@ declare class ResturaEngine {
      * @param app - The Express application instance to initialize with Restura.
      * @returns A promise that resolves when the initialization is complete.
      */
-    init(app: express.Express, authenticationHandler: AuthenticateHandler, psqlConnectionPool: PsqlPool): Promise<void>;
+    init(app: express.Express, authenticationHandler: AuthenticateHandler, psqlConnectionPool: PsqlPool, options?: {
+        logger?: ResturaLogger;
+    }): Promise<void>;
     /**
      * Determines if a given endpoint is public based on the HTTP method and full URL. This
      * is determined on whether the endpoint in the schema has no roles or scopes assigned to it.
@@ -1140,7 +1187,6 @@ declare class PsqlEngine extends SqlEngine {
     private handleTrigger;
     createDatabaseFromSchema(schema: ResturaSchema, connection: PsqlPool): Promise<string>;
     generateDatabaseSchemaFromSchema(schema: ResturaSchema): string;
-    private getNewPublicSchemaAndScratchPool;
     diffDatabaseToSchema(schema: ResturaSchema): Promise<string>;
     protected createNestedSelect(req: RsRequest<unknown>, schema: ResturaSchema, item: ResponseData, routeData: StandardRouteData, sqlParams: string[]): string;
     protected executeCreateRequest(req: RsRequest<unknown>, routeData: StandardRouteData, schema: ResturaSchema): Promise<DynamicObject>;
@@ -1161,12 +1207,62 @@ declare class PsqlEngine extends SqlEngine {
     protected generateGroupBy(routeData: StandardRouteData): string;
     protected generateOrderBy(req: RsRequest<unknown>, routeData: StandardRouteData): string;
     protected generateWhereClause(req: RsRequest<unknown>, where: WhereData[], routeData: StandardRouteData | CustomRouteData, sqlParams: string[]): string;
-    private createUpdateTrigger;
-    private createDeleteTrigger;
-    private createInsertTriggers;
-    private schemaToPsqlType;
 }
 
+interface DbColumn {
+    name: string;
+    udtName: string;
+    isNullable: boolean;
+    columnDefault: string | null;
+    characterMaximumLength: number | null;
+    numericPrecision: number | null;
+    numericScale: number | null;
+}
+interface DbIndex {
+    name: string;
+    tableName: string;
+    isUnique: boolean;
+    isPrimary: boolean;
+    columns: string[];
+    order: 'ASC' | 'DESC';
+    where: string | null;
+}
+interface DbForeignKey {
+    name: string;
+    tableName: string;
+    column: string;
+    refTable: string;
+    refColumn: string;
+    onDelete: string;
+    onUpdate: string;
+}
+interface DbCheckConstraint {
+    name: string;
+    tableName: string;
+    expression: string;
+}
+interface DbTable {
+    name: string;
+    columns: DbColumn[];
+    indexes: DbIndex[];
+    foreignKeys: DbForeignKey[];
+    checkConstraints: DbCheckConstraint[];
+}
+interface DbSnapshot {
+    tables: DbTable[];
+}
+declare function introspectDatabase(pool: PsqlPool): Promise<DbSnapshot>;
+declare function diffSchemaToDatabase(schema: ResturaSchema, snapshot: DbSnapshot): string[];
+
+declare const systemUser: RequesterDetails;
+declare function schemaToPsqlType(column: ColumnData): string;
+declare function createInsertTriggerSql(tableName: string, notify: ResturaSchema['database'][0]['notify']): string;
+declare function createUpdateTriggerSql(tableName: string, notify: ResturaSchema['database'][0]['notify']): string;
+declare function createDeleteTriggerSql(tableName: string, notify: ResturaSchema['database'][0]['notify']): string;
+declare function generateDatabaseSchemaFromSchema(schema: ResturaSchema): string;
+declare function getNewPublicSchemaAndScratchPool(targetPool: PsqlPool, scratchDbName: string): Promise<PsqlPool>;
+declare function diffDatabaseToSchema(schema: ResturaSchema, targetPool: PsqlPool, scratchDbName: string): Promise<string>;
+
 declare class PsqlTransaction extends PsqlConnection {
     clientConfig: ClientConfig;
     client: Client;
@@ -1244,4 +1340,4 @@ declare function SQL(strings: TemplateStringsArray, ...values: unknown[]): strin
  */
 declare function toSqlLiteral(value: unknown): string;
 
-export { type ActionColumnChangeData, type ActionColumnChangeFilter, type ActionRowDeleteData, type ActionRowDeleteFilter, type ActionRowInsertData, type ActionRowInsertFilter, type ApiMethod, type AsyncExpressApplication, type AuthenticateHandler, type AuthenticatedRequesterDetails, type ConjunctionTypes, type DatabaseActionData, type DynamicObject, type ErrorCode, type EventType, HtmlStatusCodes, type LoggerConfigSchema, type MatchTypes, type MutationType, type OnValidAuthenticationCallback, type PageQuery, PsqlConnection, PsqlEngine, PsqlPool, PsqlTransaction, type QueryMetadata, type RequesterDetails, type ResturaConfigSchema, type ResturaSchema, RsError, type RsErrorData, type RsErrorInternalData, type RsHeaders, type RsPagedResponseData, type RsRequest, type RsResponse, type RsResponseData, type RsRouteHandler, SQL, type SchemaChangeValue, type SchemaPreview, type SqlMutationData, type StandardOrderTypes, type TriggerResult, apiGenerator, escapeColumnName, eventManager, filterPsqlParser, insertObjectQuery, isSchemaValid, isValueNumber, logger, modelGenerator, questionMarksToOrderedParams, restura, resturaGlobalTypesGenerator, resturaSchema, toSqlLiteral, updateObjectQuery };
+export { type ActionColumnChangeData, type ActionColumnChangeFilter, type ActionRowDeleteData, type ActionRowDeleteFilter, type ActionRowInsertData, type ActionRowInsertFilter, type ApiMethod, type AsyncExpressApplication, type AuthenticateHandler, type AuthenticatedRequesterDetails, type ConjunctionTypes, type DatabaseActionData, type DbCheckConstraint, type DbColumn, type DbForeignKey, type DbIndex, type DbSnapshot, type DbTable, type DynamicObject, type ErrorCode, type EventType, HtmlStatusCodes, type LogLevel, type MatchTypes, type MutationType, type OnValidAuthenticationCallback, type PageQuery, PsqlConnection, PsqlEngine, PsqlPool, PsqlTransaction, type QueryMetadata, type RequesterDetails, type ResturaConfigSchema, type ResturaLogger, type ResturaSchema, RsError, type RsErrorData, type RsErrorInternalData, type RsHeaders, type RsPagedResponseData, type RsRequest, type RsResponse, type RsResponseData, type RsRouteHandler, SQL, type SchemaChangeValue, type SchemaPreview, type SqlMutationData, type StandardOrderTypes, type TriggerResult, apiGenerator, createDeleteTriggerSql, createInsertTriggerSql, createUpdateTriggerSql, diffDatabaseToSchema, diffSchemaToDatabase, escapeColumnName, eventManager, filterPsqlParser, generateDatabaseSchemaFromSchema, getNewPublicSchemaAndScratchPool, insertObjectQuery, introspectDatabase, isSchemaValid, isValueNumber, logger, modelGenerator, questionMarksToOrderedParams, restura, resturaGlobalTypesGenerator, resturaSchema, schemaToPsqlType, setLogger, systemUser, toSqlLiteral, updateObjectQuery };