@use-stall/types 0.0.1

package/README.md

@@ -0,0 +1,4 @@
+# Types for Stall SDKs
+
+## Description
+Type declarations for Stall SDKs.

package/index.d.ts

@@ -0,0 +1,22 @@
+export * from "./src/billing-payments";
+export * from "./src/cloud-connectors";
+export * from "./src/components";
+export * from "./src/customers";
+export * from "./src/device";
+export * from "./src/fulfillment";
+export * from "./src/global";
+export * from "./src/inventory";
+export * from "./src/locations";
+export * from "./src/lookup";
+export * from "./src/media";
+export * from "./src/onboarding";
+export * from "./src/orders";
+export * from "./src/organizations";
+export * from "./src/payments";
+export * from "./src/pos";
+export * from "./src/product";
+export * from "./src/register-sessions";
+export * from "./src/stall-icons";
+export * from "./src/system";
+export * from "./src/taxes";
+export * from "./src/users";

package/index.js

@@ -0,0 +1 @@
+module.exports = {};

package/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "@use-stall/types",
+  "version": "0.0.1",
+  "description": "Type declarations for Stall SDKs",
+  "types": "index.d.ts",
+  "type": "module",
+  "main": "index.js",
+  "module": "index.js",
+  "unpkg": "index.js",
+  "private": false
+}

package/src/billing-payments.d.ts

@@ -0,0 +1,270 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+export interface PriceType {
+  name: string;
+  price: string;
+  description: string;
+  price_id: string;
+}
+
+export interface PaymentMethodType {
+  id: string; // Unique identifier for the payment method
+  external_id?: string; // External identifier for the payment method
+  type: "native" | "custom" | "integration" | "manual"; // The type of payment method
+  is_external: boolean; // Optional flag for external payment methods
+  external_url: string; // Optional URL for external payment methods
+  icon: string; // Icon URL for the payment method
+  name: string; // The name of the payment method (e.g., "Visa", "Apple Pay", "Bank Transfer")
+  description: string; // Description of the payment method
+  logo?: string; // Icon URL for the payment method
+  requires_customer: boolean; // Flag to indicate if the payment method requires customer details
+  has_tendered_amount: boolean; // Flag to indicate if the payment method requires a tendered amount
+  active: boolean; // Flag to indicate if the payment method is active
+  track_register: boolean; // Flag to indicate if the payment method should be tracked in the register
+  mark_as_paid: boolean; // Flag to indicate if the payment method should be marked as paid
+  metadata?: { [key: string]: string }; // Additional metadata for the payment method
+  locations_enabled?: boolean; // Flag to indicate if the payment method is restricted to specific locations
+  locations?: string[]; // List of location IDs for the payment method
+}
+
+interface Recurring {
+  usage_type: string;
+  interval_count: number;
+  trial_period_days: number | null;
+  aggregate_usage: string | null;
+  meter: string | null;
+  interval: string;
+}
+
+interface Features {
+  [key: string]: string;
+}
+
+export interface BillingPriceType {
+  id: string;
+  billing_scheme: string;
+  type: string;
+  trial_period_days: number | null;
+  tax_behavior: string;
+  metadata: Record<string, any>;
+  transform_quantity: any | null;
+  tiers_mode: any | null;
+  recurring: Recurring;
+  product: string;
+  description: string | null;
+  tiers: any | null;
+  interval_count: number;
+  active: boolean;
+  currency: string;
+  interval: string;
+  unit_amount: number;
+  price_amount: number;
+  title: string;
+  price_description: string;
+  features: Features;
+  saving?: number;
+}
+
+// ============== Subscription Types ==============
+
+export interface OrganizationSubscriptionType {
+  canceled_at: number | null;
+  created: Timestamp;
+  prices: FirestorePrice[];
+  price: FirestorePrice;
+  cancel_at_period_end: boolean;
+  product: FirestoreProduct;
+  stripeLink: string;
+  status:
+    | "active"
+    | "past_due"
+    | "canceled"
+    | "incomplete"
+    | "incomplete_expired"
+    | "trialing"
+    | "unpaid";
+  current_period_end: Timestamp;
+  metadata: {
+    price: string;
+    org_id: string;
+    date: string;
+    owner: string;
+  };
+  items: SubscriptionItem[];
+  trial_start: Timestamp;
+  ended_at: number | null;
+  trial_end: Timestamp;
+  role: string | null;
+  current_period_start: Timestamp;
+  quantity: number;
+  cancel_at: number | null;
+  id: string;
+}
+
+interface Timestamp {
+  seconds: number;
+  nanoseconds: number;
+}
+
+interface FirestorePrice {
+  converter: null | string;
+  _key: FirestoreKey;
+  type: string;
+  firestore: FirestoreDetails;
+}
+
+interface FirestoreProduct {
+  converter: null | string;
+  _key: FirestoreKey;
+  type: string;
+  firestore: FirestoreDetails;
+}
+
+interface FirestoreKey {
+  path: {
+    segments: string[];
+    offset: number;
+    len: number;
+  };
+}
+
+interface FirestoreDetails {
+  app: {
+    _isDeleted: boolean;
+    _options: {
+      apiKey: string;
+      authDomain: string;
+      projectId: string;
+      storageBucket: string;
+      messagingSenderId: string;
+      appId: string;
+      measurementId: string;
+    };
+    _config: {
+      name: string;
+      automaticDataCollectionEnabled: boolean;
+    };
+    _name: string;
+    _automaticDataCollectionEnabled: boolean;
+    _container: {
+      name: string;
+      providers: Record<string, unknown>;
+    };
+  };
+  databaseId: {
+    projectId: string;
+    database: string;
+  };
+  settings: {
+    host: string;
+    ssl: boolean;
+    ignoreUndefinedProperties: boolean;
+    localCache: {
+      kind: string;
+    };
+    cacheSizeBytes: number;
+    experimentalForceLongPolling: boolean;
+    experimentalAutoDetectLongPolling: boolean;
+    experimentalLongPollingOptions: Record<string, unknown>;
+    useFetchStreams: boolean;
+  };
+}
+
+interface SubscriptionItem {
+  price: PriceDetails;
+  metadata: Record<string, unknown>;
+  created: number;
+  id: string;
+  quantity: number;
+  plan: PlanDetails;
+  billing_thresholds: null | object;
+  subscription: string;
+  discounts: unknown[];
+  object: string;
+  tax_rates: unknown[];
+}
+
+interface PriceDetails {
+  tax_behavior: string;
+  unit_amount: number;
+  nickname: string | null;
+  recurring: RecurringDetails;
+  active: boolean;
+  type: string;
+  created: number;
+  unit_amount_decimal: string;
+  currency: string;
+  lookup_key: string;
+  tiers_mode: string | null;
+  billing_scheme: string;
+  metadata: Record<string, unknown>;
+  object: string;
+  product: ProductDetails;
+  livemode: boolean;
+  custom_unit_amount: null | object;
+  id: string;
+  transform_quantity: null | object;
+}
+
+interface RecurringDetails {
+  meter: string | null;
+  interval_count: number;
+  usage_type: string;
+  trial_period_days: number | null;
+  aggregate_usage: string | null;
+  interval: string;
+}
+
+interface PlanDetails {
+  amount: number;
+  aggregate_usage: string | null;
+  tiers_mode: string | null;
+  created: number;
+  object: string;
+  livemode: boolean;
+  id: string;
+  product: string;
+  interval_count: number;
+  usage_type: string;
+  transform_usage: string | null;
+  billing_scheme: string;
+  active: boolean;
+  metadata: Record<string, unknown>;
+  meter: string | null;
+  nickname: string | null;
+  currency: string;
+  interval: string;
+  trial_period_days: number | null;
+  amount_decimal: string;
+}
+
+interface ProductDetails {
+  created: number;
+  metadata: {
+    devices: string;
+    users: string;
+    staffAccounts: string;
+  };
+  type: string;
+  package_dimensions: string | null;
+  livemode: boolean;
+  url: string | null;
+  name: string;
+  unit_label: string | null;
+  updated: number;
+  object: string;
+  marketing_features: FeatureDetails[];
+  features: FeatureDetails[];
+  images: unknown[];
+  attributes: unknown[];
+  shippable: boolean | null;
+  id: string;
+  active: boolean;
+  default_price: string;
+  statement_descriptor: string | null;
+  tax_code: string;
+  description: string;
+}
+
+interface FeatureDetails {
+  name: string;
+}

package/src/cloud-connectors.d.ts

@@ -0,0 +1,45 @@
+// These are the types for the cloud connectors that will power the users app per location.
+// Each Location will have logs
+//When creating a custom connector user must provider for all actions
+
+type ModuleKey =
+  | "products"
+  | "variants"
+  | "orders"
+  | "draft-orders"
+  | "tags"
+  | "collections"
+  | "categories"
+  | "locations"
+  | "discounts"
+  | "customers"
+  | "fulfillments"
+  | "payments";
+
+export interface CloudConnectorType {
+  id: string;
+  name: 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;
+      };
+    };
+  };
+  active: boolean;
+  internal_version: string;
+  connect_url: string;
+  setup_instructions_url: string;
+}

package/src/components.d.ts

@@ -0,0 +1,7 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+export export type ComponentRegistryItemType = {
+  id: string;
+  name: string;
+  component: React.ComponentType<any>;
+  props?: Record<string, any>;
+};

package/src/customers.d.ts

@@ -0,0 +1,38 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+export interface UnifiedCustomerType {
+  id: string;
+  email: string;
+  default_billing_address_id: string;
+  default_shipping_address_id: string;
+  company_name: string;
+  first_name: string;
+  last_name: string;
+  addresses: UnifiedCustomerAddressType[];
+  phone: string;
+  metadata: Record<string, any>;
+  created_at: string;
+  updated_at: string;
+  deleted_at: string;
+  stall_offline_id: string;
+  stall_offline_created_at: string;
+  stall_offline_updated_at: string;
+  stall_offline_deleted_at: string;
+}
+
+export interface UnifiedCustomerAddressType {
+  id: string;
+  address_name: string;
+  is_default_shipping: boolean;
+  is_default_billing: boolean;
+  company: string;
+  first_name: string;
+  last_name: string;
+  address_1: string;
+  address_2: string;
+  city: string;
+  country_code: string;
+  province: string;
+  postal_code: string;
+  metadata: Record<string, any>;
+}

package/src/device.ts

@@ -0,0 +1,80 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+export interface DeviceType {
+  id: string;
+  organization_id: string;
+  name: string;
+  device: UserAgent;
+  token: string;
+  type:
+    | "retail-pos"
+    | "retail-kiosk"
+    | "restaurant-pos"
+    | "restaurant-kiosk"
+    | "hotel";
+  last_synced_date: string;
+  status?: "online" | "offline";
+  connected_at: string;
+  connected_by: string;
+}
+
+export interface UserAgent {
+  browser: {
+    name: string;
+    version: string;
+  };
+  os: {
+    name: string;
+    version: string;
+    versionName: string;
+  };
+  platform: {
+    type: string;
+    vendor: string;
+  };
+  engine: {
+    name: string;
+  };
+  memory: string | number;
+  connectionType: string | number;
+  screenSize: string | number;
+}
+
+export enum DeviceKeyboardType {
+  STALL_ONSCREEN = "stall_onscreen",
+  DEVICE = "device",
+}
+
+export interface DeviceConfigType {
+  keyboard: {
+    type: DeviceKeyboardType;
+  };
+  payment_methods: string[]; // Ids of avaiable payment methods on this device
+  hardware: {
+    printer?: NonNullable<unknown>;
+    scanner?: NonNullable<unknown>;
+    drawer?: NonNullable<unknown>;
+  };
+  language: "en";
+}
+
+export interface VKeyboardStateType {
+  input_id: string;
+  placeholder: string;
+  type: "text" | "textarea" | "number" | "email" | "password";
+  layout: string;
+  value: any;
+  transparent_background?: boolean;
+  hide_input?: boolean;
+}
+
+export interface LocaleDeviceInfoType {
+  brand: string;
+  device_name: string;
+  device_id: string;
+  ip: string;
+  ram: number;
+  os: string;
+  os_version: string;
+  mac_address: string;
+}

package/src/fulfillment.d.ts

@@ -0,0 +1,30 @@
+/* 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
+}
+
+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 FeeStructure {
+  condition?: FeeCondition; // The condition under which the fee applies (optional)
+  amount: number; // Fee amount to be applied
+}
+
+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
+}

package/src/global.d.ts

@@ -0,0 +1,14 @@
+export {};
+
+declare global {
+  interface Window {
+    api: {
+      getDeviceInfo: () => Promise<{
+        device_id: string;
+        device_name: string;
+        device_type: string;
+      }>;
+    };
+    router: import("@remix-run/router").Router;
+  }
+}

package/src/inventory.d.ts

@@ -0,0 +1,58 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+export interface UnifiedInventoryLevelType {
+    id: string;
+    location_id: string;
+    product_id: string;
+    variant_id: string;
+    unavailable: number | string; // Items not available for sale (e.g., damaged, expired)
+    committed: number | string; // Items reserved for existing orders but not yet shipped
+    in_stock: number | string; // Items available for new orders (In Stock)
+    on_hand: number | string; // Total items physically present at the location
+    low_stock_threshold: number | string; // Low stock threshold specific to the location
+    last_updatedAt: string;
+    created_at: string;
+    metadata: Record<string, any>;
+  }
+  export interface ExtendedUnifiedInventoryLevelType
+    extends UnifiedInventoryLevelType {
+    title: string;
+    thumbnail: string;
+    options: string[];
+    is_new: boolean;
+  }
+  
+  export interface InventoryAdjustmentRequestType {
+    id: string;
+    batch?: string;
+    items: ExtendedUnifiedInventoryLevelType[];
+    reason: string;
+    location_id: string;
+    organization_id: string;
+    device_id: string;
+    staff_id: string;
+    user_id: string;
+    stall_offline_id: string;
+    stall_offline_created_at: string;
+    stall_offline_updated_at: string;
+    stall_offline_deleted_at: string;
+  }
+  
+  export interface UnifiedInventoryLevelChangeLogType {
+    id: string;
+    date: string;
+    inventory_item_id: string;
+    unavailable: number | string;
+    committed: number | string;
+    in_stock: number | string;
+    on_hand: number | string;
+    reason: string;
+    batch: string;
+    device_id: string;
+    staff_id: string;
+    location_id: string;
+    user_id: string;
+    stall_offline_id: string;
+    stall_offline_created_at: string;
+    stall_offline_updated_at: string;
+    stall_offline_deleted_at: string;
+  }

package/src/locations.d.ts

@@ -0,0 +1,14 @@
+import { UnifiedTaxRegionType } from "./taxes";
+
+export interface LocationType {
+  name: string;
+  address: string;
+  city: string;
+  country: string;
+  org_id: string;
+  id: string;
+  created_at: string;
+  updated_at: string;
+  active: boolean;
+  region?: UnifiedTaxRegionType;
+}

package/src/lookup.d.ts

@@ -0,0 +1,45 @@
+import { ExtensionModule } from "@/extensions/types";
+import React from "react";
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+export interface LookUpStateType {
+  active_group: LookupGroupRouteType | undefined;
+  routes: LookupGroupRouteType[];
+  search_query: string;
+  is_shortcut?: boolean;
+}
+
+export interface LookupGroupRouteType {
+  id: string;
+  title: string;
+  extension: {
+    id: string;
+    title: string;
+  };
+  previous_route_item: Record<string, any>;
+  filters?: LookupListFilters[];
+}
+
+export type LookupListFilters = {
+  key: string;
+  type: "string" | "number" | "array";
+  query_value: string;
+  dynamic: boolean;
+};
+
+export type ActionTriggerType = null | {
+  global: boolean;
+};
+
+export interface LookUpContextType {
+  actionsTriggered: ActionTriggerType;
+  triggerActions: (state: ActionTriggerType) => void;
+  lookUpSearchInputRef: React.RefObject<HTMLInputElement>;
+  closeLookUp: (force?: boolean) => void;
+  module: ExtensionModule | null;
+  loading: boolean;
+  error: Error | null;
+  look_up: LookUpStateType;
+  active_group: LookupGroupRouteType | undefined;
+  handleInputsKeyDown: (e: React.KeyboardEvent<HTMLInputElement>) => void;
+}

package/src/media.d.ts

@@ -0,0 +1,14 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+export interface ImageTypes {
+    source_url: string;
+    id: string;
+    alt: string;
+    date_created: string;
+}
+export interface UnifiedImageType {
+    source_url: string;
+    name: string;
+    id: string;
+    alt: string;
+    date_created: string;
+  }

package/src/onboarding.d.ts

@@ -0,0 +1,10 @@
+export interface signupForm {
+  business_type: string;
+  organization_name: string;
+  organization_size: number;
+  username: string;
+  phone_number: string;
+  email: string;
+  password: string;
+  plan: string;
+}