@secondcloset/types 2.8.0 → 2.9.0-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@secondcloset/types",
-  "version": "2.8.0",
+  "version": "2.9.0-beta.1",
   "description": "secondcloset type declaration and definitions",
   "main": "src/index.ts",
   "scripts": {

package/src/fulfillment/order/order.ts

@@ -6,6 +6,7 @@ import {
   BaseUser,
   Organization,
   File,
+  Version,
 } from "../../_common";
 import { OrderItem } from "./orderItem";
 
@@ -44,41 +45,43 @@ export interface FulfillmentOrderAddress extends BaseAddress {
   updated_at: string;
 }
 
-export interface Order {
-  id: string;
-  order_id: string;
-  external_order_number: string;
-  external_order_id: string | null;
-  notes: string;
-  internal_notes?: string;
-  platform: OrderPlatform;
-  external_platform_version: number | null;
-  parcel_type: string;
-  cancelled: boolean;
-  fulfilled_from: FacilityCode;
-  client_type: string | null;
-  insurance_value: number;
-  shipping_service: string | null;
-  signature_required?: boolean;
-  customer: Customer;
-  address: FulfillmentOrderAddress;
-  created_at: string;
-  updated_at: string;
-  organization: Organization;
-  overdue: boolean;
-  user: BaseUser;
-  status?: string;
-  shipment_tags: ShipmentTag[];
-  shipments: Shipment[];
-  items: OrderItem[];
-  files: File[];
-  stock_status:
-    | "in_stock"
-    | "partially_in_stock"
-    | "out_of_stock"
-    | "unknown_stock";
-  on_hold: boolean;
-  on_hold_at: string;
-  requested_service_code?: ScServiceCode;
-  has_errors: boolean;
-}
+export type Order<V extends Version = "V1"> = V extends "V1"
+  ? {
+      id: string;
+      order_id: string;
+      external_order_number: string;
+      external_order_id: string | null;
+      notes: string;
+      internal_notes?: string;
+      platform: OrderPlatform;
+      external_platform_version: number | null;
+      parcel_type: string;
+      cancelled: boolean;
+      fulfilled_from: FacilityCode;
+      client_type: string | null;
+      insurance_value: number;
+      shipping_service: string | null;
+      signature_required?: boolean;
+      customer: Customer;
+      address: FulfillmentOrderAddress;
+      created_at: string;
+      updated_at: string;
+      organization: Organization;
+      overdue: boolean;
+      user: BaseUser;
+      status?: string;
+      shipment_tags: ShipmentTag[];
+      shipments: Shipment<V>[];
+      items: OrderItem<V>[];
+      files: File[];
+      stock_status:
+        | "in_stock"
+        | "partially_in_stock"
+        | "out_of_stock"
+        | "unknown_stock";
+      on_hold: boolean;
+      on_hold_at: string;
+      requested_service_code?: ScServiceCode;
+      has_errors: boolean;
+    }
+  : Omit<Order<"V1">, "items" | "shipments">;

package/src/fulfillment/order/orderItem.ts

@@ -1,16 +1,34 @@
-import { Product } from "../product";
+import { Version } from "../../_common";
+import { BaseProduct, Product } from "../product";
 import { ShipmentActionType } from "../shipment";
 
-export interface OrderItem {
-  id: string;
-  product: Product;
-  quantity: number;
-  attributes: string[];
-  return_reasons: string[];
-  available_actions: ShipmentActionType[];
-  actions_history: ShipmentActionType[];
-  virtual_kit_id: null | string;
-  available_quantity: number;
-  removed: boolean;
-  removed_reason: string;
-}
+export type OrderItem<V extends Version = "V1"> = V extends "V1"
+  ? {
+      id: string;
+      product: Product;
+      quantity: number;
+      attributes: string[];
+      return_reasons: string[];
+      available_actions: ShipmentActionType[];
+      actions_history: ShipmentActionType[];
+      virtual_kit_id: null | string;
+      available_quantity: number;
+      removed: boolean;
+      removed_reason: string;
+    }
+  : {
+      product: BaseProduct & {
+        available_quantity: OrderItem<"V1">["available_quantity"];
+        base_products?: OrderItem<"V2">["product"][];
+        required_parts?: Record<string, number>;
+      };
+      available_actions: {
+        inventory_pick_up_item_ids: OrderItem<"V1">["id"][];
+        inventory_warehouse_receiving_item_ids: OrderItem<"V1">["id"][];
+        delivery_item_ids: OrderItem<"V1">["id"][];
+      };
+      removed_items: {
+        removed_reason: string;
+        quantity: number;
+      }[];
+    };

package/src/fulfillment/product/product.ts

@@ -3,14 +3,18 @@ import { BaseImage } from "../../_common";
 
 export interface BaseProduct {
   id: string;
-  organization_id: string;
   scid: string;
+  name: string;
   sku: string;
   upc: string;
-  name: string;
+  type: "base" | "kit";
+  active: boolean;
+}
+
+export interface Product extends Omit<BaseProduct, "type"> {
+  organization_id: string;
   description: string;
   platform: string;
-  active: boolean;
   fragile: boolean;
   dangerous: boolean;
   liquid: boolean;
@@ -32,7 +36,7 @@ export interface BaseProduct {
   customs_description: string | null;
   images: BaseImage[];
   packaging_criteria: string;
-  product_type: "base" | "kit";
+  product_type: BaseProduct["type"];
   stocks?: Stock[];
   deleted_at: string;
   created_at: string;
@@ -56,21 +60,14 @@ export interface BaseProduct {
   insurance_value: number | null;
   has_errors: boolean;
   under_conversion: boolean;
-}
-
-export interface Product extends BaseProduct {
-  base_products?: BaseProduct[];
+  base_products?: Product[];
 }
 
 export interface PackagingLevel {
   id?: string;
   product_id?: string;
-  product: {
-    id: string;
-    sku: string;
+  product: BaseProduct & {
     upc: string;
-    scid: string;
-    name: string;
     tracks_lot_numbers: boolean;
   };
   level: "single_item" | "inner_pack" | "master_pack" | "pallet";

package/src/fulfillment/shipment/shipment.ts

@@ -1,5 +1,11 @@
 import { ShipmentItem } from "./shipmentItem";
-import { BaseUser, BaseNote, BaseOrganization, Facility } from "../../_common";
+import {
+  BaseUser,
+  BaseNote,
+  BaseOrganization,
+  Facility,
+  Version,
+} from "../../_common";
 import { Package } from "./package";
 import {
   SecondClosetShippingMethod,
@@ -35,39 +41,41 @@ export type ScServiceCode =
   | "second_closet_to_the_door_1_person"
   | ServiceCode;
 
-export interface Shipment {
-  id: string;
-  organization_id: string;
-  organization?: BaseOrganization;
-  billed: boolean;
-  user: BaseUser;
-  notes: BaseNote[] | string;
-  shipment_items: ShipmentItem[];
-  shipment_number: string;
-  packages: Package[];
-  external_order_id: string | null;
-  external_order_type: string;
-  external_shipment_id: string | null;
-  carrier: Carrier | null;
-  created_at: string;
-  updated_at: string;
-  action_summary: ShipmentActionType[];
-  freight: boolean;
-  shipping_method:
-    | SecondClosetShippingMethod
-    | ExternalCarrierShippingMethod
-    | CustomerPickupShippingMethod;
-  shipping_method_type:
-    | "external_carrier_shipment"
-    | "appointment"
-    | "untracked_shipment"
-    | "customer_pickup_shipment";
-  external_order?: {
-    id: string;
-    external_order_number: string;
-    external_order_id: string | null;
-    created_at: string;
-    updated_at: string;
-  };
-  facility?: Partial<Facility>;
-}
+export type Shipment<V extends Version = "V1"> = V extends "V1"
+  ? {
+      id: string;
+      organization_id: string;
+      organization?: BaseOrganization;
+      billed: boolean;
+      user: BaseUser;
+      notes: BaseNote[] | string;
+      shipment_items: ShipmentItem<V>[];
+      shipment_number: string;
+      packages: Package[];
+      external_order_id: string | null;
+      external_order_type: string;
+      external_shipment_id: string | null;
+      carrier: Carrier | null;
+      created_at: string;
+      updated_at: string;
+      action_summary: ShipmentActionType[];
+      freight: boolean;
+      shipping_method:
+        | SecondClosetShippingMethod
+        | ExternalCarrierShippingMethod
+        | CustomerPickupShippingMethod;
+      shipping_method_type:
+        | "external_carrier_shipment"
+        | "appointment"
+        | "untracked_shipment"
+        | "customer_pickup_shipment";
+      external_order?: {
+        id: string;
+        external_order_number: string;
+        external_order_id: string | null;
+        created_at: string;
+        updated_at: string;
+      };
+      facility?: Partial<Facility>;
+    }
+  : Omit<Shipment<"V1">, "shipment_items">;

package/src/fulfillment/shipment/shipmentItem.ts

@@ -1,42 +1,55 @@
+import { Version } from "../../_common";
+import { BaseProduct } from "../product";
 import { ShipmentActionType } from "./shipment";
-export interface ShipmentItem {
-  id: string;
-  order_item_id: string;
-  description: string;
-  item_identifier: string;
-  item_identifier_type: string;
-  item_identifier_value: string;
-  product_id?: string;
-  weight_value: string;
-  weight_unit: string;
-  length_value: string;
-  length_unit: string;
-  height_value: string;
-  height_unit: string;
-  width_value: string;
-  width_unit: string;
-  shipment_actions: ShipmentActionType[];
-  shipment_actions_completion: Partial<
-    {
-      [key in ShipmentActionType]: boolean;
+export type ShipmentItem<V extends Version = "V1"> = V extends "V1"
+  ? {
+      id: string;
+      order_item_id: string;
+      description: string;
+      item_identifier: string;
+      item_identifier_type: string;
+      item_identifier_value: string;
+      product_id?: string;
+      weight_value: string;
+      weight_unit: string;
+      length_value: string;
+      length_unit: string;
+      height_value: string;
+      height_unit: string;
+      width_value: string;
+      width_unit: string;
+      shipment_actions: ShipmentActionType[];
+      shipment_actions_completion: Partial<
+        {
+          [key in ShipmentActionType]: boolean;
+        }
+      >;
+      shipment_actions_status?: {
+        [key in ShipmentActionType]: {
+          completed: boolean;
+          failed: boolean;
+          failed_reason: string | null;
+        };
+      };
+      shipment_item_group: {
+        id: string;
+        name: string;
+        description: string;
+        external_group_id: string;
+        group_identifier_type: string;
+        group_identifier_value: string;
+        created_at: string;
+        updated_at: string;
+        group_identifier: string;
+      } | null;
     }
-  >;
-  shipment_actions_status?: {
-    [key in ShipmentActionType]: {
-      completed: boolean;
-      failed: boolean;
-      failed_reason: string | null;
+  : {
+      product: BaseProduct;
+      shipment_item_ids: ShipmentItem<"V1">["id"][];
+      shipment_actions_status: {
+        [key in ShipmentActionType]: {
+          completed_shipment_item_ids: string[];
+          failed_shipment_items: string[];
+        };
+      };
     };
-  };
-  shipment_item_group: {
-    id: string;
-    name: string;
-    description: string;
-    external_group_id: string;
-    group_identifier_type: string;
-    group_identifier_value: string;
-    created_at: string;
-    updated_at: string;
-    group_identifier: string;
-  } | null;
-}

package/src/warehouse/carrierTransferPackage.ts

@@ -43,7 +43,7 @@ interface ShippingLabel extends Partial<ExternalCarrierShippingLabel> {
   created_at: string;
   updated_at: string;
 }
-interface PackageShipment extends Partial<Shipment> {
+interface PackageShipment extends Partial<Shipment<"V1">> {
   user_id: string;
   shipping_method_id?: string;
   customer_scheduling_token?: string;
@@ -62,4 +62,4 @@ export interface PackageDetailsInfo extends PackageInfo {
   organization: Organization;
   carrier?: PackageCarrier;
   shipping_label?: ShippingLabel;
-}
+}