@raytio/types 5.0.0 → 6.0.0

package/dist/crypto.d.ts

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

package/dist/raytio.d.ts

@@ -1,9 +1,11 @@
 import { Encrypted } from "./crypto";
-import { Colors } from "./theme";
+import { Colors, CustomFonts } from "./theme";
 /** @internal see Microsoft/TypeScript#202 */
 export declare 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 */
@@ -16,12 +18,10 @@ export declare type GId = StringWithIdentity<"GId">;
 export declare type UId = StringWithIdentity<"UId">;
 /** An `a_id` is the ID of an @see AA */
 export declare type AId = StringWithIdentity<"AId">;
-/** @internal */
 export declare type DataTypes = "string" | "number" | "boolean" | "object" | "integer" | "array" | "null";
-/** @internal */
 export declare 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 = any> = {
+export declare type ProfileObject<Properties = Json> = {
     n_id: NId;
     properties: Properties;
     labels: string[];
@@ -31,10 +31,10 @@ export declare type ProfileObject<Properties = any> = {
      * @internal the client adds this, if this PO doesn't actually belong to the current user,
      * i.e. it's actually from a submission. If truthy, it's the `[aId, iId]` of the submission.
      */
-    isFromSubmission?: [aId: string, iId: string];
+    isFromSubmission?: [aId: AId, iId: IId];
 };
 /** @internal This is what we send the API */
-export declare type ProfileObjectForUpload<Properties = any> = {
+export declare type ProfileObjectForUpload<Properties = Json> = {
     properties: Properties;
     document?: {
         content?: string | Encrypted;
@@ -75,6 +75,8 @@ export declare type Lookup = {
     label?: string | number;
     children?: Lookup[];
     description?: string;
+    /** used in AkahuDynamicSection only */
+    requires_2FA?: boolean;
 };
 export declare type AA = {
     a_id: AId;
@@ -82,19 +84,24 @@ export declare 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;
-    picture?: string;
+    picture?: Urn;
     /** Easy to use AA logo url for pasting inot emails */
     picture_url?: string;
     scopes?: string[];
     tags?: string[];
     callback_uri?: string[];
+    /** markdown or string help information including [phoneNumber || email] */
+    aa_help?: string;
     theme?: {
-        colors: Colors;
+        font?: CustomFonts;
+        colors?: Colors;
     };
     /** the n_id of the associated service provider */
     service_provider_n_id?: NId;
     /** the id of the associated organisation */
     org_id: string;
+    /** configuration for the submission rules */
+    ruleset?: unknown;
     /** @internal */
     _transitions?: unknown[];
 };
@@ -121,7 +128,7 @@ export declare type Instance = {
     /** @depreacted The status of a submission */
     _state?: SubmissionStatus;
     /** Previous status of the shared information */
-    previous_state: string;
+    previous_state: SubmissionStatus;
     /** Hash of the Service Provider ID */
     sub_service_provider_hash?: string;
     /** Service provider ID */
@@ -136,6 +143,7 @@ export declare type Instance = {
             };
         };
     };
+    relationships?: Relationship[];
 };
 /**
  * An organization.
@@ -155,3 +163,20 @@ export declare type Organization = {
     };
     customer: Record<string, unknown>;
 };
+/** validation data returned by preVerify (part of the extract&map API) */
+export declare type Validation = {
+    score: number;
+    warning?: string[];
+    breakdown: {
+        [category: string]: {
+            passed: boolean;
+            /** only present if passed=false */
+            code?: number;
+            /** only present if passed=false */
+            reason?: string;
+            /** only present if passed=false */
+            severity?: "low" | "medium" | "high";
+        };
+    };
+};
+export {};

package/dist/schema.d.ts

@@ -1,32 +1,33 @@
-import { AA, DataTypes, Organization, Urn } from "./raytio";
+import { AA, DataTypes, NId, Organization, Urn } from "./raytio";
 import { WizardConfig } from "./wizard";
+/** should be renamed since this applies to ConditionallyVerifiable */
 export declare type ConditionallyRequired = {
     field: string;
     if: {
         [fieldName: string]: string[];
     };
 };
-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:main_media:${string}` | "action:client_upload" | "verify:show_if_pending" | "special:hide_select_behind_button" | "type:extract_required";
-export declare type SchemaTag = "type:provider_profile" | "type:service_offer" | "client_only" | "globally_unique_field" | "action:verify" | "action:experimental_pass_urn" | "type:service_provider" | "type:marketplace" | "type:client_only" | "type:globally_unique_field";
+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}` | "action:client_upload" | "verify:show_if_pending" | "special:hide_select_behind_button" | "type:extract_required";
+export declare type SchemaTag = "action:experimental_pass_object_store_id" | "action:verify" | "default_camera:rear" | "default_camera:front" | `link_to:${string}:${string}` | "type:service_provider" | "type:service_offer" | "type:marketplace" | "type:client_only" | "type:globally_unique_field";
 export declare type SchemaField = {
     /** @deprecated don't use, it's inconsistent */
     $id?: string;
     title?: string;
+    title_plural?: string;
     description?: string;
     /** readOnly means the Wizard won't show this field */
     readOnly?: boolean;
     examples?: unknown[];
     tags?: SchemaFieldTag[];
     type?: DataTypes;
-    enum?: unknown[];
+    enum?: string[];
     maximum?: number;
     minimum?: number;
     /** @deprecated raytio's usage not documented */
     maxLength?: number;
     /** @deprecated raytio's usage not documented */
     minLength?: number;
-    /** @internal added by the client. It's the default value based on the existing values from subschema on their profile */
-    defaultValue?: unknown;
+    /** the default value */
     default?: unknown;
     pattern?: string;
     /** whether the field should be encrypted */
@@ -34,13 +35,17 @@ export declare type SchemaField = {
     format?: "date" | "date-time";
     contentMediaType?: string;
     contentEncoding?: "base64";
-    /** for nested JSON */
+    /** `items` is used for nested arrays, (while `properties` is used for nested objects) */
     items?: {
         type: DataTypes;
         properties: {
             [subFieldName: string]: SchemaField;
         };
     };
+    /** `properties` is used for nested objects, (while `items` is used for nested arrays) */
+    properties?: {
+        [subFieldName: string]: SchemaField;
+    };
     /** If this field refers to a sub-object */
     $ref?: string;
     /**
@@ -60,10 +65,10 @@ export declare type SchemaField = {
     /** URL to a JSON file in the `Lookup` format */
     lookup?: string;
     /** @internal the client adds this - it's the fieldName. */
-    $prop?: string;
+    $prop: string;
     priority?: number;
     /** @internal if supplied, it's the existing field values. Added by the client */
-    subObjectRef?: (string | number)[];
+    subObjectRef?: unknown[];
     /** specifies that the description is formatted in markdown */
     description_decorator?: "md";
     /** if a `pattern` is specified, this is the error message */
@@ -79,6 +84,8 @@ export declare type SchemaField = {
     };
     /** if this field is a table input, this determines the text to show on the "Add Row" btn */
     add_row_btn_label?: string;
+    /** if this field is a table input, this determines the text to show if the table is empty */
+    table_empty_message?: string;
     /**
      * used on fields that are a signature file picker, see !849
      * also used to determine if the MediaPicker should be shown inline
@@ -96,21 +103,28 @@ export declare type SchemaField = {
  * `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;
-    /** name will always exist on schema */
+    n_id?: NId;
+    /** these fields will always exist on schema */
     name: string;
+    title: string;
+    description: string;
+    /** 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.
      */
     schema_group?: string;
-    title?: string;
-    description?: 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;
     tags?: SchemaTag[];
-    verified_fields?: string[];
+    /** originally `string[]`, the client modifies this */
+    verified_fields?: (string | ConditionallyRequired)[];
     wasExpandedByClient?: boolean;
     /** added by client */
     required?: (string | ConditionallyRequired)[];
@@ -123,19 +137,46 @@ export declare type Schema = {
         if?: Schema;
         then?: Schema;
     }[];
-    /**
-     * this is deliberately an optional prop, there are cases where properties are
-     * undefined, e.g.
-     *  - from get-all-schema API
-     *  - if the schema is a sub-object
-     */
-    properties?: {
+    /** 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;
-            [fieldNameOrGroupName: string]: SchemaField & {
+            $loading_extract: {
+                title: string;
+            };
+            $loading_verify: {
+                title: string;
+            };
+            $loading_save: {
+                title: string;
+            };
+            $loading_update: {
+                title: string;
+            };
+            $loading_upload: {
+                title: string;
+            };
+            $loading_create_sub_obj: {
+                title: string;
+            };
+            $loading_permission: {
+                title: string;
+            };
+            $loading_link_to_person: {
+                title: string;
+            };
+            $loading_delete_pending_ver: {
+                title: string;
+            };
+            $loading_pending_ver_resubmit: {
+                title: string;
+            };
+            [fieldNameOrGroupName: string]: Omit<SchemaField, "$prop"> & {
                 title_plural?: string;
             };
         };
@@ -149,11 +190,13 @@ export declare type Schema = {
      * the estimated loading times in seconds for various API calls. The client adds
      * this field after processing the schema tags.
      */
-    timing?: Record<"extract" | "verify" | "persist" | "persist_verify", number>;
+    timing?: Record<"extract" | "live_person" | "verify_pending_delay", number>;
     relationships?: {
         relationship_name: string;
         direction: "from";
         type: string;
+        /** if required_relationship then use will be alerted in relationship menu and won't be able to share PO unless filled out */
+        required_relationship?: boolean;
         /** Specify `oneOf` XOR `anyOf`. It's a list of schema names, or `"instance"` (see #784) */
         oneOf?: string[];
         /** Specify `oneOf` XOR `anyOf` It's a list of schema names. */
@@ -204,6 +247,14 @@ export declare type Schema = {
             schema_name: string;
             properties: Record<string, unknown>;
         }[];
+        /** Relationships that should be created */
+        relationships?: {
+            /** will normally look like `"{n_id:profile_objects[0]}"` */
+            from: string;
+            to: string;
+            type: string;
+            properties?: Record<string, string>;
+        }[];
         /**
          * Organizations that should be created. NOTE: if multiple are specified, when the wizard
          * completes, the _first one_ will be selected
@@ -220,5 +271,19 @@ export declare type Schema = {
                 }[];
             }[];
         }[];
+        /** The relative path in the client to redirect to once finished. May include variables */
+        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"> & {
+    /**
+     * @deprecated this prop exists so that SchemaMetadata does not extend Schema.
+     * use `getSchema(schemaName)` to fetch the full schema
+     */
+    __typeof__: "You cannot supply SchemaMetadata to a function that expects Schema";
+    isProfileSchema: boolean;
+    isSpSchema: boolean;
+};
+/** @ignore */
+export declare type RelationDefinition = NonNullable<Schema["relationships"]>[number];

package/dist/theme.d.ts

@@ -13,6 +13,7 @@ export declare type Colors = {
     /** only used by the fancy layout on the login screen */
     raytioOrangeShade: string;
     successGreen: string;
+    loadingYellow: string;
     errorRed: string;
     textLight: string;
     textMedium: string;
@@ -23,3 +24,7 @@ export declare type Colors = {
     blankBackground: string;
     blank: string;
 };
+export declare type CustomFonts = {
+    header?: string;
+    body?: string;
+};

package/dist/verification.d.ts

@@ -1,4 +1,28 @@
 import { NId, ProfileObject } from "./raytio";
+export declare type VerificationPayload<WithValue extends boolean> = {
+    field: string;
+    schema?: string;
+    metadata?: Record<string, unknown>;
+    passed: boolean;
+    request_div: string;
+    /** @deprecated don't use this, it looks like the schema name but it's not */
+    source: string;
+    /** the n_id of the parent profile object that this ver belongs (NOT the n_id of the field) */
+    source_n_id?: NId;
+    /** like `source_n_id` */
+    source_hashed_n_id?: NId;
+    type?: null;
+    v_id: string;
+    verification_date: string;
+    verifier_id?: NId;
+    verifier_source_id?: NId;
+    verifier_service_id?: NId;
+    verifier_div: string;
+    /** ISO Date */
+    valid_until?: string;
+} & (WithValue extends true ? {
+    value: string | number;
+} : {});
 /**
  * Different APIs inconsistently include the `value` prop. If you know it exists,
  * use `Verification<true>`, otherwise just `Verification`. Verifications from
@@ -16,24 +40,7 @@ export declare type Verification<WithValue extends boolean = false> = ProfileObj
     verifications: [
         {
             signature: string;
-            data: {
-                field: string;
-                metadata?: Record<string, unknown>;
-                passed: boolean;
-                request_div: string;
-                /** @deprecated don't use this, it looks like the schema name but it's not */
-                source: string;
-                /** the n_id of the parent profile object that this ver belongs (NOT the n_id of the field) */
-                source_n_id: NId;
-                v_id: string;
-                verification_date: string;
-                verifier_id?: NId;
-                verifier_source_id?: NId;
-                verifier_service_id?: NId;
-                verifier_div: string;
-            } & (WithValue extends true ? {
-                value: string | number;
-            } : {});
+            data: VerificationPayload<WithValue>;
         }
     ];
 }>;
@@ -67,7 +74,7 @@ export declare type VerificationProvider = {
 /** This is what @raytio/core exposes, which is more useable than @see Verification */
 export declare type RealVer = {
     fieldName: string;
-    value: string | number;
+    value: unknown;
     provider: VerificationProvider;
     signature: string;
     /**

package/dist/verification.js

@@ -5,6 +5,8 @@ exports.POVerification = exports.FieldVerification = void 0;
  * "Not Verified" means show no badge, cf. "Verified False" means the
  * verifier revealed that the data was wrong. So show a ❌
  */
+// We cannot change the enum values, since ScoreRules have been generated
+// with the enum values hardcoded. The enum value are also used to find the "best" or "worst" verification (lower=better)
 var FieldVerification;
 (function (FieldVerification) {
     FieldVerification[FieldVerification["Verified"] = 60001] = "Verified";
@@ -12,6 +14,8 @@ var FieldVerification;
     FieldVerification[FieldVerification["VerifiedFalse"] = 60003] = "VerifiedFalse";
     FieldVerification[FieldVerification["Expired"] = 60004] = "Expired";
 })(FieldVerification = exports.FieldVerification || (exports.FieldVerification = {}));
+// We cannot change the enum values, since ScoreRules have been generated
+// with the enum values hardcoded.
 var POVerification;
 (function (POVerification) {
     POVerification[POVerification["FullyVerified"] = 70001] = "FullyVerified";

package/dist/wizard.d.ts

@@ -1,11 +1,15 @@
 import { AId } from "./raytio";
 /** configuration data for a single wizard page (@see WizardConfig) */
-export interface WizardPage {
+export declare type WizardPage = {
     /** if undefined, the schema title will be used */
-    name?: string;
+    name?: string | symbol;
     filter: "oneOf" | "anyOf";
     schemas: string[];
+    /** the fallback description, if there isn't one for the specific situation */
     description?: string;
+    description_select?: string;
+    description_create?: string;
+    description_update?: string;
     /** if explictly == false, then it's an AO (not a PO), in which case there can only be one schema */
     profile?: boolean;
     /** if true this page can be skipped. The PageResult wil be undefined */
@@ -24,12 +28,30 @@ export interface WizardPage {
     display_field_title?: boolean;
     /** whether the field descriptions should be shown */
     display_field_description?: boolean;
-    /** if supplied, only the fields that are listed should be shared */
-    fields_to_share?: string[];
+    /** if supplied, only the fields that are listed should be shared (#520, #1024) */
+    field_list?: string[];
     /** custom text & header that's displayed on reverfication modal for expired PO */
     reverify_header?: string;
     reverify_text?: string;
-}
+    /** do not allow uploading in ImageDynamicSection if this is explictly false */
+    allow_upload?: boolean;
+    /** for ImageDynamicSection, the minimum score to be treated as a pass */
+    extract_threshold?: number;
+    /** for ImageDynamicSection, the action to take if pre-verify passes */
+    extract_threshold_pass_action?: "review" | "next_step";
+    /** for ImageDynamicSection, the action to take if pre-verify fails */
+    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` */
+    verify_data?: boolean;
+    /** a list of fields that should not be required, even if the schema says they're required */
+    optional_fields?: string[];
+    /** the information to share. undefined implies both. */
+    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";
+};
 /**
  * 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
@@ -60,4 +82,23 @@ export declare type WizardConfig = {
     skip_share?: boolean;
     /** if specified, the email addresses that a submission should be sent to */
     emails?: string[];
+    /**
+     * whether the passwordless-signup process should be used if the user visits
+     * this form, and they are not logged in. If false, the standard sign-up
+     * process will be used
+     */
+    quick_onboard?: boolean;
+    /** the loading message to show next to the spinner after the review screen */
+    sharing_data_message?: string;
+    /** a list of relationships that should be created after the wizard completes (see #987) */
+    relationships?: {
+        /** schema name */
+        from: string;
+        /** schema name */
+        to: string;
+        /** relationship type */
+        type: string;
+        /** relationship properties */
+        properties?: Record<string, any>;
+    }[];
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@raytio/types",
-  "version": "5.0.0",
+  "version": "6.0.0",
   "license": "MIT",
   "main": "index",
   "types": "index",
@@ -12,6 +12,7 @@
   ],
   "scripts": {
     "docs": "sh ../../scripts/generate-docs.sh",
-    "build": "tsc"
+    "test": "npm run build",
+    "build": "tsc && rm -rf dist/__tests__"
   }
 }

package/src/__tests__/schema.ts

@@ -0,0 +1,23 @@
+/* eslint-disable fp/no-let, @typescript-eslint/no-unused-vars */
+import { Schema, SchemaField, SchemaMetadata } from "..";
+
+/**
+ * this file is not run, it is just compiled by tsc
+ * If compilation suceeds, then the test passes.
+ */
+
+let schema: Schema;
+let schemaField: SchemaField;
+let schemaMetadata: SchemaMetadata;
+
+function f() {
+  // @ts-expect-error SchemaField should not extend Schema
+  const test1: SchemaField = schema;
+  // @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;
+}

package/src/crypto.ts

@@ -1,4 +1,5 @@
-export type Encrypted = {
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export type Encrypted<_Data = string> = {
   encrypted_key: {
     encrypted_key: string;
   };