@carbonorm/carbonnode 1.0.0 → 1.0.1

package/dist/api/C6.d.ts

@@ -0,0 +1,122 @@
+export declare const C6: {
+    ADDDATE: string;
+    ADDTIME: string;
+    AS: string;
+    ASC: string;
+    BETWEEN: string;
+    CONCAT: string;
+    CONVERT_TZ: string;
+    COUNT: string;
+    COUNT_ALL: string;
+    CURRENT_DATE: string;
+    CURRENT_TIMESTAMP: string;
+    DAY: string;
+    DAY_HOUR: string;
+    DAY_MICROSECOND: string;
+    DAY_MINUTE: string;
+    DAY_SECOND: string;
+    DAYNAME: string;
+    DAYOFMONTH: string;
+    DAYOFWEEK: string;
+    DAYOFYEAR: string;
+    DATE: string;
+    DATE_ADD: string;
+    DATEDIFF: string;
+    DATE_SUB: string;
+    DATE_FORMAT: string;
+    DESC: string;
+    DISTINCT: string;
+    EXTRACT: string;
+    EQUAL: string;
+    EQUAL_NULL_SAFE: string;
+    FALSE: string;
+    FULL_OUTER: string;
+    FROM_DAYS: string;
+    FROM_UNIXTIME: string;
+    GET_FORMAT: string;
+    GREATER_THAN: string;
+    GROUP_BY: string;
+    GROUP_CONCAT: string;
+    GREATER_THAN_OR_EQUAL_TO: string;
+    HAVING: string;
+    HEX: string;
+    HOUR: string;
+    HOUR_MICROSECOND: string;
+    HOUR_SECOND: string;
+    HOUR_MINUTE: string;
+    IN: string;
+    IS: string;
+    IS_NOT: string;
+    INNER: string;
+    INTERVAL: string;
+    JOIN: string;
+    LEFT: string;
+    LEFT_OUTER: string;
+    LESS_THAN: string;
+    LESS_THAN_OR_EQUAL_TO: string;
+    LIKE: string;
+    LIMIT: string;
+    LOCALTIME: string;
+    LOCALTIMESTAMP: string;
+    MAKEDATE: string;
+    MAKETIME: string;
+    MONTHNAME: string;
+    MICROSECOND: string;
+    MINUTE: string;
+    MINUTE_MICROSECOND: string;
+    MINUTE_SECOND: string;
+    MIN: string;
+    MAX: string;
+    MONTH: string;
+    NOT_LIKE: string;
+    NOT_EQUAL: string;
+    NOT_IN: string;
+    NOW: string;
+    NULL: string;
+    ORDER: string;
+    PAGE: string;
+    PAGINATION: string;
+    RIGHT_OUTER: string;
+    SECOND: string;
+    SECOND_MICROSECOND: string;
+    SELECT: string;
+    STR_TO_DATE: string;
+    SUBDATE: string;
+    SUBTIME: string;
+    SUM: string;
+    SYSDATE: string;
+    TIME: string;
+    TIME_FORMAT: string;
+    TIME_TO_SEC: string;
+    TIMEDIFF: string;
+    TIMESTAMP: string;
+    TIMESTAMPADD: string;
+    TIMESTAMPDIFF: string;
+    TO_DAYS: string;
+    TO_SECONDS: string;
+    TRANSACTION_TIMESTAMP: string;
+    TRUE: string;
+    UNIX_TIMESTAMP: string;
+    UNKNOWN: string;
+    UPDATE: string;
+    UNHEX: string;
+    UTC_DATE: string;
+    UTC_TIME: string;
+    UTC_TIMESTAMP: string;
+    WHERE: string;
+    WEEKDAY: string;
+    WEEKOFYEAR: string;
+    YEARWEEK: string;
+    DEPENDANT_ON_ENTITY: string;
+    OPTIONS: string;
+    GET: string;
+    POST: string;
+    PUT: string;
+    REPLACE: string;
+    DELETE: string;
+    REST_REQUEST_PREPROCESS_CALLBACKS: string;
+    PREPROCESS: string;
+    REST_REQUEST_FINNISH_CALLBACKS: string;
+    FINISH: string;
+    VALIDATE_C6_ENTITY_ID_REGEX: string;
+};

package/dist/api/convertForRequestBody.d.ts

@@ -0,0 +1,3 @@
+export default function <RestTableInterfaces extends {
+    [key: string]: any;
+}>(restfulObject: RestTableInterfaces, tableName: string | string[], regexErrorHandler?: (message: string) => void): {};

package/dist/api/interfaces/ormInterfaces.d.ts

@@ -0,0 +1,27 @@
+export interface stringMap {
+    [key: string]: string;
+}
+export interface stringNumberMap {
+    [key: string]: string | number;
+}
+export interface RegExpMap {
+    [key: string]: RegExp | RegExpMap;
+}
+export interface complexMap {
+    [key: string]: stringMap | stringNumberMap | stringMap[] | RegExpMap;
+}
+export interface iTypeValidation {
+    MYSQL_TYPE: string;
+    MAX_LENGTH: string;
+    AUTO_INCREMENT: boolean;
+    SKIP_COLUMN_IN_POST: boolean;
+}
+export interface C6RestfulModel<RestShortTableNames extends string = string> {
+    TABLE_NAME: RestShortTableNames;
+    PRIMARY: string[];
+    COLUMNS: stringMap;
+    REGEX_VALIDATION: RegExpMap;
+    TYPE_VALIDATION: {
+        [key: string]: iTypeValidation;
+    };
+}

package/dist/api/restRequest.d.ts

@@ -0,0 +1,131 @@
+import { C6RestfulModel } from "api/interfaces/ormInterfaces";
+import { AxiosInstance, AxiosPromise, AxiosResponse } from "axios";
+export declare function TestRestfulResponse(response: AxiosResponse | any, success: ((r: AxiosResponse) => (string | void)) | string | undefined, error: ((r: AxiosResponse) => (string | void)) | string | undefined): string | boolean | number;
+export declare function removeInvalidKeys<iRestObject>(request: any, c6Tables: (C6RestfulModel)[]): iRestObject;
+export type Modify<T, R> = Omit<T, keyof R> & R;
+export type ModifyDeep<A, B extends DeepPartialAny<A>> = {
+    [K in keyof A | keyof B]?: K extends keyof A ? K extends keyof B ? A[K] extends AnyObject ? B[K] extends AnyObject ? ModifyDeep<A[K], B[K]> : B[K] : B[K] : A[K] : B[K];
+};
+type AnyObject = Record<string, any>;
+type DeepPartialAny<T> = {
+    [P in keyof T]?: T[P] extends AnyObject ? DeepPartialAny<T[P]> : any;
+};
+export type iAPI<RestTableInterfaces extends {
+    [key: string]: any;
+}> = RestTableInterfaces & {
+    dataInsertMultipleRows?: RestTableInterfaces[];
+    cacheResults?: boolean;
+    fetchDependencies?: boolean;
+    debug?: boolean;
+    success?: string | ((r: AxiosResponse) => (string | void));
+    error?: string | ((r: AxiosResponse) => (string | void));
+    blocking?: boolean;
+};
+export declare function checkAllRequestsComplete(): true | (string[]);
+interface iClearCache {
+    ignoreWarning: boolean;
+}
+export declare function clearCache(props?: iClearCache): void;
+/**
+ * the first argument ....
+ *
+ * Our api returns a zero argument function iff the method is get and the previous request reached the predefined limit.
+ * This function can be aliased as GetNextPageOfResults(). If the end is reached undefined will be returned.
+ *
+ *
+ * For POST, PUT, and DELETE requests one can expect the primary key of the new or modified index, or a boolean success
+ * indication if no primary key exists.
+ **/
+export declare const POST = "POST";
+export declare const PUT = "PUT";
+export declare const GET = "GET";
+export declare const DELETE = "DELETE";
+export type apiReturn<Response> = null | undefined | AxiosPromise<Response> | (Response extends iGetC6RestResponse<any> ? (() => apiReturn<Response>) : null);
+export type iRestMethods = 'GET' | 'POST' | 'PUT' | 'DELETE';
+export type RequestGetPutDeleteBody = {
+    SELECT?: any;
+    UPDATE?: any;
+    DELETE?: any;
+    WHERE?: any;
+    JOIN?: {
+        LEFT?: any;
+        RIGHT?: any;
+        INNER?: any;
+    };
+    PAGINATION?: {
+        PAGE?: number;
+        LIMIT?: number;
+    };
+};
+export type RequestQueryBody<RestTableInterfaces extends {
+    [key: string]: any;
+}> = iAPI<RestTableInterfaces> | RequestGetPutDeleteBody;
+export declare function isPromise(x: any): boolean;
+interface iC6RestResponse<RestData> {
+    rest: RestData;
+    session?: any;
+    sql?: any;
+}
+interface iChangeC6Data {
+    rowCount: number;
+}
+export interface iDeleteC6RestResponse<RestData = any, RequestData = any> extends iChangeC6Data, iC6RestResponse<RestData> {
+    deleted: boolean | number | string | RequestData;
+}
+export interface iPostC6RestResponse<RestData = any> extends iC6RestResponse<RestData> {
+    created: boolean | number | string;
+}
+export interface iPutC6RestResponse<RestData = any, RequestData = any> extends iChangeC6Data, iC6RestResponse<RestData> {
+    updated: boolean | number | string | RequestData;
+}
+export type iGetC6RestResponse<ResponseDataType, ResponseDataOverrides = {}> = iC6RestResponse<Modify<ResponseDataType, ResponseDataOverrides>[]>;
+interface iRest<CustomAndRequiredFields extends {
+    [key: string]: any;
+}, RestTableInterfaces extends {
+    [key: string]: any;
+}, RequestTableOverrides = {
+    [key in keyof RestTableInterfaces]: any;
+}, ResponseDataType = any, RestShortTableNames extends string = any> {
+    C6: {
+        TABLES: {
+            [key: string]: C6RestfulModel & {
+                [key: string]: string | number;
+            };
+        };
+    } & {
+        [key: string]: string;
+    };
+    axios: AxiosInstance;
+    restURL: string;
+    tableName: RestShortTableNames | RestShortTableNames[];
+    requestMethod: iRestMethods;
+    clearCache?: () => void;
+    skipPrimaryCheck?: boolean;
+    queryCallback: RequestQueryBody<Modify<RestTableInterfaces, RequestTableOverrides>> | ((request: iAPI<Modify<RestTableInterfaces, RequestTableOverrides>> & CustomAndRequiredFields) => (null | undefined | RequestQueryBody<Modify<RestTableInterfaces, RequestTableOverrides>>));
+    responseCallback: (response: AxiosResponse<ResponseDataType>, request: iAPI<Modify<RestTableInterfaces, RequestTableOverrides>> & CustomAndRequiredFields, success: (ResponseDataType extends iPutC6RestResponse | iDeleteC6RestResponse ? RequestQueryBody<Modify<RestTableInterfaces, RequestTableOverrides>> : string) | string | number | boolean) => any;
+}
+export declare function extendedTypeHints<RestTableInterfaces extends {
+    [key: string]: any;
+}, RestShortTableNames extends string>(): <CustomAndRequiredFields extends {
+    [key: string]: any;
+} = any, RequestTableTypes extends RestTableInterfaces = any, RequestTableOverrides extends {
+    [key: string]: any;
+} = any, ResponseDataType extends {
+    [key: string]: any;
+} = any>(argv: any) => (request?: Omit<RequestTableTypes, keyof RequestTableOverrides> & RequestTableOverrides & {
+    dataInsertMultipleRows?: Modify<RequestTableTypes, RequestTableOverrides>[] | undefined;
+    cacheResults?: boolean | undefined;
+    fetchDependencies?: boolean | undefined;
+    debug?: boolean | undefined;
+    success?: string | ((r: AxiosResponse<any, any>) => string | void) | undefined;
+    error?: string | ((r: AxiosResponse<any, any>) => string | void) | undefined;
+    blocking?: boolean | undefined;
+} & CustomAndRequiredFields) => apiReturn<ResponseDataType>;
+export default function restApi<CustomAndRequiredFields extends {
+    [key: string]: any;
+} = any, RestTableInterfaces extends {
+    [key: string]: any;
+} = any, RequestTableOverrides extends {
+    [key: string]: any;
+} = any, ResponseDataType = any, RestShortTableNames extends string = any>({ C6, axios, restURL, tableName, requestMethod, queryCallback, responseCallback, skipPrimaryCheck, clearCache }: iRest<CustomAndRequiredFields, RestTableInterfaces, RequestTableOverrides, ResponseDataType, RestShortTableNames>): (request?: iAPI<Modify<RestTableInterfaces, RequestTableOverrides>> & CustomAndRequiredFields) => apiReturn<ResponseDataType>;
+export {};