@junejuly-lockstep/sdk 0.2.0 → 0.2.1

package/README.md

@@ -1,12 +1,15 @@
 # @junejuly-lockstep/sdk
 
-A typed `fetch` client for the Lockstep platform API. Two clients:
+A typed `fetch` client for the Lockstep platform API, used by `@junejuly-lockstep/cli`. Three
+clients:
 
-- `createIngestClient` authenticates with a project API key (`lsk_...`, sent as a bearer token) and
-  covers the routes the reconciler uses: presigned uploads, baselines, `POST /api/ingest/runs` and
-  `POST /api/ingest/models`.
-- `createSessionClient` rides the SPA's session cookie and covers the read and judgment API
-  (projects, journeys, board, cards, annotations, ops).
+- `createCheckClient` authenticates with a project API key (`lsk_...`, sent as a bearer token) and
+  covers what `lockstep check` needs: presigned screenshot uploads, `POST /api/ingest/checks` and
+  the intent manifest.
+- `createDeviceClient` runs the CLI device authorization (`lockstep init`): request a code, then
+  poll until a signed-in member approves it and the project API key comes back.
+- `createAgentClient` (project API key) gives coding agents ticket context: the project, tickets,
+  a ticket's context and screens, and linking a pull request, comments and agent runs to a ticket.
 
 Every response is validated with the `@junejuly-lockstep/model` schemas before it is returned; failures
 surface as `LockstepApiError` (HTTP status and body) or `LockstepNetworkError` (retries exhausted).
@@ -21,16 +24,16 @@ pnpm add @junejuly-lockstep/sdk @junejuly-lockstep/model
 ## Usage
 
 ```ts
-import { createIngestClient, LockstepApiError } from '@junejuly-lockstep/sdk';
+import { createAgentClient, LockstepApiError } from '@junejuly-lockstep/sdk';
 
-const ingest = createIngestClient({
+const agent = createAgentClient({
   baseUrl: 'https://api.lockstep.example',
   apiKey: process.env.LOCKSTEP_API_KEY!,
 });
 
 try {
-  const baselines = await ingest.getBaselines('FERN');
-  console.log(`${baselines.entries.length} approved baselines`);
+  const tickets = await agent.listTickets(['todo', 'in_progress']);
+  console.log(`${tickets.length} open tickets`);
 } catch (err) {
   if (err instanceof LockstepApiError) console.error(err.status, err.message);
   else throw err;
@@ -38,7 +41,7 @@ try {
 ```
 
 `@junejuly-lockstep/sdk/testing` exports `fakeFetch`, a recording `fetch` double for unit tests of code that
-uses either client.
+uses any client.
 
 Published from the [Lockstep monorepo](https://github.com/JuneJulyHealth/lockstep)
-(`packages/sdk`). Versioned in lockstep with `@junejuly-lockstep/model` and `@junejuly-lockstep/reconciler`.
+(`packages/sdk`). Versioned in lockstep with `@junejuly-lockstep/model` and `@junejuly-lockstep/cli`.

package/dist/index.d.ts

@@ -1,8 +1,4 @@
 export { LockstepApiError, LockstepNetworkError } from './errors.js';
-export { createIngestClient, INGEST_ROUTES } from './ingest.js';
-export type { IngestClient, IngestClientOptions } from './ingest.js';
-export { createSessionClient, SESSION_ROUTES } from './session.js';
-export type { ConditionalOptions, JudgmentAction, RunArtifactsResponse, SessionClient, SessionClientOptions, } from './session.js';
 export { AGENT_ROUTES, CHECK_ROUTES, DEVICE_ROUTES, createAgentClient, createCheckClient, createDeviceClient, } from './v2.js';
 export type { AgentClient, ApiKeyClientOptions, CheckClient, DeviceClient, DeviceClientOptions, } from './v2.js';
 export { joinUrl, DEFAULT_RETRY } from './http.js';

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,oBAAoB,EAAE,MAAM,aAAa,CAAC;AACrE,OAAO,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAChE,YAAY,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AACrE,OAAO,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AACnE,YAAY,EACV,kBAAkB,EAClB,cAAc,EACd,oBAAoB,EACpB,aAAa,EACb,oBAAoB,GACrB,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,YAAY,EACZ,YAAY,EACZ,aAAa,EACb,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,GACnB,MAAM,SAAS,CAAC;AACjB,YAAY,EACV,WAAW,EACX,mBAAmB,EACnB,WAAW,EACX,YAAY,EACZ,mBAAmB,GACpB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AACnD,YAAY,EAAE,WAAW,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AACrE,OAAO,EACL,YAAY,EACZ,YAAY,EACZ,aAAa,EACb,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,GACnB,MAAM,SAAS,CAAC;AACjB,YAAY,EACV,WAAW,EACX,mBAAmB,EACnB,WAAW,EACX,YAAY,EACZ,mBAAmB,GACpB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AACnD,YAAY,EAAE,WAAW,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC"}

package/dist/index.js

@@ -1,6 +1,4 @@
 export { LockstepApiError, LockstepNetworkError } from './errors.js';
-export { createIngestClient, INGEST_ROUTES } from './ingest.js';
-export { createSessionClient, SESSION_ROUTES } from './session.js';
 export { AGENT_ROUTES, CHECK_ROUTES, DEVICE_ROUTES, createAgentClient, createCheckClient, createDeviceClient, } from './v2.js';
 export { joinUrl, DEFAULT_RETRY } from './http.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AACrE,OAAO,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAEhE,OAAO,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAQnE,OAAO,EACL,YAAY,EACZ,YAAY,EACZ,aAAa,EACb,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,GACnB,MAAM,SAAS,CAAC;AAQjB,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AACrE,OAAO,EACL,YAAY,EACZ,YAAY,EACZ,aAAa,EACb,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,GACnB,MAAM,SAAS,CAAC;AAQjB,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@junejuly-lockstep/sdk",
-  "version": "0.2.0",
-  "description": "Typed fetch client for the Lockstep platform: v2 check ingest, CLI device authorization and agent (ticket) clients, plus the v1 ingest and session read APIs.",
+  "version": "0.2.1",
+  "description": "Typed fetch client for the Lockstep platform: check ingest, CLI device authorization and agent (ticket) clients.",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -45,14 +45,14 @@
   },
   "dependencies": {
     "zod": "^3.24.1",
-    "@junejuly-lockstep/model": "0.2.0"
+    "@junejuly-lockstep/model": "0.2.1"
   },
   "devDependencies": {
     "typescript": "^5.7.2",
     "vitest": "^2.1.8"
   },
   "scripts": {
-    "build": "tsc -p tsconfig.json",
+    "build": "node -e \"for (const p of ['dist','tsconfig.tsbuildinfo']) require('node:fs').rmSync(p,{recursive:true,force:true})\" && tsc -p tsconfig.json",
     "typecheck": "tsc -p tsconfig.typecheck.json --noEmit",
     "lint": "eslint src",
     "test": "vitest run"

package/dist/ingest.d.ts

@@ -1,32 +0,0 @@
-import { BaselineManifest, IngestRunResponse, ModelSyncPayload, ModelSyncResponse, PresignRequest, PresignResponse, RunPayload } from '@junejuly-lockstep/model';
-import { type FetchLike, type RetryPolicy } from './http.js';
-export interface IngestClientOptions {
-    /** Platform API origin, e.g. https://api.lockstep.example */
-    baseUrl: string;
-    /** Project API key, `lsk_...`. Sent as `Authorization: Bearer`. */
-    apiKey: string;
-    fetch?: FetchLike;
-    retry?: Partial<RetryPolicy>;
-}
-/** Routes the reconciler uses. Kept in one place so the API can be reconciled against them. */
-export declare const INGEST_ROUTES: {
-    readonly presign: "/api/ingest/presign";
-    readonly runs: "/api/ingest/runs";
-    readonly baselines: "/api/ingest/baselines";
-    readonly models: "/api/ingest/models";
-};
-export interface IngestClient {
-    /** POST /api/ingest/presign: batch presigned PUT URLs (max 50 files per call). */
-    presign(req: PresignRequest): Promise<PresignResponse>;
-    /** GET /api/ingest/baselines?project=KEY: current approved baselines with presigned GET URLs. */
-    getBaselines(projectKey: string): Promise<BaselineManifest>;
-    /** POST /api/ingest/runs: the complete run payload. */
-    postRun(payload: RunPayload): Promise<IngestRunResponse>;
-    /**
-     * POST /api/ingest/models: parsed journey models and scenarios at a commit (M3 model sync, run
-     * by `lockstep sync-models` in client CI on push; the platform never evaluates journey files).
-     */
-    syncModels(payload: ModelSyncPayload): Promise<ModelSyncResponse>;
-}
-export declare function createIngestClient(options: IngestClientOptions): IngestClient;
-//# sourceMappingURL=ingest.d.ts.map

package/dist/ingest.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ingest.d.ts","sourceRoot":"","sources":["../src/ingest.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,UAAU,EACX,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAc,KAAK,SAAS,EAAE,KAAK,WAAW,EAAE,MAAM,WAAW,CAAC;AAEzE,MAAM,WAAW,mBAAmB;IAClC,6DAA6D;IAC7D,OAAO,EAAE,MAAM,CAAC;IAChB,mEAAmE;IACnE,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,KAAK,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;CAC9B;AAED,+FAA+F;AAC/F,eAAO,MAAM,aAAa;;;;;CAKhB,CAAC;AAEX,MAAM,WAAW,YAAY;IAC3B,kFAAkF;IAClF,OAAO,CAAC,GAAG,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IACvD,iGAAiG;IACjG,YAAY,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC5D,uDAAuD;IACvD,OAAO,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACzD;;;OAGG;IACH,UAAU,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;CACnE;AAED,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,mBAAmB,GAAG,YAAY,CAiD7E"}

package/dist/ingest.js

@@ -1,60 +0,0 @@
-import { BaselineManifest, IngestRunResponse, ModelSyncPayload, ModelSyncResponse, PresignRequest, PresignResponse, RunPayload, } from '@junejuly-lockstep/model';
-import { createHttp } from './http.js';
-/** Routes the reconciler uses. Kept in one place so the API can be reconciled against them. */
-export const INGEST_ROUTES = {
-    presign: '/api/ingest/presign',
-    runs: '/api/ingest/runs',
-    baselines: '/api/ingest/baselines',
-    models: '/api/ingest/models',
-};
-export function createIngestClient(options) {
-    if (!options.apiKey)
-        throw new Error('createIngestClient: apiKey is required');
-    if (!options.apiKey.startsWith('lsk_')) {
-        throw new Error('createIngestClient: apiKey must be a project key starting with lsk_');
-    }
-    const http = createHttp({
-        baseUrl: options.baseUrl,
-        fetch: options.fetch,
-        retry: options.retry,
-        headers: { authorization: `Bearer ${options.apiKey}` },
-    });
-    return {
-        async presign(req) {
-            const body = PresignRequest.parse(req);
-            return http.request({
-                method: 'POST',
-                path: INGEST_ROUTES.presign,
-                body,
-                schema: PresignResponse,
-            });
-        },
-        async getBaselines(projectKey) {
-            return http.request({
-                method: 'GET',
-                path: INGEST_ROUTES.baselines,
-                query: { project: projectKey },
-                schema: BaselineManifest,
-            });
-        },
-        async postRun(payload) {
-            const body = RunPayload.parse(payload);
-            return http.request({
-                method: 'POST',
-                path: INGEST_ROUTES.runs,
-                body,
-                schema: IngestRunResponse,
-            });
-        },
-        async syncModels(payload) {
-            const body = ModelSyncPayload.parse(payload);
-            return http.request({
-                method: 'POST',
-                path: INGEST_ROUTES.models,
-                body,
-                schema: ModelSyncResponse,
-            });
-        },
-    };
-}
-//# sourceMappingURL=ingest.js.map

package/dist/ingest.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ingest.js","sourceRoot":"","sources":["../src/ingest.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,UAAU,GACX,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,UAAU,EAAoC,MAAM,WAAW,CAAC;AAWzE,+FAA+F;AAC/F,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,OAAO,EAAE,qBAAqB;IAC9B,IAAI,EAAE,kBAAkB;IACxB,SAAS,EAAE,uBAAuB;IAClC,MAAM,EAAE,oBAAoB;CACpB,CAAC;AAgBX,MAAM,UAAU,kBAAkB,CAAC,OAA4B;IAC7D,IAAI,CAAC,OAAO,CAAC,MAAM;QAAE,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;IAC/E,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QACvC,MAAM,IAAI,KAAK,CAAC,qEAAqE,CAAC,CAAC;IACzF,CAAC;IACD,MAAM,IAAI,GAAG,UAAU,CAAC;QACtB,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,OAAO,EAAE,EAAE,aAAa,EAAE,UAAU,OAAO,CAAC,MAAM,EAAE,EAAE;KACvD,CAAC,CAAC;IAEH,OAAO;QACL,KAAK,CAAC,OAAO,CAAC,GAAG;YACf,MAAM,IAAI,GAAG,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACvC,OAAO,IAAI,CAAC,OAAO,CAAC;gBAClB,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,aAAa,CAAC,OAAO;gBAC3B,IAAI;gBACJ,MAAM,EAAE,eAAe;aACxB,CAAC,CAAC;QACL,CAAC;QACD,KAAK,CAAC,YAAY,CAAC,UAAU;YAC3B,OAAO,IAAI,CAAC,OAAO,CAAC;gBAClB,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,aAAa,CAAC,SAAS;gBAC7B,KAAK,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE;gBAC9B,MAAM,EAAE,gBAAgB;aACzB,CAAC,CAAC;QACL,CAAC;QACD,KAAK,CAAC,OAAO,CAAC,OAAO;YACnB,MAAM,IAAI,GAAG,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACvC,OAAO,IAAI,CAAC,OAAO,CAAC;gBAClB,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,aAAa,CAAC,IAAI;gBACxB,IAAI;gBACJ,MAAM,EAAE,iBAAiB;aAC1B,CAAC,CAAC;QACL,CAAC;QACD,KAAK,CAAC,UAAU,CAAC,OAAO;YACtB,MAAM,IAAI,GAAG,gBAAgB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAC7C,OAAO,IAAI,CAAC,OAAO,CAAC;gBAClB,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,aAAa,CAAC,MAAM;gBAC1B,IAAI;gBACJ,MAAM,EAAE,iBAAiB;aAC1B,CAAC,CAAC;QACL,CAAC;KACF,CAAC;AACJ,CAAC"}