Updated how types are handled.

1. Updated version of TypeScript.
2. Autogenerated d.ts file from JSDoc comments.
3. Added src/types.js where all project-wide types are amalgamented.

Author: Wobbabits

dist/runtime.js.map

@@ -1,6 +1,6 @@
 {
   "name": "@composi/runtime",
-  "version": "1.3.4",
+  "version": "1.3.5",
   "description": "A JavaScript library providing state management for DOM renderers.",
   "main": "src/index.js",
   "module": "dist/runtime.mjs",
@@ -54,8 +54,9 @@
     "rollup-plugin-babel-minify": "^6.0.0",
     "rollup-plugin-commonjs": "^8.2.0",
     "rollup-plugin-node-resolve": "^3.0.0",
-    "typescript": "^3.0.3"
+    "typescript": "^3.7.3"
   },
+  "typings": "types",
   "publishConfig": {
     "access": "public"
   }

dist/runtime.mjs.map

@@ -1,7 +1,7 @@
 /**
- * @typedef {import('./runtime').Send} Send
- * @typedef {import('./runtime').Message} Message
- * @typedef {Object} State
+ * @typedef {import('./types').Send} Send
+ * @typedef {import('./types').Message} Message
+ * @typedef {import('./types').State} State
  * @typedef {() => State} GetState
  * @typedef {(send?: Send, getState?: GetState) => any} Effect
  */

package-lock.json

@@ -2,22 +2,4 @@ export { run } from './runtime'
 export { union } from './union'
 export { batchEffects, batch } from './effects'
 
-/**
- * Make types available to programs that use them.
- */
-/**
- * A program which is executed by the `run` function.
- * @typedef { import('./runtime').Program } Program
- */
-/**
- * Message dispatched by the `send` function to the program's `update` method.
- * @typedef { import('./runtime').Message } Message
- */
-/**
- * Type of state, which can be of any type.
- * @typedef { import('./runtime').State } State
- */
-/**
- * Function for sending messages to the program's `update` method.
- * @typedef { import('./runtime').Send } Send
- */
+

package.json

@@ -1,26 +1,4 @@
-/**
- * @typedef {Object<string, any>} Message
- * @prop {string} type
- * @prop {any} [data]
- * @typedef {(msg?: Message | Function, data?: any) => Message} Send
- * @typedef {() => State} GetState
- */
-/**
- * @typedef {any} State Simple or complex types for application state.
- */
-/**
- * @typedef {State | void} InitResult Return result of program init method.
- */
-/**
- * @typedef {Object<string, any>} Program A program to run.
- * @prop {() => InitResult} init Method to set up initial state.
- * @prop {(state: State, send?: Send) => void} view Method to present the current application state.
- * @prop {(state: State, msg?: Message, send?: Send) => any} update Method to capture messages sent from view or subscriptions. According to the message, an action will transform application state and pass it the the program view method.
- * @prop {(send?: Send, getState?: GetState) => void} [subscriptions] Method to run effects when the program starts. These run independently from the rest of the program.
- * @prop {(send?: Send, getState?: GetState) => void} [subs] Shortcut for subscriptions.
- * @prop {(state: State) => void} [done] Method to do clean up when shutting down a program.
- * @prop {Send} [send] A static send function for dispatching message to a program. Used with routers and in composition.
- */
+
 /**
  * The @composi/runtime.
  * @example
@@ -47,7 +25,7 @@
  * // Run the program:
  * run(program)
  * ```
- * @param {Program} program A program to run with five methods: `init`, `view`, `update`, `subscriptions` and `done`.
+ * @param {import('./types').Program} program A program to run with five methods: `init`, `view`, `update`, `subscriptions` and `done`.
  * @return {() => void} Function to terminate runtime.
  */
 export function run(program) {
@@ -63,7 +41,7 @@ export function run(program) {
 
   /**
    * Send a message.
-   * @param {Message} message
+   * @param {import('./types').Message} message
    *
    */
   function send(message, data) {

src/effects.js

@@ -0,0 +1,32 @@
+// Dummy export to make this a module with exportable types.
+export {}
+
+/**
+ * @typedef {Object} Tag
+ * @prop {string} type
+ * @prop {any} [data]
+ */
+
+/**
+ * @typedef {Object<string, any>} Message
+ * @prop {string} type
+ * @prop {any} [data]
+ * @typedef {(msg?: Message | Function, data?: any) => Message} Send
+ * @typedef {() => State} GetState
+ */
+/**
+ * @typedef {any} State Simple or complex types for application state.
+ */
+/**
+ * @typedef {State | void} InitResult Return result of program init method.
+ */
+/**
+ * @typedef {Object<string, any>} Program A program to run.
+ * @prop {() => InitResult} init Method to set up initial state.
+ * @prop {(state: State, send?: Send) => void} view Method to present the current application state.
+ * @prop {(state: State, msg?: Message, send?: Send) => any} update Method to capture messages sent from view or subscriptions. According to the message, an action will transform application state and pass it the the program view method.
+ * @prop {(send?: Send, getState?: GetState) => void} [subscriptions] Method to run effects when the program starts. These run independently from the rest of the program.
+ * @prop {(send?: Send, getState?: GetState) => void} [subs] Shortcut for subscriptions.
+ * @prop {(state: State) => void} [done] Method to do clean up when shutting down a program.
+ * @prop {Send} [send] A static send function for dispatching message to a program. Used with routers and in composition.
+ */

src/index.d.ts

@@ -3,13 +3,9 @@
  */
 const hasOwnProperty = Object.prototype.hasOwnProperty
 
+
 /**
- * @typedef {Object} Tag
- * @prop {string} type
- * @prop {any} [data]
- */
-/**
- * @param {Tag} tag
+ * @param {import('./types').Tag} tag
  * @param {Object<string, Function>} handlers
  * @param {() => void} [catchAll]
  */

src/index.js

@@ -3,10 +3,22 @@
     "target": "es6",
     "allowJs": true,
     "checkJs": true,
-    "noEmit": true,
     "moduleResolution": "node",
+    "alwaysStrict": true,
+    "strictNullChecks": false,
+    "emitDeclarationOnly": true,
+    "declaration": true,
+    "outDir": "types",
+    "removeComments": false
   },
-  "include": [
-    "src/*.js",
+  "files": [
+    "src/effects.js",
+    "src/runtime.js",
+    "src/union.js",
+    "src/index.js"
+  ],
+  "exclude": [
+    "node_modules",
+    "types"
   ]
 }

src/runtime.js

@@ -0,0 +1,10 @@
+export function batchEffects(...effects: ((send?: (msg?: Function | import("./types").Message, data?: any) => import("./types").Message, getState?: () => any) => any)[]): (send?: (msg?: Function | import("./types").Message, data?: any) => import("./types").Message, getState?: () => any) => void;
+export function batch(...effects: ((send?: (msg?: Function | import("./types").Message, data?: any) => import("./types").Message, getState?: () => any) => any)[]): (send?: (msg?: Function | import("./types").Message, data?: any) => import("./types").Message, getState?: () => any) => void;
+export type Send = (msg?: Function | import("./types").Message, data?: any) => import("./types").Message;
+export type Message = {
+    type: string;
+    data?: any;
+};
+export type State = any;
+export type GetState = () => any;
+export type Effect = (send?: (msg?: Function | import("./types").Message, data?: any) => import("./types").Message, getState?: () => any) => any;

src/types.js

@@ -0,0 +1,3 @@
+export { run } from "./runtime";
+export { union } from "./union";
+export { batchEffects, batch } from "./effects";

src/union.js

@@ -0,0 +1,30 @@
+/**
+ * The @composi/runtime.
+ * @example
+ *
+ * ```
+ * // Create a runtime program
+ * const program = {
+ *   // Define state:
+ *   init() {
+ *     return [{count: 0}]
+ *   },
+ *   // Define view to render.
+ *   // Notice event to send message 'incr'.
+ *   view(state, send) {
+ *      return render(<div onclick={send('incr')}>The count is: {state.count}</div>, document.body)
+ *   },
+ *   // Define action to update state:
+ *   update(state, msg) {
+ *     if (msg === 'incr') {
+ *        return [state.count++]
+ *     }
+ *   }
+ * }
+ * // Run the program:
+ * run(program)
+ * ```
+ * @param {import('./types').Program} program A program to run with five methods: `init`, `view`, `update`, `subscriptions` and `done`.
+ * @return {() => void} Function to terminate runtime.
+ */
+export function run(program: import("./types").Program): () => void;

tsconfig.json

@@ -0,0 +1,51 @@
+export type Tag = {
+    type: string;
+    data?: any;
+};
+export type Message = {
+    type: string;
+    data?: any;
+};
+export type Send = (msg?: Function | Message, data?: any) => Message;
+export type GetState = () => any;
+/**
+ * Simple or complex types for application state.
+ */
+export type State = any;
+/**
+ * Return result of program init method.
+ */
+export type InitResult = any;
+/**
+ * A program to run.
+ */
+export type Program = {
+    /**
+     * Method to set up initial state.
+     */
+    init: () => any;
+    /**
+     * Method to present the current application state.
+     */
+    view: (state: any, send?: (msg?: Function | Message, data?: any) => Message) => void;
+    /**
+     * Method to capture messages sent from view or subscriptions. According to the message, an action will transform application state and pass it the the program view method.
+     */
+    update: (state: any, msg?: Message, send?: (msg?: Function | Message, data?: any) => Message) => any;
+    /**
+     * Method to run effects when the program starts. These run independently from the rest of the program.
+     */
+    subscriptions?: (send?: (msg?: Function | Message, data?: any) => Message, getState?: () => any) => void;
+    /**
+     * Shortcut for subscriptions.
+     */
+    subs?: (send?: (msg?: Function | Message, data?: any) => Message, getState?: () => any) => void;
+    /**
+     * Method to do clean up when shutting down a program.
+     */
+    done?: (state: any) => void;
+    /**
+     * A static send function for dispatching message to a program. Used with routers and in composition.
+     */
+    send?: (msg?: Function | Message, data?: any) => Message;
+};

types/effects.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @typedef {Object} MessageUnion
+ */
+/**
+ * Create a union of types for matching up with functions. This is used to define actions for the `update` method of a runtime program.
+ * @param {...string} types
+ * @returns {MessageUnion} MessageUnion
+ */
+export function union(...types: string[]): any;
+export type MessageUnion = any;