@memberjunction/doc-utils 2.111.0 → 2.112.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/README.md +2 -2
- package/dist/Engine.d.ts +5 -5
- package/dist/Engine.d.ts.map +1 -1
- package/dist/Engine.js +21 -21
- package/dist/Engine.js.map +1 -1
- package/package.json +3 -4
package/README.md
CHANGED
|
@@ -38,7 +38,7 @@ External dependencies:
|
|
|
38
38
|
|
|
39
39
|
```typescript
|
|
40
40
|
import { DocumentationEngine } from '@memberjunction/doc-utils';
|
|
41
|
-
import { UserInfo } from '@memberjunction/
|
|
41
|
+
import { UserInfo } from '@memberjunction/global';
|
|
42
42
|
|
|
43
43
|
// Get the singleton instance
|
|
44
44
|
const docEngine = DocumentationEngine.Instance;
|
|
@@ -187,4 +187,4 @@ npm test
|
|
|
187
187
|
|
|
188
188
|
## License
|
|
189
189
|
|
|
190
|
-
ISC
|
|
190
|
+
ISC
|
package/dist/Engine.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import { BaseEngine, UserInfo, IMetadataProvider } from
|
|
2
|
-
import { LibraryEntity, LibraryItemEntity } from
|
|
1
|
+
import { BaseEngine, UserInfo, IMetadataProvider } from '@memberjunction/global';
|
|
2
|
+
import { LibraryEntity, LibraryItemEntity } from '@memberjunction/core-entities';
|
|
3
3
|
/**
|
|
4
4
|
* 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
|
|
5
|
-
* @memberjunction/
|
|
5
|
+
* @memberjunction/global and an item within that library might be the BaseEntity or BaseEngine class.
|
|
6
6
|
*/
|
|
7
7
|
export declare class LibraryItemEntityExtended extends LibraryItemEntity {
|
|
8
8
|
URL: string;
|
|
@@ -37,8 +37,8 @@ export declare class DocumentationEngine extends BaseEngine<DocumentationEngine>
|
|
|
37
37
|
*/
|
|
38
38
|
get Libraries(): LibraryEntityExtended[];
|
|
39
39
|
/**
|
|
40
|
-
|
|
41
|
-
|
|
40
|
+
* 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.
|
|
41
|
+
*/
|
|
42
42
|
get LibraryItems(): LibraryItemEntityExtended[];
|
|
43
43
|
}
|
|
44
44
|
//# sourceMappingURL=Engine.d.ts.map
|
package/dist/Engine.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Engine.d.ts","sourceRoot":"","sources":["../src/Engine.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,UAAU,EAAsC,QAAQ,EAAc,iBAAiB,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"Engine.d.ts","sourceRoot":"","sources":["../src/Engine.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,UAAU,EAAsC,QAAQ,EAAc,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AACjI,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAGjF;;;GAGG;AACH,qBACa,yBAA0B,SAAQ,iBAAiB;IAC9D,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,CAAC;IAEpB,IAAW,cAAc,IAAI,MAAM,CAiBlC;CACF;AAED,qBACa,qBAAsB,SAAQ,aAAa;IACtD,OAAO,CAAC,MAAM,CAAmC;IACjD,IAAW,KAAK,IAAI,yBAAyB,EAAE,CAE9C;CACF;AAED;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,UAAU,CAAC,mBAAmB,CAAC;IACtE,WAAkB,QAAQ,IAAI,mBAAmB,CAEhD;IAGD,OAAO,CAAC,UAAU,CAA+B;IACjD,OAAO,CAAC,aAAa,CAAmC;IAExD;;;;;OAKG;IACU,MAAM,CAAC,YAAY,GAAE,OAAe,EAAE,WAAW,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAcvH,OAAO,CAAC,QAAQ,CAAkD;cACzC,iBAAiB,CAAC,WAAW,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;cAgBjE,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;IAahE,SAAS,CAAC,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM;IAOzE;;OAEG;IACH,IAAW,SAAS,IAAI,qBAAqB,EAAE,CAE9C;IAED;;OAEG;IACH,IAAW,YAAY,IAAI,yBAAyB,EAAE,CAErD;CACF"}
|
package/dist/Engine.js
CHANGED
|
@@ -12,36 +12,36 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
12
12
|
exports.DocumentationEngine = exports.LibraryEntityExtended = exports.LibraryItemEntityExtended = void 0;
|
|
13
13
|
const axios_1 = __importDefault(require("axios"));
|
|
14
14
|
const jsdom_1 = require("jsdom");
|
|
15
|
-
const core_1 = require("@memberjunction/core");
|
|
16
|
-
const core_entities_1 = require("@memberjunction/core-entities");
|
|
17
15
|
const global_1 = require("@memberjunction/global");
|
|
16
|
+
const core_entities_1 = require("@memberjunction/core-entities");
|
|
17
|
+
const global_2 = require("@memberjunction/global");
|
|
18
18
|
/**
|
|
19
19
|
* 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
|
-
* @memberjunction/
|
|
20
|
+
* @memberjunction/global and an item within that library might be the BaseEntity or BaseEngine class.
|
|
21
21
|
*/
|
|
22
22
|
let LibraryItemEntityExtended = class LibraryItemEntityExtended extends core_entities_1.LibraryItemEntity {
|
|
23
23
|
get TypeURLSegment() {
|
|
24
24
|
switch (this.Type) {
|
|
25
25
|
case 'Class':
|
|
26
|
-
return
|
|
27
|
-
case
|
|
28
|
-
return
|
|
29
|
-
case
|
|
30
|
-
return
|
|
26
|
+
return 'classes';
|
|
27
|
+
case 'Interface':
|
|
28
|
+
return 'interfaces';
|
|
29
|
+
case 'Function':
|
|
30
|
+
return 'functions';
|
|
31
31
|
case 'Module':
|
|
32
|
-
return
|
|
32
|
+
return 'modules';
|
|
33
33
|
case 'Type':
|
|
34
|
-
return
|
|
34
|
+
return 'types';
|
|
35
35
|
case 'Variable':
|
|
36
|
-
return
|
|
36
|
+
return 'variables';
|
|
37
37
|
default:
|
|
38
|
-
throw new Error(
|
|
38
|
+
throw new Error('Unknown type ' + this.Type);
|
|
39
39
|
}
|
|
40
40
|
}
|
|
41
41
|
};
|
|
42
42
|
exports.LibraryItemEntityExtended = LibraryItemEntityExtended;
|
|
43
43
|
exports.LibraryItemEntityExtended = LibraryItemEntityExtended = __decorate([
|
|
44
|
-
(0,
|
|
44
|
+
(0, global_2.RegisterClass)(global_1.BaseEntity, 'Library Items')
|
|
45
45
|
], LibraryItemEntityExtended);
|
|
46
46
|
let LibraryEntityExtended = class LibraryEntityExtended extends core_entities_1.LibraryEntity {
|
|
47
47
|
constructor() {
|
|
@@ -54,12 +54,12 @@ let LibraryEntityExtended = class LibraryEntityExtended extends core_entities_1.
|
|
|
54
54
|
};
|
|
55
55
|
exports.LibraryEntityExtended = LibraryEntityExtended;
|
|
56
56
|
exports.LibraryEntityExtended = LibraryEntityExtended = __decorate([
|
|
57
|
-
(0,
|
|
57
|
+
(0, global_2.RegisterClass)(global_1.BaseEntity, 'Libraries')
|
|
58
58
|
], LibraryEntityExtended);
|
|
59
59
|
/**
|
|
60
60
|
* Provides utility functionality for documentation of the MemberJunction system using external website content from the MemberJunction project.
|
|
61
61
|
*/
|
|
62
|
-
class DocumentationEngine extends
|
|
62
|
+
class DocumentationEngine extends global_1.BaseEngine {
|
|
63
63
|
constructor() {
|
|
64
64
|
super(...arguments);
|
|
65
65
|
// internal instance properties used for the singleton pattern
|
|
@@ -80,11 +80,11 @@ class DocumentationEngine extends core_1.BaseEngine {
|
|
|
80
80
|
const configs = [
|
|
81
81
|
{
|
|
82
82
|
EntityName: 'Libraries',
|
|
83
|
-
PropertyName: '_Libraries'
|
|
83
|
+
PropertyName: '_Libraries',
|
|
84
84
|
},
|
|
85
85
|
{
|
|
86
86
|
EntityName: 'Library Items',
|
|
87
|
-
PropertyName: '_LibraryItems'
|
|
87
|
+
PropertyName: '_LibraryItems',
|
|
88
88
|
},
|
|
89
89
|
];
|
|
90
90
|
await this.Load(configs, provider, forceRefresh, contextUser);
|
|
@@ -117,8 +117,8 @@ class DocumentationEngine extends core_1.BaseEngine {
|
|
|
117
117
|
}
|
|
118
118
|
}
|
|
119
119
|
catch (e) {
|
|
120
|
-
(0,
|
|
121
|
-
return
|
|
120
|
+
(0, global_1.LogError)(e);
|
|
121
|
+
return 'Error fetching content';
|
|
122
122
|
}
|
|
123
123
|
}
|
|
124
124
|
parseDocumentation(html, rootSelector) {
|
|
@@ -134,8 +134,8 @@ class DocumentationEngine extends core_1.BaseEngine {
|
|
|
134
134
|
return this._Libraries;
|
|
135
135
|
}
|
|
136
136
|
/**
|
|
137
|
-
|
|
138
|
-
|
|
137
|
+
* 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.
|
|
138
|
+
*/
|
|
139
139
|
get LibraryItems() {
|
|
140
140
|
return this._LibraryItems;
|
|
141
141
|
}
|
package/dist/Engine.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Engine.js","sourceRoot":"","sources":["../src/Engine.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,kDAA0B;AAC1B,iCAA8B;AAE9B
|
|
1
|
+
{"version":3,"file":"Engine.js","sourceRoot":"","sources":["../src/Engine.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,kDAA0B;AAC1B,iCAA8B;AAE9B,mDAAiI;AACjI,iEAAiF;AACjF,mDAAuD;AAEvD;;;GAGG;AAEI,IAAM,yBAAyB,GAA/B,MAAM,yBAA0B,SAAQ,iCAAiB;IAI9D,IAAW,cAAc;QACvB,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YAClB,KAAK,OAAO;gBACV,OAAO,SAAS,CAAC;YACnB,KAAK,WAAW;gBACd,OAAO,YAAY,CAAC;YACtB,KAAK,UAAU;gBACb,OAAO,WAAW,CAAC;YACrB,KAAK,QAAQ;gBACX,OAAO,SAAS,CAAC;YACnB,KAAK,MAAM;gBACT,OAAO,OAAO,CAAC;YACjB,KAAK,UAAU;gBACb,OAAO,WAAW,CAAC;YACrB;gBACE,MAAM,IAAI,KAAK,CAAC,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;QACjD,CAAC;IACH,CAAC;CACF,CAAA;AAtBY,8DAAyB;oCAAzB,yBAAyB;IADrC,IAAA,sBAAa,EAAC,mBAAU,EAAE,eAAe,CAAC;GAC9B,yBAAyB,CAsBrC;AAGM,IAAM,qBAAqB,GAA3B,MAAM,qBAAsB,SAAQ,6BAAa;IAAjD;;QACG,WAAM,GAAgC,EAAE,CAAC;IAInD,CAAC;IAHC,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;CACF,CAAA;AALY,sDAAqB;gCAArB,qBAAqB;IADjC,IAAA,sBAAa,EAAC,mBAAU,EAAE,WAAW,CAAC;GAC1B,qBAAqB,CAKjC;AAED;;GAEG;AACH,MAAa,mBAAoB,SAAQ,mBAA+B;IAAxE;;QAKE,8DAA8D;QACtD,eAAU,GAA4B,EAAE,CAAC;QACzC,kBAAa,GAAgC,EAAE,CAAC;QAsBhD,aAAQ,GAAW,sCAAsC,CAAC;IAsDpE,CAAC;IAlFQ,MAAM,KAAK,QAAQ;QACxB,OAAO,KAAK,CAAC,WAAW,EAAuB,CAAC;IAClD,CAAC;IAMD;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,eAAwB,KAAK,EAAE,WAAsB,EAAE,QAA4B;QACrG,MAAM,OAAO,GAAwC;YACnD;gBACE,UAAU,EAAE,WAAW;gBACvB,YAAY,EAAE,YAAY;aAC3B;YACD;gBACE,UAAU,EAAE,eAAe;gBAC3B,YAAY,EAAE,eAAe;aAC9B;SACF,CAAC;QACF,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;IAChE,CAAC;IAGkB,KAAK,CAAC,iBAAiB,CAAC,WAAsB;QAC/D,2GAA2G;QAC3G,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACrC,MAAM,KAAK,GAAgC,IAAI,CAAC,YAAY,CAAC,MAAM,CACjE,CAAC,IAA+B,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,KAAK,OAAO,CAAC,EAAE,CACnE,CAAC;YACF,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;gBACzB,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;YAC3B,CAAC;QACH,CAAC;IACH,CAAC;IAES,KAAK,CAAC,UAAU,CAAC,GAAW,EAAE,YAAqB;QAC3D,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC;QAChD,OAAO,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;IACrD,CAAC;IACS,KAAK,CAAC,kBAAkB,CAAC,GAAW;QAC5C,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,eAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACtC,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBAC5B,OAAO,QAAQ,CAAC,IAAI,CAAC;YACvB,CAAC;iBAAM,CAAC;gBACN,OAAO,kBAAkB,CAAC;YAC5B,CAAC;QACH,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAA,iBAAQ,EAAC,CAAC,CAAC,CAAC;YACZ,OAAO,wBAAwB,CAAC;QAClC,CAAC;IACH,CAAC;IACS,kBAAkB,CAAC,IAAY,EAAE,YAAqB;QAC9D,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;IAChD,CAAC;IAED;;OAEG;IACH,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;CACF;AAnFD,kDAmFC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@memberjunction/doc-utils",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.112.0",
|
|
4
4
|
"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
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -19,9 +19,8 @@
|
|
|
19
19
|
"typescript": "^5.4.5"
|
|
20
20
|
},
|
|
21
21
|
"dependencies": {
|
|
22
|
-
"@memberjunction/core": "2.
|
|
23
|
-
"@memberjunction/
|
|
24
|
-
"@memberjunction/global": "2.111.0",
|
|
22
|
+
"@memberjunction/core-entities": "2.112.0",
|
|
23
|
+
"@memberjunction/global": "2.112.0",
|
|
25
24
|
"jsdom": "^24.1.0",
|
|
26
25
|
"axios": "^1.6.7"
|
|
27
26
|
},
|