ts-japi 1.6.1 → 1.6.2

package/package.json

@@ -1,15 +1,18 @@
 {
   "name": "ts-japi",
-  "version": "1.6.1",
+  "version": "1.6.2",
   "description": "A highly-modular (typescript-friendly)-framework agnostic library for serializing data to the JSON:API specification",
   "main": "lib/index.js",
   "scripts": {
-    "examples": "ts-node ./examples/",
-    "benchmark": "ts-node ./benchmarks/serializer.benchmark",
+    "test": " jest --runInBand --verbose --coverage",
     "playground": "ts-node ./benchmarks/playground.benchmark",
+    "lint": "eslint .",
+    "examples": "ts-node ./examples/",
+    "docs": "npm run api-extractor && ts-node tools/generate_docs.ts",
     "clean": "make clean",
-    "build": "make",
-    "test": " jest --runInBand --verbose --coverage"
+    "build": "tsc",
+    "benchmark": "ts-node ./benchmarks/serializer.benchmark",
+    "api-extractor": "api-extractor run"
   },
   "publishConfig": {
     "access": "public",
@@ -30,39 +33,42 @@
     "backend",
     "front-end"
   ],
-  "repository": "mu-io/ts-japi",
+  "repository": "mathematic-inc/ts-japi",
   "engines": {
     "node": ">=10"
   },
   "devDependencies": {
-    "@babel/cli": "^7.14.8",
-    "@babel/core": "^7.14.8",
-    "@babel/plugin-proposal-class-properties": "^7.14.5",
-    "@babel/plugin-proposal-export-namespace-from": "^7.14.5",
-    "@babel/plugin-proposal-object-rest-spread": "^7.14.7",
-    "@babel/preset-env": "^7.14.8",
-    "@babel/preset-typescript": "^7.14.5",
-    "@changesets/cli": "^2.16.0",
+    "@babel/cli": "^7.18.6",
+    "@babel/core": "^7.18.6",
+    "@babel/plugin-proposal-class-properties": "^7.18.6",
+    "@babel/plugin-proposal-export-namespace-from": "^7.18.6",
+    "@babel/plugin-proposal-object-rest-spread": "^7.18.6",
+    "@babel/preset-env": "^7.18.6",
+    "@babel/preset-typescript": "^7.18.6",
+    "@changesets/cli": "^2.23.0",
+    "@microsoft/api-documenter": "^7.18.0",
+    "@microsoft/api-extractor": "^7.28.2",
     "@types/benchmark": "^2.1.1",
-    "@types/jest": "^26.0.24",
-    "@types/lodash": "^4.14.171",
-    "@types/uuid": "^8.3.1",
-    "@typescript-eslint/eslint-plugin": "^4.28.5",
-    "@typescript-eslint/parser": "^4.28.5",
-    "babel-jest": "^27.0.6",
+    "@types/jest": "^28.1.4",
+    "@types/lodash": "^4.14.182",
+    "@types/uuid": "^8.3.4",
+    "@typescript-eslint/eslint-plugin": "^5.30.3",
+    "@typescript-eslint/parser": "^5.30.3",
+    "babel-jest": "^28.1.2",
     "benchmark": "^2.1.4",
-    "core-js": "^3.16.0",
-    "eslint": "^7.32.0",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-prettier": "^3.4.0",
-    "jest": "^27.0.6",
+    "core-js": "^3.23.3",
+    "eslint": "^8.19.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-tsdoc": "^0.2.16",
+    "jest": "^28.1.2",
     "lodash": "^4.17.21",
-    "prettier": "^2.3.2",
+    "prettier": "^2.7.1",
     "regenerator-runtime": "^0.13.9",
-    "ts-node": "^10.1.0",
-    "typedoc": "^0.21.4",
-    "typedoc-plugin-markdown": "^3.10.4",
-    "typescript": "^4.3.5",
+    "ts-node": "^10.8.2",
+    "typedoc": "^0.23.5",
+    "typedoc-plugin-markdown": "^3.13.2",
+    "typescript": "^4.7.4",
     "uuid": "^8.3.2"
   },
   "babel": {

package/tools/generate_docs.ts

@@ -0,0 +1,33 @@
+/**
+ * Copyright 2022 Google Inc. 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
+ *
+ *     https://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.
+ */
+
+import { copyFileSync } from 'fs';
+import { join } from 'path';
+import { chdir } from 'process';
+
+// eslint-disable-next-line import/extensions
+import { generateDocs } from './internal/custom_markdown_action';
+
+// Change to root directory
+chdir(join(__dirname, '..'));
+
+// README
+{
+  copyFileSync('README.md', 'docs/index.md');
+}
+
+// Generate documentation
+generateDocs('docs/ts-japi.api.json', 'docs/api');

package/tools/internal/custom_markdown_action.ts

@@ -0,0 +1,32 @@
+/**
+ * Copyright 2022 Google Inc. 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
+ *
+ *     https://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.
+ */
+
+import { ApiModel } from '@microsoft/api-extractor-model';
+
+// eslint-disable-next-line import/extensions
+import { MarkdownDocumenter } from './custom_markdown_documenter';
+
+export const generateDocs = (jsonPath: string, outputDir: string): void => {
+  const apiModel = new ApiModel();
+  apiModel.loadPackage(jsonPath);
+
+  const markdownDocumenter: MarkdownDocumenter = new MarkdownDocumenter({
+    apiModel: apiModel,
+    documenterConfig: undefined,
+    outputFolder: outputDir,
+  });
+  markdownDocumenter.generateFiles();
+};