@anyday/sanity-workspace-manager 0.2.0 → 0.5.0

package/README.md

@@ -43,19 +43,36 @@ npx @anyday/sanity-workspace-manager register --api https://anyday-workspace-man
 npx @anyday/sanity-workspace-manager init [dir] [options]
 ```
 
-`dir` is the site repo, and defaults to the current folder. `init` asks four questions, each with a
+`dir` is the site repo, and defaults to the current folder. `init` asks five questions, each with a
 suggestion you can accept with Enter:
 
-| Question                                    | Suggested from                                                     |
-| ------------------------------------------- | ------------------------------------------------------------------ |
-| Project type id, short and lowercase        | The repo name in the git remote, e.g. `acme-site`                  |
-| Name shown in the app                       | The same repo name, capitalised                                    |
-| Sanity project to copy schemas from         | A `projectId: '…'` written in the Studio's config, if there is one |
-| Sanity organisation to create workspaces in | Looked up from that project with your login                        |
+| Question                                    | Suggested from                                                                        |
+| ------------------------------------------- | ------------------------------------------------------------------------------------- |
+| Project type id, short and lowercase        | The repo name in the git remote, e.g. `acme-site`                                     |
+| Name shown in the app                       | The same repo name, capitalised                                                       |
+| Sanity project to copy schemas from         | A `projectId: '…'` written in the Studio's config, if there is one                    |
+| Sanity organisation to create workspaces in | Looked up from that project with your login                                           |
+| Vercel team for the sites                   | Nothing: press Enter for Anyday's team; give a team id only for the client's own team |
 
 The id is permanent: jobs store it and it prefixes each site's Vercel project. Registering a
 different id later creates a second project type instead of updating this one.
 
+### Which command to run
+
+| Command                            | Questions                | Starter pages                                  | Use it when                                   |
+| ---------------------------------- | ------------------------ | ---------------------------------------------- | --------------------------------------------- |
+| `init --live`                      | Yes, then a list to pick | The pages you pick (none: one empty home page) | Usually: real theme, colours and pages        |
+| `init --live --starter home,about` | Yes, no list             | Those pages                                    | You already know which pages                  |
+| `init --live --yes`                | None, suggestions taken  | One empty home page                            | Scripts, or no starter content wanted         |
+| `init`                             | Yes                      | One empty home page                            | The project has no content yet, or no sign-in |
+
+Without `--live`, `init` reads only the repo's files, so the manifest has the structure but no
+values: colour defaults are `#000000`, theme defaults and `studioOrigins` are empty. Fill them in
+by hand, or run again with `--live --force` once the project has content.
+
+Starter pages are only what **Start fresh** writes. **Copy from a workspace** is picked in the
+Workspaces app for each new workspace, and reads its source live; it needs no `init` option.
+
 ### What it reads
 
 | Source                          | Used for                                                                                             |
@@ -63,23 +80,25 @@ different id later creates a second project type instead of updating this one.
 | git remote and default branch   | `site.repo`, `site.branch`, the suggested id and name                                                |
 | `.env.example`, names only      | `siteEnv`, the variables each new site needs                                                         |
 | `sanity.schema.json`            | copy sections, singletons, home page, language documents, settings fields, colour and font templates |
-| the live project, with `--live` | theme defaults, colour defaults and starter pages                                                    |
+| the live project, with `--live` | theme defaults, colour defaults, starter pages, and its deployed Studio for `studioOrigins`          |
 
 `sanity.schema.json` is looked for in the repo root, `frontend`, `web`, `site`, `studio`, `apps`
 and each folder in `apps`.
 
 ### Options
 
-| Option              | Does                                                                                            |
-| ------------------- | ----------------------------------------------------------------------------------------------- |
-| `--yes`             | Accepts the suggested id, name and project without asking                                       |
-| `--project <id>`    | The Sanity project new workspaces copy their schema from                                        |
-| `--org <id>`        | The Sanity organisation new workspaces are created in (found with `--live`)                     |
-| `--live`            | Reads the current theme, settings and starter pages from that project                           |
-| `--dataset <name>`  | The dataset `--live` reads (default `production`)                                               |
-| `--starter <pages>` | Starter pages without the list: `home`, slugs or document ids, comma-separated (needs `--live`) |
-| `--force`           | Replaces an existing `workspace-manager.json`                                                   |
-| `--print`           | Prints the draft instead of writing it                                                          |
+| Option               | Does                                                                                            |
+| -------------------- | ----------------------------------------------------------------------------------------------- |
+| `--yes`              | Asks nothing: takes every suggestion and skips the starter list                                 |
+| `--project <id>`     | The Sanity project new workspaces copy their schema from                                        |
+| `--org <id>`         | The Sanity organisation new workspaces are created in (found with `--live`)                     |
+| `--vercel-team <id>` | The client's own Vercel team for the sites; leave out for Anyday's team                         |
+| `--studio <origin>`  | The Studio that opens new workspaces, e.g. `https://acme.sanity.studio` (found with `--live`)   |
+| `--live`             | Reads the current theme, settings and starter pages from that project                           |
+| `--dataset <name>`   | The dataset `--live` reads (default `production`)                                               |
+| `--starter <pages>`  | Starter pages without the list: `home`, slugs or document ids, comma-separated (needs `--live`) |
+| `--force`            | Replaces an existing `workspace-manager.json`, keeping its file-backed theme defaults (fonts)   |
+| `--print`            | Prints the draft instead of writing it                                                          |
 
 ### Starter pages
 
@@ -89,19 +108,20 @@ Starter pages are what a new workspace starts with when it doesn't copy another
 ```text
 Pages of the live site:
   1. Home (/home)  ← home
-  2. About Olive (/about-olive)
+  2. About us (/about-us)
   3. Accessibility (/accessibility)
 Starter pages, by number (e.g. 1,3; Enter for one empty home page):
 ```
 
 Pick by number, or press Enter for one empty home page. To skip the list, name the pages with
 `--starter`: `home` means whichever page the settings mark as the home page, and any other entry
-is a page's slug or document id, e.g. `--starter home,about-olive`. When translations share a
+is a page's slug or document id, e.g. `--starter home,about-us`. When translations share a
 slug, the home page's language wins. With `--yes` and no `--starter`, the starter is one empty
 home page.
 
 Starter pages get `{{siteName}}` and `{{language}}` where the source site's name and language
-were. Font files are never copied into theme defaults, since fonts are often licensed per brand.
+were. Fonts are left out of theme defaults, since uploaded fonts are often licensed per brand: add
+them by hand when they may be reused, and a later `--force` keeps them.
 
 ### Review before registering
 
@@ -115,6 +135,9 @@ listed afterwards. Check these in particular:
 - **Colour roles** come with empty descriptions. Add a short one each, saying where the colour is
   used, so whoever sets up a brand knows what they are picking.
 - **Language documents and singletons** are guessed from type names (`…Settings`, `l10n.locale`).
+- **Vercel team:** sites go to Anyday's team unless you gave a team id. A client's own team needs
+  its token on the API as `VERCEL_TOKEN_<team id>` (a secret, added on Vercel by Anyday, never in
+  the manifest); `register` warns while it is missing.
 
 ## register
 
@@ -130,6 +153,7 @@ workspace manager. The live API is `https://anyday-workspace-manager-sanity-api.
 - Registering again replaces the saved copy for that `id`, so a changed manifest needs no delete
   first.
 - It prints `Registered <name> (<id>)` when saved.
+- It warns when the manifest names a Vercel team the API has no token for yet.
 
 ## Signing in
 

package/dist/cli.mjs

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
 // src/cli.ts
-import { existsSync as existsSync3, writeFileSync } from "node:fs";
+import { existsSync as existsSync3, readFileSync as readFileSync4, writeFileSync } from "node:fs";
 import { resolve } from "node:path";
 import { createInterface } from "node:readline/promises";
 import { parseArgs } from "node:util";
@@ -236,6 +236,14 @@ var workspace_manager_schema_default = {
       description: "The Sanity project whose latest deployed Studio schema each workspace gets.",
       $ref: "#/definitions/name"
     },
+    studioOrigins: {
+      description: "Origins of the Studios that open these workspaces, e.g. https://acme.sanity.studio; every new workspace allows them.",
+      type: "array",
+      items: {
+        type: "string",
+        pattern: "^https?://[^/]+$"
+      }
+    },
     languages: {
       type: "object",
       required: ["document", "setupTypes"],
@@ -411,6 +419,7 @@ function configFrom(manifest) {
     site: manifest.site,
     siteEnv: manifest.siteEnv,
     schemaSourceProjectId: manifest.schemaSourceProjectId,
+    studioOrigins: manifest.studioOrigins ?? [],
     languageDocument: languages && ((code) => fill(languages.document, {
       code,
       codeUpper: code.toUpperCase(),
@@ -431,6 +440,7 @@ function configFrom(manifest) {
     },
     brand: {
       colorRoles: brand.colorRoles,
+      fonts: brand.theme.font !== void 0,
       documents: (values, homePageId) => brandDocuments(brand, values, homePageId)
     }
   };
@@ -558,11 +568,18 @@ function draftManifest(repo, answers, live = {}) {
   );
   if (!repo.repo) note("No GitHub remote found: set site.repo to owner/name");
   if (!repo.hasRevalidateRoute) note("No /api/revalidate route found: check site.revalidatePath");
+  if (answers.vercelTeamId)
+    note(
+      `Sites go to Vercel team ${answers.vercelTeamId}: the API needs VERCEL_TOKEN_${answers.vercelTeamId} before setups reach Vercel`
+    );
+  if (answers.studioOrigins?.length) note(`Studio: ${answers.studioOrigins.join(", ")}`);
+  else note('No Studio found: add studioOrigins, e.g. ["https://acme.sanity.studio"]');
   return {
     manifest: {
       id: answers.id,
       title: answers.title,
       organizationId: answers.organizationId,
+      ...answers.vercelTeamId ? { vercelTeamId: answers.vercelTeamId } : {},
       site: {
         repo: repo.repo ?? "owner/name",
         branch: repo.branch ?? "main",
@@ -570,6 +587,7 @@ function draftManifest(repo, answers, live = {}) {
       },
       siteEnv,
       schemaSourceProjectId: answers.schemaSourceProjectId,
+      ...answers.studioOrigins?.length ? { studioOrigins: answers.studioOrigins } : {},
       ...languages ? { languages } : {},
       content: {
         sections,
@@ -754,6 +772,17 @@ function placeholders(value, siteName, language, key, parent) {
   }
   return value;
 }
+function keepFileDefaults(draft, existing) {
+  const defaults = draft.manifest.brand.theme.defaults;
+  const previous = existing?.brand?.theme?.defaults ?? {};
+  const kept = Object.keys(previous).filter(
+    (field) => !(field in defaults) && hasReference(previous[field])
+  );
+  for (const field of kept) defaults[field] = previous[field];
+  if (kept.length)
+    draft.notes.push(`Kept from the existing manifest's theme defaults: ${kept.join(", ")}`);
+  return kept;
+}
 var hasReference = (value) => JSON.stringify(value ?? null).includes('"_ref":');
 function references(value) {
   if (Array.isArray(value)) return value.flatMap(references);
@@ -785,12 +814,29 @@ function sanityToken() {
   if (!existsSync(config)) return null;
   return JSON.parse(readFileSync(config, "utf8")).authToken ?? null;
 }
-async function organizationOf(projectId, token) {
+async function projectInfo(projectId, token) {
   const response = await fetch(`https://api.sanity.io/v2021-06-07/projects/${projectId}`, {
     headers: { Authorization: `Bearer ${token}` }
   });
   if (!response.ok) throw new Error(`Couldn't read project ${projectId}: ${response.status}`);
-  return (await response.json()).organizationId ?? "";
+  return await response.json();
+}
+async function organizationOf(projectId, token) {
+  return (await projectInfo(projectId, token)).organizationId ?? "";
+}
+async function studioOriginsOf(projectId, token) {
+  const response = await fetch(
+    `https://api.sanity.io/v2024-08-01/projects/${projectId}/user-applications`,
+    { headers: { Authorization: `Bearer ${token}` } }
+  );
+  if (!response.ok) throw new Error(`Couldn't list ${projectId}'s Studios: ${response.status}`);
+  const apps = await response.json();
+  const origins = apps.filter((app) => app.type === "studio").map(
+    (app) => app.urlType === "external" ? new URL(app.appHost).origin : `https://${app.appHost}.sanity.studio`
+  );
+  const { studioHost } = await projectInfo(projectId, token);
+  if (studioHost) origins.push(`https://${studioHost}.sanity.studio`);
+  return [...new Set(origins)];
 }
 var liveClient = ({ projectId, dataset, token }) => createClient({
   projectId,
@@ -939,6 +985,9 @@ Options:
   --yes              Accept the suggested id, title and project without asking
   --project <id>     The Sanity project new workspaces copy their schema from
   --org <id>         The Sanity organisation new workspaces are created in (found with --live)
+  --vercel-team <id> The client's own Vercel team for the sites (default: Anyday's team)
+  --studio <origin>  The Studio that opens new workspaces, e.g. https://acme.sanity.studio
+                     (found with --live from the project's deployed Studio)
   --live             Read the current theme, settings and starter pages from that project
   --dataset <name>   Dataset to read with --live (default: production)
   --starter <pages>  Comma-separated pages to copy as starter content: \`home\`, slugs or
@@ -965,20 +1014,23 @@ async function registerCommand(argv) {
   if (!token) throw new Error("register needs SANITY_AUTH_TOKEN or `npx sanity login`");
   const saved = await register({ dir: dirOf(positionals[0]), api, token });
   console.log(`Registered ${saved.title} (${saved.id})`);
+  for (const warning of saved.warnings ?? []) console.error(`Warning: ${warning}`);
 }
 async function init(argv) {
   const { values, positionals } = parseArgs({
     args: argv,
     allowPositionals: true,
     options: {
-      yes: { type: "boolean", default: false },
-      project: { type: "string" },
-      org: { type: "string" },
-      live: { type: "boolean", default: false },
-      dataset: { type: "string", default: "production" },
-      starter: { type: "string" },
-      force: { type: "boolean", default: false },
-      print: { type: "boolean", default: false }
+      "yes": { type: "boolean", default: false },
+      "project": { type: "string" },
+      "org": { type: "string" },
+      "studio": { type: "string" },
+      "vercel-team": { type: "string" },
+      "live": { type: "boolean", default: false },
+      "dataset": { type: "string", default: "production" },
+      "starter": { type: "string" },
+      "force": { type: "boolean", default: false },
+      "print": { type: "boolean", default: false }
     }
   });
   const root = dirOf(positionals[0]);
@@ -991,7 +1043,11 @@ async function init(argv) {
   const orgFor = async (projectId) => values.org ?? (token && projectId ? await organizationOf(projectId, token) : "");
   const repo = readRepo(root);
   const suggested = { ...suggestNames(repo.repo), project: values.project ?? repo.projectId ?? "" };
-  const answers = values.yes ? { ...suggested, org: await orgFor(suggested.project) } : await ask(suggested, orgFor);
+  const answers = values.yes ? {
+    ...suggested,
+    org: await orgFor(suggested.project),
+    vercelTeam: values["vercel-team"] ?? ""
+  } : await ask({ ...suggested, vercelTeam: values["vercel-team"] ?? "" }, orgFor);
   if (!answers.project)
     throw new Error("Pass --project <id>: the Sanity project to copy schemas from");
   if (!answers.org) throw new Error("Pass --org <id>, or --live to read it from the project");
@@ -999,7 +1055,9 @@ async function init(argv) {
     id: answers.id,
     title: answers.title,
     organizationId: answers.org,
-    schemaSourceProjectId: answers.project
+    ...answers.vercelTeam ? { vercelTeamId: answers.vercelTeam } : {},
+    schemaSourceProjectId: answers.project,
+    studioOrigins: values.studio ? [values.studio.replace(/\/+$/, "")] : token ? await studioOriginsOf(answers.project, token) : []
   };
   let draft = draftManifest(repo, base);
   if (token) {
@@ -1022,6 +1080,7 @@ async function init(argv) {
     });
     draft = draftManifest(repo, base, live);
   }
+  if (existsSync3(out)) keepFileDefaults(draft, readJson(out));
   configFrom(parseManifest(draft.manifest));
   const json = `${JSON.stringify(draft.manifest, null, 2)}
 `;
@@ -1032,6 +1091,13 @@ async function init(argv) {
 Check before registering:`);
   for (const note of draft.notes) console.error(`  - ${note}`);
 }
+function readJson(path) {
+  try {
+    return JSON.parse(readFileSync4(path, "utf8"));
+  } catch {
+    return null;
+  }
+}
 async function ask(suggested, orgFor) {
   const prompt = createInterface({ input: process.stdin, output: process.stderr });
   const question = async (label, fallback) => (await prompt.question(`${label}${fallback ? ` (${fallback})` : ""}: `)).trim() || fallback;
@@ -1040,7 +1106,11 @@ async function ask(suggested, orgFor) {
     const title = await question("Name shown in the app", suggested.title);
     const project = await question("Sanity project to copy schemas from", suggested.project);
     const org = await question("Sanity organisation to create workspaces in", await orgFor(project));
-    return { id, title, project, org };
+    const vercelTeam = await question(
+      "Vercel team for the sites, only if it's the client's own (Enter for Anyday's)",
+      suggested.vercelTeam
+    );
+    return { id, title, project, org, vercelTeam };
   } finally {
     prompt.close();
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@anyday/sanity-workspace-manager",
-  "version": "0.2.0",
+  "version": "0.5.0",
   "description": "Drafts a site repo's workspace-manager.json for the Anyday workspace manager",
   "repository": {
     "type": "git",