@raytio/types 7.3.0 → 8.1.0

package/src/schema.ts

@@ -1,4 +1,11 @@
-import type { AA, DataTypes, Organization, SchemaName, Urn } from "./raytio";
+import type {
+  AA,
+  CommonFields,
+  DataTypes,
+  Json,
+  SchemaName,
+  Urn,
+} from "./raytio";
 import type { WizardConfig } from "./wizard";
 
 /** should be renamed since this applies to ConditionallyVerifiable */
@@ -10,6 +17,15 @@ export type ConditionallyRequired = {
   };
 };
 
+/** Schema-level conditional tags, evaluated at runtime based on form values */
+export type ConditionalTags = {
+  tags: string[];
+  // see `isConditionMet` for how this syntax works
+  if: {
+    [fieldName: string]: (string | number | boolean)[];
+  };
+};
+
 export type SchemaFieldTag =
   // legacy (TODO: remove these)
   | "password"
@@ -24,16 +40,28 @@ export type SchemaFieldTag =
   | "display:survey"
   | "display:quoting"
   | "display:customModal"
-  | `display:replace:'${string}':'${string}'`
+  | "display:mask"
+  | `display:replace:('${string}', '${string}')`
   | "display:terms_conditions"
   | `display:main_media:${string}` // property name to determine what image to display
+  // content block variants (see ContentBlockField)
+  | "display:content-block"
+  | "display:info"
+  | "display:warning"
+  | "display:error"
   // date picker components
   | "date_component:day"
   | "date_component:month"
   | "date_component:year"
   // other
+  | "action:allow_copy" // adds clipboard to input field
+  | "action:allow_unreplace" // adds reveal button for passwords
+  | "action:allow_password_compromise_check" // adds check if password is breached
   | "action:client_upload"
+  | "action:hash" // creates hash containing specified information
   | "action:require_webauthn"
+  | `action:generate_pepper:` // generates a pepper length 'n'
+  | `action:timeout:${number}` // for a lookup field. Signifies it should expire after 'n' seconds
   | "verify:show_if_pending"
   | "special:hide_select_behind_button"
   | "type:capture_geolocation" // triggers the wizard's GeoLocationInput field
@@ -43,6 +71,8 @@ export type SchemaTag =
   // action
   | "action:experimental_pass_object_store_id"
   | "action:verify"
+  | `action:display_qr_code:${/* either extract or verify */ string}:${/* when to display QR */ string}`
+  | `action:display_global_idv_app_qr_code:${/* either extract or verify */ string}`
   // camera
   | "default_camera:rear"
   | "default_camera:front"
@@ -52,12 +82,16 @@ export type SchemaTag =
   // misc
   | `time:${/* type */ string}:${/* seconds */ number}`
   | `link_to:${/* schemaName */ string}:${/* relationshipType */ string}`
+  | "display:default_view:edit" // links profile POcard direct to edit menu
+  // bot protection
+  | "support_challenge"
   // type
-  | "type:service_provider"
+  | "type:merchant"
   | "type:service_offer"
   | "type:marketplace"
   | "type:client_only"
-  | "type:globally_unique_field";
+  | "type:globally_unique_field"
+  | "type:application_object";
 
 export type SchemaField = {
   /** @deprecated don't use, it's inconsistent */
@@ -79,9 +113,9 @@ export type SchemaField = {
   step?: number;
   /** if true, the user must have encryption enabled to save this data, see #1324 */
   encrypt_require?: boolean;
-  /** @deprecated raytio's usage not documented */
+  /** for string inputs, the maximum character length. Also used to determine textarea rendering (maxLength > 30 renders a textarea) */
   maxLength?: number;
-  /** @deprecated raytio's usage not documented */
+  /** for string inputs, the minimum character length. Not currently used anywhere in the client */
   minLength?: number;
   /** the default value */
   default?: unknown;
@@ -91,6 +125,21 @@ export type SchemaField = {
   format?: "date" | "date-time" | "uri";
   contentMediaType?: string;
   contentEncoding?: "base64";
+  /**
+   * if this field is a foreign key, i.e. it is a primary key
+   * of a different schema, then that other's schema name should be listed here.
+   * e.g.
+   * ```json
+   * {
+   *   "name": "ss_AA",
+   *   "properties": {
+   *     "org_id": { "foreign_key_of": "ss_Org" }
+   *   }
+   * }
+   * ```
+   */
+  foreign_key_of?: SchemaName;
+
   /** `items` is used for nested arrays, (while `properties` is used for nested objects) */
   items?: {
     type: DataTypes;
@@ -122,15 +171,47 @@ export type SchemaField = {
   content?: string;
   /** URL to a JSON file in the `Lookup` format */
   lookup?: string;
+  /**
+   * Transforms the lookup response into the expected `{ key, value }[]` format.
+   * Use when the API returns data in a different structure.
+   *
+   * Simple format (extract array from path, use values as both key and value):
+   * ```json
+   * "lookupTransform": "[0].scopes"
+   * ```
+   *
+   * Object format (specify key/value mapping):
+   * ```json
+   * "lookupTransform": {
+   *   "path": "[0].items",
+   *   "key": "id",
+   *   "value": "name"
+   * }
+   * ```
+   */
+  lookupTransform?:
+    | string
+    | {
+        /** JSON path to extract the array (e.g., "[0].scopes", "data.items") */
+        path: string;
+        /** Property name to use as the lookup key (if omitted, uses the value itself) */
+        key?: string;
+        /** Property name to use as the lookup value (if omitted, uses the value itself) */
+        value?: string;
+      };
   /** @internal the client adds this - it's the fieldName. */
   $prop: string;
   priority?: number;
   /** @internal if supplied, it's the existing field values. Added by the client */
   subObjectRef?: unknown[];
-  /** specifies that the description is formatted in markdown */
+  /** @deprecated Markdown is now rendered by default for all descriptions. This property is no longer needed. */
   description_decorator?: "md";
   /** if a `pattern` is specified, this is the error message */
   patternMessage?: string;
+  /** the input string for a platform_unique_id */
+  hash_inputs?: string;
+  /** determines where an image is sourced from */
+  content_source?: string;
 
   override?: {
     permissions: {
@@ -163,12 +244,25 @@ export type SchemaField = {
 /** the only difference between the client & server's definition is that the client adds `$prop` */
 export type ServerSchemaField = Omit<SchemaField, "$prop">;
 
+/** An i18n entry from the fnd_i18n_entries API endpoint */
+export type FndI18nEntry = CommonFields<never> & {
+  i18n_key: string;
+  category: string;
+  translations: {
+    [locale: string]: {
+      title: string;
+      description?: string;
+      title_plural?: string;
+    };
+  };
+};
+
 /** not exported. Attributes that are identical in both client schema & server schema */
 export type CommonSchemaAttributes = {
   /** these fields will always exist on schema */
   title: string;
   description: string;
-  /** specifies that the description is formatted in markdown */
+  /** @deprecated Markdown is now rendered by default for all descriptions. This property is no longer needed. */
   description_decorator?: "md";
 
   schema_type?: SchemaType;
@@ -179,11 +273,22 @@ export type CommonSchemaAttributes = {
   /**
    * the group that a schema belongs to, such as "passports". This is useful for
    * forms that accept different types of similar documents.
+   * Can be a single group (string) or multiple groups (string[]) to allow a schema
+   * to appear in multiple lists.
    */
-  schema_group?: string;
+  schema_group?: string | string[];
+
+  /** Additional search terms to help users find schemas (e.g., ["license", "passport", "drivers license"]) */
+  search_terms?: string[];
 
   tags?: SchemaTag[];
 
+  /** if specified, suggests this onboarding scenario after creating a PO of this schema type */
+  suggest_post_create?: SchemaName;
+
+  /** Array of 2-character country codes that this schema is available for */
+  schema_country_codes?: string[];
+
   /* any overrides can be specfied per field or for the whole schema */
   i18n?: {
     [locale: string]: {
@@ -253,42 +358,154 @@ export type CommonSchemaAttributes = {
      * Array because there could be multiple expand groups
      */
     expand?: { fields: string[]; label: string }[];
-  };
 
-  /** only the schema used for the onboarding wizard have this property */
-  onboard_properties?: {
-    /** Profile Objects that should be created */
-    profile_objects?: {
-      schema_name: SchemaName;
-      properties: Record<string, unknown>;
-    }[];
+    /**
+     * By default, the admin dashboard shows columns for all fields
+     * in listed in `head_main`. In rare cases you can use this property
+     * to specify a different set of fields to show to admins by default.
+     */
+    tabular?: { fields: string[] };
 
-    /** Relationships that should be created */
-    relationships?: {
-      /** will normally look like `"{n_id:profile_objects[0]}"` */
-      from: string;
-      to: string;
-      type: string;
-      properties?: Record<string, string>;
-    }[];
+    /**
+     * determines if profile pages should display using compacted 'MiniPO'
+     * view or deafult view
+     */
+    compact_table?: boolean;
 
     /**
-     * Organizations that should be created. NOTE: if multiple are specified, when the wizard
-     * completes, the _first one_ will be selected
+     * Pre-defined filter presets provided by the schema author.
+     * These appear as "Default filters" in the admin table UI and
+     * cannot be deleted by users (unlike user-saved filters).
+     *
+     * Each token's `propertyKey` must match a key in `properties`.
+     * Valid operators: `=`, `!=`, `:`, `!:`, `>`, `<`, `>=`, `<=`
      */
-    organizations?: {
-      properties: Organization;
-      /** Access Applications that should be created for this org */
-      access_applications?: {
-        properties: Omit<AA, "org_id">;
-        /** Links that should be created for this AA */
-        links?: {
-          description: string;
-          wizardConfig: Omit<WizardConfig, "a_id">;
-        }[];
+    filters?: {
+      /** Display name for the filter preset */
+      name: string;
+      /** How tokens are combined: "and" = all must match, "or" = any must match */
+      operation: "and" | "or";
+      /** Filter conditions */
+      tokens: {
+        /** Must match a key in schema `properties` */
+        propertyKey: string;
+        /** Comparison operator */
+        operator: string;
+        /** Value to compare against */
+        value: string;
       }[];
     }[];
 
+    /** Kanban board configuration for admin dashboard */
+    kanban?: {
+      /** Field that determines which column a card belongs to */
+      column_field?: string;
+      /** Field displayed as the card title */
+      title_field?: string;
+      /** Additional fields displayed on each card */
+      card_fields?: string[];
+    };
+  };
+
+  /** only the schema used for the onboarding wizard have this property */
+  onboard_properties?: {
+    /**
+     * High-level actions for complex workflows.
+     * create_organization: Single object for creating one organization
+     * create_access_application_link: Array for creating multiple links
+     */
+    actions?: {
+      /** Creates a single organization. Use this instead of legacy 'organizations' array. */
+      create_organization?: Array<{
+        properties: Json;
+        store_as?: string; // alias used to reference the created organization
+      }>;
+      /** Creates access application links (can be multiple) */
+      create_access_application_link?: Array<{
+        properties: Record<string, unknown>;
+        store_as?: string;
+      }>;
+      /** Other actions can be defined as needed */
+      [key: string]: any;
+    };
+    /**
+     * Execution order for entity creation. If not specified, uses default order.
+     * Examples: ["actions.create_organization", "db.v1.xrm_merchants", "db.v1.dsm_nodes"]
+     */
+    execution_order?: string[];
+
+    /**
+     * Generic API endpoints organized by namespace and version.
+     *
+     * Structure: `{namespace}.{version}.{endpoint_name}` → `POST /{namespace}/{version}/{endpoint_name}`
+     *
+     * Examples:
+     * - `db.v1.xrm_merchants` → `POST /db/v1/xrm_merchants`
+     * - `db.v2.something` → `POST /db/v2/something`
+     * - `persist.v2.endpoint` → `POST /persist/v2/endpoint`
+     *
+     * Any namespace can be used. The `db` namespace is shown below as the primary example.
+     */
+    db?: {
+      v1?: {
+        /** Profile objects - POST /db/v1/dsm_nodes */
+        dsm_nodes?: Array<{
+          labels?: string[];
+          properties: Record<string, unknown>;
+          schema_name?: SchemaName;
+        }>;
+
+        /** Merchants - POST /db/v1/xrm_merchants */
+        xrm_merchants?: Array<Record<string, unknown>>;
+
+        /** Access Applications - POST /db/v1/dsm_access_applications */
+        dsm_access_applications?: Array<
+          Omit<AA, "org_id" | "a_id"> & {
+            org_id?: string;
+            links?: {
+              description: string;
+              wizardConfig: Omit<WizardConfig, "a_id">;
+            }[];
+          }
+        >;
+
+        /** Relationships - POST /db/v1/dsm_node_relationships */
+        dsm_node_relationships?: Array<{
+          from: string;
+          to: string;
+          type: string;
+          properties?: Record<string, unknown>;
+        }>;
+
+        /** Extensible for any other endpoint */
+        [endpoint: string]: Array<Record<string, unknown>> | undefined;
+      };
+      v2?: {
+        [endpoint: string]: Array<Record<string, unknown>> | undefined;
+      };
+      [version: string]:
+        | {
+            [endpoint: string]: Array<Record<string, unknown>> | undefined;
+          }
+        | undefined;
+    };
+    /**
+     * Additional namespaces can be added following the same structure as `db`.
+     * Example: persist?: { v2?: { [endpoint: string]: Array<Record<string, unknown>> } }
+     */
+    [namespace: string]:
+      | {
+          [version: string]:
+            | {
+                [endpoint: string]: Array<Record<string, unknown>> | undefined;
+              }
+            | undefined;
+        }
+      | object // for actions
+      | string[] // for execution_order
+      | string // for return_to
+      | undefined;
+
     /** The relative path in the client to redirect to once finished. May include variables */
     return_to?: string;
   };
@@ -305,6 +522,12 @@ export type Schema = CommonSchemaAttributes & {
   /** added by client */
   type?: DataTypes;
 
+  /**
+   * Schema-level conditional tags, pre-processed for runtime evaluation.
+   * When form values match the `if` condition, the tags are added to the schema.
+   */
+  conditionalTags?: ConditionalTags[];
+
   /** the localized title of the `schema_group`. added by the client */
   group_title?: string;
 
@@ -327,9 +550,52 @@ export type Schema = CommonSchemaAttributes & {
     [fieldName: string]: SchemaField;
   };
 
+  /**
+   * Some schema's represent data that is not stored as a profile object.
+   * In this case, this attribute defines what database table we need to use
+   * to fetch the corresponding data, and which field is the primary_key of that
+   * table (e.g. `id`, `o_id` etc.)
+   *
+   * The `path` property specifies the complete API path to use. If not provided,
+   * defaults to `/db/v1/{table}`. When `path` is specified, it is used directly
+   * without appending the table name.
+   * Examples:
+   * - `path: "/db/v1/rpc/my_function"` for RPC endpoints
+   * - `path: "/api/v2/custom_endpoint"` for custom API paths
+   *
+   * The optional `select` parameter supports PostgREST select syntax for nested
+   * objects/arrays. For example:
+   * `select: "id,item_id,gpm_items(id,item_key)"`
+   * This will return nested objects in the response.
+   */
+  database?: {
+    /** Table name (required when path is not specified to construct `/db/v1/{table}`) */
+    table?: string;
+    primary_key: string;
+    /** Complete API path. If specified, used directly instead of `/db/v1/{table}` */
+    path?: string;
+    select?: string;
+    /** Schema to redirect to after creating a record (for insert schemas) */
+    return_to?: SchemaName;
+    /** HTTP method override. If specified, uses this instead of the default (POST for create, PATCH for edit, DELETE for delete) */
+    method?: "POST" | "PATCH" | "DELETE";
+    /**
+     * PostgREST query parameters to include in requests.
+     * Supports variable substitution: {$context.organizationId}, {$context.userId}, {$context.tenantId}
+     * Example: "org_id=eq.{$context.organizationId}&active=eq.true"
+     * If this contains "select=", it takes precedence over the `select` property.
+     */
+    query_parameters?: string;
+  };
+
   /** the client adds this after processing the i18n property */
   groupNames?: Record<string, string>;
 
+  /** specifies the order in which groups should be displayed */
+  groups?: {
+    order?: string[];
+  };
+
   /** added by the client to inform downstream components which locale from schema.i18n was used */
   clientLocale?: string;
 
@@ -350,7 +616,7 @@ export type Schema = CommonSchemaAttributes & {
 };
 
 /** Type Classification of a Schema returned by API */
-export type SchemaType = "ss" | "ps" | "us";
+export type SchemaType = "ss" | "ps" | "us" | "ms";
 
 /** This is what's returned by the API */
 export type WrappedSchema = {
@@ -367,6 +633,10 @@ export type WrappedSchema = {
 
   /** whether the \`version\` is the latest version */
   version_current: boolean;
+
+  /** Country codes that this schema is available for */
+  schema_country_codes?: string[];
+
   schema: CommonSchemaAttributes & {
     /** @deprecated don't use this */
     $id?: string;

package/src/subscription.ts

@@ -0,0 +1,107 @@
+import type {
+  CId,
+  CommonFields,
+  PLId,
+  PLLId,
+  PMId,
+  PRCId,
+  PRid,
+  PTId,
+  SId,
+  SLId,
+} from "./raytio";
+
+export type PriceList = {
+  id: PLId;
+  price_list_type: string;
+  price_list_currency: string;
+  price_list_name: string;
+  price_list_name_i18n?: string;
+  price_list_description?: string;
+  price_list_description_i18n?: string;
+  pcm_price_list_versions?: [
+    {
+      id: string;
+      price_list_version_name: string;
+      pcm_price_list_lines: PriceListLine[];
+    },
+  ];
+};
+
+export type PriceListLine = {
+  id: PLLId;
+  pcm_prices: {
+    id: PRCId;
+    amount: number;
+    gpm_items: {
+      id: string; // not sure what this is
+      item_key: string;
+      item_name: string;
+      primary_uom: string;
+      item_name_i18n: string | null;
+      item_description: string;
+      item_description_i18n: string | null;
+    };
+    price_currency: string;
+    billing_recurrence: string;
+    recurring_billing_scheme: string;
+    recurring_billing_interval: string | null; // null if `billing_recurrence` is set to "ONCE"
+    recurring_billing_usage_type: string;
+    recurring_billing_interval_count: number;
+  };
+};
+
+export type Subscription = CommonFields<SId> & {
+  subscribed_to_customer_id: string;
+  subscribed_to_customer_site_id: string | null;
+  subscribed_to_party_contact_point_id: string;
+  billing_cycle_month: number | null;
+  billing_cycle_day_of_month: number | null;
+  billing_cycle_day_of_week: number | null;
+  billing_cycle_hour: number | null;
+  billing_cycle_minute: number | null;
+  billing_cycle_second: number | null;
+  subscription_timezone_offset_minutes: number | null;
+  subscription_name: string;
+  subscription_name_i18n: string | null;
+  current_billing_period_start: string;
+  current_billing_period_end: string | null;
+  cancellation_request_date: string | null;
+  cancellation_effective_date: string | null;
+  cancellation_request_reason: string | null;
+  cancellation_final_invoice_action: string;
+};
+
+export type SubscriptionLine = CommonFields<SLId> & {
+  billing_subscription_id: SId;
+  price_id: PRCId;
+  subscribed_qty: number;
+  metadata: string | null;
+};
+
+export type PaymentMethod = CommonFields<PMId> & {
+  customer_id: CId;
+  payer_payment_method_type: string;
+  primary_payment_method: boolean;
+  payment_processor_id: string;
+  payment_method_country_code: string | null;
+  payment_method_scheme: string;
+  payment_method_available_networks: string[] | string;
+  payment_method_preferred_network?: string | null;
+  card_expiry_month: number;
+  card_expiry_year: number;
+  card_funding_method: string;
+  card_last_4_digits: string;
+  card_fingerprint?: string | null;
+  payment_processor_payment_method_id: string;
+  address_line1_check?: string | null;
+  address_postal_code_check?: string | null;
+  cvc_check?: string | null;
+  three_d_secure_usage?: string | null;
+};
+
+export type PaymentProcessor = CommonFields<PTId> & {
+  party_id: PRid;
+  payment_processor_name: string;
+  payment_processor_system: string;
+};

package/src/tenant.ts

@@ -0,0 +1,7 @@
+import type { CommonFields, TNTId } from "./raytio";
+
+export type Tenant = CommonFields<TNTId> & {
+  tenant_name: string;
+  tenant_description: string | null;
+  tenant_domain_prefix: string | null;
+};

package/src/theme.ts

@@ -22,6 +22,10 @@ export type Colors = {
   feelingHugged: string;
   silverShell: string;
   blank: string;
+  altColoursBgLight: string;
+  altColoursBgMedium: string;
+  elevatedSurface: string;
+  fillNeutral: string;
 };
 
 export type CustomFonts = { header?: string; body?: string };