taskforceai-sdk 1.2.1 → 1.3.0

package/LICENSE

@@ -0,0 +1,37 @@
+MIT License with Attribution Requirement for Large-Scale Commercial Use
+
+Copyright (c) 2025 Clay Warren
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+ADDITIONAL COMMERCIAL ATTRIBUTION REQUIREMENT:
+If you use this Software, in whole or in part, in any product, service, or
+application that serves more than 100,000 users, you must:
+
+1. Provide clear attribution to Clay Warren as the original creator
+2. Include a statement that your product uses the "TaskForceAI" framework
+3. This attribution must be visible in one of the following locations:
+   - Product documentation
+   - About page/section
+   - Credits section
+   - Help/support documentation
+   - Or equivalent user-accessible location
+
+Example attribution: "Powered by TaskForceAI by Clay Warren"
+or "Uses TaskForceAI multi-agent system created by Clay Warren"
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -38,6 +38,22 @@ for await (const status of stream) {
 }
 ```
 
+## Mock Mode
+
+Build and test your integration without an API key using mock mode:
+
+```typescript
+import { TaskForceAI } from 'taskforceai-sdk';
+
+// No API key required in mock mode
+const client = new TaskForceAI({ mockMode: true });
+
+const result = await client.runTask('Test your integration');
+console.log(result.result); // "This is a mock response. Configure your API key to get real results."
+```
+
+Mock mode simulates the full task lifecycle locally—no network requests are made. Tasks go through "processing" then "completed" states, making it easy to build UIs and test error handling before launch.
+
 ## API Reference
 
 ### TaskForceAI
@@ -52,10 +68,11 @@ constructor(options: TaskForceAIOptions)
 
 **Options:**
 
-- `apiKey` (required): Your API key
+- `apiKey` (required unless `mockMode` is true): Your API key
 - `baseUrl` (optional): API base URL (default: https://taskforceai.chat/api/developer)
 - `timeout` (optional): Request timeout in milliseconds (default: 30000)
 - `responseHook` (optional): Callback invoked with every raw `fetch` response
+- `mockMode` (optional): Enable mock mode for development without an API key (default: false)
 
 #### Methods
 

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 import { TaskForceAIError, transportDefaults as def } from './transport';
 import type { TaskForceAIOptions, TaskResult, TaskStatus, TaskStatusCallback, TaskStatusStream, TaskSubmissionOptions } from './types';
 import { VERSION } from './types';
@@ -6,7 +7,10 @@ export declare class TaskForceAI {
     private url;
     private t;
     private rh?;
+    private mm;
+    private mcc;
     constructor(o: TaskForceAIOptions);
+    private mockResponse;
     private req;
     submitTask(p: string, o?: TaskSubmissionOptions): Promise<string>;
     getTaskStatus(id: any): Promise<TaskStatus>;

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,IAAI,GAAG,EAAe,MAAM,aAAa,CAAC;AACtF,OAAO,KAAK,EACV,kBAAkB,EAClB,UAAU,EACV,UAAU,EACV,kBAAkB,EAClB,gBAAgB,EAChB,qBAAqB,EACtB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAOlC,qBAAa,WAAW;IACtB,OAAO,CAAC,EAAE,CAAS;IACnB,OAAO,CAAC,GAAG,CAAS;IACpB,OAAO,CAAC,CAAC,CAAS;IAClB,OAAO,CAAC,EAAE,CAAC,CAAwB;gBACvB,CAAC,EAAE,kBAAkB;IAOjC,OAAO,CAAC,GAAG,CAOP;IAEE,UAAU,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,GAAE,qBAA0B,GAAG,OAAO,CAAC,MAAM,CAAC;IAWrE,aAAa,CAAC,EAAE,EAAE,GAAG;IAKrB,aAAa,CAAC,EAAE,EAAE,GAAG;YAMZ,IAAI;IAoBb,iBAAiB,CACrB,EAAE,EAAE,MAAM,EACV,EAAE,OAAqB,EACvB,GAAG,MAAsB,EACzB,EAAE,CAAC,EAAE,kBAAkB,EACvB,GAAG,CAAC,EAAE,WAAW,GAChB,OAAO,CAAC,UAAU,CAAC;IAQhB,OAAO,CACX,CAAC,EAAE,MAAM,EACT,CAAC,GAAE,qBAA0B,EAC7B,EAAE,OAAqB,EACvB,GAAG,MAAsB,EACzB,EAAE,CAAC,EAAE,kBAAkB;IAKzB,gBAAgB,CACd,EAAE,EAAE,GAAG,EACP,EAAE,OAAqB,EACvB,GAAG,MAAsB,EACzB,EAAE,CAAC,EAAE,kBAAkB,EACvB,GAAG,CAAC,EAAE,WAAW,GAChB,gBAAgB;IAgBb,aAAa,CACjB,CAAC,EAAE,MAAM,EACT,CAAC,GAAE,qBAA0B,EAC7B,EAAE,OAAqB,EACvB,GAAG,MAAsB,EACzB,EAAE,CAAC,EAAE,kBAAkB,EACvB,GAAG,CAAC,EAAE,WAAW;CAIpB;AAED,OAAO,EACL,gBAAgB,EAChB,UAAU,EACV,UAAU,EACV,qBAAqB,EACrB,kBAAkB,EAClB,gBAAgB,EAChB,kBAAkB,EAClB,OAAO,EACP,GAAG,IAAI,iBAAiB,GACzB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,IAAI,GAAG,EAAe,MAAM,aAAa,CAAC;AACtF,OAAO,KAAK,EACV,kBAAkB,EAClB,UAAU,EACV,UAAU,EACV,kBAAkB,EAClB,gBAAgB,EAChB,qBAAqB,EACtB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AASlC,qBAAa,WAAW;IACtB,OAAO,CAAC,EAAE,CAAS;IACnB,OAAO,CAAC,GAAG,CAAS;IACpB,OAAO,CAAC,CAAC,CAAS;IAClB,OAAO,CAAC,EAAE,CAAC,CAAwB;IACnC,OAAO,CAAC,EAAE,CAAU;IACpB,OAAO,CAAC,GAAG,CAAkC;gBAEjC,CAAC,EAAE,kBAAkB;IAWjC,OAAO,CAAC,YAAY;IAsBpB,OAAO,CAAC,GAAG,CAWT;IAEI,UAAU,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,GAAE,qBAA0B,GAAG,OAAO,CAAC,MAAM,CAAC;IAWrE,aAAa,CAAC,EAAE,EAAE,GAAG;IAKrB,aAAa,CAAC,EAAE,EAAE,GAAG;YAMZ,IAAI;IAoBb,iBAAiB,CACrB,EAAE,EAAE,MAAM,EACV,EAAE,OAAqB,EACvB,GAAG,MAAsB,EACzB,EAAE,CAAC,EAAE,kBAAkB,EACvB,GAAG,CAAC,EAAE,WAAW,GAChB,OAAO,CAAC,UAAU,CAAC;IAQhB,OAAO,CACX,CAAC,EAAE,MAAM,EACT,CAAC,GAAE,qBAA0B,EAC7B,EAAE,OAAqB,EACvB,GAAG,MAAsB,EACzB,EAAE,CAAC,EAAE,kBAAkB;IAKzB,gBAAgB,CACd,EAAE,EAAE,GAAG,EACP,EAAE,OAAqB,EACvB,GAAG,MAAsB,EACzB,EAAE,CAAC,EAAE,kBAAkB,EACvB,GAAG,CAAC,EAAE,WAAW,GAChB,gBAAgB;IAgBb,aAAa,CACjB,CAAC,EAAE,MAAM,EACT,CAAC,GAAE,qBAA0B,EAC7B,EAAE,OAAqB,EACvB,GAAG,MAAsB,EACzB,EAAE,CAAC,EAAE,kBAAkB,EACvB,GAAG,CAAC,EAAE,WAAW;CAIpB;AAED,OAAO,EACL,gBAAgB,EAChB,UAAU,EACV,UAAU,EACV,qBAAqB,EACrB,kBAAkB,EAClB,gBAAgB,EAChB,kBAAkB,EAClB,OAAO,EACP,GAAG,IAAI,iBAAiB,GACzB,CAAC"}

package/dist/index.js

@@ -9,14 +9,46 @@ Object.defineProperty(exports, "VERSION", { enumerable: true, get: function () {
 const sleep = (ms) => new Promise((resolve) => {
     setTimeout(() => resolve(), ms);
 });
+const MOCK_RESULT = 'This is a mock response. Configure your API key to get real results.';
 class TaskForceAI {
     constructor(o) {
-        this.req = (e, i = {}, r = false) => (0, transport_1.makeRequest)(e, i, { apiKey: this.ak, baseUrl: this.url, timeout: this.t, responseHook: this.rh }, r, transport_1.transportDefaults.maxRetries);
-        this.ak = o.apiKey;
+        this.mcc = new Map();
+        this.req = (e, i = {}, r = false) => {
+            if (this.mm) {
+                return Promise.resolve(this.mockResponse(e, i.method || 'GET'));
+            }
+            return (0, transport_1.makeRequest)(e, i, { apiKey: this.ak, baseUrl: this.url, timeout: this.t, responseHook: this.rh }, r, transport_1.transportDefaults.maxRetries);
+        };
+        this.mm = o.mockMode ?? false;
+        if (!this.mm && !o.apiKey) {
+            throw new transport_1.TaskForceAIError('API key is required when not in mock mode');
+        }
+        this.ak = o.apiKey || '';
         this.url = o.baseUrl || 'https://taskforceai.chat/api/developer';
         this.t = o.timeout || transport_1.transportDefaults.timeout;
         this.rh = o.responseHook;
     }
+    mockResponse(e, method) {
+        if (method === 'POST' && e === '/run') {
+            const taskId = `mock-${Math.random().toString(36).slice(2, 10)}`;
+            this.mcc.set(taskId, 0);
+            return { taskId, status: 'processing' };
+        }
+        if (e.startsWith('/status/')) {
+            const taskId = e.split('/').pop();
+            const count = this.mcc.get(taskId) || 0;
+            this.mcc.set(taskId, count + 1);
+            if (count < 1) {
+                return { taskId, status: 'processing', message: 'Mock task processing...' };
+            }
+            return { taskId, status: 'completed', result: MOCK_RESULT };
+        }
+        if (e.startsWith('/results/')) {
+            const taskId = e.split('/').pop();
+            return { taskId, status: 'completed', result: MOCK_RESULT };
+        }
+        return { status: 'ok' };
+    }
     async submitTask(p, o = {}) {
         if (typeof p !== 'string' || !p.trim())
             throw new transport_1.TaskForceAIError('Prompt must be a non-empty string');

package/dist/transport.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 export declare class TaskForceAIError extends Error {
     statusCode?: number | undefined;
     constructor(message: string, statusCode?: number | undefined);

package/dist/transport.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"transport.d.ts","sourceRoot":"","sources":["../src/transport.ts"],"names":[],"mappings":"AAsCA,qBAAa,gBAAiB,SAAQ,KAAK;IAGhC,UAAU,CAAC,EAAE,MAAM;gBAD1B,OAAO,EAAE,MAAM,EACR,UAAU,CAAC,EAAE,MAAM,YAAA;CAK7B;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,IAAI,CAAC;CAC7C;AAED,eAAO,MAAM,WAAW,GAAU,CAAC,EACjC,UAAU,MAAM,EAChB,SAAS,WAAW,EACpB,4CAA4C,eAAe,EAC3D,mBAAiB,EACjB,mBAAgC,KAC/B,OAAO,CAAC,CAAC,CAyDX,CAAC;AAEF,eAAO,MAAM,iBAAiB;;;;;;CAMpB,CAAC"}
+{"version":3,"file":"transport.d.ts","sourceRoot":"","sources":["../src/transport.ts"],"names":[],"mappings":";AAsCA,qBAAa,gBAAiB,SAAQ,KAAK;IAGhC,UAAU,CAAC;gBADlB,OAAO,EAAE,MAAM,EACR,UAAU,CAAC,oBAAQ;CAK7B;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,IAAI,CAAC;CAC7C;AAED,eAAO,MAAM,WAAW,gBACZ,MAAM,WACP,WAAW,8CACwB,eAAe,yDA4D5D,CAAC;AAEF,eAAO,MAAM,iBAAiB;;;;;;CAMpB,CAAC"}

package/dist/types.d.ts

@@ -1,9 +1,11 @@
+/// <reference types="node" />
 export declare const VERSION = "1.2.1";
 export interface TaskForceAIOptions {
-    apiKey: string;
+    apiKey?: string;
     baseUrl?: string;
     timeout?: number;
     responseHook?: TaskResponseHook;
+    mockMode?: boolean;
 }
 export type TaskSubmissionOptions = {
     [key: string]: unknown;

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC;AAE/B,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,gBAAgB,CAAC;CACjC;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IACvB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,WAAW,UAAU;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,YAAY,GAAG,WAAW,GAAG,QAAQ,CAAC;IAC9C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,UAAW,SAAQ,UAAU;IAC5C,MAAM,EAAE,WAAW,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,kBAAkB,GAAG,CAAC,MAAM,EAAE,UAAU,KAAK,IAAI,CAAC;AAC9D,MAAM,MAAM,gBAAgB,GAAG,CAAC,QAAQ,EAAE,QAAQ,KAAK,IAAI,CAAC;AAE5D,MAAM,WAAW,gBAAiB,SAAQ,aAAa,CAAC,UAAU,CAAC;IACjE,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,IAAI,IAAI,CAAC;CAChB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";AAAA,eAAO,MAAM,OAAO,UAAU,CAAC;AAE/B,MAAM,WAAW,kBAAkB;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAChC,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IACvB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,WAAW,UAAU;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,YAAY,GAAG,WAAW,GAAG,QAAQ,CAAC;IAC9C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,UAAW,SAAQ,UAAU;IAC5C,MAAM,EAAE,WAAW,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,kBAAkB,GAAG,CAAC,MAAM,EAAE,UAAU,KAAK,IAAI,CAAC;AAC9D,MAAM,MAAM,gBAAgB,GAAG,CAAC,QAAQ,EAAE,QAAQ,KAAK,IAAI,CAAC;AAE5D,MAAM,WAAW,gBAAiB,SAAQ,aAAa,CAAC,UAAU,CAAC;IACjE,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,IAAI,IAAI,CAAC;CAChB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "taskforceai-sdk",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "description": "TypeScript SDK for TaskForceAI",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -27,10 +27,10 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/ClayWarren/grok4fastheavy.git"
+    "url": "git+https://github.com/ClayWarren/taskforceai-sdk-typescript.git"
   },
   "bugs": {
-    "url": "https://github.com/ClayWarren/grok4fastheavy/issues"
+    "url": "https://github.com/ClayWarren/taskforceai-sdk-typescript/issues"
   },
   "homepage": "https://taskforceai.chat",
   "engines": {