@rsdk/tsconfig 2.4.2 → 3.0.2

package/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.0.2](https://github.com/R-Vision/rsdk/compare/v3.0.1...v3.0.2) (2023-08-07)
+
+**Note:** Version bump only for package @rsdk/tsconfig
+
+## [3.0.0](https://github.com/R-Vision/rsdk/compare/v3.0.0-next.0...v3.0.0) (2023-08-04)
+
+**Note:** Version bump only for package @rsdk/tsconfig
+
+# [2.6.0-next.15](https://github.com/R-Vision/rsdk/compare/v2.6.0-next.14...v2.6.0-next.15) (2023-08-04)
+
+**Note:** Version bump only for package @rsdk/tsconfig
+
 ## [2.4.2](https://github.com/R-Vision/rsdk/compare/v2.4.2-next.0...v2.4.2) (2023-06-16)
 
 **Note:** Version bump only for package @rsdk/tsconfig

package/dist/autodoc-metadata.d.ts

@@ -0,0 +1,14 @@
+import type { RsdkMetadata } from '@rsdk/metadata';
+import type { DocumentResolver } from './types';
+declare class MetadataDocumentResolver {
+    readonly resolver: DocumentResolver;
+    readonly scope: string;
+    constructor(resolver: DocumentResolver, scope: string);
+}
+export declare class AutodocMetadata {
+    readonly rsdkMetadata: RsdkMetadata;
+    constructor(rsdkMetadata: RsdkMetadata);
+    defineResolver(resolver: DocumentResolver): void;
+    getResolvers(): MetadataDocumentResolver[] | null;
+}
+export {};

package/dist/autodoc-metadata.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AutodocMetadata = void 0;
+const constants_1 = require("./constants");
+class MetadataDocumentResolver {
+    resolver;
+    scope;
+    constructor(resolver, scope) {
+        this.resolver = resolver;
+        this.scope = scope;
+    }
+}
+class AutodocMetadata {
+    rsdkMetadata;
+    constructor(rsdkMetadata) {
+        this.rsdkMetadata = rsdkMetadata;
+    }
+    defineResolver(resolver) {
+        const resolvers = this.getResolvers() ?? [];
+        resolvers.push(new MetadataDocumentResolver(resolver, this.rsdkMetadata.scope ?? 'Common'));
+        Reflect.defineMetadata(constants_1.DOCUMENT_RESOLVER_KEY, resolvers, this.rsdkMetadata.target);
+    }
+    getResolvers() {
+        return Reflect.getMetadata(constants_1.DOCUMENT_RESOLVER_KEY, this.rsdkMetadata.target);
+    }
+}
+exports.AutodocMetadata = AutodocMetadata;

package/dist/autodoc-metadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"autodoc-metadata.js","sourceRoot":"","sources":["../../autodoc/protocol/src/autodoc-metadata.ts"],"names":[],"mappings":";;;AAEA,2CAAoD;AAGpD,MAAM,wBAAwB;IACP;IAAqC;IAA1D,YAAqB,QAA0B,EAAW,KAAa;QAAlD,aAAQ,GAAR,QAAQ,CAAkB;QAAW,UAAK,GAAL,KAAK,CAAQ;IAAG,CAAC;CAC5E;AAED,MAAa,eAAe;IACL;IAArB,YAAqB,YAA0B;QAA1B,iBAAY,GAAZ,YAAY,CAAc;IAAG,CAAC;IAEnD,cAAc,CAAC,QAA0B;QACvC,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,EAAE,IAAI,EAAE,CAAC;QAE5C,SAAS,CAAC,IAAI,CACZ,IAAI,wBAAwB,CAC1B,QAAQ,EACR,IAAI,CAAC,YAAY,CAAC,KAAK,IAAI,QAAQ,CACpC,CACF,CAAC;QAEF,OAAO,CAAC,cAAc,CACpB,iCAAqB,EACrB,SAAS,EACT,IAAI,CAAC,YAAY,CAAC,MAAM,CACzB,CAAC;IACJ,CAAC;IAED,YAAY;QACV,OAAO,OAAO,CAAC,WAAW,CAAC,iCAAqB,EAAE,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IAC9E,CAAC;CACF;AAvBD,0CAuBC"}

package/dist/constants.d.ts

@@ -0,0 +1 @@
+export declare const DOCUMENT_RESOLVER_KEY: unique symbol;

package/dist/constants.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DOCUMENT_RESOLVER_KEY = void 0;
+// TODO: Rename this
+exports.DOCUMENT_RESOLVER_KEY = Symbol('DOCUMENT_RESOLVER_KEY');

package/dist/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../autodoc/protocol/src/constants.ts"],"names":[],"mappings":";;;AAAA,oBAAoB;AACP,QAAA,qBAAqB,GAAG,MAAM,CAAC,uBAAuB,CAAC,CAAC"}

package/dist/document-node/aggregate.node.d.ts

@@ -0,0 +1,14 @@
+import type { DocumentNode } from '../types';
+type DocumentItem = DocumentNode | string;
+/**
+ * This type of document node aggregate a number of
+ * other nodes (which can be composites themselves)
+ */
+export declare class Composite implements DocumentNode {
+    readonly items: DocumentItem | DocumentItem[];
+    readonly title?: string | undefined;
+    constructor(items: DocumentItem | DocumentItem[], title?: string | undefined);
+    toString(nestLevel?: number): Promise<string>;
+    isEmpty(): boolean;
+}
+export {};

package/dist/document-node/aggregate.node.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Composite = void 0;
+const common_1 = require("@rsdk/common");
+/**
+ * This type of document node aggregate a number of
+ * other nodes (which can be composites themselves)
+ */
+class Composite {
+    items;
+    title;
+    constructor(items, title) {
+        this.items = items;
+        this.title = title;
+    }
+    async toString(nestLevel = 0) {
+        const content = Array.isArray(this.items)
+            ? this.items.slice()
+            : [this.items];
+        let newNestLevel = nestLevel;
+        if (this.title) {
+            content.unshift(`${'#'.repeat(nestLevel + 1)} ${(0, common_1.capitalize)(this.title)}`);
+            newNestLevel += 1;
+        }
+        const documentItems = content.filter((item) => item && (typeof item === 'string' ? item.length > 0 : !item.isEmpty()));
+        const resolvedNodesContent = await Promise.all(documentItems.map((item) => item.toString(newNestLevel)));
+        return resolvedNodesContent.join('\n\n');
+    }
+    isEmpty() {
+        if (typeof this.items === 'string') {
+            return this.items.length === 0;
+        }
+        if (Array.isArray(this.items)) {
+            if (this.items.length === 0) {
+                return true;
+            }
+            return this.items.every((item) => typeof item === 'string' ? item.length === 0 : item.isEmpty());
+        }
+        return this.items.isEmpty();
+    }
+}
+exports.Composite = Composite;

package/dist/document-node/aggregate.node.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"aggregate.node.js","sourceRoot":"","sources":["../../../autodoc/protocol/src/document-node/aggregate.node.ts"],"names":[],"mappings":";;;AAAA,yCAA0C;AAM1C;;;GAGG;AACH,MAAa,SAAS;IAET;IACA;IAFX,YACW,KAAoC,EACpC,KAAc;QADd,UAAK,GAAL,KAAK,CAA+B;QACpC,UAAK,GAAL,KAAK,CAAS;IACtB,CAAC;IAEJ,KAAK,CAAC,QAAQ,CAAC,SAAS,GAAG,CAAC;QAC1B,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC;YACvC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE;YACpB,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAEjB,IAAI,YAAY,GAAG,SAAS,CAAC;QAC7B,IAAI,IAAI,CAAC,KAAK,EAAE;YACd,OAAO,CAAC,OAAO,CAAC,GAAG,GAAG,CAAC,MAAM,CAAC,SAAS,GAAG,CAAC,CAAC,IAAI,IAAA,mBAAU,EAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YAC1E,YAAY,IAAI,CAAC,CAAC;SACnB;QAED,MAAM,aAAa,GAAG,OAAO,CAAC,MAAM,CAClC,CAAC,IAAI,EAAE,EAAE,CACP,IAAI,IAAI,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CACzE,CAAC;QAEF,MAAM,oBAAoB,GAAG,MAAM,OAAO,CAAC,GAAG,CAC5C,aAAa,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CACzD,CAAC;QAEF,OAAO,oBAAoB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;IAED,OAAO;QACL,IAAI,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,EAAE;YAClC,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC;SAChC;QAED,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;YAC7B,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;gBAC3B,OAAO,IAAI,CAAC;aACb;YACD,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAC/B,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,CAC9D,CAAC;SACH;QAED,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;IAC9B,CAAC;CACF;AA7CD,8BA6CC"}

package/dist/document-node/list.node.d.ts

@@ -0,0 +1,10 @@
+import type { DocumentNode } from '../types';
+/**
+ * This type of node represents a list of strings
+ */
+export declare class List implements DocumentNode {
+    readonly list: string[];
+    constructor(list: string[]);
+    toString(): string;
+    isEmpty(): boolean;
+}

package/dist/document-node/list.node.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.List = void 0;
+/**
+ * This type of node represents a list of strings
+ */
+class List {
+    list;
+    constructor(list) {
+        this.list = list;
+    }
+    toString() {
+        return this.list.map((item) => '- ' + item).join('\n');
+    }
+    isEmpty() {
+        return this.list.length === 0 || this.list.some((v) => v.length === 0);
+    }
+}
+exports.List = List;

package/dist/document-node/list.node.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"list.node.js","sourceRoot":"","sources":["../../../autodoc/protocol/src/document-node/list.node.ts"],"names":[],"mappings":";;;AAEA;;GAEG;AACH,MAAa,IAAI;IACM;IAArB,YAAqB,IAAc;QAAd,SAAI,GAAJ,IAAI,CAAU;IAAG,CAAC;IAEvC,QAAQ;QACN,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzD,CAAC;IAED,OAAO;QACL,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;IACzE,CAAC;CACF;AAVD,oBAUC"}

package/dist/document-node/table.node.d.ts

@@ -0,0 +1,11 @@
+import type { DocumentNode } from '../types';
+/**
+ * This type of node represent table
+ */
+export declare class Table<T extends Record<string, string>> implements DocumentNode {
+    readonly list: T[];
+    readonly headerSequence?: (keyof T)[] | undefined;
+    constructor(list: T[], headerSequence?: (keyof T)[] | undefined);
+    toString(): string;
+    isEmpty(): boolean;
+}

package/dist/document-node/table.node.js

@@ -0,0 +1,34 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Table = void 0;
+const common_1 = require("@rsdk/common");
+const markdown_table_1 = __importDefault(require("markdown-table"));
+/**
+ * This type of node represent table
+ */
+class Table {
+    list;
+    headerSequence;
+    constructor(list, headerSequence) {
+        this.list = list;
+        this.headerSequence = headerSequence;
+    }
+    toString() {
+        const keys = this.headerSequence ?? Object.keys(this.list[0] ?? {});
+        const table = this.list.map((listItem) => {
+            return keys.map((key) => {
+                // Просто экранируем `|` чтобы таблица не плыла
+                return listItem[key].replaceAll(/\|/gi, '\\|');
+            });
+        });
+        table.unshift(keys.map((key) => (0, common_1.capitalize)(key)));
+        return (0, markdown_table_1.default)(table);
+    }
+    isEmpty() {
+        return this.list.length === 0;
+    }
+}
+exports.Table = Table;

package/dist/document-node/table.node.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"table.node.js","sourceRoot":"","sources":["../../../autodoc/protocol/src/document-node/table.node.ts"],"names":[],"mappings":";;;;;;AAAA,yCAA0C;AAC1C,oEAA2C;AAI3C;;GAEG;AACH,MAAa,KAAK;IACK;IAAoB;IAAzC,YAAqB,IAAS,EAAW,cAA4B;QAAhD,SAAI,GAAJ,IAAI,CAAK;QAAW,mBAAc,GAAd,cAAc,CAAc;IAAG,CAAC;IAEzE,QAAQ;QACN,MAAM,IAAI,GACP,IAAI,CAAC,cAA2B,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;QACvE,MAAM,KAAK,GAAe,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;YACnD,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;gBACtB,+CAA+C;gBAC/C,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,UAAU,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;YACjD,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAA,mBAAU,EAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAElD,OAAO,IAAA,wBAAa,EAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;IAED,OAAO;QACL,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC;IAChC,CAAC;CACF;AArBD,sBAqBC"}

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+import 'reflect-metadata';
+export { List } from './document-node/list.node';
+export { Composite } from './document-node/aggregate.node';
+export { Table } from './document-node/table.node';
+export { AutodocMetadata } from './autodoc-metadata';
+export { DOCUMENT_RESOLVER_KEY } from './constants';
+export { DocumentNode, DocumentResolver } from './types';

package/dist/index.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DOCUMENT_RESOLVER_KEY = exports.AutodocMetadata = exports.Table = exports.Composite = exports.List = void 0;
+require("reflect-metadata");
+var list_node_1 = require("./document-node/list.node");
+Object.defineProperty(exports, "List", { enumerable: true, get: function () { return list_node_1.List; } });
+var aggregate_node_1 = require("./document-node/aggregate.node");
+Object.defineProperty(exports, "Composite", { enumerable: true, get: function () { return aggregate_node_1.Composite; } });
+var table_node_1 = require("./document-node/table.node");
+Object.defineProperty(exports, "Table", { enumerable: true, get: function () { return table_node_1.Table; } });
+var autodoc_metadata_1 = require("./autodoc-metadata");
+Object.defineProperty(exports, "AutodocMetadata", { enumerable: true, get: function () { return autodoc_metadata_1.AutodocMetadata; } });
+var constants_1 = require("./constants");
+Object.defineProperty(exports, "DOCUMENT_RESOLVER_KEY", { enumerable: true, get: function () { return constants_1.DOCUMENT_RESOLVER_KEY; } });

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../autodoc/protocol/src/index.ts"],"names":[],"mappings":";;;AAAA,4BAA0B;AAE1B,uDAAiD;AAAxC,iGAAA,IAAI,OAAA;AACb,iEAA2D;AAAlD,2GAAA,SAAS,OAAA;AAClB,yDAAmD;AAA1C,mGAAA,KAAK,OAAA;AAEd,uDAAqD;AAA5C,mHAAA,eAAe,OAAA;AAExB,yCAAoD;AAA3C,kHAAA,qBAAqB,OAAA"}

package/dist/types.d.ts

@@ -0,0 +1,19 @@
+import type { RsdkMetadataProvider } from '@rsdk/metadata';
+import type { Promisable } from 'type-fest';
+export type DocumentResolver = {
+    getNode(rsdkMetadataProvider: RsdkMetadataProvider): Promisable<DocumentNode | null>;
+};
+/**
+ * Document is a composition of nodes of different types.
+ */
+export interface DocumentNode {
+    /**
+     * Creates string representation of document node
+     * @param {number} depth Level of nesting of the node
+     */
+    toString(depth?: number): Promisable<string>;
+    /**
+     * Signals that node has no content
+     */
+    isEmpty(): boolean;
+}

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../autodoc/protocol/src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@rsdk/tsconfig",
-  "version": "2.4.2",
+  "version": "3.0.2",
   "main": "index.js",
   "license": "Apache License 2.0",
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "eda467ff4659536e05ed1baea445e5a6a30c056e"
+  "gitHead": "3ee33710bf18bfadf87a6da92b060e6a17481110"
 }