@onesi/genesis 0.2.4 → 0.2.6

package/README.md

@@ -3,7 +3,7 @@
 The TypeScript SDK for OneOS. One typed client for every Genesis service, through the Genesis API at `https://os.one.ml/api`.
 
 ```sh
-npm install @onesi/genesis@0.2.4
+npm install @onesi/genesis@0.2.6
 ```
 
 ```ts

package/dist/client.d.ts

@@ -41,6 +41,18 @@ export declare class GenesisClient {
     constructor(opts?: GenesisOptions);
     static operations: Readonly<Record<OperationId, OperationMeta>>;
     static services: import("./types.js").ServiceMeta[];
+    /** This client's cached read of the selected context's Hives binding: kept HIVES_BINDING_TTL_MS, cleared on failure and on every link or detach. */
+    private hivesBinding?;
+    /**
+     * The Hives project id (prj_…) for a Hives project argument. A prj_… id is returned unchanged. Omitted, or the
+     * Genesis pr_… id of the selected context's project, it resolves to the Hives project bound to that selection
+     * (`hives_get_context_project`). The binding is cached for 60 s; a pr_… id that does not match a cached binding reads
+     * the selection again before it is refused, so each call makes at most one context read. Otherwise a GenesisError
+     * says how to find the prj_… id.
+     */
+    hivesProjectId(project_id?: string, init?: {
+        signal?: AbortSignal;
+    }): Promise<string>;
     /** Resolve the credential: explicit apiKey > token > env GENESIS_API_KEY > GENESIS_TOKEN > provider. */
     credential(): Promise<string | undefined>;
     /** Build the URL for an operation (exposed for tests and `--dry-run`). */

package/dist/client.js

@@ -12,6 +12,7 @@ import { requireSecureUrl, redactUserinfo, stripUserinfo } from './urls.js';
 import { iamDirectoryFailure, isIamDirectoryOperation } from './iam-directory.js';
 import { validateHivesInvocation, hivesFunctionResponseHeaders, hivesFunctionMetadata, hivesOperationError } from './hives-functions.js';
 import { validateHivesEnvironment, validateHivesEnvironmentNames, hivesEnvironmentSetNames, hivesEnvironmentMetadata, hivesEnvironmentReveal } from './hives-environment.js';
+import { hivesProjectIdRefusal, isGenesisProjectId, isHivesProjectOperation, resolveHivesProjectId } from './hives-project.js';
 import { RUNNER_SELF_GRANT_OPERATION, snapshotRunnerSelfGrant, runnerGrantResponse, runnerGrantTransportError } from './runner-grant.js';
 /** The Genesis API gateway. `https://console.life.one/api` remains an alias for the same gateway. */
 export const DEFAULT_BASE_URL = 'https://os.one.ml/api';
@@ -55,6 +56,8 @@ export function scrubError(e, depth = 0) {
     fresh.stack = stack;
     return fresh;
 }
+/** How long a client reuses its read of the selected context's Hives binding. */
+const HIVES_BINDING_TTL_MS = 60_000;
 export class GenesisClient {
     /** The configured gateway root, kept without userinfo so it is safe to log or print. */
     get baseUrl() { return stripUserinfo(this.root); }
@@ -75,6 +78,30 @@ export class GenesisClient {
     }
     static operations = operationTable;
     static services = services;
+    /** This client's cached read of the selected context's Hives binding: kept HIVES_BINDING_TTL_MS, cleared on failure and on every link or detach. */
+    hivesBinding;
+    /**
+     * The Hives project id (prj_…) for a Hives project argument. A prj_… id is returned unchanged. Omitted, or the
+     * Genesis pr_… id of the selected context's project, it resolves to the Hives project bound to that selection
+     * (`hives_get_context_project`). The binding is cached for 60 s; a pr_… id that does not match a cached binding reads
+     * the selection again before it is refused, so each call makes at most one context read. Otherwise a GenesisError
+     * says how to find the prj_… id.
+     */
+    async hivesProjectId(project_id, init = {}) {
+        let readHere = false;
+        const read = (fresh) => {
+            const cached = this.hivesBinding;
+            if (cached && !fresh && Date.now() - cached.at < HIVES_BINDING_TTL_MS)
+                return cached.read;
+            readHere = true;
+            const entry = { read: this.request('hives_get_context_project', {}, { signal: init.signal }), at: Date.now() };
+            this.hivesBinding = entry;
+            entry.read.catch(() => { if (this.hivesBinding === entry)
+                this.hivesBinding = undefined; });
+            return entry.read;
+        };
+        return resolveHivesProjectId(project_id, () => read(false), () => readHere ? undefined : read(true));
+    }
     /** Resolve the credential: explicit apiKey > token > env GENESIS_API_KEY > GENESIS_TOKEN > provider. */
     async credential() {
         return this.opts.apiKey ?? this.opts.token ?? env.GENESIS_API_KEY ?? env.GENESIS_TOKEN ?? (await this.opts.credentials?.());
@@ -184,6 +211,19 @@ export class GenesisClient {
     }
     /** Raw Response. Completed Hives guest responses retain their actual status, including non-2xx. */
     async raw(operationId, input = {}, init = {}) {
+        // A Genesis pr_… id where Hives wants its own prj_… id would only be a remote 404: refuse it before any request.
+        if (isGenesisProjectId(input.project_id) && isHivesProjectOperation(operationTable[operationId]))
+            throw hivesProjectIdRefusal(input.project_id, operationId);
+        // Linking or detaching the selection changes its Hives binding: drop the cached read before and after, whatever the outcome.
+        if (operationId === 'hives_set_context_project' || operationId === 'hives_detach_context_project') {
+            this.hivesBinding = undefined;
+            try {
+                return await this.dispatch(operationId, input, init);
+            }
+            finally {
+                this.hivesBinding = undefined;
+            }
+        }
         if (!isIamDirectoryOperation(operationId))
             return this.dispatch(operationId, input, init);
         // The gateway binds the organization context itself. A refusal is only explained here; the client never changes a session or its context.
@@ -226,7 +266,7 @@ export class GenesisClient {
         const url = this.url(operationId, input);
         const headers = {
             accept: 'application/json',
-            'user-agent': this.opts.userAgent ?? '@onesi/genesis/0.2.4',
+            'user-agent': this.opts.userAgent ?? '@onesi/genesis/0.2.6',
             ...this.opts.headers, ...init.headers,
         };
         if (op.service === 'blinds' && !['GET', 'HEAD', 'OPTIONS'].includes(op.method))

package/dist/errors.js

@@ -90,7 +90,7 @@ function backendCode(body) {
         && typeof body.error !== 'string' && !authorizationCode(body) ? body.code : undefined;
     return envelope !== undefined && !(own && /^UPSTREAM_\d{3}$/.test(envelope)) ? envelope : own;
 }
-const statusType = (s) => s === 401 ? 'unauthorized' : s === 403 ? 'forbidden' : s === 404 ? 'not_found' : s === 429 ? 'rate_limited' : s >= 500 ? 'upstream_error' : 'error';
+const statusType = (s) => s === 401 ? 'unauthorized' : s === 403 ? 'forbidden' : s === 404 ? 'not_found' : s === 410 ? 'gone' : s === 429 ? 'rate_limited' : s >= 500 ? 'upstream_error' : 'error';
 /** The gateway catalog fields of an error, for JSON output: `code`, `required_scope` and `docs_url` when the gateway sent them. */
 export function errorCatalog(e) {
     const body = e.body && typeof e.body === 'object' ? e.body.error : undefined;

package/dist/fleets.d.ts

@@ -141,7 +141,10 @@ export declare function fleetsModule(client: GenesisClient): {
             model: string;
             updated_at?: number;
         }>;
-        set: (api_key: string) => Promise<{
+        /** `model` (optional) must be a model Foundry lists for the key; omit it for the Fleets default. */
+        set: (api_key: string, options?: {
+            model?: string;
+        }) => Promise<{
             connected: boolean;
             model: string;
             updated_at?: number;

package/dist/fleets.js

@@ -26,6 +26,11 @@ function validateKey(apiKey) {
         throw invalid('fleets_setConnection', 'Foundry key must contain 1–4096 UTF-8 bytes without CR, LF or NUL.');
     }
 }
+function validateModel(model) {
+    if (typeof model !== 'string' || !/^[A-Za-z0-9][A-Za-z0-9._:/-]{0,127}$/.test(model)) {
+        throw invalid('fleets_setConnection', 'Model must be a Foundry model id of 1–128 characters (letters, digits, . _ : / -).');
+    }
+}
 const instanceId = (value, operation) => {
     if (typeof value !== 'string' || !/^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i.test(value)) {
         throw invalid(operation, 'Invalid Fleets instance ID.');
@@ -160,9 +165,12 @@ export function fleetsModule(client) {
         },
         connection: {
             get: () => client.request('fleets_getConnection', {}),
-            set: async (api_key) => {
+            /** `model` (optional) must be a model Foundry lists for the key; omit it for the Fleets default. */
+            set: async (api_key, options = {}) => {
                 validateKey(api_key);
-                return client.request('fleets_setConnection', { body: { api_key } });
+                if (options.model !== undefined)
+                    validateModel(options.model);
+                return client.request('fleets_setConnection', { body: { api_key, ...(options.model !== undefined ? { model: options.model } : {}) } });
             },
             delete: () => client.request('fleets_deleteConnection', {}),
         },