@use-stall/types 0.1.4 → 0.1.6

package/index.d.ts

@@ -22,5 +22,6 @@ export * from "./src/taxes";
 export * from "./src/users";
 export * from "./src/fulfillment";
 export * from "./src/extensions";
-export * from "./src/integrations";
+export * from "./src/connectors";
 export * from "./src/pin-auth";
+export * from "./src/integrations";

package/package.json

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

package/src/connectors.d.ts

@@ -0,0 +1,68 @@
+type ModuleKey =
+  | "products"
+  | "variants"
+  | "collections"
+  | "categories"
+  | "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"
+  | "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 ConnectorIntegrationType {
+  id: string;
+  version: string;
+  name: string;
+  description: string;
+  logo: string;
+  modules: ConnectorModulesType;
+  authentication: {
+    type: "basic" | "bearer" | "api_key" | "none";
+    ttl_type: "permanent" | "session";
+    ttl_value: number; // TTL value in minutes
+  };
+  integration_url: string;
+  integration_docs: string;
+  active: boolean;
+}
+
+export interface ConnectorConfigurationType {
+  id: string;
+  integration_id: string;
+  created_at: number;
+  updated_at: number;
+  configuration: {
+    endpoint: string; // The endpoint URL
+    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/integrations.d.ts

@@ -1,85 +1,7 @@
-type ModuleKey =
-  | "products"
-  | "variants"
-  | "collections"
-  | "categories"
-  | "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"
-  | "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 type IntegrationConnectionType =
-    | "connector"
-    | "payments"
-    | "fulfillments"
-    | "fiscalizations";
-
-export interface IntegrationModulesType {
-  [key in ModuleKey]: {
-    supported: boolean;
-    actions: {
-      create: boolean;
-      read: boolean;
-      update: boolean;
-      delete: boolean;
-    };
-  };
-}
-
-export interface IntegrationType {
-  id: string;
-  version: string;
-  name: string;
-  type: IntegrationConnectionType;
-  description: string;
-  logo: string;
-  modules: IntegrationModulesType;
-  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;
-}
-
-export interface IntegrationConfigurationType {
-  id: string;
-  integration_id: string;
-  type: IntegrationConnectionType;
-  created_at: number;
-  updated_at: number;
-  configuration: {
-    endpoint: string; // The endpoint URL
-    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
-    [key: string]: any;
-  };
-}
 
 export interface IntegrationRequestType {
   id: string;
   organization: string;
   integration: string;
   created_at: number;
-  type: IntegrationConnectionType;
-}
+}

package/src/organizations.d.ts

@@ -1,3 +1,5 @@
+import type { ConnectorConfigurationType } from "./connectors";
+
 export interface OrganizationType {
   id: string;
   business_type: string;
@@ -19,15 +21,10 @@ export interface OrganizationType {
     subscription: string;
   };
   logo: string;
-  integrations: {
-    connector: boolean;
-    payments: boolean;
-    fulfillments: boolean;
-    fiscalizations: boolean;
-  };
   emails: string[]; // Other email addresses with access, the primary one is the one with matching the owner uid
   created_at: number;
   updated_at: number;
+  connector?: ConnectorConfigurationType;
 }
 
 export interface ReceiptType {

package/src/payments.d.ts

@@ -7,7 +7,7 @@ export type MethodsType =
   | "mobile_money"
   | "connector_payments"
   | "cash"
-  | "manual";
+  | "manual" // same as Square other option;
 
 export interface PaymentProviderType {
   id: string;
@@ -21,6 +21,7 @@ export interface PaymentProviderType {
 export interface PaymentMethodType {
   type: MethodsType;
   offline_support: boolean;
+  instant_clear: boolean; // whether the payment is cleared instantly like cash or custom
 }
 
 export type PaymentCollectionStatus =
@@ -34,6 +35,8 @@ export type PaymentCollectionStatus =
 
 export interface PaymentCollectionType {
   id: string;
+  organization: string;
+  location: string;
   created_at: string;
   updated_at: string;
   status: PaymentCollectionStatus;

package/src/users.d.ts

@@ -1,4 +1,4 @@
-import type { ModuleKey } from "./integrations";
+import type { ModuleKey } from "./connectors";
 import { AuthObject } from "./pin-auth";
 
 export interface UserType {