@storm-software/workspace-tools 1.7.37 → 1.8.1

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [1.8.0](https://github.com/storm-software/storm-ops/compare/workspace-tools-v1.7.37...workspace-tools-v1.8.0) (2023-11-20)
+
+
+### Features
+
+* **workspace-tools:** Update tsup executor to generate API Report file, Doc Model, and TSDoc Metadata ([fb4cda5](https://github.com/storm-software/storm-ops/commit/fb4cda5807005d2ae412d637fa5247ebad09abf7))
+
+## [1.7.37](https://github.com/storm-software/storm-ops/compare/workspace-tools-v1.7.36...workspace-tools-v1.7.37) (2023-11-20)
+
+
+### Bug Fixes
+
+* **workspace-tools:** Added missing @microsoft/api-extractor dependency for tsup DTS build ([56ab124](https://github.com/storm-software/storm-ops/commit/56ab124124275be7f66f0e9f11d64477c82bbcf5))
+
 ## [1.7.36](https://github.com/storm-software/storm-ops/compare/workspace-tools-v1.7.35...workspace-tools-v1.7.36) (2023-11-20)
 
 

package/README.md

@@ -15,7 +15,7 @@ This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages
 
 <h3 align="center">💻 Visit <a href="https://stormsoftware.org" target="_blank">stormsoftware.org</a> to stay up to date with this developer</h3><br />
 
-[![Version](https://img.shields.io/badge/version-1.7.26-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;
+[![Version](https://img.shields.io/badge/version-1.7.36-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;
 [![Nx](https://img.shields.io/badge/Nx-17.0.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=1fb2a6)](http://nx.dev/)&nbsp;[![NextJs](https://img.shields.io/badge/Next.js-14.0.2-lightgrey?style=for-the-badge&logo=nextdotjs&logoWidth=20&color=1fb2a6)](https://nextjs.org/)&nbsp;[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=1fb2a6)](http://commitizen.github.io/cz-cli/)&nbsp;![Semantic-Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge&color=1fb2a6)&nbsp;[![documented with docusaurus](https://img.shields.io/badge/documented_with-docusaurus-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://docusaurus.io/)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/storm-ops/cr.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
 
 <h3 align="center" bold="true">⚠️ <b>Attention</b> ⚠️ - This repository, and the apps, libraries, and tools contained within, is still in it's initial development phase. As a result, bugs and issues are expected with it's usage. When the main development phase completes, a proper release will be performed, the packages will be availible through NPM (and other distributions), and this message will be removed. However, in the meantime, please feel free to report any issues you may come across.</h3><br />

package/index.js

@@ -408390,9 +408390,9 @@ var require_brace_expansion2 = __commonJS({
   }
 });
 
-// node_modules/.pnpm/tsup@8.0.0_patch_hash=mbej3fsdqjmxhdiqcxx3ntmck4_@microsoft+api-extractor@7.38.3_@swc+core@1._ra4m2fiwlqoxwr5xcfgfxijlw4/node_modules/tsup/dist/chunk-EPAEWGCP.js
+// node_modules/.pnpm/tsup@8.0.0_patch_hash=fvapec7mb4z5pzhkqr24thfvhy_@microsoft+api-extractor@7.38.3_@swc+core@1._jnaxdvysulxz7c3jl5qv6s7qpu/node_modules/tsup/dist/chunk-EPAEWGCP.js
 var require_chunk_EPAEWGCP = __commonJS({
-  "node_modules/.pnpm/tsup@8.0.0_patch_hash=mbej3fsdqjmxhdiqcxx3ntmck4_@microsoft+api-extractor@7.38.3_@swc+core@1._ra4m2fiwlqoxwr5xcfgfxijlw4/node_modules/tsup/dist/chunk-EPAEWGCP.js"(exports) {
+  "node_modules/.pnpm/tsup@8.0.0_patch_hash=fvapec7mb4z5pzhkqr24thfvhy_@microsoft+api-extractor@7.38.3_@swc+core@1._jnaxdvysulxz7c3jl5qv6s7qpu/node_modules/tsup/dist/chunk-EPAEWGCP.js"(exports) {
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });
     var version = "8.0.0";
@@ -410039,9 +410039,9 @@ var require_resolve_from = __commonJS({
   }
 });
 
-// node_modules/.pnpm/tsup@8.0.0_patch_hash=mbej3fsdqjmxhdiqcxx3ntmck4_@microsoft+api-extractor@7.38.3_@swc+core@1._ra4m2fiwlqoxwr5xcfgfxijlw4/node_modules/tsup/dist/chunk-GQ77QZBO.js
+// node_modules/.pnpm/tsup@8.0.0_patch_hash=fvapec7mb4z5pzhkqr24thfvhy_@microsoft+api-extractor@7.38.3_@swc+core@1._jnaxdvysulxz7c3jl5qv6s7qpu/node_modules/tsup/dist/chunk-GQ77QZBO.js
 var require_chunk_GQ77QZBO = __commonJS({
-  "node_modules/.pnpm/tsup@8.0.0_patch_hash=mbej3fsdqjmxhdiqcxx3ntmck4_@microsoft+api-extractor@7.38.3_@swc+core@1._ra4m2fiwlqoxwr5xcfgfxijlw4/node_modules/tsup/dist/chunk-GQ77QZBO.js"(exports) {
+  "node_modules/.pnpm/tsup@8.0.0_patch_hash=fvapec7mb4z5pzhkqr24thfvhy_@microsoft+api-extractor@7.38.3_@swc+core@1._jnaxdvysulxz7c3jl5qv6s7qpu/node_modules/tsup/dist/chunk-GQ77QZBO.js"(exports) {
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });
     function _interopRequireDefault(obj) {
@@ -410320,9 +410320,9 @@ var require_chunk_GQ77QZBO = __commonJS({
   }
 });
 
-// node_modules/.pnpm/tsup@8.0.0_patch_hash=mbej3fsdqjmxhdiqcxx3ntmck4_@microsoft+api-extractor@7.38.3_@swc+core@1._ra4m2fiwlqoxwr5xcfgfxijlw4/node_modules/tsup/dist/chunk-UIX4URMV.js
+// node_modules/.pnpm/tsup@8.0.0_patch_hash=fvapec7mb4z5pzhkqr24thfvhy_@microsoft+api-extractor@7.38.3_@swc+core@1._jnaxdvysulxz7c3jl5qv6s7qpu/node_modules/tsup/dist/chunk-UIX4URMV.js
 var require_chunk_UIX4URMV = __commonJS({
-  "node_modules/.pnpm/tsup@8.0.0_patch_hash=mbej3fsdqjmxhdiqcxx3ntmck4_@microsoft+api-extractor@7.38.3_@swc+core@1._ra4m2fiwlqoxwr5xcfgfxijlw4/node_modules/tsup/dist/chunk-UIX4URMV.js"(exports) {
+  "node_modules/.pnpm/tsup@8.0.0_patch_hash=fvapec7mb4z5pzhkqr24thfvhy_@microsoft+api-extractor@7.38.3_@swc+core@1._jnaxdvysulxz7c3jl5qv6s7qpu/node_modules/tsup/dist/chunk-UIX4URMV.js"(exports) {
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });
     function _interopRequireWildcard(obj) {
@@ -411256,9 +411256,9 @@ var require_dist2 = __commonJS({
   }
 });
 
-// node_modules/.pnpm/tsup@8.0.0_patch_hash=mbej3fsdqjmxhdiqcxx3ntmck4_@microsoft+api-extractor@7.38.3_@swc+core@1._ra4m2fiwlqoxwr5xcfgfxijlw4/node_modules/tsup/dist/chunk-7G76EW2R.js
+// node_modules/.pnpm/tsup@8.0.0_patch_hash=fvapec7mb4z5pzhkqr24thfvhy_@microsoft+api-extractor@7.38.3_@swc+core@1._jnaxdvysulxz7c3jl5qv6s7qpu/node_modules/tsup/dist/chunk-7G76EW2R.js
 var require_chunk_7G76EW2R = __commonJS({
-  "node_modules/.pnpm/tsup@8.0.0_patch_hash=mbej3fsdqjmxhdiqcxx3ntmck4_@microsoft+api-extractor@7.38.3_@swc+core@1._ra4m2fiwlqoxwr5xcfgfxijlw4/node_modules/tsup/dist/chunk-7G76EW2R.js"(exports) {
+  "node_modules/.pnpm/tsup@8.0.0_patch_hash=fvapec7mb4z5pzhkqr24thfvhy_@microsoft+api-extractor@7.38.3_@swc+core@1._jnaxdvysulxz7c3jl5qv6s7qpu/node_modules/tsup/dist/chunk-7G76EW2R.js"(exports) {
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });
     function _interopRequireDefault(obj) {
@@ -465064,9 +465064,9 @@ var require_chokidar = __commonJS({
   }
 });
 
-// node_modules/.pnpm/tsup@8.0.0_patch_hash=mbej3fsdqjmxhdiqcxx3ntmck4_@microsoft+api-extractor@7.38.3_@swc+core@1._ra4m2fiwlqoxwr5xcfgfxijlw4/node_modules/tsup/dist/index.js
+// node_modules/.pnpm/tsup@8.0.0_patch_hash=fvapec7mb4z5pzhkqr24thfvhy_@microsoft+api-extractor@7.38.3_@swc+core@1._jnaxdvysulxz7c3jl5qv6s7qpu/node_modules/tsup/dist/index.js
 var require_dist5 = __commonJS({
-  "node_modules/.pnpm/tsup@8.0.0_patch_hash=mbej3fsdqjmxhdiqcxx3ntmck4_@microsoft+api-extractor@7.38.3_@swc+core@1._ra4m2fiwlqoxwr5xcfgfxijlw4/node_modules/tsup/dist/index.js"(exports) {
+  "node_modules/.pnpm/tsup@8.0.0_patch_hash=fvapec7mb4z5pzhkqr24thfvhy_@microsoft+api-extractor@7.38.3_@swc+core@1._jnaxdvysulxz7c3jl5qv6s7qpu/node_modules/tsup/dist/index.js"(exports) {
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });
     function _interopRequireDefault(obj) {
@@ -467500,27 +467500,61 @@ var require_dist5 = __commonJS({
       return "";
     }
     var logger2 = _chunk7G76EW2Rjs.createLogger.call(void 0);
-    function rollupDtsFile(inputFilePath, outputFilePath, tsconfigFilePath) {
-      let pkgPath = packageJsonSearch(outputFilePath, false, "dts", logger2);
+    function rollupDtsFile(options, inputFilePath, outputFilePath, tsconfigFilePath) {
+      let pkgPath = packageJsonSearch(options.outDir, options.silent, "dts", logger2);
+      if (pkgPath.endsWith("/")) {
+        pkgPath = pkgPath.slice(0, -1);
+      }
       logger2.info("dts", `\u26A1 Preparing to run API Extractor (DTS generate): ${pkgPath}`);
-      let packageJsonFullPath = _path2.default.join(pkgPath, "package.json");
+      let packageJsonFullPath = options.workspaceRoot ? _path2.default.join(options.workspaceRoot, pkgPath, "package.json") : _path2.default.join(pkgPath, "package.json");
+      const packageName = pkgPath.substring(pkgPath.lastIndexOf("/") ?? 0);
+      const apiReferenceProjectDir = _path2.default.join(
+        options.workspaceRoot,
+        "docs",
+        "api-reports",
+        options.projectRoot
+      );
       let configObject = {
         mainEntryPointFilePath: inputFilePath,
         apiReport: {
-          enabled: false,
-          // `reportFileName` is not been used. It's just to fit the requirement of API Extractor.
-          reportFileName: "tsup-report.api.md"
+          enabled: options.apiReport !== false,
+          reportFileName: _path2.default.join(
+            apiReferenceProjectDir,
+            `${packageName}.api.md`
+          )
+        },
+        docModel: {
+          enabled: options.docModel !== false,
+          apiJsonFilePath: _path2.default.join(
+            apiReferenceProjectDir,
+            `${packageName}.api.json`
+          )
         },
-        docModel: { enabled: false },
         dtsRollup: {
           enabled: true,
-          untrimmedFilePath: outputFilePath
+          untrimmedFilePath: outputFilePath,
+          betaTrimmedFilePath: _path2.default.join(
+            options.workspaceRoot,
+            options.outDir,
+            `${packageName}-beta.d.ts`
+          ),
+          publicTrimmedFilePath: _path2.default.join(
+            options.workspaceRoot,
+            options.outDir,
+            `${packageName}-public.d.ts`
+          )
+        },
+        tsdocMetadata: {
+          enabled: options.tsdocMetadata !== false,
+          tsdocMetadataFilePath: _path2.default.join(
+            apiReferenceProjectDir,
+            `${packageName}.api.tsdoc-metadata.json`
+          )
         },
-        tsdocMetadata: { enabled: false },
         compiler: {
           tsconfigFilePath
         },
-        projectFolder: pkgPath
+        projectFolder: options.projectRoot ?? pkgPath
       };
       const prepareOptions = {
         configObject,
@@ -467566,6 +467600,7 @@ var require_dist5 = __commonJS({
         formatAggregationExports(exports2, declarationDir)
       );
       rollupDtsFile(
+        options,
         dtsInputFilePath,
         dtsOutputFilePath,
         options.tsconfig || "tsconfig.json"