@raytio/types 7.3.0 → 8.1.0

package/src/verification.ts

@@ -1,4 +1,12 @@
-import type { NId, ProfileObject, SchemaName } from "./raytio";
+import type {
+  CommonFields,
+  GPMId,
+  Json,
+  MId,
+  NId,
+  ProfileObject,
+  SchemaName,
+} from "./raytio";
 
 // see #659
 export enum SafeHarbourCode {
@@ -16,7 +24,11 @@ export type VerificationPayload<WithValue extends boolean> = {
   schema?: SchemaName;
   metadata?: {
     safeHarbourScore?: SafeHarbourCode;
-    status?: "pending";
+    status?: "pending" | "approved";
+    validation?: {
+      id: string;
+      url: string;
+    };
     pending_details?: {
       /**
        * for pending verifications - whether the verifier will complete fast enough that
@@ -40,12 +52,14 @@ export type VerificationPayload<WithValue extends boolean> = {
   source_n_id?: NId;
   /** like `source_n_id` */
   source_hashed_n_id?: NId;
+  hashed_source_n_id?: NId;
   type?: null;
   v_id: string;
+  verification_type_id: GPMId;
   verification_date: string;
-  verifier_id?: NId;
-  verifier_source_id?: NId;
-  verifier_service_id?: NId;
+  verifier_id?: MId;
+  verifier_source_id?: MId;
+  verifier_service_id?: MId;
   verifier_div: string;
   // we are disabling the eslint rule because even tho `{}` acts illogically in typescript,
   // in this case it's working as expected in the intersection type, see
@@ -110,11 +124,12 @@ export enum POVerification {
   Loading,
 }
 
-/** These `n_id`s point to service provider profile objects */
+/** These IDs point to merchants (formerly service provider profile objects) */
 export type VerificationProvider = {
-  verifierNId?: NId;
-  dataSourceNId?: NId;
-  serviceProviderNId?: NId;
+  verifierNId?: MId;
+  dataSourceNId?: MId;
+  serviceProviderNId?: MId;
+  verificationTypeId?: GPMId;
   /** the date which the verification was verified on, or last re-verified on */
   date?: Date;
 };
@@ -141,3 +156,39 @@ export type RealVer = {
   /** If the verification has expired, it's the date that it expired on. Otherwise it's `false` */
   expired: Date | false;
 };
+
+export type VerificationType = CommonFields<GPMId> & {
+  item_number: number;
+  org_number: number;
+  item_key: string;
+  item_key_01: string | null;
+  item_key_02: string | null;
+  item_key_03: string | null;
+  item_type: string | null;
+  item_name: string;
+  item_name_i18n: Json | null;
+  item_description: string;
+  item_description_i18n: Json | null;
+
+  primary_uom: string;
+  secondary_uom: string | null;
+  item_mass: number | null;
+  item_mass_uom: string | null;
+  item_volume: number | null;
+  item_volume_uom: string | null;
+  item_dimension_length: number | null;
+  item_dimension_width: number | null;
+  item_dimension_height: number | null;
+  item_dimension_uom: string | null;
+
+  purchased: boolean | null;
+  shipped: boolean | null;
+  stocked: boolean | null;
+  transacted: boolean | null;
+  asset: boolean | null;
+  returnable: boolean | null;
+
+  inventory_organization_number: number | null;
+  source_type: string | null;
+  source_organization_number: number | null;
+};

package/src/wizard.ts

@@ -11,20 +11,55 @@ export type WizardPage = {
   filter: "oneOf" | "anyOf";
   schemas: SchemaName[];
 
+  /**
+   * Page type: 'form' for data collection, 'message' for info/error display
+   * @default "form"
+   */
+  page_type?: "form" | "message";
+
+  /**
+   * Content to display on message pages. Supports markdown if page_content_decorator is "md"
+   */
+  page_content?: string;
+
+  /**
+   * Set to "md" to render page_content as markdown
+   */
+  page_content_decorator?: "md";
+
+  /**
+   * If true, user cannot proceed past this page (error/blocking behavior)
+   * If false, user can continue to next page (informational)
+   * @default false
+   */
+  is_terminal?: boolean;
+
+  /**
+   * Label for the exit button on terminal pages
+   * @default "Home"
+   */
+  terminal_button_label?: string;
+
+  /**
+   * URL to redirect to when exit button is clicked on terminal pages
+   * @default "/" or return_to from WizardConfig
+   */
+  terminal_button_url?: string;
+
   /** the fallback description, if there isn't one for the specific situation */
   description?: string;
   description_select?: string;
   description_create?: string;
   description_update?: string;
 
-  /** if explictly == false, then it's an AO (not a PO), in which case there can only be one schema */
+  /** @deprecated - AO/PO classification is now done per-object using schema tags (type:application_object) instead of page-level profile property */
   profile?: boolean;
   /** if true this page can be skipped. The PageResult wil be undefined */
   optional?: boolean;
   /** if true mulitple POs can be shared */
   multiple?: boolean;
   /** see #463 */
-  service_provider_link?: boolean;
+  merchant_link?: boolean;
   /** custom text to display on the Create New button */
   create_new_text?: string;
   /** a URL to a preset for configuing NestedSchemaSelect. {@link DeepConfig} */
@@ -138,6 +173,13 @@ export type WizardConfig = {
    */
   quick_onboard?: boolean;
 
+  /**
+   * If true, users must explicitly accept privacy terms during quick onboard.
+   * If false, the form auto-submits without user intervention.
+   * @default true
+   */
+  quick_onboard_require_consent?: boolean;
+
   /** the loading message to show next to the spinner after the review screen */
   sharing_data_message?: string;