@memberjunction/core-entities 2.104.0 → 2.106.0

package/dist/custom/TemplateEntityExtended.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TemplateEntityExtended.d.ts","sourceRoot":"","sources":["../../src/custom/TemplateEntityExtended.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACpE,OAAO,EAAE,qBAAqB,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AAG5G,qBACa,sBAAuB,SAAQ,cAAc;IACtD,OAAO,CAAC,QAAQ,CAA+B;IAC/C,IAAW,OAAO,IAAI,qBAAqB,EAAE,CAE5C;IACD,IAAW,OAAO,CAAC,KAAK,EAAE,qBAAqB,EAAE,EAEhD;IAED,OAAO,CAAC,OAAO,CAA6B;IAC5C,IAAW,MAAM,IAAI,mBAAmB,EAAE,CAEzC;IACD,IAAW,MAAM,CAAC,KAAK,EAAE,mBAAmB,EAAE,EAE7C;IAED;;;;OAIG;IACI,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB,EAAE;IAI9D;;;;OAIG;IACI,yBAAyB,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,qBAAqB;IAUtE;;;;;;;;;;;;;;;OAeG;IACI,uBAAuB,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,mBAAmB,EAAE;IAazE;;;;;;;;;;;;;;;;;OAiBG;IACI,qBAAqB,CAAC,IAAI,EAAE,GAAG,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,gBAAgB;CA0BhF"}

package/dist/custom/TemplateEntityExtended.js

@@ -0,0 +1,126 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TemplateEntityExtended = void 0;
+const core_1 = require("@memberjunction/core");
+const entity_subclasses_1 = require("../generated/entity_subclasses");
+const global_1 = require("@memberjunction/global");
+let TemplateEntityExtended = class TemplateEntityExtended extends entity_subclasses_1.TemplateEntity {
+    constructor() {
+        super(...arguments);
+        this._Content = [];
+        this._Params = [];
+    }
+    get Content() {
+        return this._Content;
+    }
+    set Content(value) {
+        this._Content = value;
+    }
+    get Params() {
+        return this._Params;
+    }
+    set Params(value) {
+        this._Params = value;
+    }
+    /**
+     * Returns all content for a given type for the template
+     * @param type
+     * @returns
+     */
+    GetContentByType(type) {
+        return this.Content.filter(c => c.Type.trim().toLowerCase() === type.trim().toLowerCase());
+    }
+    /**
+     * Returns the highest priority content for the template
+     * @param type If provided, returns the highest priority content of the specified type
+     * @returns
+     */
+    GetHighestPriorityContent(type) {
+        if (type) {
+            return this.Content.filter(c => c.Type.trim().toLowerCase() === type.trim().toLowerCase())
+                .sort((a, b) => a.Priority - b.Priority)[0];
+        }
+        else {
+            return this.Content.sort((a, b) => a.Priority - b.Priority)[0];
+        }
+    }
+    /**
+     * Returns all parameters that apply to a specific template content.
+     * This includes both global parameters (where TemplateContentID is NULL)
+     * and content-specific parameters for the given contentId.
+     *
+     * @param contentId - The ID of the template content. If not provided, returns only global parameters.
+     * @returns Array of TemplateParamEntity objects that apply to the specified content
+     *
+     * @example
+     * // Get all parameters for a specific content
+     * const params = template.GetParametersForContent('content-uuid');
+     *
+     * @example
+     * // Get only global parameters (that apply to all contents)
+     * const globalParams = template.GetParametersForContent();
+     */
+    GetParametersForContent(contentId) {
+        if (!contentId) {
+            // Return only global parameters (TemplateContentID is null)
+            return this.Params.filter(p => !p.TemplateContentID);
+        }
+        // Return both global parameters and content-specific parameters
+        return this.Params.filter(p => !p.TemplateContentID || // Global param (applies to all contents)
+            p.TemplateContentID === contentId // Content-specific param
+        );
+    }
+    /**
+     * This method is different from the Validate() method which validates the state of the Template itself.
+     * This method validates the data object provided meets the requirements for the template's parameter definitions.
+     *
+     * @param data - the data object to validate against the template's parameter definitions
+     * @param contentId - Optional: The ID of the template content to validate against.
+     *                    If provided, validates against parameters specific to that content.
+     *                    If not provided, validates against all parameters.
+     * @returns ValidationResult with success status and any validation errors
+     *
+     * @example
+     * // Validate against all parameters
+     * const result = template.ValidateTemplateInput(inputData);
+     *
+     * @example
+     * // Validate against parameters for a specific content
+     * const result = template.ValidateTemplateInput(inputData, 'content-uuid');
+     */
+    ValidateTemplateInput(data, contentId) {
+        const result = new core_1.ValidationResult();
+        // Get the relevant parameters based on contentId
+        const paramsToValidate = contentId ?
+            this.GetParametersForContent(contentId) :
+            this.Params;
+        paramsToValidate.forEach((p) => {
+            if (p.IsRequired) {
+                if (!data ||
+                    data[p.Name] === undefined ||
+                    data[p.Name] === null ||
+                    (typeof data[p.Name] === 'string' && data[p.Name].toString().trim() === ''))
+                    result.Errors.push({
+                        Source: p.Name,
+                        Message: `Parameter ${p.Name} is required.`,
+                        Value: data[p.Name],
+                        Type: 'Failure'
+                    });
+            }
+        });
+        // now set result's top level success flag based on the existence of ANY failure record within the errors collection
+        result.Success = result.Errors.some(e => e.Type === 'Failure') ? false : true;
+        return result;
+    }
+};
+exports.TemplateEntityExtended = TemplateEntityExtended;
+exports.TemplateEntityExtended = TemplateEntityExtended = __decorate([
+    (0, global_1.RegisterClass)(core_1.BaseEntity, 'Templates')
+], TemplateEntityExtended);
+//# sourceMappingURL=TemplateEntityExtended.js.map

package/dist/custom/TemplateEntityExtended.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TemplateEntityExtended.js","sourceRoot":"","sources":["../../src/custom/TemplateEntityExtended.ts"],"names":[],"mappings":";;;;;;;;;AAAA,+CAAoE;AACpE,sEAA4G;AAC5G,mDAAuD;AAGhD,IAAM,sBAAsB,GAA5B,MAAM,sBAAuB,SAAQ,kCAAc;IAAnD;;QACK,aAAQ,GAA4B,EAAE,CAAC;QAQvC,YAAO,GAA0B,EAAE,CAAC;IAyGhD,CAAC;IAhHG,IAAW,OAAO;QACd,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;IACD,IAAW,OAAO,CAAC,KAA8B;QAC7C,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;IAC1B,CAAC;IAGD,IAAW,MAAM;QACb,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;IACD,IAAW,MAAM,CAAC,KAA4B;QAC1C,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACI,gBAAgB,CAAC,IAAY;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;OAIG;IACI,yBAAyB,CAAC,IAAa;QAC1C,IAAI,IAAI,EAAE,CAAC;YACP,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;iBACrF,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;QACpD,CAAC;aACI,CAAC;YACF,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;QACnE,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACI,uBAAuB,CAAC,SAAkB;QAC7C,IAAI,CAAC,SAAS,EAAE,CAAC;YACb,4DAA4D;YAC5D,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC;QACzD,CAAC;QAED,gEAAgE;QAChE,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAC1B,CAAC,CAAC,CAAC,iBAAiB,IAAI,yCAAyC;YACjE,CAAC,CAAC,iBAAiB,KAAK,SAAS,CAAC,yBAAyB;SAC9D,CAAC;IACN,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACI,qBAAqB,CAAC,IAAS,EAAE,SAAkB;QACtD,MAAM,MAAM,GAAG,IAAI,uBAAgB,EAAE,CAAC;QAEtC,iDAAiD;QACjD,MAAM,gBAAgB,GAAG,SAAS,CAAC,CAAC;YAChC,IAAI,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC,CAAC;YACzC,IAAI,CAAC,MAAM,CAAC;QAEhB,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YAC3B,IAAI,CAAC,CAAC,UAAU,EAAE,CAAC;gBACf,IAAI,CAAC,IAAI;oBACL,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,SAAS;oBAC1B,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,IAAI;oBACrB,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,QAAQ,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC;oBAC3E,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC;wBACf,MAAM,EAAE,CAAC,CAAC,IAAI;wBACd,OAAO,EAAE,aAAa,CAAC,CAAC,IAAI,eAAe;wBAC3C,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;wBACnB,IAAI,EAAE,SAAS;qBAClB,CAAC,CAAC;YACX,CAAC;QACL,CAAC,CAAC,CAAC;QACH,oHAAoH;QACpH,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;QAC9E,OAAO,MAAM,CAAC;IAClB,CAAC;CACJ,CAAA;AAlHY,wDAAsB;iCAAtB,sBAAsB;IADlC,IAAA,sBAAa,EAAC,iBAAU,EAAE,WAAW,CAAC;GAC1B,sBAAsB,CAkHlC"}

package/dist/engines/artifacts.d.ts

@@ -0,0 +1,19 @@
+import { BaseEngine, IMetadataProvider, UserInfo } from "@memberjunction/core";
+import { ArtifactTypeEntity } from "../generated/entity_subclasses";
+/**
+ * Caching of metadata for components and related data
+ */
+export declare class ArtifactMetadataEngine extends BaseEngine<ArtifactMetadataEngine> {
+    /**
+     * Returns the global instance of the class. This is a singleton class, so there is only one instance of it in the application. Do not directly create new instances of it, always use this method to get the instance.
+     */
+    static get Instance(): ArtifactMetadataEngine;
+    private _artifactTypes;
+    Config(forceRefresh?: boolean, contextUser?: UserInfo, provider?: IMetadataProvider): Promise<void>;
+    get ArtifactTypes(): ArtifactTypeEntity[];
+    /**
+     * Finds an artifact type on a case-insensitive match of name
+     */
+    FindArtifactType(name: string): ArtifactTypeEntity | undefined;
+}
+//# sourceMappingURL=artifacts.d.ts.map

package/dist/engines/artifacts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"artifacts.d.ts","sourceRoot":"","sources":["../../src/engines/artifacts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAA4B,iBAAiB,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AACzG,OAAO,EACH,kBAAkB,EACrB,MAAM,gCAAgC,CAAC;AAExC;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,UAAU,CAAC,sBAAsB,CAAC;IAC1E;;OAEG;IACH,WAAkB,QAAQ,IAAI,sBAAsB,CAEnD;IAED,OAAO,CAAC,cAAc,CAAuB;IAEhC,MAAM,CAAC,YAAY,CAAC,EAAE,OAAO,EAAE,WAAW,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,EAAE,iBAAiB;IAWhG,IAAW,aAAa,IAAI,kBAAkB,EAAE,CAE/C;IAED;;OAEG;IACI,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,kBAAkB,GAAG,SAAS;CAIxE"}

package/dist/engines/artifacts.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ArtifactMetadataEngine = void 0;
+const core_1 = require("@memberjunction/core");
+/**
+ * Caching of metadata for components and related data
+ */
+class ArtifactMetadataEngine extends core_1.BaseEngine {
+    /**
+     * Returns the global instance of the class. This is a singleton class, so there is only one instance of it in the application. Do not directly create new instances of it, always use this method to get the instance.
+     */
+    static get Instance() {
+        return super.getInstance();
+    }
+    async Config(forceRefresh, contextUser, provider) {
+        const c = [
+            {
+                Type: 'entity',
+                EntityName: 'MJ: Artifact Types',
+                PropertyName: "_artifactTypes"
+            }
+        ];
+        await this.Load(c, provider, forceRefresh, contextUser);
+    }
+    get ArtifactTypes() {
+        return this._artifactTypes;
+    }
+    /**
+     * Finds an artifact type on a case-insensitive match of name
+     */
+    FindArtifactType(name) {
+        const match = this._artifactTypes.find(c => c.Name.trim().toLowerCase() === name.trim().toLowerCase());
+        return match;
+    }
+}
+exports.ArtifactMetadataEngine = ArtifactMetadataEngine;
+//# sourceMappingURL=artifacts.js.map

package/dist/engines/artifacts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"artifacts.js","sourceRoot":"","sources":["../../src/engines/artifacts.ts"],"names":[],"mappings":";;;AAAA,+CAAyG;AAKzG;;GAEG;AACH,MAAa,sBAAuB,SAAQ,iBAAkC;IAC1E;;OAEG;IACI,MAAM,KAAK,QAAQ;QACvB,OAAO,KAAK,CAAC,WAAW,EAA0B,CAAC;IACtD,CAAC;IAIM,KAAK,CAAC,MAAM,CAAC,YAAsB,EAAE,WAAsB,EAAE,QAA4B;QAC5F,MAAM,CAAC,GAAwC;YAC3C;gBACI,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE,oBAAoB;gBAChC,YAAY,EAAE,gBAAgB;aACjC;SACJ,CAAA;QACD,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,QAAQ,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;IAC5D,CAAC;IAED,IAAW,aAAa;QACpB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC/B,CAAC;IAED;;OAEG;IACI,gBAAgB,CAAC,IAAY;QAChC,MAAM,KAAK,GAAI,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;QACxG,OAAO,KAAK,CAAC;IACjB,CAAC;CACJ;AAhCD,wDAgCC"}