@sanity/cli 8.22.1 → 8.24.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/cli",
-  "version": "8.22.1",
+  "version": "8.24.0",
   "description": "Sanity CLI tool for managing Sanity projects and organizations",
   "keywords": [
     "cli",
@@ -63,8 +63,8 @@
     "@oclif/plugin-help": "^6.2.53",
     "@oclif/plugin-not-found": "^3.2.88",
     "@sanity/blueprints": "^0.28.0",
-    "@sanity/cli-build": "^7.0.0",
-    "@sanity/cli-core": "^3.11.1",
+    "@sanity/cli-build": "^7.0.2",
+    "@sanity/cli-core": "^3.13.0",
     "@sanity/client": "^8.9.0",
     "@sanity/codegen": "^8.2.0",
     "@sanity/descriptors": "^1.3.0",
@@ -73,20 +73,20 @@
     "@sanity/id-utils": "^1.1.0",
     "@sanity/import": "^7.0.4",
     "@sanity/migrate": "^8.0.5",
-    "@sanity/runtime-cli": "17.15.0",
+    "@sanity/runtime-cli": "^17.16.0",
     "@sanity/schema": "^6.17.0",
     "@sanity/schema-descriptor-utils": "^1.3.3",
     "@sanity/telemetry": "^1.1.0",
     "@sanity/template-validator": "^3.1.1",
     "@sanity/types": "^6.17.0",
-    "@sanity/workbench-cli": "^2.13.0",
+    "@sanity/workbench-cli": "^2.14.0",
     "@sanity/worker-channels": "^2.0.0",
     "@sanity/workflow-cli": "0.36.0",
     "@sanity/workflow-engine": "0.36.0",
     "@vercel/frameworks": "3.29.0",
     "chokidar": "^5.0.0",
     "console-table-printer": "^2.15.0",
-    "eventsource": "^5.1.1",
+    "eventsource": "^5.1.3",
     "execa": "^10.0.1",
     "form-data": "^4.0.5",
     "get-latest-version": "^6.0.1",
@@ -126,9 +126,10 @@
   },
   "devDependencies": {
     "@eslint/compat": "^2.1.0",
+    "@oxc-project/types": "0.152.0",
     "@repo/package.config": "0.0.1",
     "@repo/tsconfig": "3.70.0",
-    "@sanity/cli-test": "21.0.1",
+    "@sanity/cli-test": "23.0.0",
     "@sanity/eslint-config-cli": "1.1.3",
     "@sanity/pkg-utils": "^12.3.4",
     "@swc/cli": "^0.8.1",
@@ -137,7 +138,7 @@
     "@types/jsdom": "^28.0.3",
     "@types/lodash-es": "^4.17.12",
     "@types/minimist": "^1.2.5",
-    "@types/node": "^22.20.0",
+    "@types/node": "^22.20.5",
     "@types/picomatch": "^4.0.3",
     "@types/semver": "^7.7.1",
     "@types/tar-stream": "^3.1.4",

package/templates/media-library-config/README.md

@@ -0,0 +1,52 @@
+# Media Library config app
+
+A **Media Library config app**: it defines custom fields (aspects) for your
+organization's Sanity Media Library. It has no UI of its own — the CLI
+bundles the field modules in `src/fields/` into a remote that the Media
+Library loads to drive asset metadata editing.
+
+## Commands
+
+- `npm run dev` starts the dev server and prints a Sanity Dashboard URL.
+  Open it, sign in, and go to the Media Library — the fields defined here
+  appear on assets, served live from your machine.
+- `npm run build` builds the config for production.
+- `npm run deploy` deploys the config to your organization.
+
+## Defining fields
+
+Each field lives in `src/fields/<name>.tsx` as a default-exported
+`defineField(...)` — the same API as Sanity Studio — and is registered in
+`sanity.cli.ts` under `fields`. Two examples are included:
+
+- `caption` — a plain field rendered by the Media Library's standard
+  controls, with validation and an initial value.
+- `notes` — a field with a custom input component (`components.input`).
+
+The `name` of a field must match its entry in `sanity.cli.ts`: it becomes
+the key the field's data is stored under on assets.
+
+## Custom input components
+
+Custom inputs render as **islands**: isolated React roots using this app's
+own bundled `react`, `@sanity/ui`, and `sanity` copies — no version coupling
+with the Media Library itself. The rules that keep an input working inside
+an island are documented in `src/fields/notes.tsx`; the supported `sanity`
+import surface is enforced at lint time by the override in
+`eslint.config.mjs`. An import outside that surface has no provider inside
+the island and fails at runtime.
+
+## Validation and initial values
+
+Validation rules and `initialValue` resolvers are config code executed by
+the Media Library. `initialValue` runs when a new asset is uploaded;
+resolver functions receive `(params, context)` where `context` carries the
+uploaded asset document and its instance document (e.g. image metadata).
+
+## Field modules must be loadable under plain Node.js
+
+Field definitions are evaluated outside the browser when the config is
+synchronized. Browser-only libraries that touch `window` at import time must
+be loaded lazily from a component module
+(`lazy(() => import('./MapInput'))`), never imported at the top of a field
+module.

package/templates/media-library-config/eslint.config.txt

@@ -0,0 +1,52 @@
+import studio from '@sanity/eslint-config-studio'
+import tseslint from 'typescript-eslint'
+
+export default [
+  ...studio,
+  {
+    files: ['src/fields/**'],
+    // Flat config does not merge plugin registrations across config objects,
+    // so the plugin must be declared here even though the studio config also
+    // registers it (same module instance, so no redefinition conflict).
+    plugins: {'@typescript-eslint': tseslint.plugin},
+    rules: {
+      // The supported `sanity` surface for Media Library field modules.
+      // Custom inputs render in an isolated island root: imports outside
+      // this list have no provider there and fail at runtime with the
+      // field-failure card. Type-only imports are erased at build time and
+      // always safe.
+      '@typescript-eslint/no-restricted-imports': [
+        'error',
+        {
+          paths: [
+            {
+              name: 'sanity',
+              allowImportNames: [
+                'defineField',
+                'defineArrayMember',
+                'defineType',
+                'set',
+                'unset',
+                'setIfMissing',
+                'useFormValue',
+                'useGetFormValue',
+                'useCurrentLocale',
+                'useDateTimeFormat',
+              ],
+              allowTypeImports: true,
+              message:
+                'Not part of the supported Media Library field surface. Custom inputs render in an isolated island: this import has no provider there and will show the field-failure card at runtime. Call onChange with plain patches (set/unset), never PatchEvent.',
+            },
+          ],
+          patterns: [
+            {
+              group: ['sanity/*'],
+              message:
+                'Subpath imports from `sanity` are internals, not part of the supported Media Library field surface.',
+            },
+          ],
+        },
+      ],
+    },
+  },
+]

package/templates/media-library-config/src/fields/caption.tsx

@@ -0,0 +1,29 @@
+import {defineField} from 'sanity'
+
+/**
+ * A plain field: no custom input component, so the Media Library renders it
+ * with its standard aspect-form controls. Start here — most fields never
+ * need a custom component. The definition uses the same `defineField` API as
+ * Sanity Studio; validation rules and initial values run in the Media
+ * Library's own runtime.
+ */
+export default defineField({
+  name: 'caption',
+  title: 'Caption',
+  type: 'object',
+  fields: [
+    defineField({
+      name: 'text',
+      title: 'Text',
+      type: 'string',
+      validation: (Rule) => Rule.required().error('A caption is required'),
+    }),
+    defineField({
+      name: 'language',
+      title: 'Language',
+      type: 'string',
+      options: {list: ['en', 'de', 'no']},
+      initialValue: 'en',
+    }),
+  ],
+})

package/templates/media-library-config/src/fields/notes.tsx

@@ -0,0 +1,54 @@
+import {Stack, Text, TextArea} from '@sanity/ui'
+import type {ChangeEvent, Ref} from 'react'
+import {type InputProps, defineField, set, unset} from 'sanity'
+
+/**
+ * A custom input component. It renders as an *island*: an isolated React
+ * root using this app's own bundled `react` and `@sanity/ui` copies, so
+ * there is no version coupling with the Media Library host.
+ *
+ * Rules that keep an input working inside the island:
+ *
+ * - Call `onChange` with plain patches (`set(...)` / `unset()`), never
+ *   `PatchEvent.from(...)` — patches cross the island boundary as plain
+ *   data, and a PatchEvent instance from this bundle's `sanity` copy fails
+ *   the host's checks.
+ * - Wire `elementProps.id` and `elementProps.ref` onto the focusable
+ *   control, so host-driven focus (validation links, presence) reaches it.
+ * - Only import the supported `sanity` surface (enforced by the override in
+ *   `eslint.config.mjs`); other exports have no provider inside the island
+ *   and fail at runtime with the field-failure card.
+ * - Keep the module loadable under plain Node.js (field definitions are
+ *   evaluated outside the browser when the config is synchronized):
+ *   browser-only libraries must be imported lazily from a component module.
+ */
+function NotesInput(props: InputProps) {
+  const {value, onChange, elementProps} = props
+  const text = typeof value === 'string' ? value : ''
+
+  return (
+    <Stack space={2}>
+      <TextArea
+        id={elementProps?.id}
+        ref={elementProps?.ref as Ref<HTMLTextAreaElement>}
+        value={text}
+        rows={4}
+        placeholder="Add notes..."
+        onChange={(event: ChangeEvent<HTMLTextAreaElement>) => {
+          const next = event.currentTarget.value
+          onChange(next ? set(next) : unset())
+        }}
+      />
+      <Text size={1} muted>
+        {text.length} characters
+      </Text>
+    </Stack>
+  )
+}
+
+export default defineField({
+  name: 'notes',
+  title: 'Notes',
+  type: 'text',
+  components: {input: NotesInput},
+})

package/templates/shopify/.gitignore

@@ -1,26 +0,0 @@
-# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
-
-# Dependencies
-/node_modules
-/.pnp
-.pnp.js
-
-# Compiled Sanity Studio
-/dist
-
-# Temporary Sanity runtime, generated by the CLI on every dev server start
-/.sanity
-
-# Logs
-/logs
-*.log
-
-# Coverage directory used by testing tools
-/coverage
-
-# Misc
-.DS_Store
-*.pem
-
-# Typescript
-*.tsbuildinfo