@raytio/types 6.0.1 → 7.0.0

package/README.md

@@ -30,8 +30,10 @@ Hovering over the type in VSCode will display documentation and available proper
 ### Type aliases
 
 - [AA](#aa)
+- [AATags](#aatags)
 - [AId](#aid)
 - [Colors](#colors)
+- [CommonSchemaAttributes](#commonschemaattributes)
 - [ConditionallyRequired](#conditionallyrequired)
 - [CustomFonts](#customfonts)
 - [DataTypes](#datatypes)
@@ -51,8 +53,8 @@ Hovering over the type in VSCode will display documentation and available proper
 - [Schema](#schema)
 - [SchemaField](#schemafield)
 - [SchemaFieldTag](#schemafieldtag)
-- [SchemaMetadata](#schemametadata)
 - [SchemaTag](#schematag)
+- [ServerSchemaField](#serverschemafield)
 - [SubmissionStatus](#submissionstatus)
 - [UId](#uid)
 - [Urn](#urn)
@@ -61,8 +63,12 @@ Hovering over the type in VSCode will display documentation and available proper
 - [Verification](#verification)
 - [VerificationPayload](#verificationpayload)
 - [VerificationProvider](#verificationprovider)
+- [WId](#wid)
+- [Webhook](#webhook)
+- [WebhookStatus](#webhookstatus)
 - [WizardConfig](#wizardconfig)
 - [WizardPage](#wizardpage)
+- [WrappedSchema](#wrappedschema)
 
 ## Type aliases
 
@@ -81,19 +87,25 @@ Hovering over the type in VSCode will display documentation and available proper
 | `callback_uri?` | `string`[] | - |
 | `description?` | `string` | - |
 | `name` | `string` | - |
-| `org_id` | [`OId`](#oid) | the id of the associated organisation |
+| `org_id` | [`OId`](#oid) | the id of the associated organization |
 | `picture?` | [`Urn`](#urn) | - |
 | `picture_url?` | `string` | Easy to use AA logo url for pasting inot emails |
 | `ruleset?` | `unknown` | configuration for the submission rules |
 | `scopes?` | `string`[] | - |
 | `service_provider_n_id?` | [`NId`](#nid) | the n_id of the associated service provider |
-| `tags?` | `string`[] | - |
+| `tags?` | [`AATags`](#aatags)[] | - |
 | `theme?` | `Object` | - |
 | `theme.colors?` | [`Colors`](#colors) | - |
 | `theme.font?` | [`CustomFonts`](#customfonts) | - |
 
 ___
 
+### AATags
+
+Ƭ **AATags**: ``"type:client_only"`` \| ``"type:share_with_new_user"`` \| \`related\_service\_provider:n\_id:${NId}\` \| ``"ServiceProvider"``
+
+___
+
 ### AId
 
 Ƭ **AId**: `StringWithIdentity`<``"AId"``\>
@@ -111,7 +123,6 @@ ___
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `blank` | `string` | - |
-| `blankBackground` | `string` | - |
 | `climaterolText` | `string` | - |
 | `climaterolUi` | `string` | - |
 | `errorRed` | `string` | - |
@@ -120,7 +131,7 @@ ___
 | `poolblueText` | `string` | - |
 | `poolblueUi` | `string` | - |
 | `raytioOrangeHover` | `string` | - |
-| `raytioOrangeShade` | `string` | only used by the fancy layout on the login screen |
+| `raytioOrangeShade` | `string` | ✨ |
 | `raytioOrangeText` | `string` | - |
 | `raytioOrangeUi` | `string` | - |
 | `sariShade` | `string` | - |
@@ -136,6 +147,41 @@ ___
 
 ___
 
+### CommonSchemaAttributes
+
+Ƭ **CommonSchemaAttributes**: `Object`
+
+not exported. Attributes that are identical in both client schema & server schema
+
+#### Type declaration
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `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` | - |
+| `i18n?` | `Object` | - |
+| `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 |
+| `relationships?` | { `anyOf?`: `string`[] ; `direction`: ``"from"`` ; `multiple?`: `boolean` ; `oneOf?`: `string`[] ; `properties?`: { [fieldName: string]: [`SchemaField`](#schemafield);  } ; `relationship_name`: `string` ; `required?`: `string`[] ; `required_relationship?`: `boolean` ; `type`: `string`  }[] | - |
+| `schema_group?` | `string` | the group that a schema belongs to, such as "passports". This is useful for forms that accept different types of similar documents. |
+| `tags?` | [`SchemaTag`](#schematag)[] | - |
+| `title` | `string` | - |
+| `title_plural?` | `string` | plural version of the title |
+| `type?` | [`DataTypes`](#datatypes) | - |
+
+___
+
 ### ConditionallyRequired
 
 Ƭ **ConditionallyRequired**: `Object`
@@ -229,6 +275,7 @@ ___
 | `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 |
@@ -384,51 +431,10 @@ ___
 
 ### 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.
+Ƭ **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`  }
 
-#### Type declaration
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `$id?` | `string` | **`deprecated`** don't use this |
-| `$ref?` | `string` | **`deprecated`** not sure why a schema would have this, only fields should |
-| `$schema?` | `string` | - |
-| `allOf?` | { `$ref?`: `string` ; `if?`: [`Schema`](#schema) ; `then?`: [`Schema`](modules.md#schema)  }[] | - |
-| `definitions?` | `Record`<`string`, `Object`\> | - |
-| `description` | `string` | - |
-| `display?` | `Object` | - |
-| `display.expand?` | { `fields`: `string`[] ; `label`: `string`  }[] | list of fields that should not be shown by default, unless you expand a collpase section which has a name from the label property. Array because there could be multiple expand groups |
-| `display.head_main?` | `Object` | list of fields to be considered the header/name of the PO fields joined with a space unless `format` format string is supplied |
-| `display.head_main.fields` | `string`[] | - |
-| `display.head_main.format?` | `string` | - |
-| `display.head_sub?` | `Object` | list of fields to be considered the subheader of the PO fields joined with a space unless `format` format string is supplied |
-| `display.head_sub.fields` | `string`[] | - |
-| `display.head_sub.format?` | `string` | - |
-| `end_date?` | `string` | If this tag exists, the schema is deprecated. ISO Date. |
-| `group_title?` | `string` | the localized title of the `schema_group`. added by the client |
-| `i18n?` | `Object` | - |
-| `n_id?` | [`NId`](#nid) | - |
-| `name` | `string` | these fields will always exist on schema |
-| `onboard_properties?` | `Object` | only the schema used for the onboarding wizard have this property |
-| `onboard_properties.organizations?` | { `access_applications?`: { `links?`: { `description`: `string` ; `wizardConfig`: `Omit`<[`WizardConfig`](#wizardconfig), ``"a_id"``\>  }[] ; `properties`: `Omit`<[`AA`](modules.md#aa), ``"org_id"``\>  }[] ; `properties`: [`Organization`](modules.md#organization)  }[] | Organizations that should be created. NOTE: if multiple are specified, when the wizard completes, the _first one_ will be selected |
-| `onboard_properties.profile_objects?` | { `properties`: `Record`<`string`, `unknown`\> ; `schema_name`: `string`  }[] | Profile Objects that should be created |
-| `onboard_properties.relationships?` | { `from`: `string` ; `properties?`: `Record`<`string`, `string`\> ; `to`: `string` ; `type`: `string`  }[] | Relationships that should be created |
-| `onboard_properties.return_to?` | `string` | The relative path in the client to redirect to once finished. May include variables |
-| `properties` | `Object` | 🚨 Note that there are cases where properties are undefined, e.g. if the schema is a sub-object |
-| `relationships?` | { `anyOf?`: `string`[] ; `direction`: ``"from"`` ; `multiple?`: `boolean` ; `oneOf?`: `string`[] ; `properties?`: { [fieldName: string]: [`SchemaField`](#schemafield);  } ; `relationship_name`: `string` ; `required?`: `string`[] ; `required_relationship?`: `boolean` ; `type`: `string`  }[] | - |
-| `required?` | (`string` \| [`ConditionallyRequired`](#conditionallyrequired))[] | added by client |
-| `schema_group?` | `string` | the group that a schema belongs to, such as "passports". This is useful for forms that accept different types of similar documents. |
-| `tags?` | [`SchemaTag`](#schematag)[] | - |
-| `title` | `string` | - |
-| `title_plural?` | `string` | plural version of the title |
-| `type?` | [`DataTypes`](#datatypes) | - |
-| `verified_fields?` | (`string` \| [`ConditionallyRequired`](#conditionallyrequired))[] | originally `string[]`, the client modifies this |
-| `version?` | `string` | - |
-| `version_current?` | `boolean` | whether the `version` is the latest version |
-| `wasExpandedByClient?` | `boolean` | - |
+Raytio's variant of JSON Schema, as used by the client. It is a modified version
+of what the API returns.
 
 ___
 
@@ -443,7 +449,7 @@ ___
 | `$id?` | `string` | **`deprecated`** don't use, it's inconsistent |
 | `$ref?` | `string` | If this field refers to a sub-object |
 | `add_row_btn_label?` | `string` | if this field is a table input, this determines the text to show on the "Add Row" btn |
-| `allOf?` | [{ `$ref`: `string`  }, [`SchemaField`](#schemafield)] | - |
+| `allOf?` | [{ `$ref`: `string`  }, [`ServerSchemaField`](#serverschemafield)] | - |
 | `content?` | `string` | only checkbox uses this prop |
 | `contentEncoding?` | ``"base64"`` | - |
 | `contentMediaType?` | `string` | - |
@@ -452,9 +458,9 @@ ___
 | `description?` | `string` | - |
 | `description_decorator?` | ``"md"`` | specifies that the description is formatted in markdown |
 | `encrypt?` | `boolean` | whether the field should be encrypted |
-| `enum?` | `string`[] | - |
+| `enum?` | (`string` \| `number` \| `boolean`)[] | - |
 | `examples?` | `unknown`[] | - |
-| `format?` | ``"date"`` \| ``"date-time"`` | - |
+| `format?` | ``"date"`` \| ``"date-time"`` \| ``"uri"`` | - |
 | `image_silhouette?` | `string` | If this schema requires a photo of a document, you can specify a URL to a silhouette image which will be overlaid on top of the camera. For best results, the image should have a transparent background + minimal white foreground |
 | `items?` | `Object` | `items` is used for nested arrays, (while `properties` is used for nested objects) |
 | `items.properties` | `Object` | - |
@@ -482,21 +488,21 @@ ___
 
 ### SchemaFieldTag
 
-Ƭ **SchemaFieldTag**: ``"password"`` \| \`group:${string}\` \| \`upload-group:${string}\` \| ``"display:stars"`` \| ``"display:no_autofill"`` \| ``"display:currency"`` \| ``"display:cascade"`` \| ``"display:survey"`` \| ``"display:quoting"`` \| ``"display:customModal"`` \| ``"display:terms_conditions"`` \| ``"display:showOnWizard"`` \| \`display:main\_media:${string}\` \| ``"date_component:day"`` \| ``"date_component:month"`` \| ``"date_component:year"`` \| ``"action:client_upload"`` \| ``"verify:show_if_pending"`` \| ``"special:hide_select_behind_button"`` \| ``"type:capture_geolocation"`` \| ``"type:extract_required"``
+Ƭ **SchemaFieldTag**: ``"password"`` \| \`group:${string}\` \| \`upload-group:${string}\` \| ``"display:stars"`` \| ``"display:no_autofill"`` \| ``"display:currency"`` \| ``"display:cascade"`` \| ``"display:survey"`` \| ``"display:quoting"`` \| ``"display:customModal"`` \| ``"display:terms_conditions"`` \| \`display:main\_media:${string}\` \| ``"date_component:day"`` \| ``"date_component:month"`` \| ``"date_component:year"`` \| ``"action:client_upload"`` \| ``"verify:show_if_pending"`` \| ``"special:hide_select_behind_button"`` \| ``"type:capture_geolocation"`` \| ``"type:extract_required"``
 
 ___
 
-### SchemaMetadata
-
-Ƭ **SchemaMetadata**: `Pick`<[`Schema`](#schema), ``"name"`` \| ``"title"`` \| ``"description"`` \| ``"schema_group"`` \| ``"end_date"`` \| ``"i18n"`` \| ``"display"`` \| ``"tags"`` \| ``"clientLocale"`` \| ``"groupNames"`` \| ``"title_plural"`` \| ``"group_title"``\> & { `__typeof__`: ``"You cannot supply SchemaMetadata to a function that expects Schema"`` ; `isProfileSchema`: `boolean` ; `isSpSchema`: `boolean`  }
+### SchemaTag
 
-Only certain properties from the schema
+Ƭ **SchemaTag**: ``"action:experimental_pass_object_store_id"`` \| ``"action:verify"`` \| ``"default_camera:rear"`` \| ``"default_camera:front"`` \| \`oauth2\_component:name:${string}\` \| \`oauth2\_component:redirect\_url:${string}\` \| \`link\_to:${string}:${string}\` \| ``"type:service_provider"`` \| ``"type:service_offer"`` \| ``"type:marketplace"`` \| ``"type:client_only"`` \| ``"type:globally_unique_field"``
 
 ___
 
-### SchemaTag
+### ServerSchemaField
 
-Ƭ **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"``
+Ƭ **ServerSchemaField**: `Omit`<[`SchemaField`](#schemafield), ``"$prop"``\>
+
+the only difference between the client & server's definition is that the client adds `$prop`
 
 ___
 
@@ -524,7 +530,7 @@ ___
 
 ### UrnNodeType
 
-Ƭ **UrnNodeType**: ``"user"`` \| ``"profile_object"`` \| ``"instance"`` \| ``"temp_object"`` \| ``"document"``
+Ƭ **UrnNodeType**: ``"user"`` \| ``"profile_object"`` \| ``"instance"`` \| ``"schema"`` \| ``"temp_object"`` \| ``"document"``
 
 ___
 
@@ -589,12 +595,55 @@ These `n_id`s point to service provider profile objects
 
 ___
 
+### WId
+
+Ƭ **WId**: `StringWithIdentity`<``"WId"``\>
+
+A `wi_id` is the ID of a @see Webhook
+
+___
+
+### Webhook
+
+Ƭ **Webhook**: `Object`
+
+#### Type declaration
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `date_created` | `string` | ISO Date |
+| `date_updated` | `string` | ISO Date |
+| `provider_signature_check_enabled` | `boolean` | - |
+| `provider_signature_credentials` | `unknown` | - |
+| `provider_subscription_credentials` | `unknown` | - |
+| `provider_webhook_id` | [`NId`](#nid) | n_id of "the webhook provider which can be set up against a service provider" |
+| `provider_webhook_subscription_id` | [`NId`](#nid) | not sure what this is |
+| `status` | [`WebhookStatus`](#webhookstatus) | - |
+| `subscribe_log?` | { `date`: `string` ; `response_payload`: `Json` ; `response_status_code`: `number`  }[] | - |
+| `webhook_action` | { `webhook_action_type`: `string`  }[] | - |
+| `webhook_field_mapping_schema` | `Object` | - |
+| `webhook_filter_schema` | `Object` | - |
+| `webhook_filter_schema.field_name` | `string` | - |
+| `webhook_filter_schema.field_value` | `string` | - |
+| `webhook_filter_schema.operator` | `string` | - |
+| `webhook_filter_source` | `string` | - |
+| `webhook_processing_rules` | `unknown` | - |
+| `wi_id` | [`WId`](#wid) | - |
+
+___
+
+### WebhookStatus
+
+Ƭ **WebhookStatus**: ``"subscribed"`` \| ``"pending"`` \| ``"unsubscribe_failed"``
+
+___
+
 ### WizardConfig
 
 Ƭ **WizardConfig**: `Object`
 
 when a form link is generated, this is what gets saved on the API.
-Each value can be overriden in the query parameters. If specified
+Each value can be overridden in the query parameters. If specified
 in the query parameters, it needs to be base64 and/or url encoded.
 
 #### Type declaration
@@ -657,3 +706,24 @@ configuration data for a single wizard page (@see WizardConfig)
 | `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` |
+
+___
+
+### WrappedSchema
+
+Ƭ **WrappedSchema**: `Object`
+
+This is what's returned by the API
+
+#### Type declaration
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `active` | ``true`` | - |
+| `end_date` | `string` | ISO Date. If this tag exists, the schema is deprecated. |
+| `name` | `string` | - |
+| `schema` | [`CommonSchemaAttributes`](#commonschemaattributes) & { `$id?`: `string` ; `$schema?`: `string` ; `allOf?`: { `$ref?`: `string` ; `if?`: `Partial`<[`WrappedSchema`](modules.md#wrappedschema)[``"schema"``]\> ; `then?`: `Partial`<[`WrappedSchema`](modules.md#wrappedschema)[``"schema"``]\>  }[] ; `definitions?`: `Record`<`string`, `Object`\> ; `properties`: { [fieldName: string]: [`ServerSchemaField`](modules.md#serverschemafield);  } ; `required?`: `string`[] ; `verified_fields?`: `string`[]  } | - |
+| `start_date` | `string` | ISO Date |
+| `type` | ``"ss"`` \| ``"ps"`` \| ``"us"`` | - |
+| `version` | `string` | - |
+| `version_current` | `boolean` | whether the \`version\` is the latest version |

package/dist/crypto.d.ts

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

package/dist/raytio.d.ts

@@ -1,29 +1,31 @@
 import { Encrypted } from "./crypto";
 import { Colors, CustomFonts } from "./theme";
 /** @internal see Microsoft/TypeScript#202 */
-export declare type StringWithIdentity<T> = string & {
+export type StringWithIdentity<T> = string & {
     $$typeof$$: T;
 };
 /** @internal */
-declare type Json = Record<string, any>;
+type Json = Record<string, any>;
 /** A `p_id` is the ID of a @see Relationship */
-export declare type PId = StringWithIdentity<"PId">;
+export type PId = StringWithIdentity<"PId">;
 /** An `i_id` is the ID of an @see Instance */
-export declare type IId = StringWithIdentity<"IId">;
+export type IId = StringWithIdentity<"IId">;
 /** An `n_id` is the ID of a @see ProfileObject */
-export declare type NId = StringWithIdentity<"NId">;
+export type NId = StringWithIdentity<"NId">;
 /** A `g_id` is the ID of a group */
-export declare type GId = StringWithIdentity<"GId">;
+export type GId = StringWithIdentity<"GId">;
 /** A `u_id` is the ID of a user */
-export declare type UId = StringWithIdentity<"UId">;
+export type UId = StringWithIdentity<"UId">;
 /** An `a_id` is the ID of an @see AA */
-export declare type AId = StringWithIdentity<"AId">;
+export type AId = StringWithIdentity<"AId">;
 /** An `o_id` is the ID of an @see Organization */
-export declare type OId = StringWithIdentity<"OId">;
-export declare type DataTypes = "string" | "number" | "boolean" | "object" | "integer" | "array" | "null";
-export declare type SubmissionStatus = "Submitted" | "Processing" | "Rejected" | "Expired" | "Completed" | "DataChanged" | "Received" | "Accepted";
+export type OId = StringWithIdentity<"OId">;
+/** A `wi_id` is the ID of a @see Webhook */
+export type WId = StringWithIdentity<"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 */
-export declare type ProfileObject<Properties = Json> = {
+export type ProfileObject<Properties = Json> = {
     n_id: NId;
     properties: Properties;
     labels: string[];
@@ -36,7 +38,7 @@ export declare type ProfileObject<Properties = Json> = {
     isFromSubmission?: [aId: AId, iId: IId];
 };
 /** @internal This is what we send the API */
-export declare type ProfileObjectForUpload<Properties = Json> = {
+export type ProfileObjectForUpload<Properties = Json> = {
     properties: Properties;
     document?: {
         content?: string | Encrypted;
@@ -53,13 +55,13 @@ export declare type ProfileObjectForUpload<Properties = Json> = {
  * There are some limits to field names: they cannot be called
  * `__signature` nor can they include the character sequence `<=>`.
  */
-export declare type Properties = {
+export type Properties = {
     [fieldName: string]: any;
 };
-export declare type UrnNodeType = "user" | "profile_object" | "instance" | "temp_object" | "document";
+export type UrnNodeType = "user" | "profile_object" | "instance" | "schema" | "temp_object" | "document";
 /** e.g. "urn:user:..." */
-export declare type Urn = `urn:${UrnNodeType}:${string}`;
-export declare type Relationship = {
+export type Urn = `urn:${UrnNodeType}:${string}`;
+export type Relationship = {
     start: Urn;
     end: Urn;
     p_id: PId;
@@ -70,7 +72,7 @@ export declare type Relationship = {
         [fieldName: string]: unknown;
     };
 };
-export declare type Lookup = {
+export type Lookup = {
     key: string | number;
     value: string | number;
     /** Used in Antd Cascader */
@@ -80,7 +82,8 @@ export declare type Lookup = {
     /** used in AkahuDynamicSection only */
     requires_2FA?: boolean;
 };
-export declare type AA = {
+export type AATags = "type:client_only" | "type:share_with_new_user" | `related_service_provider:n_id:${NId}` | "ServiceProvider";
+export type AA = {
     a_id: AId;
     name: string;
     description?: string;
@@ -90,7 +93,7 @@ export declare type AA = {
     /** Easy to use AA logo url for pasting inot emails */
     picture_url?: string;
     scopes?: string[];
-    tags?: string[];
+    tags?: AATags[];
     callback_uri?: string[];
     /** markdown or string help information including [phoneNumber || email] */
     aa_help?: string;
@@ -100,16 +103,16 @@ export declare type AA = {
     };
     /** the n_id of the associated service provider */
     service_provider_n_id?: NId;
-    /** the id of the associated organisation */
+    /** the id of the associated organization */
     org_id: OId;
     /** configuration for the submission rules */
     ruleset?: unknown;
     /** if true, only specific email addresses can submit the form */
     auth_list_enabled?: boolean;
     /** @internal */
-    _transitions?: unknown[];
+    transitions?: unknown[];
 };
-export declare type Instance = {
+export type Instance = {
     /** Access application instance ID */
     i_id: IId;
     /** ID of the access application this submission was made to */
@@ -148,12 +151,14 @@ export declare type Instance = {
         };
     };
     relationships?: Relationship[];
+    /** added by the client once it calculates the score */
+    score?: unknown;
 };
 /**
  * An organization.
  * NOTE: this is different to how the schema defines an Organization. **The schema is wrong (see #468)**
  */
-export declare type Organization = {
+export type Organization = {
     id: OId;
     name: string;
     email: string;
@@ -167,8 +172,19 @@ export declare type Organization = {
     };
     customer: Record<string, unknown>;
 };
+/** @internal some APIs now return extra info */
+export type FullOrg = {
+    id: OId;
+    organization: Omit<Organization, "id">;
+    /** 🧙‍♂️ */
+    gandalf: unknown;
+    stripe: {
+        customer: unknown;
+    };
+    centrix_credentials: unknown;
+};
 /** validation data returned by preVerify (part of the extract&map API) */
-export declare type Validation = {
+export type Validation = {
     score: number;
     warning?: string[];
     breakdown: {
@@ -183,4 +199,38 @@ export declare type Validation = {
         };
     };
 };
+export type WebhookStatus = "subscribed" | "pending" | "unsubscribe_failed";
+export type Webhook = {
+    wi_id: WId;
+    /** n_id of "the webhook provider which can be set up against a service provider" */
+    provider_webhook_id: NId;
+    /** not sure what this is */
+    provider_webhook_subscription_id: NId;
+    status: WebhookStatus;
+    /** ISO Date */
+    date_created: string;
+    /** ISO Date */
+    date_updated: string;
+    webhook_filter_schema: {
+        operator: string;
+        field_value: string;
+        field_name: string;
+    };
+    webhook_action: {
+        webhook_action_type: string;
+    }[];
+    webhook_filter_source: string;
+    webhook_field_mapping_schema: {
+        [key: string]: string;
+    };
+    webhook_processing_rules: unknown;
+    provider_subscription_credentials: unknown;
+    provider_signature_check_enabled: boolean;
+    provider_signature_credentials: unknown;
+    subscribe_log?: {
+        date: string;
+        response_status_code: number;
+        response_payload: Json;
+    }[];
+};
 export {};

package/dist/schema.d.ts

@@ -1,15 +1,15 @@
-import { AA, DataTypes, NId, Organization, Urn } from "./raytio";
+import { AA, DataTypes, Organization, Urn } from "./raytio";
 import { WizardConfig } from "./wizard";
 /** should be renamed since this applies to ConditionallyVerifiable */
-export declare type ConditionallyRequired = {
+export type ConditionallyRequired = {
     field: string;
     if: {
-        [fieldName: string]: string[];
+        [fieldName: string]: (string | number | boolean)[];
     };
 };
-export declare type SchemaFieldTag = "password" | `group:${string}` | `upload-group:${string}` | "display:stars" | "display:no_autofill" | "display:currency" | "display:cascade" | "display:survey" | "display:quoting" | "display:customModal" | "display:terms_conditions" | "display: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";
-export declare type SchemaTag = "action:experimental_pass_object_store_id" | "action:verify" | "default_camera:rear" | "default_camera:front" | `oauth2_component:name:${string}` | `oauth2_component:redirect_url:${string}` | `link_to:${string}:${string}` | "type:service_provider" | "type:service_offer" | "type:marketplace" | "type:client_only" | "type:globally_unique_field";
-export declare type SchemaField = {
+export type SchemaFieldTag = "password" | `group:${string}` | `upload-group:${string}` | "display:stars" | "display:no_autofill" | "display:currency" | "display:cascade" | "display:survey" | "display:quoting" | "display:customModal" | "display:terms_conditions" | `display:main_media:${string}` | "date_component:day" | "date_component:month" | "date_component:year" | "action:client_upload" | "verify:show_if_pending" | "special:hide_select_behind_button" | "type:capture_geolocation" | "type:extract_required";
+export type SchemaTag = "action:experimental_pass_object_store_id" | "action:verify" | "default_camera:rear" | "default_camera:front" | `oauth2_component:name:${string}` | `oauth2_component:redirect_url:${string}` | `link_to:${string}:${string}` | "type:service_provider" | "type:service_offer" | "type:marketplace" | "type:client_only" | "type:globally_unique_field";
+export type SchemaField = {
     /** @deprecated don't use, it's inconsistent */
     $id?: string;
     title?: string;
@@ -20,7 +20,7 @@ export declare type SchemaField = {
     examples?: unknown[];
     tags?: SchemaFieldTag[];
     type?: DataTypes;
-    enum?: string[];
+    enum?: (string | number | boolean)[];
     maximum?: number;
     minimum?: number;
     /** @deprecated raytio's usage not documented */
@@ -32,7 +32,7 @@ export declare type SchemaField = {
     pattern?: string;
     /** whether the field should be encrypted */
     encrypt?: boolean;
-    format?: "date" | "date-time";
+    format?: "date" | "date-time" | "uri";
     contentMediaType?: string;
     contentEncoding?: "base64";
     /** `items` is used for nested arrays, (while `properties` is used for nested objects) */
@@ -59,7 +59,7 @@ export declare type SchemaField = {
     };
     allOf?: [{
         $ref: string;
-    }, SchemaField];
+    }, ServerSchemaField];
     /** only checkbox uses this prop */
     content?: string;
     /** URL to a JSON file in the `Lookup` format */
@@ -98,15 +98,11 @@ export declare type SchemaField = {
      */
     image_silhouette?: string;
 };
-/**
- * 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.
- */
-export declare type Schema = {
-    /** @deprecated don't use this */
-    $id?: string;
-    $schema?: string;
-    n_id?: NId;
+/** the only difference between the client & server's definition is that the client adds `$prop` */
+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;
@@ -118,37 +114,14 @@ export declare type Schema = {
      * forms that accept different types of similar documents.
      */
     schema_group?: string;
-    /** the localized title of the `schema_group`. added by the client */
-    group_title?: string;
-    /** @deprecated not sure why a schema would have this, only fields should */
-    $ref?: string;
-    version?: string;
-    /** whether the `version` is the latest version */
-    version_current?: boolean;
     tags?: SchemaTag[];
-    /** originally `string[]`, the client modifies this */
-    verified_fields?: (string | ConditionallyRequired)[];
-    wasExpandedByClient?: boolean;
-    /** added by client */
-    required?: (string | ConditionallyRequired)[];
-    type?: DataTypes;
-    definitions?: Record<string, {
-        $ref: Urn;
-    }>;
-    allOf?: {
-        $ref?: string;
-        if?: Schema;
-        then?: Schema;
-    }[];
-    /** If this tag exists, the schema is deprecated. ISO Date. */
-    end_date?: string;
-    /** 🚨 Note that there are cases where properties are undefined, e.g. if the schema is a sub-object */
-    properties: {
-        [fieldName: string]: SchemaField;
-    };
     i18n?: {
         [locale: string]: {
-            $schema: Schema;
+            $schema: {
+                title: string;
+                title_plural?: string;
+                description?: string;
+            };
             $loading_extract: {
                 title: string;
             };
@@ -179,21 +152,11 @@ export declare type Schema = {
             $loading_pending_ver_resubmit: {
                 title: string;
             };
-            [fieldNameOrGroupName: string]: Omit<SchemaField, "$prop"> & {
+            [fieldNameOrGroupName: string]: ServerSchemaField & {
                 title_plural?: string;
             };
         };
     };
-    /** @internal the client adds this after processing the i18n property */
-    groupNames?: Record<string, string>;
-    /** @internal added by the client to inform downstream components which locale from schema.i18n was used */
-    clientLocale?: string;
-    /**
-     * @internal
-     * the estimated loading times in seconds for various API calls. The client adds
-     * this field after processing the schema tags.
-     */
-    timing?: Record<"extract" | "live_person" | "verify_pending_delay", number>;
     relationships?: {
         relationship_name: string;
         direction: "from";
@@ -239,10 +202,6 @@ export declare type Schema = {
             label: string;
         }[];
     };
-    /** @internal @deprecated do not use */
-    unexpanded_allOf?: never;
-    /** @internal @deprecated do not use */
-    unexpanded_properties?: never;
     /** only the schema used for the onboarding wizard have this property */
     onboard_properties?: {
         /** Profile Objects that should be created */
@@ -278,15 +237,74 @@ export declare type Schema = {
         return_to?: string;
     };
 };
-/** Only certain properties from the schema */
-export declare type SchemaMetadata = Pick<Schema, "name" | "title" | "description" | "schema_group" | "end_date" | "i18n" | "display" | "tags" | "clientLocale" | "groupNames" | "title_plural" | "group_title"> & {
+/**
+ * Raytio's variant of JSON Schema, as used by the client. It is a modified version
+ * of what the API returns.
+ */
+export type Schema = CommonSchemaAttributes & {
+    /** the localized title of the `schema_group`. added by the client */
+    group_title?: string;
+    /** originally `string[]`, the client modifies this */
+    verified_fields?: (string | ConditionallyRequired)[];
+    /** originally `string[]`, the client modifies this */
+    required?: (string | ConditionallyRequired)[];
+    /** added by client */
+    wasExpandedByClient?: boolean;
+    /** ISO Date. Copied from @see WrappedSchema */
+    start_date?: string;
+    /** ISO Date. Copied from @see WrappedSchema If this tag exists, the schema is deprecated */
+    end_date?: string;
+    /** 🚨 Note that there are cases where properties are undefined, e.g. if the schema is a sub-object */
+    properties: {
+        [fieldName: string]: SchemaField;
+    };
+    /** the client adds this after processing the i18n property */
+    groupNames?: Record<string, string>;
+    /** added by the client to inform downstream components which locale from schema.i18n was used */
+    clientLocale?: string;
+    /** added by the client, copied from @see WrappedSchema */
+    version: string;
     /**
-     * @deprecated this prop exists so that SchemaMetadata does not extend Schema.
-     * use `getSchema(schemaName)` to fetch the full schema
+     * the estimated loading times in seconds for various API calls. The client adds
+     * this field after processing the schema tags.
      */
-    __typeof__: "You cannot supply SchemaMetadata to a function that expects Schema";
-    isProfileSchema: boolean;
-    isSpSchema: boolean;
+    timing?: Record<"extract" | "live_person" | "verify_pending_delay", number>;
+    /** added by the client. If true, this should be shown to the client */
+    isProfileSchema?: boolean;
+    /** added by the client. If true, this schema somehow relates to legacy service providers */
+    isSpSchema?: boolean;
+};
+/** This is what's returned by the API */
+export type WrappedSchema = {
+    active: true;
+    /** ISO Date */
+    start_date: string;
+    /** ISO Date. If this tag exists, the schema is deprecated. */
+    end_date: string;
+    name: string;
+    type: "ss" | "ps" | "us";
+    version: string;
+    /** whether the \`version\` is the latest version */
+    version_current: boolean;
+    schema: CommonSchemaAttributes & {
+        /** @deprecated don't use this */
+        $id?: string;
+        /** @deprecated don't use this */
+        $schema?: string;
+        definitions?: Record<string, {
+            $ref: Urn;
+        }>;
+        allOf?: {
+            $ref?: string;
+            if?: Partial<WrappedSchema["schema"]>;
+            then?: Partial<WrappedSchema["schema"]>;
+        }[];
+        properties: {
+            [fieldName: string]: ServerSchemaField;
+        };
+        required?: string[];
+        verified_fields?: string[];
+    };
 };
 /** @ignore */
-export declare type RelationDefinition = NonNullable<Schema["relationships"]>[number];
+export type RelationDefinition = NonNullable<Schema["relationships"]>[number];

package/dist/theme.d.ts

@@ -1,4 +1,4 @@
-export declare type Colors = {
+export type Colors = {
     sirPinklyText: string;
     sirPinklyUi: string;
     violaPerpetuoText: string;
@@ -10,7 +10,7 @@ export declare type Colors = {
     raytioOrangeText: string;
     raytioOrangeUi: string;
     raytioOrangeHover: string;
-    /** only used by the fancy layout on the login screen */
+    /** ✨ */
     raytioOrangeShade: string;
     successGreen: string;
     loadingYellow: string;
@@ -21,10 +21,9 @@ export declare type Colors = {
     sariShade: string;
     feelingHugged: string;
     silverShell: string;
-    blankBackground: string;
     blank: string;
 };
-export declare type CustomFonts = {
+export type CustomFonts = {
     header?: string;
     body?: string;
 };

package/dist/verification.d.ts

@@ -1,5 +1,5 @@
 import { NId, ProfileObject } from "./raytio";
-export declare type VerificationPayload<WithValue extends boolean> = {
+export type VerificationPayload<WithValue extends boolean> = {
     field: string;
     schema?: string;
     metadata?: Record<string, unknown>;
@@ -28,7 +28,7 @@ export declare type VerificationPayload<WithValue extends boolean> = {
  * use `Verification<true>`, otherwise just `Verification`. Verifications from
  * the DataContext don't have the value.
  */
-export declare type Verification<WithValue extends boolean = false> = ProfileObject<{
+export type Verification<WithValue extends boolean = false> = ProfileObject<{
     field: string;
     n_id: NId;
     /**
@@ -64,7 +64,7 @@ export declare enum POVerification {
     Loading = 70007
 }
 /** These `n_id`s point to service provider profile objects */
-export declare type VerificationProvider = {
+export type VerificationProvider = {
     verifierNId?: NId;
     dataSourceNId?: NId;
     serviceProviderNId?: NId;
@@ -72,7 +72,7 @@ export declare type VerificationProvider = {
     date?: Date;
 };
 /** This is what @raytio/core exposes, which is more useable than @see Verification */
-export declare type RealVer = {
+export type RealVer = {
     fieldName: string;
     value: unknown;
     provider: VerificationProvider;

package/dist/wizard.d.ts

@@ -1,6 +1,6 @@
 import { AId } from "./raytio";
 /** configuration data for a single wizard page (@see WizardConfig) */
-export declare type WizardPage = {
+export type WizardPage = {
     /** if undefined, the schema title will be used */
     name?: string | symbol;
     filter: "oneOf" | "anyOf";
@@ -54,10 +54,10 @@ export declare type WizardPage = {
 };
 /**
  * when a form link is generated, this is what gets saved on the API.
- * Each value can be overriden in the query parameters. If specified
+ * Each value can be overridden in the query parameters. If specified
  * in the query parameters, it needs to be base64 and/or url encoded.
  */
-export declare type WizardConfig = {
+export type WizardConfig = {
     a_id: AId;
     pages: WizardPage[];
     /** whether the user can change the reference, if there is one in the QP */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@raytio/types",
-  "version": "6.0.1",
+  "version": "7.0.0",
   "license": "MIT",
   "main": "index",
   "types": "index",
@@ -13,6 +13,6 @@
   "scripts": {
     "docs": "sh ../../scripts/generate-docs.sh",
     "test": "npm run build",
-    "build": "tsc && rm -rf dist/__tests__"
+    "build": "tsc && rimraf dist/__tests__"
   }
 }

package/src/__tests__/schema.ts

@@ -1,5 +1,5 @@
 /* eslint-disable fp/no-let, @typescript-eslint/no-unused-vars */
-import { Schema, SchemaField, SchemaMetadata } from "..";
+import { Schema, SchemaField, WrappedSchema } from "..";
 
 /**
  * this file is not run, it is just compiled by tsc
@@ -8,7 +8,7 @@ import { Schema, SchemaField, SchemaMetadata } from "..";
 
 let schema: Schema;
 let schemaField: SchemaField;
-let schemaMetadata: SchemaMetadata;
+let wrappedSchema: WrappedSchema;
 
 function f() {
   // @ts-expect-error SchemaField should not extend Schema
@@ -16,8 +16,8 @@ function f() {
   // @ts-expect-error Schema should not extend SchemaField
   const test2: Schema = schemaField;
 
-  // @ts-expect-error SchemaMetadata should not extend Schema
-  const test3: SchemaMetadata = schema;
-  // @ts-expect-error Schema should not extend SchemaMetadata
-  const test4: Schema = schemaMetadata;
+  // @ts-expect-error WrappedSchema should not extend Schema
+  const test3: WrappedSchema = schema;
+  // @ts-expect-error Schema should not extend WrappedSchema
+  const test4: Schema = wrappedSchema;
 }

package/src/raytio.ts

@@ -21,6 +21,8 @@ export type UId = StringWithIdentity<"UId">;
 export type AId = StringWithIdentity<"AId">;
 /** An `o_id` is the ID of an @see Organization */
 export type OId = StringWithIdentity<"OId">;
+/** A `wi_id` is the ID of a @see Webhook */
+export type WId = StringWithIdentity<"WId">;
 
 export type DataTypes =
   | "string"
@@ -85,6 +87,7 @@ export type UrnNodeType =
   | "user"
   | "profile_object"
   | "instance"
+  | "schema"
   | "temp_object" // this will only be encountered in backend environments which lack access to an applicationDecryptor, or from RapidShare
   | "document";
 
@@ -115,6 +118,13 @@ export type Lookup = {
   requires_2FA?: boolean;
 };
 
+export type AATags =
+  | "type:client_only"
+  | "type:share_with_new_user"
+  // heritage
+  | `related_service_provider:n_id:${NId}`
+  | "ServiceProvider"; // TODO: document or delete
+
 export type AA = {
   a_id: AId;
   name: string;
@@ -125,7 +135,7 @@ export type AA = {
   /** Easy to use AA logo url for pasting inot emails */
   picture_url?: string;
   scopes?: string[];
-  tags?: string[];
+  tags?: AATags[];
   callback_uri?: string[];
   /** markdown or string help information including [phoneNumber || email] */
   aa_help?: string;
@@ -135,7 +145,7 @@ export type AA = {
   };
   /** the n_id of the associated service provider */
   service_provider_n_id?: NId;
-  /** the id of the associated organisation */
+  /** the id of the associated organization */
   org_id: OId;
 
   /** configuration for the submission rules */
@@ -146,7 +156,7 @@ export type AA = {
   auth_list_enabled?: boolean;
 
   /** @internal */
-  _transitions?: unknown[];
+  transitions?: unknown[];
 };
 
 export type Instance = {
@@ -190,6 +200,11 @@ export type Instance = {
     };
   };
   relationships?: Relationship[];
+
+  /** added by the client once it calculates the score */
+  // Defined as `unknown` instead of `ScoreResult` because it could be nonsense,
+  // or a deprected version of `ScoreResult`.
+  score?: unknown;
 };
 
 /**
@@ -211,6 +226,16 @@ export type Organization = {
   customer: Record<string, unknown>;
 };
 
+/** @internal some APIs now return extra info */
+export type FullOrg = {
+  id: OId;
+  organization: Omit<Organization, "id">;
+  /** 🧙‍♂️ */
+  gandalf: unknown;
+  stripe: { customer: unknown };
+  centrix_credentials: unknown;
+};
+
 /** validation data returned by preVerify (part of the extract&map API) */
 export type Validation = {
   score: number;
@@ -227,3 +252,40 @@ export type Validation = {
     };
   };
 };
+
+export type WebhookStatus = "subscribed" | "pending" | "unsubscribe_failed";
+
+export type Webhook = {
+  wi_id: WId;
+  /** n_id of "the webhook provider which can be set up against a service provider" */
+  provider_webhook_id: NId;
+  /** not sure what this is */
+  provider_webhook_subscription_id: NId;
+  status: WebhookStatus;
+  /** ISO Date */
+  date_created: string;
+  /** ISO Date */
+  date_updated: string;
+
+  webhook_filter_schema: {
+    operator: string;
+    field_value: string;
+    field_name: string;
+  };
+  webhook_action: { webhook_action_type: string }[];
+  webhook_filter_source: string;
+  webhook_field_mapping_schema: {
+    [key: string]: string;
+  };
+  webhook_processing_rules: unknown;
+
+  provider_subscription_credentials: unknown;
+  provider_signature_check_enabled: boolean;
+  provider_signature_credentials: unknown;
+
+  subscribe_log?: {
+    date: string;
+    response_status_code: number;
+    response_payload: Json;
+  }[];
+};

package/src/schema.ts

@@ -1,11 +1,12 @@
-import { AA, DataTypes, NId, Organization, Urn } from "./raytio";
+import { AA, DataTypes, Organization, Urn } from "./raytio";
 import { WizardConfig } from "./wizard";
 
 /** should be renamed since this applies to ConditionallyVerifiable */
 export type ConditionallyRequired = {
   field: string;
+  // see `isConditionMet` for how this syntax works
   if: {
-    [fieldName: string]: string[];
+    [fieldName: string]: (string | number | boolean)[];
   };
 };
 
@@ -24,7 +25,6 @@ export type SchemaFieldTag =
   | "display:quoting"
   | "display:customModal"
   | "display:terms_conditions"
-  | "display:showOnWizard" // added by #837, TODO: document
   | `display:main_media:${string}` // property name to determine what image to display
   // date picker components
   | "date_component:day"
@@ -67,7 +67,7 @@ export type SchemaField = {
   examples?: unknown[];
   tags?: SchemaFieldTag[];
   type?: DataTypes;
-  enum?: string[];
+  enum?: (string | number | boolean)[];
   maximum?: number;
   minimum?: number;
   /** @deprecated raytio's usage not documented */
@@ -79,7 +79,7 @@ export type SchemaField = {
   pattern?: string;
   /** whether the field should be encrypted */
   encrypt?: boolean;
-  format?: "date" | "date-time";
+  format?: "date" | "date-time" | "uri";
   contentMediaType?: string;
   contentEncoding?: "base64";
   /** `items` is used for nested arrays, (while `properties` is used for nested objects) */
@@ -107,7 +107,7 @@ export type SchemaField = {
     [fieldName: string]: string[];
   };
 
-  allOf?: [{ $ref: string }, SchemaField];
+  allOf?: [{ $ref: string }, ServerSchemaField];
 
   /** only checkbox uses this prop */
   content?: string;
@@ -151,15 +151,12 @@ export type SchemaField = {
   image_silhouette?: string;
 };
 
-/**
- * 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.
- */
-export type Schema = {
-  /** @deprecated don't use this */
-  $id?: string;
-  $schema?: string;
-  n_id?: NId;
+/** the only difference between the client & server's definition is that the client adds `$prop` */
+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;
@@ -173,47 +170,14 @@ export type Schema = {
    * forms that accept different types of similar documents.
    */
   schema_group?: string;
-  /** the localized title of the `schema_group`. added by the client */
-  group_title?: string;
-
-  /** @deprecated not sure why a schema would have this, only fields should */
-  $ref?: string;
-
-  version?: string;
-  /** whether the `version` is the latest version */
-  version_current?: boolean;
 
   tags?: SchemaTag[];
-  /** originally `string[]`, the client modifies this */
-  verified_fields?: (string | ConditionallyRequired)[];
-
-  wasExpandedByClient?: boolean;
-  /** added by client */
-  required?: (string | ConditionallyRequired)[];
-
-  type?: DataTypes;
-  definitions?: Record<string, { $ref: Urn }>;
-  allOf?: {
-    $ref?: string;
-    if?: Schema;
-    // we don't suport else (yet)
-    then?: Schema;
-  }[];
-
-  /** If this tag exists, the schema is deprecated. ISO Date. */
-  end_date?: string;
-
-  /** 🚨 Note that there are cases where properties are undefined, e.g. if the schema is a sub-object */
-  properties: {
-    [fieldName: string]: SchemaField;
-  };
 
   /* any overrides can be specfied per field or for the whole schema */
   i18n?: {
     [locale: string]: {
-      // @ts-expect-error I don't understand what's wrong
-      $schema: Schema;
-      // not that for entries that start in "group:" or $loading_, only the title field will be used.
+      $schema: { title: string; title_plural?: string; description?: string };
+      // note that for entries that start in "group:" or $loading_, only the title field will be used.
       // ^ the exception is `group:{GROUP_NAME}:{SUB_GROUP}.field` which is used for the combined field title/desc
       // normal fields can specify any field attributes to override.
 
@@ -229,22 +193,11 @@ export type Schema = {
       $loading_delete_pending_ver: { title: string };
       $loading_pending_ver_resubmit: { title: string };
 
-      [fieldNameOrGroupName: string]: Omit<SchemaField, "$prop"> & {
+      [fieldNameOrGroupName: string]: ServerSchemaField & {
         title_plural?: string;
       };
     };
   };
-  /** @internal the client adds this after processing the i18n property */
-  groupNames?: Record<string, string>;
-  /** @internal added by the client to inform downstream components which locale from schema.i18n was used */
-  clientLocale?: string;
-
-  /**
-   * @internal
-   * the estimated loading times in seconds for various API calls. The client adds
-   * this field after processing the schema tags.
-   */
-  timing?: Record<"extract" | "live_person" | "verify_pending_delay", number>;
 
   relationships?: {
     relationship_name: string;
@@ -287,12 +240,6 @@ export type Schema = {
     expand?: { fields: string[]; label: string }[];
   };
 
-  /** @internal @deprecated do not use */
-  unexpanded_allOf?: never;
-
-  /** @internal @deprecated do not use */
-  unexpanded_properties?: never;
-
   /** only the schema used for the onboarding wizard have this property */
   onboard_properties?: {
     /** Profile Objects that should be created */
@@ -332,32 +279,88 @@ export type Schema = {
   };
 };
 
-/** Only certain properties from the schema */
-export type SchemaMetadata = Pick<
-  Schema,
-  // if you update this list, also update SCHEMA_METADATA_FIELDS
-  | "name"
-  | "title"
-  | "description"
-  | "schema_group"
-  | "end_date"
-  | "i18n"
-  | "display"
-  | "tags"
-  // added by the client
-  | "clientLocale"
-  | "groupNames"
-  | "title_plural"
-  | "group_title"
-> & {
+/**
+ * Raytio's variant of JSON Schema, as used by the client. It is a modified version
+ * of what the API returns.
+ */
+export type Schema = CommonSchemaAttributes & {
+  /** the localized title of the `schema_group`. added by the client */
+  group_title?: string;
+
+  /** originally `string[]`, the client modifies this */
+  verified_fields?: (string | ConditionallyRequired)[];
+
+  /** originally `string[]`, the client modifies this */
+  required?: (string | ConditionallyRequired)[];
+
+  /** added by client */
+  wasExpandedByClient?: boolean;
+
+  /** ISO Date. Copied from @see WrappedSchema */
+  start_date?: string;
+  /** ISO Date. Copied from @see WrappedSchema If this tag exists, the schema is deprecated */
+  end_date?: string;
+
+  /** 🚨 Note that there are cases where properties are undefined, e.g. if the schema is a sub-object */
+  properties: {
+    [fieldName: string]: SchemaField;
+  };
+
+  /** the client adds this after processing the i18n property */
+  groupNames?: Record<string, string>;
+
+  /** added by the client to inform downstream components which locale from schema.i18n was used */
+  clientLocale?: string;
+
+  /** added by the client, copied from @see WrappedSchema */
+  version: string;
+
   /**
-   * @deprecated this prop exists so that SchemaMetadata does not extend Schema.
-   * use `getSchema(schemaName)` to fetch the full schema
+   * the estimated loading times in seconds for various API calls. The client adds
+   * this field after processing the schema tags.
    */
-  __typeof__: "You cannot supply SchemaMetadata to a function that expects Schema";
+  timing?: Record<"extract" | "live_person" | "verify_pending_delay", number>;
 
-  isProfileSchema: boolean;
-  isSpSchema: boolean;
+  /** added by the client. If true, this should be shown to the client */
+  isProfileSchema?: boolean;
+
+  /** added by the client. If true, this schema somehow relates to legacy service providers */
+  isSpSchema?: boolean;
+};
+
+/** This is what's returned by the API */
+export type WrappedSchema = {
+  active: true;
+  /** ISO Date */
+  start_date: string;
+  /** ISO Date. If this tag exists, the schema is deprecated. */
+  end_date: string;
+  name: string;
+  type: "ss" | "ps" | "us";
+  version: string;
+  /** whether the \`version\` is the latest version */
+  version_current: boolean;
+  schema: CommonSchemaAttributes & {
+    /** @deprecated don't use this */
+    $id?: string;
+    /** @deprecated don't use this */
+    $schema?: string;
+
+    definitions?: Record<string, { $ref: Urn }>;
+    allOf?: {
+      $ref?: string;
+      if?: Partial<WrappedSchema["schema"]>;
+      // we don't suport else (yet)
+      then?: Partial<WrappedSchema["schema"]>;
+    }[];
+
+    properties: {
+      [fieldName: string]: ServerSchemaField;
+    };
+
+    required?: string[];
+    verified_fields?: string[];
+  };
 };
 
 /** @ignore */

package/src/theme.ts

@@ -10,7 +10,7 @@ export type Colors = {
   raytioOrangeText: string;
   raytioOrangeUi: string;
   raytioOrangeHover: string;
-  /** only used by the fancy layout on the login screen */
+  /** ✨ */
   raytioOrangeShade: string;
   successGreen: string;
   loadingYellow: string;
@@ -21,7 +21,6 @@ export type Colors = {
   sariShade: string;
   feelingHugged: string;
   silverShell: string;
-  blankBackground: string;
   blank: string;
 };
 

package/src/wizard.ts

@@ -76,7 +76,7 @@ export type WizardPage = {
 
 /**
  * when a form link is generated, this is what gets saved on the API.
- * Each value can be overriden in the query parameters. If specified
+ * Each value can be overridden in the query parameters. If specified
  * in the query parameters, it needs to be base64 and/or url encoded.
  */
 export type WizardConfig = {