@restura/core 1.5.0 → 1.7.0

package/dist/index.d.ts

@@ -81,143 +81,6 @@ declare class RsError<T extends Record<string, unknown> = Record<string, unknown
     static isRsError(error: unknown): error is RsError;
 }
 
-interface SchemaChangeValue {
-    name: string;
-    changeType: 'NEW' | 'MODIFIED' | 'DELETED';
-}
-interface SchemaPreview {
-    commands: string;
-    endPoints: SchemaChangeValue[];
-    globalParams: SchemaChangeValue[];
-    roles: SchemaChangeValue[];
-    customTypes: boolean;
-}
-type StandardOrderTypes = 'ASC' | 'DESC' | 'RAND' | 'NONE';
-type ConjunctionTypes = 'AND' | 'OR';
-type MatchTypes = 'exact' | 'fuzzy' | 'like' | 'greaterThan' | 'greaterThanEqual' | 'lessThan' | 'lessThanEqual';
-interface RsResponseData<T> {
-    data: T;
-}
-interface RsErrorData {
-    err: string;
-    msg: string;
-    stack?: string;
-}
-interface RsPagedResponseData<T> extends RsResponseData<T> {
-    total: number;
-}
-interface PageQuery {
-    page: number;
-    perPage: number;
-    sortBy: string;
-    sortOrder: StandardOrderTypes;
-    filter?: string;
-    [key: string]: string | number | boolean | object | null | undefined;
-}
-interface AuthenticatedRequesterDetails {
-    role: string;
-    scopes: string[];
-    userId?: number;
-    [key: string]: string | number | boolean | object | null | undefined;
-}
-type OnValidAuthenticationCallback = (authenticatedRequesterDetails: AuthenticatedRequesterDetails) => void;
-type AuthenticateHandler = (req: RsRequest<unknown>, res: RsResponse<unknown>, onValid: OnValidAuthenticationCallback) => Promise<void>;
-
-interface RsHeaders extends IncomingHttpHeaders {
-    'x-auth-token'?: string;
-}
-type ApiMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS';
-type RequesterDetails<T extends object = {}> = {
-    role: string;
-    scopes: string[];
-    host: string;
-    ipAddress: string;
-    userId?: number;
-    isSystemUser?: boolean;
-} & T;
-interface RsRequest<T = unknown, U extends object = Record<string, unknown>> extends express.Request {
-    requesterDetails: RequesterDetails<U>;
-    data: T;
-}
-type DynamicObject<T = unknown> = {
-    [key: string]: T;
-};
-interface RsResponse<T = unknown> extends express.Response {
-    sendData: (data: T, statusCode?: number) => void;
-    sendNoWrap: (data: T, statusCode?: number) => void;
-    sendError: (err: ErrorCode, msg: string, htmlStatusCode?: HtmlStatusCodes, stack?: string) => void;
-    sendPaginated: (pagedData: RsPagedResponseData<T>, statusCode?: number) => void;
-    _contentLength?: number;
-}
-type RsRouteHandler<T = unknown, U = unknown> = (req: RsRequest<T>, res: RsResponse<U>, next?: express.NextFunction) => Promise<void>;
-interface AsyncExpressApplication {
-    get: (url: string, handler: RsRouteHandler, nextFunction?: RsRouteHandler) => Promise<void> | void;
-    post: (url: string, handler: RsRouteHandler, nextFunction?: RsRouteHandler) => Promise<void> | void;
-    put: (url: string, handler: RsRouteHandler, nextFunction?: RsRouteHandler) => Promise<void> | void;
-    patch: (url: string, handler: RsRouteHandler, nextFunction?: RsRouteHandler) => Promise<void> | void;
-    delete: (url: string, handler: RsRouteHandler, nextFunction?: RsRouteHandler) => Promise<void> | void;
-}
-
-type EventType = 'DATABASE_ROW_DELETE' | 'DATABASE_ROW_INSERT' | 'DATABASE_COLUMN_UPDATE' | 'WEBHOOK';
-type MutationType = 'INSERT' | 'UPDATE' | 'DELETE';
-interface SqlMutationData {
-    mutationType: MutationType;
-    queryMetadata: QueryMetadata;
-}
-interface DatabaseActionData {
-    tableName: string;
-    queryMetadata: QueryMetadata;
-}
-interface ActionRowInsertData<T = DynamicObject> extends DatabaseActionData {
-    insertedId: number;
-    insertObject: T;
-}
-interface ActionRowDeleteData<T = DynamicObject> extends DatabaseActionData {
-    deletedId: number;
-    deletedRow: T;
-}
-interface ActionColumnChangeData<T = DynamicObject> extends DatabaseActionData {
-    tableName: string;
-    changedId: number;
-    newData: T;
-    oldData: T;
-}
-interface ActionRowInsertFilter {
-    tableName: string;
-}
-interface ActionRowDeleteFilter {
-    tableName: string;
-}
-interface ActionColumnChangeFilter {
-    tableName: string;
-    columns: string[];
-}
-type TriggerResult = {
-    table: string;
-    insertedId?: number;
-    changedId?: number;
-    deletedId?: number;
-    queryMetadata: QueryMetadata;
-    record: DynamicObject;
-    previousRecord: DynamicObject;
-    requesterId: number;
-};
-type QueryMetadata = RequesterDetails & {
-    connectionInstanceId: UUID;
-};
-declare class EventManager {
-    private actionHandlers;
-    addRowInsertHandler<T>(onInsert: (data: ActionRowInsertData<T>, queryMetadata: QueryMetadata) => Promise<void>, filter?: ActionRowInsertFilter): void;
-    addColumnChangeHandler<T>(onUpdate: (data: ActionColumnChangeData<T>, queryMetadata: QueryMetadata) => Promise<void>, filter: ActionColumnChangeFilter): void;
-    addRowDeleteHandler<T>(onDelete: (data: ActionRowDeleteData<T>, queryMetadata: QueryMetadata) => Promise<void>, filter?: ActionRowDeleteFilter): void;
-    fireActionFromDbTrigger(sqlMutationData: SqlMutationData, result: TriggerResult): Promise<void>;
-    private fireInsertActions;
-    private fireDeleteActions;
-    private fireUpdateActions;
-    private hasHandlersForEventType;
-}
-declare const eventManager: EventManager;
-
 declare const whereDataSchema: z.ZodObject<{
     tableName: z.ZodOptional<z.ZodString>;
     columnName: z.ZodOptional<z.ZodString>;
@@ -305,7 +168,7 @@ declare const responseDataSchema: z.ZodObject<{
                 OR: "OR";
             }>>;
         }, z.core.$strict>>;
-        properties: z.ZodArray<z.ZodObject<any, z.core.$strict>>;
+        properties: z.ZodArray<z.ZodObject</*elided*/ any, z.core.$strict>>;
         groupBy: z.ZodOptional<z.ZodObject<{
             columnName: z.ZodString;
             tableName: z.ZodString;
@@ -333,6 +196,10 @@ declare const standardRouteSchema: z.ZodObject<{
     name: z.ZodString;
     description: z.ZodString;
     path: z.ZodString;
+    deprecation: z.ZodOptional<z.ZodObject<{
+        date: z.ZodISODateTime;
+        message: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
     roles: z.ZodArray<z.ZodString>;
     scopes: z.ZodArray<z.ZodString>;
     type: z.ZodEnum<{
@@ -444,7 +311,7 @@ declare const standardRouteSchema: z.ZodObject<{
                     OR: "OR";
                 }>>;
             }, z.core.$strict>>;
-            properties: z.ZodArray<z.ZodObject<any, z.core.$strict>>;
+            properties: z.ZodArray<z.ZodObject</*elided*/ any, z.core.$strict>>;
             groupBy: z.ZodOptional<z.ZodObject<{
                 columnName: z.ZodString;
                 tableName: z.ZodString;
@@ -485,6 +352,10 @@ declare const customRouteSchema: z.ZodObject<{
     name: z.ZodString;
     description: z.ZodString;
     path: z.ZodString;
+    deprecation: z.ZodOptional<z.ZodObject<{
+        date: z.ZodISODateTime;
+        message: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
     roles: z.ZodArray<z.ZodString>;
     scopes: z.ZodArray<z.ZodString>;
     type: z.ZodEnum<{
@@ -596,6 +467,7 @@ declare const tableDataSchema: z.ZodObject<{
             ASC: "ASC";
             DESC: "DESC";
         }>;
+        where: z.ZodOptional<z.ZodString>;
     }, z.core.$strict>>;
     foreignKeys: z.ZodArray<z.ZodObject<{
         name: z.ZodString;
@@ -704,6 +576,7 @@ declare const resturaSchema: z.ZodObject<{
                 ASC: "ASC";
                 DESC: "DESC";
             }>;
+            where: z.ZodOptional<z.ZodString>;
         }, z.core.$strict>>;
         foreignKeys: z.ZodArray<z.ZodObject<{
             name: z.ZodString;
@@ -748,6 +621,10 @@ declare const resturaSchema: z.ZodObject<{
             name: z.ZodString;
             description: z.ZodString;
             path: z.ZodString;
+            deprecation: z.ZodOptional<z.ZodObject<{
+                date: z.ZodISODateTime;
+                message: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>>;
             roles: z.ZodArray<z.ZodString>;
             scopes: z.ZodArray<z.ZodString>;
             type: z.ZodEnum<{
@@ -859,7 +736,7 @@ declare const resturaSchema: z.ZodObject<{
                             OR: "OR";
                         }>>;
                     }, z.core.$strict>>;
-                    properties: z.ZodArray<z.ZodObject<any, z.core.$strict>>;
+                    properties: z.ZodArray<z.ZodObject</*elided*/ any, z.core.$strict>>;
                     groupBy: z.ZodOptional<z.ZodObject<{
                         columnName: z.ZodString;
                         tableName: z.ZodString;
@@ -898,6 +775,10 @@ declare const resturaSchema: z.ZodObject<{
             name: z.ZodString;
             description: z.ZodString;
             path: z.ZodString;
+            deprecation: z.ZodOptional<z.ZodObject<{
+                date: z.ZodISODateTime;
+                message: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>>;
             roles: z.ZodArray<z.ZodString>;
             scopes: z.ZodArray<z.ZodString>;
             type: z.ZodEnum<{
@@ -939,6 +820,144 @@ declare const resturaSchema: z.ZodObject<{
 type ResturaSchema = z.infer<typeof resturaSchema>;
 declare function isSchemaValid(schemaToCheck: unknown): Promise<boolean>;
 
+interface SchemaChangeValue {
+    name: string;
+    changeType: 'NEW' | 'MODIFIED' | 'DELETED';
+}
+interface SchemaPreview {
+    commands: string;
+    endPoints: SchemaChangeValue[];
+    globalParams: SchemaChangeValue[];
+    roles: SchemaChangeValue[];
+    customTypes: boolean;
+}
+type StandardOrderTypes = 'ASC' | 'DESC' | 'RAND' | 'NONE';
+type ConjunctionTypes = 'AND' | 'OR';
+type MatchTypes = 'exact' | 'fuzzy' | 'like' | 'greaterThan' | 'greaterThanEqual' | 'lessThan' | 'lessThanEqual';
+interface RsResponseData<T> {
+    data: T;
+}
+interface RsErrorData {
+    err: string;
+    msg: string;
+    stack?: string;
+}
+interface RsPagedResponseData<T> extends RsResponseData<T> {
+    total: number;
+}
+interface PageQuery {
+    page: number;
+    perPage: number;
+    sortBy: string;
+    sortOrder: StandardOrderTypes;
+    filter?: string;
+    [key: string]: string | number | boolean | object | null | undefined;
+}
+interface AuthenticatedRequesterDetails {
+    role: string;
+    scopes: string[];
+    userId?: number;
+    [key: string]: string | number | boolean | object | null | undefined;
+}
+type OnValidAuthenticationCallback = (authenticatedRequesterDetails: AuthenticatedRequesterDetails) => void;
+type AuthenticateHandler = (req: RsRequest<unknown>, res: RsResponse<unknown>, onValid: OnValidAuthenticationCallback) => Promise<void>;
+
+interface RsHeaders extends IncomingHttpHeaders {
+    'x-auth-token'?: string;
+}
+type ApiMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS';
+type RequesterDetails<T extends object = {}> = {
+    role: string;
+    scopes: string[];
+    host: string;
+    ipAddress: string;
+    userId?: number;
+    isSystemUser?: boolean;
+} & T;
+interface RsRequest<T = unknown, U extends object = Record<string, unknown>> extends express.Request {
+    requesterDetails: RequesterDetails<U>;
+    data: T;
+    routeData?: RouteData;
+}
+type DynamicObject<T = unknown> = {
+    [key: string]: T;
+};
+interface RsResponse<T = unknown> extends express.Response {
+    sendData: (data: T, statusCode?: number) => void;
+    sendNoWrap: (data: T, statusCode?: number) => void;
+    sendError: (err: ErrorCode, msg: string, htmlStatusCode?: HtmlStatusCodes, stack?: string) => void;
+    sendPaginated: (pagedData: RsPagedResponseData<T>, statusCode?: number) => void;
+    _contentLength?: number;
+}
+type RsRouteHandler<T = unknown, U = unknown> = (req: RsRequest<T>, res: RsResponse<U>, next?: express.NextFunction) => Promise<void>;
+interface AsyncExpressApplication {
+    get: (url: string, handler: RsRouteHandler, nextFunction?: RsRouteHandler) => Promise<void> | void;
+    post: (url: string, handler: RsRouteHandler, nextFunction?: RsRouteHandler) => Promise<void> | void;
+    put: (url: string, handler: RsRouteHandler, nextFunction?: RsRouteHandler) => Promise<void> | void;
+    patch: (url: string, handler: RsRouteHandler, nextFunction?: RsRouteHandler) => Promise<void> | void;
+    delete: (url: string, handler: RsRouteHandler, nextFunction?: RsRouteHandler) => Promise<void> | void;
+}
+
+type EventType = 'DATABASE_ROW_DELETE' | 'DATABASE_ROW_INSERT' | 'DATABASE_COLUMN_UPDATE' | 'WEBHOOK';
+type MutationType = 'INSERT' | 'UPDATE' | 'DELETE';
+interface SqlMutationData {
+    mutationType: MutationType;
+    queryMetadata: QueryMetadata;
+}
+interface DatabaseActionData {
+    tableName: string;
+    queryMetadata: QueryMetadata;
+}
+interface ActionRowInsertData<T = DynamicObject> extends DatabaseActionData {
+    insertedId: number;
+    insertObject: T;
+}
+interface ActionRowDeleteData<T = DynamicObject> extends DatabaseActionData {
+    deletedId: number;
+    deletedRow: T;
+}
+interface ActionColumnChangeData<T = DynamicObject> extends DatabaseActionData {
+    tableName: string;
+    changedId: number;
+    newData: T;
+    oldData: T;
+}
+interface ActionRowInsertFilter {
+    tableName: string;
+}
+interface ActionRowDeleteFilter {
+    tableName: string;
+}
+interface ActionColumnChangeFilter {
+    tableName: string;
+    columns: string[];
+}
+type TriggerResult = {
+    table: string;
+    insertedId?: number;
+    changedId?: number;
+    deletedId?: number;
+    queryMetadata: QueryMetadata;
+    record: DynamicObject;
+    previousRecord: DynamicObject;
+    requesterId: number;
+};
+type QueryMetadata = RequesterDetails & {
+    connectionInstanceId: UUID;
+};
+declare class EventManager {
+    private actionHandlers;
+    addRowInsertHandler<T>(onInsert: (data: ActionRowInsertData<T>, queryMetadata: QueryMetadata) => Promise<void>, filter?: ActionRowInsertFilter): void;
+    addColumnChangeHandler<T>(onUpdate: (data: ActionColumnChangeData<T>, queryMetadata: QueryMetadata) => Promise<void>, filter: ActionColumnChangeFilter): void;
+    addRowDeleteHandler<T>(onDelete: (data: ActionRowDeleteData<T>, queryMetadata: QueryMetadata) => Promise<void>, filter?: ActionRowDeleteFilter): void;
+    fireActionFromDbTrigger(sqlMutationData: SqlMutationData, result: TriggerResult): Promise<void>;
+    private fireInsertActions;
+    private fireDeleteActions;
+    private fireUpdateActions;
+    private hasHandlersForEventType;
+}
+declare const eventManager: EventManager;
+
 declare function apiGenerator(schema: ResturaSchema): Promise<string>;
 
 declare function modelGenerator(schema: ResturaSchema): Promise<string>;
@@ -1049,6 +1068,7 @@ declare class ResturaEngine {
     private getSchema;
     private getSchemaAndTypes;
     private getMulterFilesIfAny;
+    private attachRouteData;
     private executeRouteLogic;
     private isCustomRoute;
     private runCustomRouteLogic;
@@ -1196,5 +1216,18 @@ declare function isValueNumber(value: unknown): value is number;
  * @returns An escaped query with user input
  */
 declare function SQL(strings: TemplateStringsArray, ...values: unknown[]): string;
+/**
+ * Converts a JavaScript value to its PostgreSQL literal representation.
+ * Used for debug logging of SQL queries — NOT for building actual queries
+ * (use parameterized queries for that).
+ *
+ * @example
+ * toSqlLiteral('hello')     // "'hello'"
+ * toSqlLiteral(42)          // "42"
+ * toSqlLiteral(true)        // "TRUE"
+ * toSqlLiteral(null)        // "NULL"
+ * toSqlLiteral([1, 2])      // "ARRAY[1, 2]"
+ */
+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, 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 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 };