First commit

.gitignore

@@ -0,0 +1,2 @@
+node_modules/
+package-lock.json

README.md

@@ -0,0 +1,17 @@
+# Mithril CC
+
+An opinionated pleasure on writing [Mithril.js](https://mithril.js.org) components.
+
+## Motivation
+
+Mithril is the leader and forerunner of declarative HTML views in plain old JavaScript. However, its flourishing flexibility can leave one uncertain on the "right" way to do certain things; the array of options available all have different pros and cons that depend on the type of component you're writing.
+
+Mithril CC aims to compress these options into a pleasant, one-size-fits-all approach, trading tedious decision fatigue for peace and tranquility.
+
+## Getting Started
+
+```bash
+yarn add mithril-cc
+# or
+npm install mithril-cc
+```

package.json

@@ -0,0 +1,38 @@
+{
+  "name": "mithril-cc",
+  "version": "0.9.0",
+  "description": "An opinionated pleasure on writing Mithril components",
+  "main": "index.js",
+  "scripts": {
+    "build": "tsc",
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "prepublishOnly": "npm run build"
+  },
+  "files": [
+    "index.js",
+    "index.ts",
+    "index.d.ts",
+    "README.md"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/gilbert/mithril-cc.git"
+  },
+  "keywords": [
+    "mithril"
+  ],
+  "author": "gilbert",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/gilbert/mithril-cc/issues"
+  },
+  "homepage": "https://github.com/gilbert/mithril-cc#readme",
+  "peerDependencies": {
+    "mithril": "2.x"
+  },
+  "devDependencies": {
+    "@types/mithril": "^2.0.7",
+    "esbuild": "^0.10.0",
+    "typescript": "^4.2.3"
+  }
+}

src/index.ts

@@ -0,0 +1,70 @@
+import m, { Vnode } from 'mithril'
+import Stream from 'mithril/stream'
+
+type ComponentContext<Attrs> = {
+  oncreate(f: m.Component<Attrs>['oncreate']): void
+  onupdate(f: m.Component<Attrs>['onupdate']): void
+  onremove: Remover
+  addEventListener: Remover['addEventListener']
+  /** Write-only */
+  unsub: Remover['unsub']
+}
+
+type ComponentDef<Attrs> = (this: ComponentContext<Attrs>, params: Stream<Attrs>) => ((attrs: Attrs, vnode: Vnode<Attrs>) => Vnode<any,any>)
+
+export function cc<Attrs>(init: ComponentDef<Attrs>) {
+  return function actualComponent(vnode: m.Vnode<Attrs>) {
+    let oncreate = undefined as undefined | m.Component<Attrs>['oncreate']
+    let onupdate = undefined as undefined | m.Component<Attrs>['onupdate']
+    let onremove = undefined as undefined | Remover
+    const attrs = Stream<Attrs>(vnode.attrs)
+    const view = init.call({
+      oncreate(f) { oncreate = f },
+      onupdate(f) { onupdate = f },
+      get onremove() {
+        return onremove || (onremove = remover())
+      },
+      addEventListener(dom, event, handler) {
+        this.onremove.addEventListener(dom, event, handler)
+      },
+      set unsub(f: any) {
+        this.onremove.unsub = f
+      },
+    }, attrs)
+
+    return {
+      oncreate,
+      onupdate,
+      onremove,
+      view(vnode: Vnode<Attrs>) {
+        attrs(vnode.attrs)
+        return view(vnode.attrs, vnode)
+      }
+    }
+  }
+}
+
+type Remover = ReturnType<typeof remover>
+
+function remover() {
+  let unsubs = [] as Function[]
+  const onremove = function onremove() {
+    unsubs.forEach(f => f())
+  }
+  Object.defineProperty(onremove, 'unsub', {
+    set(f) {
+      unsubs.push(f.constructor === Stream ? () => f.end(true) : f)
+    }
+  })
+  Object.defineProperty(onremove, 'addEventListener', {
+    value(dom: Element | Window, event: string, handler: (e: any) => void) {
+      dom.addEventListener(event, handler)
+      unsubs.push(() => dom.removeEventListener(event, handler))
+    },
+    writable: false
+  })
+  return onremove as (() => void) & {
+    unsub: () => void
+    addEventListener(dom: Element | Window, event: string, handler: (e: any) => void): void
+  }
+}

tsconfig.json

@@ -0,0 +1,71 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+    /* Basic Options */
+    // "incremental": true,                         /* Enable incremental compilation */
+    "target": "es5",                                /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
+    "module": "esnext",                             /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
+    // "lib": [],                                   /* Specify library files to be included in the compilation. */
+    // "allowJs": true,                             /* Allow javascript files to be compiled. */
+    // "checkJs": true,                             /* Report errors in .js files. */
+    // "jsx": "preserve",                           /* Specify JSX code generation: 'preserve', 'react-native', 'react', 'react-jsx' or 'react-jsxdev'. */
+    // "declaration": true,                         /* Generates corresponding '.d.ts' file. */
+    // "declarationMap": true,                      /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    // "sourceMap": true,                           /* Generates corresponding '.map' file. */
+    // "outFile": "./",                             /* Concatenate and emit output to single file. */
+    // "outDir": "./",                              /* Redirect output structure to the directory. */
+    // "rootDir": "./",                             /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    // "composite": true,                           /* Enable project compilation */
+    // "tsBuildInfoFile": "./",                     /* Specify file to store incremental compilation information */
+    // "removeComments": true,                      /* Do not emit comments to output. */
+    "noEmit": true,                                 /* Do not emit outputs. */
+    // "importHelpers": true,                       /* Import emit helpers from 'tslib'. */
+    // "downlevelIteration": true,                  /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    // "isolatedModules": true,                     /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+
+    /* Strict Type-Checking Options */
+    "strict": true,                                 /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                       /* Raise error on expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                    /* Enable strict null checks. */
+    // "strictFunctionTypes": true,                 /* Enable strict checking of function types. */
+    // "strictBindCallApply": true,                 /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
+    // "strictPropertyInitialization": true,        /* Enable strict checking of property initialization in classes. */
+    // "noImplicitThis": true,                      /* Raise error on 'this' expressions with an implied 'any' type. */
+    // "alwaysStrict": true,                        /* Parse in strict mode and emit "use strict" for each source file. */
+
+    /* Additional Checks */
+    "noUnusedLocals": true,                      /* Report errors on unused locals. */
+    "noUnusedParameters": true,                  /* Report errors on unused parameters. */
+    // "noImplicitReturns": true,                   /* Report error when not all code paths in function return a value. */
+    // "noFallthroughCasesInSwitch": true,          /* Report errors for fallthrough cases in switch statement. */
+    "noUncheckedIndexedAccess": true,            /* Include 'undefined' in index signature results */
+    // "noPropertyAccessFromIndexSignature": true,  /* Require undeclared properties from index signatures to use element accesses. */
+
+    /* Module Resolution Options */
+    // "moduleResolution": "node",                  /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    // "baseUrl": "./",                             /* Base directory to resolve non-absolute module names. */
+    // "paths": {},                                 /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+    // "rootDirs": [],                              /* List of root folders whose combined content represents the structure of the project at runtime. */
+    // "typeRoots": [],                             /* List of folders to include type definitions from. */
+    // "types": [],                                 /* Type declaration files to be included in compilation. */
+    // "allowSyntheticDefaultImports": true,        /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    "esModuleInterop": true,                        /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    // "preserveSymlinks": true,                    /* Do not resolve the real path of symlinks. */
+    // "allowUmdGlobalAccess": true,                /* Allow accessing UMD globals from modules. */
+
+    /* Source Map Options */
+    // "sourceRoot": "",                            /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "",                               /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,                     /* Emit a single file with source maps instead of having a separate file. */
+    // "inlineSources": true,                       /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+
+    /* Experimental Options */
+    // "experimentalDecorators": true,              /* Enables experimental support for ES7 decorators. */
+    // "emitDecoratorMetadata": true,               /* Enables experimental support for emitting type metadata for decorators. */
+
+    /* Advanced Options */
+    "skipLibCheck": true,                           /* Skip type checking of declaration files. */
+    "forceConsistentCasingInFileNames": true        /* Disallow inconsistently-cased references to the same file. */
+  }
+}