@nium/nium-sdk 0.1.6 → 0.1.8

package/dist/index.d.mts

@@ -23,10 +23,34 @@ interface NiumInitOptions {
 }
 /** Theme options for embedded components */
 interface NiumTheme {
-    primaryColor?: string;
     borderRadius?: string;
     fontFamily?: string;
+    formBackgroundColor?: string;
+    inputFieldBackgroundColor?: string;
+    inputFieldBorderColor?: string;
+    inputFieldPlaceholderColor?: string;
+    inputFieldTextColor?: string;
+    inputFieldBorderRadius?: string;
+    formHeadingColor?: string;
+    labelBackgroundColor?: string;
+    radioColor?: string;
 }
+/** Per-field UI customization options for SDK beneficiary form fields. */
+interface NiumFieldCustomization {
+    hidden?: boolean;
+    disabled?: boolean;
+}
+/** Per-section UI customization options for SDK beneficiary form sections. */
+interface NiumSectionCustomization {
+    hidden?: boolean;
+}
+/** Supported beneficiary form field paths for `customizations.fields`. */
+type NiumBeneficiaryFieldPath = 'name' | 'entityType' | 'line1' | 'line2' | 'city' | 'state' | 'postalCode' | 'countryCode' | 'communicationPreference' | 'contactNumber' | 'email' | 'termsCheckbox' | 'helperText';
+type NiumBeneficiarySectionPath = 'demographicInfo' | 'communicationPreferences' | 'accountType' | 'bankAccountDetails';
+type NiumBeneficiaryFieldCustomizations = Partial<Record<NiumBeneficiaryFieldPath | string, NiumFieldCustomization>>;
+type NiumBeneficiarySectionCustomizations = Partial<Record<NiumBeneficiarySectionPath | string, NiumSectionCustomization>>;
+/** Intent for the payment (beneficiary) form */
+type NiumPaymentIntent = 'create_beneficiary' | 'return_payload' | 'update_beneficiary';
 /** Prefill data for the payment (beneficiary) form */
 interface NiumPaymentPrefill {
     name?: string;
@@ -50,12 +74,16 @@ interface NiumElementOptions {
     prefill?: NiumPaymentPrefill;
     /** Custom theme overrides */
     theme?: NiumTheme;
-    /** If true, the form will call the create beneficiary API directly instead of returning the payload */
-    createBeneficiary?: boolean;
+    /** Form intent: 'create_beneficiary' creates and returns beneficiaryId + payload; 'return_payload' returns payload only; 'update_beneficiary' updates an existing beneficiary */
+    intent?: NiumPaymentIntent;
+    /** Beneficiary hash ID (required for 'update_beneficiary' intent) */
+    beneficiaryHashId?: string;
     /** Custom minimum height for the iframe (default: 400) */
     customizations?: {
         minHeight?: number;
         maxHeight?: number;
+        fields?: NiumBeneficiaryFieldCustomizations;
+        sections?: NiumBeneficiarySectionCustomizations;
     };
 }
 interface NiumReadyEvent {
@@ -175,4 +203,4 @@ declare const init: (options: NiumInitOptions) => Promise<void>;
  */
 declare const createElement: (type: NiumElementType, options?: NiumElementOptions) => Promise<NiumElement>;
 
-export { type NiumCancelEvent, type NiumChangeEvent, NiumElement, type NiumElementOptions, type NiumElementType, type NiumEnv, type NiumErrorEvent, type NiumEvent, type NiumEventCallback, type NiumEventMap, type NiumInitOptions, type NiumPaymentPrefill, type NiumReadyEvent, type NiumResizeEvent, type NiumSubmitEvent, type NiumSubmitResult, type NiumTheme, createElement, init };
+export { type NiumBeneficiaryFieldCustomizations, type NiumBeneficiaryFieldPath, type NiumCancelEvent, type NiumChangeEvent, NiumElement, type NiumElementOptions, type NiumElementType, type NiumEnv, type NiumErrorEvent, type NiumEvent, type NiumEventCallback, type NiumEventMap, type NiumFieldCustomization, type NiumInitOptions, type NiumPaymentIntent, type NiumPaymentPrefill, type NiumReadyEvent, type NiumResizeEvent, type NiumSubmitEvent, type NiumSubmitResult, type NiumTheme, createElement, init };

package/dist/index.d.ts

@@ -23,10 +23,34 @@ interface NiumInitOptions {
 }
 /** Theme options for embedded components */
 interface NiumTheme {
-    primaryColor?: string;
     borderRadius?: string;
     fontFamily?: string;
+    formBackgroundColor?: string;
+    inputFieldBackgroundColor?: string;
+    inputFieldBorderColor?: string;
+    inputFieldPlaceholderColor?: string;
+    inputFieldTextColor?: string;
+    inputFieldBorderRadius?: string;
+    formHeadingColor?: string;
+    labelBackgroundColor?: string;
+    radioColor?: string;
 }
+/** Per-field UI customization options for SDK beneficiary form fields. */
+interface NiumFieldCustomization {
+    hidden?: boolean;
+    disabled?: boolean;
+}
+/** Per-section UI customization options for SDK beneficiary form sections. */
+interface NiumSectionCustomization {
+    hidden?: boolean;
+}
+/** Supported beneficiary form field paths for `customizations.fields`. */
+type NiumBeneficiaryFieldPath = 'name' | 'entityType' | 'line1' | 'line2' | 'city' | 'state' | 'postalCode' | 'countryCode' | 'communicationPreference' | 'contactNumber' | 'email' | 'termsCheckbox' | 'helperText';
+type NiumBeneficiarySectionPath = 'demographicInfo' | 'communicationPreferences' | 'accountType' | 'bankAccountDetails';
+type NiumBeneficiaryFieldCustomizations = Partial<Record<NiumBeneficiaryFieldPath | string, NiumFieldCustomization>>;
+type NiumBeneficiarySectionCustomizations = Partial<Record<NiumBeneficiarySectionPath | string, NiumSectionCustomization>>;
+/** Intent for the payment (beneficiary) form */
+type NiumPaymentIntent = 'create_beneficiary' | 'return_payload' | 'update_beneficiary';
 /** Prefill data for the payment (beneficiary) form */
 interface NiumPaymentPrefill {
     name?: string;
@@ -50,12 +74,16 @@ interface NiumElementOptions {
     prefill?: NiumPaymentPrefill;
     /** Custom theme overrides */
     theme?: NiumTheme;
-    /** If true, the form will call the create beneficiary API directly instead of returning the payload */
-    createBeneficiary?: boolean;
+    /** Form intent: 'create_beneficiary' creates and returns beneficiaryId + payload; 'return_payload' returns payload only; 'update_beneficiary' updates an existing beneficiary */
+    intent?: NiumPaymentIntent;
+    /** Beneficiary hash ID (required for 'update_beneficiary' intent) */
+    beneficiaryHashId?: string;
     /** Custom minimum height for the iframe (default: 400) */
     customizations?: {
         minHeight?: number;
         maxHeight?: number;
+        fields?: NiumBeneficiaryFieldCustomizations;
+        sections?: NiumBeneficiarySectionCustomizations;
     };
 }
 interface NiumReadyEvent {
@@ -175,4 +203,4 @@ declare const init: (options: NiumInitOptions) => Promise<void>;
  */
 declare const createElement: (type: NiumElementType, options?: NiumElementOptions) => Promise<NiumElement>;
 
-export { type NiumCancelEvent, type NiumChangeEvent, NiumElement, type NiumElementOptions, type NiumElementType, type NiumEnv, type NiumErrorEvent, type NiumEvent, type NiumEventCallback, type NiumEventMap, type NiumInitOptions, type NiumPaymentPrefill, type NiumReadyEvent, type NiumResizeEvent, type NiumSubmitEvent, type NiumSubmitResult, type NiumTheme, createElement, init };
+export { type NiumBeneficiaryFieldCustomizations, type NiumBeneficiaryFieldPath, type NiumCancelEvent, type NiumChangeEvent, NiumElement, type NiumElementOptions, type NiumElementType, type NiumEnv, type NiumErrorEvent, type NiumEvent, type NiumEventCallback, type NiumEventMap, type NiumFieldCustomization, type NiumInitOptions, type NiumPaymentIntent, type NiumPaymentPrefill, type NiumReadyEvent, type NiumResizeEvent, type NiumSubmitEvent, type NiumSubmitResult, type NiumTheme, createElement, init };

package/dist/index.js

@@ -241,8 +241,14 @@ var createElement = async (type, options = {}) => {
   if (options.customerHashId) {
     url.searchParams.set("customerHashId", options.customerHashId);
   }
-  if (options.createBeneficiary) {
-    url.searchParams.set("createBeneficiary", "true");
+  if (options.intent) {
+    if (options.intent === "update_beneficiary" && !options.beneficiaryHashId) {
+      throw new Error("@nium/nium-sdk: beneficiaryHashId is required for update_beneficiary intent");
+    }
+    url.searchParams.set("intent", options.intent);
+  }
+  if (options.beneficiaryHashId) {
+    url.searchParams.set("beneficiaryHashId", options.beneficiaryHashId);
   }
   if (initConfig.locale) {
     url.searchParams.set("locale", initConfig.locale);
@@ -259,6 +265,18 @@ var createElement = async (type, options = {}) => {
       btoa(JSON.stringify(options.theme))
     );
   }
+  const iframeCustomizations = {
+    ...options.customizations?.fields ? { fields: options.customizations.fields } : {},
+    ...options.customizations?.sections ? { sections: options.customizations.sections } : {}
+  };
+  if (Object.keys(iframeCustomizations).length > 0) {
+    url.searchParams.set(
+      "customizations",
+      btoa(
+        JSON.stringify(iframeCustomizations)
+      )
+    );
+  }
   return new NiumElement(url.toString(), type, options, origin);
 };
 // Annotate the CommonJS export names for ESM import in node:

package/dist/index.mjs

@@ -213,8 +213,14 @@ var createElement = async (type, options = {}) => {
   if (options.customerHashId) {
     url.searchParams.set("customerHashId", options.customerHashId);
   }
-  if (options.createBeneficiary) {
-    url.searchParams.set("createBeneficiary", "true");
+  if (options.intent) {
+    if (options.intent === "update_beneficiary" && !options.beneficiaryHashId) {
+      throw new Error("@nium/nium-sdk: beneficiaryHashId is required for update_beneficiary intent");
+    }
+    url.searchParams.set("intent", options.intent);
+  }
+  if (options.beneficiaryHashId) {
+    url.searchParams.set("beneficiaryHashId", options.beneficiaryHashId);
   }
   if (initConfig.locale) {
     url.searchParams.set("locale", initConfig.locale);
@@ -231,6 +237,18 @@ var createElement = async (type, options = {}) => {
       btoa(JSON.stringify(options.theme))
     );
   }
+  const iframeCustomizations = {
+    ...options.customizations?.fields ? { fields: options.customizations.fields } : {},
+    ...options.customizations?.sections ? { sections: options.customizations.sections } : {}
+  };
+  if (Object.keys(iframeCustomizations).length > 0) {
+    url.searchParams.set(
+      "customizations",
+      btoa(
+        JSON.stringify(iframeCustomizations)
+      )
+    );
+  }
   return new NiumElement(url.toString(), type, options, origin);
 };
 export {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nium/nium-sdk",
-  "version": "0.1.6",
+  "version": "0.1.8",
   "description": "NIUM Onboarding SDK - Embed hosted onboarding forms with a clean JavaScript API",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -8,18 +8,19 @@
   "files": [
     "dist"
   ],
-  "scripts": {
-    "build": "tsup src/index.ts --format cjs,esm --dts --clean",
-    "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
-    "type": "tsc --noEmit",
-    "lint": "eslint src/"
-  },
   "devDependencies": {
+    "@rollup/rollup-darwin-arm64": "^4.60.1",
     "tsup": "^8.0.0",
     "typescript": "^5.0.0"
   },
   "license": "UNLICENSED",
   "publishConfig": {
     "access": "public"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts --clean",
+    "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
+    "type": "tsc --noEmit",
+    "lint": "eslint src/"
   }
-}
+}