unfazed 0.8.1 → 0.9.0

package/dist/reference.js

@@ -24,12 +24,12 @@ export function help(topic) {
     const section = REFERENCE.split(/\n(?=## )/).find((block) => firstLine(block) === `## ${wanted}`);
     if (section)
         return section.trim() + "\n";
-    // A method: every entry whose heading names it.
-    const method = new RegExp(`\`${escape(wanted)}\\(|[ /]${escape(wanted)}\\(`);
+    // A method: every entry whose heading names it (`token` finds `oidc.token(`).
+    const method = new RegExp(`\`${escape(wanted)}\\(|[ /.]${escape(wanted)}\\(`);
     const matches = REFERENCE.split(/\n(?=#{2,3} )/).filter((block) => block.startsWith("### ") && method.test(firstLine(block)));
     if (matches.length > 0)
         return matches.map((block) => block.trim()).join("\n\n") + "\n";
-    const names = [...REFERENCE.matchAll(/^### `(\w+)\(/gm)].map((m) => m[1]);
+    const names = [...REFERENCE.matchAll(/^### `([\w.]+)\(/gm)].map((m) => m[1]);
     return `No entry for "${topic}". Methods: ${names.join(", ")}. help() returns the whole reference.\n`;
 }
 function escape(text) {

package/dist/reference.js.map

@@ -1 +1 @@
-{"version":3,"file":"reference.js","sourceRoot":"","sources":["../src/reference.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAErD,OAAO,EAAE,SAAS,EAAE,CAAC;AAErB;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,IAAI,CAAC,KAAc;IACjC,IAAI,CAAC,KAAK;QAAE,OAAO,SAAS,CAAC;IAC7B,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;IAC/D,MAAM,SAAS,GAAG,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAE,CAAC,WAAW,EAAE,CAAC;IAC5E,kDAAkD;IAClD,MAAM,OAAO,GAAG,SAAS,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,MAAM,MAAM,EAAE,CAAC,CAAC;IAClG,IAAI,OAAO;QAAE,OAAO,OAAO,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC;IAC1C,gDAAgD;IAChD,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,WAAW,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC7E,MAAM,OAAO,GAAG,SAAS,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,MAAM,CACrD,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CACrE,CAAC;IACF,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IACxF,MAAM,KAAK,GAAG,CAAC,GAAG,SAAS,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1E,OAAO,iBAAiB,KAAK,eAAe,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,yCAAyC,CAAC;AACxG,CAAC;AAED,SAAS,MAAM,CAAC,IAAY;IAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;AACrD,CAAC","sourcesContent":["import { REFERENCE } from \"./reference.generated.js\";\n\nexport { REFERENCE };\n\n/**\n * The SDK's reference, for a script (or a model) that needs a signature:\n * every method of {@link Unfazed} with its parameters, result and an\n * example, in one page (REFERENCE.md). It describes THIS version, the one\n * the script imported (`VERSION`): exactly what `help()` should answer.\n *\n * ```ts\n * import { help } from \"unfazed\";\n * export default () => help(\"writeFiles\");   // run_script returns the entry\n * ```\n *\n * `help()` is the whole page; `help(topic)` the entries whose heading names\n * it (a method like `\"restoreVersion\"`, or a section like `\"Events\"`), or the\n * list of methods when nothing matches.\n */\nexport function help(topic?: string): string {\n  if (!topic) return REFERENCE;\n  const wanted = topic.trim().replace(/\\(\\)$/, \"\").toLowerCase();\n  const firstLine = (block: string) => block.split(\"\\n\", 1)[0]!.toLowerCase();\n  // A section (\"Events\", \"Files\"): the whole of it.\n  const section = REFERENCE.split(/\\n(?=## )/).find((block) => firstLine(block) === `## ${wanted}`);\n  if (section) return section.trim() + \"\\n\";\n  // A method: every entry whose heading names it.\n  const method = new RegExp(`\\`${escape(wanted)}\\\\(|[ /]${escape(wanted)}\\\\(`);\n  const matches = REFERENCE.split(/\\n(?=#{2,3} )/).filter(\n    (block) => block.startsWith(\"### \") && method.test(firstLine(block)),\n  );\n  if (matches.length > 0) return matches.map((block) => block.trim()).join(\"\\n\\n\") + \"\\n\";\n  const names = [...REFERENCE.matchAll(/^### `(\\w+)\\(/gm)].map((m) => m[1]);\n  return `No entry for \"${topic}\". Methods: ${names.join(\", \")}. help() returns the whole reference.\\n`;\n}\n\nfunction escape(text: string): string {\n  return text.replace(/[.*+?^${}()|[\\]\\\\]/g, \"\\\\$&\");\n}\n"]}
+{"version":3,"file":"reference.js","sourceRoot":"","sources":["../src/reference.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAErD,OAAO,EAAE,SAAS,EAAE,CAAC;AAErB;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,IAAI,CAAC,KAAc;IACjC,IAAI,CAAC,KAAK;QAAE,OAAO,SAAS,CAAC;IAC7B,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;IAC/D,MAAM,SAAS,GAAG,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAE,CAAC,WAAW,EAAE,CAAC;IAC5E,kDAAkD;IAClD,MAAM,OAAO,GAAG,SAAS,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,MAAM,MAAM,EAAE,CAAC,CAAC;IAClG,IAAI,OAAO;QAAE,OAAO,OAAO,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC;IAC1C,8EAA8E;IAC9E,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,YAAY,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC9E,MAAM,OAAO,GAAG,SAAS,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,MAAM,CACrD,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CACrE,CAAC;IACF,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IACxF,MAAM,KAAK,GAAG,CAAC,GAAG,SAAS,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7E,OAAO,iBAAiB,KAAK,eAAe,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,yCAAyC,CAAC;AACxG,CAAC;AAED,SAAS,MAAM,CAAC,IAAY;IAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;AACrD,CAAC","sourcesContent":["import { REFERENCE } from \"./reference.generated.js\";\n\nexport { REFERENCE };\n\n/**\n * The SDK's reference, for a script (or a model) that needs a signature:\n * every method of {@link Unfazed} with its parameters, result and an\n * example, in one page (REFERENCE.md). It describes THIS version, the one\n * the script imported (`VERSION`): exactly what `help()` should answer.\n *\n * ```ts\n * import { help } from \"unfazed\";\n * export default () => help(\"writeFiles\");   // run_script returns the entry\n * ```\n *\n * `help()` is the whole page; `help(topic)` the entries whose heading names\n * it (a method like `\"restoreVersion\"`, or a section like `\"Events\"`), or the\n * list of methods when nothing matches.\n */\nexport function help(topic?: string): string {\n  if (!topic) return REFERENCE;\n  const wanted = topic.trim().replace(/\\(\\)$/, \"\").toLowerCase();\n  const firstLine = (block: string) => block.split(\"\\n\", 1)[0]!.toLowerCase();\n  // A section (\"Events\", \"Files\"): the whole of it.\n  const section = REFERENCE.split(/\\n(?=## )/).find((block) => firstLine(block) === `## ${wanted}`);\n  if (section) return section.trim() + \"\\n\";\n  // A method: every entry whose heading names it (`token` finds `oidc.token(`).\n  const method = new RegExp(`\\`${escape(wanted)}\\\\(|[ /.]${escape(wanted)}\\\\(`);\n  const matches = REFERENCE.split(/\\n(?=#{2,3} )/).filter(\n    (block) => block.startsWith(\"### \") && method.test(firstLine(block)),\n  );\n  if (matches.length > 0) return matches.map((block) => block.trim()).join(\"\\n\\n\") + \"\\n\";\n  const names = [...REFERENCE.matchAll(/^### `([\\w.]+)\\(/gm)].map((m) => m[1]);\n  return `No entry for \"${topic}\". Methods: ${names.join(\", \")}. help() returns the whole reference.\\n`;\n}\n\nfunction escape(text: string): string {\n  return text.replace(/[.*+?^${}()|[\\]\\\\]/g, \"\\\\$&\");\n}\n"]}

package/dist/unfazed.d.ts

@@ -1,4 +1,5 @@
 import { UnfazedClient, type ClientOptions, type RequestOptions } from "./client.js";
+import { UnfazedOIDC } from "./oidc.js";
 import type { AppErrorGroupFieldsFragment, CreateDeploymentInput, DeploymentEventType, DeploymentFieldsFragment, FileCommitFieldsFragment, ListDeploymentsInput, RunFieldsFragment, RunStatus, ServiceMode, ServiceRuntime, SdkAppCommitQuery, SdkAppCommitsQuery, SdkAppErrorGroupQuery, SdkAppErrorsQuery, SdkCreateWorkspaceMutation, SdkDeleteAppMutation, SdkDeploymentEventsQuery, SdkEventTypesQuery, SdkPollEventsQuery, SdkRestoreVersionMutation, SdkRunHarnessesQuery, SdkWorkspaceLiveAppsQuery } from "./generated/graphql.js";
 import { type WaitOptions } from "./wait.js";
 /** A deployment as the workflow layer returns it. */
@@ -577,9 +578,19 @@ export interface UnfazedOptions extends ClientOptions {
  */
 export declare class Unfazed {
     #private;
-    /** The underlying typed GraphQL client. Use it for un-wrapped operations. */
-    readonly client: UnfazedClient;
+    /**
+     * Workload identity tokens for the app this code runs in
+     * (`oidc.token(audience)`, `oidc.fetchWithToken(audience)`). They need only
+     * the app's `UNFZ_STATE_TOKEN`, so they work in an `Unfazed` made without
+     * an API token or a login.
+     */
+    readonly oidc: UnfazedOIDC;
     constructor(options?: UnfazedOptions);
+    /**
+     * The underlying typed GraphQL client. Use it for un-wrapped operations.
+     * Throws {@link UnfazedAuthError} when there is no token and no login.
+     */
+    get client(): UnfazedClient;
     /** Who this token authenticates as, plus usage and resource limits. */
     whoami(options?: RequestOptions): Promise<{
         kind: import("./index.js").CurrentActorKind;

package/dist/unfazed.js

@@ -1,5 +1,6 @@
 import { UnfazedClient } from "./client.js";
-import { DEPLOYMENT_NOT_FOUND, UnfazedConflictError, UnfazedDeployError, UnfazedError, UnfazedGraphQLError, UnfazedNotFoundError, UnfazedRunError, UnfazedTimeoutError, UnfazedUnconfirmedAppsError, UnfazedWriteError, WORKSPACE_NOT_FOUND, isAppNotFound, isDuplicateWorkspaceName, isNotFoundSentinel as isNotFound, isUnconfirmedAppsRefusal, isTooManyWaits, isUnsupportedField, looksLikeCASConflict, } from "./errors.js";
+import { DEPLOYMENT_NOT_FOUND, UnfazedAuthError, UnfazedConflictError, UnfazedDeployError, UnfazedError, UnfazedGraphQLError, UnfazedNotFoundError, UnfazedRunError, UnfazedTimeoutError, UnfazedUnconfirmedAppsError, UnfazedWriteError, WORKSPACE_NOT_FOUND, isAppNotFound, isDuplicateWorkspaceName, isNotFoundSentinel as isNotFound, isUnconfirmedAppsRefusal, isTooManyWaits, isUnsupportedField, looksLikeCASConflict, } from "./errors.js";
+import { UnfazedOIDC } from "./oidc.js";
 import * as ops from "./operations.js";
 import { pollWithBackoff, resolveWaitOptions } from "./wait.js";
 /**
@@ -20,11 +21,51 @@ import { pollWithBackoff, resolveWaitOptions } from "./wait.js";
  * ```
  */
 export class Unfazed {
-    /** The underlying typed GraphQL client. Use it for un-wrapped operations. */
-    client;
+    #client;
+    /** Why there is no client: no token and no stored login. */
+    #noClient;
+    /**
+     * Workload identity tokens for the app this code runs in
+     * (`oidc.token(audience)`, `oidc.fetchWithToken(audience)`). They need only
+     * the app's `UNFZ_STATE_TOKEN`, so they work in an `Unfazed` made without
+     * an API token or a login.
+     */
+    oidc;
     constructor(options = {}) {
         const { client, ...clientOptions } = options;
-        this.client = client ?? new UnfazedClient(clientOptions);
+        let made = client;
+        if (!made) {
+            try {
+                made = new UnfazedClient(clientOptions);
+            }
+            catch (error) {
+                // An app has its state token but no API token: `oidc` still works,
+                // and the first call that needs the API says how to sign in.
+                if (!(error instanceof UnfazedAuthError))
+                    throw error;
+                this.#noClient = error;
+            }
+        }
+        this.#client = made;
+        // Tokens come from the platform the client talks to: its endpoint already
+        // resolved `endpoint`, `baseUrl`, `UNFZ_API_URL` and the stored login.
+        const endpoint = made?.endpoint ?? options.endpoint;
+        this.oidc = new UnfazedOIDC({
+            ...(endpoint ? { endpoint } : {}),
+            ...(!made && options.baseUrl ? { baseUrl: options.baseUrl } : {}),
+            ...(options.env ? { env: options.env } : {}),
+            ...(options.fetch ? { fetch: options.fetch } : {}),
+            ...(options.userAgent !== undefined ? { userAgent: options.userAgent } : {}),
+        });
+    }
+    /**
+     * The underlying typed GraphQL client. Use it for un-wrapped operations.
+     * Throws {@link UnfazedAuthError} when there is no token and no login.
+     */
+    get client() {
+        if (this.#client)
+            return this.#client;
+        throw new UnfazedAuthError(this.#noClient?.message ?? "unfazed: no API client", { cause: this.#noClient });
     }
     /* ---------------------------------------------------------------- identity */
     /** Who this token authenticates as, plus usage and resource limits. */