build docs to dist

Author: edsilv

package-lock.json

@@ -23,6 +23,7 @@
     "build-es": "node ./esbuild.mjs",
     "build-tsc": "tsc --skipLibCheck --module CommonJS --esModuleInterop --declarationDir ./dist/cjs --declaration --outDir ./dist/cjs -p . && npm run copy-files",
     "copy-files": "copyfiles -u 1 src/**/*.svg dist/cjs && copyfiles -u 1 src/**/*.gif dist/cjs && copyfiles -u 1 src/**/*.less dist/cjs && copyfiles -u 1 src/extensions/**/*.less dist/cjs && copyfiles -u 1 src/**/*.css dist/cjs",
+    "docs": "typedoc --plugin typedoc-plugin-missing-exports",
     "test": "jest",
     "prepublishOnly": "npm run build && npm run build-tsc && npm run build-es"
   },
@@ -73,7 +74,9 @@
     "ts-jest": "22.4.2",
     "ts-loader": "9.2.6",
     "tslint-config-prettier": "^1.18.0",
-    "typescript": "4.4.3",
+    "typedoc": "^0.25.4",
+    "typedoc-plugin-missing-exports": "^2.1.0",
+    "typescript": "4.6.2",
     "typescript-tslint-plugin": "^0.5.5",
     "url-loader": "4.1.1",
     "webpack": "^5.59.1",
@@ -116,8 +119,8 @@
     "react": "^18.0.0",
     "react-dom": "^18.0.0",
     "react-intersection-observer": "^8.34.0",
-    "xss": "1.0.3",
     "waveform-panel": "^1.2.0",
+    "xss": "1.0.3",
     "zustand": "^4.0.0-rc.0"
   },
   "collective": {

package.json

@@ -0,0 +1,19 @@
+import { Config as ModelViewerExtensionConfig } from "@/content-handlers/iiif/extensions/uv-model-viewer-extension/config/Config";
+import { Config as AlephExtensionConfig } from "@/content-handlers/iiif/extensions/uv-aleph-extension/config/Config";
+import { Config as AVExtensionConfig } from "@/content-handlers/iiif/extensions/uv-av-extension/config/Config";
+import { Config as EbookExtensionConfig } from "@/content-handlers/iiif/extensions/uv-ebook-extension/config/Config";
+import { Config as MediaElementExtensionConfig } from "@/content-handlers/iiif/extensions/uv-mediaelement-extension/config/Config";
+import { Config as OSDExtensionConfig } from "@/content-handlers/iiif/extensions/uv-openseadragon-extension/config/Config";
+import { Config as DefaultExtensionConfig } from "@/content-handlers/iiif/extensions/uv-default-extension/config/Config";
+import { Config as PDFExtensionConfig } from "@/content-handlers/iiif/extensions/uv-pdf-extension/config/Config";
+
+export type IIIFContentHandlerConfig = {
+  aleph: AlephExtensionConfig;
+  av: AVExtensionConfig;
+  default: DefaultExtensionConfig;
+  ebook: EbookExtensionConfig;
+  mediaelement: MediaElementExtensionConfig;
+  modelViewer: ModelViewerExtensionConfig;
+  osd: OSDExtensionConfig;
+  pdf: PDFExtensionConfig;
+};

src/content-handlers/iiif/Docs.ts

@@ -21,10 +21,10 @@
     "sourceMap": true,
     "strictNullChecks": true,
     "esModuleInterop": true,
-    "suppressImplicitAnyIndexErrors": true,
     "target": "ES5",
     "tsBuildInfoFile": "./buildcache/front-end",
-    "types": ["@iiif/base-component", "jest", "jquery", "node"]
+    "types": ["@iiif/base-component", "jest", "jquery", "node"],
+    "skipLibCheck": true
   },
   "exclude": ["node_modules", "src/**/*.test.ts", "src/**/*.spec.ts"],
   "include": ["src"]

tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "entryPoints": ["src/content-handlers/iiif/Docs.ts"],
+  "out": "dist/docs"
+}