@cadenya/cadenya 1.0.0 → 1.0.2

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@cadenya/cadenya",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "The official TypeScript SDK for the Cadenya API",
-  "license": "UNLICENSED",
+  "license": "Apache-2.0",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -13,12 +13,21 @@
     }
   },
   "sideEffects": false,
-  "publishConfig": { "access": "public" },
-  "repository": { "type": "git", "url": "https://github.com/cadenya/cadenya-typescript" },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/cadenya/cadenya-typescript"
+  },
   "engines": {
     "node": ">=18"
   },
-  "files": ["dist", "src", "api.md"],
+  "files": [
+    "dist",
+    "src",
+    "api.md"
+  ],
   "scripts": {
     "build": "tsc",
     "typecheck": "tsc --noEmit"

package/src/client.ts

@@ -85,7 +85,7 @@ export class Cadenya {
       authHeader: () => ({ Authorization: `Bearer ${apiKey}` }),
       maxRetries: options.maxRetries ?? 0,
       timeout: options.timeout,
-      defaultHeaders: { 'User-Agent': 'cadenya-typescript/1.0.0 (api 1.0)', ...options.defaultHeaders },
+      defaultHeaders: { 'User-Agent': 'cadenya-typescript/1.0.1 (api 1.0)', ...options.defaultHeaders },
       fetch: options.fetch,
       logger: options.logger,
       logLevel: options.logLevel,

package/src/resources/objectives.ts

@@ -144,9 +144,12 @@ export interface ObjectiveCreateParams {
   subject?: SubjectAssertion;
   /**
    * Parameters forced onto this objective's tool calls. A pinned parameter
-   *  is an overlay on a tool's JSON schema: the parameter is removed from
-   *  what the LLM sees, and its value is always overwritten server-side with
-   *  the pinned value — the model cannot choose a different value for it.
+   *  is removed from the tool schema the LLM sees, and its value is always
+   *  overwritten server-side with the pinned value — the model cannot choose
+   *  a different value for it. By default a pinned key applies to every tool
+   *  with a top-level parameter of the same name; a tool set's overlays
+   *  (ToolSetSpec.overlays) can bind pinned keys to nested paths, differently
+   *  named parameters, or a subset of tools.
    */
   pinnedParameters?: Record<string, string>;
 }
@@ -489,7 +492,7 @@ export class Objectives {
   }
 
   /**
-   * Get objective context diagnostics
+   * Get objective context usage
    * 
    * @example
    * ```ts

package/src/resources/tool-search.ts

@@ -6,9 +6,7 @@ import type { SearchToolsOrToolSetsResponse } from '../types.js';
 export interface ToolSearchSearchOrSetsParams {
   query: string;
   /**
-   * NOTE: `query` is runtime-required (buf.validate min_len), but gnostic
-   *  does not propagate message-level schema `required` to GET query
-   *  parameters — overlay.yaml marks the parameter required instead.
+   * Workspace that contains the tools and tool sets to search.
    * 
    * Defaults to the client-level `workspaceId` option or the CADENYA_WORKSPACE_ID environment variable.
    */

package/src/resources/tools.ts

@@ -40,6 +40,14 @@ export interface ToolListParams {
    *  requiring approval; false = only tools not requiring approval.
    */
   requiresApproval?: boolean;
+  /**
+   * Filter to tools matched by the tool set overlays with these keys
+   *  (ToolSetSpec.overlays), i.e. tools whose info.overlays contains the
+   *  key. Multiple values are OR'd together. Selectors are evaluated
+   *  against every tool in the set to answer this, so total counts reflect
+   *  the filtered set. An unknown overlay key matches nothing.
+   */
+  overlays?: Array<string>;
   /**
    * Filters by metadata labels. Comma-separated key=value pairs,
    *  e.g. "env=prod,team=ai". A resource matches only if every pair
@@ -133,7 +141,7 @@ export class Tools {
     const workspaceId = String(params?.workspaceId ?? this._client.defaults['workspaceId'] ?? '').trim() || undefined;
     if (workspaceId === undefined) throw new Error("Missing 'workspaceId': pass it in params, set it on the client, or set the CADENYA_WORKSPACE_ID environment variable.");
     const _base = snapshotParams(params);
-    const response = await this._client.request<ListToolsResponse>({ method: 'GET', path: `/v1/workspaces/${pathSegment('workspaceId', workspaceId)}/tool_sets/${pathSegment('toolSetId', toolSetId)}/tools`, query: { limit: params?.limit, cursor: params?.cursor, prefix: params?.prefix, query: params?.query, names: params?.names, states: params?.states, requiresApproval: params?.requiresApproval, labels: params?.labels, sortOrder: params?.sortOrder, includeInfo: params?.includeInfo } }, options);
+    const response = await this._client.request<ListToolsResponse>({ method: 'GET', path: `/v1/workspaces/${pathSegment('workspaceId', workspaceId)}/tool_sets/${pathSegment('toolSetId', toolSetId)}/tools`, query: { limit: params?.limit, cursor: params?.cursor, prefix: params?.prefix, query: params?.query, names: params?.names, states: params?.states, requiresApproval: params?.requiresApproval, overlays: params?.overlays, labels: params?.labels, sortOrder: params?.sortOrder, includeInfo: params?.includeInfo } }, options);
     return new Page(response.items ?? [], response.pagination?.nextCursor, (cursor) => this.list(toolSetId, { ..._base, cursor: cursor }, options));
   }