@raytio/types 8.3.0 → 8.3.2

package/README.md

@@ -70,6 +70,7 @@ Hovering over the type in VSCode will display documentation and available proper
 - [InstanceNodeKey](#instancenodekey)
 - [InstanceWithoutData](#instancewithoutdata)
 - [KId](#kid)
+- [KanbanBoard](#kanbanboard)
 - [LId](#lid)
 - [LOCId](#locid)
 - [Link](#link)
@@ -346,7 +347,7 @@ not exported. Attributes that are identical in both client schema & server schem
 | :------ | :------ | :------ |
 | `description` | `string` | - |
 | `description_decorator?` | ``"md"`` | **`Deprecated`** Markdown is now rendered by default for all descriptions. This property is no longer needed. |
-| `display?` | { `compact_table?`: `boolean` ; `expand?`: { `fields`: `string`[] ; `label`: `string`  }[] ; `filters?`: { `name`: `string` ; `operation`: ``"and"`` \| ``"or"`` ; `tokens`: { `operator`: `string` ; `propertyKey`: `string` ; `value`: `string`  }[]  }[] ; `head_main?`: { `fields`: `string`[] ; `format?`: `string`  } ; `head_sub?`: { `fields`: `string`[] ; `format?`: `string`  } ; `kanban?`: { `card_fields?`: `string`[] ; `column_field?`: `string` ; `title_field?`: `string`  } ; `tabular?`: { `fields`: `string`[]  }  } | - |
+| `display?` | { `compact_table?`: `boolean` ; `expand?`: { `fields`: `string`[] ; `label`: `string`  }[] ; `filters?`: { `name`: `string` ; `operation`: ``"and"`` \| ``"or"`` ; `tokens`: { `operator`: `string` ; `propertyKey`: `string` ; `value`: `string`  }[]  }[] ; `head_main?`: { `fields`: `string`[] ; `format?`: `string`  } ; `head_sub?`: { `fields`: `string`[] ; `format?`: `string`  } ; `kanban?`: [`KanbanBoard`](#kanbanboard) \| [`KanbanBoard`](#kanbanboard)[] ; `tabular?`: { `fields`: `string`[]  } ; `views?`: { `columnPrefs?`: { `id`: `string` ; `visible`: `boolean`  }[] ; `contentDensity?`: ``"comfortable"`` \| ``"compact"`` ; `filter?`: { `operation`: ``"and"`` \| ``"or"`` ; `tokens`: { `operator`: `string` ; `propertyKey`: `string` ; `value`: `string`  }[]  } ; `name`: `string` ; `pageSize?`: `number` ; `sorting?`: { `isDescending`: `boolean` ; `sortingColumn`: `string`  } \| ``null`` ; `stickyColumns?`: { `first`: `number` ; `last`: `number`  } ; `stripedRows?`: `boolean` ; `wrapLines?`: `boolean`  }[]  } | - |
 | `display.compact_table?` | `boolean` | determines if profile pages should display using compacted 'MiniPO' view or deafult view |
 | `display.expand?` | { `fields`: `string`[] ; `label`: `string`  }[] | list of fields that should not be shown by default, unless you expand a collpase section which has a name from the label property. Array because there could be multiple expand groups |
 | `display.filters?` | { `name`: `string` ; `operation`: ``"and"`` \| ``"or"`` ; `tokens`: { `operator`: `string` ; `propertyKey`: `string` ; `value`: `string`  }[]  }[] | 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: `=`, `!=`, `:`, `!:`, `>`, `<`, `>=`, `<=` |
@@ -356,12 +357,10 @@ not exported. Attributes that are identical in both client schema & server schem
 | `display.head_sub?` | { `fields`: `string`[] ; `format?`: `string`  } | list of fields to be considered the subheader of the PO fields joined with a space unless `format` format string is supplied |
 | `display.head_sub.fields` | `string`[] | - |
 | `display.head_sub.format?` | `string` | - |
-| `display.kanban?` | { `card_fields?`: `string`[] ; `column_field?`: `string` ; `title_field?`: `string`  } | Kanban board configuration for admin dashboard |
-| `display.kanban.card_fields?` | `string`[] | Additional fields displayed on each card |
-| `display.kanban.column_field?` | `string` | Field that determines which column a card belongs to |
-| `display.kanban.title_field?` | `string` | Field displayed as the card title |
+| `display.kanban?` | [`KanbanBoard`](#kanbanboard) \| [`KanbanBoard`](#kanbanboard)[] | Kanban board configuration for the admin dashboard. Either a single board (legacy form) or an array of named boards. See packages/client/docs/layout-hierarchy-guide.md § Kanban Board Layout. |
 | `display.tabular?` | { `fields`: `string`[]  } | 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. |
 | `display.tabular.fields` | `string`[] | - |
+| `display.views?` | { `columnPrefs?`: { `id`: `string` ; `visible`: `boolean`  }[] ; `contentDensity?`: ``"comfortable"`` \| ``"compact"`` ; `filter?`: { `operation`: ``"and"`` \| ``"or"`` ; `tokens`: { `operator`: `string` ; `propertyKey`: `string` ; `value`: `string`  }[]  } ; `name`: `string` ; `pageSize?`: `number` ; `sorting?`: { `isDescending`: `boolean` ; `sortingColumn`: `string`  } \| ``null`` ; `stickyColumns?`: { `first`: `number` ; `last`: `number`  } ; `stripedRows?`: `boolean` ; `wrapLines?`: `boolean`  }[] | Pre-defined view presets provided by the schema author. A view bundles filter, sorting, column visibility/order, and display settings (page size, density, etc.) into a named configuration. These appear as "Default views" in the admin table UI and cannot be deleted by users (unlike user-saved views). Every field except `name` is optional. When applied, fields the view does not specify leave the user's current preference untouched. This lets a schema author define partial views (e.g. just sorting + columns). |
 | `i18n?` | { `[locale: string]`: { `[fieldNameOrGroupName: string]`: [`ServerSchemaField`](#serverschemafield) & { `title_plural?`: `string`  }; `$loading_create_sub_obj`: { `title`: `string`  } ; `$loading_delete_pending_ver`: { `title`: `string`  } ; `$loading_extract`: { `title`: `string`  } ; `$loading_link_to_person`: { `title`: `string`  } ; `$loading_long_verification_message`: { `description?`: `string` ; `title?`: `string`  } ; `$loading_pending_ver_resubmit`: { `title`: `string`  } ; `$loading_permission`: { `title`: `string`  } ; `$loading_save`: { `title`: `string`  } ; `$loading_update`: { `title`: `string`  } ; `$loading_upload`: { `title`: `string`  } ; `$loading_verify`: { `title`: `string`  } ; `$schema`: { `description?`: `string` ; `title`: `string` ; `title_plural?`: `string`  }  };  } | - |
 | `onboard_properties?` | { `[namespace: string]`: { `[version: string]`: { `[endpoint: string]`: `Record`<`string`, `unknown`\>[] \| `undefined`;  } \| `undefined`;  } \| `object` \| `string`[] \| `string` \| `undefined`; `actions?`: { `[key: string]`: `any`; `create_access_application_link?`: { `properties`: `Record`<`string`, `unknown`\> ; `store_as?`: `string`  }[] ; `create_organization?`: { `properties`: `Json` ; `store_as?`: `string`  }[]  } ; `db?`: { `[version: string]`: { `[endpoint: string]`: `Record`<`string`, `unknown`\>[] \| `undefined`;  } \| `undefined`; `v1?`: { `[endpoint: string]`: `Record`<`string`, `unknown`\>[] \| `undefined`; `dsm_access_applications?`: `Omit`<[`AA`](#aa), ``"org_id"`` \| ``"a_id"``\> & { `links?`: { `description`: `string` ; `wizardConfig`: `Omit`<[`WizardConfig`](#wizardconfig), ``"a_id"``\>  }[] ; `org_id?`: `string`  }[] ; `dsm_node_relationships?`: { `from`: `string` ; `properties?`: `Record`<`string`, `unknown`\> ; `to`: `string` ; `type`: `string`  }[] ; `dsm_nodes?`: { `labels?`: `string`[] ; `properties`: `Record`<`string`, `unknown`\> ; `schema_name?`: [`SchemaName`](#schemaname)  }[] ; `xrm_merchants?`: `Record`<`string`, `unknown`\>[]  } ; `v2?`: { `[endpoint: string]`: `Record`<`string`, `unknown`\>[] \| `undefined`;  }  } ; `execution_order?`: `string`[] ; `return_to?`: `string`  } | only the schema used for the onboarding wizard have this property |
 | `onboard_properties.actions?` | { `[key: string]`: `any`; `create_access_application_link?`: { `properties`: `Record`<`string`, `unknown`\> ; `store_as?`: `string`  }[] ; `create_organization?`: { `properties`: `Json` ; `store_as?`: `string`  }[]  } | High-level actions for complex workflows. create_organization: Single object for creating one organization create_access_application_link: Array for creating multiple links |
@@ -577,6 +576,25 @@ A `k_id` (also called a `aack_id` or a `publicKeyId`) is the ID of an AA's publi
 
 ___
 
+### KanbanBoard
+
+Ƭ **KanbanBoard**: `Object`
+
+Configuration for a single named kanban board.
+
+#### Type declaration
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `card_fields?` | `string`[] | Additional fields displayed on each card. |
+| `column_field?` | `string` | Field that determines which column a card belongs to. |
+| `column_field_sort?` | ``"ascending"`` \| ``"descending"`` | Default ordering of the columns themselves, by their distinct `column_field` values. |
+| `kanban_name?` | `string` | Human-readable board name shown in the board selector; should be unique within the schema. |
+| `title_field?` | `string` | Field displayed as the card title. |
+| `y_field?` | `string` | Name of a numeric record field used to order cards vertically within a column. Optional. See packages/client/docs/layout-hierarchy-guide.md § Kanban Board Layout. |
+
+___
+
 ### LId
 
 Ƭ **LId**: `StringWithIdentity`<``"LId"``\>
@@ -636,7 +654,7 @@ ___
 | `image_src?` | `string` | Icon source in format `icon:{AntDesignIconName}` (e.g., `icon:CameraOutlined`) |
 | `key` | `string` \| `number` | - |
 | `label?` | `string` \| `number` | Used in Antd Cascader |
-| `lookup_group?` | `string` | Group heading for dropdown lists (e.g., "APAC", "EMEA"). NULL = ungrouped. |
+| `lookup_group?` | `string` | Group heading for dropdown lists (e.g., "APAC", "EMEA"). NULL = ungrouped. Translated client-side via the `lookup_group` entries in `fnd_i18n_entries` (see `LookupGroupLabel`). |
 | `requires_2FA?` | `boolean` | used in AkahuDynamicSection only |
 | `value` | `string` \| `number` | - |
 
@@ -993,7 +1011,7 @@ ___
 
 ### Schema
 
-Ƭ **Schema**: [`CommonFields`](#commonfields)<`never`\> & [`CommonSchemaAttributes`](#commonschemaattributes) & { `clientLocale?`: `string` ; `conditionalTags?`: [`ConditionalTags`](#conditionaltags)[] ; `database?`: { `method?`: ``"POST"`` \| ``"PATCH"`` \| ``"DELETE"`` ; `path?`: `string` ; `primary_key`: `string` ; `query_parameters?`: `string` ; `return_to?`: [`SchemaName`](#schemaname) ; `select?`: `string` ; `table?`: `string`  } ; `groupNames?`: `Record`<`string`, `string`\> ; `group_title?`: `string` ; `groups?`: { `order?`: `string`[]  } ; `isProfileSchema?`: `boolean` ; `isSpSchema?`: `boolean` ; `name`: [`SchemaName`](#schemaname) ; `properties`: { `[fieldName: string]`: [`SchemaField`](#schemafield);  } ; `required?`: (`string` \| [`ConditionallyRequired`](#conditionallyrequired))[] ; `timing?`: `Record`<``"extract"`` \| ``"live_person"`` \| ``"verify_pending_delay"``, `number`\> ; `type?`: [`DataTypes`](#datatypes) ; `verified_fields?`: (`string` \| [`ConditionallyRequired`](#conditionallyrequired))[] ; `version`: `string` ; `wasExpandedByClient?`: `boolean`  }
+Ƭ **Schema**: [`CommonFields`](#commonfields)<`never`\> & [`CommonSchemaAttributes`](#commonschemaattributes) & { `clientLocale?`: `string` ; `conditionalTags?`: [`ConditionalTags`](#conditionaltags)[] ; `database?`: { `method?`: ``"POST"`` \| ``"PATCH"`` \| ``"DELETE"`` ; `path?`: `string` ; `primary_key`: `string` ; `query_parameters?`: `string` ; `return_to?`: [`SchemaName`](#schemaname) ; `select?`: `string` ; `table?`: `string`  } ; `groupNames?`: `Record`<`string`, `string`\> ; `group_title?`: `string` ; `groups?`: { `order?`: `string`[]  } ; `isProfileSchema?`: `boolean` ; `isSpSchema?`: `boolean` ; `merchant_id?`: [`MId`](#mid) ; `name`: [`SchemaName`](#schemaname) ; `properties`: { `[fieldName: string]`: [`SchemaField`](#schemafield);  } ; `required?`: (`string` \| [`ConditionallyRequired`](#conditionallyrequired))[] ; `timing?`: `Record`<``"extract"`` \| ``"live_person"`` \| ``"verify_pending_delay"``, `number`\> ; `type?`: [`DataTypes`](#datatypes) ; `verified_fields?`: (`string` \| [`ConditionallyRequired`](#conditionallyrequired))[] ; `version`: `string` ; `wasExpandedByClient?`: `boolean`  }
 
 Raytio's variant of JSON Schema, as used by the client. It is a modified version
 of what the API returns.
@@ -1056,7 +1074,7 @@ ___
 
 ### SchemaFieldTag
 
-Ƭ **SchemaFieldTag**: ``"password"`` \| \`group:${string}\` \| \`upload-group:${string}\` \| ``"display:stars"`` \| ``"display:no_autofill"`` \| ``"display:currency"`` \| ``"display:cascade"`` \| ``"display:survey"`` \| ``"display:quoting"`` \| ``"display:customModal"`` \| ``"display:mask"`` \| \`display:replace:('${string}', '${string}')\` \| ``"display:terms_conditions"`` \| \`display:main\_media:${string}\` \| ``"display:markdown"`` \| ``"display:content-block"`` \| ``"display:info"`` \| ``"display:warning"`` \| ``"display:error"`` \| ``"date_component:day"`` \| ``"date_component:month"`` \| ``"date_component:year"`` \| ``"action:allow_copy"`` \| ``"action:allow_unreplace"`` \| ``"action:allow_password_compromise_check"`` \| ``"action:client_upload"`` \| ``"action:hash"`` \| ``"action:require_webauthn"`` \| ``"action:generate_pepper:"`` \| \`action:timeout:${number}\` \| \`action:server-search:${string}\` \| ``"verify:show_if_pending"`` \| ``"special:hide_select_behind_button"`` \| ``"type:capture_geolocation"`` \| ``"type:extract_required"``
+Ƭ **SchemaFieldTag**: ``"password"`` \| \`group:${string}\` \| \`upload-group:${string}\` \| ``"display:stars"`` \| ``"display:no_autofill"`` \| ``"display:currency"`` \| \`display:currency:${string}\` \| ``"display:checkbox"`` \| ``"display:radio"`` \| ``"display:cascade"`` \| ``"display:survey"`` \| ``"display:quoting"`` \| ``"display:customModal"`` \| ``"display:mask"`` \| \`display:replace:('${string}', '${string}')\` \| ``"display:terms_conditions"`` \| \`display:main\_media:${string}\` \| ``"display:markdown"`` \| ``"display:content-block"`` \| ``"display:info"`` \| ``"display:warning"`` \| ``"display:error"`` \| ``"date_component:day"`` \| ``"date_component:month"`` \| ``"date_component:year"`` \| ``"action:allow_copy"`` \| ``"action:allow_unreplace"`` \| ``"action:allow_password_compromise_check"`` \| ``"action:client_upload"`` \| ``"action:hash"`` \| ``"action:require_webauthn"`` \| ``"action:generate_pepper:"`` \| \`action:timeout:${number}\` \| \`action:server-search:${string}\` \| ``"verify:show_if_pending"`` \| ``"special:hide_select_behind_button"`` \| ``"type:capture_geolocation"`` \| ``"type:extract_required"``
 
 ___
 
@@ -1350,6 +1368,7 @@ This is what's returned by the API
 | `end_date` | `string` | ISO Date. If this tag exists, the schema is deprecated. |
 | `extends_schema_name?` | [`SchemaName`](#schemaname) \| ``null`` | Base schema to extend (same tenant). NULL = not an extension. |
 | `extends_schema_version?` | `string` \| ``null`` | Pin to specific base schema version. NULL = use version_current. |
+| `merchant_id?` | [`MId`](#mid) | The merchant this schema belongs to. Always present for merchant-type (`ms`) schemas; absent for all other schema types. |
 | `resource_group?` | `string` | CommonFields row metadata — the polymorphic entity this schema maps to. |
 | `resource_name?` | `string` | - |
 | `schema` | [`CommonSchemaAttributes`](#commonschemaattributes) & { `$id?`: `string` ; `$schema?`: `string` ; `allOf?`: { `$ref?`: `string` ; `if?`: `Partial`<[`WrappedSchema`](#wrappedschema)[``"schema"``]\> ; `then?`: `Partial`<[`WrappedSchema`](#wrappedschema)[``"schema"``]\>  }[] ; `definitions?`: `Record`<`string`, { `$ref`: [`Urn`](#urn)  }\> ; `properties`: { `[fieldName: string]`: [`ServerSchemaField`](#serverschemafield);  } ; `required?`: `string`[] ; `verified_fields?`: `string`[]  } | - |

package/dist/raytio.d.ts

@@ -161,7 +161,11 @@ export type Lookup = {
     requires_2FA?: boolean;
     /** Sort order within a lookup set. NULL = unordered. */
     display_order?: number;
-    /** Group heading for dropdown lists (e.g., "APAC", "EMEA"). NULL = ungrouped. */
+    /**
+     * Group heading for dropdown lists (e.g., "APAC", "EMEA"). NULL = ungrouped.
+     * Translated client-side via the `lookup_group` entries in
+     * `fnd_i18n_entries` (see `LookupGroupLabel`).
+     */
     lookup_group?: string;
 };
 export type AATag = "type:client_only" | "type:share_with_new_user" | "Merchant";

package/dist/schema.d.ts

@@ -1,4 +1,4 @@
-import type { AA, CommonFields, DataTypes, Json, SchemaName, Urn } from "./raytio";
+import type { AA, CommonFields, DataTypes, Json, MId, SchemaName, Urn } from "./raytio";
 import type { WizardConfig } from "./wizard";
 /** should be renamed since this applies to ConditionallyVerifiable */
 export type ConditionallyRequired = {
@@ -14,7 +14,7 @@ export type ConditionalTags = {
         [fieldName: string]: (string | number | boolean)[];
     };
 };
-export type SchemaFieldTag = "password" | `group:${string}` | `upload-group:${string}` | "display:stars" | "display:no_autofill" | "display:currency" | "display:cascade" | "display:survey" | "display:quoting" | "display:customModal" | "display:mask" | `display:replace:('${string}', '${string}')` | "display:terms_conditions" | `display:main_media:${string}` | "display:markdown" | "display:content-block" | "display:info" | "display:warning" | "display:error" | "date_component:day" | "date_component:month" | "date_component:year" | "action:allow_copy" | "action:allow_unreplace" | "action:allow_password_compromise_check" | "action:client_upload" | "action:hash" | "action:require_webauthn" | `action:generate_pepper:` | `action:timeout:${number}` | `action:server-search:${string}` | "verify:show_if_pending" | "special:hide_select_behind_button" | "type:capture_geolocation" | "type:extract_required";
+export type SchemaFieldTag = "password" | `group:${string}` | `upload-group:${string}` | "display:stars" | "display:no_autofill" | "display:currency" | `display:currency:${string}` | "display:checkbox" | "display:radio" | "display:cascade" | "display:survey" | "display:quoting" | "display:customModal" | "display:mask" | `display:replace:('${string}', '${string}')` | "display:terms_conditions" | `display:main_media:${string}` | "display:markdown" | "display:content-block" | "display:info" | "display:warning" | "display:error" | "date_component:day" | "date_component:month" | "date_component:year" | "action:allow_copy" | "action:allow_unreplace" | "action:allow_password_compromise_check" | "action:client_upload" | "action:hash" | "action:require_webauthn" | `action:generate_pepper:` | `action:timeout:${number}` | `action:server-search:${string}` | "verify:show_if_pending" | "special:hide_select_behind_button" | "type:capture_geolocation" | "type:extract_required";
 export type SchemaTag = "action:experimental_pass_object_store_id" | "action:verify" | `action:display_qr_code:${string}:${string}` | `action:display_global_idv_app_qr_code:${string}` | "default_camera:rear" | "default_camera:front" | `oauth2_component:name:${string}` | `oauth2_component:redirect_url:${string}` | `time:${string}:${number}` | `link_to:${string}:${string}` | "display:default_view:edit" | "support_challenge" | "type:merchant" | "type:service_offer" | "type:marketplace" | "type:client_only" | "type:globally_unique_field" | "type:application_object";
 export type SchemaField = {
     /** @deprecated don't use, it's inconsistent */
@@ -169,6 +169,25 @@ export type FndI18nEntry = CommonFields<never> & {
         };
     };
 };
+/** Configuration for a single named kanban board. */
+export type KanbanBoard = {
+    /** Human-readable board name shown in the board selector; should be unique within the schema. */
+    kanban_name?: string;
+    /** Field that determines which column a card belongs to. */
+    column_field?: string;
+    /** Default ordering of the columns themselves, by their distinct `column_field` values. */
+    column_field_sort?: "ascending" | "descending";
+    /** Field displayed as the card title. */
+    title_field?: string;
+    /**
+     * Name of a numeric record field used to order cards vertically within
+     * a column. Optional. See
+     * packages/client/docs/layout-hierarchy-guide.md § Kanban Board Layout.
+     */
+    y_field?: string;
+    /** Additional fields displayed on each card. */
+    card_fields?: string[];
+};
 /** not exported. Attributes that are identical in both client schema & server schema */
 export type CommonSchemaAttributes = {
     /** these fields will always exist on schema */
@@ -319,15 +338,64 @@ export type CommonSchemaAttributes = {
                 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[];
-        };
+        /**
+         * Pre-defined view presets provided by the schema author.
+         * A view bundles filter, sorting, column visibility/order, and display
+         * settings (page size, density, etc.) into a named configuration.
+         * These appear as "Default views" in the admin table UI and cannot be
+         * deleted by users (unlike user-saved views).
+         *
+         * Every field except `name` is optional. When applied, fields the view
+         * does not specify leave the user's current preference untouched. This
+         * lets a schema author define partial views (e.g. just sorting + columns).
+         */
+        views?: {
+            /** Display name for the view preset */
+            name: string;
+            /** Filter to apply (PropertyFilter tokens + operation) */
+            filter?: {
+                /** 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;
+                }[];
+            };
+            /** Server-side sorting state, or `null` to explicitly clear sorting */
+            sorting?: {
+                sortingColumn: string;
+                isDescending: boolean;
+            } | null;
+            /** Column visibility + order. `id` must match a key in `properties`. */
+            columnPrefs?: {
+                id: string;
+                visible: boolean;
+            }[];
+            /** Page size (rows per page) */
+            pageSize?: number;
+            /** Whether to wrap cell content onto multiple lines */
+            wrapLines?: boolean;
+            /** Whether alternating rows are striped */
+            stripedRows?: boolean;
+            /** Density of the table content */
+            contentDensity?: "comfortable" | "compact";
+            /** Number of sticky columns pinned to the start/end of the table */
+            stickyColumns?: {
+                first: number;
+                last: number;
+            };
+        }[];
+        /**
+         * Kanban board configuration for the admin dashboard. Either a single
+         * board (legacy form) or an array of named boards. See
+         * packages/client/docs/layout-hierarchy-guide.md § Kanban Board Layout.
+         */
+        kanban?: KanbanBoard | KanbanBoard[];
     };
     /** only the schema used for the onboarding wizard have this property */
     onboard_properties?: {
@@ -422,6 +490,8 @@ export type CommonSchemaAttributes = {
 export type Schema = CommonFields<never> & CommonSchemaAttributes & {
     /** added by the client, copied from {@link WrappedSchema} */
     name: SchemaName;
+    /** added by the client, copied from {@link WrappedSchema}. Only set for `ms` schemas. */
+    merchant_id?: MId;
     /** added by client */
     type?: DataTypes;
     /**
@@ -514,6 +584,11 @@ export type WrappedSchema = {
     schema_name: SchemaName;
     schema_type: SchemaType;
     schema_version: string;
+    /**
+     * The merchant this schema belongs to. Always present for merchant-type
+     * (`ms`) schemas; absent for all other schema types.
+     */
+    merchant_id?: MId;
     /** whether the \`version\` is the latest version */
     version_current: boolean;
     /** Country codes that this schema is available for */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@raytio/types",
-  "version": "8.3.0",
+  "version": "8.3.2",
   "license": "MIT",
   "main": "index",
   "types": "index",

package/src/raytio.ts

@@ -210,7 +210,11 @@ export type Lookup = {
 
   /** Sort order within a lookup set. NULL = unordered. */
   display_order?: number;
-  /** Group heading for dropdown lists (e.g., "APAC", "EMEA"). NULL = ungrouped. */
+  /**
+   * Group heading for dropdown lists (e.g., "APAC", "EMEA"). NULL = ungrouped.
+   * Translated client-side via the `lookup_group` entries in
+   * `fnd_i18n_entries` (see `LookupGroupLabel`).
+   */
   lookup_group?: string;
 };
 

package/src/schema.ts

@@ -3,6 +3,7 @@ import type {
   CommonFields,
   DataTypes,
   Json,
+  MId,
   SchemaName,
   Urn,
 } from "./raytio";
@@ -36,6 +37,14 @@ export type SchemaFieldTag =
   | "display:stars"
   | "display:no_autofill"
   | "display:currency"
+  // currency with an explicit ISO 4217 code, e.g. `display:currency:usd`.
+  // The code is case-insensitive; a malformed code falls back to the bare behaviour.
+  | `display:currency:${string}`
+  // renders a fixed-option (enum) multi-select array as a checkbox group
+  | "display:checkbox"
+  // forces radio rendering for string + (enum|lookup) fields regardless of
+  // list size; the automatic ≤ 7 behaviour is handled by the rules directly
+  | "display:radio"
   | "display:cascade"
   | "display:survey"
   | "display:quoting"
@@ -260,6 +269,26 @@ export type FndI18nEntry = CommonFields<never> & {
   };
 };
 
+/** Configuration for a single named kanban board. */
+export type KanbanBoard = {
+  /** Human-readable board name shown in the board selector; should be unique within the schema. */
+  kanban_name?: string;
+  /** Field that determines which column a card belongs to. */
+  column_field?: string;
+  /** Default ordering of the columns themselves, by their distinct `column_field` values. */
+  column_field_sort?: "ascending" | "descending";
+  /** Field displayed as the card title. */
+  title_field?: string;
+  /**
+   * Name of a numeric record field used to order cards vertically within
+   * a column. Optional. See
+   * packages/client/docs/layout-hierarchy-guide.md § Kanban Board Layout.
+   */
+  y_field?: string;
+  /** Additional fields displayed on each card. */
+  card_fields?: string[];
+};
+
 /** not exported. Attributes that are identical in both client schema & server schema */
 export type CommonSchemaAttributes = {
   /** these fields will always exist on schema */
@@ -399,15 +428,56 @@ export type CommonSchemaAttributes = {
       }[];
     }[];
 
-    /** 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[];
-    };
+    /**
+     * Pre-defined view presets provided by the schema author.
+     * A view bundles filter, sorting, column visibility/order, and display
+     * settings (page size, density, etc.) into a named configuration.
+     * These appear as "Default views" in the admin table UI and cannot be
+     * deleted by users (unlike user-saved views).
+     *
+     * Every field except `name` is optional. When applied, fields the view
+     * does not specify leave the user's current preference untouched. This
+     * lets a schema author define partial views (e.g. just sorting + columns).
+     */
+    views?: {
+      /** Display name for the view preset */
+      name: string;
+      /** Filter to apply (PropertyFilter tokens + operation) */
+      filter?: {
+        /** 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;
+        }[];
+      };
+      /** Server-side sorting state, or `null` to explicitly clear sorting */
+      sorting?: { sortingColumn: string; isDescending: boolean } | null;
+      /** Column visibility + order. `id` must match a key in `properties`. */
+      columnPrefs?: { id: string; visible: boolean }[];
+      /** Page size (rows per page) */
+      pageSize?: number;
+      /** Whether to wrap cell content onto multiple lines */
+      wrapLines?: boolean;
+      /** Whether alternating rows are striped */
+      stripedRows?: boolean;
+      /** Density of the table content */
+      contentDensity?: "comfortable" | "compact";
+      /** Number of sticky columns pinned to the start/end of the table */
+      stickyColumns?: { first: number; last: number };
+    }[];
+
+    /**
+     * Kanban board configuration for the admin dashboard. Either a single
+     * board (legacy form) or an array of named boards. See
+     * packages/client/docs/layout-hierarchy-guide.md § Kanban Board Layout.
+     */
+    kanban?: KanbanBoard | KanbanBoard[];
   };
 
   /** only the schema used for the onboarding wizard have this property */
@@ -522,6 +592,8 @@ export type Schema = CommonFields<never> &
   CommonSchemaAttributes & {
     /** added by the client, copied from {@link WrappedSchema} */
     name: SchemaName;
+    /** added by the client, copied from {@link WrappedSchema}. Only set for `ms` schemas. */
+    merchant_id?: MId;
 
     /** added by client */
     type?: DataTypes;
@@ -633,6 +705,11 @@ export type WrappedSchema = {
   schema_name: SchemaName;
   schema_type: SchemaType;
   schema_version: string;
+  /**
+   * The merchant this schema belongs to. Always present for merchant-type
+   * (`ms`) schemas; absent for all other schema types.
+   */
+  merchant_id?: MId;
 
   /** whether the \`version\` is the latest version */
   version_current: boolean;