@raytio/types 7.1.0 → 7.3.0

package/README.md

@@ -30,36 +30,46 @@ Hovering over the type in VSCode will display documentation and available proper
 
 - [FieldVerification](enums/FieldVerification.md)
 - [POVerification](enums/POVerification.md)
+- [SafeHarbourCode](enums/SafeHarbourCode.md)
 
 ### Type Aliases
 
 - [AA](#aa)
 - [AATag](#aatag)
 - [AId](#aid)
-- [AnyId](#anyid)
 - [Colors](#colors)
+- [CommonFields](#commonfields)
 - [CommonSchemaAttributes](#commonschemaattributes)
 - [ConditionallyRequired](#conditionallyrequired)
+- [ContactPoint](#contactpoint)
 - [CustomFonts](#customfonts)
 - [DataTypes](#datatypes)
 - [Encrypted](#encrypted)
 - [GId](#gid)
 - [IId](#iid)
 - [Instance](#instance)
+- [InstanceWithoutData](#instancewithoutdata)
+- [KId](#kid)
 - [LId](#lid)
+- [Location](#location)
 - [Lookup](#lookup)
 - [NId](#nid)
+- [NId2](#nid2)
 - [OId](#oid)
 - [Organization](#organization)
 - [PId](#pid)
+- [Party](#party)
+- [PartyMetadata](#partymetadata)
+- [PartySite](#partysite)
 - [ProfileObject](#profileobject)
-- [Properties](#properties)
 - [RealVer](#realver)
 - [Relationship](#relationship)
 - [Schema](#schema)
 - [SchemaField](#schemafield)
 - [SchemaFieldTag](#schemafieldtag)
+- [SchemaName](#schemaname)
 - [SchemaTag](#schematag)
+- [SchemaType](#schematype)
 - [ServerSchemaField](#serverschemafield)
 - [SubmissionStatus](#submissionstatus)
 - [UId](#uid)
@@ -90,18 +100,25 @@ Hovering over the type in VSCode will display documentation and available proper
 | `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. |
+| `active?` | `boolean` | - |
 | `auth_list_enabled?` | `boolean` | if true, only specific email addresses can submit the form |
 | `callback_uri?` | `string`[] | - |
 | `description?` | `string` | - |
+| `end_date?` | `Date` | - |
+| `key?` | `string` | - |
+| `logout_uri?` | `string`[] | - |
+| `metadata?` | `unknown` | - |
 | `name` | `string` | - |
 | `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 |
+| `picture?` | [`Urn`](#urn) | **`Deprecated`** see !2101 |
+| `picture_url?` | `string` | Easy to use AA logo url for pasting into emails |
 | `ruleset?` | `unknown` | configuration for the submission rules |
 | `scopes?` | `string`[] | - |
+| `secret?` | `unknown` | - |
 | `service_provider_n_id?` | [`NId`](#nid) | the n_id of the associated service provider |
+| `start_date?` | `Date` | Currently Unused Attributes |
 | `tags?` | [`AATag`](#aatag)[] | - |
-| `theme?` | { `colors?`: [`Colors`](#colors) ; `font?`: [`CustomFonts`](modules.md#customfonts)  } | - |
+| `theme?` | { `colors?`: [`Colors`](#colors) ; `font?`: [`CustomFonts`](#customfonts)  } | - |
 | `theme.colors?` | [`Colors`](#colors) | - |
 | `theme.font?` | [`CustomFonts`](#customfonts) | - |
 
@@ -121,12 +138,6 @@ 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)
-
-___
-
 ### Colors
 
 Ƭ **Colors**: `Object`
@@ -160,6 +171,40 @@ ___
 
 ___
 
+### CommonFields
+
+Ƭ **CommonFields**<`IdType`, `Metadata`\>: `Object`
+
+Every object in the new database has these fields. In the
+interest of type-safety, the `id` should be one of the
+well-known IDs that extend StringWithIdentity (e.g.
+[NId](#nid) or [AId](#aid)). If the ID is irrelevant, then
+use `CommonFields<never>` rather than `CommonFields<string>`.
+This will deliberately prevent you from utilising the `id`
+field until you define a special type for that ID.
+
+This is especially important with the new API where it is much
+easier to mix up the different types of IDs.
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `IdType` | extends `StringWithIdentity`<`string`\> |
+| `Metadata` | `unknown` |
+
+#### Type declaration
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `active` | `boolean` | - |
+| `end_date` | `string` | ISO Date |
+| `id` | `IdType` | - |
+| `metadata` | `Metadata` \| `undefined` | - |
+| `start_date` | `string` | ISO Date |
+
+___
+
 ### CommonSchemaAttributes
 
 Ƭ **CommonSchemaAttributes**: `Object`
@@ -171,6 +216,7 @@ not exported. Attributes that are identical in both client schema & server schem
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `description` | `string` | - |
+| `description_decorator?` | ``"md"`` | specifies that the description is formatted in markdown |
 | `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 |
@@ -179,19 +225,18 @@ not exported. Attributes that are identical in both client schema & server schem
 | `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 |
+| `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_long_verification_message`: { `description?`: `string` ; `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`  }  };  } | - |
+| `onboard_properties?` | { `organizations?`: { `access_applications?`: { `links?`: { `description`: `string` ; `wizardConfig`: `Omit`<[`WizardConfig`](#wizardconfig), ``"a_id"``\>  }[] ; `properties`: `Omit`<[`AA`](#aa), ``"org_id"``\>  }[] ; `properties`: [`Organization`](#organization)  }[] ; `profile_objects?`: { `properties`: `Record`<`string`, `unknown`\> ; `schema_name`: [`SchemaName`](#schemaname)  }[] ; `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`](#aa), ``"org_id"``\>  }[] ; `properties`: [`Organization`](#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`: [`SchemaName`](#schemaname)  }[] | 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?`: [`SchemaName`](#schemaname)[] ; `direction`: ``"from"`` ; `multiple?`: `boolean` ; `oneOf?`: ([`SchemaName`](#schemaname) \| ``"instance"``)[] ; `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. |
+| `schema_type?` | [`SchemaType`](#schematype) | - |
 | `tags?` | [`SchemaTag`](#schematag)[] | - |
-| `title` | `string` | - |
+| `title` | `string` | these fields will always exist on schema |
 | `title_plural?` | `string` | plural version of the title |
-| `type?` | [`DataTypes`](#datatypes) | - |
 
 ___
 
@@ -210,6 +255,35 @@ should be renamed since this applies to ConditionallyVerifiable
 
 ___
 
+### ContactPoint
+
+Ƭ **ContactPoint**: `Object`
+
+A Contact Point for an Organization
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `active` | `boolean` |
+| `contact_point_purpose` | `string` |
+| `contact_point_type` | `string` |
+| `e164` | `string` \| ``null`` |
+| `e164_suffix` | `string` \| ``null`` |
+| `e164_type` | `string` \| ``null`` |
+| `email_address` | `string` |
+| `email_address_preferred_format` | `string` |
+| `end_date` | `string` |
+| `id` | `string` |
+| `metadata` | `unknown` |
+| `start_date` | `string` |
+| `to_table` | `string` |
+| `url` | `string` \| ``null`` |
+| `url_type` | `string` \| ``null`` |
+| `uuid` | `string` \| `undefined` |
+
+___
+
 ### CustomFonts
 
 Ƭ **CustomFonts**: `Object`
@@ -270,30 +344,24 @@ ___
 
 ### Instance
 
-Ƭ **Instance**: `Object`
+Ƭ **Instance**: [`InstanceWithoutData`](#instancewithoutdata) & { `keys`: { `[nId2: NId2]`: { `[fieldName: string]`: { `data`: `string`  };  };  } ; `profile_objects`: [`ProfileObject`](#profileobject)[] ; `relationships`: [`Relationship`](#relationship)[]  }
 
-#### Type declaration
+The API used to store data in this format, but it no
+longer does :( so `@raytio/core` reconstructs this object.
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `_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` | { `[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 |
-| `relationships?` | [`Relationship`](#relationship)[] | - |
-| `score?` | `unknown` | added by the client once it calculates the score |
-| `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` | - |
+___
+
+### InstanceWithoutData
+
+Ƭ **InstanceWithoutData**: [`CommonFields`](#commonfields)<[`IId`](#iid), { `message?`: `string`  }\> & { `aa_id`: [`AId`](#aid) ; `aack_id`: [`KId`](#kid) ; `confirmation_code`: `string` ; `data_provider_email`: `string` ; `device_id?`: `unknown` ; `instance_version?`: `unknown` ; `platform_footer_html?`: `unknown` ; `previous_state?`: [`SubmissionStatus`](#submissionstatus) ; `reference`: `string` ; `related_offers?`: `unknown` ; `related_service_types?`: `unknown` ; `score?`: `unknown` ; `service_provider_n_id`: [`NId`](#nid) ; `source_ip?`: `unknown` ; `state`: [`SubmissionStatus`](#submissionstatus) ; `sub_service_provider_hash`: `string` ; `thread`: `string`  }
+
+___
+
+### KId
+
+Ƭ **KId**: `StringWithIdentity`<``"KId"``\>
+
+A `k_id` (also called a `aack_id` or a `publicKeyId`) is the ID of an AA's public key
 
 ___
 
@@ -305,6 +373,45 @@ An `l_id` is the ID of any data stored in the KV-Store
 
 ___
 
+### Location
+
+Ƭ **Location**: `Object`
+
+An Organization Location
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `active` | `boolean` |
+| `address_line_1` | `string` \| ``null`` |
+| `address_line_2` | `string` \| ``null`` |
+| `address_line_3` | `string` \| ``null`` |
+| `address_line_4` | `string` \| ``null`` |
+| `administrative_area_level_1` | `string` \| ``null`` |
+| `administrative_area_level_2` | `string` \| ``null`` |
+| `administrative_area_level_3` | `string` \| ``null`` |
+| `city` | `string` \| ``null`` |
+| `country` | `string` \| ``null`` |
+| `end_date` | `string` |
+| `geolocation` | `string` \| ``null`` |
+| `geolocation_outline` | `string` \| ``null`` |
+| `id` | `string` |
+| `locality` | `string` \| ``null`` |
+| `location_description` | `string` \| ``null`` |
+| `location_name` | `string` |
+| `metadata` | `unknown` |
+| `postal_code` | `string` |
+| `postal_code_suffix` | `string` \| ``null`` |
+| `premise` | `string` \| ``null`` |
+| `region` | `string` \| ``null`` |
+| `route` | `string` \| ``null`` |
+| `start_date` | `string` |
+| `street_number` | `string` \| ``null`` |
+| `subpremise` | `string` \| ``null`` |
+
+___
+
 ### Lookup
 
 Ƭ **Lookup**: `Object`
@@ -330,6 +437,14 @@ An `n_id` is the ID of a [ProfileObject](#profileobject)
 
 ___
 
+### NId2
+
+Ƭ **NId2**: `StringWithIdentity`<``"NId2"``\>
+
+⚠️ This ID duplicates the [NId](#nid) and should only be used in exceptional circumstances
+
+___
+
 ### OId
 
 Ƭ **OId**: `StringWithIdentity`<``"OId"``\>
@@ -349,14 +464,8 @@ NOTE: this is different to how the schema defines an Organization. **The schema
 
 | Name | Type |
 | :------ | :------ |
-| `address` | { `city`: `string` ; `country`: `string` ; `locationType`: `string` ; `region`: `string` ; `street1`: `string` ; `street2`: `string`  } |
-| `address.city` | `string` |
-| `address.country` | `string` |
-| `address.locationType` | `string` |
-| `address.region` | `string` |
-| `address.street1` | `string` |
-| `address.street2` | `string` |
-| `customer` | `Record`<`string`, `unknown`\> |
+| `address` | `unknown` |
+| `customer` | `unknown` |
 | `email` | `string` |
 | `id` | [`OId`](#oid) |
 | `name` | `string` |
@@ -371,41 +480,81 @@ A `p_id` is the ID of a [Relationship](#relationship)
 
 ___
 
-### ProfileObject
+### Party
 
-Ƭ **ProfileObject**<`Properties`\>: `Object`
+Ƭ **Party**: `Object`
 
-You can supply an option type argument if you know exactly what the properties will be
+An Organisation
 
-#### Type parameters
+#### Type declaration
 
 | Name | Type |
 | :------ | :------ |
-| `Properties` | `Json` |
+| `active` | `boolean` |
+| `end_date` | `string` |
+| `id` | `string` |
+| `metadata` | [`PartyMetadata`](#partymetadata) |
+| `party_description` | `string` |
+| `party_name` | `string` |
+| `party_number` | `number` |
+| `party_type` | `string` |
+| `start_date` | `string` |
+
+___
+
+### PartyMetadata
+
+Ƭ **PartyMetadata**: `Object`
+
+An Organizations credentials
 
 #### Type declaration
 
 | Name | Type |
 | :------ | :------ |
-| `labels` | `string`[] |
-| `n_id` | [`NId`](#nid) |
-| `properties` | `Properties` |
+| `centrix_credentials` | `unknown` |
+| `gandalf` | `unknown` |
+| `stripe` | { `customer`: `unknown`  } |
+| `stripe.customer` | `unknown` |
 
 ___
 
-### Properties
+### PartySite
 
-Ƭ **Properties**: `Json`
+Ƭ **PartySite**: `Object`
 
-arbitrary key-values pairs stored on a Profile Object.
-May contain nested JSON and [Encrypted](#encrypted) properties.
+An Organization Site
 
-There are some limits to field names: they cannot be called
-`__signature` nor can they include the character sequence `<=>`.
+#### Type declaration
 
-**`Deprecated`**
+| Name | Type |
+| :------ | :------ |
+| `active` | `boolean` |
+| `end_date` | `string` |
+| `id` | `string` |
+| `location_number` | `number` |
+| `metadata` | `unknown` |
+| `party_id` | `string` |
+| `party_site_description` | `string` \| ``null`` |
+| `party_site_name` | `string` |
+| `party_site_number` | `string` \| ``null`` |
+| `party_use_primary` | `string` |
+| `party_uses` | `string`[] |
+| `start_date` | `string` |
 
-- use Json
+___
+
+### ProfileObject
+
+Ƭ **ProfileObject**<`Properties`\>: `Partial`<[`CommonFields`](#commonfields)<[`NId2`](#nid2)\>\> & { `labels`: `string`[] ; `n_id`: [`NId`](#nid) ; `properties`: `Properties`  }
+
+You can supply an option type argument if you know exactly what the properties will be
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `Properties` | `Json` |
 
 ___
 
@@ -422,7 +571,7 @@ This is what @raytio/core exposes, which is more useable than [Verification](#ve
 | `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 |
+| `metadata?` | [`VerificationPayload`](#verificationpayload)<``false``\>[``"metadata"``] | arbitary metadata returned by the verifier |
 | `nID` | [`NId`](#nid) | nId of the verification |
 | `provider` | [`VerificationProvider`](#verificationprovider) | - |
 | `signature` | `string` | - |
@@ -440,19 +589,22 @@ ___
 
 | Name | Type |
 | :------ | :------ |
+| `active?` | `boolean` |
 | `end` | [`Urn`](#urn) |
+| `end_date?` | `string` |
 | `p_id` | [`PId`](#pid) |
 | `properties?` | { `[fieldName: string]`: `unknown`; `name?`: `string` ; `p_id`: [`PId`](#pid)  } |
 | `properties.name?` | `string` |
 | `properties.p_id` | [`PId`](#pid) |
 | `start` | [`Urn`](#urn) |
+| `start_date?` | `string` |
 | `type` | `string` |
 
 ___
 
 ### 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` ; `name`: [`SchemaName`](#schemaname) ; `properties`: { `[fieldName: string]`: [`SchemaField`](#schemafield);  } ; `required?`: (`string` \| [`ConditionallyRequired`](#conditionallyrequired))[] ; `start_date?`: `string` ; `timing?`: `Record`<``"extract"`` \| ``"live_person"`` \| ``"verify_pending_delay"``, `number`\> ; `type?`: [`DataTypes`](#datatypes) ; `verified_fields?`: (`string` \| [`ConditionallyRequired`](#conditionallyrequired))[] ; `version`: `string` ; `wasExpandedByClient?`: `boolean`  }
 
 Raytio's variant of JSON Schema, as used by the client. It is a modified version
 of what the API returns.
@@ -468,7 +620,7 @@ ___
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `$id?` | `string` | **`Deprecated`** don't use, it's inconsistent |
-| `$ref?` | `string` | If this field refers to a sub-object |
+| `$ref?` | [`SchemaName`](#schemaname) | 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)] | - |
 | `content?` | `string` | only checkbox uses this prop |
@@ -484,7 +636,7 @@ ___
 | `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?` | { `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);  } ; `type`: [`DataTypes`](#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 |
@@ -511,7 +663,15 @@ ___
 
 ### SchemaFieldTag
 
-Ƭ **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"``
+Ƭ **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"`` \| ``"action:require_webauthn"`` \| ``"verify:show_if_pending"`` \| ``"special:hide_select_behind_button"`` \| ``"type:capture_geolocation"`` \| ``"type:extract_required"``
+
+___
+
+### SchemaName
+
+Ƭ **SchemaName**: `StringWithIdentity`<``"SchemaName"``\>
+
+A `SchemaName` is the ID of a [Schema](#schema)
 
 ___
 
@@ -521,6 +681,14 @@ ___
 
 ___
 
+### SchemaType
+
+Ƭ **SchemaType**: ``"ss"`` \| ``"ps"`` \| ``"us"``
+
+Type Classification of a Schema returned by API
+
+___
+
 ### ServerSchemaField
 
 Ƭ **ServerSchemaField**: `Omit`<[`SchemaField`](#schemafield), ``"$prop"``\>
@@ -545,7 +713,7 @@ ___
 
 ### Urn
 
-Ƭ **Urn**: \`urn:${UrnNodeType}:${AnyId}\`
+Ƭ **Urn**: \`urn:user:${UId}\` \| \`urn:profile\_object:${NId}\` \| \`urn:instance:${IId}\` \| \`urn:temp\_object:${LId}\` \| \`urn:schema:${SchemaName}\` \| \`urn:document:${NId}\`
 
 e.g. "urn:user:..."
 
@@ -575,7 +743,7 @@ ___
 
 ### Verification
 
-Ƭ **Verification**<`WithValue`\>: [`ProfileObject`](#profileobject)<{ `field`: `string` ; `n_id`: [`NId`](modules.md#nid) ; `valid_until?`: `string` ; `verifications`: [{ `data`: [`VerificationPayload`](modules.md#verificationpayload)<`WithValue`\> ; `signature`: `string`  }]  }\>
+Ƭ **Verification**<`WithValue`\>: [`ProfileObject`](#profileobject)<{ `field`: `string` ; `n_id`: [`NId`](#nid) ; `valid_until?`: `string` ; `verifications`: [{ `data`: [`VerificationPayload`](#verificationpayload)<`WithValue`\> ; `hashing_algorithm?`: ``"SHA512"`` ; `key_id?`: `string` ; `key_urn?`: `string` ; `signature`: `string` ; `signing_algorithm?`: ``"RSASSA_PSS_SHA_512"``  }]  }\>
 
 Different APIs inconsistently include the `value` prop. If you know it exists,
 use `Verification<true>`, otherwise just `Verification`. Verifications from
@@ -591,7 +759,7 @@ ___
 
 ### 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` ; `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?`: { `[otherAttributes: string]`: `unknown`; `pending_details?`: { `pending_time`: ``"short"`` \| ``"long"`` ; `pending_type`: ``"time"`` \| ``"user"``  } ; `safeHarbourScore?`: [`SafeHarbourCode`](enums/SafeHarbourCode.md) ; `status?`: ``"pending"``  } ; `passed`: `boolean` ; `request_div`: `string` ; `schema?`: [`SchemaName`](#schemaname) ; `source`: `string` ; `source_hashed_n_id?`: [`NId`](#nid) ; `source_n_id?`: [`NId`](#nid) ; `type?`: ``null`` ; `v_id`: `string` ; `verification_date`: `string` ; `verifier_div`: `string` ; `verifier_id?`: [`NId`](#nid) ; `verifier_service_id?`: [`NId`](#nid) ; `verifier_source_id?`: [`NId`](#nid)  } & `WithValue` extends ``true`` ? { `value`: `string` \| `number`  } : {}
 
 #### Type parameters
 
@@ -674,6 +842,7 @@ in the query parameters, it needs to be base64 and/or url encoded.
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `a_id` | [`AId`](#aid) | - |
+| `display_sharing_preview?` | `boolean` | If this value is true, the form will display some data sharing information before the form (WizardPreview) |
 | `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)[] | - |
@@ -683,11 +852,12 @@ in the query parameters, it needs to be base64 and/or url encoded.
 | `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 |
+| `signature_schema?` | [`SchemaName`](#schemaname) | 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 |
+| `terms_schema?` | [`SchemaName`](#schemaname) | 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 |
+| `webauthn_type?` | (``"usb"`` \| ``"nfc"`` \| ``"ble"`` \| ``"internal"``)[] | if specified, the user must validate their WebAuthN credential before they can submit the form |
 
 ___
 
@@ -725,7 +895,7 @@ configuration data for a single wizard page ([WizardConfig](#wizardconfig))
 | `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`[] | - |
+| `schemas` | [`SchemaName`](#schemaname)[] | - |
 | `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. |
@@ -752,9 +922,9 @@ 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`, { `$ref`: [`Urn`](modules.md#urn)  }\> ; `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`](#wrappedschema)[``"schema"``]\> ; `then?`: `Partial`<[`WrappedSchema`](#wrappedschema)[``"schema"``]\>  }[] ; `definitions?`: `Record`<`string`, { `$ref`: [`Urn`](#urn)  }\> ; `properties`: { `[fieldName: string]`: [`ServerSchemaField`](#serverschemafield);  } ; `required?`: `string`[] ; `verified_fields?`: `string`[]  } | - |
+| `schema_name` | [`SchemaName`](#schemaname) | Schema Name Type and Version Properties |
+| `schema_type` | [`SchemaType`](#schematype) | - |
+| `schema_version` | `string` | - |
 | `start_date` | `string` | ISO Date |
-| `type` | ``"ss"`` \| ``"ps"`` \| ``"us"`` | - |
-| `version` | `string` | - |
 | `version_current` | `boolean` | whether the `version` is the latest version |

package/dist/index.d.ts

@@ -4,3 +4,4 @@ export * from "./schema";
 export * from "./theme";
 export * from "./verification";
 export * from "./wizard";
+export * from "./orgs";

package/dist/index.js

@@ -20,3 +20,4 @@ __exportStar(require("./schema"), exports);
 __exportStar(require("./theme"), exports);
 __exportStar(require("./verification"), exports);
 __exportStar(require("./wizard"), exports);
+__exportStar(require("./orgs"), exports);