sane-wasm 0.2.0 → 0.3.0

package/README.md

@@ -24,9 +24,9 @@ https://www.npmjs.com/package/sane-wasm?activeTab=code
 npm install -D sane-wasm
 ```
 
-The main .js will not be bundled with your application. A loader ([lib/loader.js](lib/loader.js)) is provided to automatically load the .js/.wasm files from a CDN ([jsdelivr.com](https://www.jsdelivr.com/)). You can configure the loader to serve the files from your server if you want.
+The main .js will not be bundled with your application. A loader ([lib/loader.js](https://github.com/goncalomb/sane-wasm/blob/master/lib/loader.js)) is provided to automatically load the .js/.wasm files from a CDN ([jsdelivr.com](https://www.jsdelivr.com/)). You can configure the loader to serve the files from your server if you want.
 
-See [examples/webpack/](examples/webpack/) for a working example.
+See [examples/webpack/](https://github.com/goncalomb/sane-wasm/tree/master/examples/webpack) for a working example.
 
 ### For Node.js
 
@@ -36,7 +36,7 @@ npm install sane-wasm usb
 
 The usb package ([node-usb](https://github.com/node-usb/node-usb)) is required to provide USB functionality.
 
-See [examples/node/](examples/node/) for a working example.
+See [examples/node/](https://github.com/goncalomb/sane-wasm/tree/master/examples/node) for a working example.
 
 ### As Git Submodule (not recommended) / Custom Build
 
@@ -103,7 +103,7 @@ usage: build.sh [options]
 
 To do a full build use `npm run build`.
 
-## Exposed API
+## API
 
 Most of the SANE API is exposed as-is. Check the [SANE Standard](https://sane-project.gitlab.io/standard/index.html).
 
@@ -113,12 +113,12 @@ Some safeguards are in place to avoid API misuse and prevent memory leaks. It's
 
 The most important difference with the underlying SANE API is that **device handles are not exposed**. This means that `sane_open()` does not return a device handle. A single handle is managed by the internal code. This effectively means that **only one device can be accessed at a time**. This was a design decision made to simplify the API and prevent other issues.
 
-> Personally, I believe that this is an acceptable change, especially for WebAssembly where it may be easier to lose track of opened resources and crash the application. The SANE API is also somewhat unforgiving and building more safeguards around it (especially with multiple handles) is not worth the effort. Ultimately I don't see a use that requires more than one device open at a time. @goncalomb
+> Personally, I believe that this is an acceptable change, especially for WebAssembly where it may be easier to lose track of opened resources and crash the application. The SANE API is also somewhat unforgiving and building more safeguards around it (especially with multiple handles) is not worth the effort. Ultimately I don't see a use that requires more than one device open at a time. -goncalomb
 
 ### Documentation
 
-For now, check the [src/index.ts](src/index.ts) for the API declaration.
+Check API documentation at: [goncalomb.github.io/sane-wasm/modules.html](https://goncalomb.github.io/sane-wasm/modules.html).
 
 ## License
 
-Because of the weird state of SANE's licensing (GPL + linking exception, on some backends), see [backends/LICENSE](https://gitlab.com/sane-project/backends/-/blob/master/LICENSE). I'm releasing this project with dual licensing [GNU GPLv2](LICENSE.txt) + [GNU LGPLv2.1](LICENSE-LGPL.txt). IANAL, you choose.
+Because of the weird state of SANE's licensing (GPL + linking exception, on some backends), see [backends/LICENSE](https://gitlab.com/sane-project/backends/-/blob/master/LICENSE). I'm releasing this project with dual licensing [GNU GPLv2](https://github.com/goncalomb/sane-wasm/blob/master/LICENSE.txt) + [GNU LGPLv2.1](https://github.com/goncalomb/sane-wasm/blob/master/LICENSE-LGPL.txt). IANAL, you choose.

package/dist/index.d.ts

@@ -1,3 +1,7 @@
+/**
+ * Equivalent to the SANE API C enum `SANE_Status`.
+ * @see {@link https://sane-project.gitlab.io/standard/1.06/api.html#status-type}
+ */
 export declare enum SANEStatus {
     GOOD = 0,
     UNSUPPORTED = 1,
@@ -12,6 +16,10 @@ export declare enum SANEStatus {
     NO_MEM = 10,
     ACCESS_DENIED = 11
 }
+/**
+ * Equivalent to the SANE API C enum `SANE_Value_Type`.
+ * @see {@link https://sane-project.gitlab.io/standard/1.06/api.html#option-value-type}
+ */
 export declare enum SANEValueType {
     BOOL = 0,
     INT = 1,
@@ -20,6 +28,10 @@ export declare enum SANEValueType {
     BUTTON = 4,
     GROUP = 5
 }
+/**
+ * Equivalent to the SANE API C enum `SANE_Unit`.
+ * @see {@link https://sane-project.gitlab.io/standard/1.06/api.html#option-value-unit}
+ */
 export declare enum SANEUnit {
     NONE = 0,
     PIXEL = 1,
@@ -29,12 +41,20 @@ export declare enum SANEUnit {
     PERCENT = 5,
     MICROSECOND = 6
 }
+/**
+ * Equivalent to the SANE API C enum `SANE_Constraint_Type`.
+ * @see {@link https://sane-project.gitlab.io/standard/1.06/api.html#option-value-constraints}
+ */
 export declare enum SANEConstraintType {
     NONE = 0,
     RANGE = 1,
     WORD_LIST = 2,
     STRING_LIST = 3
 }
+/**
+ * Equivalent to the SANE API C enum `SANE_Frame`.
+ * @see {@link https://sane-project.gitlab.io/standard/1.06/api.html#sane-get-parameters}
+ */
 export declare enum SANEFrame {
     GRAY = 0,
     RGB = 1,
@@ -42,22 +62,69 @@ export declare enum SANEFrame {
     GREEN = 3,
     BLUE = 4
 }
+/**
+ * Library state. This is provided by sane-wasm, it's not part of SANE API.
+ */
 export type SANEState = {
+    /**
+     * Is the library initialized with {@link LibSANE.sane_init}?
+     */
     initialized: boolean;
+    /**
+     * Version code provided by the last {@link LibSANE.sane_init} call.
+     * @see {@link https://sane-project.gitlab.io/standard/1.06/api.html#version-control}
+     */
     version_code: number;
+    /**
+     * Version code (decoded) provided by the last {@link LibSANE.sane_init} call.
+     * @see {@link https://sane-project.gitlab.io/standard/1.06/api.html#version-control}
+     */
     version: {
         major: number;
         minor: number;
         build: number;
     };
+    /**
+     * Is a device open with {@link LibSANE.sane_open}?
+     */
     open: boolean;
 };
+/**
+ * Equivalent to the SANE API C type `SANE_Device`.
+ * @see {@link https://sane-project.gitlab.io/standard/1.06/api.html#device-descriptor-type}
+ */
 export type SANEDevice = {
     name: string;
     vendor: string;
     model: string;
     type: string;
 };
+/**
+ * Equivalent to the SANE API C bit mask `SANE_CAP_*`.
+ * @see {@link https://sane-project.gitlab.io/standard/1.06/api.html#option-capabilities}
+ */
+export type SANECap = {
+    SOFT_SELECT: boolean;
+    HARD_SELECT: boolean;
+    SOFT_DETECT: boolean;
+    EMULATED: boolean;
+    AUTOMATIC: boolean;
+    INACTIVE: boolean;
+    ADVANCED: boolean;
+};
+/**
+ * Equivalent to the SANE API C type `SANE_Range`.
+ * @see {@link https://sane-project.gitlab.io/standard/1.06/api.html#option-descriptor-type}
+ */
+export type SANERange = {
+    min: number;
+    max: number;
+    quant: number;
+};
+/**
+ * Equivalent to the SANE API C type `SANE_Option_Descriptor`.
+ * @see {@link https://sane-project.gitlab.io/standard/1.06/api.html#option-descriptor-type}
+ */
 export type SANEOptionDescriptor = {
     name: string;
     title: string;
@@ -65,25 +132,13 @@ export type SANEOptionDescriptor = {
     type: SANEValueType;
     unit: SANEUnit;
     size: number;
-    cap: {
-        SOFT_SELECT: boolean;
-        HARD_SELECT: boolean;
-        SOFT_DETECT: boolean;
-        EMULATED: boolean;
-        AUTOMATIC: boolean;
-        INACTIVE: boolean;
-        ADVANCED: boolean;
-    };
+    cap: SANECap;
 } & ({
     constraint_type: SANEConstraintType.NONE;
     constraint: null;
 } | {
     constraint_type: SANEConstraintType.RANGE;
-    constraint: {
-        min: number;
-        max: number;
-        quant: number;
-    };
+    constraint: SANERange;
 } | {
     constraint_type: SANEConstraintType.WORD_LIST;
     constraint: number[];
@@ -91,11 +146,19 @@ export type SANEOptionDescriptor = {
     constraint_type: SANEConstraintType.STRING_LIST;
     constraint: string[];
 });
+/**
+ * Equivalent to the SANE API C bit mask `SANE_INFO_*`.
+ * @see {@link https://sane-project.gitlab.io/standard/1.06/api.html#sane-control-option}
+ */
 export type SANEInfo = {
     INEXACT: boolean;
     RELOAD_OPTIONS: boolean;
     RELOAD_PARAMS: boolean;
 };
+/**
+ * Equivalent to the SANE API C type `SANE_Parameters`.
+ * @see {@link https://sane-project.gitlab.io/standard/1.06/api.html#sane-get-parameters}
+ */
 export type SANEParameters = {
     format: SANEFrame;
     last_frame: boolean;
@@ -104,86 +167,325 @@ export type SANEParameters = {
     lines: number;
     depth: number;
 };
-type SANEEnum<E, TE> = E & {
+/**
+ * @private Type for enums provided by the core SANE Emscripten module.
+ * @deprecated
+ */
+export type SANEEnum<E, TE> = E & {
     /**
      * @deprecated Use reverse map already built into TS enums.
      */
     asString: (value: TE) => string;
 };
+/**
+ * The core SANE Emscripten module.
+ */
 export interface LibSANE {
+    /**
+     * Commit hash of sane-wasm.
+     */
     SANE_WASM_COMMIT: string;
+    /**
+     * Version code of sane-wasm.
+     */
     SANE_WASM_VERSION: string;
+    /**
+     * List of SANE API backends built into sane-wasm.
+     */
     SANE_WASM_BACKENDS: string;
+    /**
+     * SANE API version code (major).
+     * @see {@link https://sane-project.gitlab.io/standard/1.06/api.html#version-control}
+     */
     SANE_CURRENT_MAJOR: number;
+    /**
+     * SANE API version code (minor).
+     * @see {@link https://sane-project.gitlab.io/standard/1.06/api.html#version-control}
+     */
     SANE_CURRENT_MINOR: number;
+    /**
+     * @deprecated Consider using the SANEStatus enum directly.
+     *
+     * This object is not going away anytime soon (or ever probably).
+     *
+     * But you should consider using the equivalent enum because it doesn't
+     * require having a reference to the library module. All enums are
+     * exported with the package.
+     */
     SANE_STATUS: SANEEnum<typeof SANEStatus, SANEStatus>;
+    /**
+     * @deprecated Consider using the SANEValueType enum directly.
+     *
+     * This object is not going away anytime soon (or ever probably).
+     *
+     * But you should consider using the equivalent enum because it doesn't
+     * require having a reference to the library module. All enums are
+     * exported with the package.
+     */
     SANE_TYPE: SANEEnum<typeof SANEValueType, SANEValueType>;
+    /**
+     * @deprecated Consider using the SANEUnit enum directly.
+     *
+     * This object is not going away anytime soon (or ever probably).
+     *
+     * But you should consider using the equivalent enum because it doesn't
+     * require having a reference to the library module. All enums are
+     * exported with the package.
+     */
     SANE_UNIT: SANEEnum<typeof SANEUnit, SANEUnit>;
+    /**
+     * @deprecated Consider using the SANEConstraintType enum directly.
+     *
+     * This object is not going away anytime soon (or ever probably).
+     *
+     * But you should consider using the equivalent enum because it doesn't
+     * require having a reference to the library module. All enums are
+     * exported with the package.
+     */
     SANE_CONSTRAINT: SANEEnum<typeof SANEConstraintType, SANEConstraintType>;
+    /**
+     * @deprecated Consider using the SANEFrame enum directly.
+     *
+     * This object is not going away anytime soon (or ever probably).
+     *
+     * But you should consider using the equivalent enum because it doesn't
+     * require having a reference to the library module. All enums are
+     * exported with the package.
+     */
     SANE_FRAME: SANEEnum<typeof SANEFrame, SANEFrame>;
+    /**
+     * Get the current state of the library.
+     *
+     * This is provided by sane-wasm, it's not part of SANE API.
+     */
     sane_get_state: () => SANEState;
+    /**
+     * Equivalent to the SANE API C function `sane_init`.
+     * @see {@link https://sane-project.gitlab.io/standard/1.06/api.html#sane-init}
+     */
     sane_init: () => {
-        status: SANEStatus;
+        status: SANEStatus.GOOD;
         version_code: number;
+    } | {
+        status: Exclude<SANEStatus, SANEStatus.GOOD>;
+        version_code: null;
     };
+    /**
+     * Equivalent to the SANE API C function `sane_exit`.
+     * @see {@link https://sane-project.gitlab.io/standard/1.06/api.html#sane-exit}
+     */
     sane_exit: () => Promise<{
         status: SANEStatus;
     }>;
+    /**
+     * Equivalent to the SANE API C function `sane_get_devices`.
+     * @see {@link https://sane-project.gitlab.io/standard/1.06/api.html#sane-get-devices}
+     */
     sane_get_devices: () => Promise<{
-        status: SANEStatus;
+        status: SANEStatus.GOOD;
         devices: SANEDevice[];
+    } | {
+        status: Exclude<SANEStatus, SANEStatus.GOOD>;
+        devices: null;
     }>;
+    /**
+     * Equivalent to the SANE API C function `sane_open`.
+     * @see {@link https://sane-project.gitlab.io/standard/1.06/api.html#sane-open}
+     */
     sane_open: (devicename: string) => Promise<{
         status: SANEStatus;
     }>;
+    /**
+     * Equivalent to the SANE API C function `sane_close`.
+     * @see {@link https://sane-project.gitlab.io/standard/1.06/api.html#sane-close}
+     */
     sane_close: () => Promise<{
         status: SANEStatus;
     }>;
+    /**
+     * Equivalent to the SANE API C function `sane_get_option_descriptor`.
+     *
+     * The result `option_descriptor` can be null even with
+     * `status = SANEStatus.GOOD`, it signals invalid option index.
+     *
+     * @see {@link https://sane-project.gitlab.io/standard/1.06/api.html#sane-get-option-descriptor}
+     */
     sane_get_option_descriptor: (option: number) => {
         status: SANEStatus;
         option_descriptor: SANEOptionDescriptor | null;
     };
+    /**
+     * Equivalent to the SANE API C function `sane_control_option`.
+     *
+     * With `a = SANE_ACTION_GET_VALUE` (get option value).
+     *
+     * @see {@link https://sane-project.gitlab.io/standard/1.06/api.html#sane-control-option}
+     */
     sane_control_option_get_value: (option: number) => Promise<{
-        status: SANEStatus;
+        status: SANEStatus.GOOD;
         value: any;
+    } | {
+        status: Exclude<SANEStatus, SANEStatus.GOOD>;
+        value: null;
     }>;
+    /**
+     * Equivalent to the SANE API C function `sane_control_option`.
+     *
+     * With `a = SANE_ACTION_SET_VALUE` (set option value).
+     *
+     * @see {@link https://sane-project.gitlab.io/standard/1.06/api.html#sane-control-option}
+     */
     sane_control_option_set_value: (option: number, value: any) => Promise<{
-        status: SANEStatus;
+        status: SANEStatus.GOOD;
         info: SANEInfo;
+    } | {
+        status: Exclude<SANEStatus, SANEStatus.GOOD>;
+        info: null;
     }>;
+    /**
+     * Equivalent to the SANE API C function `sane_control_option`.
+     *
+     * With `a = SANE_ACTION_SET_AUTO` (set option automatic).
+     *
+     * @see {@link https://sane-project.gitlab.io/standard/1.06/api.html#sane-control-option}
+     */
     sane_control_option_set_auto: (option: number) => Promise<{
-        status: SANEStatus;
+        status: SANEStatus.GOOD;
         info: SANEInfo;
+    } | {
+        status: Exclude<SANEStatus, SANEStatus.GOOD>;
+        info: null;
     }>;
+    /**
+     * Equivalent to the SANE API C function `sane_get_parameters`.
+     * @see {@link https://sane-project.gitlab.io/standard/1.06/api.html#sane-get-parameters}
+     */
     sane_get_parameters: () => {
-        status: SANEStatus;
+        status: SANEStatus.GOOD;
         parameters: SANEParameters;
+    } | {
+        status: Exclude<SANEStatus, SANEStatus.GOOD>;
+        parameters: null;
     };
+    /**
+     * Equivalent to the SANE API C function `sane_start`.
+     * @see {@link https://sane-project.gitlab.io/standard/1.06/api.html#sane-start}
+     */
     sane_start: () => {
         status: SANEStatus;
     };
+    /**
+     * Equivalent to the SANE API C function `sane_read`.
+     * @see {@link https://sane-project.gitlab.io/standard/1.06/api.html#sane-read}
+     */
     sane_read: () => Promise<{
-        status: SANEStatus;
+        status: SANEStatus.GOOD;
         data: Uint8Array;
+    } | {
+        status: Exclude<SANEStatus, SANEStatus.GOOD>;
+        data: null;
     }>;
+    /**
+     * Equivalent to the SANE API C function `sane_cancel`.
+     * @see {@link https://sane-project.gitlab.io/standard/1.06/api.html#sane-cancel}
+     */
     sane_cancel: () => Promise<{
         status: SANEStatus;
     }>;
+    /**
+     * Equivalent to the SANE API C function `sane_strstatus`.
+     * @see {@link https://sane-project.gitlab.io/standard/1.06/api.html#sane-strstatus}
+     */
     sane_strstatus: (status: SANEStatus) => string;
 }
-export type LibSANEFactory = (option?: {
-    sane?: {
-        loaderURL: string;
-        loaderPrefetchToBlob: boolean;
-        loaderRemoveGlobal: boolean;
-        debugSANE?: boolean;
-        debugUSB?: boolean;
-        debugFunctionCalls?: boolean;
-        debugTestDevices?: number;
-        promisify?: boolean;
-        promisifyQueue?: boolean;
-    };
-} & {
+/**
+ * SANE Emscripten module options (specific to sane-wasm).
+ */
+export type LibSANEOptions = {
+    /**
+     * Loader URL that serves the build artifacts (libsane.js etc.).
+     *
+     * The loader is only used on web environments.
+     *
+     * @defaultvalue "sane-wasm @ jsdelivr.net"
+     */
+    loaderURL?: string;
+    /**
+     * Should the loader prefetch the resources to a Bob object? This is
+     * required when loading from a different origin. Check the loader
+     * code for more information.
+     *
+     * The loader is only used on web environments.
+     *
+     * @defaultvalue `true`
+     */
+    loaderPrefetchToBlob?: boolean;
+    /**
+     * Should the loader remove the global module variable `window.LibSANE`?
+     *
+     * The loader is only used on web environments.
+     *
+     * @defaultvalue `true`
+     */
+    loaderRemoveGlobal?: boolean;
+    /**
+     * Enables SANE low-level debug messages, this can be quite verbose.
+     *
+     * @defaultvalue `false`
+     */
+    debugSANE?: boolean;
+    /**
+     * Enables libusb low-level debug messages, this can be quite verbose.
+     *
+     * @defaultvalue `false`
+     */
+    debugUSB?: boolean;
+    /**
+     * Enables debug messages for SANE function calls.
+     *
+     * @defaultvalue `false`
+     */
+    debugFunctionCalls?: boolean;
+    /**
+     * Sets the number of test devices for SANE's test backend.
+     *
+     * @defaultvalue `0`
+     */
+    debugTestDevices?: number;
+    /**
+     * Enables sane-wasm "promisify" to normalize the API. See pre.js for more
+     * information.
+     *
+     * @deprecated Setting this to `false` changes the API definition! Some
+     * functions may stop being asynchronous in some cases. You want this
+     * option enabled! This option may be removed in the future.
+     *
+     * @defaultvalue `true`
+     */
+    promisify?: boolean;
+    /**
+     * Enables sane-wasm "promisify" queue that queues function calls to
+     * prevent issues with calling multiple asynchronous functions. See pre.js
+     * for more information.
+     *
+     * @deprecated You want this option enabled! This option may be removed in
+     * the future.
+     *
+     * @defaultvalue `true`
+     */
+    promisifyQueue?: boolean;
+};
+/**
+ * The factory that initializes the core SANE Emscripten module.
+ */
+export type LibSANEFactory = (options?: {
+    /**
+     * Emscripten module options specific to sane-wasm.
+     */
+    sane?: LibSANEOptions;
+    /**
+     * Other Emscripten module options.
+     */
     [k: string]: any;
 }) => Promise<LibSANE>;
 /**

package/dist/index.js

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.libsane = exports.SANEFrame = exports.SANEConstraintType = exports.SANEUnit = exports.SANEValueType = exports.SANEStatus = void 0;
+/**
+ * Equivalent to the SANE API C enum `SANE_Status`.
+ * @see {@link https://sane-project.gitlab.io/standard/1.06/api.html#status-type}
+ */
 var SANEStatus;
 (function (SANEStatus) {
     SANEStatus[SANEStatus["GOOD"] = 0] = "GOOD";
@@ -16,6 +20,10 @@ var SANEStatus;
     SANEStatus[SANEStatus["NO_MEM"] = 10] = "NO_MEM";
     SANEStatus[SANEStatus["ACCESS_DENIED"] = 11] = "ACCESS_DENIED";
 })(SANEStatus || (exports.SANEStatus = SANEStatus = {}));
+/**
+ * Equivalent to the SANE API C enum `SANE_Value_Type`.
+ * @see {@link https://sane-project.gitlab.io/standard/1.06/api.html#option-value-type}
+ */
 var SANEValueType;
 (function (SANEValueType) {
     SANEValueType[SANEValueType["BOOL"] = 0] = "BOOL";
@@ -25,6 +33,10 @@ var SANEValueType;
     SANEValueType[SANEValueType["BUTTON"] = 4] = "BUTTON";
     SANEValueType[SANEValueType["GROUP"] = 5] = "GROUP";
 })(SANEValueType || (exports.SANEValueType = SANEValueType = {}));
+/**
+ * Equivalent to the SANE API C enum `SANE_Unit`.
+ * @see {@link https://sane-project.gitlab.io/standard/1.06/api.html#option-value-unit}
+ */
 var SANEUnit;
 (function (SANEUnit) {
     SANEUnit[SANEUnit["NONE"] = 0] = "NONE";
@@ -35,6 +47,10 @@ var SANEUnit;
     SANEUnit[SANEUnit["PERCENT"] = 5] = "PERCENT";
     SANEUnit[SANEUnit["MICROSECOND"] = 6] = "MICROSECOND";
 })(SANEUnit || (exports.SANEUnit = SANEUnit = {}));
+/**
+ * Equivalent to the SANE API C enum `SANE_Constraint_Type`.
+ * @see {@link https://sane-project.gitlab.io/standard/1.06/api.html#option-value-constraints}
+ */
 var SANEConstraintType;
 (function (SANEConstraintType) {
     SANEConstraintType[SANEConstraintType["NONE"] = 0] = "NONE";
@@ -42,6 +58,10 @@ var SANEConstraintType;
     SANEConstraintType[SANEConstraintType["WORD_LIST"] = 2] = "WORD_LIST";
     SANEConstraintType[SANEConstraintType["STRING_LIST"] = 3] = "STRING_LIST";
 })(SANEConstraintType || (exports.SANEConstraintType = SANEConstraintType = {}));
+/**
+ * Equivalent to the SANE API C enum `SANE_Frame`.
+ * @see {@link https://sane-project.gitlab.io/standard/1.06/api.html#sane-get-parameters}
+ */
 var SANEFrame;
 (function (SANEFrame) {
     SANEFrame[SANEFrame["GRAY"] = 0] = "GRAY";

package/package.json

@@ -1,17 +1,18 @@
 {
   "name": "sane-wasm",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "A project to bring the SANE API to the web.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
     "test": "jest",
-    "clean": "npm run clean:tsc && npm run clean:sane",
-    "clean:tsc": "rm -rf dist/",
+    "clean": "npm run clean:ts && npm run clean:sane",
+    "clean:ts": "rm -rf dist/ docs/",
     "clean:sane": "./build.sh --no-build --clean",
-    "prebuild": "rm -rf dist/ build/",
-    "build": "npm run build:tsc && npm run build:sane",
-    "build:tsc": "tsc",
+    "prebuild": "rm -rf dist/ docs/ build/",
+    "build": "npm run build:ts && npm run build:sane",
+    "build:ts": "tsc && typedoc",
+    "postbuild:ts": "rm -rf dist/docs-plugin.*",
     "build:sane": "./build.sh --with-docker --clean",
     "debug:sane": "./build.sh --with-docker --debug --emrun"
   },
@@ -49,6 +50,7 @@
   "devDependencies": {
     "jest": "^29.6.4",
     "jest-extended": "^4.0.1",
+    "typedoc": "^0.25.0",
     "typescript": "^5.2.2"
   }
 }