@sanity/cli 6.0.0-alpha.4 → 6.0.0-alpha.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/actions/dev/startStudioDevServer.js +3 -8
- package/dist/actions/dev/startStudioDevServer.js.map +1 -1
- package/dist/actions/dev/types.d.ts +1 -3
- package/dist/actions/dev/types.js.map +1 -1
- package/dist/actions/documents/validate.d.ts +0 -2
- package/dist/actions/documents/validate.js +21 -1
- package/dist/actions/documents/validate.js.map +1 -1
- package/dist/actions/exec/execScript.js +1 -1
- package/dist/actions/exec/execScript.js.map +1 -1
- package/dist/actions/graphql/__tests__/getGraphQLAPIs.test.js +1 -1
- package/dist/actions/graphql/__tests__/getGraphQLAPIs.test.js.map +1 -1
- package/dist/actions/graphql/getGraphQLAPIs.js +1 -1
- package/dist/actions/graphql/getGraphQLAPIs.js.map +1 -1
- package/dist/actions/manifest/extractManifest.js +1 -4
- package/dist/actions/manifest/extractManifest.js.map +1 -1
- package/dist/actions/schema/deleteSchemaAction.d.ts +13 -5
- package/dist/actions/schema/deleteSchemaAction.js +12 -17
- package/dist/actions/schema/deleteSchemaAction.js.map +1 -1
- package/dist/actions/schema/deploySchemas.d.ts +15 -0
- package/dist/actions/schema/deploySchemas.js +98 -0
- package/dist/actions/schema/deploySchemas.js.map +1 -0
- package/dist/actions/schema/listSchemas.d.ts +12 -0
- package/dist/actions/schema/listSchemas.js +119 -0
- package/dist/actions/schema/listSchemas.js.map +1 -0
- package/dist/actions/schema/schemaStoreTypes.d.ts +0 -11
- package/dist/actions/schema/schemaStoreTypes.js.map +1 -1
- package/dist/actions/schema/utils/debug.d.ts +2 -0
- package/dist/actions/schema/utils/debug.js +5 -0
- package/dist/actions/schema/utils/debug.js.map +1 -0
- package/dist/actions/schema/utils/manifestExtractor.d.ts +3 -8
- package/dist/actions/schema/utils/manifestExtractor.js +12 -17
- package/dist/actions/schema/utils/manifestExtractor.js.map +1 -1
- package/dist/actions/schema/utils/manifestReader.d.ts +2 -9
- package/dist/actions/schema/utils/manifestReader.js +6 -12
- package/dist/actions/schema/utils/manifestReader.js.map +1 -1
- package/dist/actions/schema/utils/schemaStoreOutStrings.d.ts +0 -1
- package/dist/actions/schema/utils/schemaStoreOutStrings.js +1 -1
- package/dist/actions/schema/utils/schemaStoreOutStrings.js.map +1 -1
- package/dist/actions/schema/utils/schemaStoreValidation.d.ts +10 -62
- package/dist/actions/schema/utils/schemaStoreValidation.js +38 -125
- package/dist/actions/schema/utils/schemaStoreValidation.js.map +1 -1
- package/dist/actions/schema/utils/uniqByProjectIdDataset.d.ts +14 -0
- package/dist/actions/schema/utils/uniqByProjectIdDataset.js +9 -0
- package/dist/actions/schema/utils/uniqByProjectIdDataset.js.map +1 -0
- package/dist/actions/users/getMembersForProject.d.ts +1 -3
- package/dist/actions/users/getMembersForProject.js +6 -17
- package/dist/actions/users/getMembersForProject.js.map +1 -1
- package/dist/actions/users/types.d.ts +0 -11
- package/dist/actions/users/types.js.map +1 -1
- package/dist/commands/__tests__/debug.test.js +113 -220
- package/dist/commands/__tests__/debug.test.js.map +1 -1
- package/dist/commands/__tests__/deploy.test.js +325 -293
- package/dist/commands/__tests__/deploy.test.js.map +1 -1
- package/dist/commands/__tests__/dev.test.js +62 -19
- package/dist/commands/__tests__/dev.test.js.map +1 -1
- package/dist/commands/__tests__/init/init.authentication.test.js +40 -27
- package/dist/commands/__tests__/init/init.authentication.test.js.map +1 -1
- package/dist/commands/__tests__/init/init.create-new-project.test.js +84 -85
- package/dist/commands/__tests__/init/init.create-new-project.test.js.map +1 -1
- package/dist/commands/__tests__/init/init.plan.test.js +103 -44
- package/dist/commands/__tests__/init/init.plan.test.js.map +1 -1
- package/dist/commands/__tests__/init/init.setup.test.js +85 -29
- package/dist/commands/__tests__/init/init.setup.test.js.map +1 -1
- package/dist/commands/__tests__/install.test.js +46 -22
- package/dist/commands/__tests__/install.test.js.map +1 -1
- package/dist/commands/__tests__/logout.test.js +8 -5
- package/dist/commands/__tests__/logout.test.js.map +1 -1
- package/dist/commands/__tests__/manage.test.js +29 -24
- package/dist/commands/__tests__/manage.test.js.map +1 -1
- package/dist/commands/__tests__/versions.test.js +22 -14
- package/dist/commands/__tests__/versions.test.js.map +1 -1
- package/dist/commands/backup/__tests__/disable.test.js +72 -75
- package/dist/commands/backup/__tests__/disable.test.js.map +1 -1
- package/dist/commands/backup/__tests__/download.test.js +166 -77
- package/dist/commands/backup/__tests__/download.test.js.map +1 -1
- package/dist/commands/backup/__tests__/enable.test.js +109 -140
- package/dist/commands/backup/__tests__/enable.test.js.map +1 -1
- package/dist/commands/backup/__tests__/list.test.js +84 -75
- package/dist/commands/backup/__tests__/list.test.js.map +1 -1
- package/dist/commands/backup/disable.js +5 -11
- package/dist/commands/backup/disable.js.map +1 -1
- package/dist/commands/backup/enable.js +5 -11
- package/dist/commands/backup/enable.js.map +1 -1
- package/dist/commands/backup/list.js +7 -8
- package/dist/commands/backup/list.js.map +1 -1
- package/dist/commands/cors/__tests__/add.test.js +68 -38
- package/dist/commands/cors/__tests__/add.test.js.map +1 -1
- package/dist/commands/cors/__tests__/delete.test.js +52 -37
- package/dist/commands/cors/__tests__/delete.test.js.map +1 -1
- package/dist/commands/cors/__tests__/list.test.js +80 -57
- package/dist/commands/cors/__tests__/list.test.js.map +1 -1
- package/dist/commands/cors/add.js +5 -13
- package/dist/commands/cors/add.js.map +1 -1
- package/dist/commands/cors/delete.js +7 -15
- package/dist/commands/cors/delete.js.map +1 -1
- package/dist/commands/cors/list.js +2 -10
- package/dist/commands/cors/list.js.map +1 -1
- package/dist/commands/dataset/__tests__/copy.test.js +197 -89
- package/dist/commands/dataset/__tests__/copy.test.js.map +1 -1
- package/dist/commands/dataset/__tests__/create.test.js +147 -117
- package/dist/commands/dataset/__tests__/create.test.js.map +1 -1
- package/dist/commands/dataset/__tests__/delete.test.js +75 -68
- package/dist/commands/dataset/__tests__/delete.test.js.map +1 -1
- package/dist/commands/dataset/__tests__/export.test.js +123 -83
- package/dist/commands/dataset/__tests__/export.test.js.map +1 -1
- package/dist/commands/dataset/__tests__/list.test.js +107 -65
- package/dist/commands/dataset/__tests__/list.test.js.map +1 -1
- package/dist/commands/dataset/alias/__tests__/create.test.js +114 -74
- package/dist/commands/dataset/alias/__tests__/create.test.js.map +1 -1
- package/dist/commands/dataset/alias/__tests__/delete.test.js +40 -29
- package/dist/commands/dataset/alias/__tests__/delete.test.js.map +1 -1
- package/dist/commands/dataset/alias/__tests__/link.test.js +114 -74
- package/dist/commands/dataset/alias/__tests__/link.test.js.map +1 -1
- package/dist/commands/dataset/alias/__tests__/unlink.test.js +44 -29
- package/dist/commands/dataset/alias/__tests__/unlink.test.js.map +1 -1
- package/dist/commands/dataset/export.js +4 -4
- package/dist/commands/dataset/export.js.map +1 -1
- package/dist/commands/dataset/visibility/__tests__/get.test.js +48 -67
- package/dist/commands/dataset/visibility/__tests__/get.test.js.map +1 -1
- package/dist/commands/dataset/visibility/__tests__/set.test.js +76 -123
- package/dist/commands/dataset/visibility/__tests__/set.test.js.map +1 -1
- package/dist/commands/dev.js +0 -1
- package/dist/commands/dev.js.map +1 -1
- package/dist/commands/docs/__tests__/search.test.js +8 -7
- package/dist/commands/docs/__tests__/search.test.js.map +1 -1
- package/dist/commands/documents/__tests__/create.test.js +328 -265
- package/dist/commands/documents/__tests__/create.test.js.map +1 -1
- package/dist/commands/documents/__tests__/delete.test.js +119 -87
- package/dist/commands/documents/__tests__/delete.test.js.map +1 -1
- package/dist/commands/documents/__tests__/get.test.js +68 -95
- package/dist/commands/documents/__tests__/get.test.js.map +1 -1
- package/dist/commands/documents/__tests__/query.test.js +84 -189
- package/dist/commands/documents/__tests__/query.test.js.map +1 -1
- package/dist/commands/documents/__tests__/validate.test.js +52 -29
- package/dist/commands/documents/__tests__/validate.test.js.map +1 -1
- package/dist/commands/documents/create.d.ts +1 -0
- package/dist/commands/documents/create.js +10 -9
- package/dist/commands/documents/create.js.map +1 -1
- package/dist/commands/documents/delete.js +2 -3
- package/dist/commands/documents/delete.js.map +1 -1
- package/dist/commands/documents/get.js +2 -3
- package/dist/commands/documents/get.js.map +1 -1
- package/dist/commands/documents/query.js +2 -3
- package/dist/commands/documents/query.js.map +1 -1
- package/dist/commands/documents/validate.js +0 -20
- package/dist/commands/documents/validate.js.map +1 -1
- package/dist/commands/graphql/__tests__/list.test.js +57 -45
- package/dist/commands/graphql/__tests__/list.test.js.map +1 -1
- package/dist/commands/graphql/__tests__/undeploy.test.js +85 -59
- package/dist/commands/graphql/__tests__/undeploy.test.js.map +1 -1
- package/dist/commands/graphql/list.js +2 -2
- package/dist/commands/graphql/list.js.map +1 -1
- package/dist/commands/graphql/undeploy.js +4 -9
- package/dist/commands/graphql/undeploy.js.map +1 -1
- package/dist/commands/hook/__tests__/attempt.test.js +48 -33
- package/dist/commands/hook/__tests__/attempt.test.js.map +1 -1
- package/dist/commands/hook/__tests__/create.test.js +49 -51
- package/dist/commands/hook/__tests__/create.test.js.map +1 -1
- package/dist/commands/hook/__tests__/delete.test.js +43 -30
- package/dist/commands/hook/__tests__/delete.test.js.map +1 -1
- package/dist/commands/hook/__tests__/list.test.js +38 -31
- package/dist/commands/hook/__tests__/list.test.js.map +1 -1
- package/dist/commands/hook/__tests__/logs.test.js +68 -40
- package/dist/commands/hook/__tests__/logs.test.js.map +1 -1
- package/dist/commands/hook/create.js +2 -6
- package/dist/commands/hook/create.js.map +1 -1
- package/dist/commands/hook/delete.js +5 -17
- package/dist/commands/hook/delete.js.map +1 -1
- package/dist/commands/hook/list.js +2 -8
- package/dist/commands/hook/list.js.map +1 -1
- package/dist/commands/manifest/__tests__/extract.test.js +22 -13
- package/dist/commands/manifest/__tests__/extract.test.js.map +1 -1
- package/dist/commands/media/__tests__/create-aspect.test.js +41 -28
- package/dist/commands/media/__tests__/create-aspect.test.js.map +1 -1
- package/dist/commands/media/__tests__/delete-aspect.test.js +44 -35
- package/dist/commands/media/__tests__/delete-aspect.test.js.map +1 -1
- package/dist/commands/media/__tests__/deploy-aspect.test.js +67 -80
- package/dist/commands/media/__tests__/deploy-aspect.test.js.map +1 -1
- package/dist/commands/media/__tests__/export.test.js +365 -66
- package/dist/commands/media/__tests__/export.test.js.map +1 -1
- package/dist/commands/media/__tests__/import.test.js +171 -105
- package/dist/commands/media/__tests__/import.test.js.map +1 -1
- package/dist/commands/media/export.js +2 -2
- package/dist/commands/media/export.js.map +1 -1
- package/dist/commands/media/import.js +2 -2
- package/dist/commands/media/import.js.map +1 -1
- package/dist/commands/projects/__tests__/list.test.js +5 -4
- package/dist/commands/projects/__tests__/list.test.js.map +1 -1
- package/dist/commands/projects/list.js +2 -6
- package/dist/commands/projects/list.js.map +1 -1
- package/dist/commands/schema/__tests__/delete.test.js +396 -151
- package/dist/commands/schema/__tests__/delete.test.js.map +1 -1
- package/dist/commands/schema/__tests__/deploy.test.js +348 -0
- package/dist/commands/schema/__tests__/deploy.test.js.map +1 -0
- package/dist/commands/schema/__tests__/extract.test.js +19 -11
- package/dist/commands/schema/__tests__/extract.test.js.map +1 -1
- package/dist/commands/schema/__tests__/list.test.js +399 -0
- package/dist/commands/schema/__tests__/list.test.js.map +1 -0
- package/dist/commands/schema/__tests__/validate.test.js +27 -10
- package/dist/commands/schema/__tests__/validate.test.js.map +1 -1
- package/dist/commands/schema/delete.d.ts +1 -1
- package/dist/commands/schema/delete.js +20 -23
- package/dist/commands/schema/delete.js.map +1 -1
- package/dist/commands/schema/deploy.d.ts +16 -0
- package/dist/commands/schema/deploy.js +98 -0
- package/dist/commands/schema/deploy.js.map +1 -0
- package/dist/commands/schema/list.d.ts +15 -0
- package/dist/commands/schema/list.js +104 -0
- package/dist/commands/schema/list.js.map +1 -0
- package/dist/commands/telemetry/__tests__/disable.test.js +7 -5
- package/dist/commands/telemetry/__tests__/disable.test.js.map +1 -1
- package/dist/commands/telemetry/__tests__/enable.test.js +7 -5
- package/dist/commands/telemetry/__tests__/enable.test.js.map +1 -1
- package/dist/commands/telemetry/__tests__/status.test.js +7 -5
- package/dist/commands/telemetry/__tests__/status.test.js.map +1 -1
- package/dist/commands/tokens/__tests__/add.test.js +55 -40
- package/dist/commands/tokens/__tests__/add.test.js.map +1 -1
- package/dist/commands/tokens/__tests__/delete.test.js +72 -42
- package/dist/commands/tokens/__tests__/delete.test.js.map +1 -1
- package/dist/commands/tokens/__tests__/list.test.js +87 -60
- package/dist/commands/tokens/__tests__/list.test.js.map +1 -1
- package/dist/commands/tokens/add.js +3 -5
- package/dist/commands/tokens/add.js.map +1 -1
- package/dist/commands/users/__tests__/invite.test.js +100 -79
- package/dist/commands/users/__tests__/invite.test.js.map +1 -1
- package/dist/commands/users/__tests__/list.test.js +186 -180
- package/dist/commands/users/__tests__/list.test.js.map +1 -1
- package/dist/commands/users/invite.js +6 -17
- package/dist/commands/users/invite.js.map +1 -1
- package/dist/commands/users/list.js +4 -7
- package/dist/commands/users/list.js.map +1 -1
- package/dist/config/createCliConfig.d.ts +4 -4
- package/dist/services/backup.d.ts +8 -0
- package/dist/services/backup.js +19 -0
- package/dist/services/backup.js.map +1 -1
- package/dist/services/cors.d.ts +23 -0
- package/dist/services/cors.js +38 -0
- package/dist/services/cors.js.map +1 -0
- package/dist/services/graphql.d.ts +7 -0
- package/dist/services/graphql.js +11 -0
- package/dist/services/graphql.js.map +1 -1
- package/dist/services/hooks.d.ts +2 -0
- package/dist/services/hooks.js +19 -0
- package/dist/services/hooks.js.map +1 -1
- package/dist/services/organizations.d.ts +1 -1
- package/dist/services/organizations.js +1 -1
- package/dist/services/organizations.js.map +1 -1
- package/dist/services/projects.d.ts +11 -0
- package/dist/services/projects.js +41 -0
- package/dist/services/projects.js.map +1 -1
- package/dist/services/schemas.d.ts +4 -0
- package/dist/services/schemas.js +40 -0
- package/dist/services/schemas.js.map +1 -0
- package/dist/services/user.d.ts +8 -0
- package/dist/services/user.js +15 -2
- package/dist/services/user.js.map +1 -1
- package/dist/util/__tests__/getCliVersion.test.js +2 -2
- package/dist/util/__tests__/getCliVersion.test.js.map +1 -1
- package/dist/util/errorMessages.d.ts +1 -0
- package/dist/util/errorMessages.js +1 -0
- package/dist/util/errorMessages.js.map +1 -1
- package/dist/util/getCliVersion.js +1 -1
- package/dist/util/getCliVersion.js.map +1 -1
- package/dist/util/readPackageJson.d.ts +1 -15
- package/dist/util/readPackageJson.js +1 -1
- package/dist/util/readPackageJson.js.map +1 -1
- package/dist/util/uniqBy.d.ts +1 -0
- package/dist/util/uniqBy.js +14 -0
- package/dist/util/uniqBy.js.map +1 -0
- package/oclif.manifest.json +172 -27
- package/package.json +27 -28
- package/dist/actions/cors/constants.d.ts +0 -1
- package/dist/actions/cors/constants.js +0 -3
- package/dist/actions/cors/constants.js.map +0 -1
- package/dist/actions/cors/types.d.ts +0 -9
- package/dist/actions/cors/types.js +0 -3
- package/dist/actions/cors/types.js.map +0 -1
- package/dist/actions/schema/__tests__/deleteSchemaAction.test.js +0 -294
- package/dist/actions/schema/__tests__/deleteSchemaAction.test.js.map +0 -1
- package/dist/actions/schema/schemaStoreConstants.d.ts +0 -1
- package/dist/actions/schema/schemaStoreConstants.js +0 -4
- package/dist/actions/schema/schemaStoreConstants.js.map +0 -1
- package/dist/actions/schema/utils/schemaActionHelpers.d.ts +0 -1
- package/dist/actions/schema/utils/schemaActionHelpers.js +0 -5
- package/dist/actions/schema/utils/schemaActionHelpers.js.map +0 -1
- package/dist/actions/schema/utils/schemaApiClient.d.ts +0 -6
- package/dist/actions/schema/utils/schemaApiClient.js +0 -17
- package/dist/actions/schema/utils/schemaApiClient.js.map +0 -1
- package/dist/actions/users/apiVersion.d.ts +0 -6
- package/dist/actions/users/apiVersion.js +0 -7
- package/dist/actions/users/apiVersion.js.map +0 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../../src/commands/documents/__tests__/validate.test.ts"],"sourcesContent":["import {runCommand} from '@oclif/test'\nimport {testCommand} from '@sanity/cli-test'\nimport {afterEach, beforeEach, describe, expect, test, vi} from 'vitest'\n\nimport {ValidateDocumentsCommand} from '../validate.js'\n\nconst mocks = vi.hoisted(() => ({\n confirm: vi.fn(),\n isFile: vi.fn(),\n validate: vi.fn(),\n}))\n\nvi.mock('node:fs', () => ({\n default: {\n promises: {\n stat: vi.fn().mockResolvedValue({\n isFile: mocks.isFile,\n }),\n },\n resolve: vi.fn((dir, file) => `/resolved/${file}`),\n },\n}))\n\nvi.mock('@sanity/cli-core/ux', async () => {\n const actual = await vi.importActual<typeof import('@sanity/cli-core/ux')>('@sanity/cli-core/ux')\n return {\n ...actual,\n confirm: mocks.confirm,\n }\n})\n\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(),\n}))\n\nvi.mock('../../../../../cli-core/src/services/apiClient.js', () => ({\n getGlobalCliClient: vi.fn().mockResolvedValue({\n config: vi.fn(() => ({\n dataset: 'test-dataset',\n projectId: 'test-project',\n })),\n }),\n}))\n\nvi.mock('../../../actions/documents/validate.js', () => ({\n validateDocuments: mocks.validate,\n}))\n\nconst mockConfirm = mocks.confirm\nconst mockIsFile = mocks.isFile\nconst mockValidate = mocks.validate\n\ndescribe('#documents:validate', () => {\n afterEach(() => {\n vi.clearAllMocks()\n })\n beforeEach(() => {\n mockConfirm.mockResolvedValue(true)\n mockIsFile.mockReturnValue(true)\n })\n\n test('--help works', async () => {\n const {stdout} = await runCommand(['documents validate', '--help'])\n\n expect(stdout).toMatchInlineSnapshot(`\n \"Validate documents in a dataset against the studio schema\n\n USAGE\n $ sanity documents validate [-d <value>] [--file <value>] [--format <value>]\n [--level error|warning|info] [--max-custom-validation-concurrency <value>]\n [--max-fetch-concurrency <value>] [--workspace <value>] [-y]\n\n FLAGS\n -d, --dataset=<value> Override the dataset used. By\n default, this is derived from\n the given workspace\n -y, --yes Skips the first confirmation\n prompt\n --file=<value> Provide a path to either an\n .ndjson file or a tarball\n containing an .ndjson file\n --format=<value> The output format used to\n print the found validation\n markers and report progress\n --level=<option> [default: warning] The\n minimum level reported out.\n Defaults to warning\n <options: error|warning|info>\n --max-custom-validation-concurrency=<value> [default: 5] Specify how many\n custom validators can run\n concurrently\n --max-fetch-concurrency=<value> [default: 25] Specify how\n many \\`client.fetch\\` requests\n are allow concurrency at once\n --workspace=<value> The name of the workspace to\n use when downloading and\n validating all documents\n\n DESCRIPTION\n Validate documents in a dataset against the studio schema\n\n EXAMPLES\n Validates all documents in a Sanity project with more than one workspace\n\n $ sanity documents validate --workspace default\n\n Override the dataset specified in the workspace\n\n $ sanity documents validate --workspace default --dataset staging\n\n Save the results of the report into a file\n\n $ sanity documents validate --yes > report.txt\n\n Report out info level validation markers too\n\n $ sanity documents validate --level info\n\n \"\n `)\n })\n\n test('throws error if user enters unsupported level flag', async () => {\n const {error} = await testCommand(ValidateDocumentsCommand, ['--level', 'critical'])\n\n expect(error?.message).toContain('Expected --level=critical to be one of: error, warning, info')\n })\n\n test('throws error if user enters non integer max-custom-validation-concurrency flag', async () => {\n const {error} = await testCommand(ValidateDocumentsCommand, [\n '--max-custom-validation-concurrency',\n 'abc',\n ])\n\n expect(error?.message).toContain('Expected an integer but received: abc')\n })\n\n test('throws error if user enters non integer max-fetch-concurrency flag', async () => {\n const {error} = await testCommand(ValidateDocumentsCommand, ['--max-fetch-concurrency', 'xyz'])\n\n expect(error?.message).toContain('Expected an integer but received: xyz')\n })\n\n test('prompts user to confirm by default and exits if they do not want to continue', async () => {\n mockConfirm.mockResolvedValue(false)\n\n const {stdout} = await testCommand(ValidateDocumentsCommand, [])\n\n expect(stdout).toMatchInlineSnapshot(`\n \"⚠ Warning: This command downloads all documents from your dataset and processes them through your local schema within a simulated browser environment.\n\n Potential pitfalls:\n\n - Processes all documents locally (excluding assets). Large datasets may require more resources.\n - Executes all custom validation functions. Some functions may need to be refactored for compatibility.\n - Not all standard browser features are available and may cause issues while loading your Studio.\n - Adheres to document permissions. Ensure this account can see all desired documents.\n User aborted\n \"\n `)\n expect(mockConfirm).toHaveBeenCalledWith({\n default: true,\n message: expect.stringContaining('Are you sure you want to continue?'),\n })\n expect(mockConfirm).toHaveBeenCalled()\n })\n\n test('skips confirm if user uses yes flag', async () => {\n await testCommand(ValidateDocumentsCommand, ['--y'])\n\n expect(mockConfirm).not.toHaveBeenCalled()\n })\n\n test('exits if format is incorrect value', async () => {\n const {error} = await testCommand(ValidateDocumentsCommand, ['--format', 'xml'])\n\n expect(error?.message).toContain(\n \"Did not recognize format 'xml'. Available formats are 'json', 'ndjson', and 'pretty'\",\n )\n })\n\n test('exits if user inputs invalid file path in flag', async () => {\n mockIsFile.mockReturnValue(false)\n\n const {error} = await testCommand(ValidateDocumentsCommand, [\n '--file',\n '/non/existent/file.ndjson',\n ])\n\n expect(error?.message).toContain(\"'--file' must point to a valid ndjson file or tarball\")\n })\n\n test('validateDocuments is called with the correct params', async () => {\n mockValidate.mockResolvedValue('warning')\n\n await testCommand(ValidateDocumentsCommand, [\n '--yes',\n '--dataset',\n 'my-dataset',\n '--workspace',\n 'my-workspace',\n '--level',\n 'info',\n '--max-custom-validation-concurrency',\n '10',\n '--max-fetch-concurrency',\n '50',\n '--file',\n '/path/to/file.ndjson',\n ])\n\n expect(mockValidate).toHaveBeenCalledWith({\n clientConfig: expect.any(Object),\n dataset: 'my-dataset',\n level: 'info',\n maxCustomValidationConcurrency: 10,\n maxFetchConcurrency: 50,\n ndjsonFilePath: expect.stringContaining('file.ndjson'),\n reporter: expect.any(Function),\n studioHost: undefined,\n workDir: '/test/path',\n workspace: 'my-workspace',\n })\n })\n\n test('exits with code 1 if validateDocuments returns overall level as error', async () => {\n mockValidate.mockResolvedValue('error')\n\n const {error} = await testCommand(ValidateDocumentsCommand, [])\n\n expect(error?.oclif?.exit).toBe(1)\n })\n\n test('exits with code 0 if validateDocuments does not return overall level as error', async () => {\n mockValidate.mockResolvedValue('warning')\n\n const {error} = await testCommand(ValidateDocumentsCommand, [])\n\n expect(error).toBe(undefined)\n })\n})\n"],"names":["runCommand","testCommand","afterEach","beforeEach","describe","expect","test","vi","ValidateDocumentsCommand","mocks","hoisted","confirm","fn","isFile","validate","mock","default","promises","stat","mockResolvedValue","resolve","dir","file","actual","importActual","findProjectRoot","directory","root","type","getCliConfig","getGlobalCliClient","config","dataset","projectId","validateDocuments","mockConfirm","mockIsFile","mockValidate","clearAllMocks","mockReturnValue","stdout","toMatchInlineSnapshot","error","message","toContain","toHaveBeenCalledWith","stringContaining","toHaveBeenCalled","not","clientConfig","any","Object","level","maxCustomValidationConcurrency","maxFetchConcurrency","ndjsonFilePath","reporter","Function","studioHost","undefined","workDir","workspace","oclif","exit","toBe"],"mappings":"AAAA,SAAQA,UAAU,QAAO,cAAa;AACtC,SAAQC,WAAW,QAAO,mBAAkB;AAC5C,SAAQC,SAAS,EAAEC,UAAU,EAAEC,QAAQ,EAAEC,MAAM,EAAEC,IAAI,EAAEC,EAAE,QAAO,SAAQ;AAExE,SAAQC,wBAAwB,QAAO,iBAAgB;AAEvD,MAAMC,QAAQF,GAAGG,OAAO,CAAC,IAAO,CAAA;QAC9BC,SAASJ,GAAGK,EAAE;QACdC,QAAQN,GAAGK,EAAE;QACbE,UAAUP,GAAGK,EAAE;IACjB,CAAA;AAEAL,GAAGQ,IAAI,CAAC,WAAW,IAAO,CAAA;QACxBC,SAAS;YACPC,UAAU;gBACRC,MAAMX,GAAGK,EAAE,GAAGO,iBAAiB,CAAC;oBAC9BN,QAAQJ,MAAMI,MAAM;gBACtB;YACF;YACAO,SAASb,GAAGK,EAAE,CAAC,CAACS,KAAKC,OAAS,CAAC,UAAU,EAAEA,MAAM;QACnD;IACF,CAAA;AAEAf,GAAGQ,IAAI,CAAC,uBAAuB;IAC7B,MAAMQ,SAAS,MAAMhB,GAAGiB,YAAY,CAAuC;IAC3E,OAAO;QACL,GAAGD,MAAM;QACTZ,SAASF,MAAME,OAAO;IACxB;AACF;AAEAJ,GAAGQ,IAAI,CAAC,yDAAyD,IAAO,CAAA;QACtEU,iBAAiBlB,GAAGK,EAAE,GAAGO,iBAAiB,CAAC;YACzCO,WAAW;YACXC,MAAM;YACNC,MAAM;QACR;IACF,CAAA;AAEArB,GAAGQ,IAAI,CAAC,0DAA0D,IAAO,CAAA;QACvEc,cAActB,GAAGK,EAAE;IACrB,CAAA;AAEAL,GAAGQ,IAAI,CAAC,qDAAqD,IAAO,CAAA;QAClEe,oBAAoBvB,GAAGK,EAAE,GAAGO,iBAAiB,CAAC;YAC5CY,QAAQxB,GAAGK,EAAE,CAAC,IAAO,CAAA;oBACnBoB,SAAS;oBACTC,WAAW;gBACb,CAAA;QACF;IACF,CAAA;AAEA1B,GAAGQ,IAAI,CAAC,0CAA0C,IAAO,CAAA;QACvDmB,mBAAmBzB,MAAMK,QAAQ;IACnC,CAAA;AAEA,MAAMqB,cAAc1B,MAAME,OAAO;AACjC,MAAMyB,aAAa3B,MAAMI,MAAM;AAC/B,MAAMwB,eAAe5B,MAAMK,QAAQ;AAEnCV,SAAS,uBAAuB;IAC9BF,UAAU;QACRK,GAAG+B,aAAa;IAClB;IACAnC,WAAW;QACTgC,YAAYhB,iBAAiB,CAAC;QAC9BiB,WAAWG,eAAe,CAAC;IAC7B;IAEAjC,KAAK,gBAAgB;QACnB,MAAM,EAACkC,MAAM,EAAC,GAAG,MAAMxC,WAAW;YAAC;YAAsB;SAAS;QAElEK,OAAOmC,QAAQC,qBAAqB,CAAC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAuDtC,CAAC;IACH;IAEAnC,KAAK,sDAAsD;QACzD,MAAM,EAACoC,KAAK,EAAC,GAAG,MAAMzC,YAAYO,0BAA0B;YAAC;YAAW;SAAW;QAEnFH,OAAOqC,OAAOC,SAASC,SAAS,CAAC;IACnC;IAEAtC,KAAK,kFAAkF;QACrF,MAAM,EAACoC,KAAK,EAAC,GAAG,MAAMzC,YAAYO,0BAA0B;YAC1D;YACA;SACD;QAEDH,OAAOqC,OAAOC,SAASC,SAAS,CAAC;IACnC;IAEAtC,KAAK,sEAAsE;QACzE,MAAM,EAACoC,KAAK,EAAC,GAAG,MAAMzC,YAAYO,0BAA0B;YAAC;YAA2B;SAAM;QAE9FH,OAAOqC,OAAOC,SAASC,SAAS,CAAC;IACnC;IAEAtC,KAAK,gFAAgF;QACnF6B,YAAYhB,iBAAiB,CAAC;QAE9B,MAAM,EAACqB,MAAM,EAAC,GAAG,MAAMvC,YAAYO,0BAA0B,EAAE;QAE/DH,OAAOmC,QAAQC,qBAAqB,CAAC,CAAC;;;;;;;;;;;IAWtC,CAAC;QACDpC,OAAO8B,aAAaU,oBAAoB,CAAC;YACvC7B,SAAS;YACT2B,SAAStC,OAAOyC,gBAAgB,CAAC;QACnC;QACAzC,OAAO8B,aAAaY,gBAAgB;IACtC;IAEAzC,KAAK,uCAAuC;QAC1C,MAAML,YAAYO,0BAA0B;YAAC;SAAM;QAEnDH,OAAO8B,aAAaa,GAAG,CAACD,gBAAgB;IAC1C;IAEAzC,KAAK,sCAAsC;QACzC,MAAM,EAACoC,KAAK,EAAC,GAAG,MAAMzC,YAAYO,0BAA0B;YAAC;YAAY;SAAM;QAE/EH,OAAOqC,OAAOC,SAASC,SAAS,CAC9B;IAEJ;IAEAtC,KAAK,kDAAkD;QACrD8B,WAAWG,eAAe,CAAC;QAE3B,MAAM,EAACG,KAAK,EAAC,GAAG,MAAMzC,YAAYO,0BAA0B;YAC1D;YACA;SACD;QAEDH,OAAOqC,OAAOC,SAASC,SAAS,CAAC;IACnC;IAEAtC,KAAK,uDAAuD;QAC1D+B,aAAalB,iBAAiB,CAAC;QAE/B,MAAMlB,YAAYO,0BAA0B;YAC1C;YACA;YACA;YACA;YACA;YACA;YACA;YACA;YACA;YACA;YACA;YACA;YACA;SACD;QAEDH,OAAOgC,cAAcQ,oBAAoB,CAAC;YACxCI,cAAc5C,OAAO6C,GAAG,CAACC;YACzBnB,SAAS;YACToB,OAAO;YACPC,gCAAgC;YAChCC,qBAAqB;YACrBC,gBAAgBlD,OAAOyC,gBAAgB,CAAC;YACxCU,UAAUnD,OAAO6C,GAAG,CAACO;YACrBC,YAAYC;YACZC,SAAS;YACTC,WAAW;QACb;IACF;IAEAvD,KAAK,yEAAyE;QAC5E+B,aAAalB,iBAAiB,CAAC;QAE/B,MAAM,EAACuB,KAAK,EAAC,GAAG,MAAMzC,YAAYO,0BAA0B,EAAE;QAE9DH,OAAOqC,OAAOoB,OAAOC,MAAMC,IAAI,CAAC;IAClC;IAEA1D,KAAK,iFAAiF;QACpF+B,aAAalB,iBAAiB,CAAC;QAE/B,MAAM,EAACuB,KAAK,EAAC,GAAG,MAAMzC,YAAYO,0BAA0B,EAAE;QAE9DH,OAAOqC,OAAOsB,IAAI,CAACL;IACrB;AACF"}
|
|
1
|
+
{"version":3,"sources":["../../../../src/commands/documents/__tests__/validate.test.ts"],"sourcesContent":["import {runCommand} from '@oclif/test'\nimport {testCommand} from '@sanity/cli-test'\nimport {afterEach, beforeEach, describe, expect, test, vi} from 'vitest'\n\nimport {ValidateDocumentsCommand} from '../validate.js'\n\nconst mocks = vi.hoisted(() => ({\n confirm: vi.fn(),\n isFile: vi.fn(),\n validate: vi.fn(),\n}))\n\nvi.mock('node:fs', () => ({\n default: {\n promises: {\n stat: vi.fn().mockResolvedValue({\n isFile: mocks.isFile,\n }),\n },\n resolve: vi.fn((dir, file) => `/resolved/${file}`),\n },\n}))\n\nvi.mock('@sanity/cli-core/ux', async () => {\n const actual = await vi.importActual<typeof import('@sanity/cli-core/ux')>('@sanity/cli-core/ux')\n return {\n ...actual,\n confirm: mocks.confirm,\n }\n})\n\nvi.mock('../../../actions/documents/validate.js', () => ({\n validateDocuments: mocks.validate,\n}))\n\nconst mockConfirm = mocks.confirm\nconst mockIsFile = mocks.isFile\nconst mockValidate = mocks.validate\n\nconst testProjectId = 'test-project'\nconst testDataset = 'test-dataset'\n\nconst defaultMocks = {\n cliConfig: {api: {dataset: testDataset, projectId: testProjectId}},\n globalApiClient: {\n config: vi.fn(() => ({\n dataset: testDataset,\n projectId: testProjectId,\n })),\n } as never,\n projectRoot: {\n directory: '/test/path',\n path: '/test/path/sanity.config.ts',\n type: 'studio' as const,\n },\n token: 'test-token',\n}\n\ndescribe('#documents:validate', () => {\n afterEach(() => {\n vi.clearAllMocks()\n })\n beforeEach(() => {\n mockConfirm.mockResolvedValue(true)\n mockIsFile.mockReturnValue(true)\n })\n\n test('--help works', async () => {\n const {stdout} = await runCommand(['documents validate', '--help'])\n\n expect(stdout).toMatchInlineSnapshot(`\n \"Validate documents in a dataset against the studio schema\n\n USAGE\n $ sanity documents validate [-d <value>] [--file <value>] [--format <value>]\n [--level error|warning|info] [--max-custom-validation-concurrency <value>]\n [--max-fetch-concurrency <value>] [--workspace <value>] [-y]\n\n FLAGS\n -d, --dataset=<value> Override the dataset used. By\n default, this is derived from\n the given workspace\n -y, --yes Skips the first confirmation\n prompt\n --file=<value> Provide a path to either an\n .ndjson file or a tarball\n containing an .ndjson file\n --format=<value> The output format used to\n print the found validation\n markers and report progress\n --level=<option> [default: warning] The\n minimum level reported out.\n Defaults to warning\n <options: error|warning|info>\n --max-custom-validation-concurrency=<value> [default: 5] Specify how many\n custom validators can run\n concurrently\n --max-fetch-concurrency=<value> [default: 25] Specify how\n many \\`client.fetch\\` requests\n are allow concurrency at once\n --workspace=<value> The name of the workspace to\n use when downloading and\n validating all documents\n\n DESCRIPTION\n Validate documents in a dataset against the studio schema\n\n EXAMPLES\n Validates all documents in a Sanity project with more than one workspace\n\n $ sanity documents validate --workspace default\n\n Override the dataset specified in the workspace\n\n $ sanity documents validate --workspace default --dataset staging\n\n Save the results of the report into a file\n\n $ sanity documents validate --yes > report.txt\n\n Report out info level validation markers too\n\n $ sanity documents validate --level info\n\n \"\n `)\n })\n\n test('throws error if user enters unsupported level flag', async () => {\n const {error} = await testCommand(ValidateDocumentsCommand, ['--level', 'critical'], {\n mocks: defaultMocks,\n })\n\n expect(error?.message).toContain('Expected --level=critical to be one of: error, warning, info')\n })\n\n test('throws error if user enters non integer max-custom-validation-concurrency flag', async () => {\n const {error} = await testCommand(\n ValidateDocumentsCommand,\n ['--max-custom-validation-concurrency', 'abc'],\n {mocks: defaultMocks},\n )\n\n expect(error?.message).toContain('Expected an integer but received: abc')\n })\n\n test('throws error if user enters non integer max-fetch-concurrency flag', async () => {\n const {error} = await testCommand(\n ValidateDocumentsCommand,\n ['--max-fetch-concurrency', 'xyz'],\n {mocks: defaultMocks},\n )\n\n expect(error?.message).toContain('Expected an integer but received: xyz')\n })\n\n test('prompts user to confirm by default and exits if they do not want to continue', async () => {\n mockConfirm.mockResolvedValue(false)\n\n const {stdout} = await testCommand(ValidateDocumentsCommand, [], {mocks: defaultMocks})\n\n expect(stdout).toMatchInlineSnapshot(`\n \"⚠ Warning: This command downloads all documents from your dataset and processes them through your local schema within a simulated browser environment.\n\n Potential pitfalls:\n\n - Processes all documents locally (excluding assets). Large datasets may require more resources.\n - Executes all custom validation functions. Some functions may need to be refactored for compatibility.\n - Not all standard browser features are available and may cause issues while loading your Studio.\n - Adheres to document permissions. Ensure this account can see all desired documents.\n User aborted\n \"\n `)\n expect(mockConfirm).toHaveBeenCalledWith({\n default: true,\n message: expect.stringContaining('Are you sure you want to continue?'),\n })\n expect(mockConfirm).toHaveBeenCalled()\n })\n\n test('skips confirm if user uses yes flag', async () => {\n await testCommand(ValidateDocumentsCommand, ['--y'], {mocks: defaultMocks})\n\n expect(mockConfirm).not.toHaveBeenCalled()\n })\n\n test('exits if format is incorrect value', async () => {\n const {error} = await testCommand(ValidateDocumentsCommand, ['--format', 'xml'], {\n mocks: defaultMocks,\n })\n\n expect(error?.message).toContain(\n \"Did not recognize format 'xml'. Available formats are 'json', 'ndjson', and 'pretty'\",\n )\n })\n\n test('exits if user inputs invalid file path in flag', async () => {\n mockIsFile.mockReturnValue(false)\n\n const {error} = await testCommand(\n ValidateDocumentsCommand,\n ['--file', '/non/existent/file.ndjson'],\n {mocks: defaultMocks},\n )\n\n expect(error?.message).toContain(\"'--file' must point to a valid ndjson file or tarball\")\n })\n\n test('validateDocuments is called with the correct params', async () => {\n mockValidate.mockResolvedValue('warning')\n\n await testCommand(\n ValidateDocumentsCommand,\n [\n '--yes',\n '--dataset',\n 'my-dataset',\n '--workspace',\n 'my-workspace',\n '--level',\n 'info',\n '--max-custom-validation-concurrency',\n '10',\n '--max-fetch-concurrency',\n '50',\n '--file',\n '/path/to/file.ndjson',\n ],\n {mocks: defaultMocks},\n )\n\n expect(mockValidate).toHaveBeenCalledWith({\n dataset: 'my-dataset',\n level: 'info',\n maxCustomValidationConcurrency: 10,\n maxFetchConcurrency: 50,\n ndjsonFilePath: expect.stringContaining('file.ndjson'),\n reporter: expect.any(Function),\n studioHost: undefined,\n workDir: '/test/path',\n workspace: 'my-workspace',\n })\n })\n\n test('exits with code 1 if validateDocuments returns overall level as error', async () => {\n mockValidate.mockResolvedValue('error')\n\n const {error} = await testCommand(ValidateDocumentsCommand, [], {mocks: defaultMocks})\n\n expect(error?.oclif?.exit).toBe(1)\n })\n\n test('exits with code 0 if validateDocuments does not return overall level as error', async () => {\n mockValidate.mockResolvedValue('warning')\n\n const {error} = await testCommand(ValidateDocumentsCommand, [], {mocks: defaultMocks})\n\n expect(error).toBe(undefined)\n })\n})\n"],"names":["runCommand","testCommand","afterEach","beforeEach","describe","expect","test","vi","ValidateDocumentsCommand","mocks","hoisted","confirm","fn","isFile","validate","mock","default","promises","stat","mockResolvedValue","resolve","dir","file","actual","importActual","validateDocuments","mockConfirm","mockIsFile","mockValidate","testProjectId","testDataset","defaultMocks","cliConfig","api","dataset","projectId","globalApiClient","config","projectRoot","directory","path","type","token","clearAllMocks","mockReturnValue","stdout","toMatchInlineSnapshot","error","message","toContain","toHaveBeenCalledWith","stringContaining","toHaveBeenCalled","not","level","maxCustomValidationConcurrency","maxFetchConcurrency","ndjsonFilePath","reporter","any","Function","studioHost","undefined","workDir","workspace","oclif","exit","toBe"],"mappings":"AAAA,SAAQA,UAAU,QAAO,cAAa;AACtC,SAAQC,WAAW,QAAO,mBAAkB;AAC5C,SAAQC,SAAS,EAAEC,UAAU,EAAEC,QAAQ,EAAEC,MAAM,EAAEC,IAAI,EAAEC,EAAE,QAAO,SAAQ;AAExE,SAAQC,wBAAwB,QAAO,iBAAgB;AAEvD,MAAMC,QAAQF,GAAGG,OAAO,CAAC,IAAO,CAAA;QAC9BC,SAASJ,GAAGK,EAAE;QACdC,QAAQN,GAAGK,EAAE;QACbE,UAAUP,GAAGK,EAAE;IACjB,CAAA;AAEAL,GAAGQ,IAAI,CAAC,WAAW,IAAO,CAAA;QACxBC,SAAS;YACPC,UAAU;gBACRC,MAAMX,GAAGK,EAAE,GAAGO,iBAAiB,CAAC;oBAC9BN,QAAQJ,MAAMI,MAAM;gBACtB;YACF;YACAO,SAASb,GAAGK,EAAE,CAAC,CAACS,KAAKC,OAAS,CAAC,UAAU,EAAEA,MAAM;QACnD;IACF,CAAA;AAEAf,GAAGQ,IAAI,CAAC,uBAAuB;IAC7B,MAAMQ,SAAS,MAAMhB,GAAGiB,YAAY,CAAuC;IAC3E,OAAO;QACL,GAAGD,MAAM;QACTZ,SAASF,MAAME,OAAO;IACxB;AACF;AAEAJ,GAAGQ,IAAI,CAAC,0CAA0C,IAAO,CAAA;QACvDU,mBAAmBhB,MAAMK,QAAQ;IACnC,CAAA;AAEA,MAAMY,cAAcjB,MAAME,OAAO;AACjC,MAAMgB,aAAalB,MAAMI,MAAM;AAC/B,MAAMe,eAAenB,MAAMK,QAAQ;AAEnC,MAAMe,gBAAgB;AACtB,MAAMC,cAAc;AAEpB,MAAMC,eAAe;IACnBC,WAAW;QAACC,KAAK;YAACC,SAASJ;YAAaK,WAAWN;QAAa;IAAC;IACjEO,iBAAiB;QACfC,QAAQ9B,GAAGK,EAAE,CAAC,IAAO,CAAA;gBACnBsB,SAASJ;gBACTK,WAAWN;YACb,CAAA;IACF;IACAS,aAAa;QACXC,WAAW;QACXC,MAAM;QACNC,MAAM;IACR;IACAC,OAAO;AACT;AAEAtC,SAAS,uBAAuB;IAC9BF,UAAU;QACRK,GAAGoC,aAAa;IAClB;IACAxC,WAAW;QACTuB,YAAYP,iBAAiB,CAAC;QAC9BQ,WAAWiB,eAAe,CAAC;IAC7B;IAEAtC,KAAK,gBAAgB;QACnB,MAAM,EAACuC,MAAM,EAAC,GAAG,MAAM7C,WAAW;YAAC;YAAsB;SAAS;QAElEK,OAAOwC,QAAQC,qBAAqB,CAAC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAuDtC,CAAC;IACH;IAEAxC,KAAK,sDAAsD;QACzD,MAAM,EAACyC,KAAK,EAAC,GAAG,MAAM9C,YAAYO,0BAA0B;YAAC;YAAW;SAAW,EAAE;YACnFC,OAAOsB;QACT;QAEA1B,OAAO0C,OAAOC,SAASC,SAAS,CAAC;IACnC;IAEA3C,KAAK,kFAAkF;QACrF,MAAM,EAACyC,KAAK,EAAC,GAAG,MAAM9C,YACpBO,0BACA;YAAC;YAAuC;SAAM,EAC9C;YAACC,OAAOsB;QAAY;QAGtB1B,OAAO0C,OAAOC,SAASC,SAAS,CAAC;IACnC;IAEA3C,KAAK,sEAAsE;QACzE,MAAM,EAACyC,KAAK,EAAC,GAAG,MAAM9C,YACpBO,0BACA;YAAC;YAA2B;SAAM,EAClC;YAACC,OAAOsB;QAAY;QAGtB1B,OAAO0C,OAAOC,SAASC,SAAS,CAAC;IACnC;IAEA3C,KAAK,gFAAgF;QACnFoB,YAAYP,iBAAiB,CAAC;QAE9B,MAAM,EAAC0B,MAAM,EAAC,GAAG,MAAM5C,YAAYO,0BAA0B,EAAE,EAAE;YAACC,OAAOsB;QAAY;QAErF1B,OAAOwC,QAAQC,qBAAqB,CAAC,CAAC;;;;;;;;;;;IAWtC,CAAC;QACDzC,OAAOqB,aAAawB,oBAAoB,CAAC;YACvClC,SAAS;YACTgC,SAAS3C,OAAO8C,gBAAgB,CAAC;QACnC;QACA9C,OAAOqB,aAAa0B,gBAAgB;IACtC;IAEA9C,KAAK,uCAAuC;QAC1C,MAAML,YAAYO,0BAA0B;YAAC;SAAM,EAAE;YAACC,OAAOsB;QAAY;QAEzE1B,OAAOqB,aAAa2B,GAAG,CAACD,gBAAgB;IAC1C;IAEA9C,KAAK,sCAAsC;QACzC,MAAM,EAACyC,KAAK,EAAC,GAAG,MAAM9C,YAAYO,0BAA0B;YAAC;YAAY;SAAM,EAAE;YAC/EC,OAAOsB;QACT;QAEA1B,OAAO0C,OAAOC,SAASC,SAAS,CAC9B;IAEJ;IAEA3C,KAAK,kDAAkD;QACrDqB,WAAWiB,eAAe,CAAC;QAE3B,MAAM,EAACG,KAAK,EAAC,GAAG,MAAM9C,YACpBO,0BACA;YAAC;YAAU;SAA4B,EACvC;YAACC,OAAOsB;QAAY;QAGtB1B,OAAO0C,OAAOC,SAASC,SAAS,CAAC;IACnC;IAEA3C,KAAK,uDAAuD;QAC1DsB,aAAaT,iBAAiB,CAAC;QAE/B,MAAMlB,YACJO,0BACA;YACE;YACA;YACA;YACA;YACA;YACA;YACA;YACA;YACA;YACA;YACA;YACA;YACA;SACD,EACD;YAACC,OAAOsB;QAAY;QAGtB1B,OAAOuB,cAAcsB,oBAAoB,CAAC;YACxChB,SAAS;YACToB,OAAO;YACPC,gCAAgC;YAChCC,qBAAqB;YACrBC,gBAAgBpD,OAAO8C,gBAAgB,CAAC;YACxCO,UAAUrD,OAAOsD,GAAG,CAACC;YACrBC,YAAYC;YACZC,SAAS;YACTC,WAAW;QACb;IACF;IAEA1D,KAAK,yEAAyE;QAC5EsB,aAAaT,iBAAiB,CAAC;QAE/B,MAAM,EAAC4B,KAAK,EAAC,GAAG,MAAM9C,YAAYO,0BAA0B,EAAE,EAAE;YAACC,OAAOsB;QAAY;QAEpF1B,OAAO0C,OAAOkB,OAAOC,MAAMC,IAAI,CAAC;IAClC;IAEA7D,KAAK,iFAAiF;QACpFsB,aAAaT,iBAAiB,CAAC;QAE/B,MAAM,EAAC4B,KAAK,EAAC,GAAG,MAAM9C,YAAYO,0BAA0B,EAAE,EAAE;YAACC,OAAOsB;QAAY;QAEpF1B,OAAO0C,OAAOoB,IAAI,CAACL;IACrB;AACF"}
|
|
@@ -17,6 +17,7 @@ export declare class CreateDocumentCommand extends SanityCommand<typeof CreateDo
|
|
|
17
17
|
replace: import("@oclif/core/interfaces").BooleanFlag<boolean>;
|
|
18
18
|
watch: import("@oclif/core/interfaces").BooleanFlag<boolean>;
|
|
19
19
|
};
|
|
20
|
+
private client;
|
|
20
21
|
run(): Promise<void>;
|
|
21
22
|
private getErrorMessage;
|
|
22
23
|
/**
|
|
@@ -3,7 +3,7 @@ import fs from 'node:fs/promises';
|
|
|
3
3
|
import os from 'node:os';
|
|
4
4
|
import path from 'node:path';
|
|
5
5
|
import { Args, Flags } from '@oclif/core';
|
|
6
|
-
import { SanityCommand, subdebug } from '@sanity/cli-core';
|
|
6
|
+
import { getProjectCliClient, SanityCommand, subdebug } from '@sanity/cli-core';
|
|
7
7
|
import { watch as chokidarWatch } from 'chokidar';
|
|
8
8
|
import { execa, execaSync } from 'execa';
|
|
9
9
|
import json5 from 'json5';
|
|
@@ -60,6 +60,7 @@ export class CreateDocumentCommand extends SanityCommand {
|
|
|
60
60
|
description: 'Write the documents whenever the target file or buffer changes'
|
|
61
61
|
})
|
|
62
62
|
};
|
|
63
|
+
client;
|
|
63
64
|
async run() {
|
|
64
65
|
const { args, flags } = await this.parse(CreateDocumentCommand);
|
|
65
66
|
const { file } = args;
|
|
@@ -77,7 +78,7 @@ export class CreateDocumentCommand extends SanityCommand {
|
|
|
77
78
|
});
|
|
78
79
|
}
|
|
79
80
|
const targetDataset = dataset || cliConfig.api?.dataset;
|
|
80
|
-
|
|
81
|
+
this.client = await getProjectCliClient({
|
|
81
82
|
apiVersion: DOCUMENTS_API_VERSION,
|
|
82
83
|
dataset: targetDataset,
|
|
83
84
|
projectId,
|
|
@@ -101,7 +102,7 @@ export class CreateDocumentCommand extends SanityCommand {
|
|
|
101
102
|
try {
|
|
102
103
|
const contentPath = path.resolve(process.cwd(), file);
|
|
103
104
|
const content = json5.parse(await fs.readFile(contentPath, 'utf8'));
|
|
104
|
-
const result = await this.writeDocuments(content, operation
|
|
105
|
+
const result = await this.writeDocuments(content, operation);
|
|
105
106
|
this.log(this.getResultMessage(result, operation));
|
|
106
107
|
return;
|
|
107
108
|
} catch (error) {
|
|
@@ -119,7 +120,7 @@ export class CreateDocumentCommand extends SanityCommand {
|
|
|
119
120
|
// Add UUID prefix to prevent predictable file names and potential conflicts
|
|
120
121
|
const tmpFile = path.join(os.tmpdir(), 'sanity-cli', `${randomUUID()}-${docId}.${ext}`);
|
|
121
122
|
const stringify = useJson5 ? json5.stringify : JSON.stringify;
|
|
122
|
-
const defaultValue = id && await client.getDocument(id) || {
|
|
123
|
+
const defaultValue = id && await this.client.getDocument(id) || {
|
|
123
124
|
_id: docId,
|
|
124
125
|
_type: 'specify-me'
|
|
125
126
|
};
|
|
@@ -135,7 +136,7 @@ export class CreateDocumentCommand extends SanityCommand {
|
|
|
135
136
|
mode: 0o600
|
|
136
137
|
});
|
|
137
138
|
const editor = getEditor();
|
|
138
|
-
const readAndPerformCreatesFromFile = this.readAndPerformCreatesFromFile.bind(this, operation
|
|
139
|
+
const readAndPerformCreatesFromFile = this.readAndPerformCreatesFromFile.bind(this, operation);
|
|
139
140
|
if (watch) {
|
|
140
141
|
// If we're in watch mode, we want to run the creation on each change (if it validates)
|
|
141
142
|
registerUnlinkOnSigInt(tmpFile);
|
|
@@ -216,7 +217,7 @@ export class CreateDocumentCommand extends SanityCommand {
|
|
|
216
217
|
}
|
|
217
218
|
/**
|
|
218
219
|
* Reads and processes documents from a file for creation
|
|
219
|
-
*/ async readAndPerformCreatesFromFile(operation,
|
|
220
|
+
*/ async readAndPerformCreatesFromFile(operation, filePath, defaultValue) {
|
|
220
221
|
let content;
|
|
221
222
|
try {
|
|
222
223
|
content = json5.parse(await fs.readFile(filePath, 'utf8'));
|
|
@@ -232,7 +233,7 @@ export class CreateDocumentCommand extends SanityCommand {
|
|
|
232
233
|
return;
|
|
233
234
|
}
|
|
234
235
|
try {
|
|
235
|
-
const writeResult = await this.writeDocuments(content, operation
|
|
236
|
+
const writeResult = await this.writeDocuments(content, operation);
|
|
236
237
|
this.log(this.getResultMessage(writeResult, operation));
|
|
237
238
|
} catch (err) {
|
|
238
239
|
const error = err;
|
|
@@ -298,7 +299,7 @@ export class CreateDocumentCommand extends SanityCommand {
|
|
|
298
299
|
}
|
|
299
300
|
/**
|
|
300
301
|
* Writes documents to Sanity using the specified operation
|
|
301
|
-
*/ async writeDocuments(documents, operation
|
|
302
|
+
*/ async writeDocuments(documents, operation) {
|
|
302
303
|
const docs = Array.isArray(documents) ? documents : [
|
|
303
304
|
documents
|
|
304
305
|
];
|
|
@@ -330,7 +331,7 @@ export class CreateDocumentCommand extends SanityCommand {
|
|
|
330
331
|
}
|
|
331
332
|
throw new Error(`Unsupported operation ${operation}`);
|
|
332
333
|
});
|
|
333
|
-
return client.transaction(mutations).commit();
|
|
334
|
+
return this.client.transaction(mutations).commit();
|
|
334
335
|
}
|
|
335
336
|
}
|
|
336
337
|
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../src/commands/documents/create.ts"],"sourcesContent":["import {randomUUID} from 'node:crypto'\nimport fs from 'node:fs/promises'\nimport os from 'node:os'\nimport path from 'node:path'\n\nimport {Args, Flags} from '@oclif/core'\nimport {SanityCommand, subdebug} from '@sanity/cli-core'\nimport {type MultipleMutationResult, type Mutation} from '@sanity/client'\nimport {watch as chokidarWatch} from 'chokidar'\nimport {execa, execaSync} from 'execa'\nimport json5 from 'json5'\nimport {isEqual, isPlainObject} from 'lodash-es'\n\nimport {DOCUMENTS_API_VERSION} from '../../actions/documents/constants.js'\nimport {getEditor, registerUnlinkOnSigInt} from '../../actions/documents/editor.js'\nimport {NO_PROJECT_ID} from '../../util/errorMessages.js'\nimport {isIdentifiedSanityDocument, isSanityDocumentish} from '../../util/isSanityDocumentish.js'\n\nexport type MutationOperationName = 'create' | 'createIfNotExists' | 'createOrReplace'\n\nconst createDocumentDebug = subdebug('documents:create')\n\nexport class CreateDocumentCommand extends SanityCommand<typeof CreateDocumentCommand> {\n static override args = {\n file: Args.string({\n description: 'JSON file to create document(s) from',\n required: false,\n }),\n }\n\n static override description = 'Create one or more documents'\n\n static override examples = [\n {\n command: '<%= config.bin %> <%= command.id %> myDocument.json',\n description: 'Create the document specified in \"myDocument.json\"',\n },\n {\n command: '<%= config.bin %> <%= command.id %>',\n description: 'Open configured $EDITOR and create the specified document(s)',\n },\n {\n command: '<%= config.bin %> <%= command.id %> --id myDocId --replace',\n description:\n 'Fetch document with the ID \"myDocId\" and open configured $EDITOR with the current document content (if any). Replace document with the edited version when the editor closes',\n },\n {\n command: '<%= config.bin %> <%= command.id %> --id myDocId --watch --replace --json5',\n description:\n 'Open configured $EDITOR and replace the document with the given content on each save. Use JSON5 file extension and parser for simplified syntax.',\n },\n ]\n\n static override flags = {\n dataset: Flags.string({\n char: 'd',\n description: 'Dataset to create document(s) in (overrides config)',\n }),\n id: Flags.string({\n description:\n 'Specify a document ID to use. Will fetch remote document ID and populate editor.',\n }),\n json5: Flags.boolean({\n description: 'Use JSON5 file type to allow a \"simplified\" version of JSON',\n }),\n missing: Flags.boolean({\n description: \"On duplicate document IDs, don't modify the target document(s)\",\n }),\n replace: Flags.boolean({\n description:\n 'On duplicate document IDs, replace existing document with specified document(s)',\n }),\n watch: Flags.boolean({\n description: 'Write the documents whenever the target file or buffer changes',\n }),\n }\n\n public async run(): Promise<void> {\n const {args, flags} = await this.parse(CreateDocumentCommand)\n const {file} = args\n const {dataset, id, json5: useJson5, missing, replace, watch} = flags\n const cliConfig = await this.getCliConfig()\n const projectId = await this.getProjectId()\n\n if (!projectId) {\n this.error(NO_PROJECT_ID, {exit: 1})\n }\n\n if (!cliConfig.api?.dataset && !dataset) {\n this.error(\n 'No dataset specified. Either configure a dataset in sanity.cli.ts or use the --dataset flag',\n {exit: 1},\n )\n }\n\n const targetDataset = dataset || cliConfig.api?.dataset\n\n const client = await this.getProjectApiClient({\n apiVersion: DOCUMENTS_API_VERSION,\n dataset: targetDataset,\n projectId,\n requireUser: true,\n })\n\n if (replace && missing) {\n this.error('Cannot use both --replace and --missing', {exit: 1})\n }\n\n if (id && file) {\n this.error('Cannot use --id when specifying a file path', {exit: 1})\n }\n\n let operation: MutationOperationName = 'create'\n if (replace || missing) {\n operation = replace ? 'createOrReplace' : 'createIfNotExists'\n }\n\n if (file) {\n try {\n const contentPath = path.resolve(process.cwd(), file)\n const content = json5.parse(await fs.readFile(contentPath, 'utf8'))\n const result = await this.writeDocuments(content, operation, client)\n this.log(this.getResultMessage(result, operation))\n return\n } catch (error) {\n const err = error as Error\n createDocumentDebug(`Error creating documents from file ${file}`, err)\n this.error(`Failed to create documents: ${err.message}`, {exit: 1})\n }\n }\n\n try {\n // Create a temporary file and use that as source, opening an editor on it\n const docId = id || randomUUID()\n const ext = useJson5 ? 'json5' : 'json'\n // Add UUID prefix to prevent predictable file names and potential conflicts\n const tmpFile = path.join(os.tmpdir(), 'sanity-cli', `${randomUUID()}-${docId}.${ext}`)\n const stringify = useJson5 ? json5.stringify : JSON.stringify\n const defaultValue = (id && (await client.getDocument(id))) || {\n _id: docId,\n _type: 'specify-me',\n }\n\n // Create temp directory with restricted permissions (owner only)\n const tempDir = path.join(os.tmpdir(), 'sanity-cli')\n await fs.mkdir(tempDir, {\n mode: 0o700, // rwx------ (owner read/write/execute only)\n recursive: true,\n })\n\n // Write file with restricted permissions (owner read/write only)\n await fs.writeFile(tmpFile, stringify(defaultValue, null, 2), {\n encoding: 'utf8',\n mode: 0o600, // rw------- (owner read/write only)\n })\n\n const editor = getEditor()\n const readAndPerformCreatesFromFile = this.readAndPerformCreatesFromFile.bind(\n this,\n operation,\n client,\n )\n\n if (watch) {\n // If we're in watch mode, we want to run the creation on each change (if it validates)\n registerUnlinkOnSigInt(tmpFile)\n this.log(`Watch mode: ${tmpFile}`)\n this.log('Watch mode: Will write documents on each save.')\n this.log('Watch mode: Press Ctrl + C to cancel watch mode.')\n\n // Add race condition protection\n let isProcessing = false\n chokidarWatch(tmpFile).on('change', async () => {\n if (isProcessing) {\n return // Skip if already processing\n }\n isProcessing = true\n\n this.log('')\n try {\n await readAndPerformCreatesFromFile(tmpFile, defaultValue)\n } finally {\n isProcessing = false\n }\n })\n execa(editor.bin, [...editor.args, tmpFile], {stdio: 'inherit'})\n } else {\n // While in normal mode, we just want to wait for the editor to close and run the thing once\n execaSync(editor.bin, [...editor.args, tmpFile], {stdio: 'inherit'})\n await readAndPerformCreatesFromFile(tmpFile, defaultValue)\n await fs.unlink(tmpFile).catch(() => {})\n }\n } catch (error) {\n const err = error as Error\n createDocumentDebug('Error in editor workflow', err)\n this.error(`Failed to create documents: ${err.message}`, {exit: 1})\n }\n }\n\n private getErrorMessage(message: string, index: number, isSingle: boolean): string {\n return isSingle ? `Document ${message}` : `Document at index ${index} ${message}`\n }\n\n /**\n * Formats the result message for document operations\n */\n private getResultMessage(\n result: MultipleMutationResult,\n operation: MutationOperationName,\n ): string {\n const joiner = '\\n - '\n if (operation === 'createOrReplace') {\n return `Upserted:\\n - ${result.results.map((res) => res.id).join(joiner)}`\n }\n\n if (operation === 'create') {\n return `Created:\\n - ${result.results.map((res) => res.id).join(joiner)}`\n }\n\n // \"Missing\" (createIfNotExists)\n const created: string[] = []\n const skipped: string[] = []\n for (const res of result.results) {\n if (res.operation === 'update') {\n skipped.push(res.id)\n } else {\n created.push(res.id)\n }\n }\n\n if (created.length > 0 && skipped.length > 0) {\n return [\n `Created:\\n - ${created.join(joiner)}`,\n `Skipped (already exists):${joiner}${skipped.join(joiner)}`,\n ].join('\\n\\n')\n } else if (created.length > 0) {\n return `Created:\\n - ${created.join(joiner)}`\n }\n\n return `Skipped (already exists):\\n - ${skipped.join(joiner)}`\n }\n\n /**\n * Reads and processes documents from a file for creation\n */\n private async readAndPerformCreatesFromFile(\n operation: MutationOperationName,\n client: Awaited<ReturnType<typeof this.getProjectApiClient>>,\n filePath: string,\n defaultValue: unknown,\n ): Promise<void> {\n let content\n try {\n content = json5.parse(await fs.readFile(filePath, 'utf8'))\n } catch (err) {\n const error = err as Error\n createDocumentDebug(`Failed to read input file ${filePath}`, error)\n this.log(`Failed to read input: ${error.message}`)\n return\n }\n\n if (isEqual(content, defaultValue)) {\n this.log('Value not modified, doing nothing.')\n this.log('Modify document to trigger creation.')\n return\n }\n\n try {\n const writeResult = await this.writeDocuments(content, operation, client)\n this.log(this.getResultMessage(writeResult, operation))\n } catch (err) {\n const error = err as Error\n createDocumentDebug(`Failed to write documents`, error)\n let errorMessage = `Failed to write documents: ${error.message}`\n if (error.message.includes('already exists')) {\n errorMessage += '\\nPerhaps you want to use `--replace` or `--missing`?'\n }\n this.error(errorMessage, {exit: 1})\n }\n }\n\n /**\n * Validates a document for Sanity requirements\n */\n private validateDocument(doc: unknown, index: number, arr: unknown[]): void {\n const isSingle = arr.length === 1\n\n if (!isPlainObject(doc)) {\n throw new Error(this.getErrorMessage('must be an object', index, isSingle))\n }\n\n if (!isSanityDocumentish(doc)) {\n throw new Error(\n this.getErrorMessage('must have a `_type` property of type string', index, isSingle),\n )\n }\n\n // Enhanced validations for Sanity document constraints\n const docObj = doc as Record<string, unknown>\n\n // Validate _type is non-empty\n const typeValue = docObj._type?.toString().trim()\n if (!typeValue) {\n throw new Error(this.getErrorMessage('_type cannot be empty', index, isSingle))\n }\n\n // Validate _type format (alphanumeric, underscore, hyphen, dot)\n if (!/^[a-zA-Z][a-zA-Z0-9_.-]*$/.test(typeValue)) {\n throw new Error(\n this.getErrorMessage(\n '_type must start with a letter and contain only alphanumeric characters, underscores, hyphens, and dots',\n index,\n isSingle,\n ),\n )\n }\n\n // Validate _id format if present\n if (docObj._id && typeof docObj._id === 'string') {\n const idValue = docObj._id.trim()\n if (!idValue) {\n throw new Error(this.getErrorMessage('_id cannot be empty', index, isSingle))\n }\n\n // Sanity document IDs can contain alphanumeric chars, hyphens, underscores, and dots\n if (!/^[a-zA-Z0-9_.-]+$/.test(idValue)) {\n throw new Error(\n this.getErrorMessage(\n '_id can only contain alphanumeric characters, underscores, hyphens, and dots',\n index,\n isSingle,\n ),\n )\n }\n\n // Check length constraints (Sanity has reasonable limits)\n if (idValue.length > 200) {\n throw new Error(\n this.getErrorMessage('_id cannot be longer than 200 characters', index, isSingle),\n )\n }\n }\n\n // Warn about reserved fields (these are managed by Sanity)\n const reservedFields = ['_rev', '_updatedAt', '_createdAt']\n for (const field of reservedFields) {\n if (field in docObj) {\n // Note: We don't throw an error here as these might be present in fetched documents\n // that are being re-uploaded, but we could add a debug warning\n createDocumentDebug(\n `Warning: Document ${index} contains reserved field '${field}' which will be ignored by Sanity`,\n )\n }\n }\n }\n\n /**\n * Writes documents to Sanity using the specified operation\n */\n private async writeDocuments(\n documents: {_id?: string; _type: string} | {_id?: string; _type: string}[],\n operation: MutationOperationName,\n client: Awaited<ReturnType<typeof this.getProjectApiClient>>,\n ): Promise<MultipleMutationResult> {\n const docs = Array.isArray(documents) ? documents : [documents]\n if (docs.length === 0) {\n throw new Error('No documents provided')\n }\n\n const mutations = docs.map((doc, index): Mutation => {\n this.validateDocument(doc, index, docs)\n if (operation === 'create') {\n return {create: doc}\n }\n\n if (operation === 'createIfNotExists') {\n if (isIdentifiedSanityDocument(doc)) {\n return {createIfNotExists: doc}\n }\n\n throw new Error(`Missing required _id attribute for ${operation}`)\n }\n\n if (operation === 'createOrReplace') {\n if (isIdentifiedSanityDocument(doc)) {\n return {createOrReplace: doc}\n }\n\n throw new Error(`Missing required _id attribute for ${operation}`)\n }\n\n throw new Error(`Unsupported operation ${operation}`)\n })\n\n return client.transaction(mutations).commit()\n }\n}\n"],"names":["randomUUID","fs","os","path","Args","Flags","SanityCommand","subdebug","watch","chokidarWatch","execa","execaSync","json5","isEqual","isPlainObject","DOCUMENTS_API_VERSION","getEditor","registerUnlinkOnSigInt","NO_PROJECT_ID","isIdentifiedSanityDocument","isSanityDocumentish","createDocumentDebug","CreateDocumentCommand","args","file","string","description","required","examples","command","flags","dataset","char","id","boolean","missing","replace","run","parse","useJson5","cliConfig","getCliConfig","projectId","getProjectId","error","exit","api","targetDataset","client","getProjectApiClient","apiVersion","requireUser","operation","contentPath","resolve","process","cwd","content","readFile","result","writeDocuments","log","getResultMessage","err","message","docId","ext","tmpFile","join","tmpdir","stringify","JSON","defaultValue","getDocument","_id","_type","tempDir","mkdir","mode","recursive","writeFile","encoding","editor","readAndPerformCreatesFromFile","bind","isProcessing","on","bin","stdio","unlink","catch","getErrorMessage","index","isSingle","joiner","results","map","res","created","skipped","push","length","filePath","writeResult","errorMessage","includes","validateDocument","doc","arr","Error","docObj","typeValue","toString","trim","test","idValue","reservedFields","field","documents","docs","Array","isArray","mutations","create","createIfNotExists","createOrReplace","transaction","commit"],"mappings":"AAAA,SAAQA,UAAU,QAAO,cAAa;AACtC,OAAOC,QAAQ,mBAAkB;AACjC,OAAOC,QAAQ,UAAS;AACxB,OAAOC,UAAU,YAAW;AAE5B,SAAQC,IAAI,EAAEC,KAAK,QAAO,cAAa;AACvC,SAAQC,aAAa,EAAEC,QAAQ,QAAO,mBAAkB;AAExD,SAAQC,SAASC,aAAa,QAAO,WAAU;AAC/C,SAAQC,KAAK,EAAEC,SAAS,QAAO,QAAO;AACtC,OAAOC,WAAW,QAAO;AACzB,SAAQC,OAAO,EAAEC,aAAa,QAAO,YAAW;AAEhD,SAAQC,qBAAqB,QAAO,uCAAsC;AAC1E,SAAQC,SAAS,EAAEC,sBAAsB,QAAO,oCAAmC;AACnF,SAAQC,aAAa,QAAO,8BAA6B;AACzD,SAAQC,0BAA0B,EAAEC,mBAAmB,QAAO,oCAAmC;AAIjG,MAAMC,sBAAsBd,SAAS;AAErC,OAAO,MAAMe,8BAA8BhB;IACzC,OAAgBiB,OAAO;QACrBC,MAAMpB,KAAKqB,MAAM,CAAC;YAChBC,aAAa;YACbC,UAAU;QACZ;IACF,EAAC;IAED,OAAgBD,cAAc,+BAA8B;IAE5D,OAAgBE,WAAW;QACzB;YACEC,SAAS;YACTH,aAAa;QACf;QACA;YACEG,SAAS;YACTH,aAAa;QACf;QACA;YACEG,SAAS;YACTH,aACE;QACJ;QACA;YACEG,SAAS;YACTH,aACE;QACJ;KACD,CAAA;IAED,OAAgBI,QAAQ;QACtBC,SAAS1B,MAAMoB,MAAM,CAAC;YACpBO,MAAM;YACNN,aAAa;QACf;QACAO,IAAI5B,MAAMoB,MAAM,CAAC;YACfC,aACE;QACJ;QACAd,OAAOP,MAAM6B,OAAO,CAAC;YACnBR,aAAa;QACf;QACAS,SAAS9B,MAAM6B,OAAO,CAAC;YACrBR,aAAa;QACf;QACAU,SAAS/B,MAAM6B,OAAO,CAAC;YACrBR,aACE;QACJ;QACAlB,OAAOH,MAAM6B,OAAO,CAAC;YACnBR,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,OAAO,EAAEE,EAAE,EAAErB,OAAO2B,QAAQ,EAAEJ,OAAO,EAAEC,OAAO,EAAE5B,KAAK,EAAC,GAAGsB;QAChE,MAAMU,YAAY,MAAM,IAAI,CAACC,YAAY;QACzC,MAAMC,YAAY,MAAM,IAAI,CAACC,YAAY;QAEzC,IAAI,CAACD,WAAW;YACd,IAAI,CAACE,KAAK,CAAC1B,eAAe;gBAAC2B,MAAM;YAAC;QACpC;QAEA,IAAI,CAACL,UAAUM,GAAG,EAAEf,WAAW,CAACA,SAAS;YACvC,IAAI,CAACa,KAAK,CACR,+FACA;gBAACC,MAAM;YAAC;QAEZ;QAEA,MAAME,gBAAgBhB,WAAWS,UAAUM,GAAG,EAAEf;QAEhD,MAAMiB,SAAS,MAAM,IAAI,CAACC,mBAAmB,CAAC;YAC5CC,YAAYnC;YACZgB,SAASgB;YACTL;YACAS,aAAa;QACf;QAEA,IAAIf,WAAWD,SAAS;YACtB,IAAI,CAACS,KAAK,CAAC,2CAA2C;gBAACC,MAAM;YAAC;QAChE;QAEA,IAAIZ,MAAMT,MAAM;YACd,IAAI,CAACoB,KAAK,CAAC,+CAA+C;gBAACC,MAAM;YAAC;QACpE;QAEA,IAAIO,YAAmC;QACvC,IAAIhB,WAAWD,SAAS;YACtBiB,YAAYhB,UAAU,oBAAoB;QAC5C;QAEA,IAAIZ,MAAM;YACR,IAAI;gBACF,MAAM6B,cAAclD,KAAKmD,OAAO,CAACC,QAAQC,GAAG,IAAIhC;gBAChD,MAAMiC,UAAU7C,MAAM0B,KAAK,CAAC,MAAMrC,GAAGyD,QAAQ,CAACL,aAAa;gBAC3D,MAAMM,SAAS,MAAM,IAAI,CAACC,cAAc,CAACH,SAASL,WAAWJ;gBAC7D,IAAI,CAACa,GAAG,CAAC,IAAI,CAACC,gBAAgB,CAACH,QAAQP;gBACvC;YACF,EAAE,OAAOR,OAAO;gBACd,MAAMmB,MAAMnB;gBACZvB,oBAAoB,CAAC,mCAAmC,EAAEG,MAAM,EAAEuC;gBAClE,IAAI,CAACnB,KAAK,CAAC,CAAC,4BAA4B,EAAEmB,IAAIC,OAAO,EAAE,EAAE;oBAACnB,MAAM;gBAAC;YACnE;QACF;QAEA,IAAI;YACF,0EAA0E;YAC1E,MAAMoB,QAAQhC,MAAMjC;YACpB,MAAMkE,MAAM3B,WAAW,UAAU;YACjC,4EAA4E;YAC5E,MAAM4B,UAAUhE,KAAKiE,IAAI,CAAClE,GAAGmE,MAAM,IAAI,cAAc,GAAGrE,aAAa,CAAC,EAAEiE,MAAM,CAAC,EAAEC,KAAK;YACtF,MAAMI,YAAY/B,WAAW3B,MAAM0D,SAAS,GAAGC,KAAKD,SAAS;YAC7D,MAAME,eAAe,AAACvC,MAAO,MAAMe,OAAOyB,WAAW,CAACxC,OAAS;gBAC7DyC,KAAKT;gBACLU,OAAO;YACT;YAEA,iEAAiE;YACjE,MAAMC,UAAUzE,KAAKiE,IAAI,CAAClE,GAAGmE,MAAM,IAAI;YACvC,MAAMpE,GAAG4E,KAAK,CAACD,SAAS;gBACtBE,MAAM;gBACNC,WAAW;YACb;YAEA,iEAAiE;YACjE,MAAM9E,GAAG+E,SAAS,CAACb,SAASG,UAAUE,cAAc,MAAM,IAAI;gBAC5DS,UAAU;gBACVH,MAAM;YACR;YAEA,MAAMI,SAASlE;YACf,MAAMmE,gCAAgC,IAAI,CAACA,6BAA6B,CAACC,IAAI,CAC3E,IAAI,EACJhC,WACAJ;YAGF,IAAIxC,OAAO;gBACT,uFAAuF;gBACvFS,uBAAuBkD;gBACvB,IAAI,CAACN,GAAG,CAAC,CAAC,YAAY,EAAEM,SAAS;gBACjC,IAAI,CAACN,GAAG,CAAC;gBACT,IAAI,CAACA,GAAG,CAAC;gBAET,gCAAgC;gBAChC,IAAIwB,eAAe;gBACnB5E,cAAc0D,SAASmB,EAAE,CAAC,UAAU;oBAClC,IAAID,cAAc;wBAChB,QAAO,6BAA6B;oBACtC;oBACAA,eAAe;oBAEf,IAAI,CAACxB,GAAG,CAAC;oBACT,IAAI;wBACF,MAAMsB,8BAA8BhB,SAASK;oBAC/C,SAAU;wBACRa,eAAe;oBACjB;gBACF;gBACA3E,MAAMwE,OAAOK,GAAG,EAAE;uBAAIL,OAAO3D,IAAI;oBAAE4C;iBAAQ,EAAE;oBAACqB,OAAO;gBAAS;YAChE,OAAO;gBACL,4FAA4F;gBAC5F7E,UAAUuE,OAAOK,GAAG,EAAE;uBAAIL,OAAO3D,IAAI;oBAAE4C;iBAAQ,EAAE;oBAACqB,OAAO;gBAAS;gBAClE,MAAML,8BAA8BhB,SAASK;gBAC7C,MAAMvE,GAAGwF,MAAM,CAACtB,SAASuB,KAAK,CAAC,KAAO;YACxC;QACF,EAAE,OAAO9C,OAAO;YACd,MAAMmB,MAAMnB;YACZvB,oBAAoB,4BAA4B0C;YAChD,IAAI,CAACnB,KAAK,CAAC,CAAC,4BAA4B,EAAEmB,IAAIC,OAAO,EAAE,EAAE;gBAACnB,MAAM;YAAC;QACnE;IACF;IAEQ8C,gBAAgB3B,OAAe,EAAE4B,KAAa,EAAEC,QAAiB,EAAU;QACjF,OAAOA,WAAW,CAAC,SAAS,EAAE7B,SAAS,GAAG,CAAC,kBAAkB,EAAE4B,MAAM,CAAC,EAAE5B,SAAS;IACnF;IAEA;;GAEC,GACD,AAAQF,iBACNH,MAA8B,EAC9BP,SAAgC,EACxB;QACR,MAAM0C,SAAS;QACf,IAAI1C,cAAc,mBAAmB;YACnC,OAAO,CAAC,eAAe,EAAEO,OAAOoC,OAAO,CAACC,GAAG,CAAC,CAACC,MAAQA,IAAIhE,EAAE,EAAEmC,IAAI,CAAC0B,SAAS;QAC7E;QAEA,IAAI1C,cAAc,UAAU;YAC1B,OAAO,CAAC,cAAc,EAAEO,OAAOoC,OAAO,CAACC,GAAG,CAAC,CAACC,MAAQA,IAAIhE,EAAE,EAAEmC,IAAI,CAAC0B,SAAS;QAC5E;QAEA,gCAAgC;QAChC,MAAMI,UAAoB,EAAE;QAC5B,MAAMC,UAAoB,EAAE;QAC5B,KAAK,MAAMF,OAAOtC,OAAOoC,OAAO,CAAE;YAChC,IAAIE,IAAI7C,SAAS,KAAK,UAAU;gBAC9B+C,QAAQC,IAAI,CAACH,IAAIhE,EAAE;YACrB,OAAO;gBACLiE,QAAQE,IAAI,CAACH,IAAIhE,EAAE;YACrB;QACF;QAEA,IAAIiE,QAAQG,MAAM,GAAG,KAAKF,QAAQE,MAAM,GAAG,GAAG;YAC5C,OAAO;gBACL,CAAC,cAAc,EAAEH,QAAQ9B,IAAI,CAAC0B,SAAS;gBACvC,CAAC,yBAAyB,EAAEA,SAASK,QAAQ/B,IAAI,CAAC0B,SAAS;aAC5D,CAAC1B,IAAI,CAAC;QACT,OAAO,IAAI8B,QAAQG,MAAM,GAAG,GAAG;YAC7B,OAAO,CAAC,cAAc,EAAEH,QAAQ9B,IAAI,CAAC0B,SAAS;QAChD;QAEA,OAAO,CAAC,+BAA+B,EAAEK,QAAQ/B,IAAI,CAAC0B,SAAS;IACjE;IAEA;;GAEC,GACD,MAAcX,8BACZ/B,SAAgC,EAChCJ,MAA4D,EAC5DsD,QAAgB,EAChB9B,YAAqB,EACN;QACf,IAAIf;QACJ,IAAI;YACFA,UAAU7C,MAAM0B,KAAK,CAAC,MAAMrC,GAAGyD,QAAQ,CAAC4C,UAAU;QACpD,EAAE,OAAOvC,KAAK;YACZ,MAAMnB,QAAQmB;YACd1C,oBAAoB,CAAC,0BAA0B,EAAEiF,UAAU,EAAE1D;YAC7D,IAAI,CAACiB,GAAG,CAAC,CAAC,sBAAsB,EAAEjB,MAAMoB,OAAO,EAAE;YACjD;QACF;QAEA,IAAInD,QAAQ4C,SAASe,eAAe;YAClC,IAAI,CAACX,GAAG,CAAC;YACT,IAAI,CAACA,GAAG,CAAC;YACT;QACF;QAEA,IAAI;YACF,MAAM0C,cAAc,MAAM,IAAI,CAAC3C,cAAc,CAACH,SAASL,WAAWJ;YAClE,IAAI,CAACa,GAAG,CAAC,IAAI,CAACC,gBAAgB,CAACyC,aAAanD;QAC9C,EAAE,OAAOW,KAAK;YACZ,MAAMnB,QAAQmB;YACd1C,oBAAoB,CAAC,yBAAyB,CAAC,EAAEuB;YACjD,IAAI4D,eAAe,CAAC,2BAA2B,EAAE5D,MAAMoB,OAAO,EAAE;YAChE,IAAIpB,MAAMoB,OAAO,CAACyC,QAAQ,CAAC,mBAAmB;gBAC5CD,gBAAgB;YAClB;YACA,IAAI,CAAC5D,KAAK,CAAC4D,cAAc;gBAAC3D,MAAM;YAAC;QACnC;IACF;IAEA;;GAEC,GACD,AAAQ6D,iBAAiBC,GAAY,EAAEf,KAAa,EAAEgB,GAAc,EAAQ;QAC1E,MAAMf,WAAWe,IAAIP,MAAM,KAAK;QAEhC,IAAI,CAACvF,cAAc6F,MAAM;YACvB,MAAM,IAAIE,MAAM,IAAI,CAAClB,eAAe,CAAC,qBAAqBC,OAAOC;QACnE;QAEA,IAAI,CAACzE,oBAAoBuF,MAAM;YAC7B,MAAM,IAAIE,MACR,IAAI,CAAClB,eAAe,CAAC,+CAA+CC,OAAOC;QAE/E;QAEA,uDAAuD;QACvD,MAAMiB,SAASH;QAEf,8BAA8B;QAC9B,MAAMI,YAAYD,OAAOnC,KAAK,EAAEqC,WAAWC;QAC3C,IAAI,CAACF,WAAW;YACd,MAAM,IAAIF,MAAM,IAAI,CAAClB,eAAe,CAAC,yBAAyBC,OAAOC;QACvE;QAEA,gEAAgE;QAChE,IAAI,CAAC,4BAA4BqB,IAAI,CAACH,YAAY;YAChD,MAAM,IAAIF,MACR,IAAI,CAAClB,eAAe,CAClB,2GACAC,OACAC;QAGN;QAEA,iCAAiC;QACjC,IAAIiB,OAAOpC,GAAG,IAAI,OAAOoC,OAAOpC,GAAG,KAAK,UAAU;YAChD,MAAMyC,UAAUL,OAAOpC,GAAG,CAACuC,IAAI;YAC/B,IAAI,CAACE,SAAS;gBACZ,MAAM,IAAIN,MAAM,IAAI,CAAClB,eAAe,CAAC,uBAAuBC,OAAOC;YACrE;YAEA,qFAAqF;YACrF,IAAI,CAAC,oBAAoBqB,IAAI,CAACC,UAAU;gBACtC,MAAM,IAAIN,MACR,IAAI,CAAClB,eAAe,CAClB,gFACAC,OACAC;YAGN;YAEA,0DAA0D;YAC1D,IAAIsB,QAAQd,MAAM,GAAG,KAAK;gBACxB,MAAM,IAAIQ,MACR,IAAI,CAAClB,eAAe,CAAC,4CAA4CC,OAAOC;YAE5E;QACF;QAEA,2DAA2D;QAC3D,MAAMuB,iBAAiB;YAAC;YAAQ;YAAc;SAAa;QAC3D,KAAK,MAAMC,SAASD,eAAgB;YAClC,IAAIC,SAASP,QAAQ;gBACnB,oFAAoF;gBACpF,+DAA+D;gBAC/DzF,oBACE,CAAC,kBAAkB,EAAEuE,MAAM,0BAA0B,EAAEyB,MAAM,iCAAiC,CAAC;YAEnG;QACF;IACF;IAEA;;GAEC,GACD,MAAczD,eACZ0D,SAA0E,EAC1ElE,SAAgC,EAChCJ,MAA4D,EAC3B;QACjC,MAAMuE,OAAOC,MAAMC,OAAO,CAACH,aAAaA,YAAY;YAACA;SAAU;QAC/D,IAAIC,KAAKlB,MAAM,KAAK,GAAG;YACrB,MAAM,IAAIQ,MAAM;QAClB;QAEA,MAAMa,YAAYH,KAAKvB,GAAG,CAAC,CAACW,KAAKf;YAC/B,IAAI,CAACc,gBAAgB,CAACC,KAAKf,OAAO2B;YAClC,IAAInE,cAAc,UAAU;gBAC1B,OAAO;oBAACuE,QAAQhB;gBAAG;YACrB;YAEA,IAAIvD,cAAc,qBAAqB;gBACrC,IAAIjC,2BAA2BwF,MAAM;oBACnC,OAAO;wBAACiB,mBAAmBjB;oBAAG;gBAChC;gBAEA,MAAM,IAAIE,MAAM,CAAC,mCAAmC,EAAEzD,WAAW;YACnE;YAEA,IAAIA,cAAc,mBAAmB;gBACnC,IAAIjC,2BAA2BwF,MAAM;oBACnC,OAAO;wBAACkB,iBAAiBlB;oBAAG;gBAC9B;gBAEA,MAAM,IAAIE,MAAM,CAAC,mCAAmC,EAAEzD,WAAW;YACnE;YAEA,MAAM,IAAIyD,MAAM,CAAC,sBAAsB,EAAEzD,WAAW;QACtD;QAEA,OAAOJ,OAAO8E,WAAW,CAACJ,WAAWK,MAAM;IAC7C;AACF"}
|
|
1
|
+
{"version":3,"sources":["../../../src/commands/documents/create.ts"],"sourcesContent":["import {randomUUID} from 'node:crypto'\nimport fs from 'node:fs/promises'\nimport os from 'node:os'\nimport path from 'node:path'\n\nimport {Args, Flags} from '@oclif/core'\nimport {getProjectCliClient, SanityCommand, subdebug} from '@sanity/cli-core'\nimport {type MultipleMutationResult, type Mutation} from '@sanity/client'\nimport {watch as chokidarWatch} from 'chokidar'\nimport {execa, execaSync} from 'execa'\nimport json5 from 'json5'\nimport {isEqual, isPlainObject} from 'lodash-es'\n\nimport {DOCUMENTS_API_VERSION} from '../../actions/documents/constants.js'\nimport {getEditor, registerUnlinkOnSigInt} from '../../actions/documents/editor.js'\nimport {NO_PROJECT_ID} from '../../util/errorMessages.js'\nimport {isIdentifiedSanityDocument, isSanityDocumentish} from '../../util/isSanityDocumentish.js'\n\nexport type MutationOperationName = 'create' | 'createIfNotExists' | 'createOrReplace'\n\nconst createDocumentDebug = subdebug('documents:create')\n\nexport class CreateDocumentCommand extends SanityCommand<typeof CreateDocumentCommand> {\n static override args = {\n file: Args.string({\n description: 'JSON file to create document(s) from',\n required: false,\n }),\n }\n\n static override description = 'Create one or more documents'\n\n static override examples = [\n {\n command: '<%= config.bin %> <%= command.id %> myDocument.json',\n description: 'Create the document specified in \"myDocument.json\"',\n },\n {\n command: '<%= config.bin %> <%= command.id %>',\n description: 'Open configured $EDITOR and create the specified document(s)',\n },\n {\n command: '<%= config.bin %> <%= command.id %> --id myDocId --replace',\n description:\n 'Fetch document with the ID \"myDocId\" and open configured $EDITOR with the current document content (if any). Replace document with the edited version when the editor closes',\n },\n {\n command: '<%= config.bin %> <%= command.id %> --id myDocId --watch --replace --json5',\n description:\n 'Open configured $EDITOR and replace the document with the given content on each save. Use JSON5 file extension and parser for simplified syntax.',\n },\n ]\n\n static override flags = {\n dataset: Flags.string({\n char: 'd',\n description: 'Dataset to create document(s) in (overrides config)',\n }),\n id: Flags.string({\n description:\n 'Specify a document ID to use. Will fetch remote document ID and populate editor.',\n }),\n json5: Flags.boolean({\n description: 'Use JSON5 file type to allow a \"simplified\" version of JSON',\n }),\n missing: Flags.boolean({\n description: \"On duplicate document IDs, don't modify the target document(s)\",\n }),\n replace: Flags.boolean({\n description:\n 'On duplicate document IDs, replace existing document with specified document(s)',\n }),\n watch: Flags.boolean({\n description: 'Write the documents whenever the target file or buffer changes',\n }),\n }\n\n private client!: Awaited<ReturnType<typeof getProjectCliClient>>\n\n public async run(): Promise<void> {\n const {args, flags} = await this.parse(CreateDocumentCommand)\n const {file} = args\n const {dataset, id, json5: useJson5, missing, replace, watch} = flags\n const cliConfig = await this.getCliConfig()\n const projectId = await this.getProjectId()\n\n if (!projectId) {\n this.error(NO_PROJECT_ID, {exit: 1})\n }\n\n if (!cliConfig.api?.dataset && !dataset) {\n this.error(\n 'No dataset specified. Either configure a dataset in sanity.cli.ts or use the --dataset flag',\n {exit: 1},\n )\n }\n\n const targetDataset = dataset || cliConfig.api?.dataset\n\n this.client = await getProjectCliClient({\n apiVersion: DOCUMENTS_API_VERSION,\n dataset: targetDataset,\n projectId,\n requireUser: true,\n })\n\n if (replace && missing) {\n this.error('Cannot use both --replace and --missing', {exit: 1})\n }\n\n if (id && file) {\n this.error('Cannot use --id when specifying a file path', {exit: 1})\n }\n\n let operation: MutationOperationName = 'create'\n if (replace || missing) {\n operation = replace ? 'createOrReplace' : 'createIfNotExists'\n }\n\n if (file) {\n try {\n const contentPath = path.resolve(process.cwd(), file)\n const content = json5.parse(await fs.readFile(contentPath, 'utf8'))\n const result = await this.writeDocuments(content, operation)\n this.log(this.getResultMessage(result, operation))\n return\n } catch (error) {\n const err = error as Error\n createDocumentDebug(`Error creating documents from file ${file}`, err)\n this.error(`Failed to create documents: ${err.message}`, {exit: 1})\n }\n }\n\n try {\n // Create a temporary file and use that as source, opening an editor on it\n const docId = id || randomUUID()\n const ext = useJson5 ? 'json5' : 'json'\n // Add UUID prefix to prevent predictable file names and potential conflicts\n const tmpFile = path.join(os.tmpdir(), 'sanity-cli', `${randomUUID()}-${docId}.${ext}`)\n const stringify = useJson5 ? json5.stringify : JSON.stringify\n const defaultValue = (id && (await this.client.getDocument(id))) || {\n _id: docId,\n _type: 'specify-me',\n }\n\n // Create temp directory with restricted permissions (owner only)\n const tempDir = path.join(os.tmpdir(), 'sanity-cli')\n await fs.mkdir(tempDir, {\n mode: 0o700, // rwx------ (owner read/write/execute only)\n recursive: true,\n })\n\n // Write file with restricted permissions (owner read/write only)\n await fs.writeFile(tmpFile, stringify(defaultValue, null, 2), {\n encoding: 'utf8',\n mode: 0o600, // rw------- (owner read/write only)\n })\n\n const editor = getEditor()\n const readAndPerformCreatesFromFile = this.readAndPerformCreatesFromFile.bind(this, operation)\n\n if (watch) {\n // If we're in watch mode, we want to run the creation on each change (if it validates)\n registerUnlinkOnSigInt(tmpFile)\n this.log(`Watch mode: ${tmpFile}`)\n this.log('Watch mode: Will write documents on each save.')\n this.log('Watch mode: Press Ctrl + C to cancel watch mode.')\n\n // Add race condition protection\n let isProcessing = false\n chokidarWatch(tmpFile).on('change', async () => {\n if (isProcessing) {\n return // Skip if already processing\n }\n isProcessing = true\n\n this.log('')\n try {\n await readAndPerformCreatesFromFile(tmpFile, defaultValue)\n } finally {\n isProcessing = false\n }\n })\n execa(editor.bin, [...editor.args, tmpFile], {stdio: 'inherit'})\n } else {\n // While in normal mode, we just want to wait for the editor to close and run the thing once\n execaSync(editor.bin, [...editor.args, tmpFile], {stdio: 'inherit'})\n await readAndPerformCreatesFromFile(tmpFile, defaultValue)\n await fs.unlink(tmpFile).catch(() => {})\n }\n } catch (error) {\n const err = error as Error\n createDocumentDebug('Error in editor workflow', err)\n this.error(`Failed to create documents: ${err.message}`, {exit: 1})\n }\n }\n\n private getErrorMessage(message: string, index: number, isSingle: boolean): string {\n return isSingle ? `Document ${message}` : `Document at index ${index} ${message}`\n }\n\n /**\n * Formats the result message for document operations\n */\n private getResultMessage(\n result: MultipleMutationResult,\n operation: MutationOperationName,\n ): string {\n const joiner = '\\n - '\n if (operation === 'createOrReplace') {\n return `Upserted:\\n - ${result.results.map((res) => res.id).join(joiner)}`\n }\n\n if (operation === 'create') {\n return `Created:\\n - ${result.results.map((res) => res.id).join(joiner)}`\n }\n\n // \"Missing\" (createIfNotExists)\n const created: string[] = []\n const skipped: string[] = []\n for (const res of result.results) {\n if (res.operation === 'update') {\n skipped.push(res.id)\n } else {\n created.push(res.id)\n }\n }\n\n if (created.length > 0 && skipped.length > 0) {\n return [\n `Created:\\n - ${created.join(joiner)}`,\n `Skipped (already exists):${joiner}${skipped.join(joiner)}`,\n ].join('\\n\\n')\n } else if (created.length > 0) {\n return `Created:\\n - ${created.join(joiner)}`\n }\n\n return `Skipped (already exists):\\n - ${skipped.join(joiner)}`\n }\n\n /**\n * Reads and processes documents from a file for creation\n */\n private async readAndPerformCreatesFromFile(\n operation: MutationOperationName,\n filePath: string,\n defaultValue: unknown,\n ): Promise<void> {\n let content\n try {\n content = json5.parse(await fs.readFile(filePath, 'utf8'))\n } catch (err) {\n const error = err as Error\n createDocumentDebug(`Failed to read input file ${filePath}`, error)\n this.log(`Failed to read input: ${error.message}`)\n return\n }\n\n if (isEqual(content, defaultValue)) {\n this.log('Value not modified, doing nothing.')\n this.log('Modify document to trigger creation.')\n return\n }\n\n try {\n const writeResult = await this.writeDocuments(content, operation)\n this.log(this.getResultMessage(writeResult, operation))\n } catch (err) {\n const error = err as Error\n createDocumentDebug(`Failed to write documents`, error)\n let errorMessage = `Failed to write documents: ${error.message}`\n if (error.message.includes('already exists')) {\n errorMessage += '\\nPerhaps you want to use `--replace` or `--missing`?'\n }\n this.error(errorMessage, {exit: 1})\n }\n }\n\n /**\n * Validates a document for Sanity requirements\n */\n private validateDocument(doc: unknown, index: number, arr: unknown[]): void {\n const isSingle = arr.length === 1\n\n if (!isPlainObject(doc)) {\n throw new Error(this.getErrorMessage('must be an object', index, isSingle))\n }\n\n if (!isSanityDocumentish(doc)) {\n throw new Error(\n this.getErrorMessage('must have a `_type` property of type string', index, isSingle),\n )\n }\n\n // Enhanced validations for Sanity document constraints\n const docObj = doc as Record<string, unknown>\n\n // Validate _type is non-empty\n const typeValue = docObj._type?.toString().trim()\n if (!typeValue) {\n throw new Error(this.getErrorMessage('_type cannot be empty', index, isSingle))\n }\n\n // Validate _type format (alphanumeric, underscore, hyphen, dot)\n if (!/^[a-zA-Z][a-zA-Z0-9_.-]*$/.test(typeValue)) {\n throw new Error(\n this.getErrorMessage(\n '_type must start with a letter and contain only alphanumeric characters, underscores, hyphens, and dots',\n index,\n isSingle,\n ),\n )\n }\n\n // Validate _id format if present\n if (docObj._id && typeof docObj._id === 'string') {\n const idValue = docObj._id.trim()\n if (!idValue) {\n throw new Error(this.getErrorMessage('_id cannot be empty', index, isSingle))\n }\n\n // Sanity document IDs can contain alphanumeric chars, hyphens, underscores, and dots\n if (!/^[a-zA-Z0-9_.-]+$/.test(idValue)) {\n throw new Error(\n this.getErrorMessage(\n '_id can only contain alphanumeric characters, underscores, hyphens, and dots',\n index,\n isSingle,\n ),\n )\n }\n\n // Check length constraints (Sanity has reasonable limits)\n if (idValue.length > 200) {\n throw new Error(\n this.getErrorMessage('_id cannot be longer than 200 characters', index, isSingle),\n )\n }\n }\n\n // Warn about reserved fields (these are managed by Sanity)\n const reservedFields = ['_rev', '_updatedAt', '_createdAt']\n for (const field of reservedFields) {\n if (field in docObj) {\n // Note: We don't throw an error here as these might be present in fetched documents\n // that are being re-uploaded, but we could add a debug warning\n createDocumentDebug(\n `Warning: Document ${index} contains reserved field '${field}' which will be ignored by Sanity`,\n )\n }\n }\n }\n\n /**\n * Writes documents to Sanity using the specified operation\n */\n private async writeDocuments(\n documents: {_id?: string; _type: string} | {_id?: string; _type: string}[],\n operation: MutationOperationName,\n ): Promise<MultipleMutationResult> {\n const docs = Array.isArray(documents) ? documents : [documents]\n if (docs.length === 0) {\n throw new Error('No documents provided')\n }\n\n const mutations = docs.map((doc, index): Mutation => {\n this.validateDocument(doc, index, docs)\n if (operation === 'create') {\n return {create: doc}\n }\n\n if (operation === 'createIfNotExists') {\n if (isIdentifiedSanityDocument(doc)) {\n return {createIfNotExists: doc}\n }\n\n throw new Error(`Missing required _id attribute for ${operation}`)\n }\n\n if (operation === 'createOrReplace') {\n if (isIdentifiedSanityDocument(doc)) {\n return {createOrReplace: doc}\n }\n\n throw new Error(`Missing required _id attribute for ${operation}`)\n }\n\n throw new Error(`Unsupported operation ${operation}`)\n })\n\n return this.client.transaction(mutations).commit()\n }\n}\n"],"names":["randomUUID","fs","os","path","Args","Flags","getProjectCliClient","SanityCommand","subdebug","watch","chokidarWatch","execa","execaSync","json5","isEqual","isPlainObject","DOCUMENTS_API_VERSION","getEditor","registerUnlinkOnSigInt","NO_PROJECT_ID","isIdentifiedSanityDocument","isSanityDocumentish","createDocumentDebug","CreateDocumentCommand","args","file","string","description","required","examples","command","flags","dataset","char","id","boolean","missing","replace","client","run","parse","useJson5","cliConfig","getCliConfig","projectId","getProjectId","error","exit","api","targetDataset","apiVersion","requireUser","operation","contentPath","resolve","process","cwd","content","readFile","result","writeDocuments","log","getResultMessage","err","message","docId","ext","tmpFile","join","tmpdir","stringify","JSON","defaultValue","getDocument","_id","_type","tempDir","mkdir","mode","recursive","writeFile","encoding","editor","readAndPerformCreatesFromFile","bind","isProcessing","on","bin","stdio","unlink","catch","getErrorMessage","index","isSingle","joiner","results","map","res","created","skipped","push","length","filePath","writeResult","errorMessage","includes","validateDocument","doc","arr","Error","docObj","typeValue","toString","trim","test","idValue","reservedFields","field","documents","docs","Array","isArray","mutations","create","createIfNotExists","createOrReplace","transaction","commit"],"mappings":"AAAA,SAAQA,UAAU,QAAO,cAAa;AACtC,OAAOC,QAAQ,mBAAkB;AACjC,OAAOC,QAAQ,UAAS;AACxB,OAAOC,UAAU,YAAW;AAE5B,SAAQC,IAAI,EAAEC,KAAK,QAAO,cAAa;AACvC,SAAQC,mBAAmB,EAAEC,aAAa,EAAEC,QAAQ,QAAO,mBAAkB;AAE7E,SAAQC,SAASC,aAAa,QAAO,WAAU;AAC/C,SAAQC,KAAK,EAAEC,SAAS,QAAO,QAAO;AACtC,OAAOC,WAAW,QAAO;AACzB,SAAQC,OAAO,EAAEC,aAAa,QAAO,YAAW;AAEhD,SAAQC,qBAAqB,QAAO,uCAAsC;AAC1E,SAAQC,SAAS,EAAEC,sBAAsB,QAAO,oCAAmC;AACnF,SAAQC,aAAa,QAAO,8BAA6B;AACzD,SAAQC,0BAA0B,EAAEC,mBAAmB,QAAO,oCAAmC;AAIjG,MAAMC,sBAAsBd,SAAS;AAErC,OAAO,MAAMe,8BAA8BhB;IACzC,OAAgBiB,OAAO;QACrBC,MAAMrB,KAAKsB,MAAM,CAAC;YAChBC,aAAa;YACbC,UAAU;QACZ;IACF,EAAC;IAED,OAAgBD,cAAc,+BAA8B;IAE5D,OAAgBE,WAAW;QACzB;YACEC,SAAS;YACTH,aAAa;QACf;QACA;YACEG,SAAS;YACTH,aAAa;QACf;QACA;YACEG,SAAS;YACTH,aACE;QACJ;QACA;YACEG,SAAS;YACTH,aACE;QACJ;KACD,CAAA;IAED,OAAgBI,QAAQ;QACtBC,SAAS3B,MAAMqB,MAAM,CAAC;YACpBO,MAAM;YACNN,aAAa;QACf;QACAO,IAAI7B,MAAMqB,MAAM,CAAC;YACfC,aACE;QACJ;QACAd,OAAOR,MAAM8B,OAAO,CAAC;YACnBR,aAAa;QACf;QACAS,SAAS/B,MAAM8B,OAAO,CAAC;YACrBR,aAAa;QACf;QACAU,SAAShC,MAAM8B,OAAO,CAAC;YACrBR,aACE;QACJ;QACAlB,OAAOJ,MAAM8B,OAAO,CAAC;YACnBR,aAAa;QACf;IACF,EAAC;IAEOW,OAAwD;IAEhE,MAAaC,MAAqB;QAChC,MAAM,EAACf,IAAI,EAAEO,KAAK,EAAC,GAAG,MAAM,IAAI,CAACS,KAAK,CAACjB;QACvC,MAAM,EAACE,IAAI,EAAC,GAAGD;QACf,MAAM,EAACQ,OAAO,EAAEE,EAAE,EAAErB,OAAO4B,QAAQ,EAAEL,OAAO,EAAEC,OAAO,EAAE5B,KAAK,EAAC,GAAGsB;QAChE,MAAMW,YAAY,MAAM,IAAI,CAACC,YAAY;QACzC,MAAMC,YAAY,MAAM,IAAI,CAACC,YAAY;QAEzC,IAAI,CAACD,WAAW;YACd,IAAI,CAACE,KAAK,CAAC3B,eAAe;gBAAC4B,MAAM;YAAC;QACpC;QAEA,IAAI,CAACL,UAAUM,GAAG,EAAEhB,WAAW,CAACA,SAAS;YACvC,IAAI,CAACc,KAAK,CACR,+FACA;gBAACC,MAAM;YAAC;QAEZ;QAEA,MAAME,gBAAgBjB,WAAWU,UAAUM,GAAG,EAAEhB;QAEhD,IAAI,CAACM,MAAM,GAAG,MAAMhC,oBAAoB;YACtC4C,YAAYlC;YACZgB,SAASiB;YACTL;YACAO,aAAa;QACf;QAEA,IAAId,WAAWD,SAAS;YACtB,IAAI,CAACU,KAAK,CAAC,2CAA2C;gBAACC,MAAM;YAAC;QAChE;QAEA,IAAIb,MAAMT,MAAM;YACd,IAAI,CAACqB,KAAK,CAAC,+CAA+C;gBAACC,MAAM;YAAC;QACpE;QAEA,IAAIK,YAAmC;QACvC,IAAIf,WAAWD,SAAS;YACtBgB,YAAYf,UAAU,oBAAoB;QAC5C;QAEA,IAAIZ,MAAM;YACR,IAAI;gBACF,MAAM4B,cAAclD,KAAKmD,OAAO,CAACC,QAAQC,GAAG,IAAI/B;gBAChD,MAAMgC,UAAU5C,MAAM2B,KAAK,CAAC,MAAMvC,GAAGyD,QAAQ,CAACL,aAAa;gBAC3D,MAAMM,SAAS,MAAM,IAAI,CAACC,cAAc,CAACH,SAASL;gBAClD,IAAI,CAACS,GAAG,CAAC,IAAI,CAACC,gBAAgB,CAACH,QAAQP;gBACvC;YACF,EAAE,OAAON,OAAO;gBACd,MAAMiB,MAAMjB;gBACZxB,oBAAoB,CAAC,mCAAmC,EAAEG,MAAM,EAAEsC;gBAClE,IAAI,CAACjB,KAAK,CAAC,CAAC,4BAA4B,EAAEiB,IAAIC,OAAO,EAAE,EAAE;oBAACjB,MAAM;gBAAC;YACnE;QACF;QAEA,IAAI;YACF,0EAA0E;YAC1E,MAAMkB,QAAQ/B,MAAMlC;YACpB,MAAMkE,MAAMzB,WAAW,UAAU;YACjC,4EAA4E;YAC5E,MAAM0B,UAAUhE,KAAKiE,IAAI,CAAClE,GAAGmE,MAAM,IAAI,cAAc,GAAGrE,aAAa,CAAC,EAAEiE,MAAM,CAAC,EAAEC,KAAK;YACtF,MAAMI,YAAY7B,WAAW5B,MAAMyD,SAAS,GAAGC,KAAKD,SAAS;YAC7D,MAAME,eAAe,AAACtC,MAAO,MAAM,IAAI,CAACI,MAAM,CAACmC,WAAW,CAACvC,OAAS;gBAClEwC,KAAKT;gBACLU,OAAO;YACT;YAEA,iEAAiE;YACjE,MAAMC,UAAUzE,KAAKiE,IAAI,CAAClE,GAAGmE,MAAM,IAAI;YACvC,MAAMpE,GAAG4E,KAAK,CAACD,SAAS;gBACtBE,MAAM;gBACNC,WAAW;YACb;YAEA,iEAAiE;YACjE,MAAM9E,GAAG+E,SAAS,CAACb,SAASG,UAAUE,cAAc,MAAM,IAAI;gBAC5DS,UAAU;gBACVH,MAAM;YACR;YAEA,MAAMI,SAASjE;YACf,MAAMkE,gCAAgC,IAAI,CAACA,6BAA6B,CAACC,IAAI,CAAC,IAAI,EAAEhC;YAEpF,IAAI3C,OAAO;gBACT,uFAAuF;gBACvFS,uBAAuBiD;gBACvB,IAAI,CAACN,GAAG,CAAC,CAAC,YAAY,EAAEM,SAAS;gBACjC,IAAI,CAACN,GAAG,CAAC;gBACT,IAAI,CAACA,GAAG,CAAC;gBAET,gCAAgC;gBAChC,IAAIwB,eAAe;gBACnB3E,cAAcyD,SAASmB,EAAE,CAAC,UAAU;oBAClC,IAAID,cAAc;wBAChB,QAAO,6BAA6B;oBACtC;oBACAA,eAAe;oBAEf,IAAI,CAACxB,GAAG,CAAC;oBACT,IAAI;wBACF,MAAMsB,8BAA8BhB,SAASK;oBAC/C,SAAU;wBACRa,eAAe;oBACjB;gBACF;gBACA1E,MAAMuE,OAAOK,GAAG,EAAE;uBAAIL,OAAO1D,IAAI;oBAAE2C;iBAAQ,EAAE;oBAACqB,OAAO;gBAAS;YAChE,OAAO;gBACL,4FAA4F;gBAC5F5E,UAAUsE,OAAOK,GAAG,EAAE;uBAAIL,OAAO1D,IAAI;oBAAE2C;iBAAQ,EAAE;oBAACqB,OAAO;gBAAS;gBAClE,MAAML,8BAA8BhB,SAASK;gBAC7C,MAAMvE,GAAGwF,MAAM,CAACtB,SAASuB,KAAK,CAAC,KAAO;YACxC;QACF,EAAE,OAAO5C,OAAO;YACd,MAAMiB,MAAMjB;YACZxB,oBAAoB,4BAA4ByC;YAChD,IAAI,CAACjB,KAAK,CAAC,CAAC,4BAA4B,EAAEiB,IAAIC,OAAO,EAAE,EAAE;gBAACjB,MAAM;YAAC;QACnE;IACF;IAEQ4C,gBAAgB3B,OAAe,EAAE4B,KAAa,EAAEC,QAAiB,EAAU;QACjF,OAAOA,WAAW,CAAC,SAAS,EAAE7B,SAAS,GAAG,CAAC,kBAAkB,EAAE4B,MAAM,CAAC,EAAE5B,SAAS;IACnF;IAEA;;GAEC,GACD,AAAQF,iBACNH,MAA8B,EAC9BP,SAAgC,EACxB;QACR,MAAM0C,SAAS;QACf,IAAI1C,cAAc,mBAAmB;YACnC,OAAO,CAAC,eAAe,EAAEO,OAAOoC,OAAO,CAACC,GAAG,CAAC,CAACC,MAAQA,IAAI/D,EAAE,EAAEkC,IAAI,CAAC0B,SAAS;QAC7E;QAEA,IAAI1C,cAAc,UAAU;YAC1B,OAAO,CAAC,cAAc,EAAEO,OAAOoC,OAAO,CAACC,GAAG,CAAC,CAACC,MAAQA,IAAI/D,EAAE,EAAEkC,IAAI,CAAC0B,SAAS;QAC5E;QAEA,gCAAgC;QAChC,MAAMI,UAAoB,EAAE;QAC5B,MAAMC,UAAoB,EAAE;QAC5B,KAAK,MAAMF,OAAOtC,OAAOoC,OAAO,CAAE;YAChC,IAAIE,IAAI7C,SAAS,KAAK,UAAU;gBAC9B+C,QAAQC,IAAI,CAACH,IAAI/D,EAAE;YACrB,OAAO;gBACLgE,QAAQE,IAAI,CAACH,IAAI/D,EAAE;YACrB;QACF;QAEA,IAAIgE,QAAQG,MAAM,GAAG,KAAKF,QAAQE,MAAM,GAAG,GAAG;YAC5C,OAAO;gBACL,CAAC,cAAc,EAAEH,QAAQ9B,IAAI,CAAC0B,SAAS;gBACvC,CAAC,yBAAyB,EAAEA,SAASK,QAAQ/B,IAAI,CAAC0B,SAAS;aAC5D,CAAC1B,IAAI,CAAC;QACT,OAAO,IAAI8B,QAAQG,MAAM,GAAG,GAAG;YAC7B,OAAO,CAAC,cAAc,EAAEH,QAAQ9B,IAAI,CAAC0B,SAAS;QAChD;QAEA,OAAO,CAAC,+BAA+B,EAAEK,QAAQ/B,IAAI,CAAC0B,SAAS;IACjE;IAEA;;GAEC,GACD,MAAcX,8BACZ/B,SAAgC,EAChCkD,QAAgB,EAChB9B,YAAqB,EACN;QACf,IAAIf;QACJ,IAAI;YACFA,UAAU5C,MAAM2B,KAAK,CAAC,MAAMvC,GAAGyD,QAAQ,CAAC4C,UAAU;QACpD,EAAE,OAAOvC,KAAK;YACZ,MAAMjB,QAAQiB;YACdzC,oBAAoB,CAAC,0BAA0B,EAAEgF,UAAU,EAAExD;YAC7D,IAAI,CAACe,GAAG,CAAC,CAAC,sBAAsB,EAAEf,MAAMkB,OAAO,EAAE;YACjD;QACF;QAEA,IAAIlD,QAAQ2C,SAASe,eAAe;YAClC,IAAI,CAACX,GAAG,CAAC;YACT,IAAI,CAACA,GAAG,CAAC;YACT;QACF;QAEA,IAAI;YACF,MAAM0C,cAAc,MAAM,IAAI,CAAC3C,cAAc,CAACH,SAASL;YACvD,IAAI,CAACS,GAAG,CAAC,IAAI,CAACC,gBAAgB,CAACyC,aAAanD;QAC9C,EAAE,OAAOW,KAAK;YACZ,MAAMjB,QAAQiB;YACdzC,oBAAoB,CAAC,yBAAyB,CAAC,EAAEwB;YACjD,IAAI0D,eAAe,CAAC,2BAA2B,EAAE1D,MAAMkB,OAAO,EAAE;YAChE,IAAIlB,MAAMkB,OAAO,CAACyC,QAAQ,CAAC,mBAAmB;gBAC5CD,gBAAgB;YAClB;YACA,IAAI,CAAC1D,KAAK,CAAC0D,cAAc;gBAACzD,MAAM;YAAC;QACnC;IACF;IAEA;;GAEC,GACD,AAAQ2D,iBAAiBC,GAAY,EAAEf,KAAa,EAAEgB,GAAc,EAAQ;QAC1E,MAAMf,WAAWe,IAAIP,MAAM,KAAK;QAEhC,IAAI,CAACtF,cAAc4F,MAAM;YACvB,MAAM,IAAIE,MAAM,IAAI,CAAClB,eAAe,CAAC,qBAAqBC,OAAOC;QACnE;QAEA,IAAI,CAACxE,oBAAoBsF,MAAM;YAC7B,MAAM,IAAIE,MACR,IAAI,CAAClB,eAAe,CAAC,+CAA+CC,OAAOC;QAE/E;QAEA,uDAAuD;QACvD,MAAMiB,SAASH;QAEf,8BAA8B;QAC9B,MAAMI,YAAYD,OAAOnC,KAAK,EAAEqC,WAAWC;QAC3C,IAAI,CAACF,WAAW;YACd,MAAM,IAAIF,MAAM,IAAI,CAAClB,eAAe,CAAC,yBAAyBC,OAAOC;QACvE;QAEA,gEAAgE;QAChE,IAAI,CAAC,4BAA4BqB,IAAI,CAACH,YAAY;YAChD,MAAM,IAAIF,MACR,IAAI,CAAClB,eAAe,CAClB,2GACAC,OACAC;QAGN;QAEA,iCAAiC;QACjC,IAAIiB,OAAOpC,GAAG,IAAI,OAAOoC,OAAOpC,GAAG,KAAK,UAAU;YAChD,MAAMyC,UAAUL,OAAOpC,GAAG,CAACuC,IAAI;YAC/B,IAAI,CAACE,SAAS;gBACZ,MAAM,IAAIN,MAAM,IAAI,CAAClB,eAAe,CAAC,uBAAuBC,OAAOC;YACrE;YAEA,qFAAqF;YACrF,IAAI,CAAC,oBAAoBqB,IAAI,CAACC,UAAU;gBACtC,MAAM,IAAIN,MACR,IAAI,CAAClB,eAAe,CAClB,gFACAC,OACAC;YAGN;YAEA,0DAA0D;YAC1D,IAAIsB,QAAQd,MAAM,GAAG,KAAK;gBACxB,MAAM,IAAIQ,MACR,IAAI,CAAClB,eAAe,CAAC,4CAA4CC,OAAOC;YAE5E;QACF;QAEA,2DAA2D;QAC3D,MAAMuB,iBAAiB;YAAC;YAAQ;YAAc;SAAa;QAC3D,KAAK,MAAMC,SAASD,eAAgB;YAClC,IAAIC,SAASP,QAAQ;gBACnB,oFAAoF;gBACpF,+DAA+D;gBAC/DxF,oBACE,CAAC,kBAAkB,EAAEsE,MAAM,0BAA0B,EAAEyB,MAAM,iCAAiC,CAAC;YAEnG;QACF;IACF;IAEA;;GAEC,GACD,MAAczD,eACZ0D,SAA0E,EAC1ElE,SAAgC,EACC;QACjC,MAAMmE,OAAOC,MAAMC,OAAO,CAACH,aAAaA,YAAY;YAACA;SAAU;QAC/D,IAAIC,KAAKlB,MAAM,KAAK,GAAG;YACrB,MAAM,IAAIQ,MAAM;QAClB;QAEA,MAAMa,YAAYH,KAAKvB,GAAG,CAAC,CAACW,KAAKf;YAC/B,IAAI,CAACc,gBAAgB,CAACC,KAAKf,OAAO2B;YAClC,IAAInE,cAAc,UAAU;gBAC1B,OAAO;oBAACuE,QAAQhB;gBAAG;YACrB;YAEA,IAAIvD,cAAc,qBAAqB;gBACrC,IAAIhC,2BAA2BuF,MAAM;oBACnC,OAAO;wBAACiB,mBAAmBjB;oBAAG;gBAChC;gBAEA,MAAM,IAAIE,MAAM,CAAC,mCAAmC,EAAEzD,WAAW;YACnE;YAEA,IAAIA,cAAc,mBAAmB;gBACnC,IAAIhC,2BAA2BuF,MAAM;oBACnC,OAAO;wBAACkB,iBAAiBlB;oBAAG;gBAC9B;gBAEA,MAAM,IAAIE,MAAM,CAAC,mCAAmC,EAAEzD,WAAW;YACnE;YAEA,MAAM,IAAIyD,MAAM,CAAC,sBAAsB,EAAEzD,WAAW;QACtD;QAEA,OAAO,IAAI,CAACd,MAAM,CAACwF,WAAW,CAACJ,WAAWK,MAAM;IAClD;AACF"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { Args, Flags } from '@oclif/core';
|
|
2
|
-
import { SanityCommand, subdebug } from '@sanity/cli-core';
|
|
2
|
+
import { getProjectCliClient, SanityCommand, subdebug } from '@sanity/cli-core';
|
|
3
3
|
import { DOCUMENTS_API_VERSION } from '../../actions/documents/constants.js';
|
|
4
4
|
import { NO_PROJECT_ID } from '../../util/errorMessages.js';
|
|
5
5
|
const deleteDocumentDebug = subdebug('documents:delete');
|
|
@@ -70,8 +70,7 @@ export class DeleteDocumentCommand extends SanityCommand {
|
|
|
70
70
|
}
|
|
71
71
|
const targetDataset = dataset || cliConfig.api?.dataset;
|
|
72
72
|
try {
|
|
73
|
-
|
|
74
|
-
const projectClient = await this.getProjectApiClient({
|
|
73
|
+
const projectClient = await getProjectCliClient({
|
|
75
74
|
apiVersion: DOCUMENTS_API_VERSION,
|
|
76
75
|
dataset: targetDataset,
|
|
77
76
|
projectId,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../src/commands/documents/delete.ts"],"sourcesContent":["import {Args, Flags} from '@oclif/core'\nimport {SanityCommand, subdebug} from '@sanity/cli-core'\n\nimport {DOCUMENTS_API_VERSION} from '../../actions/documents/constants.js'\nimport {NO_PROJECT_ID} from '../../util/errorMessages.js'\n\nconst deleteDocumentDebug = subdebug('documents:delete')\n\nexport class DeleteDocumentCommand extends SanityCommand<typeof DeleteDocumentCommand> {\n static override args = {\n id: Args.string({\n description: 'Document ID to delete',\n required: true,\n }),\n ids: Args.string({\n description: 'Additional document IDs to delete',\n required: false,\n }),\n }\n\n static override description = 'Delete one or more documents from the projects configured dataset'\n\n static override examples = [\n {\n command: '<%= config.bin %> <%= command.id %> myDocId',\n description: 'Delete the document with the ID \"myDocId\"',\n },\n {\n command: \"<%= config.bin %> <%= command.id %> 'myDocId'\",\n description: 'ID wrapped in double or single quote works equally well',\n },\n {\n command: '<%= config.bin %> <%= command.id %> --dataset=blog someDocId',\n description: 'Delete document with ID \"someDocId\" from dataset \"blog\"',\n },\n {\n command: '<%= config.bin %> <%= command.id %> doc1 doc2',\n description: 'Delete the document with ID \"doc1\" and \"doc2\"',\n },\n ]\n\n static override flags = {\n dataset: Flags.string({\n description: 'NAME to override dataset',\n }),\n }\n\n // Disable strict mode to allow for more flexible input\n // This is needed for supporting multiple document IDs\n static override strict = false\n\n public async run(): Promise<void> {\n const {args, argv, flags} = await this.parse(DeleteDocumentCommand)\n const {id} = args\n const {dataset} = flags\n\n // Collect all document IDs from args and argv\n const ids = [id, ...argv.slice(1)].filter(Boolean) as string[]\n\n if (ids.length === 0) {\n this.error('Document ID must be specified', {exit: 1})\n }\n\n // Get project configuration\n const cliConfig = await this.getCliConfig()\n const projectId = await this.getProjectId()\n\n if (!projectId) {\n this.error(NO_PROJECT_ID, {exit: 1})\n }\n\n if (!cliConfig.api?.dataset && !dataset) {\n this.error(\n 'No dataset specified. Either configure a dataset in sanity.cli.ts or use the --dataset flag',\n {exit: 1},\n )\n }\n\n const targetDataset = dataset || cliConfig.api?.dataset\n\n try {\n
|
|
1
|
+
{"version":3,"sources":["../../../src/commands/documents/delete.ts"],"sourcesContent":["import {Args, Flags} from '@oclif/core'\nimport {getProjectCliClient, SanityCommand, subdebug} from '@sanity/cli-core'\n\nimport {DOCUMENTS_API_VERSION} from '../../actions/documents/constants.js'\nimport {NO_PROJECT_ID} from '../../util/errorMessages.js'\n\nconst deleteDocumentDebug = subdebug('documents:delete')\n\nexport class DeleteDocumentCommand extends SanityCommand<typeof DeleteDocumentCommand> {\n static override args = {\n id: Args.string({\n description: 'Document ID to delete',\n required: true,\n }),\n ids: Args.string({\n description: 'Additional document IDs to delete',\n required: false,\n }),\n }\n\n static override description = 'Delete one or more documents from the projects configured dataset'\n\n static override examples = [\n {\n command: '<%= config.bin %> <%= command.id %> myDocId',\n description: 'Delete the document with the ID \"myDocId\"',\n },\n {\n command: \"<%= config.bin %> <%= command.id %> 'myDocId'\",\n description: 'ID wrapped in double or single quote works equally well',\n },\n {\n command: '<%= config.bin %> <%= command.id %> --dataset=blog someDocId',\n description: 'Delete document with ID \"someDocId\" from dataset \"blog\"',\n },\n {\n command: '<%= config.bin %> <%= command.id %> doc1 doc2',\n description: 'Delete the document with ID \"doc1\" and \"doc2\"',\n },\n ]\n\n static override flags = {\n dataset: Flags.string({\n description: 'NAME to override dataset',\n }),\n }\n\n // Disable strict mode to allow for more flexible input\n // This is needed for supporting multiple document IDs\n static override strict = false\n\n public async run(): Promise<void> {\n const {args, argv, flags} = await this.parse(DeleteDocumentCommand)\n const {id} = args\n const {dataset} = flags\n\n // Collect all document IDs from args and argv\n const ids = [id, ...argv.slice(1)].filter(Boolean) as string[]\n\n if (ids.length === 0) {\n this.error('Document ID must be specified', {exit: 1})\n }\n\n // Get project configuration\n const cliConfig = await this.getCliConfig()\n const projectId = await this.getProjectId()\n\n if (!projectId) {\n this.error(NO_PROJECT_ID, {exit: 1})\n }\n\n if (!cliConfig.api?.dataset && !dataset) {\n this.error(\n 'No dataset specified. Either configure a dataset in sanity.cli.ts or use the --dataset flag',\n {exit: 1},\n )\n }\n\n const targetDataset = dataset || cliConfig.api?.dataset\n\n try {\n const projectClient = await getProjectCliClient({\n apiVersion: DOCUMENTS_API_VERSION,\n dataset: targetDataset,\n projectId,\n requireUser: true,\n })\n\n const transaction = projectClient.transaction()\n for (const id of ids) {\n transaction.delete(id)\n }\n const {results} = await transaction.commit()\n const deleted = results.filter((res) => res.operation === 'delete').map((res) => res.id)\n const notFound = ids.filter((id) => !deleted.includes(id))\n\n if (deleted.length > 0) {\n this.log(`Deleted ${deleted.length} ${deleted.length === 1 ? 'document' : 'documents'}`)\n }\n\n if (notFound.length > 0) {\n this.error(\n `${notFound.length === 1 ? 'Document' : 'Documents'} not found: ${notFound.join(', ')}`,\n {\n exit: 1,\n },\n )\n }\n } catch (error) {\n const err = error as Error\n deleteDocumentDebug(`Error deleting documents ${ids.join(', ')}`, err)\n this.error(\n `Failed to delete ${ids.length} ${ids.length === 1 ? 'document' : 'documents'}: ${err.message}`,\n {\n exit: 1,\n },\n )\n }\n }\n}\n"],"names":["Args","Flags","getProjectCliClient","SanityCommand","subdebug","DOCUMENTS_API_VERSION","NO_PROJECT_ID","deleteDocumentDebug","DeleteDocumentCommand","args","id","string","description","required","ids","examples","command","flags","dataset","strict","run","argv","parse","slice","filter","Boolean","length","error","exit","cliConfig","getCliConfig","projectId","getProjectId","api","targetDataset","projectClient","apiVersion","requireUser","transaction","delete","results","commit","deleted","res","operation","map","notFound","includes","log","join","err","message"],"mappings":"AAAA,SAAQA,IAAI,EAAEC,KAAK,QAAO,cAAa;AACvC,SAAQC,mBAAmB,EAAEC,aAAa,EAAEC,QAAQ,QAAO,mBAAkB;AAE7E,SAAQC,qBAAqB,QAAO,uCAAsC;AAC1E,SAAQC,aAAa,QAAO,8BAA6B;AAEzD,MAAMC,sBAAsBH,SAAS;AAErC,OAAO,MAAMI,8BAA8BL;IACzC,OAAgBM,OAAO;QACrBC,IAAIV,KAAKW,MAAM,CAAC;YACdC,aAAa;YACbC,UAAU;QACZ;QACAC,KAAKd,KAAKW,MAAM,CAAC;YACfC,aAAa;YACbC,UAAU;QACZ;IACF,EAAC;IAED,OAAgBD,cAAc,oEAAmE;IAEjG,OAAgBG,WAAW;QACzB;YACEC,SAAS;YACTJ,aAAa;QACf;QACA;YACEI,SAAS;YACTJ,aAAa;QACf;QACA;YACEI,SAAS;YACTJ,aAAa;QACf;QACA;YACEI,SAAS;YACTJ,aAAa;QACf;KACD,CAAA;IAED,OAAgBK,QAAQ;QACtBC,SAASjB,MAAMU,MAAM,CAAC;YACpBC,aAAa;QACf;IACF,EAAC;IAED,uDAAuD;IACvD,sDAAsD;IACtD,OAAgBO,SAAS,MAAK;IAE9B,MAAaC,MAAqB;QAChC,MAAM,EAACX,IAAI,EAAEY,IAAI,EAAEJ,KAAK,EAAC,GAAG,MAAM,IAAI,CAACK,KAAK,CAACd;QAC7C,MAAM,EAACE,EAAE,EAAC,GAAGD;QACb,MAAM,EAACS,OAAO,EAAC,GAAGD;QAElB,8CAA8C;QAC9C,MAAMH,MAAM;YAACJ;eAAOW,KAAKE,KAAK,CAAC;SAAG,CAACC,MAAM,CAACC;QAE1C,IAAIX,IAAIY,MAAM,KAAK,GAAG;YACpB,IAAI,CAACC,KAAK,CAAC,iCAAiC;gBAACC,MAAM;YAAC;QACtD;QAEA,4BAA4B;QAC5B,MAAMC,YAAY,MAAM,IAAI,CAACC,YAAY;QACzC,MAAMC,YAAY,MAAM,IAAI,CAACC,YAAY;QAEzC,IAAI,CAACD,WAAW;YACd,IAAI,CAACJ,KAAK,CAACrB,eAAe;gBAACsB,MAAM;YAAC;QACpC;QAEA,IAAI,CAACC,UAAUI,GAAG,EAAEf,WAAW,CAACA,SAAS;YACvC,IAAI,CAACS,KAAK,CACR,+FACA;gBAACC,MAAM;YAAC;QAEZ;QAEA,MAAMM,gBAAgBhB,WAAWW,UAAUI,GAAG,EAAEf;QAEhD,IAAI;YACF,MAAMiB,gBAAgB,MAAMjC,oBAAoB;gBAC9CkC,YAAY/B;gBACZa,SAASgB;gBACTH;gBACAM,aAAa;YACf;YAEA,MAAMC,cAAcH,cAAcG,WAAW;YAC7C,KAAK,MAAM5B,MAAMI,IAAK;gBACpBwB,YAAYC,MAAM,CAAC7B;YACrB;YACA,MAAM,EAAC8B,OAAO,EAAC,GAAG,MAAMF,YAAYG,MAAM;YAC1C,MAAMC,UAAUF,QAAQhB,MAAM,CAAC,CAACmB,MAAQA,IAAIC,SAAS,KAAK,UAAUC,GAAG,CAAC,CAACF,MAAQA,IAAIjC,EAAE;YACvF,MAAMoC,WAAWhC,IAAIU,MAAM,CAAC,CAACd,KAAO,CAACgC,QAAQK,QAAQ,CAACrC;YAEtD,IAAIgC,QAAQhB,MAAM,GAAG,GAAG;gBACtB,IAAI,CAACsB,GAAG,CAAC,CAAC,QAAQ,EAAEN,QAAQhB,MAAM,CAAC,CAAC,EAAEgB,QAAQhB,MAAM,KAAK,IAAI,aAAa,aAAa;YACzF;YAEA,IAAIoB,SAASpB,MAAM,GAAG,GAAG;gBACvB,IAAI,CAACC,KAAK,CACR,GAAGmB,SAASpB,MAAM,KAAK,IAAI,aAAa,YAAY,YAAY,EAAEoB,SAASG,IAAI,CAAC,OAAO,EACvF;oBACErB,MAAM;gBACR;YAEJ;QACF,EAAE,OAAOD,OAAO;YACd,MAAMuB,MAAMvB;YACZpB,oBAAoB,CAAC,yBAAyB,EAAEO,IAAImC,IAAI,CAAC,OAAO,EAAEC;YAClE,IAAI,CAACvB,KAAK,CACR,CAAC,iBAAiB,EAAEb,IAAIY,MAAM,CAAC,CAAC,EAAEZ,IAAIY,MAAM,KAAK,IAAI,aAAa,YAAY,EAAE,EAAEwB,IAAIC,OAAO,EAAE,EAC/F;gBACEvB,MAAM;YACR;QAEJ;IACF;AACF"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { Args, Flags } from '@oclif/core';
|
|
2
|
-
import { colorizeJson, SanityCommand, subdebug } from '@sanity/cli-core';
|
|
2
|
+
import { colorizeJson, getProjectCliClient, SanityCommand, subdebug } from '@sanity/cli-core';
|
|
3
3
|
import { DOCUMENTS_API_VERSION } from '../../actions/documents/constants.js';
|
|
4
4
|
import { NO_PROJECT_ID } from '../../util/errorMessages.js';
|
|
5
5
|
const getDocumentDebug = subdebug('documents:get');
|
|
@@ -54,8 +54,7 @@ export class GetDocumentCommand extends SanityCommand {
|
|
|
54
54
|
}
|
|
55
55
|
const targetDataset = dataset || cliConfig.api?.dataset;
|
|
56
56
|
try {
|
|
57
|
-
|
|
58
|
-
const projectClient = await this.getProjectApiClient({
|
|
57
|
+
const projectClient = await getProjectCliClient({
|
|
59
58
|
apiVersion: DOCUMENTS_API_VERSION,
|
|
60
59
|
dataset: targetDataset,
|
|
61
60
|
projectId,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../src/commands/documents/get.ts"],"sourcesContent":["import {Args, Flags} from '@oclif/core'\nimport {colorizeJson, SanityCommand, subdebug} from '@sanity/cli-core'\n\nimport {DOCUMENTS_API_VERSION} from '../../actions/documents/constants.js'\nimport {NO_PROJECT_ID} from '../../util/errorMessages.js'\n\nconst getDocumentDebug = subdebug('documents:get')\n\nexport class GetDocumentCommand extends SanityCommand<typeof GetDocumentCommand> {\n static override args = {\n documentId: Args.string({\n description: 'Document ID to retrieve',\n required: true,\n }),\n }\n\n static override description = 'Get and print a document by ID'\n\n static override examples = [\n {\n command: '<%= config.bin %> <%= command.id %> myDocId',\n description: 'Get the document with ID \"myDocId\"',\n },\n {\n command: '<%= config.bin %> <%= command.id %> myDocId --pretty',\n description: 'Get document with colorized JSON output',\n },\n {\n command: '<%= config.bin %> <%= command.id %> myDocId --dataset production',\n description: 'Get document from a specific dataset',\n },\n ]\n\n static override flags = {\n dataset: Flags.string({\n char: 'd',\n description: 'Dataset to get document from (overrides config)',\n }),\n pretty: Flags.boolean({\n default: false,\n description: 'Colorize JSON output',\n }),\n }\n\n public async run(): Promise<void> {\n const {args, flags} = await this.parse(GetDocumentCommand)\n const {documentId} = args\n const {dataset, pretty} = flags\n\n // Get project configuration\n const cliConfig = await this.getCliConfig()\n const projectId = await this.getProjectId()\n\n if (!projectId) {\n this.error(NO_PROJECT_ID, {exit: 1})\n }\n\n if (!cliConfig.api?.dataset && !dataset) {\n this.error(\n 'No dataset specified. Either configure a dataset in sanity.cli.ts or use the --dataset flag',\n {exit: 1},\n )\n }\n\n const targetDataset = dataset || cliConfig.api?.dataset\n\n try {\n
|
|
1
|
+
{"version":3,"sources":["../../../src/commands/documents/get.ts"],"sourcesContent":["import {Args, Flags} from '@oclif/core'\nimport {colorizeJson, getProjectCliClient, SanityCommand, subdebug} from '@sanity/cli-core'\n\nimport {DOCUMENTS_API_VERSION} from '../../actions/documents/constants.js'\nimport {NO_PROJECT_ID} from '../../util/errorMessages.js'\n\nconst getDocumentDebug = subdebug('documents:get')\n\nexport class GetDocumentCommand extends SanityCommand<typeof GetDocumentCommand> {\n static override args = {\n documentId: Args.string({\n description: 'Document ID to retrieve',\n required: true,\n }),\n }\n\n static override description = 'Get and print a document by ID'\n\n static override examples = [\n {\n command: '<%= config.bin %> <%= command.id %> myDocId',\n description: 'Get the document with ID \"myDocId\"',\n },\n {\n command: '<%= config.bin %> <%= command.id %> myDocId --pretty',\n description: 'Get document with colorized JSON output',\n },\n {\n command: '<%= config.bin %> <%= command.id %> myDocId --dataset production',\n description: 'Get document from a specific dataset',\n },\n ]\n\n static override flags = {\n dataset: Flags.string({\n char: 'd',\n description: 'Dataset to get document from (overrides config)',\n }),\n pretty: Flags.boolean({\n default: false,\n description: 'Colorize JSON output',\n }),\n }\n\n public async run(): Promise<void> {\n const {args, flags} = await this.parse(GetDocumentCommand)\n const {documentId} = args\n const {dataset, pretty} = flags\n\n // Get project configuration\n const cliConfig = await this.getCliConfig()\n const projectId = await this.getProjectId()\n\n if (!projectId) {\n this.error(NO_PROJECT_ID, {exit: 1})\n }\n\n if (!cliConfig.api?.dataset && !dataset) {\n this.error(\n 'No dataset specified. Either configure a dataset in sanity.cli.ts or use the --dataset flag',\n {exit: 1},\n )\n }\n\n const targetDataset = dataset || cliConfig.api?.dataset\n\n try {\n const projectClient = await getProjectCliClient({\n apiVersion: DOCUMENTS_API_VERSION,\n dataset: targetDataset,\n projectId,\n requireUser: true,\n })\n\n const doc = await projectClient.getDocument(documentId)\n\n if (!doc) {\n this.error(`Document \"${documentId}\" not found in dataset \"${targetDataset}\"`, {exit: 1})\n }\n\n // Output the document\n if (pretty) {\n this.log(colorizeJson(doc))\n } else {\n this.log(JSON.stringify(doc, null, 2))\n }\n } catch (error) {\n const err = error as Error\n\n getDocumentDebug(`Error fetching document ${documentId}`, err)\n this.error(`Failed to fetch document: ${err.message}`, {exit: 1})\n }\n }\n}\n"],"names":["Args","Flags","colorizeJson","getProjectCliClient","SanityCommand","subdebug","DOCUMENTS_API_VERSION","NO_PROJECT_ID","getDocumentDebug","GetDocumentCommand","args","documentId","string","description","required","examples","command","flags","dataset","char","pretty","boolean","default","run","parse","cliConfig","getCliConfig","projectId","getProjectId","error","exit","api","targetDataset","projectClient","apiVersion","requireUser","doc","getDocument","log","JSON","stringify","err","message"],"mappings":"AAAA,SAAQA,IAAI,EAAEC,KAAK,QAAO,cAAa;AACvC,SAAQC,YAAY,EAAEC,mBAAmB,EAAEC,aAAa,EAAEC,QAAQ,QAAO,mBAAkB;AAE3F,SAAQC,qBAAqB,QAAO,uCAAsC;AAC1E,SAAQC,aAAa,QAAO,8BAA6B;AAEzD,MAAMC,mBAAmBH,SAAS;AAElC,OAAO,MAAMI,2BAA2BL;IACtC,OAAgBM,OAAO;QACrBC,YAAYX,KAAKY,MAAM,CAAC;YACtBC,aAAa;YACbC,UAAU;QACZ;IACF,EAAC;IAED,OAAgBD,cAAc,iCAAgC;IAE9D,OAAgBE,WAAW;QACzB;YACEC,SAAS;YACTH,aAAa;QACf;QACA;YACEG,SAAS;YACTH,aAAa;QACf;QACA;YACEG,SAAS;YACTH,aAAa;QACf;KACD,CAAA;IAED,OAAgBI,QAAQ;QACtBC,SAASjB,MAAMW,MAAM,CAAC;YACpBO,MAAM;YACNN,aAAa;QACf;QACAO,QAAQnB,MAAMoB,OAAO,CAAC;YACpBC,SAAS;YACTT,aAAa;QACf;IACF,EAAC;IAED,MAAaU,MAAqB;QAChC,MAAM,EAACb,IAAI,EAAEO,KAAK,EAAC,GAAG,MAAM,IAAI,CAACO,KAAK,CAACf;QACvC,MAAM,EAACE,UAAU,EAAC,GAAGD;QACrB,MAAM,EAACQ,OAAO,EAAEE,MAAM,EAAC,GAAGH;QAE1B,4BAA4B;QAC5B,MAAMQ,YAAY,MAAM,IAAI,CAACC,YAAY;QACzC,MAAMC,YAAY,MAAM,IAAI,CAACC,YAAY;QAEzC,IAAI,CAACD,WAAW;YACd,IAAI,CAACE,KAAK,CAACtB,eAAe;gBAACuB,MAAM;YAAC;QACpC;QAEA,IAAI,CAACL,UAAUM,GAAG,EAAEb,WAAW,CAACA,SAAS;YACvC,IAAI,CAACW,KAAK,CACR,+FACA;gBAACC,MAAM;YAAC;QAEZ;QAEA,MAAME,gBAAgBd,WAAWO,UAAUM,GAAG,EAAEb;QAEhD,IAAI;YACF,MAAMe,gBAAgB,MAAM9B,oBAAoB;gBAC9C+B,YAAY5B;gBACZY,SAASc;gBACTL;gBACAQ,aAAa;YACf;YAEA,MAAMC,MAAM,MAAMH,cAAcI,WAAW,CAAC1B;YAE5C,IAAI,CAACyB,KAAK;gBACR,IAAI,CAACP,KAAK,CAAC,CAAC,UAAU,EAAElB,WAAW,wBAAwB,EAAEqB,cAAc,CAAC,CAAC,EAAE;oBAACF,MAAM;gBAAC;YACzF;YAEA,sBAAsB;YACtB,IAAIV,QAAQ;gBACV,IAAI,CAACkB,GAAG,CAACpC,aAAakC;YACxB,OAAO;gBACL,IAAI,CAACE,GAAG,CAACC,KAAKC,SAAS,CAACJ,KAAK,MAAM;YACrC;QACF,EAAE,OAAOP,OAAO;YACd,MAAMY,MAAMZ;YAEZrB,iBAAiB,CAAC,wBAAwB,EAAEG,YAAY,EAAE8B;YAC1D,IAAI,CAACZ,KAAK,CAAC,CAAC,0BAA0B,EAAEY,IAAIC,OAAO,EAAE,EAAE;gBAACZ,MAAM;YAAC;QACjE;IACF;AACF"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { Args, Flags } from '@oclif/core';
|
|
2
|
-
import { colorizeJson, SanityCommand, subdebug } from '@sanity/cli-core';
|
|
2
|
+
import { colorizeJson, getProjectCliClient, SanityCommand, subdebug } from '@sanity/cli-core';
|
|
3
3
|
import { DOCUMENTS_API_VERSION } from '../../actions/documents/constants.js';
|
|
4
4
|
import { NO_PROJECT_ID } from '../../util/errorMessages.js';
|
|
5
5
|
const queryDocumentDebug = subdebug('documents:query');
|
|
@@ -72,8 +72,7 @@ export class QueryDocumentCommand extends SanityCommand {
|
|
|
72
72
|
this.warn(`--api-version not specified, using \`${DOCUMENTS_API_VERSION}\``);
|
|
73
73
|
}
|
|
74
74
|
try {
|
|
75
|
-
|
|
76
|
-
const projectClient = await this.getProjectApiClient({
|
|
75
|
+
const projectClient = await getProjectCliClient({
|
|
77
76
|
apiVersion: targetApiVersion,
|
|
78
77
|
dataset: targetDataset,
|
|
79
78
|
projectId: targetProject,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../src/commands/documents/query.ts"],"sourcesContent":["import {Args, Flags} from '@oclif/core'\nimport {colorizeJson, SanityCommand, subdebug} from '@sanity/cli-core'\n\nimport {DOCUMENTS_API_VERSION} from '../../actions/documents/constants.js'\nimport {NO_PROJECT_ID} from '../../util/errorMessages.js'\n\nconst queryDocumentDebug = subdebug('documents:query')\n\nexport class QueryDocumentCommand extends SanityCommand<typeof QueryDocumentCommand> {\n static override args = {\n query: Args.string({\n description: 'GROQ query to run against the dataset',\n required: true,\n }),\n }\n\n static override description = 'Query for documents'\n\n static override examples = [\n {\n command: '<%= config.bin %> <%= command.id %> \\'*[_type == \"movie\"][0..4]\\'',\n description: 'Fetch 5 documents of type \"movie\"',\n },\n {\n command:\n '<%= config.bin %> <%= command.id %> \\'*[_type == \"movie\"]|order(releaseDate asc)[0]{title}\\' --dataset staging',\n description: 'Fetch title of the oldest movie in the dataset named \"staging\"',\n },\n {\n command:\n '<%= config.bin %> <%= command.id %> \\'*[_id == \"header\"] { \"headerText\": pt::text(body) }\\' --api-version v2021-06-07',\n description: 'Use API version v2021-06-07 and do a query',\n },\n ]\n\n static override flags = {\n anonymous: Flags.boolean({\n default: false,\n description: 'Send the query without any authorization token',\n }),\n 'api-version': Flags.string({\n description: `API version to use (defaults to ${DOCUMENTS_API_VERSION})`,\n env: 'SANITY_CLI_QUERY_API_VERSION',\n }),\n dataset: Flags.string({\n char: 'd',\n description: 'Dataset to query (overrides config)',\n }),\n pretty: Flags.boolean({\n default: false,\n description: 'Colorize JSON output',\n }),\n project: Flags.string({\n char: 'p',\n description: 'Project ID to query (overrides config)',\n }),\n }\n\n public async run(): Promise<void> {\n const {args, flags} = await this.parse(QueryDocumentCommand)\n const {query} = args\n const {anonymous, 'api-version': apiVersion, dataset, pretty, project} = flags\n\n // Get project configuration\n const cliConfig = await this.getCliConfig()\n const configProjectId = await this.getProjectId()\n\n const targetProject = project || configProjectId\n const requireUser = !anonymous\n\n if (!targetProject) {\n this.error(NO_PROJECT_ID, {exit: 1})\n }\n\n if (!cliConfig.api?.dataset && !dataset) {\n this.error(\n 'No dataset specified. Either configure a dataset in sanity.cli.ts or use the --dataset flag',\n {exit: 1},\n )\n }\n\n const targetDataset = dataset || cliConfig.api?.dataset\n const targetApiVersion = apiVersion || DOCUMENTS_API_VERSION\n\n if (!apiVersion) {\n this.warn(`--api-version not specified, using \\`${DOCUMENTS_API_VERSION}\\``)\n }\n\n try {\n
|
|
1
|
+
{"version":3,"sources":["../../../src/commands/documents/query.ts"],"sourcesContent":["import {Args, Flags} from '@oclif/core'\nimport {colorizeJson, getProjectCliClient, SanityCommand, subdebug} from '@sanity/cli-core'\n\nimport {DOCUMENTS_API_VERSION} from '../../actions/documents/constants.js'\nimport {NO_PROJECT_ID} from '../../util/errorMessages.js'\n\nconst queryDocumentDebug = subdebug('documents:query')\n\nexport class QueryDocumentCommand extends SanityCommand<typeof QueryDocumentCommand> {\n static override args = {\n query: Args.string({\n description: 'GROQ query to run against the dataset',\n required: true,\n }),\n }\n\n static override description = 'Query for documents'\n\n static override examples = [\n {\n command: '<%= config.bin %> <%= command.id %> \\'*[_type == \"movie\"][0..4]\\'',\n description: 'Fetch 5 documents of type \"movie\"',\n },\n {\n command:\n '<%= config.bin %> <%= command.id %> \\'*[_type == \"movie\"]|order(releaseDate asc)[0]{title}\\' --dataset staging',\n description: 'Fetch title of the oldest movie in the dataset named \"staging\"',\n },\n {\n command:\n '<%= config.bin %> <%= command.id %> \\'*[_id == \"header\"] { \"headerText\": pt::text(body) }\\' --api-version v2021-06-07',\n description: 'Use API version v2021-06-07 and do a query',\n },\n ]\n\n static override flags = {\n anonymous: Flags.boolean({\n default: false,\n description: 'Send the query without any authorization token',\n }),\n 'api-version': Flags.string({\n description: `API version to use (defaults to ${DOCUMENTS_API_VERSION})`,\n env: 'SANITY_CLI_QUERY_API_VERSION',\n }),\n dataset: Flags.string({\n char: 'd',\n description: 'Dataset to query (overrides config)',\n }),\n pretty: Flags.boolean({\n default: false,\n description: 'Colorize JSON output',\n }),\n project: Flags.string({\n char: 'p',\n description: 'Project ID to query (overrides config)',\n }),\n }\n\n public async run(): Promise<void> {\n const {args, flags} = await this.parse(QueryDocumentCommand)\n const {query} = args\n const {anonymous, 'api-version': apiVersion, dataset, pretty, project} = flags\n\n // Get project configuration\n const cliConfig = await this.getCliConfig()\n const configProjectId = await this.getProjectId()\n\n const targetProject = project || configProjectId\n const requireUser = !anonymous\n\n if (!targetProject) {\n this.error(NO_PROJECT_ID, {exit: 1})\n }\n\n if (!cliConfig.api?.dataset && !dataset) {\n this.error(\n 'No dataset specified. Either configure a dataset in sanity.cli.ts or use the --dataset flag',\n {exit: 1},\n )\n }\n\n const targetDataset = dataset || cliConfig.api?.dataset\n const targetApiVersion = apiVersion || DOCUMENTS_API_VERSION\n\n if (!apiVersion) {\n this.warn(`--api-version not specified, using \\`${DOCUMENTS_API_VERSION}\\``)\n }\n\n try {\n const projectClient = await getProjectCliClient({\n apiVersion: targetApiVersion,\n dataset: targetDataset,\n projectId: targetProject,\n requireUser,\n })\n\n const docs = await projectClient.fetch(query)\n\n if (!docs) {\n this.error('Query returned no results', {exit: 1})\n }\n\n // Output the query results\n if (pretty) {\n this.log(colorizeJson(docs))\n } else {\n this.log(JSON.stringify(docs, null, 2))\n }\n } catch (error) {\n const err = error as Error\n\n queryDocumentDebug(`Error running query: ${query}`, err)\n\n // Provide more context in error messages\n const errorMsg = err.message.toLowerCase().includes('syntax')\n ? `Invalid GROQ query syntax: ${err.message}`\n : `Failed to run query: ${err.message}`\n\n this.error(`${errorMsg}\\nQuery: ${query}`, {exit: 1})\n }\n }\n}\n"],"names":["Args","Flags","colorizeJson","getProjectCliClient","SanityCommand","subdebug","DOCUMENTS_API_VERSION","NO_PROJECT_ID","queryDocumentDebug","QueryDocumentCommand","args","query","string","description","required","examples","command","flags","anonymous","boolean","default","env","dataset","char","pretty","project","run","parse","apiVersion","cliConfig","getCliConfig","configProjectId","getProjectId","targetProject","requireUser","error","exit","api","targetDataset","targetApiVersion","warn","projectClient","projectId","docs","fetch","log","JSON","stringify","err","errorMsg","message","toLowerCase","includes"],"mappings":"AAAA,SAAQA,IAAI,EAAEC,KAAK,QAAO,cAAa;AACvC,SAAQC,YAAY,EAAEC,mBAAmB,EAAEC,aAAa,EAAEC,QAAQ,QAAO,mBAAkB;AAE3F,SAAQC,qBAAqB,QAAO,uCAAsC;AAC1E,SAAQC,aAAa,QAAO,8BAA6B;AAEzD,MAAMC,qBAAqBH,SAAS;AAEpC,OAAO,MAAMI,6BAA6BL;IACxC,OAAgBM,OAAO;QACrBC,OAAOX,KAAKY,MAAM,CAAC;YACjBC,aAAa;YACbC,UAAU;QACZ;IACF,EAAC;IAED,OAAgBD,cAAc,sBAAqB;IAEnD,OAAgBE,WAAW;QACzB;YACEC,SAAS;YACTH,aAAa;QACf;QACA;YACEG,SACE;YACFH,aAAa;QACf;QACA;YACEG,SACE;YACFH,aAAa;QACf;KACD,CAAA;IAED,OAAgBI,QAAQ;QACtBC,WAAWjB,MAAMkB,OAAO,CAAC;YACvBC,SAAS;YACTP,aAAa;QACf;QACA,eAAeZ,MAAMW,MAAM,CAAC;YAC1BC,aAAa,CAAC,gCAAgC,EAAEP,sBAAsB,CAAC,CAAC;YACxEe,KAAK;QACP;QACAC,SAASrB,MAAMW,MAAM,CAAC;YACpBW,MAAM;YACNV,aAAa;QACf;QACAW,QAAQvB,MAAMkB,OAAO,CAAC;YACpBC,SAAS;YACTP,aAAa;QACf;QACAY,SAASxB,MAAMW,MAAM,CAAC;YACpBW,MAAM;YACNV,aAAa;QACf;IACF,EAAC;IAED,MAAaa,MAAqB;QAChC,MAAM,EAAChB,IAAI,EAAEO,KAAK,EAAC,GAAG,MAAM,IAAI,CAACU,KAAK,CAAClB;QACvC,MAAM,EAACE,KAAK,EAAC,GAAGD;QAChB,MAAM,EAACQ,SAAS,EAAE,eAAeU,UAAU,EAAEN,OAAO,EAAEE,MAAM,EAAEC,OAAO,EAAC,GAAGR;QAEzE,4BAA4B;QAC5B,MAAMY,YAAY,MAAM,IAAI,CAACC,YAAY;QACzC,MAAMC,kBAAkB,MAAM,IAAI,CAACC,YAAY;QAE/C,MAAMC,gBAAgBR,WAAWM;QACjC,MAAMG,cAAc,CAAChB;QAErB,IAAI,CAACe,eAAe;YAClB,IAAI,CAACE,KAAK,CAAC5B,eAAe;gBAAC6B,MAAM;YAAC;QACpC;QAEA,IAAI,CAACP,UAAUQ,GAAG,EAAEf,WAAW,CAACA,SAAS;YACvC,IAAI,CAACa,KAAK,CACR,+FACA;gBAACC,MAAM;YAAC;QAEZ;QAEA,MAAME,gBAAgBhB,WAAWO,UAAUQ,GAAG,EAAEf;QAChD,MAAMiB,mBAAmBX,cAActB;QAEvC,IAAI,CAACsB,YAAY;YACf,IAAI,CAACY,IAAI,CAAC,CAAC,qCAAqC,EAAElC,sBAAsB,EAAE,CAAC;QAC7E;QAEA,IAAI;YACF,MAAMmC,gBAAgB,MAAMtC,oBAAoB;gBAC9CyB,YAAYW;gBACZjB,SAASgB;gBACTI,WAAWT;gBACXC;YACF;YAEA,MAAMS,OAAO,MAAMF,cAAcG,KAAK,CAACjC;YAEvC,IAAI,CAACgC,MAAM;gBACT,IAAI,CAACR,KAAK,CAAC,6BAA6B;oBAACC,MAAM;gBAAC;YAClD;YAEA,2BAA2B;YAC3B,IAAIZ,QAAQ;gBACV,IAAI,CAACqB,GAAG,CAAC3C,aAAayC;YACxB,OAAO;gBACL,IAAI,CAACE,GAAG,CAACC,KAAKC,SAAS,CAACJ,MAAM,MAAM;YACtC;QACF,EAAE,OAAOR,OAAO;YACd,MAAMa,MAAMb;YAEZ3B,mBAAmB,CAAC,qBAAqB,EAAEG,OAAO,EAAEqC;YAEpD,yCAAyC;YACzC,MAAMC,WAAWD,IAAIE,OAAO,CAACC,WAAW,GAAGC,QAAQ,CAAC,YAChD,CAAC,2BAA2B,EAAEJ,IAAIE,OAAO,EAAE,GAC3C,CAAC,qBAAqB,EAAEF,IAAIE,OAAO,EAAE;YAEzC,IAAI,CAACf,KAAK,CAAC,GAAGc,SAAS,SAAS,EAAEtC,OAAO,EAAE;gBAACyB,MAAM;YAAC;QACrD;IACF;AACF"}
|
|
@@ -3,7 +3,6 @@ import path from 'node:path';
|
|
|
3
3
|
import { Flags } from '@oclif/core';
|
|
4
4
|
import { SanityCommand } from '@sanity/cli-core';
|
|
5
5
|
import { chalk, confirm, logSymbols } from '@sanity/cli-core/ux';
|
|
6
|
-
import { DOCUMENTS_API_VERSION } from '../../actions/documents/constants.js';
|
|
7
6
|
import { validateDocuments } from '../../actions/documents/validate.js';
|
|
8
7
|
import { reporters } from '../../actions/documents/validation/reporters/index.js';
|
|
9
8
|
export class ValidateDocumentsCommand extends SanityCommand {
|
|
@@ -72,10 +71,6 @@ export class ValidateDocumentsCommand extends SanityCommand {
|
|
|
72
71
|
async run() {
|
|
73
72
|
const { flags } = await this.parse(ValidateDocumentsCommand);
|
|
74
73
|
const unattendedMode = Boolean(flags.yes);
|
|
75
|
-
const apiClient = await this.getGlobalApiClient({
|
|
76
|
-
apiVersion: DOCUMENTS_API_VERSION,
|
|
77
|
-
requireUser: true
|
|
78
|
-
});
|
|
79
74
|
const cliConfig = await this.getCliConfig();
|
|
80
75
|
const workDir = (await this.getProjectRoot()).directory;
|
|
81
76
|
if (!unattendedMode) {
|
|
@@ -107,20 +102,6 @@ export class ValidateDocumentsCommand extends SanityCommand {
|
|
|
107
102
|
const level = flags.level;
|
|
108
103
|
const maxCustomValidationConcurrency = flags['max-custom-validation-concurrency'];
|
|
109
104
|
const maxFetchConcurrency = flags['max-fetch-concurrency'];
|
|
110
|
-
const clientConfig = {
|
|
111
|
-
...apiClient.config(),
|
|
112
|
-
// we set this explictly to true because we pass in a token via the
|
|
113
|
-
// `clientConfiguration` object and also mock a browser environment in
|
|
114
|
-
// this worker which triggers the browser warning
|
|
115
|
-
ignoreBrowserTokenWarning: true,
|
|
116
|
-
// Removing from object so config can be serialized
|
|
117
|
-
// before sent to validation worker
|
|
118
|
-
requester: undefined,
|
|
119
|
-
// we set this explictly to true because the default client configuration
|
|
120
|
-
// from the CLI comes configured with `useProjectHostname: false` when
|
|
121
|
-
// `requireProject` is set to false
|
|
122
|
-
useProjectHostname: true
|
|
123
|
-
};
|
|
124
105
|
let ndjsonFilePath;
|
|
125
106
|
if (flags.file) {
|
|
126
107
|
const filePath = path.resolve(workDir, flags.file);
|
|
@@ -131,7 +112,6 @@ export class ValidateDocumentsCommand extends SanityCommand {
|
|
|
131
112
|
ndjsonFilePath = filePath;
|
|
132
113
|
}
|
|
133
114
|
const overallLevel = await validateDocuments({
|
|
134
|
-
clientConfig,
|
|
135
115
|
dataset: flags.dataset,
|
|
136
116
|
level,
|
|
137
117
|
maxCustomValidationConcurrency,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../src/commands/documents/validate.ts"],"sourcesContent":["import fs from 'node:fs'\nimport path from 'node:path'\n\nimport {Flags} from '@oclif/core'\nimport {Output, SanityCommand} from '@sanity/cli-core'\nimport {chalk, confirm, logSymbols} from '@sanity/cli-core/ux'\nimport {type ClientConfig} from '@sanity/client'\n\nimport {DOCUMENTS_API_VERSION} from '../../actions/documents/constants.js'\nimport {Level} from '../../actions/documents/types.js'\nimport {validateDocuments} from '../../actions/documents/validate.js'\nimport {reporters} from '../../actions/documents/validation/reporters/index.js'\nimport {type ValidationWorkerChannel} from '../../threads/validateDocuments.js'\nimport {type WorkerChannelReceiver} from '../../util/workerChannels.js'\n\ntype ValidateDocumentsCommandFlags = ValidateDocumentsCommand['flags']\n\nexport type BuiltInValidationReporter = (options: {\n flags: ValidateDocumentsCommandFlags\n output: Output\n worker: WorkerChannelReceiver<ValidationWorkerChannel>\n}) => Promise<Level>\n\nexport class ValidateDocumentsCommand extends SanityCommand<typeof ValidateDocumentsCommand> {\n static description = 'Validate documents in a dataset against the studio schema'\n\n static examples = [\n {\n command: '<%= config.bin %> <%= command.id %> --workspace default',\n description: 'Validates all documents in a Sanity project with more than one workspace',\n },\n {\n command: '<%= config.bin %> <%= command.id %> --workspace default --dataset staging',\n description: 'Override the dataset specified in the workspace',\n },\n {\n command: '<%= config.bin %> <%= command.id %> --yes > report.txt',\n description: 'Save the results of the report into a file',\n },\n {\n command: '<%= config.bin %> <%= command.id %> --level info',\n description: 'Report out info level validation markers too',\n },\n ]\n\n static flags = {\n dataset: Flags.string({\n char: 'd',\n description:\n 'Override the dataset used. By default, this is derived from the given workspace',\n }),\n file: Flags.string({\n description:\n 'Provide a path to either an .ndjson file or a tarball containing an .ndjson file',\n }),\n format: Flags.string({\n description:\n 'The output format used to print the found validation markers and report progress',\n }),\n level: Flags.custom<Level>({\n default: 'warning',\n description: 'The minimum level reported out. Defaults to warning',\n options: ['error', 'warning', 'info'],\n parse: async (input) => {\n if (input !== 'error' && input !== 'warning' && input !== 'info') {\n throw new Error(`Invalid level: ${input}. Must be 'error', 'warning', or 'info'`)\n }\n return input as Level\n },\n })(),\n 'max-custom-validation-concurrency': Flags.integer({\n default: 5,\n description: 'Specify how many custom validators can run concurrently',\n }),\n 'max-fetch-concurrency': Flags.integer({\n default: 25,\n description: 'Specify how many `client.fetch` requests are allow concurrency at once',\n }),\n workspace: Flags.string({\n description: 'The name of the workspace to use when downloading and validating all documents',\n }),\n yes: Flags.boolean({\n char: 'y',\n default: false,\n description: 'Skips the first confirmation prompt',\n }),\n }\n\n public async run(): Promise<void> {\n const {flags} = await this.parse(ValidateDocumentsCommand)\n const unattendedMode = Boolean(flags.yes)\n\n const apiClient = await this.getGlobalApiClient({\n apiVersion: DOCUMENTS_API_VERSION,\n requireUser: true,\n })\n const cliConfig = await this.getCliConfig()\n const workDir = (await this.getProjectRoot()).directory\n\n if (!unattendedMode) {\n this.log(\n `${chalk.yellow(`${logSymbols.warning} Warning:`)} This command ${\n flags.file\n ? 'reads all documents from your input file'\n : 'downloads all documents from your dataset'\n } and processes them through your local schema within a ` +\n `simulated browser environment.\\n`,\n )\n this.log(`Potential pitfalls:\\n`)\n this.log(\n `- Processes all documents locally (excluding assets). Large datasets may require more resources.`,\n )\n this.log(\n `- Executes all custom validation functions. Some functions may need to be refactored for compatibility.`,\n )\n this.log(\n `- Not all standard browser features are available and may cause issues while loading your Studio.`,\n )\n this.log(\n `- Adheres to document permissions. Ensure this account can see all desired documents.`,\n )\n if (flags.file) {\n this.log(\n `- Checks for missing document references against the live dataset if not found in your file.`,\n )\n }\n\n const confirmed = await confirm({\n default: true,\n message: `Are you sure you want to continue?`,\n })\n\n if (!confirmed) {\n this.log('User aborted')\n this.exit(1)\n }\n }\n\n if (flags.format && !(flags.format in reporters)) {\n const formatter = new Intl.ListFormat('en-US', {\n style: 'long',\n type: 'conjunction',\n })\n throw new Error(\n `Did not recognize format '${flags.format}'. Available formats are ${formatter.format(\n Object.keys(reporters).map((key) => `'${key}'`),\n )}`,\n )\n }\n\n const level = flags.level\n const maxCustomValidationConcurrency = flags['max-custom-validation-concurrency']\n const maxFetchConcurrency = flags['max-fetch-concurrency']\n\n const clientConfig: ClientConfig = {\n ...apiClient.config(),\n // we set this explictly to true because we pass in a token via the\n // `clientConfiguration` object and also mock a browser environment in\n // this worker which triggers the browser warning\n ignoreBrowserTokenWarning: true,\n // Removing from object so config can be serialized\n // before sent to validation worker\n requester: undefined,\n // we set this explictly to true because the default client configuration\n // from the CLI comes configured with `useProjectHostname: false` when\n // `requireProject` is set to false\n useProjectHostname: true,\n }\n\n let ndjsonFilePath\n if (flags.file) {\n const filePath = path.resolve(workDir, flags.file)\n\n const stat = await fs.promises.stat(filePath)\n if (!stat.isFile()) {\n this.error(`'--file' must point to a valid ndjson file or tarball`)\n }\n\n ndjsonFilePath = filePath\n }\n\n const overallLevel = await validateDocuments({\n clientConfig,\n dataset: flags.dataset,\n level,\n maxCustomValidationConcurrency,\n maxFetchConcurrency,\n ndjsonFilePath,\n reporter: (worker) => {\n const reporter =\n flags.format && flags.format in reporters\n ? reporters[flags.format as keyof typeof reporters]\n : reporters.pretty\n\n return reporter({flags, output: this.output, worker})\n },\n studioHost: cliConfig?.studioHost,\n workDir,\n workspace: flags.workspace,\n })\n\n if (overallLevel === 'error') {\n this.exit(1)\n }\n }\n}\n"],"names":["fs","path","Flags","SanityCommand","chalk","confirm","logSymbols","DOCUMENTS_API_VERSION","validateDocuments","reporters","ValidateDocumentsCommand","description","examples","command","flags","dataset","string","char","file","format","level","custom","default","options","parse","input","Error","integer","workspace","yes","boolean","run","unattendedMode","Boolean","apiClient","getGlobalApiClient","apiVersion","requireUser","cliConfig","getCliConfig","workDir","getProjectRoot","directory","log","yellow","warning","confirmed","message","exit","formatter","Intl","ListFormat","style","type","Object","keys","map","key","maxCustomValidationConcurrency","maxFetchConcurrency","clientConfig","config","ignoreBrowserTokenWarning","requester","undefined","useProjectHostname","ndjsonFilePath","filePath","resolve","stat","promises","isFile","error","overallLevel","reporter","worker","pretty","output","studioHost"],"mappings":"AAAA,OAAOA,QAAQ,UAAS;AACxB,OAAOC,UAAU,YAAW;AAE5B,SAAQC,KAAK,QAAO,cAAa;AACjC,SAAgBC,aAAa,QAAO,mBAAkB;AACtD,SAAQC,KAAK,EAAEC,OAAO,EAAEC,UAAU,QAAO,sBAAqB;AAG9D,SAAQC,qBAAqB,QAAO,uCAAsC;AAE1E,SAAQC,iBAAiB,QAAO,sCAAqC;AACrE,SAAQC,SAAS,QAAO,wDAAuD;AAY/E,OAAO,MAAMC,iCAAiCP;IAC5C,OAAOQ,cAAc,4DAA2D;IAEhF,OAAOC,WAAW;QAChB;YACEC,SAAS;YACTF,aAAa;QACf;QACA;YACEE,SAAS;YACTF,aAAa;QACf;QACA;YACEE,SAAS;YACTF,aAAa;QACf;QACA;YACEE,SAAS;YACTF,aAAa;QACf;KACD,CAAA;IAED,OAAOG,QAAQ;QACbC,SAASb,MAAMc,MAAM,CAAC;YACpBC,MAAM;YACNN,aACE;QACJ;QACAO,MAAMhB,MAAMc,MAAM,CAAC;YACjBL,aACE;QACJ;QACAQ,QAAQjB,MAAMc,MAAM,CAAC;YACnBL,aACE;QACJ;QACAS,OAAOlB,MAAMmB,MAAM,CAAQ;YACzBC,SAAS;YACTX,aAAa;YACbY,SAAS;gBAAC;gBAAS;gBAAW;aAAO;YACrCC,OAAO,OAAOC;gBACZ,IAAIA,UAAU,WAAWA,UAAU,aAAaA,UAAU,QAAQ;oBAChE,MAAM,IAAIC,MAAM,CAAC,eAAe,EAAED,MAAM,uCAAuC,CAAC;gBAClF;gBACA,OAAOA;YACT;QACF;QACA,qCAAqCvB,MAAMyB,OAAO,CAAC;YACjDL,SAAS;YACTX,aAAa;QACf;QACA,yBAAyBT,MAAMyB,OAAO,CAAC;YACrCL,SAAS;YACTX,aAAa;QACf;QACAiB,WAAW1B,MAAMc,MAAM,CAAC;YACtBL,aAAa;QACf;QACAkB,KAAK3B,MAAM4B,OAAO,CAAC;YACjBb,MAAM;YACNK,SAAS;YACTX,aAAa;QACf;IACF,EAAC;IAED,MAAaoB,MAAqB;QAChC,MAAM,EAACjB,KAAK,EAAC,GAAG,MAAM,IAAI,CAACU,KAAK,CAACd;QACjC,MAAMsB,iBAAiBC,QAAQnB,MAAMe,GAAG;QAExC,MAAMK,YAAY,MAAM,IAAI,CAACC,kBAAkB,CAAC;YAC9CC,YAAY7B;YACZ8B,aAAa;QACf;QACA,MAAMC,YAAY,MAAM,IAAI,CAACC,YAAY;QACzC,MAAMC,UAAU,AAAC,CAAA,MAAM,IAAI,CAACC,cAAc,EAAC,EAAGC,SAAS;QAEvD,IAAI,CAACV,gBAAgB;YACnB,IAAI,CAACW,GAAG,CACN,GAAGvC,MAAMwC,MAAM,CAAC,GAAGtC,WAAWuC,OAAO,CAAC,SAAS,CAAC,EAAE,cAAc,EAC9D/B,MAAMI,IAAI,GACN,6CACA,4CACL,uDAAuD,CAAC,GACvD,CAAC,gCAAgC,CAAC;YAEtC,IAAI,CAACyB,GAAG,CAAC,CAAC,qBAAqB,CAAC;YAChC,IAAI,CAACA,GAAG,CACN,CAAC,gGAAgG,CAAC;YAEpG,IAAI,CAACA,GAAG,CACN,CAAC,uGAAuG,CAAC;YAE3G,IAAI,CAACA,GAAG,CACN,CAAC,iGAAiG,CAAC;YAErG,IAAI,CAACA,GAAG,CACN,CAAC,qFAAqF,CAAC;YAEzF,IAAI7B,MAAMI,IAAI,EAAE;gBACd,IAAI,CAACyB,GAAG,CACN,CAAC,4FAA4F,CAAC;YAElG;YAEA,MAAMG,YAAY,MAAMzC,QAAQ;gBAC9BiB,SAAS;gBACTyB,SAAS,CAAC,kCAAkC,CAAC;YAC/C;YAEA,IAAI,CAACD,WAAW;gBACd,IAAI,CAACH,GAAG,CAAC;gBACT,IAAI,CAACK,IAAI,CAAC;YACZ;QACF;QAEA,IAAIlC,MAAMK,MAAM,IAAI,CAAEL,CAAAA,MAAMK,MAAM,IAAIV,SAAQ,GAAI;YAChD,MAAMwC,YAAY,IAAIC,KAAKC,UAAU,CAAC,SAAS;gBAC7CC,OAAO;gBACPC,MAAM;YACR;YACA,MAAM,IAAI3B,MACR,CAAC,0BAA0B,EAAEZ,MAAMK,MAAM,CAAC,yBAAyB,EAAE8B,UAAU9B,MAAM,CACnFmC,OAAOC,IAAI,CAAC9C,WAAW+C,GAAG,CAAC,CAACC,MAAQ,CAAC,CAAC,EAAEA,IAAI,CAAC,CAAC,IAC7C;QAEP;QAEA,MAAMrC,QAAQN,MAAMM,KAAK;QACzB,MAAMsC,iCAAiC5C,KAAK,CAAC,oCAAoC;QACjF,MAAM6C,sBAAsB7C,KAAK,CAAC,wBAAwB;QAE1D,MAAM8C,eAA6B;YACjC,GAAG1B,UAAU2B,MAAM,EAAE;YACrB,mEAAmE;YACnE,sEAAsE;YACtE,iDAAiD;YACjDC,2BAA2B;YAC3B,mDAAmD;YACnD,mCAAmC;YACnCC,WAAWC;YACX,yEAAyE;YACzE,sEAAsE;YACtE,mCAAmC;YACnCC,oBAAoB;QACtB;QAEA,IAAIC;QACJ,IAAIpD,MAAMI,IAAI,EAAE;YACd,MAAMiD,WAAWlE,KAAKmE,OAAO,CAAC5B,SAAS1B,MAAMI,IAAI;YAEjD,MAAMmD,OAAO,MAAMrE,GAAGsE,QAAQ,CAACD,IAAI,CAACF;YACpC,IAAI,CAACE,KAAKE,MAAM,IAAI;gBAClB,IAAI,CAACC,KAAK,CAAC,CAAC,qDAAqD,CAAC;YACpE;YAEAN,iBAAiBC;QACnB;QAEA,MAAMM,eAAe,MAAMjE,kBAAkB;YAC3CoD;YACA7C,SAASD,MAAMC,OAAO;YACtBK;YACAsC;YACAC;YACAO;YACAQ,UAAU,CAACC;gBACT,MAAMD,WACJ5D,MAAMK,MAAM,IAAIL,MAAMK,MAAM,IAAIV,YAC5BA,SAAS,CAACK,MAAMK,MAAM,CAA2B,GACjDV,UAAUmE,MAAM;gBAEtB,OAAOF,SAAS;oBAAC5D;oBAAO+D,QAAQ,IAAI,CAACA,MAAM;oBAAEF;gBAAM;YACrD;YACAG,YAAYxC,WAAWwC;YACvBtC;YACAZ,WAAWd,MAAMc,SAAS;QAC5B;QAEA,IAAI6C,iBAAiB,SAAS;YAC5B,IAAI,CAACzB,IAAI,CAAC;QACZ;IACF;AACF"}
|
|
1
|
+
{"version":3,"sources":["../../../src/commands/documents/validate.ts"],"sourcesContent":["import fs from 'node:fs'\nimport path from 'node:path'\n\nimport {Flags} from '@oclif/core'\nimport {Output, SanityCommand} from '@sanity/cli-core'\nimport {chalk, confirm, logSymbols} from '@sanity/cli-core/ux'\n\nimport {Level} from '../../actions/documents/types.js'\nimport {validateDocuments} from '../../actions/documents/validate.js'\nimport {reporters} from '../../actions/documents/validation/reporters/index.js'\nimport {type ValidationWorkerChannel} from '../../threads/validateDocuments.js'\nimport {type WorkerChannelReceiver} from '../../util/workerChannels.js'\n\ntype ValidateDocumentsCommandFlags = ValidateDocumentsCommand['flags']\n\nexport type BuiltInValidationReporter = (options: {\n flags: ValidateDocumentsCommandFlags\n output: Output\n worker: WorkerChannelReceiver<ValidationWorkerChannel>\n}) => Promise<Level>\n\nexport class ValidateDocumentsCommand extends SanityCommand<typeof ValidateDocumentsCommand> {\n static description = 'Validate documents in a dataset against the studio schema'\n\n static examples = [\n {\n command: '<%= config.bin %> <%= command.id %> --workspace default',\n description: 'Validates all documents in a Sanity project with more than one workspace',\n },\n {\n command: '<%= config.bin %> <%= command.id %> --workspace default --dataset staging',\n description: 'Override the dataset specified in the workspace',\n },\n {\n command: '<%= config.bin %> <%= command.id %> --yes > report.txt',\n description: 'Save the results of the report into a file',\n },\n {\n command: '<%= config.bin %> <%= command.id %> --level info',\n description: 'Report out info level validation markers too',\n },\n ]\n\n static flags = {\n dataset: Flags.string({\n char: 'd',\n description:\n 'Override the dataset used. By default, this is derived from the given workspace',\n }),\n file: Flags.string({\n description:\n 'Provide a path to either an .ndjson file or a tarball containing an .ndjson file',\n }),\n format: Flags.string({\n description:\n 'The output format used to print the found validation markers and report progress',\n }),\n level: Flags.custom<Level>({\n default: 'warning',\n description: 'The minimum level reported out. Defaults to warning',\n options: ['error', 'warning', 'info'],\n parse: async (input) => {\n if (input !== 'error' && input !== 'warning' && input !== 'info') {\n throw new Error(`Invalid level: ${input}. Must be 'error', 'warning', or 'info'`)\n }\n return input as Level\n },\n })(),\n 'max-custom-validation-concurrency': Flags.integer({\n default: 5,\n description: 'Specify how many custom validators can run concurrently',\n }),\n 'max-fetch-concurrency': Flags.integer({\n default: 25,\n description: 'Specify how many `client.fetch` requests are allow concurrency at once',\n }),\n workspace: Flags.string({\n description: 'The name of the workspace to use when downloading and validating all documents',\n }),\n yes: Flags.boolean({\n char: 'y',\n default: false,\n description: 'Skips the first confirmation prompt',\n }),\n }\n\n public async run(): Promise<void> {\n const {flags} = await this.parse(ValidateDocumentsCommand)\n const unattendedMode = Boolean(flags.yes)\n\n const cliConfig = await this.getCliConfig()\n const workDir = (await this.getProjectRoot()).directory\n\n if (!unattendedMode) {\n this.log(\n `${chalk.yellow(`${logSymbols.warning} Warning:`)} This command ${\n flags.file\n ? 'reads all documents from your input file'\n : 'downloads all documents from your dataset'\n } and processes them through your local schema within a ` +\n `simulated browser environment.\\n`,\n )\n this.log(`Potential pitfalls:\\n`)\n this.log(\n `- Processes all documents locally (excluding assets). Large datasets may require more resources.`,\n )\n this.log(\n `- Executes all custom validation functions. Some functions may need to be refactored for compatibility.`,\n )\n this.log(\n `- Not all standard browser features are available and may cause issues while loading your Studio.`,\n )\n this.log(\n `- Adheres to document permissions. Ensure this account can see all desired documents.`,\n )\n if (flags.file) {\n this.log(\n `- Checks for missing document references against the live dataset if not found in your file.`,\n )\n }\n\n const confirmed = await confirm({\n default: true,\n message: `Are you sure you want to continue?`,\n })\n\n if (!confirmed) {\n this.log('User aborted')\n this.exit(1)\n }\n }\n\n if (flags.format && !(flags.format in reporters)) {\n const formatter = new Intl.ListFormat('en-US', {\n style: 'long',\n type: 'conjunction',\n })\n throw new Error(\n `Did not recognize format '${flags.format}'. Available formats are ${formatter.format(\n Object.keys(reporters).map((key) => `'${key}'`),\n )}`,\n )\n }\n\n const level = flags.level\n const maxCustomValidationConcurrency = flags['max-custom-validation-concurrency']\n const maxFetchConcurrency = flags['max-fetch-concurrency']\n\n let ndjsonFilePath\n if (flags.file) {\n const filePath = path.resolve(workDir, flags.file)\n\n const stat = await fs.promises.stat(filePath)\n if (!stat.isFile()) {\n this.error(`'--file' must point to a valid ndjson file or tarball`)\n }\n\n ndjsonFilePath = filePath\n }\n\n const overallLevel = await validateDocuments({\n dataset: flags.dataset,\n level,\n maxCustomValidationConcurrency,\n maxFetchConcurrency,\n ndjsonFilePath,\n reporter: (worker) => {\n const reporter =\n flags.format && flags.format in reporters\n ? reporters[flags.format as keyof typeof reporters]\n : reporters.pretty\n\n return reporter({flags, output: this.output, worker})\n },\n studioHost: cliConfig?.studioHost,\n workDir,\n workspace: flags.workspace,\n })\n\n if (overallLevel === 'error') {\n this.exit(1)\n }\n }\n}\n"],"names":["fs","path","Flags","SanityCommand","chalk","confirm","logSymbols","validateDocuments","reporters","ValidateDocumentsCommand","description","examples","command","flags","dataset","string","char","file","format","level","custom","default","options","parse","input","Error","integer","workspace","yes","boolean","run","unattendedMode","Boolean","cliConfig","getCliConfig","workDir","getProjectRoot","directory","log","yellow","warning","confirmed","message","exit","formatter","Intl","ListFormat","style","type","Object","keys","map","key","maxCustomValidationConcurrency","maxFetchConcurrency","ndjsonFilePath","filePath","resolve","stat","promises","isFile","error","overallLevel","reporter","worker","pretty","output","studioHost"],"mappings":"AAAA,OAAOA,QAAQ,UAAS;AACxB,OAAOC,UAAU,YAAW;AAE5B,SAAQC,KAAK,QAAO,cAAa;AACjC,SAAgBC,aAAa,QAAO,mBAAkB;AACtD,SAAQC,KAAK,EAAEC,OAAO,EAAEC,UAAU,QAAO,sBAAqB;AAG9D,SAAQC,iBAAiB,QAAO,sCAAqC;AACrE,SAAQC,SAAS,QAAO,wDAAuD;AAY/E,OAAO,MAAMC,iCAAiCN;IAC5C,OAAOO,cAAc,4DAA2D;IAEhF,OAAOC,WAAW;QAChB;YACEC,SAAS;YACTF,aAAa;QACf;QACA;YACEE,SAAS;YACTF,aAAa;QACf;QACA;YACEE,SAAS;YACTF,aAAa;QACf;QACA;YACEE,SAAS;YACTF,aAAa;QACf;KACD,CAAA;IAED,OAAOG,QAAQ;QACbC,SAASZ,MAAMa,MAAM,CAAC;YACpBC,MAAM;YACNN,aACE;QACJ;QACAO,MAAMf,MAAMa,MAAM,CAAC;YACjBL,aACE;QACJ;QACAQ,QAAQhB,MAAMa,MAAM,CAAC;YACnBL,aACE;QACJ;QACAS,OAAOjB,MAAMkB,MAAM,CAAQ;YACzBC,SAAS;YACTX,aAAa;YACbY,SAAS;gBAAC;gBAAS;gBAAW;aAAO;YACrCC,OAAO,OAAOC;gBACZ,IAAIA,UAAU,WAAWA,UAAU,aAAaA,UAAU,QAAQ;oBAChE,MAAM,IAAIC,MAAM,CAAC,eAAe,EAAED,MAAM,uCAAuC,CAAC;gBAClF;gBACA,OAAOA;YACT;QACF;QACA,qCAAqCtB,MAAMwB,OAAO,CAAC;YACjDL,SAAS;YACTX,aAAa;QACf;QACA,yBAAyBR,MAAMwB,OAAO,CAAC;YACrCL,SAAS;YACTX,aAAa;QACf;QACAiB,WAAWzB,MAAMa,MAAM,CAAC;YACtBL,aAAa;QACf;QACAkB,KAAK1B,MAAM2B,OAAO,CAAC;YACjBb,MAAM;YACNK,SAAS;YACTX,aAAa;QACf;IACF,EAAC;IAED,MAAaoB,MAAqB;QAChC,MAAM,EAACjB,KAAK,EAAC,GAAG,MAAM,IAAI,CAACU,KAAK,CAACd;QACjC,MAAMsB,iBAAiBC,QAAQnB,MAAMe,GAAG;QAExC,MAAMK,YAAY,MAAM,IAAI,CAACC,YAAY;QACzC,MAAMC,UAAU,AAAC,CAAA,MAAM,IAAI,CAACC,cAAc,EAAC,EAAGC,SAAS;QAEvD,IAAI,CAACN,gBAAgB;YACnB,IAAI,CAACO,GAAG,CACN,GAAGlC,MAAMmC,MAAM,CAAC,GAAGjC,WAAWkC,OAAO,CAAC,SAAS,CAAC,EAAE,cAAc,EAC9D3B,MAAMI,IAAI,GACN,6CACA,4CACL,uDAAuD,CAAC,GACvD,CAAC,gCAAgC,CAAC;YAEtC,IAAI,CAACqB,GAAG,CAAC,CAAC,qBAAqB,CAAC;YAChC,IAAI,CAACA,GAAG,CACN,CAAC,gGAAgG,CAAC;YAEpG,IAAI,CAACA,GAAG,CACN,CAAC,uGAAuG,CAAC;YAE3G,IAAI,CAACA,GAAG,CACN,CAAC,iGAAiG,CAAC;YAErG,IAAI,CAACA,GAAG,CACN,CAAC,qFAAqF,CAAC;YAEzF,IAAIzB,MAAMI,IAAI,EAAE;gBACd,IAAI,CAACqB,GAAG,CACN,CAAC,4FAA4F,CAAC;YAElG;YAEA,MAAMG,YAAY,MAAMpC,QAAQ;gBAC9BgB,SAAS;gBACTqB,SAAS,CAAC,kCAAkC,CAAC;YAC/C;YAEA,IAAI,CAACD,WAAW;gBACd,IAAI,CAACH,GAAG,CAAC;gBACT,IAAI,CAACK,IAAI,CAAC;YACZ;QACF;QAEA,IAAI9B,MAAMK,MAAM,IAAI,CAAEL,CAAAA,MAAMK,MAAM,IAAIV,SAAQ,GAAI;YAChD,MAAMoC,YAAY,IAAIC,KAAKC,UAAU,CAAC,SAAS;gBAC7CC,OAAO;gBACPC,MAAM;YACR;YACA,MAAM,IAAIvB,MACR,CAAC,0BAA0B,EAAEZ,MAAMK,MAAM,CAAC,yBAAyB,EAAE0B,UAAU1B,MAAM,CACnF+B,OAAOC,IAAI,CAAC1C,WAAW2C,GAAG,CAAC,CAACC,MAAQ,CAAC,CAAC,EAAEA,IAAI,CAAC,CAAC,IAC7C;QAEP;QAEA,MAAMjC,QAAQN,MAAMM,KAAK;QACzB,MAAMkC,iCAAiCxC,KAAK,CAAC,oCAAoC;QACjF,MAAMyC,sBAAsBzC,KAAK,CAAC,wBAAwB;QAE1D,IAAI0C;QACJ,IAAI1C,MAAMI,IAAI,EAAE;YACd,MAAMuC,WAAWvD,KAAKwD,OAAO,CAACtB,SAAStB,MAAMI,IAAI;YAEjD,MAAMyC,OAAO,MAAM1D,GAAG2D,QAAQ,CAACD,IAAI,CAACF;YACpC,IAAI,CAACE,KAAKE,MAAM,IAAI;gBAClB,IAAI,CAACC,KAAK,CAAC,CAAC,qDAAqD,CAAC;YACpE;YAEAN,iBAAiBC;QACnB;QAEA,MAAMM,eAAe,MAAMvD,kBAAkB;YAC3CO,SAASD,MAAMC,OAAO;YACtBK;YACAkC;YACAC;YACAC;YACAQ,UAAU,CAACC;gBACT,MAAMD,WACJlD,MAAMK,MAAM,IAAIL,MAAMK,MAAM,IAAIV,YAC5BA,SAAS,CAACK,MAAMK,MAAM,CAA2B,GACjDV,UAAUyD,MAAM;gBAEtB,OAAOF,SAAS;oBAAClD;oBAAOqD,QAAQ,IAAI,CAACA,MAAM;oBAAEF;gBAAM;YACrD;YACAG,YAAYlC,WAAWkC;YACvBhC;YACAR,WAAWd,MAAMc,SAAS;QAC5B;QAEA,IAAImC,iBAAiB,SAAS;YAC5B,IAAI,CAACnB,IAAI,CAAC;QACZ;IACF;AACF"}
|