@deepraxis/sdk 0.1.1-dev.d3030b1 → 0.1.1-dev.d38b647

package/METHODS.md

@@ -1,6 +1,6 @@
 # SDK methods
 
-Generated by `bun run generate`. 619 HTTP operations, plus product aliases. Version segments and path parameters are omitted from resource names. Inputs use typed `{ path, query, body, headers }` options. Collections form nested resource objects; POST actions retain their verb. Naming rules are documented in `scripts/resources.ts`; semantic exceptions and aliases with reasons are in `scripts/naming-overrides.ts`.
+Generated by `bun run generate`. 677 HTTP operations, plus product aliases. Version segments and path parameters are omitted from resource names. Inputs use typed `{ path, query, body, headers }` options. Collections form nested resource objects; POST actions retain their verb. Naming rules are documented in `scripts/resources.ts`; semantic exceptions and aliases with reasons are in `scripts/naming-overrides.ts`.
 
 `always` returns an AsyncIterable; `optional` streams with `{ stream: true }`; `yes` pagination returns a Page. Only `{ data, next_cursor }` + `cursor` query contracts are automatically paginated.
 
@@ -576,9 +576,11 @@ Multipart request bodies expand plain objects into bracketed fields (for example
 | Method | HTTP | Path | Streaming | Pagination |
 |---|---|---|---|---|
 | create | POST | `/browser/v1/sessions` | no | no |
+| frames | GET | `/browser/v1/sessions/{sessionId}/frames` | always | no |
 | list | GET | `/browser/v1/sessions` | no | no |
 | retrieve | GET | `/browser/v1/sessions/{sessionId}` | no | no |
 | retrieveDebug | GET | `/browser/v1/sessions/{sessionId}/debug` | no | no |
+| retrieveFrame | GET | `/browser/v1/sessions/{sessionId}/frame` | no | no |
 | stream | GET | `/browser/v1/sessions/{sessionId}/stream` | always | no |
 | update | POST | `/browser/v1/sessions/{sessionId}` | no | no |
 
@@ -878,12 +880,78 @@ Multipart request bodies expand plain objects into bracketed fields (for example
 
 ## devops
 
+### devops.environments.checkpoints
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| list | GET | `/devops/v1/environments/{id}/checkpoints` | no | no |
+
+### devops.flags
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| archive | POST | `/devops/v1/flags/{id}:archive` | no | no |
+| conclude | POST | `/devops/v1/flags/{id}:conclude` | no | no |
+| retrieve | GET | `/devops/v1/flags/{id}` | no | no |
+| update | PATCH | `/devops/v1/flags/{id}` | no | no |
+
+### devops.flags.environments
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| update | PATCH | `/devops/v1/flags/{id}/environments/{environment}` | no | no |
+
+### devops.progressiveRollouts
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| create | POST | `/devops/v1/progressive-rollouts` | no | no |
+| pause | POST | `/devops/v1/progressive-rollouts/{id}:pause` | no | no |
+| resume | POST | `/devops/v1/progressive-rollouts/{id}:resume` | no | no |
+| retrieve | GET | `/devops/v1/progressive-rollouts/{id}` | no | no |
+| rollback | POST | `/devops/v1/progressive-rollouts/{id}:rollback` | no | no |
+
 ### devops.projects
 
 | Method | HTTP | Path | Streaming | Pagination |
 |---|---|---|---|---|
+| list | GET | `/devops/v1/projects` | no | no |
+| retrieve | GET | `/devops/v1/projects/{id}` | no | no |
 | retrieveTestCatalog | GET | `/devops/v1/projects/{project}/test-catalog` | no | no |
 
+### devops.projects.environments
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| list | GET | `/devops/v1/projects/{project}/environments` | no | no |
+
+### devops.projects.flags
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| create | POST | `/devops/v1/projects/{project}/flags` | no | no |
+| list | GET | `/devops/v1/projects/{project}/flags` | no | no |
+
+### devops.projects.promotions
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| list | GET | `/devops/v1/projects/{project}/promotions` | no | no |
+
+### devops.projects.releases
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| create | POST | `/devops/v1/projects/{project}/releases` | no | no |
+| list | GET | `/devops/v1/projects/{project}/releases` | no | no |
+
+### devops.projects.targets
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| list | GET | `/devops/v1/projects/{project}/targets` | no | no |
+| refresh | POST | `/devops/v1/projects/{project}/targets:refresh` | no | no |
+
 ### devops.projects.testCases
 
 | Method | HTTP | Path | Streaming | Pagination |
@@ -916,6 +984,36 @@ Multipart request bodies expand plain objects into bracketed fields (for example
 |---|---|---|---|---|
 | list | GET | `/devops/v1/projects/{project}/test-suites` | no | no |
 
+### devops.promotions
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| approve | POST | `/devops/v1/promotions/{id}:approve` | no | no |
+| cancel | POST | `/devops/v1/promotions/{id}:cancel` | no | no |
+| conclude | POST | `/devops/v1/promotions/{id}:conclude` | no | no |
+| create | POST | `/devops/v1/promotions` | no | no |
+| retrieve | GET | `/devops/v1/promotions/{id}` | no | no |
+| retry | POST | `/devops/v1/promotions/{id}:retry` | no | no |
+
+### devops.promotions.rollouts
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| list | GET | `/devops/v1/promotions/{promotion}/rollouts` | no | no |
+
+### devops.releases
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| abandon | POST | `/devops/v1/releases/{id}:abandon` | no | no |
+| retrieve | GET | `/devops/v1/releases/{id}` | no | no |
+
+### devops.rollouts
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| retrieve | GET | `/devops/v1/rollouts/{id}` | no | no |
+
 ### devops.testCases
 
 | Method | HTTP | Path | Streaming | Pagination |
@@ -1068,12 +1166,25 @@ Multipart request bodies expand plain objects into bracketed fields (for example
 
 ## media
 
+### media.assets
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| edit | POST | `/media/v1/libraries/{library_id}/assets/{asset_id}/edits` | no | no |
+| lineage | GET | `/media/v1/libraries/{library_id}/assets/{asset_id}/lineage` | no | no |
+
 ### media.generation.capabilities
 
 | Method | HTTP | Path | Streaming | Pagination |
 |---|---|---|---|---|
 | list | GET | `/media/v1/generation/capabilities` | no | no |
 
+### media.images
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| generate | POST | `/media/v1/libraries/{library_id}/images/generations` | no | no |
+
 ### media.libraries
 
 | Method | HTTP | Path | Streaming | Pagination |
@@ -1083,6 +1194,8 @@ Multipart request bodies expand plain objects into bracketed fields (for example
 | list | GET | `/media/v1/libraries` | no | yes |
 | restore | POST | `/media/v1/libraries/{library_id}/restore` | no | no |
 | retrieve | GET | `/media/v1/libraries/{library_id}` | no | no |
+| retrieveDefault | GET | `/media/v1/libraries/default` | no | no |
+| setDefault | PUT | `/media/v1/libraries/default` | no | no |
 | update | PATCH | `/media/v1/libraries/{library_id}` | no | no |
 
 ### media.libraries.assets
@@ -1145,12 +1258,6 @@ Multipart request bodies expand plain objects into bracketed fields (for example
 |---|---|---|---|---|
 | list | GET | `/media/v1/libraries/{library_id}/folders` | no | no |
 
-### media.libraries.generations
-
-| Method | HTTP | Path | Streaming | Pagination |
-|---|---|---|---|---|
-| create | POST | `/media/v1/libraries/{library_id}/generations` | no | no |
-
 ### media.libraries.jobs
 
 | Method | HTTP | Path | Streaming | Pagination |
@@ -1159,12 +1266,6 @@ Multipart request bodies expand plain objects into bracketed fields (for example
 | list | GET | `/media/v1/libraries/{library_id}/jobs` | no | yes |
 | retrieve | GET | `/media/v1/libraries/{library_id}/jobs/{job_id}` | no | no |
 
-### media.libraries.jobs.outputs.save
-
-| Method | HTTP | Path | Streaming | Pagination |
-|---|---|---|---|---|
-| create | POST | `/media/v1/libraries/{library_id}/jobs/{job_id}/outputs/{index}/save` | no | no |
-
 ### media.libraries.purge
 
 | Method | HTTP | Path | Streaming | Pagination |
@@ -1202,6 +1303,18 @@ Multipart request bodies expand plain objects into bracketed fields (for example
 | list | GET | `/media/v1/libraries/{library_id}/understandings` | no | yes |
 | retrieveFailureSummary | GET | `/media/v1/libraries/{library_id}/understandings/failure_summary` | no | no |
 
+### media.speech
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| create | POST | `/media/v1/libraries/{library_id}/audio/speech` | no | no |
+
+### media.videos
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| generate | POST | `/media/v1/libraries/{library_id}/videos/generations` | no | no |
+
 ## meta
 
 ### meta.docs
@@ -1366,6 +1479,7 @@ Multipart request bodies expand plain objects into bracketed fields (for example
 | create | POST | `/ontology/v1/nodes` | no | no |
 | list | GET | `/ontology/v1/nodes` | no | yes |
 | retrieve | GET | `/ontology/v1/nodes/{node_id}` | no | no |
+| retrieveNeighborhood | GET | `/ontology/v1/nodes/{node_id}/neighborhood` | no | no |
 | update | PATCH | `/ontology/v1/nodes/{node_id}` | no | no |
 
 ### ontology.nodes.merge
@@ -1458,6 +1572,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
 
 ## sandbox
 
+### sandbox.events.sandboxes
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| retrieve | GET | `/sandbox/v1/events/sandboxes/{sandboxID}` | no | no |
+
 ### sandbox.sandboxes
 
 | Method | HTTP | Path | Streaming | Pagination |
@@ -1634,6 +1754,13 @@ Multipart request bodies expand plain objects into bracketed fields (for example
 | list | GET | `/studio/v1/platforms` | no | no |
 | retrieve | GET | `/studio/v1/platforms/{platform}` | no | no |
 
+### studio.reviewers
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| list | GET | `/studio/v1/reviewers` | no | no |
+| update | PATCH | `/studio/v1/reviewers/{agent}` | no | no |
+
 ### studio.styles
 
 | Method | HTTP | Path | Streaming | Pagination |
@@ -1687,6 +1814,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
 | retrieveReview | GET | `/studio/v1/works/{work}/drafts/{draft}/review` | no | no |
 | update | PATCH | `/studio/v1/works/{work}/drafts/{draft}` | no | no |
 
+### studio.works.drafts.renditions
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| create | POST | `/studio/v1/works/{work}/drafts/{draft}/renditions` | no | no |
+
 ### studio.works.drafts.status
 
 | Method | HTTP | Path | Streaming | Pagination |
@@ -1701,6 +1834,35 @@ Multipart request bodies expand plain objects into bracketed fields (for example
 | batchUpdate | POST | `/studio/v1/works/{work}/drafts/{draft}/units:batchUpdate` | no | no |
 | create | POST | `/studio/v1/works/{work}/drafts/{draft}/units` | no | no |
 
+### studio.works.renditions
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| delete | DELETE | `/studio/v1/works/{work}/renditions/{rendition}` | no | no |
+| list | GET | `/studio/v1/works/{work}/renditions` | no | no |
+| publish | POST | `/studio/v1/works/{work}/renditions/{rendition}:publish` | no | no |
+| render | POST | `/studio/v1/works/{work}/renditions/{rendition}:render` | no | no |
+| retrieve | GET | `/studio/v1/works/{work}/renditions/{rendition}` | no | no |
+| retrieveContent | GET | `/studio/v1/works/{work}/renditions/{rendition}/content` | no | no |
+| update | PATCH | `/studio/v1/works/{work}/renditions/{rendition}` | no | no |
+
+### studio.works.reviewSettings
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| retrieve | GET | `/studio/v1/works/{work}/review-settings` | no | no |
+| update | PATCH | `/studio/v1/works/{work}/review-settings` | no | no |
+
+### studio.works.reviews
+
+| Method | HTTP | Path | Streaming | Pagination |
+|---|---|---|---|---|
+| appeal | POST | `/studio/v1/works/{work}/reviews/{review}:appeal` | no | no |
+| cancel | POST | `/studio/v1/works/{work}/reviews/{review}:cancel` | no | no |
+| create | POST | `/studio/v1/works/{work}/reviews` | no | no |
+| list | GET | `/studio/v1/works/{work}/reviews` | no | no |
+| retrieve | GET | `/studio/v1/works/{work}/reviews/{review}` | no | no |
+
 ### studio.works.units
 
 | Method | HTTP | Path | Streaming | Pagination |
@@ -1764,6 +1926,7 @@ Multipart request bodies expand plain objects into bracketed fields (for example
 | Method | HTTP | Path | Streaming | Pagination |
 |---|---|---|---|---|
 | list | GET | `/ticket/v1/repositories` | no | no |
+| update | PATCH | `/ticket/v1/repositories/{id}` | no | no |
 
 ### ticket.tickets
 
@@ -1955,11 +2118,19 @@ Multipart request bodies expand plain objects into bracketed fields (for example
 | crm.properties.archive | CRM DELETE archives the resource rather than permanently deleting it; expose the archive product verb. |
 | database.databases.rest.create | The final parameter identifies a table collection; POST inserts rows rather than updating the table. |
 | file.uploads.createSigned | Signed upload creation returns a one-time local PUT URL; ADR-039 names this operation uploads.createSigned. |
+| media.libraries.retrieveDefault | ADR-094 §9 names the default-library read libraries.retrieveDefault; the URL names a reference rather than an id, so the path-derived name would otherwise read as retrieving a library called default. |
+| media.libraries.setDefault | ADR-094 §9 names the default-library write libraries.setDefault; the URL has no library id because the organization owns one default library, so the path alone cannot say which. |
+| media.assets.edit | ADR-094 §9 names the edit write assets.edit; an edit acts on the addressed asset and returns a Job, so the URL nesting under a library is a mount rather than an SDK resource level. |
+| media.assets.lineage | ADR-094 §9 names the edit-tree read assets.lineage; lineage is the product verb and the URL nesting under a library is a mount, not an SDK resource level. |
+| media.speech.create | ADR-094 §1/§9 names speech synthesis speech.create; the URL says audio/speech because that is the artifact the caller gets back, and the path alone would derive a speech collection create under an audio level that is not an SDK resource. |
+| media.images.generate | ADR-094 §9 names image generation images.generate; the URL mounts it under a library, but generation is an operation on images and the path alone would derive a generations collection create. |
+| media.videos.generate | ADR-094 §2/§9 names video generation videos.generate beside images.generate; the URL mounts it under a library, but generation is an operation on videos and the path alone would derive a generations collection create. The unqualified videos resource is the video lane, distinct from the batch and legacy job resources. |
 | meta.docs.search | Documentation keyword search is an operation on docs, not a nested collection. |
 | sandbox.sandboxes.commands.run | Sandbox data operations use the E2B SDK verb while preserving URL resource nesting. |
 | sandbox.sandboxes.files.remove | Sandbox data operations use the E2B SDK verb while preserving URL resource nesting. |
 | sandbox.sandboxes.files.read | Sandbox data operations use the E2B SDK verb while preserving URL resource nesting. |
 | sandbox.sandboxes.files.write | Sandbox data operations use the E2B SDK verb while preserving URL resource nesting. |
+| studio.works.reviewSettings.retrieve | A work has one review-settings singleton; the segment ends in s only because English writes it that way, so the collection rule would derive reviewSettings.list for a read that returns the settings object itself. |
 | vault.oauth.retrieveClientMetadata | The literal .json filename otherwise introduces a dot inside a method identifier. |
 
 ## SDK parameter aliases

package/README.md

@@ -33,7 +33,7 @@ console.log(completion.choices[0]?.message.content);
 ## Why this SDK
 
 - **The whole platform, one client.** About 350 operations across models, agents, sandboxes,
-  cloud browsers, web search, databases, knowledge bases, files, media, automation and hosted
+  browsers, web search, databases, knowledge bases, files, media, automation and hosted
   applications, generated from the same contract as the API.
 - **Types from the contract.** Every path, query, body and response is typed, including the
   events of each stream, so your editor knows what comes back.
@@ -122,7 +122,7 @@ conversation with it, on its own machine.
 ```ts
 const { sandboxes } = praxis.sandbox;
 const sandbox = await sandboxes.create({
-  body: { templateID: 'base' },
+  body: { templateID: 'base', autoPause: false }, // ends at its timeout; autoPause: true keeps a long-lived computer
 });
 const result = await sandboxes.commands.run({
   path: { sandbox_id: sandbox.sandboxID },

package/dist/core/credentials.d.ts

@@ -1,7 +1,9 @@
 /**
- * Default credential chain for code running on a Praxis computer (ticket-5367):
- * PRAXIS_API_TOKEN environment variable, then ~/.praxis/credentials. Resolved at call time so a
- * token the platform renewed in the file is picked up by an already-running process.
+ * Default credential chain for code running on a Praxis computer (ticket-5367, ADR-098 §2):
+ * the PRAXIS_API_TOKEN environment variable, then the login file of the environment,
+ * `~/.praxis/cli/<env>.json` — the one file `praxis login` writes for a person and the platform writes
+ * for a managed login. Resolved at call time so a token the platform renewed in the file is picked up
+ * by an already-running process.
  */
 export interface ResolvedCredentials {
     token?: string;
@@ -9,6 +11,13 @@ export interface ResolvedCredentials {
 }
 type Env = Record<string, string | undefined>;
 type ReadFile = (path: string) => string | null;
+/**
+ * Which environment's login file applies: PRAXIS_ENV when it names one, otherwise a `-develop.` host in
+ * PRAXIS_API_URL means develop and any other host production — the rule apps/cli/src/config/env.ts
+ * applies. A PRAXIS_ENV that is not a plain name is no environment at all and is ignored. Pure.
+ */
+export declare function credentialsEnv(env: Env): string;
+/** The one login file, the same path the CLI reads for this environment. Null without a home directory. Pure. */
 export declare function credentialsPath(env: Env): string | null;
 export declare function resolveDefaultCredentials(env?: Env, readFile?: ReadFile): ResolvedCredentials;
 export {};

package/dist/core/credentials.js

@@ -8,9 +8,29 @@ function defaultReadFile(path) {
         return null;
     }
 }
+/**
+ * Which environment's login file applies: PRAXIS_ENV when it names one, otherwise a `-develop.` host in
+ * PRAXIS_API_URL means develop and any other host production — the rule apps/cli/src/config/env.ts
+ * applies. A PRAXIS_ENV that is not a plain name is no environment at all and is ignored. Pure.
+ */
+export function credentialsEnv(env) {
+    const declared = nonEmpty(env.PRAXIS_ENV);
+    if (declared && /^[A-Za-z0-9_-]+$/.test(declared))
+        return declared;
+    const apiUrl = nonEmpty(env.PRAXIS_API_URL);
+    if (apiUrl) {
+        try {
+            if (new URL(apiUrl).hostname.includes('-develop.'))
+                return 'develop';
+        }
+        catch { /* a malformed URL is not evidence of develop */ }
+    }
+    return 'production';
+}
+/** The one login file, the same path the CLI reads for this environment. Null without a home directory. Pure. */
 export function credentialsPath(env) {
     const home = nonEmpty(env.HOME) ?? nonEmpty(env.USERPROFILE);
-    return home ? `${home.replace(/\/$/, '')}/.praxis/credentials` : null;
+    return home ? `${home.replace(/[/\\]+$/, '')}/.praxis/cli/${credentialsEnv(env)}.json` : null;
 }
 export function resolveDefaultCredentials(env = globalThis.process?.env ?? {}, readFile = defaultReadFile) {
     const envToken = nonEmpty(env.PRAXIS_API_TOKEN);
@@ -23,7 +43,7 @@ export function resolveDefaultCredentials(env = globalThis.process?.env ?? {}, r
         return envUrl ? { apiUrl: envUrl } : {};
     try {
         const file = JSON.parse(text);
-        const token = nonEmpty(file.token);
+        const token = nonEmpty(file.access_token);
         const apiUrl = envUrl ?? nonEmpty(file.api_url);
         return { ...(token ? { token } : {}), ...(apiUrl ? { apiUrl } : {}) };
     }

package/dist/core/transport.d.ts

@@ -1,6 +1,6 @@
 import { type SSEEvent } from './sse.js';
 export interface PraxisOptions {
-    /** Explicit key. Omitted on a Praxis computer: PRAXIS_API_TOKEN, then ~/.praxis/credentials, are used. */
+    /** Explicit key. Omitted on a Praxis computer: PRAXIS_API_TOKEN, then the login file `~/.praxis/cli/<env>.json`, are used. */
     apiKey?: string;
     baseUrl?: string;
     timeoutMs?: number;