@salesforce/b2c-cli 0.6.0 → 0.7.0

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 (5) hide show
  1. package/dist/commands/sandbox/update.d.ts +24 -0
  2. package/dist/commands/sandbox/update.js +111 -0
  3. package/dist/commands/sandbox/update.js.map +1 -0
  4. package/oclif.manifest.json +3318 -3043
  5. package/package.json +2 -2
package/dist/commands/sandbox/update.d.ts ADDED
@@ -0,0 +1,24 @@
1
+ import { OdsCommand } from '@salesforce/b2c-tooling-sdk/cli';
2
+ import { type OdsComponents } from '@salesforce/b2c-tooling-sdk';
3
+ type SandboxModel = OdsComponents['schemas']['SandboxModel'];
4
+ /**
5
+ * Command to update an on-demand sandbox.
6
+ */
7
+ export default class SandboxUpdate extends OdsCommand<typeof SandboxUpdate> {
8
+ static aliases: string[];
9
+ static args: {
10
+ sandboxId: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
11
+ };
12
+ static description: string;
13
+ static enableJsonFlag: boolean;
14
+ static examples: string[];
15
+ static flags: {
16
+ ttl: import("@oclif/core/interfaces").OptionFlag<number | undefined, import("@oclif/core/interfaces").CustomOptions>;
17
+ 'auto-scheduled': import("@oclif/core/interfaces").BooleanFlag<boolean>;
18
+ tags: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
19
+ emails: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
20
+ };
21
+ run(): Promise<SandboxModel>;
22
+ private printSandboxSummary;
23
+ }
24
+ export {};
package/dist/commands/sandbox/update.js ADDED
@@ -0,0 +1,111 @@
1
+ /*
2
+ * Copyright (c) 2025, Salesforce, Inc.
3
+ * SPDX-License-Identifier: Apache-2
4
+ * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0
5
+ */
6
+ import { Args, Flags, ux } from '@oclif/core';
7
+ import cliui from 'cliui';
8
+ import { OdsCommand } from '@salesforce/b2c-tooling-sdk/cli';
9
+ import { getApiErrorMessage } from '@salesforce/b2c-tooling-sdk';
10
+ import { t, withDocs } from '../../i18n/index.js';
11
+ /**
12
+ * Command to update an on-demand sandbox.
13
+ */
14
+ export default class SandboxUpdate extends OdsCommand {
15
+ static aliases = ['ods:update'];
16
+ static args = {
17
+ sandboxId: Args.string({
18
+ description: 'Sandbox ID (UUID or realm-instance, e.g., abcd-123)',
19
+ required: true,
20
+ }),
21
+ };
22
+ static description = withDocs(t('commands.sandbox.update.description', 'Update a sandbox (extend TTL, change scheduling, update tags or emails)'), '/cli/sandbox.html#b2c-sandbox-update');
23
+ static enableJsonFlag = true;
24
+ static examples = [
25
+ '<%= config.bin %> <%= command.id %> zzzv-123 --ttl 48',
26
+ '<%= config.bin %> <%= command.id %> zzzv-123 --ttl 0',
27
+ '<%= config.bin %> <%= command.id %> zzzv-123 --auto-scheduled',
28
+ '<%= config.bin %> <%= command.id %> zzzv-123 --no-auto-scheduled',
29
+ '<%= config.bin %> <%= command.id %> zzzv-123 --tags tag1,tag2',
30
+ '<%= config.bin %> <%= command.id %> zzzv-123 --emails user@example.com,dev@example.com',
31
+ '<%= config.bin %> <%= command.id %> zzzv-123 --ttl 48 --tags ci,nightly --json',
32
+ ];
33
+ static flags = {
34
+ ttl: Flags.integer({
35
+ description: 'Number of hours to add to sandbox lifetime (0 or less for infinite)',
36
+ }),
37
+ 'auto-scheduled': Flags.boolean({
38
+ description: 'Enable or disable automatic start/stop scheduling',
39
+ allowNo: true,
40
+ }),
41
+ tags: Flags.string({
42
+ description: 'Comma-separated list of tags',
43
+ }),
44
+ emails: Flags.string({
45
+ description: 'Comma-separated list of notification email addresses',
46
+ }),
47
+ };
48
+ async run() {
49
+ const sandboxId = await this.resolveSandboxId(this.args.sandboxId);
50
+ const { ttl, 'auto-scheduled': autoScheduled, tags, emails } = this.flags;
51
+ // Require at least one update flag
52
+ if (ttl === undefined && autoScheduled === undefined && tags === undefined && emails === undefined) {
53
+ this.error('At least one update flag is required. Use --ttl, --auto-scheduled, --tags, or --emails.');
54
+ }
55
+ const body = {};
56
+ if (ttl !== undefined) {
57
+ body.ttl = ttl;
58
+ }
59
+ if (autoScheduled !== undefined) {
60
+ body.autoScheduled = autoScheduled;
61
+ }
62
+ if (tags !== undefined) {
63
+ body.tags = tags.split(',').map((tag) => tag.trim());
64
+ }
65
+ if (emails !== undefined) {
66
+ body.emails = emails.split(',').map((email) => email.trim());
67
+ }
68
+ this.log(t('commands.sandbox.update.updating', 'Updating sandbox {{sandboxId}}...', { sandboxId }));
69
+ const result = await this.odsClient.PATCH('/sandboxes/{sandboxId}', {
70
+ params: {
71
+ path: { sandboxId },
72
+ },
73
+ body,
74
+ });
75
+ if (!result.data?.data) {
76
+ const message = getApiErrorMessage(result.error, result.response);
77
+ this.error(`Failed to update sandbox: ${message}`);
78
+ }
79
+ const sandbox = result.data.data;
80
+ this.log(t('commands.sandbox.update.success', 'Sandbox updated successfully'));
81
+ if (this.jsonEnabled()) {
82
+ return sandbox;
83
+ }
84
+ this.printSandboxSummary(sandbox);
85
+ return sandbox;
86
+ }
87
+ printSandboxSummary(sandbox) {
88
+ const ui = cliui({ width: process.stdout.columns || 80 });
89
+ const fields = [
90
+ ['ID', sandbox.id],
91
+ ['Realm', sandbox.realm],
92
+ ['Instance', sandbox.instance],
93
+ ['State', sandbox.state],
94
+ ['Auto Scheduled', sandbox.autoScheduled?.toString()],
95
+ ['EOL', sandbox.eol ? new Date(sandbox.eol).toLocaleString() : undefined],
96
+ ];
97
+ if (sandbox.tags && sandbox.tags.length > 0) {
98
+ fields.push(['Tags', sandbox.tags.join(', ')]);
99
+ }
100
+ if (sandbox.emails && sandbox.emails.length > 0) {
101
+ fields.push(['Emails', sandbox.emails.join(', ')]);
102
+ }
103
+ for (const [label, value] of fields) {
104
+ if (value !== undefined) {
105
+ ui.div({ text: `${label}:`, width: 20, padding: [0, 2, 0, 0] }, { text: value, padding: [0, 0, 0, 0] });
106
+ }
107
+ }
108
+ ux.stdout(ui.toString());
109
+ }
110
+ }
111
+ //# sourceMappingURL=update.js.map
package/dist/commands/sandbox/update.js.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"update.js","sourceRoot":"","sources":["../../../src/commands/sandbox/update.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAC,IAAI,EAAE,KAAK,EAAE,EAAE,EAAC,MAAM,aAAa,CAAC;AAC5C,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAC,UAAU,EAAC,MAAM,iCAAiC,CAAC;AAC3D,OAAO,EAAC,kBAAkB,EAAqB,MAAM,6BAA6B,CAAC;AACnF,OAAO,EAAC,CAAC,EAAE,QAAQ,EAAC,MAAM,qBAAqB,CAAC;AAKhD;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,UAAgC;IACzE,MAAM,CAAC,OAAO,GAAG,CAAC,YAAY,CAAC,CAAC;IAEhC,MAAM,CAAC,IAAI,GAAG;QACZ,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC;YACrB,WAAW,EAAE,qDAAqD;YAClE,QAAQ,EAAE,IAAI;SACf,CAAC;KACH,CAAC;IAEF,MAAM,CAAC,WAAW,GAAG,QAAQ,CAC3B,CAAC,CAAC,qCAAqC,EAAE,yEAAyE,CAAC,EACnH,sCAAsC,CACvC,CAAC;IAEF,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC;IAE7B,MAAM,CAAC,QAAQ,GAAG;QAChB,uDAAuD;QACvD,sDAAsD;QACtD,+DAA+D;QAC/D,kEAAkE;QAClE,+DAA+D;QAC/D,wFAAwF;QACxF,gFAAgF;KACjF,CAAC;IAEF,MAAM,CAAC,KAAK,GAAG;QACb,GAAG,EAAE,KAAK,CAAC,OAAO,CAAC;YACjB,WAAW,EAAE,qEAAqE;SACnF,CAAC;QACF,gBAAgB,EAAE,KAAK,CAAC,OAAO,CAAC;YAC9B,WAAW,EAAE,mDAAmD;YAChE,OAAO,EAAE,IAAI;SACd,CAAC;QACF,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC;YACjB,WAAW,EAAE,8BAA8B;SAC5C,CAAC;QACF,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;YACnB,WAAW,EAAE,sDAAsD;SACpE,CAAC;KACH,CAAC;IAEF,KAAK,CAAC,GAAG;QACP,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACnE,MAAM,EAAC,GAAG,EAAE,gBAAgB,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAC,GAAG,IAAI,CAAC,KAAK,CAAC;QAExE,mCAAmC;QACnC,IAAI,GAAG,KAAK,SAAS,IAAI,aAAa,KAAK,SAAS,IAAI,IAAI,KAAK,SAAS,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACnG,IAAI,CAAC,KAAK,CAAC,yFAAyF,CAAC,CAAC;QACxG,CAAC;QAED,MAAM,IAAI,GAA8B,EAAE,CAAC;QAE3C,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;YACtB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACjB,CAAC;QAED,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;YAChC,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACrC,CAAC;QAED,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;QACvD,CAAC;QAED,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;QAC/D,CAAC;QAED,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,kCAAkC,EAAE,mCAAmC,EAAE,EAAC,SAAS,EAAC,CAAC,CAAC,CAAC;QAElG,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,wBAAwB,EAAE;YAClE,MAAM,EAAE;gBACN,IAAI,EAAE,EAAC,SAAS,EAAC;aAClB;YACD,IAAI;SACL,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC;YACvB,MAAM,OAAO,GAAG,kBAAkB,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;YAClE,IAAI,CAAC,KAAK,CAAC,6BAA6B,OAAO,EAAE,CAAC,CAAC;QACrD,CAAC;QAED,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;QAEjC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,iCAAiC,EAAE,8BAA8B,CAAC,CAAC,CAAC;QAE/E,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YACvB,OAAO,OAAO,CAAC;QACjB,CAAC;QAED,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;QAElC,OAAO,OAAO,CAAC;IACjB,CAAC;IAEO,mBAAmB,CAAC,OAAqB;QAC/C,MAAM,EAAE,GAAG,KAAK,CAAC,EAAC,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,OAAO,IAAI,EAAE,EAAC,CAAC,CAAC;QAExD,MAAM,MAAM,GAAmC;YAC7C,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,CAAC;YAClB,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC;YACxB,CAAC,UAAU,EAAE,OAAO,CAAC,QAAQ,CAAC;YAC9B,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC;YACxB,CAAC,gBAAgB,EAAE,OAAO,CAAC,aAAa,EAAE,QAAQ,EAAE,CAAC;YACrD,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;SAC1E,CAAC;QAEF,IAAI,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC5C,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjD,CAAC;QAED,IAAI,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChD,MAAM,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACrD,CAAC;QAED,KAAK,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,MAAM,EAAE,CAAC;YACpC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACxB,EAAE,CAAC,GAAG,CAAC,EAAC,IAAI,EAAE,GAAG,KAAK,GAAG,EAAE,KAAK,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAC,EAAE,EAAC,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAC,CAAC,CAAC;YACtG,CAAC;QACH,CAAC;QAED,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC3B,CAAC"}