@use-stall/types 0.0.1 → 0.0.3

package/README.md

@@ -2,3 +2,9 @@
 
 ## Description
 Type declarations for Stall SDKs.
+
+## Installation
+Install the types using npm:
+```bash
+bun install @stall/types
+```

package/index.d.ts

@@ -20,3 +20,5 @@ export * from "./src/stall-icons";
 export * from "./src/system";
 export * from "./src/taxes";
 export * from "./src/users";
+export * from "./src/fulfillment";
+export * from "./src/extensions";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@use-stall/types",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "Type declarations for Stall SDKs",
   "types": "index.d.ts",
   "type": "module",

package/src/cloud-connectors.d.ts

@@ -5,41 +5,64 @@
 type ModuleKey =
   | "products"
   | "variants"
-  | "orders"
-  | "draft-orders"
-  | "tags"
   | "collections"
   | "categories"
-  | "locations"
-  | "discounts"
+  | "tags"
+  | "inventory_levels" // For products with stock tracking
+  | "inventory_history" // History of inventory levels at a specific point in time
+  | "coupons"
+  | "gift_cards"
+  | "orders"
+  | "order_notes" // Activities related to order
+  | "refunds" // Activities related to refunds
+  | "payment_providers"
+  | "payments" // Create, Read, Update, Delete, Webhooks
+  | "receipts" // These are not tax invoices but rather and indication of a successful payment
+  | "tax_regions" // can be tax class or groups in other data sources
+  | "tax_rates"
   | "customers"
-  | "fulfillments"
-  | "payments";
+  | "locations" // Can be stock locations, warehouses, or any other location-related data
+  | "sessions_tracking" // This will be used for cash tracking and tracking the POS/Flex user
+  | "fulfillment_types" // Like delivery, pickup, etc.
+  | "fulfillment_providers" // Providers third party or custom like DHL, FedEx, UPS, etc.
+  | "fulfillments"; // Individual fulfillment instances for an order
+
+export interface ConnectorModulesType {
+  [key in ModuleKey]: {
+    supported: boolean;
+    actions: {
+      create: boolean;
+      read: boolean;
+      update: boolean;
+      delete: boolean;
+    };
+  };
+}
 
-export interface CloudConnectorType {
+export interface ConnectorType {
   id: string;
+  version: string;
   name: string;
+  description: string;
   logo: string;
-  type: "native" | "custom";
-  api: {
-    base_url: string;
-    apiVersion: string;
-    auth_type: "basic" | "bearer" | "none";
-    auth_config_keys: string[];
-  };
-  modules: {
-    [key in ModuleKey]: {
-      supported: boolean;
-      actions: {
-        create: boolean;
-        read: boolean;
-        update: boolean;
-        delete: boolean;
-      };
-    };
+  modules: ConnectorModulesType;
+  authentication: {
+    type: "basic" | "bearer" | "api_key" | "none";
+    ttl_type: "permanent" | "session";
+    ttl_value: number; // TTL value in minutes
   };
+  integration_url: string; // Where to redirect the users to connect their account
+  integration_docs: string; // Where to redirect the users to learn how to connect their account
   active: boolean;
-  internal_version: string;
-  connect_url: string;
-  setup_instructions_url: string;
 }
+
+export interface ConnectorConfigurationType {
+  connector_id: string;
+  configuration: {
+    username: string; // For basic authentication
+    password: string; // For basic authentication
+    token: string; // For bearer authentication
+    api_key_header: string; // For API key authentication or Custom header
+    api_key_value: string; // For API key authentication or Custom header
+  };
+}

package/src/{device.ts → device.d.ts}

@@ -1,43 +1,51 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
+import type { InstalledExtensionType } from "./extensions";
 
 export interface DeviceType {
   id: string;
-  organization_id: string;
+  organization: string;
+  location: string;
   name: string;
-  device: UserAgent;
+  description: string;
+  code: string;
+  paired: boolean;
   token: string;
-  type:
-    | "retail-pos"
-    | "retail-kiosk"
-    | "restaurant-pos"
-    | "restaurant-kiosk"
-    | "hotel";
-  last_synced_date: string;
-  status?: "online" | "offline";
+  device_profile: string;
+  created_at: string;
+  created_by: string;
+  last_seen: string;
   connected_at: string;
   connected_by: string;
+  device_details: DeviceDetails;
 }
 
-export interface UserAgent {
-  browser: {
-    name: string;
-    version: string;
-  };
-  os: {
-    name: string;
-    version: string;
-    versionName: string;
-  };
-  platform: {
-    type: string;
-    vendor: string;
+export interface DeviceDetails {
+  device_id: string;
+  ip: string;
+  mac_address: string;
+  brand: string;
+  model: string;
+  os: string;
+  os_version: string;
+  ram: number;
+  network_type: string;
+  screen_size: string;
+  origin: "web" | "app";
+}
+
+export interface DeviceProfile {
+  id: string;
+  name: string;
+  description: string;
+  extensions: {
+    extensions: InstalledExtensionType[];
+    groups: string[]; // When configure they will take precedence over the individual extensions where duplicates exist
+    auto_update: boolean;
   };
-  engine: {
-    name: string;
+  restrictions: {
+    roles: string[]; // If empty, no roles restrictions will be applied
+    users: string[]; // If empty, no users restrictions will be applied
   };
-  memory: string | number;
-  connectionType: string | number;
-  screenSize: string | number;
 }
 
 export enum DeviceKeyboardType {

package/src/extensions.d.ts

@@ -0,0 +1,17 @@
+export interface ExtensionType {
+  id: string;
+  version: string;
+  created_at: string;
+  updated_at: string;
+  name: string;
+  description: string;
+  icon: string;
+  keywords: string[];
+  authors: string[];
+}
+
+
+export interface InstalledExtensionType {
+  id: string;
+  version: string;
+}

package/src/fulfillment.d.ts

@@ -1,30 +1,63 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-export interface FulfillmentProviderType {
-  id: string; // Unique ID for the provider
-  method: "pick-up" | "delivery" | "shipment"; // The fulfillment method type
-  name: string; // Name of the fulfillment method
-  description: string; // Description of the service
-  minOrderAmount?: number; // Minimum order value for eligibility (optional)
-  maxOrderAmount?: number; // Maximum order value for eligibility (optional)
-  restrictions?: Restriction[]; // Dynamic restrictions based on regions, products, etc.
-  fees?: FeeStructure[]; // Flexible fee structure based on conditions
-  estimatedFulfillmentTime?: number; // Estimated time for fulfillment in hours
-  metadata?:{[key:string]:any} // Additional metadata for the provider
-}
+import type { UnifiedCustomerAddressType } from "./customers";
 
-export interface Restriction {
-  type: "region" | "country" | "state" | "zip_code" | "product" | "order_value";
-  value: string | number; // Value that corresponds to the restriction, such as "US" for country or a minimum order value
-  operator?: "equals" | "not_equals" | "greater_than" | "less_than"; // Operator for order value or numeric restrictions
+export interface FulfillmentProvider {
+  id: string;
+  name: string;
+  description: string;
+  logo: string;
 }
 
-export interface FeeStructure {
-  condition?: FeeCondition; // The condition under which the fee applies (optional)
-  amount: number; // Fee amount to be applied
+export interface FulfillmentType {
+  id: string;
+  name: string;
+  description: string;
+  configurations: {
+    customer: boolean;
+    address: boolean;
+  };
 }
 
-export interface FeeCondition {
-  orderValue?: { min?: number; max?: number }; // Apply the fee if the order falls within this range
-  weight?: { min?: number; max?: number }; // Apply the fee based on order weight (optional)
-  regions?: string[]; // Specific regions or countries where this fee applies
+export type FulFillmentStatus =
+  | "pending"
+  | "packing"
+  | "dispatched"
+  | "en-route"
+  | "delivered"
+  | "cancelled"
+  | "returned";
+
+export interface FulFillmentLineItem {
+  id: string;
+  sku: string;
+  name: string;
+  dimensions: {
+    length: string; // e.g. "10cm"
+    width: string; // e.g. "5cm"
+    height: string; // e.g. "3m"
+    weight: string; // e.g. "1kg"
+  };
+  quantity: number;
+  amount: number;
 }
+
+export interface OrderFulfillment {
+  id: string;
+  order_id: string;
+  tracking_number: string;
+  type_id: string;
+  provider_id: string;
+  status: FulFillmentStatus;
+  created_at: string;
+  updated_at: string;
+  delivered_at: string;
+  line_items: FulFillmentLineItem[];
+  fees: {
+    subtotal: number;
+    total: number;
+    currency: string;
+  };
+  address: {
+    destination: UnifiedCustomerAddressType;
+    departure: UnifiedCustomerAddressType;
+  };
+}

package/src/orders.d.ts

@@ -1,3 +1,5 @@
+import type { UnifiedCustomerAddressType } from "./customers";
+
 /* eslint-disable @typescript-eslint/no-explicit-any */
 export interface UnifiedOrderType {
   id: string;
@@ -22,8 +24,8 @@ export interface UnifiedOrderType {
   checkout_token: string;
   customer_id: string;
   customer_note: string;
-  billing: UnifiedAddressType;
-  shipping_address: UnifiedAddressType;
+  billing: UnifiedCustomerAddressType;
+  shipping_address: UnifiedCustomerAddressType;
   line_items: UnifiedLineItemType[]; // Array of purchased items (products/variants)
   currency: string; // Currency of the order
   payment: UnifiedOrderPaymentDetailsType;
@@ -69,20 +71,6 @@ export interface UnifiedLineItemType {
   metadata: Record<string, any>; // Optional custom fields
 }
 
-export interface UnifiedAddressType {
-  first_name: string;
-  last_name: string;
-  company: string;
-  address_1: string;
-  address_2: string;
-  city: string;
-  state: string;
-  postcode: string;
-  country: string;
-  email: string;
-  phone: string;
-}
-
 export interface UnifiedTaxLineType {
   id: string;
   name: string;