@sanity/cli 7.18.0 → 8.0.0

package/oclif.manifest.json

@@ -1344,6 +1344,112 @@
         "versions.js"
       ]
     },
+    "assets:upload": {
+      "aliases": [],
+      "args": {},
+      "description": "Upload one local image or file to a Sanity dataset and print the asset document as JSON",
+      "examples": [
+        {
+          "command": "<%= config.bin %> <%= command.id %> --file ./hero.png --type image --dataset production",
+          "description": "Upload an image using the configured project"
+        },
+        {
+          "command": "<%= config.bin %> <%= command.id %> --file ./brief.pdf --type file --content-type application/pdf --project-id abc123 --dataset production",
+          "description": "Upload a file with explicit project, dataset, and MIME type"
+        }
+      ],
+      "flags": {
+        "project-id": {
+          "char": "p",
+          "description": "Project ID to upload the asset to (overrides CLI configuration)",
+          "helpGroup": "OVERRIDE",
+          "name": "project-id",
+          "hasDynamicHelp": false,
+          "helpValue": "<id>",
+          "multiple": false,
+          "type": "option"
+        },
+        "dataset": {
+          "char": "d",
+          "description": "Dataset to upload the asset to (overrides CLI configuration)",
+          "helpGroup": "OVERRIDE",
+          "name": "dataset",
+          "hasDynamicHelp": false,
+          "helpValue": "<name>",
+          "multiple": false,
+          "type": "option"
+        },
+        "content-type": {
+          "description": "MIME type of the asset, such as image/png or application/pdf",
+          "name": "content-type",
+          "hasDynamicHelp": false,
+          "helpValue": "<mime-type>",
+          "multiple": false,
+          "type": "option"
+        },
+        "file": {
+          "description": "Path to the local file to upload",
+          "name": "file",
+          "required": true,
+          "hasDynamicHelp": false,
+          "helpValue": "<path>",
+          "multiple": false,
+          "type": "option"
+        },
+        "filename": {
+          "description": "Original filename stored on the asset document. Defaults to the local filename",
+          "name": "filename",
+          "hasDynamicHelp": false,
+          "helpValue": "<filename>",
+          "multiple": false,
+          "type": "option"
+        },
+        "type": {
+          "description": "Asset type to create",
+          "name": "type",
+          "default": "image",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "image",
+            "file"
+          ],
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [
+        "asset:upload"
+      ],
+      "id": "assets:upload",
+      "pluginAlias": "@sanity/cli",
+      "pluginName": "@sanity/cli",
+      "pluginType": "core",
+      "strict": true,
+      "telemetry": {
+        "redactedFlags": [
+          {
+            "canonical": "--file",
+            "flags": [
+              "--file"
+            ]
+          },
+          {
+            "canonical": "--filename",
+            "flags": [
+              "--filename"
+            ]
+          }
+        ]
+      },
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "assets",
+        "upload.js"
+      ]
+    },
     "backups:disable": {
       "aliases": [],
       "args": {
@@ -5097,6 +5203,10 @@
           "command": "<%= config.bin %> <%= command.id %> \"CI Token\" --role=editor --yes",
           "description": "Create a token in unattended mode"
         },
+        {
+          "command": "<%= config.bin %> <%= command.id %> \"Build Token\" --expires-at 2027-01-01",
+          "description": "Create a token that expires on a given date"
+        },
         {
           "command": "<%= config.bin %> <%= command.id %> \"API Token\" --json",
           "description": "Output token information as JSON"
@@ -5117,6 +5227,14 @@
           "multiple": false,
           "type": "option"
         },
+        "expires-at": {
+          "description": "Date or timestamp the token expires (ISO 8601; tokens never expire by default)",
+          "name": "expires-at",
+          "hasDynamicHelp": false,
+          "helpValue": "2027-01-01",
+          "multiple": false,
+          "type": "option"
+        },
         "json": {
           "description": "Output as JSON",
           "name": "json",
@@ -5278,6 +5396,100 @@
         "list.js"
       ]
     },
+    "tokens:rotate": {
+      "aliases": [],
+      "args": {},
+      "description": "Rotate an API token, replacing its secret with a new one",
+      "examples": [
+        {
+          "command": "echo \"$SANITY_TOKEN\" | <%= config.bin %> <%= command.id %>",
+          "description": "Rotate the token piped on standard input"
+        },
+        {
+          "command": "<%= config.bin %> <%= command.id %> < token.txt",
+          "description": "Rotate a token read from a file"
+        },
+        {
+          "command": "echo \"$SANITY_TOKEN\" | <%= config.bin %> <%= command.id %> --json",
+          "description": "Output the rotated token as JSON"
+        }
+      ],
+      "flags": {
+        "json": {
+          "description": "Output as JSON",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "token": {
+          "char": "t",
+          "description": "Token to rotate (prefer standard input to keep it out of shell history)",
+          "name": "token",
+          "hasDynamicHelp": false,
+          "helpValue": "<token>",
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [
+        "token:rotate"
+      ],
+      "id": "tokens:rotate",
+      "pluginAlias": "@sanity/cli",
+      "pluginName": "@sanity/cli",
+      "pluginType": "core",
+      "strict": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "tokens",
+        "rotate.js"
+      ]
+    },
+    "typegen:generate": {
+      "aliases": [],
+      "args": {},
+      "description": "Sanity TypeGen\n\nConfiguration:\nThis command can utilize configuration settings defined in a `sanity-typegen.json` file. These settings include:\n\n- \"path\": Specifies a glob pattern to locate your TypeScript or JavaScript files.\n  Default: \"./src/**/*.{ts,tsx,js,jsx}\"\n\n- \"schema\": Defines the path to your Sanity schema file. This file should be generated using the `sanity schema extract` command.\n  Default: \"schema.json\"\n\n- \"generates\": Indicates the path where the generated TypeScript type definitions will be saved.\n  Default: \"./sanity.types.ts\"\n\nThe default configuration values listed above are used if not overridden in your `sanity-typegen.json` configuration file. To customize the behavior of the type generation, adjust these properties in the configuration file according to your project's needs.\n\nNote:\n- The `sanity schema extract` command is a prerequisite for extracting your Sanity Studio schema into a `schema.json` file, which is then used by the `sanity typegen generate` command to generate type definitions.",
+      "examples": [
+        {
+          "command": "<%= config.bin %> <%= command.id %>",
+          "description": "Generate TypeScript type definitions from a Sanity Studio schema extracted using the `sanity schema extract` command."
+        }
+      ],
+      "flags": {
+        "config-path": {
+          "description": "[Default: sanity-typegen.json] Specifies the path to the typegen configuration file. This file should be a JSON file that contains settings for the type generation process.",
+          "name": "config-path",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "watch": {
+          "description": "[Default: false] Run the typegen in watch mode",
+          "name": "watch",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [
+        "typegen:generate"
+      ],
+      "id": "typegen:generate",
+      "pluginAlias": "@sanity/cli",
+      "pluginName": "@sanity/cli",
+      "pluginType": "core",
+      "strict": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "typegen",
+        "generate.js"
+      ]
+    },
     "users:invite": {
       "aliases": [],
       "args": {
@@ -5949,5 +6161,5 @@
       ]
     }
   },
-  "version": "7.18.0"
+  "version": "8.0.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/cli",
-  "version": "7.18.0",
+  "version": "8.0.0",
   "description": "Sanity CLI tool for managing Sanity projects and organizations",
   "keywords": [
     "cli",
@@ -63,14 +63,14 @@
     "@oclif/plugin-help": "^6.2.53",
     "@oclif/plugin-not-found": "^3.2.88",
     "@sanity/client": "^7.25.0",
-    "@sanity/codegen": "^7.0.3",
+    "@sanity/codegen": "^8.0.0",
     "@sanity/descriptors": "^1.3.0",
     "@sanity/export": "^6.2.0",
     "@sanity/generate-help-url": "^4.0.0",
     "@sanity/id-utils": "^1.0.0",
     "@sanity/import": "^6.0.3",
-    "@sanity/migrate": "^8.0.1",
-    "@sanity/runtime-cli": "^17.3.0",
+    "@sanity/migrate": "^8.0.2",
+    "@sanity/runtime-cli": "^17.4.0",
     "@sanity/schema": "^6.7.0",
     "@sanity/telemetry": "^1.1.0",
     "@sanity/template-validator": "^3.1.0",
@@ -86,7 +86,7 @@
     "execa": "^9.6.0",
     "form-data": "^4.0.5",
     "get-latest-version": "^6.0.1",
-    "groq-js": "^1.30.3",
+    "groq-js": "^2.0.0",
     "gunzip-maybe": "^1.4.2",
     "import-meta-resolve": "^4.2.0",
     "is-installed-globally": "^1.0.0",
@@ -113,6 +113,7 @@
     "skills": "^1.5.9",
     "smol-toml": "^1.6.1",
     "string-argv": "^0.3.2",
+    "string-width": "^7.2.0",
     "tar": "^7.5.18",
     "tar-fs": "^3.1.2",
     "tar-stream": "^3.2.0",
@@ -121,11 +122,12 @@
     "typeid-js": "^1.2.0",
     "vite": "^8.2.0",
     "which": "^6.0.1",
+    "wrap-ansi": "^9.0.2",
     "yaml": "^2.9.0",
     "zod": "^4.4.3",
-    "@sanity/cli-build": "^5.1.0",
-    "@sanity/cli-core": "^2.8.1",
-    "@sanity/workbench-cli": "^1.10.0"
+    "@sanity/cli-build": "^5.2.0",
+    "@sanity/workbench-cli": "^2.0.0",
+    "@sanity/cli-core": "^3.0.0"
   },
   "devDependencies": {
     "@eslint/compat": "^2.1.0",
@@ -158,9 +160,9 @@
     "sanity": "^6.7.0",
     "typescript": "^6.0.3",
     "vitest": "^4.1.10",
-    "@repo/tsconfig": "3.70.0",
     "@repo/package.config": "0.0.1",
-    "@sanity/cli-test": "9.0.2",
+    "@repo/tsconfig": "3.70.0",
+    "@sanity/cli-test": "10.0.0",
     "@sanity/eslint-config-cli": "1.1.3"
   },
   "peerDependencies": {

package/templates/shopify/components/inputs/ShopifyMetafield.tsx

@@ -0,0 +1,20 @@
+import {Card, Code} from '@sanity/ui'
+import {type ObjectInputProps} from 'sanity'
+import {formatMetafieldValue} from '../../utils/formatMetafieldValue'
+
+/**
+ * Shows a synced metafield's value. `value` isn't a declared field on `shopifyMetafield` — its shape
+ * depends on the Shopify metafield type — so it's read from the raw object value here.
+ */
+export default function ShopifyMetafield(props: ObjectInputProps) {
+  const {type, value} = (props.value || {}) as {type?: string; value?: unknown}
+  const text = formatMetafieldValue(type, value)
+
+  return (
+    <Card border padding={3} radius={1} tone="transparent">
+      <Code size={1} style={{margin: 0}}>
+        {text}
+      </Code>
+    </Card>
+  )
+}

package/templates/shopify/docs/features.md

@@ -12,6 +12,30 @@ Inside `/schemaTypes` you'll find schema definitions for all the content types.
 - `/schemaTypes/documents/`: Document types determines the shape of the JSON documents that's stored in your content lake. This is where you define the content forms for things like collections, products, product variants, as well as articles.
 - `/schemaTypes/objects/`: General purpose & re-usable content structures, such as links, custom product options and modules.
 
+## Shopify metafields
+
+If you've selected metafield namespaces to import in Sanity Connect, your product and collection metafields are synced to `store.metafields` and shown under a **Metafields** fieldset.
+
+Each entry holds the metafield's `namespace`, `key`, Shopify `type` and `value`:
+
+```json
+{
+  "_key": "custom.snowboard_length",
+  "namespace": "custom",
+  "key": "snowboard_length",
+  "type": "dimension",
+  "value": {"value": 180, "unit": "CENTIMETERS"}
+}
+```
+
+`value` isn't declared on the `shopifyMetafield` schema type. Its shape follows the Shopify metafield type — a string, number, boolean, list or object — and no Sanity field type accepts all of those. `/components/inputs/ShopifyMetafield.tsx` reads it from the raw value instead.
+
+`/utils/formatMetafieldValue.ts` decides how a value is shown, using a small map keyed by metafield type. `dimension`, `weight`, `volume`, `money`, `rating` and `list.single_line_text_field` are there as examples.
+
+Anything not listed falls back to the raw value — a string as-is, anything else as JSON — so your own metafields still display. To show one of them nicely, add an entry to `formatters`. Shopify's [list of data types](https://shopify.dev/docs/apps/build/custom-data/metafields/list-of-data-types) gives the shape of every value.
+
+Metafields are read-only and the whole array is replaced on every sync, so edits made here are overwritten. Variant metafields and metaobjects aren't synced.
+
 ## Structure
 
 Sanity Studio will automatically list all your [document types][docs-document-types] out of the box. Sometimes you want a more streamlined editor experience. That's why you'll find a custom [structure][docs-structure] that's defined in `/structure`. It does the following things:

package/templates/shopify/schemaTypes/index.ts

@@ -37,6 +37,7 @@ import {productWithVariantType} from './objects/shopify/productWithVariantType'
 import {proxyStringType} from './objects/shopify/proxyStringType'
 import {seoType} from './objects/seoType'
 import {shopifyCollectionType} from './objects/shopify/shopifyCollectionType'
+import {shopifyMetafieldType} from './objects/shopify/shopifyMetafieldType'
 import {shopifyProductType} from './objects/shopify/shopifyProductType'
 import {shopifyProductVariantType} from './objects/shopify/shopifyProductVariantType'
 import {shopType} from './objects/shopify/shopType'
@@ -81,6 +82,7 @@ const objects = [
   proxyStringType,
   seoType,
   shopifyCollectionType,
+  shopifyMetafieldType,
   shopifyProductType,
   shopifyProductVariantType,
   shopType,

package/templates/shopify/schemaTypes/objects/shopify/shopifyCollectionType.ts

@@ -1,4 +1,4 @@
-import {defineField} from 'sanity'
+import {defineArrayMember, defineField} from 'sanity'
 
 export const shopifyCollectionType = defineField({
   name: 'shopifyCollection',
@@ -14,6 +14,14 @@ export const shopifyCollectionType = defineField({
       name: 'status',
       title: 'Status',
     },
+    {
+      name: 'metafields',
+      title: 'Metafields',
+      options: {
+        collapsed: true,
+        collapsible: true,
+      },
+    },
   ],
   fields: [
     defineField({
@@ -80,5 +88,14 @@ export const shopifyCollectionType = defineField({
       name: 'sortOrder',
       type: 'string',
     }),
+    defineField({
+      fieldset: 'metafields',
+      name: 'metafields',
+      type: 'array',
+      description: 'Read-only. Replaced in full on every sync',
+      // Shopify owns the order, and `readOnly` does not remove the drag handles on its own.
+      options: {sortable: false},
+      of: [defineArrayMember({type: 'shopifyMetafield'})],
+    }),
   ],
 })

package/templates/shopify/schemaTypes/objects/shopify/shopifyMetafieldType.ts

@@ -0,0 +1,47 @@
+import {TagIcon} from '@sanity/icons/Tag'
+import {defineField} from 'sanity'
+
+import ShopifyMetafield from '../../../components/inputs/ShopifyMetafield'
+import {formatMetafieldValue} from '../../../utils/formatMetafieldValue'
+
+export const shopifyMetafieldType = defineField({
+  title: 'Metafield',
+  name: 'shopifyMetafield',
+  type: 'object',
+  icon: TagIcon,
+  readOnly: true,
+  components: {
+    input: ShopifyMetafield,
+  },
+  fields: [
+    defineField({
+      name: 'namespace',
+      type: 'string',
+    }),
+    defineField({
+      name: 'key',
+      type: 'string',
+    }),
+    defineField({
+      name: 'type',
+      type: 'string',
+    }),
+    // `value` is deliberately left undeclared: it can be a string, number, boolean, list or object
+    // depending on the metafield type, and a declared field is type-checked even when hidden.
+  ],
+  preview: {
+    select: {
+      key: 'key',
+      namespace: 'namespace',
+      type: 'type',
+      value: 'value',
+    },
+    prepare({key, namespace, type, value}) {
+      const name = [namespace, key].filter(Boolean).join('.')
+      return {
+        subtitle: formatMetafieldValue(type, value),
+        title: type ? `${name} (${type})` : name,
+      }
+    },
+  },
+})

package/templates/shopify/schemaTypes/objects/shopify/shopifyProductType.ts

@@ -29,6 +29,14 @@ export const shopifyProductType = defineField({
         collapsible: true,
       },
     },
+    {
+      name: 'metafields',
+      title: 'Metafields',
+      options: {
+        collapsed: true,
+        collapsible: true,
+      },
+    },
   ],
   fields: [
     defineField({
@@ -127,5 +135,14 @@ export const shopifyProductType = defineField({
         }),
       ],
     }),
+    defineField({
+      fieldset: 'metafields',
+      name: 'metafields',
+      type: 'array',
+      description: 'Read-only. Replaced in full on every sync',
+      // Shopify owns the order, and `readOnly` does not remove the drag handles on its own.
+      options: {sortable: false},
+      of: [defineArrayMember({type: 'shopifyMetafield'})],
+    }),
   ],
 })

package/templates/shopify/utils/formatMetafieldValue.ts

@@ -0,0 +1,30 @@
+/**
+ * Shows a synced Shopify metafield value as text, based on its metafield `type`.
+ *
+ * The types below are examples. Anything not listed falls back to the raw value, so your own
+ * metafields still display — add an entry here to show one of them nicely. Every type and the shape
+ * of its value: https://shopify.dev/docs/apps/build/custom-data/metafields/list-of-data-types
+ */
+const measurement = ({value, unit}: {value: number; unit: string}) => `${value} ${unit}`
+
+const formatters: Record<string, (value: any) => string> = {
+  dimension: measurement,
+  weight: measurement,
+  volume: measurement,
+  money: ({amount, currency_code: currencyCode}) => `${amount} ${currencyCode}`,
+  rating: ({value, scale_max: scaleMax}) => `${value} / ${scaleMax}`,
+  'list.single_line_text_field': (values: string[]) => values.join(', '),
+}
+
+export const formatMetafieldValue = (type: string | undefined, value: unknown) => {
+  if (value === null || typeof value === 'undefined') {
+    return ''
+  }
+
+  const format = type ? formatters[type] : undefined
+  if (format) {
+    return format(value)
+  }
+
+  return typeof value === 'string' ? value : JSON.stringify(value)
+}

package/templates/shopify-online-storefront/components/inputs/ShopifyMetafield.tsx

@@ -0,0 +1,22 @@
+import {Card, Code} from '@sanity/ui'
+import {type ObjectInputProps} from 'sanity'
+import {formatMetafieldValue} from '../../utils/formatMetafieldValue'
+
+/**
+ * Shows a synced metafield's value. `value` isn't a declared field on `shopifyMetafield` — its shape
+ * depends on the Shopify metafield type — so it's read from the raw object value here.
+ */
+const ShopifyMetafield = (props: ObjectInputProps) => {
+  const {type, value} = (props.value || {}) as {type?: string; value?: unknown}
+  const text = formatMetafieldValue(type, value)
+
+  return (
+    <Card border padding={3} radius={1} tone="transparent">
+      <Code size={1} style={{margin: 0}}>
+        {text}
+      </Code>
+    </Card>
+  )
+}
+
+export default ShopifyMetafield

package/templates/shopify-online-storefront/schemaTypes/index.ts

@@ -10,9 +10,11 @@ import callout from './objects/callout'
 import inventory from './objects/inventory'
 import option from './objects/option'
 import priceRange from './objects/priceRange'
+import shop from './objects/shop'
 import proxyString from './objects/proxyString'
 import shopifyCollection from './objects/shopifyCollection'
 import shopifyCollectionRule from './objects/shopifyCollectionRule'
+import shopifyMetafield from './objects/shopifyMetafield'
 import shopifyProduct from './objects/shopifyProduct'
 import shopifyProductVariant from './objects/shopifyProductVariant'
 
@@ -33,8 +35,10 @@ export const schemaTypes = [
   option,
   priceRange,
   proxyString,
+  shop,
   shopifyCollection,
   shopifyCollectionRule,
+  shopifyMetafield,
   shopifyProduct,
   shopifyProductVariant,
 

package/templates/shopify-online-storefront/schemaTypes/objects/shop.ts

@@ -0,0 +1,16 @@
+import {defineField, defineType} from 'sanity'
+
+export default defineType({
+  name: 'shop',
+  title: 'Shop',
+  type: 'object',
+  readOnly: true,
+  fields: [
+    // Domain
+    defineField({
+      name: 'domain',
+      title: 'Domain',
+      type: 'string',
+    }),
+  ],
+})

package/templates/shopify-online-storefront/schemaTypes/objects/shopifyCollection.ts

@@ -14,6 +14,14 @@ export default defineType({
       name: 'status',
       title: 'Status',
     },
+    {
+      name: 'metafields',
+      title: 'Metafields',
+      options: {
+        collapsed: true,
+        collapsible: true,
+      },
+    },
   ],
   fields: [
     // Created at
@@ -98,6 +106,17 @@ export default defineType({
       title: 'Sort order',
       type: 'string',
     }),
+    // Metafields
+    defineField({
+      fieldset: 'metafields',
+      name: 'metafields',
+      title: 'Metafields',
+      type: 'array',
+      description: 'Read-only. Replaced in full on every sync',
+      // Shopify owns the order, and `readOnly` does not remove the drag handles on its own.
+      options: {sortable: false},
+      of: [{type: 'shopifyMetafield'}],
+    }),
     // Shop details
     defineField({
       name: 'shop',