@sanity/cli-test 0.0.2-alpha.1 → 0.0.2-alpha.11

package/dist/index.d.ts

@@ -1,3 +1,516 @@
-export * from './test/mockApi.js';
-export * from './test/testCommand.js';
-export * from './test/testHook.js';
+import {CliConfig} from '@sanity/cli-core'
+import {ClientConfig} from '@sanity/client'
+import {CLITelemetryStore} from '@sanity/cli-core'
+import {Command} from '@oclif/core'
+import {Config} from '@oclif/core'
+import {Errors} from '@oclif/core'
+import {Hook} from '@oclif/core/hooks'
+import {Hooks} from '@oclif/core/hooks'
+import nock from 'nock'
+import {ProjectRootResult} from '@sanity/cli-core'
+import {SanityClient} from '@sanity/client'
+import {SanityCommand} from '@sanity/cli-core'
+import {TestProject} from 'vitest/node'
+import {vi} from 'vitest'
+
+declare interface CaptureOptions {
+  /**
+   * Whether to print the output to the console
+   */
+  print?: boolean
+  /**
+   * Whether to strip ANSI escape codes from the output
+   */
+  stripAnsi?: boolean
+  testNodeEnv?: string
+}
+
+declare interface CaptureResult<T = unknown> {
+  stderr: string
+  stdout: string
+  error?: Error & Partial<Errors.CLIError>
+  result?: T
+}
+
+declare type CommandClass = (new (argv: string[], config: Config) => Command) & typeof Command
+
+/**
+ * Converts Unix-style paths to platform-appropriate paths.
+ * On Windows:
+ *   - Absolute paths starting with '/': adds drive letter and converts to backslashes
+ *   - Relative/partial paths: converts forward slashes to backslashes
+ * On Unix: keeps paths as-is.
+ *
+ * @param pathStr - Unix-style path (e.g., '/test/path' or '.config/file.json')
+ * @returns Platform-appropriate path
+ * @internal
+ */
+export declare function convertToSystemPath(pathStr: string): string
+
+/**
+ * Creates a real Sanity client instance for testing that makes actual HTTP requests.
+ * Use with mockApi() to intercept and mock the HTTP calls.
+ *
+ * @public
+ *
+ * @example
+ * ```typescript
+ * // Mock getGlobalCliClient to return a test client
+ * vi.mock('@sanity/cli-core', async (importOriginal) => {
+ *   const actual = await importOriginal<typeof import('@sanity/cli-core')>()
+ *   const {createTestClient} = await import('@sanity/cli-test')
+ *
+ *   return {
+ *     ...actual,
+ *     getGlobalCliClient: vi.fn().mockImplementation((opts) => {
+ *       return Promise.resolve(createTestClient({
+ *         apiVersion: opts.apiVersion,
+ *       }))
+ *     }),
+ *   }
+ * })
+ *
+ * // Then use mockApi to intercept requests
+ * mockApi({
+ *   apiVersion: 'v2025-02-19',
+ *   method: 'get',
+ *   uri: '/media-libraries',
+ * }).reply(200, {data: [...]})
+ * ```
+ */
+export declare function createTestClient(options: CreateTestClientOptions): {
+  client: SanityClient
+  request: ReturnType<typeof vi.fn>
+}
+
+/**
+ * Options for createTestClient
+ *
+ * @public
+ */
+export declare interface CreateTestClientOptions extends ClientConfig {
+  /**
+   * API version for the client
+   */
+  apiVersion: string
+  /**
+   * Authentication token
+   */
+  token: string
+}
+
+/**
+ * Creates a test token for the Sanity CLI
+ *
+ * @public
+ *
+ * @param token - The token to create
+ * @returns void
+ */
+export declare function createTestToken(token: string): void
+
+/**
+ * Default fixtures bundled with the package and their options.
+ *
+ * @public
+ */
+export declare const DEFAULT_FIXTURES: Record<FixtureName, FixtureOptions>
+
+/**
+ * @deprecated Use {@link FixtureName} instead. This type alias will be removed in a future release.
+ * @public
+ */
+export declare type ExampleName = FixtureName
+
+/**
+ * Valid fixture name type.
+ * @public
+ */
+export declare type FixtureName =
+  | 'basic-app'
+  | 'basic-studio'
+  | 'multi-workspace-studio'
+  | 'prebuilt-app'
+  | 'prebuilt-studio'
+  | 'worst-case-studio'
+
+/**
+ * Options for each fixture.
+ * @public
+ */
+export declare interface FixtureOptions {
+  includeDist?: boolean
+}
+
+/**
+ * Gets the current Windows drive letter from process.cwd().
+ * Falls back to 'C:\\' if detection fails.
+ *
+ * @returns Drive letter with backslash (e.g., 'C:\\', 'D:\\') or empty string on Unix
+ * @internal
+ */
+export declare function getCurrentDrive(): string
+
+/**
+ * Gets the path to the fixtures directory bundled with this package.
+ *
+ * The fixtures are copied during build and bundled with the published package.
+ * This function works the same whether the package is used in a monorepo
+ * or installed from npm.
+ *
+ * @returns Absolute path to the fixtures directory
+ * @internal
+ */
+export declare function getFixturesPath(): string
+
+/**
+ * Gets the path to the temporary directory for test fixtures.
+ *
+ * Uses the initial working directory captured when this module was first loaded,
+ * not process.cwd() which may change during test execution.
+ *
+ * @param customTempDir - Optional custom temp directory path
+ * @returns Absolute path to temp directory (default: initial cwd/tmp)
+ * @internal
+ */
+export declare function getTempPath(customTempDir?: string): string
+
+/**
+ * Mocks the API calls, add some defaults so it doesn't cause too much friction
+ *
+ * @internal
+ */
+export declare function mockApi({
+  apiHost,
+  apiVersion,
+  includeQueryTag,
+  method,
+  projectId,
+  query,
+  uri,
+}: MockApiOptions): nock.Interceptor
+
+/**
+ * @internal
+ */
+export declare interface MockApiOptions {
+  /**
+   * Uri to mock
+   */
+  uri: string
+  /**
+   * Api host to mock, defaults to `https://api.sanity.io`
+   */
+  apiHost?: string
+  /**
+   * Api version to mock, defaults to `v2025-05-14`
+   */
+  apiVersion?: string
+  /**
+   * Whether to include `tag: 'sanity.cli'` in query parameters.
+   * Defaults to `true`. Set to `false` for endpoints that don't use CLI tagging.
+   */
+  includeQueryTag?: boolean
+  /**
+   * HTTP method to mock
+   *
+   * Defaults to 'get'
+   */
+  method?: 'delete' | 'get' | 'patch' | 'post' | 'put'
+  /**
+   * Project ID to mock. When provided, constructs apiHost as `https://{projectId}.api.sanity.io`
+   * Takes precedence over apiHost if both are provided.
+   */
+  projectId?: string
+  /**
+   * Query parameters to mock
+   */
+  query?: Record<string, string>
+}
+
+/**
+ * Creates a testable subclass of a command with mocked SanityCommand dependencies.
+ *
+ * @public
+ *
+ * @example
+ * ```ts
+ * // Basic config mocking
+ * const TestAdd = mockSanityCommand(Add, {
+ *   cliConfig: { api: { projectId: 'test-project' } }
+ * })
+ *
+ * // With mock API client
+ * const mockClient = {
+ *   getDocument: vi.fn().mockResolvedValue({ _id: 'doc1', title: 'Test' }),
+ *   fetch: vi.fn().mockResolvedValue([]),
+ * }
+ * const TestGet = mockSanityCommand(GetDocumentCommand, {
+ *   cliConfig: { api: { projectId: 'test-project', dataset: 'production' } },
+ *   projectApiClient: mockClient,
+ * })
+ *
+ * const {stdout} = await testCommand(TestGet, ['doc1'])
+ * expect(mockClient.getDocument).toHaveBeenCalledWith('doc1')
+ * ```
+ */
+export declare function mockSanityCommand<T extends typeof SanityCommand<typeof Command>>(
+  CommandClass: T,
+  options?: MockSanityCommandOptions,
+): T
+
+/**
+ * @public
+ */
+export declare interface MockSanityCommandOptions {
+  /**
+   * Mock CLI config (required if command uses getCliConfig or getProjectId)
+   */
+  cliConfig?: CliConfig
+  /**
+   * Mock whether the terminal is interactive (used by isUnattended)
+   */
+  isInteractive?: boolean
+  /**
+   * Mock project root result (required if command uses getProjectRoot)
+   */
+  projectRoot?: ProjectRootResult
+  /**
+   * Mock authentication token (passed to API clients, bypasses getCliToken)
+   */
+  token?: string
+}
+
+/**
+ * @public
+ * @param options - Options for mocking the telemetry store.
+ * @returns The mocked telemetry store.
+ */
+export declare const mockTelemetry: (options?: MockTelemetryOptions) => CLITelemetryStore
+
+/**
+ * @public
+ */
+export declare interface MockTelemetryOptions {
+  trace?: () => void
+  updateUserProperties?: () => void
+}
+
+declare interface Options {
+  config: Config
+  Command?: Command.Class
+  context?: Hook.Context
+}
+
+/**
+ * Global setup function for initializing test fixtures.
+ *
+ * Copies fixtures from the bundled location to a temp directory
+ * and installs dependencies.
+ *
+ * Note: Fixtures are NOT built during setup. Tests that need built
+ * fixtures should build them as part of the test.
+ *
+ * This function is designed to be used with vitest globalSetup.
+ *
+ * @public
+ *
+ * @param options - Configuration options
+ * @example
+ * ```typescript
+ * // In vitest.config.ts
+ * export default defineConfig({
+ *   test: {
+ *     globalSetup: ['@sanity/cli-test/vitest']
+ *   }
+ * })
+ * ```
+ */
+export declare function setup(_: TestProject, options?: SetupTestFixturesOptions): Promise<void>
+
+/**
+ * Options for setupTestFixtures
+ *
+ * @public
+ */
+export declare interface SetupTestFixturesOptions {
+  /**
+   * Glob patterns for additional fixture directories to set up.
+   *
+   * Each pattern is matched against directories in the current working directory.
+   * Only directories containing a `package.json` file are included.
+   *
+   * @example
+   * ```typescript
+   * ['fixtures/*', 'dev/*']
+   * ```
+   */
+  additionalFixtures?: string[]
+  /**
+   * Custom temp directory path. Defaults to process.cwd()/tmp
+   */
+  tempDir?: string
+}
+
+/**
+ * Teardown function to clean up test fixtures.
+ *
+ * Removes the temp directory created by setupTestFixtures.
+ *
+ * This function is designed to be used with vitest globalSetup.
+ *
+ * @public
+ *
+ * @param options - Configuration options
+ */
+export declare function teardown(options?: TeardownTestFixturesOptions): Promise<void>
+
+/**
+ * Options for teardownTestFixtures
+ *
+ * @public
+ */
+export declare interface TeardownTestFixturesOptions {
+  /**
+   * Custom temp directory path. Defaults to process.cwd()/tmp
+   */
+  tempDir?: string
+}
+
+/**
+ * @public
+ */
+export declare function testCommand(
+  command: CommandClass,
+  args?: string[],
+  options?: TestCommandOptions,
+): Promise<CaptureResult<unknown>>
+
+/**
+ * @public
+ */
+export declare interface TestCommandOptions {
+  /**
+   * Options for capturing output
+   */
+  capture?: CaptureOptions
+  /**
+   * Partial oclif config overrides
+   */
+  config?: Partial<Config>
+  /**
+   * Mock options for SanityCommand dependencies (config, project root, API clients).
+   * When provided, the command is automatically wrapped with mockSanityCommand.
+   */
+  mocks?: MockSanityCommandOptions & MockTelemetryOptions
+}
+
+/**
+ * Recursively copy a directory, skipping specified folders.
+ *
+ * @param srcDir - Source directory to copy from
+ * @param destDir - Destination directory to copy to
+ * @param skip - Array of directory/file names to skip (e.g., ['node_modules', 'dist'])
+ * @internal
+ */
+export declare function testCopyDirectory(
+  srcDir: string,
+  destDir: string,
+  skip?: string[],
+): Promise<void>
+
+/**
+ * @deprecated Use {@link testFixture} instead. This function will be removed in a future release.
+ *
+ * Clones an example (now called fixture) directory into a temporary directory with an isolated copy.
+ *
+ * @param exampleName - The name of the example/fixture to clone (e.g., 'basic-app', 'basic-studio')
+ * @param options - Configuration options
+ * @returns The absolute path to the temporary directory containing the example/fixture
+ *
+ * @public
+ */
+export declare function testExample(
+  exampleName: FixtureName | (string & {}),
+  options?: TestFixtureOptions,
+): Promise<string>
+
+/**
+ * @deprecated Use {@link TestFixtureOptions} instead. This type alias will be removed in a future release.
+ * @public
+ */
+export declare type TestExampleOptions = TestFixtureOptions
+
+/**
+ * Clones a fixture directory into a temporary directory with an isolated copy.
+ *
+ * The function creates a unique temporary copy of the specified fixture with:
+ * - A random unique ID to avoid conflicts between parallel tests
+ * - Symlinked node_modules for performance (from the global setup version)
+ * - Modified package.json name to prevent conflicts
+ *
+ * The fixture is first looked up in the temp directory (if global setup ran),
+ * otherwise it falls back to the bundled fixtures in the package.
+ *
+ * @param fixtureName - The name of the fixture to clone (e.g., 'basic-app', 'basic-studio')
+ * @param options - Configuration options
+ * @returns The absolute path to the temporary directory containing the fixture
+ *
+ * @public
+ *
+ * @example
+ * ```typescript
+ * import {testFixture} from '@sanity/cli-test'
+ * import {describe, test} from 'vitest'
+ *
+ * describe('my test suite', () => {
+ *   test('should work with basic-studio', async () => {
+ *     const cwd = await testFixture('basic-studio')
+ *     // ... run your tests in this directory
+ *   })
+ * })
+ * ```
+ */
+export declare function testFixture(
+  fixtureName: FixtureName | (string & {}),
+  options?: TestFixtureOptions,
+): Promise<string>
+
+/**
+ * @public
+ */
+export declare interface TestFixtureOptions {
+  /**
+   * Custom temp directory. Defaults to process.cwd()/tmp
+   */
+  tempDir?: string
+}
+
+/**
+ * Test an oclif hook
+ *
+ * @public
+ *
+ * @example
+ * ```ts
+ * const result = await testHook(hook, {
+ *   Command: Command.loadable,
+ *   context: {
+ *     config: Config.load({
+ *      // CLI root is the directory of the package that contains the hook.
+ *       root: path.resolve(fileURLToPath(import.meta.url), '../../../root'),
+ *     }),
+ *   },
+ * })
+ * ```
+ *
+ * @param hook - The hook to test
+ * @param options - The options for the hook
+ * @returns The result of the hook
+ */
+export declare function testHook<T extends keyof Hooks>(
+  hook: Hook<T>,
+  options: Options,
+): Promise<CaptureResult<Hooks[T]['return']>>
+
+export {}

package/dist/index.js

@@ -1,5 +1,13 @@
+export * from './test/constants.js';
+export * from './test/createTestClient.js';
+export * from './test/createTestToken.js';
 export * from './test/mockApi.js';
+export * from './test/mockSanityCommand.js';
+export * from './test/mockTelemetry.js';
+export * from './test/setupFixtures.js';
 export * from './test/testCommand.js';
+export * from './test/testFixture.js';
 export * from './test/testHook.js';
+export * from './utils/paths.js';
 
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export * from './test/mockApi.js'\nexport * from './test/testCommand.js'\nexport * from './test/testHook.js'\n"],"names":[],"mappings":"AAAA,cAAc,oBAAmB;AACjC,cAAc,wBAAuB;AACrC,cAAc,qBAAoB"}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export * from './test/constants.js'\nexport * from './test/createTestClient.js'\nexport * from './test/createTestToken.js'\nexport * from './test/mockApi.js'\nexport * from './test/mockSanityCommand.js'\nexport * from './test/mockTelemetry.js'\nexport * from './test/setupFixtures.js'\nexport * from './test/testCommand.js'\nexport * from './test/testFixture.js'\nexport * from './test/testHook.js'\nexport * from './utils/paths.js'\n"],"names":[],"mappings":"AAAA,cAAc,sBAAqB;AACnC,cAAc,6BAA4B;AAC1C,cAAc,4BAA2B;AACzC,cAAc,oBAAmB;AACjC,cAAc,8BAA6B;AAC3C,cAAc,0BAAyB;AACvC,cAAc,0BAAyB;AACvC,cAAc,wBAAuB;AACrC,cAAc,wBAAuB;AACrC,cAAc,qBAAoB;AAClC,cAAc,mBAAkB"}

package/dist/test/constants.js

@@ -0,0 +1,21 @@
+/**
+ * Options for each fixture.
+ * @public
+ */ /**
+ * Default fixtures bundled with the package and their options.
+ *
+ * @public
+ */ export const DEFAULT_FIXTURES = {
+    'basic-app': {},
+    'basic-studio': {},
+    'multi-workspace-studio': {},
+    'prebuilt-app': {
+        includeDist: true
+    },
+    'prebuilt-studio': {
+        includeDist: true
+    },
+    'worst-case-studio': {}
+};
+
+//# sourceMappingURL=constants.js.map

package/dist/test/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/test/constants.ts"],"sourcesContent":["/**\n * Options for each fixture.\n * @public\n */\nexport interface FixtureOptions {\n  includeDist?: boolean\n}\n\n/**\n * Default fixtures bundled with the package and their options.\n *\n * @public\n */\nexport const DEFAULT_FIXTURES: Record<FixtureName, FixtureOptions> = {\n  'basic-app': {},\n  'basic-studio': {},\n  'multi-workspace-studio': {},\n  'prebuilt-app': {includeDist: true},\n  'prebuilt-studio': {includeDist: true},\n  'worst-case-studio': {},\n} as const\n\n/**\n * Valid fixture name type.\n * @public\n */\nexport type FixtureName =\n  | 'basic-app'\n  | 'basic-studio'\n  | 'multi-workspace-studio'\n  | 'prebuilt-app'\n  | 'prebuilt-studio'\n  | 'worst-case-studio'\n\n/**\n * @deprecated Use {@link FixtureName} instead. This type alias will be removed in a future release.\n * @public\n */\nexport type ExampleName = FixtureName\n"],"names":["DEFAULT_FIXTURES","includeDist"],"mappings":"AAAA;;;CAGC,GAKD;;;;CAIC,GACD,OAAO,MAAMA,mBAAwD;IACnE,aAAa,CAAC;IACd,gBAAgB,CAAC;IACjB,0BAA0B,CAAC;IAC3B,gBAAgB;QAACC,aAAa;IAAI;IAClC,mBAAmB;QAACA,aAAa;IAAI;IACrC,qBAAqB,CAAC;AACxB,EAAU"}

package/dist/test/createTestClient.js

@@ -0,0 +1,53 @@
+import { createClient } from '@sanity/client';
+import { vi } from 'vitest';
+/**
+ * Creates a real Sanity client instance for testing that makes actual HTTP requests.
+ * Use with mockApi() to intercept and mock the HTTP calls.
+ *
+ * @public
+ *
+ * @example
+ * ```typescript
+ * // Mock getGlobalCliClient to return a test client
+ * vi.mock('@sanity/cli-core', async (importOriginal) => {
+ *   const actual = await importOriginal<typeof import('@sanity/cli-core')>()
+ *   const {createTestClient} = await import('@sanity/cli-test')
+ *
+ *   return {
+ *     ...actual,
+ *     getGlobalCliClient: vi.fn().mockImplementation((opts) => {
+ *       return Promise.resolve(createTestClient({
+ *         apiVersion: opts.apiVersion,
+ *       }))
+ *     }),
+ *   }
+ * })
+ *
+ * // Then use mockApi to intercept requests
+ * mockApi({
+ *   apiVersion: 'v2025-02-19',
+ *   method: 'get',
+ *   uri: '/media-libraries',
+ * }).reply(200, {data: [...]})
+ * ```
+ */ export function createTestClient(options) {
+    const { apiVersion, projectId, token, ...rest } = options;
+    const client = createClient({
+        apiVersion,
+        projectId,
+        requestTagPrefix: 'sanity.cli',
+        token,
+        useCdn: false,
+        useProjectHostname: projectId ? true : false,
+        ...rest
+    });
+    /**
+   * Mock the request method of the client to return the actual response from the client
+   */ const request = vi.fn((...args)=>client.request(...args));
+    return {
+        client,
+        request
+    };
+}
+
+//# sourceMappingURL=createTestClient.js.map

package/dist/test/createTestClient.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/test/createTestClient.ts"],"sourcesContent":["import {type ClientConfig, createClient, type SanityClient} from '@sanity/client'\nimport {vi} from 'vitest'\n\n/**\n * Options for createTestClient\n *\n * @public\n */\nexport interface CreateTestClientOptions extends ClientConfig {\n  /**\n   * API version for the client\n   */\n  apiVersion: string\n\n  /**\n   * Authentication token\n   */\n  token: string\n}\n\n/**\n * Creates a real Sanity client instance for testing that makes actual HTTP requests.\n * Use with mockApi() to intercept and mock the HTTP calls.\n *\n * @public\n *\n * @example\n * ```typescript\n * // Mock getGlobalCliClient to return a test client\n * vi.mock('@sanity/cli-core', async (importOriginal) => {\n *   const actual = await importOriginal<typeof import('@sanity/cli-core')>()\n *   const {createTestClient} = await import('@sanity/cli-test')\n *\n *   return {\n *     ...actual,\n *     getGlobalCliClient: vi.fn().mockImplementation((opts) => {\n *       return Promise.resolve(createTestClient({\n *         apiVersion: opts.apiVersion,\n *       }))\n *     }),\n *   }\n * })\n *\n * // Then use mockApi to intercept requests\n * mockApi({\n *   apiVersion: 'v2025-02-19',\n *   method: 'get',\n *   uri: '/media-libraries',\n * }).reply(200, {data: [...]})\n * ```\n */\nexport function createTestClient(options: CreateTestClientOptions): {\n  client: SanityClient\n  request: ReturnType<typeof vi.fn>\n} {\n  const {apiVersion, projectId, token, ...rest} = options\n\n  const client = createClient({\n    apiVersion,\n    projectId,\n    requestTagPrefix: 'sanity.cli',\n    token,\n    useCdn: false,\n    useProjectHostname: projectId ? true : false,\n    ...rest,\n  })\n\n  /**\n   * Mock the request method of the client to return the actual response from the client\n   */\n  const request = vi.fn((...args: Parameters<typeof client.request>) => client.request(...args))\n\n  return {\n    client,\n    request,\n  }\n}\n"],"names":["createClient","vi","createTestClient","options","apiVersion","projectId","token","rest","client","requestTagPrefix","useCdn","useProjectHostname","request","fn","args"],"mappings":"AAAA,SAA2BA,YAAY,QAA0B,iBAAgB;AACjF,SAAQC,EAAE,QAAO,SAAQ;AAmBzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8BC,GACD,OAAO,SAASC,iBAAiBC,OAAgC;IAI/D,MAAM,EAACC,UAAU,EAAEC,SAAS,EAAEC,KAAK,EAAE,GAAGC,MAAK,GAAGJ;IAEhD,MAAMK,SAASR,aAAa;QAC1BI;QACAC;QACAI,kBAAkB;QAClBH;QACAI,QAAQ;QACRC,oBAAoBN,YAAY,OAAO;QACvC,GAAGE,IAAI;IACT;IAEA;;GAEC,GACD,MAAMK,UAAUX,GAAGY,EAAE,CAAC,CAAC,GAAGC,OAA4CN,OAAOI,OAAO,IAAIE;IAExF,OAAO;QACLN;QACAI;IACF;AACF"}

package/dist/test/createTestToken.js

@@ -0,0 +1,13 @@
+import { vi } from 'vitest';
+/**
+ * Creates a test token for the Sanity CLI
+ *
+ * @public
+ *
+ * @param token - The token to create
+ * @returns void
+ */ export function createTestToken(token) {
+    vi.stubEnv('SANITY_AUTH_TOKEN', token);
+}
+
+//# sourceMappingURL=createTestToken.js.map

package/dist/test/createTestToken.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/test/createTestToken.ts"],"sourcesContent":["import {vi} from 'vitest'\n\n/**\n * Creates a test token for the Sanity CLI\n *\n * @public\n *\n * @param token - The token to create\n * @returns void\n */\nexport function createTestToken(token: string) {\n  vi.stubEnv('SANITY_AUTH_TOKEN', token)\n}\n"],"names":["vi","createTestToken","token","stubEnv"],"mappings":"AAAA,SAAQA,EAAE,QAAO,SAAQ;AAEzB;;;;;;;CAOC,GACD,OAAO,SAASC,gBAAgBC,KAAa;IAC3CF,GAAGG,OAAO,CAAC,qBAAqBD;AAClC"}

package/dist/test/mockApi.js

@@ -3,12 +3,14 @@ import nock from 'nock';
  * Mocks the API calls, add some defaults so it doesn't cause too much friction
  *
  * @internal
- */ export function mockApi({ apiHost = 'https://api.sanity.io', apiVersion = 'v2025-05-14', method = 'get', query = {}, uri }) {
+ */ export function mockApi({ apiHost = 'https://api.sanity.io', apiVersion = 'v2025-05-14', includeQueryTag = true, method = 'get', projectId, query = {}, uri }) {
     const version = apiVersion.startsWith('v') ? apiVersion : `v${apiVersion}`;
-    return nock(apiHost)[method](`/${version}${uri}`).query({
+    const host = projectId ? `https://${projectId}.api.sanity.io` : apiHost;
+    const queryParams = includeQueryTag ? {
         tag: 'sanity.cli',
         ...query
-    });
+    } : query;
+    return nock(host)[method](`/${version}${uri}`).query(queryParams);
 }
 
 //# sourceMappingURL=mockApi.js.map

package/dist/test/mockApi.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/test/mockApi.ts"],"sourcesContent":["import nock from 'nock'\n\n/**\n * @internal\n */\nexport interface MockApiOptions {\n  /**\n   * Uri to mock\n   */\n  uri: string\n\n  /**\n   * Api host to mock, defaults to `https://api.sanity.io`\n   */\n  apiHost?: string\n\n  /**\n   * Api version to mock, defaults to `v2025-05-14`\n   */\n  apiVersion?: string\n\n  /**\n   * HTTP method to mock\n   *\n   * Defaults to 'get'\n   */\n  method?: 'delete' | 'get' | 'patch' | 'post' | 'put'\n\n  /**\n   * Query parameters to mock\n   */\n  query?: Record<string, string>\n}\n\n/**\n * Mocks the API calls, add some defaults so it doesn't cause too much friction\n *\n * @internal\n */\nexport function mockApi({\n  apiHost = 'https://api.sanity.io',\n  apiVersion = 'v2025-05-14',\n  method = 'get',\n  query = {},\n  uri,\n}: MockApiOptions) {\n  const version = apiVersion.startsWith('v') ? apiVersion : `v${apiVersion}`\n\n  return nock(apiHost)\n    [method](`/${version}${uri}`)\n    .query({tag: 'sanity.cli', ...query})\n}\n"],"names":["nock","mockApi","apiHost","apiVersion","method","query","uri","version","startsWith","tag"],"mappings":"AAAA,OAAOA,UAAU,OAAM;AAkCvB;;;;CAIC,GACD,OAAO,SAASC,QAAQ,EACtBC,UAAU,uBAAuB,EACjCC,aAAa,aAAa,EAC1BC,SAAS,KAAK,EACdC,QAAQ,CAAC,CAAC,EACVC,GAAG,EACY;IACf,MAAMC,UAAUJ,WAAWK,UAAU,CAAC,OAAOL,aAAa,CAAC,CAAC,EAAEA,YAAY;IAE1E,OAAOH,KAAKE,QACV,CAACE,OAAO,CAAC,CAAC,CAAC,EAAEG,UAAUD,KAAK,EAC3BD,KAAK,CAAC;QAACI,KAAK;QAAc,GAAGJ,KAAK;IAAA;AACvC"}
+{"version":3,"sources":["../../src/test/mockApi.ts"],"sourcesContent":["import nock from 'nock'\n\n/**\n * @internal\n */\nexport interface MockApiOptions {\n  /**\n   * Uri to mock\n   */\n  uri: string\n\n  /**\n   * Api host to mock, defaults to `https://api.sanity.io`\n   */\n  apiHost?: string\n\n  /**\n   * Api version to mock, defaults to `v2025-05-14`\n   */\n  apiVersion?: string\n\n  /**\n   * Whether to include `tag: 'sanity.cli'` in query parameters.\n   * Defaults to `true`. Set to `false` for endpoints that don't use CLI tagging.\n   */\n  includeQueryTag?: boolean\n\n  /**\n   * HTTP method to mock\n   *\n   * Defaults to 'get'\n   */\n  method?: 'delete' | 'get' | 'patch' | 'post' | 'put'\n\n  /**\n   * Project ID to mock. When provided, constructs apiHost as `https://{projectId}.api.sanity.io`\n   * Takes precedence over apiHost if both are provided.\n   */\n  projectId?: string\n\n  /**\n   * Query parameters to mock\n   */\n  query?: Record<string, string>\n}\n\n/**\n * Mocks the API calls, add some defaults so it doesn't cause too much friction\n *\n * @internal\n */\nexport function mockApi({\n  apiHost = 'https://api.sanity.io',\n  apiVersion = 'v2025-05-14',\n  includeQueryTag = true,\n  method = 'get',\n  projectId,\n  query = {},\n  uri,\n}: MockApiOptions) {\n  const version = apiVersion.startsWith('v') ? apiVersion : `v${apiVersion}`\n  const host = projectId ? `https://${projectId}.api.sanity.io` : apiHost\n  const queryParams = includeQueryTag ? {tag: 'sanity.cli', ...query} : query\n\n  return nock(host)[method](`/${version}${uri}`).query(queryParams)\n}\n"],"names":["nock","mockApi","apiHost","apiVersion","includeQueryTag","method","projectId","query","uri","version","startsWith","host","queryParams","tag"],"mappings":"AAAA,OAAOA,UAAU,OAAM;AA8CvB;;;;CAIC,GACD,OAAO,SAASC,QAAQ,EACtBC,UAAU,uBAAuB,EACjCC,aAAa,aAAa,EAC1BC,kBAAkB,IAAI,EACtBC,SAAS,KAAK,EACdC,SAAS,EACTC,QAAQ,CAAC,CAAC,EACVC,GAAG,EACY;IACf,MAAMC,UAAUN,WAAWO,UAAU,CAAC,OAAOP,aAAa,CAAC,CAAC,EAAEA,YAAY;IAC1E,MAAMQ,OAAOL,YAAY,CAAC,QAAQ,EAAEA,UAAU,cAAc,CAAC,GAAGJ;IAChE,MAAMU,cAAcR,kBAAkB;QAACS,KAAK;QAAc,GAAGN,KAAK;IAAA,IAAIA;IAEtE,OAAOP,KAAKW,KAAK,CAACN,OAAO,CAAC,CAAC,CAAC,EAAEI,UAAUD,KAAK,EAAED,KAAK,CAACK;AACvD"}