@spectratools/graphic-designer-cli 0.3.1 → 0.3.2

package/dist/index.js

@@ -8,38 +8,8 @@ import { Cli, z as z3 } from "incur";
 // src/publish/gist.ts
 import { readFile } from "fs/promises";
 import { basename } from "path";
-
-// src/utils/retry.ts
-var DEFAULT_RETRY_POLICY = {
-  maxRetries: 3,
-  baseMs: 500,
-  maxMs: 4e3
-};
-function sleep(ms) {
-  return new Promise((resolve5) => setTimeout(resolve5, ms));
-}
-async function withRetry(operation, policy = DEFAULT_RETRY_POLICY) {
-  let attempt = 0;
-  let lastError;
-  while (attempt <= policy.maxRetries) {
-    try {
-      const value = await operation();
-      return { value, attempts: attempt + 1 };
-    } catch (error) {
-      lastError = error;
-      if (attempt >= policy.maxRetries) {
-        break;
-      }
-      const backoff = Math.min(policy.baseMs * 2 ** attempt, policy.maxMs);
-      const jitter = Math.floor(Math.random() * 125);
-      await sleep(backoff + jitter);
-      attempt += 1;
-    }
-  }
-  throw lastError;
-}
-
-// src/publish/gist.ts
+import { withRetry } from "@spectratools/cli-shared/middleware";
+import { createHttpClient } from "@spectratools/cli-shared/utils";
 function requireGitHubToken(token) {
   const resolved = token ?? process.env.GITHUB_TOKEN;
   if (!resolved) {
@@ -47,28 +17,21 @@ function requireGitHubToken(token) {
   }
   return resolved;
 }
-async function gistJson(path, init, token, retryPolicy) {
-  return withRetry(async () => {
-    const response = await fetch(`https://api.github.com${path}`, {
-      ...init,
-      headers: {
-        Accept: "application/vnd.github+json",
-        Authorization: `Bearer ${token}`,
-        "User-Agent": "spectratools-graphic-designer",
-        ...init.headers
-      }
-    });
-    if (!response.ok) {
-      const text = await response.text();
-      throw new Error(
-        `GitHub Gist API ${path} failed (${response.status}): ${text || response.statusText}`
-      );
-    }
-    return await response.json();
-  }, retryPolicy);
-}
+var DEFAULT_RETRY = {
+  maxRetries: 3,
+  baseMs: 500,
+  maxMs: 4e3
+};
+var github = createHttpClient({
+  baseUrl: "https://api.github.com",
+  defaultHeaders: {
+    Accept: "application/vnd.github+json",
+    "User-Agent": "spectratools-graphic-designer"
+  }
+});
 async function publishToGist(options) {
   const token = requireGitHubToken(options.token);
+  const retry = options.retryPolicy ?? DEFAULT_RETRY;
   const [imageBuffer, metadataBuffer] = await Promise.all([
     readFile(options.imagePath),
     readFile(options.metadataPath)
@@ -106,27 +69,27 @@ async function publishToGist(options) {
   };
   const endpoint = options.gistId ? `/gists/${options.gistId}` : "/gists";
   const method = options.gistId ? "PATCH" : "POST";
-  const published = await gistJson(
-    endpoint,
-    {
+  const published = await withRetry(
+    () => github.request(endpoint, {
       method,
-      body: JSON.stringify(payload)
-    },
-    token,
-    options.retryPolicy
+      body: payload,
+      headers: { Authorization: `Bearer ${token}` }
+    }),
+    retry
   );
   return {
     target: "gist",
-    gistId: published.value.id,
-    htmlUrl: published.value.html_url,
-    attempts: published.attempts,
-    files: Object.keys(published.value.files ?? payload.files)
+    gistId: published.id,
+    htmlUrl: published.html_url,
+    files: Object.keys(published.files ?? payload.files)
   };
 }
 
 // src/publish/github.ts
 import { readFile as readFile2 } from "fs/promises";
 import { basename as basename2, posix } from "path";
+import { withRetry as withRetry2 } from "@spectratools/cli-shared/middleware";
+import { HttpError, createHttpClient as createHttpClient2 } from "@spectratools/cli-shared/utils";
 function requireGitHubToken2(token) {
   const resolved = token ?? process.env.GITHUB_TOKEN;
   if (!resolved) {
@@ -134,56 +97,18 @@ function requireGitHubToken2(token) {
   }
   return resolved;
 }
-async function githubJson(path, init, token, retryPolicy) {
-  return withRetry(async () => {
-    const response = await fetch(`https://api.github.com${path}`, {
-      ...init,
-      headers: {
-        Accept: "application/vnd.github+json",
-        Authorization: `Bearer ${token}`,
-        "User-Agent": "spectratools-graphic-designer",
-        ...init.headers
-      }
-    });
-    if (!response.ok) {
-      const text = await response.text();
-      throw new Error(
-        `GitHub API ${path} failed (${response.status}): ${text || response.statusText}`
-      );
-    }
-    return await response.json();
-  }, retryPolicy);
-}
-async function githubJsonMaybe(path, token, retryPolicy) {
-  const { value, attempts } = await withRetry(async () => {
-    const response = await fetch(`https://api.github.com${path}`, {
-      headers: {
-        Accept: "application/vnd.github+json",
-        Authorization: `Bearer ${token}`,
-        "User-Agent": "spectratools-graphic-designer"
-      }
-    });
-    if (response.status === 404) {
-      return { found: false };
-    }
-    if (!response.ok) {
-      const text = await response.text();
-      throw new Error(
-        `GitHub API ${path} failed (${response.status}): ${text || response.statusText}`
-      );
-    }
-    const json = await response.json();
-    return { found: true, value: json };
-  }, retryPolicy);
-  if (!value.found) {
-    return { found: false, attempts };
+var DEFAULT_RETRY2 = {
+  maxRetries: 3,
+  baseMs: 500,
+  maxMs: 4e3
+};
+var github2 = createHttpClient2({
+  baseUrl: "https://api.github.com",
+  defaultHeaders: {
+    Accept: "application/vnd.github+json",
+    "User-Agent": "spectratools-graphic-designer"
   }
-  return {
-    found: true,
-    value: value.value,
-    attempts
-  };
-}
+});
 function parseRepo(repo) {
   const [owner, name] = repo.split("/");
   if (!owner || !name) {
@@ -199,9 +124,25 @@ function normalizePath(pathPrefix, filename) {
   const trimmed = (pathPrefix ?? "artifacts").replace(/^\/+|\/+$/gu, "");
   return posix.join(trimmed, filename);
 }
+async function githubJsonMaybe(path, token, retry) {
+  return withRetry2(async () => {
+    try {
+      const value = await github2.request(path, {
+        headers: { Authorization: `Bearer ${token}` }
+      });
+      return { found: true, value };
+    } catch (err) {
+      if (err instanceof HttpError && err.status === 404) {
+        return { found: false };
+      }
+      throw err;
+    }
+  }, retry);
+}
 async function publishToGitHub(options) {
   const token = requireGitHubToken2(options.token);
   const branch = options.branch ?? "main";
+  const retry = options.retryPolicy ?? DEFAULT_RETRY2;
   const commitMessage = options.commitMessage ?? "chore(graphic-designer): publish deterministic artifacts";
   const [imageBuffer, metadataBuffer] = await Promise.all([
     readFile2(options.imagePath),
@@ -219,16 +160,10 @@ async function publishToGitHub(options) {
       content: metadataBuffer.toString("base64")
     }
   ];
-  let totalAttempts = 0;
   const files = [];
   for (const upload of uploads) {
     const existingPath = `${toApiContentPath(options.repo, upload.destination)}?ref=${encodeURIComponent(branch)}`;
-    const existing = await githubJsonMaybe(
-      existingPath,
-      token,
-      options.retryPolicy
-    );
-    totalAttempts += existing.attempts;
+    const existing = await githubJsonMaybe(existingPath, token, retry);
     const body = {
       message: `${commitMessage} (${basename2(upload.sourcePath)})`,
       content: upload.content,
@@ -236,27 +171,24 @@ async function publishToGitHub(options) {
       sha: existing.value?.sha
     };
     const putPath = toApiContentPath(options.repo, upload.destination);
-    const published = await githubJson(
-      putPath,
-      {
+    const published = await withRetry2(
+      () => github2.request(putPath, {
         method: "PUT",
-        body: JSON.stringify(body)
-      },
-      token,
-      options.retryPolicy
+        body,
+        headers: { Authorization: `Bearer ${token}` }
+      }),
+      retry
     );
-    totalAttempts += published.attempts;
     files.push({
       path: upload.destination,
-      ...published.value.content?.sha ? { sha: published.value.content.sha } : {},
-      ...published.value.content?.html_url ? { htmlUrl: published.value.content.html_url } : {}
+      ...published.content?.sha ? { sha: published.content.sha } : {},
+      ...published.content?.html_url ? { htmlUrl: published.content.html_url } : {}
     });
   }
   return {
     target: "github",
     repo: options.repo,
     branch,
-    attempts: totalAttempts,
     files
   };
 }
@@ -4827,7 +4759,6 @@ cli.command("publish", {
       issueCount: z3.number()
     }),
     publish: z3.object({
-      attempts: z3.number(),
       summary: z3.string(),
       url: z3.string().optional()
     })
@@ -4880,7 +4811,6 @@ cli.command("publish", {
           issueCount: qa.issues.length
         },
         publish: {
-          attempts: gist.attempts,
           summary: `Published ${gist.files.length} files to gist ${gist.gistId}.`,
           url: gist.htmlUrl
         }
@@ -4893,7 +4823,7 @@ cli.command("publish", {
         retryable: false
       });
     }
-    const github = await publishToGitHub({
+    const github3 = await publishToGitHub({
       imagePath,
       metadataPath,
       repo: c.options.repo,
@@ -4901,7 +4831,7 @@ cli.command("publish", {
       ...c.options.pathPrefix ? { pathPrefix: c.options.pathPrefix } : {},
       ...c.options.description ? { commitMessage: c.options.description } : {}
     });
-    const url = github.files.find((file) => file.htmlUrl)?.htmlUrl;
+    const url = github3.files.find((file) => file.htmlUrl)?.htmlUrl;
     return c.ok({
       target: "github",
       qa: {
@@ -4909,8 +4839,7 @@ cli.command("publish", {
         issueCount: qa.issues.length
       },
       publish: {
-        attempts: github.attempts,
-        summary: `Published ${github.files.length} files to ${github.repo}@${github.branch}.`,
+        summary: `Published ${github3.files.length} files to ${github3.repo}@${github3.branch}.`,
         url
       }
     });

package/dist/publish/index.d.ts

@@ -1,8 +1,4 @@
-interface RetryPolicy {
-    maxRetries: number;
-    baseMs: number;
-    maxMs: number;
-}
+import { RetryOptions } from '@spectratools/cli-shared/middleware';
 
 type GitHubPublishOptions = {
     imagePath: string;
@@ -12,19 +8,37 @@ type GitHubPublishOptions = {
     branch?: string;
     token?: string;
     commitMessage?: string;
-    retryPolicy?: RetryPolicy;
+    retryPolicy?: RetryOptions;
 };
 type GitHubPublishResult = {
     target: 'github';
     repo: string;
     branch: string;
-    attempts: number;
     files: Array<{
         path: string;
         htmlUrl?: string;
         sha?: string;
     }>;
 };
+/**
+ * Publish rendered design artifacts to a GitHub repository.
+ *
+ * Uploads the PNG image and sidecar `.meta.json` metadata to the specified
+ * repository via the GitHub Contents API. Files are placed under
+ * {@link GitHubPublishOptions.pathPrefix} (defaults to `"artifacts"`). If a
+ * file already exists at the destination it is updated in-place (its SHA is
+ * fetched first for the update).
+ *
+ * Requires a GitHub token — either passed via
+ * {@link GitHubPublishOptions.token} or resolved from the `GITHUB_TOKEN`
+ * environment variable.
+ *
+ * @param options - Publish configuration including file paths, target repo,
+ *   branch, commit message, and optional retry policy.
+ * @returns A {@link GitHubPublishResult} with the repo, branch, and per-file
+ *   metadata (path, SHA, HTML URL).
+ * @throws When no GitHub token is available or the API request fails.
+ */
 declare function publishToGitHub(options: GitHubPublishOptions): Promise<GitHubPublishResult>;
 
 type GistPublishOptions = {
@@ -35,15 +49,30 @@ type GistPublishOptions = {
     filenamePrefix?: string;
     public?: boolean;
     token?: string;
-    retryPolicy?: RetryPolicy;
+    retryPolicy?: RetryOptions;
 };
 type GistPublishResult = {
     target: 'gist';
     gistId: string;
     htmlUrl: string;
-    attempts: number;
     files: string[];
 };
+/**
+ * Publish rendered design artifacts to a GitHub Gist.
+ *
+ * Creates (or updates, when {@link GistPublishOptions.gistId} is set) a gist
+ * containing the PNG image as a base64 text file, the sidecar `.meta.json`
+ * metadata, and a Markdown README with an embedded preview.
+ *
+ * Requires a GitHub token — either passed via {@link GistPublishOptions.token}
+ * or resolved from the `GITHUB_TOKEN` environment variable.
+ *
+ * @param options - Publish configuration including file paths, gist settings,
+ *   and optional retry policy.
+ * @returns A {@link GistPublishResult} with the gist ID, URL, attempt count,
+ *   and list of created file names.
+ * @throws When no GitHub token is available or the API request fails.
+ */
 declare function publishToGist(options: GistPublishOptions): Promise<GistPublishResult>;
 
 export { type GistPublishOptions, type GistPublishResult, type GitHubPublishOptions, type GitHubPublishResult, publishToGist, publishToGitHub };

package/dist/publish/index.js

@@ -1,38 +1,8 @@
 // src/publish/github.ts
 import { readFile } from "fs/promises";
 import { basename, posix } from "path";
-
-// src/utils/retry.ts
-var DEFAULT_RETRY_POLICY = {
-  maxRetries: 3,
-  baseMs: 500,
-  maxMs: 4e3
-};
-function sleep(ms) {
-  return new Promise((resolve) => setTimeout(resolve, ms));
-}
-async function withRetry(operation, policy = DEFAULT_RETRY_POLICY) {
-  let attempt = 0;
-  let lastError;
-  while (attempt <= policy.maxRetries) {
-    try {
-      const value = await operation();
-      return { value, attempts: attempt + 1 };
-    } catch (error) {
-      lastError = error;
-      if (attempt >= policy.maxRetries) {
-        break;
-      }
-      const backoff = Math.min(policy.baseMs * 2 ** attempt, policy.maxMs);
-      const jitter = Math.floor(Math.random() * 125);
-      await sleep(backoff + jitter);
-      attempt += 1;
-    }
-  }
-  throw lastError;
-}
-
-// src/publish/github.ts
+import { withRetry } from "@spectratools/cli-shared/middleware";
+import { HttpError, createHttpClient } from "@spectratools/cli-shared/utils";
 function requireGitHubToken(token) {
   const resolved = token ?? process.env.GITHUB_TOKEN;
   if (!resolved) {
@@ -40,56 +10,18 @@ function requireGitHubToken(token) {
   }
   return resolved;
 }
-async function githubJson(path, init, token, retryPolicy) {
-  return withRetry(async () => {
-    const response = await fetch(`https://api.github.com${path}`, {
-      ...init,
-      headers: {
-        Accept: "application/vnd.github+json",
-        Authorization: `Bearer ${token}`,
-        "User-Agent": "spectratools-graphic-designer",
-        ...init.headers
-      }
-    });
-    if (!response.ok) {
-      const text = await response.text();
-      throw new Error(
-        `GitHub API ${path} failed (${response.status}): ${text || response.statusText}`
-      );
-    }
-    return await response.json();
-  }, retryPolicy);
-}
-async function githubJsonMaybe(path, token, retryPolicy) {
-  const { value, attempts } = await withRetry(async () => {
-    const response = await fetch(`https://api.github.com${path}`, {
-      headers: {
-        Accept: "application/vnd.github+json",
-        Authorization: `Bearer ${token}`,
-        "User-Agent": "spectratools-graphic-designer"
-      }
-    });
-    if (response.status === 404) {
-      return { found: false };
-    }
-    if (!response.ok) {
-      const text = await response.text();
-      throw new Error(
-        `GitHub API ${path} failed (${response.status}): ${text || response.statusText}`
-      );
-    }
-    const json = await response.json();
-    return { found: true, value: json };
-  }, retryPolicy);
-  if (!value.found) {
-    return { found: false, attempts };
+var DEFAULT_RETRY = {
+  maxRetries: 3,
+  baseMs: 500,
+  maxMs: 4e3
+};
+var github = createHttpClient({
+  baseUrl: "https://api.github.com",
+  defaultHeaders: {
+    Accept: "application/vnd.github+json",
+    "User-Agent": "spectratools-graphic-designer"
   }
-  return {
-    found: true,
-    value: value.value,
-    attempts
-  };
-}
+});
 function parseRepo(repo) {
   const [owner, name] = repo.split("/");
   if (!owner || !name) {
@@ -105,9 +37,25 @@ function normalizePath(pathPrefix, filename) {
   const trimmed = (pathPrefix ?? "artifacts").replace(/^\/+|\/+$/gu, "");
   return posix.join(trimmed, filename);
 }
+async function githubJsonMaybe(path, token, retry) {
+  return withRetry(async () => {
+    try {
+      const value = await github.request(path, {
+        headers: { Authorization: `Bearer ${token}` }
+      });
+      return { found: true, value };
+    } catch (err) {
+      if (err instanceof HttpError && err.status === 404) {
+        return { found: false };
+      }
+      throw err;
+    }
+  }, retry);
+}
 async function publishToGitHub(options) {
   const token = requireGitHubToken(options.token);
   const branch = options.branch ?? "main";
+  const retry = options.retryPolicy ?? DEFAULT_RETRY;
   const commitMessage = options.commitMessage ?? "chore(graphic-designer): publish deterministic artifacts";
   const [imageBuffer, metadataBuffer] = await Promise.all([
     readFile(options.imagePath),
@@ -125,16 +73,10 @@ async function publishToGitHub(options) {
       content: metadataBuffer.toString("base64")
     }
   ];
-  let totalAttempts = 0;
   const files = [];
   for (const upload of uploads) {
     const existingPath = `${toApiContentPath(options.repo, upload.destination)}?ref=${encodeURIComponent(branch)}`;
-    const existing = await githubJsonMaybe(
-      existingPath,
-      token,
-      options.retryPolicy
-    );
-    totalAttempts += existing.attempts;
+    const existing = await githubJsonMaybe(existingPath, token, retry);
     const body = {
       message: `${commitMessage} (${basename(upload.sourcePath)})`,
       content: upload.content,
@@ -142,27 +84,24 @@ async function publishToGitHub(options) {
       sha: existing.value?.sha
     };
     const putPath = toApiContentPath(options.repo, upload.destination);
-    const published = await githubJson(
-      putPath,
-      {
+    const published = await withRetry(
+      () => github.request(putPath, {
         method: "PUT",
-        body: JSON.stringify(body)
-      },
-      token,
-      options.retryPolicy
+        body,
+        headers: { Authorization: `Bearer ${token}` }
+      }),
+      retry
     );
-    totalAttempts += published.attempts;
     files.push({
       path: upload.destination,
-      ...published.value.content?.sha ? { sha: published.value.content.sha } : {},
-      ...published.value.content?.html_url ? { htmlUrl: published.value.content.html_url } : {}
+      ...published.content?.sha ? { sha: published.content.sha } : {},
+      ...published.content?.html_url ? { htmlUrl: published.content.html_url } : {}
     });
   }
   return {
     target: "github",
     repo: options.repo,
     branch,
-    attempts: totalAttempts,
     files
   };
 }
@@ -170,6 +109,8 @@ async function publishToGitHub(options) {
 // src/publish/gist.ts
 import { readFile as readFile2 } from "fs/promises";
 import { basename as basename2 } from "path";
+import { withRetry as withRetry2 } from "@spectratools/cli-shared/middleware";
+import { createHttpClient as createHttpClient2 } from "@spectratools/cli-shared/utils";
 function requireGitHubToken2(token) {
   const resolved = token ?? process.env.GITHUB_TOKEN;
   if (!resolved) {
@@ -177,28 +118,21 @@ function requireGitHubToken2(token) {
   }
   return resolved;
 }
-async function gistJson(path, init, token, retryPolicy) {
-  return withRetry(async () => {
-    const response = await fetch(`https://api.github.com${path}`, {
-      ...init,
-      headers: {
-        Accept: "application/vnd.github+json",
-        Authorization: `Bearer ${token}`,
-        "User-Agent": "spectratools-graphic-designer",
-        ...init.headers
-      }
-    });
-    if (!response.ok) {
-      const text = await response.text();
-      throw new Error(
-        `GitHub Gist API ${path} failed (${response.status}): ${text || response.statusText}`
-      );
-    }
-    return await response.json();
-  }, retryPolicy);
-}
+var DEFAULT_RETRY2 = {
+  maxRetries: 3,
+  baseMs: 500,
+  maxMs: 4e3
+};
+var github2 = createHttpClient2({
+  baseUrl: "https://api.github.com",
+  defaultHeaders: {
+    Accept: "application/vnd.github+json",
+    "User-Agent": "spectratools-graphic-designer"
+  }
+});
 async function publishToGist(options) {
   const token = requireGitHubToken2(options.token);
+  const retry = options.retryPolicy ?? DEFAULT_RETRY2;
   const [imageBuffer, metadataBuffer] = await Promise.all([
     readFile2(options.imagePath),
     readFile2(options.metadataPath)
@@ -236,21 +170,19 @@ async function publishToGist(options) {
   };
   const endpoint = options.gistId ? `/gists/${options.gistId}` : "/gists";
   const method = options.gistId ? "PATCH" : "POST";
-  const published = await gistJson(
-    endpoint,
-    {
+  const published = await withRetry2(
+    () => github2.request(endpoint, {
       method,
-      body: JSON.stringify(payload)
-    },
-    token,
-    options.retryPolicy
+      body: payload,
+      headers: { Authorization: `Bearer ${token}` }
+    }),
+    retry
   );
   return {
     target: "gist",
-    gistId: published.value.id,
-    htmlUrl: published.value.html_url,
-    attempts: published.attempts,
-    files: Object.keys(published.value.files ?? payload.files)
+    gistId: published.id,
+    htmlUrl: published.html_url,
+    files: Object.keys(published.files ?? payload.files)
   };
 }
 export {