@jterrats/smart-deployment 1.0.3

package/lib/types/salesforce/object.d.ts

@@ -0,0 +1,427 @@
+/**
+ * Type definitions for Salesforce Object metadata
+ * Represents CustomObject and CustomField metadata structures
+ */
+import type { Encoding } from './common.js';
+/**
+ * Custom Object metadata (.object-meta.xml)
+ */
+export type CustomObjectMetadata = {
+    actionOverrides?: ActionOverride[];
+    allowInChatterGroups?: boolean;
+    compactLayoutAssignment?: string;
+    customHelpPage?: string;
+    deploymentStatus?: DeploymentStatus;
+    deprecated?: boolean;
+    description?: string;
+    enableActivities?: boolean;
+    enableBulkApi?: boolean;
+    enableChangeDataCapture?: boolean;
+    enableEnhancedLookup?: boolean;
+    enableFeeds?: boolean;
+    enableHistory?: boolean;
+    enableReports?: boolean;
+    enableSearch?: boolean;
+    enableSharing?: boolean;
+    enableStreamingApi?: boolean;
+    externalSharingModel?: SharingModel;
+    fields?: CustomField[];
+    fieldSets?: FieldSet[];
+    gender?: Gender;
+    household?: boolean;
+    label: string;
+    listViews?: ListView[];
+    nameField?: CustomField;
+    pluralLabel: string;
+    recordTypes?: RecordType[];
+    searchLayouts?: SearchLayouts;
+    sharingModel?: SharingModel;
+    sharingReasons?: SharingReason[];
+    sharingRecalculations?: SharingRecalculation[];
+    startsWith?: StartsWith;
+    validationRules?: ValidationRule[];
+    visibility?: SetupObjectVisibility;
+    webLinks?: WebLink[];
+};
+/**
+ * Deployment status
+ */
+export type DeploymentStatus = 'Deployed' | 'InDevelopment';
+/**
+ * Sharing model
+ */
+export type SharingModel = 'Private' | 'Read' | 'ReadWrite' | 'ReadWriteTransfer' | 'FullAccess' | 'ControlledByParent' | 'ControlledByCampaign' | 'ControlledByLeadOrContact';
+/**
+ * Gender
+ */
+export type Gender = 'Neuter' | 'Masculine' | 'Feminine' | 'AnimateMasculine' | 'ClassI' | 'ClassIII';
+/**
+ * Starts with
+ */
+export type StartsWith = 'Consonant' | 'Vowel' | 'Special';
+/**
+ * Setup object visibility
+ */
+export type SetupObjectVisibility = 'Public' | 'Protected' | 'PackageProtected';
+/**
+ * Action override
+ */
+export type ActionOverride = {
+    actionName: string;
+    comment?: string;
+    content?: string;
+    formFactor?: FormFactor;
+    skipRecordTypeSelect?: boolean;
+    type: ActionOverrideType;
+};
+/**
+ * Form factor
+ */
+export type FormFactor = 'Small' | 'Medium' | 'Large';
+/**
+ * Action override type
+ */
+export type ActionOverrideType = 'Default' | 'Standard' | 'Scontrol' | 'Visualforce' | 'Flexipage' | 'LightningComponent';
+/**
+ * Custom Field metadata
+ */
+export type CustomField = {
+    fullName: string;
+    label: string;
+    type: FieldType;
+    businessOwnerGroup?: string;
+    businessOwnerUser?: string;
+    businessStatus?: string;
+    caseSensitive?: boolean;
+    complianceGroup?: string;
+    customDataType?: string;
+    defaultValue?: string;
+    deleteConstraint?: DeleteConstraint;
+    deprecated?: boolean;
+    description?: string;
+    displayFormat?: string;
+    displayLocationInDecimal?: boolean;
+    encrypted?: boolean;
+    encryptionScheme?: EncryptionScheme;
+    externalDeveloperName?: string;
+    externalId?: boolean;
+    fieldManageability?: FieldManageability;
+    formula?: string;
+    formulaTreatBlanksAs?: TreatBlanksAs;
+    inlineHelpText?: string;
+    isAIPredictionField?: boolean;
+    isConversationIntelligenceField?: boolean;
+    isFilteringDisabled?: boolean;
+    isNameField?: boolean;
+    isSortingDisabled?: boolean;
+    length?: number;
+    lookupFilter?: LookupFilter;
+    maskChar?: MaskChar;
+    maskType?: MaskType;
+    metadataRelationshipControllingField?: string;
+    populateExistingRows?: boolean;
+    precision?: number;
+    referenceTo?: string[];
+    referenceTargetField?: string;
+    relationshipLabel?: string;
+    relationshipName?: string;
+    relationshipOrder?: number;
+    reparentableMasterDetail?: boolean;
+    required?: boolean;
+    scale?: number;
+    securityClassification?: string;
+    startingNumber?: number;
+    stripMarkup?: boolean;
+    summarizedField?: string;
+    summaryFilterItems?: FilterItem[];
+    summaryForeignKey?: string;
+    summaryOperation?: SummaryOperations;
+    trackFeedHistory?: boolean;
+    trackHistory?: boolean;
+    trackTrending?: boolean;
+    translateData?: boolean;
+    unique?: boolean;
+    valueSet?: ValueSet;
+    visibleLines?: number;
+    writeRequiresMasterRead?: boolean;
+};
+/**
+ * Field type
+ */
+export type FieldType = 'AutoNumber' | 'Lookup' | 'MasterDetail' | 'MetadataRelationship' | 'Checkbox' | 'Currency' | 'Date' | 'DateTime' | 'Email' | 'EncryptedText' | 'ExternalLookup' | 'IndirectLookup' | 'Number' | 'Percent' | 'Phone' | 'Picklist' | 'MultiselectPicklist' | 'Summary' | 'Text' | 'TextArea' | 'LongTextArea' | 'Html' | 'Url' | 'Hierarchy' | 'File' | 'Location' | 'Time';
+/**
+ * Delete constraint
+ */
+export type DeleteConstraint = 'Cascade' | 'Restrict' | 'SetNull';
+/**
+ * Encryption scheme
+ */
+export type EncryptionScheme = 'None' | 'ProbabilisticEncryption' | 'CaseSensitiveDeterministicEncryption' | 'CaseInsensitiveDeterministicEncryption';
+/**
+ * Field manageability
+ */
+export type FieldManageability = 'DeveloperControlled' | 'SubscriberControlled' | 'Locked';
+/**
+ * Treat blanks as
+ */
+export type TreatBlanksAs = 'BlankAsBlank' | 'BlankAsZero';
+/**
+ * Mask char
+ */
+export type MaskChar = 'asterisk' | 'X';
+/**
+ * Mask type
+ */
+export type MaskType = 'all' | 'creditCard' | 'ssn' | 'lastFour' | 'sin' | 'nino';
+/**
+ * Summary operations
+ */
+export type SummaryOperations = 'count' | 'min' | 'max' | 'sum';
+/**
+ * Lookup filter
+ */
+export type LookupFilter = {
+    active: boolean;
+    booleanFilter?: string;
+    errorMessage?: string;
+    filterItems?: FilterItem[];
+    infoMessage?: string;
+    isOptional: boolean;
+};
+/**
+ * Filter item
+ */
+export type FilterItem = {
+    field: string;
+    operation: FilterOperation;
+    value?: string;
+    valueField?: string;
+};
+/**
+ * Filter operation
+ */
+export type FilterOperation = 'equals' | 'notEqual' | 'lessThan' | 'greaterThan' | 'lessOrEqual' | 'greaterOrEqual' | 'contains' | 'notContain' | 'startsWith' | 'includes' | 'excludes' | 'within';
+/**
+ * Value set
+ */
+export type ValueSet = {
+    controllingField?: string;
+    restricted?: boolean;
+    valueSetDefinition?: ValueSetDefinition;
+    valueSetName?: string;
+};
+/**
+ * Value set definition
+ */
+export type ValueSetDefinition = {
+    sorted: boolean;
+    value: CustomValue[];
+};
+/**
+ * Custom value (picklist value)
+ */
+export type CustomValue = {
+    fullName: string;
+    default: boolean;
+    label: string;
+    color?: string;
+    isActive?: boolean;
+    description?: string;
+};
+/**
+ * Field set
+ */
+export type FieldSet = {
+    fullName: string;
+    availableFields?: FieldSetItem[];
+    description?: string;
+    displayedFields: FieldSetItem[];
+    label: string;
+};
+/**
+ * Field set item
+ */
+export type FieldSetItem = {
+    field: string;
+    isFieldManaged?: boolean;
+    isRequired?: boolean;
+};
+/**
+ * List view
+ */
+export type ListView = {
+    fullName: string;
+    booleanFilter?: string;
+    columns: string[];
+    division?: string;
+    filterScope: FilterScope;
+    filters?: ListViewFilter[];
+    label: string;
+    language?: string;
+    queue?: string;
+    sharedTo?: SharedTo;
+};
+/**
+ * Filter scope
+ */
+export type FilterScope = 'Everything' | 'Mine' | 'Queue' | 'Delegated' | 'MyTerritory' | 'MyTeamTerritory' | 'Team' | 'AssignedToMe' | 'MineAndMyGroups';
+/**
+ * List view filter
+ */
+export type ListViewFilter = {
+    field: string;
+    operation: FilterOperation;
+    value?: string;
+};
+/**
+ * Shared to
+ */
+export type SharedTo = {
+    allCustomerPortalUsers?: string;
+    allInternalUsers?: string;
+    allPartnerUsers?: string;
+    channelProgramGroup?: string[];
+    channelProgramGroups?: string[];
+    group?: string[];
+    groups?: string[];
+    managerSubordinates?: string[];
+    managers?: string[];
+    portalRole?: string[];
+    portalRoleAndSubordinates?: string[];
+    queue?: string[];
+    role?: string[];
+    roleAndSubordinates?: string[];
+    roleAndSubordinatesInternal?: string[];
+    roles?: string[];
+    rolesAndSubordinates?: string[];
+    territories?: string[];
+    territoriesAndSubordinates?: string[];
+    territory?: string[];
+    territoryAndSubordinates?: string[];
+};
+/**
+ * Record type
+ */
+export type RecordType = {
+    fullName: string;
+    active: boolean;
+    businessProcess?: string;
+    compactLayoutAssignment?: string;
+    description?: string;
+    label: string;
+    picklistValues?: RecordTypePicklistValue[];
+};
+/**
+ * Record type picklist value
+ */
+export type RecordTypePicklistValue = {
+    picklist: string;
+    values: PicklistValue[];
+};
+/**
+ * Picklist value
+ */
+export type PicklistValue = {
+    fullName: string;
+    default: boolean;
+    allowEmail?: boolean;
+    closed?: boolean;
+    controllingFieldValues?: string[];
+    converted?: boolean;
+    cssExposed?: boolean;
+    forecastCategory?: ForecastCategories;
+    highPriority?: boolean;
+    probability?: number;
+    reverseRole?: string;
+    reviewed?: boolean;
+    won?: boolean;
+};
+/**
+ * Forecast categories
+ */
+export type ForecastCategories = 'Omitted' | 'Pipeline' | 'BestCase' | 'Forecast' | 'Closed';
+/**
+ * Search layouts
+ */
+export type SearchLayouts = {
+    customTabListAdditionalFields?: string[];
+    excludedStandardButtons?: string[];
+    listViewButtons?: string[];
+    lookupDialogsAdditionalFields?: string[];
+    lookupFilterFields?: string[];
+    lookupPhoneDialogsAdditionalFields?: string[];
+    searchFilterFields?: string[];
+    searchResultsAdditionalFields?: string[];
+    searchResultsCustomButtons?: string[];
+};
+/**
+ * Sharing reason
+ */
+export type SharingReason = {
+    fullName: string;
+    label: string;
+};
+/**
+ * Sharing recalculation
+ */
+export type SharingRecalculation = {
+    className: string;
+};
+/**
+ * Validation rule
+ */
+export type ValidationRule = {
+    fullName: string;
+    active: boolean;
+    description?: string;
+    errorConditionFormula: string;
+    errorDisplayField?: string;
+    errorMessage: string;
+};
+/**
+ * Web link
+ */
+export type WebLink = {
+    fullName: string;
+    availability: WebLinkAvailability;
+    description?: string;
+    displayType: WebLinkDisplayType;
+    encodingKey?: Encoding;
+    hasMenubar?: boolean;
+    hasScrollbars?: boolean;
+    hasToolbar?: boolean;
+    height?: number;
+    isResizable?: boolean;
+    linkType: WebLinkType;
+    masterLabel?: string;
+    openType: WebLinkWindowType;
+    page?: string;
+    position?: WebLinkPosition;
+    protected: boolean;
+    requireRowSelection?: boolean;
+    scontrol?: string;
+    showsLocation?: boolean;
+    showsStatus?: boolean;
+    url?: string;
+    width?: number;
+};
+/**
+ * Web link availability
+ */
+export type WebLinkAvailability = 'online' | 'offline';
+/**
+ * Web link display type
+ */
+export type WebLinkDisplayType = 'link' | 'button' | 'massActionButton';
+/**
+ * Web link type
+ */
+export type WebLinkType = 'url' | 'sControl' | 'javascript' | 'page' | 'flow';
+/**
+ * Web link window type
+ */
+export type WebLinkWindowType = 'newWindow' | 'sidebar' | 'noSidebar' | 'replace' | 'onClickJavaScript';
+/**
+ * Web link position
+ */
+export type WebLinkPosition = 'fullScreen' | 'none' | 'topLeft';

package/lib/types/salesforce/object.js

@@ -0,0 +1,6 @@
+/**
+ * Type definitions for Salesforce Object metadata
+ * Represents CustomObject and CustomField metadata structures
+ */
+export {};
+//# sourceMappingURL=object.js.map

package/lib/types/salesforce/object.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"object.js","sourceRoot":"","sources":["../../../src/types/salesforce/object.ts"],"names":[],"mappings":"AAAA;;;GAGG"}

package/lib/types/salesforce/parser-types.d.ts

@@ -0,0 +1,79 @@
+/**
+ * Parser-friendly types for Salesforce metadata
+ *
+ * These types are more permissive than the strict metadata types,
+ * allowing parsers to handle unknown/future metadata types gracefully.
+ *
+ * @module types/salesforce/parser-types
+ */
+import type { FlowMetadata, LWCMetadata, AuraComponentMetadata, ApexClassMetadata, ApexTriggerMetadata, CustomObjectMetadata } from './index.js';
+/**
+ * Parser-safe Flow metadata
+ * Allows unknown processType values for forward compatibility
+ */
+export type ParsedFlowMetadata = Omit<Partial<FlowMetadata>, 'processType' | 'status'> & {
+    label: string;
+    processType: string;
+    status: string;
+};
+/**
+ * Parser-safe LWC metadata
+ * Allows unknown target values
+ */
+export type ParsedLWCMetadata = Omit<Partial<LWCMetadata>, 'targets'> & {
+    apiVersion: string;
+    isExposed: boolean;
+    targets?: {
+        target: string[];
+    };
+};
+/**
+ * Parser-safe Aura metadata
+ * Allows unknown access levels
+ */
+export type ParsedAuraMetadata = Partial<AuraComponentMetadata> & {
+    apiVersion?: string;
+    access?: string;
+};
+/**
+ * Parser-safe Apex metadata
+ * Allows unknown status values
+ */
+export type ParsedApexClassMetadata = Omit<Partial<ApexClassMetadata>, 'status'> & {
+    apiVersion: string;
+    status: string;
+};
+export type ParsedApexTriggerMetadata = Omit<Partial<ApexTriggerMetadata>, 'status'> & {
+    apiVersion: string;
+    status: string;
+};
+/**
+ * Parser-safe Custom Object metadata
+ * Allows unknown deployment status and sharing models
+ */
+export type ParsedCustomObjectMetadata = Omit<Partial<CustomObjectMetadata>, 'deploymentStatus' | 'sharingModel'> & {
+    label: string;
+    pluralLabel: string;
+    deploymentStatus?: string;
+    sharingModel?: string;
+};
+/**
+ * Type guard helpers for safe type narrowing
+ */
+export declare function isKnownFlowProcessType(type: string): boolean;
+export declare function isKnownFlowStatus(status: string): boolean;
+export declare function isKnownApexStatus(status: string): boolean;
+export declare function isKnownAuraAccess(access: string): boolean;
+export declare function isKnownLWCTarget(target: string): boolean;
+/**
+ * Validation helpers that log warnings for unknown values
+ * but don't throw errors
+ */
+export declare function validateFlowMetadata(parsed: ParsedFlowMetadata): FlowMetadata;
+export declare function validateLWCMetadata(parsed: ParsedLWCMetadata): LWCMetadata;
+/**
+ * Helper to safely parse unknown metadata
+ * Returns a generic Record if the metadata type is completely unknown
+ */
+export type UnknownMetadata = Record<string, unknown>;
+export declare function parseUnknownMetadata(xmlContent: string, metadataType: string): UnknownMetadata;

package/lib/types/salesforce/parser-types.js

@@ -0,0 +1,80 @@
+/**
+ * Parser-friendly types for Salesforce metadata
+ *
+ * These types are more permissive than the strict metadata types,
+ * allowing parsers to handle unknown/future metadata types gracefully.
+ *
+ * @module types/salesforce/parser-types
+ */
+/**
+ * Type guard helpers for safe type narrowing
+ */
+export function isKnownFlowProcessType(type) {
+    const knownTypes = [
+        'AutoLaunchedFlow',
+        'Flow',
+        'Workflow',
+        'CustomEvent',
+        'InvocableProcess',
+        'LoginFlow',
+        'ActionPlan',
+        // Add all known types
+    ];
+    return knownTypes.includes(type);
+}
+export function isKnownFlowStatus(status) {
+    return ['Active', 'Draft', 'Obsolete', 'InvalidDraft'].includes(status);
+}
+export function isKnownApexStatus(status) {
+    return ['Active', 'Inactive', 'Deleted'].includes(status);
+}
+export function isKnownAuraAccess(access) {
+    return ['GLOBAL', 'PUBLIC', 'PRIVATE', 'INTERNAL'].includes(access);
+}
+export function isKnownLWCTarget(target) {
+    const knownTargets = [
+        'lightning__AppPage',
+        'lightning__HomePage',
+        'lightning__RecordPage',
+        'lightning__RecordAction',
+        'lightning__FlowScreen',
+        // Add all known targets
+    ];
+    return knownTargets.includes(target);
+}
+/**
+ * Validation helpers that log warnings for unknown values
+ * but don't throw errors
+ */
+export function validateFlowMetadata(parsed) {
+    if (!isKnownFlowProcessType(parsed.processType)) {
+        // Note: In production, replace with proper logger
+        // logger.warn(`[FlowParser] Unknown processType: ${parsed.processType}. This might be a new Salesforce feature. Proceeding anyway...`);
+    }
+    if (parsed.status && !isKnownFlowStatus(parsed.status)) {
+        // Note: In production, replace with proper logger
+        // logger.warn(`[FlowParser] Unknown status: ${parsed.status}. Proceeding anyway...`);
+    }
+    // Cast to strict type after validation
+    return parsed;
+}
+export function validateLWCMetadata(parsed) {
+    if (parsed.targets?.target) {
+        const unknownTargets = parsed.targets.target.filter((t) => !isKnownLWCTarget(t));
+        if (unknownTargets.length > 0) {
+            // Note: In production, replace with proper logger
+            // logger.warn(`[LWCParser] Unknown targets: ${unknownTargets.join(', ')}. These might be new Salesforce features. Proceeding anyway...`);
+        }
+    }
+    return parsed;
+}
+export function parseUnknownMetadata(xmlContent, metadataType) {
+    // Note: In production, replace with proper logger
+    // logger.warn(`[Parser] No specific parser for metadata type: ${metadataType}. Parsing as generic metadata. Consider adding a parser for this type.`);
+    // Return a generic object that can hold any properties
+    return {
+        _metadataType: metadataType,
+        _rawContent: xmlContent,
+    };
+}
+//# sourceMappingURL=parser-types.js.map

package/lib/types/salesforce/parser-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parser-types.js","sourceRoot":"","sources":["../../../src/types/salesforce/parser-types.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAmEH;;GAEG;AAEH,MAAM,UAAU,sBAAsB,CAAC,IAAY;IACjD,MAAM,UAAU,GAAG;QACjB,kBAAkB;QAClB,MAAM;QACN,UAAU;QACV,aAAa;QACb,kBAAkB;QAClB,WAAW;QACX,YAAY;QACZ,sBAAsB;KACvB,CAAC;IACF,OAAO,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AACnC,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,MAAc;IAC9C,OAAO,CAAC,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,cAAc,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AAC1E,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,MAAc;IAC9C,OAAO,CAAC,QAAQ,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AAC5D,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,MAAc;IAC9C,OAAO,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AACtE,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,MAAc;IAC7C,MAAM,YAAY,GAAG;QACnB,oBAAoB;QACpB,qBAAqB;QACrB,uBAAuB;QACvB,yBAAyB;QACzB,uBAAuB;QACvB,wBAAwB;KACzB,CAAC;IACF,OAAO,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AACvC,CAAC;AAED;;;GAGG;AAEH,MAAM,UAAU,oBAAoB,CAAC,MAA0B;IAC7D,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC;QAChD,kDAAkD;QAClD,wIAAwI;IAC1I,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;QACvD,kDAAkD;QAClD,sFAAsF;IACxF,CAAC;IAED,uCAAuC;IACvC,OAAO,MAAiC,CAAC;AAC3C,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,MAAyB;IAC3D,IAAI,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;QAC3B,MAAM,cAAc,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;QACjF,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC9B,kDAAkD;YAClD,0IAA0I;QAC5I,CAAC;IACH,CAAC;IAED,OAAO,MAAgC,CAAC;AAC1C,CAAC;AAQD,MAAM,UAAU,oBAAoB,CAAC,UAAkB,EAAE,YAAoB;IAC3E,kDAAkD;IAClD,uJAAuJ;IAEvJ,uDAAuD;IACvD,OAAO;QACL,aAAa,EAAE,YAAY;QAC3B,WAAW,EAAE,UAAU;KACxB,CAAC;AACJ,CAAC"}