@use-stall/types 0.3.3 → 0.3.5

package/package.json

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

package/src/customers.d.ts

@@ -3,12 +3,11 @@
 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[];
+  billing_address: UnifiedCustomerAddressType;
+  shipping_address: UnifiedCustomerAddressType;
   phone: string;
   metadata: {
     stall_offline_id: string;
@@ -23,10 +22,7 @@ export interface UnifiedCustomerType {
 }
 
 export interface UnifiedCustomerAddressType {
-  id: string;
   address_name: string;
-  is_default_shipping: boolean;
-  is_default_billing: boolean;
   company: string;
   first_name: string;
   last_name: string;

package/src/extensions.d.ts

@@ -1,7 +1,5 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import { UnifiedOrderType } from "./orders";
-import { ComponentType } from "./utils/react";
-import type { Router } from "./utils/router";
 import { LookupGroupRouteType } from "./utils/lookup";
 import type { CoreConfig } from "./core-sdk";
 
@@ -47,16 +45,15 @@ interface ExtensionActionFunctionProps {
   action: ExtensionLookupAction;
 }
 
-enum ListDataSourceOptions {
-  PRODUCTS = "products",
-  CUSTOMERS = "customers",
-  ORDERS = "orders",
-  PARKED_ORDERS = "parked_orders",
-  COLLECTIONS = "collections",
-  CATEGORIES = "categories",
-  REGISTERS = "register_sessions",
-  TRANSACTIONS = "session_transactions",
-}
+type ListDataSourceOptions =
+  | "products"
+  | "customers"
+  | "orders"
+  | "parked_orders"
+  | "collections"
+  | "categories"
+  | "register_sessions"
+  | "session_transactions";
 
 type ListKeyFormat =
   | "string"
@@ -121,14 +118,9 @@ interface RemoteListUIComponent {
 
 type ExtensionLookupGroup = LocalListUIComponent | RemoteListUIComponent;
 
-interface UIProps {
+interface RuntimeProps {
   item: any;
-  search_query: Record<string, string>;
   base_currency: string;
-  active_cart: UnifiedOrderType | null;
-  BackButton: ComponentType<any>;
-  LoaderComponent: ComponentType<any>;
-  router: Router;
   stall: CoreConfig;
 }
 
@@ -150,12 +142,11 @@ interface StallExtensionConfig {
   };
 }
 
-enum ExtensionNativeActions {
-  OPEN_GROUP = "open_group",
-  OPEN_PAGE = "open_page",
-  ADD_TO_CART = "add_to_cart",
-  ADD_CUSTOMER_TO_ORDER = "add_customer_to_order",
-}
+type ExtensionNativeActions =
+  | "open_group"
+  | "open_page"
+  | "add_to_cart"
+  | "add_customer_to_order";
 
 export type {
   StallExtension,
@@ -169,11 +160,11 @@ export type {
   LocalListUIComponent,
   RemoteListUIComponent,
   ExtensionLookupGroup,
-  UIProps,
+  RuntimeProps,
   StallExtensionConfig,
 };
 
-export { ListDataSourceOptions, ExtensionNativeActions };
+export type { ListDataSourceOptions, ExtensionNativeActions };
 
 export interface ExtensionType {
   id: string;

package/src/utils/react.d.ts

@@ -1,34 +0,0 @@
-export type ReactText = string | number;
-export type ReactChild = ReactElement | ReactText;
-export type ReactFragment = Iterable<ReactNode>;
-
-export interface ReactPortal {
-  key: string | null;
-  children: ReactNode;
-  type: string | ComponentType<any>;
-  props: any;
-}
-
-export type ReactNode =
-  | ReactChild
-  | ReactFragment
-  | ReactPortal
-  | boolean
-  | null
-  | undefined;
-
-export interface ReactElement<P = any> {
-  type: string | ComponentType<P>;
-  props: P & { children?: ReactNode }; // ← children must be here
-  key: string | null;
-}
-
-export interface FunctionComponent<P = {}> {
-  (props: P): ReactElement<any> | null;
-}
-
-export interface ComponentClass<P = {}> {
-  new (props: P): { render(): ReactNode };
-}
-
-export type ComponentType<P = {}> = FunctionComponent<P> | ComponentClass<P>;

package/src/utils/router.d.ts

@@ -1,637 +0,0 @@
-// ─── Primitive / shared types ────────────────────────────────────────────────
-
-export type Primitive = string | number | boolean | null | undefined;
-
-/** A URL-safe path made up of its three constituent parts. */
-export interface Path {
-  /** The portion of the URL pathname before any query string. */
-  pathname: string;
-  /** The URL search string, starting with `?`. */
-  search: string;
-  /** The URL fragment identifier, starting with `#`. */
-  hash: string;
-}
-
-/** Accepted values for the `to` argument of `navigate`. */
-export type To = string | Partial<Path>;
-
-/** A fully-resolved browser Location, augmented with router-level state. */
-export interface Location extends Path {
-  /**
-   * A value of arbitrary data associated with this location.
-   */
-  state: any;
-  /**
-   * A unique string associated with this location. May be used to safely store
-   * and retrieve data in some other storage API, like `localStorage`.
-   */
-  key: string;
-}
-
-// ─── History ─────────────────────────────────────────────────────────────────
-
-export type Action = "POP" | "PUSH" | "REPLACE";
-
-export interface Update {
-  action: Action;
-  location: Location;
-  delta: number | null;
-}
-
-export interface Listener {
-  (update: Update): void;
-}
-
-// ─── Route objects ────────────────────────────────────────────────────────────
-
-export type AgnosticRouteMatch<
-  ParamsKey extends string = string,
-  RouteObjectType extends AgnosticRouteObject = AgnosticRouteObject
-> = {
-  params: Params<ParamsKey>;
-  pathname: string;
-  pathnameBase: string;
-  route: RouteObjectType;
-};
-
-export interface IndexRouteObject {
-  caseSensitive?: boolean;
-  path?: string;
-  id?: string;
-  loader?: LoaderFunction;
-  action?: ActionFunction;
-  hasErrorBoundary?: boolean;
-  shouldRevalidate?: ShouldRevalidateFunction;
-  handle?: RouteObject["handle"];
-  index: true;
-  children?: undefined;
-  element?: React.ReactNode | null;
-  hydrateFallbackElement?: React.ReactNode | null;
-  errorElement?: React.ReactNode | null;
-  Component?: React.ComponentType | null;
-  HydrateFallback?: React.ComponentType | null;
-  ErrorBoundary?: React.ComponentType | null;
-  lazy?: LazyRouteFunction<RouteObject>;
-}
-
-export interface NonIndexRouteObject {
-  caseSensitive?: boolean;
-  path?: string;
-  id?: string;
-  loader?: LoaderFunction;
-  action?: ActionFunction;
-  hasErrorBoundary?: boolean;
-  shouldRevalidate?: ShouldRevalidateFunction;
-  handle?: any;
-  index?: false;
-  children?: RouteObject[];
-  element?: React.ReactNode | null;
-  hydrateFallbackElement?: React.ReactNode | null;
-  errorElement?: React.ReactNode | null;
-  Component?: React.ComponentType | null;
-  HydrateFallback?: React.ComponentType | null;
-  ErrorBoundary?: React.ComponentType | null;
-  lazy?: LazyRouteFunction<RouteObject>;
-}
-
-export type RouteObject = IndexRouteObject | NonIndexRouteObject;
-
-/**
- * Framework-agnostic route object — the underlying shape the router core
- * operates on (no React-specific fields).
- */
-export interface AgnosticRouteObject {
-  caseSensitive?: boolean;
-  children?: AgnosticRouteObject[];
-  element?: any;
-  index?: boolean;
-  path?: string;
-  id?: string;
-  loader?: LoaderFunction;
-  action?: ActionFunction;
-  hasErrorBoundary?: boolean;
-  shouldRevalidate?: ShouldRevalidateFunction;
-  handle?: any;
-  lazy?: LazyRouteFunction<AgnosticRouteObject>;
-}
-
-export interface AgnosticDataRouteObject extends AgnosticRouteObject {
-  children?: AgnosticDataRouteObject[];
-  id: string;
-}
-
-// ─── Params ──────────────────────────────────────────────────────────────────
-
-export type Params<Key extends string = string> = {
-  readonly [key in Key]: string | undefined;
-};
-
-// ─── Loader / action functions ────────────────────────────────────────────────
-
-export type LoaderFunctionArgs<Context = any> = {
-  request: Request;
-  params: Params;
-  context?: Context;
-};
-
-export type ActionFunctionArgs<Context = any> = {
-  request: Request;
-  params: Params;
-  context?: Context;
-};
-
-export interface LoaderFunction<Context = any> {
-  (args: LoaderFunctionArgs<Context>, handlerCtx?: unknown):
-    | Promise<Response>
-    | Response
-    | Promise<any>
-    | any;
-}
-
-export interface ActionFunction<Context = any> {
-  (args: ActionFunctionArgs<Context>, handlerCtx?: unknown):
-    | Promise<Response>
-    | Response
-    | Promise<any>
-    | any;
-}
-
-export interface ShouldRevalidateFunctionArgs {
-  currentUrl: URL;
-  currentParams: Params;
-  nextUrl: URL;
-  nextParams: Params;
-  formMethod?: string;
-  formAction?: string;
-  formEncType?: string;
-  text?: string;
-  formData?: FormData;
-  json?: any;
-  actionStatus?: number;
-  actionResult?: any;
-  defaultShouldRevalidate: boolean;
-}
-
-export interface ShouldRevalidateFunction {
-  (args: ShouldRevalidateFunctionArgs): boolean;
-}
-
-export type LazyRouteFunction<R extends AgnosticRouteObject> = () => Promise<
-  Omit<R, "lazy" | "id" | "index" | "children">
->;
-
-// ─── Navigation ──────────────────────────────────────────────────────────────
-
-export type FormMethod =
-  | "get"
-  | "post"
-  | "put"
-  | "patch"
-  | "delete"
-  | "GET"
-  | "POST"
-  | "PUT"
-  | "PATCH"
-  | "DELETE";
-
-export type FormEncType =
-  | "application/x-www-form-urlencoded"
-  | "multipart/form-data"
-  | "application/json"
-  | "text/plain";
-
-export type RelativeRoutingType = "route" | "path";
-
-interface NavigateOptions {
-  replace?: boolean;
-  state?: any;
-  relative?: RelativeRoutingType;
-  flushSync?: boolean;
-  viewTransition?: boolean;
-}
-
-export interface RouterNavigateOptions extends NavigateOptions {
-  fromRouteId?: string;
-  /** Submission options */
-  formMethod?: FormMethod;
-  formAction?: string;
-  formEncType?: FormEncType;
-  body?: any;
-  formData?: FormData;
-  json?: any;
-  text?: string;
-  /** Replace / unstable flags */
-  preventScrollReset?: boolean;
-}
-
-export interface RouterFetchOptions {
-  formMethod?: FormMethod;
-  formAction?: string;
-  formEncType?: FormEncType;
-  body?: any;
-  formData?: FormData;
-  json?: any;
-  text?: string;
-  preventScrollReset?: boolean;
-}
-
-// ─── Navigation state ─────────────────────────────────────────────────────────
-
-export type NavigationState =
-  | { state: "idle"; location?: undefined; formMethod?: undefined; formAction?: undefined; formEncType?: undefined; formData?: undefined; json?: undefined; text?: undefined }
-  | { state: "loading"; location: Location; formMethod?: FormMethod; formAction?: string; formEncType?: FormEncType; formData?: FormData; json?: any; text?: string }
-  | { state: "submitting"; location: Location; formMethod: FormMethod; formAction: string; formEncType: FormEncType; formData?: FormData; json?: any; text?: string };
-
-export type Navigation = NavigationState;
-
-// ─── Fetcher ─────────────────────────────────────────────────────────────────
-
-export type FetcherState =
-  | { state: "idle"; data: undefined; formMethod?: undefined; formAction?: undefined; formEncType?: undefined; formData?: undefined; json?: undefined; text?: undefined }
-  | { state: "loading"; data: undefined; formMethod?: FormMethod; formAction?: string; formEncType?: FormEncType; formData?: FormData; json?: any; text?: string }
-  | { state: "submitting"; data: undefined; formMethod: FormMethod; formAction: string; formEncType: FormEncType; formData?: FormData; json?: any; text?: string };
-
-export type Fetcher<TData = any> = (
-  | { state: "idle"; data: TData | undefined; formMethod?: undefined; formAction?: undefined; formEncType?: undefined; formData?: undefined; json?: undefined; text?: undefined }
-  | { state: "loading"; data: TData | undefined; formMethod?: FormMethod; formAction?: string; formEncType?: FormEncType; formData?: FormData; json?: any; text?: string }
-  | { state: "submitting"; data: TData | undefined; formMethod: FormMethod; formAction: string; formEncType: FormEncType; formData?: FormData; json?: any; text?: string }
-);
-
-// ─── Blocker ─────────────────────────────────────────────────────────────────
-
-export type BlockerFunction = (args: {
-  currentLocation: Location;
-  nextLocation: Location;
-  historyAction: Action;
-}) => boolean;
-
-export type Blocker =
-  | { state: "unblocked"; reset: undefined; proceed: undefined; location: undefined }
-  | { state: "blocked"; reset: () => void; proceed: () => void; location: Location }
-  | { state: "proceeding"; reset: undefined; proceed: undefined; location: Location };
-
-// ─── Revalidation ────────────────────────────────────────────────────────────
-
-export type RevalidationState = "idle" | "loading";
-
-// ─── Deferred data ───────────────────────────────────────────────────────────
-
-export interface DeferredData {
-  readonly done: boolean;
-  readonly unwrappedData: Record<string, any>;
-  subscribe(fn: (aborted: boolean, settledKey?: string) => void): boolean;
-  cancel(): void;
-  resolveData(signal: AbortSignal): Promise<boolean>;
-}
-
-// ─── Router state ─────────────────────────────────────────────────────────────
-
-export interface RouterState {
-  historyAction: Action;
-  location: Location;
-  matches: AgnosticDataRouteMatch[];
-  initialized: boolean;
-  navigation: Navigation;
-  restoreScrollPosition: number | false | null;
-  preventScrollReset: boolean;
-  revalidation: RevalidationState;
-  loaderData: RouteData;
-  actionData: RouteData | null;
-  errors: RouteData | null;
-  fetchers: Map<string, Fetcher>;
-  blockers: Map<string, Blocker>;
-}
-
-export type AgnosticDataRouteMatch = AgnosticRouteMatch<
-  string,
-  AgnosticDataRouteObject
->;
-
-export type RouteData = {
-  [routeId: string]: any;
-};
-
-// ─── Scroll restoration ───────────────────────────────────────────────────────
-
-export type GetScrollPositionFunction = () => number;
-
-export type GetScrollRestorationKeyFunction = (
-  location: Location,
-  matches: AgnosticDataRouteMatch[]
-) => string;
-
-// ─── Future config ────────────────────────────────────────────────────────────
-
-export interface FutureConfig {
-  unstable_skipActionErrorRevalidation: boolean;
-}
-
-// ─── Router init ─────────────────────────────────────────────────────────────
-
-export interface RouterInit {
-  routes: AgnosticRouteObject[];
-  history: {
-    readonly action: Action;
-    readonly location: Location;
-    listen(listener: Listener): () => void;
-    createHref(to: To): string;
-    encodeLocation(to: To): Path;
-    push(to: To, state?: any): void;
-    replace(to: To, state?: any): void;
-    go(delta: number): void;
-    back(): void;
-    forward(): void;
-  };
-  basename?: string;
-  mapRouteProperties?: (route: AgnosticRouteObject) => Partial<AgnosticRouteObject>;
-  future?: Partial<FutureConfig>;
-  hydrationData?: {
-    loaderData?: RouteData;
-    actionData?: RouteData | null;
-    errors?: RouteData | null;
-  };
-  window?: Window;
-  dataStrategy?: DataStrategyFunction;
-  patchRoutesOnNavigation?: PatchRoutesOnNavigationFunction;
-}
-
-// ─── Data strategy ───────────────────────────────────────────────────────────
-
-export type DataStrategyMatch = AgnosticRouteMatch<string, AgnosticDataRouteObject> & {
-  shouldLoad: boolean;
-  resolve: (
-    handlerOverride?: (
-      handler: (ctx?: unknown) => DataFunctionReturnValue
-    ) => DataFunctionReturnValue
-  ) => Promise<DataStrategyResult>;
-};
-
-export type DataFunctionReturnValue =
-  | Promise<Response>
-  | Response
-  | Promise<any>
-  | any;
-
-export type DataStrategyResult =
-  | { type: "data"; result: any }
-  | { type: "error"; result: any };
-
-export interface DataStrategyFunctionArgs<Context = any> {
-  request: Request;
-  params: Params;
-  context?: Context;
-  matches: DataStrategyMatch[];
-  fetcherKey: string | null;
-}
-
-export interface DataStrategyFunction {
-  (args: DataStrategyFunctionArgs): Promise<Record<string, DataStrategyResult>>;
-}
-
-// ─── Patch routes on navigation ───────────────────────────────────────────────
-
-export interface PatchRoutesOnNavigationFunctionArgs {
-  path: string;
-  matches: AgnosticRouteMatch[];
-  patch: (routeId: string | null, children: AgnosticRouteObject[]) => void;
-  signal: AbortSignal;
-}
-
-export interface PatchRoutesOnNavigationFunction {
-  (opts: PatchRoutesOnNavigationFunctionArgs): void | Promise<void>;
-}
-
-// ─── Subscriber ──────────────────────────────────────────────────────────────
-
-export type RouterSubscriber = (
-  state: RouterState,
-  opts: { deletedFetchers: string[]; flushSync: boolean; viewTransitionOpts?: ViewTransitionOpts }
-) => void;
-
-export interface ViewTransitionOpts {
-  currentLocation: Location;
-  nextLocation: Location;
-}
-
-// ─── Router interface (original, now fully self-contained) ────────────────────
-
-export interface Router {
-  /**
-   * @internal
-   * PRIVATE - DO NOT USE
-   *
-   * Return the basename for the router
-   */
-  get basename(): RouterInit["basename"];
-
-  /**
-   * @internal
-   * PRIVATE - DO NOT USE
-   *
-   * Return the future config for the router
-   */
-  get future(): FutureConfig;
-
-  /**
-   * @internal
-   * PRIVATE - DO NOT USE
-   *
-   * Return the current state of the router
-   */
-  get state(): RouterState;
-
-  /**
-   * @internal
-   * PRIVATE - DO NOT USE
-   *
-   * Return the routes for this router instance
-   */
-  get routes(): AgnosticDataRouteObject[];
-
-  /**
-   * @internal
-   * PRIVATE - DO NOT USE
-   *
-   * Return the window associated with the router
-   */
-  get window(): RouterInit["window"];
-
-  /**
-   * @internal
-   * PRIVATE - DO NOT USE
-   *
-   * Initialize the router, including adding history listeners and kicking off
-   * initial data fetches. Returns a function to cleanup listeners and abort
-   * any in-progress loads.
-   */
-  initialize(): Router;
-
-  /**
-   * @internal
-   * PRIVATE - DO NOT USE
-   *
-   * Subscribe to router.state updates
-   *
-   * @param fn function to call with the new state
-   */
-  subscribe(fn: RouterSubscriber): () => void;
-
-  /**
-   * @internal
-   * PRIVATE - DO NOT USE
-   *
-   * Enable scroll restoration behavior in the router
-   *
-   * @param savedScrollPositions Object that will manage positions, in case
-   *                             it's being restored from sessionStorage
-   * @param getScrollPosition    Function to get the active Y scroll position
-   * @param getKey               Function to get the key to use for restoration
-   */
-  enableScrollRestoration(
-    savedScrollPositions: Record<string, number>,
-    getScrollPosition: GetScrollPositionFunction,
-    getKey?: GetScrollRestorationKeyFunction
-  ): () => void;
-
-  /**
-   * @internal
-   * PRIVATE - DO NOT USE
-   *
-   * Navigate forward/backward in the history stack
-   * @param to Delta to move in the history stack
-   */
-  navigate(to: number): Promise<void>;
-
-  /**
-   * Navigate to the given path
-   * @param to Path to navigate to
-   * @param opts Navigation options (method, submission, etc.)
-   */
-  navigate(to: To | null, opts?: RouterNavigateOptions): Promise<void>;
-
-  /**
-   * @internal
-   * PRIVATE - DO NOT USE
-   *
-   * Trigger a fetcher load/submission
-   *
-   * @param key     Fetcher key
-   * @param routeId Route that owns the fetcher
-   * @param href    href to fetch
-   * @param opts    Fetcher options, (method, submission, etc.)
-   */
-  fetch(
-    key: string,
-    routeId: string,
-    href: string | null,
-    opts?: RouterFetchOptions
-  ): void;
-
-  /**
-   * @internal
-   * PRIVATE - DO NOT USE
-   *
-   * Trigger a revalidation of all current route loaders and fetcher loads
-   */
-  revalidate(): void;
-
-  /**
-   * @internal
-   * PRIVATE - DO NOT USE
-   *
-   * Utility function to create an href for the given location
-   * @param location
-   */
-  createHref(location: Location | URL): string;
-
-  /**
-   * @internal
-   * PRIVATE - DO NOT USE
-   *
-   * Utility function to URL encode a destination path according to the internal
-   * history implementation
-   * @param to
-   */
-  encodeLocation(to: To): Path;
-
-  /**
-   * @internal
-   * PRIVATE - DO NOT USE
-   *
-   * Get/create a fetcher for the given key
-   * @param key
-   */
-  getFetcher<TData = any>(key: string): Fetcher<TData>;
-
-  /**
-   * @internal
-   * PRIVATE - DO NOT USE
-   *
-   * Delete the fetcher for a given key
-   * @param key
-   */
-  deleteFetcher(key: string): void;
-
-  /**
-   * @internal
-   * PRIVATE - DO NOT USE
-   *
-   * Cleanup listeners and abort any in-progress loads
-   */
-  dispose(): void;
-
-  /**
-   * @internal
-   * PRIVATE - DO NOT USE
-   *
-   * Get a navigation blocker
-   * @param key The identifier for the blocker
-   * @param fn  The blocker function implementation
-   */
-  getBlocker(key: string, fn: BlockerFunction): Blocker;
-
-  /**
-   * @internal
-   * PRIVATE - DO NOT USE
-   *
-   * Delete a navigation blocker
-   * @param key The identifier for the blocker
-   */
-  deleteBlocker(key: string): void;
-
-  /**
-   * @internal
-   * PRIVATE DO NOT USE
-   *
-   * Patch additional children routes into an existing parent route
-   * @param routeId  The parent route id or a callback function accepting `patch`
-   *                 to perform batch patching
-   * @param children The additional children routes
-   */
-  patchRoutes(routeId: string | null, children: AgnosticRouteObject[]): void;
-
-  /**
-   * @internal
-   * PRIVATE - DO NOT USE
-   *
-   * HMR needs to pass in-flight route updates to React Router
-   * TODO: Replace this with granular route update APIs (addRoute, updateRoute, deleteRoute)
-   */
-  _internalSetRoutes(routes: AgnosticRouteObject[]): void;
-
-  /**
-   * @internal
-   * PRIVATE - DO NOT USE
-   *
-   * Internal fetch AbortControllers accessed by unit tests
-   */
-  _internalFetchControllers: Map<string, AbortController>;
-
-  /**
-   * @internal
-   * PRIVATE - DO NOT USE
-   *
-   * Internal pending DeferredData instances accessed by unit tests
-   */
-  _internalActiveDeferreds: Map<string, DeferredData>;
-}