@sanity/cli-build 0.1.0

package/README.md

@@ -0,0 +1,3 @@
+# @sanity/cli-build
+
+Build utilities for Studio and App SDK.

package/dist/_exports/_internal.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Copies a directory from one location to another
+ *
+ * @internal
+ *
+ * @param srcDir - Source directory
+ * @param destDir - Destination directory
+ * @param skipExisting - Skip existing files
+ */
+export declare function copyDir(
+  srcDir: string,
+  destDir: string,
+  skipExisting?: boolean,
+): Promise<void>;
+
+/**
+ * @internal
+ */
+export declare function generateWebManifest(basePath: string): WebManifest;
+
+/**
+ * @internal
+ */
+export declare function getDefaultFaviconsPath(): Promise<string>;
+
+/**
+ * @internal
+ */
+declare interface WebManifest {
+  icons: {
+    sizes: string;
+    src: string;
+    type: string;
+  }[];
+}
+
+/**
+ * @internal
+ */
+export declare function writeFavicons(
+  basePath: string,
+  destDir: string,
+): Promise<void>;
+
+export {};

package/dist/_exports/_internal.js

@@ -0,0 +1,5 @@
+export * from '../actions/build/generateWebManifest.js';
+export * from '../actions/build/writeFavicons.js';
+export { copyDir } from '../util/copyDir.js';
+
+//# sourceMappingURL=_internal.js.map

package/dist/_exports/_internal.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/_exports/_internal.ts"],"sourcesContent":["export * from '../actions/build/generateWebManifest.js'\nexport * from '../actions/build/writeFavicons.js'\nexport {copyDir} from '../util/copyDir.js'\n"],"names":["copyDir"],"mappings":"AAAA,cAAc,0CAAyC;AACvD,cAAc,oCAAmC;AACjD,SAAQA,OAAO,QAAO,qBAAoB"}

package/dist/actions/build/generateWebManifest.js

@@ -0,0 +1,27 @@
+/**
+ * @internal
+ */ /**
+ * @internal
+ */ export function generateWebManifest(basePath) {
+    return {
+        icons: [
+            {
+                sizes: '96x96',
+                src: `${basePath}/favicon-96.png`,
+                type: 'image/png'
+            },
+            {
+                sizes: '192x192',
+                src: `${basePath}/favicon-192.png`,
+                type: 'image/png'
+            },
+            {
+                sizes: '512x512',
+                src: `${basePath}/favicon-512.png`,
+                type: 'image/png'
+            }
+        ]
+    };
+}
+
+//# sourceMappingURL=generateWebManifest.js.map

package/dist/actions/build/generateWebManifest.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/actions/build/generateWebManifest.ts"],"sourcesContent":["/**\n * @internal\n */\ninterface WebManifest {\n  icons: {\n    sizes: string\n    src: string\n    type: string\n  }[]\n}\n\n/**\n * @internal\n */\nexport function generateWebManifest(basePath: string): WebManifest {\n  return {\n    icons: [\n      {sizes: '96x96', src: `${basePath}/favicon-96.png`, type: 'image/png'},\n      {sizes: '192x192', src: `${basePath}/favicon-192.png`, type: 'image/png'},\n      {sizes: '512x512', src: `${basePath}/favicon-512.png`, type: 'image/png'},\n    ],\n  }\n}\n"],"names":["generateWebManifest","basePath","icons","sizes","src","type"],"mappings":"AAAA;;CAEC,GASD;;CAEC,GACD,OAAO,SAASA,oBAAoBC,QAAgB;IAClD,OAAO;QACLC,OAAO;YACL;gBAACC,OAAO;gBAASC,KAAK,GAAGH,SAAS,eAAe,CAAC;gBAAEI,MAAM;YAAW;YACrE;gBAACF,OAAO;gBAAWC,KAAK,GAAGH,SAAS,gBAAgB,CAAC;gBAAEI,MAAM;YAAW;YACxE;gBAACF,OAAO;gBAAWC,KAAK,GAAGH,SAAS,gBAAgB,CAAC;gBAAEI,MAAM;YAAW;SACzE;IACH;AACF"}

package/dist/actions/build/writeFavicons.js

@@ -0,0 +1,31 @@
+import fs from 'node:fs/promises';
+import path from 'node:path';
+import { readPackageUp } from 'read-package-up';
+import { copyDir } from '../../util/copyDir.js';
+import { writeWebManifest } from './writeWebManifest.js';
+/**
+ * @internal
+ */ export async function getDefaultFaviconsPath() {
+    const sanityCliPkgPath = (await readPackageUp({
+        cwd: import.meta.dirname
+    }))?.path;
+    if (!sanityCliPkgPath) {
+        throw new Error('Unable to resolve `@sanity/cli-build` module root');
+    }
+    return path.join(path.dirname(sanityCliPkgPath), 'static', 'favicons');
+}
+/**
+ * @internal
+ */ export async function writeFavicons(basePath, destDir) {
+    const faviconsPath = await getDefaultFaviconsPath();
+    await fs.mkdir(destDir, {
+        recursive: true
+    });
+    await copyDir(faviconsPath, destDir, true);
+    await writeWebManifest(basePath, destDir);
+    // Copy the /static/favicon.ico to /favicon.ico as well, because some tools/browsers
+    // blindly expects it to be there before requesting the HTML containing the actual path
+    await fs.copyFile(path.join(destDir, 'favicon.ico'), path.join(destDir, '..', 'favicon.ico'));
+}
+
+//# sourceMappingURL=writeFavicons.js.map

package/dist/actions/build/writeFavicons.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/actions/build/writeFavicons.ts"],"sourcesContent":["import fs from 'node:fs/promises'\nimport path from 'node:path'\n\nimport {readPackageUp} from 'read-package-up'\n\nimport {copyDir} from '../../util/copyDir.js'\nimport {writeWebManifest} from './writeWebManifest.js'\n\n/**\n * @internal\n */\nexport async function getDefaultFaviconsPath(): Promise<string> {\n  const sanityCliPkgPath = (await readPackageUp({cwd: import.meta.dirname}))?.path\n  if (!sanityCliPkgPath) {\n    throw new Error('Unable to resolve `@sanity/cli-build` module root')\n  }\n\n  return path.join(path.dirname(sanityCliPkgPath), 'static', 'favicons')\n}\n\n/**\n * @internal\n */\nexport async function writeFavicons(basePath: string, destDir: string): Promise<void> {\n  const faviconsPath = await getDefaultFaviconsPath()\n\n  await fs.mkdir(destDir, {recursive: true})\n  await copyDir(faviconsPath, destDir, true)\n  await writeWebManifest(basePath, destDir)\n\n  // Copy the /static/favicon.ico to /favicon.ico as well, because some tools/browsers\n  // blindly expects it to be there before requesting the HTML containing the actual path\n  await fs.copyFile(path.join(destDir, 'favicon.ico'), path.join(destDir, '..', 'favicon.ico'))\n}\n"],"names":["fs","path","readPackageUp","copyDir","writeWebManifest","getDefaultFaviconsPath","sanityCliPkgPath","cwd","dirname","Error","join","writeFavicons","basePath","destDir","faviconsPath","mkdir","recursive","copyFile"],"mappings":"AAAA,OAAOA,QAAQ,mBAAkB;AACjC,OAAOC,UAAU,YAAW;AAE5B,SAAQC,aAAa,QAAO,kBAAiB;AAE7C,SAAQC,OAAO,QAAO,wBAAuB;AAC7C,SAAQC,gBAAgB,QAAO,wBAAuB;AAEtD;;CAEC,GACD,OAAO,eAAeC;IACpB,MAAMC,mBAAoB,CAAA,MAAMJ,cAAc;QAACK,KAAK,YAAYC,OAAO;IAAA,EAAC,GAAIP;IAC5E,IAAI,CAACK,kBAAkB;QACrB,MAAM,IAAIG,MAAM;IAClB;IAEA,OAAOR,KAAKS,IAAI,CAACT,KAAKO,OAAO,CAACF,mBAAmB,UAAU;AAC7D;AAEA;;CAEC,GACD,OAAO,eAAeK,cAAcC,QAAgB,EAAEC,OAAe;IACnE,MAAMC,eAAe,MAAMT;IAE3B,MAAML,GAAGe,KAAK,CAACF,SAAS;QAACG,WAAW;IAAI;IACxC,MAAMb,QAAQW,cAAcD,SAAS;IACrC,MAAMT,iBAAiBQ,UAAUC;IAEjC,oFAAoF;IACpF,uFAAuF;IACvF,MAAMb,GAAGiB,QAAQ,CAAChB,KAAKS,IAAI,CAACG,SAAS,gBAAgBZ,KAAKS,IAAI,CAACG,SAAS,MAAM;AAChF"}

package/dist/actions/build/writeWebManifest.js

@@ -0,0 +1,12 @@
+import fs from 'node:fs/promises';
+import path from 'node:path';
+import { skipIfExistsError } from '../../util/copyDir.js';
+import { generateWebManifest } from './generateWebManifest.js';
+/**
+ * @internal
+ */ export async function writeWebManifest(basePath, destDir) {
+    const content = JSON.stringify(generateWebManifest(basePath), null, 2);
+    await fs.writeFile(path.join(destDir, 'manifest.webmanifest'), content, 'utf8').catch(skipIfExistsError);
+}
+
+//# sourceMappingURL=writeWebManifest.js.map

package/dist/actions/build/writeWebManifest.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/actions/build/writeWebManifest.ts"],"sourcesContent":["import fs from 'node:fs/promises'\nimport path from 'node:path'\n\nimport {skipIfExistsError} from '../../util/copyDir.js'\nimport {generateWebManifest} from './generateWebManifest.js'\n\n/**\n * @internal\n */\nexport async function writeWebManifest(basePath: string, destDir: string): Promise<void> {\n  const content = JSON.stringify(generateWebManifest(basePath), null, 2)\n  await fs\n    .writeFile(path.join(destDir, 'manifest.webmanifest'), content, 'utf8')\n    .catch(skipIfExistsError)\n}\n"],"names":["fs","path","skipIfExistsError","generateWebManifest","writeWebManifest","basePath","destDir","content","JSON","stringify","writeFile","join","catch"],"mappings":"AAAA,OAAOA,QAAQ,mBAAkB;AACjC,OAAOC,UAAU,YAAW;AAE5B,SAAQC,iBAAiB,QAAO,wBAAuB;AACvD,SAAQC,mBAAmB,QAAO,2BAA0B;AAE5D;;CAEC,GACD,OAAO,eAAeC,iBAAiBC,QAAgB,EAAEC,OAAe;IACtE,MAAMC,UAAUC,KAAKC,SAAS,CAACN,oBAAoBE,WAAW,MAAM;IACpE,MAAML,GACHU,SAAS,CAACT,KAAKU,IAAI,CAACL,SAAS,yBAAyBC,SAAS,QAC/DK,KAAK,CAACV;AACX"}

package/dist/util/copyDir.js

@@ -0,0 +1,63 @@
+import { constants as fsConstants } from 'node:fs';
+import fs from 'node:fs/promises';
+import path from 'node:path';
+/**
+ * Tries to read a directory, and returns an empty array if the directory does not exist
+ *
+ * @internal
+ *
+ * @param dir - Directory to read
+ * @returns List of files in the directory
+ */ async function tryReadDir(dir) {
+    try {
+        const content = await fs.readdir(dir);
+        return content;
+    } catch (err) {
+        if (err.code === 'ENOENT') {
+            return [];
+        }
+        throw err;
+    }
+}
+/**
+ * Skips an error if the file already exists
+ *
+ * @internal
+ *
+ * @param err - Error to check
+ */ export function skipIfExistsError(err) {
+    if (err.code === 'EEXIST') {
+        return;
+    }
+    throw err;
+}
+/**
+ * Copies a directory from one location to another
+ *
+ * @internal
+ *
+ * @param srcDir - Source directory
+ * @param destDir - Destination directory
+ * @param skipExisting - Skip existing files
+ */ export async function copyDir(srcDir, destDir, skipExisting) {
+    await fs.mkdir(destDir, {
+        recursive: true
+    });
+    for (const file of (await tryReadDir(srcDir))){
+        const srcFile = path.resolve(srcDir, file);
+        if (srcFile === destDir) {
+            continue;
+        }
+        const destFile = path.resolve(destDir, file);
+        const stat = await fs.stat(srcFile);
+        if (stat.isDirectory()) {
+            await copyDir(srcFile, destFile, skipExisting);
+        } else if (skipExisting) {
+            await fs.copyFile(srcFile, destFile, fsConstants.COPYFILE_EXCL).catch(skipIfExistsError);
+        } else {
+            await fs.copyFile(srcFile, destFile);
+        }
+    }
+}
+
+//# sourceMappingURL=copyDir.js.map

package/dist/util/copyDir.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/util/copyDir.ts"],"sourcesContent":["import {constants as fsConstants} from 'node:fs'\nimport fs from 'node:fs/promises'\nimport path from 'node:path'\n\n/**\n * Tries to read a directory, and returns an empty array if the directory does not exist\n *\n * @internal\n *\n * @param dir - Directory to read\n * @returns List of files in the directory\n */\nasync function tryReadDir(dir: string): Promise<string[]> {\n  try {\n    const content = await fs.readdir(dir)\n    return content\n  } catch (err) {\n    if (err.code === 'ENOENT') {\n      return []\n    }\n\n    throw err\n  }\n}\n\n/**\n * Skips an error if the file already exists\n *\n * @internal\n *\n * @param err - Error to check\n */\nexport function skipIfExistsError(err: Error & {code: string}) {\n  if (err.code === 'EEXIST') {\n    return\n  }\n\n  throw err\n}\n\n/**\n * Copies a directory from one location to another\n *\n * @internal\n *\n * @param srcDir - Source directory\n * @param destDir - Destination directory\n * @param skipExisting - Skip existing files\n */\nexport async function copyDir(\n  srcDir: string,\n  destDir: string,\n  skipExisting?: boolean,\n): Promise<void> {\n  await fs.mkdir(destDir, {recursive: true})\n\n  for (const file of await tryReadDir(srcDir)) {\n    const srcFile = path.resolve(srcDir, file)\n    if (srcFile === destDir) {\n      continue\n    }\n\n    const destFile = path.resolve(destDir, file)\n    const stat = await fs.stat(srcFile)\n\n    if (stat.isDirectory()) {\n      await copyDir(srcFile, destFile, skipExisting)\n    } else if (skipExisting) {\n      await fs.copyFile(srcFile, destFile, fsConstants.COPYFILE_EXCL).catch(skipIfExistsError)\n    } else {\n      await fs.copyFile(srcFile, destFile)\n    }\n  }\n}\n"],"names":["constants","fsConstants","fs","path","tryReadDir","dir","content","readdir","err","code","skipIfExistsError","copyDir","srcDir","destDir","skipExisting","mkdir","recursive","file","srcFile","resolve","destFile","stat","isDirectory","copyFile","COPYFILE_EXCL","catch"],"mappings":"AAAA,SAAQA,aAAaC,WAAW,QAAO,UAAS;AAChD,OAAOC,QAAQ,mBAAkB;AACjC,OAAOC,UAAU,YAAW;AAE5B;;;;;;;CAOC,GACD,eAAeC,WAAWC,GAAW;IACnC,IAAI;QACF,MAAMC,UAAU,MAAMJ,GAAGK,OAAO,CAACF;QACjC,OAAOC;IACT,EAAE,OAAOE,KAAK;QACZ,IAAIA,IAAIC,IAAI,KAAK,UAAU;YACzB,OAAO,EAAE;QACX;QAEA,MAAMD;IACR;AACF;AAEA;;;;;;CAMC,GACD,OAAO,SAASE,kBAAkBF,GAA2B;IAC3D,IAAIA,IAAIC,IAAI,KAAK,UAAU;QACzB;IACF;IAEA,MAAMD;AACR;AAEA;;;;;;;;CAQC,GACD,OAAO,eAAeG,QACpBC,MAAc,EACdC,OAAe,EACfC,YAAsB;IAEtB,MAAMZ,GAAGa,KAAK,CAACF,SAAS;QAACG,WAAW;IAAI;IAExC,KAAK,MAAMC,QAAQ,CAAA,MAAMb,WAAWQ,OAAM,EAAG;QAC3C,MAAMM,UAAUf,KAAKgB,OAAO,CAACP,QAAQK;QACrC,IAAIC,YAAYL,SAAS;YACvB;QACF;QAEA,MAAMO,WAAWjB,KAAKgB,OAAO,CAACN,SAASI;QACvC,MAAMI,OAAO,MAAMnB,GAAGmB,IAAI,CAACH;QAE3B,IAAIG,KAAKC,WAAW,IAAI;YACtB,MAAMX,QAAQO,SAASE,UAAUN;QACnC,OAAO,IAAIA,cAAc;YACvB,MAAMZ,GAAGqB,QAAQ,CAACL,SAASE,UAAUnB,YAAYuB,aAAa,EAAEC,KAAK,CAACf;QACxE,OAAO;YACL,MAAMR,GAAGqB,QAAQ,CAACL,SAASE;QAC7B;IACF;AACF"}

package/package.json

@@ -0,0 +1,76 @@
+{
+  "name": "@sanity/cli-build",
+  "version": "0.1.0",
+  "description": "Internal Sanity package for building studios and apps",
+  "keywords": [
+    "cli",
+    "cms",
+    "content",
+    "headless",
+    "realtime",
+    "sanity",
+    "tool"
+  ],
+  "homepage": "https://github.com/sanity-io/cli",
+  "bugs": "https://github.com/sanity-io/cli/issues",
+  "license": "MIT",
+  "author": "Sanity.io <hello@sanity.io>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sanity-io/cli.git",
+    "directory": "packages/@sanity/cli-build"
+  },
+  "files": [
+    "./dist",
+    "!./dist/**/__tests__",
+    "./static"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/_exports/_internal.js",
+  "types": "./dist/_exports/_internal.d.ts",
+  "exports": {
+    "./_internal": {
+      "source": "./src/_exports/_internal.ts",
+      "default": "./dist/_exports/_internal.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "swc --delete-dir-on-start --strip-leading-paths --out-dir dist/ src --ignore '**/*.test.ts' --ignore '**/__tests__/**'",
+    "build:types": "pkg-utils build --emitDeclarationOnly",
+    "check:types": "tsc --noEmit",
+    "lint": "eslint .",
+    "publint": "publint",
+    "test": "vitest run",
+    "posttest": "pnpm run lint",
+    "test:coverage": "vitest run --coverage",
+    "test:watch": "vitest",
+    "watch": "swc --delete-dir-on-start --strip-leading-paths --out-dir dist/ --watch src"
+  },
+  "dependencies": {
+    "read-package-up": "catalog:"
+  },
+  "devDependencies": {
+    "@eslint/compat": "catalog:",
+    "@repo/package.config": "workspace:*",
+    "@repo/tsconfig": "workspace:*",
+    "@sanity/cli-test": "workspace:*",
+    "@sanity/eslint-config-cli": "workspace:^",
+    "@sanity/pkg-utils": "catalog:",
+    "@swc/cli": "catalog:",
+    "@swc/core": "catalog:",
+    "@types/node": "catalog:",
+    "@vitest/coverage-istanbul": "catalog:",
+    "eslint": "catalog:",
+    "publint": "catalog:",
+    "typescript": "catalog:",
+    "vitest": "catalog:"
+  },
+  "engines": {
+    "node": ">=20.19.1 <22 || >=22.12"
+  }
+}

package/static/favicons/favicon.svg

@@ -0,0 +1,12 @@
+<svg width="512" height="512" viewBox="0 0 512 512" fill="none" xmlns="http://www.w3.org/2000/svg">
+<rect width="512" height="512" fill="#0B0B0B"/>
+<rect width="256" height="256" fill="#0B0B0B"/>
+<g clip-path="url(#clip0_261_6485)">
+<path d="M431.519 304.966L417.597 280.733L350.26 321.759L425.051 226.504L436.358 219.867L433.56 215.662L438.697 209.096L415.097 189.445L404.295 203.215L186.253 330.829L266.869 233.849L417.024 151.513L402.758 123.926L320.972 168.755L361.246 120.336L338.174 100L247.535 209.026L157.515 258.413L226.435 167.267L269.621 144.782L255.906 116.888L130.085 182.407L164.396 136.987L140.429 117.785L68 213.678L69.1238 214.576L82.6554 242.139L162.951 200.31L89.7653 297.077L101.76 306.69L108.893 320.484L193.431 274.12L100.338 386.121L123.411 406.457L128.044 400.883L352.623 269.018L278.061 364.014L279.277 365.029L279.162 365.1L294.62 392.002L393.791 331.561L355.604 393.207L381.199 410L442 311.863L431.519 304.966Z" fill="white"/>
+</g>
+<defs>
+<clipPath id="clip0_261_6485">
+<rect width="374" height="310" fill="white" transform="translate(68 100)"/>
+</clipPath>
+</defs>
+</svg>