inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-09-10 14:11:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove unused webdriver-manager dependency to eliminate vulnerable form-data ~2.3.2 (#11060)

Browse Source 
* Initial plan

* Remove webdriver-manager to eliminate form-data ~2.3.2 dependency

Co-authored-by: eromano <1030050+eromano@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: eromano <1030050+eromano@users.noreply.github.com>
This commit is contained in:
Copilot
2025-07-30 13:28:22 -04:00
committed by GitHub
parent a29d846f4a
commit 4c4dd195a4
12 changed files with 692 additions and 1134 deletions
Download Patch File Download Diff File Expand all files Collapse all files

233
tools/doc/mdNav.js
View File

@@ -1,15 +1,39 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
'use strict';
/*!
* @license
* Copyright © 2005-2025 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
Object.defineProperty(exports, '__esModule', { value: true });
exports.MDNav = void 0;
var MDNav = /** @class */ (function () {
function MDNav(root, pos) {
if (pos === void 0) { pos = 0; }
if (pos === void 0) {
pos = 0;
}
this.root = root;
this.pos = pos;
}
MDNav.prototype.find = function (test, index) {
if (test === void 0) { test = function () { return true; }; }
if (index === void 0) { index = 0; }
if (test === void 0) {
test = function () {
return true;
};
}
if (index === void 0) {
index = 0;
}
if (!this.root || !this.root.children) {
return new MDNav(null);
}
@@ -19,8 +43,7 @@ var MDNav = /** @class */ (function () {
if (test(child)) {
if (currIndex === index) {
return new MDNav(this.root, i);
}
else {
} else {
currIndex++;
}
}
@@ -28,8 +51,14 @@ var MDNav = /** @class */ (function () {
return new MDNav(this.root, this.root.children.length);
};
MDNav.prototype.findAll = function (test, index) {
if (test === void 0) { test = function () { return true; }; }
if (index === void 0) { index = 0; }
if (test === void 0) {
test = function () {
return true;
};
}
if (index === void 0) {
index = 0;
}
if (!this.root || !this.root.children) {
return [];
}
@@ -40,8 +69,7 @@ var MDNav = /** @class */ (function () {
if (test(child)) {
if (currIndex === index) {
result.push(new MDNav(this.root, i));
}
else {
} else {
currIndex++;
}
}
@@ -49,166 +77,247 @@ var MDNav = /** @class */ (function () {
return result;
};
MDNav.prototype.emph = function (test, index) {
if (test === void 0) { test = function () { return true; }; }
if (index === void 0) { index = 0; }
if (test === void 0) {
test = function () {
return true;
};
}
if (index === void 0) {
index = 0;
}
return this.find(function (h) {
return h.type === 'emphasis' && test(h);
}, index);
};
MDNav.prototype.heading = function (test, index) {
if (test === void 0) { test = function () { return true; }; }
if (index === void 0) { index = 0; }
if (test === void 0) {
test = function () {
return true;
};
}
if (index === void 0) {
index = 0;
}
return this.find(function (h) {
return h.type === 'heading' && test(h);
}, index);
};
MDNav.prototype.headings = function (test, index) {
if (test === void 0) { test = function () { return true; }; }
if (index === void 0) { index = 0; }
if (test === void 0) {
test = function () {
return true;
};
}
if (index === void 0) {
index = 0;
}
return this.findAll(function (h) {
return h.type === 'heading' && test(h);
}, index);
};
MDNav.prototype.html = function (test, index) {
if (test === void 0) { test = function () { return true; }; }
if (index === void 0) { index = 0; }
if (test === void 0) {
test = function () {
return true;
};
}
if (index === void 0) {
index = 0;
}
return this.find(function (h) {
return h.type === 'html' && test(h);
}, index);
};
MDNav.prototype.link = function (test, index) {
if (test === void 0) { test = function () { return true; }; }
if (index === void 0) { index = 0; }
if (test === void 0) {
test = function () {
return true;
};
}
if (index === void 0) {
index = 0;
}
return this.find(function (h) {
return h.type === 'link' && test(h);
}, index);
};
MDNav.prototype.links = function (test, index) {
if (test === void 0) { test = function () { return true; }; }
if (index === void 0) { index = 0; }
if (test === void 0) {
test = function () {
return true;
};
}
if (index === void 0) {
index = 0;
}
return this.findAll(function (h) {
return h.type === 'link' && test(h);
}, index);
};
MDNav.prototype.list = function (test, index) {
if (test === void 0) { test = function () { return true; }; }
if (index === void 0) { index = 0; }
if (test === void 0) {
test = function () {
return true;
};
}
if (index === void 0) {
index = 0;
}
return this.find(function (h) {
return h.type === 'list' && test(h);
}, index);
};
MDNav.prototype.listItem = function (test, index) {
if (test === void 0) { test = function () { return true; }; }
if (index === void 0) { index = 0; }
if (test === void 0) {
test = function () {
return true;
};
}
if (index === void 0) {
index = 0;
}
return this.find(function (h) {
return h.type === 'listItem' && test(h);
}, index);
};
MDNav.prototype.listItems = function (test, index) {
if (test === void 0) { test = function () { return true; }; }
if (index === void 0) { index = 0; }
if (test === void 0) {
test = function () {
return true;
};
}
if (index === void 0) {
index = 0;
}
return this.findAll(function (h) {
return h.type === 'listItem' && test(h);
}, index);
};
MDNav.prototype.paragraph = function (test, index) {
if (test === void 0) { test = function () { return true; }; }
if (index === void 0) { index = 0; }
if (test === void 0) {
test = function () {
return true;
};
}
if (index === void 0) {
index = 0;
}
return this.find(function (h) {
return h.type === 'paragraph' && test(h);
}, index);
};
MDNav.prototype.strong = function (test, index) {
if (test === void 0) { test = function () { return true; }; }
if (index === void 0) { index = 0; }
if (test === void 0) {
test = function () {
return true;
};
}
if (index === void 0) {
index = 0;
}
return this.find(function (h) {
return h.type === 'strong' && test(h);
}, index);
};
MDNav.prototype.table = function (test, index) {
if (test === void 0) { test = function () { return true; }; }
if (index === void 0) { index = 0; }
if (test === void 0) {
test = function () {
return true;
};
}
if (index === void 0) {
index = 0;
}
return this.find(function (h) {
return h.type === 'table' && test(h);
}, index);
};
MDNav.prototype.tableRow = function (test, index) {
if (test === void 0) { test = function () { return true; }; }
if (index === void 0) { index = 0; }
if (test === void 0) {
test = function () {
return true;
};
}
if (index === void 0) {
index = 0;
}
return this.find(function (h) {
return h.type === 'tableRow' && test(h);
}, index);
};
MDNav.prototype.tableCell = function (test, index) {
if (test === void 0) { test = function () { return true; }; }
if (index === void 0) { index = 0; }
if (test === void 0) {
test = function () {
return true;
};
}
if (index === void 0) {
index = 0;
}
return this.find(function (h) {
return h.type === 'tableCell' && test(h);
}, index);
};
MDNav.prototype.text = function (test, index) {
if (test === void 0) { test = function () { return true; }; }
if (index === void 0) { index = 0; }
if (test === void 0) {
test = function () {
return true;
};
}
if (index === void 0) {
index = 0;
}
return this.find(function (h) {
return h.type === 'text' && test(h);
}, index);
};
Object.defineProperty(MDNav.prototype, "item", {
Object.defineProperty(MDNav.prototype, 'item', {
get: function () {
if (!this.root || !this.root.children) {
return undefined;
}
else {
} else {
return this.root.children[this.pos];
}
},
enumerable: false,
configurable: true
});
Object.defineProperty(MDNav.prototype, "empty", {
Object.defineProperty(MDNav.prototype, 'empty', {
get: function () {
return !this.root ||
!this.root.children ||
(this.pos >= this.root.children.length);
return !this.root || !this.root.children || this.pos >= this.root.children.length;
},
enumerable: false,
configurable: true
});
Object.defineProperty(MDNav.prototype, "childNav", {
Object.defineProperty(MDNav.prototype, 'childNav', {
get: function () {
return new MDNav(this.item);
},
enumerable: false,
configurable: true
});
Object.defineProperty(MDNav.prototype, "value", {
Object.defineProperty(MDNav.prototype, 'value', {
get: function () {
if (this.item && this.item['value']) {
return this.item.value;
}
else {
} else {
return '';
}
},
enumerable: false,
configurable: true
});
Object.defineProperty(MDNav.prototype, "textValue", {
Object.defineProperty(MDNav.prototype, 'textValue', {
get: function () {
if (this.item) {
if (this.item['value']) {
return this.item.value;
}
else if (this.item.children &&
(this.item.children.length > 0) &&
(this.item.children[0].type === 'text')) {
} else if (this.item.children && this.item.children.length > 0 && this.item.children[0].type === 'text') {
return this.item.children[0].value;
}
else {
} else {
return '';
}
}
else {
} else {
return '';
}
},
@@ -216,5 +325,5 @@ var MDNav = /** @class */ (function () {
configurable: true
});
return MDNav;
}());
})();
exports.MDNav = MDNav;

202
tools/doc/mqDefs.js
View File

@@ -1,24 +1,59 @@
"use strict";
var __extends = (this && this.__extends) || (function () {
var extendStatics = function (d, b) {
extendStatics = Object.setPrototypeOf ||
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
return extendStatics(d, b);
};
return function (d, b) {
if (typeof b !== "function" && b !== null)
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
extendStatics(d, b);
function __() { this.constructor = d; }
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
};
})();
Object.defineProperty(exports, "__esModule", { value: true });
exports.Docset = exports.Text = exports.Link = exports.Paragraph = exports.Heading = exports.Root = exports.Parent = exports.Node = exports.schema = void 0;
var mdToString = require("mdast-util-to-string");
var jsyaml = require("js-yaml");
exports.schema = "\n type Query {\n documents(idFilter: String = \"\"): [Root]\n }\n\n type Root {\n id: ID\n type: String\n folder(depth: Int = 1): String\n metadata(key: String): String\n heading(depth: Int = 0): Heading\n headings(depth: Int = 0): [Heading]\n paragraph: Paragraph\n paragraphs: [Paragraph]\n link: Link\n links: [Link]\n text: Text\n texts: [Text]\n children: [Node]\n }\n\n type Heading {\n depth: Int\n plaintext: String\n paragraph: Paragraph\n paragraphs: [Paragraph]\n link: Link\n links: [Link]\n children: [Node]\n }\n\n type Paragraph {\n plaintext: String\n }\n\n type Link {\n plaintext: String\n title: String\n url: String\n paragraph: Paragraph\n paragraphs: [Paragraph]\n text: Text\n texts: [Text]\n }\n\n type Text {\n value: String\n }\n\n type Node {\n type: String\n children: [Node]\n }\n";
'use strict';
/*!
* @license
* Copyright © 2005-2025 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
var __extends =
(this && this.__extends) ||
(function () {
var extendStatics = function (d, b) {
extendStatics =
Object.setPrototypeOf ||
({ __proto__: [] } instanceof Array &&
function (d, b) {
d.__proto__ = b;
}) ||
function (d, b) {
for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p];
};
return extendStatics(d, b);
};
return function (d, b) {
if (typeof b !== 'function' && b !== null) throw new TypeError('Class extends value ' + String(b) + ' is not a constructor or null');
extendStatics(d, b);
function __() {
this.constructor = d;
}
d.prototype = b === null ? Object.create(b) : ((__.prototype = b.prototype), new __());
};
})();
Object.defineProperty(exports, '__esModule', { value: true });
exports.Docset =
exports.Text =
exports.Link =
exports.Paragraph =
exports.Heading =
exports.Root =
exports.Parent =
exports.Node =
exports.schema =
void 0;
var mdast_util_to_string_1 = require('mdast-util-to-string');
var jsyaml = require('js-yaml');
exports.schema =
'\n type Query {\n documents(idFilter: String = ""): [Root]\n }\n\n type Root {\n id: ID\n type: String\n folder(depth: Int = 1): String\n metadata(key: String): String\n heading(depth: Int = 0): Heading\n headings(depth: Int = 0): [Heading]\n paragraph: Paragraph\n paragraphs: [Paragraph]\n link: Link\n links: [Link]\n text: Text\n texts: [Text]\n children: [Node]\n }\n\n type Heading {\n depth: Int\n plaintext: String\n paragraph: Paragraph\n paragraphs: [Paragraph]\n link: Link\n links: [Link]\n children: [Node]\n }\n\n type Paragraph {\n plaintext: String\n }\n\n type Link {\n plaintext: String\n title: String\n url: String\n paragraph: Paragraph\n paragraphs: [Paragraph]\n text: Text\n texts: [Text]\n }\n\n type Text {\n value: String\n }\n\n type Node {\n type: String\n children: [Node]\n }\n';
var Node = /** @class */ (function () {
function Node(orig) {
this.orig = orig;
@@ -52,56 +87,78 @@ var Node = /** @class */ (function () {
};
Node.prototype.children = function () {
if (this.orig['children']) {
return this.orig['children'].map(function (x) { return new Node(x); });
}
else {
return this.orig['children'].map(function (x) {
return new Node(x);
});
} else {
return null;
}
};
return Node;
}());
})();
exports.Node = Node;
var Parent = /** @class */ (function () {
function Parent(orig) {
this.orig = orig;
}
Parent.prototype.plaintext = function () {
return mdToString(this.orig);
return (0, mdast_util_to_string_1.toString)(this.orig);
};
Parent.prototype.paragraph = function () {
return new Paragraph(this.orig.children.find(function (ch) { return (ch.type === 'paragraph'); }));
return new Paragraph(
this.orig.children.find(function (ch) {
return ch.type === 'paragraph';
})
);
};
Parent.prototype.paragraphs = function () {
return this.orig.children.filter(function (ch) {
return (ch.type === 'paragraph');
})
.map(function (ch) { return new Paragraph(ch); });
return this.orig.children
.filter(function (ch) {
return ch.type === 'paragraph';
})
.map(function (ch) {
return new Paragraph(ch);
});
};
Parent.prototype.link = function () {
return new Link(this.orig.children.find(function (ch) { return (ch.type === 'link'); }));
return new Link(
this.orig.children.find(function (ch) {
return ch.type === 'link';
})
);
};
Parent.prototype.links = function () {
return this.orig.children.filter(function (ch) {
return (ch.type === 'link');
})
.map(function (ch) { return new Link(ch); });
return this.orig.children
.filter(function (ch) {
return ch.type === 'link';
})
.map(function (ch) {
return new Link(ch);
});
};
Parent.prototype.text = function () {
return new Text(this.orig.children.find(function (ch) { return (ch.type === 'text'); }));
return new Text(
this.orig.children.find(function (ch) {
return ch.type === 'text';
})
);
};
Parent.prototype.texts = function () {
return this.orig.children.filter(function (ch) {
return (ch.type === 'text');
})
.map(function (ch) { return new Text(ch); });
return this.orig.children
.filter(function (ch) {
return ch.type === 'text';
})
.map(function (ch) {
return new Text(ch);
});
};
return Parent;
}());
})();
exports.Parent = Parent;
var Root = /** @class */ (function (_super) {
__extends(Root, _super);
function Root() {
return _super !== null && _super.apply(this, arguments) || this;
return (_super !== null && _super.apply(this, arguments)) || this;
}
Root.prototype.type = function () {
return 'root';
@@ -114,62 +171,65 @@ var Root = /** @class */ (function (_super) {
};
Root.prototype.metadata = function (args) {
if (!this._meta) {
var yamlElement = this.orig.children.find(function (ch) { return (ch.type === 'yaml'); });
var yamlElement = this.orig.children.find(function (ch) {
return ch.type === 'yaml';
});
if (yamlElement) {
this._meta = jsyaml.safeLoad(yamlElement.value);
}
else {
} else {
this._meta = {};
}
}
if (this._meta[args['key']]) {
return this._meta[args['key']];
}
else {
} else {
return '';
}
};
Root.prototype.heading = function (args) {
var depth = args['depth'];
return new Heading(this.orig.children.find(function (ch) {
return (ch.type === 'heading') &&
((depth === 0) || (depth === ch.depth));
}));
return new Heading(
this.orig.children.find(function (ch) {
return ch.type === 'heading' && (depth === 0 || depth === ch.depth);
})
);
};
Root.prototype.headings = function (args) {
var depth = args['depth'];
return this.orig.children.filter(function (ch) {
return (ch.type === 'heading') &&
((depth === 0) || (depth === ch.depth));
})
.map(function (ch) { return new Heading(ch); });
return this.orig.children
.filter(function (ch) {
return ch.type === 'heading' && (depth === 0 || depth === ch.depth);
})
.map(function (ch) {
return new Heading(ch);
});
};
return Root;
}(Parent));
})(Parent);
exports.Root = Root;
var Heading = /** @class */ (function (_super) {
__extends(Heading, _super);
function Heading() {
return _super !== null && _super.apply(this, arguments) || this;
return (_super !== null && _super.apply(this, arguments)) || this;
}
Heading.prototype.depth = function () {
return this.orig.depth;
};
return Heading;
}(Parent));
})(Parent);
exports.Heading = Heading;
var Paragraph = /** @class */ (function (_super) {
__extends(Paragraph, _super);
function Paragraph() {
return _super !== null && _super.apply(this, arguments) || this;
return (_super !== null && _super.apply(this, arguments)) || this;
}
return Paragraph;
}(Parent));
})(Parent);
exports.Paragraph = Paragraph;
var Link = /** @class */ (function (_super) {
__extends(Link, _super);
function Link() {
return _super !== null && _super.apply(this, arguments) || this;
return (_super !== null && _super.apply(this, arguments)) || this;
}
Link.prototype.title = function () {
return this.orig.title;
@@ -178,7 +238,7 @@ var Link = /** @class */ (function (_super) {
return this.orig.url;
};
return Link;
}(Parent));
})(Parent);
exports.Link = Link;
var Text = /** @class */ (function () {
function Text(orig) {
@@ -188,7 +248,7 @@ var Text = /** @class */ (function () {
return this.orig.value;
};
return Text;
}());
})();
exports.Text = Text;
var libNamesRegex = /content-services|core|extensions|insights|process-services|process-services-cloud/;
var Docset = /** @class */ (function () {
@@ -197,8 +257,7 @@ var Docset = /** @class */ (function () {
this.docs = [];
var pathnames = Object.keys(mdCache);
pathnames.forEach(function (pathname) {
if (!pathname.match(/README/) &&
pathname.match(libNamesRegex)) {
if (!pathname.match(/README/) && pathname.match(libNamesRegex)) {
var doc = new Root(mdCache[pathname].mdInTree);
doc.id = pathname.replace(/\\/g, '/');
_this.docs.push(doc);
@@ -208,14 +267,15 @@ var Docset = /** @class */ (function () {
Docset.prototype.documents = function (args) {
if (args['idFilter'] === '') {
return this.docs;
}
else {
return this.docs.filter(function (doc) { return doc.id.indexOf(args['idFilter'] + '/') !== -1; });
} else {
return this.docs.filter(function (doc) {
return doc.id.indexOf(args['idFilter'] + '/') !== -1;
});
}
};
Docset.prototype.size = function () {
return this.docs.length;
};
return Docset;
}());
})();
exports.Docset = Docset;

87
tools/doc/sourceInfoClasses.js
View File

@@ -1,11 +1,23 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
'use strict';
/*!
* @license
* Copyright © 2005-2025 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
Object.defineProperty(exports, '__esModule', { value: true });
exports.ComponentInfo = exports.MethodSigInfo = exports.ParamInfo = exports.PropInfo = void 0;
var skipMethodNames = [
'ngOnChanges',
'ngOnDestroy',
'ngOnInit'
];
var skipMethodNames = ['ngOnChanges', 'ngOnDestroy', 'ngOnInit'];
var PropInfo = /** @class */ (function () {
function PropInfo(sourceData) {
var _this = this;
@@ -19,7 +31,9 @@ var PropInfo = /** @class */ (function () {
this.type = sourceData.syntax['return'].type || '';
this.type = this.type.toString().replace(/\|/, '\\|').replace('unknown', '');
if (sourceData.tags) {
var depTag = sourceData.tags.find(function (tag) { return tag.name === 'deprecated'; });
var depTag = sourceData.tags.find(function (tag) {
return tag.name === 'deprecated';
});
if (depTag) {
this.isDeprecated = true;
this.docText = '(**Deprecated:** ' + depTag.text.replace(/[\n\r]+/g, ' ').trim() + ') ' + this.docText;
@@ -33,24 +47,24 @@ var PropInfo = /** @class */ (function () {
_this.isInput = true;
if (dec.arguments) {
var bindingName = dec.arguments['bindingPropertyName'];
if (bindingName && (bindingName !== '')) {
if (bindingName && bindingName !== '') {
_this.name = bindingName.replace(/['"]/g, '');
}
}
if (!_this.docText && !_this.isDeprecated) {
_this.errorMessages.push("Error: Input \"".concat(sourceData.name, "\" has no doc text."));
_this.errorMessages.push('Error: Input "'.concat(sourceData.name, '" has no doc text.'));
}
}
if (dec.name === 'Output') {
_this.isOutput = true;
if (!_this.docText && !_this.isDeprecated) {
_this.errorMessages.push("Error: Output \"".concat(sourceData.name, "\" has no doc text."));
_this.errorMessages.push('Error: Output "'.concat(sourceData.name, '" has no doc text.'));
}
}
});
}
}
Object.defineProperty(PropInfo.prototype, "errors", {
Object.defineProperty(PropInfo.prototype, 'errors', {
get: function () {
return this.errorMessages;
},
@@ -58,7 +72,7 @@ var PropInfo = /** @class */ (function () {
configurable: true
});
return PropInfo;
}());
})();
exports.PropInfo = PropInfo;
var ParamInfo = /** @class */ (function () {
function ParamInfo(sourceData) {
@@ -68,7 +82,9 @@ var ParamInfo = /** @class */ (function () {
this.docText = sourceData.description.replace(/[\n\r]+/g, ' ').trim();
this.isOptional = false;
if (sourceData.flags) {
var flag = sourceData.flags.find(function (sourceFlag) { return sourceFlag.name === 'isOptional'; });
var flag = sourceData.flags.find(function (sourceFlag) {
return sourceFlag.name === 'isOptional';
});
if (flag) {
this.isOptional = true;
}
@@ -77,13 +93,13 @@ var ParamInfo = /** @class */ (function () {
if (this.isOptional) {
this.combined += '?';
}
this.combined += ": `".concat(this.type, "`");
this.combined += ': `'.concat(this.type, '`');
if (this.defaultValue !== '') {
this.combined += " = `".concat(this.defaultValue, "`");
this.combined += ' = `'.concat(this.defaultValue, '`');
}
}
return ParamInfo;
}());
})();
exports.ParamInfo = ParamInfo;
var MethodSigInfo = /** @class */ (function () {
function MethodSigInfo(sourceData) {
@@ -93,21 +109,23 @@ var MethodSigInfo = /** @class */ (function () {
this.docText = sourceData.summary || '';
this.docText = this.docText.replace(/[\n\r]+/g, ' ').trim();
if (!this.docText && this.name.indexOf('service') > 0) {
this.errorMessages.push("Warning: method \"".concat(sourceData.name, "\" has no doc text."));
this.errorMessages.push('Warning: method "'.concat(sourceData.name, '" has no doc text.'));
}
this.returnType = sourceData.syntax['return'].type || '';
this.returnType = this.returnType.toString().replace(/\s/g, '');
this.returnsSomething = this.returnType && (this.returnType !== 'void');
this.returnsSomething = this.returnType && this.returnType !== 'void';
this.returnDocText = sourceData.syntax['return'].summary || '';
if (this.returnDocText.toLowerCase() === 'nothing') {
this.returnsSomething = false;
}
if (this.returnsSomething && !this.returnDocText && this.name.indexOf('service') > 0) {
this.errorMessages.push("Warning: Return value of method \"".concat(sourceData.name, "\" has no doc text."));
this.errorMessages.push('Warning: Return value of method "'.concat(sourceData.name, '" has no doc text.'));
}
this.isDeprecated = false;
if (sourceData.tags) {
var depTag = sourceData.tags.find(function (tag) { return tag.name === 'deprecated'; });
var depTag = sourceData.tags.find(function (tag) {
return tag.name === 'deprecated';
});
if (depTag) {
this.isDeprecated = true;
this.docText = '(**Deprecated:** ' + depTag.text.replace(/[\n\r]+/g, ' ').trim() + ') ' + this.docText;
@@ -118,7 +136,9 @@ var MethodSigInfo = /** @class */ (function () {
if (sourceData.syntax.parameters) {
sourceData.syntax.parameters.forEach(function (rawParam) {
if (rawParam.name && !rawParam.description && !rawParam.name.startWith('on')) {
_this.errorMessages.push("Warning: parameter \"".concat(rawParam.name, "\" of method \"").concat(sourceData.name, "\" has no doc text."));
_this.errorMessages.push(
'Warning: parameter "'.concat(rawParam.name, '" of method "').concat(sourceData.name, '" has no doc text.')
);
}
var param = new ParamInfo(rawParam);
_this.params.push(param);
@@ -127,7 +147,7 @@ var MethodSigInfo = /** @class */ (function () {
}
this.signature = '(' + paramStrings.join(', ') + ')';
}
Object.defineProperty(MethodSigInfo.prototype, "errors", {
Object.defineProperty(MethodSigInfo.prototype, 'errors', {
get: function () {
return this.errorMessages;
},
@@ -135,7 +155,7 @@ var MethodSigInfo = /** @class */ (function () {
configurable: true
});
return MethodSigInfo;
}());
})();
exports.MethodSigInfo = MethodSigInfo;
var ComponentInfo = /** @class */ (function () {
function ComponentInfo(sourceData) {
@@ -166,10 +186,17 @@ var ComponentInfo = /** @class */ (function () {
}
break;
case 'method':
if (item.flags && (item.flags.length > 0) &&
!item.flags.find(function (flag) { return flag.name === 'isPrivate'; }) &&
!item.flags.find(function (flag) { return flag.name === 'isProtected'; }) &&
!skipMethodNames.includes(item.name)) {
if (
item.flags &&
item.flags.length > 0 &&
!item.flags.find(function (flag) {
return flag.name === 'isPrivate';
}) &&
!item.flags.find(function (flag) {
return flag.name === 'isProtected';
}) &&
!skipMethodNames.includes(item.name)
) {
_this.methods.push(new MethodSigInfo(item));
_this.hasMethods = true;
}
@@ -179,7 +206,7 @@ var ComponentInfo = /** @class */ (function () {
}
});
}
Object.defineProperty(ComponentInfo.prototype, "errors", {
Object.defineProperty(ComponentInfo.prototype, 'errors', {
get: function () {
var combinedErrors = [];
this.methods.forEach(function (method) {
@@ -198,5 +225,5 @@ var ComponentInfo = /** @class */ (function () {
configurable: true
});
return ComponentInfo;
}());
})();
exports.ComponentInfo = ComponentInfo;

57
tools/doc/tools/fileChecker.js
View File

@@ -1,11 +1,27 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.processDocs = void 0;
var path = require("path");
var fs = require("fs");
var unist_util_select_1 = require("unist-util-select");
var lev = require("fast-levenshtein");
var ngHelpers = require("../ngHelpers");
'use strict';
/*!
* @license
* Copyright © 2005-2025 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
Object.defineProperty(exports, '__esModule', { value: true });
exports.processDocs = processDocs;
var path = require('path');
var fs = require('fs');
var unist_util_select_1 = require('unist-util-select');
var lev = require('fast-levenshtein');
var ngHelpers = require('../ngHelpers');
var imageFolderPath = path.resolve('docs', 'docassets', 'images');
// Using this value for the edit distance between Markdown image URLs
// and filenames is enough to trap errors like missing out the 'images'
@@ -27,8 +43,7 @@ function processDocs(mdCache, aggData) {
if (!filterFilepath(filters, pathname)) {
classlessDocs.push(pathname);
}
}
else {
} else {
var linkElems = (0, unist_util_select_1.selectAll)('link', tree);
linkElems.forEach(function (linkElem) {
var normUrl = normaliseLinkPath(pathname, linkElem.url);
@@ -46,11 +61,11 @@ function processDocs(mdCache, aggData) {
});
classlessDocs.forEach(function (docPath) {
var relDocPath = docPath.substring(docPath.indexOf('docs'));
console.group("Warning: no source class found for \"".concat(relDocPath, "\""));
console.group('Warning: no source class found for "'.concat(relDocPath, '"'));
if (linkRefs[docPath]) {
linkRefs[docPath].forEach(function (linkRef) {
var relLinkPath = linkRef.substring(linkRef.indexOf('docs'));
console.log("Linked from: \"".concat(relLinkPath, "\""));
console.log('Linked from: "'.concat(relLinkPath, '"'));
});
}
console.groupEnd();
@@ -60,7 +75,7 @@ function processDocs(mdCache, aggData) {
imagePaths.forEach(function (imagePath) {
if (!imageRefs[imagePath]) {
var relImagePath = imagePath.substring(imagePath.indexOf('docs'));
console.log("Warning: no links to image file \"".concat(relImagePath, "\""));
console.log('Warning: no links to image file "'.concat(relImagePath, '"'));
}
});
console.log();
@@ -68,27 +83,30 @@ function processDocs(mdCache, aggData) {
brokenImUrls.forEach(function (url) {
var relUrl = url.substring(url.indexOf('docs'));
var relDocPath = brokenImageRefs[url].substring(brokenImageRefs[url].indexOf('docs'));
console.group("Broken image link \"".concat(relUrl, "\" found in \"").concat(relDocPath));
console.group('Broken image link "'.concat(relUrl, '" found in "').concat(relDocPath));
imagePaths.forEach(function (imPath) {
if (lev.get(imPath, url) <= maxImagePathLevDistance) {
var relImPath = imPath.substring(imPath.indexOf('docs'));
console.log("Should it be \"".concat(relImPath, "\"?"));
console.log('Should it be "'.concat(relImPath, '"?'));
}
});
console.groupEnd();
});
}
exports.processDocs = processDocs;
function normaliseLinkPath(homeFilePath, linkUrl) {
var homeFolder = path.dirname(homeFilePath);
return path.resolve(homeFolder, linkUrl);
}
function getImagePaths(imageFolder) {
var files = fs.readdirSync(imageFolder);
return files.map(function (f) { return path.resolve(imageFolder, f); });
return files.map(function (f) {
return path.resolve(imageFolder, f);
});
}
function makeFilepathFilters(patterns) {
return patterns.map(function (r) { return new RegExp(r); });
return patterns.map(function (r) {
return new RegExp(r);
});
}
function filterFilepath(filters, filepath) {
for (var i = 0; i < filters.length; i++) {
@@ -101,8 +119,7 @@ function filterFilepath(filters, filepath) {
function multiSetAdd(container, key, value) {
if (container[key]) {
container[key].push(value);
}
else {
} else {
container[key] = [value];
}
}

57
tools/doc/tools/gqIndex.js
View File

@@ -1,19 +1,33 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.processDocs = void 0;
var fs = require("fs");
var path = require("path");
var ejs = require("ejs");
var remark = require("remark");
var frontMatter = require("remark-frontmatter");
var replaceZone = require("mdast-zone");
var graphql_1 = require("graphql");
var MQ = require("../mqDefs");
var libNamesList = [
'content-services', 'core', 'extensions',
'insights', 'process-services', 'process-services-cloud'
];
var query = "\n query libIndex($libName: String) {\n documents(idFilter: $libName) {\n title: metadata(key: \"Title\")\n status: metadata(key: \"Status\")\n id\n classType: folder(depth: 2)\n heading {\n link {\n url\n }\n }\n paragraph {\n plaintext\n }\n }\n }\n";
'use strict';
/*!
* @license
* Copyright © 2005-2025 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
Object.defineProperty(exports, '__esModule', { value: true });
exports.processDocs = processDocs;
var fs = require('fs');
var path = require('path');
var ejs = require('ejs');
var remark = require('remark');
var frontMatter = require('remark-frontmatter');
var replaceZone = require('mdast-zone');
var graphql_1 = require('graphql');
var MQ = require('../mqDefs');
var libNamesList = ['content-services', 'core', 'extensions', 'insights', 'process-services', 'process-services-cloud'];
var query =
'\n query libIndex($libName: String) {\n documents(idFilter: $libName) {\n title: metadata(key: "Title")\n status: metadata(key: "Status")\n id\n classType: folder(depth: 2)\n heading {\n link {\n url\n }\n }\n paragraph {\n plaintext\n }\n }\n }\n';
function processDocs(mdCache, aggData) {
var docset = new MQ.Docset(mdCache);
var templateFilePath = path.resolve(__dirname, '..', 'templates', 'gqIndex.ejs');
@@ -21,17 +35,13 @@ function processDocs(mdCache, aggData) {
var template = ejs.compile(templateSource);
var indexFilePath = path.resolve(aggData['rootFolder'], 'docs', 'README.md');
var indexFileText = fs.readFileSync(indexFilePath, 'utf8');
var indexMD = remark()
.use(frontMatter, ['yaml'])
.parse(indexFileText);
var indexMD = remark().use(frontMatter, ['yaml']).parse(indexFileText);
var schema = (0, graphql_1.buildSchema)(MQ.schema);
libNamesList.forEach(function (libName) {
(0, graphql_1.graphql)(schema, query, docset, null, { 'libName': libName })
.then(function (response) {
(0, graphql_1.graphql)(schema, query, docset, null, { libName: libName }).then(function (response) {
if (!response['data']) {
console.log(JSON.stringify(response));
}
else {
} else {
// console.log(template(response['data']));
var newSection_1 = remark().parse(template(response['data'])).children;
replaceZone(indexMD, libName, function (start, _oldZone, end) {
@@ -48,4 +58,3 @@ function processDocs(mdCache, aggData) {
});
});
}
exports.processDocs = processDocs;

59
tools/doc/tools/linkFixer.js
View File

@@ -1,9 +1,25 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.processDocs = void 0;
var path = require("path");
var fs = require("fs");
var unist_util_select_1 = require("unist-util-select");
'use strict';
/*!
* @license
* Copyright © 2005-2025 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
Object.defineProperty(exports, '__esModule', { value: true });
exports.processDocs = processDocs;
var path = require('path');
var fs = require('fs');
var unist_util_select_1 = require('unist-util-select');
var suffixesNotToCheck = /\.ts/;
function processDocs(mdCache, aggData) {
var pathnames = Object.keys(mdCache);
@@ -16,7 +32,6 @@ function processDocs(mdCache, aggData) {
fixUrls(tree, pathname, imageSet, 'image');
});
}
exports.processDocs = processDocs;
function fixUrls(tree, docFilePath, linkSet, selector) {
var linksInDoc = (0, unist_util_select_1.selectAll)(selector, tree);
var errors = [];
@@ -28,20 +43,22 @@ function fixUrls(tree, docFilePath, linkSet, selector) {
anchor = origFullUrlPath.substring(hashPos);
origFullUrlPath = origFullUrlPath.substring(0, hashPos);
}
if (!linkElem.url.match(/http:|https:|ftp:|mailto:/) &&
if (
!linkElem.url.match(/http:|https:|ftp:|mailto:/) &&
!path.extname(origFullUrlPath).match(suffixesNotToCheck) &&
(origFullUrlPath !== '') &&
!fs.existsSync(origFullUrlPath)) {
origFullUrlPath !== '' &&
!fs.existsSync(origFullUrlPath)
) {
var newUrl = linkSet.update(origFullUrlPath) || origFullUrlPath;
linkElem.url = path.relative(path.dirname(docFilePath), newUrl).replace(/\\/g, '/') + anchor;
errors.push("Bad link: ".concat(origFullUrlPath, "\nReplacing with ").concat(linkElem.url));
errors.push('Bad link: '.concat(origFullUrlPath, '\nReplacing with ').concat(linkElem.url));
} /*else {
console.log(`Link OK: ${origFullUrlPath}`);
}
*/
});
if (errors.length > 0) {
showMessages("File: ".concat(docFilePath, ":"), errors);
showMessages('File: '.concat(docFilePath, ':'), errors);
}
}
function showMessages(groupName, messages) {
@@ -52,8 +69,9 @@ function showMessages(groupName, messages) {
console.groupEnd();
}
function getImagePaths(imageFolderPath) {
return fs.readdirSync(imageFolderPath)
.map(function (imageFileName) { return path.resolve(imageFolderPath, imageFileName); });
return fs.readdirSync(imageFolderPath).map(function (imageFileName) {
return path.resolve(imageFolderPath, imageFileName);
});
}
var LinkSet = /** @class */ (function () {
function LinkSet(urls) {
@@ -64,8 +82,7 @@ var LinkSet = /** @class */ (function () {
if (_this.links.has(fileName)) {
var item = _this.links.get(fileName);
item.push(url);
}
else {
} else {
_this.links.set(fileName, [url]);
}
});
@@ -74,17 +91,15 @@ var LinkSet = /** @class */ (function () {
var oldFileName = path.basename(oldUrl);
if (!this.links.has(oldFileName)) {
return '';
}
else {
} else {
var candidates = this.links.get(oldFileName);
if (candidates.length === 1) {
return candidates[0];
}
else {
console.log("Multiple candidates for ".concat(oldUrl));
} else {
console.log('Multiple candidates for '.concat(oldUrl));
return '';
}
}
};
return LinkSet;
}());
})();

42
tools/doc/tools/sourceLinker.js
View File

@@ -1,9 +1,25 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.processDocs = void 0;
var path = require("path");
var unist_util_select_1 = require("unist-util-select");
var ngHelpers = require("../ngHelpers");
'use strict';
/*!
* @license
* Copyright © 2005-2025 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
Object.defineProperty(exports, '__esModule', { value: true });
exports.processDocs = processDocs;
var path = require('path');
var unist_util_select_1 = require('unist-util-select');
var ngHelpers = require('../ngHelpers');
var angFilenameRegex = /([a-zA-Z0-9\-]+)\.((component)|(dialog)|(directive)|(interface)|(model)|(pipe)|(service)|(widget))/;
function processDocs(mdCache, aggData) {
var pathnames = Object.keys(mdCache);
@@ -23,23 +39,21 @@ function processDocs(mdCache, aggData) {
var titleText = titleHeading.children[0];
titleHeading.children[0] = {
type: 'link',
url: srcUrl,
title: "Defined in ".concat(path.basename(sourcePath)),
url: srcUrl, // `../../${sourcePath}`,
title: 'Defined in '.concat(path.basename(sourcePath)),
children: [titleText]
};
}
else if ((titleHeading && titleHeading.children[0].type === 'link') && sourcePath) {
} else if (titleHeading && titleHeading.children[0].type === 'link' && sourcePath) {
var linkElem = titleHeading.children[0];
linkElem.url = srcUrl, // `../../${sourcePath}`;
linkElem.title = "Defined in ".concat(path.basename(sourcePath));
((linkElem.url = srcUrl), // `../../${sourcePath}`;
(linkElem.title = 'Defined in '.concat(path.basename(sourcePath))));
}
});
}
exports.processDocs = processDocs;
function fixRelSrcUrl(docPath, srcPath) {
var docPathSegments = docPath.split(/[\\\/]/);
var dotPathPart = '';
for (var i = 0; i < (docPathSegments.length - 1); i++) {
for (var i = 0; i < docPathSegments.length - 1; i++) {
dotPathPart += '../';
}
return dotPathPart + srcPath;

134
tools/doc/tools/tsInfo.js
View File

@@ -1,20 +1,36 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.processDocs = void 0;
var fs = require("fs");
var path = require("path");
var replaceSection = require("mdast-util-heading-range");
var remark = require("remark");
var ejs = require("ejs");
var mdNav_1 = require("../mdNav");
var ngHelpers_1 = require("../ngHelpers");
'use strict';
/*!
* @license
* Copyright © 2005-2025 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
Object.defineProperty(exports, '__esModule', { value: true });
exports.processDocs = processDocs;
var fs = require('fs');
var path = require('path');
var replaceSection = require('mdast-util-heading-range');
var remark = require('remark');
var ejs = require('ejs');
var mdNav_1 = require('../mdNav');
var ngHelpers_1 = require('../ngHelpers');
var templateFolder = path.resolve('tools', 'doc', 'templates');
var nameExceptions;
function processDocs(mdCache, aggData) {
nameExceptions = aggData.config.typeNameExceptions;
var pathnames = Object.keys(mdCache);
var pathNames = Object.keys(mdCache);
var internalErrors;
pathnames.forEach(function (pathname) {
pathNames.forEach(function (pathname) {
internalErrors = [];
updateFile(mdCache[pathname].mdOutTree, pathname, aggData, internalErrors);
if (internalErrors.length > 0) {
@@ -22,7 +38,6 @@ function processDocs(mdCache, aggData) {
}
});
}
exports.processDocs = processDocs;
function showErrors(filename, errorMessages) {
console.log(filename);
errorMessages.forEach(function (message) {
@@ -48,7 +63,7 @@ function updateFile(tree, pathname, aggData, errorMessages) {
var templateSource = fs.readFileSync(templateName, 'utf8');
var template = ejs.compile(templateSource);
var mdText = template(compData);
mdText = mdText.replace(/^ +\|/mg, '|');
mdText = mdText.replace(/^ +\|/gm, '|');
var newSection_1 = remark().parse(mdText.trim()).children;
replaceSection(tree, 'Class members', function (before, section, after) {
newSection_1.unshift(before);
@@ -64,94 +79,86 @@ function updateFile(tree, pathname, aggData, errorMessages) {
function getPropDocsFromMD(tree, sectionHeading, docsColumn) {
var result = {};
var nav = new mdNav_1.MDNav(tree);
var classMemHeading = nav
.heading(function (h) {
return (h.children[0].type === 'text') && (h.children[0].value === 'Class members');
var classMemHeading = nav.heading(function (h) {
return h.children[0].type === 'text' && h.children[0].value === 'Class members';
});
var propsTable = classMemHeading
.heading(function (h) {
return (h.children[0].type === 'text') && (h.children[0].value === sectionHeading);
}).table();
var propTableRow = propsTable.childNav
.tableRow(function () { return true; }, 1).childNav;
return h.children[0].type === 'text' && h.children[0].value === sectionHeading;
})
.table();
var propTableRow = propsTable.childNav.tableRow(function () {
return true;
}, 1).childNav;
var i = 1;
while (!propTableRow.empty) {
var propName = propTableRow
.tableCell().childNav
.text().item.value;
var propName = propTableRow.tableCell().childNav.text().item.value;
var propDocText = propTableRow
.tableCell(function () { return true; }, docsColumn).childNav
.text().item;
.tableCell(function () {
return true;
}, docsColumn)
.childNav.text().item;
if (propDocText) {
result[propName] = propDocText.value;
}
i++;
propTableRow = propsTable.childNav
.tableRow(function () { return true; }, i).childNav;
propTableRow = propsTable.childNav.tableRow(function () {
return true;
}, i).childNav;
}
return result;
}
function getMethodDocsFromMD(tree) {
var result = {};
var nav = new mdNav_1.MDNav(tree);
var classMemHeading = nav
.heading(function (h) {
return (h.children[0].type === 'text') && (h.children[0].value === 'Class members');
var classMemHeading = nav.heading(function (h) {
return h.children[0].type === 'text' && h.children[0].value === 'Class members';
});
var methListItems = classMemHeading
.heading(function (h) {
return (h.children[0].type === 'text') && (h.children[0].value === 'Methods');
}).list().childNav;
var methItem = methListItems
.listItem();
return h.children[0].type === 'text' && h.children[0].value === 'Methods';
})
.list().childNav;
var methItem = methListItems.listItem();
var i = 0;
while (!methItem.empty) {
var methNameSection = methItem.childNav
.paragraph().childNav
.strong().childNav;
var methNameSection = methItem.childNav.paragraph().childNav.strong().childNav;
var methName = '';
// Method docs must be in "new" format with names and types styled separately.
if (!methNameSection.empty) {
methName = methNameSection.text().item.value;
var methDoc = methItem.childNav
.paragraph().childNav
.html()
.text().value;
var methDoc = methItem.childNav.paragraph().childNav.html().text().value;
var params = getMDMethodParams(methItem);
result[methName] = {
'docText': methDoc.replace(/^\n/, ''),
'params': params
docText: methDoc.replace(/^\n/, ''),
params: params
};
}
i++;
methItem = methListItems
.listItem(function (l) { return true; }, i);
methItem = methListItems.listItem(function (l) {
return true;
}, i);
}
return result;
}
function getMDMethodParams(methItem) {
var result = {};
var paramList = methItem.childNav.list().childNav;
var paramListItems = paramList
.listItems();
var paramListItems = paramList.listItems();
paramListItems.forEach(function (paramListItem) {
var paramNameNode = paramListItem.childNav
.paragraph().childNav
.emph().childNav;
var paramNameNode = paramListItem.childNav.paragraph().childNav.emph().childNav;
var paramName;
if (!paramNameNode.empty) {
paramName = paramNameNode.text().item.value.replace(/:/, '');
}
else {
var item = paramListItem.childNav.paragraph().childNav
.strong().childNav.text();
} else {
var item = paramListItem.childNav.paragraph().childNav.strong().childNav.text();
if (paramName) {
paramName = item.value;
}
}
var paramDoc = paramListItem.childNav
.paragraph().childNav
.text(function (t) { return true; }, 1).value; // item.value;
var paramDoc = paramListItem.childNav.paragraph().childNav.text(function (t) {
return true;
}, 1).value; // item.value;
result[paramName] = paramDoc.replace(/^[ -]+/, '');
});
return result;
@@ -161,14 +168,13 @@ function updatePropDocsFromMD(comp, inputDocs, outputDocs, errorMessages) {
var propMDDoc;
if (prop.isInput) {
propMDDoc = inputDocs[prop.name];
}
else if (prop.isOutput) {
} else if (prop.isOutput) {
propMDDoc = outputDocs[prop.name];
}
// If JSDocs are empty but MD docs aren't then the Markdown is presumably more up-to-date.
if (!prop.docText && propMDDoc) {
prop.docText = propMDDoc;
errorMessages.push("Warning: empty JSDocs for property \"".concat(prop.name, "\" may need sync with the .md file."));
errorMessages.push('Warning: empty JSDocs for property "'.concat(prop.name, '" may need sync with the .md file.'));
}
});
}
@@ -178,12 +184,14 @@ function updateMethodDocsFromMD(comp, methodDocs, errorMessages) {
// If JSDocs are empty but MD docs aren't then the Markdown is presumably more up-to-date.
if (!meth.docText && currMethMD && currMethMD.docText) {
meth.docText = currMethMD.docText;
errorMessages.push("Warning: empty JSDocs for method sig \"".concat(meth.name, "\" may need sync with the .md file."));
errorMessages.push('Warning: empty JSDocs for method sig "'.concat(meth.name, '" may need sync with the .md file.'));
}
meth.params.forEach(function (param) {
if (!param.docText && currMethMD && currMethMD.params[param.name]) {
param.docText = currMethMD.params[param.name];
errorMessages.push("Warning: empty JSDocs for parameter \"".concat(param.name, " (").concat(meth.name, ")\" may need sync with the .md file."));
errorMessages.push(
'Warning: empty JSDocs for parameter "'.concat(param.name, ' (').concat(meth.name, ')" may need sync with the .md file.')
);
}
});
});

68
tools/doc/tools/tutorialIndex.js
View File

@@ -1,28 +1,43 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.processDocs = void 0;
var fs = require("fs");
var path = require("path");
var replaceSection = require("mdast-util-heading-range");
var remark = require("remark");
var frontMatter = require("remark-frontmatter");
var yaml = require("js-yaml");
var ejs = require("ejs");
var unist = require("../unistHelpers");
'use strict';
/*!
* @license
* Copyright © 2005-2025 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
Object.defineProperty(exports, '__esModule', { value: true });
exports.processDocs = processDocs;
var fs = require('fs');
var path = require('path');
var replaceSection = require('mdast-util-heading-range');
var remark = require('remark');
var frontMatter = require('remark-frontmatter');
var yaml = require('js-yaml');
var ejs = require('ejs');
var unist = require('../unistHelpers');
var tutFolder = path.resolve('docs', 'tutorials');
var templateFolder = path.resolve('tools', 'doc', 'templates');
var userGuideFolder = path.resolve('docs', 'user-guide');
function processDocs() {
aggPhase();
}
exports.processDocs = processDocs;
function aggPhase() {
var indexDocData = getIndexDocData();
var templateName = path.resolve(templateFolder, 'tutIndex.ejs');
var templateSource = fs.readFileSync(templateName, 'utf8');
var template = ejs.compile(templateSource);
var mdText = template(indexDocData);
mdText = mdText.replace(/^ +\|/mg, '|');
mdText = mdText.replace(/^ +\|/gm, '|');
var newSection = remark().use(frontMatter, ['yaml']).data('settings', { paddedTable: false, gfm: false }).parse(mdText.trim()).children;
var tutIndexFile = path.resolve(tutFolder, 'README.md');
var tutIndexText = fs.readFileSync(tutIndexFile, 'utf8');
@@ -32,7 +47,10 @@ function aggPhase() {
newSection.push(after);
return newSection;
});
fs.writeFileSync(tutIndexFile, remark().use(frontMatter, { type: 'yaml', fence: '---' }).data('settings', { paddedTable: false, gfm: false }).stringify(tutIndexMD));
fs.writeFileSync(
tutIndexFile,
remark().use(frontMatter, { type: 'yaml', fence: '---' }).data('settings', { paddedTable: false, gfm: false }).stringify(tutIndexMD)
);
}
function getIndexDocData() {
var indexFile = path.resolve(userGuideFolder, 'summary.json');
@@ -54,22 +72,19 @@ function getIndexDocData() {
var metadata = getDocMetadata(tutMD);
if (metadata['Level']) {
tutData['level'] = metadata['Level'];
}
else {
} else {
tutData['level'] = '';
}
var briefDesc = getFirstParagraph(tutMD);
var briefDescText = remark()
tutData['briefDesc'] = remark()
.use(frontMatter, { type: 'yaml', fence: '---' })
.data('settings', { paddedTable: false, gfm: false })
.stringify(briefDesc);
tutData['briefDesc'] = briefDescText;
var title = getFirstHeading(tutMD);
var titleText = remark()
tutData['title'] = remark()
.use(frontMatter, { type: 'yaml', fence: '---' })
.data('settings', { paddedTable: false, gfm: false })
.stringify(title.children[0]);
tutData['title'] = titleText;
result.tuts.push(tutData);
});
return result;
@@ -77,28 +92,25 @@ function getIndexDocData() {
function getDocMetadata(tree) {
if (tree.children[0].type === 'yaml') {
return yaml.load(tree.children[0].value);
}
else {
} else {
return {};
}
}
function getFirstParagraph(tree) {
var s = 0;
for (; (s < tree.children.length) && !unist.isParagraph(tree.children[s]); s++) { }
for (; s < tree.children.length && !unist.isParagraph(tree.children[s]); s++) {}
if (s < tree.children.length) {
return tree.children[s];
}
else {
} else {
return null;
}
}
function getFirstHeading(tree) {
var s = 0;
for (; (s < tree.children.length) && !unist.isHeading(tree.children[s]); s++) { }
for (; s < tree.children.length && !unist.isHeading(tree.children[s]); s++) {}
if (s < tree.children.length) {
return tree.children[s];
}
else {
} else {
return null;
}
}

154
tools/doc/tools/typeLinker.js
View File

@@ -1,22 +1,50 @@
"use strict";
var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
if (ar || !(i in from)) {
if (!ar) ar = Array.prototype.slice.call(from, 0, i);
ar[i] = from[i];
}
}
return to.concat(ar || Array.prototype.slice.call(from));
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.processDocs = void 0;
var path = require("path");
var unist = require("../unistHelpers");
var ngHelpers = require("../ngHelpers");
'use strict';
/*!
* @license
* Copyright © 2005-2025 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
var __spreadArray =
(this && this.__spreadArray) ||
function (to, from, pack) {
if (pack || arguments.length === 2)
for (var i = 0, l = from.length, ar; i < l; i++) {
if (ar || !(i in from)) {
if (!ar) ar = Array.prototype.slice.call(from, 0, i);
ar[i] = from[i];
}
}
return to.concat(ar || Array.prototype.slice.call(from));
};
Object.defineProperty(exports, '__esModule', { value: true });
exports.processDocs = processDocs;
var path = require('path');
var unist = require('../unistHelpers');
var ngHelpers = require('../ngHelpers');
var includedNodeTypes = [
'root', 'paragraph', 'inlineCode', 'list', 'listItem',
'table', 'tableRow', 'tableCell', 'emphasis', 'strong',
'link', 'text'
'root',
'paragraph',
'inlineCode',
'list',
'listItem',
'table',
'tableRow',
'tableCell',
'emphasis',
'strong',
'link',
'text'
];
var externalNameLinks;
var linkOverrides;
@@ -28,7 +56,6 @@ function processDocs(mdCache, aggData) {
updateFile(mdCache[pathname].mdOutTree, pathname, aggData);
});
}
exports.processDocs = processDocs;
function initPhase(aggData, mdCache) {
externalNameLinks = aggData.config.externalNameLinks;
ignoreLinkWords = aggData.config.ignoreLinkWords;
@@ -59,8 +86,7 @@ function updateFile(tree, pathname, aggData) {
return;
}
if (node.type === 'link') {
if (node.children[0] && ((node.children[0].type === 'inlineCode') ||
(node.children[0].type === 'text'))) {
if (node.children[0] && (node.children[0].type === 'inlineCode' || node.children[0].type === 'text')) {
if (!ignoreLinkWords.includes(node.children[0].value)) {
var link = resolveTypeLink(aggData, pathname, node.children[0].value);
if (link) {
@@ -68,15 +94,13 @@ function updateFile(tree, pathname, aggData) {
}
}
}
}
else if ((node.children) && (node.type !== 'heading')) {
} else if (node.children && node.type !== 'heading') {
node.children.forEach(function (child, index) {
var _a;
if ((child.type === 'text') || (child.type === 'inlineCode')) {
if (child.type === 'text' || child.type === 'inlineCode') {
var newNodes = handleLinksInBodyText(aggData, pathname, child.value, child.type === 'inlineCode');
(_a = node.children).splice.apply(_a, __spreadArray([index, 1], newNodes, false));
}
else {
} else {
traverseMDTree(child);
}
});
@@ -85,8 +109,12 @@ function updateFile(tree, pathname, aggData) {
}
var SplitNameNode = /** @class */ (function () {
function SplitNameNode(key, value) {
if (key === void 0) { key = ''; }
if (value === void 0) { value = ''; }
if (key === void 0) {
key = '';
}
if (value === void 0) {
value = '';
}
this.key = key;
this.value = value;
this.children = {};
@@ -95,21 +123,21 @@ var SplitNameNode = /** @class */ (function () {
this.children[child.key] = child;
};
return SplitNameNode;
}());
})();
var SplitNameMatchElement = /** @class */ (function () {
function SplitNameMatchElement(node, textPos) {
this.node = node;
this.textPos = textPos;
}
return SplitNameMatchElement;
}());
})();
var SplitNameMatchResult = /** @class */ (function () {
function SplitNameMatchResult(value, startPos) {
this.value = value;
this.startPos = startPos;
}
return SplitNameMatchResult;
}());
})();
var SplitNameMatcher = /** @class */ (function () {
function SplitNameMatcher(root) {
this.root = root;
@@ -125,29 +153,25 @@ var SplitNameMatcher = /** @class */ (function () {
if (child) {
if (child.value) {
/* Using unshift to add the match to the array means that
* the longest matches will appear first in the array.
* User can then just use the first array element if only
* the longest match is needed.
*/
* the longest matches will appear first in the array.
* User can then just use the first array element if only
* the longest match is needed.
*/
result.unshift(new SplitNameMatchResult(child.value, this.matches[i].textPos));
this.matches.splice(i, 1);
}
else {
} else {
this.matches[i] = new SplitNameMatchElement(child, this.matches[i].textPos);
}
}
else {
} else {
this.matches.splice(i, 1);
}
}
else {
} else {
this.matches.splice(i, 1);
}
}
if (result === []) {
return null;
}
else {
} else {
return result;
}
};
@@ -155,7 +179,7 @@ var SplitNameMatcher = /** @class */ (function () {
this.matches = [];
};
return SplitNameMatcher;
}());
})();
var SplitNameLookup = /** @class */ (function () {
function SplitNameLookup() {
this.root = new SplitNameNode();
@@ -166,7 +190,7 @@ var SplitNameLookup = /** @class */ (function () {
var currNode = this.root;
segments.forEach(function (segment, index) {
var value = '';
if (index === (segments.length - 1)) {
if (index === segments.length - 1) {
value = name;
}
var childNode = currNode.children[segment];
@@ -178,7 +202,7 @@ var SplitNameLookup = /** @class */ (function () {
});
};
return SplitNameLookup;
}());
})();
var WordScanner = /** @class */ (function () {
function WordScanner(text) {
this.text = text;
@@ -214,9 +238,11 @@ var WordScanner = /** @class */ (function () {
this.index = this.text.length;
};
return WordScanner;
}());
})();
function handleLinksInBodyText(aggData, docFilePath, text, wrapInlineCode) {
if (wrapInlineCode === void 0) { wrapInlineCode = false; }
if (wrapInlineCode === void 0) {
wrapInlineCode = false;
}
var result = [];
var currTextStart = 0;
var matcher = new SplitNameMatcher(aggData.nameLookup.root);
@@ -234,8 +260,7 @@ function handleLinksInBodyText(aggData, docFilePath, text, wrapInlineCode) {
link = resolveTypeLink(aggData, docFilePath, match[0].value);
matchStart = match[0].startPos;
}
}
else {
} else {
matchStart = scanner.index;
}
if (link) {
@@ -243,8 +268,7 @@ function handleLinksInBodyText(aggData, docFilePath, text, wrapInlineCode) {
var linkTitle = void 0;
if (wrapInlineCode) {
linkTitle = unist.makeInlineCode(linkText);
}
else {
} else {
linkTitle = unist.makeText(linkText);
}
var linkNode = unist.makeLink(linkTitle, link);
@@ -252,8 +276,7 @@ function handleLinksInBodyText(aggData, docFilePath, text, wrapInlineCode) {
if (prevText) {
if (wrapInlineCode) {
result.push(unist.makeInlineCode(prevText));
}
else {
} else {
result.push(unist.makeText(prevText));
}
}
@@ -267,8 +290,7 @@ function handleLinksInBodyText(aggData, docFilePath, text, wrapInlineCode) {
if (remainingText) {
if (wrapInlineCode) {
result.push(unist.makeInlineCode(remainingText));
}
else {
} else {
result.push(unist.makeText(remainingText));
}
}
@@ -282,11 +304,9 @@ function resolveTypeLink(aggData, docFilePath, text) {
var classInfo = aggData.classInfo[possTypeName];
if (linkOverrides[possTypeName.toLowerCase()]) {
return '';
}
else if (externalNameLinks[possTypeName]) {
} else if (externalNameLinks[possTypeName]) {
return externalNameLinks[possTypeName];
}
else if (classInfo) {
} else if (classInfo) {
var kebabName = ngHelpers.kebabifyClassName(possTypeName);
var possDocFile = aggData.docFiles[kebabName];
var url = fixRelSrcUrl(docFilePath, classInfo.sourcePath);
@@ -294,8 +314,7 @@ function resolveTypeLink(aggData, docFilePath, text) {
url = fixRelDocUrl(docFilePath, possDocFile);
}
return url;
}
else {
} else {
return '';
}
}
@@ -303,7 +322,7 @@ function fixRelSrcUrl(docPath, srcPath) {
var relDocPath = docPath.substring(docPath.indexOf('docs'));
var docPathSegments = relDocPath.split(/[\\\/]/);
var dotPathPart = '';
for (var i = 0; i < (docPathSegments.length - 1); i++) {
for (var i = 0; i < docPathSegments.length - 1; i++) {
dotPathPart += '../';
}
return dotPathPart + srcPath;
@@ -312,7 +331,7 @@ function fixRelDocUrl(docPathFrom, docPathTo) {
var relDocPathFrom = docPathFrom.substring(docPathFrom.indexOf('docs'));
var docPathSegments = relDocPathFrom.split(/[\\\/]/);
var dotPathPart = '';
for (var i = 0; i < (docPathSegments.length - 2); i++) {
for (var i = 0; i < docPathSegments.length - 2; i++) {
dotPathPart += '../';
}
return dotPathPart + docPathTo;
@@ -321,13 +340,14 @@ function cleanTypeName(text) {
var matches = text.match(/[a-zA-Z0-9_]+<([a-zA-Z0-9_]+)(\[\])?>/);
if (matches) {
return matches[1];
}
else {
} else {
return text.replace(/\[\]$/, '');
}
}
function convertNodeToTypeLink(node, text, url, title) {
if (title === void 0) { title = null; }
if (title === void 0) {
title = null;
}
var linkDisplayText = unist.makeInlineCode(text);
node.type = 'link';
node.title = title;