@salesforce/plugin-org/lib/commands/org/delete/scratch.js

Commands to interact with Salesforce orgs

/*
 * Copyright 2026, Salesforce, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import { AuthInfo, AuthRemover, Messages, Org } from '@salesforce/core';
import { Flags, SfCommand } from '@salesforce/sf-plugins-core';
import { ensureString } from '@salesforce/ts-types';
import { orgThatMightBeDeleted } from '../../../shared/flags.js';
Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
const messages = Messages.loadMessages('@salesforce/plugin-org', 'delete_scratch');
export default class DeleteScratch extends SfCommand {
    static summary = messages.getMessage('summary');
    static description = messages.getMessage('description');
    static examples = messages.getMessages('examples');
    static aliases = ['env:delete:scratch'];
    static deprecateAliases = true;
    static flags = {
        'target-org': orgThatMightBeDeleted({
            summary: messages.getMessage('flags.target-org.summary'),
            required: true,
        }),
        'no-prompt': Flags.boolean({
            char: 'p',
            summary: messages.getMessage('flags.no-prompt.summary'),
        }),
    };
    async run() {
        const flags = (await this.parse(DeleteScratch)).flags;
        const resolvedUsername = flags['target-org'];
        const { orgId, isScratch } = (await AuthInfo.create({ username: resolvedUsername })).getFields();
        if (!isScratch) {
            throw messages.createError('error.unknownScratch', [resolvedUsername]);
        }
        if (flags['no-prompt'] ||
            (await this.confirm({ message: messages.getMessage('prompt.confirm', [resolvedUsername]) }))) {
            try {
                const org = await Org.create({ aliasOrUsername: resolvedUsername });
                await org.delete();
                return { username: org.getUsername(), orgId: org.getOrgId() };
            }
            catch (e) {
                if (e instanceof Error && e.name === 'DomainNotFoundError') {
                    // the org has expired, so remote operations won't work
                    // let's clean up the files locally
                    const authRemover = await AuthRemover.create();
                    await authRemover.removeAuth(resolvedUsername);
                    this.logSuccess(messages.getMessage('success', [resolvedUsername]));
                }
                else if (e instanceof Error && e.name === 'ScratchOrgNotFound') {
                    this.logSuccess(messages.getMessage('success.Idempotent', [resolvedUsername]));
                }
                else {
                    throw e;
                }
            }
        }
        return {
            username: resolvedUsername,
            orgId: ensureString(orgId),
        };
    }
}
//# sourceMappingURL=scratch.js.map