@sanity/cli 5.2.0-next.12 → 6.0.0-alpha.4

package/dist/commands/openapi/__tests__/get.test.js

@@ -0,0 +1,149 @@
+import { runCommand } from '@oclif/test';
+import { testCommand } from '@sanity/cli-test';
+import nock from 'nock';
+import open from 'open';
+import { afterEach, describe, expect, test, vi } from 'vitest';
+import { GetOpenApiCommand } from '../get.js';
+const mockYamlSpec = `
+openapi: 3.0.0
+info:
+  title: Query API
+  version: 1.0.0
+paths:
+  /query:
+    get:
+      summary: Query documents
+`.trim();
+const mockJsonSpec = JSON.stringify({
+    info: {
+        title: 'Query API',
+        version: '1.0.0'
+    },
+    openapi: '3.0.0',
+    paths: {
+        '/query': {
+            get: {
+                summary: 'Query documents'
+            }
+        }
+    }
+});
+describe('#openapi:get', ()=>{
+    afterEach(()=>{
+        vi.clearAllMocks();
+        const pending = nock.pendingMocks();
+        nock.cleanAll();
+        expect(pending, 'pending mocks').toEqual([]);
+    });
+    test('--help works', async ()=>{
+        const { stdout } = await runCommand([
+            'openapi get',
+            '--help'
+        ]);
+        expect(stdout).toContain('Get an OpenAPI specification by slug');
+    });
+    test('gets YAML spec by default', async ()=>{
+        nock('https://www.sanity.io').get('/docs/api/openapi/query').query({
+            format: 'yaml'
+        }).reply(200, mockYamlSpec, {
+            'Content-Type': 'text/yaml'
+        });
+        const { stdout } = await testCommand(GetOpenApiCommand, [
+            'query'
+        ]);
+        expect(stdout).toContain(mockYamlSpec);
+    });
+    test('gets JSON spec with --format=json', async ()=>{
+        nock('https://www.sanity.io').get('/docs/api/openapi/query').query({
+            format: 'json'
+        }).reply(200, mockJsonSpec, {
+            'Content-Type': 'application/json'
+        });
+        const { stdout } = await testCommand(GetOpenApiCommand, [
+            'query',
+            '--format=json'
+        ]);
+        expect(stdout).toContain(mockJsonSpec);
+    });
+    test('gets YAML spec with explicit --format=yaml', async ()=>{
+        nock('https://www.sanity.io').get('/docs/api/openapi/query').query({
+            format: 'yaml'
+        }).reply(200, mockYamlSpec, {
+            'Content-Type': 'text/yaml'
+        });
+        const { stdout } = await testCommand(GetOpenApiCommand, [
+            'query',
+            '--format=yaml'
+        ]);
+        expect(stdout).toContain(mockYamlSpec);
+    });
+    test('opens web browser with --web flag', async ()=>{
+        const { stdout } = await testCommand(GetOpenApiCommand, [
+            'query',
+            '--web'
+        ]);
+        expect(stdout).toContain('Opening https://www.sanity.io/docs/http-reference/query');
+        expect(open).toHaveBeenCalledWith('https://www.sanity.io/docs/http-reference/query');
+    });
+    test('handles 404 not found', async ()=>{
+        nock('https://www.sanity.io').get('/docs/api/openapi/nonexistent').query({
+            format: 'yaml'
+        }).reply(404, 'Not Found');
+        const { error } = await testCommand(GetOpenApiCommand, [
+            'nonexistent'
+        ]);
+        expect(error).toBeInstanceOf(Error);
+        expect(error?.message).toContain('OpenAPI specification not found. nonexistent');
+        expect(error?.oclif?.exit).toBe(1);
+    });
+    test('handles server error', async ()=>{
+        nock('https://www.sanity.io').get('/docs/api/openapi/query').query({
+            format: 'yaml'
+        }).reply(500, 'Server Error');
+        const { error } = await testCommand(GetOpenApiCommand, [
+            'query'
+        ]);
+        expect(error).toBeInstanceOf(Error);
+        expect(error?.message).toContain('The OpenAPI service is currently unavailable. Please try again later.');
+        expect(error?.oclif?.exit).toBe(1);
+    });
+    test('handles network error', async ()=>{
+        nock('https://www.sanity.io').get('/docs/api/openapi/query').query({
+            format: 'yaml'
+        }).replyWithError('Network error');
+        const { error } = await testCommand(GetOpenApiCommand, [
+            'query'
+        ]);
+        expect(error).toBeInstanceOf(Error);
+        expect(error?.message).toContain('The OpenAPI service is currently unavailable. Please try again later.');
+        expect(error?.oclif?.exit).toBe(1);
+    });
+    test('requires slug argument', async ()=>{
+        const { error } = await testCommand(GetOpenApiCommand, []);
+        expect(error).toBeInstanceOf(Error);
+        expect(error?.message).toContain('Missing 1 required arg');
+        expect(error?.message).toContain('slug');
+        expect(error?.oclif?.exit).toBe(2);
+    });
+    test('handles different slug formats', async ()=>{
+        nock('https://www.sanity.io').get('/docs/api/openapi/admin-api').query({
+            format: 'yaml'
+        }).reply(200, mockYamlSpec, {
+            'Content-Type': 'text/yaml'
+        });
+        const { stdout } = await testCommand(GetOpenApiCommand, [
+            'admin-api'
+        ]);
+        expect(stdout).toContain(mockYamlSpec);
+    });
+    test('combines --web with slug in URL', async ()=>{
+        const { stdout } = await testCommand(GetOpenApiCommand, [
+            'admin-api',
+            '--web'
+        ]);
+        expect(stdout).toContain('Opening https://www.sanity.io/docs/http-reference/admin-api');
+        expect(open).toHaveBeenCalledWith('https://www.sanity.io/docs/http-reference/admin-api');
+    });
+});
+
+//# sourceMappingURL=get.test.js.map

package/dist/commands/openapi/__tests__/get.test.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/commands/openapi/__tests__/get.test.ts"],"sourcesContent":["import {runCommand} from '@oclif/test'\nimport {testCommand} from '@sanity/cli-test'\nimport nock from 'nock'\nimport open from 'open'\nimport {afterEach, describe, expect, test, vi} from 'vitest'\n\nimport {GetOpenApiCommand} from '../get.js'\n\nconst mockYamlSpec = `\nopenapi: 3.0.0\ninfo:\n  title: Query API\n  version: 1.0.0\npaths:\n  /query:\n    get:\n      summary: Query documents\n`.trim()\n\nconst mockJsonSpec = JSON.stringify({\n  info: {\n    title: 'Query API',\n    version: '1.0.0',\n  },\n  openapi: '3.0.0',\n  paths: {\n    '/query': {\n      get: {\n        summary: 'Query documents',\n      },\n    },\n  },\n})\n\ndescribe('#openapi:get', () => {\n  afterEach(() => {\n    vi.clearAllMocks()\n    const pending = nock.pendingMocks()\n    nock.cleanAll()\n    expect(pending, 'pending mocks').toEqual([])\n  })\n\n  test('--help works', async () => {\n    const {stdout} = await runCommand(['openapi get', '--help'])\n\n    expect(stdout).toContain('Get an OpenAPI specification by slug')\n  })\n\n  test('gets YAML spec by default', async () => {\n    nock('https://www.sanity.io')\n      .get('/docs/api/openapi/query')\n      .query({format: 'yaml'})\n      .reply(200, mockYamlSpec, {'Content-Type': 'text/yaml'})\n\n    const {stdout} = await testCommand(GetOpenApiCommand, ['query'])\n\n    expect(stdout).toContain(mockYamlSpec)\n  })\n\n  test('gets JSON spec with --format=json', async () => {\n    nock('https://www.sanity.io')\n      .get('/docs/api/openapi/query')\n      .query({format: 'json'})\n      .reply(200, mockJsonSpec, {'Content-Type': 'application/json'})\n\n    const {stdout} = await testCommand(GetOpenApiCommand, ['query', '--format=json'])\n\n    expect(stdout).toContain(mockJsonSpec)\n  })\n\n  test('gets YAML spec with explicit --format=yaml', async () => {\n    nock('https://www.sanity.io')\n      .get('/docs/api/openapi/query')\n      .query({format: 'yaml'})\n      .reply(200, mockYamlSpec, {'Content-Type': 'text/yaml'})\n\n    const {stdout} = await testCommand(GetOpenApiCommand, ['query', '--format=yaml'])\n\n    expect(stdout).toContain(mockYamlSpec)\n  })\n\n  test('opens web browser with --web flag', async () => {\n    const {stdout} = await testCommand(GetOpenApiCommand, ['query', '--web'])\n\n    expect(stdout).toContain('Opening https://www.sanity.io/docs/http-reference/query')\n    expect(open).toHaveBeenCalledWith('https://www.sanity.io/docs/http-reference/query')\n  })\n\n  test('handles 404 not found', async () => {\n    nock('https://www.sanity.io')\n      .get('/docs/api/openapi/nonexistent')\n      .query({format: 'yaml'})\n      .reply(404, 'Not Found')\n\n    const {error} = await testCommand(GetOpenApiCommand, ['nonexistent'])\n\n    expect(error).toBeInstanceOf(Error)\n    expect(error?.message).toContain('OpenAPI specification not found. nonexistent')\n    expect(error?.oclif?.exit).toBe(1)\n  })\n\n  test('handles server error', async () => {\n    nock('https://www.sanity.io')\n      .get('/docs/api/openapi/query')\n      .query({format: 'yaml'})\n      .reply(500, 'Server Error')\n\n    const {error} = await testCommand(GetOpenApiCommand, ['query'])\n\n    expect(error).toBeInstanceOf(Error)\n    expect(error?.message).toContain(\n      'The OpenAPI service is currently unavailable. Please try again later.',\n    )\n    expect(error?.oclif?.exit).toBe(1)\n  })\n\n  test('handles network error', async () => {\n    nock('https://www.sanity.io')\n      .get('/docs/api/openapi/query')\n      .query({format: 'yaml'})\n      .replyWithError('Network error')\n\n    const {error} = await testCommand(GetOpenApiCommand, ['query'])\n\n    expect(error).toBeInstanceOf(Error)\n    expect(error?.message).toContain(\n      'The OpenAPI service is currently unavailable. Please try again later.',\n    )\n    expect(error?.oclif?.exit).toBe(1)\n  })\n\n  test('requires slug argument', async () => {\n    const {error} = await testCommand(GetOpenApiCommand, [])\n\n    expect(error).toBeInstanceOf(Error)\n    expect(error?.message).toContain('Missing 1 required arg')\n    expect(error?.message).toContain('slug')\n    expect(error?.oclif?.exit).toBe(2)\n  })\n\n  test('handles different slug formats', async () => {\n    nock('https://www.sanity.io')\n      .get('/docs/api/openapi/admin-api')\n      .query({format: 'yaml'})\n      .reply(200, mockYamlSpec, {'Content-Type': 'text/yaml'})\n\n    const {stdout} = await testCommand(GetOpenApiCommand, ['admin-api'])\n\n    expect(stdout).toContain(mockYamlSpec)\n  })\n\n  test('combines --web with slug in URL', async () => {\n    const {stdout} = await testCommand(GetOpenApiCommand, ['admin-api', '--web'])\n\n    expect(stdout).toContain('Opening https://www.sanity.io/docs/http-reference/admin-api')\n    expect(open).toHaveBeenCalledWith('https://www.sanity.io/docs/http-reference/admin-api')\n  })\n})\n"],"names":["runCommand","testCommand","nock","open","afterEach","describe","expect","test","vi","GetOpenApiCommand","mockYamlSpec","trim","mockJsonSpec","JSON","stringify","info","title","version","openapi","paths","get","summary","clearAllMocks","pending","pendingMocks","cleanAll","toEqual","stdout","toContain","query","format","reply","toHaveBeenCalledWith","error","toBeInstanceOf","Error","message","oclif","exit","toBe","replyWithError"],"mappings":"AAAA,SAAQA,UAAU,QAAO,cAAa;AACtC,SAAQC,WAAW,QAAO,mBAAkB;AAC5C,OAAOC,UAAU,OAAM;AACvB,OAAOC,UAAU,OAAM;AACvB,SAAQC,SAAS,EAAEC,QAAQ,EAAEC,MAAM,EAAEC,IAAI,EAAEC,EAAE,QAAO,SAAQ;AAE5D,SAAQC,iBAAiB,QAAO,YAAW;AAE3C,MAAMC,eAAe,CAAC;;;;;;;;;AAStB,CAAC,CAACC,IAAI;AAEN,MAAMC,eAAeC,KAAKC,SAAS,CAAC;IAClCC,MAAM;QACJC,OAAO;QACPC,SAAS;IACX;IACAC,SAAS;IACTC,OAAO;QACL,UAAU;YACRC,KAAK;gBACHC,SAAS;YACX;QACF;IACF;AACF;AAEAhB,SAAS,gBAAgB;IACvBD,UAAU;QACRI,GAAGc,aAAa;QAChB,MAAMC,UAAUrB,KAAKsB,YAAY;QACjCtB,KAAKuB,QAAQ;QACbnB,OAAOiB,SAAS,iBAAiBG,OAAO,CAAC,EAAE;IAC7C;IAEAnB,KAAK,gBAAgB;QACnB,MAAM,EAACoB,MAAM,EAAC,GAAG,MAAM3B,WAAW;YAAC;YAAe;SAAS;QAE3DM,OAAOqB,QAAQC,SAAS,CAAC;IAC3B;IAEArB,KAAK,6BAA6B;QAChCL,KAAK,yBACFkB,GAAG,CAAC,2BACJS,KAAK,CAAC;YAACC,QAAQ;QAAM,GACrBC,KAAK,CAAC,KAAKrB,cAAc;YAAC,gBAAgB;QAAW;QAExD,MAAM,EAACiB,MAAM,EAAC,GAAG,MAAM1B,YAAYQ,mBAAmB;YAAC;SAAQ;QAE/DH,OAAOqB,QAAQC,SAAS,CAAClB;IAC3B;IAEAH,KAAK,qCAAqC;QACxCL,KAAK,yBACFkB,GAAG,CAAC,2BACJS,KAAK,CAAC;YAACC,QAAQ;QAAM,GACrBC,KAAK,CAAC,KAAKnB,cAAc;YAAC,gBAAgB;QAAkB;QAE/D,MAAM,EAACe,MAAM,EAAC,GAAG,MAAM1B,YAAYQ,mBAAmB;YAAC;YAAS;SAAgB;QAEhFH,OAAOqB,QAAQC,SAAS,CAAChB;IAC3B;IAEAL,KAAK,8CAA8C;QACjDL,KAAK,yBACFkB,GAAG,CAAC,2BACJS,KAAK,CAAC;YAACC,QAAQ;QAAM,GACrBC,KAAK,CAAC,KAAKrB,cAAc;YAAC,gBAAgB;QAAW;QAExD,MAAM,EAACiB,MAAM,EAAC,GAAG,MAAM1B,YAAYQ,mBAAmB;YAAC;YAAS;SAAgB;QAEhFH,OAAOqB,QAAQC,SAAS,CAAClB;IAC3B;IAEAH,KAAK,qCAAqC;QACxC,MAAM,EAACoB,MAAM,EAAC,GAAG,MAAM1B,YAAYQ,mBAAmB;YAAC;YAAS;SAAQ;QAExEH,OAAOqB,QAAQC,SAAS,CAAC;QACzBtB,OAAOH,MAAM6B,oBAAoB,CAAC;IACpC;IAEAzB,KAAK,yBAAyB;QAC5BL,KAAK,yBACFkB,GAAG,CAAC,iCACJS,KAAK,CAAC;YAACC,QAAQ;QAAM,GACrBC,KAAK,CAAC,KAAK;QAEd,MAAM,EAACE,KAAK,EAAC,GAAG,MAAMhC,YAAYQ,mBAAmB;YAAC;SAAc;QAEpEH,OAAO2B,OAAOC,cAAc,CAACC;QAC7B7B,OAAO2B,OAAOG,SAASR,SAAS,CAAC;QACjCtB,OAAO2B,OAAOI,OAAOC,MAAMC,IAAI,CAAC;IAClC;IAEAhC,KAAK,wBAAwB;QAC3BL,KAAK,yBACFkB,GAAG,CAAC,2BACJS,KAAK,CAAC;YAACC,QAAQ;QAAM,GACrBC,KAAK,CAAC,KAAK;QAEd,MAAM,EAACE,KAAK,EAAC,GAAG,MAAMhC,YAAYQ,mBAAmB;YAAC;SAAQ;QAE9DH,OAAO2B,OAAOC,cAAc,CAACC;QAC7B7B,OAAO2B,OAAOG,SAASR,SAAS,CAC9B;QAEFtB,OAAO2B,OAAOI,OAAOC,MAAMC,IAAI,CAAC;IAClC;IAEAhC,KAAK,yBAAyB;QAC5BL,KAAK,yBACFkB,GAAG,CAAC,2BACJS,KAAK,CAAC;YAACC,QAAQ;QAAM,GACrBU,cAAc,CAAC;QAElB,MAAM,EAACP,KAAK,EAAC,GAAG,MAAMhC,YAAYQ,mBAAmB;YAAC;SAAQ;QAE9DH,OAAO2B,OAAOC,cAAc,CAACC;QAC7B7B,OAAO2B,OAAOG,SAASR,SAAS,CAC9B;QAEFtB,OAAO2B,OAAOI,OAAOC,MAAMC,IAAI,CAAC;IAClC;IAEAhC,KAAK,0BAA0B;QAC7B,MAAM,EAAC0B,KAAK,EAAC,GAAG,MAAMhC,YAAYQ,mBAAmB,EAAE;QAEvDH,OAAO2B,OAAOC,cAAc,CAACC;QAC7B7B,OAAO2B,OAAOG,SAASR,SAAS,CAAC;QACjCtB,OAAO2B,OAAOG,SAASR,SAAS,CAAC;QACjCtB,OAAO2B,OAAOI,OAAOC,MAAMC,IAAI,CAAC;IAClC;IAEAhC,KAAK,kCAAkC;QACrCL,KAAK,yBACFkB,GAAG,CAAC,+BACJS,KAAK,CAAC;YAACC,QAAQ;QAAM,GACrBC,KAAK,CAAC,KAAKrB,cAAc;YAAC,gBAAgB;QAAW;QAExD,MAAM,EAACiB,MAAM,EAAC,GAAG,MAAM1B,YAAYQ,mBAAmB;YAAC;SAAY;QAEnEH,OAAOqB,QAAQC,SAAS,CAAClB;IAC3B;IAEAH,KAAK,mCAAmC;QACtC,MAAM,EAACoB,MAAM,EAAC,GAAG,MAAM1B,YAAYQ,mBAAmB;YAAC;YAAa;SAAQ;QAE5EH,OAAOqB,QAAQC,SAAS,CAAC;QACzBtB,OAAOH,MAAM6B,oBAAoB,CAAC;IACpC;AACF"}

package/dist/commands/openapi/__tests__/list.test.js

@@ -0,0 +1,113 @@
+import { runCommand } from '@oclif/test';
+import { testCommand } from '@sanity/cli-test';
+import nock from 'nock';
+import open from 'open';
+import { afterEach, describe, expect, test, vi } from 'vitest';
+import { ListOpenApiCommand } from '../list.js';
+const mockSpecs = [
+    {
+        description: 'Query documents and other content',
+        slug: 'query',
+        title: 'Query API'
+    },
+    {
+        description: 'Create, update and delete documents',
+        slug: 'mutate',
+        title: 'Mutate API'
+    }
+];
+describe('#openapi:list', ()=>{
+    afterEach(()=>{
+        vi.clearAllMocks();
+        const pending = nock.pendingMocks();
+        nock.cleanAll();
+        expect(pending, 'pending mocks').toEqual([]);
+    });
+    test('--help works', async ()=>{
+        const { stdout } = await runCommand([
+            'openapi list',
+            '--help'
+        ]);
+        expect(stdout).toContain('List all available OpenAPI specifications');
+    });
+    test('displays OpenAPI specs correctly', async ()=>{
+        nock('https://www.sanity.io').get('/docs/api/openapi').reply(200, {
+            specs: mockSpecs
+        }, {
+            'Content-Type': 'application/json'
+        });
+        const { stdout } = await testCommand(ListOpenApiCommand);
+        expect(stdout).toContain('Title: Query API');
+        expect(stdout).toContain('Description: Query documents and other content');
+        expect(stdout).toContain('Slug: query');
+        expect(stdout).toContain('Title: Mutate API');
+        expect(stdout).toContain('Description: Create, update and delete documents');
+        expect(stdout).toContain('Slug: mutate');
+    });
+    test('displays specs in JSON format with --json flag', async ()=>{
+        nock('https://www.sanity.io').get('/docs/api/openapi').reply(200, {
+            specs: mockSpecs
+        }, {
+            'Content-Type': 'application/json'
+        });
+        const { stdout } = await testCommand(ListOpenApiCommand, [
+            '--json'
+        ]);
+        expect(stdout).toContain(JSON.stringify(mockSpecs, null, 2));
+    });
+    test('opens web browser with --web flag', async ()=>{
+        const { stdout } = await testCommand(ListOpenApiCommand, [
+            '--web'
+        ]);
+        expect(stdout).toContain('Opening https://www.sanity.io/docs/http-reference');
+        expect(open).toHaveBeenCalledWith('https://www.sanity.io/docs/http-reference');
+    });
+    test('handles empty specs list', async ()=>{
+        nock('https://www.sanity.io').get('/docs/api/openapi').reply(200, {
+            specs: []
+        }, {
+            'Content-Type': 'application/json'
+        });
+        const { stdout } = await testCommand(ListOpenApiCommand);
+        expect(stdout).toContain('No OpenAPI specifications available.');
+    });
+    test('handles missing specs property', async ()=>{
+        nock('https://www.sanity.io').get('/docs/api/openapi').reply(200, {}, {
+            'Content-Type': 'application/json'
+        });
+        const { stdout } = await testCommand(ListOpenApiCommand);
+        expect(stdout).toContain('No OpenAPI specifications available.');
+    });
+    test('handles specs without description', async ()=>{
+        const specsWithoutDesc = [
+            {
+                slug: 'test',
+                title: 'Test API'
+            }
+        ];
+        nock('https://www.sanity.io').get('/docs/api/openapi').reply(200, {
+            specs: specsWithoutDesc
+        }, {
+            'Content-Type': 'application/json'
+        });
+        const { stdout } = await testCommand(ListOpenApiCommand);
+        expect(stdout).toContain('Title: Test API');
+        expect(stdout).not.toContain('  ');
+    });
+    test('handles API server error', async ()=>{
+        nock('https://www.sanity.io').get('/docs/api/openapi').reply(500, 'Server Error');
+        const { error } = await testCommand(ListOpenApiCommand);
+        expect(error).toBeInstanceOf(Error);
+        expect(error?.message).toContain('The OpenAPI service is currently unavailable. Please try again later.');
+        expect(error?.oclif?.exit).toBe(1);
+    });
+    test('handles network error', async ()=>{
+        nock('https://www.sanity.io').get('/docs/api/openapi').replyWithError('Network error');
+        const { error } = await testCommand(ListOpenApiCommand);
+        expect(error).toBeInstanceOf(Error);
+        expect(error?.message).toContain('The OpenAPI service is currently unavailable. Please try again later.');
+        expect(error?.oclif?.exit).toBe(1);
+    });
+});
+
+//# sourceMappingURL=list.test.js.map

package/dist/commands/openapi/__tests__/list.test.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/commands/openapi/__tests__/list.test.ts"],"sourcesContent":["import {runCommand} from '@oclif/test'\nimport {testCommand} from '@sanity/cli-test'\nimport nock from 'nock'\nimport open from 'open'\nimport {afterEach, describe, expect, test, vi} from 'vitest'\n\nimport {ListOpenApiCommand} from '../list.js'\n\nconst mockSpecs = [\n  {\n    description: 'Query documents and other content',\n    slug: 'query',\n    title: 'Query API',\n  },\n  {\n    description: 'Create, update and delete documents',\n    slug: 'mutate',\n    title: 'Mutate API',\n  },\n]\n\ndescribe('#openapi:list', () => {\n  afterEach(() => {\n    vi.clearAllMocks()\n    const pending = nock.pendingMocks()\n    nock.cleanAll()\n    expect(pending, 'pending mocks').toEqual([])\n  })\n\n  test('--help works', async () => {\n    const {stdout} = await runCommand(['openapi list', '--help'])\n\n    expect(stdout).toContain('List all available OpenAPI specifications')\n  })\n\n  test('displays OpenAPI specs correctly', async () => {\n    nock('https://www.sanity.io')\n      .get('/docs/api/openapi')\n      .reply(200, {specs: mockSpecs}, {'Content-Type': 'application/json'})\n\n    const {stdout} = await testCommand(ListOpenApiCommand)\n\n    expect(stdout).toContain('Title: Query API')\n    expect(stdout).toContain('Description: Query documents and other content')\n    expect(stdout).toContain('Slug: query')\n    expect(stdout).toContain('Title: Mutate API')\n    expect(stdout).toContain('Description: Create, update and delete documents')\n    expect(stdout).toContain('Slug: mutate')\n  })\n\n  test('displays specs in JSON format with --json flag', async () => {\n    nock('https://www.sanity.io')\n      .get('/docs/api/openapi')\n      .reply(200, {specs: mockSpecs}, {'Content-Type': 'application/json'})\n\n    const {stdout} = await testCommand(ListOpenApiCommand, ['--json'])\n\n    expect(stdout).toContain(JSON.stringify(mockSpecs, null, 2))\n  })\n\n  test('opens web browser with --web flag', async () => {\n    const {stdout} = await testCommand(ListOpenApiCommand, ['--web'])\n\n    expect(stdout).toContain('Opening https://www.sanity.io/docs/http-reference')\n    expect(open).toHaveBeenCalledWith('https://www.sanity.io/docs/http-reference')\n  })\n\n  test('handles empty specs list', async () => {\n    nock('https://www.sanity.io')\n      .get('/docs/api/openapi')\n      .reply(200, {specs: []}, {'Content-Type': 'application/json'})\n\n    const {stdout} = await testCommand(ListOpenApiCommand)\n\n    expect(stdout).toContain('No OpenAPI specifications available.')\n  })\n\n  test('handles missing specs property', async () => {\n    nock('https://www.sanity.io')\n      .get('/docs/api/openapi')\n      .reply(200, {}, {'Content-Type': 'application/json'})\n\n    const {stdout} = await testCommand(ListOpenApiCommand)\n\n    expect(stdout).toContain('No OpenAPI specifications available.')\n  })\n\n  test('handles specs without description', async () => {\n    const specsWithoutDesc = [{slug: 'test', title: 'Test API'}]\n    nock('https://www.sanity.io')\n      .get('/docs/api/openapi')\n      .reply(200, {specs: specsWithoutDesc}, {'Content-Type': 'application/json'})\n\n    const {stdout} = await testCommand(ListOpenApiCommand)\n\n    expect(stdout).toContain('Title: Test API')\n    expect(stdout).not.toContain('  ')\n  })\n\n  test('handles API server error', async () => {\n    nock('https://www.sanity.io').get('/docs/api/openapi').reply(500, 'Server Error')\n\n    const {error} = await testCommand(ListOpenApiCommand)\n\n    expect(error).toBeInstanceOf(Error)\n    expect(error?.message).toContain(\n      'The OpenAPI service is currently unavailable. Please try again later.',\n    )\n    expect(error?.oclif?.exit).toBe(1)\n  })\n\n  test('handles network error', async () => {\n    nock('https://www.sanity.io').get('/docs/api/openapi').replyWithError('Network error')\n\n    const {error} = await testCommand(ListOpenApiCommand)\n\n    expect(error).toBeInstanceOf(Error)\n    expect(error?.message).toContain(\n      'The OpenAPI service is currently unavailable. Please try again later.',\n    )\n    expect(error?.oclif?.exit).toBe(1)\n  })\n})\n"],"names":["runCommand","testCommand","nock","open","afterEach","describe","expect","test","vi","ListOpenApiCommand","mockSpecs","description","slug","title","clearAllMocks","pending","pendingMocks","cleanAll","toEqual","stdout","toContain","get","reply","specs","JSON","stringify","toHaveBeenCalledWith","specsWithoutDesc","not","error","toBeInstanceOf","Error","message","oclif","exit","toBe","replyWithError"],"mappings":"AAAA,SAAQA,UAAU,QAAO,cAAa;AACtC,SAAQC,WAAW,QAAO,mBAAkB;AAC5C,OAAOC,UAAU,OAAM;AACvB,OAAOC,UAAU,OAAM;AACvB,SAAQC,SAAS,EAAEC,QAAQ,EAAEC,MAAM,EAAEC,IAAI,EAAEC,EAAE,QAAO,SAAQ;AAE5D,SAAQC,kBAAkB,QAAO,aAAY;AAE7C,MAAMC,YAAY;IAChB;QACEC,aAAa;QACbC,MAAM;QACNC,OAAO;IACT;IACA;QACEF,aAAa;QACbC,MAAM;QACNC,OAAO;IACT;CACD;AAEDR,SAAS,iBAAiB;IACxBD,UAAU;QACRI,GAAGM,aAAa;QAChB,MAAMC,UAAUb,KAAKc,YAAY;QACjCd,KAAKe,QAAQ;QACbX,OAAOS,SAAS,iBAAiBG,OAAO,CAAC,EAAE;IAC7C;IAEAX,KAAK,gBAAgB;QACnB,MAAM,EAACY,MAAM,EAAC,GAAG,MAAMnB,WAAW;YAAC;YAAgB;SAAS;QAE5DM,OAAOa,QAAQC,SAAS,CAAC;IAC3B;IAEAb,KAAK,oCAAoC;QACvCL,KAAK,yBACFmB,GAAG,CAAC,qBACJC,KAAK,CAAC,KAAK;YAACC,OAAOb;QAAS,GAAG;YAAC,gBAAgB;QAAkB;QAErE,MAAM,EAACS,MAAM,EAAC,GAAG,MAAMlB,YAAYQ;QAEnCH,OAAOa,QAAQC,SAAS,CAAC;QACzBd,OAAOa,QAAQC,SAAS,CAAC;QACzBd,OAAOa,QAAQC,SAAS,CAAC;QACzBd,OAAOa,QAAQC,SAAS,CAAC;QACzBd,OAAOa,QAAQC,SAAS,CAAC;QACzBd,OAAOa,QAAQC,SAAS,CAAC;IAC3B;IAEAb,KAAK,kDAAkD;QACrDL,KAAK,yBACFmB,GAAG,CAAC,qBACJC,KAAK,CAAC,KAAK;YAACC,OAAOb;QAAS,GAAG;YAAC,gBAAgB;QAAkB;QAErE,MAAM,EAACS,MAAM,EAAC,GAAG,MAAMlB,YAAYQ,oBAAoB;YAAC;SAAS;QAEjEH,OAAOa,QAAQC,SAAS,CAACI,KAAKC,SAAS,CAACf,WAAW,MAAM;IAC3D;IAEAH,KAAK,qCAAqC;QACxC,MAAM,EAACY,MAAM,EAAC,GAAG,MAAMlB,YAAYQ,oBAAoB;YAAC;SAAQ;QAEhEH,OAAOa,QAAQC,SAAS,CAAC;QACzBd,OAAOH,MAAMuB,oBAAoB,CAAC;IACpC;IAEAnB,KAAK,4BAA4B;QAC/BL,KAAK,yBACFmB,GAAG,CAAC,qBACJC,KAAK,CAAC,KAAK;YAACC,OAAO,EAAE;QAAA,GAAG;YAAC,gBAAgB;QAAkB;QAE9D,MAAM,EAACJ,MAAM,EAAC,GAAG,MAAMlB,YAAYQ;QAEnCH,OAAOa,QAAQC,SAAS,CAAC;IAC3B;IAEAb,KAAK,kCAAkC;QACrCL,KAAK,yBACFmB,GAAG,CAAC,qBACJC,KAAK,CAAC,KAAK,CAAC,GAAG;YAAC,gBAAgB;QAAkB;QAErD,MAAM,EAACH,MAAM,EAAC,GAAG,MAAMlB,YAAYQ;QAEnCH,OAAOa,QAAQC,SAAS,CAAC;IAC3B;IAEAb,KAAK,qCAAqC;QACxC,MAAMoB,mBAAmB;YAAC;gBAACf,MAAM;gBAAQC,OAAO;YAAU;SAAE;QAC5DX,KAAK,yBACFmB,GAAG,CAAC,qBACJC,KAAK,CAAC,KAAK;YAACC,OAAOI;QAAgB,GAAG;YAAC,gBAAgB;QAAkB;QAE5E,MAAM,EAACR,MAAM,EAAC,GAAG,MAAMlB,YAAYQ;QAEnCH,OAAOa,QAAQC,SAAS,CAAC;QACzBd,OAAOa,QAAQS,GAAG,CAACR,SAAS,CAAC;IAC/B;IAEAb,KAAK,4BAA4B;QAC/BL,KAAK,yBAAyBmB,GAAG,CAAC,qBAAqBC,KAAK,CAAC,KAAK;QAElE,MAAM,EAACO,KAAK,EAAC,GAAG,MAAM5B,YAAYQ;QAElCH,OAAOuB,OAAOC,cAAc,CAACC;QAC7BzB,OAAOuB,OAAOG,SAASZ,SAAS,CAC9B;QAEFd,OAAOuB,OAAOI,OAAOC,MAAMC,IAAI,CAAC;IAClC;IAEA5B,KAAK,yBAAyB;QAC5BL,KAAK,yBAAyBmB,GAAG,CAAC,qBAAqBe,cAAc,CAAC;QAEtE,MAAM,EAACP,KAAK,EAAC,GAAG,MAAM5B,YAAYQ;QAElCH,OAAOuB,OAAOC,cAAc,CAACC;QAC7BzB,OAAOuB,OAAOG,SAASZ,SAAS,CAC9B;QAEFd,OAAOuB,OAAOI,OAAOC,MAAMC,IAAI,CAAC;IAClC;AACF"}

package/dist/commands/openapi/get.d.ts

@@ -0,0 +1,17 @@
+import { SanityCommand } from '@sanity/cli-core';
+export declare class GetOpenApiCommand extends SanityCommand<typeof GetOpenApiCommand> {
+    static args: {
+        slug: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: {
+        command: string;
+        description: string;
+    }[];
+    static flags: {
+        format: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        web: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+    private getSpecContent;
+}

package/dist/commands/openapi/get.js

@@ -0,0 +1,83 @@
+import { Args, Flags } from '@oclif/core';
+import { SanityCommand, subdebug } from '@sanity/cli-core';
+import open from 'open';
+const getOpenapiDebug = subdebug('openapi:get');
+export class GetOpenApiCommand extends SanityCommand {
+    static args = {
+        slug: Args.string({
+            description: 'Slug of the OpenAPI specification to retrieve',
+            required: true
+        })
+    };
+    static description = 'Get an OpenAPI specification by slug';
+    static examples = [
+        {
+            command: '<%= config.bin %> <%= command.id %> query',
+            description: 'Get a specification (YAML format, default)'
+        },
+        {
+            command: '<%= config.bin %> <%= command.id %> query --format=json',
+            description: 'Get specification in JSON format'
+        },
+        {
+            command: '<%= config.bin %> <%= command.id %> query --web',
+            description: 'Open specification in browser'
+        },
+        {
+            command: '<%= config.bin %> <%= command.id %> query > query-api.yaml',
+            description: 'Pipe to file'
+        }
+    ];
+    static flags = {
+        format: Flags.string({
+            default: 'yaml',
+            description: 'Output format: yaml (default), json',
+            options: [
+                'yaml',
+                'json'
+            ]
+        }),
+        web: Flags.boolean({
+            char: 'w',
+            description: 'Open in web browser'
+        })
+    };
+    async run() {
+        const { args, flags } = await this.parse(GetOpenApiCommand);
+        const { slug } = args;
+        const { format, web } = flags;
+        if (web) {
+            const url = `https://www.sanity.io/docs/http-reference/${slug}`;
+            this.log(`Opening ${url}`);
+            await open(url);
+            return;
+        }
+        try {
+            const specContent = await this.getSpecContent(slug, format);
+            this.log(specContent);
+        } catch (error) {
+            getOpenapiDebug(`Error fetching OpenAPI spec ${slug}`, error);
+            if (error instanceof Response && error.status === 404) {
+                this.error(`OpenAPI specification not found. ${slug}`, {
+                    exit: 1
+                });
+            }
+            this.error('The OpenAPI service is currently unavailable. Please try again later.', {
+                exit: 1
+            });
+        }
+    }
+    async getSpecContent(slug, format) {
+        const url = new URL(`https://www.sanity.io/docs/api/openapi/${slug}`);
+        url.searchParams.set('format', format);
+        const response = await fetch(url, {
+            signal: AbortSignal.timeout(10_000)
+        });
+        if (response.ok) {
+            return response.text();
+        }
+        throw response;
+    }
+}
+
+//# sourceMappingURL=get.js.map

package/dist/commands/openapi/get.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/commands/openapi/get.ts"],"sourcesContent":["import {Args, Flags} from '@oclif/core'\nimport {SanityCommand, subdebug} from '@sanity/cli-core'\nimport open from 'open'\n\nconst getOpenapiDebug = subdebug('openapi:get')\n\nexport class GetOpenApiCommand extends SanityCommand<typeof GetOpenApiCommand> {\n  static override args = {\n    slug: Args.string({\n      description: 'Slug of the OpenAPI specification to retrieve',\n      required: true,\n    }),\n  }\n\n  static override description = 'Get an OpenAPI specification by slug'\n\n  static override examples = [\n    {\n      command: '<%= config.bin %> <%= command.id %> query',\n      description: 'Get a specification (YAML format, default)',\n    },\n    {\n      command: '<%= config.bin %> <%= command.id %> query --format=json',\n      description: 'Get specification in JSON format',\n    },\n    {\n      command: '<%= config.bin %> <%= command.id %> query --web',\n      description: 'Open specification in browser',\n    },\n    {\n      command: '<%= config.bin %> <%= command.id %> query > query-api.yaml',\n      description: 'Pipe to file',\n    },\n  ]\n\n  static override flags = {\n    format: Flags.string({\n      default: 'yaml',\n      description: 'Output format: yaml (default), json',\n      options: ['yaml', 'json'],\n    }),\n    web: Flags.boolean({\n      char: 'w',\n      description: 'Open in web browser',\n    }),\n  }\n\n  public async run(): Promise<void> {\n    const {args, flags} = await this.parse(GetOpenApiCommand)\n    const {slug} = args\n    const {format, web} = flags\n\n    if (web) {\n      const url = `https://www.sanity.io/docs/http-reference/${slug}`\n      this.log(`Opening ${url}`)\n      await open(url)\n      return\n    }\n\n    try {\n      const specContent = await this.getSpecContent(slug, format)\n\n      this.log(specContent)\n    } catch (error) {\n      getOpenapiDebug(`Error fetching OpenAPI spec ${slug}`, error)\n\n      if (error instanceof Response && error.status === 404) {\n        this.error(`OpenAPI specification not found. ${slug}`, {exit: 1})\n      }\n\n      this.error('The OpenAPI service is currently unavailable. Please try again later.', {\n        exit: 1,\n      })\n    }\n  }\n\n  private async getSpecContent(slug: string, format: string): Promise<string> {\n    const url = new URL(`https://www.sanity.io/docs/api/openapi/${slug}`)\n    url.searchParams.set('format', format)\n    const response = await fetch(url, {\n      signal: AbortSignal.timeout(10_000),\n    })\n\n    if (response.ok) {\n      return response.text()\n    }\n\n    throw response\n  }\n}\n"],"names":["Args","Flags","SanityCommand","subdebug","open","getOpenapiDebug","GetOpenApiCommand","args","slug","string","description","required","examples","command","flags","format","default","options","web","boolean","char","run","parse","url","log","specContent","getSpecContent","error","Response","status","exit","URL","searchParams","set","response","fetch","signal","AbortSignal","timeout","ok","text"],"mappings":"AAAA,SAAQA,IAAI,EAAEC,KAAK,QAAO,cAAa;AACvC,SAAQC,aAAa,EAAEC,QAAQ,QAAO,mBAAkB;AACxD,OAAOC,UAAU,OAAM;AAEvB,MAAMC,kBAAkBF,SAAS;AAEjC,OAAO,MAAMG,0BAA0BJ;IACrC,OAAgBK,OAAO;QACrBC,MAAMR,KAAKS,MAAM,CAAC;YAChBC,aAAa;YACbC,UAAU;QACZ;IACF,EAAC;IAED,OAAgBD,cAAc,uCAAsC;IAEpE,OAAgBE,WAAW;QACzB;YACEC,SAAS;YACTH,aAAa;QACf;QACA;YACEG,SAAS;YACTH,aAAa;QACf;QACA;YACEG,SAAS;YACTH,aAAa;QACf;QACA;YACEG,SAAS;YACTH,aAAa;QACf;KACD,CAAA;IAED,OAAgBI,QAAQ;QACtBC,QAAQd,MAAMQ,MAAM,CAAC;YACnBO,SAAS;YACTN,aAAa;YACbO,SAAS;gBAAC;gBAAQ;aAAO;QAC3B;QACAC,KAAKjB,MAAMkB,OAAO,CAAC;YACjBC,MAAM;YACNV,aAAa;QACf;IACF,EAAC;IAED,MAAaW,MAAqB;QAChC,MAAM,EAACd,IAAI,EAAEO,KAAK,EAAC,GAAG,MAAM,IAAI,CAACQ,KAAK,CAAChB;QACvC,MAAM,EAACE,IAAI,EAAC,GAAGD;QACf,MAAM,EAACQ,MAAM,EAAEG,GAAG,EAAC,GAAGJ;QAEtB,IAAII,KAAK;YACP,MAAMK,MAAM,CAAC,0CAA0C,EAAEf,MAAM;YAC/D,IAAI,CAACgB,GAAG,CAAC,CAAC,QAAQ,EAAED,KAAK;YACzB,MAAMnB,KAAKmB;YACX;QACF;QAEA,IAAI;YACF,MAAME,cAAc,MAAM,IAAI,CAACC,cAAc,CAAClB,MAAMO;YAEpD,IAAI,CAACS,GAAG,CAACC;QACX,EAAE,OAAOE,OAAO;YACdtB,gBAAgB,CAAC,4BAA4B,EAAEG,MAAM,EAAEmB;YAEvD,IAAIA,iBAAiBC,YAAYD,MAAME,MAAM,KAAK,KAAK;gBACrD,IAAI,CAACF,KAAK,CAAC,CAAC,iCAAiC,EAAEnB,MAAM,EAAE;oBAACsB,MAAM;gBAAC;YACjE;YAEA,IAAI,CAACH,KAAK,CAAC,yEAAyE;gBAClFG,MAAM;YACR;QACF;IACF;IAEA,MAAcJ,eAAelB,IAAY,EAAEO,MAAc,EAAmB;QAC1E,MAAMQ,MAAM,IAAIQ,IAAI,CAAC,uCAAuC,EAAEvB,MAAM;QACpEe,IAAIS,YAAY,CAACC,GAAG,CAAC,UAAUlB;QAC/B,MAAMmB,WAAW,MAAMC,MAAMZ,KAAK;YAChCa,QAAQC,YAAYC,OAAO,CAAC;QAC9B;QAEA,IAAIJ,SAASK,EAAE,EAAE;YACf,OAAOL,SAASM,IAAI;QACtB;QAEA,MAAMN;IACR;AACF"}

package/dist/commands/openapi/list.d.ts

@@ -0,0 +1,14 @@
+import { SanityCommand } from '@sanity/cli-core';
+export declare class ListOpenApiCommand extends SanityCommand<typeof ListOpenApiCommand> {
+    static description: string;
+    static examples: {
+        command: string;
+        description: string;
+    }[];
+    static flags: {
+        json: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        web: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+    private getSpecs;
+}

package/dist/commands/openapi/list.js

@@ -0,0 +1,80 @@
+import { Flags } from '@oclif/core';
+import { SanityCommand, subdebug } from '@sanity/cli-core';
+import open from 'open';
+const listOpenapiDebug = subdebug('openapi:list');
+export class ListOpenApiCommand extends SanityCommand {
+    static description = 'List all available OpenAPI specifications';
+    static examples = [
+        {
+            command: '<%= config.bin %> <%= command.id %>',
+            description: 'List all available OpenAPI specs'
+        },
+        {
+            command: '<%= config.bin %> <%= command.id %> --json',
+            description: 'List with JSON output'
+        },
+        {
+            command: '<%= config.bin %> <%= command.id %> --web',
+            description: 'Open HTTP Reference in browser'
+        }
+    ];
+    static flags = {
+        json: Flags.boolean({
+            description: 'Output JSON'
+        }),
+        web: Flags.boolean({
+            char: 'w',
+            description: 'Open HTTP Reference in web browser'
+        })
+    };
+    async run() {
+        const { flags } = await this.parse(ListOpenApiCommand);
+        const { json, web } = flags;
+        if (web) {
+            const url = 'https://www.sanity.io/docs/http-reference';
+            this.log(`Opening ${url}`);
+            await open(url);
+            return;
+        }
+        let specs;
+        try {
+            specs = await this.getSpecs();
+        } catch (error) {
+            listOpenapiDebug('Error fetching OpenAPI specs', error);
+            this.error('The OpenAPI service is currently unavailable. Please try again later.', {
+                exit: 1
+            });
+        }
+        if (json) {
+            this.log(JSON.stringify(specs, null, 2));
+            return;
+        }
+        if (specs.length === 0) {
+            this.log('No OpenAPI specifications available.');
+            return;
+        }
+        // Human-readable table format
+        this.log(`\nFound ${specs.length} OpenAPI specification(s):\n`);
+        for (const spec of specs){
+            this.log(`Title: ${spec.title}`);
+            this.log(`Slug: ${spec.slug}`);
+            if (spec.description) {
+                this.log(`Description: ${spec.description}`);
+            }
+            this.log('');
+        }
+        this.log(`Use 'sanity openapi get <slug>' to retrieve a specific specification.`);
+    }
+    async getSpecs() {
+        const response = await fetch('https://www.sanity.io/docs/api/openapi', {
+            signal: AbortSignal.timeout(10_000)
+        });
+        if (response.ok) {
+            const data = await response.json();
+            return Array.isArray(data?.specs) ? data.specs : [];
+        }
+        throw response;
+    }
+}
+
+//# sourceMappingURL=list.js.map

package/dist/commands/openapi/list.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/commands/openapi/list.ts"],"sourcesContent":["import {Flags} from '@oclif/core'\nimport {SanityCommand, subdebug} from '@sanity/cli-core'\nimport open from 'open'\n\ninterface OpenAPISpec {\n  description: string\n  slug: string\n  title: string\n}\n\nconst listOpenapiDebug = subdebug('openapi:list')\n\nexport class ListOpenApiCommand extends SanityCommand<typeof ListOpenApiCommand> {\n  static override description = 'List all available OpenAPI specifications'\n\n  static override examples = [\n    {\n      command: '<%= config.bin %> <%= command.id %>',\n      description: 'List all available OpenAPI specs',\n    },\n    {\n      command: '<%= config.bin %> <%= command.id %> --json',\n      description: 'List with JSON output',\n    },\n    {\n      command: '<%= config.bin %> <%= command.id %> --web',\n      description: 'Open HTTP Reference in browser',\n    },\n  ]\n\n  static override flags = {\n    json: Flags.boolean({\n      description: 'Output JSON',\n    }),\n    web: Flags.boolean({\n      char: 'w',\n      description: 'Open HTTP Reference in web browser',\n    }),\n  }\n\n  public async run(): Promise<void> {\n    const {flags} = await this.parse(ListOpenApiCommand)\n    const {json, web} = flags\n\n    if (web) {\n      const url = 'https://www.sanity.io/docs/http-reference'\n      this.log(`Opening ${url}`)\n      await open(url)\n      return\n    }\n\n    let specs: OpenAPISpec[]\n    try {\n      specs = await this.getSpecs()\n    } catch (error) {\n      listOpenapiDebug('Error fetching OpenAPI specs', error)\n\n      this.error('The OpenAPI service is currently unavailable. Please try again later.', {\n        exit: 1,\n      })\n    }\n\n    if (json) {\n      this.log(JSON.stringify(specs, null, 2))\n      return\n    }\n\n    if (specs.length === 0) {\n      this.log('No OpenAPI specifications available.')\n      return\n    }\n\n    // Human-readable table format\n    this.log(`\\nFound ${specs.length} OpenAPI specification(s):\\n`)\n\n    for (const spec of specs) {\n      this.log(`Title: ${spec.title}`)\n      this.log(`Slug: ${spec.slug}`)\n      if (spec.description) {\n        this.log(`Description: ${spec.description}`)\n      }\n      this.log('')\n    }\n\n    this.log(`Use 'sanity openapi get <slug>' to retrieve a specific specification.`)\n  }\n\n  private async getSpecs(): Promise<OpenAPISpec[]> {\n    const response = await fetch('https://www.sanity.io/docs/api/openapi', {\n      signal: AbortSignal.timeout(10_000),\n    })\n\n    if (response.ok) {\n      const data = await response.json()\n      return Array.isArray(data?.specs) ? data.specs : []\n    }\n\n    throw response\n  }\n}\n"],"names":["Flags","SanityCommand","subdebug","open","listOpenapiDebug","ListOpenApiCommand","description","examples","command","flags","json","boolean","web","char","run","parse","url","log","specs","getSpecs","error","exit","JSON","stringify","length","spec","title","slug","response","fetch","signal","AbortSignal","timeout","ok","data","Array","isArray"],"mappings":"AAAA,SAAQA,KAAK,QAAO,cAAa;AACjC,SAAQC,aAAa,EAAEC,QAAQ,QAAO,mBAAkB;AACxD,OAAOC,UAAU,OAAM;AAQvB,MAAMC,mBAAmBF,SAAS;AAElC,OAAO,MAAMG,2BAA2BJ;IACtC,OAAgBK,cAAc,4CAA2C;IAEzE,OAAgBC,WAAW;QACzB;YACEC,SAAS;YACTF,aAAa;QACf;QACA;YACEE,SAAS;YACTF,aAAa;QACf;QACA;YACEE,SAAS;YACTF,aAAa;QACf;KACD,CAAA;IAED,OAAgBG,QAAQ;QACtBC,MAAMV,MAAMW,OAAO,CAAC;YAClBL,aAAa;QACf;QACAM,KAAKZ,MAAMW,OAAO,CAAC;YACjBE,MAAM;YACNP,aAAa;QACf;IACF,EAAC;IAED,MAAaQ,MAAqB;QAChC,MAAM,EAACL,KAAK,EAAC,GAAG,MAAM,IAAI,CAACM,KAAK,CAACV;QACjC,MAAM,EAACK,IAAI,EAAEE,GAAG,EAAC,GAAGH;QAEpB,IAAIG,KAAK;YACP,MAAMI,MAAM;YACZ,IAAI,CAACC,GAAG,CAAC,CAAC,QAAQ,EAAED,KAAK;YACzB,MAAMb,KAAKa;YACX;QACF;QAEA,IAAIE;QACJ,IAAI;YACFA,QAAQ,MAAM,IAAI,CAACC,QAAQ;QAC7B,EAAE,OAAOC,OAAO;YACdhB,iBAAiB,gCAAgCgB;YAEjD,IAAI,CAACA,KAAK,CAAC,yEAAyE;gBAClFC,MAAM;YACR;QACF;QAEA,IAAIX,MAAM;YACR,IAAI,CAACO,GAAG,CAACK,KAAKC,SAAS,CAACL,OAAO,MAAM;YACrC;QACF;QAEA,IAAIA,MAAMM,MAAM,KAAK,GAAG;YACtB,IAAI,CAACP,GAAG,CAAC;YACT;QACF;QAEA,8BAA8B;QAC9B,IAAI,CAACA,GAAG,CAAC,CAAC,QAAQ,EAAEC,MAAMM,MAAM,CAAC,4BAA4B,CAAC;QAE9D,KAAK,MAAMC,QAAQP,MAAO;YACxB,IAAI,CAACD,GAAG,CAAC,CAAC,OAAO,EAAEQ,KAAKC,KAAK,EAAE;YAC/B,IAAI,CAACT,GAAG,CAAC,CAAC,MAAM,EAAEQ,KAAKE,IAAI,EAAE;YAC7B,IAAIF,KAAKnB,WAAW,EAAE;gBACpB,IAAI,CAACW,GAAG,CAAC,CAAC,aAAa,EAAEQ,KAAKnB,WAAW,EAAE;YAC7C;YACA,IAAI,CAACW,GAAG,CAAC;QACX;QAEA,IAAI,CAACA,GAAG,CAAC,CAAC,qEAAqE,CAAC;IAClF;IAEA,MAAcE,WAAmC;QAC/C,MAAMS,WAAW,MAAMC,MAAM,0CAA0C;YACrEC,QAAQC,YAAYC,OAAO,CAAC;QAC9B;QAEA,IAAIJ,SAASK,EAAE,EAAE;YACf,MAAMC,OAAO,MAAMN,SAASlB,IAAI;YAChC,OAAOyB,MAAMC,OAAO,CAACF,MAAMhB,SAASgB,KAAKhB,KAAK,GAAG,EAAE;QACrD;QAEA,MAAMU;IACR;AACF"}

package/dist/commands/preview.d.ts

@@ -0,0 +1,17 @@
+import { SanityCommand } from '@sanity/cli-core';
+export declare const previewDebug: import("debug").Debugger;
+export declare class PreviewCommand extends SanityCommand<typeof PreviewCommand> {
+    static aliases: string[];
+    static args: {
+        outputDir: import("@oclif/core/interfaces").Arg<string | undefined, {
+            exists?: boolean;
+        }>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        host: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        port: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/preview.js

@@ -0,0 +1,74 @@
+import path from 'node:path';
+import { Args, Flags } from '@oclif/core';
+import { isInteractive, SanityCommand, subdebug } from '@sanity/cli-core';
+import { chalk, confirm } from '@sanity/cli-core/ux';
+import { previewAction } from '../actions/preview/previewAction.js';
+export const previewDebug = subdebug('preview');
+export class PreviewCommand extends SanityCommand {
+    // sanity start is an alias for sanity preview
+    static aliases = [
+        'start'
+    ];
+    static args = {
+        outputDir: Args.directory({
+            description: 'Output directory'
+        })
+    };
+    static description = 'Starts a server to preview a production build';
+    static examples = [
+        '<%= config.bin %> <%= command.id %> --host=0.0.0.0',
+        '<%= config.bin %> <%= command.id %> --port=1942',
+        '<%= config.bin %> <%= command.id %> some/build-output-dir'
+    ];
+    static flags = {
+        host: Flags.string({
+            default: 'localhost',
+            description: 'The local network interface at which to listen.'
+        }),
+        port: Flags.string({
+            default: '3333',
+            description: 'TCP port to start server on.'
+        })
+    };
+    async run() {
+        const { args, flags } = await this.parse(PreviewCommand);
+        const workDir = (await this.getProjectRoot()).directory;
+        const cliConfig = await this.getCliConfig();
+        const { outputDir } = args;
+        const defaultRootDir = path.resolve(path.join(workDir, 'dist'));
+        const outDir = path.resolve(outputDir || defaultRootDir);
+        try {
+            await previewAction({
+                cliConfig,
+                flags,
+                outDir,
+                workDir
+            });
+        } catch (error) {
+            if (error.name !== 'BUILD_NOT_FOUND') {
+                previewDebug(`Failed to start preview server`, {
+                    error
+                });
+                this.output.error(error.message, {
+                    exit: 1
+                });
+            }
+            this.output.log(chalk.red.bgBlack(error.message));
+            this.output.log(chalk.red.bgBlack('\n'));
+            const shouldRunDevServer = isInteractive() && await confirm({
+                message: 'Do you want to start a development server instead?'
+            });
+            if (shouldRunDevServer) {
+                // TODO: Implement dev server
+                this.output.log(chalk.green.bgBlack('Starting development server...'));
+            } else {
+                // Indicate that this isn't an expected exit
+                this.output.error(`Failed to start preview server`, {
+                    exit: 1
+                });
+            }
+        }
+    }
+}
+
+//# sourceMappingURL=preview.js.map

package/dist/commands/preview.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/commands/preview.ts"],"sourcesContent":["import path from 'node:path'\n\nimport {Args, Flags} from '@oclif/core'\nimport {isInteractive, SanityCommand, subdebug} from '@sanity/cli-core'\nimport {chalk, confirm} from '@sanity/cli-core/ux'\n\nimport {previewAction} from '../actions/preview/previewAction.js'\n\nexport const previewDebug = subdebug('preview')\n\nexport class PreviewCommand extends SanityCommand<typeof PreviewCommand> {\n  // sanity start is an alias for sanity preview\n  static override aliases: string[] = ['start']\n\n  static override args = {\n    outputDir: Args.directory({description: 'Output directory'}),\n  }\n\n  static override description = 'Starts a server to preview a production build'\n\n  static override examples = [\n    '<%= config.bin %> <%= command.id %> --host=0.0.0.0',\n    '<%= config.bin %> <%= command.id %> --port=1942',\n    '<%= config.bin %> <%= command.id %> some/build-output-dir',\n  ]\n\n  static override flags = {\n    host: Flags.string({\n      default: 'localhost',\n      description: 'The local network interface at which to listen.',\n    }),\n    port: Flags.string({\n      default: '3333',\n      description: 'TCP port to start server on.',\n    }),\n  }\n\n  public async run(): Promise<void> {\n    const {args, flags} = await this.parse(PreviewCommand)\n\n    const workDir = (await this.getProjectRoot()).directory\n    const cliConfig = await this.getCliConfig()\n\n    const {outputDir} = args\n\n    const defaultRootDir = path.resolve(path.join(workDir, 'dist'))\n    const outDir = path.resolve(outputDir || defaultRootDir)\n\n    try {\n      await previewAction({cliConfig, flags, outDir, workDir})\n    } catch (error) {\n      if (error.name !== 'BUILD_NOT_FOUND') {\n        previewDebug(`Failed to start preview server`, {error})\n        this.output.error(error.message, {exit: 1})\n      }\n\n      this.output.log(chalk.red.bgBlack(error.message))\n      this.output.log(chalk.red.bgBlack('\\n'))\n\n      const shouldRunDevServer =\n        isInteractive() &&\n        (await confirm({\n          message: 'Do you want to start a development server instead?',\n        }))\n\n      if (shouldRunDevServer) {\n        // TODO: Implement dev server\n        this.output.log(chalk.green.bgBlack('Starting development server...'))\n      } else {\n        // Indicate that this isn't an expected exit\n        this.output.error(`Failed to start preview server`, {exit: 1})\n      }\n    }\n  }\n}\n"],"names":["path","Args","Flags","isInteractive","SanityCommand","subdebug","chalk","confirm","previewAction","previewDebug","PreviewCommand","aliases","args","outputDir","directory","description","examples","flags","host","string","default","port","run","parse","workDir","getProjectRoot","cliConfig","getCliConfig","defaultRootDir","resolve","join","outDir","error","name","output","message","exit","log","red","bgBlack","shouldRunDevServer","green"],"mappings":"AAAA,OAAOA,UAAU,YAAW;AAE5B,SAAQC,IAAI,EAAEC,KAAK,QAAO,cAAa;AACvC,SAAQC,aAAa,EAAEC,aAAa,EAAEC,QAAQ,QAAO,mBAAkB;AACvE,SAAQC,KAAK,EAAEC,OAAO,QAAO,sBAAqB;AAElD,SAAQC,aAAa,QAAO,sCAAqC;AAEjE,OAAO,MAAMC,eAAeJ,SAAS,WAAU;AAE/C,OAAO,MAAMK,uBAAuBN;IAClC,8CAA8C;IAC9C,OAAgBO,UAAoB;QAAC;KAAQ,CAAA;IAE7C,OAAgBC,OAAO;QACrBC,WAAWZ,KAAKa,SAAS,CAAC;YAACC,aAAa;QAAkB;IAC5D,EAAC;IAED,OAAgBA,cAAc,gDAA+C;IAE7E,OAAgBC,WAAW;QACzB;QACA;QACA;KACD,CAAA;IAED,OAAgBC,QAAQ;QACtBC,MAAMhB,MAAMiB,MAAM,CAAC;YACjBC,SAAS;YACTL,aAAa;QACf;QACAM,MAAMnB,MAAMiB,MAAM,CAAC;YACjBC,SAAS;YACTL,aAAa;QACf;IACF,EAAC;IAED,MAAaO,MAAqB;QAChC,MAAM,EAACV,IAAI,EAAEK,KAAK,EAAC,GAAG,MAAM,IAAI,CAACM,KAAK,CAACb;QAEvC,MAAMc,UAAU,AAAC,CAAA,MAAM,IAAI,CAACC,cAAc,EAAC,EAAGX,SAAS;QACvD,MAAMY,YAAY,MAAM,IAAI,CAACC,YAAY;QAEzC,MAAM,EAACd,SAAS,EAAC,GAAGD;QAEpB,MAAMgB,iBAAiB5B,KAAK6B,OAAO,CAAC7B,KAAK8B,IAAI,CAACN,SAAS;QACvD,MAAMO,SAAS/B,KAAK6B,OAAO,CAAChB,aAAae;QAEzC,IAAI;YACF,MAAMpB,cAAc;gBAACkB;gBAAWT;gBAAOc;gBAAQP;YAAO;QACxD,EAAE,OAAOQ,OAAO;YACd,IAAIA,MAAMC,IAAI,KAAK,mBAAmB;gBACpCxB,aAAa,CAAC,8BAA8B,CAAC,EAAE;oBAACuB;gBAAK;gBACrD,IAAI,CAACE,MAAM,CAACF,KAAK,CAACA,MAAMG,OAAO,EAAE;oBAACC,MAAM;gBAAC;YAC3C;YAEA,IAAI,CAACF,MAAM,CAACG,GAAG,CAAC/B,MAAMgC,GAAG,CAACC,OAAO,CAACP,MAAMG,OAAO;YAC/C,IAAI,CAACD,MAAM,CAACG,GAAG,CAAC/B,MAAMgC,GAAG,CAACC,OAAO,CAAC;YAElC,MAAMC,qBACJrC,mBACC,MAAMI,QAAQ;gBACb4B,SAAS;YACX;YAEF,IAAIK,oBAAoB;gBACtB,6BAA6B;gBAC7B,IAAI,CAACN,MAAM,CAACG,GAAG,CAAC/B,MAAMmC,KAAK,CAACF,OAAO,CAAC;YACtC,OAAO;gBACL,4CAA4C;gBAC5C,IAAI,CAACL,MAAM,CAACF,KAAK,CAAC,CAAC,8BAA8B,CAAC,EAAE;oBAACI,MAAM;gBAAC;YAC9D;QACF;IACF;AACF"}