@questwork/q-utilities 0.1.34 → 0.1.35

package/dist/q-utilities.d.ts

@@ -106,13 +106,31 @@ export declare function changeCreatorOwner(that: any, { source, target }: {
 export declare class CheckResult {
     dataSets: DataSet[];
     constructor(opts?: CheckResultOptions);
+    static init(opts?: CheckResultOptions): CheckResult | null;
+    static initFromArray(arr?: any[]): Array<CheckResult>;
+    static initOnlyValidFromArray(arr?: any[]): Array<CheckResult>;
     addDataSet(dataSet: DataSet): void;
     getDataSetByName(name: string): DataSet | undefined;
+    getAllSummary(): {
+        summary: DataSetSummaryItem[];
+    };
     getSummary(): DataSetSummaryItem[];
     getDuplicatedDetails(): DetailsResultItem[];
     getIgnoredDetails(): DetailsResultItem[];
     getInvalidDetails(): DetailsResultItem[];
     getValidDetails(): Record<string, DataWrapper[]>;
+    getAllDetails(): {
+        details: {
+            ignoredDetails: DetailsResultItem[];
+            invalidDetails: DetailsResultItem[];
+            duplicatedDetails: DetailsResultItem[];
+        };
+    };
+    getDetails(): {
+        ignoredDetails: DetailsResultItem[];
+        invalidDetails: DetailsResultItem[];
+        duplicatedDetails: DetailsResultItem[];
+    };
     hasInvalidData(): boolean;
 }
 
@@ -152,13 +170,23 @@ declare function customHandler({ responseHelper, handler, ignoreError }: {
 declare class DataSet {
     name: string;
     data?: Array<DataWrapper>;
+    orphanData: Array<DataWrapper>;
     checkResultConfig: CheckResultConfig;
     saveResultConfig: SaveResultConfig;
+    orphanBehavior?: 'DELETE' | 'KEEP' | null;
+    notExistBehavior?: 'INSERT' | 'SKIP';
+    existBehavior?: 'UPDATE' | 'SKIP';
     constructor(opts?: any);
+    static init(opts?: DataSet): DataSet | null;
+    static initFromArray(arr?: any[]): Array<DataSet>;
+    static initOnlyValidFromArray(arr?: any[]): Array<DataSet>;
     add(data: DataWrapper): DataSetOptions;
     getExistedData(): Array<DataWrapper>;
     getInvalidData(): Array<DataWrapper>;
     getNotExistedData(): Array<DataWrapper>;
+    getSkipData(): Array<DataWrapper>;
+    addOrphan(data: Record<string, any>): DataSet;
+    getOrphanData(): Array<DataWrapper>;
 }
 
 declare interface DataSetOptions {
@@ -166,6 +194,9 @@ declare interface DataSetOptions {
     data?: Array<DataWrapper>;
     checkResultConfig?: CheckResultConfig;
     saveResultConfig?: SaveResultConfig;
+    orphanBehavior?: 'DELETE' | 'KEEP' | null;
+    notExistBehavior?: 'INSERT' | 'SKIP';
+    existBehavior?: 'UPDATE' | 'SKIP';
 }
 
 declare interface DataSetSummary {
@@ -188,11 +219,16 @@ declare interface DataSourceConfig {
         dataSet: DataSet;
         ctx: Record<string, any>;
     }) => Promise<DataSet>;
+    checkOrphans?: (params: {
+        dataSet: DataSet;
+        ctx: Record<string, any>;
+    }) => Promise<void>;
     converter?: (value: any) => any;
     isIgnore?: (value: any) => any;
     primaryKeys?: string[];
     notExistBehavior: 'INSERT' | 'SKIP';
     existBehavior: 'UPDATE' | 'SKIP';
+    orphanBehavior?: 'DELETE' | 'KEEP';
     handleData?: (params: {
         dataSet: DataSet;
         dataSource: DataSourceConfig;
@@ -205,30 +241,46 @@ declare interface DataSourceConfig {
 
 declare class DataWrapper {
     data: Record<string, any>;
-    errorLogs?: Array<Log>;
-    ignoreLog?: Log;
+    logs: Array<Log>;
     rawData: Record<string, any>;
     rowIndex: number;
     status?: Status_2;
     transformedData: Record<string, any>;
     constructor(opts: DataWrapperOptions);
-    addError(detail: Log): DataWrapper;
-    addInsertError(msg: string): DataWrapper;
-    addUpdateError(msg: string): DataWrapper;
-    isValid(): boolean;
-    setIgnoreLog(detail: Log): DataWrapper;
-    setData(data: Record<string, any>): DataWrapper;
+    static init(opts?: DataWrapperOptions): DataWrapper | null;
+    static initFromArray(arr?: any[]): Array<DataWrapper>;
+    static initOnlyValidFromArray(arr?: any[]): Array<DataWrapper>;
+    get errorLogs(): Array<Log>;
+    get ignoreLog(): Log | undefined;
+    addLog(detail: LogInput): DataWrapper;
+    addError(detail: LogInput): DataWrapper;
+    addOrphanDeleteError(msg?: string): DataWrapper;
+    addInsertError(msg?: string): DataWrapper;
+    addUpdateError(msg?: string): DataWrapper;
+    addDuplicatedLog(msg?: string): DataWrapper;
+    addSkippedLog(msg?: string): DataWrapper;
+    addIgnoreLog(msg?: string): DataWrapper;
+    addInsertedLog(msg?: string): DataWrapper;
+    addUpdatedLog(msg?: string): DataWrapper;
+    addOrphanDeletedLog(msg?: string): DataWrapper;
+    isCheckValid(): boolean;
+    isIgnored(): boolean;
+    isDuplicated(): boolean;
+    hasErrors(): boolean;
+    setStatus(status: keyof typeof DATAWRAPPER_STATUS): DataWrapper;
     setExisted(): DataWrapper;
     setFailed(): DataWrapper;
     setInserted(): DataWrapper;
-    setRawData(rawData: Record<string, any>): DataWrapper;
     setSkipped(): DataWrapper;
-    setStatus(status: keyof typeof DATAWRAPPER_STATUS): DataWrapper;
-    setTransformedData(transformedData: Record<string, any>): DataWrapper;
     setUpdated(): DataWrapper;
+    setOrphanDeleted(): DataWrapper;
+    setData(data: Record<string, any>): DataWrapper;
+    setRawData(rawData: Record<string, any>): DataWrapper;
+    setTransformedData(transformedData: Record<string, any>): DataWrapper;
 }
 
 declare const DATAWRAPPER_STATUS: {
+    ORPHAN_DELETED: string;
     EXISTED: string;
     FAILED: string;
     INSERTED: string;
@@ -238,10 +290,9 @@ declare const DATAWRAPPER_STATUS: {
 
 declare interface DataWrapperOptions {
     data?: Record<string, any>;
-    errorLogs?: Array<Log>;
-    ignoreLog?: Log;
+    logs?: Array<Log>;
     rawData?: Record<string, any>;
-    rowIndex: number;
+    rowIndex?: number;
     status?: Status_2;
     transformedData?: Record<string, any>;
 }
@@ -302,7 +353,9 @@ declare const _default: {
     QMeta: typeof models.QMeta;
     Repo: typeof models.Repo;
     makeService: typeof models.makeService;
+    makeServiceBulkWrite: typeof models.makeServiceBulkWrite;
     Service: typeof models.Service;
+    ServiceBulkWrite: typeof models.ServiceBulkWrite;
     ActionRecord: typeof models.ActionRecord;
     Status: typeof models.Status;
     StatusDocument: typeof models.StatusDocument;
@@ -345,6 +398,20 @@ declare const _default: {
     escapeRegex(string: any): string;
     ExcelImportHelper: typeof helpers.ExcelImportHelper;
     CheckResult: typeof helpers.CheckResult;
+    LOG_TYPE: {
+        readonly IGNORE: "IGNORE";
+        readonly DUPLICATED: "DUPLICATED";
+        readonly REQUIRED_ERROR: "REQUIRED_ERROR";
+        readonly TRANSFORM_ERROR: "TRANSFORM_ERROR";
+        readonly CONVERT_ERROR: "CONVERT_ERROR";
+        readonly ORPHAN_DELETE_ERROR: "ORPHAN_DELETE_ERROR";
+        readonly INSERT_ERROR: "INSERT_ERROR";
+        readonly UPDATE_ERROR: "UPDATE_ERROR";
+        readonly SKIPPED: "SKIPPED";
+        readonly INSERTED: "INSERTED";
+        readonly UPDATED: "UPDATED";
+        readonly ORPHAN_DELETED: "ORPHAN_DELETED";
+    };
     expressHelper: {
         customHandler: customHandler;
         findAllResult: findAllResult;
@@ -490,6 +557,7 @@ export declare class ExcelImportHelper {
     private static createExcelRow;
     private static getRawDataFromHeaders;
     private static isIgnore;
+    private static checkRequired;
     private static checkDuplicated;
     private static transform;
     private static convert;
@@ -569,6 +637,7 @@ declare namespace helpers {
         escapeRegex,
         ExcelImportHelper,
         CheckResult,
+        LOG_TYPE,
         expressHelper,
         extractEmails,
         formatDate,
@@ -663,7 +732,28 @@ declare interface Log {
     rowIndex: number;
     column: string;
     message: string;
-    type: string;
+    type: LogType;
+}
+
+export declare const LOG_TYPE: {
+    readonly IGNORE: "IGNORE";
+    readonly DUPLICATED: "DUPLICATED";
+    readonly REQUIRED_ERROR: "REQUIRED_ERROR";
+    readonly TRANSFORM_ERROR: "TRANSFORM_ERROR";
+    readonly CONVERT_ERROR: "CONVERT_ERROR";
+    readonly ORPHAN_DELETE_ERROR: "ORPHAN_DELETE_ERROR";
+    readonly INSERT_ERROR: "INSERT_ERROR";
+    readonly UPDATE_ERROR: "UPDATE_ERROR";
+    readonly SKIPPED: "SKIPPED";
+    readonly INSERTED: "INSERTED";
+    readonly UPDATED: "UPDATED";
+    readonly ORPHAN_DELETED: "ORPHAN_DELETED";
+};
+
+declare interface LogInput {
+    column: string;
+    message: string;
+    type: LogType;
 }
 
 export declare class LogRecord {
@@ -679,6 +769,8 @@ export declare class LogRecord {
     serialize(): any;
 }
 
+declare type LogType = typeof LOG_TYPE[keyof typeof LOG_TYPE];
+
 export declare function makeApiResponse({ repo, result }: {
     repo: any;
     result: any;
@@ -688,6 +780,10 @@ export declare function makeService({ repo }: {
     repo: any;
 }): Service;
 
+export declare function makeServiceBulkWrite({ repo }: {
+    repo: any;
+}): ServiceBulkWrite;
+
 export declare function mergeArraysByKey(arr1: any, arr2: any): {
     key: any;
     value: any;
@@ -713,7 +809,9 @@ declare namespace models {
         QMeta,
         Repo,
         makeService,
+        makeServiceBulkWrite,
         Service,
+        ServiceBulkWrite,
         ActionRecord,
         Status,
         StatusDocument,
@@ -739,6 +837,17 @@ export declare namespace objectHelper {
     export { set };
 }
 
+declare interface OrphanDetail {
+    deleted: DataWrapper[];
+    failed: DataWrapper[];
+}
+
+declare interface OrphanSummary {
+    total: number;
+    deleted: number;
+    failed: number;
+}
+
 export declare function padZeros(num: any, minLength?: number): any;
 
 export declare function pMap(iterable: any, mapper: any, { concurrency, stopOnError, signal, }?: {
@@ -899,6 +1008,11 @@ export declare class Repo {
     get queryOptions(): any;
     get saveOptions(): any;
     init(options: any): any;
+    bulkWriteDocs({ operations, config, systemLog }: {
+        operations: any;
+        config: any;
+        systemLog: any;
+    }): Promise<any>;
     deleteOne({ id }: {
         id: any;
     }): Promise<any>;
@@ -945,8 +1059,110 @@ declare class SaveResult {
     dataSets: DataSet[];
     constructor(opt?: any);
     addDataSet(dataSet: DataSet): this;
+    getAllDetails(): {
+        details: {
+            failed: {
+                name: string;
+                hidden: boolean;
+                logs: any[];
+            }[];
+            skipped: {
+                name: string;
+                hidden: boolean;
+                logs: any[];
+            }[];
+            inserted: {
+                name: string;
+                hidden: boolean;
+                logs: any[];
+            }[];
+            updated: {
+                name: string;
+                hidden: boolean;
+                logs: any[];
+            }[];
+        };
+        orphanDetails: {
+            deleted: any[];
+            failed: any[];
+        };
+    };
+    getDetails(): {
+        failed: {
+            name: string;
+            hidden: boolean;
+            logs: any[];
+        }[];
+        skipped: {
+            name: string;
+            hidden: boolean;
+            logs: any[];
+        }[];
+        inserted: {
+            name: string;
+            hidden: boolean;
+            logs: any[];
+        }[];
+        updated: {
+            name: string;
+            hidden: boolean;
+            logs: any[];
+        }[];
+    };
+    getFailedDetails(): {
+        name: string;
+        hidden: boolean;
+        logs: any[];
+    }[];
+    getSkippedDetails(): {
+        name: string;
+        hidden: boolean;
+        logs: any[];
+    }[];
+    getInsertedDetails(): {
+        name: string;
+        hidden: boolean;
+        logs: any[];
+    }[];
+    getUpdatedDetails(): {
+        name: string;
+        hidden: boolean;
+        logs: any[];
+    }[];
+    getOrphanDetails(): {
+        deleted: any[];
+        failed: any[];
+    };
+    getOrphanFailedDetails(): any[];
+    getOrphanDeletedDetails(): any[];
     getSaveDetails(): SaveResultDetailItem[];
     getSaveSummary(): SaveResultSummaryItem[];
+    getAllSummary(): {
+        summary: {
+            name: string;
+            hidden: boolean;
+            summary: {
+                total: number;
+                failed: number;
+                inserted: number;
+                skipped: number;
+                updated: number;
+            };
+        }[];
+        orphanSummary: any[];
+    };
+    getSummary(): {
+        name: string;
+        hidden: boolean;
+        summary: {
+            total: number;
+            failed: number;
+            inserted: number;
+            skipped: number;
+            updated: number;
+        };
+    }[];
+    getOrphanSummary(): any[];
 }
 
 declare interface SaveResultConfig {
@@ -956,6 +1172,7 @@ declare interface SaveResultConfig {
         skipped: boolean;
         inserted: boolean;
         updated: boolean;
+        orphanDeleted?: boolean;
     };
 }
 
@@ -969,6 +1186,7 @@ declare interface SaveResultDetail {
 declare interface SaveResultDetailItem {
     name: string;
     hidden: boolean;
+    orphanDetails: OrphanDetail | null;
     details: SaveResultDetail;
 }
 
@@ -983,6 +1201,7 @@ declare interface SaveResultSummary {
 declare interface SaveResultSummaryItem {
     name: string;
     hidden: boolean;
+    orphanSummary: OrphanSummary | null;
     summary: SaveResultSummary;
 }
 
@@ -1021,6 +1240,13 @@ export declare class Service {
     }>;
 }
 
+export declare class ServiceBulkWrite extends Service {
+    bulkWriteDocs({ operations, config }: {
+        operations: any;
+        config: any;
+    }): Promise<any>;
+}
+
 export declare function setId(id: any): any;
 
 export declare function shuffleArray(array: any): any[];
@@ -1044,6 +1270,7 @@ export declare class Status {
 }
 
 declare interface Status_2 {
+    orphanDeleted?: number;
     existed?: number;
     failed?: number;
     inserted?: number;
@@ -1275,6 +1502,7 @@ declare interface WorksheetConfig {
     dataStartRow?: number;
     dataEndRow?: number;
     dataSources: DataSourceConfig[];
+    rowIndexKey?: string;
 }
 
 export { }