npm - @raytio/types - Versions diffs - 7.1.0 → 7.2.0 - Mend

@raytio/types 7.1.0 → 7.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (19) hide show

package/README.md +183 -48
package/dist/index.d.ts +1 -0
package/dist/index.js +1 -0
package/dist/orgs.d.ts +84 -0
package/dist/orgs.js +2 -0
package/dist/raytio.d.ts +33 -24
package/dist/schema.d.ts +18 -6
package/dist/verification.d.ts +34 -2
package/dist/verification.js +13 -3
package/dist/wizard.d.ts +4 -0
package/package.json +1 -1
package/src/__tests__/raytio.typetest.ts +6 -0
package/src/index.ts +1 -0
package/src/orgs.ts +86 -0
package/src/raytio.ts +43 -26
package/src/schema.ts +26 -6
package/src/verification.ts +38 -2
package/src/wizard.ts +6 -0
/package/src/__tests__/{schema.ts → schema.typetest.ts} +0 -0

package/README.md CHANGED Viewed

@@ -30,16 +30,17 @@ 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)
 - [CommonSchemaAttributes](#commonschemaattributes)
 - [ConditionallyRequired](#conditionallyrequired)
+- [ContactPoint](#contactpoint)
 - [CustomFonts](#customfonts)
 - [DataTypes](#datatypes)
 - [Encrypted](#encrypted)
@@ -47,19 +48,23 @@ Hovering over the type in VSCode will display documentation and available proper
 - [IId](#iid)
 - [Instance](#instance)
 - [LId](#lid)
+- [Location](#location)
 - [Lookup](#lookup)
 - [NId](#nid)
 - [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)
 - [SchemaTag](#schematag)
+- [SchemaType](#schematype)
 - [ServerSchemaField](#serverschemafield)
 - [SubmissionStatus](#submissionstatus)
 - [UId](#uid)
@@ -90,16 +95,23 @@ 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) | - |
@@ -121,12 +133,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`
@@ -171,6 +177,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,8 +186,7 @@ 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 |
+| `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`](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 |
@@ -188,10 +194,10 @@ not exported. Attributes that are identical in both client schema & server schem
 | `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. |
+| `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 +216,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`
@@ -279,17 +314,26 @@ ___
 | `_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 |
+| `aack_id?` | `string` | Key (Can be used to retrieve instance) |
+| `active?` | `boolean` | Activity Status |
 | `confirmation_code` | `string` | Code that validates information has been shared |
 | `data_provider_email` | `string` | Email of user who shared the data |
+| `device_id?` | `unknown` | Device Id |
 | `end_date` | `string` | Latest date in which the shared information was available |
 | `i_id` | [`IId`](#iid) | Access application instance ID |
+| `instance_version?` | `unknown` | Instance Version |
 | `keys` | { `[nId: NId]`: { `[fieldName: string]`: { `data`: `string` ; `n_id`: [`NId`](#nid)  };  };  } | - |
-| `previous_state` | [`SubmissionStatus`](#submissionstatus) | Previous status of the shared information |
+| `metadata?` | `unknown` | Metadata |
+| `platform_footer_html?` | `unknown` | Footer Html |
+| `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 |
+| `related_offers?` | `unknown` | Related Offers |
+| `related_service_types?` | `unknown` | Related Service Types |
 | `relationships?` | [`Relationship`](#relationship)[] | - |
 | `score?` | `unknown` | added by the client once it calculates the score |
 | `service_provider_n_id?` | [`NId`](#nid) | Service provider ID |
+| `source_ip?` | `unknown` | Source IP |
 | `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 |
@@ -305,6 +349,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`
@@ -349,14 +432,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 +448,89 @@ 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
+Ƭ **PartySite**: `Object`
+An Organization Site
+#### Type declaration
+| 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` |
-Ƭ **Properties**: `Json`
+___
-arbitrary key-values pairs stored on a Profile Object.
-May contain nested JSON and [Encrypted](#encrypted) properties.
+### ProfileObject
-There are some limits to field names: they cannot be called
-`__signature` nor can they include the character sequence `<=>`.
+Ƭ **ProfileObject**<`Properties`\>: `Object`
-**`Deprecated`**
+You can supply an option type argument if you know exactly what the properties will be
-- use Json
+#### Type parameters
+| Name | Type |
+| :------ | :------ |
+| `Properties` | `Json` |
+#### Type declaration
+| Name | Type |
+| :------ | :------ |
+| `labels` | `string`[] |
+| `n_id` | [`NId`](#nid) |
+| `properties` | `Properties` |
 ___
@@ -422,7 +547,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` | - |
@@ -452,7 +577,7 @@ ___
 ### Schema
-Ƭ **Schema**: [`CommonSchemaAttributes`](#commonschemaattributes) & { `clientLocale?`: `string` ; `end_date?`: `string` ; `groupNames?`: `Record`<`string`, `string`\> ; `group_title?`: `string` ; `isProfileSchema?`: `boolean` ; `isSpSchema?`: `boolean` ; `properties`: { `[fieldName: string]`: [`SchemaField`](modules.md#schemafield);  } ; `required?`: (`string` \| [`ConditionallyRequired`](modules.md#conditionallyrequired))[] ; `start_date?`: `string` ; `timing?`: `Record`<``"extract"`` \| ``"live_person"`` \| ``"verify_pending_delay"``, `number`\> ; `verified_fields?`: (`string` \| [`ConditionallyRequired`](modules.md#conditionallyrequired))[] ; `version`: `string` ; `wasExpandedByClient?`: `boolean`  }
+Ƭ **Schema**: [`CommonSchemaAttributes`](#commonschemaattributes) & { `clientLocale?`: `string` ; `end_date?`: `string` ; `groupNames?`: `Record`<`string`, `string`\> ; `group_title?`: `string` ; `isProfileSchema?`: `boolean` ; `isSpSchema?`: `boolean` ; `name`: `string` ; `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`\> ; `type?`: [`DataTypes`](modules.md#datatypes) ; `verified_fields?`: (`string` \| [`ConditionallyRequired`](modules.md#conditionallyrequired))[] ; `version`: `string` ; `wasExpandedByClient?`: `boolean`  }
 Raytio's variant of JSON Schema, as used by the client. It is a modified version
 of what the API returns.
@@ -511,7 +636,7 @@ ___
 ### 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"``
 ___
@@ -521,6 +646,14 @@ ___
 ___
+### SchemaType
+Ƭ **SchemaType**: ``"ss"`` \| ``"ps"`` \| ``"us"``
+Type Classification of a Schema returned by API
+___
 ### ServerSchemaField
 Ƭ **ServerSchemaField**: `Omit`<[`SchemaField`](#schemafield), ``"$prop"``\>
@@ -545,7 +678,7 @@ ___
 ### Urn
-Ƭ **Urn**: \`urn:${UrnNodeType}:${AnyId}\`
+Ƭ **Urn**: \`urn:user:${UId}\` \| \`urn:profile\_object:${NId}\` \| \`urn:instance:${IId}\` \| \`urn:temp\_object:${LId}\` \| \`urn:schema:${string}\` \| \`urn:document:${NId}\`
 e.g. "urn:user:..."
@@ -575,7 +708,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`](modules.md#nid) ; `valid_until?`: `string` ; `verifications`: [{ `data`: [`VerificationPayload`](modules.md#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 +724,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?`: `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
@@ -674,6 +807,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)[] | - |
@@ -688,6 +822,7 @@ in the query parameters, it needs to be base64 and/or url encoded.
 | `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 |
+| `webauthn_type?` | (``"usb"`` \| ``"nfc"`` \| ``"ble"`` \| ``"internal"``)[] | if specified, the user must validate their WebAuthN credential before they can submit the form |
 ___
@@ -752,9 +887,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_name` | `string` | 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 CHANGED Viewed

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

package/dist/index.js CHANGED Viewed

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

package/dist/orgs.d.ts ADDED Viewed

@@ -0,0 +1,84 @@
+/** Types Used for Organization Related API Responses */
+/** An Organisation */
+export type Party = {
+    id: string;
+    start_date: string;
+    end_date: string;
+    active: boolean;
+    party_name: string;
+    party_description: string;
+    party_type: string;
+    metadata: PartyMetadata;
+    party_number: number;
+};
+/** An Organizations credentials */
+export type PartyMetadata = {
+    gandalf: unknown;
+    stripe: {
+        customer: unknown;
+    };
+    centrix_credentials: unknown;
+};
+/** An Organization Site */
+export type PartySite = {
+    id: string;
+    start_date: string;
+    end_date: string;
+    active: boolean;
+    party_id: string;
+    location_number: number;
+    party_site_name: string;
+    party_site_description: string | null;
+    party_site_number: string | null;
+    party_uses: string[];
+    party_use_primary: string;
+    metadata: unknown;
+};
+/** An Organization Location */
+export type Location = {
+    id: string;
+    start_date: string;
+    end_date: string;
+    active: boolean;
+    location_name: string;
+    location_description: string | null;
+    address_line_1: string | null;
+    address_line_2: string | null;
+    address_line_3: string | null;
+    address_line_4: string | null;
+    premise: string | null;
+    subpremise: string | null;
+    street_number: string | null;
+    administrative_area_level_1: string | null;
+    administrative_area_level_2: string | null;
+    administrative_area_level_3: string | null;
+    route: string | null;
+    locality: string | null;
+    postal_code: string;
+    postal_code_suffix: string | null;
+    city: string | null;
+    region: string | null;
+    country: string | null;
+    geolocation: string | null;
+    geolocation_outline: string | null;
+    metadata: unknown;
+};
+/** A Contact Point for an Organization */
+export type ContactPoint = {
+    id: string;
+    start_date: string;
+    end_date: string;
+    active: boolean;
+    to_table: string;
+    uuid: string | undefined;
+    contact_point_purpose: string;
+    contact_point_type: string;
+    e164: string | null;
+    e164_suffix: string | null;
+    e164_type: string | null;
+    url: string | null;
+    url_type: string | null;
+    email_address: string;
+    email_address_preferred_format: string;
+    metadata: unknown;
+};

package/dist/orgs.js ADDED Viewed

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

package/dist/raytio.d.ts CHANGED Viewed

@@ -23,7 +23,6 @@ export type OId = StringWithIdentity<"OId">;
 /** A `wi_id` is the ID of a {@link Webhook} */
 export type WId = StringWithIdentity<"WId">;
 /** An `l_id` is the ID of any data stored in the KV-Store */ export type LId = StringWithIdentity<"LId">;
-export type AnyId = PId | IId | NId | GId | UId | AId | OId | WId;
 export type DataTypes = "string" | "number" | "boolean" | "object" | "integer" | "array" | "null";
 export type SubmissionStatus = "Submitted" | "Processing" | "Rejected" | "Expired" | "Completed" | "DataChanged" | "Received" | "Accepted";
 /** You can supply an option type argument if you know exactly what the properties will be */
@@ -50,19 +49,9 @@ export type ProfileObjectForUpload<Properties = Json> = {
     schema?: string;
     n_id?: NId;
 };
-/**
- * arbitrary key-values pairs stored on a Profile Object.
- * May contain nested JSON and {@link Encrypted} properties.
- *
- * There are some limits to field names: they cannot be called
- * `__signature` nor can they include the character sequence `<=>`.
- *
- * @deprecated - use {@link Json}
- */
-export type Properties = Json;
 export type UrnNodeType = "user" | "profile_object" | "instance" | "schema" | "temp_object" | "document";
 /** e.g. "urn:user:..." */
-export type Urn = `urn:${UrnNodeType}:${AnyId}`;
+export type Urn = `urn:user:${UId}` | `urn:profile_object:${NId}` | `urn:instance:${IId}` | `urn:temp_object:${LId}` | `urn:schema:${string}` | `urn:document:${NId}`;
 export type Relationship = {
     start: Urn;
     end: Urn;
@@ -91,8 +80,9 @@ export type AA = {
     description?: string;
     /** If a user signs up while completing this form, this message will be sent in the sign up email.  */
     aa_introduction?: string;
+    /** @deprecated see !2101 */
     picture?: Urn;
-    /** Easy to use AA logo url for pasting inot emails */
+    /** Easy to use AA logo url for pasting into emails */
     picture_url?: string;
     scopes?: string[];
     tags?: AATag[];
@@ -111,6 +101,14 @@ export type AA = {
     ruleset?: unknown;
     /** if true, only specific email addresses can submit the form */
     auth_list_enabled?: boolean;
+    /** Currently Unused Attributes */
+    start_date?: Date;
+    end_date?: Date;
+    active?: boolean;
+    key?: string;
+    logout_uri?: string[];
+    metadata?: unknown;
+    secret?: unknown;
     /** @internal */
     transitions?: unknown[];
 };
@@ -136,8 +134,6 @@ export type Instance = {
     state: SubmissionStatus;
     /** @deprecated The status of a submission */
     _state?: SubmissionStatus;
-    /** Previous status of the shared information */
-    previous_state: SubmissionStatus;
     /** Hash of the Service Provider ID */
     sub_service_provider_hash?: string;
     /** Service provider ID */
@@ -155,6 +151,26 @@ export type Instance = {
     relationships?: Relationship[];
     /** added by the client once it calculates the score */
     score?: unknown;
+    /** Previous status of the shared information */
+    previous_state?: SubmissionStatus;
+    /** Device Id */
+    device_id?: unknown;
+    /** Source IP */
+    source_ip?: unknown;
+    /** Related Offers */
+    related_offers?: unknown;
+    /** Instance Version */
+    instance_version?: unknown;
+    /** Footer Html */
+    platform_footer_html?: unknown;
+    /** Related Service Types */
+    related_service_types?: unknown;
+    /** Activity Status */
+    active?: boolean;
+    /** Key (Can be used to retrieve instance) */
+    aack_id?: string;
+    /** Metadata */
+    metadata?: unknown;
 };
 /**
  * An organization.
@@ -164,15 +180,8 @@ export type Organization = {
     id: OId;
     name: string;
     email: string;
-    address: {
-        locationType: string;
-        street1: string;
-        street2: string;
-        city: string;
-        region: string;
-        country: string;
-    };
-    customer: Record<string, unknown>;
+    address: unknown;
+    customer: unknown;
 };
 /** @internal some APIs now return extra info */
 export type FullOrg = {

package/dist/schema.d.ts CHANGED Viewed

@@ -7,7 +7,7 @@ export type ConditionallyRequired = {
         [fieldName: string]: (string | number | boolean)[];
     };
 };
-export type SchemaFieldTag = "password" | `group:${string}` | `upload-group:${string}` | "display:stars" | "display:no_autofill" | "display:currency" | "display:cascade" | "display:survey" | "display:quoting" | "display:customModal" | `display:replace:'${string}':'${string}'` | "display:terms_conditions" | `display:main_media:${string}` | "date_component:day" | "date_component:month" | "date_component:year" | "action:client_upload" | "verify:show_if_pending" | "special:hide_select_behind_button" | "type:capture_geolocation" | "type:extract_required";
+export type 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";
 export type SchemaTag = "action:experimental_pass_object_store_id" | "action:verify" | "default_camera:rear" | "default_camera:front" | `oauth2_component:name:${string}` | `oauth2_component:redirect_url:${string}` | `time:${string}:${number}` | `link_to:${string}:${string}` | "type:service_provider" | "type:service_offer" | "type:marketplace" | "type:client_only" | "type:globally_unique_field";
 export type SchemaField = {
     /** @deprecated don't use, it's inconsistent */
@@ -108,11 +108,12 @@ export type SchemaField = {
 export type ServerSchemaField = Omit<SchemaField, "$prop">;
 /** not exported. Attributes that are identical in both client schema & server schema */
 export type CommonSchemaAttributes = {
-    type?: DataTypes;
     /** these fields will always exist on schema */
-    name: string;
     title: string;
     description: string;
+    /** specifies that the description is formatted in markdown */
+    description_decorator?: "md";
+    schema_type?: SchemaType;
     /** plural version of the title */
     title_plural?: string;
     /**
@@ -158,6 +159,10 @@ export type CommonSchemaAttributes = {
             $loading_pending_ver_resubmit: {
                 title: string;
             };
+            $loading_long_verification_message: {
+                title?: string;
+                description?: string;
+            };
             [fieldNameOrGroupName: string]: ServerSchemaField & {
                 title_plural?: string;
             };
@@ -248,6 +253,10 @@ export type CommonSchemaAttributes = {
  * of what the API returns.
  */
 export type Schema = CommonSchemaAttributes & {
+    /** added by the client, copied from {@link WrappedSchema} */
+    name: string;
+    /** added by client */
+    type?: DataTypes;
     /** the localized title of the `schema_group`. added by the client */
     group_title?: string;
     /** originally `string[]`, the client modifies this */
@@ -280,6 +289,8 @@ export type Schema = CommonSchemaAttributes & {
     /** added by the client. If true, this schema somehow relates to legacy service providers */
     isSpSchema?: boolean;
 };
+/** Type Classification of a Schema returned by API */
+export type SchemaType = "ss" | "ps" | "us";
 /** This is what's returned by the API */
 export type WrappedSchema = {
     active: true;
@@ -287,9 +298,10 @@ export type WrappedSchema = {
     start_date: string;
     /** ISO Date. If this tag exists, the schema is deprecated. */
     end_date: string;
-    name: string;
-    type: "ss" | "ps" | "us";
-    version: string;
+    /** Schema Name Type and Version Properties */
+    schema_name: string;
+    schema_type: SchemaType;
+    schema_version: string;
     /** whether the \`version\` is the latest version */
     version_current: boolean;
     schema: CommonSchemaAttributes & {

package/dist/verification.d.ts CHANGED Viewed

@@ -1,8 +1,32 @@
 import { NId, ProfileObject } from "./raytio";
+export declare enum SafeHarbourCode {
+    /** “a match has been made on each the Full Name, Address and Date of Birth” */
+    M1 = "M1",
+    /** “a match has been made on both Full Name and Date of Birth (but not Address)” */
+    M2 = "M2",
+    /** “a match has been made on both Full Name and Address (but not Date of Birth)” */
+    N1 = "N1"
+}
 export type VerificationPayload<WithValue extends boolean> = {
     field: string;
     schema?: string;
-    metadata?: Record<string, unknown>;
+    metadata?: {
+        safeHarbourScore?: SafeHarbourCode;
+        status?: "pending";
+        pending_details?: {
+            /**
+             * for pending verifications - whether the verifier will complete fast enough that
+             * we can show a loading indicator. If not, the user has to come back another day.
+             */
+            pending_time: "short" | "long";
+            /**
+             * for pending verifications - whether further user interaction is required to
+             * complete the verification, or if it will complete silently in the background.
+             */
+            pending_type: "time" | "user";
+        };
+        [otherAttributes: string]: unknown;
+    };
     passed: boolean;
     request_div: string;
     /** @deprecated don't use this, it looks like the schema name but it's not */
@@ -39,6 +63,14 @@ export type Verification<WithValue extends boolean = false> = ProfileObject<{
         {
             signature: string;
             data: VerificationPayload<WithValue>;
+            /** undefined for data created before July 2023 */
+            key_id?: string;
+            /** undefined for data created before July 2023 */
+            key_urn?: string;
+            /** undefined for data created before July 2023 */
+            signing_algorithm?: "RSASSA_PSS_SHA_512";
+            /** undefined for data created before July 2023 */
+            hashing_algorithm?: "SHA512";
         }
     ];
 }>;
@@ -81,7 +113,7 @@ export type RealVer = {
      */
     verified: boolean;
     /** arbitary metadata returned by the verifier */
-    metadata?: Record<string, unknown>;
+    metadata?: VerificationPayload<false>["metadata"];
     /** nId of the verification */
     nID: NId;
     /** nId of the PO that the verification belongs to. Could be undefined */

package/dist/verification.js CHANGED Viewed

@@ -1,6 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.POVerification = exports.FieldVerification = void 0;
+exports.POVerification = exports.FieldVerification = exports.SafeHarbourCode = void 0;
+// see #659
+var SafeHarbourCode;
+(function (SafeHarbourCode) {
+    /** “a match has been made on each the Full Name, Address and Date of Birth” */
+    SafeHarbourCode["M1"] = "M1";
+    /** “a match has been made on both Full Name and Date of Birth (but not Address)” */
+    SafeHarbourCode["M2"] = "M2";
+    /** “a match has been made on both Full Name and Address (but not Date of Birth)” */
+    SafeHarbourCode["N1"] = "N1";
+})(SafeHarbourCode || (exports.SafeHarbourCode = SafeHarbourCode = {}));
 /**
  * "Not Verified" means show no badge, cf. "Verified False" means the
  * verifier revealed that the data was wrong. So show a ❌
@@ -13,7 +23,7 @@ var FieldVerification;
     FieldVerification[FieldVerification["NotVerified"] = 60002] = "NotVerified";
     FieldVerification[FieldVerification["VerifiedFalse"] = 60003] = "VerifiedFalse";
     FieldVerification[FieldVerification["Expired"] = 60004] = "Expired";
-})(FieldVerification = exports.FieldVerification || (exports.FieldVerification = {}));
+})(FieldVerification || (exports.FieldVerification = FieldVerification = {}));
 // We cannot change the enum values, since ScoreRules have been generated
 // with the enum values hardcoded.
 var POVerification;
@@ -25,4 +35,4 @@ var POVerification;
     POVerification[POVerification["NotVerified"] = 70005] = "NotVerified";
     POVerification[POVerification["Expired"] = 70006] = "Expired";
     POVerification[POVerification["Loading"] = 70007] = "Loading";
-})(POVerification = exports.POVerification || (exports.POVerification = {}));
+})(POVerification || (exports.POVerification = POVerification = {}));

package/dist/wizard.d.ts CHANGED Viewed

@@ -102,6 +102,8 @@ export type WizardConfig = {
     quick_onboard?: boolean;
     /** the loading message to show next to the spinner after the review screen */
     sharing_data_message?: string;
+    /** If this value is true, the form will display some data sharing information before the form (WizardPreview) */
+    display_sharing_preview?: boolean;
     /** a list of relationships that should be created after the wizard completes (see #987) */
     relationships?: {
         /** schema name */
@@ -113,4 +115,6 @@ export type WizardConfig = {
         /** relationship properties */
         properties?: Record<string, any>;
     }[];
+    /** if specified, the user must validate their WebAuthN credential before they can submit the form */
+    webauthn_type?: ("usb" | "nfc" | "ble" | "internal")[];
 };

package/package.json CHANGED Viewed

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

package/src/__tests__/raytio.typetest.ts ADDED Viewed

@@ -0,0 +1,6 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import { Urn, UrnNodeType } from "..";
+// test that the definition of `Urn` only uses valid `UrnNodeType`s
+const assertTrue: Urn extends `urn:${UrnNodeType}:${string}` ? true : false =
+  true;

package/src/index.ts CHANGED Viewed

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

package/src/orgs.ts ADDED Viewed

@@ -0,0 +1,86 @@
+/** Types Used for Organization Related API Responses */
+/** An Organisation */
+export type Party = {
+  id: string;
+  start_date: string;
+  end_date: string;
+  active: boolean;
+  party_name: string;
+  party_description: string;
+  party_type: string;
+  metadata: PartyMetadata;
+  party_number: number;
+};
+/** An Organizations credentials */
+export type PartyMetadata = {
+  gandalf: unknown;
+  stripe: { customer: unknown };
+  centrix_credentials: unknown;
+};
+/** An Organization Site */
+export type PartySite = {
+  id: string;
+  start_date: string;
+  end_date: string;
+  active: boolean;
+  party_id: string;
+  location_number: number;
+  party_site_name: string;
+  party_site_description: string | null;
+  party_site_number: string | null;
+  party_uses: string[];
+  party_use_primary: string;
+  metadata: unknown;
+};
+/** An Organization Location */
+export type Location = {
+  id: string;
+  start_date: string;
+  end_date: string;
+  active: boolean;
+  location_name: string;
+  location_description: string | null;
+  address_line_1: string | null;
+  address_line_2: string | null;
+  address_line_3: string | null;
+  address_line_4: string | null;
+  premise: string | null;
+  subpremise: string | null;
+  street_number: string | null;
+  administrative_area_level_1: string | null;
+  administrative_area_level_2: string | null;
+  administrative_area_level_3: string | null;
+  route: string | null;
+  locality: string | null;
+  postal_code: string;
+  postal_code_suffix: string | null;
+  city: string | null;
+  region: string | null;
+  country: string | null;
+  geolocation: string | null;
+  geolocation_outline: string | null;
+  metadata: unknown;
+};
+/** A Contact Point for an Organization */
+export type ContactPoint = {
+  id: string;
+  start_date: string;
+  end_date: string;
+  active: boolean;
+  to_table: string;
+  uuid: string | undefined;
+  contact_point_purpose: string;
+  contact_point_type: string;
+  e164: string | null;
+  e164_suffix: string | null;
+  e164_type: string | null;
+  url: string | null;
+  url_type: string | null;
+  email_address: string;
+  email_address_preferred_format: string;
+  metadata: unknown;
+};

package/src/raytio.ts CHANGED Viewed

@@ -26,8 +26,6 @@ export type WId = StringWithIdentity<"WId">;
 /** An `l_id` is the ID of any data stored in the KV-Store */ // e.g. StoredWizardConfig and VerBundleMetadata
 export type LId = StringWithIdentity<"LId">;
-export type AnyId = PId | IId | NId | GId | UId | AId | OId | WId;
 export type DataTypes =
   | "string"
   | "number"
@@ -76,17 +74,6 @@ export type ProfileObjectForUpload<Properties = Json> = {
   n_id?: NId; // only if editing an existing PO
 };
-/**
- * arbitrary key-values pairs stored on a Profile Object.
- * May contain nested JSON and {@link Encrypted} properties.
- *
- * There are some limits to field names: they cannot be called
- * `__signature` nor can they include the character sequence `<=>`.
- *
- * @deprecated - use {@link Json}
- */
-export type Properties = Json;
 export type UrnNodeType =
   | "user"
   | "profile_object"
@@ -96,7 +83,13 @@ export type UrnNodeType =
   | "document";
 /** e.g. "urn:user:..." */
-export type Urn = `urn:${UrnNodeType}:${AnyId}`;
+export type Urn =
+  | `urn:user:${UId}`
+  | `urn:profile_object:${NId}`
+  | `urn:instance:${IId}`
+  | `urn:temp_object:${LId}`
+  | `urn:schema:${/* schemaName */ string}`
+  | `urn:document:${NId}`;
 export type Relationship = {
   start: Urn;
@@ -135,8 +128,9 @@ export type AA = {
   description?: string;
   /** If a user signs up while completing this form, this message will be sent in the sign up email.  */
   aa_introduction?: string;
+  /** @deprecated see !2101 */
   picture?: Urn;
-  /** Easy to use AA logo url for pasting inot emails */
+  /** Easy to use AA logo url for pasting into emails */
   picture_url?: string;
   scopes?: string[];
   tags?: AATag[];
@@ -159,6 +153,15 @@ export type AA = {
   /** if true, only specific email addresses can submit the form */
   auth_list_enabled?: boolean;
+  /** Currently Unused Attributes */
+  start_date?: Date;
+  end_date?: Date;
+  active?: boolean;
+  key?: string;
+  logout_uri?: string[];
+  metadata?: unknown;
+  secret?: unknown;
   /** @internal */
   transitions?: unknown[];
 };
@@ -185,8 +188,7 @@ export type Instance = {
   state: SubmissionStatus;
   /** @deprecated The status of a submission */
   _state?: SubmissionStatus;
-  /** Previous status of the shared information */
-  previous_state: SubmissionStatus;
   /** Hash of the Service Provider ID */
   sub_service_provider_hash?: string;
   /** Service provider ID */
@@ -208,6 +210,28 @@ export type Instance = {
   // Defined as `unknown` instead of `ScoreResult` because it could be nonsense,
   // or a deprected version of `ScoreResult`.
   score?: unknown;
+  // Currently Unused properties
+  /** Previous status of the shared information */
+  previous_state?: SubmissionStatus;
+  /** Device Id */
+  device_id?: unknown;
+  /** Source IP */
+  source_ip?: unknown;
+  /** Related Offers */
+  related_offers?: unknown;
+  /** Instance Version */
+  instance_version?: unknown;
+  /** Footer Html */
+  platform_footer_html?: unknown;
+  /** Related Service Types */
+  related_service_types?: unknown;
+  /** Activity Status */
+  active?: boolean;
+  /** Key (Can be used to retrieve instance) */
+  aack_id?: string;
+  /** Metadata */
+  metadata?: unknown;
 };
 /**
@@ -218,15 +242,8 @@ export type Organization = {
   id: OId;
   name: string;
   email: string;
-  address: {
-    locationType: string;
-    street1: string;
-    street2: string;
-    city: string;
-    region: string;
-    country: string;
-  };
-  customer: Record<string, unknown>;
+  address: unknown; // Waiting on Backend Progress Before being properly updated (as of #1361)
+  customer: unknown; // Waiting on Backend Progress Before being properly updated (as of #1361) (was previously Record<string, unknown>)
 };
 /** @internal some APIs now return extra info */

package/src/schema.ts CHANGED Viewed

@@ -33,6 +33,7 @@ export type SchemaFieldTag =
   | "date_component:year"
   // other
   | "action:client_upload"
+  | "action:require_webauthn"
   | "verify:show_if_pending"
   | "special:hide_select_behind_button"
   | "type:capture_geolocation" // triggers the wizard's GeoLocationInput field
@@ -164,15 +165,17 @@ export type ServerSchemaField = Omit<SchemaField, "$prop">;
 /** not exported. Attributes that are identical in both client schema & server schema */
 export type CommonSchemaAttributes = {
-  type?: DataTypes;
   /** these fields will always exist on schema */
-  name: string;
   title: string;
   description: string;
+  /** specifies that the description is formatted in markdown */
+  description_decorator?: "md";
+  schema_type?: SchemaType;
   /** plural version of the title */
   title_plural?: string;
   /**
    * the group that a schema belongs to, such as "passports". This is useful for
    * forms that accept different types of similar documents.
@@ -200,6 +203,10 @@ export type CommonSchemaAttributes = {
       $loading_link_to_person: { title: string };
       $loading_delete_pending_ver: { title: string };
       $loading_pending_ver_resubmit: { title: string };
+      $loading_long_verification_message: {
+        title?: string;
+        description?: string;
+      };
       [fieldNameOrGroupName: string]: ServerSchemaField & {
         title_plural?: string;
@@ -292,6 +299,12 @@ export type CommonSchemaAttributes = {
  * of what the API returns.
  */
 export type Schema = CommonSchemaAttributes & {
+  /** added by the client, copied from {@link WrappedSchema} */
+  name: string; // Will always exist on schema
+  /** added by client */
+  type?: DataTypes;
   /** the localized title of the `schema_group`. added by the client */
   group_title?: string;
@@ -336,6 +349,9 @@ export type Schema = CommonSchemaAttributes & {
   isSpSchema?: boolean;
 };
+/** Type Classification of a Schema returned by API */
+export type SchemaType = "ss" | "ps" | "us";
 /** This is what's returned by the API */
 export type WrappedSchema = {
   active: true;
@@ -343,9 +359,12 @@ export type WrappedSchema = {
   start_date: string;
   /** ISO Date. If this tag exists, the schema is deprecated. */
   end_date: string;
-  name: string;
-  type: "ss" | "ps" | "us";
-  version: string;
+  /** Schema Name Type and Version Properties */
+  schema_name: string;
+  schema_type: SchemaType;
+  schema_version: string;
   /** whether the \`version\` is the latest version */
   version_current: boolean;
   schema: CommonSchemaAttributes & {
@@ -355,6 +374,7 @@ export type WrappedSchema = {
     $schema?: string;
     definitions?: Record<string, { $ref: Urn }>;
     allOf?: {
       $ref?: string;
       if?: Partial<WrappedSchema["schema"]>;

package/src/verification.ts CHANGED Viewed

@@ -1,10 +1,37 @@
 import { NId, ProfileObject } from "./raytio";
+// see #659
+export enum SafeHarbourCode {
+  /** “a match has been made on each the Full Name, Address and Date of Birth” */
+  M1 = "M1",
+  /** “a match has been made on both Full Name and Date of Birth (but not Address)” */
+  M2 = "M2",
+  /** “a match has been made on both Full Name and Address (but not Date of Birth)” */
+  N1 = "N1",
+}
 export type VerificationPayload<WithValue extends boolean> = {
   // we deliberately haven't defined 'sub'
   field: string;
   schema?: string;
-  metadata?: Record<string, unknown>;
+  metadata?: {
+    safeHarbourScore?: SafeHarbourCode;
+    status?: "pending";
+    pending_details?: {
+      /**
+       * for pending verifications - whether the verifier will complete fast enough that
+       * we can show a loading indicator. If not, the user has to come back another day.
+       */
+      pending_time: "short" | "long";
+      /**
+       * for pending verifications - whether further user interaction is required to
+       * complete the verification, or if it will complete silently in the background.
+       */
+      pending_type: "time" | "user";
+    };
+    [otherAttributes: string]: unknown;
+  };
   passed: boolean;
   request_div: string;
   /** @deprecated don't use this, it looks like the schema name but it's not */
@@ -45,6 +72,15 @@ export type Verification<WithValue extends boolean = false> = ProfileObject<{
     {
       signature: string;
       data: VerificationPayload<WithValue>;
+      /** undefined for data created before July 2023 */
+      key_id?: string;
+      /** undefined for data created before July 2023 */
+      key_urn?: string;
+      /** undefined for data created before July 2023 */
+      signing_algorithm?: "RSASSA_PSS_SHA_512";
+      /** undefined for data created before July 2023 */
+      hashing_algorithm?: "SHA512";
     },
   ];
 }>;
@@ -95,7 +131,7 @@ export type RealVer = {
    */
   verified: boolean;
   /** arbitary metadata returned by the verifier */
-  metadata?: Record<string, unknown>;
+  metadata?: VerificationPayload<false>["metadata"];
   /** nId of the verification */
   nID: NId;
   /** nId of the PO that the verification belongs to. Could be undefined */

package/src/wizard.ts CHANGED Viewed

@@ -141,6 +141,9 @@ export type WizardConfig = {
   /** the loading message to show next to the spinner after the review screen */
   sharing_data_message?: string;
+  /** If this value is true, the form will display some data sharing information before the form (WizardPreview) */
+  display_sharing_preview?: boolean;
   /** a list of relationships that should be created after the wizard completes (see #987) */
   relationships?: {
     /** schema name */
@@ -152,4 +155,7 @@ export type WizardConfig = {
     /** relationship properties */
     properties?: Record<string, any>;
   }[];
+  /** if specified, the user must validate their WebAuthN credential before they can submit the form */
+  webauthn_type?: ("usb" | "nfc" | "ble" | "internal")[];
 };

/package/src/__tests__/{schema.ts → schema.typetest.ts} RENAMED Viewed

File without changes