dromo-uploader-js 2.8.0 → 2.9.0

package/dist/interfaces.d.ts

@@ -628,6 +628,7 @@ export type IUser = {
     companyId?: string | undefined;
     companyName?: string | undefined;
 };
+export type CustomStepInsertAfter = "HEADER_SELECT" | "COLUMN_MATCH" | "SELECT_MATCH";
 type MaybeAsync<T> = T | Promise<T>;
 export interface IParentConnectionMethods {
     handleColumnHooks: (fieldName: string, data: IColumnHookInput[]) => Promise<IColumnHookOutput[]>;
@@ -639,6 +640,8 @@ export interface IParentConnectionMethods {
     handleCloseModal: () => void;
     handleCancel: () => void;
     handleParseFileCallback: (buffer: ArrayBuffer, fileName: string) => Promise<string[][] | void>;
+    handleCustomStep: (id: string) => Promise<string | void>;
+    handleCustomStepMessage: (id: string, payload: unknown) => Promise<void>;
 }
 export interface IConnectionMethods {
     init: (licenseKey: string, fields: IDeveloperField[], settings: IDeveloperSettings, user: IUser, appHost?: string) => void;
@@ -661,11 +664,20 @@ export interface IConnectionMethods {
         cancelButtonText?: string;
     }) => void;
     setCustomParserFileExtensions: (fileExtensions: string[]) => void;
+    setCustomSteps: (steps: Array<{
+        id: string;
+        insertAfter: CustomStepInsertAfter;
+        label?: string;
+        url?: string;
+    }>) => void;
+    completeCustomStep: () => void;
+    goBackCustomStep: () => void;
 }
 export type WrapAsync<T> = {
     [P in keyof T]: T[P] extends (...args: infer Args) => infer Return ? (...args: Args) => Promise<Return> : T[P];
 };
 export type IPublicConnectionMethods = WrapAsync<Pick<IConnectionMethods, "addField" | "updateInfoMessages" | "setHeaderRowOverride" | "setUser" | "removeField" | "setDevelopmentMode" | "addRows" | "removeRows" | "setConfirmationMessage">>;
+export type ICustomStepConnectionMethods = IPublicConnectionMethods & WrapAsync<Pick<IConnectionMethods, "completeCustomStep" | "goBackCustomStep">>;
 export type IDeveloperFieldType = "string" | "checkbox" | "select" | "multi-select" | "number" | "domain" | "date" | "ssn" | "datetime" | "phone-number" | "time" | "url" | "us-zip-code" | "country" | "uuid" | "us-state-territory" | "email";
 export interface ICellRef {
     rowIndex: number;
@@ -816,6 +828,25 @@ export interface IStepHook {
     type: keyof typeof EStepHook;
     callback: (uploader: IPublicConnectionMethods, data: IUploadStepData | IReviewStepData | IReviewStepPostHooksData) => MaybeAsync<void>;
 }
+export interface ICustomStepConfig {
+    id: string;
+    insertAfter: CustomStepInsertAfter;
+    /** Label shown in the stepper bar. Defaults to the step id if omitted. */
+    label?: string;
+    /**
+     * Dromo renders an <iframe> pointing to this URL inside the standard
+     * StepContainer. Step id and label are appended as query params
+     * (?stepId=…&stepLabel=…). The iframe page signals navigation by posting
+     * { type: "DROMO_NEXT" } or { type: "DROMO_BACK" } to its parent window.
+     */
+    url?: string;
+    /**
+     * Called when the iframe posts { type: "DROMO_MESSAGE", payload: any }.
+     * Receives the same uploader instance as step hooks so you can call
+     * addField, removeField, addRows, etc. in response to iframe messages.
+     */
+    onMessage?: (uploader: ICustomStepConnectionMethods, payload: unknown) => MaybeAsync<void>;
+}
 export type IBeforeFinishCallback = (data: Record<string, any>[], metadata: IResultMetadataWithValues, instance: IPublicConnectionMethods) => MaybeAsync<IBeforeFinishOutput>;
 export type IBeforeFinishOutput = void | {
     cancel: true;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dromo-uploader-js",
-  "version": "2.8.0",
+  "version": "2.9.0",
   "description": "Easy to use data (CSV, TSV, Excel) importer",
   "author": "ankitgoyal100",
   "license": "MIT",
@@ -34,6 +34,7 @@
     "@rollup/plugin-commonjs": "^16.0.0",
     "@rollup/plugin-node-resolve": "^10.0.0",
     "@rollup/plugin-replace": "^2.3.4",
+    "@rollup/plugin-terser": "^1.0.0",
     "@typescript-eslint/eslint-plugin": "^6.3.0",
     "@typescript-eslint/parser": "^6.3.0",
     "eslint": "^7.32.0",
@@ -43,12 +44,11 @@
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^4.0.0",
     "eslint-plugin-promise": "^5.2.0",
-    "microbundle-crl": "^0.13.10",
     "prettier": "^2.6.2",
     "rollup": "^2.79.2",
-    "rollup-plugin-terser": "^7.0.2",
     "rollup-plugin-typescript2": "^0.29.0",
-    "serve": "^13.0.2",
+    "serve": "^14.2.6",
+    "tslib": "^2.8.1",
     "typescript": "^5.1.6"
   },
   "files": [