@raytio/types 6.0.2 → 7.1.0

package/dist/raytio.d.ts

@@ -1,31 +1,33 @@
 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>;
-/** A `p_id` is the ID of a @see Relationship */
-export declare type PId = StringWithIdentity<"PId">;
-/** An `i_id` is the ID of an @see Instance */
-export declare type IId = StringWithIdentity<"IId">;
-/** An `n_id` is the ID of a @see ProfileObject */
-export declare type NId = StringWithIdentity<"NId">;
+type Json = Record<string, any>;
+/** A `p_id` is the ID of a {@link Relationship} */
+export type PId = StringWithIdentity<"PId">;
+/** An `i_id` is the ID of an {@link Instance} */
+export type IId = StringWithIdentity<"IId">;
+/** An `n_id` is the ID of a {@link ProfileObject} */
+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">;
-/** An `a_id` is the ID of an @see AA */
-export declare type AId = StringWithIdentity<"AId">;
-/** An `o_id` is the ID of an @see Organization */
-export declare type OId = StringWithIdentity<"OId">;
-/** A `wi_id` is the ID of a @see Webhook */
-export declare type WId = StringWithIdentity<"WId">;
-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 UId = StringWithIdentity<"UId">;
+/** An `a_id` is the ID of an {@link AA} */
+export type AId = StringWithIdentity<"AId">;
+/** An `o_id` is the ID of an {@link Organization} */
+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 */
-export declare type ProfileObject<Properties = Json> = {
+export type ProfileObject<Properties = Json> = {
     n_id: NId;
     properties: Properties;
     labels: string[];
@@ -38,7 +40,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;
@@ -50,18 +52,18 @@ export declare type ProfileObjectForUpload<Properties = Json> = {
 };
 /**
  * arbitrary key-values pairs stored on a Profile Object.
- * May contain nested JSON and @see Encrypted properties.
+ * 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 declare type Properties = {
-    [fieldName: string]: any;
-};
-export declare type UrnNodeType = "user" | "profile_object" | "instance" | "temp_object" | "document";
+export type Properties = Json;
+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}:${AnyId}`;
+export type Relationship = {
     start: Urn;
     end: Urn;
     p_id: PId;
@@ -72,7 +74,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 */
@@ -82,7 +84,8 @@ export declare type Lookup = {
     /** used in AkahuDynamicSection only */
     requires_2FA?: boolean;
 };
-export declare type AA = {
+export type AATag = "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;
@@ -92,7 +95,7 @@ export declare type AA = {
     /** Easy to use AA logo url for pasting inot emails */
     picture_url?: string;
     scopes?: string[];
-    tags?: string[];
+    tags?: AATag[];
     callback_uri?: string[];
     /** markdown or string help information including [phoneNumber || email] */
     aa_help?: string;
@@ -102,16 +105,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 */
@@ -131,7 +134,7 @@ export declare type Instance = {
     start_date: string;
     /** The status of a submission */
     state: SubmissionStatus;
-    /** @depreacted The status of a submission */
+    /** @deprecated The status of a submission */
     _state?: SubmissionStatus;
     /** Previous status of the shared information */
     previous_state: SubmissionStatus;
@@ -142,7 +145,7 @@ export declare type Instance = {
     /** data associated is access application's instance */
     profile_objects: ProfileObject[];
     keys: {
-        [nId: string]: {
+        [nId: NId]: {
             [fieldName: string]: {
                 data: string;
                 n_id: NId;
@@ -157,7 +160,7 @@ export declare type Instance = {
  * 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;
@@ -171,8 +174,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: {
@@ -187,11 +201,14 @@ export declare type Validation = {
         };
     };
 };
-export declare type Webhook = {
+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;
-    status: unknown;
+    /** not sure what this is */
+    provider_webhook_subscription_id: NId;
+    status: WebhookStatus;
     /** ISO Date */
     date_created: string;
     /** ISO Date */
@@ -204,10 +221,18 @@ export declare type Webhook = {
     webhook_action: {
         webhook_action_type: string;
     }[];
-    provider_subscription_credentials: unknown;
     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/raytio.js

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

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: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 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 */
     $id?: string;
     title?: string;
@@ -20,9 +20,15 @@ export declare type SchemaField = {
     examples?: unknown[];
     tags?: SchemaFieldTag[];
     type?: DataTypes;
-    enum?: string[];
+    enum?: (string | number | boolean)[];
+    /** for number inputs, the maximum allowed value */
     maximum?: number;
+    /** for number inputs, the minimum allowed value */
     minimum?: number;
+    /** for number inputs, the step size used in the input or slider */
+    step?: number;
+    /** if true, the user must have encryption enabled to save this data, see #1324 */
+    encrypt_require?: boolean;
     /** @deprecated raytio's usage not documented */
     maxLength?: number;
     /** @deprecated raytio's usage not documented */
@@ -59,7 +65,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 +104,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 +120,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 +158,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 +208,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 +243,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 {@link WrappedSchema} */
+    start_date?: string;
+    /** ISO Date. Copied from {@link 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 {@link 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/schema.js

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

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;
@@ -23,7 +23,7 @@ export declare type Colors = {
     silverShell: string;
     blank: string;
 };
-export declare type CustomFonts = {
+export type CustomFonts = {
     header?: string;
     body?: string;
 };

package/dist/theme.js

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

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>;
@@ -18,8 +18,6 @@ export declare type VerificationPayload<WithValue extends boolean> = {
     verifier_source_id?: NId;
     verifier_service_id?: NId;
     verifier_div: string;
-    /** ISO Date */
-    valid_until?: string;
 } & (WithValue extends true ? {
     value: string | number;
 } : {});
@@ -28,7 +26,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,15 +62,15 @@ 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;
     /** the date which the verification was verified on, or last re-verified on */
     date?: Date;
 };
-/** This is what @raytio/core exposes, which is more useable than @see Verification */
-export declare type RealVer = {
+/** This is what @raytio/core exposes, which is more useable than {@link Verification} */
+export type RealVer = {
     fieldName: string;
     value: unknown;
     provider: VerificationProvider;

package/dist/verification.js

@@ -1,5 +1,5 @@
 "use strict";
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.POVerification = exports.FieldVerification = void 0;
 /**
  * "Not Verified" means show no badge, cf. "Verified False" means the

package/dist/wizard.d.ts

@@ -1,6 +1,7 @@
 import { AId } from "./raytio";
-/** configuration data for a single wizard page (@see WizardConfig) */
-export declare type WizardPage = {
+export type WizardPageTag = "action:require_chip";
+/** configuration data for a single wizard page ({@link WizardConfig}) */
+export type WizardPage = {
     /** if undefined, the schema title will be used */
     name?: string | symbol;
     filter: "oneOf" | "anyOf";
@@ -20,7 +21,7 @@ export declare type WizardPage = {
     service_provider_link?: boolean;
     /** custom text to display on the Create New button */
     create_new_text?: string;
-    /** a URL to a preset for configuing NestedSchemaSelect. @see DeepConfig */
+    /** a URL to a preset for configuing NestedSchemaSelect. {@link DeepConfig} */
     selection_hierarchy_json?: string;
     /** whether the schema description should be shown */
     display_schema_description?: boolean;
@@ -43,7 +44,12 @@ export declare type WizardPage = {
     extract_threshold_fail_action?: "capture" | "capture_review" | "recapture_or_next_step" | "review" | "next_step";
     /** for ImageDynamicSection, the action to take if the API returns no `validation: {}` object */
     extract_threshold_null_action?: WizardPage["extract_threshold_fail_action"];
-    /** if `false`, ProfileObjects created while completing the form will not be verified. `undefined` implies `true` */
+    /**
+     * if `false`, ProfileObjects created while completing the form will not be verified.
+     * if `true`, you can only select ProfileObjects that are partially or fully verified.
+     * `undefined` implies `true`.
+     * @default true
+     */
     verify_data?: boolean;
     /** a list of fields that should not be required, even if the schema says they're required */
     optional_fields?: string[];
@@ -51,13 +57,19 @@ export declare type WizardPage = {
     share?: "profile" | "verification" | "both";
     /** can you force the colour theme to change for just one page (#1066, #1074). At the moment this on pages that use WebcamImageCapture */
     display_mode?: "light" | "dark" | "default";
+    tags?: WizardPageTag[];
+    /**
+     * If specified, this is is a "Conditional Wizard Page", which is only shown
+     * if the rule passed. This field contains the ID (not name) of the rule.
+     */
+    branching_rule_name?: string;
 };
 /**
  * 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/dist/wizard.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@raytio/types",
-  "version": "6.0.2",
+  "version": "7.1.0",
   "license": "MIT",
   "main": "index",
   "types": "index",
@@ -12,7 +12,7 @@
   ],
   "scripts": {
     "docs": "sh ../../scripts/generate-docs.sh",
-    "test": "npm run build",
-    "build": "tsc && rm -rf dist/__tests__"
+    "test": "npm run build && yarn docs",
+    "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 "..";
+/* eslint-disable @typescript-eslint/no-unused-vars */
+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;
 }