@raytio/types 7.2.0 → 8.0.0

package/dist/verification.d.ts

@@ -1,4 +1,4 @@
-import { NId, ProfileObject } from "./raytio";
+import type { CommonFields, GPMId, Json, NId, ProfileObject, SchemaName } from "./raytio";
 export declare enum SafeHarbourCode {
     /** “a match has been made on each the Full Name, Address and Date of Birth” */
     M1 = "M1",
@@ -9,10 +9,14 @@ export declare enum SafeHarbourCode {
 }
 export type VerificationPayload<WithValue extends boolean> = {
     field: string;
-    schema?: string;
+    schema?: SchemaName;
     metadata?: {
         safeHarbourScore?: SafeHarbourCode;
-        status?: "pending";
+        status?: "pending" | "approved";
+        validation?: {
+            id: string;
+            url: string;
+        };
         pending_details?: {
             /**
              * for pending verifications - whether the verifier will complete fast enough that
@@ -37,6 +41,7 @@ export type VerificationPayload<WithValue extends boolean> = {
     source_hashed_n_id?: NId;
     type?: null;
     v_id: string;
+    verification_type_id: GPMId;
     verification_date: string;
     verifier_id?: NId;
     verifier_source_id?: NId;
@@ -98,6 +103,7 @@ export type VerificationProvider = {
     verifierNId?: NId;
     dataSourceNId?: NId;
     serviceProviderNId?: NId;
+    verificationTypeId?: GPMId;
     /** the date which the verification was verified on, or last re-verified on */
     date?: Date;
 };
@@ -123,3 +129,35 @@ export type RealVer = {
     /** If the verification has expired, it's the date that it expired on. Otherwise it's `false` */
     expired: Date | false;
 };
+export type VerificationType = CommonFields<GPMId> & {
+    item_number: number;
+    org_number: number;
+    item_key: string;
+    item_key_01: string | null;
+    item_key_02: string | null;
+    item_key_03: string | null;
+    item_type: string | null;
+    item_name: string;
+    item_name_i18n: Json | null;
+    item_description: string;
+    item_description_i18n: Json | null;
+    primary_uom: string;
+    secondary_uom: string | null;
+    item_mass: number | null;
+    item_mass_uom: string | null;
+    item_volume: number | null;
+    item_volume_uom: string | null;
+    item_dimension_length: number | null;
+    item_dimension_width: number | null;
+    item_dimension_height: number | null;
+    item_dimension_uom: string | null;
+    purchased: boolean | null;
+    shipped: boolean | null;
+    stocked: boolean | null;
+    transacted: boolean | null;
+    asset: boolean | null;
+    returnable: boolean | null;
+    inventory_organization_number: number | null;
+    source_type: string | null;
+    source_organization_number: number | null;
+};

package/dist/wizard.d.ts

@@ -1,11 +1,11 @@
-import { AId } from "./raytio";
+import type { AId, SchemaName } from "./raytio";
 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";
-    schemas: string[];
+    schemas: SchemaName[];
     /** the fallback description, if there isn't one for the specific situation */
     description?: string;
     description_select?: string;
@@ -81,9 +81,9 @@ export type WizardConfig = {
     /** number of days in the future */
     expiry_date?: number;
     /** if specified, a Wizard will be shown on the review page with this schema */
-    terms_schema?: string;
+    terms_schema?: SchemaName;
     /** if specified, a Wizard will be shown on the review page with this schema */
-    signature_schema?: string;
+    signature_schema?: SchemaName;
     reference?: string;
     /**
      * the callback url to redirect to once complete. Must be in the AA's

package/package.json

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

package/src/__tests__/raytio.typetest.ts

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

package/src/__tests__/schema.typetest.ts

@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
-import { Schema, SchemaField, WrappedSchema } from "..";
+import type { Schema, SchemaField, WrappedSchema } from "..";
 
 /**
  * this file is not run, it is just compiled by tsc

package/src/index.ts

@@ -5,3 +5,5 @@ export * from "./theme";
 export * from "./verification";
 export * from "./wizard";
 export * from "./orgs";
+export * from "./subscription";
+export * from "./merchant";

package/src/merchant.ts

@@ -0,0 +1,22 @@
+import type { CommonFields, Json, MId, PRid } from "./raytio";
+
+export type MerchantTypeCode = "TYPE_1" | "TYPE_2";
+export type MerchantClassCode = "CLASS_1" | "CLASS_2";
+export type MerchantStatusCode = "ACTIVE" | "INACTIVE";
+export type MerchantApprovalStatusCode = "PENDING" | "APPROVED";
+
+export type Merchant = CommonFields<MId> & {
+  party_id: PRid;
+  merchant_name: string | null;
+  merchant_name_i18n: Json | null;
+  merchant_common_name: string | null;
+  merchant_common_name_i18n: Json | null;
+  merchant_description: string | null;
+  merchant_description_i18n: Json | null;
+  merchant_image_url_logo: string | null;
+  merchant_image_url_thumbnail: string | null;
+  merchant_type_code: MerchantTypeCode | null;
+  merchant_class_code: MerchantClassCode | null;
+  merchant_status_code: MerchantStatusCode | null;
+  merchant_approval_status_code: MerchantApprovalStatusCode | null;
+};

package/src/orgs.ts

@@ -1,15 +1,86 @@
+import type {
+  CId,
+  CommonFields,
+  LOCId,
+  Lookup,
+  OId,
+  PCId,
+  PRid,
+  PermissionType,
+  UId,
+} from "./raytio";
+
 /** Types Used for Organization Related API Responses */
-/** An Organisation */
-export type Party = {
-  id: string;
-  start_date: string;
-  end_date: string;
-  active: boolean;
+
+/**
+ * An organization.
+ * NOTE: this is different to how the schema defines an Organization. **The schema is wrong (see #468)**
+ */
+export type Organization = {
+  id: CId;
+  orgId: OId;
+  name: string;
+  // just using email_address for now until ss_Billing_Organization gets updated to support the additional fields
+  contact_point?: Pick<ContactPoint, "email_address" | "id">;
+  address?: unknown; // Waiting on Backend Progress Before being properly updated (as of #1361)
+  customerUsers: CustomerUser[];
+};
+
+/** @internal some APIs now return extra info. this is what gets passed around in the client.  */
+export type FullOrg = {
+  id: CId;
+  organization: Omit<Organization, "id">;
+  /** 🧙‍♂️ */
+  gandalf?: unknown;
+  stripe?: { customer: unknown };
+  centrix_credentials?: unknown;
+};
+
+/** An organization/customer, directly returned by the API */
+export type Customer = CommonFields<CId> & {
+  customer_code: string;
+  party_id: PRid;
+  party_description: OId; // this is the old org_id but it's not a UUID so it's stored here (see #1361)
+  permission_type: PermissionType | null; // Once we start caring about Permissions (Sometime after #1390) this should be in a similar format to "ADMINS" | "OWNS" etc
+  user_id: UId | null;
+  owner_email: string;
+  user_email: string;
+  prm_parties?: Party;
+};
+
+/** Organization Customer / User, Returned directly by the API */
+export type CustomerUser = CommonFields<CId> & {
+  customer_code: string;
+  party_id: PRid;
   party_name: string;
-  party_description: string;
+  party_description: OId;
+  owner_id: UId;
+  owner_email: string;
+  permission_type: PermissionType | null;
+  user_id: UId | null;
+  user_email: string | null;
+  group_name: string | null;
+};
+
+export type Party = CommonFields<PRid, PartyMetadata> & {
+  party_name: string;
+  party_description: OId;
   party_type: string;
-  metadata: PartyMetadata;
-  party_number: number;
+  party_image_url_logo: string | null;
+  far_customers: CommonFields<CId> &
+    {
+      freight_term_code: string;
+      customer_type_code: string;
+      customer_class_code: string;
+      customer_status_code: string;
+      price_list_version_id: string | null;
+      customer_approval_status_code: string;
+      far_customers_customer_type_lookup: Lookup;
+      far_customers_freight_terms_lookup: Lookup;
+      far_customers_customer_class_lookup: Lookup;
+      far_customers_customer_status_lookup: Lookup;
+      far_customers_customer_approval_status_lookup: Lookup;
+    }[];
 };
 
 /** An Organizations credentials */
@@ -20,27 +91,34 @@ export type PartyMetadata = {
 };
 
 /** An Organization Site */
-export type PartySite = {
-  id: string;
-  start_date: string;
-  end_date: string;
-  active: boolean;
-  party_id: string;
-  location_number: number;
+export type PartySite = CommonFields<never> & {
+  party_id: PRid;
+  location_id: number;
   party_site_name: string;
   party_site_description: string | null;
-  party_site_number: string | null;
   party_uses: string[];
   party_use_primary: string;
-  metadata: unknown;
+};
+
+export type CustomerSite = CommonFields<never> & {
+  org_id: OId;
+  party_site_id: string;
+  customer_site_code: string;
+  customer_site_status_code: string;
+};
+
+export type CustomerSiteUse = CommonFields<never> & {
+  org_id: OId;
+  customer_site_id: string;
+  customer_site_use_purpose_code: string;
+  customer_site_use_name: string;
+  freight_term_code: string | null;
+  payment_term_id: string;
+  price_list_version_id: string | null;
 };
 
 /** An Organization Location */
-export type Location = {
-  id: string;
-  start_date: string;
-  end_date: string;
-  active: boolean;
+export type Location = CommonFields<LOCId> & {
   location_name: string;
   location_description: string | null;
   address_line_1: string | null;
@@ -62,16 +140,11 @@ export type Location = {
   country: string | null;
   geolocation: string | null;
   geolocation_outline: string | null;
-  metadata: unknown;
 };
 
 /** A Contact Point for an Organization */
-export type ContactPoint = {
-  id: string;
-  start_date: string;
-  end_date: string;
-  active: boolean;
-  to_table: string;
+export type ContactPoint = CommonFields<PCId> & {
+  party_id: PRid;
   uuid: string | undefined;
   contact_point_purpose: string;
   contact_point_type: string;
@@ -82,5 +155,4 @@ export type ContactPoint = {
   url_type: string | null;
   email_address: string;
   email_address_preferred_format: string;
-  metadata: unknown;
 };

package/src/raytio.ts

@@ -1,11 +1,11 @@
-import { Encrypted } from "./crypto";
-import { Colors, CustomFonts } from "./theme";
+import type { Encrypted } from "./crypto";
+import type { Colors, CustomFonts } from "./theme";
 
 /** @internal see Microsoft/TypeScript#202 */
 export type StringWithIdentity<T> = string & { $$typeof$$: T };
 
 /** @internal */
-type Json = Record<string, any>; // TODO: (semver breaking) unknown
+export type Json = Record<string, any>; // TODO: (semver breaking) unknown
 
 /** A `p_id` is the ID of a {@link Relationship} */
 export type PId = StringWithIdentity<"PId">;
@@ -13,18 +13,60 @@ export type PId = StringWithIdentity<"PId">;
 export type IId = StringWithIdentity<"IId">;
 /** An `n_id` is the ID of a {@link ProfileObject} */
 export type NId = StringWithIdentity<"NId">;
+/** ⚠️ This ID duplicates the {@link NId} and should only be used in exceptional circumstances */
+export type NId2 = StringWithIdentity<"NId2">;
 /** A `g_id` is the ID of a group */
 export type GId = StringWithIdentity<"GId">;
 /** A `u_id` is the ID of a user */
 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} */
+/**
+ * An `o_id` is the ID of an {@link Organization}
+ *
+ * NOTE: Will be deprecated soon. Use CId instead.
+ * */
 export type OId = StringWithIdentity<"OId">;
+/** A `pr_id` is the ID of a {@link Party} */
+export type PRid = StringWithIdentity<"PRid">;
+/** A `pc_id` is the ID of a Party Contact Point */
+export type PCId = StringWithIdentity<"PCId">;
 /** 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 */ // e.g. StoredWizardConfig and VerBundleMetadata
 export type LId = StringWithIdentity<"LId">;
+/** A `k_id` (also called a `aack_id` or a `publicKeyId`) is the ID of an AA's public key  */
+export type KId = StringWithIdentity<"KId">;
+/** A `pk_id` is the ID of an AA's private key  */
+export type PKId = StringWithIdentity<"PKId">;
+/** A `c_id` is the ID of a {@link Customer}, (will eventually replace org_id) */
+export type CId = StringWithIdentity<"CId">;
+/** A `t_id` is the ID of a transaction */
+export type TId = StringWithIdentity<"TId">;
+/** A `ws_id` is the ID of a transition */
+export type WSId = StringWithIdentity<"WSId">;
+/** A `SchemaName` is the ID of a {@link Schema} */
+export type SchemaName = StringWithIdentity<"SchemaName">;
+/** A `loc_id` is the ID of a location */
+export type LOCId = StringWithIdentity<"LOCId">;
+/** A `pl_id` is the ID of a PriceList */
+export type PLId = StringWithIdentity<"PLId">;
+/** A `prc_id` is the ID of a Price */
+export type PRCId = StringWithIdentity<"PRCId">;
+/** A `pll_id` is the ID of a PriceListLine/Plan */
+export type PLLId = StringWithIdentity<"PLLId">;
+/** A `s_id` is the ID of a Subscription */
+export type SId = StringWithIdentity<"SId">;
+/** A `sl_id` is the ID of a SubscriptionLine */
+export type SLId = StringWithIdentity<"SLId">;
+/** A `pm_id` is the ID of a PaymentMethod */
+export type PMId = StringWithIdentity<"PMId">;
+/** A `pt_id` is the ID of a PaymentProcessor */
+export type PTId = StringWithIdentity<"PTId">;
+/** A `m_id` is the ID of a Merchant */
+export type MId = StringWithIdentity<"MId">;
+/** A `gpm_id` is the ID of a Verification Type */
+export type GPMId = StringWithIdentity<"GPMId">;
 
 export type DataTypes =
   | "string"
@@ -45,8 +87,40 @@ export type SubmissionStatus =
   | "Received"
   | "Accepted";
 
+/**
+ * Every object in the new database has these fields. In the
+ * interest of type-safety, the `id` should be one of the
+ * well-known IDs that extend {@link StringWithIdentity} (e.g.
+ * {@link NId} or {@link AId}). If the ID is irrelevant, then
+ * use `CommonFields<never>` rather than `CommonFields<string>`.
+ * This will deliberately prevent you from utilising the `id`
+ * field until you define a special type for that ID.
+ *
+ * This is especially important with the new API where it is much
+ * easier to mix up the different types of IDs.
+ */
+export type CommonFields<
+  IdType extends StringWithIdentity<string>,
+  Metadata = unknown,
+> = {
+  id: IdType;
+  /** ISO Date */
+  start_date: string;
+  /** ISO Date */
+  end_date: string;
+  active: boolean;
+  metadata: Metadata | undefined;
+  row_version?: number;
+  resource_group?: string;
+  resource_name?: string;
+  resource_url?: string;
+  tenant_id?: string;
+};
+
+export type PermissionType = "ADMINS" | "VIEWS" | "EDITS" | "OWNS";
+
 /** You can supply an option type argument if you know exactly what the properties will be */
-export type ProfileObject<Properties = Json> = {
+export type ProfileObject<Properties = Json> = Partial<CommonFields<NId2>> & {
   n_id: NId;
   properties: Properties;
   labels: string[];
@@ -70,7 +144,7 @@ export type ProfileObjectForUpload<Properties = Json> = {
 
   // TODO: represent the below constraint in the typedef
   // `schema` XOR `n_id` depending on whether creating or updating
-  schema?: string; // only if creating a new PO
+  schema?: SchemaName; // only if creating a new PO
   n_id?: NId; // only if editing an existing PO
 };
 
@@ -88,9 +162,11 @@ export type Urn =
   | `urn:profile_object:${NId}`
   | `urn:instance:${IId}`
   | `urn:temp_object:${LId}`
-  | `urn:schema:${/* schemaName */ string}`
+  | `urn:schema:${SchemaName}`
   | `urn:document:${NId}`;
 
+export type ContentUrl = `url:${string}`;
+
 export type Relationship = {
   start: Urn;
   end: Urn;
@@ -101,6 +177,9 @@ export type Relationship = {
     name?: string;
     [fieldName: string]: unknown;
   };
+  start_date?: string;
+  end_date?: string;
+  active?: boolean;
 };
 
 export type Lookup = {
@@ -144,7 +223,8 @@ export type AA = {
   /** the n_id of the associated service provider */
   service_provider_n_id?: NId;
   /** the id of the associated organization */
-  org_id: OId;
+  org_id?: OId;
+  customer_id: CId;
 
   /** configuration for the submission rules */
   // we know the type should be `ScoreConfig`, but we can't rely that it's valid, or the right version
@@ -162,17 +242,15 @@ export type AA = {
   metadata?: unknown;
   secret?: unknown;
 
-  /** @internal */
+  /** @internal fetched separately (see #1511)  */
   transitions?: unknown[];
 };
 
-export type Instance = {
-  /** Access application instance ID */
-  i_id: IId;
+export type InstanceWithoutData = CommonFields<IId, { message?: string }> & {
   /** ID of the access application this submission was made to */
-  a_id: AId;
-  /** name of the access application this submission was made to */
-  aa_name: string;
+  aa_id: AId;
+  /** ID of the public key for this AA */
+  aack_id: KId;
   /** Code that validates information has been shared */
   confirmation_code: string;
   /** reference provided by the user who shared the data */
@@ -180,31 +258,12 @@ export type Instance = {
   /** Email of user who shared the data */
   data_provider_email: string;
   thread: string;
-  /** Latest date in which the shared information was available */
-  end_date: string;
-  /** Earliest date on which the shared information was available */
-  start_date: string;
   /** The status of a submission */
   state: SubmissionStatus;
-  /** @deprecated The status of a submission */
-  _state?: SubmissionStatus;
-
   /** Hash of the Service Provider ID */
-  sub_service_provider_hash?: string;
+  sub_service_provider_hash: string;
   /** Service provider ID */
-  service_provider_n_id?: NId;
-  /** data associated is access application's instance */
-  profile_objects: ProfileObject[];
-  // TODO: (semver breaking) mark as optional since the get-shared-data API doesn't return keys
-  keys: {
-    [nId: NId]: {
-      [fieldName: string]: {
-        data: string;
-        n_id: NId;
-      };
-    };
-  };
-  relationships?: Relationship[];
+  service_provider_n_id: NId;
 
   /** added by the client once it calculates the score */
   // Defined as `unknown` instead of `ScoreResult` because it could be nonsense,
@@ -226,34 +285,23 @@ export type Instance = {
   platform_footer_html?: unknown;
   /** Related Service Types */
   related_service_types?: unknown;
-  /** Activity Status */
-  active?: boolean;
-  /** Key (Can be used to retrieve instance) */
-  aack_id?: string;
-  /** Metadata */
-  metadata?: unknown;
 };
 
 /**
- * An organization.
- * NOTE: this is different to how the schema defines an Organization. **The schema is wrong (see #468)**
+ * The API used to store data in this format, but it no
+ * longer does :( so `@raytio/core` reconstructs this object.
  */
-export type Organization = {
-  id: OId;
-  name: string;
-  email: string;
-  address: unknown; // Waiting on Backend Progress Before being properly updated (as of #1361)
-  customer: unknown; // Waiting on Backend Progress Before being properly updated (as of #1361) (was previously Record<string, unknown>)
-};
-
-/** @internal some APIs now return extra info */
-export type FullOrg = {
-  id: OId;
-  organization: Omit<Organization, "id">;
-  /** 🧙‍♂️ */
-  gandalf: unknown;
-  stripe: { customer: unknown };
-  centrix_credentials: unknown;
+export type Instance = InstanceWithoutData & {
+  profile_objects: ProfileObject[];
+  keys: {
+    // this is no longer keyed by the nId,
+    [nId2: NId2]: {
+      [fieldName: string]: {
+        data: string;
+      };
+    };
+  };
+  relationships: Relationship[];
 };
 
 /** validation data returned by preVerify (part of the extract&map API) */
@@ -309,3 +357,17 @@ export type Webhook = {
     response_payload: Json;
   }[];
 };
+
+/**
+ * Link used for an Access Application, including all additional information
+ */
+export type Link = {
+  id: NId;
+  a_id: AId;
+  name: string;
+  subtitle: string;
+  code: LId;
+  url: string;
+  details?: AA;
+  isDefault?: boolean;
+};