@use-stall/types 0.3.5 → 0.3.6

package/package.json

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

package/src/extensions.d.ts

@@ -1,6 +1,10 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import { UnifiedOrderType } from "./orders";
-import { LookupGroupRouteType } from "./utils/lookup";
+import {
+  LookupActionHelpersType,
+  LookupGroupRouteType,
+  LookupListFilterType,
+} from "./lookup";
 import type { CoreConfig } from "./core-sdk";
 
 interface StallExtension {
@@ -26,22 +30,23 @@ interface ExtensionActionShortcut {
 }
 
 interface ExtensionLookupAction {
-  native: boolean;
-  name: string;
+  id: string;
   label: string;
-  static_args: Record<string, any>;
-  close_on_complete: boolean; // Close lookup
+  close_on_complete?: boolean; // Close lookup
   reopen_on_return?: boolean; // Reopen lookup on return from an external page
   always_show?: boolean; // Always show the action in the lookup even if no item is selected or highlighted
   shortcut?: ExtensionActionShortcut;
   paths?: string[]; // You can specify a list of paths where this action should be available, when left empty it will be available everywhere
+  static_args?: Record<string, any>;
+  run: (arg: ExtensionLookupActionArgs) => Promise<void> | void;
 }
 
-interface ExtensionActionFunctionProps {
-  static_args: Record<string, any>;
-  item: any;
-  router: Router;
+interface ExtensionLookupActionArgs {
+  item: any | null;
   active_group: LookupGroupRouteType;
+  search_query: string;
+  helpers: LookupActionHelpersType;
+  static_args: Record<string, any>;
   action: ExtensionLookupAction;
 }
 
@@ -86,12 +91,20 @@ type ListFilters = {
   dynamic: boolean;
 };
 
+interface ExtensionLookupFetchArgs {
+  filters: LookupListFilterType[];
+  active_group: LookupGroupRouteType;
+  parent_item: Record<string, any>;
+  search_query: string;
+  helpers: LookupActionHelpersType;
+}
+
 interface LocalListUIComponent {
   id: string;
   title: string;
   description: string;
   data_origin: "local";
-  filters: ListFilters[];
+  filters: LookupListFilterType[];
   sorting: {
     key: string;
     order: "asc" | "desc";
@@ -106,12 +119,13 @@ interface RemoteListUIComponent {
   title: string;
   description: string;
   data_origin: "remote";
-  filters: ListFilters[];
+  filters: LookupListFilterType[];
   sorting: {
     key: string;
     order: "asc" | "desc";
   };
   source: string;
+  fetch: (arg: ExtensionLookupFetchArgs) => Promise<any[]> | any[];
   keys: ListKeys;
   actions: ExtensionLookupAction[];
 }
@@ -153,7 +167,8 @@ export type {
   ExtensionPage,
   ExtensionActionShortcut,
   ExtensionLookupAction,
-  ExtensionActionFunctionProps,
+  ExtensionLookupActionArgs,
+  ExtensionLookupFetchArgs,
   ListFilters,
   ListFormatKey,
   ListKeys,

package/src/lookup.d.ts

@@ -1,45 +1,58 @@
-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 type LookupValueType = "string" | "number" | "array";
+
+export interface LookupListFilterType {
+  key: string;
+  type: LookupValueType;
+  query_value: string;
+  dynamic: boolean;
+}
+
+export interface LookupRouteExtensionType {
+  id: string;
+  title: string;
 }
 
 export interface LookupGroupRouteType {
   id: string;
   title: string;
-  extension: {
-    id: string;
-    title: string;
-  };
+  extension: LookupRouteExtensionType;
   previous_route_item: Record<string, any>;
-  filters?: LookupListFilters[];
+  filters?: LookupListFilterType[];
 }
 
-export type LookupListFilters = {
-  key: string;
-  type: "string" | "number" | "array";
-  query_value: string;
-  dynamic: boolean;
-};
+export interface LookupStateType {
+  active_group: LookupGroupRouteType | undefined;
+  routes: LookupGroupRouteType[];
+  search_query: string;
+  is_shortcut?: boolean;
+}
 
-export type ActionTriggerType = null | {
-  global: boolean;
-};
+export interface LookupLastInstanceType extends LookupStateType {
+  path: string;
+}
+
+export interface LookupOpenGroupArgsType {
+  group: Omit<LookupGroupRouteType, "previous_route_item">;
+  item?: Record<string, any>;
+}
 
-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;
+export interface LookupActionHelpersType {
+  navigate: (path: string | number, options?: { replace?: boolean }) => void;
+  open_group: (arg: LookupOpenGroupArgsType) => void;
+  go_back: (force?: boolean) => void;
+  close_lookup: (force?: boolean) => void;
+  set_search_query: (value: string) => void;
+  get_lookup_state: () => LookupStateType | null;
+}
+
+export interface LookUpStateType {
   active_group: LookupGroupRouteType | undefined;
-  handleInputsKeyDown: (e: React.KeyboardEvent<HTMLInputElement>) => void;
+  routes: LookupGroupRouteType[];
+  search_query: string;
+  is_shortcut?: boolean;
 }
+
+export type LookupActionTriggerType = null | {
+  global: boolean;
+};

package/src/utils/lookup.d.ts

@@ -1,17 +0,0 @@
-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;
-};