@memberjunction/doc-utils 1.4.1

package/dist/Engine.d.ts

@@ -0,0 +1,41 @@
+import { BaseEngine, UserInfo } from "@memberjunction/core";
+import { LibraryEntity } from "@memberjunction/core-entities";
+/**
+ * Represents a single item within a library/package that is used to provide documentation for the MemberJunction system. For example a library would be something like
+ * @memberjunction/core and an item within that library might be the BaseEntity or BaseEngine class.
+ */
+export declare class LibraryItem {
+    Name: string;
+    URL: string;
+    HTMLContent: string;
+    Library: LibraryEntity;
+}
+export declare class LibraryEntityExtended extends LibraryEntity {
+    private _items;
+    get Items(): LibraryItem[];
+}
+/**
+ * Provides utility functionality for documentation of the MemberJunction system using external website content from the MemberJunction project.
+ */
+export declare class DocumentationEngine extends BaseEngine<DocumentationEngine> {
+    private constructor();
+    static get Instance(): DocumentationEngine;
+    private _Libraries;
+    /**
+     * This method is called to configure the ActionEngine. It loads the metadata for the actions, filters, and result codes and caches them in the GlobalObjectStore. You must call this method before running any actions.
+     * If this method was previously run on the instance of the ActionEngine, it will return immediately without re-loading the metadata. If you want to force a reload of the metadata, you can pass true for the forceReload parameter.
+     * @param forceRefresh If true, the metadata will be loaded from the database even if it was previously loaded.
+     * @param contextUser If you are running the action on the server side you must pass this in, but it is not required in an environment where a user is authenticated directly, e.g. a browser or other client.
+     */
+    Config(forceRefresh?: boolean, contextUser?: UserInfo): Promise<void>;
+    private _baseURL;
+    protected AdditionalLoading(contextUser?: UserInfo): Promise<void>;
+    protected GetContent(url: string, rootSelector?: string): Promise<string>;
+    protected fetchDocumentation(url: string): Promise<string>;
+    protected parseDocumentation(html: string, rootSelector?: string): string;
+    /**
+     * List of all the Entity Action objects that are available for use in the system. Make sure you call Config() before any other methods on this class.
+     */
+    get Libraries(): LibraryEntityExtended[];
+}
+//# sourceMappingURL=Engine.d.ts.map

package/dist/Engine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Engine.d.ts","sourceRoot":"","sources":["../src/Engine.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,UAAU,EAAsC,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChG,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAK9D;;;GAGG;AACH,qBAAa,WAAW;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,aAAa,CAAC;CAC1B;AAED,qBACa,qBAAsB,SAAQ,aAAa;IACpD,OAAO,CAAC,MAAM,CAAqB;IACnC,IAAW,KAAK,IAAI,WAAW,EAAE,CAEhC;CACJ;AAED;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,UAAU,CAAC,mBAAmB,CAAC;IACpE,OAAO;IAIP,WAAkB,QAAQ,IAAI,mBAAmB,CAEhD;IAID,OAAO,CAAC,UAAU,CAA+B;IAEjD;;;;;OAKG;IACU,MAAM,CAAC,YAAY,GAAE,OAAe,EAAE,WAAW,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAUzF,OAAO,CAAC,QAAQ,CAA0D;cACjD,iBAAiB,CAAC,WAAW,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;cAiBjE,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;cAI/D,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAchE,SAAS,CAAE,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM;IAO1E;;OAEG;IACH,IAAW,SAAS,IAAI,qBAAqB,EAAE,CAE9C;CACJ"}

package/dist/Engine.js

@@ -0,0 +1,116 @@
+"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;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentationEngine = exports.LibraryEntityExtended = exports.LibraryItem = void 0;
+const axios_1 = __importDefault(require("axios"));
+const jsdom_1 = require("jsdom");
+const core_1 = require("@memberjunction/core");
+const core_entities_1 = require("@memberjunction/core-entities");
+const global_1 = require("@memberjunction/global");
+const typeorm_1 = require("typeorm");
+/**
+ * Represents a single item within a library/package that is used to provide documentation for the MemberJunction system. For example a library would be something like
+ * @memberjunction/core and an item within that library might be the BaseEntity or BaseEngine class.
+ */
+class LibraryItem {
+}
+exports.LibraryItem = LibraryItem;
+let LibraryEntityExtended = class LibraryEntityExtended extends core_entities_1.LibraryEntity {
+    constructor() {
+        super(...arguments);
+        this._items = [];
+    }
+    get Items() {
+        return this._items;
+    }
+};
+exports.LibraryEntityExtended = LibraryEntityExtended;
+exports.LibraryEntityExtended = LibraryEntityExtended = __decorate([
+    (0, global_1.RegisterClass)(typeorm_1.BaseEntity, "Libraries")
+], LibraryEntityExtended);
+/**
+ * Provides utility functionality for documentation of the MemberJunction system using external website content from the MemberJunction project.
+ */
+class DocumentationEngine extends core_1.BaseEngine {
+    constructor() {
+        super('MJ_Documentation_Metadata');
+        // internal instance properties used for the singleton pattern
+        this._Libraries = [];
+        this._baseURL = 'https://memberjunction.github.io/MJ/classes/';
+    }
+    static get Instance() {
+        return super.getInstance('MJ_Documentation_Metadata');
+    }
+    /**
+     * This method is called to configure the ActionEngine. It loads the metadata for the actions, filters, and result codes and caches them in the GlobalObjectStore. You must call this method before running any actions.
+     * If this method was previously run on the instance of the ActionEngine, it will return immediately without re-loading the metadata. If you want to force a reload of the metadata, you can pass true for the forceReload parameter.
+     * @param forceRefresh If true, the metadata will be loaded from the database even if it was previously loaded.
+     * @param contextUser If you are running the action on the server side you must pass this in, but it is not required in an environment where a user is authenticated directly, e.g. a browser or other client.
+     */
+    async Config(forceRefresh = false, contextUser) {
+        const configs = [
+            {
+                EntityName: 'Libraries',
+                PropertyName: '_Libraries'
+            },
+        ];
+        await this.Load(configs, forceRefresh, contextUser);
+    }
+    async AdditionalLoading(contextUser) {
+        // Load the items for each library using the comma delimited list of included items in the Library metadata
+        for (const library of this.Libraries) {
+            const items = library.ExportedItems.split(',').map(x => x.trim());
+            for (const item of items) {
+                const libraryItem = new LibraryItem();
+                // lib code name is replace all instances of @ . and / or \ in the library name with _
+                const codeName = library.Name.replace(/[@.\/\\]/g, '_');
+                libraryItem.Name = item;
+                libraryItem.URL = `${this._baseURL}${codeName}.${item}.html`;
+                libraryItem.HTMLContent = await this.GetContent(libraryItem.URL);
+                libraryItem.Library = library;
+                library.Items.push(libraryItem);
+            }
+        }
+    }
+    async GetContent(url, rootSelector) {
+        const html = await this.fetchDocumentation(url);
+        return this.parseDocumentation(html, rootSelector);
+    }
+    async fetchDocumentation(url) {
+        try {
+            const response = await axios_1.default.get(url);
+            if (response.status === 200) {
+                return response.data;
+            }
+            else {
+                return 'No content found';
+            }
+        }
+        catch (e) {
+            (0, core_1.LogError)(e);
+            return "Error fetching content";
+        }
+    }
+    parseDocumentation(html, rootSelector) {
+        const dom = new jsdom_1.JSDOM(html);
+        const document = dom.window.document;
+        const content = document.querySelector('div.col-content')?.innerHTML;
+        return content || 'No relevant content found';
+    }
+    /**
+     * List of all the Entity Action objects that are available for use in the system. Make sure you call Config() before any other methods on this class.
+     */
+    get Libraries() {
+        return this._Libraries;
+    }
+}
+exports.DocumentationEngine = DocumentationEngine;
+//# sourceMappingURL=Engine.js.map

package/dist/Engine.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Engine.js","sourceRoot":"","sources":["../src/Engine.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,kDAA0B;AAC1B,iCAA8B;AAE9B,+CAAgG;AAChG,iEAA8D;AAC9D,mDAAuD;AACvD,qCAAqC;AAGrC;;;GAGG;AACH,MAAa,WAAW;CAKvB;AALD,kCAKC;AAGM,IAAM,qBAAqB,GAA3B,MAAM,qBAAsB,SAAQ,6BAAa;IAAjD;;QACK,WAAM,GAAkB,EAAE,CAAC;IAIvC,CAAC;IAHG,IAAW,KAAK;QACZ,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;CACJ,CAAA;AALY,sDAAqB;gCAArB,qBAAqB;IADjC,IAAA,sBAAa,EAAC,oBAAU,EAAE,WAAW,CAAC;GAC1B,qBAAqB,CAKjC;AAED;;GAEG;AACH,MAAa,mBAAoB,SAAQ,iBAA+B;IACpE;QACI,KAAK,CAAC,2BAA2B,CAAC,CAAC;QAQvC,8DAA8D;QACtD,eAAU,GAA4B,EAAE,CAAC;QAkBzC,aAAQ,GAAW,8CAA8C,CAAC;IA1B1E,CAAC;IAEM,MAAM,KAAK,QAAQ;QACtB,OAAO,KAAK,CAAC,WAAW,CAAsB,2BAA2B,CAAC,CAAC;IAC/E,CAAC;IAMD;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,eAAwB,KAAK,EAAE,WAAsB;QACrE,MAAM,OAAO,GAA+B;YACxC;gBACI,UAAU,EAAE,WAAW;gBACvB,YAAY,EAAE,YAAY;aAC7B;SACJ,CAAC;QACF,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;IACxD,CAAC;IAGkB,KAAK,CAAC,iBAAiB,CAAC,WAAsB;QAC7D,2GAA2G;QAC3G,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnC,MAAM,KAAK,GAAG,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;YAClE,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;gBACvB,MAAM,WAAW,GAAG,IAAI,WAAW,EAAE,CAAC;gBACtC,sFAAsF;gBACtF,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;gBACxD,WAAW,CAAC,IAAI,GAAG,IAAI,CAAC;gBACxB,WAAW,CAAC,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,GAAG,QAAQ,IAAI,IAAI,OAAO,CAAC;gBAC7D,WAAW,CAAC,WAAW,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;gBACjE,WAAW,CAAC,OAAO,GAAG,OAAO,CAAC;gBAC9B,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACpC,CAAC;QACL,CAAC;IACL,CAAC;IAES,KAAK,CAAC,UAAU,CAAC,GAAW,EAAE,YAAqB;QACzD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC;QAChD,OAAO,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;IACvD,CAAC;IACS,KAAK,CAAC,kBAAkB,CAAC,GAAW;QAC1C,IAAI,CAAC;YACD,MAAM,QAAQ,GAAG,MAAM,eAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACtC,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBAC1B,OAAO,QAAQ,CAAC,IAAI,CAAC;YACzB,CAAC;iBAAM,CAAC;gBACJ,OAAO,kBAAkB,CAAC;YAC9B,CAAC;QACL,CAAC;QACD,OAAO,CAAC,EAAE,CAAC;YACP,IAAA,eAAQ,EAAC,CAAC,CAAC,CAAA;YACX,OAAO,wBAAwB,CAAA;QACnC,CAAC;IACL,CAAC;IACU,kBAAkB,CAAC,IAAY,EAAE,YAAqB;QAC7D,MAAM,GAAG,GAAG,IAAI,aAAK,CAAC,IAAI,CAAC,CAAC;QAC5B,MAAM,QAAQ,GAAG,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC;QACrC,MAAM,OAAO,GAAG,QAAQ,CAAC,aAAa,CAAC,iBAAiB,CAAC,EAAE,SAAS,CAAC;QACrE,OAAO,OAAO,IAAI,2BAA2B,CAAC;IAClD,CAAC;IAED;;OAEG;IACH,IAAW,SAAS;QAChB,OAAO,IAAI,CAAC,UAAU,CAAC;IAC3B,CAAC;CACJ;AA9ED,kDA8EC"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './Engine';
+//# 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":"AAEA,cAAc,UAAU,CAAC"}

package/dist/index.js

@@ -0,0 +1,19 @@
+"use strict";
+//PUBLIC API SURFACE AREA
+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("./Engine"), 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,yBAAyB;;;;;;;;;;;;;;;;AAEzB,2CAAyB"}

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@memberjunction/doc-utils",
+  "version": "1.4.1",
+  "description": "This library provides functionality for dynamically retreiving documentation from the official MemberJunction object model documentation site, parsing it, and caching elements in memory for performance. Use this whenever you need dynamic access to the MJ documentation to feed to AI models and for any other similar purpose.",
+  "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": {
+    "ts-node-dev": "^2.0.0",
+    "typescript": "^5.3.3"
+  },
+  "dependencies": {
+    "@memberjunction/ai": "~1.4.1",
+    "@memberjunction/core": "~1.4.1",
+    "@memberjunction/actions": "~1.4.1",
+    "@memberjunction/core-entities": "~1.4.1",
+    "@memberjunction/global": "~1.4.1",
+    "@memberjunction/sqlserver-dataprovider": "~1.4.1",
+    "env-var": "^7.4.1",
+    "fs-extra": "^11.1.1",
+    "glob": "^10.3.10",
+    "typeorm": "^0.3.20",
+    "jsdom": "^24.1.0"
+  }
+}