skyflow-js 1.22.0 → 1.23.0

package/package.json

@@ -2,7 +2,7 @@
   "name": "skyflow-js",
   "preferGlobal": true,
   "analyze": false,
-  "version": "1.22.0",
+  "version": "1.23.0",
   "author": "Skyflow",
   "description": "Skyflow JavaScript SDK",
   "homepage": "https://github.com/skyflowapi/skyflow-js",

package/types/core/external/skyflow-container.d.ts

@@ -1,9 +1,9 @@
-import { IDetokenizeInput, IGetByIdInput } from '../../utils/common';
+import { IDetokenizeInput, IGetByIdInput, IInsertOptions } from '../../utils/common';
 declare class SkyflowContainer {
     #private;
     constructor(client: any, context: any);
     detokenize(detokenizeInput: IDetokenizeInput): Promise<any>;
-    insert(records: any, options: any): Promise<any>;
+    insert(records: any, options: IInsertOptions): Promise<any>;
     getById(getByIdInput: IGetByIdInput): Promise<unknown>;
 }
 export default SkyflowContainer;

package/types/skyflow.d.ts

@@ -1,7 +1,7 @@
 import { ElementType } from './core/constants';
 import RevealContainer from './core/external/reveal/reveal-container';
 import CollectContainer from './core/external/collect/collect-container';
-import { IRevealResponseType, RequestMethod, IInsertRecordInput, IDetokenizeInput, IGetByIdInput, RedactionType, EventName, Env, LogLevel, ValidationRuleType } from './utils/common';
+import { IRevealResponseType, RequestMethod, IInsertRecordInput, IDetokenizeInput, IGetByIdInput, RedactionType, EventName, Env, LogLevel, ValidationRuleType, IInsertOptions } from './utils/common';
 export declare enum ContainerType {
     COLLECT = "COLLECT",
     REVEAL = "REVEAL"
@@ -17,9 +17,10 @@ declare class Skyflow {
     constructor(config: ISkyflow);
     static init(config: ISkyflow): Skyflow;
     container(type: ContainerType, options?: Record<string, any>): CollectContainer | RevealContainer;
-    insert(records: IInsertRecordInput, options?: Record<string, any>): Promise<any>;
+    insert(records: IInsertRecordInput, options: IInsertOptions): Promise<any>;
     detokenize(detokenizeInput: IDetokenizeInput): Promise<IRevealResponseType>;
     getById(getByIdInput: IGetByIdInput): Promise<unknown>;
+    get(getByIdInput: IGetByIdInput): Promise<unknown>;
     static get ContainerType(): typeof ContainerType;
     static get ElementType(): typeof ElementType;
     static get RedactionType(): typeof RedactionType;

package/types/utils/common/index.d.ts

@@ -56,9 +56,11 @@ export interface IDetokenizeInput {
     records: IRevealRecord[];
 }
 export interface ISkyflowIdRecord {
-    ids: string[];
+    ids?: string[];
     redaction: RedactionType;
     table: string;
+    columnName?: string;
+    columnValues?: string[];
 }
 export interface IGetByIdInput {
     records: ISkyflowIdRecord[];
@@ -71,3 +73,11 @@ export interface IValidationRule {
     type: ValidationRuleType;
     params: any;
 }
+export interface IUpsertOption {
+    table: string;
+    column: string;
+}
+export interface IInsertOptions {
+    tokens?: boolean;
+    upsert?: IUpsertOption[];
+}

package/types/utils/constants.d.ts

@@ -131,47 +131,51 @@ declare const SKYFLOW_ERROR_CODE: {
         code: number;
         description: string;
     };
-    RECORDS_KEY_NOT_FOUND_GETBYID: {
+    RECORDS_KEY_NOT_FOUND_GET: {
         code: number;
         description: string;
     };
-    INVALID_RECORDS_IN_GETBYID: {
+    INVALID_RECORDS_IN_GET: {
         code: number;
         description: string;
     };
-    EMPTY_RECORDS_GETBYID: {
+    EMPTY_RECORDS_GET: {
         code: number;
         description: string;
     };
-    MISSING_IDS_IN_GETBYID: {
+    MISSING_IDS_IN_GET: {
         code: number;
         description: string;
     };
-    INVALID_IDS_IN_GETBYID: {
+    INVALID_IDS_IN_GET: {
         code: number;
         description: string;
     };
-    EMPTY_IDS_IN_GETBYID: {
+    INVALID_COLUMN_VALUES_IN_GET: {
         code: number;
         description: string;
     };
-    INVALID_SKYFLOWID_TYPE_IN_GETBYID: {
+    EMPTY_IDS_IN_GET: {
         code: number;
         description: string;
     };
-    MISSING_TABLE_IN_GETBYID: {
+    INVALID_SKYFLOWID_TYPE_IN_GET: {
         code: number;
         description: string;
     };
-    INVALID_TABLE_IN_GETBYID: {
+    MISSING_TABLE_IN_GET: {
         code: number;
         description: string;
     };
-    MISSING_REDACTION_IN_GETBYID: {
+    INVALID_TABLE_IN_GET: {
         code: number;
         description: string;
     };
-    INVALID_REDACTION_TYPE_IN_GETBYID: {
+    MISSING_REDACTION_IN_GET: {
+        code: number;
+        description: string;
+    };
+    INVALID_REDACTION_TYPE_IN_GET: {
         code: number;
         description: string;
     };
@@ -239,15 +243,15 @@ declare const SKYFLOW_ERROR_CODE: {
         code: number;
         description: string;
     };
-    EMPTY_SKYFLOWID_IN_GETBYID: {
+    EMPTY_SKYFLOWID_IN_GET: {
         code: number;
         description: string;
     };
-    EMPTY_TABLE_IN_GETBYID: {
+    EMPTY_TABLE_IN_GET: {
         code: number;
         description: string;
     };
-    EMPTY_REDACTION_TYPE_IN_GETBYID: {
+    EMPTY_REDACTION_TYPE_IN_GET: {
         code: number;
         description: string;
     };
@@ -287,6 +291,18 @@ declare const SKYFLOW_ERROR_CODE: {
         code: number;
         description: string;
     };
+    INVALID_RECORD_COLUMN_VALUE: {
+        code: number;
+        description: string;
+    };
+    MISSING_RECORD_COLUMN_VALUE: {
+        code: number;
+        description: string;
+    };
+    MISSING_RECORD_COLUMN_NAME: {
+        code: number;
+        description: string;
+    };
     INVALID_EVENT_TYPE: {
         code: number;
         description: string;
@@ -403,5 +419,29 @@ declare const SKYFLOW_ERROR_CODE: {
         code: number;
         description: string;
     };
+    INVALID_RECORD_COLUMN_VALUE_TYPE: {
+        code: number;
+        description: string;
+    };
+    INVALID_COLUMN_VALUES_TYPE: {
+        code: number;
+        description: string;
+    };
+    EMPTY_RECORD_COLUMN_VALUES: {
+        code: number;
+        description: string;
+    };
+    EMPTY_COLUMN_VALUE: {
+        code: number;
+        description: string;
+    };
+    MISSING_IDS_OR_COLUMN_VALUES_IN_GET: {
+        code: number;
+        description: string;
+    };
+    SKYFLOW_IDS_AND_COLUMN_NAME_BOTH_SPECIFIED: {
+        code: number;
+        description: string;
+    };
 };
 export default SKYFLOW_ERROR_CODE;

package/types/utils/logs.d.ts

@@ -8,7 +8,7 @@ declare const logs: {
         REVEAL_CONTAINER_CREATED: string;
         VALIDATE_RECORDS: string;
         VALIDATE_DETOKENIZE_INPUT: string;
-        VALIDATE_GET_BY_ID_INPUT: string;
+        VALIDATE_GET_INPUT: string;
         VALIDATE_COLLECT_RECORDS: string;
         VALIDATE_REVEAL_RECORDS: string;
         CREATED_ELEMENT: string;
@@ -18,7 +18,7 @@ declare const logs: {
         REVEAL_SUBMIT_SUCCESS: string;
         INSERT_DATA_SUCCESS: string;
         DETOKENIZE_SUCCESS: string;
-        GET_BY_ID_SUCCESS: string;
+        GET_SUCCESS: string;
         BEARER_TOKEN_LISTENER: string;
         CAPTURED_BEARER_TOKEN_EVENT: string;
         BEARER_TOKEN_RESOLVED: string;
@@ -28,14 +28,14 @@ declare const logs: {
         EMIT_PURE_JS_CONTROLLER: string;
         INSERT_TRIGGERED: string;
         DETOKENIZE_TRIGGERED: string;
-        GET_BY_ID_TRIGGERED: string;
+        GET_TRIGGERED: string;
         EMIT_PURE_JS_REQUEST: string;
         CAPTURE_PURE_JS_REQUEST: string;
         LISTEN_PURE_JS_REQUEST: string;
         CAPTURE_PUREJS_FRAME: string;
         FETCH_RECORDS_RESOLVED: string;
         INSERT_RECORDS_RESOLVED: string;
-        GET_BY_SKYFLOWID_RESOLVED: string;
+        GET_RESOLVED: string;
         EMIT_EVENT: string;
         CAPTURE_EVENT: string;
         LISTEN_COLLECT_FRAME_READY: string;
@@ -98,17 +98,18 @@ declare const logs: {
         INVALID_RECORDS_IN_DETOKENIZE: string;
         MISSING_TOKEN_IN_DETOKENIZE: string;
         INVALID_TOKEN_IN_DETOKENIZE: string;
-        RECORDS_KEY_NOT_FOUND_GETBYID: string;
-        INVALID_RECORDS_IN_GETBYID: string;
-        EMPTY_RECORDS_GETBYID: string;
-        MISSING_IDS_IN_GETBYID: string;
-        INVALID_IDS_IN_GETBYID: string;
-        EMPTY_IDS_IN_GETBYID: string;
-        INVALID_SKYFLOWID_TYPE_IN_GETBYID: string;
-        MISSING_TABLE_IN_GETBYID: string;
-        INVALID_TABLE_IN_GETBYID: string;
-        MISSING_REDACTION_IN_GETBYID: string;
-        INVALID_REDACTION_TYPE_IN_GETBYID: string;
+        RECORDS_KEY_NOT_FOUND_GET: string;
+        INVALID_RECORDS_IN_GET: string;
+        EMPTY_RECORDS_GET: string;
+        MISSING_IDS_IN_GET: string;
+        INVALID_IDS_IN_GET: string;
+        INVALID_COLUMN_VALUES_IN_GET: string;
+        EMPTY_IDS_IN_GET: string;
+        INVALID_SKYFLOWID_TYPE_IN_GET: string;
+        MISSING_TABLE_IN_GET: string;
+        INVALID_TABLE_IN_GET: string;
+        MISSING_REDACTION_IN_GET: string;
+        INVALID_REDACTION_TYPE_IN_GET: string;
         EMPTY_RECORDS_REVEAL: string;
         MISSING_TOKEN_KEY_REVEAL: string;
         INVALID_TOKEN_ID_REVEAL: string;
@@ -118,13 +119,13 @@ declare const logs: {
         EMPTY_TABLE_IN_ADDITIONAL_FIELDS: string;
         EMPTY_FIELDS_IN_ADDITIONAL_FIELDS: string;
         EMPTY_TOKEN_IN_DETOKENIZE: string;
-        EMPTY_SKYFLOWID_IN_GETBYID: string;
-        EMPTY_TABLE_IN_GETBYID: string;
-        EMPTY_REDACTION_TYPE_IN_GETBYID: string;
+        EMPTY_SKYFLOWID_IN_GET: string;
+        EMPTY_TABLE_IN_GET: string;
+        EMPTY_REDACTION_TYPE_IN_GET: string;
         EMPTY_TOKEN_ID_REVEAL: string;
         FETCH_RECORDS_REJECTED: string;
         INSERT_RECORDS_REJECTED: string;
-        GET_BY_SKYFLOWID_REJECTED: string;
+        GET_REJECTED: string;
         FAILED_REVEAL: string;
         MISSING_TABLE_IN_COLLECT: string;
         EMPTY_TABLE_IN_COLLECT: string;
@@ -176,6 +177,15 @@ declare const logs: {
         MISSING_COLUMN_IN_UPSERT_OPTION: string;
         INVALID_TABLE_IN_UPSERT_OPTION: string;
         INVALID_COLUMN_IN_UPSERT_OPTION: string;
+        INVALID_RECORD_COLUMN_VALUE: string;
+        MISSING_RECORD_COLUMN_VALUE: string;
+        MISSING_RECORD_COLUMN_NAME: string;
+        INVALID_RECORD_COLUMN_VALUE_TYPE: string;
+        INVALID_COLUMN_VALUES_TYPE: string;
+        EMPTY_RECORD_COLUMN_VALUES: string;
+        EMPTY_COLUMN_VALUE: string;
+        MISSING_IDS_OR_COLUMN_VALUES_IN_GET: string;
+        SKYFLOW_IDS_AND_COLUMN_NAME_BOTH_SPECIFIED: string;
     };
     warnLogs: {
         INVALID_EXPIRATION_DATE_FORMAT: string;
@@ -183,6 +193,7 @@ declare const logs: {
         UNABLE_TO_SET_VALUE_IN_PROD_ENV: string;
         UNABLE_TO_CLEAR_VALUE_IN_PROD_ENV: string;
         COLLECT_ALT_TEXT_DEPERECATED: string;
+        GET_BY_ID_DEPRECATED: string;
     };
 };
 export default logs;