@sanity/cli 5.3.0-next.64 → 5.3.0-next.65

package/lib/index.d.ts

@@ -1,6 +1,7 @@
 import {Answers} from 'inquirer'
 import type chalk from 'chalk'
 import {ChoiceCollection} from 'inquirer'
+import {ClientConfig} from '@sanity/client'
 import {ConfigEnv} from 'vite'
 import {DistinctQuestion} from 'inquirer'
 import {InlineConfig} from 'vite'
@@ -34,13 +35,18 @@ export declare interface CliApiConfig {
   dataset?: string
 }
 
-export declare interface CliClientOptions {
+/**
+ * `getCliClient` accepts all options the `ClientConfig` does but provides
+ * `projectId` and `dataset` from the `sanity.cli.ts` configuration file along
+ * with a token in certain scenarios (e.g. `sanity exec SCRIPT --with-user-token`)
+ */
+export declare interface CliClientOptions extends ClientConfig {
+  /**
+   * If no `projectId` or `dataset` is provided, `getCliClient` will try to
+   * resolve these from the `sanity.cli.ts` configuration file. Use this option
+   * to specify the directory to look for this file.
+   */
   cwd?: string
-  projectId?: string
-  dataset?: string
-  useCdn?: boolean
-  token?: string
-  apiVersion?: string
 }
 
 export declare type CliCommandAction<F = Record<string, unknown>> = (

package/lib/index.js

@@ -10,10 +10,11 @@ function getCliClientImpl(options = {}) {
     apiVersion = "2022-06-06",
     projectId,
     dataset,
-    token = getCliClient.__internal__getToken()
+    token = getCliClient.__internal__getToken(),
+    ...restOfOptions
   } = options;
   if (projectId && dataset)
-    return client.createClient({ projectId, dataset, apiVersion, useCdn, token });
+    return client.createClient({ projectId, dataset, apiVersion, useCdn, token, ...restOfOptions });
   const rootDir = loadEnv.resolveRootDir(cwd), { config } = getCliConfig.getSanityCliConfig(rootDir) || {};
   if (!config)
     throw new Error("Unable to resolve CLI configuration");
@@ -25,7 +26,8 @@ function getCliClientImpl(options = {}) {
     dataset: apiConfig.dataset,
     apiVersion,
     useCdn,
-    token
+    token,
+    ...restOfOptions
   });
 }
 getCliClientImpl.__internal__getToken = () => {

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../src/cliClient.ts","../src/config.ts"],"sourcesContent":["import {createClient, type SanityClient} from '@sanity/client'\n\nimport {getSanityCliConfig} from './util/getCliConfig'\nimport {resolveRootDir} from './util/resolveRootDir'\n\nexport interface CliClientOptions {\n  cwd?: string\n\n  projectId?: string\n  dataset?: string\n  useCdn?: boolean\n  token?: string\n  apiVersion?: string\n}\n\ninterface GetCliClient {\n  (options?: CliClientOptions): SanityClient\n  /**\n   * @internal\n   * @deprecated This is only for INTERNAL use, and should not be relied upon outside of official Sanity modules\n   * @returns A token to use when constructing a client without a `token` explicitly defined, or undefined\n   */\n  __internal__getToken: () => string | undefined\n}\n\nfunction getCliClientImpl(options: CliClientOptions = {}): SanityClient {\n  if (typeof process !== 'object') {\n    throw new Error('getCliClient() should only be called from node.js scripts')\n  }\n\n  const {\n    cwd = process.env.SANITY_BASE_PATH || process.cwd(),\n    useCdn = false,\n    apiVersion = '2022-06-06',\n    projectId,\n    dataset,\n    token = getCliClient.__internal__getToken(),\n  } = options\n\n  if (projectId && dataset) {\n    return createClient({projectId, dataset, apiVersion, useCdn, token})\n  }\n\n  const rootDir = resolveRootDir(cwd)\n  const {config} = getSanityCliConfig(rootDir) || {}\n  if (!config) {\n    throw new Error('Unable to resolve CLI configuration')\n  }\n\n  const apiConfig = config?.api || {}\n  if (!apiConfig.projectId || !apiConfig.dataset) {\n    throw new Error('Unable to resolve project ID/dataset from CLI configuration')\n  }\n\n  return createClient({\n    projectId: apiConfig.projectId,\n    dataset: apiConfig.dataset,\n    apiVersion,\n    useCdn,\n    token,\n  })\n}\n\n/* eslint-disable camelcase */\ngetCliClientImpl.__internal__getToken = (): string | undefined => undefined\n/* eslint-enable camelcase */\n\n/** @internal */\nexport const getCliClient: GetCliClient = getCliClientImpl\n","import {type CliConfig} from './types'\n\n/** @beta */\nexport function defineCliConfig(config: CliConfig): CliConfig {\n  return config\n}\n\n/**\n * @deprecated Use `defineCliConfig` instead\n * @beta\n */\nexport function createCliConfig(config: CliConfig): CliConfig {\n  return config\n}\n"],"names":["createClient","resolveRootDir","getSanityCliConfig"],"mappings":";;;AAyBA,SAAS,iBAAiB,UAA4B,IAAkB;AACtE,MAAI,OAAO,WAAY;AACrB,UAAM,IAAI,MAAM,2DAA2D;AAG7E,QAAM;AAAA,IACJ,MAAM,QAAQ,IAAI,oBAAoB,QAAQ,IAAA;AAAA,IAC9C,SAAS;AAAA,IACT,aAAa;AAAA,IACb;AAAA,IACA;AAAA,IACA,QAAQ,aAAa,qBAAA;AAAA,EAAqB,IACxC;AAEJ,MAAI,aAAa;AACf,WAAOA,OAAAA,aAAa,EAAC,WAAW,SAAS,YAAY,QAAQ,OAAM;AAGrE,QAAM,UAAUC,QAAAA,eAAe,GAAG,GAC5B,EAAC,WAAUC,aAAAA,mBAAmB,OAAO,KAAK,CAAA;AAChD,MAAI,CAAC;AACH,UAAM,IAAI,MAAM,qCAAqC;AAGvD,QAAM,YAAY,QAAQ,OAAO,CAAA;AACjC,MAAI,CAAC,UAAU,aAAa,CAAC,UAAU;AACrC,UAAM,IAAI,MAAM,6DAA6D;AAG/E,SAAOF,oBAAa;AAAA,IAClB,WAAW,UAAU;AAAA,IACrB,SAAS,UAAU;AAAA,IACnB;AAAA,IACA;AAAA,IACA;AAAA,EAAA,CACD;AACH;AAGA,iBAAiB,uBAAuB,MAAuB;AAAA;AAIxD,MAAM,eAA6B;ACjEnC,SAAS,gBAAgB,QAA8B;AAC5D,SAAO;AACT;AAMO,SAAS,gBAAgB,QAA8B;AAC5D,SAAO;AACT;;;;;"}
+{"version":3,"file":"index.js","sources":["../src/cliClient.ts","../src/config.ts"],"sourcesContent":["import {type ClientConfig, createClient, type SanityClient} from '@sanity/client'\n\nimport {getSanityCliConfig} from './util/getCliConfig'\nimport {resolveRootDir} from './util/resolveRootDir'\n\n/**\n * `getCliClient` accepts all options the `ClientConfig` does but provides\n * `projectId` and `dataset` from the `sanity.cli.ts` configuration file along\n * with a token in certain scenarios (e.g. `sanity exec SCRIPT --with-user-token`)\n */\nexport interface CliClientOptions extends ClientConfig {\n  /**\n   * If no `projectId` or `dataset` is provided, `getCliClient` will try to\n   * resolve these from the `sanity.cli.ts` configuration file. Use this option\n   * to specify the directory to look for this file.\n   */\n  cwd?: string\n}\n\ninterface GetCliClient {\n  (options?: CliClientOptions): SanityClient\n  /**\n   * @internal\n   * @deprecated This is only for INTERNAL use, and should not be relied upon outside of official Sanity modules\n   * @returns A token to use when constructing a client without a `token` explicitly defined, or undefined\n   */\n  __internal__getToken: () => string | undefined\n}\n\nfunction getCliClientImpl(options: CliClientOptions = {}): SanityClient {\n  if (typeof process !== 'object') {\n    throw new Error('getCliClient() should only be called from node.js scripts')\n  }\n\n  const {\n    cwd = process.env.SANITY_BASE_PATH || process.cwd(),\n    useCdn = false,\n    apiVersion = '2022-06-06',\n    projectId,\n    dataset,\n    token = getCliClient.__internal__getToken(),\n    ...restOfOptions\n  } = options\n\n  if (projectId && dataset) {\n    return createClient({projectId, dataset, apiVersion, useCdn, token, ...restOfOptions})\n  }\n\n  const rootDir = resolveRootDir(cwd)\n  const {config} = getSanityCliConfig(rootDir) || {}\n  if (!config) {\n    throw new Error('Unable to resolve CLI configuration')\n  }\n\n  const apiConfig = config?.api || {}\n  if (!apiConfig.projectId || !apiConfig.dataset) {\n    throw new Error('Unable to resolve project ID/dataset from CLI configuration')\n  }\n\n  return createClient({\n    projectId: apiConfig.projectId,\n    dataset: apiConfig.dataset,\n    apiVersion,\n    useCdn,\n    token,\n    ...restOfOptions,\n  })\n}\n\n/* eslint-disable camelcase */\ngetCliClientImpl.__internal__getToken = (): string | undefined => undefined\n/* eslint-enable camelcase */\n\n/** @internal */\nexport const getCliClient: GetCliClient = getCliClientImpl\n","import {type CliConfig} from './types'\n\n/** @beta */\nexport function defineCliConfig(config: CliConfig): CliConfig {\n  return config\n}\n\n/**\n * @deprecated Use `defineCliConfig` instead\n * @beta\n */\nexport function createCliConfig(config: CliConfig): CliConfig {\n  return config\n}\n"],"names":["createClient","resolveRootDir","getSanityCliConfig"],"mappings":";;;AA6BA,SAAS,iBAAiB,UAA4B,IAAkB;AACtE,MAAI,OAAO,WAAY;AACrB,UAAM,IAAI,MAAM,2DAA2D;AAG7E,QAAM;AAAA,IACJ,MAAM,QAAQ,IAAI,oBAAoB,QAAQ,IAAA;AAAA,IAC9C,SAAS;AAAA,IACT,aAAa;AAAA,IACb;AAAA,IACA;AAAA,IACA,QAAQ,aAAa,qBAAA;AAAA,IACrB,GAAG;AAAA,EAAA,IACD;AAEJ,MAAI,aAAa;AACf,WAAOA,OAAAA,aAAa,EAAC,WAAW,SAAS,YAAY,QAAQ,OAAO,GAAG,eAAc;AAGvF,QAAM,UAAUC,QAAAA,eAAe,GAAG,GAC5B,EAAC,WAAUC,aAAAA,mBAAmB,OAAO,KAAK,CAAA;AAChD,MAAI,CAAC;AACH,UAAM,IAAI,MAAM,qCAAqC;AAGvD,QAAM,YAAY,QAAQ,OAAO,CAAA;AACjC,MAAI,CAAC,UAAU,aAAa,CAAC,UAAU;AACrC,UAAM,IAAI,MAAM,6DAA6D;AAG/E,SAAOF,oBAAa;AAAA,IAClB,WAAW,UAAU;AAAA,IACrB,SAAS,UAAU;AAAA,IACnB;AAAA,IACA;AAAA,IACA;AAAA,IACA,GAAG;AAAA,EAAA,CACJ;AACH;AAGA,iBAAiB,uBAAuB,MAAuB;AAAA;AAIxD,MAAM,eAA6B;ACvEnC,SAAS,gBAAgB,QAA8B;AAC5D,SAAO;AACT;AAMO,SAAS,gBAAgB,QAA8B;AAC5D,SAAO;AACT;;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/cli",
-  "version": "5.3.0-next.64+110c6c75e0",
+  "version": "5.3.0-next.65+1e4e248f6a",
   "description": "Sanity CLI tool for managing Sanity installations, managing plugins, schemas and datasets",
   "keywords": [
     "sanity",
@@ -57,7 +57,7 @@
     "pkg-dir": "^5.0.0",
     "prettier": "^3.7.4",
     "semver": "^7.7.2",
-    "@sanity/codegen": "5.3.0-next.64+110c6c75e0"
+    "@sanity/codegen": "5.3.0-next.65+1e4e248f6a"
   },
   "devDependencies": {
     "@rexxars/gitconfiglocal": "^3.0.1",
@@ -111,11 +111,11 @@
     "vitest": "^4.0.16",
     "which": "^2.0.2",
     "xdg-basedir": "^4.0.0",
-    "@repo/eslint-config": "5.3.0-next.64+110c6c75e0",
-    "@repo/package.config": "5.3.0-next.64+110c6c75e0",
-    "@repo/tsconfig": "5.3.0-next.64+110c6c75e0",
-    "@sanity/types": "5.2.0",
-    "@repo/test-config": "5.3.0-next.64+110c6c75e0"
+    "@repo/eslint-config": "5.3.0-next.65+1e4e248f6a",
+    "@repo/package.config": "5.3.0-next.65+1e4e248f6a",
+    "@repo/test-config": "5.3.0-next.65+1e4e248f6a",
+    "@repo/tsconfig": "5.3.0-next.65+1e4e248f6a",
+    "@sanity/types": "5.2.0"
   },
   "peerDependencies": {
     "babel-plugin-react-compiler": "*"