@raytio/types 6.0.2 → 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,14 @@ 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)
+- [AATag](#aatag)
 - [AId](#aid)
+- [AnyId](#anyid)
 - [Colors](#colors)
+- [CommonSchemaAttributes](#commonschemaattributes)
 - [ConditionallyRequired](#conditionallyrequired)
 - [CustomFonts](#customfonts)
 - [DataTypes](#datatypes)
@@ -39,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)
@@ -51,8 +59,8 @@ Hovering over the type in VSCode will display documentation and available proper
 - [Schema](#schema)
 - [SchemaField](#schemafield)
 - [SchemaFieldTag](#schemafieldtag)
-- [SchemaMetadata](#schemametadata)
 - [SchemaTag](#schematag)
+- [ServerSchemaField](#serverschemafield)
 - [SubmissionStatus](#submissionstatus)
 - [UId](#uid)
 - [Urn](#urn)
@@ -63,10 +71,13 @@ Hovering over the type in VSCode will display documentation and available proper
 - [VerificationProvider](#verificationprovider)
 - [WId](#wid)
 - [Webhook](#webhook)
+- [WebhookStatus](#webhookstatus)
 - [WizardConfig](#wizardconfig)
 - [WizardPage](#wizardpage)
+- [WizardPageTag](#wizardpagetag)
+- [WrappedSchema](#wrappedschema)
 
-## Type aliases
+## Type Aliases
 
 ### AA
 
@@ -77,30 +88,42 @@ 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`[] | - |
 | `description?` | `string` | - |
 | `name` | `string` | - |
-| `org_id` | [`OId`](#oid) | the id of the associated organisation |
+| `org_id` | [`OId`](#oid) | the id of the associated organization |
 | `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` | - |
+| `tags?` | [`AATag`](#aatag)[] | - |
+| `theme?` | { `colors?`: [`Colors`](#colors) ; `font?`: [`CustomFonts`](modules.md#customfonts)  } | - |
 | `theme.colors?` | [`Colors`](#colors) | - |
 | `theme.font?` | [`CustomFonts`](#customfonts) | - |
 
 ___
 
+### AATag
+
+Ƭ **AATag**: ``"type:client_only"`` \| ``"type:share_with_new_user"`` \| \`related\_service\_provider:n\_id:${NId}\` \| ``"ServiceProvider"``
+
+___
+
 ### AId
 
 Ƭ **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)
 
 ___
 
@@ -121,7 +144,7 @@ ___
 | `poolblueText` | `string` | - |
 | `poolblueUi` | `string` | - |
 | `raytioOrangeHover` | `string` | - |
-| `raytioOrangeShade` | `string` | only used by the fancy layout on the login screen |
+| `raytioOrangeShade` | `string` | ✨ |
 | `raytioOrangeText` | `string` | - |
 | `raytioOrangeUi` | `string` | - |
 | `sariShade` | `string` | - |
@@ -137,6 +160,41 @@ ___
 
 ___
 
+### CommonSchemaAttributes
+
+Ƭ **CommonSchemaAttributes**: `Object`
+
+not exported. Attributes that are identical in both client schema & server schema
+
+#### Type declaration
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `description` | `string` | - |
+| `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?` | { `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?` | { `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?` | { `[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?` | { `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`  }[] | - |
+| `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) | - |
+
+___
+
 ### ConditionallyRequired
 
 Ƭ **ConditionallyRequired**: `Object`
@@ -148,7 +206,7 @@ should be renamed since this applies to ConditionallyVerifiable
 | Name | Type |
 | :------ | :------ |
 | `field` | `string` |
-| `if` | `Object` |
+| `if` | { `[fieldName: string]`: (`string` \| `number` \| `boolean`)[];  } |
 
 ___
 
@@ -185,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` |
 
 ___
@@ -206,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)
 
 ___
 
@@ -218,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 |
@@ -239,6 +297,14 @@ ___
 
 ___
 
+### LId
+
+Ƭ **LId**: `StringWithIdentity`<``"LId"``\>
+
+An `l_id` is the ID of any data stored in the KV-Store
+
+___
+
 ### Lookup
 
 Ƭ **Lookup**: `Object`
@@ -260,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)
 
 ___
 
@@ -268,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)
 
 ___
 
@@ -283,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` |
@@ -301,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)
 
 ___
 
@@ -329,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
 
 ___
 
@@ -347,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
 
@@ -376,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) |
@@ -386,51 +452,10 @@ ___
 
 ### Schema
 
-Ƭ **Schema**: `Object`
+Ƭ **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. All props marked as optional except
-`name`. This type can be used for both the schema and for individual fields.
-
-#### Type declaration
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `$id?` | `string` | **`deprecated`** don't use this |
-| `$ref?` | `string` | **`deprecated`** not sure why a schema would have this, only fields should |
-| `$schema?` | `string` | - |
-| `allOf?` | { `$ref?`: `string` ; `if?`: [`Schema`](#schema) ; `then?`: [`Schema`](modules.md#schema)  }[] | - |
-| `definitions?` | `Record`<`string`, `Object`\> | - |
-| `description` | `string` | - |
-| `display?` | `Object` | - |
-| `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`[] | - |
-| `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`[] | - |
-| `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) | - |
-| `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)  }[] | 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 |
-| `properties` | `Object` | 🚨 Note that there are cases where properties are undefined, e.g. if the schema is a sub-object |
-| `relationships?` | { `anyOf?`: `string`[] ; `direction`: ``"from"`` ; `multiple?`: `boolean` ; `oneOf?`: `string`[] ; `properties?`: { [fieldName: string]: [`SchemaField`](#schemafield);  } ; `relationship_name`: `string` ; `required?`: `string`[] ; `required_relationship?`: `boolean` ; `type`: `string`  }[] | - |
-| `required?` | (`string` \| [`ConditionallyRequired`](#conditionallyrequired))[] | added by client |
-| `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 |
-| `version?` | `string` | - |
-| `version_current?` | `boolean` | whether the `version` is the latest version |
-| `wasExpandedByClient?` | `boolean` | - |
+Raytio's variant of JSON Schema, as used by the client. It is a modified version
+of what the API returns.
 
 ___
 
@@ -442,10 +467,10 @@ ___
 
 | 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`  }, [`SchemaField`](#schemafield)] | - |
+| `allOf?` | [{ `$ref`: `string`  }, [`ServerSchemaField`](#serverschemafield)] | - |
 | `content?` | `string` | only checkbox uses this prop |
 | `contentEncoding?` | ``"base64"`` | - |
 | `contentMediaType?` | `string` | - |
@@ -454,26 +479,28 @@ ___
 | `description?` | `string` | - |
 | `description_decorator?` | ``"md"`` | specifies that the description is formatted in markdown |
 | `encrypt?` | `boolean` | whether the field should be encrypted |
-| `enum?` | `string`[] | - |
+| `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` | - |
@@ -484,21 +511,21 @@ ___
 
 ### 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:showOnWizard"`` \| \`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"``
 
 ___
 
-### SchemaMetadata
-
-Ƭ **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`  }
+### SchemaTag
 
-Only certain properties from the schema
+Ƭ **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"``
 
 ___
 
-### SchemaTag
+### ServerSchemaField
+
+Ƭ **ServerSchemaField**: `Omit`<[`SchemaField`](#schemafield), ``"$prop"``\>
 
-Ƭ **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"``
+the only difference between the client & server's definition is that the client adds `$prop`
 
 ___
 
@@ -518,7 +545,7 @@ ___
 
 ### Urn
 
-Ƭ **Urn**: \`urn:${UrnNodeType}:${string}\`
+Ƭ **Urn**: \`urn:${UrnNodeType}:${AnyId}\`
 
 e.g. "urn:user:..."
 
@@ -526,7 +553,7 @@ ___
 
 ### UrnNodeType
 
-Ƭ **UrnNodeType**: ``"user"`` \| ``"profile_object"`` \| ``"instance"`` \| ``"temp_object"`` \| ``"document"``
+Ƭ **UrnNodeType**: ``"user"`` \| ``"profile_object"`` \| ``"instance"`` \| ``"schema"`` \| ``"temp_object"`` \| ``"document"``
 
 ___
 
@@ -540,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`[] |
 
@@ -548,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
@@ -558,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
 
@@ -595,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)
 
 ___
 
@@ -609,26 +636,37 @@ ___
 | :------ | :------ | :------ |
 | `date_created` | `string` | ISO Date |
 | `date_updated` | `string` | ISO Date |
+| `provider_signature_check_enabled` | `boolean` | - |
+| `provider_signature_credentials` | `unknown` | - |
 | `provider_subscription_credentials` | `unknown` | - |
 | `provider_webhook_id` | [`NId`](#nid) | n_id of "the webhook provider which can be set up against a service provider" |
-| `status` | `unknown` | - |
+| `provider_webhook_subscription_id` | [`NId`](#nid) | not sure what this is |
+| `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` | - |
 | `webhook_filter_source` | `string` | - |
+| `webhook_processing_rules` | `unknown` | - |
 | `wi_id` | [`WId`](#wid) | - |
 
 ___
 
+### WebhookStatus
+
+Ƭ **WebhookStatus**: ``"subscribed"`` \| ``"pending"`` \| ``"unsubscribe_failed"``
+
+___
+
 ### WizardConfig
 
 Ƭ **WizardConfig**: `Object`
 
 when a form link is generated, this is what gets saved on the API.
-Each value can be overriden in the query parameters. If specified
+Each value can be overridden in the query parameters. If specified
 in the query parameters, it needs to be base64 and/or url encoded.
 
 #### Type declaration
@@ -646,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 |
@@ -657,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` | - |
@@ -687,7 +726,35 @@ 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"``
+
+___
+
+### WrappedSchema
+
+Ƭ **WrappedSchema**: `Object`
+
+This is what's returned by the API
+
+#### Type declaration
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `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`, { `$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 |

package/dist/crypto.d.ts

@@ -1,4 +1,4 @@
-export declare type Encrypted<_Data = string> = {
+export type Encrypted<_Data = string> = {
     encrypted_key: {
         encrypted_key: string;
     };

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);