@raytio/types 5.2.0 → 6.0.1

package/src/schema.ts

@@ -23,12 +23,18 @@ export type SchemaFieldTag =
   | "display:survey"
   | "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"
+  | "date_component:month"
+  | "date_component:year"
   // other
   | "action:client_upload"
   | "verify:show_if_pending"
   | "special:hide_select_behind_button"
+  | "type:capture_geolocation" // triggers the wizard's GeoLocationInput field
   | "type:extract_required";
 
 export type SchemaTag =
@@ -38,6 +44,11 @@ export type SchemaTag =
   // camera
   | "default_camera:rear"
   | "default_camera:front"
+  // oauth group rule
+  | `oauth2_component:name:${string}`
+  | `oauth2_component:redirect_url:${string}`
+  // misc
+  | `link_to:${/* schemaName */ string}:${/* relationshipType */ string}`
   // type
   | "type:service_provider"
   | "type:service_offer"
@@ -49,21 +60,21 @@ export 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 */
@@ -71,13 +82,17 @@ export 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;
@@ -99,10 +114,10 @@ export 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 */
@@ -119,6 +134,8 @@ export 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
@@ -144,9 +161,13 @@ export type Schema = {
   $schema?: string;
   n_id?: NId;
 
-  /** name will always exist on schema */
+  /** 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.
@@ -155,12 +176,13 @@ export type Schema = {
   /** the localized title of the `schema_group`. added by the client */
   group_title?: string;
 
-  title?: string;
-  description?: 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)[];
@@ -178,13 +200,11 @@ export type 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;
   };
 
@@ -194,6 +214,7 @@ export type Schema = {
       // @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.
+      // ^ 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.
 
       // see !1796 for where these are used
@@ -208,7 +229,9 @@ export type Schema = {
       $loading_delete_pending_ver: { title: string };
       $loading_pending_ver_resubmit: { title: string };
 
-      [fieldNameOrGroupName: string]: SchemaField & { title_plural?: string };
+      [fieldNameOrGroupName: string]: Omit<SchemaField, "$prop"> & {
+        title_plural?: string;
+      };
     };
   };
   /** @internal the client adds this after processing the i18n property */
@@ -308,3 +331,34 @@ export type Schema = {
     return_to?: string;
   };
 };
+
+/** 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"
+> & {
+  /**
+   * @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 type RelationDefinition = NonNullable<Schema["relationships"]>[number];

package/src/theme.ts

@@ -24,3 +24,5 @@ export type Colors = {
   blankBackground: string;
   blank: string;
 };
+
+export type CustomFonts = { header?: string; body?: string };

package/src/verification.ts

@@ -1,5 +1,34 @@
 import { NId, ProfileObject } from "./raytio";
 
+export type VerificationPayload<WithValue extends boolean> = {
+  // we deliberately haven't defined 'sub'
+  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;
+  // we are disabling the eslint rule beacuse even tho `{}` acts illogically in typescript,
+  // in this case it's working as expected in the intersection type, see
+  // https://github.com/typescript-eslint/typescript-eslint/issues/2063#issuecomment-632833366
+  // and https://github.com/typescript-eslint/typescript-eslint/issues/2063#issuecomment-645510515
+  // eslint-disable-next-line @typescript-eslint/ban-types
+} & (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
@@ -17,27 +46,7 @@ export type Verification<WithValue extends boolean = false> = ProfileObject<{
   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;
-        // we are disabling the eslint rule beacuse even tho `{}` acts illogically in typescript,
-        // in this case it's working as expected in the intersection type, see
-        // https://github.com/typescript-eslint/typescript-eslint/issues/2063#issuecomment-632833366
-        // and https://github.com/typescript-eslint/typescript-eslint/issues/2063#issuecomment-645510515
-        // eslint-disable-next-line @typescript-eslint/ban-types
-      } & (WithValue extends true ? { value: string | number } : {});
+      data: VerificationPayload<WithValue>;
     },
   ];
 }>;
@@ -46,6 +55,8 @@ export type Verification<WithValue extends boolean = false> = ProfileObject<{
  * "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)
 export enum FieldVerification {
   Verified = 60_001,
   NotVerified,
@@ -53,6 +64,8 @@ export enum FieldVerification {
   Expired,
 }
 
+// We cannot change the enum values, since ScoreRules have been generated
+// with the enum values hardcoded.
 export enum POVerification {
   FullyVerified = 70_001,
   PartiallyVerified,
@@ -69,13 +82,13 @@ export type VerificationProvider = {
   dataSourceNId?: NId;
   serviceProviderNId?: NId;
   /** the date which the verification was verified on, or last re-verified on */
-  date: Date;
+  date?: Date;
 };
 
 /** This is what @raytio/core exposes, which is more useable than @see Verification */
 export type RealVer = {
   fieldName: string;
-  value: string | number;
+  value: unknown;
   provider: VerificationProvider;
   signature: string;
   /**

package/src/wizard.ts

@@ -1,13 +1,18 @@
 import { AId } from "./raytio";
 
 /** configuration data for a single wizard page (@see WizardConfig) */
-export interface WizardPage {
+export type WizardPage = {
   /** if undefined, the schema title will be used */
   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 */
@@ -52,16 +57,22 @@ export interface WizardPage {
     | "review" // continue to review page
     | "next_step"; // continue & skip the review page
 
+  /** 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?: boolean;
+  verify_data?: boolean;
 
   /** a list of fields that should not be required, even if the schema says they're required */
   optional_fields?: string[];
 
-  /** the infomation to share. undefined implies both. */
+  /** the information to share. undefined implies both. */
   // TODO: 'profile' is not supported yet
   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.
@@ -104,7 +115,7 @@ export type WizardConfig = {
   emails?: string[];
 
   /**
-   * whether the "quick onboard" process should be used if the user visits
+   * 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
    */