@sanity/cli 5.1.1-next.5 → 6.0.0-alpha.3

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

@@ -0,0 +1,153 @@
+import { runCommand } from '@oclif/test';
+import { mockApi, testCommand } from '@sanity/cli-test';
+import nock from 'nock';
+import { afterEach, describe, expect, test } from 'vitest';
+import { List } from '../list.js';
+describe('#list', ()=>{
+    afterEach(()=>{
+        const pending = nock.pendingMocks();
+        nock.cleanAll();
+        expect(pending, 'pending mocks').toEqual([]);
+    });
+    test('--help works', async ()=>{
+        const { stdout } = await runCommand([
+            'projects list',
+            '--help'
+        ]);
+        expect(stdout).toContain('Lists projects connected to your user');
+    });
+    test('displays projects correctly', async ()=>{
+        mockApi({
+            apiVersion: 'v2025-05-15',
+            uri: '/projects'
+        }).reply(200, [
+            {
+                createdAt: '2023-01-01',
+                displayName: 'Project One',
+                id: 'project1',
+                members: [
+                    'user1',
+                    'user2'
+                ]
+            },
+            {
+                createdAt: '2023-01-02',
+                displayName: 'Project Two',
+                id: 'project2',
+                members: [
+                    'user1'
+                ]
+            }
+        ]);
+        const { stdout } = await testCommand(List);
+        expect(stdout).toMatchSnapshot();
+    });
+    test('sorts by members when --sort members is specified', async ()=>{
+        mockApi({
+            apiVersion: 'v2025-05-15',
+            uri: '/projects'
+        }).reply(200, [
+            {
+                createdAt: '2023-01-01',
+                displayName: 'Project One',
+                id: 'project1',
+                members: [
+                    'user1',
+                    'user2',
+                    'user3'
+                ]
+            },
+            {
+                createdAt: '2023-01-02',
+                displayName: 'Project Two',
+                id: 'project2',
+                members: [
+                    'user1'
+                ]
+            },
+            {
+                createdAt: '2023-01-03',
+                displayName: 'Project Three',
+                id: 'project3',
+                members: [
+                    'user1',
+                    'user2'
+                ]
+            }
+        ]);
+        const { stdout } = await testCommand(List, [
+            '--sort',
+            'members'
+        ]);
+        const lines = stdout.split('\n').filter(Boolean);
+        // Find the indices of lines containing each project
+        const project1Index = lines.findIndex((line)=>line.includes('project1'));
+        const project2Index = lines.findIndex((line)=>line.includes('project2'));
+        const project3Index = lines.findIndex((line)=>line.includes('project3'));
+        // Verify they all exist
+        expect(project1Index).toBeGreaterThan(-1);
+        expect(project2Index).toBeGreaterThan(-1);
+        expect(project3Index).toBeGreaterThan(-1);
+        // By default order is desc, so project with most members should come first
+        expect(project1Index).toBeLessThan(project3Index);
+        expect(project3Index).toBeLessThan(project2Index);
+    });
+    test('sorts in ascending order when --order asc is specified', async ()=>{
+        mockApi({
+            apiVersion: 'v2025-05-15',
+            uri: '/projects'
+        }).reply(200, [
+            {
+                createdAt: '2023-01-01',
+                displayName: 'Project One',
+                id: 'project1',
+                members: [
+                    'user1',
+                    'user2'
+                ]
+            },
+            {
+                createdAt: '2023-01-02',
+                displayName: 'Project Two',
+                id: 'project2'
+            },
+            {
+                createdAt: '2023-01-03',
+                displayName: 'Project Three',
+                id: 'project3',
+                members: [
+                    'user1',
+                    'user2',
+                    'user3'
+                ]
+            }
+        ]);
+        const { stdout } = await testCommand(List, [
+            '--order',
+            'asc'
+        ]);
+        const lines = stdout.split('\n').filter(Boolean);
+        const line2023_01_01 = lines.findIndex((line)=>line.includes('2023-01-01'));
+        const line2023_01_02 = lines.findIndex((line)=>line.includes('2023-01-02'));
+        const line2023_01_03 = lines.findIndex((line)=>line.includes('2023-01-03'));
+        expect(line2023_01_01).toBeGreaterThan(0); // First line is header
+        expect(line2023_01_02).toBeGreaterThan(0);
+        expect(line2023_01_03).toBeGreaterThan(0);
+        // Check the order (ascending)
+        expect(line2023_01_01).toBeLessThan(line2023_01_02);
+        expect(line2023_01_02).toBeLessThan(line2023_01_03);
+    });
+    test('displays an error if the API request fails', async ()=>{
+        mockApi({
+            apiVersion: 'v2025-05-15',
+            uri: '/projects'
+        }).reply(500, {
+            message: 'Internal Server Error'
+        });
+        const { error } = await testCommand(List);
+        expect(error).toBeInstanceOf(Error);
+        expect(error?.message).toContain('Failed to list projects');
+    });
+});
+
+//# sourceMappingURL=list.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/commands/projects/__tests__/list.test.ts"],"sourcesContent":["import {runCommand} from '@oclif/test'\nimport {mockApi, testCommand} from '@sanity/cli-test'\nimport nock from 'nock'\nimport {afterEach, describe, expect, test} from 'vitest'\n\nimport {List} from '../list.js'\n\ndescribe('#list', () => {\n  afterEach(() => {\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(['projects list', '--help'])\n\n    expect(stdout).toContain('Lists projects connected to your user')\n  })\n\n  test('displays projects correctly', async () => {\n    mockApi({\n      apiVersion: 'v2025-05-15',\n      uri: '/projects',\n    }).reply(200, [\n      {\n        createdAt: '2023-01-01',\n        displayName: 'Project One',\n        id: 'project1',\n        members: ['user1', 'user2'],\n      },\n      {\n        createdAt: '2023-01-02',\n        displayName: 'Project Two',\n        id: 'project2',\n        members: ['user1'],\n      },\n    ])\n\n    const {stdout} = await testCommand(List)\n\n    expect(stdout).toMatchSnapshot()\n  })\n\n  test('sorts by members when --sort members is specified', async () => {\n    mockApi({\n      apiVersion: 'v2025-05-15',\n      uri: '/projects',\n    }).reply(200, [\n      {\n        createdAt: '2023-01-01',\n        displayName: 'Project One',\n        id: 'project1',\n        members: ['user1', 'user2', 'user3'],\n      },\n      {\n        createdAt: '2023-01-02',\n        displayName: 'Project Two',\n        id: 'project2',\n        members: ['user1'],\n      },\n      {\n        createdAt: '2023-01-03',\n        displayName: 'Project Three',\n        id: 'project3',\n        members: ['user1', 'user2'],\n      },\n    ])\n\n    const {stdout} = await testCommand(List, ['--sort', 'members'])\n\n    const lines = stdout.split('\\n').filter(Boolean)\n\n    // Find the indices of lines containing each project\n    const project1Index = lines.findIndex((line) => line.includes('project1'))\n    const project2Index = lines.findIndex((line) => line.includes('project2'))\n    const project3Index = lines.findIndex((line) => line.includes('project3'))\n\n    // Verify they all exist\n    expect(project1Index).toBeGreaterThan(-1)\n    expect(project2Index).toBeGreaterThan(-1)\n    expect(project3Index).toBeGreaterThan(-1)\n\n    // By default order is desc, so project with most members should come first\n    expect(project1Index).toBeLessThan(project3Index)\n    expect(project3Index).toBeLessThan(project2Index)\n  })\n\n  test('sorts in ascending order when --order asc is specified', async () => {\n    mockApi({\n      apiVersion: 'v2025-05-15',\n      uri: '/projects',\n    }).reply(200, [\n      {\n        createdAt: '2023-01-01',\n        displayName: 'Project One',\n        id: 'project1',\n        members: ['user1', 'user2'],\n      },\n      {\n        createdAt: '2023-01-02',\n        displayName: 'Project Two',\n        id: 'project2',\n      },\n      {\n        createdAt: '2023-01-03',\n        displayName: 'Project Three',\n        id: 'project3',\n        members: ['user1', 'user2', 'user3'],\n      },\n    ])\n\n    const {stdout} = await testCommand(List, ['--order', 'asc'])\n\n    const lines = stdout.split('\\n').filter(Boolean)\n\n    const line2023_01_01 = lines.findIndex((line) => line.includes('2023-01-01'))\n    const line2023_01_02 = lines.findIndex((line) => line.includes('2023-01-02'))\n    const line2023_01_03 = lines.findIndex((line) => line.includes('2023-01-03'))\n\n    expect(line2023_01_01).toBeGreaterThan(0) // First line is header\n    expect(line2023_01_02).toBeGreaterThan(0)\n    expect(line2023_01_03).toBeGreaterThan(0)\n\n    // Check the order (ascending)\n    expect(line2023_01_01).toBeLessThan(line2023_01_02)\n    expect(line2023_01_02).toBeLessThan(line2023_01_03)\n  })\n\n  test('displays an error if the API request fails', async () => {\n    mockApi({\n      apiVersion: 'v2025-05-15',\n      uri: '/projects',\n    }).reply(500, {message: 'Internal Server Error'})\n\n    const {error} = await testCommand(List)\n\n    expect(error).toBeInstanceOf(Error)\n    expect(error?.message).toContain('Failed to list projects')\n  })\n})\n"],"names":["runCommand","mockApi","testCommand","nock","afterEach","describe","expect","test","List","pending","pendingMocks","cleanAll","toEqual","stdout","toContain","apiVersion","uri","reply","createdAt","displayName","id","members","toMatchSnapshot","lines","split","filter","Boolean","project1Index","findIndex","line","includes","project2Index","project3Index","toBeGreaterThan","toBeLessThan","line2023_01_01","line2023_01_02","line2023_01_03","message","error","toBeInstanceOf","Error"],"mappings":"AAAA,SAAQA,UAAU,QAAO,cAAa;AACtC,SAAQC,OAAO,EAAEC,WAAW,QAAO,mBAAkB;AACrD,OAAOC,UAAU,OAAM;AACvB,SAAQC,SAAS,EAAEC,QAAQ,EAAEC,MAAM,EAAEC,IAAI,QAAO,SAAQ;AAExD,SAAQC,IAAI,QAAO,aAAY;AAE/BH,SAAS,SAAS;IAChBD,UAAU;QACR,MAAMK,UAAUN,KAAKO,YAAY;QACjCP,KAAKQ,QAAQ;QACbL,OAAOG,SAAS,iBAAiBG,OAAO,CAAC,EAAE;IAC7C;IAEAL,KAAK,gBAAgB;QACnB,MAAM,EAACM,MAAM,EAAC,GAAG,MAAMb,WAAW;YAAC;YAAiB;SAAS;QAE7DM,OAAOO,QAAQC,SAAS,CAAC;IAC3B;IAEAP,KAAK,+BAA+B;QAClCN,QAAQ;YACNc,YAAY;YACZC,KAAK;QACP,GAAGC,KAAK,CAAC,KAAK;YACZ;gBACEC,WAAW;gBACXC,aAAa;gBACbC,IAAI;gBACJC,SAAS;oBAAC;oBAAS;iBAAQ;YAC7B;YACA;gBACEH,WAAW;gBACXC,aAAa;gBACbC,IAAI;gBACJC,SAAS;oBAAC;iBAAQ;YACpB;SACD;QAED,MAAM,EAACR,MAAM,EAAC,GAAG,MAAMX,YAAYM;QAEnCF,OAAOO,QAAQS,eAAe;IAChC;IAEAf,KAAK,qDAAqD;QACxDN,QAAQ;YACNc,YAAY;YACZC,KAAK;QACP,GAAGC,KAAK,CAAC,KAAK;YACZ;gBACEC,WAAW;gBACXC,aAAa;gBACbC,IAAI;gBACJC,SAAS;oBAAC;oBAAS;oBAAS;iBAAQ;YACtC;YACA;gBACEH,WAAW;gBACXC,aAAa;gBACbC,IAAI;gBACJC,SAAS;oBAAC;iBAAQ;YACpB;YACA;gBACEH,WAAW;gBACXC,aAAa;gBACbC,IAAI;gBACJC,SAAS;oBAAC;oBAAS;iBAAQ;YAC7B;SACD;QAED,MAAM,EAACR,MAAM,EAAC,GAAG,MAAMX,YAAYM,MAAM;YAAC;YAAU;SAAU;QAE9D,MAAMe,QAAQV,OAAOW,KAAK,CAAC,MAAMC,MAAM,CAACC;QAExC,oDAAoD;QACpD,MAAMC,gBAAgBJ,MAAMK,SAAS,CAAC,CAACC,OAASA,KAAKC,QAAQ,CAAC;QAC9D,MAAMC,gBAAgBR,MAAMK,SAAS,CAAC,CAACC,OAASA,KAAKC,QAAQ,CAAC;QAC9D,MAAME,gBAAgBT,MAAMK,SAAS,CAAC,CAACC,OAASA,KAAKC,QAAQ,CAAC;QAE9D,wBAAwB;QACxBxB,OAAOqB,eAAeM,eAAe,CAAC,CAAC;QACvC3B,OAAOyB,eAAeE,eAAe,CAAC,CAAC;QACvC3B,OAAO0B,eAAeC,eAAe,CAAC,CAAC;QAEvC,2EAA2E;QAC3E3B,OAAOqB,eAAeO,YAAY,CAACF;QACnC1B,OAAO0B,eAAeE,YAAY,CAACH;IACrC;IAEAxB,KAAK,0DAA0D;QAC7DN,QAAQ;YACNc,YAAY;YACZC,KAAK;QACP,GAAGC,KAAK,CAAC,KAAK;YACZ;gBACEC,WAAW;gBACXC,aAAa;gBACbC,IAAI;gBACJC,SAAS;oBAAC;oBAAS;iBAAQ;YAC7B;YACA;gBACEH,WAAW;gBACXC,aAAa;gBACbC,IAAI;YACN;YACA;gBACEF,WAAW;gBACXC,aAAa;gBACbC,IAAI;gBACJC,SAAS;oBAAC;oBAAS;oBAAS;iBAAQ;YACtC;SACD;QAED,MAAM,EAACR,MAAM,EAAC,GAAG,MAAMX,YAAYM,MAAM;YAAC;YAAW;SAAM;QAE3D,MAAMe,QAAQV,OAAOW,KAAK,CAAC,MAAMC,MAAM,CAACC;QAExC,MAAMS,iBAAiBZ,MAAMK,SAAS,CAAC,CAACC,OAASA,KAAKC,QAAQ,CAAC;QAC/D,MAAMM,iBAAiBb,MAAMK,SAAS,CAAC,CAACC,OAASA,KAAKC,QAAQ,CAAC;QAC/D,MAAMO,iBAAiBd,MAAMK,SAAS,CAAC,CAACC,OAASA,KAAKC,QAAQ,CAAC;QAE/DxB,OAAO6B,gBAAgBF,eAAe,CAAC,IAAG,uBAAuB;QACjE3B,OAAO8B,gBAAgBH,eAAe,CAAC;QACvC3B,OAAO+B,gBAAgBJ,eAAe,CAAC;QAEvC,8BAA8B;QAC9B3B,OAAO6B,gBAAgBD,YAAY,CAACE;QACpC9B,OAAO8B,gBAAgBF,YAAY,CAACG;IACtC;IAEA9B,KAAK,8CAA8C;QACjDN,QAAQ;YACNc,YAAY;YACZC,KAAK;QACP,GAAGC,KAAK,CAAC,KAAK;YAACqB,SAAS;QAAuB;QAE/C,MAAM,EAACC,KAAK,EAAC,GAAG,MAAMrC,YAAYM;QAElCF,OAAOiC,OAAOC,cAAc,CAACC;QAC7BnC,OAAOiC,OAAOD,SAASxB,SAAS,CAAC;IACnC;AACF"}

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

@@ -0,0 +1,13 @@
+import { SanityCommand } from '@sanity/cli-core';
+export declare class List extends SanityCommand<typeof List> {
+    static description: string;
+    static examples: {
+        command: string;
+        description: string;
+    }[];
+    static flags: {
+        order: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        sort: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/projects/list.js

@@ -0,0 +1,80 @@
+import { Flags } from '@oclif/core';
+import { SanityCommand, subdebug } from '@sanity/cli-core';
+import { chalk } from '@sanity/cli-core/ux';
+import { size, sortBy } from 'lodash-es';
+const sortFields = [
+    'id',
+    'members',
+    'name',
+    'url',
+    'created'
+];
+const LIST_PROJECTS_API_VERSION = 'v2025-05-15';
+const projectsDebug = subdebug('projects');
+export class List extends SanityCommand {
+    static description = 'Lists projects connected to your user';
+    static examples = [
+        {
+            command: '<%= config.bin %> <%= command.id %>',
+            description: 'List projects'
+        },
+        {
+            command: '<%= config.bin %> <%= command.id %> --sort=members --order=asc',
+            description: 'List all users of the project, but exclude pending invitations and robots'
+        }
+    ];
+    static flags = {
+        order: Flags.string({
+            default: 'desc',
+            options: [
+                'asc',
+                'desc'
+            ]
+        }),
+        sort: Flags.string({
+            default: 'created',
+            options: sortFields
+        })
+    };
+    async run() {
+        const { order, sort } = this.flags;
+        const client = await this.getGlobalApiClient({
+            apiVersion: LIST_PROJECTS_API_VERSION,
+            requireUser: true
+        });
+        try {
+            const projects = await client.projects.list();
+            const ordered = sortBy(projects.map(({ createdAt, displayName, id, members = [] })=>{
+                const manage = `https://www.sanity.io/manage/project/${id}`;
+                return [
+                    id,
+                    members.length,
+                    displayName,
+                    manage,
+                    createdAt
+                ].map(String);
+            }), [
+                sortFields.indexOf(sort)
+            ]);
+            const rows = order === 'asc' ? ordered : ordered.toReversed();
+            // Initialize maxWidths with the width of each header
+            const maxWidths = sortFields.map((str)=>size(str));
+            // Calculate maximum width for each column
+            for (const row of rows){
+                for (const [i, element] of row.entries()){
+                    maxWidths[i] = Math.max(size(element), maxWidths[i]);
+                }
+            }
+            const printRow = (row)=>row.map((col, i)=>`${col}`.padEnd(maxWidths[i])).join('   ');
+            this.log(chalk.cyan(printRow(sortFields)));
+            for (const row of rows)this.log(printRow(row));
+        } catch (error) {
+            projectsDebug('Error listing projects', error);
+            this.error('Failed to list projects', {
+                exit: 1
+            });
+        }
+    }
+}
+
+//# sourceMappingURL=list.js.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/commands/projects/list.ts"],"sourcesContent":["import {Flags} from '@oclif/core'\nimport {SanityCommand, subdebug} from '@sanity/cli-core'\nimport {chalk} from '@sanity/cli-core/ux'\nimport {size, sortBy} from 'lodash-es'\n\nconst sortFields = ['id', 'members', 'name', 'url', 'created']\n\nconst LIST_PROJECTS_API_VERSION = 'v2025-05-15'\nconst projectsDebug = subdebug('projects')\n\nexport class List extends SanityCommand<typeof List> {\n  static override description = 'Lists projects connected to your user'\n  static override examples = [\n    {\n      command: '<%= config.bin %> <%= command.id %>',\n      description: 'List projects',\n    },\n    {\n      command: '<%= config.bin %> <%= command.id %> --sort=members --order=asc',\n      description: 'List all users of the project, but exclude pending invitations and robots',\n    },\n  ]\n\n  static override flags = {\n    order: Flags.string({\n      default: 'desc',\n      options: ['asc', 'desc'],\n    }),\n    sort: Flags.string({\n      default: 'created',\n      options: sortFields,\n    }),\n  }\n\n  public async run() {\n    const {order, sort} = this.flags\n\n    const client = await this.getGlobalApiClient({\n      apiVersion: LIST_PROJECTS_API_VERSION,\n      requireUser: true,\n    })\n\n    try {\n      const projects = await client.projects.list()\n      const ordered = sortBy(\n        projects.map(({createdAt, displayName, id, members = []}) => {\n          const manage = `https://www.sanity.io/manage/project/${id}`\n          return [id, members.length, displayName, manage, createdAt].map(String)\n        }),\n        [sortFields.indexOf(sort)],\n      )\n\n      const rows = order === 'asc' ? ordered : ordered.toReversed()\n\n      // Initialize maxWidths with the width of each header\n      const maxWidths = sortFields.map((str) => size(str))\n\n      // Calculate maximum width for each column\n      for (const row of rows) {\n        for (const [i, element] of row.entries()) {\n          maxWidths[i] = Math.max(size(element), maxWidths[i])\n        }\n      }\n\n      const printRow = (row: string[]) =>\n        row.map((col, i) => `${col}`.padEnd(maxWidths[i])).join('   ')\n\n      this.log(chalk.cyan(printRow(sortFields)))\n      for (const row of rows) this.log(printRow(row))\n    } catch (error) {\n      projectsDebug('Error listing projects', error)\n      this.error('Failed to list projects', {exit: 1})\n    }\n  }\n}\n"],"names":["Flags","SanityCommand","subdebug","chalk","size","sortBy","sortFields","LIST_PROJECTS_API_VERSION","projectsDebug","List","description","examples","command","flags","order","string","default","options","sort","run","client","getGlobalApiClient","apiVersion","requireUser","projects","list","ordered","map","createdAt","displayName","id","members","manage","length","String","indexOf","rows","toReversed","maxWidths","str","row","i","element","entries","Math","max","printRow","col","padEnd","join","log","cyan","error","exit"],"mappings":"AAAA,SAAQA,KAAK,QAAO,cAAa;AACjC,SAAQC,aAAa,EAAEC,QAAQ,QAAO,mBAAkB;AACxD,SAAQC,KAAK,QAAO,sBAAqB;AACzC,SAAQC,IAAI,EAAEC,MAAM,QAAO,YAAW;AAEtC,MAAMC,aAAa;IAAC;IAAM;IAAW;IAAQ;IAAO;CAAU;AAE9D,MAAMC,4BAA4B;AAClC,MAAMC,gBAAgBN,SAAS;AAE/B,OAAO,MAAMO,aAAaR;IACxB,OAAgBS,cAAc,wCAAuC;IACrE,OAAgBC,WAAW;QACzB;YACEC,SAAS;YACTF,aAAa;QACf;QACA;YACEE,SAAS;YACTF,aAAa;QACf;KACD,CAAA;IAED,OAAgBG,QAAQ;QACtBC,OAAOd,MAAMe,MAAM,CAAC;YAClBC,SAAS;YACTC,SAAS;gBAAC;gBAAO;aAAO;QAC1B;QACAC,MAAMlB,MAAMe,MAAM,CAAC;YACjBC,SAAS;YACTC,SAASX;QACX;IACF,EAAC;IAED,MAAaa,MAAM;QACjB,MAAM,EAACL,KAAK,EAAEI,IAAI,EAAC,GAAG,IAAI,CAACL,KAAK;QAEhC,MAAMO,SAAS,MAAM,IAAI,CAACC,kBAAkB,CAAC;YAC3CC,YAAYf;YACZgB,aAAa;QACf;QAEA,IAAI;YACF,MAAMC,WAAW,MAAMJ,OAAOI,QAAQ,CAACC,IAAI;YAC3C,MAAMC,UAAUrB,OACdmB,SAASG,GAAG,CAAC,CAAC,EAACC,SAAS,EAAEC,WAAW,EAAEC,EAAE,EAAEC,UAAU,EAAE,EAAC;gBACtD,MAAMC,SAAS,CAAC,qCAAqC,EAAEF,IAAI;gBAC3D,OAAO;oBAACA;oBAAIC,QAAQE,MAAM;oBAAEJ;oBAAaG;oBAAQJ;iBAAU,CAACD,GAAG,CAACO;YAClE,IACA;gBAAC5B,WAAW6B,OAAO,CAACjB;aAAM;YAG5B,MAAMkB,OAAOtB,UAAU,QAAQY,UAAUA,QAAQW,UAAU;YAE3D,qDAAqD;YACrD,MAAMC,YAAYhC,WAAWqB,GAAG,CAAC,CAACY,MAAQnC,KAAKmC;YAE/C,0CAA0C;YAC1C,KAAK,MAAMC,OAAOJ,KAAM;gBACtB,KAAK,MAAM,CAACK,GAAGC,QAAQ,IAAIF,IAAIG,OAAO,GAAI;oBACxCL,SAAS,CAACG,EAAE,GAAGG,KAAKC,GAAG,CAACzC,KAAKsC,UAAUJ,SAAS,CAACG,EAAE;gBACrD;YACF;YAEA,MAAMK,WAAW,CAACN,MAChBA,IAAIb,GAAG,CAAC,CAACoB,KAAKN,IAAM,GAAGM,KAAK,CAACC,MAAM,CAACV,SAAS,CAACG,EAAE,GAAGQ,IAAI,CAAC;YAE1D,IAAI,CAACC,GAAG,CAAC/C,MAAMgD,IAAI,CAACL,SAASxC;YAC7B,KAAK,MAAMkC,OAAOJ,KAAM,IAAI,CAACc,GAAG,CAACJ,SAASN;QAC5C,EAAE,OAAOY,OAAO;YACd5C,cAAc,0BAA0B4C;YACxC,IAAI,CAACA,KAAK,CAAC,2BAA2B;gBAACC,MAAM;YAAC;QAChD;IACF;AACF"}

package/dist/commands/schema/__tests__/delete.test.js

@@ -0,0 +1,209 @@
+import { runCommand } from '@oclif/test';
+import { getCliConfig } from '@sanity/cli-core';
+import { testCommand } from '@sanity/cli-test';
+import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest';
+import { deleteSchemaAction } from '../../../actions/schema/deleteSchemaAction.js';
+import { DeleteSchemaCommand } from '../delete.js';
+// Mock the delete schema action
+vi.mock('../../../actions/schema/deleteSchemaAction.js', ()=>({
+        deleteSchemaAction: vi.fn()
+    }));
+// Mock the manifest extractor
+vi.mock('../../../actions/schema/utils/manifestExtractor.js', ()=>({
+        createManifestExtractor: vi.fn(()=>vi.fn())
+    }));
+// Mock the config functions
+vi.mock('../../../../../cli-core/src/config/findProjectRoot.js', ()=>({
+        findProjectRoot: vi.fn().mockResolvedValue({
+            directory: '/test/path',
+            root: '/test/path',
+            type: 'studio'
+        })
+    }));
+vi.mock('../../../../../cli-core/src/config/cli/getCliConfig.js', ()=>({
+        getCliConfig: vi.fn().mockResolvedValue({
+            api: {
+                dataset: 'production',
+                projectId: 'test-project'
+            }
+        })
+    }));
+vi.mock('../../../../../cli-core/src/services/apiClient.js', ()=>({
+        getProjectCliClient: vi.fn()
+    }));
+vi.mock('../../../../../cli-core/src/services/getCliToken.js', ()=>({
+        getCliToken: vi.fn().mockResolvedValue('test-token')
+    }));
+const mockedDeleteSchemaAction = vi.mocked(deleteSchemaAction);
+const mockedGetCliConfig = vi.mocked(getCliConfig);
+describe('#schema:delete', ()=>{
+    beforeEach(()=>{
+        mockedDeleteSchemaAction.mockResolvedValue('success');
+    });
+    afterEach(()=>{
+        vi.clearAllMocks();
+    });
+    test('--help works', async ()=>{
+        const { stdout } = await runCommand([
+            'schema delete',
+            '--help'
+        ]);
+        expect(stdout).toContain('Delete schema documents by id');
+        expect(stdout).toContain('--ids');
+        expect(stdout).toContain('--dataset');
+        expect(stdout).toContain('--extract-manifest');
+        expect(stdout).toContain('--manifest-dir');
+        expect(stdout).toContain('--verbose');
+    });
+    test('deletes a single schema successfully', async ()=>{
+        mockedDeleteSchemaAction.mockResolvedValue('success');
+        await testCommand(DeleteSchemaCommand, [
+            '--ids',
+            'sanity.workspace.schema.workspaceName'
+        ]);
+        expect(mockedDeleteSchemaAction).toHaveBeenCalledWith(expect.objectContaining({
+            ids: 'sanity.workspace.schema.workspaceName'
+        }), expect.any(Object));
+    });
+    test('deletes multiple schemas successfully', async ()=>{
+        mockedDeleteSchemaAction.mockResolvedValue('success');
+        await testCommand(DeleteSchemaCommand, [
+            '--ids',
+            'sanity.workspace.schema.workspace1,sanity.workspace.schema.workspace2'
+        ]);
+        expect(mockedDeleteSchemaAction).toHaveBeenCalledWith(expect.objectContaining({
+            ids: 'sanity.workspace.schema.workspace1,sanity.workspace.schema.workspace2'
+        }), expect.any(Object));
+    });
+    test('uses custom dataset when --dataset flag is provided', async ()=>{
+        mockedDeleteSchemaAction.mockResolvedValue('success');
+        await testCommand(DeleteSchemaCommand, [
+            '--ids',
+            'sanity.workspace.schema.workspaceName',
+            '--dataset',
+            'staging'
+        ]);
+        expect(mockedDeleteSchemaAction).toHaveBeenCalledWith(expect.objectContaining({
+            dataset: 'staging',
+            ids: 'sanity.workspace.schema.workspaceName'
+        }), expect.any(Object));
+    });
+    test('disables manifest extraction with --no-extract-manifest', async ()=>{
+        mockedDeleteSchemaAction.mockResolvedValue('success');
+        await testCommand(DeleteSchemaCommand, [
+            '--ids',
+            'sanity.workspace.schema.workspaceName',
+            '--no-extract-manifest'
+        ]);
+        expect(mockedDeleteSchemaAction).toHaveBeenCalledWith(expect.objectContaining({
+            'extract-manifest': false,
+            ids: 'sanity.workspace.schema.workspaceName'
+        }), expect.any(Object));
+    });
+    test('uses custom manifest directory when --manifest-dir is provided', async ()=>{
+        mockedDeleteSchemaAction.mockResolvedValue('success');
+        await testCommand(DeleteSchemaCommand, [
+            '--ids',
+            'sanity.workspace.schema.workspaceName',
+            '--manifest-dir',
+            './custom/path'
+        ]);
+        expect(mockedDeleteSchemaAction).toHaveBeenCalledWith(expect.objectContaining({
+            ids: 'sanity.workspace.schema.workspaceName',
+            'manifest-dir': './custom/path'
+        }), expect.any(Object));
+    });
+    test('enables verbose logging when --verbose is provided', async ()=>{
+        mockedDeleteSchemaAction.mockResolvedValue('success');
+        await testCommand(DeleteSchemaCommand, [
+            '--ids',
+            'sanity.workspace.schema.workspaceName',
+            '--verbose'
+        ]);
+        expect(mockedDeleteSchemaAction).toHaveBeenCalledWith(expect.objectContaining({
+            ids: 'sanity.workspace.schema.workspaceName',
+            verbose: true
+        }), expect.any(Object));
+    });
+    test('handles action failure', async ()=>{
+        mockedDeleteSchemaAction.mockResolvedValue('failure');
+        const { error } = await testCommand(DeleteSchemaCommand, [
+            '--ids',
+            'sanity.workspace.schema.workspaceName'
+        ]);
+        expect(error).toBeInstanceOf(Error);
+        expect(error?.message).toContain('Failed to delete schemas');
+        expect(error?.oclif?.exit).toBe(1);
+    });
+    test('handles action errors gracefully', async ()=>{
+        mockedDeleteSchemaAction.mockRejectedValue(new Error('Schema delete failed'));
+        const { error } = await testCommand(DeleteSchemaCommand, [
+            '--ids',
+            'sanity.workspace.schema.workspaceName'
+        ]);
+        expect(error).toBeInstanceOf(Error);
+        expect(error?.message).toContain('Failed to delete schemas: Schema delete failed');
+        expect(error?.oclif?.exit).toBe(1);
+    });
+    test('requires --ids flag', async ()=>{
+        const { error } = await testCommand(DeleteSchemaCommand, []);
+        expect(error).toBeInstanceOf(Error);
+        expect(error?.message).toContain('Missing required flag ids');
+    });
+    test.each([
+        {
+            desc: 'no project ID is found',
+            projectId: undefined
+        },
+        {
+            desc: 'project ID is empty string',
+            projectId: ''
+        }
+    ])('throws error when $desc', async ({ projectId })=>{
+        // Mock getCliConfig twice since it's called by both run() and getProjectId()
+        const mockConfig = {
+            api: {
+                dataset: 'production',
+                projectId
+            }
+        };
+        mockedGetCliConfig.mockResolvedValueOnce(mockConfig).mockResolvedValueOnce(mockConfig);
+        const { error } = await testCommand(DeleteSchemaCommand, [
+            '--ids',
+            'sanity.workspace.schema.workspaceName'
+        ]);
+        expect(error).toBeInstanceOf(Error);
+        expect(error?.message).toContain('No project ID found');
+        expect(error?.message).toContain('Sanity project directory');
+        expect(error?.oclif?.exit).toBe(1);
+    });
+    test.each([
+        {
+            dataset: undefined,
+            desc: 'no dataset is found'
+        },
+        {
+            dataset: '',
+            desc: 'dataset is empty string'
+        }
+    ])('throws error when $desc', async ({ dataset })=>{
+        // Mock getCliConfig twice since it's called by both run() and getProjectId()
+        const mockConfig = {
+            api: {
+                dataset,
+                projectId: 'test-project'
+            }
+        };
+        mockedGetCliConfig.mockResolvedValueOnce(mockConfig).mockResolvedValueOnce(mockConfig);
+        const { error } = await testCommand(DeleteSchemaCommand, [
+            '--ids',
+            'sanity.workspace.schema.workspaceName'
+        ]);
+        expect(error).toBeInstanceOf(Error);
+        expect(error?.message).toContain('No dataset found');
+        expect(error?.message).toContain('sanity.config.ts');
+        expect(error?.oclif?.exit).toBe(1);
+    });
+});
+
+//# sourceMappingURL=delete.test.js.map

package/dist/commands/schema/__tests__/delete.test.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/commands/schema/__tests__/delete.test.ts"],"sourcesContent":["import {runCommand} from '@oclif/test'\nimport {getCliConfig} from '@sanity/cli-core'\nimport {testCommand} from '@sanity/cli-test'\nimport {afterEach, beforeEach, describe, expect, test, vi} from 'vitest'\n\nimport {deleteSchemaAction} from '../../../actions/schema/deleteSchemaAction.js'\nimport {DeleteSchemaCommand} from '../delete.js'\n\n// Mock the delete schema action\nvi.mock('../../../actions/schema/deleteSchemaAction.js', () => ({\n  deleteSchemaAction: vi.fn(),\n}))\n\n// Mock the manifest extractor\nvi.mock('../../../actions/schema/utils/manifestExtractor.js', () => ({\n  createManifestExtractor: vi.fn(() => vi.fn()),\n}))\n\n// Mock the config functions\nvi.mock('../../../../../cli-core/src/config/findProjectRoot.js', () => ({\n  findProjectRoot: vi.fn().mockResolvedValue({\n    directory: '/test/path',\n    root: '/test/path',\n    type: 'studio',\n  }),\n}))\n\nvi.mock('../../../../../cli-core/src/config/cli/getCliConfig.js', () => ({\n  getCliConfig: vi.fn().mockResolvedValue({\n    api: {\n      dataset: 'production',\n      projectId: 'test-project',\n    },\n  }),\n}))\n\nvi.mock('../../../../../cli-core/src/services/apiClient.js', () => ({\n  getProjectCliClient: vi.fn(),\n}))\n\nvi.mock('../../../../../cli-core/src/services/getCliToken.js', () => ({\n  getCliToken: vi.fn().mockResolvedValue('test-token'),\n}))\n\nconst mockedDeleteSchemaAction = vi.mocked(deleteSchemaAction)\nconst mockedGetCliConfig = vi.mocked(getCliConfig)\n\ndescribe('#schema:delete', () => {\n  beforeEach(() => {\n    mockedDeleteSchemaAction.mockResolvedValue('success')\n  })\n\n  afterEach(() => {\n    vi.clearAllMocks()\n  })\n\n  test('--help works', async () => {\n    const {stdout} = await runCommand(['schema delete', '--help'])\n\n    expect(stdout).toContain('Delete schema documents by id')\n    expect(stdout).toContain('--ids')\n    expect(stdout).toContain('--dataset')\n    expect(stdout).toContain('--extract-manifest')\n    expect(stdout).toContain('--manifest-dir')\n    expect(stdout).toContain('--verbose')\n  })\n\n  test('deletes a single schema successfully', async () => {\n    mockedDeleteSchemaAction.mockResolvedValue('success')\n\n    await testCommand(DeleteSchemaCommand, ['--ids', 'sanity.workspace.schema.workspaceName'])\n\n    expect(mockedDeleteSchemaAction).toHaveBeenCalledWith(\n      expect.objectContaining({\n        ids: 'sanity.workspace.schema.workspaceName',\n      }),\n      expect.any(Object),\n    )\n  })\n\n  test('deletes multiple schemas successfully', async () => {\n    mockedDeleteSchemaAction.mockResolvedValue('success')\n\n    await testCommand(DeleteSchemaCommand, [\n      '--ids',\n      'sanity.workspace.schema.workspace1,sanity.workspace.schema.workspace2',\n    ])\n\n    expect(mockedDeleteSchemaAction).toHaveBeenCalledWith(\n      expect.objectContaining({\n        ids: 'sanity.workspace.schema.workspace1,sanity.workspace.schema.workspace2',\n      }),\n      expect.any(Object),\n    )\n  })\n\n  test('uses custom dataset when --dataset flag is provided', async () => {\n    mockedDeleteSchemaAction.mockResolvedValue('success')\n\n    await testCommand(DeleteSchemaCommand, [\n      '--ids',\n      'sanity.workspace.schema.workspaceName',\n      '--dataset',\n      'staging',\n    ])\n\n    expect(mockedDeleteSchemaAction).toHaveBeenCalledWith(\n      expect.objectContaining({\n        dataset: 'staging',\n        ids: 'sanity.workspace.schema.workspaceName',\n      }),\n      expect.any(Object),\n    )\n  })\n\n  test('disables manifest extraction with --no-extract-manifest', async () => {\n    mockedDeleteSchemaAction.mockResolvedValue('success')\n\n    await testCommand(DeleteSchemaCommand, [\n      '--ids',\n      'sanity.workspace.schema.workspaceName',\n      '--no-extract-manifest',\n    ])\n\n    expect(mockedDeleteSchemaAction).toHaveBeenCalledWith(\n      expect.objectContaining({\n        'extract-manifest': false,\n        ids: 'sanity.workspace.schema.workspaceName',\n      }),\n      expect.any(Object),\n    )\n  })\n\n  test('uses custom manifest directory when --manifest-dir is provided', async () => {\n    mockedDeleteSchemaAction.mockResolvedValue('success')\n\n    await testCommand(DeleteSchemaCommand, [\n      '--ids',\n      'sanity.workspace.schema.workspaceName',\n      '--manifest-dir',\n      './custom/path',\n    ])\n\n    expect(mockedDeleteSchemaAction).toHaveBeenCalledWith(\n      expect.objectContaining({\n        ids: 'sanity.workspace.schema.workspaceName',\n        'manifest-dir': './custom/path',\n      }),\n      expect.any(Object),\n    )\n  })\n\n  test('enables verbose logging when --verbose is provided', async () => {\n    mockedDeleteSchemaAction.mockResolvedValue('success')\n\n    await testCommand(DeleteSchemaCommand, [\n      '--ids',\n      'sanity.workspace.schema.workspaceName',\n      '--verbose',\n    ])\n\n    expect(mockedDeleteSchemaAction).toHaveBeenCalledWith(\n      expect.objectContaining({\n        ids: 'sanity.workspace.schema.workspaceName',\n        verbose: true,\n      }),\n      expect.any(Object),\n    )\n  })\n\n  test('handles action failure', async () => {\n    mockedDeleteSchemaAction.mockResolvedValue('failure')\n\n    const {error} = await testCommand(DeleteSchemaCommand, [\n      '--ids',\n      'sanity.workspace.schema.workspaceName',\n    ])\n\n    expect(error).toBeInstanceOf(Error)\n    expect(error?.message).toContain('Failed to delete schemas')\n    expect(error?.oclif?.exit).toBe(1)\n  })\n\n  test('handles action errors gracefully', async () => {\n    mockedDeleteSchemaAction.mockRejectedValue(new Error('Schema delete failed'))\n\n    const {error} = await testCommand(DeleteSchemaCommand, [\n      '--ids',\n      'sanity.workspace.schema.workspaceName',\n    ])\n\n    expect(error).toBeInstanceOf(Error)\n    expect(error?.message).toContain('Failed to delete schemas: Schema delete failed')\n    expect(error?.oclif?.exit).toBe(1)\n  })\n\n  test('requires --ids flag', async () => {\n    const {error} = await testCommand(DeleteSchemaCommand, [])\n\n    expect(error).toBeInstanceOf(Error)\n    expect(error?.message).toContain('Missing required flag ids')\n  })\n\n  test.each([\n    {desc: 'no project ID is found', projectId: undefined},\n    {desc: 'project ID is empty string', projectId: ''},\n  ])('throws error when $desc', async ({projectId}) => {\n    // Mock getCliConfig twice since it's called by both run() and getProjectId()\n    const mockConfig = {\n      api: {\n        dataset: 'production',\n        projectId,\n      },\n    }\n    mockedGetCliConfig.mockResolvedValueOnce(mockConfig).mockResolvedValueOnce(mockConfig)\n\n    const {error} = await testCommand(DeleteSchemaCommand, [\n      '--ids',\n      'sanity.workspace.schema.workspaceName',\n    ])\n\n    expect(error).toBeInstanceOf(Error)\n    expect(error?.message).toContain('No project ID found')\n    expect(error?.message).toContain('Sanity project directory')\n    expect(error?.oclif?.exit).toBe(1)\n  })\n\n  test.each([\n    {dataset: undefined, desc: 'no dataset is found'},\n    {dataset: '', desc: 'dataset is empty string'},\n  ])('throws error when $desc', async ({dataset}) => {\n    // Mock getCliConfig twice since it's called by both run() and getProjectId()\n    const mockConfig = {\n      api: {\n        dataset,\n        projectId: 'test-project',\n      },\n    }\n    mockedGetCliConfig.mockResolvedValueOnce(mockConfig).mockResolvedValueOnce(mockConfig)\n\n    const {error} = await testCommand(DeleteSchemaCommand, [\n      '--ids',\n      'sanity.workspace.schema.workspaceName',\n    ])\n\n    expect(error).toBeInstanceOf(Error)\n    expect(error?.message).toContain('No dataset found')\n    expect(error?.message).toContain('sanity.config.ts')\n    expect(error?.oclif?.exit).toBe(1)\n  })\n})\n"],"names":["runCommand","getCliConfig","testCommand","afterEach","beforeEach","describe","expect","test","vi","deleteSchemaAction","DeleteSchemaCommand","mock","fn","createManifestExtractor","findProjectRoot","mockResolvedValue","directory","root","type","api","dataset","projectId","getProjectCliClient","getCliToken","mockedDeleteSchemaAction","mocked","mockedGetCliConfig","clearAllMocks","stdout","toContain","toHaveBeenCalledWith","objectContaining","ids","any","Object","verbose","error","toBeInstanceOf","Error","message","oclif","exit","toBe","mockRejectedValue","each","desc","undefined","mockConfig","mockResolvedValueOnce"],"mappings":"AAAA,SAAQA,UAAU,QAAO,cAAa;AACtC,SAAQC,YAAY,QAAO,mBAAkB;AAC7C,SAAQC,WAAW,QAAO,mBAAkB;AAC5C,SAAQC,SAAS,EAAEC,UAAU,EAAEC,QAAQ,EAAEC,MAAM,EAAEC,IAAI,EAAEC,EAAE,QAAO,SAAQ;AAExE,SAAQC,kBAAkB,QAAO,gDAA+C;AAChF,SAAQC,mBAAmB,QAAO,eAAc;AAEhD,gCAAgC;AAChCF,GAAGG,IAAI,CAAC,iDAAiD,IAAO,CAAA;QAC9DF,oBAAoBD,GAAGI,EAAE;IAC3B,CAAA;AAEA,8BAA8B;AAC9BJ,GAAGG,IAAI,CAAC,sDAAsD,IAAO,CAAA;QACnEE,yBAAyBL,GAAGI,EAAE,CAAC,IAAMJ,GAAGI,EAAE;IAC5C,CAAA;AAEA,4BAA4B;AAC5BJ,GAAGG,IAAI,CAAC,yDAAyD,IAAO,CAAA;QACtEG,iBAAiBN,GAAGI,EAAE,GAAGG,iBAAiB,CAAC;YACzCC,WAAW;YACXC,MAAM;YACNC,MAAM;QACR;IACF,CAAA;AAEAV,GAAGG,IAAI,CAAC,0DAA0D,IAAO,CAAA;QACvEV,cAAcO,GAAGI,EAAE,GAAGG,iBAAiB,CAAC;YACtCI,KAAK;gBACHC,SAAS;gBACTC,WAAW;YACb;QACF;IACF,CAAA;AAEAb,GAAGG,IAAI,CAAC,qDAAqD,IAAO,CAAA;QAClEW,qBAAqBd,GAAGI,EAAE;IAC5B,CAAA;AAEAJ,GAAGG,IAAI,CAAC,uDAAuD,IAAO,CAAA;QACpEY,aAAaf,GAAGI,EAAE,GAAGG,iBAAiB,CAAC;IACzC,CAAA;AAEA,MAAMS,2BAA2BhB,GAAGiB,MAAM,CAAChB;AAC3C,MAAMiB,qBAAqBlB,GAAGiB,MAAM,CAACxB;AAErCI,SAAS,kBAAkB;IACzBD,WAAW;QACToB,yBAAyBT,iBAAiB,CAAC;IAC7C;IAEAZ,UAAU;QACRK,GAAGmB,aAAa;IAClB;IAEApB,KAAK,gBAAgB;QACnB,MAAM,EAACqB,MAAM,EAAC,GAAG,MAAM5B,WAAW;YAAC;YAAiB;SAAS;QAE7DM,OAAOsB,QAAQC,SAAS,CAAC;QACzBvB,OAAOsB,QAAQC,SAAS,CAAC;QACzBvB,OAAOsB,QAAQC,SAAS,CAAC;QACzBvB,OAAOsB,QAAQC,SAAS,CAAC;QACzBvB,OAAOsB,QAAQC,SAAS,CAAC;QACzBvB,OAAOsB,QAAQC,SAAS,CAAC;IAC3B;IAEAtB,KAAK,wCAAwC;QAC3CiB,yBAAyBT,iBAAiB,CAAC;QAE3C,MAAMb,YAAYQ,qBAAqB;YAAC;YAAS;SAAwC;QAEzFJ,OAAOkB,0BAA0BM,oBAAoB,CACnDxB,OAAOyB,gBAAgB,CAAC;YACtBC,KAAK;QACP,IACA1B,OAAO2B,GAAG,CAACC;IAEf;IAEA3B,KAAK,yCAAyC;QAC5CiB,yBAAyBT,iBAAiB,CAAC;QAE3C,MAAMb,YAAYQ,qBAAqB;YACrC;YACA;SACD;QAEDJ,OAAOkB,0BAA0BM,oBAAoB,CACnDxB,OAAOyB,gBAAgB,CAAC;YACtBC,KAAK;QACP,IACA1B,OAAO2B,GAAG,CAACC;IAEf;IAEA3B,KAAK,uDAAuD;QAC1DiB,yBAAyBT,iBAAiB,CAAC;QAE3C,MAAMb,YAAYQ,qBAAqB;YACrC;YACA;YACA;YACA;SACD;QAEDJ,OAAOkB,0BAA0BM,oBAAoB,CACnDxB,OAAOyB,gBAAgB,CAAC;YACtBX,SAAS;YACTY,KAAK;QACP,IACA1B,OAAO2B,GAAG,CAACC;IAEf;IAEA3B,KAAK,2DAA2D;QAC9DiB,yBAAyBT,iBAAiB,CAAC;QAE3C,MAAMb,YAAYQ,qBAAqB;YACrC;YACA;YACA;SACD;QAEDJ,OAAOkB,0BAA0BM,oBAAoB,CACnDxB,OAAOyB,gBAAgB,CAAC;YACtB,oBAAoB;YACpBC,KAAK;QACP,IACA1B,OAAO2B,GAAG,CAACC;IAEf;IAEA3B,KAAK,kEAAkE;QACrEiB,yBAAyBT,iBAAiB,CAAC;QAE3C,MAAMb,YAAYQ,qBAAqB;YACrC;YACA;YACA;YACA;SACD;QAEDJ,OAAOkB,0BAA0BM,oBAAoB,CACnDxB,OAAOyB,gBAAgB,CAAC;YACtBC,KAAK;YACL,gBAAgB;QAClB,IACA1B,OAAO2B,GAAG,CAACC;IAEf;IAEA3B,KAAK,sDAAsD;QACzDiB,yBAAyBT,iBAAiB,CAAC;QAE3C,MAAMb,YAAYQ,qBAAqB;YACrC;YACA;YACA;SACD;QAEDJ,OAAOkB,0BAA0BM,oBAAoB,CACnDxB,OAAOyB,gBAAgB,CAAC;YACtBC,KAAK;YACLG,SAAS;QACX,IACA7B,OAAO2B,GAAG,CAACC;IAEf;IAEA3B,KAAK,0BAA0B;QAC7BiB,yBAAyBT,iBAAiB,CAAC;QAE3C,MAAM,EAACqB,KAAK,EAAC,GAAG,MAAMlC,YAAYQ,qBAAqB;YACrD;YACA;SACD;QAEDJ,OAAO8B,OAAOC,cAAc,CAACC;QAC7BhC,OAAO8B,OAAOG,SAASV,SAAS,CAAC;QACjCvB,OAAO8B,OAAOI,OAAOC,MAAMC,IAAI,CAAC;IAClC;IAEAnC,KAAK,oCAAoC;QACvCiB,yBAAyBmB,iBAAiB,CAAC,IAAIL,MAAM;QAErD,MAAM,EAACF,KAAK,EAAC,GAAG,MAAMlC,YAAYQ,qBAAqB;YACrD;YACA;SACD;QAEDJ,OAAO8B,OAAOC,cAAc,CAACC;QAC7BhC,OAAO8B,OAAOG,SAASV,SAAS,CAAC;QACjCvB,OAAO8B,OAAOI,OAAOC,MAAMC,IAAI,CAAC;IAClC;IAEAnC,KAAK,uBAAuB;QAC1B,MAAM,EAAC6B,KAAK,EAAC,GAAG,MAAMlC,YAAYQ,qBAAqB,EAAE;QAEzDJ,OAAO8B,OAAOC,cAAc,CAACC;QAC7BhC,OAAO8B,OAAOG,SAASV,SAAS,CAAC;IACnC;IAEAtB,KAAKqC,IAAI,CAAC;QACR;YAACC,MAAM;YAA0BxB,WAAWyB;QAAS;QACrD;YAACD,MAAM;YAA8BxB,WAAW;QAAE;KACnD,EAAE,2BAA2B,OAAO,EAACA,SAAS,EAAC;QAC9C,6EAA6E;QAC7E,MAAM0B,aAAa;YACjB5B,KAAK;gBACHC,SAAS;gBACTC;YACF;QACF;QACAK,mBAAmBsB,qBAAqB,CAACD,YAAYC,qBAAqB,CAACD;QAE3E,MAAM,EAACX,KAAK,EAAC,GAAG,MAAMlC,YAAYQ,qBAAqB;YACrD;YACA;SACD;QAEDJ,OAAO8B,OAAOC,cAAc,CAACC;QAC7BhC,OAAO8B,OAAOG,SAASV,SAAS,CAAC;QACjCvB,OAAO8B,OAAOG,SAASV,SAAS,CAAC;QACjCvB,OAAO8B,OAAOI,OAAOC,MAAMC,IAAI,CAAC;IAClC;IAEAnC,KAAKqC,IAAI,CAAC;QACR;YAACxB,SAAS0B;YAAWD,MAAM;QAAqB;QAChD;YAACzB,SAAS;YAAIyB,MAAM;QAAyB;KAC9C,EAAE,2BAA2B,OAAO,EAACzB,OAAO,EAAC;QAC5C,6EAA6E;QAC7E,MAAM2B,aAAa;YACjB5B,KAAK;gBACHC;gBACAC,WAAW;YACb;QACF;QACAK,mBAAmBsB,qBAAqB,CAACD,YAAYC,qBAAqB,CAACD;QAE3E,MAAM,EAACX,KAAK,EAAC,GAAG,MAAMlC,YAAYQ,qBAAqB;YACrD;YACA;SACD;QAEDJ,OAAO8B,OAAOC,cAAc,CAACC;QAC7BhC,OAAO8B,OAAOG,SAASV,SAAS,CAAC;QACjCvB,OAAO8B,OAAOG,SAASV,SAAS,CAAC;QACjCvB,OAAO8B,OAAOI,OAAOC,MAAMC,IAAI,CAAC;IAClC;AACF"}

package/dist/commands/schema/__tests__/extract.test.js

@@ -0,0 +1,113 @@
+import { mkdir, writeFile } from 'node:fs/promises';
+import { runCommand } from '@oclif/test';
+import { testCommand } from '@sanity/cli-test';
+import { afterEach, describe, expect, test, vi } from 'vitest';
+import { ExtractSchemaCommand } from '../extract.js';
+vi.mock('node:fs/promises');
+vi.mock('../../../../../cli-core/src/config/findProjectRoot.js', async ()=>({
+        findProjectRoot: vi.fn().mockResolvedValue({
+            directory: '/test/project',
+            root: '/test/project',
+            type: 'studio'
+        })
+    }));
+vi.mock('../../../util/getWorkspace.js', ()=>({
+        getWorkspace: vi.fn().mockReturnValue({})
+    }));
+vi.mock('../../../util/importStudioConfig.js', async ()=>({
+        importStudioConfig: vi.fn()
+    }));
+vi.mock('@sanity/schema/_internal', ()=>({
+        extractSchema: vi.fn().mockReturnValue([
+            {
+                fields: [
+                    {
+                        name: 'type',
+                        title: 'string'
+                    }
+                ],
+                name: 'post',
+                type: 'document'
+            }
+        ])
+    }));
+const mockMkdir = vi.mocked(mkdir);
+const mockWriteFile = vi.mocked(writeFile);
+describe('#schema:extract', ()=>{
+    afterEach(()=>{
+        vi.clearAllMocks();
+    });
+    test('should show --help text', async ()=>{
+        const { stdout } = await runCommand('schema extract --help');
+        expect(stdout).toMatchInlineSnapshot(`
+      "Extracts a JSON representation of a Sanity schema within a Studio context.
+
+      USAGE
+        $ sanity schema extract [--enforce-required-fields] [--format <format>]
+          [--path <value>] [--workspace <name>]
+
+      FLAGS
+        --enforce-required-fields  Makes the schema generated treat fields marked as
+                                   required as non-optional
+        --format=<format>          [default: groq-type-nodes] Format the schema as
+                                   GROQ type nodes. Only available format at the
+                                   moment.
+        --path=<value>             Optional path to specify destination of the schema
+                                   file
+        --workspace=<name>         The name of the workspace to generate a schema for
+
+      DESCRIPTION
+        Extracts a JSON representation of a Sanity schema within a Studio context.
+
+        **Note**: This command is experimental and subject to change.
+
+      EXAMPLES
+        Extracts schema types in a Sanity project with more than one workspace
+
+          $ sanity schema extract --workspace default
+
+      "
+    `);
+    });
+    test('should extract schema', async ()=>{
+        mockWriteFile.mockResolvedValue(undefined);
+        const { stderr } = await testCommand(ExtractSchemaCommand);
+        expect(stderr).toContain('Extracting schema');
+        expect(stderr).toContain('✔ Extracted schema');
+        expect(mockWriteFile).toHaveBeenCalledWith(expect.stringContaining('schema.json'), // eslint-disable-next-line no-useless-escape
+        expect.stringContaining(`\"name\": \"post\"`));
+    });
+    test('should extract schema with enforce-required-fields flag', async ()=>{
+        mockWriteFile.mockResolvedValue(undefined);
+        const { stderr } = await testCommand(ExtractSchemaCommand, [
+            '--enforce-required-fields'
+        ]);
+        expect(stderr).toContain('Extracting schema with enforced required fields');
+    });
+    test('should extract schema with path flag', async ()=>{
+        mockMkdir.mockResolvedValue(undefined);
+        mockWriteFile.mockResolvedValue(undefined);
+        const { stderr } = await testCommand(ExtractSchemaCommand, [
+            '--path',
+            '/test'
+        ]);
+        expect(stderr).toContain('Extracting schema');
+        expect(stderr).toContain('✔ Extracted schema');
+        expect(mockMkdir).toHaveBeenCalledWith('/test/project/test', {
+            recursive: true
+        });
+        expect(mockWriteFile).toHaveBeenCalledWith('/test/project/test/schema.json', // eslint-disable-next-line no-useless-escape
+        expect.stringContaining(`\"name\": \"post\"`));
+    });
+    test('throws an error if format flag is not groq-type-nodes', async ()=>{
+        const { error, stderr } = await testCommand(ExtractSchemaCommand, [
+            '--format',
+            'test-format'
+        ]);
+        expect(stderr).toContain('Extracting schema');
+        expect(stderr).toContain('Failed to extract schema');
+        expect(error?.message).toContain('Unsupported format: "test-format"');
+    });
+});
+
+//# sourceMappingURL=extract.test.js.map

package/dist/commands/schema/__tests__/extract.test.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/commands/schema/__tests__/extract.test.ts"],"sourcesContent":["import {mkdir, writeFile} from 'node:fs/promises'\n\nimport {runCommand} from '@oclif/test'\nimport {testCommand} from '@sanity/cli-test'\nimport {afterEach, describe, expect, test, vi} from 'vitest'\n\nimport {ExtractSchemaCommand} from '../extract.js'\n\nvi.mock('node:fs/promises')\n\nvi.mock('../../../../../cli-core/src/config/findProjectRoot.js', async () => ({\n  findProjectRoot: vi.fn().mockResolvedValue({\n    directory: '/test/project',\n    root: '/test/project',\n    type: 'studio',\n  }),\n}))\n\nvi.mock('../../../util/getWorkspace.js', () => ({\n  getWorkspace: vi.fn().mockReturnValue({}),\n}))\n\nvi.mock('../../../util/importStudioConfig.js', async () => ({\n  importStudioConfig: vi.fn(),\n}))\n\nvi.mock('@sanity/schema/_internal', () => ({\n  extractSchema: vi.fn().mockReturnValue([\n    {\n      fields: [\n        {\n          name: 'type',\n          title: 'string',\n        },\n      ],\n      name: 'post',\n      type: 'document',\n    },\n  ]),\n}))\n\nconst mockMkdir = vi.mocked(mkdir)\nconst mockWriteFile = vi.mocked(writeFile)\n\ndescribe('#schema:extract', () => {\n  afterEach(() => {\n    vi.clearAllMocks()\n  })\n\n  test('should show --help text', async () => {\n    const {stdout} = await runCommand('schema extract --help')\n\n    expect(stdout).toMatchInlineSnapshot(`\n      \"Extracts a JSON representation of a Sanity schema within a Studio context.\n\n      USAGE\n        $ sanity schema extract [--enforce-required-fields] [--format <format>]\n          [--path <value>] [--workspace <name>]\n\n      FLAGS\n        --enforce-required-fields  Makes the schema generated treat fields marked as\n                                   required as non-optional\n        --format=<format>          [default: groq-type-nodes] Format the schema as\n                                   GROQ type nodes. Only available format at the\n                                   moment.\n        --path=<value>             Optional path to specify destination of the schema\n                                   file\n        --workspace=<name>         The name of the workspace to generate a schema for\n\n      DESCRIPTION\n        Extracts a JSON representation of a Sanity schema within a Studio context.\n\n        **Note**: This command is experimental and subject to change.\n\n      EXAMPLES\n        Extracts schema types in a Sanity project with more than one workspace\n\n          $ sanity schema extract --workspace default\n\n      \"\n    `)\n  })\n\n  test('should extract schema', async () => {\n    mockWriteFile.mockResolvedValue(undefined)\n\n    const {stderr} = await testCommand(ExtractSchemaCommand)\n\n    expect(stderr).toContain('Extracting schema')\n    expect(stderr).toContain('✔ Extracted schema')\n\n    expect(mockWriteFile).toHaveBeenCalledWith(\n      expect.stringContaining('schema.json'),\n      // eslint-disable-next-line no-useless-escape\n      expect.stringContaining(`\\\"name\\\": \\\"post\\\"`),\n    )\n  })\n\n  test('should extract schema with enforce-required-fields flag', async () => {\n    mockWriteFile.mockResolvedValue(undefined)\n\n    const {stderr} = await testCommand(ExtractSchemaCommand, ['--enforce-required-fields'])\n\n    expect(stderr).toContain('Extracting schema with enforced required fields')\n  })\n\n  test('should extract schema with path flag', async () => {\n    mockMkdir.mockResolvedValue(undefined)\n    mockWriteFile.mockResolvedValue(undefined)\n\n    const {stderr} = await testCommand(ExtractSchemaCommand, ['--path', '/test'])\n\n    expect(stderr).toContain('Extracting schema')\n    expect(stderr).toContain('✔ Extracted schema')\n\n    expect(mockMkdir).toHaveBeenCalledWith('/test/project/test', {recursive: true})\n\n    expect(mockWriteFile).toHaveBeenCalledWith(\n      '/test/project/test/schema.json',\n      // eslint-disable-next-line no-useless-escape\n      expect.stringContaining(`\\\"name\\\": \\\"post\\\"`),\n    )\n  })\n\n  test('throws an error if format flag is not groq-type-nodes', async () => {\n    const {error, stderr} = await testCommand(ExtractSchemaCommand, ['--format', 'test-format'])\n\n    expect(stderr).toContain('Extracting schema')\n    expect(stderr).toContain('Failed to extract schema')\n    expect(error?.message).toContain('Unsupported format: \"test-format\"')\n  })\n})\n"],"names":["mkdir","writeFile","runCommand","testCommand","afterEach","describe","expect","test","vi","ExtractSchemaCommand","mock","findProjectRoot","fn","mockResolvedValue","directory","root","type","getWorkspace","mockReturnValue","importStudioConfig","extractSchema","fields","name","title","mockMkdir","mocked","mockWriteFile","clearAllMocks","stdout","toMatchInlineSnapshot","undefined","stderr","toContain","toHaveBeenCalledWith","stringContaining","recursive","error","message"],"mappings":"AAAA,SAAQA,KAAK,EAAEC,SAAS,QAAO,mBAAkB;AAEjD,SAAQC,UAAU,QAAO,cAAa;AACtC,SAAQC,WAAW,QAAO,mBAAkB;AAC5C,SAAQC,SAAS,EAAEC,QAAQ,EAAEC,MAAM,EAAEC,IAAI,EAAEC,EAAE,QAAO,SAAQ;AAE5D,SAAQC,oBAAoB,QAAO,gBAAe;AAElDD,GAAGE,IAAI,CAAC;AAERF,GAAGE,IAAI,CAAC,yDAAyD,UAAa,CAAA;QAC5EC,iBAAiBH,GAAGI,EAAE,GAAGC,iBAAiB,CAAC;YACzCC,WAAW;YACXC,MAAM;YACNC,MAAM;QACR;IACF,CAAA;AAEAR,GAAGE,IAAI,CAAC,iCAAiC,IAAO,CAAA;QAC9CO,cAAcT,GAAGI,EAAE,GAAGM,eAAe,CAAC,CAAC;IACzC,CAAA;AAEAV,GAAGE,IAAI,CAAC,uCAAuC,UAAa,CAAA;QAC1DS,oBAAoBX,GAAGI,EAAE;IAC3B,CAAA;AAEAJ,GAAGE,IAAI,CAAC,4BAA4B,IAAO,CAAA;QACzCU,eAAeZ,GAAGI,EAAE,GAAGM,eAAe,CAAC;YACrC;gBACEG,QAAQ;oBACN;wBACEC,MAAM;wBACNC,OAAO;oBACT;iBACD;gBACDD,MAAM;gBACNN,MAAM;YACR;SACD;IACH,CAAA;AAEA,MAAMQ,YAAYhB,GAAGiB,MAAM,CAACzB;AAC5B,MAAM0B,gBAAgBlB,GAAGiB,MAAM,CAACxB;AAEhCI,SAAS,mBAAmB;IAC1BD,UAAU;QACRI,GAAGmB,aAAa;IAClB;IAEApB,KAAK,2BAA2B;QAC9B,MAAM,EAACqB,MAAM,EAAC,GAAG,MAAM1B,WAAW;QAElCI,OAAOsB,QAAQC,qBAAqB,CAAC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA4BtC,CAAC;IACH;IAEAtB,KAAK,yBAAyB;QAC5BmB,cAAcb,iBAAiB,CAACiB;QAEhC,MAAM,EAACC,MAAM,EAAC,GAAG,MAAM5B,YAAYM;QAEnCH,OAAOyB,QAAQC,SAAS,CAAC;QACzB1B,OAAOyB,QAAQC,SAAS,CAAC;QAEzB1B,OAAOoB,eAAeO,oBAAoB,CACxC3B,OAAO4B,gBAAgB,CAAC,gBACxB,6CAA6C;QAC7C5B,OAAO4B,gBAAgB,CAAC,CAAC,kBAAkB,CAAC;IAEhD;IAEA3B,KAAK,2DAA2D;QAC9DmB,cAAcb,iBAAiB,CAACiB;QAEhC,MAAM,EAACC,MAAM,EAAC,GAAG,MAAM5B,YAAYM,sBAAsB;YAAC;SAA4B;QAEtFH,OAAOyB,QAAQC,SAAS,CAAC;IAC3B;IAEAzB,KAAK,wCAAwC;QAC3CiB,UAAUX,iBAAiB,CAACiB;QAC5BJ,cAAcb,iBAAiB,CAACiB;QAEhC,MAAM,EAACC,MAAM,EAAC,GAAG,MAAM5B,YAAYM,sBAAsB;YAAC;YAAU;SAAQ;QAE5EH,OAAOyB,QAAQC,SAAS,CAAC;QACzB1B,OAAOyB,QAAQC,SAAS,CAAC;QAEzB1B,OAAOkB,WAAWS,oBAAoB,CAAC,sBAAsB;YAACE,WAAW;QAAI;QAE7E7B,OAAOoB,eAAeO,oBAAoB,CACxC,kCACA,6CAA6C;QAC7C3B,OAAO4B,gBAAgB,CAAC,CAAC,kBAAkB,CAAC;IAEhD;IAEA3B,KAAK,yDAAyD;QAC5D,MAAM,EAAC6B,KAAK,EAAEL,MAAM,EAAC,GAAG,MAAM5B,YAAYM,sBAAsB;YAAC;YAAY;SAAc;QAE3FH,OAAOyB,QAAQC,SAAS,CAAC;QACzB1B,OAAOyB,QAAQC,SAAS,CAAC;QACzB1B,OAAO8B,OAAOC,SAASL,SAAS,CAAC;IACnC;AACF"}