chore: automate-docs

fix doc generation commands

.eslintignore

@@ -1,2 +1,3 @@
 node_modules
 pnpm-lock.yaml
+packages/*/docs

.gitignore

@@ -61,6 +61,7 @@ todos/*
 users/*
 #Project Docs
 docs/packages/javascript-sdk
+packages/*/docs
 **/playwright-report
 **/playwright/.cache
 

packages/davinci-client/.eslintignore

@@ -6,3 +6,4 @@ LICENSE
 .bin
 dist
 .eslintignore
+docs

packages/davinci-client/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forgerock/davinci-client",
-  "version": "0.0.1-davinci.6",
+  "version": "0.0.1-davinci.8",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
   "typings": "./dist/index.d.ts",

packages/davinci-client/project.json

@@ -5,6 +5,9 @@
   "projectType": "library",
   "tags": ["scope:package"],
   "targets": {
+    "docs": {
+      "command": "pnpm typedoc --options {projectRoot}/typedoc.json"
+    },
     "build": {
       "inputs": [
         "default",

packages/davinci-client/typedoc.json

@@ -0,0 +1,68 @@
+{
+  "entryPointStrategy": "expand",
+  "entryPoints": ["./src/"],
+  "tsconfig": "tsconfig.lib.json",
+  "compilerOptions": {},
+  "exclude": [
+    "**/*.(spec|test|e2e).ts",
+    "**/*.mock.*",
+    "**/*.data.*",
+    "docs/**",
+    "tests/**",
+    "specs/**",
+    "spec/**",
+    "test/**"
+  ],
+  "externalPattern": ["**/node_modules/**"],
+  "excludeExternals": true,
+  "excludeInternal": false,
+  "excludePrivate": false,
+  "excludeProtected": false,
+  "excludeNotDocumented": false,
+  "externalSymbolLinkMappings": {},
+  "out": "./docs",
+  "emit": "docs",
+  "theme": "hierarchy",
+  "name": "davinci-client",
+  "includeVersion": true,
+  "readme": "./README.md",
+  "disableSources": false,
+  "excludeTags": [],
+  "cname": "",
+  "sourceLinkTemplate": "",
+  "gitRevision": "master",
+  "gitRemote": "origin",
+  "lang": "en",
+  "githubPages": true,
+  "hideGenerator": true,
+  "searchInComments": false,
+  "cleanOutputDir": true,
+  "titleLink": "",
+  "navigationLinks": {},
+  "sidebarLinks": {},
+  "commentStyle": "all",
+  "categorizeByGroup": true,
+  "defaultCategory": "Other",
+  "categoryOrder": [],
+  "sort": ["visibility", "required-first", "source-order"],
+  "visibilityFilters": {
+    "protected": true,
+    "private": true,
+    "inherited": true,
+    "external": true
+  },
+  "searchCategoryBoosts": {},
+  "searchGroupBoosts": {},
+  "preserveWatchOutput": false,
+  "skipErrorChecking": false,
+  "validation": {
+    "notExported": true,
+    "invalidLink": true,
+    "notDocumented": true
+  },
+  "requiredToBeDocumented": [],
+  "treatWarningsAsErrors": false,
+  "intentionallyNotExported": [],
+  "logLevel": "Verbose",
+  "plugin": ["typedoc-plugin-rename-defaults", "typedoc-theme-hierarchy"]
+}

packages/device-client/.eslintignore

@@ -6,3 +6,4 @@ LICENSE
 .bin
 dist
 .eslintignore
+docs

packages/device-client/project.json

@@ -5,6 +5,9 @@
   "projectType": "library",
   "tags": ["scope:package"],
   "targets": {
+    "docs": {
+      "command": "pnpm typedoc --options {projectRoot}/typedoc.json"
+    },
     "build": {
       "outputs": ["{projectRoot}/{options.outDir}", "{projectRoot}/dist"],
       "options": {

packages/device-client/tsconfig.json

@@ -1,8 +1,8 @@
 {
   "extends": "../../tsconfig.base.json",
   "compilerOptions": {
-    "module": "NodeNext",
-    "moduleResolution": "NodeNext",
+    "module": "ES2020",
+    "moduleResolution": "Bundler",
     "forceConsistentCasingInFileNames": true,
     "strict": true,
     "noImplicitOverride": true,

packages/device-client/typedoc.json

@@ -0,0 +1,68 @@
+{
+  "entryPointStrategy": "expand",
+  "entryPoints": ["./src/"],
+  "tsconfig": "tsconfig.lib.json",
+  "compilerOptions": {},
+  "exclude": [
+    "**/*.(spec|test|e2e).ts",
+    "**/*.mock.*",
+    "**/*.data.*",
+    "docs/**",
+    "tests/**",
+    "specs/**",
+    "spec/**",
+    "test/**"
+  ],
+  "externalPattern": ["**/node_modules/**"],
+  "excludeExternals": true,
+  "excludeInternal": false,
+  "excludePrivate": false,
+  "excludeProtected": false,
+  "excludeNotDocumented": false,
+  "externalSymbolLinkMappings": {},
+  "out": "./docs",
+  "emit": "docs",
+  "theme": "hierarchy",
+  "name": "device-client",
+  "includeVersion": true,
+  "readme": "./README.md",
+  "disableSources": false,
+  "excludeTags": [],
+  "cname": "",
+  "sourceLinkTemplate": "",
+  "gitRevision": "master",
+  "gitRemote": "origin",
+  "lang": "en",
+  "githubPages": true,
+  "hideGenerator": true,
+  "searchInComments": false,
+  "cleanOutputDir": true,
+  "titleLink": "",
+  "navigationLinks": {},
+  "sidebarLinks": {},
+  "commentStyle": "all",
+  "categorizeByGroup": true,
+  "defaultCategory": "Other",
+  "categoryOrder": [],
+  "sort": ["visibility", "required-first", "source-order"],
+  "visibilityFilters": {
+    "protected": true,
+    "private": true,
+    "inherited": true,
+    "external": true
+  },
+  "searchCategoryBoosts": {},
+  "searchGroupBoosts": {},
+  "preserveWatchOutput": false,
+  "skipErrorChecking": false,
+  "validation": {
+    "notExported": true,
+    "invalidLink": true,
+    "notDocumented": true
+  },
+  "requiredToBeDocumented": [],
+  "treatWarningsAsErrors": false,
+  "intentionallyNotExported": [],
+  "logLevel": "Verbose",
+  "plugin": ["typedoc-plugin-rename-defaults", "typedoc-theme-hierarchy"]
+}

packages/javascript-sdk/.eslintignore

@@ -5,3 +5,4 @@ LICENSE
 .env*
 .bin
 dist
+docs

packages/javascript-sdk/project.json

@@ -6,7 +6,7 @@
   "tags": ["scope:sdk"],
   "targets": {
     "docs": {
-      "command": "npx typedoc --options packages/javascript-sdk/typedoc.json"
+      "command": "pnpm typedoc --options {projectRoot}/typedoc.json"
     },
     "build": {
       "inputs": [

packages/javascript-sdk/typedoc.json

@@ -20,7 +20,7 @@
   "excludeProtected": false,
   "excludeNotDocumented": false,
   "externalSymbolLinkMappings": {},
-  "out": "../../docs/packages/javascript-sdk",
+  "out": "./docs",
   "emit": "docs",
   "theme": "hierarchy",
   "name": "javascript-sdk",

packages/ping-protect/.eslintignore

@@ -6,4 +6,5 @@ LICENSE
 .bin
 dist
 src/lib/ping-signals-sdk.js
-.eslintignore
+.eslintignore
+docs

packages/ping-protect/project.json

@@ -6,7 +6,7 @@
   "tags": ["scope:package"],
   "targets": {
     "docs": {
-      "command": "npx typedoc --options ./packages/ping-protect/typedoc.json"
+      "command": "pnpm typedoc --options {projectRoot}/typedoc.json"
     },
     "build": {
       "inputs": [

packages/ping-protect/typedoc.json

@@ -20,7 +20,7 @@
   "excludeProtected": false,
   "excludeNotDocumented": false,
   "externalSymbolLinkMappings": {},
-  "out": "../../docs/packages/ping-protect",
+  "out": "./docs",
   "emit": "docs",
   "theme": "hierarchy",
   "name": "ping-protect",

packages/token-vault/.eslintignore

@@ -6,3 +6,4 @@ LICENSE
 .env*
 .bin
 dist
+docs

packages/token-vault/project.json

@@ -5,6 +5,9 @@
   "projectType": "library",
   "tags": ["scope:package"],
   "targets": {
+    "docs": {
+      "command": "pnpm typedoc --options {projectRoot}/typedoc.json"
+    },
     "build": {
       "dependsOn": ["javascript-sdk:build"],
       "inputs": [

packages/token-vault/typedoc.json

@@ -0,0 +1,68 @@
+{
+  "entryPointStrategy": "expand",
+  "entryPoints": ["./src/"],
+  "tsconfig": "tsconfig.lib.json",
+  "compilerOptions": {},
+  "exclude": [
+    "**/*.(spec|test|e2e).ts",
+    "**/*.mock.*",
+    "**/*.data.*",
+    "docs/**",
+    "tests/**",
+    "specs/**",
+    "spec/**",
+    "test/**"
+  ],
+  "externalPattern": ["**/node_modules/**"],
+  "excludeExternals": true,
+  "excludeInternal": false,
+  "excludePrivate": false,
+  "excludeProtected": false,
+  "excludeNotDocumented": false,
+  "externalSymbolLinkMappings": {},
+  "out": "./docs",
+  "emit": "docs",
+  "theme": "hierarchy",
+  "name": "token-vault",
+  "includeVersion": true,
+  "readme": "./README.md",
+  "disableSources": false,
+  "excludeTags": [],
+  "cname": "",
+  "sourceLinkTemplate": "",
+  "gitRevision": "master",
+  "gitRemote": "origin",
+  "lang": "en",
+  "githubPages": true,
+  "hideGenerator": true,
+  "searchInComments": false,
+  "cleanOutputDir": true,
+  "titleLink": "",
+  "navigationLinks": {},
+  "sidebarLinks": {},
+  "commentStyle": "all",
+  "categorizeByGroup": true,
+  "defaultCategory": "Other",
+  "categoryOrder": [],
+  "sort": ["visibility", "required-first", "source-order"],
+  "visibilityFilters": {
+    "protected": true,
+    "private": true,
+    "inherited": true,
+    "external": true
+  },
+  "searchCategoryBoosts": {},
+  "searchGroupBoosts": {},
+  "preserveWatchOutput": false,
+  "skipErrorChecking": false,
+  "validation": {
+    "notExported": true,
+    "invalidLink": true,
+    "notDocumented": true
+  },
+  "requiredToBeDocumented": [],
+  "treatWarningsAsErrors": false,
+  "intentionallyNotExported": [],
+  "logLevel": "Verbose",
+  "plugin": ["typedoc-plugin-rename-defaults", "typedoc-theme-hierarchy"]
+}