@memberjunction/templates-base-types 1.5.3

package/dist/TemplateEntityExtended.d.ts

@@ -0,0 +1,28 @@
+import { ValidationResult } from "@memberjunction/core";
+import { TemplateContentEntity, TemplateEntity, TemplateParamEntity } from "@memberjunction/core-entities";
+export declare class TemplateEntityExtended extends TemplateEntity {
+    private _Content;
+    get Content(): TemplateContentEntity[];
+    set Content(value: TemplateContentEntity[]);
+    private _Params;
+    get Params(): TemplateParamEntity[];
+    set Params(value: TemplateParamEntity[]);
+    /**
+     * Returns all content for a given type for the template
+     * @param type
+     * @returns
+     */
+    GetContentByType(type: string): TemplateContentEntity[];
+    /**
+     * Returns the highest priority content for the template
+     * @param type If provided, returns the highest priority content of the specified type
+     * @returns
+     */
+    GetHighestPriorityContent(type?: string): TemplateContentEntity;
+    /**
+     * 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
+     */
+    ValidateTemplateInput(data: any): ValidationResult;
+}
+//# sourceMappingURL=TemplateEntityExtended.d.ts.map

package/dist/TemplateEntityExtended.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TemplateEntityExtended.d.ts","sourceRoot":"","sources":["../src/TemplateEntityExtended.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiC,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACvF,OAAO,EAAE,qBAAqB,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AAG3G,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;;;OAGG;IACI,qBAAqB,CAAC,IAAI,EAAE,GAAG,GAAG,gBAAgB;CAoB5D"}

package/dist/TemplateEntityExtended.js

@@ -0,0 +1,82 @@
+"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 core_entities_1 = require("@memberjunction/core-entities");
+const global_1 = require("@memberjunction/global");
+let TemplateEntityExtended = class TemplateEntityExtended extends core_entities_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];
+        }
+    }
+    /**
+     * 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
+     */
+    ValidateTemplateInput(data) {
+        const result = new core_1.ValidationResult();
+        this.Params.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 falg 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/TemplateEntityExtended.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TemplateEntityExtended.js","sourceRoot":"","sources":["../src/TemplateEntityExtended.ts"],"names":[],"mappings":";;;;;;;;;AAAA,+CAAuF;AACvF,iEAA2G;AAC3G,mDAAuD;AAGhD,IAAM,sBAAsB,GAA5B,MAAM,sBAAuB,SAAQ,8BAAc;IAAnD;;QACK,aAAQ,GAA4B,EAAE,CAAC;QAQvC,YAAO,GAA0B,EAAE,CAAC;IAwDhD,CAAC;IA/DG,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;;;OAGG;IACI,qBAAqB,CAAC,IAAS;QAClC,MAAM,MAAM,GAAG,IAAI,uBAAgB,EAAE,CAAC;QACtC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YACtB,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;AAjEY,wDAAsB;iCAAtB,sBAAsB;IADlC,IAAA,sBAAa,EAAC,iBAAU,EAAE,WAAW,CAAC;GAC1B,sBAAsB,CAiElC"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './TemplateEntityExtended';
+export * from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC;AACzC,cAAc,SAAS,CAAC"}

package/dist/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./TemplateEntityExtended"), exports);
+__exportStar(require("./types"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2DAAyC;AACzC,0CAAwB"}

package/dist/types.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Contains the results of a call to render a template
+ */
+export declare class TemplateRenderResult {
+    Success: boolean;
+    Output: string;
+    /**
+     * Optional, typically used only for Success=false
+     */
+    Message?: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,qBAAa,oBAAoB;IAC7B,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB"}

package/dist/types.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TemplateRenderResult = void 0;
+/**
+ * Contains the results of a call to render a template
+ */
+class TemplateRenderResult {
+}
+exports.TemplateRenderResult = TemplateRenderResult;
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,MAAa,oBAAoB;CAOhC;AAPD,oDAOC"}

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@memberjunction/templates-base-types",
+  "version": "1.5.3",
+  "description": "MemberJunction Templating Base Types for Client/Server Use",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "/dist"
+  ],
+  "scripts": {
+    "start": "ts-node-dev src/index.ts",
+    "build": "tsc",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "MemberJunction.com",
+  "license": "ISC",
+  "devDependencies": {
+    "typescript": "^5.4.5"
+  },
+  "dependencies": {
+    "@memberjunction/core": "1.5.3",
+    "@memberjunction/core-entities": "1.5.3",
+    "@memberjunction/global": "1.5.3"
+  }
+}