@be-link/tfs-cli-nodejs 0.0.1

package/jest.config.js

@@ -0,0 +1,194 @@
+/*
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+module.exports = {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/private/var/folders/dt/kcn7j7yj36n1881sqpgzqv3c0000gn/T/jest_dx",
+
+  // Automatically clear mock calls and instances between every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  // collectCoverage: false,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: undefined,
+
+  // The directory where Jest should output its coverage files
+  // coverageDirectory: undefined,
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // Indicates which provider should be used to instrument code for coverage
+  coverageProvider: 'v8',
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: undefined,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  moduleFileExtensions: [
+    "js",
+    "jsx",
+    "ts",
+    "tsx",
+    "json",
+    "node"
+  ],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  preset: 'ts-jest',
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state between every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state between every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  // testEnvironment: "jest-environment-node",
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  // testMatch: [
+  //   "**/__tests__/**/*.[jt]s?(x)",
+  //   "**/?(*.)+(spec|test).[tj]s?(x)"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jest-circus/runner",
+
+  // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
+  // testURL: "http://localhost",
+
+  // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
+  // timers: "real",
+
+  // A map from regular expressions to paths to transformers
+  transform: { "^.+\\.ts?$": "ts-jest" },
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "/node_modules/",
+  //   "\\.pnp\\.[^\\/]+$"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: undefined,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@be-link/tfs-cli-nodejs",
+  "version": "0.0.1",
+  "description": "交易履约服务Nodejs客户端",
+  "main": "index.js",
+  "scripts": {
+    "build": "rm -rf ./dist && tsc && cp package.json README.md ./dist/",
+    "test": "npx jest",
+    "gen-doc": "npx typedoc --options typedoc.json",
+    "update:major": "standard-version --release-as major",
+    "update:minor": "standard-version  --release-as minor",
+    "update:patch": "standard-version  --release-as patch",
+    "update:beta": "standard-version --prerelease beta",
+    "publish": "ts-node ./ci/index"
+  },
+  "author": "dev@8848top.com",
+  "license": "ISC",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^18.4.3",
+    "@commitlint/config-conventional": "^18.4.3",
+    "@types/inquirer": "^9.0.7",
+    "@types/jest": "^29.5.7",
+    "@types/node": "^20.14.2",
+    "@types/uuid": "^9.0.6",
+    "husky": "^8.0.3",
+    "inquirer": "8.2.6",
+    "ioredis": "5.3.2",
+    "jest": "29.7.0",
+    "standard-version": "^9.5.0",
+    "ts-jest": "29.1.1",
+    "typedoc": "0.25.2",
+    "typedoc-plugin-missing-exports": "2.1.0",
+    "typescript": "5.2.2"
+  },
+  "dependencies": {
+    "axios": "0.27.2",
+    "uuid": "^9.0.1",
+    "vitality-meta": "1.0.67"
+  },
+  "engines": {
+    "node": ">18"
+  }
+}

package/src/errors/BizError.ts

@@ -0,0 +1,10 @@
+export default class BizError extends Error {
+
+  code: number
+
+  constructor(message: string, code: number = 400) {
+    super(message)
+    this.code = code
+    this.name = 'BizError'
+  }
+}

package/src/errors/FulfillError.ts

@@ -0,0 +1,10 @@
+export default class FulfillError extends Error {
+
+  code: number
+
+  constructor(message: string, code: number = 500) {
+    super(message)
+    this.code = code
+    this.name = 'UserError'
+  }
+}

package/src/index.ts

@@ -0,0 +1,8 @@
+import BizError from './errors/BizError'
+import rescheduleService from './tfs/modules/reschedule/service'
+
+/** 业务模块 */
+export {
+  BizError,
+  rescheduleService,
+}

package/src/tfs/http.ts

@@ -0,0 +1,66 @@
+import axios, { AxiosError } from 'axios'
+import FulfillError from '../errors/FulfillError'
+import { v4 as uuidV4 } from 'uuid'
+import BizError from '../errors/BizError'
+type ResponseData = {
+  data: any
+  message: string
+}
+
+export async function callApi<T extends (args: any) => Promise<any>>(url: string, ...request: Parameters<T>)
+  : Promise<Awaited<ReturnType<T>>> {
+  const requestId = uuidV4()
+  const maxRetries = 3 // 最大重试次数
+  let retries = 0
+  let errorInfo: any = null
+
+  while (retries < maxRetries) {
+    try {
+      console.info(`准备发起TFS请求[${requestId}]: ${url}, 参数: ${JSON.stringify(request)}`);
+      const response = await axios.post(url, request[0], {
+        headers: {
+          'X-Request-Id': requestId,
+          'x-belink-accessType': 'authorizationTokenInside',
+          'x-belink-authorization': process.env.authorizationTokenInside || ""
+        },
+        timeout: 60000, // 设置超时时间为 60 秒
+      });
+
+      const responseData = response.data as ResponseData
+      return responseData.data
+    } catch (error: any) {
+      console.error(`TFS请求失败[${requestId}]: ${error.message}`)
+      errorInfo = error
+      const axiosError = error as AxiosError
+      const ErrorClass = axiosError.response
+        ? axiosError.response.status === 400
+          ? BizError
+          : FulfillError
+        : FulfillError
+      if (axiosError.response) {
+        const response = axiosError.response
+        const data = response.data as ResponseData
+        console.error(`TFS 异常: ${axiosError.message},requestId: ${requestId}`)
+        console.info('响应信息', data.message)
+        console.info('响应信息Data', JSON.stringify(data))
+        console.error('异常堆栈', JSON.stringify(error.stack))
+        if (axiosError.response.status !== 502) {
+          throw new ErrorClass(data.message || 'TFS Error', response.status)
+        }
+        if (retries === maxRetries) {
+          throw new ErrorClass(data.message || 'TFS Error', response.status)
+        }
+      }
+      console.error(`TFS 未知异常: ${axiosError.message}`, error.stack)
+      if (retries === maxRetries) {
+        throw error
+      }
+      retries++
+      // 进行重试
+      await new Promise(resolve => setTimeout(resolve, 1000)) // 延时 1 秒再重试
+    }
+  }
+
+  // 如果重试次数达到上限，抛出错误
+  throw new Error(errorInfo)
+}

package/src/tfs/modules/baseService.ts

@@ -0,0 +1,31 @@
+import envUtils from '../../utils/env'
+import { camelToKebabCase } from '../../utils/string'
+
+export default abstract class BaseService {
+  private isPublicEnv: boolean
+  /** URL一级路径 */
+  protected abstract prefixUrl: string
+  /** 子网域名 */
+  protected readonly natDevHost = 'http://qgostaxv.tfs.nmkh74o4.rlwzae9d.com:8090'
+  protected readonly natProdHost = ''
+  /** 公网域名 */
+  protected readonly publicDevHost = 'https://tfs-74680-5-1304510571.sh.run.tcloudbase.com'
+  protected readonly publicProdHost = ''
+
+  constructor() {
+    /** 如果是云函数环境, 默认走公网访问 */
+    this.isPublicEnv = (process.env.CONTAINER_ENV || 'SCF') === 'SCF'
+  }
+
+  /** 获取API URL */
+  protected getApiUrl(func: Function): string {
+    const host = this.isPublicEnv
+      ? envUtils.isProduction()
+        ? this.publicProdHost
+        : this.publicDevHost
+      : envUtils.isProduction()
+        ? this.natProdHost
+        : this.natDevHost
+    return `${host}${this.prefixUrl}/${camelToKebabCase(func.name)}`
+  }
+}

package/src/tfs/modules/reschedule/service.ts

@@ -0,0 +1,19 @@
+import { callApi } from '../../http'
+import BaseService from '../baseService'
+import { Reschedule } from './type'
+
+class RescheduleService extends BaseService implements Reschedule.Controller {
+  protected prefixUrl: string = '/reschedule'
+
+  rescheduleOrder(request: Reschedule.Request.IRescheduleOrder): Promise<void> {
+    return callApi<Reschedule.Controller['rescheduleOrder']>(this.getApiUrl(this.rescheduleOrder), request)
+  }
+  isOrderCanReschedule(request: Reschedule.Request.IIsOrderCanReschedule): Promise<Reschedule.Response.IIsOrderCanReschedule> {
+    return callApi<Reschedule.Controller['isOrderCanReschedule']>(this.getApiUrl(this.isOrderCanReschedule), request)
+  }
+
+}
+
+const rescheduleService = new RescheduleService()
+
+export default rescheduleService

package/src/tfs/modules/reschedule/type.d.ts

@@ -0,0 +1,51 @@
+export namespace Reschedule {
+
+  export namespace Request {
+    export interface IRescheduleOrder {
+      /** 订单号 */
+      orderId: string
+      /** 目标SkuId */
+      targetSkuId: string
+      /** 原因类型 */
+      reasonType: string
+      /** 原因描述 */
+      reasonDesc: string
+      /** 操作人姓名 */
+      operatorName: string
+      /** 附件列表 */
+      attachment: string[]
+    }
+
+    export interface IIsOrderCanReschedule {
+      /** 订单号 */
+      orderId: string
+      /** 目标SkuId */
+      targetSkuId: string
+      /** 原因类型 */
+      reasonType: string
+      /** 原因描述 */
+      reasonDesc: string
+    }
+  }
+
+  export namespace Response {
+
+    export interface IIsOrderCanReschedule {
+      /** 是否允许改期 */
+      isCanReschedule: boolean
+    }
+  }
+
+  export namespace DTO {
+
+  }
+
+  export interface Controller {
+    /** 更改订单出行日期 */
+    rescheduleOrder(request: Request.IRescheduleOrder): Promise<void>
+
+    /** 校验订单是否允许改期 */
+    isOrderCanReschedule(request: Request.IIsOrderCanReschedule): Promise<Response.IIsOrderCanReschedule>
+  }
+
+}

package/src/types.ts

@@ -0,0 +1,22 @@
+export namespace Fulfill {
+
+  /**
+   * 常量类型
+   */
+  export namespace Constants {
+    /**
+     * 流水类型
+     * @enum
+     */
+    export const enum OperationEnum {
+      /**
+       * 增加
+       */
+      ADD = 'ADD',
+      /**
+       * 扣减
+       */
+      SUBTRACT = 'SUBTRACT',
+    }
+  }
+}

package/src/utils/env.ts

@@ -0,0 +1,14 @@
+const envUtils = {
+  // 环境判断
+  isProduction() {
+    return process.env.NODE_ENV === 'prod'
+  },
+  isDevelopment() {
+    return process.env.NODE_ENV === 'development'
+  },
+  isPPE() {
+    return process.env.NODE_ENV === 'ppe'
+  }
+}
+
+export default envUtils

package/src/utils/string.ts

@@ -0,0 +1,6 @@
+
+/**
+ * Camel case to kebab case
+ * e.g. camelToKebabCase('camelCase') => 'camel-case'
+ */
+export const camelToKebabCase = (str: string) => str.replace(/[A-Z]/g, letter => `-${letter.toLowerCase()}`)

package/tsconfig.json

@@ -0,0 +1,114 @@
+{
+  "include": [
+    "src/**/*",
+  ],
+  "exclude": [
+    "node_modules",
+    "dist"
+  ],
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Enable incremental compilation */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./",                          /* Specify the folder for .tsbuildinfo incremental compilation files. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "es2020",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    "lib": [
+      "ES2020",
+      "DOM"
+    ],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
+    // "reactNamespace": "",                             /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+
+    /* Modules */
+    "module": "commonjs",                                /* Specify what module code is generated. */
+    "rootDir": "./src",                                  /* Specify the root folder within your source files. */
+    "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like `./node_modules/@types`. */
+    "types": [
+      "jest",
+      "node"
+    ],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    "resolveJsonModule": true,                        /* Enable importing .json files */
+    // "noResolve": true,                                /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */
+
+    /* Emit */
+    "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    "declarationMap": false,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
+    "outDir": "./dist",                                   /* Specify an output folder for all emitted files. */
+    "removeComments": false,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like `__extends` in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing `const enum` declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+
+    /* Type Checking */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied `any` type.. */
+    // "strictNullChecks": true,                         /* When type checking, take into account `null` and `undefined`. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when `this` is given the type `any`. */
+    // "useUnknownInCatchVariables": true,               /* Type catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when a local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Include 'undefined' in index signature results */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    // "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+  }
+}

package/typedoc.json

@@ -0,0 +1,15 @@
+{
+  "entryPoints": [
+    "src/index.ts",
+  ],
+  "out": "./docs",
+  "readme": "./README.md",
+  "includeVersion": true,
+  "disableSources": true,
+  "excludePrivate": true,
+  "excludeProtected": true,
+  "tsconfig": "./tsconfig.json",
+  "plugin": [
+    "typedoc-plugin-missing-exports"
+  ]
+}