@salesforce/core/lib/schema/sfdx-project/sfdxProjectJson.d.ts

Core libraries to interact with SFDX projects, orgs, and APIs.

import { z } from 'zod';
/**
 * The properties and shape of the SFDX project
 */
export declare const ProjectJsonSchema: z.ZodObject<{
    name: z.ZodOptional<z.ZodString>;
    packageDirectories: z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
        default: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
        path: z.ZodString;
    }, z.core.$strict>, z.ZodObject<{
        default: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
        path: z.ZodString;
        ancestorId: z.ZodOptional<z.ZodString>;
        ancestorVersion: z.ZodOptional<z.ZodString>;
        apexTestAccess: z.ZodOptional<z.ZodObject<{
            permissionSets: z.ZodUnion<readonly [z.ZodArray<z.ZodString>, z.ZodString]>;
            permissionSetLicenses: z.ZodUnion<readonly [z.ZodArray<z.ZodString>, z.ZodString]>;
        }, z.core.$strip>>;
        definitionFile: z.ZodOptional<z.ZodString>;
        dependencies: z.ZodOptional<z.ZodArray<z.ZodObject<{
            package: z.ZodString;
            versionNumber: z.ZodOptional<z.ZodString>;
            branch: z.ZodOptional<z.ZodString>;
        }, z.core.$catchall<z.ZodUnknown>>>>;
        includeProfileUserLicenses: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
        package: z.ZodString;
        packageMetadataAccess: z.ZodOptional<z.ZodObject<{
            permissionSets: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>;
            permissionSetLicenses: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>;
        }, z.core.$strip>>;
        postInstallScript: z.ZodOptional<z.ZodString>;
        postInstallUrl: z.ZodOptional<z.ZodString>;
        releaseNotesUrl: z.ZodOptional<z.ZodString>;
        scopeProfiles: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
        uninstallScript: z.ZodOptional<z.ZodString>;
        calculateTransitiveDependencies: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
        versionDescription: z.ZodOptional<z.ZodString>;
        versionName: z.ZodOptional<z.ZodString>;
        versionNumber: z.ZodString;
        unpackagedMetadata: z.ZodOptional<z.ZodObject<{
            path: z.ZodString;
        }, z.core.$strip>>;
        seedMetadata: z.ZodOptional<z.ZodObject<{
            path: z.ZodString;
        }, z.core.$strip>>;
        functions: z.ZodOptional<z.ZodArray<z.ZodString>>;
    }, z.core.$strict>]>>;
    namespace: z.ZodOptional<z.ZodString>;
    sourceApiVersion: z.ZodOptional<z.ZodDefault<z.ZodString>>;
    sfdcLoginUrl: z.ZodOptional<z.ZodString>;
    signupTargetLoginUrl: z.ZodOptional<z.ZodString>;
    oauthLocalPort: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
    plugins: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
    packageAliases: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
    packageBundles: z.ZodOptional<z.ZodArray<z.ZodObject<{
        name: z.ZodString;
        versionName: z.ZodString;
        versionNumber: z.ZodString;
        versionDescription: z.ZodOptional<z.ZodString>;
    }, z.core.$strip>>>;
    packageBundleAliases: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>>;
    registryPresets: z.ZodOptional<z.ZodArray<z.ZodString>>;
    sourceBehaviorOptions: z.ZodOptional<z.ZodArray<z.ZodString>>;
    registryCustomizations: z.ZodOptional<z.ZodObject<{
        types: z.ZodType<{
            [typeId: string]: {
                id: string;
                name: string;
                directoryName: string;
                suffix?: string;
                strictDirectoryName?: boolean;
                ignoreParsedFullName?: boolean;
                folderContentType?: string;
                folderType?: string;
                xmlElementName?: string;
                uniqueIdElement?: string;
                isAddressable?: boolean;
                unaddressableWithoutParent?: boolean;
                supportsWildcardAndName?: boolean;
                supportsPartialDelete?: boolean;
                aliasFor?: string;
                children?: {
                    types: {
                        [typeId: string]: any;
                    };
                    suffixes: Record<string, string>;
                    directories?: Record<string, string>;
                };
                strategies?: {
                    adapter: "mixedContent" | "matchingContentFile" | "decomposed" | "bundle" | "default";
                    transformer?: "decomposed" | "staticResource" | "standard";
                    decomposition?: "topLevel" | "folderPerType";
                };
            };
        }, unknown, z.core.$ZodTypeInternals<{
            [typeId: string]: {
                id: string;
                name: string;
                directoryName: string;
                suffix?: string;
                strictDirectoryName?: boolean;
                ignoreParsedFullName?: boolean;
                folderContentType?: string;
                folderType?: string;
                xmlElementName?: string;
                uniqueIdElement?: string;
                isAddressable?: boolean;
                unaddressableWithoutParent?: boolean;
                supportsWildcardAndName?: boolean;
                supportsPartialDelete?: boolean;
                aliasFor?: string;
                children?: {
                    types: {
                        [typeId: string]: any;
                    };
                    suffixes: Record<string, string>;
                    directories?: Record<string, string>;
                };
                strategies?: {
                    adapter: "mixedContent" | "matchingContentFile" | "decomposed" | "bundle" | "default";
                    transformer?: "decomposed" | "staticResource" | "standard";
                    decomposition?: "topLevel" | "folderPerType";
                };
            };
        }, unknown>>;
        suffixes: z.ZodRecord<z.ZodString, z.ZodString>;
        strictDirectoryNames: z.ZodRecord<z.ZodString, z.ZodString>;
        childTypes: z.ZodRecord<z.ZodString, z.ZodString>;
    }, z.core.$strip>>;
    replacements: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
        replaceWhenEnv: z.ZodOptional<z.ZodArray<z.ZodObject<{
            env: z.ZodString;
            value: z.ZodString;
        }, z.core.$strict>>>;
        filename: z.ZodString;
        stringToReplace: z.ZodString;
        replaceWithFile: z.ZodString;
    }, z.core.$strict>, z.ZodObject<{
        replaceWhenEnv: z.ZodOptional<z.ZodArray<z.ZodObject<{
            env: z.ZodString;
            value: z.ZodString;
        }, z.core.$strict>>>;
        filename: z.ZodString;
        stringToReplace: z.ZodString;
        replaceWithEnv: z.ZodString;
        allowUnsetEnvVariable: z.ZodOptional<z.ZodBoolean>;
    }, z.core.$strict>, z.ZodObject<{
        replaceWhenEnv: z.ZodOptional<z.ZodArray<z.ZodObject<{
            env: z.ZodString;
            value: z.ZodString;
        }, z.core.$strict>>>;
        filename: z.ZodString;
        regexToReplace: z.ZodString;
        replaceWithFile: z.ZodString;
    }, z.core.$strict>, z.ZodObject<{
        replaceWhenEnv: z.ZodOptional<z.ZodArray<z.ZodObject<{
            env: z.ZodString;
            value: z.ZodString;
        }, z.core.$strict>>>;
        filename: z.ZodString;
        regexToReplace: z.ZodString;
        replaceWithEnv: z.ZodString;
        allowUnsetEnvVariable: z.ZodOptional<z.ZodBoolean>;
    }, z.core.$strict>, z.ZodObject<{
        replaceWhenEnv: z.ZodOptional<z.ZodArray<z.ZodObject<{
            env: z.ZodString;
            value: z.ZodString;
        }, z.core.$strict>>>;
        glob: z.ZodString;
        stringToReplace: z.ZodString;
        replaceWithFile: z.ZodString;
    }, z.core.$strict>, z.ZodObject<{
        replaceWhenEnv: z.ZodOptional<z.ZodArray<z.ZodObject<{
            env: z.ZodString;
            value: z.ZodString;
        }, z.core.$strict>>>;
        glob: z.ZodString;
        stringToReplace: z.ZodString;
        replaceWithEnv: z.ZodString;
        allowUnsetEnvVariable: z.ZodOptional<z.ZodBoolean>;
    }, z.core.$strict>, z.ZodObject<{
        replaceWhenEnv: z.ZodOptional<z.ZodArray<z.ZodObject<{
            env: z.ZodString;
            value: z.ZodString;
        }, z.core.$strict>>>;
        glob: z.ZodString;
        regexToReplace: z.ZodString;
        replaceWithFile: z.ZodString;
    }, z.core.$strict>, z.ZodObject<{
        replaceWhenEnv: z.ZodOptional<z.ZodArray<z.ZodObject<{
            env: z.ZodString;
            value: z.ZodString;
        }, z.core.$strict>>>;
        glob: z.ZodString;
        regexToReplace: z.ZodString;
        replaceWithEnv: z.ZodString;
        allowUnsetEnvVariable: z.ZodOptional<z.ZodBoolean>;
    }, z.core.$strict>]>>>;
    pushPackageDirectoriesSequentially: z.ZodOptional<z.ZodBoolean>;
}, z.core.$strict>;
export type ProjectJson = z.infer<typeof ProjectJsonSchema>;