@smithy/service-client-documentation-generator 3.0.0 → 4.1.0

package/dist-cjs/index.js

@@ -21,17 +21,16 @@ var __decorateClass = (decorators, target, key, kind) => {
   for (var i = decorators.length - 1, decorator; i >= 0; i--)
     if (decorator = decorators[i])
       result = (kind ? decorator(target, key, result) : decorator(result)) || result;
-  if (kind && result)
-    __defProp(target, key, result);
+  if (kind && result) __defProp(target, key, result);
   return result;
 };
 
 // src/index.ts
-var src_exports = {};
-__export(src_exports, {
+var index_exports = {};
+__export(index_exports, {
   load: () => load
 });
-module.exports = __toCommonJS(src_exports);
+module.exports = __toCommonJS(index_exports);
 
 
 // src/sdk-client-toc-plugin.ts
@@ -40,28 +39,23 @@ var import_typedoc = require("typedoc");
 
 // src/utils.ts
 var import_path = require("path");
-var isClientModel = /* @__PURE__ */ __name((model) => {
-  var _a, _b;
-  return (_b = (_a = model == null ? void 0 : model.sources) == null ? void 0 : _a[0]) == null ? void 0 : _b.fullFileName.includes(`${import_path.sep}clients${import_path.sep}`);
-}, "isClientModel");
+var isClientModel = /* @__PURE__ */ __name((model) => model?.sources?.[0]?.fullFileName.includes(`${import_path.sep}clients${import_path.sep}`), "isClientModel");
 
 // src/sdk-client-toc-plugin.ts
-var _SdkClientTocPlugin = class _SdkClientTocPlugin {
+var SdkClientTocPlugin = class {
   constructor(options, logger, renderer) {
     this.options = options;
     this.logger = logger;
     this.renderer = renderer;
-    this.changeLinksToLowerCase = (context) => {
+    this.changeLinksToLowerCase = /* @__PURE__ */ __name((context) => {
       Object.keys(context.project.reflections).forEach((reflectionName) => {
         context.project.reflections[reflectionName]._alias = context.project.reflections[reflectionName].getAlias().toLowerCase();
       });
-    };
-    this.onEndResolve = (context) => {
-      var _a;
-      if (!this.clientDir)
-        this.clientDir = this.loadClientDir(context.project);
+    }, "changeLinksToLowerCase");
+    this.onEndResolve = /* @__PURE__ */ __name((context) => {
+      if (!this.clientDir) this.clientDir = this.loadClientDir(context.project);
       for (const model of Object.values(context.project.reflections)) {
-        const isEffectiveParent = model instanceof import_typedoc.ContainerReflection && ((_a = model.children) == null ? void 0 : _a.length) || model.isProject();
+        const isEffectiveParent = model instanceof import_typedoc.ContainerReflection && model.children?.length || model.isProject();
         if (!isEffectiveParent || model.kindOf(import_typedoc.ReflectionKind.SomeModule)) {
           return;
         }
@@ -79,14 +73,16 @@ var _SdkClientTocPlugin = class _SdkClientTocPlugin {
           model.groups.splice(modulesIndex, 1);
         }
       }
-    };
+    }, "onEndResolve");
     this.renderer.application.converter.on(import_typedoc.Converter.EVENT_END, this.changeLinksToLowerCase);
     this.renderer.application.converter.on(import_typedoc.Converter.EVENT_RESOLVE_END, this.onEndResolve);
   }
+  static {
+    __name(this, "SdkClientTocPlugin");
+  }
   // Confirm declaration comes from the same folder as the client class
   belongsToClientPackage(model) {
-    var _a;
-    return this.clientDir && ((_a = model.sources) == null ? void 0 : _a[0].fullFileName.indexOf(this.clientDir)) === 0;
+    return this.clientDir && model.sources?.[0].fullFileName.indexOf(this.clientDir) === 0;
   }
   isClient(model) {
     const { extendedTypes = [] } = model;
@@ -116,8 +112,7 @@ var _SdkClientTocPlugin = class _SdkClientTocPlugin {
    */
   defineCategories(group, reflections) {
     const categories = group.categories || [];
-    if (this.isCategorized(categories))
-      return group.categories;
+    if (this.isCategorized(categories)) return group.categories;
     const clients = new import_typedoc.ReflectionCategory("Clients");
     const commands = new import_typedoc.ReflectionCategory("Commands");
     const paginators = new import_typedoc.ReflectionCategory("Paginators");
@@ -157,14 +152,12 @@ var _SdkClientTocPlugin = class _SdkClientTocPlugin {
     return (0, import_path.dirname)((0, import_path.dirname)(fullFileName));
   }
 };
-__name(_SdkClientTocPlugin, "SdkClientTocPlugin");
 __decorateClass([
   (0, import_typedoc.BindOption)("defaultGroup")
-], _SdkClientTocPlugin.prototype, "defaultGroup", 2);
+], SdkClientTocPlugin.prototype, "defaultGroup", 2);
 __decorateClass([
   (0, import_typedoc.BindOption)("defaultCategory")
-], _SdkClientTocPlugin.prototype, "defaultCategory", 2);
-var SdkClientTocPlugin = _SdkClientTocPlugin;
+], SdkClientTocPlugin.prototype, "defaultCategory", 2);
 
 // src/index.ts
 function load(app) {

package/dist-types/index.d.ts

@@ -1,4 +1,4 @@
-import { Application } from "typedoc";
+import type { Application } from "typedoc";
 /**
  * @internal
  */

package/dist-types/sdk-client-toc-plugin.d.ts

@@ -1,4 +1,4 @@
-import { Logger, Options, Renderer } from "typedoc";
+import type { Logger, Options, Renderer } from "typedoc";
 /**
  * @internal
  *

package/dist-types/utils.d.ts

@@ -1,4 +1,4 @@
-import { Reflection } from "typedoc";
+import type { Reflection } from "typedoc";
 /**
  * @internal
  */

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "@smithy/service-client-documentation-generator",
-  "version": "3.0.0",
+  "version": "4.1.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types && yarn build:types:downlevel'",
     "build:cjs": "node ../../scripts/inline service-client-documentation-generator",
     "build:es": "yarn g:tsc -p tsconfig.es.json",
     "build:types": "yarn g:tsc -p tsconfig.types.json",
-    "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4",
+    "build:types:downlevel": "rimraf dist-types/ts3.4 && downlevel-dts dist-types dist-types/ts3.4",
     "stage-release": "rimraf ./.release && yarn pack && mkdir ./.release && tar zxvf ./package.tgz --directory ./.release && rm ./package.tgz",
     "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo || exit 0",
     "lint": "eslint -c ../../.eslintrc.js \"src/**/*.ts\"",
-    "format": "prettier --config ../../prettier.config.js --ignore-path ../.prettierignore --write \"**/*.{ts,md,json}\"",
+    "format": "prettier --config ../../prettier.config.js --ignore-path ../../.prettierignore --write \"**/*.{ts,md,json}\"",
     "test": "exit 0"
   },
   "main": "./dist-cjs/index.js",
@@ -21,6 +21,7 @@
     "url": "https://aws.amazon.com/javascript/"
   },
   "license": "Apache-2.0",
+  "sideEffects": false,
   "keywords": [
     "typedocplugin"
   ],
@@ -29,7 +30,7 @@
     "typedoc": "0.23.23"
   },
   "devDependencies": {
-    "@types/node": "^16.18.96",
+    "@types/node": "^18.11.9",
     "concurrently": "7.0.0",
     "downlevel-dts": "0.10.1",
     "rimraf": "3.0.2"
@@ -47,13 +48,16 @@
   "files": [
     "dist-*/**"
   ],
-  "homepage": "https://github.com/awslabs/smithy-typescript/tree/main/packages/client-documentation-generator",
+  "homepage": "https://github.com/smithy-lang/smithy-typescript/tree/main/packages/client-documentation-generator",
   "repository": {
     "type": "git",
-    "url": "https://github.com/awslabs/smithy-typescript.git",
+    "url": "https://github.com/smithy-lang/smithy-typescript.git",
     "directory": "packages/client-documentation-generator"
   },
   "publishConfig": {
     "directory": ".release/package"
+  },
+  "engines": {
+    "node": ">=18.0.0"
   }
 }