@raytio/types 7.2.0 → 8.0.0

package/src/schema.ts

@@ -1,5 +1,6 @@
-import { AA, DataTypes, Organization, Urn } from "./raytio";
-import { WizardConfig } from "./wizard";
+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 */
 export type ConditionallyRequired = {
@@ -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;
@@ -104,7 +128,7 @@ export type SchemaField = {
   };
 
   /** If this field refers to a sub-object */
-  $ref?: string;
+  $ref?: SchemaName;
 
   /**
    * @internal
@@ -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: {
@@ -221,9 +249,9 @@ export type CommonSchemaAttributes = {
     /** 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[];
+    oneOf?: (SchemaName | "instance")[];
     /** Specify `oneOf` XOR `anyOf` It's a list of schema names. */
-    anyOf?: string[];
+    anyOf?: SchemaName[];
 
     /** assume TRUE if not specified */
     multiple?: boolean;
@@ -253,13 +281,26 @@ 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 */
   onboard_properties?: {
     /** Profile Objects that should be created */
     profile_objects?: {
-      schema_name: string;
+      schema_name: SchemaName;
       properties: Record<string, unknown>;
     }[];
 
@@ -300,7 +341,7 @@ export type CommonSchemaAttributes = {
  */
 export type Schema = CommonSchemaAttributes & {
   /** added by the client, copied from {@link WrappedSchema} */
-  name: string; // Will always exist on schema
+  name: SchemaName;
 
   /** added by client */
   type?: DataTypes;
@@ -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>;
 
@@ -361,7 +410,7 @@ export type WrappedSchema = {
   end_date: string;
 
   /** Schema Name Type and Version Properties */
-  schema_name: string;
+  schema_name: SchemaName;
   schema_type: SchemaType;
   schema_version: 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 { NId, ProfileObject } from "./raytio";
+import type {
+  CommonFields,
+  GPMId,
+  Json,
+  NId,
+  ProfileObject,
+  SchemaName,
+} from "./raytio";
 
 // see #659
 export enum SafeHarbourCode {
@@ -13,10 +20,14 @@ export enum SafeHarbourCode {
 export type VerificationPayload<WithValue extends boolean> = {
   // we deliberately haven't defined 'sub'
   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
@@ -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;
+};

package/src/wizard.ts

@@ -1,4 +1,4 @@
-import { AId } from "./raytio";
+import type { AId, SchemaName } from "./raytio";
 
 export type WizardPageTag =
   // actions
@@ -9,7 +9,7 @@ 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;
@@ -110,9 +110,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;
 
   // the following ones are generally not pre-configured, instead they
   // just come from the URL query params.