@restura/core 0.1.0-alpha.8 → 0.1.0-alpha.9

package/dist/index.d.mts

@@ -2,23 +2,57 @@ import winston from 'winston';
 import * as express from 'express';
 import { z } from 'zod';
 import { PoolConfig, Pool } from 'pg';
+import { IncomingHttpHeaders } from 'http2';
 
 declare const logger: winston.Logger;
 
+interface RsErrorInternalData {
+    err: ErrorCode;
+    msg: string;
+    stack: string;
+    status: number;
+    message?: string;
+}
+declare enum HtmlStatusCodes {
+    BAD_REQUEST = 400,
+    UNAUTHORIZED = 401,
+    FORBIDDEN = 403,
+    NOT_FOUND = 404,
+    METHOD_NOT_ALLOWED = 405,
+    CONFLICT = 409,
+    VERSION_OUT_OF_DATE = 418,// Technically this is the I'm a teapot code that was a joke.
+    SERVER_ERROR = 500,
+    SERVICE_UNAVAILABLE = 503,
+    NETWORK_CONNECT_TIMEOUT = 599
+}
+type ErrorCode = 'UNKNOWN_ERROR' | 'NOT_FOUND' | 'EMAIL_TAKEN' | 'UNAUTHORIZED' | 'FORBIDDEN' | 'CONFLICT' | 'UPDATE_FORBIDDEN' | 'CREATE_FORBIDDEN' | 'DELETE_FORBIDDEN' | 'DELETE_FAILURE' | 'BAD_REQUEST' | 'INVALID_TOKEN' | 'INCORRECT_EMAIL_OR_PASSWORD' | 'DUPLICATE_TOKEN' | 'DUPLICATE_USERNAME' | 'DUPLICATE_EMAIL' | 'DUPLICATE' | 'EMAIL_NOT_VERIFIED' | 'UPDATE_WITHOUT_ID' | 'CONNECTION_ERROR' | 'INVALID_PAYMENT' | 'DECLINED_PAYMENT' | 'INTEGRATION_ERROR' | 'CANNOT_RESERVE' | 'REFUND_FAILURE' | 'INVALID_INVOICE' | 'INVALID_COUPON' | 'SERVICE_UNAVAILABLE' | 'METHOD_UNALLOWED' | 'LOGIN_EXPIRED' | 'THIRD_PARTY_ERROR' | 'ACCESS_DENIED' | 'DATABASE_ERROR' | 'SCHEMA_ERROR';
+declare class RsError {
+    err: ErrorCode;
+    msg: string;
+    status?: number;
+    stack: string;
+    constructor(errCode: ErrorCode, message?: string);
+    static htmlStatus(code: ErrorCode): number;
+    static isRsError(error: any): error is RsError;
+}
+
 declare const resturaConfigSchema: z.ZodObject<{
     authToken: z.ZodString;
     sendErrorStackTrace: z.ZodDefault<z.ZodBoolean>;
     schemaFilePath: z.ZodDefault<z.ZodString>;
+    customApiFolderPath: z.ZodDefault<z.ZodString>;
     generatedTypesPath: z.ZodDefault<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     authToken: string;
     sendErrorStackTrace: boolean;
     schemaFilePath: string;
+    customApiFolderPath: string;
     generatedTypesPath: string;
 }, {
     authToken: string;
     sendErrorStackTrace?: boolean | undefined;
     schemaFilePath?: string | undefined;
+    customApiFolderPath?: string | undefined;
     generatedTypesPath?: string | undefined;
 }>;
 type ResturaConfigSchema = z.infer<typeof resturaConfigSchema>;
@@ -1245,29 +1279,107 @@ declare const resturaZodSchema: z.ZodObject<{
 }>;
 type ResturaSchema = z.infer<typeof resturaZodSchema>;
 
-interface RequesterDetails {
-    role?: string;
-    host: string;
-    ipAddress: string;
-    [key: string]: string | number | undefined | null | boolean;
+interface SchemaChangeValue {
+    name: string;
+    changeType: 'NEW' | 'MODIFIED' | 'DELETED';
 }
-interface RsRequest<T = unknown> extends express.Request {
-    requesterDetails: RequesterDetails;
+interface SchemaPreview {
+    commands: string;
+    endPoints: SchemaChangeValue[];
+    globalParams: SchemaChangeValue[];
+    roles: SchemaChangeValue[];
+    customTypes: boolean;
+}
+interface LoginDetails {
+    token: string;
+    refreshToken: string;
+    expiresOn: string;
+    user: {
+        firstName: string;
+        lastName: string;
+        email: string;
+    };
+}
+type ValidatorString = 'boolean' | 'string' | 'number' | 'object' | 'any';
+interface ResponseType {
+    isOptional?: boolean;
+    isArray?: boolean;
+    validator: ValidatorString | ResponseTypeMap | string[];
+}
+interface ResponseTypeMap {
+    [property: string]: ResponseType;
+}
+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 AuthenticationUserDetails {
+    role: string;
+    userId?: number;
+    [key: string]: string | number | boolean | object | null | undefined;
+}
+type ValidAuthenticationCallback = (userDetails: AuthenticationUserDetails) => void;
+type AuthenticateHandler = (req: RsRequest<unknown>, res: RsResponse<unknown>, onValid: ValidAuthenticationCallback) => Promise<void>;
 
-interface RoleWithOptionalUserDetails {
+interface RsHeaders extends IncomingHttpHeaders {
+    'x-auth-token'?: string;
+}
+type ApiMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS';
+type RequesterDetails<T extends object = {}> = {
     role: string;
-    [key: string]: string | number | boolean | object | null;
+    host: string;
+    ipAddress: string;
+    userId?: number;
+    isSystemUser?: boolean;
+} & T;
+interface RsRequest<T = unknown, U extends object = Record<string, never>> 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 AuthenticateHandler = (req: RsRequest<unknown>, onValid: (userDetails: RoleWithOptionalUserDetails) => void, onReject: (errorMessage: string) => void) => Promise<void>;
 
 declare class PsqlPool {
     poolConfig: PoolConfig;
     pool: Pool;
     constructor(poolConfig: PoolConfig);
-    queryOne(query: string, options: Array<any>): Promise<any>;
-    runQuery(query: string, options: any[]): Promise<any[]>;
+    queryOne(query: string, options: any[], requesterDetails: RequesterDetails): Promise<any>;
+    runQuery(query: string, options: any[], requesterDetails: RequesterDetails): Promise<any[]>;
+    private logSqlStatement;
 }
 
 declare class ResturaEngine {
@@ -1352,6 +1464,7 @@ declare class ResturaEngine {
     private getSchemaAndTypes;
     private executeRouteLogic;
     private isCustomRoute;
+    private runCustomRouteLogic;
     private generateHashForSchema;
     private storeFileSystemSchema;
     private resetPublicEndpoints;
@@ -1360,4 +1473,11 @@ declare class ResturaEngine {
 }
 declare const restura: ResturaEngine;
 
-export { PsqlPool, logger, restura };
+declare function escapeColumnName(columnName: string | undefined): string;
+declare function questionMarksToOrderedParams(query: string): string;
+declare function insertObjectQuery(table: string, obj: DynamicObject): string;
+declare function updateObjectQuery(table: string, obj: DynamicObject, whereStatement: string): string;
+declare function isValueNumber(value: unknown): value is number;
+declare function SQL(strings: any, ...values: any): any;
+
+export { type ApiMethod, type AsyncExpressApplication, type AuthenticateHandler, type AuthenticationUserDetails, type ConjunctionTypes, type DynamicObject, type ErrorCode, HtmlStatusCodes, type LoginDetails, type MatchTypes, type PageQuery, PsqlPool, type RequesterDetails, type ResponseType, type ResponseTypeMap, RsError, type RsErrorData, type RsErrorInternalData, type RsHeaders, type RsPagedResponseData, type RsRequest, type RsResponse, type RsResponseData, type RsRouteHandler, SQL, type SchemaChangeValue, type SchemaPreview, type StandardOrderTypes, type ValidAuthenticationCallback, type ValidatorString, escapeColumnName, insertObjectQuery, isValueNumber, logger, questionMarksToOrderedParams, restura, updateObjectQuery };

package/dist/index.d.ts

@@ -2,23 +2,57 @@ import winston from 'winston';
 import * as express from 'express';
 import { z } from 'zod';
 import { PoolConfig, Pool } from 'pg';
+import { IncomingHttpHeaders } from 'http2';
 
 declare const logger: winston.Logger;
 
+interface RsErrorInternalData {
+    err: ErrorCode;
+    msg: string;
+    stack: string;
+    status: number;
+    message?: string;
+}
+declare enum HtmlStatusCodes {
+    BAD_REQUEST = 400,
+    UNAUTHORIZED = 401,
+    FORBIDDEN = 403,
+    NOT_FOUND = 404,
+    METHOD_NOT_ALLOWED = 405,
+    CONFLICT = 409,
+    VERSION_OUT_OF_DATE = 418,// Technically this is the I'm a teapot code that was a joke.
+    SERVER_ERROR = 500,
+    SERVICE_UNAVAILABLE = 503,
+    NETWORK_CONNECT_TIMEOUT = 599
+}
+type ErrorCode = 'UNKNOWN_ERROR' | 'NOT_FOUND' | 'EMAIL_TAKEN' | 'UNAUTHORIZED' | 'FORBIDDEN' | 'CONFLICT' | 'UPDATE_FORBIDDEN' | 'CREATE_FORBIDDEN' | 'DELETE_FORBIDDEN' | 'DELETE_FAILURE' | 'BAD_REQUEST' | 'INVALID_TOKEN' | 'INCORRECT_EMAIL_OR_PASSWORD' | 'DUPLICATE_TOKEN' | 'DUPLICATE_USERNAME' | 'DUPLICATE_EMAIL' | 'DUPLICATE' | 'EMAIL_NOT_VERIFIED' | 'UPDATE_WITHOUT_ID' | 'CONNECTION_ERROR' | 'INVALID_PAYMENT' | 'DECLINED_PAYMENT' | 'INTEGRATION_ERROR' | 'CANNOT_RESERVE' | 'REFUND_FAILURE' | 'INVALID_INVOICE' | 'INVALID_COUPON' | 'SERVICE_UNAVAILABLE' | 'METHOD_UNALLOWED' | 'LOGIN_EXPIRED' | 'THIRD_PARTY_ERROR' | 'ACCESS_DENIED' | 'DATABASE_ERROR' | 'SCHEMA_ERROR';
+declare class RsError {
+    err: ErrorCode;
+    msg: string;
+    status?: number;
+    stack: string;
+    constructor(errCode: ErrorCode, message?: string);
+    static htmlStatus(code: ErrorCode): number;
+    static isRsError(error: any): error is RsError;
+}
+
 declare const resturaConfigSchema: z.ZodObject<{
     authToken: z.ZodString;
     sendErrorStackTrace: z.ZodDefault<z.ZodBoolean>;
     schemaFilePath: z.ZodDefault<z.ZodString>;
+    customApiFolderPath: z.ZodDefault<z.ZodString>;
     generatedTypesPath: z.ZodDefault<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     authToken: string;
     sendErrorStackTrace: boolean;
     schemaFilePath: string;
+    customApiFolderPath: string;
     generatedTypesPath: string;
 }, {
     authToken: string;
     sendErrorStackTrace?: boolean | undefined;
     schemaFilePath?: string | undefined;
+    customApiFolderPath?: string | undefined;
     generatedTypesPath?: string | undefined;
 }>;
 type ResturaConfigSchema = z.infer<typeof resturaConfigSchema>;
@@ -1245,29 +1279,107 @@ declare const resturaZodSchema: z.ZodObject<{
 }>;
 type ResturaSchema = z.infer<typeof resturaZodSchema>;
 
-interface RequesterDetails {
-    role?: string;
-    host: string;
-    ipAddress: string;
-    [key: string]: string | number | undefined | null | boolean;
+interface SchemaChangeValue {
+    name: string;
+    changeType: 'NEW' | 'MODIFIED' | 'DELETED';
 }
-interface RsRequest<T = unknown> extends express.Request {
-    requesterDetails: RequesterDetails;
+interface SchemaPreview {
+    commands: string;
+    endPoints: SchemaChangeValue[];
+    globalParams: SchemaChangeValue[];
+    roles: SchemaChangeValue[];
+    customTypes: boolean;
+}
+interface LoginDetails {
+    token: string;
+    refreshToken: string;
+    expiresOn: string;
+    user: {
+        firstName: string;
+        lastName: string;
+        email: string;
+    };
+}
+type ValidatorString = 'boolean' | 'string' | 'number' | 'object' | 'any';
+interface ResponseType {
+    isOptional?: boolean;
+    isArray?: boolean;
+    validator: ValidatorString | ResponseTypeMap | string[];
+}
+interface ResponseTypeMap {
+    [property: string]: ResponseType;
+}
+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 AuthenticationUserDetails {
+    role: string;
+    userId?: number;
+    [key: string]: string | number | boolean | object | null | undefined;
+}
+type ValidAuthenticationCallback = (userDetails: AuthenticationUserDetails) => void;
+type AuthenticateHandler = (req: RsRequest<unknown>, res: RsResponse<unknown>, onValid: ValidAuthenticationCallback) => Promise<void>;
 
-interface RoleWithOptionalUserDetails {
+interface RsHeaders extends IncomingHttpHeaders {
+    'x-auth-token'?: string;
+}
+type ApiMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS';
+type RequesterDetails<T extends object = {}> = {
     role: string;
-    [key: string]: string | number | boolean | object | null;
+    host: string;
+    ipAddress: string;
+    userId?: number;
+    isSystemUser?: boolean;
+} & T;
+interface RsRequest<T = unknown, U extends object = Record<string, never>> 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 AuthenticateHandler = (req: RsRequest<unknown>, onValid: (userDetails: RoleWithOptionalUserDetails) => void, onReject: (errorMessage: string) => void) => Promise<void>;
 
 declare class PsqlPool {
     poolConfig: PoolConfig;
     pool: Pool;
     constructor(poolConfig: PoolConfig);
-    queryOne(query: string, options: Array<any>): Promise<any>;
-    runQuery(query: string, options: any[]): Promise<any[]>;
+    queryOne(query: string, options: any[], requesterDetails: RequesterDetails): Promise<any>;
+    runQuery(query: string, options: any[], requesterDetails: RequesterDetails): Promise<any[]>;
+    private logSqlStatement;
 }
 
 declare class ResturaEngine {
@@ -1352,6 +1464,7 @@ declare class ResturaEngine {
     private getSchemaAndTypes;
     private executeRouteLogic;
     private isCustomRoute;
+    private runCustomRouteLogic;
     private generateHashForSchema;
     private storeFileSystemSchema;
     private resetPublicEndpoints;
@@ -1360,4 +1473,11 @@ declare class ResturaEngine {
 }
 declare const restura: ResturaEngine;
 
-export { PsqlPool, logger, restura };
+declare function escapeColumnName(columnName: string | undefined): string;
+declare function questionMarksToOrderedParams(query: string): string;
+declare function insertObjectQuery(table: string, obj: DynamicObject): string;
+declare function updateObjectQuery(table: string, obj: DynamicObject, whereStatement: string): string;
+declare function isValueNumber(value: unknown): value is number;
+declare function SQL(strings: any, ...values: any): any;
+
+export { type ApiMethod, type AsyncExpressApplication, type AuthenticateHandler, type AuthenticationUserDetails, type ConjunctionTypes, type DynamicObject, type ErrorCode, HtmlStatusCodes, type LoginDetails, type MatchTypes, type PageQuery, PsqlPool, type RequesterDetails, type ResponseType, type ResponseTypeMap, RsError, type RsErrorData, type RsErrorInternalData, type RsHeaders, type RsPagedResponseData, type RsRequest, type RsResponse, type RsResponseData, type RsRouteHandler, SQL, type SchemaChangeValue, type SchemaPreview, type StandardOrderTypes, type ValidAuthenticationCallback, type ValidatorString, escapeColumnName, insertObjectQuery, isValueNumber, logger, questionMarksToOrderedParams, restura, updateObjectQuery };