@memberjunction/doc-utils 3.4.0 → 4.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/Engine.js +17 -24
- package/dist/Engine.js.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -17
- package/dist/index.js.map +1 -1
- package/package.json +24 -23
package/dist/Engine.js
CHANGED
|
@@ -1,25 +1,19 @@
|
|
|
1
|
-
"use strict";
|
|
2
1
|
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
|
|
3
2
|
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
|
|
4
3
|
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
|
|
5
4
|
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;
|
|
6
5
|
return c > 3 && r && Object.defineProperty(target, key, r), r;
|
|
7
6
|
};
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
};
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
const axios_1 = __importDefault(require("axios"));
|
|
14
|
-
const jsdom_1 = require("jsdom");
|
|
15
|
-
const core_1 = require("@memberjunction/core");
|
|
16
|
-
const core_entities_1 = require("@memberjunction/core-entities");
|
|
17
|
-
const global_1 = require("@memberjunction/global");
|
|
7
|
+
import axios from 'axios';
|
|
8
|
+
import { JSDOM } from 'jsdom';
|
|
9
|
+
import { BaseEngine, LogError, BaseEntity } from "@memberjunction/core";
|
|
10
|
+
import { LibraryEntity, LibraryItemEntity } from "@memberjunction/core-entities";
|
|
11
|
+
import { RegisterClass } from '@memberjunction/global';
|
|
18
12
|
/**
|
|
19
13
|
* 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
|
|
20
14
|
* @memberjunction/core and an item within that library might be the BaseEntity or BaseEngine class.
|
|
21
15
|
*/
|
|
22
|
-
let LibraryItemEntityExtended = class LibraryItemEntityExtended extends
|
|
16
|
+
let LibraryItemEntityExtended = class LibraryItemEntityExtended extends LibraryItemEntity {
|
|
23
17
|
get TypeURLSegment() {
|
|
24
18
|
switch (this.Type) {
|
|
25
19
|
case 'Class':
|
|
@@ -39,11 +33,11 @@ let LibraryItemEntityExtended = class LibraryItemEntityExtended extends core_ent
|
|
|
39
33
|
}
|
|
40
34
|
}
|
|
41
35
|
};
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
(0, global_1.RegisterClass)(core_1.BaseEntity, "Library Items")
|
|
36
|
+
LibraryItemEntityExtended = __decorate([
|
|
37
|
+
RegisterClass(BaseEntity, "Library Items")
|
|
45
38
|
], LibraryItemEntityExtended);
|
|
46
|
-
|
|
39
|
+
export { LibraryItemEntityExtended };
|
|
40
|
+
let LibraryEntityExtended = class LibraryEntityExtended extends LibraryEntity {
|
|
47
41
|
constructor() {
|
|
48
42
|
super(...arguments);
|
|
49
43
|
this._items = [];
|
|
@@ -52,14 +46,14 @@ let LibraryEntityExtended = class LibraryEntityExtended extends core_entities_1.
|
|
|
52
46
|
return this._items;
|
|
53
47
|
}
|
|
54
48
|
};
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
(0, global_1.RegisterClass)(core_1.BaseEntity, "Libraries")
|
|
49
|
+
LibraryEntityExtended = __decorate([
|
|
50
|
+
RegisterClass(BaseEntity, "Libraries")
|
|
58
51
|
], LibraryEntityExtended);
|
|
52
|
+
export { LibraryEntityExtended };
|
|
59
53
|
/**
|
|
60
54
|
* Provides utility functionality for documentation of the MemberJunction system using external website content from the MemberJunction project.
|
|
61
55
|
*/
|
|
62
|
-
class DocumentationEngine extends
|
|
56
|
+
export class DocumentationEngine extends BaseEngine {
|
|
63
57
|
constructor() {
|
|
64
58
|
super(...arguments);
|
|
65
59
|
// internal instance properties used for the singleton pattern
|
|
@@ -110,7 +104,7 @@ class DocumentationEngine extends core_1.BaseEngine {
|
|
|
110
104
|
}
|
|
111
105
|
async fetchDocumentation(url) {
|
|
112
106
|
try {
|
|
113
|
-
const response = await
|
|
107
|
+
const response = await axios.get(url);
|
|
114
108
|
if (response.status === 200) {
|
|
115
109
|
return response.data;
|
|
116
110
|
}
|
|
@@ -119,12 +113,12 @@ class DocumentationEngine extends core_1.BaseEngine {
|
|
|
119
113
|
}
|
|
120
114
|
}
|
|
121
115
|
catch (e) {
|
|
122
|
-
|
|
116
|
+
LogError(e);
|
|
123
117
|
return "Error fetching content";
|
|
124
118
|
}
|
|
125
119
|
}
|
|
126
120
|
parseDocumentation(html, rootSelector) {
|
|
127
|
-
const dom = new
|
|
121
|
+
const dom = new JSDOM(html);
|
|
128
122
|
const document = dom.window.document;
|
|
129
123
|
const content = document.querySelector('div.col-content')?.innerHTML;
|
|
130
124
|
return content || 'No relevant content found';
|
|
@@ -142,5 +136,4 @@ class DocumentationEngine extends core_1.BaseEngine {
|
|
|
142
136
|
return this._LibraryItems;
|
|
143
137
|
}
|
|
144
138
|
}
|
|
145
|
-
exports.DocumentationEngine = DocumentationEngine;
|
|
146
139
|
//# sourceMappingURL=Engine.js.map
|
package/dist/Engine.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Engine.js","sourceRoot":"","sources":["../src/Engine.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"Engine.js","sourceRoot":"","sources":["../src/Engine.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAE9B,OAAO,EAAE,UAAU,EAA4B,QAAQ,EAAY,UAAU,EAAqB,MAAM,sBAAsB,CAAC;AAC/H,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AACjF,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAGvD;;;GAGG;AAEI,IAAM,yBAAyB,GAA/B,MAAM,yBAA0B,SAAQ,iBAAiB;IAI5D,IAAW,cAAc;QACrB,QAAO,IAAI,CAAC,IAAI,EAAC,CAAC;YACd,KAAK,OAAO;gBACR,OAAO,SAAS,CAAA;YACpB,KAAK,WAAW;gBACZ,OAAO,YAAY,CAAC;YACxB,KAAK,UAAU;gBACX,OAAO,WAAW,CAAC;YACvB,KAAK,QAAQ;gBACT,OAAO,SAAS,CAAC;YACrB,KAAK,MAAM;gBACP,OAAO,OAAO,CAAC;YACnB,KAAK,UAAU;gBACX,OAAO,WAAW,CAAC;YACvB;gBACI,MAAM,IAAI,KAAK,CAAC,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;QACrD,CAAC;IACL,CAAC;CACJ,CAAA;AAtBY,yBAAyB;IADrC,aAAa,CAAC,UAAU,EAAE,eAAe,CAAC;GAC9B,yBAAyB,CAsBrC;;AAGM,IAAM,qBAAqB,GAA3B,MAAM,qBAAsB,SAAQ,aAAa;IAAjD;;QACK,WAAM,GAAgC,EAAE,CAAC;IAIrD,CAAC;IAHG,IAAW,KAAK;QACZ,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;CACJ,CAAA;AALY,qBAAqB;IADjC,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC;GAC1B,qBAAqB,CAKjC;;AAED;;GAEG;AACH,MAAM,OAAO,mBAAoB,SAAQ,UAA+B;IAAxE;;QAMI,8DAA8D;QACtD,eAAU,GAA4B,EAAE,CAAC;QACzC,kBAAa,GAAgC,EAAE,CAAC;QAwBhD,aAAQ,GAAW,sCAAsC,CAAC;IAsDtE,CAAC;IArFU,MAAM,KAAK,QAAQ;QACtB,OAAO,KAAK,CAAC,WAAW,EAAuB,CAAC;IACpD,CAAC;IAOD;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,eAAwB,KAAK,EAAE,WAAsB,EAAE,QAA4B;QACnG,MAAM,OAAO,GAAwC;YACjD;gBACI,UAAU,EAAE,WAAW;gBACvB,YAAY,EAAE,YAAY;gBAC1B,UAAU,EAAE,IAAI;aACnB;YACD;gBACI,UAAU,EAAE,eAAe;gBAC3B,YAAY,EAAE,eAAe;gBAC7B,UAAU,EAAE,IAAI;aACnB;SACJ,CAAC;QACF,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;IAClE,CAAC;IAGkB,KAAK,CAAC,iBAAiB,CAAC,WAAsB;QAC7D,2GAA2G;QAC3G,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnC,MAAM,KAAK,GAAgC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,IAA+B,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,KAAK,OAAO,CAAC,EAAE,CAAC,CAAC;YACxI,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;gBAEvB,sFAAsF;gBACtF,MAAM,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;gBAC1D,IAAI,CAAC,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,cAAc,IAAI,UAAU,IAAI,IAAI,CAAC,IAAI,OAAO,CAAC;gBACpF,IAAI,CAAC,WAAW,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACnD,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC7B,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,KAAK,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,QAAQ,CAAC,CAAC,CAAC,CAAA;YACX,OAAO,wBAAwB,CAAA;QACnC,CAAC;IACL,CAAC;IACU,kBAAkB,CAAC,IAAY,EAAE,YAAqB;QAC7D,MAAM,GAAG,GAAG,IAAI,KAAK,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;IAEA;;MAEE;IACF,IAAW,YAAY;QACpB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC9B,CAAC;CACJ"}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export * from './Engine';
|
|
1
|
+
export * from './Engine.js';
|
|
2
2
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.js
CHANGED
|
@@ -1,19 +1,3 @@
|
|
|
1
|
-
"use strict";
|
|
2
1
|
//PUBLIC API SURFACE AREA
|
|
3
|
-
|
|
4
|
-
if (k2 === undefined) k2 = k;
|
|
5
|
-
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
6
|
-
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
7
|
-
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
8
|
-
}
|
|
9
|
-
Object.defineProperty(o, k2, desc);
|
|
10
|
-
}) : (function(o, m, k, k2) {
|
|
11
|
-
if (k2 === undefined) k2 = k;
|
|
12
|
-
o[k2] = m[k];
|
|
13
|
-
}));
|
|
14
|
-
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
15
|
-
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
16
|
-
};
|
|
17
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
18
|
-
__exportStar(require("./Engine"), exports);
|
|
2
|
+
export * from './Engine.js';
|
|
19
3
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,yBAAyB;AAEzB,cAAc,UAAU,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@memberjunction/doc-utils",
|
|
3
|
-
"
|
|
3
|
+
"type": "module",
|
|
4
|
+
"version": "4.0.0",
|
|
4
5
|
"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.",
|
|
5
6
|
"main": "dist/index.js",
|
|
6
7
|
"types": "dist/index.d.ts",
|
|
@@ -9,43 +10,43 @@
|
|
|
9
10
|
],
|
|
10
11
|
"scripts": {
|
|
11
12
|
"start": "ts-node-dev src/index.ts",
|
|
12
|
-
"build": "tsc",
|
|
13
|
+
"build": "tsc && tsc-alias -f",
|
|
13
14
|
"test": "echo \"Error: no test specified\" && exit 1"
|
|
14
15
|
},
|
|
15
16
|
"author": "MemberJunction.com",
|
|
16
17
|
"license": "ISC",
|
|
17
18
|
"devDependencies": {
|
|
18
19
|
"ts-node-dev": "^2.0.0",
|
|
19
|
-
"typescript": "^5.
|
|
20
|
+
"typescript": "^5.9.3"
|
|
20
21
|
},
|
|
21
22
|
"dependencies": {
|
|
22
|
-
"@asamuzakjp/css-color": "^
|
|
23
|
-
"@memberjunction/core": "
|
|
24
|
-
"@memberjunction/core-entities": "
|
|
25
|
-
"@memberjunction/global": "
|
|
26
|
-
"axios": "^1.
|
|
27
|
-
"cssstyle": "^
|
|
28
|
-
"data-urls": "^
|
|
29
|
-
"decimal.js": "^10.
|
|
30
|
-
"form-data": "^4.0.
|
|
23
|
+
"@asamuzakjp/css-color": "^4.1.2",
|
|
24
|
+
"@memberjunction/core": "4.0.0",
|
|
25
|
+
"@memberjunction/core-entities": "4.0.0",
|
|
26
|
+
"@memberjunction/global": "4.0.0",
|
|
27
|
+
"axios": "^1.13.4",
|
|
28
|
+
"cssstyle": "^6.0.1",
|
|
29
|
+
"data-urls": "^7.0.0",
|
|
30
|
+
"decimal.js": "^10.6.0",
|
|
31
|
+
"form-data": "^4.0.5",
|
|
31
32
|
"html-encoding-sniffer": "^6.0.0",
|
|
32
33
|
"http-proxy-agent": "^7.0.2",
|
|
33
|
-
"https-proxy-agent": "^7.0.
|
|
34
|
+
"https-proxy-agent": "^7.0.6",
|
|
34
35
|
"is-potential-custom-element-name": "^1.0.1",
|
|
35
|
-
"jsdom": "^
|
|
36
|
-
"nwsapi": "^2.2.
|
|
37
|
-
"parse5": "^
|
|
38
|
-
"psl": "^1.
|
|
39
|
-
"rrweb-cssom": "^0.
|
|
36
|
+
"jsdom": "^28.0.0",
|
|
37
|
+
"nwsapi": "^2.2.23",
|
|
38
|
+
"parse5": "^8.0.0",
|
|
39
|
+
"psl": "^1.15.0",
|
|
40
|
+
"rrweb-cssom": "^0.8.0",
|
|
40
41
|
"saxes": "^6.0.0",
|
|
41
42
|
"symbol-tree": "^3.2.4",
|
|
42
|
-
"tough-cookie": "^
|
|
43
|
+
"tough-cookie": "^6.0.0",
|
|
43
44
|
"w3c-xmlserializer": "^5.0.0",
|
|
44
|
-
"webidl-conversions": "^
|
|
45
|
+
"webidl-conversions": "^8.0.1",
|
|
45
46
|
"whatwg-encoding": "^3.1.1",
|
|
46
|
-
"whatwg-mimetype": "^
|
|
47
|
-
"whatwg-url": "^
|
|
48
|
-
"ws": "^8.
|
|
47
|
+
"whatwg-mimetype": "^5.0.0",
|
|
48
|
+
"whatwg-url": "^16.0.0",
|
|
49
|
+
"ws": "^8.19.0",
|
|
49
50
|
"xml-name-validator": "^5.0.0"
|
|
50
51
|
},
|
|
51
52
|
"repository": {
|