Improved typedoc

Author: joepio

lib/src/parse.ts

@@ -87,6 +87,8 @@ export function parseJsonADResource(
   return resource;
 }
 
+/** Resources in JSON-AD can be referenced by their URL (string),
+ * be entire (nested) resources, in which case they are JSONObjects */
 type StringOrNestedResource = string | JSONObject;
 
 /**

lib/src/resource.ts

@@ -403,11 +403,15 @@ export class Resource {
   }
 }
 
+/** Type of Rights (e.g. read or write) */
 enum RightType {
+  /** Open a resource or its children */
   READ = 'read',
+  /** Edit or delete a resource or its children */
   WRITE = 'write',
 }
 
+/** A grant / permission that is set somewhere */
 export interface Right {
   /** Subject of the Agent who the right is for */
   for: string;

lib/src/store.ts

@@ -11,6 +11,7 @@ import {
 } from './index';
 import { authenticate, fetchWebSocket, startWebsocket } from './websockets';
 
+/** Function called when a resource is updated or removed */
 type Callback = (resource: Resource) => void;
 
 export enum StoreEvents {
@@ -28,10 +29,13 @@ export enum StoreEvents {
   ResourceManuallyCreated = 'resource-manually-created',
 }
 
+/**
+ * Handlers are functions that are called when a certain event occurs.
+ */
 type StoreEventHandlers = {
-  [StoreEvents.ResourceSaved]: (resource: Resource) => void;
-  [StoreEvents.ResourceRemoved]: (resource: Resource) => void;
-  [StoreEvents.ResourceManuallyCreated]: (resource: Resource) => void;
+  [StoreEvents.ResourceSaved]: Callback;
+  [StoreEvents.ResourceRemoved]: Callback;
+  [StoreEvents.ResourceManuallyCreated]: Callback;
 };
 
 /**

package.json

@@ -27,6 +27,7 @@
     "react": "^18.2.0",
     "ts-jest": "^29.0.1",
     "typedoc": "^0.23.14",
+    "typedoc-plugin-missing-exports": "^1.0.0",
     "typescript": "^4.8",
     "vite": "^3.0.5"
   },

pnpm-lock.yaml

@@ -1,6 +1,6 @@
 {
   "$schema": "https://typedoc.org/schema.json",
-  "entryPointStrategy": "Packages",
+  "entryPointStrategy": "packages",
   "excludeExternals": true,
   "readme": "DOCS.md",
   "name": "@tomic",