@piedata/pieui 2.0.5 → 2.0.7

package/dist/pieui.components.json

@@ -149,6 +149,150 @@
       "$schema": "http://json-schema.org/draft-07/schema#"
     }
   },
+  {
+    "card": "SessionStorageCard",
+    "data": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "key": {
+          "type": "string"
+        },
+        "value": {
+          "type": "string"
+        },
+        "useSocketioSupport": {
+          "type": "boolean"
+        },
+        "useCentrifugeSupport": {
+          "type": "boolean"
+        },
+        "useMittSupport": {
+          "type": "boolean"
+        },
+        "centrifugeChannel": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "key",
+        "name",
+        "value"
+      ],
+      "$schema": "http://json-schema.org/draft-07/schema#"
+    }
+  },
+  {
+    "card": "DeviceStorageCard",
+    "data": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "key": {
+          "type": "string"
+        },
+        "value": {
+          "type": "string"
+        },
+        "useSocketioSupport": {
+          "type": "boolean"
+        },
+        "useCentrifugeSupport": {
+          "type": "boolean"
+        },
+        "useMittSupport": {
+          "type": "boolean"
+        },
+        "centrifugeChannel": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "key",
+        "name",
+        "value"
+      ],
+      "$schema": "http://json-schema.org/draft-07/schema#"
+    }
+  },
+  {
+    "card": "CloudStorageCard",
+    "data": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "key": {
+          "type": "string"
+        },
+        "value": {
+          "type": "string"
+        },
+        "useSocketioSupport": {
+          "type": "boolean"
+        },
+        "useCentrifugeSupport": {
+          "type": "boolean"
+        },
+        "useMittSupport": {
+          "type": "boolean"
+        },
+        "centrifugeChannel": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "key",
+        "name",
+        "value"
+      ],
+      "$schema": "http://json-schema.org/draft-07/schema#"
+    }
+  },
+  {
+    "card": "SecureStorageCard",
+    "data": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "key": {
+          "type": "string"
+        },
+        "value": {
+          "type": "string"
+        },
+        "useSocketioSupport": {
+          "type": "boolean"
+        },
+        "useCentrifugeSupport": {
+          "type": "boolean"
+        },
+        "useMittSupport": {
+          "type": "boolean"
+        },
+        "centrifugeChannel": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "key",
+        "name",
+        "value"
+      ],
+      "$schema": "http://json-schema.org/draft-07/schema#"
+    }
+  },
   {
     "card": "AjaxGroupCard",
     "data": {

package/dist/tests/mittAgentTools.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=mittAgentTools.test.d.ts.map

package/dist/tests/mittAgentTools.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mittAgentTools.test.d.ts","sourceRoot":"","sources":["../../src/tests/mittAgentTools.test.ts"],"names":[],"mappings":""}

package/dist/util/ajaxCommonUtils.d.ts

@@ -1,5 +1,16 @@
 import '../types';
 import { SetUiAjaxConfigurationType } from '../types';
+/**
+ * Retry policy configuration for AJAX requests.
+ */
+export type RetryPolicy = {
+    /** Maximum number of retry attempts (default: 0 — no retries). */
+    maxRetries?: number;
+    /** Base delay in ms between retries (default: 1000). Doubled on each attempt. */
+    baseDelay?: number;
+    /** HTTP status codes that should trigger a retry (default: [502, 503, 504]). Timeouts and network errors always retry regardless of this list. */
+    retryOn?: number[];
+};
 /**
  * Options for {@link getAjaxSubmit}. Passed explicitly so that the helper can
  * stay a plain function — callers forward the values they already obtained
@@ -10,6 +21,10 @@ export type GetAjaxSubmitOptions = {
     apiServer?: string | null;
     /** When `true`, the helper will log registration and error details. */
     renderingLogEnabled?: boolean;
+    /** Request timeout in milliseconds. No timeout if omitted. */
+    timeout?: number;
+    /** Retry policy for failed requests. No retries if omitted. */
+    retryPolicy?: RetryPolicy;
 };
 /**
  * Builds an async "submit" function that issues an AJAX request to
@@ -38,7 +53,7 @@ export type GetAjaxSubmitOptions = {
  * @param options                See {@link GetAjaxSubmitOptions}.
  * @returns An `async (extraKwargs?) => Promise<any>` submit function.
  */
-export declare const getAjaxSubmit: (setUiAjaxConfiguration?: SetUiAjaxConfigurationType, kwargs?: Record<string, any>, depsNames?: Array<string>, pathname?: string, options?: GetAjaxSubmitOptions) => (() => void) | ((extraKwargs?: Record<string, any>) => Promise<any>);
+export declare const getAjaxSubmit: (setUiAjaxConfiguration?: SetUiAjaxConfigurationType, kwargs?: Record<string, any>, depsNames?: Array<string>, pathname?: string, options?: GetAjaxSubmitOptions) => (extraKwargs?: Record<string, any>) => Promise<any>;
 /**
  * React hook wrapper around {@link getAjaxSubmit}. Reads `apiServer` and
  * `enableRenderingLog` from {@link usePieConfig} and memoizes the submit
@@ -51,7 +66,11 @@ export declare const getAjaxSubmit: (setUiAjaxConfiguration?: SetUiAjaxConfigura
  * @param depsNames              Names of DOM inputs whose current values should
  *                               be sent alongside the request.
  * @param pathname               Path segment appended to `api/ajax_content`.
+ * @param options                Optional `timeout` (ms) and `retryPolicy`.
  * @returns A memoized submit function; see {@link getAjaxSubmit}.
  */
-export declare const useAjaxSubmit: (setUiAjaxConfiguration?: SetUiAjaxConfigurationType, kwargs?: Record<string, any>, depsNames?: Array<string>, pathname?: string) => (() => void) | ((extraKwargs?: Record<string, any>) => Promise<any>);
+export declare const useAjaxSubmit: (setUiAjaxConfiguration?: SetUiAjaxConfigurationType, kwargs?: Record<string, any>, depsNames?: Array<string>, pathname?: string, options?: {
+    timeout?: number;
+    retryPolicy?: RetryPolicy;
+}) => (extraKwargs?: Record<string, any>) => Promise<any>;
 //# sourceMappingURL=ajaxCommonUtils.d.ts.map

package/dist/util/ajaxCommonUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ajaxCommonUtils.d.ts","sourceRoot":"","sources":["../../src/util/ajaxCommonUtils.ts"],"names":[],"mappings":"AAEA,OAAO,UAAU,CAAA;AACjB,OAAO,EAAE,0BAA0B,EAAe,MAAM,UAAU,CAAA;AAKlE;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG;IAC/B,4DAA4D;IAC5D,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,uEAAuE;IACvE,mBAAmB,CAAC,EAAE,OAAO,CAAA;CAChC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,aAAa,GACtB,yBAAyB,0BAA0B,EACnD,SAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAM,EAChC,YAAW,KAAK,CAAC,MAAM,CAAM,EAC7B,WAAW,MAAM,EACjB,UAAU,oBAAoB,oCAyBH,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,kBAoIjD,CAAA;AAED;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,aAAa,GACtB,yBAAyB,0BAA0B,EACnD,SAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAM,EAChC,YAAW,KAAK,CAAC,MAAM,CAAM,EAC7B,WAAW,MAAM,oCAxJU,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,kBAgLjD,CAAA"}
+{"version":3,"file":"ajaxCommonUtils.d.ts","sourceRoot":"","sources":["../../src/util/ajaxCommonUtils.ts"],"names":[],"mappings":"AAEA,OAAO,UAAU,CAAA;AACjB,OAAO,EAAE,0BAA0B,EAAe,MAAM,UAAU,CAAA;AAKlE;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACtB,kEAAkE;IAClE,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,iFAAiF;IACjF,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,kJAAkJ;IAClJ,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;CACrB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG;IAC/B,4DAA4D;IAC5D,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,uEAAuE;IACvE,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B,8DAA8D;IAC9D,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,+DAA+D;IAC/D,WAAW,CAAC,EAAE,WAAW,CAAA;CAC5B,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,aAAa,GACtB,yBAAyB,0BAA0B,EACnD,SAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAM,EAChC,YAAW,KAAK,CAAC,MAAM,CAAM,EAC7B,WAAW,MAAM,EACjB,UAAU,oBAAoB,MAahB,cAAa,MAAM,CAAC,MAAM,EAAE,GAAG,CAAM,iBA6LtD,CAAA;AAED;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,aAAa,GACtB,yBAAyB,0BAA0B,EACnD,SAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAM,EAChC,YAAW,KAAK,CAAC,MAAM,CAAM,EAC7B,WAAW,MAAM,EACjB,UAAU;IAAE,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,WAAW,CAAA;CAAE,oBAnN9B,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,iBA+OjD,CAAA"}

package/dist/util/mittAgentTools.d.ts

@@ -0,0 +1,89 @@
+import { tool } from '@openai/agents';
+import type { Emitter } from 'mitt';
+import { type MittEvents } from './mitt';
+/**
+ * Descriptor passed to the customization callbacks on
+ * {@link MittAgentToolsOptions}.
+ */
+export type MittAgentToolDescriptor = {
+    /** Method key originally registered on the `PieCard.methods` map. */
+    methodName: string;
+    /** Value of `data.name` on the target `PieCard`. */
+    cardName: string;
+    /** Raw mitt event name (`pie{methodName}_{cardName}`). */
+    eventName: string;
+};
+/**
+ * Options accepted by {@link getMittAgentTools} and
+ * {@link usePieMittAgentTools}.
+ */
+export type MittAgentToolsOptions = {
+    /**
+     * Optional predicate invoked for each discovered PieCard method. Return
+     * `false` to omit the event from the generated tool list. Defaults to
+     * accepting everything.
+     */
+    filter?: (descriptor: MittAgentToolDescriptor) => boolean;
+    /**
+     * Optional override for the tool description surfaced to the model.
+     * Defaults to a generic string mentioning the card and method.
+     */
+    describe?: (descriptor: MittAgentToolDescriptor) => string;
+    /**
+     * Optional override for the public tool name. Defaults to
+     * `{cardName}_{methodName}`. The returned value must be unique within the
+     * final tool set.
+     */
+    nameFor?: (descriptor: MittAgentToolDescriptor) => string;
+};
+/**
+ * Return type of {@link getMittAgentTools}. We intentionally keep this loose
+ * rather than importing the deeply-parameterized `FunctionTool` generic from
+ * `@openai/agents-core` — callers typically feed the result directly into
+ * `new Agent({ tools: [...] })` which accepts any tool-shaped value.
+ */
+export type MittAgentTool = ReturnType<typeof tool>;
+/**
+ * Scans a mitt emitter for all currently-registered PieCard methods (events
+ * matching `pie{methodName}_{cardName}`) and wraps each one as an
+ * `@openai/agents` function tool.
+ *
+ * Calling a returned tool re-emits the matching mitt event with the
+ * `payload` argument supplied by the model. Because mitt listeners run
+ * synchronously in-process, the tool executes entirely locally with no
+ * network hop.
+ *
+ * This takes a *snapshot* of the emitter at the moment it is called — cards
+ * that mount afterwards will not be represented until the function is called
+ * again. Prefer {@link usePieMittAgentTools} from inside React components so
+ * the snapshot refreshes whenever the surrounding tree re-renders.
+ *
+ * @param emitter The mitt emitter to scan. Defaults to the global PieUI
+ *                singleton returned by {@link getEmitter}.
+ * @param options See {@link MittAgentToolsOptions}.
+ * @returns An array of `@openai/agents` function tools, one per discovered
+ *          PieCard method.
+ */
+export declare function getMittAgentTools(emitter?: Emitter<MittEvents>, options?: MittAgentToolsOptions): MittAgentTool[];
+/**
+ * React hook wrapper around {@link getMittAgentTools}. Reads the emitter from
+ * {@link MittContext} — falling back to the global singleton returned by
+ * {@link getEmitter} when used outside of a PieRoot — and memoizes the
+ * resulting tool array by a sorted snapshot of registered event names so the
+ * returned reference is stable across renders that don't add or remove
+ * PieCard methods.
+ *
+ * Because mitt does not emit a "handler-added" notification, the hook only
+ * refreshes its snapshot when the calling component re-renders. If you need
+ * to react to cards mounting at arbitrary times, trigger a re-render from the
+ * consumer or call {@link getMittAgentTools} imperatively right before you
+ * build the `Agent`.
+ *
+ * @example
+ * ```tsx
+ * const tools = usePieMittAgentTools()
+ * const agent = useMemo(() => new Agent({ name: 'UI', tools }), [tools])
+ * ```
+ */
+export declare function usePieMittAgentTools(options?: MittAgentToolsOptions): MittAgentTool[];
+//# sourceMappingURL=mittAgentTools.d.ts.map

package/dist/util/mittAgentTools.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mittAgentTools.d.ts","sourceRoot":"","sources":["../../src/util/mittAgentTools.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAA;AAErC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AACnC,OAAoB,EAAc,KAAK,UAAU,EAAE,MAAM,QAAQ,CAAA;AAWjE;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAAG;IAClC,qEAAqE;IACrE,UAAU,EAAE,MAAM,CAAA;IAClB,oDAAoD;IACpD,QAAQ,EAAE,MAAM,CAAA;IAChB,0DAA0D;IAC1D,SAAS,EAAE,MAAM,CAAA;CACpB,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAChC;;;;OAIG;IACH,MAAM,CAAC,EAAE,CAAC,UAAU,EAAE,uBAAuB,KAAK,OAAO,CAAA;IACzD;;;OAGG;IACH,QAAQ,CAAC,EAAE,CAAC,UAAU,EAAE,uBAAuB,KAAK,MAAM,CAAA;IAC1D;;;;OAIG;IACH,OAAO,CAAC,EAAE,CAAC,UAAU,EAAE,uBAAuB,KAAK,MAAM,CAAA;CAC5D,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,OAAO,IAAI,CAAC,CAAA;AAEnD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,iBAAiB,CAC7B,OAAO,GAAE,OAAO,CAAC,UAAU,CAAgB,EAC3C,OAAO,GAAE,qBAA0B,GACpC,aAAa,EAAE,CAqDjB;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,oBAAoB,CAChC,OAAO,GAAE,qBAA0B,GACpC,aAAa,EAAE,CAsBjB"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@piedata/pieui",
-    "version": "2.0.5",
+    "version": "2.0.7",
     "description": "A React component library featuring PieCard component",
     "repository": {
         "type": "git",