@raytio/types 5.2.1 → 6.0.0

package/README.md

@@ -33,6 +33,7 @@ Hovering over the type in VSCode will display documentation and available proper
 - [AId](#aid)
 - [Colors](#colors)
 - [ConditionallyRequired](#conditionallyrequired)
+- [CustomFonts](#customfonts)
 - [DataTypes](#datatypes)
 - [Encrypted](#encrypted)
 - [GId](#gid)
@@ -57,6 +58,7 @@ Hovering over the type in VSCode will display documentation and available proper
 - [UrnNodeType](#urnnodetype)
 - [Validation](#validation)
 - [Verification](#verification)
+- [VerificationPayload](#verificationpayload)
 - [VerificationProvider](#verificationprovider)
 - [WizardConfig](#wizardconfig)
 - [WizardPage](#wizardpage)
@@ -80,11 +82,13 @@ Hovering over the type in VSCode will display documentation and available proper
 | `org_id` | `string` | the id of the associated organisation |
 | `picture?` | [`Urn`](#urn) | - |
 | `picture_url?` | `string` | Easy to use AA logo url for pasting inot emails |
+| `ruleset?` | `unknown` | configuration for the submission rules |
 | `scopes?` | `string`[] | - |
 | `service_provider_n_id?` | [`NId`](#nid) | the n_id of the associated service provider |
 | `tags?` | `string`[] | - |
 | `theme?` | `Object` | - |
-| `theme.colors` | [`Colors`](#colors) | - |
+| `theme.colors?` | [`Colors`](#colors) | - |
+| `theme.font?` | [`CustomFonts`](#customfonts) | - |
 
 ___
 
@@ -145,6 +149,19 @@ should be renamed since this applies to ConditionallyVerifiable
 
 ___
 
+### CustomFonts
+
+Ƭ **CustomFonts**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `body?` | `string` |
+| `header?` | `string` |
+
+___
+
 ### DataTypes
 
 Ƭ **DataTypes**: ``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``
@@ -153,13 +170,13 @@ ___
 
 ### Encrypted
 
-Ƭ **Encrypted**<`Data`\>: `Object`
+Ƭ **Encrypted**<`_Data`\>: `Object`
 
 #### Type parameters
 
 | Name | Type |
 | :------ | :------ |
-| `Data` | `string` |
+| `_Data` | `string` |
 
 #### Type declaration
 
@@ -167,7 +184,7 @@ ___
 | :------ | :------ |
 | `encrypted_data` | `Object` |
 | `encrypted_data.algorithm` | `AesKeyAlgorithm` |
-| `encrypted_data.data` | `Data` |
+| `encrypted_data.data` | `string` |
 | `encrypted_data.iv` | `string` |
 | `encrypted_key` | `Object` |
 | `encrypted_key.encrypted_key` | `string` |
@@ -286,7 +303,7 @@ You can supply an option type argument if you know exactly what the properties w
 
 | Name | Type |
 | :------ | :------ |
-| `Properties` | `any` |
+| `Properties` | `Json` |
 
 #### Type declaration
 
@@ -331,7 +348,7 @@ This is what @raytio/core exposes, which is more useable than @see Verification
 | `nID` | [`NId`](#nid) | nId of the verification |
 | `provider` | [`VerificationProvider`](#verificationprovider) | - |
 | `signature` | `string` | - |
-| `value` | `string` \| `number` | - |
+| `value` | `unknown` | - |
 | `verified` | `boolean` | whether the `fieldName`/`value` pair is verified, as confirmed by the API. This should be the single source of truth. |
 | `xId` | `string` | this will be a unique id to group verifications from the same PO. Doesn't work yet |
 
@@ -380,6 +397,7 @@ Raytio's variant of JSON Schema. All props marked as optional except
 | `display.head_sub?` | `Object` | 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` | - |
+| `end_date?` | `string` | If this tag exists, the schema is deprecated. ISO Date. |
 | `group_title?` | `string` | the localized title of the `schema_group`. added by the client |
 | `i18n?` | `Object` | - |
 | `n_id?` | [`NId`](#nid) | - |
@@ -395,6 +413,7 @@ Raytio's variant of JSON Schema. All props marked as optional except
 | `schema_group?` | `string` | the group that a schema belongs to, such as "passports". This is useful for forms that accept different types of similar documents. |
 | `tags?` | [`SchemaTag`](#schematag)[] | - |
 | `title` | `string` | - |
+| `title_plural?` | `string` | plural version of the title |
 | `type?` | [`DataTypes`](#datatypes) | - |
 | `verified_fields?` | (`string` \| [`ConditionallyRequired`](#conditionallyrequired))[] | originally `string[]`, the client modifies this |
 | `wasExpandedByClient?` | `boolean` | - |
@@ -416,7 +435,7 @@ ___
 | `content?` | `string` | only checkbox uses this prop |
 | `contentEncoding?` | ``"base64"`` | - |
 | `contentMediaType?` | `string` | - |
-| `default?` | `unknown` | - |
+| `default?` | `unknown` | the default value |
 | `default_signature_name?` | `string` | used on fields that are a signature file picker, see !849 also used to determine if the MediaPicker should be shown inline |
 | `description?` | `string` | - |
 | `description_decorator?` | ``"md"`` | specifies that the description is formatted in markdown |
@@ -425,7 +444,7 @@ ___
 | `examples?` | `unknown`[] | - |
 | `format?` | ``"date"`` \| ``"date-time"`` | - |
 | `image_silhouette?` | `string` | If this schema requires a photo of a document, you can specify a URL to a silhouette image which will be overlaid on top of the camera. For best results, the image should have a transparent background + minimal white foreground |
-| `items?` | `Object` | for nested JSON |
+| `items?` | `Object` | `items` is used for nested arrays, (while `properties` is used for nested objects) |
 | `items.properties` | `Object` | - |
 | `items.type` | [`DataTypes`](#datatypes) | - |
 | `lookup?` | `string` | URL to a JSON file in the `Lookup` format |
@@ -439,22 +458,25 @@ ___
 | `pattern?` | `string` | - |
 | `patternMessage?` | `string` | if a `pattern` is specified, this is the error message |
 | `priority?` | `number` | - |
+| `properties?` | `Object` | `properties` is used for nested objects, (while `items` is used for nested arrays) |
 | `readOnly?` | `boolean` | readOnly means the Wizard won't show this field |
+| `table_empty_message?` | `string` | if this field is a table input, this determines the text to show if the table is empty |
 | `tags?` | [`SchemaFieldTag`](#schemafieldtag)[] | - |
 | `title?` | `string` | - |
+| `title_plural?` | `string` | - |
 | `type?` | [`DataTypes`](#datatypes) | - |
 
 ___
 
 ### SchemaFieldTag
 
-Ƭ **SchemaFieldTag**: ``"password"`` \| \`group:${string}\` \| \`upload-group:${string}\` \| ``"display:stars"`` \| ``"display:no_autofill"`` \| ``"display:currency"`` \| ``"display:cascade"`` \| ``"display:survey"`` \| ``"display:quoting"`` \| ``"display:customModal"`` \| ``"display:showOnWizard"`` \| \`display:main\_media:${string}\` \| ``"action:client_upload"`` \| ``"verify:show_if_pending"`` \| ``"special:hide_select_behind_button"`` \| ``"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:terms_conditions"`` \| ``"display:showOnWizard"`` \| \`display:main\_media:${string}\` \| ``"action:client_upload"`` \| ``"verify:show_if_pending"`` \| ``"special:hide_select_behind_button"`` \| ``"type:extract_required"``
 
 ___
 
 ### SchemaMetadata
 
-Ƭ **SchemaMetadata**: `Pick`<[`Schema`](#schema), ``"name"`` \| ``"title"`` \| ``"description"`` \| ``"schema_group"`` \| ``"i18n"`` \| ``"display"`` \| ``"clientLocale"`` \| ``"groupNames"`` \| ``"group_title"``\> & { `__typeof__`: ``"You cannot supply SchemaMetadata to a function that expects Schema"`` ; `isProfileSchema`: `boolean` ; `isSpSchema`: `boolean`  }
+Ƭ **SchemaMetadata**: `Pick`<[`Schema`](#schema), ``"name"`` \| ``"title"`` \| ``"description"`` \| ``"schema_group"`` \| ``"end_date"`` \| ``"i18n"`` \| ``"display"`` \| ``"tags"`` \| ``"clientLocale"`` \| ``"groupNames"`` \| ``"title_plural"`` \| ``"group_title"``\> & { `__typeof__`: ``"You cannot supply SchemaMetadata to a function that expects Schema"`` ; `isProfileSchema`: `boolean` ; `isSpSchema`: `boolean`  }
 
 Only certain properties from the schema
 
@@ -462,7 +484,7 @@ ___
 
 ### SchemaTag
 
-Ƭ **SchemaTag**: ``"action:experimental_pass_object_store_id"`` \| ``"action:verify"`` \| ``"default_camera:rear"`` \| ``"default_camera:front"`` \| ``"type:service_provider"`` \| ``"type:service_offer"`` \| ``"type:marketplace"`` \| ``"type:client_only"`` \| ``"type:globally_unique_field"``
+Ƭ **SchemaTag**: ``"action:experimental_pass_object_store_id"`` \| ``"action:verify"`` \| ``"default_camera:rear"`` \| ``"default_camera:front"`` \| \`link\_to:${string}:${string}\` \| ``"type:service_provider"`` \| ``"type:service_offer"`` \| ``"type:marketplace"`` \| ``"type:client_only"`` \| ``"type:globally_unique_field"``
 
 ___
 
@@ -526,6 +548,18 @@ the DataContext don't have the value.
 
 ___
 
+### VerificationPayload
+
+Ƭ **VerificationPayload**<`WithValue`\>: { `field`: `string` ; `metadata?`: `Record`<`string`, `unknown`\> ; `passed`: `boolean` ; `request_div`: `string` ; `schema?`: `string` ; `source`: `string` ; `source_hashed_n_id?`: [`NId`](#nid) ; `source_n_id?`: [`NId`](modules.md#nid) ; `type?`: ``null`` ; `v_id`: `string` ; `valid_until?`: `string` ; `verification_date`: `string` ; `verifier_div`: `string` ; `verifier_id?`: [`NId`](modules.md#nid) ; `verifier_service_id?`: [`NId`](modules.md#nid) ; `verifier_source_id?`: [`NId`](modules.md#nid)  } & `WithValue` extends ``true`` ? { `value`: `string` \| `number`  } : {}
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `WithValue` | extends `boolean` |
+
+___
+
 ### VerificationProvider
 
 Ƭ **VerificationProvider**: `Object`
@@ -559,7 +593,7 @@ in the query parameters, it needs to be base64 and/or url encoded.
 | `emails?` | `string`[] | if specified, the email addresses that a submission should be sent to |
 | `expiry_date?` | `number` | number of days in the future |
 | `pages` | [`WizardPage`](#wizardpage)[] | - |
-| `quick_onboard?` | `boolean` | whether the "quick onboard" process should be used if the user visits this form, and they are not logged in. If false, the standard sign-up process will be used |
+| `quick_onboard?` | `boolean` | whether the passwordless-signup process should be used if the user visits this form, and they are not logged in. If false, the standard sign-up process will be used |
 | `reference?` | `string` | - |
 | `relationships?` | { `from`: `string` ; `properties?`: `Record`<`string`, `any`\> ; `to`: `string` ; `type`: `string`  }[] | a list of relationships that should be created after the wizard completes (see #987) |
 | `return_to?` | `string` | the callback url to redirect to once complete. Must be in the AA's list of authorized callback urls |
@@ -585,9 +619,13 @@ configuration data for a single wizard page (@see WizardConfig)
 | :------ | :------ | :------ |
 | `allow_upload?` | `boolean` | do not allow uploading in ImageDynamicSection if this is explictly false |
 | `create_new_text?` | `string` | custom text to display on the Create New button |
-| `description?` | `string` | - |
+| `description?` | `string` | the fallback description, if there isn't one for the specific situation |
+| `description_create?` | `string` | - |
+| `description_select?` | `string` | - |
+| `description_update?` | `string` | - |
 | `display_field_description?` | `boolean` | whether the field descriptions should be shown |
 | `display_field_title?` | `boolean` | whether the field titles should be shown |
+| `display_mode?` | ``"light"`` \| ``"dark"`` \| ``"default"`` | can you force the colour theme to change for just one page (#1066, #1074). At the moment this on pages that use WebcamImageCapture |
 | `display_schema_description?` | `boolean` | whether the schema description should be shown |
 | `extract_threshold?` | `number` | for ImageDynamicSection, the minimum score to be treated as a pass |
 | `extract_threshold_fail_action?` | ``"capture"`` \| ``"capture_review"`` \| ``"recapture_or_next_step"`` \| ``"review"`` \| ``"next_step"`` | for ImageDynamicSection, the action to take if pre-verify fails |
@@ -605,5 +643,5 @@ configuration data for a single wizard page (@see WizardConfig)
 | `schemas` | `string`[] | - |
 | `selection_hierarchy_json?` | `string` | a URL to a preset for configuing NestedSchemaSelect. @see DeepConfig |
 | `service_provider_link?` | `boolean` | see #463 |
-| `share?` | ``"profile"`` \| ``"verification"`` \| ``"both"`` | the infomation to share. undefined implies both. |
+| `share?` | ``"profile"`` \| ``"verification"`` \| ``"both"`` | the information to share. undefined implies both. |
 | `verify_data?` | `boolean` | if `false`, ProfileObjects created while completing the form will not be verified. `undefined` implies `true` |

package/dist/crypto.d.ts

@@ -1,10 +1,10 @@
-export declare type Encrypted<Data = string> = {
+export declare type Encrypted<_Data = string> = {
     encrypted_key: {
         encrypted_key: string;
     };
     encrypted_data: {
         iv: string;
-        data: Data;
+        data: string;
         algorithm: AesKeyAlgorithm;
     };
 };

package/dist/raytio.d.ts

@@ -1,9 +1,11 @@
 import { Encrypted } from "./crypto";
-import { Colors } from "./theme";
+import { Colors, CustomFonts } from "./theme";
 /** @internal see Microsoft/TypeScript#202 */
 export declare type StringWithIdentity<T> = string & {
     $$typeof$$: T;
 };
+/** @internal */
+declare type Json = Record<string, any>;
 /** A `p_id` is the ID of a @see Relationship */
 export declare type PId = StringWithIdentity<"PId">;
 /** An `i_id` is the ID of an @see Instance */
@@ -19,7 +21,7 @@ export declare type AId = StringWithIdentity<"AId">;
 export declare type DataTypes = "string" | "number" | "boolean" | "object" | "integer" | "array" | "null";
 export declare type SubmissionStatus = "Submitted" | "Processing" | "Rejected" | "Expired" | "Completed" | "DataChanged" | "Received" | "Accepted";
 /** You can supply an option type argument if you know exactly what the properties will be */
-export declare type ProfileObject<Properties = any> = {
+export declare type ProfileObject<Properties = Json> = {
     n_id: NId;
     properties: Properties;
     labels: string[];
@@ -29,10 +31,10 @@ export declare type ProfileObject<Properties = any> = {
      * @internal the client adds this, if this PO doesn't actually belong to the current user,
      * i.e. it's actually from a submission. If truthy, it's the `[aId, iId]` of the submission.
      */
-    isFromSubmission?: [aId: string, iId: string];
+    isFromSubmission?: [aId: AId, iId: IId];
 };
 /** @internal This is what we send the API */
-export declare type ProfileObjectForUpload<Properties = any> = {
+export declare type ProfileObjectForUpload<Properties = Json> = {
     properties: Properties;
     document?: {
         content?: string | Encrypted;
@@ -91,12 +93,15 @@ export declare type AA = {
     /** markdown or string help information including [phoneNumber || email] */
     aa_help?: string;
     theme?: {
-        colors: Colors;
+        font?: CustomFonts;
+        colors?: Colors;
     };
     /** the n_id of the associated service provider */
     service_provider_n_id?: NId;
     /** the id of the associated organisation */
     org_id: string;
+    /** configuration for the submission rules */
+    ruleset?: unknown;
     /** @internal */
     _transitions?: unknown[];
 };
@@ -174,3 +179,4 @@ export declare type Validation = {
         };
     };
 };
+export {};

package/dist/schema.d.ts

@@ -7,12 +7,13 @@ export declare type ConditionallyRequired = {
         [fieldName: string]: string[];
     };
 };
-export declare type SchemaFieldTag = "password" | `group:${string}` | `upload-group:${string}` | "display:stars" | "display:no_autofill" | "display:currency" | "display:cascade" | "display:survey" | "display:quoting" | "display:customModal" | "display:showOnWizard" | `display:main_media:${string}` | "action:client_upload" | "verify:show_if_pending" | "special:hide_select_behind_button" | "type:extract_required";
-export declare type SchemaTag = "action:experimental_pass_object_store_id" | "action:verify" | "default_camera:rear" | "default_camera:front" | "type:service_provider" | "type:service_offer" | "type:marketplace" | "type:client_only" | "type:globally_unique_field";
+export declare type SchemaFieldTag = "password" | `group:${string}` | `upload-group:${string}` | "display:stars" | "display:no_autofill" | "display:currency" | "display:cascade" | "display:survey" | "display:quoting" | "display:customModal" | "display:terms_conditions" | "display:showOnWizard" | `display:main_media:${string}` | "action:client_upload" | "verify:show_if_pending" | "special:hide_select_behind_button" | "type:extract_required";
+export declare type SchemaTag = "action:experimental_pass_object_store_id" | "action:verify" | "default_camera:rear" | "default_camera:front" | `link_to:${string}:${string}` | "type:service_provider" | "type:service_offer" | "type:marketplace" | "type:client_only" | "type:globally_unique_field";
 export declare type SchemaField = {
     /** @deprecated don't use, it's inconsistent */
     $id?: string;
     title?: string;
+    title_plural?: string;
     description?: string;
     /** readOnly means the Wizard won't show this field */
     readOnly?: boolean;
@@ -26,8 +27,7 @@ export declare type SchemaField = {
     maxLength?: number;
     /** @deprecated raytio's usage not documented */
     minLength?: number;
-    /** @internal added by the client. It's the default value based on the existing values from subschema on their profile */
-    defaultValue?: unknown;
+    /** the default value */
     default?: unknown;
     pattern?: string;
     /** whether the field should be encrypted */
@@ -35,13 +35,17 @@ export declare type SchemaField = {
     format?: "date" | "date-time";
     contentMediaType?: string;
     contentEncoding?: "base64";
-    /** for nested JSON */
+    /** `items` is used for nested arrays, (while `properties` is used for nested objects) */
     items?: {
         type: DataTypes;
         properties: {
             [subFieldName: string]: SchemaField;
         };
     };
+    /** `properties` is used for nested objects, (while `items` is used for nested arrays) */
+    properties?: {
+        [subFieldName: string]: SchemaField;
+    };
     /** If this field refers to a sub-object */
     $ref?: string;
     /**
@@ -61,10 +65,10 @@ export declare type SchemaField = {
     /** URL to a JSON file in the `Lookup` format */
     lookup?: string;
     /** @internal the client adds this - it's the fieldName. */
-    $prop?: string;
+    $prop: string;
     priority?: number;
     /** @internal if supplied, it's the existing field values. Added by the client */
-    subObjectRef?: (string | number)[];
+    subObjectRef?: unknown[];
     /** specifies that the description is formatted in markdown */
     description_decorator?: "md";
     /** if a `pattern` is specified, this is the error message */
@@ -80,6 +84,8 @@ export declare type SchemaField = {
     };
     /** if this field is a table input, this determines the text to show on the "Add Row" btn */
     add_row_btn_label?: string;
+    /** if this field is a table input, this determines the text to show if the table is empty */
+    table_empty_message?: string;
     /**
      * used on fields that are a signature file picker, see !849
      * also used to determine if the MediaPicker should be shown inline
@@ -105,6 +111,8 @@ export declare type Schema = {
     name: string;
     title: string;
     description: string;
+    /** plural version of the title */
+    title_plural?: string;
     /**
      * the group that a schema belongs to, such as "passports". This is useful for
      * forms that accept different types of similar documents.
@@ -129,6 +137,8 @@ export declare type Schema = {
         if?: Schema;
         then?: Schema;
     }[];
+    /** If this tag exists, the schema is deprecated. ISO Date. */
+    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;
@@ -166,7 +176,7 @@ export declare type Schema = {
             $loading_pending_ver_resubmit: {
                 title: string;
             };
-            [fieldNameOrGroupName: string]: SchemaField & {
+            [fieldNameOrGroupName: string]: Omit<SchemaField, "$prop"> & {
                 title_plural?: string;
             };
         };
@@ -266,7 +276,7 @@ export declare type Schema = {
     };
 };
 /** Only certain properties from the schema */
-export declare type SchemaMetadata = Pick<Schema, "name" | "title" | "description" | "schema_group" | "i18n" | "display" | "clientLocale" | "groupNames" | "group_title"> & {
+export declare type SchemaMetadata = Pick<Schema, "name" | "title" | "description" | "schema_group" | "end_date" | "i18n" | "display" | "tags" | "clientLocale" | "groupNames" | "title_plural" | "group_title"> & {
     /**
      * @deprecated this prop exists so that SchemaMetadata does not extend Schema.
      * use `getSchema(schemaName)` to fetch the full schema
@@ -275,3 +285,5 @@ export declare type SchemaMetadata = Pick<Schema, "name" | "title" | "descriptio
     isProfileSchema: boolean;
     isSpSchema: boolean;
 };
+/** @ignore */
+export declare type RelationDefinition = NonNullable<Schema["relationships"]>[number];

package/dist/theme.d.ts

@@ -24,3 +24,7 @@ export declare type Colors = {
     blankBackground: string;
     blank: string;
 };
+export declare type CustomFonts = {
+    header?: string;
+    body?: string;
+};

package/dist/verification.d.ts

@@ -1,4 +1,28 @@
 import { NId, ProfileObject } from "./raytio";
+export declare type VerificationPayload<WithValue extends boolean> = {
+    field: string;
+    schema?: string;
+    metadata?: Record<string, unknown>;
+    passed: boolean;
+    request_div: string;
+    /** @deprecated don't use this, it looks like the schema name but it's not */
+    source: string;
+    /** the n_id of the parent profile object that this ver belongs (NOT the n_id of the field) */
+    source_n_id?: NId;
+    /** like `source_n_id` */
+    source_hashed_n_id?: NId;
+    type?: null;
+    v_id: string;
+    verification_date: string;
+    verifier_id?: NId;
+    verifier_source_id?: NId;
+    verifier_service_id?: NId;
+    verifier_div: string;
+    /** ISO Date */
+    valid_until?: string;
+} & (WithValue extends true ? {
+    value: string | number;
+} : {});
 /**
  * Different APIs inconsistently include the `value` prop. If you know it exists,
  * use `Verification<true>`, otherwise just `Verification`. Verifications from
@@ -16,24 +40,7 @@ export declare type Verification<WithValue extends boolean = false> = ProfileObj
     verifications: [
         {
             signature: string;
-            data: {
-                field: string;
-                metadata?: Record<string, unknown>;
-                passed: boolean;
-                request_div: string;
-                /** @deprecated don't use this, it looks like the schema name but it's not */
-                source: string;
-                /** the n_id of the parent profile object that this ver belongs (NOT the n_id of the field) */
-                source_n_id: NId;
-                v_id: string;
-                verification_date: string;
-                verifier_id?: NId;
-                verifier_source_id?: NId;
-                verifier_service_id?: NId;
-                verifier_div: string;
-            } & (WithValue extends true ? {
-                value: string | number;
-            } : {});
+            data: VerificationPayload<WithValue>;
         }
     ];
 }>;
@@ -67,7 +74,7 @@ export declare type VerificationProvider = {
 /** This is what @raytio/core exposes, which is more useable than @see Verification */
 export declare type RealVer = {
     fieldName: string;
-    value: string | number;
+    value: unknown;
     provider: VerificationProvider;
     signature: string;
     /**

package/dist/verification.js

@@ -5,6 +5,8 @@ exports.POVerification = exports.FieldVerification = void 0;
  * "Not Verified" means show no badge, cf. "Verified False" means the
  * verifier revealed that the data was wrong. So show a ❌
  */
+// We cannot change the enum values, since ScoreRules have been generated
+// with the enum values hardcoded. The enum value are also used to find the "best" or "worst" verification (lower=better)
 var FieldVerification;
 (function (FieldVerification) {
     FieldVerification[FieldVerification["Verified"] = 60001] = "Verified";
@@ -12,6 +14,8 @@ var FieldVerification;
     FieldVerification[FieldVerification["VerifiedFalse"] = 60003] = "VerifiedFalse";
     FieldVerification[FieldVerification["Expired"] = 60004] = "Expired";
 })(FieldVerification = exports.FieldVerification || (exports.FieldVerification = {}));
+// We cannot change the enum values, since ScoreRules have been generated
+// with the enum values hardcoded.
 var POVerification;
 (function (POVerification) {
     POVerification[POVerification["FullyVerified"] = 70001] = "FullyVerified";

package/dist/wizard.d.ts

@@ -5,7 +5,11 @@ export declare type WizardPage = {
     name?: string | symbol;
     filter: "oneOf" | "anyOf";
     schemas: 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 */
     profile?: boolean;
     /** if true this page can be skipped. The PageResult wil be undefined */
@@ -43,8 +47,10 @@ export declare type WizardPage = {
     verify_data?: boolean;
     /** a list of fields that should not be required, even if the schema says they're required */
     optional_fields?: string[];
-    /** the infomation to share. undefined implies both. */
+    /** the information to share. undefined implies both. */
     share?: "profile" | "verification" | "both";
+    /** can you force the colour theme to change for just one page (#1066, #1074). At the moment this on pages that use WebcamImageCapture */
+    display_mode?: "light" | "dark" | "default";
 };
 /**
  * when a form link is generated, this is what gets saved on the API.
@@ -77,7 +83,7 @@ export declare type WizardConfig = {
     /** if specified, the email addresses that a submission should be sent to */
     emails?: string[];
     /**
-     * whether the "quick onboard" process should be used if the user visits
+     * whether the passwordless-signup process should be used if the user visits
      * this form, and they are not logged in. If false, the standard sign-up
      * process will be used
      */

package/package.json

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

package/src/crypto.ts

@@ -1,10 +1,11 @@
-export type Encrypted<Data = string> = {
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export type Encrypted<_Data = string> = {
   encrypted_key: {
     encrypted_key: string;
   };
   encrypted_data: {
     iv: string;
-    data: Data;
+    data: string;
     algorithm: AesKeyAlgorithm;
   };
 };

package/src/raytio.ts

@@ -1,9 +1,12 @@
 import { Encrypted } from "./crypto";
-import { Colors } from "./theme";
+import { Colors, CustomFonts } from "./theme";
 
 /** @internal see Microsoft/TypeScript#202 */
 export type StringWithIdentity<T> = string & { $$typeof$$: T };
 
+/** @internal */
+type Json = Record<string, any>; // TODO: (semver breaking) unknown
+
 /** A `p_id` is the ID of a @see Relationship */
 export type PId = StringWithIdentity<"PId">;
 /** An `i_id` is the ID of an @see Instance */
@@ -37,7 +40,7 @@ export type SubmissionStatus =
   | "Accepted";
 
 /** You can supply an option type argument if you know exactly what the properties will be */
-export type ProfileObject<Properties = any> = {
+export type ProfileObject<Properties = Json> = {
   n_id: NId;
   properties: Properties;
   labels: string[];
@@ -47,11 +50,11 @@ export type ProfileObject<Properties = any> = {
    * @internal the client adds this, if this PO doesn't actually belong to the current user,
    * i.e. it's actually from a submission. If truthy, it's the `[aId, iId]` of the submission.
    */
-  isFromSubmission?: [aId: string, iId: string]; // TODO: do NOT use nominal types here, see microsoft/TypeScript#42773
+  isFromSubmission?: [aId: AId, iId: IId];
 };
 
 /** @internal This is what we send the API */
-export type ProfileObjectForUpload<Properties = any> = {
+export type ProfileObjectForUpload<Properties = Json> = {
   properties: Properties;
   document?: {
     content?: string | Encrypted;
@@ -125,12 +128,18 @@ export type AA = {
   /** markdown or string help information including [phoneNumber || email] */
   aa_help?: string;
   theme?: {
-    colors: Colors;
+    font?: CustomFonts;
+    colors?: Colors;
   };
   /** the n_id of the associated service provider */
   service_provider_n_id?: NId;
   /** the id of the associated organisation */
   org_id: string;
+
+  /** configuration for the submission rules */
+  // we know the type should be `ScoreConfig`, but we can't rely that it's valid, or the right version
+  ruleset?: unknown;
+
   /** @internal */
   _transitions?: unknown[];
 };

package/src/schema.ts

@@ -23,6 +23,7 @@ export type SchemaFieldTag =
   | "display:survey"
   | "display:quoting"
   | "display:customModal"
+  | "display:terms_conditions"
   | "display:showOnWizard" // added by #837, TODO: document
   | `display:main_media:${string}` // property name to determine what image to display
   // other
@@ -38,6 +39,8 @@ export type SchemaTag =
   // camera
   | "default_camera:rear"
   | "default_camera:front"
+  // misc
+  | `link_to:${/* schemaName */ string}:${/* relationshipType */ string}`
   // type
   | "type:service_provider"
   | "type:service_offer"
@@ -49,6 +52,7 @@ export type SchemaField = {
   /** @deprecated don't use, it's inconsistent */
   $id?: string;
   title?: string;
+  title_plural?: string;
   description?: string;
   /** readOnly means the Wizard won't show this field */
   readOnly?: boolean;
@@ -62,8 +66,7 @@ export type SchemaField = {
   maxLength?: number;
   /** @deprecated raytio's usage not documented */
   minLength?: number;
-  /** @internal added by the client. It's the default value based on the existing values from subschema on their profile */
-  defaultValue?: unknown;
+  /** the default value */
   default?: unknown;
   pattern?: string;
   /** whether the field should be encrypted */
@@ -71,13 +74,17 @@ export type SchemaField = {
   format?: "date" | "date-time";
   contentMediaType?: string;
   contentEncoding?: "base64";
-  /** for nested JSON */
+  /** `items` is used for nested arrays, (while `properties` is used for nested objects) */
   items?: {
     type: DataTypes;
     properties: {
       [subFieldName: string]: SchemaField;
     };
   };
+  /** `properties` is used for nested objects, (while `items` is used for nested arrays) */
+  properties?: {
+    [subFieldName: string]: SchemaField;
+  };
 
   /** If this field refers to a sub-object */
   $ref?: string;
@@ -99,10 +106,10 @@ export type SchemaField = {
   /** URL to a JSON file in the `Lookup` format */
   lookup?: string;
   /** @internal the client adds this - it's the fieldName. */
-  $prop?: string;
+  $prop: string;
   priority?: number;
   /** @internal if supplied, it's the existing field values. Added by the client */
-  subObjectRef?: (string | number)[]; //
+  subObjectRef?: unknown[];
   /** specifies that the description is formatted in markdown */
   description_decorator?: "md";
   /** if a `pattern` is specified, this is the error message */
@@ -119,6 +126,8 @@ export type SchemaField = {
   };
   /** if this field is a table input, this determines the text to show on the "Add Row" btn */
   add_row_btn_label?: string;
+  /** if this field is a table input, this determines the text to show if the table is empty */
+  table_empty_message?: string;
 
   /**
    * used on fields that are a signature file picker, see !849
@@ -149,6 +158,8 @@ export type Schema = {
   title: string;
   description: string;
 
+  /** plural version of the title */
+  title_plural?: string;
   /**
    * the group that a schema belongs to, such as "passports". This is useful for
    * forms that accept different types of similar documents.
@@ -177,6 +188,9 @@ export type Schema = {
     then?: Schema;
   }[];
 
+  /** If this tag exists, the schema is deprecated. ISO Date. */
+  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;
@@ -188,6 +202,7 @@ export type Schema = {
       // @ts-expect-error I don't understand what's wrong
       $schema: Schema;
       // not that for entries that start in "group:" or $loading_, only the title field will be used.
+      // ^ the exception is `group:{GROUP_NAME}:{SUB_GROUP}.field` which is used for the combined field title/desc
       // normal fields can specify any field attributes to override.
 
       // see !1796 for where these are used
@@ -202,7 +217,9 @@ export type Schema = {
       $loading_delete_pending_ver: { title: string };
       $loading_pending_ver_resubmit: { title: string };
 
-      [fieldNameOrGroupName: string]: SchemaField & { title_plural?: string };
+      [fieldNameOrGroupName: string]: Omit<SchemaField, "$prop"> & {
+        title_plural?: string;
+      };
     };
   };
   /** @internal the client adds this after processing the i18n property */
@@ -311,11 +328,14 @@ export type SchemaMetadata = Pick<
   | "title"
   | "description"
   | "schema_group"
+  | "end_date"
   | "i18n"
   | "display"
+  | "tags"
   // added by the client
   | "clientLocale"
   | "groupNames"
+  | "title_plural"
   | "group_title"
 > & {
   /**
@@ -327,3 +347,6 @@ export type SchemaMetadata = Pick<
   isProfileSchema: boolean;
   isSpSchema: boolean;
 };
+
+/** @ignore */
+export type RelationDefinition = NonNullable<Schema["relationships"]>[number];

package/src/theme.ts

@@ -24,3 +24,5 @@ export type Colors = {
   blankBackground: string;
   blank: string;
 };
+
+export type CustomFonts = { header?: string; body?: string };

package/src/verification.ts

@@ -1,5 +1,34 @@
 import { NId, ProfileObject } from "./raytio";
 
+export type VerificationPayload<WithValue extends boolean> = {
+  // we deliberately haven't defined 'sub'
+  field: string;
+  schema?: string;
+  metadata?: Record<string, unknown>;
+  passed: boolean;
+  request_div: string;
+  /** @deprecated don't use this, it looks like the schema name but it's not */
+  source: string;
+  /** the n_id of the parent profile object that this ver belongs (NOT the n_id of the field) */
+  source_n_id?: NId;
+  /** like `source_n_id` */
+  source_hashed_n_id?: NId;
+  type?: null;
+  v_id: string;
+  verification_date: string;
+  verifier_id?: NId;
+  verifier_source_id?: NId;
+  verifier_service_id?: NId;
+  verifier_div: string;
+  /** ISO Date */
+  valid_until?: string;
+  // we are disabling the eslint rule beacuse even tho `{}` acts illogically in typescript,
+  // in this case it's working as expected in the intersection type, see
+  // https://github.com/typescript-eslint/typescript-eslint/issues/2063#issuecomment-632833366
+  // and https://github.com/typescript-eslint/typescript-eslint/issues/2063#issuecomment-645510515
+  // eslint-disable-next-line @typescript-eslint/ban-types
+} & (WithValue extends true ? { value: string | number } : {});
+
 /**
  * Different APIs inconsistently include the `value` prop. If you know it exists,
  * use `Verification<true>`, otherwise just `Verification`. Verifications from
@@ -17,27 +46,7 @@ export type Verification<WithValue extends boolean = false> = ProfileObject<{
   verifications: [
     {
       signature: string;
-      data: {
-        field: string;
-        metadata?: Record<string, unknown>;
-        passed: boolean;
-        request_div: string;
-        /** @deprecated don't use this, it looks like the schema name but it's not */
-        source: string;
-        /** the n_id of the parent profile object that this ver belongs (NOT the n_id of the field) */
-        source_n_id: NId;
-        v_id: string;
-        verification_date: string;
-        verifier_id?: NId;
-        verifier_source_id?: NId;
-        verifier_service_id?: NId;
-        verifier_div: string;
-        // we are disabling the eslint rule beacuse even tho `{}` acts illogically in typescript,
-        // in this case it's working as expected in the intersection type, see
-        // https://github.com/typescript-eslint/typescript-eslint/issues/2063#issuecomment-632833366
-        // and https://github.com/typescript-eslint/typescript-eslint/issues/2063#issuecomment-645510515
-        // eslint-disable-next-line @typescript-eslint/ban-types
-      } & (WithValue extends true ? { value: string | number } : {});
+      data: VerificationPayload<WithValue>;
     },
   ];
 }>;
@@ -46,6 +55,8 @@ export type Verification<WithValue extends boolean = false> = ProfileObject<{
  * "Not Verified" means show no badge, cf. "Verified False" means the
  * verifier revealed that the data was wrong. So show a ❌
  */
+// We cannot change the enum values, since ScoreRules have been generated
+// with the enum values hardcoded. The enum value are also used to find the "best" or "worst" verification (lower=better)
 export enum FieldVerification {
   Verified = 60_001,
   NotVerified,
@@ -53,6 +64,8 @@ export enum FieldVerification {
   Expired,
 }
 
+// We cannot change the enum values, since ScoreRules have been generated
+// with the enum values hardcoded.
 export enum POVerification {
   FullyVerified = 70_001,
   PartiallyVerified,
@@ -75,7 +88,7 @@ export type VerificationProvider = {
 /** This is what @raytio/core exposes, which is more useable than @see Verification */
 export type RealVer = {
   fieldName: string;
-  value: string | number;
+  value: unknown;
   provider: VerificationProvider;
   signature: string;
   /**

package/src/wizard.ts

@@ -7,7 +7,12 @@ export type WizardPage = {
   filter: "oneOf" | "anyOf";
   schemas: 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 */
   profile?: boolean;
   /** if true this page can be skipped. The PageResult wil be undefined */
@@ -61,9 +66,12 @@ export type WizardPage = {
   /** a list of fields that should not be required, even if the schema says they're required */
   optional_fields?: string[];
 
-  /** the infomation to share. undefined implies both. */
+  /** the information to share. undefined implies both. */
   // TODO: 'profile' is not supported yet
   share?: "profile" | "verification" | "both";
+
+  /** can you force the colour theme to change for just one page (#1066, #1074). At the moment this on pages that use WebcamImageCapture */
+  display_mode?: "light" | "dark" | "default";
 };
 
 /**
@@ -107,7 +115,7 @@ export type WizardConfig = {
   emails?: string[];
 
   /**
-   * whether the "quick onboard" process should be used if the user visits
+   * whether the passwordless-signup process should be used if the user visits
    * this form, and they are not logged in. If false, the standard sign-up
    * process will be used
    */