@raytio/types 7.0.0 → 7.1.0

package/README.md

@@ -18,6 +18,10 @@ import type { Schema } from "@raytio/types";
 
 Hovering over the type in VSCode will display documentation and available properties.
 
+# Versioning
+
+⚠️ This package does not strictly follow semver, since every change to the type definitions is a breaking change.
+
 # Documentation
 
 ## Table of contents
@@ -27,11 +31,12 @@ Hovering over the type in VSCode will display documentation and available proper
 - [FieldVerification](enums/FieldVerification.md)
 - [POVerification](enums/POVerification.md)
 
-### Type aliases
+### Type Aliases
 
 - [AA](#aa)
-- [AATags](#aatags)
+- [AATag](#aatag)
 - [AId](#aid)
+- [AnyId](#anyid)
 - [Colors](#colors)
 - [CommonSchemaAttributes](#commonschemaattributes)
 - [ConditionallyRequired](#conditionallyrequired)
@@ -41,6 +46,7 @@ Hovering over the type in VSCode will display documentation and available proper
 - [GId](#gid)
 - [IId](#iid)
 - [Instance](#instance)
+- [LId](#lid)
 - [Lookup](#lookup)
 - [NId](#nid)
 - [OId](#oid)
@@ -68,9 +74,10 @@ Hovering over the type in VSCode will display documentation and available proper
 - [WebhookStatus](#webhookstatus)
 - [WizardConfig](#wizardconfig)
 - [WizardPage](#wizardpage)
+- [WizardPageTag](#wizardpagetag)
 - [WrappedSchema](#wrappedschema)
 
-## Type aliases
+## Type Aliases
 
 ### AA
 
@@ -81,7 +88,7 @@ Hovering over the type in VSCode will display documentation and available proper
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `a_id` | [`AId`](#aid) | - |
-| `aa_help?` | `string` | markdown or string help information including [phoneNumber || email] |
+| `aa_help?` | `string` | markdown or string help information including [phoneNumber \|\| email] |
 | `aa_introduction?` | `string` | If a user signs up while completing this form, this message will be sent in the sign up email. |
 | `auth_list_enabled?` | `boolean` | if true, only specific email addresses can submit the form |
 | `callback_uri?` | `string`[] | - |
@@ -93,16 +100,16 @@ Hovering over the type in VSCode will display documentation and available proper
 | `ruleset?` | `unknown` | configuration for the submission rules |
 | `scopes?` | `string`[] | - |
 | `service_provider_n_id?` | [`NId`](#nid) | the n_id of the associated service provider |
-| `tags?` | [`AATags`](#aatags)[] | - |
-| `theme?` | `Object` | - |
+| `tags?` | [`AATag`](#aatag)[] | - |
+| `theme?` | { `colors?`: [`Colors`](#colors) ; `font?`: [`CustomFonts`](modules.md#customfonts)  } | - |
 | `theme.colors?` | [`Colors`](#colors) | - |
 | `theme.font?` | [`CustomFonts`](#customfonts) | - |
 
 ___
 
-### AATags
+### AATag
 
-Ƭ **AATags**: ``"type:client_only"`` \| ``"type:share_with_new_user"`` \| \`related\_service\_provider:n\_id:${NId}\` \| ``"ServiceProvider"``
+Ƭ **AATag**: ``"type:client_only"`` \| ``"type:share_with_new_user"`` \| \`related\_service\_provider:n\_id:${NId}\` \| ``"ServiceProvider"``
 
 ___
 
@@ -110,7 +117,13 @@ ___
 
 Ƭ **AId**: `StringWithIdentity`<``"AId"``\>
 
-An `a_id` is the ID of an @see AA
+An `a_id` is the ID of an [AA](#aa)
+
+___
+
+### AnyId
+
+Ƭ **AnyId**: [`PId`](#pid) \| [`IId`](modules.md#iid) \| [`NId`](modules.md#nid) \| [`GId`](modules.md#gid) \| [`UId`](modules.md#uid) \| [`AId`](modules.md#aid) \| [`OId`](modules.md#oid) \| [`WId`](modules.md#wid)
 
 ___
 
@@ -158,22 +171,22 @@ not exported. Attributes that are identical in both client schema & server schem
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `description` | `string` | - |
-| `display?` | `Object` | - |
+| `display?` | { `expand?`: { `fields`: `string`[] ; `label`: `string`  }[] ; `head_main?`: { `fields`: `string`[] ; `format?`: `string`  } ; `head_sub?`: { `fields`: `string`[] ; `format?`: `string`  }  } | - |
 | `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.head_main?` | `Object` | list of fields to be considered the header/name of the PO fields joined with a space unless `format` format string is supplied |
+| `display.head_main?` | { `fields`: `string`[] ; `format?`: `string`  } | list of fields to be considered the header/name of the PO fields joined with a space unless `format` format string is supplied |
 | `display.head_main.fields` | `string`[] | - |
 | `display.head_main.format?` | `string` | - |
-| `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`[] ; `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` | - |
-| `i18n?` | `Object` | - |
+| `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_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`  }  };  } | - |
 | `name` | `string` | these fields will always exist on schema |
-| `onboard_properties?` | `Object` | only the schema used for the onboarding wizard have this property |
+| `onboard_properties?` | { `organizations?`: { `access_applications?`: { `links?`: { `description`: `string` ; `wizardConfig`: `Omit`<[`WizardConfig`](#wizardconfig), ``"a_id"``\>  }[] ; `properties`: `Omit`<[`AA`](modules.md#aa), ``"org_id"``\>  }[] ; `properties`: [`Organization`](modules.md#organization)  }[] ; `profile_objects?`: { `properties`: `Record`<`string`, `unknown`\> ; `schema_name`: `string`  }[] ; `relationships?`: { `from`: `string` ; `properties?`: `Record`<`string`, `string`\> ; `to`: `string` ; `type`: `string`  }[] ; `return_to?`: `string`  } | only the schema used for the onboarding wizard have this property |
 | `onboard_properties.organizations?` | { `access_applications?`: { `links?`: { `description`: `string` ; `wizardConfig`: `Omit`<[`WizardConfig`](#wizardconfig), ``"a_id"``\>  }[] ; `properties`: `Omit`<[`AA`](modules.md#aa), ``"org_id"``\>  }[] ; `properties`: [`Organization`](modules.md#organization)  }[] | Organizations that should be created. NOTE: if multiple are specified, when the wizard completes, the _first one_ will be selected |
 | `onboard_properties.profile_objects?` | { `properties`: `Record`<`string`, `unknown`\> ; `schema_name`: `string`  }[] | Profile Objects that should be created |
 | `onboard_properties.relationships?` | { `from`: `string` ; `properties?`: `Record`<`string`, `string`\> ; `to`: `string` ; `type`: `string`  }[] | Relationships that should be created |
 | `onboard_properties.return_to?` | `string` | The relative path in the client to redirect to once finished. May include variables |
-| `relationships?` | { `anyOf?`: `string`[] ; `direction`: ``"from"`` ; `multiple?`: `boolean` ; `oneOf?`: `string`[] ; `properties?`: { [fieldName: string]: [`SchemaField`](#schemafield);  } ; `relationship_name`: `string` ; `required?`: `string`[] ; `required_relationship?`: `boolean` ; `type`: `string`  }[] | - |
+| `relationships?` | { `anyOf?`: `string`[] ; `direction`: ``"from"`` ; `multiple?`: `boolean` ; `oneOf?`: `string`[] ; `properties?`: { `[fieldName: string]`: [`SchemaField`](#schemafield);  } ; `relationship_name`: `string` ; `required?`: `string`[] ; `required_relationship?`: `boolean` ; `type`: `string`  }[] | - |
 | `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` | - |
@@ -193,7 +206,7 @@ should be renamed since this applies to ConditionallyVerifiable
 | Name | Type |
 | :------ | :------ |
 | `field` | `string` |
-| `if` | `Object` |
+| `if` | { `[fieldName: string]`: (`string` \| `number` \| `boolean`)[];  } |
 
 ___
 
@@ -230,11 +243,11 @@ ___
 
 | Name | Type |
 | :------ | :------ |
-| `encrypted_data` | `Object` |
+| `encrypted_data` | { `algorithm`: `AesKeyAlgorithm` ; `data`: `string` ; `iv`: `string`  } |
 | `encrypted_data.algorithm` | `AesKeyAlgorithm` |
 | `encrypted_data.data` | `string` |
 | `encrypted_data.iv` | `string` |
-| `encrypted_key` | `Object` |
+| `encrypted_key` | { `encrypted_key`: `string`  } |
 | `encrypted_key.encrypted_key` | `string` |
 
 ___
@@ -251,7 +264,7 @@ ___
 
 Ƭ **IId**: `StringWithIdentity`<``"IId"``\>
 
-An `i_id` is the ID of an @see Instance
+An `i_id` is the ID of an [Instance](#instance)
 
 ___
 
@@ -263,14 +276,14 @@ ___
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `_state?` | [`SubmissionStatus`](#submissionstatus) | **`depreacted`** The status of a submission |
+| `_state?` | [`SubmissionStatus`](#submissionstatus) | **`Deprecated`** The status of a submission |
 | `a_id` | [`AId`](#aid) | ID of the access application this submission was made to |
 | `aa_name` | `string` | name of the access application this submission was made to |
 | `confirmation_code` | `string` | Code that validates information has been shared |
 | `data_provider_email` | `string` | Email of user who shared the data |
 | `end_date` | `string` | Latest date in which the shared information was available |
 | `i_id` | [`IId`](#iid) | Access application instance ID |
-| `keys` | `Object` | - |
+| `keys` | { `[nId: NId]`: { `[fieldName: string]`: { `data`: `string` ; `n_id`: [`NId`](#nid)  };  };  } | - |
 | `previous_state` | [`SubmissionStatus`](#submissionstatus) | Previous status of the shared information |
 | `profile_objects` | [`ProfileObject`](#profileobject)[] | data associated is access application's instance |
 | `reference` | `string` | reference provided by the user who shared the data |
@@ -284,6 +297,14 @@ ___
 
 ___
 
+### LId
+
+Ƭ **LId**: `StringWithIdentity`<``"LId"``\>
+
+An `l_id` is the ID of any data stored in the KV-Store
+
+___
+
 ### Lookup
 
 Ƭ **Lookup**: `Object`
@@ -305,7 +326,7 @@ ___
 
 Ƭ **NId**: `StringWithIdentity`<``"NId"``\>
 
-An `n_id` is the ID of a @see ProfileObject
+An `n_id` is the ID of a [ProfileObject](#profileobject)
 
 ___
 
@@ -313,7 +334,7 @@ ___
 
 Ƭ **OId**: `StringWithIdentity`<``"OId"``\>
 
-An `o_id` is the ID of an @see Organization
+An `o_id` is the ID of an [Organization](#organization)
 
 ___
 
@@ -328,7 +349,7 @@ NOTE: this is different to how the schema defines an Organization. **The schema
 
 | Name | Type |
 | :------ | :------ |
-| `address` | `Object` |
+| `address` | { `city`: `string` ; `country`: `string` ; `locationType`: `string` ; `region`: `string` ; `street1`: `string` ; `street2`: `string`  } |
 | `address.city` | `string` |
 | `address.country` | `string` |
 | `address.locationType` | `string` |
@@ -346,7 +367,7 @@ ___
 
 Ƭ **PId**: `StringWithIdentity`<``"PId"``\>
 
-A `p_id` is the ID of a @see Relationship
+A `p_id` is the ID of a [Relationship](#relationship)
 
 ___
 
@@ -374,17 +395,17 @@ ___
 
 ### Properties
 
-Ƭ **Properties**: `Object`
+Ƭ **Properties**: `Json`
 
 arbitrary key-values pairs stored on a Profile Object.
-May contain nested JSON and @see Encrypted properties.
+May contain nested JSON and [Encrypted](#encrypted) properties.
 
 There are some limits to field names: they cannot be called
 `__signature` nor can they include the character sequence `<=>`.
 
-#### Index signature
+**`Deprecated`**
 
-▪ [fieldName: `string`]: `any`
+- use Json
 
 ___
 
@@ -392,7 +413,7 @@ ___
 
 Ƭ **RealVer**: `Object`
 
-This is what @raytio/core exposes, which is more useable than @see Verification
+This is what @raytio/core exposes, which is more useable than [Verification](#verification)
 
 #### Type declaration
 
@@ -421,7 +442,7 @@ ___
 | :------ | :------ |
 | `end` | [`Urn`](#urn) |
 | `p_id` | [`PId`](#pid) |
-| `properties?` | `Object` |
+| `properties?` | { `[fieldName: string]`: `unknown`; `name?`: `string` ; `p_id`: [`PId`](#pid)  } |
 | `properties.name?` | `string` |
 | `properties.p_id` | [`PId`](#pid) |
 | `start` | [`Urn`](#urn) |
@@ -431,7 +452,7 @@ ___
 
 ### Schema
 
-Ƭ **Schema**: [`CommonSchemaAttributes`](#commonschemaattributes) & { `clientLocale?`: `string` ; `end_date?`: `string` ; `groupNames?`: `Record`<`string`, `string`\> ; `group_title?`: `string` ; `isProfileSchema?`: `boolean` ; `isSpSchema?`: `boolean` ; `properties`: { [fieldName: string]: [`SchemaField`](modules.md#schemafield);  } ; `required?`: (`string` \| [`ConditionallyRequired`](modules.md#conditionallyrequired))[] ; `start_date?`: `string` ; `timing?`: `Record`<``"extract"`` \| ``"live_person"`` \| ``"verify_pending_delay"``, `number`\> ; `verified_fields?`: (`string` \| [`ConditionallyRequired`](modules.md#conditionallyrequired))[] ; `version`: `string` ; `wasExpandedByClient?`: `boolean`  }
+Ƭ **Schema**: [`CommonSchemaAttributes`](#commonschemaattributes) & { `clientLocale?`: `string` ; `end_date?`: `string` ; `groupNames?`: `Record`<`string`, `string`\> ; `group_title?`: `string` ; `isProfileSchema?`: `boolean` ; `isSpSchema?`: `boolean` ; `properties`: { `[fieldName: string]`: [`SchemaField`](modules.md#schemafield);  } ; `required?`: (`string` \| [`ConditionallyRequired`](modules.md#conditionallyrequired))[] ; `start_date?`: `string` ; `timing?`: `Record`<``"extract"`` \| ``"live_person"`` \| ``"verify_pending_delay"``, `number`\> ; `verified_fields?`: (`string` \| [`ConditionallyRequired`](modules.md#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.
@@ -446,7 +467,7 @@ ___
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `$id?` | `string` | **`deprecated`** don't use, it's inconsistent |
+| `$id?` | `string` | **`Deprecated`** don't use, it's inconsistent |
 | `$ref?` | `string` | If this field refers to a sub-object |
 | `add_row_btn_label?` | `string` | if this field is a table input, this determines the text to show on the "Add Row" btn |
 | `allOf?` | [{ `$ref`: `string`  }, [`ServerSchemaField`](#serverschemafield)] | - |
@@ -458,26 +479,28 @@ ___
 | `description?` | `string` | - |
 | `description_decorator?` | ``"md"`` | specifies that the description is formatted in markdown |
 | `encrypt?` | `boolean` | whether the field should be encrypted |
+| `encrypt_require?` | `boolean` | if true, the user must have encryption enabled to save this data, see #1324 |
 | `enum?` | (`string` \| `number` \| `boolean`)[] | - |
 | `examples?` | `unknown`[] | - |
 | `format?` | ``"date"`` \| ``"date-time"`` \| ``"uri"`` | - |
 | `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` | `items` is used for nested arrays, (while `properties` is used for nested objects) |
-| `items.properties` | `Object` | - |
+| `items?` | { `properties`: { `[subFieldName: string]`: [`SchemaField`](#schemafield);  } ; `type`: [`DataTypes`](modules.md#datatypes)  } | `items` is used for nested arrays, (while `properties` is used for nested objects) |
+| `items.properties` | { `[subFieldName: string]`: [`SchemaField`](#schemafield);  } | - |
 | `items.type` | [`DataTypes`](#datatypes) | - |
 | `lookup?` | `string` | URL to a JSON file in the `Lookup` format |
-| `maxLength?` | `number` | **`deprecated`** raytio's usage not documented |
-| `maximum?` | `number` | - |
-| `minLength?` | `number` | **`deprecated`** raytio's usage not documented |
-| `minimum?` | `number` | - |
-| `override?` | `Object` | - |
-| `override.permissions` | `Object` | - |
+| `maxLength?` | `number` | **`Deprecated`** raytio's usage not documented |
+| `maximum?` | `number` | for number inputs, the maximum allowed value |
+| `minLength?` | `number` | **`Deprecated`** raytio's usage not documented |
+| `minimum?` | `number` | for number inputs, the minimum allowed value |
+| `override?` | { `permissions`: { `default`: `string`  }  } | - |
+| `override.permissions` | { `default`: `string`  } | - |
 | `override.permissions.default` | `string` | ideally this could be typed as `keyof typeof GROUPS` but the schemas aren't consistent and we have to assume it could be invalid. |
 | `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) |
+| `properties?` | { `[subFieldName: string]`: [`SchemaField`](#schemafield);  } | `properties` is used for nested objects, (while `items` is used for nested arrays) |
 | `readOnly?` | `boolean` | readOnly means the Wizard won't show this field |
+| `step?` | `number` | for number inputs, the step size used in the input or slider |
 | `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` | - |
@@ -488,13 +511,13 @@ ___
 
 ### SchemaFieldTag
 
-Ƭ **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:main\_media:${string}\` \| ``"date_component:day"`` \| ``"date_component:month"`` \| ``"date_component:year"`` \| ``"action:client_upload"`` \| ``"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:replace:'${string}':'${string}'\` \| ``"display:terms_conditions"`` \| \`display:main\_media:${string}\` \| ``"date_component:day"`` \| ``"date_component:month"`` \| ``"date_component:year"`` \| ``"action:client_upload"`` \| ``"verify:show_if_pending"`` \| ``"special:hide_select_behind_button"`` \| ``"type:capture_geolocation"`` \| ``"type:extract_required"``
 
 ___
 
 ### SchemaTag
 
-Ƭ **SchemaTag**: ``"action:experimental_pass_object_store_id"`` \| ``"action:verify"`` \| ``"default_camera:rear"`` \| ``"default_camera:front"`` \| \`oauth2\_component:name:${string}\` \| \`oauth2\_component:redirect\_url:${string}\` \| \`link\_to:${string}:${string}\` \| ``"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"`` \| \`oauth2\_component:name:${string}\` \| \`oauth2\_component:redirect\_url:${string}\` \| \`time:${string}:${number}\` \| \`link\_to:${string}:${string}\` \| ``"type:service_provider"`` \| ``"type:service_offer"`` \| ``"type:marketplace"`` \| ``"type:client_only"`` \| ``"type:globally_unique_field"``
 
 ___
 
@@ -522,7 +545,7 @@ ___
 
 ### Urn
 
-Ƭ **Urn**: \`urn:${UrnNodeType}:${string}\`
+Ƭ **Urn**: \`urn:${UrnNodeType}:${AnyId}\`
 
 e.g. "urn:user:..."
 
@@ -544,7 +567,7 @@ validation data returned by preVerify (part of the extract&map API)
 
 | Name | Type |
 | :------ | :------ |
-| `breakdown` | `Object` |
+| `breakdown` | { `[category: string]`: { `code?`: `number` ; `passed`: `boolean` ; `reason?`: `string` ; `severity?`: ``"low"`` \| ``"medium"`` \| ``"high"``  };  } |
 | `score` | `number` |
 | `warning?` | `string`[] |
 
@@ -552,7 +575,7 @@ ___
 
 ### Verification
 
-Ƭ **Verification**<`WithValue`\>: [`ProfileObject`](#profileobject)<`Object`\>
+Ƭ **Verification**<`WithValue`\>: [`ProfileObject`](#profileobject)<{ `field`: `string` ; `n_id`: [`NId`](modules.md#nid) ; `valid_until?`: `string` ; `verifications`: [{ `data`: [`VerificationPayload`](modules.md#verificationpayload)<`WithValue`\> ; `signature`: `string`  }]  }\>
 
 Different APIs inconsistently include the `value` prop. If you know it exists,
 use `Verification<true>`, otherwise just `Verification`. Verifications from
@@ -562,13 +585,13 @@ the DataContext don't have the value.
 
 | Name | Type |
 | :------ | :------ |
-| `WithValue` | extends `boolean```false`` |
+| `WithValue` | extends `boolean` = ``false`` |
 
 ___
 
 ### 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`  } : {}
+Ƭ **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` ; `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
 
@@ -599,7 +622,7 @@ ___
 
 Ƭ **WId**: `StringWithIdentity`<``"WId"``\>
 
-A `wi_id` is the ID of a @see Webhook
+A `wi_id` is the ID of a [Webhook](#webhook)
 
 ___
 
@@ -621,8 +644,8 @@ ___
 | `status` | [`WebhookStatus`](#webhookstatus) | - |
 | `subscribe_log?` | { `date`: `string` ; `response_payload`: `Json` ; `response_status_code`: `number`  }[] | - |
 | `webhook_action` | { `webhook_action_type`: `string`  }[] | - |
-| `webhook_field_mapping_schema` | `Object` | - |
-| `webhook_filter_schema` | `Object` | - |
+| `webhook_field_mapping_schema` | { `[key: string]`: `string`;  } | - |
+| `webhook_filter_schema` | { `field_name`: `string` ; `field_value`: `string` ; `operator`: `string`  } | - |
 | `webhook_filter_schema.field_name` | `string` | - |
 | `webhook_filter_schema.field_value` | `string` | - |
 | `webhook_filter_schema.operator` | `string` | - |
@@ -661,7 +684,7 @@ in the query parameters, it needs to be base64 and/or url encoded.
 | `review_text?` | `string` | the text on the WizardReview page |
 | `sharing_data_message?` | `string` | the loading message to show next to the spinner after the review screen |
 | `signature_schema?` | `string` | if specified, a Wizard will be shown on the review page with this schema |
-| `skip_share?` | `boolean` | **`deprecated`** added in !244 but never used |
+| `skip_share?` | `boolean` | **`Deprecated`** added in !244 but never used |
 | `submit_text?` | `string` | the submit button label |
 | `terms_schema?` | `string` | if specified, a Wizard will be shown on the review page with this schema |
 | `update_reference?` | `boolean` | whether the user can change the reference, if there is one in the QP |
@@ -672,13 +695,14 @@ ___
 
 Ƭ **WizardPage**: `Object`
 
-configuration data for a single wizard page (@see WizardConfig)
+configuration data for a single wizard page ([WizardConfig](#wizardconfig))
 
 #### Type declaration
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `allow_upload?` | `boolean` | do not allow uploading in ImageDynamicSection if this is explictly false |
+| `branching_rule_name?` | `string` | If specified, this is is a "Conditional Wizard Page", which is only shown if the rule passed. This field contains the ID (not name) of the rule. |
 | `create_new_text?` | `string` | custom text to display on the Create New button |
 | `description?` | `string` | the fallback description, if there isn't one for the specific situation |
 | `description_create?` | `string` | - |
@@ -702,10 +726,17 @@ configuration data for a single wizard page (@see WizardConfig)
 | `reverify_header?` | `string` | custom text & header that's displayed on reverfication modal for expired PO |
 | `reverify_text?` | `string` | - |
 | `schemas` | `string`[] | - |
-| `selection_hierarchy_json?` | `string` | a URL to a preset for configuing NestedSchemaSelect. @see DeepConfig |
+| `selection_hierarchy_json?` | `string` | a URL to a preset for configuing NestedSchemaSelect. DeepConfig |
 | `service_provider_link?` | `boolean` | see #463 |
 | `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` |
+| `tags?` | [`WizardPageTag`](#wizardpagetag)[] | - |
+| `verify_data?` | `boolean` | if `false`, ProfileObjects created while completing the form will not be verified. if `true`, you can only select ProfileObjects that are partially or fully verified. `undefined` implies `true`. **`Default`** ```ts true ``` |
+
+___
+
+### WizardPageTag
+
+Ƭ **WizardPageTag**: ``"action:require_chip"``
 
 ___
 
@@ -722,8 +753,8 @@ This is what's returned by the API
 | `active` | ``true`` | - |
 | `end_date` | `string` | ISO Date. If this tag exists, the schema is deprecated. |
 | `name` | `string` | - |
-| `schema` | [`CommonSchemaAttributes`](#commonschemaattributes) & { `$id?`: `string` ; `$schema?`: `string` ; `allOf?`: { `$ref?`: `string` ; `if?`: `Partial`<[`WrappedSchema`](modules.md#wrappedschema)[``"schema"``]\> ; `then?`: `Partial`<[`WrappedSchema`](modules.md#wrappedschema)[``"schema"``]\>  }[] ; `definitions?`: `Record`<`string`, `Object`\> ; `properties`: { [fieldName: string]: [`ServerSchemaField`](modules.md#serverschemafield);  } ; `required?`: `string`[] ; `verified_fields?`: `string`[]  } | - |
+| `schema` | [`CommonSchemaAttributes`](#commonschemaattributes) & { `$id?`: `string` ; `$schema?`: `string` ; `allOf?`: { `$ref?`: `string` ; `if?`: `Partial`<[`WrappedSchema`](modules.md#wrappedschema)[``"schema"``]\> ; `then?`: `Partial`<[`WrappedSchema`](modules.md#wrappedschema)[``"schema"``]\>  }[] ; `definitions?`: `Record`<`string`, { `$ref`: [`Urn`](modules.md#urn)  }\> ; `properties`: { `[fieldName: string]`: [`ServerSchemaField`](modules.md#serverschemafield);  } ; `required?`: `string`[] ; `verified_fields?`: `string`[]  } | - |
 | `start_date` | `string` | ISO Date |
 | `type` | ``"ss"`` \| ``"ps"`` \| ``"us"`` | - |
 | `version` | `string` | - |
-| `version_current` | `boolean` | whether the \`version\` is the latest version |
+| `version_current` | `boolean` | whether the `version` is the latest version |

package/dist/crypto.js

@@ -1,2 +1,2 @@
 "use strict";
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/index.js

@@ -13,7 +13,7 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./crypto"), exports);
 __exportStar(require("./raytio"), exports);
 __exportStar(require("./schema"), exports);

package/dist/raytio.d.ts

@@ -6,22 +6,24 @@ export type StringWithIdentity<T> = string & {
 };
 /** @internal */
 type Json = Record<string, any>;
-/** A `p_id` is the ID of a @see Relationship */
+/** A `p_id` is the ID of a {@link Relationship} */
 export type PId = StringWithIdentity<"PId">;
-/** An `i_id` is the ID of an @see Instance */
+/** An `i_id` is the ID of an {@link Instance} */
 export type IId = StringWithIdentity<"IId">;
-/** An `n_id` is the ID of a @see ProfileObject */
+/** An `n_id` is the ID of a {@link ProfileObject} */
 export type NId = StringWithIdentity<"NId">;
 /** A `g_id` is the ID of a group */
 export type GId = StringWithIdentity<"GId">;
 /** A `u_id` is the ID of a user */
 export type UId = StringWithIdentity<"UId">;
-/** An `a_id` is the ID of an @see AA */
+/** An `a_id` is the ID of an {@link AA} */
 export type AId = StringWithIdentity<"AId">;
-/** An `o_id` is the ID of an @see Organization */
+/** An `o_id` is the ID of an {@link Organization} */
 export type OId = StringWithIdentity<"OId">;
-/** A `wi_id` is the ID of a @see Webhook */
+/** A `wi_id` is the ID of a {@link Webhook} */
 export type WId = StringWithIdentity<"WId">;
+/** An `l_id` is the ID of any data stored in the KV-Store */ export type LId = StringWithIdentity<"LId">;
+export type AnyId = PId | IId | NId | GId | UId | AId | OId | WId;
 export type DataTypes = "string" | "number" | "boolean" | "object" | "integer" | "array" | "null";
 export 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 */
@@ -50,17 +52,17 @@ export type ProfileObjectForUpload<Properties = Json> = {
 };
 /**
  * arbitrary key-values pairs stored on a Profile Object.
- * May contain nested JSON and @see Encrypted properties.
+ * May contain nested JSON and {@link Encrypted} properties.
  *
  * There are some limits to field names: they cannot be called
  * `__signature` nor can they include the character sequence `<=>`.
+ *
+ * @deprecated - use {@link Json}
  */
-export type Properties = {
-    [fieldName: string]: any;
-};
+export type Properties = Json;
 export type UrnNodeType = "user" | "profile_object" | "instance" | "schema" | "temp_object" | "document";
 /** e.g. "urn:user:..." */
-export type Urn = `urn:${UrnNodeType}:${string}`;
+export type Urn = `urn:${UrnNodeType}:${AnyId}`;
 export type Relationship = {
     start: Urn;
     end: Urn;
@@ -82,7 +84,7 @@ export type Lookup = {
     /** used in AkahuDynamicSection only */
     requires_2FA?: boolean;
 };
-export type AATags = "type:client_only" | "type:share_with_new_user" | `related_service_provider:n_id:${NId}` | "ServiceProvider";
+export type AATag = "type:client_only" | "type:share_with_new_user" | `related_service_provider:n_id:${NId}` | "ServiceProvider";
 export type AA = {
     a_id: AId;
     name: string;
@@ -93,7 +95,7 @@ export type AA = {
     /** Easy to use AA logo url for pasting inot emails */
     picture_url?: string;
     scopes?: string[];
-    tags?: AATags[];
+    tags?: AATag[];
     callback_uri?: string[];
     /** markdown or string help information including [phoneNumber || email] */
     aa_help?: string;
@@ -132,7 +134,7 @@ export type Instance = {
     start_date: string;
     /** The status of a submission */
     state: SubmissionStatus;
-    /** @depreacted The status of a submission */
+    /** @deprecated The status of a submission */
     _state?: SubmissionStatus;
     /** Previous status of the shared information */
     previous_state: SubmissionStatus;
@@ -143,7 +145,7 @@ export type Instance = {
     /** data associated is access application's instance */
     profile_objects: ProfileObject[];
     keys: {
-        [nId: string]: {
+        [nId: NId]: {
             [fieldName: string]: {
                 data: string;
                 n_id: NId;

package/dist/raytio.js

@@ -1,2 +1,2 @@
 "use strict";
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/schema.d.ts

@@ -7,8 +7,8 @@ export type ConditionallyRequired = {
         [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:terms_conditions" | `display:main_media:${string}` | "date_component:day" | "date_component:month" | "date_component:year" | "action:client_upload" | "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" | "default_camera:rear" | "default_camera:front" | `oauth2_component:name:${string}` | `oauth2_component:redirect_url:${string}` | `link_to:${string}:${string}` | "type:service_provider" | "type:service_offer" | "type:marketplace" | "type:client_only" | "type:globally_unique_field";
+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:replace:'${string}':'${string}'` | "display:terms_conditions" | `display:main_media:${string}` | "date_component:day" | "date_component:month" | "date_component:year" | "action:client_upload" | "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" | "default_camera:rear" | "default_camera:front" | `oauth2_component:name:${string}` | `oauth2_component:redirect_url:${string}` | `time:${string}:${number}` | `link_to:${string}:${string}` | "type:service_provider" | "type:service_offer" | "type:marketplace" | "type:client_only" | "type:globally_unique_field";
 export type SchemaField = {
     /** @deprecated don't use, it's inconsistent */
     $id?: string;
@@ -21,8 +21,14 @@ export type SchemaField = {
     tags?: SchemaFieldTag[];
     type?: DataTypes;
     enum?: (string | number | boolean)[];
+    /** for number inputs, the maximum allowed value */
     maximum?: number;
+    /** for number inputs, the minimum allowed value */
     minimum?: number;
+    /** for number inputs, the step size used in the input or slider */
+    step?: number;
+    /** if true, the user must have encryption enabled to save this data, see #1324 */
+    encrypt_require?: boolean;
     /** @deprecated raytio's usage not documented */
     maxLength?: number;
     /** @deprecated raytio's usage not documented */
@@ -250,9 +256,9 @@ export type Schema = CommonSchemaAttributes & {
     required?: (string | ConditionallyRequired)[];
     /** added by client */
     wasExpandedByClient?: boolean;
-    /** ISO Date. Copied from @see WrappedSchema */
+    /** ISO Date. Copied from {@link WrappedSchema} */
     start_date?: string;
-    /** ISO Date. Copied from @see WrappedSchema If this tag exists, the schema is deprecated */
+    /** 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: {
@@ -262,7 +268,7 @@ export type Schema = CommonSchemaAttributes & {
     groupNames?: Record<string, string>;
     /** added by the client to inform downstream components which locale from schema.i18n was used */
     clientLocale?: string;
-    /** added by the client, copied from @see WrappedSchema */
+    /** added by the client, copied from {@link WrappedSchema} */
     version: string;
     /**
      * the estimated loading times in seconds for various API calls. The client adds

package/dist/schema.js

@@ -1,2 +1,2 @@
 "use strict";
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/theme.js

@@ -1,2 +1,2 @@
 "use strict";
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/verification.d.ts

@@ -18,8 +18,6 @@ export type VerificationPayload<WithValue extends boolean> = {
     verifier_source_id?: NId;
     verifier_service_id?: NId;
     verifier_div: string;
-    /** ISO Date */
-    valid_until?: string;
 } & (WithValue extends true ? {
     value: string | number;
 } : {});
@@ -71,7 +69,7 @@ export type VerificationProvider = {
     /** the date which the verification was verified on, or last re-verified on */
     date?: Date;
 };
-/** This is what @raytio/core exposes, which is more useable than @see Verification */
+/** This is what @raytio/core exposes, which is more useable than {@link Verification} */
 export type RealVer = {
     fieldName: string;
     value: unknown;

package/dist/verification.js

@@ -1,5 +1,5 @@
 "use strict";
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.POVerification = exports.FieldVerification = void 0;
 /**
  * "Not Verified" means show no badge, cf. "Verified False" means the

package/dist/wizard.d.ts

@@ -1,5 +1,6 @@
 import { AId } from "./raytio";
-/** configuration data for a single wizard page (@see WizardConfig) */
+export type WizardPageTag = "action:require_chip";
+/** configuration data for a single wizard page ({@link WizardConfig}) */
 export type WizardPage = {
     /** if undefined, the schema title will be used */
     name?: string | symbol;
@@ -20,7 +21,7 @@ export type WizardPage = {
     service_provider_link?: boolean;
     /** custom text to display on the Create New button */
     create_new_text?: string;
-    /** a URL to a preset for configuing NestedSchemaSelect. @see DeepConfig */
+    /** a URL to a preset for configuing NestedSchemaSelect. {@link DeepConfig} */
     selection_hierarchy_json?: string;
     /** whether the schema description should be shown */
     display_schema_description?: boolean;
@@ -43,7 +44,12 @@ export type WizardPage = {
     extract_threshold_fail_action?: "capture" | "capture_review" | "recapture_or_next_step" | "review" | "next_step";
     /** for ImageDynamicSection, the action to take if the API returns no `validation: {}` object */
     extract_threshold_null_action?: WizardPage["extract_threshold_fail_action"];
-    /** if `false`, ProfileObjects created while completing the form will not be verified. `undefined` implies `true` */
+    /**
+     * if `false`, ProfileObjects created while completing the form will not be verified.
+     * if `true`, you can only select ProfileObjects that are partially or fully verified.
+     * `undefined` implies `true`.
+     * @default true
+     */
     verify_data?: boolean;
     /** a list of fields that should not be required, even if the schema says they're required */
     optional_fields?: string[];
@@ -51,6 +57,12 @@ export type WizardPage = {
     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";
+    tags?: WizardPageTag[];
+    /**
+     * If specified, this is is a "Conditional Wizard Page", which is only shown
+     * if the rule passed. This field contains the ID (not name) of the rule.
+     */
+    branching_rule_name?: string;
 };
 /**
  * when a form link is generated, this is what gets saved on the API.

package/dist/wizard.js

@@ -1,2 +1,2 @@
 "use strict";
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@raytio/types",
-  "version": "7.0.0",
+  "version": "7.1.0",
   "license": "MIT",
   "main": "index",
   "types": "index",
@@ -12,7 +12,7 @@
   ],
   "scripts": {
     "docs": "sh ../../scripts/generate-docs.sh",
-    "test": "npm run build",
+    "test": "npm run build && yarn docs",
     "build": "tsc && rimraf dist/__tests__"
   }
 }

package/src/__tests__/schema.ts

@@ -1,4 +1,4 @@
-/* eslint-disable fp/no-let, @typescript-eslint/no-unused-vars */
+/* eslint-disable @typescript-eslint/no-unused-vars */
 import { Schema, SchemaField, WrappedSchema } from "..";
 
 /**

package/src/raytio.ts

@@ -7,22 +7,26 @@ 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 */
+/** A `p_id` is the ID of a {@link Relationship} */
 export type PId = StringWithIdentity<"PId">;
-/** An `i_id` is the ID of an @see Instance */
+/** An `i_id` is the ID of an {@link Instance} */
 export type IId = StringWithIdentity<"IId">;
-/** An `n_id` is the ID of a @see ProfileObject */
+/** An `n_id` is the ID of a {@link ProfileObject} */
 export type NId = StringWithIdentity<"NId">;
 /** A `g_id` is the ID of a group */
 export type GId = StringWithIdentity<"GId">;
 /** A `u_id` is the ID of a user */
 export type UId = StringWithIdentity<"UId">;
-/** An `a_id` is the ID of an @see AA */
+/** An `a_id` is the ID of an {@link AA} */
 export type AId = StringWithIdentity<"AId">;
-/** An `o_id` is the ID of an @see Organization */
+/** An `o_id` is the ID of an {@link Organization} */
 export type OId = StringWithIdentity<"OId">;
-/** A `wi_id` is the ID of a @see Webhook */
+/** A `wi_id` is the ID of a {@link Webhook} */
 export type WId = StringWithIdentity<"WId">;
+/** An `l_id` is the ID of any data stored in the KV-Store */ // e.g. StoredWizardConfig and VerBundleMetadata
+export type LId = StringWithIdentity<"LId">;
+
+export type AnyId = PId | IId | NId | GId | UId | AId | OId | WId;
 
 export type DataTypes =
   | "string"
@@ -74,14 +78,14 @@ export type ProfileObjectForUpload<Properties = Json> = {
 
 /**
  * arbitrary key-values pairs stored on a Profile Object.
- * May contain nested JSON and @see Encrypted properties.
+ * May contain nested JSON and {@link Encrypted} properties.
  *
  * There are some limits to field names: they cannot be called
  * `__signature` nor can they include the character sequence `<=>`.
+ *
+ * @deprecated - use {@link Json}
  */
-export type Properties = {
-  [fieldName: string]: any; // TODO: (semver breaking) unknown
-};
+export type Properties = Json;
 
 export type UrnNodeType =
   | "user"
@@ -92,7 +96,7 @@ export type UrnNodeType =
   | "document";
 
 /** e.g. "urn:user:..." */
-export type Urn = `urn:${UrnNodeType}:${string}`; // TODO: TS4.3 replace `string` with `IId | NId | GId | UId | AId`
+export type Urn = `urn:${UrnNodeType}:${AnyId}`;
 
 export type Relationship = {
   start: Urn;
@@ -118,7 +122,7 @@ export type Lookup = {
   requires_2FA?: boolean;
 };
 
-export type AATags =
+export type AATag =
   | "type:client_only"
   | "type:share_with_new_user"
   // heritage
@@ -135,7 +139,7 @@ export type AA = {
   /** Easy to use AA logo url for pasting inot emails */
   picture_url?: string;
   scopes?: string[];
-  tags?: AATags[];
+  tags?: AATag[];
   callback_uri?: string[];
   /** markdown or string help information including [phoneNumber || email] */
   aa_help?: string;
@@ -179,7 +183,7 @@ export type Instance = {
   start_date: string;
   /** The status of a submission */
   state: SubmissionStatus;
-  /** @depreacted The status of a submission */
+  /** @deprecated The status of a submission */
   _state?: SubmissionStatus;
   /** Previous status of the shared information */
   previous_state: SubmissionStatus;
@@ -191,8 +195,7 @@ export type Instance = {
   profile_objects: ProfileObject[];
   // TODO: (semver breaking) mark as optional since the get-shared-data API doesn't return keys
   keys: {
-    // TODO: TS4.3 use `NId` instead of `string`
-    [nId: string]: {
+    [nId: NId]: {
       [fieldName: string]: {
         data: string;
         n_id: NId;

package/src/schema.ts

@@ -24,6 +24,7 @@ export type SchemaFieldTag =
   | "display:survey"
   | "display:quoting"
   | "display:customModal"
+  | `display:replace:'${string}':'${string}'`
   | "display:terms_conditions"
   | `display:main_media:${string}` // property name to determine what image to display
   // date picker components
@@ -48,6 +49,7 @@ export type SchemaTag =
   | `oauth2_component:name:${string}`
   | `oauth2_component:redirect_url:${string}`
   // misc
+  | `time:${/* type */ string}:${/* seconds */ number}`
   | `link_to:${/* schemaName */ string}:${/* relationshipType */ string}`
   // type
   | "type:service_provider"
@@ -68,8 +70,14 @@ export type SchemaField = {
   tags?: SchemaFieldTag[];
   type?: DataTypes;
   enum?: (string | number | boolean)[];
+  /** for number inputs, the maximum allowed value */
   maximum?: number;
+  /** for number inputs, the minimum allowed value */
   minimum?: number;
+  /** for number inputs, the step size used in the input or slider */
+  step?: number;
+  /** if true, the user must have encryption enabled to save this data, see #1324 */
+  encrypt_require?: boolean;
   /** @deprecated raytio's usage not documented */
   maxLength?: number;
   /** @deprecated raytio's usage not documented */
@@ -296,9 +304,9 @@ export type Schema = CommonSchemaAttributes & {
   /** added by client */
   wasExpandedByClient?: boolean;
 
-  /** ISO Date. Copied from @see WrappedSchema */
+  /** ISO Date. Copied from {@link WrappedSchema} */
   start_date?: string;
-  /** ISO Date. Copied from @see WrappedSchema If this tag exists, the schema is deprecated */
+  /** 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 */
@@ -312,7 +320,7 @@ export type Schema = CommonSchemaAttributes & {
   /** added by the client to inform downstream components which locale from schema.i18n was used */
   clientLocale?: string;
 
-  /** added by the client, copied from @see WrappedSchema */
+  /** added by the client, copied from {@link WrappedSchema} */
   version: string;
 
   /**

package/src/verification.ts

@@ -20,9 +20,7 @@ export type VerificationPayload<WithValue extends boolean> = {
   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,
+  // we are disabling the eslint rule because 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
@@ -85,7 +83,7 @@ export type VerificationProvider = {
   date?: Date;
 };
 
-/** This is what @raytio/core exposes, which is more useable than @see Verification */
+/** This is what @raytio/core exposes, which is more useable than {@link Verification} */
 export type RealVer = {
   fieldName: string;
   value: unknown;

package/src/wizard.ts

@@ -1,6 +1,10 @@
 import { AId } from "./raytio";
 
-/** configuration data for a single wizard page (@see WizardConfig) */
+export type WizardPageTag =
+  // actions
+  "action:require_chip";
+
+/** configuration data for a single wizard page ({@link WizardConfig}) */
 export type WizardPage = {
   /** if undefined, the schema title will be used */
   name?: string | symbol;
@@ -23,7 +27,7 @@ export type WizardPage = {
   service_provider_link?: boolean;
   /** custom text to display on the Create New button */
   create_new_text?: string;
-  /** a URL to a preset for configuing NestedSchemaSelect. @see DeepConfig */
+  /** a URL to a preset for configuing NestedSchemaSelect. {@link DeepConfig} */
   selection_hierarchy_json?: string;
 
   /** whether the schema description should be shown */
@@ -60,7 +64,12 @@ export type WizardPage = {
   /** for ImageDynamicSection, the action to take if the API returns no `validation: {}` object */
   extract_threshold_null_action?: WizardPage["extract_threshold_fail_action"];
 
-  /** if `false`, ProfileObjects created while completing the form will not be verified. `undefined` implies `true` */
+  /**
+   * if `false`, ProfileObjects created while completing the form will not be verified.
+   * if `true`, you can only select ProfileObjects that are partially or fully verified.
+   * `undefined` implies `true`.
+   * @default true
+   */
   verify_data?: boolean;
 
   /** a list of fields that should not be required, even if the schema says they're required */
@@ -72,6 +81,14 @@ export type WizardPage = {
 
   /** 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";
+
+  tags?: WizardPageTag[];
+
+  /**
+   * If specified, this is is a "Conditional Wizard Page", which is only shown
+   * if the rule passed. This field contains the ID (not name) of the rule.
+   */
+  branching_rule_name?: string;
 };
 
 /**