@raytio/types 5.2.0 → 6.0.1

package/README.md

@@ -19,3 +19,641 @@ import type { Schema } from "@raytio/types";
 Hovering over the type in VSCode will display documentation and available properties.
 
 # Documentation
+
+## Table of contents
+
+### Enumerations
+
+- [FieldVerification](enums/FieldVerification.md)
+- [POVerification](enums/POVerification.md)
+
+### Type aliases
+
+- [AA](#aa)
+- [AId](#aid)
+- [Colors](#colors)
+- [ConditionallyRequired](#conditionallyrequired)
+- [CustomFonts](#customfonts)
+- [DataTypes](#datatypes)
+- [Encrypted](#encrypted)
+- [GId](#gid)
+- [IId](#iid)
+- [Instance](#instance)
+- [Lookup](#lookup)
+- [NId](#nid)
+- [OId](#oid)
+- [Organization](#organization)
+- [PId](#pid)
+- [ProfileObject](#profileobject)
+- [Properties](#properties)
+- [RealVer](#realver)
+- [Relationship](#relationship)
+- [Schema](#schema)
+- [SchemaField](#schemafield)
+- [SchemaFieldTag](#schemafieldtag)
+- [SchemaMetadata](#schemametadata)
+- [SchemaTag](#schematag)
+- [SubmissionStatus](#submissionstatus)
+- [UId](#uid)
+- [Urn](#urn)
+- [UrnNodeType](#urnnodetype)
+- [Validation](#validation)
+- [Verification](#verification)
+- [VerificationPayload](#verificationpayload)
+- [VerificationProvider](#verificationprovider)
+- [WizardConfig](#wizardconfig)
+- [WizardPage](#wizardpage)
+
+## Type aliases
+
+### AA
+
+Ƭ **AA**: `Object`
+
+#### Type declaration
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `a_id` | [`AId`](#aid) | - |
+| `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 |
+| `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.font?` | [`CustomFonts`](#customfonts) | - |
+
+___
+
+### AId
+
+Ƭ **AId**: `StringWithIdentity`<``"AId"``\>
+
+An `a_id` is the ID of an @see AA
+
+___
+
+### Colors
+
+Ƭ **Colors**: `Object`
+
+#### Type declaration
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `blank` | `string` | - |
+| `blankBackground` | `string` | - |
+| `climaterolText` | `string` | - |
+| `climaterolUi` | `string` | - |
+| `errorRed` | `string` | - |
+| `feelingHugged` | `string` | - |
+| `loadingYellow` | `string` | - |
+| `poolblueText` | `string` | - |
+| `poolblueUi` | `string` | - |
+| `raytioOrangeHover` | `string` | - |
+| `raytioOrangeShade` | `string` | only used by the fancy layout on the login screen |
+| `raytioOrangeText` | `string` | - |
+| `raytioOrangeUi` | `string` | - |
+| `sariShade` | `string` | - |
+| `silverShell` | `string` | - |
+| `sirPinklyText` | `string` | - |
+| `sirPinklyUi` | `string` | - |
+| `successGreen` | `string` | - |
+| `textFull` | `string` | - |
+| `textLight` | `string` | - |
+| `textMedium` | `string` | - |
+| `violaPerpetuoText` | `string` | - |
+| `violaPerpetuoUi` | `string` | - |
+
+___
+
+### ConditionallyRequired
+
+Ƭ **ConditionallyRequired**: `Object`
+
+should be renamed since this applies to ConditionallyVerifiable
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `field` | `string` |
+| `if` | `Object` |
+
+___
+
+### CustomFonts
+
+Ƭ **CustomFonts**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `body?` | `string` |
+| `header?` | `string` |
+
+___
+
+### DataTypes
+
+Ƭ **DataTypes**: ``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``
+
+___
+
+### Encrypted
+
+Ƭ **Encrypted**<`_Data`\>: `Object`
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `_Data` | `string` |
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `encrypted_data` | `Object` |
+| `encrypted_data.algorithm` | `AesKeyAlgorithm` |
+| `encrypted_data.data` | `string` |
+| `encrypted_data.iv` | `string` |
+| `encrypted_key` | `Object` |
+| `encrypted_key.encrypted_key` | `string` |
+
+___
+
+### GId
+
+Ƭ **GId**: `StringWithIdentity`<``"GId"``\>
+
+A `g_id` is the ID of a group
+
+___
+
+### IId
+
+Ƭ **IId**: `StringWithIdentity`<``"IId"``\>
+
+An `i_id` is the ID of an @see Instance
+
+___
+
+### Instance
+
+Ƭ **Instance**: `Object`
+
+#### Type declaration
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `_state?` | [`SubmissionStatus`](#submissionstatus) | **`depreacted`** 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` | - |
+| `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 |
+| `relationships?` | [`Relationship`](#relationship)[] | - |
+| `service_provider_n_id?` | [`NId`](#nid) | Service provider ID |
+| `start_date` | `string` | Earliest date on which the shared information was available |
+| `state` | [`SubmissionStatus`](#submissionstatus) | The status of a submission |
+| `sub_service_provider_hash?` | `string` | Hash of the Service Provider ID |
+| `thread` | `string` | - |
+
+___
+
+### Lookup
+
+Ƭ **Lookup**: `Object`
+
+#### Type declaration
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `children?` | [`Lookup`](#lookup)[] | - |
+| `description?` | `string` | - |
+| `key` | `string` \| `number` | - |
+| `label?` | `string` \| `number` | Used in Antd Cascader |
+| `requires_2FA?` | `boolean` | used in AkahuDynamicSection only |
+| `value` | `string` \| `number` | - |
+
+___
+
+### NId
+
+Ƭ **NId**: `StringWithIdentity`<``"NId"``\>
+
+An `n_id` is the ID of a @see ProfileObject
+
+___
+
+### OId
+
+Ƭ **OId**: `StringWithIdentity`<``"OId"``\>
+
+An `o_id` is the ID of an @see Organization
+
+___
+
+### Organization
+
+Ƭ **Organization**: `Object`
+
+An organization.
+NOTE: this is different to how the schema defines an Organization. **The schema is wrong (see #468)**
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `address` | `Object` |
+| `address.city` | `string` |
+| `address.country` | `string` |
+| `address.locationType` | `string` |
+| `address.region` | `string` |
+| `address.street1` | `string` |
+| `address.street2` | `string` |
+| `customer` | `Record`<`string`, `unknown`\> |
+| `email` | `string` |
+| `id` | [`OId`](#oid) |
+| `name` | `string` |
+
+___
+
+### PId
+
+Ƭ **PId**: `StringWithIdentity`<``"PId"``\>
+
+A `p_id` is the ID of a @see Relationship
+
+___
+
+### ProfileObject
+
+Ƭ **ProfileObject**<`Properties`\>: `Object`
+
+You can supply an option type argument if you know exactly what the properties will be
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `Properties` | `Json` |
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `labels` | `string`[] |
+| `n_id` | [`NId`](#nid) |
+| `properties` | `Properties` |
+
+___
+
+### Properties
+
+Ƭ **Properties**: `Object`
+
+arbitrary key-values pairs stored on a Profile Object.
+May contain nested JSON and @see Encrypted properties.
+
+There are some limits to field names: they cannot be called
+`__signature` nor can they include the character sequence `<=>`.
+
+#### Index signature
+
+▪ [fieldName: `string`]: `any`
+
+___
+
+### RealVer
+
+Ƭ **RealVer**: `Object`
+
+This is what @raytio/core exposes, which is more useable than @see Verification
+
+#### Type declaration
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `belongsToNId?` | [`NId`](#nid) | nId of the PO that the verification belongs to. Could be undefined |
+| `expired` | `Date` \| ``false`` | If the verification has expired, it's the date that it expired on. Otherwise it's `false` |
+| `fieldName` | `string` | - |
+| `metadata?` | `Record`<`string`, `unknown`\> | arbitary metadata returned by the verifier |
+| `nID` | [`NId`](#nid) | nId of the verification |
+| `provider` | [`VerificationProvider`](#verificationprovider) | - |
+| `signature` | `string` | - |
+| `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 |
+
+___
+
+### Relationship
+
+Ƭ **Relationship**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `end` | [`Urn`](#urn) |
+| `p_id` | [`PId`](#pid) |
+| `properties?` | `Object` |
+| `properties.name?` | `string` |
+| `properties.p_id` | [`PId`](#pid) |
+| `start` | [`Urn`](#urn) |
+| `type` | `string` |
+
+___
+
+### Schema
+
+Ƭ **Schema**: `Object`
+
+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` | - |
+
+___
+
+### SchemaField
+
+Ƭ **SchemaField**: `Object`
+
+#### Type declaration
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `$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)] | - |
+| `content?` | `string` | only checkbox uses this prop |
+| `contentEncoding?` | ``"base64"`` | - |
+| `contentMediaType?` | `string` | - |
+| `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 |
+| `encrypt?` | `boolean` | whether the field should be encrypted |
+| `enum?` | `string`[] | - |
+| `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` | `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 |
+| `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` | - |
+| `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) |
+| `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: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"``
+
+___
+
+### 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`  }
+
+Only certain properties from the schema
+
+___
+
+### 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"``
+
+___
+
+### SubmissionStatus
+
+Ƭ **SubmissionStatus**: ``"Submitted"`` \| ``"Processing"`` \| ``"Rejected"`` \| ``"Expired"`` \| ``"Completed"`` \| ``"DataChanged"`` \| ``"Received"`` \| ``"Accepted"``
+
+___
+
+### UId
+
+Ƭ **UId**: `StringWithIdentity`<``"UId"``\>
+
+A `u_id` is the ID of a user
+
+___
+
+### Urn
+
+Ƭ **Urn**: \`urn:${UrnNodeType}:${string}\`
+
+e.g. "urn:user:..."
+
+___
+
+### UrnNodeType
+
+Ƭ **UrnNodeType**: ``"user"`` \| ``"profile_object"`` \| ``"instance"`` \| ``"temp_object"`` \| ``"document"``
+
+___
+
+### Validation
+
+Ƭ **Validation**: `Object`
+
+validation data returned by preVerify (part of the extract&map API)
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `breakdown` | `Object` |
+| `score` | `number` |
+| `warning?` | `string`[] |
+
+___
+
+### Verification
+
+Ƭ **Verification**<`WithValue`\>: [`ProfileObject`](#profileobject)<`Object`\>
+
+Different APIs inconsistently include the `value` prop. If you know it exists,
+use `Verification<true>`, otherwise just `Verification`. Verifications from
+the DataContext don't have the value.
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `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`  } : {}
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `WithValue` | extends `boolean` |
+
+___
+
+### VerificationProvider
+
+Ƭ **VerificationProvider**: `Object`
+
+These `n_id`s point to service provider profile objects
+
+#### Type declaration
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `dataSourceNId?` | [`NId`](#nid) | - |
+| `date?` | `Date` | the date which the verification was verified on, or last re-verified on |
+| `serviceProviderNId?` | [`NId`](#nid) | - |
+| `verifierNId?` | [`NId`](#nid) | - |
+
+___
+
+### 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
+in the query parameters, it needs to be base64 and/or url encoded.
+
+#### Type declaration
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `a_id` | [`AId`](#aid) | - |
+| `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 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 |
+| `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 |
+| `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 |
+
+___
+
+### WizardPage
+
+Ƭ **WizardPage**: `Object`
+
+configuration data for a single wizard page (@see WizardConfig)
+
+#### Type declaration
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `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` | 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 |
+| `extract_threshold_null_action?` | [`WizardPage`](#wizardpage)[``"extract_threshold_fail_action"``] | for ImageDynamicSection, the action to take if the API returns no `validation: {}` object |
+| `extract_threshold_pass_action?` | ``"review"`` \| ``"next_step"`` | for ImageDynamicSection, the action to take if pre-verify passes |
+| `field_list?` | `string`[] | if supplied, only the fields that are listed should be shared (#520, #1024) |
+| `filter` | ``"oneOf"`` \| ``"anyOf"`` | - |
+| `multiple?` | `boolean` | if true mulitple POs can be shared |
+| `name?` | `string` \| `symbol` | if undefined, the schema title will be used |
+| `optional?` | `boolean` | if true this page can be skipped. The PageResult wil be undefined |
+| `optional_fields?` | `string`[] | a list of fields that should not be required, even if the schema says they're required |
+| `profile?` | `boolean` | if explictly == false, then it's an AO (not a PO), in which case there can only be one schema |
+| `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 |
+| `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` |

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/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];