@memberjunction/entity-documents 0.0.0 → 6.2.0-edge.0

package/LICENSE

@@ -0,0 +1,183 @@
+Business Source License 1.1
+
+License text copyright (c) 2024 MariaDB plc, All Rights Reserved.
+"Business Source License" is a trademark of MariaDB plc.
+
+-----------------------------------------------------------------------------
+
+Parameters
+
+Licensor:             Blue Cypress, Inc.
+
+Licensed Work:        MemberJunction.
+                      The Licensed Work is (c) 2023-2026 Blue Cypress, Inc.
+
+Additional Use Grant: Subject to the terms of this License, Licensor grants
+                      you the following additional rights to make Production
+                      Use of the Licensed Work.
+
+                      1. Internal Use
+
+                      You may make production use of the Licensed Work for
+                      your own internal business or organizational operations.
+
+                      2. Nonprofit Use
+
+                      If you are a Nonprofit, you may make production use of
+                      the Licensed Work for the operations and activities of
+                      your Organizational Family.
+
+                      3. MemberJunction Certified Program Use
+
+                      If you are authorized by Licensor under the
+                      MemberJunction Certified Program to provide professional
+                      services using the Licensed Work, you may make
+                      production use of the Licensed Work in providing such
+                      professional services to a client, provided that:
+
+                      (a) the Licensed Work is deployed in, and the applicable
+                      production use occurs within, an environment owned,
+                      leased, licensed, subscribed to, or otherwise controlled
+                      by that client; and
+
+                      (b) the production use is for that client's own internal
+                      business or organizational operations or is otherwise
+                      independently permitted to that client under this
+                      Additional Use Grant.
+
+                      4. Definitions Applicable to the Additional Use Grant
+
+                      "Affiliate" means, with respect to a specified Person,
+                      any other Person that directly or indirectly Controls,
+                      is Controlled by, or is under common Control with such
+                      specified Person.
+
+                      "Control" (including the terms "Controls," "Controlled
+                      by," and "under common Control with") means the direct
+                      or indirect possession of the power to direct or cause
+                      the direction of the management and policies of a
+                      Person, whether through ownership of voting interests,
+                      by contract, or otherwise.
+
+                      "Organizational Family" means, with respect to a Person,
+                      (a) such Person and its Affiliates, and (b) any
+                      nonprofit organization, governmental entity, chapter,
+                      division, local affiliate, regional affiliate, state
+                      affiliate, national affiliate, or other entity that is
+                      formally affiliated with such Person through governing
+                      documents, a charter, bylaws, a membership agreement, or
+                      another written organizational instrument, and is
+                      recognized under such documents as part of the same
+                      organizational structure.
+
+                      "Nonprofit" means a Person recognized by the Internal
+                      Revenue Service as exempt from federal income taxation
+                      under Section 501(c)(3), 501(c)(4), 501(c)(5), or
+                      501(c)(6) of the Internal Revenue Code, or a foreign
+                      organization recognized under substantially equivalent
+                      laws.
+
+                      A Person claiming eligibility as a Nonprofit shall, upon
+                      Licensor's reasonable request, provide documentation
+                      reasonably sufficient to demonstrate that it qualifies
+                      as a Nonprofit. If such Person materially misrepresents,
+                      or is unable to demonstrate, its qualification as a
+                      Nonprofit, the rights granted to such Person under
+                      Section 2 of this Additional Use Grant shall terminate.
+
+                      "MemberJunction Certified Program" means Licensor's
+                      then-current program for certifying and authorizing a
+                      Person to provide professional services using the
+                      Licensed Work.
+
+                      "Person" means any individual, corporation, limited
+                      liability company, partnership, association, nonprofit
+                      organization, governmental entity, or other legal or
+                      organizational entity.
+
+Change Date:          Four (4) years from the date the Licensed Work is first
+                      made available.
+
+Change License:       MIT License.
+
+For information about alternative licensing arrangements for the Licensed
+Work, please contact Blue Cypress, Inc.
+
+-----------------------------------------------------------------------------
+
+Terms
+
+The Licensor hereby grants you the right to copy, modify, create derivative
+works, redistribute, and make non-production use of the Licensed Work. The
+Licensor may make an Additional Use Grant, above, permitting limited
+production use.
+
+Effective on the Change Date, or the fourth anniversary of the first publicly
+available distribution of a specific version of the Licensed Work under this
+License, whichever comes first, the Licensor hereby grants you rights under
+the terms of the Change License, and the rights granted in the paragraph
+above terminate.
+
+If your use of the Licensed Work does not comply with the requirements
+currently in effect as described in this License, you must purchase a
+commercial license from the Licensor, its affiliated entities, or authorized
+resellers, or you must refrain from using the Licensed Work.
+
+All copies of the original and modified Licensed Work, and derivative works
+of the Licensed Work, are subject to this License. This License applies
+separately for each version of the Licensed Work and the Change Date may vary
+for each version of the Licensed Work released by Licensor.
+
+You must conspicuously display this License on each original or modified copy
+of the Licensed Work. If you receive the Licensed Work in original or
+modified form from a third party, the terms and conditions set forth in this
+License apply to your use of that work.
+
+Any use of the Licensed Work in violation of this License will automatically
+terminate your rights under this License for the current and all other
+versions of the Licensed Work.
+
+This License does not grant you any right in any trademark or logo of
+Licensor or its affiliates (provided that you may use a trademark or logo of
+Licensor as expressly required by this License).
+
+TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
+AN "AS IS" BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
+EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
+TITLE.
+
+MariaDB hereby grants you permission to use this License's text to license
+your works, and to refer to it using the trademark "Business Source License",
+as long as you comply with the Covenants of Licensor below.
+
+-----------------------------------------------------------------------------
+
+Covenants of Licensor
+
+In consideration of the right to use this License's text and the "Business
+Source License" name and trademark, Licensor covenants to MariaDB, and to all
+other recipients of the licensed work to be provided by Licensor:
+
+1. To specify as the Change License the GPL Version 2.0 or any later version,
+   or a license that is compatible with GPL Version 2.0 or a later version,
+   where "compatible" means that software provided under the Change License
+   can be included in a program with software provided under GPL Version 2.0
+   or a later version. Licensor may specify additional Change Licenses without
+   limitation.
+
+2. To either: (a) specify an additional grant of rights to use that does not
+   impose any additional restriction on the right granted in this License, as
+   the Additional Use Grant; or (b) insert the text "None".
+
+3. To specify a Change Date.
+
+4. Not to modify this License in any other way.
+
+-----------------------------------------------------------------------------
+
+Notice
+
+The Business Source License (this document, or the "License") is not an Open
+Source license. However, the Licensed Work will eventually be made available
+under an Open Source License, as stated in this License.

package/dist/generic/EntityDocumentTemplateParser.d.ts

@@ -0,0 +1,32 @@
+import { UserInfo } from '@memberjunction/core';
+import { MJEntityDocumentEntity } from '@memberjunction/core-entities';
+import { EntityDocumentTemplateParserBase } from './EntityDocumentTemplateParserBase.js';
+/**
+ * First-level subclass of EntityDocumentTemplateParserBase used to parse entity document templates
+ * with variables, dotted context paths (__Parent), and functions such as Relationship().
+ */
+export declare class EntityDocumentTemplateParser extends EntityDocumentTemplateParserBase {
+    /** Convenience factory method to get an instance via ClassFactory, allowing registered subclass overrides */
+    static CreateInstance(): EntityDocumentTemplateParser;
+    /**
+     * Resolves related records for an entity and recursively renders a child Entity Document over each.
+     *
+     * @param entityID - ID of the parent entity
+     * @param entityRecord - Data of the parent entity record
+     * @param ContextUser - Current user info
+     * @param relationshipName - Name of the related entity / relationship
+     * @param maxRows - Maximum number of related rows to load
+     * @param entityDocumentName - Name of the child Entity Document to render over each related row
+     * @returns Concatenated rendered output for all related rows, or raw JSON data if no document specified
+     */
+    protected Relationship(entityID: string, entityRecord: Record<string, unknown>, ContextUser: UserInfo, relationshipName: string, maxRows: number, entityDocumentName: string): Promise<string>;
+    /**
+     * Resolves the template text from an Entity Document.
+     * Priority:
+     * 1. doc.TemplateText virtual property (MJEntityDocumentEntityExtended)
+     * 2. TemplateEngine cached contents for doc.TemplateID
+     * 3. RunView on MJ: Template Contents
+     */
+    resolveDocumentTemplateText(doc: MJEntityDocumentEntity, contextUser: UserInfo): Promise<string>;
+}
+//# sourceMappingURL=EntityDocumentTemplateParser.d.ts.map

package/dist/generic/EntityDocumentTemplateParser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EntityDocumentTemplateParser.d.ts","sourceRoot":"","sources":["../../src/generic/EntityDocumentTemplateParser.ts"],"names":[],"mappings":"AAAA,OAAO,EAA6D,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAE3G,OAAO,EAAE,sBAAsB,EAA2B,MAAM,+BAA+B,CAAC;AAEhG,OAAO,EAAE,gCAAgC,EAAE,MAAM,oCAAoC,CAAC;AAQtF;;;GAGG;AACH,qBAAa,4BAA6B,SAAQ,gCAAgC;IAChF,6GAA6G;WAC/F,cAAc,IAAI,4BAA4B;IAI5D;;;;;;;;;;OAUG;cACa,YAAY,CAC1B,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACrC,WAAW,EAAE,QAAQ,EACrB,gBAAgB,EAAE,MAAM,EACxB,OAAO,EAAE,MAAM,EACf,kBAAkB,EAAE,MAAM,GACzB,OAAO,CAAC,MAAM,CAAC;IAqElB;;;;;;OAMG;IACU,2BAA2B,CAAC,GAAG,EAAE,sBAAsB,EAAE,WAAW,EAAE,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC;CAwD9G"}

package/dist/generic/EntityDocumentTemplateParser.js

@@ -0,0 +1,141 @@
+import { CompositeKey, LogError, LogStatus, RunView } from '@memberjunction/core';
+import { EscapeSQLString, MJGlobal, UUIDsEqual } from '@memberjunction/global';
+import { TemplateEngineServer } from '@memberjunction/templates';
+import { EntityDocumentTemplateParserBase } from './EntityDocumentTemplateParserBase.js';
+import { EntityDocumentCache } from '../models/EntityDocumentCache.js';
+/**
+ * First-level subclass of EntityDocumentTemplateParserBase used to parse entity document templates
+ * with variables, dotted context paths (__Parent), and functions such as Relationship().
+ */
+export class EntityDocumentTemplateParser extends EntityDocumentTemplateParserBase {
+    /** Convenience factory method to get an instance via ClassFactory, allowing registered subclass overrides */
+    static CreateInstance() {
+        return MJGlobal.Instance.ClassFactory.CreateInstance(EntityDocumentTemplateParser);
+    }
+    /**
+     * Resolves related records for an entity and recursively renders a child Entity Document over each.
+     *
+     * @param entityID - ID of the parent entity
+     * @param entityRecord - Data of the parent entity record
+     * @param ContextUser - Current user info
+     * @param relationshipName - Name of the related entity / relationship
+     * @param maxRows - Maximum number of related rows to load
+     * @param entityDocumentName - Name of the child Entity Document to render over each related row
+     * @returns Concatenated rendered output for all related rows, or raw JSON data if no document specified
+     */
+    async Relationship(entityID, entityRecord, ContextUser, relationshipName, maxRows, entityDocumentName) {
+        // G6 Note: Relationship() loads related entities per parent row. Batch-optimizing
+        // related-record loading across multi-row batches is mapped in plans/feature-pipelines-build-plan.md (§3 D12, G6).
+        const md = this.ProviderToUse;
+        const entityInfo = md.Entities.find((e) => UUIDsEqual(e.ID, entityID));
+        if (!entityInfo) {
+            throw new Error(`Entity with ID ${entityID} not found.`);
+        }
+        const re = entityInfo.RelatedEntities.find((r) => r.RelatedEntity === relationshipName);
+        if (!re) {
+            throw new Error(`Relationship ${relationshipName} not found for entity ${entityInfo.Name}`);
+        }
+        const obj = await md.GetEntityObject(entityInfo.Name, ContextUser);
+        const compositeKey = new CompositeKey();
+        compositeKey.LoadFromEntityInfoAndRecord(entityInfo, entityRecord);
+        const loadResult = await obj.InnerLoad(compositeKey);
+        if (!loadResult) {
+            LogError(`Failed to load entity ${entityInfo.Name} with ID ${compositeKey.ToString()}`);
+            return '';
+        }
+        const reData = await obj.GetRelatedEntityDataExt(re, null, maxRows);
+        if (reData && reData.Data && reData.Data.length > 0) {
+            if (entityDocumentName && entityDocumentName.trim().length > 0) {
+                // Resolve child entity document from cache
+                const cache = EntityDocumentCache.Instance;
+                if (!cache.IsLoaded) {
+                    await cache.Refresh(false, ContextUser);
+                }
+                const doc = cache.GetDocumentByName(entityDocumentName);
+                if (doc) {
+                    // Resolve actual template text (C1 fix: never pass the template's name, pass the template's content text)
+                    const templateText = await this.resolveDocumentTemplateText(doc, ContextUser);
+                    const parser = EntityDocumentTemplateParser.CreateInstance();
+                    parser.ProviderOverride = this.ProviderToUse;
+                    const batchSize = 10;
+                    const results = [];
+                    for (let i = 0; i < reData.Data.length; i += batchSize) {
+                        const batchPromises = reData.Data.slice(i, i + batchSize).map((data) => {
+                            // D14: Child context gains __Parent pointing to the parent data context, chainable to arbitrary depth
+                            const childRecord = {
+                                ...data,
+                                __Parent: entityRecord,
+                            };
+                            return parser.Parse(templateText, re.RelatedEntityID, childRecord, ContextUser);
+                        });
+                        const batchResults = await Promise.all(batchPromises);
+                        results.push(...batchResults);
+                    }
+                    return results.map((r) => r + '\n\n').join('');
+                }
+                else {
+                    LogStatus(`Entity Document with name ${entityDocumentName} not found.`);
+                    return '';
+                }
+            }
+            else {
+                return JSON.stringify({ Relationship: relationshipName, Data: reData.Data });
+            }
+        }
+        else {
+            return '{ No Data for: ' + relationshipName + ' }';
+        }
+    }
+    /**
+     * Resolves the template text from an Entity Document.
+     * Priority:
+     * 1. doc.TemplateText virtual property (MJEntityDocumentEntityExtended)
+     * 2. TemplateEngine cached contents for doc.TemplateID
+     * 3. RunView on MJ: Template Contents
+     */
+    async resolveDocumentTemplateText(doc, contextUser) {
+        // 1. Virtual property on extended entity subclass if populated
+        const virtualDoc = doc;
+        if (virtualDoc.TemplateText && virtualDoc.TemplateText.trim().length > 0) {
+            return virtualDoc.TemplateText;
+        }
+        // 2. TemplateEngine cached template contents
+        if (doc.TemplateID) {
+            const cached = TemplateEngineServer.Instance.TemplateContents.filter((tc) => UUIDsEqual(tc.TemplateID, doc.TemplateID));
+            if (cached.length > 0) {
+                const sorted = cached.sort((a, b) => {
+                    const aP = a.Priority ?? 0;
+                    const bP = b.Priority ?? 0;
+                    return aP - bP;
+                });
+                if (sorted[0]?.TemplateText) {
+                    return sorted[0].TemplateText;
+                }
+            }
+            // Warm template cache if needed
+            await TemplateEngineServer.Instance.Config(false, contextUser);
+            const afterWarm = TemplateEngineServer.Instance.TemplateContents.filter((tc) => UUIDsEqual(tc.TemplateID, doc.TemplateID));
+            if (afterWarm.length > 0) {
+                if (afterWarm[0]?.TemplateText) {
+                    return afterWarm[0].TemplateText;
+                }
+            }
+            // 3. Fallback: RunView lookup for template content
+            const rv = new RunView();
+            const rvResult = await rv.RunView({
+                EntityName: 'MJ: Template Contents',
+                ExtraFilter: `TemplateID = '${EscapeSQLString(doc.TemplateID)}'`,
+                OrderBy: 'Priority ASC',
+                MaxRows: 1,
+                ResultType: 'entity_object',
+            }, contextUser);
+            if (rvResult.Success && rvResult.Results.length > 0 && rvResult.Results[0].TemplateText) {
+                return rvResult.Results[0].TemplateText;
+            }
+        }
+        // Fallback: if doc has a Template property that is string, return it as last resort
+        const fallbackTemplate = doc.Template;
+        return fallbackTemplate ?? '';
+    }
+}
+//# sourceMappingURL=EntityDocumentTemplateParser.js.map

package/dist/generic/EntityDocumentTemplateParser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EntityDocumentTemplateParser.js","sourceRoot":"","sources":["../../src/generic/EntityDocumentTemplateParser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAA2B,MAAM,sBAAsB,CAAC;AAC3G,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAiB,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAE9F,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,gCAAgC,EAAE,MAAM,oCAAoC,CAAC;AACtF,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AAOpE;;;GAGG;AACH,MAAM,OAAO,4BAA6B,SAAQ,gCAAgC;IAChF,6GAA6G;IACtG,MAAM,CAAC,cAAc;QAC1B,OAAO,QAAQ,CAAC,QAAQ,CAAC,YAAY,CAAC,cAAc,CAA+B,4BAA4B,CAAC,CAAC;IACnH,CAAC;IAED;;;;;;;;;;OAUG;IACO,KAAK,CAAC,YAAY,CAC1B,QAAgB,EAChB,YAAqC,EACrC,WAAqB,EACrB,gBAAwB,EACxB,OAAe,EACf,kBAA0B;QAE1B,kFAAkF;QAClF,mHAAmH;QACnH,MAAM,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC;QAE9B,MAAM,UAAU,GAAG,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC;QACvE,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,kBAAkB,QAAQ,aAAa,CAAC,CAAC;QAC3D,CAAC;QAED,MAAM,EAAE,GAAG,UAAU,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,KAAK,gBAAgB,CAAC,CAAC;QACxF,IAAI,CAAC,EAAE,EAAE,CAAC;YACR,MAAM,IAAI,KAAK,CAAC,gBAAgB,gBAAgB,yBAAyB,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC;QAC9F,CAAC;QAED,MAAM,GAAG,GAAG,MAAM,EAAE,CAAC,eAAe,CAAC,UAAU,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QACnE,MAAM,YAAY,GAAG,IAAI,YAAY,EAAE,CAAC;QACxC,YAAY,CAAC,2BAA2B,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;QACnE,MAAM,UAAU,GAAG,MAAM,GAAG,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;QACrD,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,QAAQ,CAAC,yBAAyB,UAAU,CAAC,IAAI,YAAY,YAAY,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;YACxF,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,uBAAuB,CAAC,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAEpE,IAAI,MAAM,IAAI,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpD,IAAI,kBAAkB,IAAI,kBAAkB,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC/D,2CAA2C;gBAC3C,MAAM,KAAK,GAAG,mBAAmB,CAAC,QAAQ,CAAC;gBAC3C,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;oBACpB,MAAM,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;gBAC1C,CAAC;gBACD,MAAM,GAAG,GAAG,KAAK,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,CAAC;gBACxD,IAAI,GAAG,EAAE,CAAC;oBACR,0GAA0G;oBAC1G,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,2BAA2B,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;oBAC9E,MAAM,MAAM,GAAG,4BAA4B,CAAC,cAAc,EAAE,CAAC;oBAC7D,MAAM,CAAC,gBAAgB,GAAG,IAAI,CAAC,aAAa,CAAC;oBAE7C,MAAM,SAAS,GAAG,EAAE,CAAC;oBACrB,MAAM,OAAO,GAAa,EAAE,CAAC;oBAE7B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,SAAS,EAAE,CAAC;wBACvD,MAAM,aAAa,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,IAA6B,EAAE,EAAE;4BAC9F,sGAAsG;4BACtG,MAAM,WAAW,GAA4B;gCAC3C,GAAG,IAAI;gCACP,QAAQ,EAAE,YAAY;6BACvB,CAAC;4BACF,OAAO,MAAM,CAAC,KAAK,CAAC,YAAY,EAAE,EAAE,CAAC,eAAe,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;wBAClF,CAAC,CAAC,CAAC;wBACH,MAAM,YAAY,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;wBACtD,OAAO,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,CAAC;oBAChC,CAAC;oBAED,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACjD,CAAC;qBAAM,CAAC;oBACN,SAAS,CAAC,6BAA6B,kBAAkB,aAAa,CAAC,CAAC;oBACxE,OAAO,EAAE,CAAC;gBACZ,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,OAAO,IAAI,CAAC,SAAS,CAAC,EAAE,YAAY,EAAE,gBAAgB,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;YAC/E,CAAC;QACH,CAAC;aAAM,CAAC;YACN,OAAO,iBAAiB,GAAG,gBAAgB,GAAG,IAAI,CAAC;QACrD,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,2BAA2B,CAAC,GAA2B,EAAE,WAAqB;QACzF,+DAA+D;QAC/D,MAAM,UAAU,GAAG,GAAiC,CAAC;QACrD,IAAI,UAAU,CAAC,YAAY,IAAI,UAAU,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzE,OAAO,UAAU,CAAC,YAAY,CAAC;QACjC,CAAC;QAED,6CAA6C;QAC7C,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC;YACnB,MAAM,MAAM,GAAG,oBAAoB,CAAC,QAAQ,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAC1E,UAAU,CAAC,EAAE,CAAC,UAAU,EAAE,GAAG,CAAC,UAAU,CAAC,CAC1C,CAAC;YACF,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACtB,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;oBAClC,MAAM,EAAE,GAAG,CAAC,CAAC,QAAQ,IAAI,CAAC,CAAC;oBAC3B,MAAM,EAAE,GAAG,CAAC,CAAC,QAAQ,IAAI,CAAC,CAAC;oBAC3B,OAAO,EAAE,GAAG,EAAE,CAAC;gBACjB,CAAC,CAAC,CAAC;gBACH,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC;oBAC5B,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC;gBAChC,CAAC;YACH,CAAC;YAED,gCAAgC;YAChC,MAAM,oBAAoB,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;YAC/D,MAAM,SAAS,GAAG,oBAAoB,CAAC,QAAQ,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAC7E,UAAU,CAAC,EAAE,CAAC,UAAU,EAAE,GAAG,CAAC,UAAU,CAAC,CAC1C,CAAC;YACF,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACzB,IAAI,SAAS,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC;oBAC/B,OAAO,SAAS,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC;gBACnC,CAAC;YACH,CAAC;YAED,mDAAmD;YACnD,MAAM,EAAE,GAAG,IAAI,OAAO,EAAE,CAAC;YACzB,MAAM,QAAQ,GAAG,MAAM,EAAE,CAAC,OAAO,CAC/B;gBACE,UAAU,EAAE,uBAAuB;gBACnC,WAAW,EAAE,iBAAiB,eAAe,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG;gBAChE,OAAO,EAAE,cAAc;gBACvB,OAAO,EAAE,CAAC;gBACV,UAAU,EAAE,eAAe;aAC5B,EACD,WAAW,CACZ,CAAC;YAEF,IAAI,QAAQ,CAAC,OAAO,IAAI,QAAQ,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,YAAY,EAAE,CAAC;gBACxF,OAAO,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC;YAC1C,CAAC;QACH,CAAC;QAED,oFAAoF;QACpF,MAAM,gBAAgB,GAAI,GAAkC,CAAC,QAAQ,CAAC;QACtE,OAAO,gBAAgB,IAAI,EAAE,CAAC;IAChC,CAAC;CACF"}

package/dist/generic/EntityDocumentTemplateParserBase.d.ts

@@ -0,0 +1,34 @@
+import { IMetadataProvider, UserInfo } from '@memberjunction/core';
+/**
+ * Abstract base class for entity document template parsing.
+ * Use EntityDocumentTemplateParser or a subclass thereof.
+ */
+export declare abstract class EntityDocumentTemplateParserBase {
+    static ClearCache(): void;
+    static CreateCacheKey(EntityID: string, EntityRecordPrimaryKey: string, Content: string): string;
+    protected static __cache: Record<string, string>;
+    protected static get _cache(): Record<string, string>;
+    /** Optional provider override; falls back to Metadata.Provider when not set. */
+    protected _provider?: IMetadataProvider;
+    /** Allows setting or reading an explicit provider override for testing or isolated execution */
+    get ProviderOverride(): IMetadataProvider | undefined;
+    set ProviderOverride(value: IMetadataProvider | undefined);
+    /** Returns the active provider — explicit override if set, otherwise the global default. */
+    protected get ProviderToUse(): IMetadataProvider;
+    /**
+     * Parses an entity document template and replaces values within ${} placeholders with actual values from the entity record.
+     * If template uses Nunjucks {{ }} syntax, it is pre-rendered with the MJ TemplateEngine first.
+     *
+     * @param Template - the document template to parse
+     * @param EntityID - the ID of the entity
+     * @param EntityRecord - the values for the entity record (may contain __Parent context)
+     * @param ContextUser - the current user
+     * @returns the evaluated value of the template incorporating fields, nested contexts, and function call(s)
+     */
+    Parse(Template: string, EntityID: string, EntityRecord: Record<string, unknown>, ContextUser: UserInfo): Promise<string>;
+    /**
+     * Evaluates a single placeholder argument: either a function call like Relationship(...) or a field/path reference like Name or __Parent.Title.
+     */
+    protected evalSingleArgument(argument: string, entityID: string, entityRecord: Record<string, unknown>, ContextUser: UserInfo): Promise<string>;
+}
+//# sourceMappingURL=EntityDocumentTemplateParserBase.d.ts.map

package/dist/generic/EntityDocumentTemplateParserBase.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EntityDocumentTemplateParserBase.d.ts","sourceRoot":"","sources":["../../src/generic/EntityDocumentTemplateParserBase.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,iBAAiB,EAAY,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAI3F;;;GAGG;AACH,8BAAsB,gCAAgC;WACtC,UAAU,IAAI,IAAI;WAIlB,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,sBAAsB,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM;IAIvG,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAM;IACtD,SAAS,CAAC,MAAM,KAAK,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAEpD;IAED,gFAAgF;IAChF,SAAS,CAAC,SAAS,CAAC,EAAE,iBAAiB,CAAC;IAExC,gGAAgG;IAChG,IAAW,gBAAgB,IAAI,iBAAiB,GAAG,SAAS,CAE3D;IACD,IAAW,gBAAgB,CAAC,KAAK,EAAE,iBAAiB,GAAG,SAAS,EAE/D;IAED,4FAA4F;IAC5F,SAAS,KAAK,aAAa,IAAI,iBAAiB,CAE/C;IAED;;;;;;;;;OASG;IACU,KAAK,CAChB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACrC,WAAW,EAAE,QAAQ,GACpB,OAAO,CAAC,MAAM,CAAC;IA2DlB;;OAEG;cACa,kBAAkB,CAChC,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACrC,WAAW,EAAE,QAAQ,GACpB,OAAO,CAAC,MAAM,CAAC;CA4CnB"}

package/dist/generic/EntityDocumentTemplateParserBase.js

@@ -0,0 +1,132 @@
+import { CompositeKey, Metadata } from '@memberjunction/core';
+import { UUIDsEqual } from '@memberjunction/global';
+import { TemplateEngineServer } from '@memberjunction/templates';
+/**
+ * Abstract base class for entity document template parsing.
+ * Use EntityDocumentTemplateParser or a subclass thereof.
+ */
+export class EntityDocumentTemplateParserBase {
+    static ClearCache() {
+        EntityDocumentTemplateParserBase.__cache = {};
+    }
+    static CreateCacheKey(EntityID, EntityRecordPrimaryKey, Content) {
+        return `${EntityID}___${EntityRecordPrimaryKey}___${Content}`;
+    }
+    static { this.__cache = {}; }
+    static get _cache() {
+        return EntityDocumentTemplateParserBase.__cache;
+    }
+    /** Allows setting or reading an explicit provider override for testing or isolated execution */
+    get ProviderOverride() {
+        return this._provider;
+    }
+    set ProviderOverride(value) {
+        this._provider = value;
+    }
+    /** Returns the active provider — explicit override if set, otherwise the global default. */
+    get ProviderToUse() {
+        return this._provider ?? Metadata.Provider;
+    }
+    /**
+     * Parses an entity document template and replaces values within ${} placeholders with actual values from the entity record.
+     * If template uses Nunjucks {{ }} syntax, it is pre-rendered with the MJ TemplateEngine first.
+     *
+     * @param Template - the document template to parse
+     * @param EntityID - the ID of the entity
+     * @param EntityRecord - the values for the entity record (may contain __Parent context)
+     * @param ContextUser - the current user
+     * @returns the evaluated value of the template incorporating fields, nested contexts, and function call(s)
+     */
+    async Parse(Template, EntityID, EntityRecord, ContextUser) {
+        if (!ContextUser) {
+            throw new Error('ContextUser is required to parse the template');
+        }
+        const md = this.ProviderToUse;
+        const entityInfo = md.Entities.find((e) => UUIDsEqual(e.ID, EntityID));
+        if (!entityInfo) {
+            throw new Error(`Entity with ID ${EntityID} not found.`);
+        }
+        // Pass 1: If template uses Nunjucks {{ }} syntax, pre-render with the MJ TemplateEngine first.
+        // This handles conditionals ({% if __Parent %}), filters, and expressions.
+        let processedTemplate = Template;
+        if (Template.includes('{{') || Template.includes('{%')) {
+            await TemplateEngineServer.Instance.Config(false, ContextUser);
+            const renderResult = await TemplateEngineServer.Instance.RenderTemplateSimple(Template, EntityRecord);
+            if (renderResult.Success && renderResult.Output) {
+                processedTemplate = renderResult.Output;
+            }
+        }
+        const compositeKey = new CompositeKey();
+        compositeKey.LoadFromEntityInfoAndRecord(entityInfo, EntityRecord);
+        const regex = /\$\{([^{}]+)\}/g;
+        const matches = processedTemplate.matchAll(regex);
+        // Pass 2: Replace ${} placeholders (variables, dotted paths like __Parent.Field, and function calls)
+        const replacements = Array.from(matches).map(async (match) => {
+            const content = match[1]; // The captured group from regex
+            const cacheKey = EntityDocumentTemplateParserBase.CreateCacheKey(EntityID, compositeKey.ToString(), content);
+            if (!EntityDocumentTemplateParserBase._cache[cacheKey]) {
+                EntityDocumentTemplateParserBase._cache[cacheKey] = await this.evalSingleArgument(content, EntityID, EntityRecord, ContextUser);
+            }
+            return {
+                old: match[0],
+                new: EntityDocumentTemplateParserBase._cache[cacheKey],
+            };
+        });
+        const resolvedReplacements = await Promise.all(replacements);
+        let resolvedTemplate = processedTemplate;
+        resolvedReplacements.forEach((replacement) => {
+            // Function replacement: the resolved value is field data, so $&/$`/$$ in it must be text rather than splice directives (#3171).
+            resolvedTemplate = resolvedTemplate.replace(replacement.old, () => replacement.new);
+        });
+        return resolvedTemplate;
+    }
+    /**
+     * Evaluates a single placeholder argument: either a function call like Relationship(...) or a field/path reference like Name or __Parent.Title.
+     */
+    async evalSingleArgument(argument, entityID, entityRecord, ContextUser) {
+        const funcMatch = argument.match(/^\s*(\w+)\(([^)]*)\)\s*$/);
+        if (funcMatch) {
+            const [, funcName, paramsString] = funcMatch;
+            const params = paramsString.split(',').map((param) => {
+                param = param.trim();
+                if ((param.startsWith('"') && param.endsWith('"')) || (param.startsWith("'") && param.endsWith("'"))) {
+                    return param.slice(1, -1);
+                }
+                return param;
+            });
+            const method = this[funcName];
+            if (typeof method === 'function') {
+                const result = await method.apply(this, [
+                    entityID,
+                    entityRecord,
+                    ContextUser,
+                    ...params,
+                ]);
+                return result ?? '';
+            }
+            else {
+                throw new Error(`Function ${funcName} is not defined.`);
+            }
+        }
+        else {
+            // Field or property path resolution (supports dotted paths e.g. __Parent.Field, __Parent.__Parent.Field)
+            if (argument.includes('.')) {
+                let current = entityRecord;
+                const parts = argument.split('.');
+                for (const part of parts) {
+                    if (current !== null && typeof current === 'object' && part in current) {
+                        current = current[part];
+                    }
+                    else {
+                        current = undefined;
+                        break;
+                    }
+                }
+                return current !== undefined && current !== null ? String(current) : '';
+            }
+            const val = entityRecord[argument];
+            return val !== undefined && val !== null ? String(val) : '';
+        }
+    }
+}
+//# sourceMappingURL=EntityDocumentTemplateParserBase.js.map

package/dist/generic/EntityDocumentTemplateParserBase.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EntityDocumentTemplateParserBase.js","sourceRoot":"","sources":["../../src/generic/EntityDocumentTemplateParserBase.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAqB,QAAQ,EAAY,MAAM,sBAAsB,CAAC;AAC3F,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAEjE;;;GAGG;AACH,MAAM,OAAgB,gCAAgC;IAC7C,MAAM,CAAC,UAAU;QACtB,gCAAgC,CAAC,OAAO,GAAG,EAAE,CAAC;IAChD,CAAC;IAEM,MAAM,CAAC,cAAc,CAAC,QAAgB,EAAE,sBAA8B,EAAE,OAAe;QAC5F,OAAO,GAAG,QAAQ,MAAM,sBAAsB,MAAM,OAAO,EAAE,CAAC;IAChE,CAAC;aAEgB,YAAO,GAA2B,EAAE,CAAC;IAC5C,MAAM,KAAK,MAAM;QACzB,OAAO,gCAAgC,CAAC,OAAO,CAAC;IAClD,CAAC;IAKD,gGAAgG;IAChG,IAAW,gBAAgB;QACzB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IACD,IAAW,gBAAgB,CAAC,KAAoC;QAC9D,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;IACzB,CAAC;IAED,4FAA4F;IAC5F,IAAc,aAAa;QACzB,OAAO,IAAI,CAAC,SAAS,IAAI,QAAQ,CAAC,QAAQ,CAAC;IAC7C,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,KAAK,CAChB,QAAgB,EAChB,QAAgB,EAChB,YAAqC,EACrC,WAAqB;QAErB,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;QACnE,CAAC;QAED,MAAM,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC;QAC9B,MAAM,UAAU,GAAG,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC;QACvE,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,kBAAkB,QAAQ,aAAa,CAAC,CAAC;QAC3D,CAAC;QAED,+FAA+F;QAC/F,2EAA2E;QAC3E,IAAI,iBAAiB,GAAG,QAAQ,CAAC;QACjC,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACvD,MAAM,oBAAoB,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;YAC/D,MAAM,YAAY,GAAG,MAAM,oBAAoB,CAAC,QAAQ,CAAC,oBAAoB,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;YACtG,IAAI,YAAY,CAAC,OAAO,IAAI,YAAY,CAAC,MAAM,EAAE,CAAC;gBAChD,iBAAiB,GAAG,YAAY,CAAC,MAAM,CAAC;YAC1C,CAAC;QACH,CAAC;QAED,MAAM,YAAY,GAAG,IAAI,YAAY,EAAE,CAAC;QACxC,YAAY,CAAC,2BAA2B,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;QAEnE,MAAM,KAAK,GAAG,iBAAiB,CAAC;QAChC,MAAM,OAAO,GAAG,iBAAiB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAElD,qGAAqG;QACrG,MAAM,YAAY,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YAC3D,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,gCAAgC;YAC1D,MAAM,QAAQ,GAAG,gCAAgC,CAAC,cAAc,CAAC,QAAQ,EAAE,YAAY,CAAC,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;YAE7G,IAAI,CAAC,gCAAgC,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACvD,gCAAgC,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAC/E,OAAO,EACP,QAAQ,EACR,YAAY,EACZ,WAAW,CACZ,CAAC;YACJ,CAAC;YAED,OAAO;gBACL,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;gBACb,GAAG,EAAE,gCAAgC,CAAC,MAAM,CAAC,QAAQ,CAAC;aACvD,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,MAAM,oBAAoB,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QAE7D,IAAI,gBAAgB,GAAG,iBAAiB,CAAC;QACzC,oBAAoB,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;YAC3C,gIAAgI;YAChI,gBAAgB,GAAG,gBAAgB,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QACtF,CAAC,CAAC,CAAC;QAEH,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,kBAAkB,CAChC,QAAgB,EAChB,QAAgB,EAChB,YAAqC,EACrC,WAAqB;QAErB,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAC7D,IAAI,SAAS,EAAE,CAAC;YACd,MAAM,CAAC,EAAE,QAAQ,EAAE,YAAY,CAAC,GAAG,SAAS,CAAC;YAC7C,MAAM,MAAM,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;gBACnD,KAAK,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;gBACrB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;oBACrG,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;gBAC5B,CAAC;gBACD,OAAO,KAAK,CAAC;YACf,CAAC,CAAC,CAAC;YAEH,MAAM,MAAM,GAAI,IAAgC,CAAC,QAAQ,CAAC,CAAC;YAC3D,IAAI,OAAO,MAAM,KAAK,UAAU,EAAE,CAAC;gBACjC,MAAM,MAAM,GAAG,MAAO,MAA2D,CAAC,KAAK,CAAC,IAAI,EAAE;oBAC5F,QAAQ;oBACR,YAAY;oBACZ,WAAW;oBACX,GAAG,MAAM;iBACV,CAAC,CAAC;gBACH,OAAO,MAAM,IAAI,EAAE,CAAC;YACtB,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CAAC,YAAY,QAAQ,kBAAkB,CAAC,CAAC;YAC1D,CAAC;QACH,CAAC;aAAM,CAAC;YACN,yGAAyG;YACzG,IAAI,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC3B,IAAI,OAAO,GAAY,YAAY,CAAC;gBACpC,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAClC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;oBACzB,IAAI,OAAO,KAAK,IAAI,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,IAAI,IAAK,OAAmC,EAAE,CAAC;wBACpG,OAAO,GAAI,OAAmC,CAAC,IAAI,CAAC,CAAC;oBACvD,CAAC;yBAAM,CAAC;wBACN,OAAO,GAAG,SAAS,CAAC;wBACpB,MAAM;oBACR,CAAC;gBACH,CAAC;gBACD,OAAO,OAAO,KAAK,SAAS,IAAI,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC1E,CAAC;YAED,MAAM,GAAG,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;YACnC,OAAO,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9D,CAAC;IACH,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from './generic/EntityDocumentTemplateParserBase.js';
+export * from './generic/EntityDocumentTemplateParser.js';
+export * from './models/EntityDocumentCache.js';
+//# 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,4CAA4C,CAAC;AAC3D,cAAc,wCAAwC,CAAC;AACvD,cAAc,8BAA8B,CAAC"}

package/dist/index.js

@@ -0,0 +1,4 @@
+export * from './generic/EntityDocumentTemplateParserBase.js';
+export * from './generic/EntityDocumentTemplateParser.js';
+export * from './models/EntityDocumentCache.js';
+//# 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,cAAc,4CAA4C,CAAC;AAC3D,cAAc,wCAAwC,CAAC;AACvD,cAAc,8BAA8B,CAAC"}

package/dist/models/EntityDocumentCache.d.ts

@@ -0,0 +1,31 @@
+import { UserInfo } from "@memberjunction/core";
+import { BaseSingleton } from "@memberjunction/global";
+import { MJEntityDocumentEntity, MJEntityDocumentTypeEntity } from "@memberjunction/core-entities";
+/**
+ * Caching class for Entity Documents and Entity Document Types.
+ *
+ * Delegates Entity Document storage to KnowledgeHubMetadataEngine (which uses
+ * BaseEngine auto-refresh on entity events), and only independently caches
+ * Entity Document Types (which KH engine does not manage).
+ */
+export declare class EntityDocumentCache extends BaseSingleton<EntityDocumentCache> {
+    private _loaded;
+    private _typeCache;
+    private _contextUser;
+    constructor();
+    static get Instance(): EntityDocumentCache;
+    get IsLoaded(): boolean;
+    GetDocument(EntityDocumentID: string): MJEntityDocumentEntity | null;
+    GetFirstActiveDocumentForEntityByID(EntityID: string): MJEntityDocumentEntity | null;
+    GetFirstActiveDocumentForEntityByName(EntityName: string): MJEntityDocumentEntity | null;
+    GetDocumentByName(EntityDocumentName: string): MJEntityDocumentEntity | null;
+    GetDocumentType(EntityDocumentTypeID: string): MJEntityDocumentTypeEntity | null;
+    GetDocumentTypeByName(EntityDocumentTypeName: string): MJEntityDocumentTypeEntity | null;
+    SetCurrentUser(user: UserInfo): void;
+    /**
+     * Refreshes the cache. Entity Documents are loaded via KnowledgeHubMetadataEngine
+     * (auto-refreshing BaseEngine). Entity Document Types are loaded independently.
+     */
+    Refresh(forceRefresh: boolean, ContextUser?: UserInfo): Promise<void>;
+}
+//# sourceMappingURL=EntityDocumentCache.d.ts.map

package/dist/models/EntityDocumentCache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EntityDocumentCache.d.ts","sourceRoot":"","sources":["../../src/models/EntityDocumentCache.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAqC,MAAM,sBAAsB,CAAC;AACnF,OAAO,EAAc,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,EAAE,sBAAsB,EAAE,0BAA0B,EAA8B,MAAM,+BAA+B,CAAC;AAE/H;;;;;;GAMG;AACH,qBAAa,mBAAoB,SAAQ,aAAa,CAAC,mBAAmB,CAAC;IACvE,OAAO,CAAC,OAAO,CAAkB;IACjC,OAAO,CAAC,UAAU,CAAqD;IACvE,OAAO,CAAC,YAAY,CAAyB;;IAM7C,WAAkB,QAAQ,IAAI,mBAAmB,CAEhD;IAED,IAAW,QAAQ,IAAI,OAAO,CAE7B;IAEM,WAAW,CAAC,gBAAgB,EAAE,MAAM,GAAG,sBAAsB,GAAG,IAAI;IAQpE,mCAAmC,CAAC,QAAQ,EAAE,MAAM,GAAG,sBAAsB,GAAG,IAAI;IAWpF,qCAAqC,CAAC,UAAU,EAAE,MAAM,GAAG,sBAAsB,GAAG,IAAI;IAWxF,iBAAiB,CAAC,kBAAkB,EAAE,MAAM,GAAG,sBAAsB,GAAG,IAAI;IAa5E,eAAe,CAAC,oBAAoB,EAAE,MAAM,GAAG,0BAA0B,GAAG,IAAI;IAUhF,qBAAqB,CAAC,sBAAsB,EAAE,MAAM,GAAG,0BAA0B,GAAG,IAAI;IAcxF,cAAc,CAAC,IAAI,EAAE,QAAQ;IAIpC;;;OAGG;IACU,OAAO,CAAC,YAAY,EAAE,OAAO,EAAE,WAAW,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;CA4BrF"}

package/dist/models/EntityDocumentCache.js

@@ -0,0 +1,100 @@
+import { RunView, LogStatus } from "@memberjunction/core";
+import { UUIDsEqual, BaseSingleton } from "@memberjunction/global";
+import { KnowledgeHubMetadataEngine } from "@memberjunction/core-entities";
+/**
+ * Caching class for Entity Documents and Entity Document Types.
+ *
+ * Delegates Entity Document storage to KnowledgeHubMetadataEngine (which uses
+ * BaseEngine auto-refresh on entity events), and only independently caches
+ * Entity Document Types (which KH engine does not manage).
+ */
+export class EntityDocumentCache extends BaseSingleton {
+    constructor() {
+        super();
+        this._loaded = false;
+        this._typeCache = {};
+        this._contextUser = null;
+    }
+    static get Instance() {
+        return super.getInstance();
+    }
+    get IsLoaded() {
+        return this._loaded;
+    }
+    GetDocument(EntityDocumentID) {
+        const document = KnowledgeHubMetadataEngine.Instance.GetEntityDocumentByID(EntityDocumentID);
+        if (!document) {
+            LogStatus(`EntityDocumentCache.GetDocument: Cache miss for EntityDocumentID: ${EntityDocumentID}`);
+        }
+        return document ?? null;
+    }
+    GetFirstActiveDocumentForEntityByID(EntityID) {
+        const documentType = this.GetDocumentTypeByName('Record Duplicate');
+        if (!documentType) {
+            return null;
+        }
+        return KnowledgeHubMetadataEngine.Instance.EntityDocuments.find((ed) => UUIDsEqual(ed.EntityID, EntityID) && ed.Status === 'Active' && UUIDsEqual(ed.TypeID, documentType.ID)) ?? null;
+    }
+    GetFirstActiveDocumentForEntityByName(EntityName) {
+        const documentType = this.GetDocumentTypeByName('Record Duplicate');
+        if (!documentType) {
+            return null;
+        }
+        return KnowledgeHubMetadataEngine.Instance.EntityDocuments.find((ed) => ed.Entity === EntityName && ed.Status === 'Active' && UUIDsEqual(ed.TypeID, documentType.ID)) ?? null;
+    }
+    GetDocumentByName(EntityDocumentName) {
+        const toLower = EntityDocumentName.trim().toLowerCase();
+        const document = KnowledgeHubMetadataEngine.Instance.EntityDocuments.find((ed) => ed.Name.trim().toLowerCase() === toLower);
+        if (!document) {
+            LogStatus(`EntityDocumentCache.GetDocumentByName: Cache miss for EntityDocumentName: ${EntityDocumentName}`);
+        }
+        return document ?? null;
+    }
+    GetDocumentType(EntityDocumentTypeID) {
+        const documentType = this._typeCache[EntityDocumentTypeID];
+        if (!documentType) {
+            LogStatus(`EntityDocumentCache.GetDocumentType: Cache miss for EntityDocumentTypeID: ${EntityDocumentTypeID}`);
+            return null;
+        }
+        return documentType;
+    }
+    GetDocumentTypeByName(EntityDocumentTypeName) {
+        const toLower = EntityDocumentTypeName.trim().toLowerCase();
+        const documentType = Object.values(this._typeCache).find((edt) => edt.Name.trim().toLowerCase() === toLower);
+        if (!documentType) {
+            LogStatus(`EntityDocumentCache.GetDocumentTypeByName: Cache miss for EntityDocumentTypeName: ${EntityDocumentTypeName}`);
+            return null;
+        }
+        return documentType;
+    }
+    SetCurrentUser(user) {
+        this._contextUser = user;
+    }
+    /**
+     * Refreshes the cache. Entity Documents are loaded via KnowledgeHubMetadataEngine
+     * (auto-refreshing BaseEngine). Entity Document Types are loaded independently.
+     */
+    async Refresh(forceRefresh, ContextUser) {
+        if (!forceRefresh && this._loaded) {
+            return;
+        }
+        LogStatus('Refreshing Entity Document Cache');
+        this._typeCache = {};
+        const user = ContextUser || this._contextUser;
+        // Delegate Entity Documents to KnowledgeHubMetadataEngine
+        await KnowledgeHubMetadataEngine.Instance.Config(forceRefresh, user);
+        // Load Entity Document Types independently (KH engine doesn't cache these)
+        const rv = new RunView();
+        const result = await rv.RunView({
+            EntityName: "MJ: Entity Document Types",
+            ResultType: "entity_object"
+        }, user);
+        if (result && result.Success) {
+            for (const entityDocumentType of result.Results) {
+                this._typeCache[entityDocumentType.ID] = entityDocumentType;
+            }
+        }
+        this._loaded = true;
+    }
+}
+//# sourceMappingURL=EntityDocumentCache.js.map

package/dist/models/EntityDocumentCache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EntityDocumentCache.js","sourceRoot":"","sources":["../../src/models/EntityDocumentCache.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,OAAO,EAAE,SAAS,EAAiB,MAAM,sBAAsB,CAAC;AACnF,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,EAAsD,0BAA0B,EAAE,MAAM,+BAA+B,CAAC;AAE/H;;;;;;GAMG;AACH,MAAM,OAAO,mBAAoB,SAAQ,aAAkC;IAKvE;QACI,KAAK,EAAE,CAAC;QALJ,YAAO,GAAY,KAAK,CAAC;QACzB,eAAU,GAAkD,EAAE,CAAC;QAC/D,iBAAY,GAAoB,IAAI,CAAC;IAI7C,CAAC;IAEM,MAAM,KAAK,QAAQ;QACtB,OAAO,KAAK,CAAC,WAAW,EAAuB,CAAC;IACpD,CAAC;IAED,IAAW,QAAQ;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;IAEM,WAAW,CAAC,gBAAwB;QACvC,MAAM,QAAQ,GAAG,0BAA0B,CAAC,QAAQ,CAAC,qBAAqB,CAAC,gBAAgB,CAAC,CAAC;QAC7F,IAAI,CAAC,QAAQ,EAAE,CAAC;YACZ,SAAS,CAAC,qEAAqE,gBAAgB,EAAE,CAAC,CAAC;QACvG,CAAC;QACD,OAAO,QAAQ,IAAI,IAAI,CAAC;IAC5B,CAAC;IAEM,mCAAmC,CAAC,QAAgB;QACvD,MAAM,YAAY,GAAsC,IAAI,CAAC,qBAAqB,CAAC,kBAAkB,CAAC,CAAC;QACvG,IAAI,CAAC,YAAY,EAAE,CAAC;YAChB,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,OAAO,0BAA0B,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,EAA0B,EAAE,EAAE,CAC3F,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,QAAQ,IAAI,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,YAAY,CAAC,EAAE,CAAC,CACxG,IAAI,IAAI,CAAC;IACd,CAAC;IAEM,qCAAqC,CAAC,UAAkB;QAC3D,MAAM,YAAY,GAAsC,IAAI,CAAC,qBAAqB,CAAC,kBAAkB,CAAC,CAAC;QACvG,IAAI,CAAC,YAAY,EAAE,CAAC;YAChB,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,OAAO,0BAA0B,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,EAA0B,EAAE,EAAE,CAC3F,EAAE,CAAC,MAAM,KAAK,UAAU,IAAI,EAAE,CAAC,MAAM,KAAK,QAAQ,IAAI,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,YAAY,CAAC,EAAE,CAAC,CAC/F,IAAI,IAAI,CAAC;IACd,CAAC;IAEM,iBAAiB,CAAC,kBAA0B;QAC/C,MAAM,OAAO,GAAG,kBAAkB,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QACxD,MAAM,QAAQ,GAAG,0BAA0B,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,EAA0B,EAAE,EAAE,CACrG,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,KAAK,OAAO,CAC3C,CAAC;QAEF,IAAI,CAAC,QAAQ,EAAE,CAAC;YACZ,SAAS,CAAC,6EAA6E,kBAAkB,EAAE,CAAC,CAAC;QACjH,CAAC;QAED,OAAO,QAAQ,IAAI,IAAI,CAAC;IAC5B,CAAC;IAEM,eAAe,CAAC,oBAA4B;QAC/C,MAAM,YAAY,GAA+B,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC;QACvF,IAAI,CAAC,YAAY,EAAE,CAAC;YAChB,SAAS,CAAC,6EAA6E,oBAAoB,EAAE,CAAC,CAAC;YAC/G,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,OAAO,YAAY,CAAC;IACxB,CAAC;IAEM,qBAAqB,CAAC,sBAA8B;QACvD,MAAM,OAAO,GAAG,sBAAsB,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QAC5D,MAAM,YAAY,GAA2C,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,IAAI,CAC5F,CAAC,GAA+B,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,KAAK,OAAO,CACjF,CAAC;QAEF,IAAI,CAAC,YAAY,EAAE,CAAC;YAChB,SAAS,CAAC,qFAAqF,sBAAsB,EAAE,CAAC,CAAC;YACzH,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,OAAO,YAAY,CAAC;IACxB,CAAC;IAEM,cAAc,CAAC,IAAc;QAChC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,OAAO,CAAC,YAAqB,EAAE,WAAsB;QAC9D,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAChC,OAAO;QACX,CAAC;QAED,SAAS,CAAC,kCAAkC,CAAC,CAAC;QAC9C,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QAErB,MAAM,IAAI,GAAG,WAAW,IAAI,IAAI,CAAC,YAAY,CAAC;QAE9C,0DAA0D;QAC1D,MAAM,0BAA0B,CAAC,QAAQ,CAAC,MAAM,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;QAErE,2EAA2E;QAC3E,MAAM,EAAE,GAAG,IAAI,OAAO,EAAE,CAAC;QACzB,MAAM,MAAM,GAA8C,MAAM,EAAE,CAAC,OAAO,CAA6B;YACnG,UAAU,EAAE,2BAA2B;YACvC,UAAU,EAAE,eAAe;SAC9B,EAAE,IAAI,CAAC,CAAC;QAET,IAAI,MAAM,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YAC3B,KAAK,MAAM,kBAAkB,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;gBAC9C,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC,EAAE,CAAC,GAAG,kBAAkB,CAAC;YAChE,CAAC;QACL,CAAC;QAED,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;IACxB,CAAC;CACJ"}

package/package.json

@@ -1,10 +1,34 @@
 {
   "name": "@memberjunction/entity-documents",
-  "version": "0.0.0",
-  "description": "OIDC trusted publishing setup package for @memberjunction/entity-documents",
-  "keywords": [
-    "oidc",
-    "trusted-publishing",
-    "setup"
-  ]
-}
+  "type": "module",
+  "version": "6.2.0-edge.0",
+  "description": "MemberJunction: Entity Documents - lightweight template parsing and caching engine for converting records into rich prompt context",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "/dist"
+  ],
+  "author": "MemberJunction.com",
+  "license": "BUSL-1.1",
+  "dependencies": {
+    "@memberjunction/core": "6.2.0-edge.0",
+    "@memberjunction/core-entities": "6.2.0-edge.0",
+    "@memberjunction/global": "6.2.0-edge.0",
+    "@memberjunction/templates": "6.2.0-edge.0"
+  },
+  "devDependencies": {
+    "@types/node": "24.10.11",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.18"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MemberJunction/MJ"
+  },
+  "scripts": {
+    "build": "tsc && tsc-alias -f",
+    "watch": "tsc --watch",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  }
+}

package/README.md

@@ -1,45 +0,0 @@
-# @memberjunction/entity-documents
-
-## ⚠️ IMPORTANT NOTICE ⚠️
-
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
-
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
-
-## Purpose
-
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `@memberjunction/entity-documents`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
-
-## What is OIDC Trusted Publishing?
-
-OIDC trusted publishing allows package maintainers to publish packages directly from their CI/CD workflows without needing to manage npm access tokens. Instead, it uses OpenID Connect to establish trust between the CI/CD provider (like GitHub Actions) and npm.
-
-## Setup Instructions
-
-To properly configure OIDC trusted publishing for this package:
-
-1. Go to [npmjs.com](https://www.npmjs.com/) and navigate to your package settings
-2. Configure the trusted publisher (e.g., GitHub Actions)
-3. Specify the repository and workflow that should be allowed to publish
-4. Use the configured workflow to publish your actual package
-
-## DO NOT USE THIS PACKAGE
-
-This package is a placeholder for OIDC configuration only. It:
-- Contains no executable code
-- Provides no functionality
-- Should not be installed as a dependency
-- Exists only for administrative purposes
-
-## More Information
-
-For more details about npm's trusted publishing feature, see:
-- [npm Trusted Publishing Documentation](https://docs.npmjs.com/generating-provenance-statements)
-- [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
-
----
-
-**Maintained for OIDC setup purposes only**