@fencyai/react 0.1.166 → 0.1.167

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (16) hide show
  1. package/dist/agent-task/AgentTaskProgress.d.ts +21 -0
  2. package/dist/agent-task/AgentTaskProgress.d.ts.map +1 -1
  3. package/dist/agent-task/translations.d.ts +2 -2
  4. package/dist/agent-task/translations.d.ts.map +1 -1
  5. package/dist/hooks/useAgentTasks/index.d.ts +21 -0
  6. package/dist/hooks/useAgentTasks/index.d.ts.map +1 -1
  7. package/dist/index.d.ts +12 -0
  8. package/dist/index.d.ts.map +1 -1
  9. package/dist/index.js +281 -275
  10. package/dist/provider/StreamEventManager.d.ts +1 -1
  11. package/dist/provider/StreamEventManager.d.ts.map +1 -1
  12. package/dist/types/UseAgentTasks.d.ts +10 -1
  13. package/dist/types/UseAgentTasks.d.ts.map +1 -1
  14. package/dist/types/UseAgentTasksProps.d.ts +17 -3
  15. package/dist/types/UseAgentTasksProps.d.ts.map +1 -1
  16. package/package.json +7 -5
package/dist/provider/StreamEventManager.d.ts CHANGED
@@ -2,7 +2,7 @@ import { FencyInstance } from '@fencyai/js';
2
2
  import { StreamCache } from '../types/FencyContext';
3
3
  type EventCallback = (data: string, streamId: string) => void;
4
4
  type ErrorCallback = (streamId: string, errorMessage?: string) => void;
5
- interface Subscription {
5
+ export interface Subscription {
6
6
  onMessage: EventCallback;
7
7
  onError: ErrorCallback;
8
8
  }
package/dist/provider/StreamEventManager.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"StreamEventManager.d.ts","sourceRoot":"","sources":["../../src/provider/StreamEventManager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAG3C,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAQnD,KAAK,aAAa,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAA;AAC7D,KAAK,aAAa,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,KAAK,IAAI,CAAA;AAEtE,UAAU,YAAY;IAClB,SAAS,EAAE,aAAa,CAAA;IACxB,OAAO,EAAE,aAAa,CAAA;CACzB;AAED;;;GAGG;AACH,qBAAa,kBAAkB;IAC3B,OAAO,CAAC,YAAY,CAA0C;IAC9D,OAAO,CAAC,WAAW,CAAuC;IAC1D,OAAO,CAAC,KAAK,CAAe;gBAEhB,KAAK,EAAE,aAAa;IAIhC;;;OAGG;IACH,aAAa,CAAC,OAAO,EAAE,WAAW,EAAE,GAAG,IAAI;IAmB3C,OAAO,CAAC,aAAa;IA+CrB;;;OAGG;IACH,SAAS,CAAC,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,YAAY,GAAG,MAAM,IAAI;IASpE,OAAO,CAAC,SAAS;IAMjB,OAAO,CAAC,cAAc;IAMtB;;OAEG;IACH,OAAO,IAAI,IAAI;CAKlB"}
1
+ {"version":3,"file":"StreamEventManager.d.ts","sourceRoot":"","sources":["../../src/provider/StreamEventManager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAG3C,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAQnD,KAAK,aAAa,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAA;AAC7D,KAAK,aAAa,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,KAAK,IAAI,CAAA;AAEtE,MAAM,WAAW,YAAY;IACzB,SAAS,EAAE,aAAa,CAAA;IACxB,OAAO,EAAE,aAAa,CAAA;CACzB;AAED;;;GAGG;AACH,qBAAa,kBAAkB;IAC3B,OAAO,CAAC,YAAY,CAA0C;IAC9D,OAAO,CAAC,WAAW,CAAuC;IAC1D,OAAO,CAAC,KAAK,CAAe;gBAEhB,KAAK,EAAE,aAAa;IAIhC;;;OAGG;IACH,aAAa,CAAC,OAAO,EAAE,WAAW,EAAE,GAAG,IAAI;IAmB3C,OAAO,CAAC,aAAa;IA+CrB;;;OAGG;IACH,SAAS,CAAC,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,YAAY,GAAG,MAAM,IAAI;IASpE,OAAO,CAAC,SAAS;IAMjB,OAAO,CAAC,cAAc;IAMtB;;OAEG;IACH,OAAO,IAAI,IAAI;CAKlB"}
package/dist/types/UseAgentTasks.d.ts CHANGED
@@ -1,12 +1,21 @@
1
+ import { AgentTask } from './AgentTask';
1
2
  import { CreateAgentTaskParams } from './CreateAgentTaskParams';
2
3
  import { CreateAgentTaskResponse } from './CreateAgentTaskResponse';
3
- import { AgentTask } from './AgentTask';
4
+ import { FetchCreateAgentTaskClientToken } from './UseAgentTasksProps';
4
5
  export interface UseAgentTasks {
5
6
  agentTasks: AgentTask[];
6
7
  createAgentTask: (params: CreateAgentTaskParams, options?: {
7
8
  loadingText?: string;
8
9
  /** Called as soon as the task is registered locally (after stream is created). Useful for parallel runs. */
9
10
  onTaskRegistered?: (task: AgentTask) => void;
11
+ /**
12
+ * Token fetcher for this invocation only.
13
+ *
14
+ * @remarks
15
+ * When set, overrides `fetchCreateAgentTaskClientToken` from {@link UseAgentTasksProps} for this call.
16
+ * If the hook prop is also omitted, this option must be set or `createAgentTask` throws.
17
+ */
18
+ fetchCreateAgentTaskClientToken?: FetchCreateAgentTaskClientToken;
10
19
  }) => Promise<CreateAgentTaskResponse>;
11
20
  latest?: AgentTask;
12
21
  }
package/dist/types/UseAgentTasks.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"UseAgentTasks.d.ts","sourceRoot":"","sources":["../../src/types/UseAgentTasks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAC/D,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAA;AACnE,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAEvC,MAAM,WAAW,aAAa;IAC1B,UAAU,EAAE,SAAS,EAAE,CAAA;IACvB,eAAe,EAAE,CACb,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE;QACN,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,4GAA4G;QAC5G,gBAAgB,CAAC,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,IAAI,CAAA;KAC/C,KACA,OAAO,CAAC,uBAAuB,CAAC,CAAA;IACrC,MAAM,CAAC,EAAE,SAAS,CAAA;CACrB"}
1
+ {"version":3,"file":"UseAgentTasks.d.ts","sourceRoot":"","sources":["../../src/types/UseAgentTasks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAC/D,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAA;AACnE,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,sBAAsB,CAAA;AAE3E,MAAM,WAAW,aAAa;IAC1B,UAAU,EAAE,SAAS,EAAE,CAAA;IACvB,eAAe,EAAE,CACb,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE;QACN,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,4GAA4G;QAC5G,gBAAgB,CAAC,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,IAAI,CAAA;QAC5C;;;;;;WAMG;QACH,+BAA+B,CAAC,EAAE,+BAA+B,CAAA;KACpE,KACA,OAAO,CAAC,uBAAuB,CAAC,CAAA;IACrC,MAAM,CAAC,EAAE,SAAS,CAAA;CACrB"}
package/dist/types/UseAgentTasksProps.d.ts CHANGED
@@ -1,9 +1,23 @@
1
1
  import { AgentTaskProgressItemUpdated, StreamNotFound, StreamTimeout } from './StreamData';
2
2
  import { StreamError } from './StreamError';
3
+ /**
4
+ * Returns a short-lived client token used to authorize the create-agent-task request to the Fency API.
5
+ *
6
+ * @remarks
7
+ * Implement this by calling your backend (or session endpoint) and returning `{ clientToken }`.
8
+ */
9
+ export type FetchCreateAgentTaskClientToken = () => Promise<{
10
+ clientToken: string;
11
+ }>;
3
12
  export interface UseAgentTasksProps {
4
- fetchCreateAgentTaskClientToken: (taskType: 'StreamingChatCompletion' | 'StructuredChatCompletion' | 'MemoryChat' | 'MemorySearch') => Promise<{
5
- clientToken: string;
6
- }>;
13
+ /**
14
+ * Default token fetcher for {@link UseAgentTasks.createAgentTask}.
15
+ *
16
+ * @remarks
17
+ * Omit this if every `createAgentTask` call passes `fetchCreateAgentTaskClientToken` in its options.
18
+ * For each task, at least one of this prop or per-call `createAgentTask(..., { fetchCreateAgentTaskClientToken })` must be set; when both are set on a call, the per-call fetcher is used.
19
+ */
20
+ fetchCreateAgentTaskClientToken?: FetchCreateAgentTaskClientToken;
7
21
  onAgentTaskProgressItemUpdated?: (streamData: AgentTaskProgressItemUpdated) => void;
8
22
  onAgentTaskCompleted?: (streamId: string) => void;
9
23
  onStreamError?: (event: StreamError) => void;
package/dist/types/UseAgentTasksProps.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"UseAgentTasksProps.d.ts","sourceRoot":"","sources":["../../src/types/UseAgentTasksProps.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,cAAc,EACd,aAAa,EAChB,MAAM,cAAc,CAAA;AACrB,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAE3C,MAAM,WAAW,kBAAkB;IAC/B,+BAA+B,EAAE,CAC7B,QAAQ,EAAE,yBAAyB,GAAG,0BAA0B,GAAG,YAAY,GAAG,cAAc,KAC/F,OAAO,CAAC;QACT,WAAW,EAAE,MAAM,CAAA;KACtB,CAAC,CAAA;IACF,8BAA8B,CAAC,EAAE,CAC7B,UAAU,EAAE,4BAA4B,KACvC,IAAI,CAAA;IACT,oBAAoB,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAA;IACjD,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,IAAI,CAAA;IAC5C,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,IAAI,CAAA;IAClD,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,CAAA;CACnD"}
1
+ {"version":3,"file":"UseAgentTasksProps.d.ts","sourceRoot":"","sources":["../../src/types/UseAgentTasksProps.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,cAAc,EACd,aAAa,EAChB,MAAM,cAAc,CAAA;AACrB,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAE3C;;;;;GAKG;AACH,MAAM,MAAM,+BAA+B,GAAG,MAAM,OAAO,CAAC;IACxD,WAAW,EAAE,MAAM,CAAA;CACtB,CAAC,CAAA;AAEF,MAAM,WAAW,kBAAkB;IAC/B;;;;;;OAMG;IACH,+BAA+B,CAAC,EAAE,+BAA+B,CAAA;IACjE,8BAA8B,CAAC,EAAE,CAC7B,UAAU,EAAE,4BAA4B,KACvC,IAAI,CAAA;IACT,oBAAoB,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAA;IACjD,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,IAAI,CAAA;IAC5C,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,IAAI,CAAA;IAClD,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,CAAA;CACnD"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fencyai/react",
3
- "version": "0.1.166",
3
+ "version": "0.1.167",
4
4
  "description": "> TODO: description",
5
5
  "author": "staklau <steinaageklaussen@gmail.com>",
6
6
  "homepage": "",
@@ -31,13 +31,15 @@
31
31
  "dev": "vite build --watch",
32
32
  "prepublishOnly": "npm run build",
33
33
  "extract-api": "api-extractor run",
34
- "extract-api:local": "api-extractor run --local"
34
+ "extract-api:local": "api-extractor run --local && api-documenter markdown --input-folder etc --output-folder etc/docs",
35
+ "docs": "npx -y serve etc/docs"
35
36
  },
36
37
  "dependencies": {
37
38
  "@microsoft/fetch-event-source": "^2.0.1"
38
39
  },
39
40
  "devDependencies": {
40
- "@fencyai/js": "^0.1.166",
41
+ "@fencyai/js": "^0.1.167",
42
+ "@microsoft/api-documenter": "^7.30.0",
41
43
  "@testing-library/react": "^16.3.2",
42
44
  "@types/jest": "^30.0.0",
43
45
  "@types/node": "^20.10.5",
@@ -53,7 +55,7 @@
53
55
  "vite-plugin-lib-inject-css": "^2.1.1"
54
56
  },
55
57
  "peerDependencies": {
56
- "@fencyai/js": "^0.1.166",
58
+ "@fencyai/js": "^0.1.167",
57
59
  "motion": "^11.15.0 || ^12.0.0",
58
60
  "react": ">=16.8.0",
59
61
  "react-markdown": "^10.1.0",
@@ -66,5 +68,5 @@
66
68
  "optional": false
67
69
  }
68
70
  },
69
- "gitHead": "679c4a96957868701ac672c44b255dda377fae95"
71
+ "gitHead": "0cedf6690c501efe2564e62ceb8b5169f8dd03bd"
70
72
  }