@use-stall/types 0.0.1

package/src/register-sessions.d.ts

@@ -0,0 +1,73 @@
+import { Timestamp } from "firebase/firestore";
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+export interface UnifiedRegisterSessionType {
+  id: string;
+  device_id: string;
+  staff_id: string;
+  location_id: string;
+  opening_date: Timestamp;
+  opening_date_string: string;
+  closing_date: Timestamp;
+  closing_date_string: string;
+  last_activity_date: Timestamp;
+  duration: number; // Duration in miliseconds
+  opening_cash_balance: number;
+  closing_cash_balance_declared: number;
+  closing_cash_balance_system_calculated: number;
+  cash_difference: number;
+  cash_excess: number;
+  running_cash_balance: number;
+  paid_in: number; // Total value of cash paid into the register during the session
+  paid_out: number; // Total value of cash paid out of the register during the session
+  non_cash_tender_total: number; // Total value of non-cash transactions during the session
+  total_amount: number; // Total value of all transactions
+  number_of_transactions: number;
+  status: "open" | "closed" | "pending";
+  notes: string;
+  closing_remarks: string;
+  metadata: Record<string, any>;
+}
+
+export interface UnifiedSessionTransactionType {
+  id: string;
+  date: Timestamp;
+  date_string: string;
+  order_id: string;
+  session_id: string;
+  location_id: string;
+  staff_id: string;
+  transaction_type:
+    | "sale"
+    | "return"
+    | "refund"
+    | "void"
+    | "pay-out"
+    | "pay-in";
+  tender_type: string; // e.g., "Cash", "Credit Card", "Gift Card"
+  total_amount: number;
+  note: string;
+  metadata: Record<string, any>;
+  payment_method: {
+    name: string;
+    id: string;
+  };
+}
+
+export interface UpdateSessionBalanceProps {
+  amount: number;
+  note: string;
+  transaction_type:
+    | "sale"
+    | "return"
+    | "refund"
+    | "void"
+    | "pay-out"
+    | "pay-in";
+  tender_type: string;
+  order_id?: string;
+  payment_method: {
+    name: string;
+    id: string;
+  };
+}

package/src/stall-icons.d.ts

@@ -0,0 +1 @@
+declare module "stall-icons";

package/src/system.d.ts

@@ -0,0 +1,44 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { UnifiedCustomerType } from "./customers";
+import { UnifiedOrderRefundType, UnifiedOrderType } from "./orders";
+
+export interface PosQueueDataType {
+  action: "create" | "update" | "delete";
+  group: "orders" | "order_refunds" | "customers" | "purchase_orders";
+  data: UnifiedOrderType | UnifiedCustomerType | UnifiedOrderRefundType;
+  timestamp: number;
+  id: string;
+  document_id: string;
+  status: "syncing" | "pending";
+  device_token: string;
+}
+
+export interface LoaderDataType {
+  percentage: number;
+  title?: string;
+  icon?: unknown;
+}
+
+export interface SystemInfo {
+  browser: {
+    name: string;
+    version: string;
+  };
+  os: {
+    name: string;
+    version: string;
+    versionName: string;
+  };
+  platform: {
+    type: string;
+    vendor: string;
+  };
+  engine: {
+    name: string;
+  };
+}
+
+export interface NativeEventType {
+  type: "haptic" | "theme";
+  payload: any;
+}

package/src/taxes.d.ts

@@ -0,0 +1,32 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+export interface UnifiedTaxRegionType {
+  id: string; // Unique identifier
+  name: string; // Display name (e.g., "California", "EU VAT Zone")
+  country: string; // Country
+  alpha3: string; // ISO 3166-1 alpha-3 code (e.g., "USA", "GBR")
+  alpha2: string; // ISO 3166-1 alpha-2 code (e.g., "US", "GB")
+  states: string[]; // Optional state/province (e.g., "CA")
+  postal_codes: string[]; // Specific ZIP codes if applicable
+  tax_inclusive: boolean; // Whether prices include tax
+  is_default?: boolean; // Whether this is the default region
+  metadata: { [key: string]: string }; // Additional metadata
+}
+
+export interface UnifiedTaxClassType {
+  id: string; // Unique ID for the tax class
+  region_id: string; // Links to TaxZone
+  name: string; // Name (e.g., "Standard", "Reduced", "Exempt")
+  metadata: { [key: string]: any }; // Additional metadata
+}
+
+export interface UnifiedTaxRateType {
+  id: string; // Unique identifier
+  class_id: string; // Links to TaxClass
+  region_id: string; // Links to TaxRegion
+  rate: number; // Tax rate (e.g., 0.2 for 20%)
+  type: "percentage" | "fixed"; // Type of tax
+  code: string; // Optional description
+  compound: boolean; // Whether this is a compound tax rate
+  priority: number; // Priority order
+  metadata: { [key: string]: any }; // Additional metadata
+}

package/src/users.d.ts

@@ -0,0 +1,40 @@
+import { AuthObject } from "pin-auth";
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+export interface UserType {
+  fullname: string;
+  email: string;
+  organizations: string[];
+  createdAt: string;
+  updatedAt: string;
+  id: string;
+  role_id: string;
+  phone_number: string;
+  profile_picture?: string;
+}
+
+export interface PosProfileType {
+  id: string;
+  name: string;
+  email?: string;
+  createdAt: string;
+  updatedAt: string;
+  role_id: string;
+  linked_devices: string[];
+  profile?: string;
+  locations: string[];
+  locations_enabled?: boolean;
+  auth: AuthObject;
+}
+
+export interface RoleType {
+  id: string;
+  role: string;
+  permissions: { [key: string]: any };
+}
+
+export interface PosRoleType {
+  id: string;
+  role: string;
+  permissions: { [key: string]: any };
+}

package/tsconfig.json

@@ -0,0 +1,30 @@
+{
+  "compilerOptions": {
+    // Environment setup & latest features
+    "lib": ["ESNext"],
+    "target": "ESNext",
+    "module": "Preserve",
+    "moduleDetection": "force",
+    "jsx": "react-jsx",
+    "allowJs": true,
+
+    // Bundler mode
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "noEmit": true,
+
+    // Best practices
+    "strict": true,
+    "skipLibCheck": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedIndexedAccess": true,
+    "noImplicitOverride": true,
+
+    // Some stricter flags (disabled by default)
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "noPropertyAccessFromIndexSignature": false
+  }
+}
+