@salesforce/plugin-bre-to-cml 1.0.2

package/lib/shared/types/cml-relation.d.ts

@@ -0,0 +1,31 @@
+import { AnnotatedCmlElementWAttributes } from './base/types.js';
+export type CmlRelationCardinality = {
+    min?: number;
+    max?: number;
+};
+export declare class CmlRelation extends AnnotatedCmlElementWAttributes {
+    #private;
+    constructor(name: string, type: string);
+    get name(): string;
+    get type(): string;
+    get cardinality(): CmlRelationCardinality;
+    get order(): string[];
+    get prcIds(): string[];
+    set type(type: string);
+    set name(name: string);
+    /**
+     * Cardinality can be an integer or a string constant.
+     */
+    setMinCardinality(minCardinality: number): void;
+    /**
+     * Cardinality can be an integer or a string constant.
+     */
+    setMaxCardinality(maxCardinality: number): void;
+    hasCardinality(): boolean;
+    hasMinCardinality(): boolean;
+    hasMaxCardinality(): boolean;
+    setOrder(order: string[]): void;
+    setPrcIds(prcIds: string[]): void;
+    hasOrder(): boolean;
+    generateCml(): string;
+}

package/lib/shared/types/cml-relation.js

@@ -0,0 +1,118 @@
+/*
+ * Copyright 2025, 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 { isEmpty } from '../utils/common.utils.js';
+import { AnnotatedCmlElementWAttributes } from './base/types.js';
+export class CmlRelation extends AnnotatedCmlElementWAttributes {
+    #name;
+    #type;
+    #cardinality = {};
+    #order = [];
+    #prcIds = [];
+    constructor(name, type) {
+        super();
+        this.#name = name;
+        this.#type = type;
+    }
+    get name() {
+        return this.#name;
+    }
+    get type() {
+        return this.#type;
+    }
+    get cardinality() {
+        return this.#cardinality;
+    }
+    get order() {
+        return this.#order;
+    }
+    get prcIds() {
+        return this.#prcIds;
+    }
+    set type(type) {
+        this.#type = type;
+    }
+    set name(name) {
+        this.#name = name;
+    }
+    /**
+     * Cardinality can be an integer or a string constant.
+     */
+    setMinCardinality(minCardinality) {
+        this.#cardinality.min = minCardinality;
+    }
+    /**
+     * Cardinality can be an integer or a string constant.
+     */
+    setMaxCardinality(maxCardinality) {
+        if (isEmpty(this.#cardinality.min)) {
+            this.#cardinality.min = 0;
+        }
+        this.#cardinality.max = maxCardinality;
+    }
+    hasCardinality() {
+        return !isEmpty(this.#cardinality.min) && !isEmpty(this.#cardinality.max);
+    }
+    hasMinCardinality() {
+        return !isEmpty(this.#cardinality.min);
+    }
+    hasMaxCardinality() {
+        return !isEmpty(this.#cardinality.max);
+    }
+    setOrder(order) {
+        this.#order = order;
+    }
+    setPrcIds(prcIds) {
+        this.#prcIds = prcIds;
+    }
+    hasOrder() {
+        return this.#order.length > 0;
+    }
+    generateCml() {
+        let output = '';
+        if (this.hasProperties()) {
+            output += this.generateAnnotation() + '\n';
+        }
+        output += `relation ${this.#name} : ${this.#type}`;
+        // relations can have min/max cardinalities
+        if (this.hasCardinality()) {
+            if (this.cardinality.min === this.cardinality.max) {
+                output += `[${this.cardinality.min ?? 0}]`;
+            }
+            else {
+                output += `[${this.cardinality.min ?? 0}..${this.cardinality.max ?? 0}]`;
+            }
+        }
+        // relations can have an order of child types
+        if (this.hasOrder()) {
+            output += ' order (';
+            output += this.order.join(', ');
+            output += ')';
+        }
+        // relation body can contain relation attributes and default components
+        if (this.hasAttributes()) {
+            output += ' {\n';
+            this.attributes.forEach((a) => {
+                output += a.generateCml() + ';\n';
+            });
+            output += '}';
+        }
+        else {
+            output += ';';
+        }
+        return output;
+    }
+}
+//# sourceMappingURL=cml-relation.js.map

package/lib/shared/types/cml-relation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cml-relation.js","sourceRoot":"","sources":["../../../src/shared/types/cml-relation.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,OAAO,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAC;AACnD,OAAO,EAAE,8BAA8B,EAAE,MAAM,iBAAiB,CAAC;AAOjE,MAAM,OAAO,WAAY,SAAQ,8BAA8B;IAC7D,KAAK,CAAC;IACN,KAAK,CAAC;IACN,YAAY,GAA2B,EAAE,CAAC;IAC1C,MAAM,GAAa,EAAE,CAAC;IACtB,OAAO,GAAa,EAAE,CAAC;IAEvB,YAAmB,IAAY,EAAE,IAAY;QAC3C,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,IAAW,IAAI,CAAC,IAAY;QAC1B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED,IAAW,IAAI,CAAC,IAAY;QAC1B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED;;OAEG;IACI,iBAAiB,CAAC,cAAsB;QAC7C,IAAI,CAAC,YAAY,CAAC,GAAG,GAAG,cAAc,CAAC;IACzC,CAAC;IAED;;OAEG;IACI,iBAAiB,CAAC,cAAsB;QAC7C,IAAI,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC;YACnC,IAAI,CAAC,YAAY,CAAC,GAAG,GAAG,CAAC,CAAC;QAC5B,CAAC;QACD,IAAI,CAAC,YAAY,CAAC,GAAG,GAAG,cAAc,CAAC;IACzC,CAAC;IAEM,cAAc;QACnB,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;IAC5E,CAAC;IAEM,iBAAiB;QACtB,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;IACzC,CAAC;IAEM,iBAAiB;QACtB,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;IACzC,CAAC;IAEM,QAAQ,CAAC,KAAe;QAC7B,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAEM,SAAS,CAAC,MAAgB;QAC/B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAEM,QAAQ;QACb,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;IAChC,CAAC;IAEM,WAAW;QAChB,IAAI,MAAM,GAAG,EAAE,CAAC;QAEhB,IAAI,IAAI,CAAC,aAAa,EAAE,EAAE,CAAC;YACzB,MAAM,IAAI,IAAI,CAAC,kBAAkB,EAAE,GAAG,IAAI,CAAC;QAC7C,CAAC;QAED,MAAM,IAAI,YAAY,IAAI,CAAC,KAAK,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;QAEnD,2CAA2C;QAC3C,IAAI,IAAI,CAAC,cAAc,EAAE,EAAE,CAAC;YAC1B,IAAI,IAAI,CAAC,WAAW,CAAC,GAAG,KAAK,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC;gBAClD,MAAM,IAAI,IAAI,IAAI,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC;YAC7C,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,IAAI,IAAI,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,KAAK,IAAI,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC;YAC3E,CAAC;QACH,CAAC;QAED,6CAA6C;QAC7C,IAAI,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC;YACpB,MAAM,IAAI,UAAU,CAAC;YACrB,MAAM,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAChC,MAAM,IAAI,GAAG,CAAC;QAChB,CAAC;QAED,uEAAuE;QACvE,IAAI,IAAI,CAAC,aAAa,EAAE,EAAE,CAAC;YACzB,MAAM,IAAI,MAAM,CAAC;YAEjB,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;gBAC5B,MAAM,IAAI,CAAC,CAAC,WAAW,EAAE,GAAG,KAAK,CAAC;YACpC,CAAC,CAAC,CAAC;YAEH,MAAM,IAAI,GAAG,CAAC;QAChB,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,GAAG,CAAC;QAChB,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}

package/lib/shared/types/cml-type.d.ts

@@ -0,0 +1,22 @@
+import { AnnotatedCmlElementWAttributes } from './base/types.js';
+import { CmlConstraint } from './cml-constraint.js';
+import { CmlRelation } from './cml-relation.js';
+export declare class CmlType extends AnnotatedCmlElementWAttributes {
+    #private;
+    constructor(name: string, productId: string | undefined, basedOnId?: string);
+    get name(): string;
+    get productId(): string | undefined;
+    get basedOnId(): string | undefined;
+    get parentType(): CmlType | undefined;
+    get relations(): CmlRelation[];
+    get constraints(): CmlConstraint[];
+    get isVirtualContainer(): boolean;
+    hasParentType(): boolean;
+    setParentType(parentType: CmlType): void;
+    isEmptyType(): boolean;
+    addRelation(r: CmlRelation): void;
+    getRelation(name: string): CmlRelation | undefined;
+    editRelation(r: CmlRelation): void;
+    addConstraint(c: CmlConstraint): void;
+    generateCml(): string;
+}

package/lib/shared/types/cml-type.js

@@ -0,0 +1,111 @@
+/*
+ * Copyright 2025, 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 { AnnotatedCmlElementWAttributes } from './base/types.js';
+export class CmlType extends AnnotatedCmlElementWAttributes {
+    #name;
+    #productId;
+    #basedOnId;
+    #parentType;
+    #relations = new Map();
+    #constraints = [];
+    constructor(name, productId, basedOnId) {
+        super();
+        this.#name = name;
+        this.#productId = productId;
+        this.#basedOnId = basedOnId;
+    }
+    get name() {
+        return this.#name;
+    }
+    get productId() {
+        return this.#productId;
+    }
+    get basedOnId() {
+        return this.#basedOnId;
+    }
+    get parentType() {
+        return this.#parentType;
+    }
+    get relations() {
+        return Array.from(this.#relations.values());
+    }
+    get constraints() {
+        return Array.from(this.#constraints);
+    }
+    get isVirtualContainer() {
+        return this.properties?.virtual === true;
+    }
+    hasParentType() {
+        return !!this.#parentType;
+    }
+    setParentType(parentType) {
+        this.#parentType = parentType;
+    }
+    isEmptyType() {
+        return this.attributes.length === 0 && this.relations.length === 0 && this.constraints.length === 0;
+    }
+    addRelation(r) {
+        if (!r.name) {
+            throw new Error('MissingRelationName');
+        }
+        const existingRelation = this.#relations.get(r.name);
+        if (existingRelation) {
+            throw new Error('RelationExists'.replace('{0}', r.name));
+        }
+        this.#relations.set(r.name, r);
+    }
+    getRelation(name) {
+        return this.#relations.get(name);
+    }
+    editRelation(r) {
+        if (!r.name) {
+            throw new Error('MissingRelationName');
+        }
+        if (!this.#relations.has(r.name)) {
+            throw new Error('RelationDoesNotExist'.replace('{0}', r.name));
+        }
+        this.#relations.set(r.name, r);
+    }
+    addConstraint(c) {
+        if (!c.name || !this.#constraints.some(({ name }) => c.name === name)) {
+            c.setSequence(this.#constraints.length);
+            this.#constraints.push(c);
+        }
+    }
+    generateCml() {
+        let output = '';
+        if (this.hasProperties()) {
+            output += this.generateAnnotation() + '\n';
+        }
+        output += `type ${this.#name}`;
+        if (this.#parentType) {
+            output += ` : ${this.#parentType.name}`;
+        }
+        if (this.isEmptyType()) {
+            return `${output};\n`;
+        }
+        const sections = [
+            this.attributes.map((a) => a.generateCml() + ';\n'),
+            this.relations.map((r) => r.generateCml() + '\n'),
+            this.constraints.sort((l, r) => l.sequence - r.sequence).map((c) => c.generateCml() + '\n'),
+        ]
+            .filter((section) => section.length > 0)
+            .flat();
+        output += ` {\n${sections.join('\n')}\n}\n`;
+        return output;
+    }
+}
+//# sourceMappingURL=cml-type.js.map

package/lib/shared/types/cml-type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cml-type.js","sourceRoot":"","sources":["../../../src/shared/types/cml-type.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,OAAO,EAAE,8BAA8B,EAAE,MAAM,iBAAiB,CAAC;AAIjE,MAAM,OAAO,OAAQ,SAAQ,8BAA8B;IAChD,KAAK,CAAS;IACd,UAAU,CAAqB;IAC/B,UAAU,CAAqB;IACxC,WAAW,CAAW;IACtB,UAAU,GAA6B,IAAI,GAAG,EAAE,CAAC;IACjD,YAAY,GAAoB,EAAE,CAAC;IAEnC,YAAmB,IAAY,EAAE,SAA6B,EAAE,SAAkB;QAChF,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IAC9B,CAAC;IAED,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,IAAW,SAAS;QAClB,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC;IAC9C,CAAC;IAED,IAAW,WAAW;QACpB,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACvC,CAAC;IAED,IAAW,kBAAkB;QAC3B,OAAO,IAAI,CAAC,UAAU,EAAE,OAAO,KAAK,IAAI,CAAC;IAC3C,CAAC;IAEM,aAAa;QAClB,OAAO,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC;IAC5B,CAAC;IAEM,aAAa,CAAC,UAAmB;QACtC,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;IAEM,WAAW;QAChB,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,KAAK,CAAC,CAAC;IACtG,CAAC;IAEM,WAAW,CAAC,CAAc;QAC/B,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACzC,CAAC;QACD,MAAM,gBAAgB,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACrD,IAAI,gBAAgB,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QAC3D,CAAC;QACD,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IACjC,CAAC;IAEM,WAAW,CAAC,IAAY;QAC7B,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;IAEM,YAAY,CAAC,CAAc;QAChC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACzC,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;YACjC,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QACjE,CAAC;QACD,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IACjC,CAAC;IAEM,aAAa,CAAC,CAAgB;QACnC,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC;YACtE,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;YACxC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC;IAEM,WAAW;QAChB,IAAI,MAAM,GAAG,EAAE,CAAC;QAEhB,IAAI,IAAI,CAAC,aAAa,EAAE,EAAE,CAAC;YACzB,MAAM,IAAI,IAAI,CAAC,kBAAkB,EAAE,GAAG,IAAI,CAAC;QAC7C,CAAC;QAED,MAAM,IAAI,QAAQ,IAAI,CAAC,KAAK,EAAE,CAAC;QAE/B,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,MAAM,IAAI,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;QAC1C,CAAC;QAED,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YACvB,OAAO,GAAG,MAAM,KAAK,CAAC;QACxB,CAAC;QAED,MAAM,QAAQ,GAAG;YACf,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,KAAK,CAAC;YACnD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC;YACjD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC;SAC5F;aACE,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;aACvC,IAAI,EAAE,CAAC;QAEV,MAAM,IAAI,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;QAC5C,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}

package/lib/shared/types/sobject.d.ts

@@ -0,0 +1,13 @@
+export type ExpressionSetConstraintObj = {
+    Id: string;
+    ExpressionSetId: string;
+    'ExpressionSet.ApiName': string;
+    ReferenceObjectId: string;
+    ConstraintModelTag: string;
+    ConstraintModelTagType: 'Type' | 'Port';
+};
+export type ExpressionSetConstraintObjCustom = ExpressionSetConstraintObj & {
+    $Product2ReferenceId: string;
+    $ProductClassificationName: string;
+    $ProductRelatedComponentKey: string;
+};

package/lib/shared/types/sobject.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=sobject.js.map

package/lib/shared/types/sobject.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sobject.js","sourceRoot":"","sources":["../../../src/shared/types/sobject.ts"],"names":[],"mappings":""}

package/lib/shared/types/types.d.ts

@@ -0,0 +1,8 @@
+export * from './association.js';
+export * from './cml-attribute.js';
+export * from './cml-constraint.js';
+export * from './cml-domain.js';
+export * from './cml-model.js';
+export * from './cml-relation.js';
+export * from './cml-type.js';
+export * from './sobject.js';

package/lib/shared/types/types.js

@@ -0,0 +1,24 @@
+/*
+ * Copyright 2025, 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.
+ */
+export * from './association.js';
+export * from './cml-attribute.js';
+export * from './cml-constraint.js';
+export * from './cml-domain.js';
+export * from './cml-model.js';
+export * from './cml-relation.js';
+export * from './cml-type.js';
+export * from './sobject.js';
+//# sourceMappingURL=types.js.map

package/lib/shared/types/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/shared/types/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC"}

package/lib/shared/utils/association.utils.d.ts

@@ -0,0 +1,61 @@
+import { Association, CmlRelation, CmlType } from '../types/types.js';
+/**
+ * Filters associations to return only those that match the specified type
+ * and are not marked for deletion.
+ *
+ * @param {Array} associations - Array of association objects to filter.
+ * @param {Object} typeName - The type name to filter associations by.
+ * @returns {Array} Filtered array of associations for the specified type and not marked for deletion.
+ */
+export declare function getTypeAssociationsForType(associations: Association[], typeName: string): Association[];
+export declare function getTypeAssociationForTypeAndReferenceObjectId(associations: Association[], type: CmlType, referenceObjectId: string): Association | undefined;
+export declare function getRelationAssociationForRelationAndReferenceObjectId(associations: Association[], relation: CmlRelation, referenceObjectId: string): Association | undefined;
+export declare function getRelationAssociationsForType(associations: Association[], type: CmlType): Association[];
+export declare function getRelationAssociationsForRelation(associations: Association[], relation: CmlRelation): Association[];
+/**
+ * Retrieves the tag name of the type association for a given reference object ID.
+ *
+ * @param {Array} associations - Array of association objects to search within.
+ * @param {string} referenceObjectId - The reference object ID to match.
+ * @returns {string|undefined} The tag name of the type association if found, otherwise undefined.
+ */
+export declare function getTypeNameForRelatedObjectId(associations: Association[], referenceObjectId: string): string | undefined;
+/**
+ * Retrieves the tag name of the relation association for a given reference object ID.
+ *
+ * @param {Array} associations - Array of association objects to search within.
+ * @param {string} referenceObjectId - The reference object ID to match.
+ * @returns {string|undefined} The tag name of the relation association if found, otherwise undefined.
+ */
+export declare function getRelationNameForRelatedObjectId(associations: Association[], referenceObjectId: string): string | undefined;
+/**
+ * Filters associations to return only those marked for creation.
+ *
+ * @param {Array} associations - Array of association objects to filter.
+ * @returns {Array} Filtered array of associations marked for creation.
+ */
+export declare function getAssociationRecordsToCreate(associations: Association[]): Association[];
+/**
+ * Filters associations to return only those marked for update.
+ *
+ * @param {Array} associations - Array of association objects to filter.
+ * @returns {Array} Filtered array of associations marked for update.
+ */
+export declare function getAssociationRecordsToUpdate(associations: Association[]): Association[];
+/**
+ * Returns true if there is an existing association for the same tag and reference object ID
+ *
+ * @param {Array} associations - Array of association objects to filter.
+ * @param {string} tag - The tag of the association to match
+ * @param {string} referenceObjectId - The reference object ID of the association to match.
+ * @returns {Boolean} True or false depending on if the association exists
+ */
+export declare function isDuplicateAssociationRecord(associations: Association[], tag: string, referenceObjectId: string): boolean;
+/**
+ * Returns generated CSV using provided associations for provided CML model name
+ *
+ * @param {string} cmlName - The name of target CML model.
+ * @param {Array} associations - Array of association objects.
+ * @returns {String} Generated CSV content
+ */
+export declare function generateCsvForAssociations(cmlName: string, associations: Association[]): string;

package/lib/shared/utils/association.utils.js

@@ -0,0 +1,175 @@
+/*
+ * Copyright 2025, 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 { ASSOCIATION_TYPES } from '../constants/constants.js';
+/**
+ * Filters associations to return only those that match the specified type
+ * and are not marked for deletion.
+ *
+ * @param {Array} associations - Array of association objects to filter.
+ * @param {Object} typeName - The type name to filter associations by.
+ * @returns {Array} Filtered array of associations for the specified type and not marked for deletion.
+ */
+export function getTypeAssociationsForType(associations, typeName) {
+    const isTypeAssociation = (a) => a.type === ASSOCIATION_TYPES.TYPE;
+    const isForTypeName = (a) => a.tag === typeName;
+    return associations.filter(isTypeAssociation).filter(isForTypeName);
+}
+// /**
+//  * Retrieves type association that match a specified type and reference object ID.
+//  *
+//  * @param {Array} associations - Array of association objects to search within.
+//  * @param {Object} type - The type object to filter associations by.
+//  * @param {string} referenceObjectId - The reference object ID to match.
+//  * @returns {Object} - An association that:
+//  *                        is of the specified relation
+//  *                        have a matching reference object ID
+//  */
+export function getTypeAssociationForTypeAndReferenceObjectId(associations, type, referenceObjectId) {
+    const typeAssociations = getTypeAssociationsForType(associations, type.name);
+    const isForReferenceObjectId = (a) => a.referenceObjectId === referenceObjectId;
+    return typeAssociations.find(isForReferenceObjectId);
+}
+// /**
+//  * Retrieves relation associations that match a specified relation and reference object ID.
+//  *
+//  * @param {Array} associations - Array of association objects to search within.
+//  * @param {Object} relation - The relation object to filter associations by.
+//  * @param {string} referenceObjectId - The reference object ID to match.
+//  * @returns {Object} - An association that:
+//    *                      is of the specified relation
+//  *                        have a matching reference object ID
+//  */
+export function getRelationAssociationForRelationAndReferenceObjectId(associations, relation, referenceObjectId) {
+    const relationAssociations = getRelationAssociationsForRelation(associations, relation);
+    const isForReferenceObjectId = (a) => a.referenceObjectId === referenceObjectId;
+    return relationAssociations.find(isForReferenceObjectId);
+}
+// /**
+//  * Filters a list of associations to return only those that are of type `RELATION`,
+//  * are part of the specified type's relations, and are not marked for deletion.
+//  *
+//  * @param {Array} associations - Array of association objects to filter.
+//  * @param {Object} type - An object representing the type, which includes a `relations` property.
+//  * @param {Array<Object>} type.relations - Array of relation objects associated with the type.
+//  * @param {string} type.relations[].name - The name of each relation associated with the type.
+//  * @returns {Array} Filtered array of associations that match the criteria:
+//  *                  they are of type `RELATION`, their tag matches a relation in the specified type,
+//  *                  and they are not marked for deletion.
+//  */
+export function getRelationAssociationsForType(associations, type) {
+    const relations = new Set(type.relations.map((r) => r.name));
+    const prcIds = new Set(type.relations.flatMap((r) => r.prcIds));
+    const isRelationAssociation = (a) => a.type === ASSOCIATION_TYPES.RELATION;
+    const isRelationAssociationPartOfType = (a) => relations.has(a.tag) && prcIds.has(a.referenceObjectId);
+    const isNotMarkedForDelete = (a) => a && false; // !a.hasState(ASSOCIATION_STATES.MARKED_FOR_DELETION);
+    return associations
+        .filter(isRelationAssociation)
+        .filter(isRelationAssociationPartOfType)
+        .filter(isNotMarkedForDelete);
+}
+// /**
+//  * Retrieves active relation associations for a specified relation from a list of associations.
+//  *
+//  * @param {Array} associations - The list of associations to filter.
+//  * @param {Object} relation - The relation object to match against.
+//  * @param {string} relation.name - The name of the relation to filter associations by.
+//  * @returns {Array} - An array of associations that:
+//  *   - have the type `ASSOCIATION_TYPES.RELATION`
+//  *   - match the specified relation's name
+//  *   - are not marked for deletion
+//  */
+export function getRelationAssociationsForRelation(associations, relation) {
+    const isRelationAssociation = (a) => a.type === ASSOCIATION_TYPES.RELATION;
+    const isForRelationName = (a) => a.tag === relation.name && relation.prcIds?.includes(a.referenceObjectId);
+    const isNotMarkedForDelete = (a) => a && false; // !a.hasState(ASSOCIATION_STATES.MARKED_FOR_DELETION);
+    return associations.filter(isRelationAssociation).filter(isForRelationName).filter(isNotMarkedForDelete);
+}
+/**
+ * Retrieves the tag name of the type association for a given reference object ID.
+ *
+ * @param {Array} associations - Array of association objects to search within.
+ * @param {string} referenceObjectId - The reference object ID to match.
+ * @returns {string|undefined} The tag name of the type association if found, otherwise undefined.
+ */
+export function getTypeNameForRelatedObjectId(associations, referenceObjectId) {
+    const isTypeAssociation = (a) => a.type === ASSOCIATION_TYPES.TYPE;
+    const isRelatedObjectMatch = (a) => a.referenceObjectId === referenceObjectId;
+    const association = associations.filter(isTypeAssociation).find(isRelatedObjectMatch);
+    return association?.tag;
+}
+/**
+ * Retrieves the tag name of the relation association for a given reference object ID.
+ *
+ * @param {Array} associations - Array of association objects to search within.
+ * @param {string} referenceObjectId - The reference object ID to match.
+ * @returns {string|undefined} The tag name of the relation association if found, otherwise undefined.
+ */
+export function getRelationNameForRelatedObjectId(associations, referenceObjectId) {
+    const isRelationAssociation = (a) => a.type === ASSOCIATION_TYPES.RELATION;
+    const isRelatedObjectMatch = (a) => a.referenceObjectId === referenceObjectId;
+    const association = associations.filter(isRelationAssociation).find(isRelatedObjectMatch);
+    return association?.tag;
+}
+/**
+ * Filters associations to return only those marked for creation.
+ *
+ * @param {Array} associations - Array of association objects to filter.
+ * @returns {Array} Filtered array of associations marked for creation.
+ */
+export function getAssociationRecordsToCreate(associations) {
+    return associations;
+    // return associations.filter((a) => a.hasState(ASSOCIATION_STATES.DRAFT));
+}
+/**
+ * Filters associations to return only those marked for update.
+ *
+ * @param {Array} associations - Array of association objects to filter.
+ * @returns {Array} Filtered array of associations marked for update.
+ */
+export function getAssociationRecordsToUpdate(associations) {
+    return associations;
+    // return associations.filter((a) => a.hasState(ASSOCIATION_STATES.MARKED_FOR_UPDATE));
+}
+/**
+ * Returns true if there is an existing association for the same tag and reference object ID
+ *
+ * @param {Array} associations - Array of association objects to filter.
+ * @param {string} tag - The tag of the association to match
+ * @param {string} referenceObjectId - The reference object ID of the association to match.
+ * @returns {Boolean} True or false depending on if the association exists
+ */
+export function isDuplicateAssociationRecord(associations, tag, referenceObjectId) {
+    return associations.some((a) => a.tag === tag && a.referenceObjectId === referenceObjectId);
+}
+/**
+ * Returns generated CSV using provided associations for provided CML model name
+ *
+ * @param {string} cmlName - The name of target CML model.
+ * @param {Array} associations - Array of association objects.
+ * @returns {String} Generated CSV content
+ */
+export function generateCsvForAssociations(cmlName, associations) {
+    return ('ExpressionSet.ApiName,ConstraintModelTag,ConstraintModelTagType,ReferenceObjectId,$Product2ReferenceId,$ProductClassificationName,$ProductRelatedComponentKey\n' +
+        associations
+            .map((a) => {
+            const product2ReferenceId = a.referenceObjectType === 'Product2' ? a.referenceObjectReferenceValue : '';
+            const productClassificationName = a.referenceObjectType === 'ProductClassification' ? a.referenceObjectReferenceValue : '';
+            const productRelatedComponentKey = a.referenceObjectType === 'ProductRelatedComponent' ? a.referenceObjectReferenceValue : '';
+            return `${cmlName},${a.tag},${a.type},${a.referenceObjectId},${product2ReferenceId},${productClassificationName},${productRelatedComponentKey}`;
+        })
+            .join('\n'));
+}
+//# sourceMappingURL=association.utils.js.map

package/lib/shared/utils/association.utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"association.utils.js","sourceRoot":"","sources":["../../../src/shared/utils/association.utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAG9D;;;;;;;GAOG;AACH,MAAM,UAAU,0BAA0B,CAAC,YAA2B,EAAE,QAAgB;IACtF,MAAM,iBAAiB,GAAG,CAAC,CAAc,EAAW,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,iBAAiB,CAAC,IAAI,CAAC;IACzF,MAAM,aAAa,GAAG,CAAC,CAAc,EAAW,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,QAAQ,CAAC;IAEtE,OAAO,YAAY,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;AACtE,CAAC;AAED,MAAM;AACN,qFAAqF;AACrF,KAAK;AACL,kFAAkF;AAClF,uEAAuE;AACvE,2EAA2E;AAC3E,8CAA8C;AAC9C,yDAAyD;AACzD,gEAAgE;AAChE,MAAM;AACN,MAAM,UAAU,6CAA6C,CAC3D,YAA2B,EAC3B,IAAa,EACb,iBAAyB;IAEzB,MAAM,gBAAgB,GAAG,0BAA0B,CAAC,YAAY,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7E,MAAM,sBAAsB,GAAG,CAAC,CAAc,EAAW,EAAE,CAAC,CAAC,CAAC,iBAAiB,KAAK,iBAAiB,CAAC;IAEtG,OAAO,gBAAgB,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;AACvD,CAAC;AAED,MAAM;AACN,8FAA8F;AAC9F,KAAK;AACL,kFAAkF;AAClF,+EAA+E;AAC/E,2EAA2E;AAC3E,8CAA8C;AAC9C,yDAAyD;AACzD,gEAAgE;AAChE,MAAM;AACN,MAAM,UAAU,qDAAqD,CACnE,YAA2B,EAC3B,QAAqB,EACrB,iBAAyB;IAEzB,MAAM,oBAAoB,GAAG,kCAAkC,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;IACxF,MAAM,sBAAsB,GAAG,CAAC,CAAc,EAAW,EAAE,CAAC,CAAC,CAAC,iBAAiB,KAAK,iBAAiB,CAAC;IAEtG,OAAO,oBAAoB,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;AAC3D,CAAC;AAED,MAAM;AACN,sFAAsF;AACtF,kFAAkF;AAClF,KAAK;AACL,2EAA2E;AAC3E,oGAAoG;AACpG,iGAAiG;AACjG,iGAAiG;AACjG,8EAA8E;AAC9E,uGAAuG;AACvG,4DAA4D;AAC5D,MAAM;AACN,MAAM,UAAU,8BAA8B,CAAC,YAA2B,EAAE,IAAa;IACvF,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAC7D,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;IAEhE,MAAM,qBAAqB,GAAG,CAAC,CAAc,EAAW,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,iBAAiB,CAAC,QAAQ,CAAC;IACjG,MAAM,+BAA+B,GAAG,CAAC,CAAc,EAAW,EAAE,CAClE,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC;IAC1D,MAAM,oBAAoB,GAAG,CAAC,CAAc,EAAW,EAAE,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,uDAAuD;IAE7H,OAAO,YAAY;SAChB,MAAM,CAAC,qBAAqB,CAAC;SAC7B,MAAM,CAAC,+BAA+B,CAAC;SACvC,MAAM,CAAC,oBAAoB,CAAC,CAAC;AAClC,CAAC;AAED,MAAM;AACN,kGAAkG;AAClG,KAAK;AACL,uEAAuE;AACvE,sEAAsE;AACtE,yFAAyF;AACzF,uDAAuD;AACvD,oDAAoD;AACpD,6CAA6C;AAC7C,qCAAqC;AACrC,MAAM;AACN,MAAM,UAAU,kCAAkC,CAAC,YAA2B,EAAE,QAAqB;IACnG,MAAM,qBAAqB,GAAG,CAAC,CAAc,EAAW,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,iBAAiB,CAAC,QAAQ,CAAC;IACjG,MAAM,iBAAiB,GAAG,CAAC,CAAc,EAAW,EAAE,CACpD,CAAC,CAAC,GAAG,KAAK,QAAQ,CAAC,IAAI,IAAI,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC;IAC5E,MAAM,oBAAoB,GAAG,CAAC,CAAc,EAAW,EAAE,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,uDAAuD;IAE7H,OAAO,YAAY,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC;AAC3G,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,6BAA6B,CAC3C,YAA2B,EAC3B,iBAAyB;IAEzB,MAAM,iBAAiB,GAAG,CAAC,CAAc,EAAW,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,iBAAiB,CAAC,IAAI,CAAC;IACzF,MAAM,oBAAoB,GAAG,CAAC,CAAc,EAAW,EAAE,CAAC,CAAC,CAAC,iBAAiB,KAAK,iBAAiB,CAAC;IAEpG,MAAM,WAAW,GAAG,YAAY,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;IAEtF,OAAO,WAAW,EAAE,GAAG,CAAC;AAC1B,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,iCAAiC,CAC/C,YAA2B,EAC3B,iBAAyB;IAEzB,MAAM,qBAAqB,GAAG,CAAC,CAAc,EAAW,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,iBAAiB,CAAC,QAAQ,CAAC;IACjG,MAAM,oBAAoB,GAAG,CAAC,CAAc,EAAW,EAAE,CAAC,CAAC,CAAC,iBAAiB,KAAK,iBAAiB,CAAC;IAEpG,MAAM,WAAW,GAAG,YAAY,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;IAE1F,OAAO,WAAW,EAAE,GAAG,CAAC;AAC1B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,6BAA6B,CAAC,YAA2B;IACvE,OAAO,YAAY,CAAC;IACpB,2EAA2E;AAC7E,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,6BAA6B,CAAC,YAA2B;IACvE,OAAO,YAAY,CAAC;IACpB,uFAAuF;AACzF,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,4BAA4B,CAC1C,YAA2B,EAC3B,GAAW,EACX,iBAAyB;IAEzB,OAAO,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,IAAI,CAAC,CAAC,iBAAiB,KAAK,iBAAiB,CAAC,CAAC;AAC9F,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,0BAA0B,CAAC,OAAe,EAAE,YAA2B;IACrF,OAAO,CACL,iKAAiK;QACjK,YAAY;aACT,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YACT,MAAM,mBAAmB,GAAG,CAAC,CAAC,mBAAmB,KAAK,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,6BAA6B,CAAC,CAAC,CAAC,EAAE,CAAC;YACxG,MAAM,yBAAyB,GAC7B,CAAC,CAAC,mBAAmB,KAAK,uBAAuB,CAAC,CAAC,CAAC,CAAC,CAAC,6BAA6B,CAAC,CAAC,CAAC,EAAE,CAAC;YAC3F,MAAM,0BAA0B,GAC9B,CAAC,CAAC,mBAAmB,KAAK,yBAAyB,CAAC,CAAC,CAAC,CAAC,CAAC,6BAA6B,CAAC,CAAC,CAAC,EAAE,CAAC;YAC7F,OAAO,GAAG,OAAO,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,iBAAiB,IAAI,mBAAmB,IAAI,yBAAyB,IAAI,0BAA0B,EAAE,CAAC;QAClJ,CAAC,CAAC;aACD,IAAI,CAAC,IAAI,CAAC,CACd,CAAC;AACJ,CAAC"}