@sanity/runtime-cli 17.1.0-next.gcfbd613 → 17.2.0-blueprinit.g62f8017

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 (58) hide show
  1. package/README.md +84 -54
  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.js +15 -24
  12. package/dist/actions/blueprints/pre-deploy.d.ts +29 -0
  13. package/dist/actions/blueprints/pre-deploy.js +164 -0
  14. package/dist/actions/sanity/datasets.d.ts +15 -0
  15. package/dist/actions/sanity/datasets.js +26 -0
  16. package/dist/baseCommands.d.ts +3 -0
  17. package/dist/baseCommands.js +17 -0
  18. package/dist/commands/blueprinit.d.ts +13 -0
  19. package/dist/commands/blueprinit.js +44 -0
  20. package/dist/commands/functions/env/add.d.ts +3 -0
  21. package/dist/commands/functions/env/add.js +6 -2
  22. package/dist/commands/functions/env/list.d.ts +3 -0
  23. package/dist/commands/functions/env/list.js +9 -3
  24. package/dist/commands/functions/env/remove.d.ts +3 -0
  25. package/dist/commands/functions/env/remove.js +9 -3
  26. package/dist/constants.d.ts +1 -0
  27. package/dist/constants.js +1 -0
  28. package/dist/cores/blueprinit/adopt.d.ts +6 -0
  29. package/dist/cores/blueprinit/adopt.js +90 -0
  30. package/dist/cores/blueprinit/finish.d.ts +14 -0
  31. package/dist/cores/blueprinit/finish.js +36 -0
  32. package/dist/cores/blueprinit/fresh.d.ts +3 -0
  33. package/dist/cores/blueprinit/fresh.js +88 -0
  34. package/dist/cores/blueprinit/prompts.d.ts +4 -0
  35. package/dist/cores/blueprinit/prompts.js +14 -0
  36. package/dist/cores/blueprinit/selection.d.ts +15 -0
  37. package/dist/cores/blueprinit/selection.js +63 -0
  38. package/dist/cores/blueprinit/types.d.ts +13 -0
  39. package/dist/cores/blueprinit/types.js +1 -0
  40. package/dist/cores/blueprinit.d.ts +7 -0
  41. package/dist/cores/blueprinit.js +39 -0
  42. package/dist/cores/blueprints/deploy.js +16 -64
  43. package/dist/utils/command-skills.d.ts +2 -0
  44. package/dist/utils/command-skills.js +17 -0
  45. package/dist/utils/functions/child-process-wrapper.js +13 -171
  46. package/dist/utils/functions/child-runtime/console.d.ts +1 -0
  47. package/dist/utils/functions/child-runtime/console.js +50 -0
  48. package/dist/utils/functions/child-runtime/invoke.d.ts +4 -0
  49. package/dist/utils/functions/child-runtime/invoke.js +47 -0
  50. package/dist/utils/functions/child-runtime/resources.d.ts +4 -0
  51. package/dist/utils/functions/child-runtime/resources.js +59 -0
  52. package/dist/utils/studios/prepare-asset.d.ts +6 -0
  53. package/dist/utils/studios/prepare-asset.js +139 -0
  54. package/dist/utils/types.d.ts +4 -7
  55. package/dist/utils/types.js +2 -3
  56. package/oclif.manifest.json +293 -7
  57. package/package.json +12 -4
  58. package/skills/blueprinit.md +40 -0
@@ -0,0 +1,13 @@
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
+ yes: import("@oclif/core/interfaces").BooleanFlag<boolean>;
9
+ 'organization-id': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
10
+ 'project-id': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
11
+ };
12
+ run(): Promise<Record<string, unknown> | undefined>;
13
+ }
@@ -0,0 +1,44 @@
1
+ import { Flags } from '@oclif/core';
2
+ import { RuntimeCommand } from '../baseCommands.js';
3
+ import { blueprinitCore } from '../cores/blueprinit.js';
4
+ import { Logger } from '../utils/logger.js';
5
+ export default class BlueprinitCommand extends RuntimeCommand {
6
+ static hidden = true;
7
+ static summary = 'Experimental blueprints-first project init';
8
+ static description = `Scaffolds a Blueprint, Studio, and starter function around an existing Sanity project.
9
+
10
+ This hidden command is an experiment; its interface and generated files are not stable.`;
11
+ static examples = [
12
+ '<%= config.bin %> <%= command.id %>',
13
+ '<%= config.bin %> <%= command.id %> --yes',
14
+ ];
15
+ static flags = {
16
+ yes: Flags.boolean({
17
+ char: 'y',
18
+ description: 'Skip confirmation prompts',
19
+ default: false,
20
+ }),
21
+ 'organization-id': Flags.string({
22
+ description: 'Organization to use when the account has several',
23
+ aliases: ['organization', 'organizationId', 'org'],
24
+ }),
25
+ 'project-id': Flags.string({
26
+ description: 'Project to use when the organization has several',
27
+ aliases: ['project', 'projectId'],
28
+ }),
29
+ };
30
+ async run() {
31
+ const result = await blueprinitCore({
32
+ bin: this.config.bin,
33
+ log: Logger(this.log.bind(this), this.flags),
34
+ flags: {
35
+ yes: this.flags.yes,
36
+ organizationId: this.flags['organization-id'],
37
+ projectId: this.flags['project-id'],
38
+ },
39
+ });
40
+ if (!result.success)
41
+ this.coreError(result);
42
+ return result.json;
43
+ }
44
+ }
@@ -8,6 +8,9 @@ export default class EnvAddCommand extends ResolvedCommand<typeof EnvAddCommand>
8
8
  key: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
9
9
  value: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
10
10
  };
11
+ static flags: {
12
+ stack: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
13
+ };
11
14
  static examples: string[];
12
15
  run(): Promise<Record<string, unknown> | undefined>;
13
16
  }
@@ -1,5 +1,5 @@
1
- import { Args } from '@oclif/core';
2
- import { ResolvedCommand } from '../../../baseCommands.js';
1
+ import { Args, Flags } from '@oclif/core';
2
+ import { ResolvedCommand, stackFlagConfig } from '../../../baseCommands.js';
3
3
  import { functionEnvAddCore } from '../../../cores/functions/env/add.js';
4
4
  import { Logger } from '../../../utils/logger.js';
5
5
  export default class EnvAddCommand extends ResolvedCommand {
@@ -13,8 +13,12 @@ Environment variables are useful for API keys, configuration values, and other s
13
13
  key: Args.string({ description: 'The name of the environment variable', required: true }),
14
14
  value: Args.string({ description: 'The value of the environment variable', required: true }),
15
15
  };
16
+ static flags = {
17
+ stack: Flags.string({ ...stackFlagConfig }),
18
+ };
16
19
  static examples = [
17
20
  '<%= config.bin %> <%= command.id %> MyFunction API_URL https://api.example.com/',
21
+ '<%= config.bin %> <%= command.id %> --stack <name-or-id> MyFunction API_URL https://api.example.com/',
18
22
  ];
19
23
  async run() {
20
24
  const result = await functionEnvAddCore({
@@ -6,6 +6,9 @@ export default class EnvListCommand extends ResolvedCommand<typeof EnvListComman
6
6
  static args: {
7
7
  name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
8
8
  };
9
+ static flags: {
10
+ stack: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
11
+ };
9
12
  static examples: string[];
10
13
  run(): Promise<Record<string, unknown> | undefined>;
11
14
  }
@@ -1,5 +1,5 @@
1
- import { Args } from '@oclif/core';
2
- import { ResolvedCommand } from '../../../baseCommands.js';
1
+ import { Args, Flags } from '@oclif/core';
2
+ import { ResolvedCommand, stackFlagConfig } from '../../../baseCommands.js';
3
3
  import { functionEnvListCore } from '../../../cores/functions/env/list.js';
4
4
  import { Logger } from '../../../utils/logger.js';
5
5
  export default class EnvListCommand extends ResolvedCommand {
@@ -11,7 +11,13 @@ Use 'functions env add' to set variables or 'functions env remove' to delete the
11
11
  static args = {
12
12
  name: Args.string({ description: 'The name of the Sanity Function', required: true }),
13
13
  };
14
- static examples = ['<%= config.bin %> <%= command.id %> MyFunction'];
14
+ static flags = {
15
+ stack: Flags.string({ ...stackFlagConfig }),
16
+ };
17
+ static examples = [
18
+ '<%= config.bin %> <%= command.id %> MyFunction',
19
+ '<%= config.bin %> <%= command.id %> --stack <name-or-id> MyFunction',
20
+ ];
15
21
  async run() {
16
22
  const result = await functionEnvListCore({
17
23
  bin: this.config.bin,
@@ -7,6 +7,9 @@ export default class EnvRemoveCommand extends ResolvedCommand<typeof EnvRemoveCo
7
7
  name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
8
8
  key: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
9
9
  };
10
+ static flags: {
11
+ stack: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
12
+ };
10
13
  static examples: string[];
11
14
  run(): Promise<Record<string, unknown> | undefined>;
12
15
  }
@@ -1,5 +1,5 @@
1
- import { Args } from '@oclif/core';
2
- import { ResolvedCommand } from '../../../baseCommands.js';
1
+ import { Args, Flags } from '@oclif/core';
2
+ import { ResolvedCommand, stackFlagConfig } from '../../../baseCommands.js';
3
3
  import { functionEnvRemoveCore } from '../../../cores/functions/env/remove.js';
4
4
  import { Logger } from '../../../utils/logger.js';
5
5
  export default class EnvRemoveCommand extends ResolvedCommand {
@@ -12,7 +12,13 @@ Use 'functions env list' to see current variables before removing.`;
12
12
  name: Args.string({ description: 'The name of the Sanity Function', required: true }),
13
13
  key: Args.string({ description: 'The name of the environment variable', required: true }),
14
14
  };
15
- static examples = ['<%= config.bin %> <%= command.id %> MyFunction API_URL'];
15
+ static flags = {
16
+ stack: Flags.string({ ...stackFlagConfig }),
17
+ };
18
+ static examples = [
19
+ '<%= config.bin %> <%= command.id %> MyFunction API_URL',
20
+ '<%= config.bin %> <%= command.id %> --stack <name-or-id> MyFunction API_URL',
21
+ ];
16
22
  async run() {
17
23
  const result = await functionEnvRemoveCore({
18
24
  bin: this.config.bin,
@@ -9,6 +9,7 @@ export declare const SANITY_PROJECT = "sanity.project";
9
9
  export declare const SANITY_PROJECT_CORS = "sanity.project.cors";
10
10
  export declare const SANITY_PROJECT_DATASET = "sanity.project.dataset";
11
11
  export declare const SANITY_PROJECT_WEBHOOK = "sanity.project.webhook";
12
+ export declare const SANITY_STUDIO = "sanity.studio";
12
13
  export declare const EVENT_DOCUMENT_PUBLISH = "document-publish";
13
14
  export declare const EVENT_DOCUMENT_CREATE = "document-create";
14
15
  export declare const EVENT_DOCUMENT_UPDATE = "document-update";
package/dist/constants.js CHANGED
@@ -9,6 +9,7 @@ export const SANITY_PROJECT = 'sanity.project';
9
9
  export const SANITY_PROJECT_CORS = 'sanity.project.cors';
10
10
  export const SANITY_PROJECT_DATASET = 'sanity.project.dataset';
11
11
  export const SANITY_PROJECT_WEBHOOK = 'sanity.project.webhook';
12
+ export const SANITY_STUDIO = 'sanity.studio';
12
13
  export const EVENT_DOCUMENT_PUBLISH = 'document-publish';
13
14
  export const EVENT_DOCUMENT_CREATE = 'document-create';
14
15
  export const EVENT_DOCUMENT_UPDATE = 'document-update';
@@ -0,0 +1,6 @@
1
+ import type { DetectedStudio } from '../../actions/blueprinit/studio.js';
2
+ import type { CoreResult } from '../index.js';
3
+ import type { BlueprinitFlowOptions } from './types.js';
4
+ export declare function adoptFlow(options: BlueprinitFlowOptions & {
5
+ studio: DetectedStudio;
6
+ }): Promise<CoreResult>;
@@ -0,0 +1,90 @@
1
+ import { existsSync } from 'node:fs';
2
+ import { join } from 'node:path';
3
+ import { slugify } from '../../actions/blueprinit/manifest.js';
4
+ import { adoptWorkspace } from '../../actions/blueprinit/workspace.js';
5
+ import { listDatasets } from '../../actions/sanity/datasets.js';
6
+ import { groupProjectsByOrganization } from '../../actions/sanity/projects.js';
7
+ import { check } from '../../utils/display/presenters.js';
8
+ import { getLatestNpmVersion } from '../../utils/external/npmjs.js';
9
+ import { isInteractive } from '../../utils/interactive.js';
10
+ import { createStackAndFinish } from './finish.js';
11
+ import { confirmUnlessSkipped, promptForStudioName } from './prompts.js';
12
+ import { findProject } from './selection.js';
13
+ export async function adoptFlow(options) {
14
+ const { bin, dir, flags, log, studio, token } = options;
15
+ if (!studio.projectId || !studio.dataset) {
16
+ return {
17
+ success: false,
18
+ error: `Found ${studio.configFile}, but could not read a projectId and dataset from it.`,
19
+ suggestions: ['Use literal projectId and dataset values in the Studio config.'],
20
+ };
21
+ }
22
+ if (flags.projectId && flags.projectId !== studio.projectId) {
23
+ return { success: false, error: `The Studio uses project "${studio.projectId}".` };
24
+ }
25
+ log(check(`Studio detected (${studio.configFile})`));
26
+ const grouped = await groupProjectsByOrganization({ token, logger: log });
27
+ if (!grouped.ok) {
28
+ return { success: false, error: `Could not list organizations: ${grouped.error}` };
29
+ }
30
+ const match = findProject(grouped.organizations, studio.projectId);
31
+ if (!match) {
32
+ return {
33
+ success: false,
34
+ error: `Project "${studio.projectId}" from ${studio.configFile} was not found in your account.`,
35
+ };
36
+ }
37
+ if (flags.organizationId && flags.organizationId !== match.organization.id) {
38
+ return {
39
+ success: false,
40
+ error: `Project "${studio.projectId}" belongs to organization "${match.organization.id}".`,
41
+ };
42
+ }
43
+ const datasets = await listDatasets({ token, projectId: match.project.id, logger: log });
44
+ if (!datasets.ok) {
45
+ return { success: false, error: `Could not list datasets: ${datasets.error}` };
46
+ }
47
+ if (!datasets.datasets.some(({ name }) => name === studio.dataset)) {
48
+ return {
49
+ success: false,
50
+ error: `Dataset "${studio.dataset}" was not found in project ${match.project.displayName}.`,
51
+ };
52
+ }
53
+ log(check(`Matches project ${match.project.displayName} (${match.project.id}), dataset ${studio.dataset}`));
54
+ log('');
55
+ const confirmed = await confirmUnlessSkipped(flags, isInteractive, 'Adopt this Studio into a Blueprint?');
56
+ if (!confirmed)
57
+ return { success: false, error: 'Initialization cancelled.' };
58
+ const studioName = await promptForStudioName(flags, isInteractive);
59
+ const stackName = slugify(match.project.displayName) || match.project.id;
60
+ const marker = (file) => (existsSync(join(dir, file)) ? '~' : '+');
61
+ log('Changes:');
62
+ log(" + sanity.blueprint.ts attach project + dataset; adopt Studio at '.'");
63
+ log(` + .sanity/blueprint.config.json org scope, stack ${stackName}`);
64
+ log(` ${marker('.gitignore')} .gitignore`);
65
+ log(` ${marker('package.json')} package.json`);
66
+ log('');
67
+ const adoption = adoptWorkspace({
68
+ dir,
69
+ projectId: match.project.id,
70
+ displayName: match.project.displayName,
71
+ datasetName: studio.dataset,
72
+ stackName,
73
+ studioName,
74
+ blueprintsVersion: await getLatestNpmVersion('@sanity/blueprints', log),
75
+ });
76
+ return await createStackAndFinish({
77
+ ...options,
78
+ organizationId: match.organization.id,
79
+ projectId: match.project.id,
80
+ datasetName: studio.dataset,
81
+ stackName,
82
+ blueprintFilePath: adoption.blueprintFilePath,
83
+ files: adoption.files,
84
+ nextSteps: [
85
+ ` npx ${bin} blueprints plan`,
86
+ ` npx ${bin} blueprints deploy`,
87
+ ` npx ${bin} blueprints info`,
88
+ ],
89
+ });
90
+ }
@@ -0,0 +1,14 @@
1
+ import type { CoreResult } from '../index.js';
2
+ import type { BlueprinitFlowOptions } from './types.js';
3
+ interface FinishOptions extends BlueprinitFlowOptions {
4
+ organizationId: string;
5
+ projectId: string;
6
+ datasetName: string;
7
+ stackName: string;
8
+ blueprintFilePath: string;
9
+ files: string[];
10
+ nextSteps: string[];
11
+ }
12
+ export declare function createStackAndFinish(options: FinishOptions): Promise<CoreResult>;
13
+ export declare function alignSteps(steps: Array<[command: string, description?: string]>): string[];
14
+ export {};
@@ -0,0 +1,36 @@
1
+ import { writeConfigFile } from '../../actions/blueprints/config.js';
2
+ import { createEmptyStack } from '../../actions/blueprints/stacks.js';
3
+ import { check } from '../../utils/display/presenters.js';
4
+ export async function createStackAndFinish(options) {
5
+ const stack = await createEmptyStack({
6
+ token: options.token,
7
+ scopeType: 'organization',
8
+ scopeId: options.organizationId,
9
+ name: options.stackName,
10
+ logger: options.log,
11
+ });
12
+ writeConfigFile(options.blueprintFilePath, {
13
+ organizationId: options.organizationId,
14
+ stackId: stack.id,
15
+ });
16
+ options.log(check(`Stack ${stack.name} created (org scope)`));
17
+ options.log('');
18
+ options.log('Next steps:');
19
+ for (const step of options.nextSteps)
20
+ options.log(step);
21
+ return {
22
+ success: true,
23
+ json: {
24
+ organizationId: options.organizationId,
25
+ projectId: options.projectId,
26
+ dataset: options.datasetName,
27
+ stackId: stack.id,
28
+ stackName: stack.name,
29
+ files: [...options.files, '.sanity/blueprint.config.json'],
30
+ },
31
+ };
32
+ }
33
+ export function alignSteps(steps) {
34
+ const width = Math.max(...steps.map(([command]) => command.length));
35
+ return steps.map(([command, description]) => description ? ` ${command.padEnd(width + 2)}${description}` : ` ${command}`);
36
+ }
@@ -0,0 +1,3 @@
1
+ import type { CoreResult } from '../index.js';
2
+ import type { BlueprinitFlowOptions } from './types.js';
3
+ export declare function freshFlow(options: BlueprinitFlowOptions): Promise<CoreResult>;
@@ -0,0 +1,88 @@
1
+ import { STARTER_FUNCTION_NAME, slugify } from '../../actions/blueprinit/manifest.js';
2
+ import { scaffoldWorkspace } from '../../actions/blueprinit/workspace.js';
3
+ import { listDatasets } from '../../actions/sanity/datasets.js';
4
+ import { groupProjectsByOrganization } from '../../actions/sanity/projects.js';
5
+ import { check } from '../../utils/display/presenters.js';
6
+ import { getLatestNpmVersion } from '../../utils/external/npmjs.js';
7
+ import { isInteractive } from '../../utils/interactive.js';
8
+ import { alignSteps, createStackAndFinish } from './finish.js';
9
+ import { confirmUnlessSkipped, promptForStudioName } from './prompts.js';
10
+ import { chooseDataset, chooseOrganization, chooseProject } from './selection.js';
11
+ export async function freshFlow(options) {
12
+ const { bin, dir, flags, log, token } = options;
13
+ const grouped = await groupProjectsByOrganization({ token, logger: log });
14
+ if (!grouped.ok) {
15
+ return { success: false, error: `Could not list organizations: ${grouped.error}` };
16
+ }
17
+ const organizationResult = await chooseOrganization(grouped.organizations, flags.organizationId, isInteractive);
18
+ if (!organizationResult.ok) {
19
+ return {
20
+ success: false,
21
+ error: organizationResult.error.message,
22
+ suggestions: organizationResult.error.suggestions,
23
+ };
24
+ }
25
+ const { organization, projects = [] } = organizationResult.value;
26
+ const projectResult = await chooseProject(projects, flags.projectId, organization.name, isInteractive);
27
+ if (!projectResult.ok) {
28
+ return {
29
+ success: false,
30
+ error: projectResult.error.message,
31
+ suggestions: projectResult.error.suggestions,
32
+ };
33
+ }
34
+ const project = projectResult.value;
35
+ const datasets = await listDatasets({ token, projectId: project.id, logger: log });
36
+ if (!datasets.ok) {
37
+ return { success: false, error: `Could not list datasets: ${datasets.error}` };
38
+ }
39
+ const dataset = chooseDataset(datasets.datasets);
40
+ if (!dataset)
41
+ return { success: false, error: `No datasets found in ${project.displayName}.` };
42
+ log(check(`Org: ${organization.name} (${organization.id})`));
43
+ log(check(`Project: ${project.displayName} (${project.id}), dataset: ${dataset.name}`));
44
+ log('');
45
+ const confirmed = await confirmUnlessSkipped(flags, isInteractive, `Set up this directory as the workspace for "${project.displayName}"?`);
46
+ if (!confirmed)
47
+ return { success: false, error: 'Initialization cancelled.' };
48
+ const stackName = slugify(project.displayName) || project.id;
49
+ const studioName = await promptForStudioName(flags, isInteractive);
50
+ log('Files to write:');
51
+ log(' + sanity.blueprint.ts project + dataset (attached), studio, function');
52
+ log(` + ${`studios/${studioName}/`.padEnd(32)}Studio with a "post" type`);
53
+ log(` + ${`functions/${STARTER_FUNCTION_NAME}/`.padEnd(32)}sets a post slug from its title`);
54
+ log(` + .sanity/blueprint.config.json org scope, stack ${stackName}`);
55
+ log(' + .gitignore');
56
+ log(' + package.json');
57
+ log('');
58
+ const scaffold = scaffoldWorkspace({
59
+ dir,
60
+ projectId: project.id,
61
+ displayName: project.displayName,
62
+ datasetName: dataset.name,
63
+ stackName,
64
+ studioName,
65
+ blueprintsVersion: await getLatestNpmVersion('@sanity/blueprints', log),
66
+ });
67
+ return await createStackAndFinish({
68
+ ...options,
69
+ organizationId: organization.id,
70
+ projectId: project.id,
71
+ datasetName: dataset.name,
72
+ stackName,
73
+ blueprintFilePath: scaffold.blueprintFilePath,
74
+ files: scaffold.files,
75
+ nextSteps: [
76
+ ...alignSteps([
77
+ ['npm install'],
78
+ [`npm run dev -w studios/${studioName}`, 'open the Studio and add a post'],
79
+ [`npx ${bin} blueprints plan`, 'preview the deployment'],
80
+ [`npx ${bin} blueprints deploy`, 'deploy the resources'],
81
+ ]),
82
+ '',
83
+ 'Test the function on that post:',
84
+ ` npx ${bin} functions test ${STARTER_FUNCTION_NAME} --document-id <id>` +
85
+ ` --project-id ${project.id} --dataset ${dataset.name} --with-user-token`,
86
+ ],
87
+ });
88
+ }
@@ -0,0 +1,4 @@
1
+ import type { BlueprinitFlags } from './types.js';
2
+ export declare const DEFAULT_STUDIO_NAME = "studio";
3
+ export declare function confirmUnlessSkipped(flags: BlueprinitFlags, interactive: boolean, message: string): Promise<boolean>;
4
+ export declare function promptForStudioName(flags: BlueprinitFlags, interactive: boolean): Promise<string>;
@@ -0,0 +1,14 @@
1
+ import { confirm, input } from '@inquirer/prompts';
2
+ import { slugify } from '../../actions/blueprinit/manifest.js';
3
+ export const DEFAULT_STUDIO_NAME = 'studio';
4
+ export async function confirmUnlessSkipped(flags, interactive, message) {
5
+ if (flags.yes || !interactive)
6
+ return true;
7
+ return await confirm({ message, default: true });
8
+ }
9
+ export async function promptForStudioName(flags, interactive) {
10
+ if (flags.yes || !interactive)
11
+ return DEFAULT_STUDIO_NAME;
12
+ const answer = await input({ message: 'Name your studio?', default: DEFAULT_STUDIO_NAME });
13
+ return slugify(answer) || DEFAULT_STUDIO_NAME;
14
+ }
@@ -0,0 +1,15 @@
1
+ import type { Dataset } from '../../actions/sanity/datasets.js';
2
+ import type { GroupedProjects, Project } from '../../actions/sanity/projects.js';
3
+ import type { Result } from '../../utils/types.js';
4
+ interface SelectionError {
5
+ message: string;
6
+ suggestions?: string[];
7
+ }
8
+ export declare function chooseOrganization(groups: GroupedProjects[], organizationId: string | undefined, interactive: boolean): Promise<Result<GroupedProjects, SelectionError>>;
9
+ export declare function chooseProject(projects: Project[], projectId: string | undefined, organizationName: string, interactive: boolean): Promise<Result<Project, SelectionError>>;
10
+ export declare function chooseDataset(datasets: Dataset[]): Dataset | undefined;
11
+ export declare function findProject(groups: GroupedProjects[], projectId: string): {
12
+ organization: GroupedProjects['organization'];
13
+ project: Project;
14
+ } | undefined;
15
+ export {};
@@ -0,0 +1,63 @@
1
+ import { select } from '@inquirer/prompts';
2
+ export async function chooseOrganization(groups, organizationId, interactive) {
3
+ if (groups.length === 0) {
4
+ return failure('No organizations found for this account.');
5
+ }
6
+ if (organizationId) {
7
+ const organization = groups.find((group) => group.organization.id === organizationId);
8
+ return organization
9
+ ? { ok: true, value: organization }
10
+ : failure(`No organization "${organizationId}" found for this account.`);
11
+ }
12
+ if (groups.length === 1)
13
+ return { ok: true, value: groups[0] };
14
+ if (!interactive) {
15
+ return failure('Multiple organizations found.', ['Pass --organization-id <id> to choose one.']);
16
+ }
17
+ const selectedId = await select({
18
+ message: 'Choose a Sanity organization:',
19
+ choices: groups.map(({ organization, projects }) => ({
20
+ name: organization.name,
21
+ value: organization.id,
22
+ description: `${projects?.length ?? 0} projects`,
23
+ })),
24
+ });
25
+ const selected = groups.find(({ organization }) => organization.id === selectedId);
26
+ return selected ? { ok: true, value: selected } : failure('Organization not found.');
27
+ }
28
+ export async function chooseProject(projects, projectId, organizationName, interactive) {
29
+ if (projects.length === 0) {
30
+ return failure(`No projects found in ${organizationName}.`);
31
+ }
32
+ if (projectId) {
33
+ const project = projects.find(({ id }) => id === projectId);
34
+ return project
35
+ ? { ok: true, value: project }
36
+ : failure(`No project "${projectId}" found in ${organizationName}.`);
37
+ }
38
+ if (projects.length === 1)
39
+ return { ok: true, value: projects[0] };
40
+ if (!interactive) {
41
+ return failure('Multiple projects found.', ['Pass --project-id <id> to choose one.']);
42
+ }
43
+ const selectedId = await select({
44
+ message: 'Choose a Sanity project:',
45
+ choices: projects.map((project) => ({ name: project.displayName, value: project.id })),
46
+ });
47
+ const selected = projects.find(({ id }) => id === selectedId);
48
+ return selected ? { ok: true, value: selected } : failure('Project not found.');
49
+ }
50
+ export function chooseDataset(datasets) {
51
+ return datasets.find(({ name }) => name === 'production') ?? datasets[0];
52
+ }
53
+ export function findProject(groups, projectId) {
54
+ for (const { organization, projects = [] } of groups) {
55
+ const project = projects.find(({ id }) => id === projectId);
56
+ if (project)
57
+ return { organization, project };
58
+ }
59
+ return undefined;
60
+ }
61
+ function failure(message, suggestions) {
62
+ return { ok: false, error: { message, suggestions } };
63
+ }
@@ -0,0 +1,13 @@
1
+ import type { Logger } from '../../utils/logger.js';
2
+ export interface BlueprinitFlags {
3
+ yes?: boolean;
4
+ organizationId?: string;
5
+ projectId?: string;
6
+ }
7
+ export interface BlueprinitFlowOptions {
8
+ bin: string;
9
+ dir: string;
10
+ flags: BlueprinitFlags;
11
+ log: Logger;
12
+ token: string;
13
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,7 @@
1
+ import type { BlueprinitFlags } from './blueprinit/types.js';
2
+ import type { CoreConfig, CoreResult } from './index.js';
3
+ export interface BlueprinitOptions extends CoreConfig {
4
+ dir?: string;
5
+ flags?: BlueprinitFlags;
6
+ }
7
+ export declare function blueprinitCore(options: BlueprinitOptions): Promise<CoreResult>;
@@ -0,0 +1,39 @@
1
+ import { cwd } from 'node:process';
2
+ import { detectStudio } from '../actions/blueprinit/studio.js';
3
+ import { findBlueprintFile } from '../actions/blueprints/blueprint.js';
4
+ import { validTokenOrErrorMessage } from '../utils/validated-token.js';
5
+ import { adoptFlow } from './blueprinit/adopt.js';
6
+ import { freshFlow } from './blueprinit/fresh.js';
7
+ export async function blueprinitCore(options) {
8
+ const { bin, log, flags = {}, dir = cwd() } = options;
9
+ try {
10
+ const existingBlueprint = findBlueprintFile(dir);
11
+ if (existingBlueprint) {
12
+ log(`A blueprint already exists here (${existingBlueprint.fileName}).`);
13
+ log('');
14
+ log('Use these instead:');
15
+ log(` npx ${bin} blueprints config --edit`);
16
+ log(` npx ${bin} blueprints doctor`);
17
+ return {
18
+ success: true,
19
+ json: { alreadyInitialized: true, blueprintFile: existingBlueprint.fileName },
20
+ };
21
+ }
22
+ const tokenCheck = await validTokenOrErrorMessage(log);
23
+ if (!tokenCheck.ok) {
24
+ return {
25
+ success: false,
26
+ error: 'No Sanity session found.',
27
+ suggestions: ['Sign in first: npx sanity login', 'Then run blueprinit again.'],
28
+ };
29
+ }
30
+ log('Setting up your Sanity workspace.');
31
+ log('');
32
+ const flowOptions = { bin, dir, flags, log, token: tokenCheck.value };
33
+ const studio = detectStudio(dir);
34
+ return studio ? await adoptFlow({ ...flowOptions, studio }) : await freshFlow(flowOptions);
35
+ }
36
+ catch (error) {
37
+ return { success: false, error: error instanceof Error ? error.message : String(error) };
38
+ }
39
+ }