@sanity/runtime-cli 17.1.0 → 17.2.0-blueprinit.g3a96975

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.
Files changed (109) hide show
  1. package/README.md +38 -28
  2. package/SKILL.md +21 -0
  3. package/dist/actions/blueprinit/manifest.d.ts +13 -0
  4. package/dist/actions/blueprinit/manifest.js +57 -0
  5. package/dist/actions/blueprinit/studio.d.ts +6 -0
  6. package/dist/actions/blueprinit/studio.js +43 -0
  7. package/dist/actions/blueprinit/templates.d.ts +34 -0
  8. package/dist/actions/blueprinit/templates.js +83 -0
  9. package/dist/actions/blueprinit/workspace.d.ts +15 -0
  10. package/dist/actions/blueprinit/workspace.js +142 -0
  11. package/dist/actions/blueprints/assets.d.ts +2 -1
  12. package/dist/actions/blueprints/assets.js +17 -26
  13. package/dist/actions/blueprints/blueprint.d.ts +1 -1
  14. package/dist/actions/blueprints/pre-deploy.d.ts +29 -0
  15. package/dist/actions/blueprints/pre-deploy.js +164 -0
  16. package/dist/actions/blueprints/wait-for-operation.js +4 -0
  17. package/dist/actions/sanity/datasets.d.ts +15 -0
  18. package/dist/actions/sanity/datasets.js +26 -0
  19. package/dist/actions/sanity/examples.d.ts +4 -4
  20. package/dist/baseCommands.d.ts +11 -4
  21. package/dist/baseCommands.js +21 -0
  22. package/dist/commands/blueprinit.d.ts +14 -0
  23. package/dist/commands/blueprinit.js +45 -0
  24. package/dist/commands/blueprints/add.d.ts +1 -1
  25. package/dist/commands/blueprints/config.d.ts +1 -1
  26. package/dist/commands/blueprints/deploy.d.ts +1 -1
  27. package/dist/commands/blueprints/destroy.d.ts +1 -1
  28. package/dist/commands/blueprints/doctor.d.ts +0 -1
  29. package/dist/commands/blueprints/doctor.js +3 -7
  30. package/dist/commands/blueprints/info.d.ts +1 -1
  31. package/dist/commands/blueprints/logs.d.ts +1 -1
  32. package/dist/commands/blueprints/mint-deploy-token.d.ts +1 -1
  33. package/dist/commands/blueprints/plan.d.ts +1 -1
  34. package/dist/commands/blueprints/promote.d.ts +1 -1
  35. package/dist/commands/blueprints/stacks.d.ts +1 -1
  36. package/dist/commands/functions/add.d.ts +1 -1
  37. package/dist/commands/functions/build.d.ts +1 -1
  38. package/dist/commands/functions/dev.d.ts +1 -1
  39. package/dist/commands/functions/env/add.d.ts +4 -1
  40. package/dist/commands/functions/env/add.js +6 -2
  41. package/dist/commands/functions/env/list.d.ts +4 -1
  42. package/dist/commands/functions/env/list.js +9 -3
  43. package/dist/commands/functions/env/remove.d.ts +4 -1
  44. package/dist/commands/functions/env/remove.js +9 -3
  45. package/dist/commands/functions/logs.d.ts +1 -1
  46. package/dist/commands/functions/test.d.ts +1 -1
  47. package/dist/constants.d.ts +1 -0
  48. package/dist/constants.js +1 -0
  49. package/dist/cores/blueprinit/adopt.d.ts +6 -0
  50. package/dist/cores/blueprinit/adopt.js +90 -0
  51. package/dist/cores/blueprinit/finish.d.ts +14 -0
  52. package/dist/cores/blueprinit/finish.js +36 -0
  53. package/dist/cores/blueprinit/fresh.d.ts +3 -0
  54. package/dist/cores/blueprinit/fresh.js +88 -0
  55. package/dist/cores/blueprinit/prompts.d.ts +4 -0
  56. package/dist/cores/blueprinit/prompts.js +14 -0
  57. package/dist/cores/blueprinit/selection.d.ts +15 -0
  58. package/dist/cores/blueprinit/selection.js +63 -0
  59. package/dist/cores/blueprinit/types.d.ts +13 -0
  60. package/dist/cores/blueprinit/types.js +1 -0
  61. package/dist/cores/blueprinit.d.ts +7 -0
  62. package/dist/cores/blueprinit.js +39 -0
  63. package/dist/cores/blueprints/deploy.js +18 -65
  64. package/dist/cores/blueprints/doctor.js +15 -12
  65. package/dist/cores/functions/build.js +3 -2
  66. package/dist/cores/functions/test.js +4 -2
  67. package/dist/server/app.js +8 -2
  68. package/dist/server/static/favicon-dark.svg +1 -0
  69. package/dist/server/static/favicon.svg +1 -0
  70. package/dist/server/static/index.html +1 -1
  71. package/dist/server/static/vendor/vendor.bundle.js +5 -0
  72. package/dist/utils/command-skills.d.ts +2 -0
  73. package/dist/utils/command-skills.js +17 -0
  74. package/dist/utils/functions/child-process-wrapper.js +13 -171
  75. package/dist/utils/functions/child-runtime/console.d.ts +1 -0
  76. package/dist/utils/functions/child-runtime/console.js +50 -0
  77. package/dist/utils/functions/child-runtime/invoke.d.ts +4 -0
  78. package/dist/utils/functions/child-runtime/invoke.js +47 -0
  79. package/dist/utils/functions/child-runtime/resources.d.ts +4 -0
  80. package/dist/utils/functions/child-runtime/resources.js +59 -0
  81. package/dist/utils/functions/find-entry-point.d.ts +1 -1
  82. package/dist/utils/functions/find-entry-point.js +10 -12
  83. package/dist/utils/functions/invoke/local.js +1 -1
  84. package/dist/utils/functions/invoke/prepare.d.ts +1 -1
  85. package/dist/utils/functions/invoke/prepare.js +19 -8
  86. package/dist/utils/functions/package-json.d.ts +1 -2
  87. package/dist/utils/functions/package-json.js +4 -6
  88. package/dist/utils/functions/prepare-asset.d.ts +2 -2
  89. package/dist/utils/functions/prepare-asset.js +18 -7
  90. package/dist/utils/functions/resolve-dependencies.d.ts +4 -1
  91. package/dist/utils/functions/resolve-dependencies.js +5 -6
  92. package/dist/utils/functions/resource-to-arc.d.ts +1 -1
  93. package/dist/utils/functions/resource-to-arc.js +4 -5
  94. package/dist/utils/functions/should-transpile.d.ts +7 -1
  95. package/dist/utils/functions/should-transpile.js +10 -10
  96. package/dist/utils/functions/transpile/function.d.ts +4 -1
  97. package/dist/utils/functions/transpile/function.js +9 -14
  98. package/dist/utils/functions/transpile/verify-handler.js +1 -1
  99. package/dist/utils/logger.d.ts +7 -5
  100. package/dist/utils/logger.js +33 -1
  101. package/dist/utils/progress.d.ts +5 -0
  102. package/dist/utils/progress.js +40 -0
  103. package/dist/utils/studios/prepare-asset.d.ts +6 -0
  104. package/dist/utils/studios/prepare-asset.js +139 -0
  105. package/dist/utils/types.d.ts +9 -8
  106. package/dist/utils/types.js +2 -3
  107. package/oclif.manifest.json +1237 -930
  108. package/package.json +33 -24
  109. package/skills/blueprinit.md +137 -0
@@ -0,0 +1,142 @@
1
+ import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'node:fs';
2
+ import { dirname, join, posix } from 'node:path';
3
+ import { renderBlueprint, STARTER_FUNCTION_NAME } from './manifest.js';
4
+ import { FUNCTION_SET_SLUG, functionPackageJson, renderStudioConfig, STUDIO_POST_TYPE, STUDIO_SCHEMA_TYPES, studioPackageJson, } from './templates.js';
5
+ const GITIGNORE_ENTRY = '# Sanity Blueprints\n.sanity/';
6
+ const DEFAULT_GITIGNORE = `node_modules
7
+ .env
8
+
9
+ ${GITIGNORE_ENTRY}
10
+ `;
11
+ export function scaffoldWorkspace(options) {
12
+ const { dir, studioName } = options;
13
+ assertTargetsAvailable(dir, [
14
+ posix.join('studios', studioName),
15
+ posix.join('functions', STARTER_FUNCTION_NAME),
16
+ ]);
17
+ const packageJson = preparePackageJson(options, ['studios/*', 'functions/*']);
18
+ const files = [];
19
+ const write = createWriter(dir, files);
20
+ const blueprintFilePath = write('sanity.blueprint.ts', renderBlueprint({
21
+ ...manifestOptions(options),
22
+ studioSrc: `./studios/${studioName}`,
23
+ withFunction: true,
24
+ }));
25
+ write(posix.join('studios', studioName, 'package.json'), formatJson(studioPackageJson(studioName)));
26
+ write(posix.join('studios', studioName, 'sanity.config.ts'), renderStudioConfig(options));
27
+ write(posix.join('studios', studioName, 'schemaTypes', 'index.ts'), STUDIO_SCHEMA_TYPES);
28
+ write(posix.join('studios', studioName, 'schemaTypes', 'post.ts'), STUDIO_POST_TYPE);
29
+ write(posix.join('studios', studioName, 'static', '.gitkeep'), '');
30
+ write(posix.join('functions', STARTER_FUNCTION_NAME, 'package.json'), formatJson(functionPackageJson(STARTER_FUNCTION_NAME)));
31
+ write(posix.join('functions', STARTER_FUNCTION_NAME, 'index.ts'), FUNCTION_SET_SLUG);
32
+ writePreparedRootFiles(dir, packageJson, files);
33
+ return { blueprintFilePath, files };
34
+ }
35
+ export function adoptWorkspace(options) {
36
+ const { dir } = options;
37
+ const packageJson = preparePackageJson(options, []);
38
+ const files = [];
39
+ const write = createWriter(dir, files);
40
+ const blueprintFilePath = write('sanity.blueprint.ts', renderBlueprint({ ...manifestOptions(options), studioSrc: '.', withFunction: false }));
41
+ writePreparedRootFiles(dir, packageJson, files);
42
+ return { blueprintFilePath, files };
43
+ }
44
+ function manifestOptions(options) {
45
+ return {
46
+ projectName: options.stackName,
47
+ displayName: options.displayName,
48
+ projectId: options.projectId,
49
+ datasetName: options.datasetName,
50
+ studioName: options.studioName,
51
+ };
52
+ }
53
+ function assertTargetsAvailable(dir, paths) {
54
+ const conflicts = paths.filter((path) => existsSync(join(dir, path)));
55
+ if (conflicts.length > 0) {
56
+ throw new Error(`Refusing to overwrite existing paths: ${conflicts.join(', ')}`);
57
+ }
58
+ }
59
+ function createWriter(dir, files) {
60
+ return (relativePath, content) => {
61
+ const filePath = join(dir, relativePath);
62
+ mkdirSync(dirname(filePath), { recursive: true });
63
+ writeFileSync(filePath, content);
64
+ files.push(relativePath);
65
+ return filePath;
66
+ };
67
+ }
68
+ function writePreparedRootFiles(dir, packageJson, files) {
69
+ if (writeGitignore(dir))
70
+ files.push('.gitignore');
71
+ writeFileSync(join(dir, 'package.json'), formatJson(packageJson));
72
+ files.push('package.json');
73
+ }
74
+ function writeGitignore(dir) {
75
+ const filePath = join(dir, '.gitignore');
76
+ if (!existsSync(filePath)) {
77
+ writeFileSync(filePath, DEFAULT_GITIGNORE);
78
+ return true;
79
+ }
80
+ const existing = readFileSync(filePath, 'utf8');
81
+ if (existing.split(/\r?\n/).some((line) => line.trim() === '.sanity/'))
82
+ return false;
83
+ writeFileSync(filePath, `${existing.trimEnd()}\n\n${GITIGNORE_ENTRY}\n`);
84
+ return true;
85
+ }
86
+ function preparePackageJson(options, requiredWorkspaces) {
87
+ const filePath = join(options.dir, 'package.json');
88
+ const parsed = existsSync(filePath)
89
+ ? JSON.parse(readFileSync(filePath, 'utf8'))
90
+ : {
91
+ name: options.stackName,
92
+ version: '0.1.0',
93
+ private: true,
94
+ type: 'module',
95
+ };
96
+ if (!parsed || typeof parsed !== 'object' || Array.isArray(parsed)) {
97
+ throw new Error('The existing package.json must contain a JSON object.');
98
+ }
99
+ const packageJson = parsed;
100
+ addWorkspaces(packageJson, requiredWorkspaces);
101
+ addBlueprintsDependency(packageJson, options.blueprintsVersion);
102
+ return packageJson;
103
+ }
104
+ function addWorkspaces(packageJson, required) {
105
+ if (required.length === 0)
106
+ return;
107
+ if (!packageJson.workspaces) {
108
+ packageJson.workspaces = required;
109
+ return;
110
+ }
111
+ if (Array.isArray(packageJson.workspaces)) {
112
+ packageJson.workspaces = [...new Set([...packageJson.workspaces, ...required])];
113
+ return;
114
+ }
115
+ if (!packageJson.workspaces || typeof packageJson.workspaces !== 'object') {
116
+ throw new Error('Cannot add generated packages to the existing package.json workspaces.');
117
+ }
118
+ const workspaces = packageJson.workspaces;
119
+ if (Array.isArray(workspaces.packages)) {
120
+ workspaces.packages = [...new Set([...workspaces.packages, ...required])];
121
+ return;
122
+ }
123
+ throw new Error('Cannot add generated packages to the existing package.json workspaces.');
124
+ }
125
+ function addBlueprintsDependency(packageJson, blueprintsVersion) {
126
+ const dependencies = recordOrEmpty(packageJson.dependencies);
127
+ const devDependencies = recordOrEmpty(packageJson.devDependencies);
128
+ if (dependencies['@sanity/blueprints'] || devDependencies['@sanity/blueprints'])
129
+ return;
130
+ packageJson.devDependencies = {
131
+ ...devDependencies,
132
+ '@sanity/blueprints': blueprintsVersion,
133
+ };
134
+ }
135
+ function recordOrEmpty(value) {
136
+ return value && typeof value === 'object' && !Array.isArray(value)
137
+ ? value
138
+ : {};
139
+ }
140
+ function formatJson(value) {
141
+ return `${JSON.stringify(value, null, 2)}\n`;
142
+ }
@@ -3,9 +3,10 @@ import type { Logger } from '../../utils/logger.js';
3
3
  import type { AssetResource, AuthParams, InstallerType } from '../../utils/types.js';
4
4
  export declare const assetCheckUrl: string;
5
5
  export declare const assetStashUrl: string;
6
- export declare function stashAsset({ resource, auth, logger, installer, }: {
6
+ export declare function stashAsset({ resource, auth, blueprintFileDir, logger, installer, }: {
7
7
  resource: AssetResource;
8
8
  auth: AuthParams;
9
+ blueprintFileDir: string;
9
10
  logger: Logger;
10
11
  installer?: InstallerType;
11
12
  }): Promise<{
@@ -1,48 +1,52 @@
1
1
  import crypto from 'node:crypto';
2
2
  import fs from 'node:fs';
3
+ import { readFile } from 'node:fs/promises';
3
4
  import AdmZip from 'adm-zip';
4
5
  import { blueprintsUrl } from '../../config.js';
5
6
  import { CONVERT_BYTES_TO_MB, MAX_ASSET_SIZE } from '../../constants.js';
6
7
  import { prepareAsset as prepareFunctionAsset } from '../../utils/functions/prepare-asset.js';
7
8
  import getHeaders from '../../utils/get-headers.js';
9
+ import { prepareStudioAsset } from '../../utils/studios/prepare-asset.js';
8
10
  import { createTracedFetch } from '../../utils/traced-fetch.js';
9
11
  import { isLocalFunctionResource, isStudioResource } from '../../utils/types.js';
10
12
  const assetsUrl = blueprintsUrl('assets');
11
13
  export const assetCheckUrl = `${assetsUrl}/check`;
12
14
  export const assetStashUrl = `${assetsUrl}/stash`;
13
- export async function stashAsset({ resource, auth, logger, installer, }) {
15
+ export async function stashAsset({ resource, auth, blueprintFileDir, logger, installer, }) {
16
+ let cleanup = async () => { };
14
17
  try {
15
18
  let b64;
16
19
  let hash;
17
20
  let extension;
18
- let cleanup;
19
21
  if (isLocalFunctionResource(resource)) {
20
- const prepResult = await prepareFunctionAsset({ resource }, { installer });
22
+ const prepResult = await prepareFunctionAsset({ resource, blueprintFileDir, installer });
21
23
  if (prepResult.success === false) {
24
+ await prepResult.cleanup();
22
25
  return {
23
26
  success: false,
24
27
  error: prepResult.error,
25
28
  };
26
29
  }
30
+ cleanup = prepResult.cleanup;
27
31
  const zipResult = await pathToB64ZipHash(prepResult.outputPath);
28
32
  b64 = zipResult.b64;
29
33
  hash = zipResult.hash;
30
34
  extension = 'zip';
31
- cleanup = prepResult.cleanup;
32
35
  }
33
36
  else if (isStudioResource(resource)) {
34
- const prepResult = await prepareStudioAsset({ resource });
37
+ const prepResult = await prepareStudioAsset({ resource, blueprintFileDir });
35
38
  if (prepResult.success === false) {
39
+ await prepResult.cleanup();
36
40
  return {
37
41
  success: false,
38
42
  error: prepResult.error,
39
43
  };
40
44
  }
41
- const buffer = await fs.promises.readFile(prepResult.outputPath);
45
+ cleanup = prepResult.cleanup;
46
+ const buffer = await readFile(prepResult.outputPath);
42
47
  b64 = buffer.toString('base64');
43
48
  hash = hashBuffer(buffer);
44
49
  extension = 'tar.gz';
45
- cleanup = prepResult.cleanup;
46
50
  }
47
51
  else {
48
52
  return {
@@ -61,28 +65,15 @@ export async function stashAsset({ resource, auth, logger, installer, }) {
61
65
  });
62
66
  }
63
67
  catch (err) {
68
+ try {
69
+ await cleanup();
70
+ }
71
+ catch {
72
+ // ignore clean up errors
73
+ }
64
74
  return { success: false, error: err instanceof Error ? err.message : `${err}` };
65
75
  }
66
76
  }
67
- async function prepareStudioAsset({ resource, }) {
68
- if (!fs.existsSync(resource.src)) {
69
- return {
70
- success: false,
71
- async cleanup() {
72
- // no op
73
- },
74
- error: `Property 'src' on resource with type '${resource.type}' must be a directory`,
75
- };
76
- }
77
- return {
78
- success: true,
79
- async cleanup() {
80
- // no op
81
- },
82
- // studio must be pre built (e.g. with `npm run build`) and tarred/gzipped
83
- outputPath: resource.src,
84
- };
85
- }
86
77
  async function stashSingleAsset({ b64, hash, cleanup, resource, auth, logger, extension = 'zip', }) {
87
78
  const fetchFn = createTracedFetch(logger);
88
79
  try {
@@ -4,7 +4,7 @@ import type { Logger } from '../../utils/logger.js';
4
4
  import type { BlueprintParserError, ScopeType } from '../../utils/types.js';
5
5
  import { type LocatedBlueprintsConfig } from './config.js';
6
6
  import { type ConfigSource } from './resolve.js';
7
- declare const SUPPORTED_FILE_EXTENSIONS: readonly [".json", ".js", ".mjs", ".ts"];
7
+ declare const SUPPORTED_FILE_EXTENSIONS: readonly ['.json', '.js', '.mjs', '.ts'];
8
8
  type BlueprintFileExtension = (typeof SUPPORTED_FILE_EXTENSIONS)[number];
9
9
  export declare const JSON_BLUEPRINT_CONTENT: {
10
10
  blueprintVersion: string;
@@ -0,0 +1,29 @@
1
+ import type { BlueprintResource } from '@sanity/blueprints';
2
+ import type { Logger } from '../../utils/logger.js';
3
+ import { type AuthParams, type InstallerType, type ScopeType } from '../../utils/types.js';
4
+ type PreDeployResult = {
5
+ success: false;
6
+ error: string;
7
+ code?: string;
8
+ exitCode?: number;
9
+ suggestions?: string[];
10
+ } | {
11
+ success: true;
12
+ };
13
+ type PreDeployResourceOptions = {
14
+ auth: AuthParams;
15
+ blueprintFileDir: string;
16
+ installer: InstallerType;
17
+ log: Logger;
18
+ };
19
+ type PreDeployOptions = {
20
+ scopeType: ScopeType;
21
+ scopeId: string;
22
+ resources: BlueprintResource[];
23
+ stackId: string;
24
+ stackName: string;
25
+ bin: string;
26
+ verbose: boolean | undefined;
27
+ } & PreDeployResourceOptions;
28
+ export declare function preDeploy(options: PreDeployOptions): Promise<PreDeployResult>;
29
+ export {};
@@ -0,0 +1,164 @@
1
+ import { env } from 'node:process';
2
+ import { resolveDeployedResources } from '../../utils/blueprints/resolve-deployed-resources.js';
3
+ import { niceId } from '../../utils/display/presenters.js';
4
+ import { CODE_OPERATION_UNCONFIRMED, EXIT_OPERATION_UNCONFIRMED } from '../../utils/exit-codes.js';
5
+ import { styleText } from '../../utils/style-text.js';
6
+ import { isAssetResource, } from '../../utils/types.js';
7
+ import { stashAsset } from './assets.js';
8
+ import { updateStack } from './stacks.js';
9
+ import { waitForOperation } from './wait-for-operation.js';
10
+ const DEFAULT_ASSET_TIMEOUT = 180;
11
+ const assetTimeoutS = Number(process.env.SANITY_ASSET_TIMEOUT) || DEFAULT_ASSET_TIMEOUT;
12
+ const assetTimeoutMs = assetTimeoutS * 1000;
13
+ const warnTimeoutMs = assetTimeoutMs / 3;
14
+ export async function preDeploy(options) {
15
+ const { resources, stackId, auth, blueprintFileDir, installer, log } = options;
16
+ const hasAssetResources = resources.some(isAssetResource);
17
+ if (hasAssetResources) {
18
+ let assetResources;
19
+ if (env.SANITY_BLUEPRINTS_PRE_DEPLOY_ENABLED === 'true') {
20
+ const preDeployStackResult = await preDeployStack(options);
21
+ if (!preDeployStackResult.success) {
22
+ return preDeployStackResult;
23
+ }
24
+ /** Look up resources from the back-end and attach the externalId if possible */
25
+ const resolvedResources = await resolveDeployedResources({
26
+ resources,
27
+ stackId,
28
+ auth,
29
+ logger: log,
30
+ });
31
+ assetResources = resolvedResources.filter(isAssetResource);
32
+ }
33
+ else {
34
+ assetResources = resources.filter(isAssetResource);
35
+ }
36
+ log('Processing assets...');
37
+ for (const resource of assetResources) {
38
+ const preDeployResult = await preDeployResource(resource, {
39
+ auth,
40
+ blueprintFileDir,
41
+ installer,
42
+ log,
43
+ });
44
+ if (!preDeployResult.success)
45
+ return preDeployResult;
46
+ const idx = resources.findIndex((r) => r.name === resource.name);
47
+ if (idx === -1)
48
+ throw new Error('Unable to update resource asset');
49
+ resources[idx] = preDeployResult.resource;
50
+ }
51
+ }
52
+ return { success: true };
53
+ }
54
+ async function preDeployStack(options) {
55
+ const { scopeType, scopeId, stackId, stackName, resources, auth, log, bin, verbose } = options;
56
+ const spinner = log.ora('Starting pre-deploy...').start();
57
+ const stackMutation = {
58
+ scopeType,
59
+ scopeId,
60
+ name: stackName,
61
+ preDeploy: true,
62
+ document: { resources },
63
+ };
64
+ const { ok: deployOk, stack, error: deployError, } = await updateStack({ stackId, stackMutation, auth, logger: log });
65
+ if (!deployOk) {
66
+ spinner.fail(`${styleText('red', 'Failed')} to complete Stack pre-deployment`);
67
+ return {
68
+ success: false,
69
+ error: deployError || 'Failed to complete Stack pre-deployment',
70
+ suggestions: [
71
+ `Run \`npx ${bin} blueprints plan\` to preview changes before deploying.`,
72
+ `Run \`npx ${bin} blueprints doctor\` to check your configuration.`,
73
+ ],
74
+ };
75
+ }
76
+ spinner.stop().clear();
77
+ log(styleText('dim', 'Stack deployment progress:'));
78
+ log('');
79
+ const outcome = await waitForOperation({
80
+ stackId,
81
+ operationId: stack.operationId,
82
+ auth,
83
+ log,
84
+ bin,
85
+ verbose,
86
+ progressNoun: 'pre-deployment',
87
+ });
88
+ if (outcome.type === 'completed') {
89
+ log(styleText(['bold', 'green'], 'Stack pre-deployment completed!'));
90
+ }
91
+ else if (outcome.type === 'unconfirmed') {
92
+ return {
93
+ success: false,
94
+ error: `Stack pre-deployment was accepted but completion could not be confirmed${outcome.error ? ` (${outcome.error})` : ''}.`,
95
+ code: CODE_OPERATION_UNCONFIRMED,
96
+ exitCode: EXIT_OPERATION_UNCONFIRMED,
97
+ suggestions: [
98
+ 'The pre-deployment may or may not have finished on Sanity servers.',
99
+ `Run \`npx ${bin} blueprints info\` to check status.`,
100
+ `Run \`npx ${bin} blueprints logs --watch\` to keep streaming logs.`,
101
+ ],
102
+ };
103
+ }
104
+ else {
105
+ return {
106
+ success: false,
107
+ error: 'Stack pre-deployment failed',
108
+ suggestions: [
109
+ ...outcome.logHints,
110
+ 'Review the pre-deployment output above for error details.',
111
+ `Run \`npx ${bin} blueprints logs --verbose\` for more context.`,
112
+ `Run \`npx ${bin} blueprints plan\` to identify issues with your Blueprint.`,
113
+ ],
114
+ };
115
+ }
116
+ return { success: true };
117
+ }
118
+ async function preDeployResource(resource, options) {
119
+ const { auth, blueprintFileDir, installer, log } = options;
120
+ const fnSpinner = log.ora({ text: `Processing ${resource.name}...`, prefixText: ' ' }).start();
121
+ const warnTimer = setTimeout(() => {
122
+ fnSpinner.text = `Still processing ${resource.name}, this can take a moment...`;
123
+ }, warnTimeoutMs);
124
+ let assetTimeoutTimer;
125
+ let result;
126
+ try {
127
+ result = await Promise.race([
128
+ stashAsset({ resource, blueprintFileDir, auth, logger: log, installer }),
129
+ new Promise((_, reject) => {
130
+ assetTimeoutTimer = setTimeout(() => {
131
+ reject(new Error(`Processing ${resource.name} timed out after ${assetTimeoutS}s`));
132
+ }, assetTimeoutMs);
133
+ }),
134
+ ]);
135
+ }
136
+ catch (err) {
137
+ const msg = err instanceof Error ? err.message : String(err);
138
+ fnSpinner.fail(msg);
139
+ return { success: false, error: msg };
140
+ }
141
+ finally {
142
+ clearTimeout(warnTimer);
143
+ clearTimeout(assetTimeoutTimer);
144
+ }
145
+ if (result.success && result.assetId) {
146
+ const updatedResource = { ...resource, src: result.assetId };
147
+ fnSpinner.succeed(`${updatedResource.name} ${niceId(result.assetId)}`);
148
+ log(` Source: ${updatedResource.src}`);
149
+ if (result.hash) {
150
+ if (result.hash.length > 24) {
151
+ log.verbose(` Hash: ${result.hash.slice(0, 8)}...${result.hash.slice(-12)}`);
152
+ }
153
+ else {
154
+ log.verbose(` Hash: ${result.hash}`);
155
+ }
156
+ }
157
+ if (result.exists)
158
+ log.verbose(' Asset unchanged');
159
+ return { success: true, resource: updatedResource };
160
+ }
161
+ const errorMsg = `Failed uploading ${resource.name} asset, deploy has stopped`;
162
+ fnSpinner.fail(errorMsg);
163
+ return { success: false, error: result.error || 'Failed to process asset' };
164
+ }
@@ -12,6 +12,7 @@ export async function waitForOperation(options) {
12
12
  const logHints = createHintCollector(bin);
13
13
  let logStreamCleanup = null;
14
14
  try {
15
+ log.showProgress();
15
16
  let lastLogAt = Date.now();
16
17
  let idleMessageShown = false;
17
18
  let consecutiveErrors = 0;
@@ -85,4 +86,7 @@ export async function waitForOperation(options) {
85
86
  logStreamCleanup();
86
87
  throw error;
87
88
  }
89
+ finally {
90
+ log.clearProgress();
91
+ }
88
92
  }
@@ -0,0 +1,15 @@
1
+ import type { Logger } from '../../utils/logger.js';
2
+ import type { ActionResponse } from '../../utils/types.js';
3
+ export interface Dataset {
4
+ name: string;
5
+ aclMode: string;
6
+ }
7
+ interface ListDatasetsResponse extends ActionResponse {
8
+ datasets: Dataset[];
9
+ }
10
+ export declare function listDatasets({ token, projectId, logger, }: {
11
+ token: string;
12
+ projectId: string;
13
+ logger: Logger;
14
+ }): Promise<ListDatasetsResponse>;
15
+ export {};
@@ -0,0 +1,26 @@
1
+ import { createTracedFetch } from '../../utils/traced-fetch.js';
2
+ import { projectsApiPath } from './projects.js';
3
+ export async function listDatasets({ token, projectId, logger, }) {
4
+ const fetchFn = createTracedFetch(logger);
5
+ const url = `${projectsApiPath}/${encodeURIComponent(projectId)}/datasets`;
6
+ const response = await fetchFn(url, {
7
+ method: 'GET',
8
+ headers: {
9
+ Authorization: `Bearer ${token}`,
10
+ 'Content-Type': 'application/json',
11
+ },
12
+ });
13
+ const body = await response.json();
14
+ if (!response.ok) {
15
+ return {
16
+ ok: false,
17
+ error: body.error?.message ?? response.statusText,
18
+ datasets: [],
19
+ };
20
+ }
21
+ return {
22
+ ok: true,
23
+ error: null,
24
+ datasets: body,
25
+ };
26
+ }
@@ -2,12 +2,12 @@ import type { Logger } from '../../utils/logger.js';
2
2
  export declare const EXAMPLES_CACHE_DIR: string;
3
3
  declare const EXAMPLE_TYPES: {
4
4
  readonly blueprint: {
5
- readonly repo: "sanity-io/sanity";
6
- readonly dir: "examples/blueprints";
5
+ readonly repo: 'sanity-io/sanity';
6
+ readonly dir: 'examples/blueprints';
7
7
  };
8
8
  readonly function: {
9
- readonly repo: "sanity-labs/function-recipes";
10
- readonly dir: "";
9
+ readonly repo: 'sanity-labs/function-recipes';
10
+ readonly dir: '';
11
11
  };
12
12
  };
13
13
  export declare function verifyExampleExists({ type, name, logger, }: {
@@ -10,10 +10,15 @@ export declare const pathFlagConfig: {
10
10
  description: string;
11
11
  env: string;
12
12
  aliases: string[];
13
- char: "p";
13
+ char: 'p';
14
+ };
15
+ export declare const llmsFlagConfig: {
16
+ description: string;
17
+ aliases: string[];
14
18
  };
15
19
  export declare const baseFlags: {
16
20
  json: Interfaces.BooleanFlag<boolean>;
21
+ llms: Interfaces.BooleanFlag<boolean>;
17
22
  path: Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
18
23
  trace: Interfaces.BooleanFlag<boolean>;
19
24
  'validate-resources': Interfaces.BooleanFlag<boolean>;
@@ -42,6 +47,7 @@ export declare abstract class RuntimeCommand<T extends typeof Command> extends C
42
47
  protected args: Args<T>;
43
48
  static baseFlags: {
44
49
  json: Interfaces.BooleanFlag<boolean>;
50
+ llms: Interfaces.BooleanFlag<boolean>;
45
51
  path: Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
46
52
  trace: Interfaces.BooleanFlag<boolean>;
47
53
  'validate-resources': Interfaces.BooleanFlag<boolean>;
@@ -112,14 +118,15 @@ export type Need = 'token' | 'blueprint' | 'scope' | 'stackId' | 'deployedStack'
112
118
  export declare abstract class ResolvedCommand<T extends typeof Command> extends RuntimeCommand<T> {
113
119
  static needs: readonly Need[];
114
120
  static baseFlags: {
115
- stack: Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
116
- 'project-id': Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
117
- 'organization-id': Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
118
121
  json: Interfaces.BooleanFlag<boolean>;
122
+ llms: Interfaces.BooleanFlag<boolean>;
119
123
  path: Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
120
124
  trace: Interfaces.BooleanFlag<boolean>;
121
125
  'validate-resources': Interfaces.BooleanFlag<boolean>;
122
126
  verbose: Interfaces.BooleanFlag<boolean>;
127
+ stack: Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
128
+ 'project-id': Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
129
+ 'organization-id': Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
123
130
  };
124
131
  protected sanityToken: string;
125
132
  protected blueprint: ReadBlueprintResult;
@@ -6,6 +6,7 @@ import { resolveIds } from './actions/blueprints/resolve.js';
6
6
  import { getStack, resolveStackIdByNameOrId } from './actions/blueprints/stacks.js';
7
7
  import config from './config.js';
8
8
  import { CI_SETUP_DOCS_URL } from './constants.js';
9
+ import { commandSkillFilename, readCommandSkill } from './utils/command-skills.js';
9
10
  import { presentBlueprintParserErrors } from './utils/display/errors.js';
10
11
  import { Logger } from './utils/logger.js';
11
12
  import { styleText } from './utils/style-text.js';
@@ -25,11 +26,19 @@ export const pathFlagConfig = {
25
26
  aliases: ['blueprint-path'],
26
27
  char: 'p',
27
28
  };
29
+ export const llmsFlagConfig = {
30
+ description: 'Show agent-oriented guidance for this command',
31
+ aliases: ['skill'],
32
+ };
28
33
  export const baseFlags = {
29
34
  json: OclifFlags.boolean({
30
35
  // override defaults from oclif's built-in --json flag
31
36
  description: 'Format output as json',
32
37
  }),
38
+ llms: OclifFlags.boolean({
39
+ ...llmsFlagConfig,
40
+ hidden: true,
41
+ }),
33
42
  path: OclifFlags.string({
34
43
  ...pathFlagConfig,
35
44
  hidden: true,
@@ -118,6 +127,18 @@ export class RuntimeCommand extends Command {
118
127
  return commandHelp.generate();
119
128
  }
120
129
  async init() {
130
+ if (this.argv.some((arg) => arg === '--llms' || arg === '--skill')) {
131
+ const commandId = this.id ?? this.ctor.id;
132
+ const skill = await readCommandSkill(commandId);
133
+ if (!skill) {
134
+ const commandName = commandId.replaceAll(':', ' ');
135
+ this.error(`No agent guidance is available for \`${commandName}\`.`, {
136
+ suggestions: [`Add it at skills/${commandSkillFilename(commandId)}.`],
137
+ });
138
+ }
139
+ process.stdout.write(skill.endsWith('\n') ? skill : `${skill}\n`);
140
+ this.exit();
141
+ }
121
142
  const { args, flags } = await this.parse({
122
143
  flags: this.ctor.flags,
123
144
  baseFlags: super.ctor.baseFlags,
@@ -0,0 +1,14 @@
1
+ import { RuntimeCommand } from '../baseCommands.js';
2
+ export default class BlueprinitCommand extends RuntimeCommand<typeof BlueprinitCommand> {
3
+ static hidden: boolean;
4
+ static summary: string;
5
+ static description: string;
6
+ static examples: string[];
7
+ static flags: {
8
+ llms: import("@oclif/core/interfaces").BooleanFlag<boolean>;
9
+ yes: import("@oclif/core/interfaces").BooleanFlag<boolean>;
10
+ 'organization-id': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
11
+ 'project-id': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
12
+ };
13
+ run(): Promise<Record<string, unknown> | undefined>;
14
+ }