@nirmos/sdk 0.3.3 → 0.3.4

package/README.md

@@ -1,5 +1,7 @@
 # Nirmos TypeScript SDK
 
+Documentation and offline checks target SDK **0.3.3**.
+
 One client for Nirmos management and AI execution. Works in modern browsers and Node 18+ with ESM/CommonJS; no runtime dependencies.
 
 ```bash
@@ -38,7 +40,7 @@ const nirmos = new Nirmos({
 
 This sends credentials include; JavaScript never reads the HttpOnly cookie. The first-party dashboard uses the API execution bridge for host-only cookies. Server API-key clients call runtime directly. `auth: {type: "access-token", token}` sends Bearer authorization where backend session/token authentication supports it. No token issuance or OAuth application management is included.
 
-Management resources include organizations/members/invitations, users/workspace, apiKeys, providers/models/providerCredentials, prompts/branches/versions, routes, endpoints, evaluations/configuration/reviews, knowledge/documents/vectorStores, logs/traces/observability. Types derive from public REST DTOs, never Prisma. Resources only expose implemented contracts; applications/environments/limits do not currently have dashboard CRUD APIs.
+Management resources include organizations/members/invitations, users/workspace, apiKeys, providers/models/providerCredentials, prompts/branches/versions, routes, endpoints, evaluations/configuration/reviews, knowledge/documents/vectorStores, logs/traces/observability. Types derive from public REST DTOs, never Prisma. Resources expose declared endpoint contracts; consult feature guides for verified execution and known limitations. Applications/environments/limits do not currently have dashboard CRUD APIs.
 
 ```ts
 await nirmos.prompts.versions.publish(prompt.promptId, "version-id");
@@ -364,3 +366,24 @@ example into cleanup of its disposable space.
 Memory management uses `apiBaseUrl`; execution uses `runtimeBaseUrl`. Ingestion is
 explicit. Automatic gateway memory capture and autonomous maintenance are not
 implemented. See the public Memory guide and generated reference for all methods.
+
+
+## Repository verification
+
+From the monorepo root, use Node 24+ and pnpm 9:
+
+```sh
+pnpm --filter @nirmos/sdk build
+pnpm --filter @nirmos/sdk test
+pnpm docs:sdk:check
+node --test apps/web/scripts/sdk/docs-examples.test.mjs
+```
+
+These checks use local/injected responses, with no provider quota. See the public
+installation and evaluation guides for complete environment, run and cleanup
+instructions. `evaluations.traceCandidates()` exposes public request IDs and
+eligibility metadata. Runtime can retain normalized non-streaming chat bodies with operator opt-in
+(`REQUEST_LOG_STORE_PAYLOADS=true`, default false). Use Gateway
+`response.metadata.requestId` with `datasets.importTrace({ requestLogId, ... })`.
+See [runnable trace example](examples/evaluation-trace-import.ts) for bounded
+persistence polling, required JSON columns, eligibility errors and cleanup.

package/dist/cjs/core/version.js

@@ -2,5 +2,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
 // Generated from package.json by scripts/generate-version.mjs.
-exports.SDK_VERSION = "0.3.3";
+exports.SDK_VERSION = "0.3.4";
 //# sourceMappingURL=version.js.map

package/dist/cjs/evaluations/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/cjs/evaluations/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/evaluations/types.ts"],"names":[],"mappings":""}

package/dist/cjs/memory/execution-types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=execution-types.js.map

package/dist/cjs/memory/execution-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"execution-types.js","sourceRoot":"","sources":["../../../src/memory/execution-types.ts"],"names":[],"mappings":""}

package/dist/esm/core/version.d.ts

@@ -1,2 +1,2 @@
-export declare const SDK_VERSION = "0.3.3";
+export declare const SDK_VERSION = "0.3.4";
 //# sourceMappingURL=version.d.ts.map

package/dist/esm/core/version.js

@@ -1,3 +1,3 @@
 // Generated from package.json by scripts/generate-version.mjs.
-export const SDK_VERSION = "0.3.3";
+export const SDK_VERSION = "0.3.4";
 //# sourceMappingURL=version.js.map

package/dist/esm/evaluations/types.d.ts

@@ -0,0 +1,13 @@
+import type { Requests } from "../management/contracts.js";
+/** Built-in evaluator versions are discriminated by type. Configs follow the API schemas. */
+export type EvaluationEvaluatorVersion = Requests["createEvaluatorVersion"];
+export type EvaluationTargetConfig = NonNullable<Requests["createEvaluationColumn"]["target"]>;
+export type EvaluationColumnCreate = Requests["createEvaluationColumn"];
+export type EvaluationInputBinding = NonNullable<NonNullable<EvaluationColumnCreate["config"]>["inputMapping"]>[string];
+export type EvaluationSegmentCriteria = Requests["createSegment"]["criteria"];
+export type EvaluationEvaluatorType = EvaluationEvaluatorVersion["type"];
+export type EvaluationEvaluatorConfig<T extends EvaluationEvaluatorType> = Extract<EvaluationEvaluatorVersion, {
+    type: T;
+}>["config"];
+export type EvaluationExpression = EvaluationEvaluatorConfig<"custom_expression">["expression"];
+//# sourceMappingURL=types.d.ts.map

package/dist/esm/evaluations/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/evaluations/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AAE3D,6FAA6F;AAC7F,MAAM,MAAM,0BAA0B,GAAG,QAAQ,CAAC,wBAAwB,CAAC,CAAC;AAC5E,MAAM,MAAM,sBAAsB,GAAG,WAAW,CAC9C,QAAQ,CAAC,wBAAwB,CAAC,CAAC,QAAQ,CAAC,CAC7C,CAAC;AACF,MAAM,MAAM,sBAAsB,GAAG,QAAQ,CAAC,wBAAwB,CAAC,CAAC;AACxE,MAAM,MAAM,sBAAsB,GAAG,WAAW,CAC9C,WAAW,CAAC,sBAAsB,CAAC,QAAQ,CAAC,CAAC,CAAC,cAAc,CAAC,CAC9D,CAAC,MAAM,CAAC,CAAC;AACV,MAAM,MAAM,yBAAyB,GAAG,QAAQ,CAAC,eAAe,CAAC,CAAC,UAAU,CAAC,CAAC;AAE9E,MAAM,MAAM,uBAAuB,GAAG,0BAA0B,CAAC,MAAM,CAAC,CAAC;AACzE,MAAM,MAAM,yBAAyB,CAAC,CAAC,SAAS,uBAAuB,IACrE,OAAO,CAAC,0BAA0B,EAAE;IAAE,IAAI,EAAE,CAAC,CAAA;CAAE,CAAC,CAAC,QAAQ,CAAC,CAAC;AAC7D,MAAM,MAAM,oBAAoB,GAC9B,yBAAyB,CAAC,mBAAmB,CAAC,CAAC,YAAY,CAAC,CAAC"}

package/dist/esm/evaluations/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/esm/evaluations/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/evaluations/types.ts"],"names":[],"mappings":""}

package/dist/esm/index.d.ts

@@ -10,4 +10,5 @@ export type * from "./management/execution-types.js";
 export type { MemoryPage, MemorySpace, MemoryPolicy, MemoryItem, MemoryEvidence, MemoryRelation, MemoryEmbedding, MemoryItemEntity, MemoryEntity, MemoryProfile, MemoryRun, MemorySpaceCreate, MemorySpaceUpdate, MemoryPolicyCreate, MemoryPolicyUpdate, MemoryItemUpdate, MemorySpaceFilters, MemoryPolicyFilters, MemoryItemFilters, MemoryRunFilters, MemoryType, MemoryStatus, MemoryLayer, MemorySourceType, MemoryMessage, MemoryEvent, MemoryIngestRequest, MemorySearchFilters, MemorySearchRequest, MemoryContextRequest, MemoryResult, MemorySearchResponse, MemoryContextResponse, MemoryIndexingResult, MemoryIngestResponse, MemoryManualRequest, MemoryIndexingConfig, MemoryReindexRequest, MemoryGenerateRequest, MemoryProfileGenerateResponse, MemoryObservationGenerateResponse, } from "./memory/types.js";
 export { managementManifest } from "./management/manifest.js";
 export { extractPromptVariableNames, interpolatePromptVariables, promptVariableValue, validatePromptTemplate, validatePromptVariableValues, validatePromptSettings, } from "./prompts/variables.js";
+export type { EvaluationEvaluatorVersion, EvaluationEvaluatorType, EvaluationEvaluatorConfig, EvaluationExpression, EvaluationTargetConfig, EvaluationColumnCreate, EvaluationInputBinding, EvaluationSegmentCriteria, } from "./evaluations/types.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/esm/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,YAAY,EACV,aAAa,EACb,UAAU,EACV,iBAAiB,EACjB,cAAc,EACd,sBAAsB,EACtB,uBAAuB,EACvB,mBAAmB,EACnB,qBAAqB,EACrB,iBAAiB,EACjB,kBAAkB,GACnB,MAAM,aAAa,CAAC;AAErB,OAAO,EACL,QAAQ,EACR,mBAAmB,EACnB,kBAAkB,EAClB,aAAa,EACb,YAAY,EACZ,WAAW,EACX,aAAa,EACb,qBAAqB,EACrB,iBAAiB,EACjB,cAAc,EACd,mBAAmB,EACnB,WAAW,EACX,WAAW,EACX,YAAY,EACZ,eAAe,GAChB,MAAM,kBAAkB,CAAC;AAE1B,YAAY,EACV,YAAY,EACZ,aAAa,EACb,SAAS,EACT,IAAI,EACJ,eAAe,EACf,cAAc,EACd,KAAK,GACN,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,YAAY,EACV,gBAAgB,EAChB,UAAU,EACV,cAAc,EACd,eAAe,EACf,gBAAgB,EAChB,WAAW,EACX,QAAQ,EACR,eAAe,EACf,SAAS,EACT,qBAAqB,EACrB,iBAAiB,EACjB,YAAY,EACZ,YAAY,EACZ,gBAAgB,EAChB,cAAc,EACd,gBAAgB,EAChB,mBAAmB,EACnB,eAAe,EACf,SAAS,EACT,eAAe,EACf,cAAc,EACd,eAAe,EACf,eAAe,EACf,UAAU,GACX,MAAM,oBAAoB,CAAC;AAE5B,YAAY,EACV,iBAAiB,EACjB,MAAM,EACN,iBAAiB,EACjB,eAAe,EACf,aAAa,EACb,kBAAkB,EAClB,gBAAgB,EAChB,mBAAmB,EACnB,qBAAqB,EACrB,qBAAqB,EACrB,YAAY,EACZ,kBAAkB,EAClB,cAAc,EACd,kBAAkB,EAClB,mBAAmB,EACnB,oBAAoB,EACpB,aAAa,EACb,yBAAyB,EACzB,wBAAwB,EACxB,iBAAiB,EACjB,cAAc,EACd,iBAAiB,GAClB,MAAM,oBAAoB,CAAC;AAE5B,YAAY,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAC9E,mBAAmB,iCAAiC,CAAC;AAErD,YAAY,EACV,UAAU,EACV,WAAW,EACX,YAAY,EACZ,UAAU,EACV,cAAc,EACd,cAAc,EACd,eAAe,EACf,gBAAgB,EAChB,YAAY,EACZ,aAAa,EACb,SAAS,EACT,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,gBAAgB,EAChB,kBAAkB,EAClB,mBAAmB,EACnB,iBAAiB,EACjB,gBAAgB,EAChB,UAAU,EACV,YAAY,EACZ,WAAW,EACX,gBAAgB,EAChB,aAAa,EACb,WAAW,EACX,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,oBAAoB,EACpB,YAAY,EACZ,oBAAoB,EACpB,qBAAqB,EACrB,oBAAoB,EACpB,oBAAoB,EACpB,mBAAmB,EACnB,oBAAoB,EACpB,oBAAoB,EACpB,qBAAqB,EACrB,6BAA6B,EAC7B,iCAAiC,GAClC,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAE9D,OAAO,EACL,0BAA0B,EAC1B,0BAA0B,EAC1B,mBAAmB,EACnB,sBAAsB,EACtB,4BAA4B,EAC5B,sBAAsB,GACvB,MAAM,wBAAwB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,YAAY,EACV,aAAa,EACb,UAAU,EACV,iBAAiB,EACjB,cAAc,EACd,sBAAsB,EACtB,uBAAuB,EACvB,mBAAmB,EACnB,qBAAqB,EACrB,iBAAiB,EACjB,kBAAkB,GACnB,MAAM,aAAa,CAAC;AAErB,OAAO,EACL,QAAQ,EACR,mBAAmB,EACnB,kBAAkB,EAClB,aAAa,EACb,YAAY,EACZ,WAAW,EACX,aAAa,EACb,qBAAqB,EACrB,iBAAiB,EACjB,cAAc,EACd,mBAAmB,EACnB,WAAW,EACX,WAAW,EACX,YAAY,EACZ,eAAe,GAChB,MAAM,kBAAkB,CAAC;AAE1B,YAAY,EACV,YAAY,EACZ,aAAa,EACb,SAAS,EACT,IAAI,EACJ,eAAe,EACf,cAAc,EACd,KAAK,GACN,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,YAAY,EACV,gBAAgB,EAChB,UAAU,EACV,cAAc,EACd,eAAe,EACf,gBAAgB,EAChB,WAAW,EACX,QAAQ,EACR,eAAe,EACf,SAAS,EACT,qBAAqB,EACrB,iBAAiB,EACjB,YAAY,EACZ,YAAY,EACZ,gBAAgB,EAChB,cAAc,EACd,gBAAgB,EAChB,mBAAmB,EACnB,eAAe,EACf,SAAS,EACT,eAAe,EACf,cAAc,EACd,eAAe,EACf,eAAe,EACf,UAAU,GACX,MAAM,oBAAoB,CAAC;AAE5B,YAAY,EACV,iBAAiB,EACjB,MAAM,EACN,iBAAiB,EACjB,eAAe,EACf,aAAa,EACb,kBAAkB,EAClB,gBAAgB,EAChB,mBAAmB,EACnB,qBAAqB,EACrB,qBAAqB,EACrB,YAAY,EACZ,kBAAkB,EAClB,cAAc,EACd,kBAAkB,EAClB,mBAAmB,EACnB,oBAAoB,EACpB,aAAa,EACb,yBAAyB,EACzB,wBAAwB,EACxB,iBAAiB,EACjB,cAAc,EACd,iBAAiB,GAClB,MAAM,oBAAoB,CAAC;AAE5B,YAAY,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAC9E,mBAAmB,iCAAiC,CAAC;AAErD,YAAY,EACV,UAAU,EACV,WAAW,EACX,YAAY,EACZ,UAAU,EACV,cAAc,EACd,cAAc,EACd,eAAe,EACf,gBAAgB,EAChB,YAAY,EACZ,aAAa,EACb,SAAS,EACT,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,gBAAgB,EAChB,kBAAkB,EAClB,mBAAmB,EACnB,iBAAiB,EACjB,gBAAgB,EAChB,UAAU,EACV,YAAY,EACZ,WAAW,EACX,gBAAgB,EAChB,aAAa,EACb,WAAW,EACX,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,oBAAoB,EACpB,YAAY,EACZ,oBAAoB,EACpB,qBAAqB,EACrB,oBAAoB,EACpB,oBAAoB,EACpB,mBAAmB,EACnB,oBAAoB,EACpB,oBAAoB,EACpB,qBAAqB,EACrB,6BAA6B,EAC7B,iCAAiC,GAClC,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAE9D,OAAO,EACL,0BAA0B,EAC1B,0BAA0B,EAC1B,mBAAmB,EACnB,sBAAsB,EACtB,4BAA4B,EAC5B,sBAAsB,GACvB,MAAM,wBAAwB,CAAC;AAEhC,YAAY,EACV,0BAA0B,EAC1B,uBAAuB,EACvB,yBAAyB,EACzB,oBAAoB,EACpB,sBAAsB,EACtB,sBAAsB,EACtB,sBAAsB,EACtB,yBAAyB,GAC1B,MAAM,wBAAwB,CAAC"}