@raytio/types 8.3.0 → 8.3.1

package/README.md

@@ -346,7 +346,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?`: { `card_fields?`: `string`[] ; `column_field?`: `string` ; `title_field?`: `string`  } ; `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: `=`, `!=`, `:`, `!:`, `>`, `<`, `>=`, `<=` |
@@ -362,6 +362,7 @@ not exported. Attributes that are identical in both client schema & server schem
 | `display.kanban.title_field?` | `string` | Field displayed as the card title |
 | `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 |
@@ -1056,7 +1057,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"``
 
 ___
 

package/dist/schema.d.ts

@@ -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 */
@@ -319,6 +319,58 @@ export type CommonSchemaAttributes = {
                 value: 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 admin dashboard */
         kanban?: {
             /** Field that determines which column a card belongs to */

package/package.json

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

package/src/schema.ts

@@ -36,6 +36,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"
@@ -399,6 +407,50 @@ export type CommonSchemaAttributes = {
       }[];
     }[];
 
+    /**
+     * 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 admin dashboard */
     kanban?: {
       /** Field that determines which column a card belongs to */