@raytio/types 7.3.0 → 8.0.0

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

@@ -5,7 +5,7 @@ import type { Colors, CustomFonts } from "./theme";
 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">;
@@ -21,16 +21,52 @@ export type GId = StringWithIdentity<"GId">;
 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"
@@ -74,8 +110,15 @@ export type CommonFields<
   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> = Partial<CommonFields<NId2>> & {
   n_id: NId;
@@ -122,6 +165,8 @@ export type Urn =
   | `urn:schema:${SchemaName}`
   | `urn:document:${NId}`;
 
+export type ContentUrl = `url:${string}`;
+
 export type Relationship = {
   start: Urn;
   end: Urn;
@@ -178,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
@@ -196,7 +242,7 @@ export type AA = {
   metadata?: unknown;
   secret?: unknown;
 
-  /** @internal */
+  /** @internal fetched separately (see #1511)  */
   transitions?: unknown[];
 };
 
@@ -258,28 +304,6 @@ export type Instance = InstanceWithoutData & {
   relationships: Relationship[];
 };
 
-/**
- * An organization.
- * NOTE: this is different to how the schema defines an Organization. **The schema is wrong (see #468)**
- */
-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;
-};
-
 /** validation data returned by preVerify (part of the extract&map API) */
 export type Validation = {
   score: number;
@@ -333,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;
+};

package/src/schema.ts

@@ -1,4 +1,5 @@
-import type { AA, DataTypes, Organization, SchemaName, Urn } from "./raytio";
+import type { AA, DataTypes, SchemaName, Urn } from "./raytio";
+import type { Organization } from "./orgs";
 import type { WizardConfig } from "./wizard";
 
 /** should be renamed since this applies to ConditionallyVerifiable */
@@ -24,7 +25,8 @@ export type SchemaFieldTag =
   | "display:survey"
   | "display:quoting"
   | "display:customModal"
-  | `display:replace:'${string}':'${string}'`
+  | "display:mask"
+  | `display:replace:('${string}', '${string}')`
   | "display:terms_conditions"
   | `display:main_media:${string}` // property name to determine what image to display
   // date picker components
@@ -32,8 +34,13 @@ export type SchemaFieldTag =
   | "date_component:month"
   | "date_component:year"
   // other
+  | "action:allow_copy" // adds clipboard to input field
+  | "action:allow_unreplace" // adds reveal button for passwords
+  | "action:allow_password_compromise_check" // adds check if password is breached
   | "action:client_upload"
+  | "action:hash" // creates hash containing specified information
   | "action:require_webauthn"
+  | `action:generate_pepper:` // generates a pepper length 'n'
   | "verify:show_if_pending"
   | "special:hide_select_behind_button"
   | "type:capture_geolocation" // triggers the wizard's GeoLocationInput field
@@ -43,6 +50,7 @@ export type SchemaTag =
   // action
   | "action:experimental_pass_object_store_id"
   | "action:verify"
+  | `action:display_qr_code:${/* either extract or verify */ string}:${/* when to display QR */ string}`
   // camera
   | "default_camera:rear"
   | "default_camera:front"
@@ -52,6 +60,7 @@ export type SchemaTag =
   // misc
   | `time:${/* type */ string}:${/* seconds */ number}`
   | `link_to:${/* schemaName */ string}:${/* relationshipType */ string}`
+  | "display:default_view:edit" // links profile POcard direct to edit menu
   // type
   | "type:service_provider"
   | "type:service_offer"
@@ -91,6 +100,21 @@ export type SchemaField = {
   format?: "date" | "date-time" | "uri";
   contentMediaType?: string;
   contentEncoding?: "base64";
+  /**
+   * if this field is a foreign key, i.e. it is a primary key
+   * of a different schema, then that other's schema name should be listed here.
+   * e.g.
+   * ```json
+   * {
+   *   "name": "ss_AA",
+   *   "properties": {
+   *     "org_id": { "foreign_key_of": "ss_Org" }
+   *   }
+   * }
+   * ```
+   */
+  foreign_key_of?: SchemaName;
+
   /** `items` is used for nested arrays, (while `properties` is used for nested objects) */
   items?: {
     type: DataTypes;
@@ -131,6 +155,10 @@ export type SchemaField = {
   description_decorator?: "md";
   /** if a `pattern` is specified, this is the error message */
   patternMessage?: string;
+  /** the input string for a platform_unique_id */
+  hash_inputs?: string;
+  /** determines where an image is sourced from */
+  content_source?: string;
 
   override?: {
     permissions: {
@@ -253,6 +281,19 @@ export type CommonSchemaAttributes = {
      * Array because there could be multiple expand groups
      */
     expand?: { fields: string[]; label: string }[];
+
+    /**
+     * By default, the admin dashboard shows columns for all fields
+     * in listed in `head_main`. In rare cases you can use this property
+     * to specify a different set of fields to show to admins by default.
+     */
+    tabular?: { fields: string[] };
+
+    /**
+     * determines if profile pages should display using compacted 'MiniPO'
+     * view or deafult view
+     */
+    compact_table?: boolean;
   };
 
   /** only the schema used for the onboarding wizard have this property */
@@ -327,6 +368,14 @@ export type Schema = CommonSchemaAttributes & {
     [fieldName: string]: SchemaField;
   };
 
+  /**
+   * Some schema's represent data that is not stored as a profile object.
+   * In this case, this attribute defines what database table we need to use
+   * to fetch the corresponding data, and which field is the primary_key of that
+   * table (e.g. `id`, `o_id` etc.)
+   */
+  database?: { table: string; primary_key: string };
+
   /** the client adds this after processing the i18n property */
   groupNames?: Record<string, string>;
 

package/src/subscription.ts

@@ -0,0 +1,106 @@
+import type {
+  CId,
+  CommonFields,
+  PLId,
+  PLLId,
+  PMId,
+  PRCId,
+  PRid,
+  PTId,
+  SId,
+  SLId,
+} from "./raytio";
+
+export type PriceList = {
+  id: PLId;
+  price_list_type: string;
+  price_list_currency: string;
+  price_list_name: string;
+  price_list_name_i18n?: string;
+  price_list_description?: string;
+  price_list_description_i18n?: string;
+  pcm_price_list_versions?: [
+    {
+      id: string;
+      price_list_version_name: string;
+      pcm_price_list_lines: PriceListLine[];
+    },
+  ];
+};
+
+export type PriceListLine = {
+  id: PLLId;
+  pcm_prices: {
+    id: PRCId;
+    amount: number;
+    gpm_items: {
+      id: string; // not sure what this is
+      item_key: string;
+      item_name: string;
+      primary_uom: string;
+      item_name_i18n: string | null;
+      item_description: string;
+      item_description_i18n: string | null;
+    };
+    price_currency: string;
+    billing_recurrence: string;
+    recurring_billing_scheme: string;
+    recurring_billing_interval: string | null; // null if `billing_recurrence` is set to "ONCE"
+    recurring_billing_usage_type: string;
+    recurring_billing_interval_count: number;
+  };
+};
+
+export type Subscription = CommonFields<SId> & {
+  subscribed_to_customer_id: string;
+  subscribed_to_customer_site_id: string | null;
+  subscribed_to_party_contact_point_id: string;
+  billing_cycle_month: number | null;
+  billing_cycle_day_of_month: number | null;
+  billing_cycle_day_of_week: number | null;
+  billing_cycle_hour: number | null;
+  billing_cycle_minute: number | null;
+  billing_cycle_second: number | null;
+  subscription_name: string;
+  subscription_name_i18n: string | null;
+  current_billing_period_start: string;
+  current_billing_period_end: string | null;
+  cancellation_request_date: string | null;
+  cancellation_effective_date: string | null;
+  cancellation_request_reason: string | null;
+  cancellation_final_invoice_action: string;
+};
+
+export type SubscriptionLine = CommonFields<SLId> & {
+  billing_subscription_id: SId;
+  price_id: PRCId;
+  subscribed_qty: number;
+  metadata: string | null;
+};
+
+export type PaymentMethod = CommonFields<PMId> & {
+  customer_id: CId;
+  payer_payment_method_type: string;
+  primary_payment_method: boolean;
+  payment_processor_id: string;
+  payment_method_country_code: string | null;
+  payment_method_scheme: string;
+  payment_method_available_networks: string[] | string;
+  payment_method_preferred_network?: string | null;
+  card_expiry_month: number;
+  card_expiry_year: number;
+  card_funding_method: string;
+  card_last_4_digits: string;
+  card_fingerprint?: string | null;
+  payment_processor_payment_method_id: string;
+  address_line1_check?: string | null;
+  address_postal_code_check?: string | null;
+  cvc_check?: string | null;
+  three_d_secure_usage?: string | null;
+};
+
+export type PaymentProcessor = CommonFields<PTId> & {
+  party_id: PRid;
+  payment_processor_name: string;
+  payment_processor_system: string;
+};

package/src/verification.ts

@@ -1,4 +1,11 @@
-import type { NId, ProfileObject, SchemaName } from "./raytio";
+import type {
+  CommonFields,
+  GPMId,
+  Json,
+  NId,
+  ProfileObject,
+  SchemaName,
+} from "./raytio";
 
 // see #659
 export enum SafeHarbourCode {
@@ -16,7 +23,11 @@ export type VerificationPayload<WithValue extends boolean> = {
   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
@@ -42,6 +53,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;
@@ -115,6 +127,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;
 };
@@ -141,3 +154,39 @@ 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;
+};