@gradientlabs/client 0.1.0 → 0.1.1
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.
- package/README.md +20 -0
- package/dist/index.d.cts +3 -1
- package/dist/index.d.ts +3 -1
- package/package.json +8 -5
package/README.md
CHANGED
|
@@ -154,6 +154,26 @@ See the [`examples/`](./examples) directory for runnable examples covering
|
|
|
154
154
|
conversations, tools, articles, procedures, resources, back-office tasks, and a
|
|
155
155
|
webhook server.
|
|
156
156
|
|
|
157
|
+
## Releasing
|
|
158
|
+
|
|
159
|
+
Releases are published to [npm](https://www.npmjs.com/package/@gradientlabs/client) automatically when a version tag is pushed to `main`.
|
|
160
|
+
|
|
161
|
+
**One-time setup** (if not already done):
|
|
162
|
+
|
|
163
|
+
1. On npmjs.com, go to the `@gradientlabs/client` package → **Settings** → **Trusted Publishers** → **Add trusted publisher**.
|
|
164
|
+
2. Select **GitHub Actions** and fill in owner `gradientlabs-ai`, repository `gradientlabs-nodejs`, workflow `publish.yml`.
|
|
165
|
+
|
|
166
|
+
**To publish a new version:**
|
|
167
|
+
|
|
168
|
+
1. Merge all changes into `main`.
|
|
169
|
+
2. Update the version in `package.json`, merge that to `main`, and pull locally.
|
|
170
|
+
3. Push a version tag matching the `package.json` version:
|
|
171
|
+
```sh
|
|
172
|
+
git tag v1.2.3
|
|
173
|
+
git push origin v1.2.3
|
|
174
|
+
```
|
|
175
|
+
4. The [publish workflow](.github/workflows/publish.yml) runs automatically: it verifies the tag matches the `package.json` version, builds the library, and publishes it to npm.
|
|
176
|
+
|
|
157
177
|
## Development
|
|
158
178
|
|
|
159
179
|
```bash
|
package/dist/index.d.cts
CHANGED
|
@@ -339,8 +339,10 @@ interface CreateBackOfficeTaskParams {
|
|
|
339
339
|
id: string;
|
|
340
340
|
/** Input data for the task; shape depends on the task type. */
|
|
341
341
|
input: Record<string, unknown>;
|
|
342
|
-
/** Identifies the
|
|
342
|
+
/** Identifies the agent (`agent_…`) that owns the procedure to run the task against. Required. */
|
|
343
343
|
agent_id: string;
|
|
344
|
+
/** Identifies the procedure (`proc_…`) within the agent to start the task from. Required. */
|
|
345
|
+
procedure_id: string;
|
|
344
346
|
/** Optional free-format metadata the agent can read. */
|
|
345
347
|
metadata?: Record<string, string>;
|
|
346
348
|
attachments?: BackOfficeTaskAttachmentInput[];
|
package/dist/index.d.ts
CHANGED
|
@@ -339,8 +339,10 @@ interface CreateBackOfficeTaskParams {
|
|
|
339
339
|
id: string;
|
|
340
340
|
/** Input data for the task; shape depends on the task type. */
|
|
341
341
|
input: Record<string, unknown>;
|
|
342
|
-
/** Identifies the
|
|
342
|
+
/** Identifies the agent (`agent_…`) that owns the procedure to run the task against. Required. */
|
|
343
343
|
agent_id: string;
|
|
344
|
+
/** Identifies the procedure (`proc_…`) within the agent to start the task from. Required. */
|
|
345
|
+
procedure_id: string;
|
|
344
346
|
/** Optional free-format metadata the agent can read. */
|
|
345
347
|
metadata?: Record<string, string>;
|
|
346
348
|
attachments?: BackOfficeTaskAttachmentInput[];
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@gradientlabs/client",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "Official Node.js / TypeScript client for the Gradient Labs API",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"engines": {
|
|
@@ -41,11 +41,11 @@
|
|
|
41
41
|
"license": "MIT",
|
|
42
42
|
"repository": {
|
|
43
43
|
"type": "git",
|
|
44
|
-
"url": "git+https://github.com/gradientlabs-ai/nodejs
|
|
44
|
+
"url": "git+https://github.com/gradientlabs-ai/gradientlabs-nodejs.git"
|
|
45
45
|
},
|
|
46
|
-
"homepage": "https://github.com/gradientlabs-ai/nodejs
|
|
46
|
+
"homepage": "https://github.com/gradientlabs-ai/gradientlabs-nodejs#readme",
|
|
47
47
|
"bugs": {
|
|
48
|
-
"url": "https://github.com/gradientlabs-ai/nodejs
|
|
48
|
+
"url": "https://github.com/gradientlabs-ai/gradientlabs-nodejs/issues"
|
|
49
49
|
},
|
|
50
50
|
"devDependencies": {
|
|
51
51
|
"@eslint/js": "^9.7.0",
|
|
@@ -55,6 +55,9 @@
|
|
|
55
55
|
"tsup": "^8.2.0",
|
|
56
56
|
"typescript": "^5.5.0",
|
|
57
57
|
"typescript-eslint": "^8.0.0",
|
|
58
|
-
"vitest": "^2.
|
|
58
|
+
"vitest": "^3.2.6"
|
|
59
|
+
},
|
|
60
|
+
"overrides": {
|
|
61
|
+
"esbuild": ">=0.28.1"
|
|
59
62
|
}
|
|
60
63
|
}
|