@raytio/types 8.2.0 → 8.3.0

package/README.md

@@ -993,7 +993,7 @@ ___
 
 ### Schema
 
-Ƭ **Schema**: [`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`  } ; `end_date?`: `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))[] ; `start_date?`: `string` ; `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` ; `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 +1056,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: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: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"``
 
 ___
 
@@ -1348,6 +1348,10 @@ This is what's returned by the API
 | :------ | :------ | :------ |
 | `active` | ``true`` | - |
 | `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. |
+| `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`[]  } | - |
 | `schema_country_codes?` | `string`[] | Country codes that this schema is available for |
 | `schema_name` | [`SchemaName`](#schemaname) | Schema Name Type and Version Properties |

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: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: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 */
@@ -419,7 +419,7 @@ export type CommonSchemaAttributes = {
  * Raytio's variant of JSON Schema, as used by the client. It is a modified version
  * of what the API returns.
  */
-export type Schema = CommonSchemaAttributes & {
+export type Schema = CommonFields<never> & CommonSchemaAttributes & {
     /** added by the client, copied from {@link WrappedSchema} */
     name: SchemaName;
     /** added by client */
@@ -437,10 +437,6 @@ export type Schema = CommonSchemaAttributes & {
     required?: (string | ConditionallyRequired)[];
     /** added by client */
     wasExpandedByClient?: boolean;
-    /** ISO Date. Copied from {@link WrappedSchema} */
-    start_date?: string;
-    /** ISO Date. Copied from {@link WrappedSchema} If this tag exists, the schema is deprecated */
-    end_date?: string;
     /** 🚨 Note that there are cases where properties are undefined, e.g. if the schema is a sub-object */
     properties: {
         [fieldName: string]: SchemaField;
@@ -511,6 +507,9 @@ export type WrappedSchema = {
     start_date: string;
     /** ISO Date. If this tag exists, the schema is deprecated. */
     end_date: string;
+    /** CommonFields row metadata — the polymorphic entity this schema maps to. */
+    resource_group?: string;
+    resource_name?: string;
     /** Schema Name Type and Version Properties */
     schema_name: SchemaName;
     schema_type: SchemaType;
@@ -519,6 +518,10 @@ export type WrappedSchema = {
     version_current: boolean;
     /** Country codes that this schema is available for */
     schema_country_codes?: string[];
+    /** Base schema to extend (same tenant). NULL = not an extension. */
+    extends_schema_name?: SchemaName | null;
+    /** Pin to specific base schema version. NULL = use version_current. */
+    extends_schema_version?: string | null;
     schema: CommonSchemaAttributes & {
         /** @deprecated don't use this */
         $id?: string;

package/package.json

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

package/src/schema.ts

@@ -44,6 +44,8 @@ export type SchemaFieldTag =
   | `display:replace:('${string}', '${string}')`
   | "display:terms_conditions"
   | `display:main_media:${string}` // property name to determine what image to display
+  // render the field value as markdown in Cloudscape detail views (#1902)
+  | "display:markdown"
   // content block variants (see ContentBlockField)
   | "display:content-block"
   | "display:info"
@@ -516,105 +518,101 @@ export type CommonSchemaAttributes = {
  * Raytio's variant of JSON Schema, as used by the client. It is a modified version
  * of what the API returns.
  */
-export type Schema = CommonSchemaAttributes & {
-  /** added by the client, copied from {@link WrappedSchema} */
-  name: SchemaName;
+export type Schema = CommonFields<never> &
+  CommonSchemaAttributes & {
+    /** added by the client, copied from {@link WrappedSchema} */
+    name: SchemaName;
 
-  /** 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[];
+    /** added by client */
+    type?: DataTypes;
 
-  /** the localized title of the `schema_group`. added by the client */
-  group_title?: string;
+    /**
+     * 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[];
 
-  /** originally `string[]`, the client modifies this */
-  verified_fields?: (string | ConditionallyRequired)[];
+    /** the localized title of the `schema_group`. added by the client */
+    group_title?: string;
 
-  /** originally `string[]`, the client modifies this */
-  required?: (string | ConditionallyRequired)[];
+    /** originally `string[]`, the client modifies this */
+    verified_fields?: (string | ConditionallyRequired)[];
 
-  /** added by client */
-  wasExpandedByClient?: boolean;
+    /** originally `string[]`, the client modifies this */
+    required?: (string | ConditionallyRequired)[];
 
-  /** ISO Date. Copied from {@link WrappedSchema} */
-  start_date?: string;
-  /** ISO Date. Copied from {@link WrappedSchema} If this tag exists, the schema is deprecated */
-  end_date?: string;
+    /** added by client */
+    wasExpandedByClient?: boolean;
 
-  /** 🚨 Note that there are cases where properties are undefined, e.g. if the schema is a sub-object */
-  properties: {
-    [fieldName: string]: SchemaField;
-  };
+    /** 🚨 Note that there are cases where properties are undefined, e.g. if the schema is a sub-object */
+    properties: {
+      [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.
+     * 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.
      */
-    query_parameters?: string;
-  };
+    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>;
+    /** 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[];
-  };
+    /** 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;
+    /** added by the client to inform downstream components which locale from schema.i18n was used */
+    clientLocale?: string;
 
-  /** added by the client, copied from {@link WrappedSchema} */
-  version: string;
+    /** added by the client, copied from {@link WrappedSchema} */
+    version: string;
 
-  /**
-   * the estimated loading times in seconds for various API calls. The client adds
-   * this field after processing the schema tags.
-   */
-  timing?: Record<"extract" | "live_person" | "verify_pending_delay", number>;
+    /**
+     * the estimated loading times in seconds for various API calls. The client adds
+     * this field after processing the schema tags.
+     */
+    timing?: Record<"extract" | "live_person" | "verify_pending_delay", number>;
 
-  /** added by the client. If true, this should be shown to the client */
-  isProfileSchema?: boolean;
+    /** added by the client. If true, this should be shown to the client */
+    isProfileSchema?: boolean;
 
-  /** added by the client. If true, this schema somehow relates to legacy service providers */
-  isSpSchema?: boolean;
-};
+    /** added by the client. If true, this schema somehow relates to legacy service providers */
+    isSpSchema?: boolean;
+  };
 
 /** Type Classification of a Schema returned by API */
 export type SchemaType = "ss" | "ps" | "us" | "ms";
@@ -627,6 +625,10 @@ export type WrappedSchema = {
   /** ISO Date. If this tag exists, the schema is deprecated. */
   end_date: string;
 
+  /** CommonFields row metadata — the polymorphic entity this schema maps to. */
+  resource_group?: string;
+  resource_name?: string;
+
   /** Schema Name Type and Version Properties */
   schema_name: SchemaName;
   schema_type: SchemaType;
@@ -638,6 +640,11 @@ export type WrappedSchema = {
   /** Country codes that this schema is available for */
   schema_country_codes?: string[];
 
+  /** Base schema to extend (same tenant). NULL = not an extension. */
+  extends_schema_name?: SchemaName | null;
+  /** Pin to specific base schema version. NULL = use version_current. */
+  extends_schema_version?: string | null;
+
   schema: CommonSchemaAttributes & {
     /** @deprecated don't use this */
     $id?: string;