modelmix 2.3.2 → 2.3.8

package/demo/node_modules/event-target-shim/README.md

@@ -0,0 +1,293 @@
+# event-target-shim
+
+[![npm version](https://img.shields.io/npm/v/event-target-shim.svg)](https://www.npmjs.com/package/event-target-shim)
+[![Downloads/month](https://img.shields.io/npm/dm/event-target-shim.svg)](http://www.npmtrends.com/event-target-shim)
+[![Build Status](https://travis-ci.org/mysticatea/event-target-shim.svg?branch=master)](https://travis-ci.org/mysticatea/event-target-shim)
+[![Coverage Status](https://codecov.io/gh/mysticatea/event-target-shim/branch/master/graph/badge.svg)](https://codecov.io/gh/mysticatea/event-target-shim)
+[![Dependency Status](https://david-dm.org/mysticatea/event-target-shim.svg)](https://david-dm.org/mysticatea/event-target-shim)
+
+An implementation of [WHATWG EventTarget interface](https://dom.spec.whatwg.org/#interface-eventtarget), plus few extensions.
+
+- This provides `EventTarget` constructor that can inherit for your custom object.
+- This provides an utility that defines properties of attribute listeners (e.g. `obj.onclick`).
+
+```js
+import {EventTarget, defineEventAttribute} from "event-target-shim"
+
+class Foo extends EventTarget {
+    // ...
+}
+
+// Define `foo.onhello` property.
+defineEventAttribute(Foo.prototype, "hello")
+
+// Use
+const foo = new Foo()
+foo.addEventListener("hello", e => console.log("hello", e))
+foo.onhello = e => console.log("onhello:", e)
+foo.dispatchEvent(new CustomEvent("hello"))
+```
+
+## 💿 Installation
+
+Use [npm](https://www.npmjs.com/) to install then use a bundler.
+
+```
+npm install event-target-shim
+```
+
+Or download from [`dist` directory](./dist).
+
+- [dist/event-target-shim.mjs](dist/event-target-shim.mjs) ... ES modules version.
+- [dist/event-target-shim.js](dist/event-target-shim.js) ... Common JS version.
+- [dist/event-target-shim.umd.js](dist/event-target-shim.umd.js) ... UMD (Universal Module Definition) version. This is transpiled by [Babel](https://babeljs.io/) for IE 11.
+
+## 📖 Usage
+
+```js
+import {EventTarget, defineEventAttribute} from "event-target-shim"
+// or
+const {EventTarget, defineEventAttribute} = require("event-target-shim")
+
+// or UMD version defines a global variable:
+const {EventTarget, defineEventAttribute} = window.EventTargetShim
+```
+
+### EventTarget
+
+> https://dom.spec.whatwg.org/#interface-eventtarget
+
+#### eventTarget.addEventListener(type, callback, options)
+
+Register an event listener.
+
+- `type` is a string. This is the event name to register.
+- `callback` is a function. This is the event listener to register.
+- `options` is a boolean or an object `{ capture?: boolean, passive?: boolean, once?: boolean }`. If this is a boolean, it's same meaning as `{ capture: options }`.
+    - `capture` is the flag to register the event listener for capture phase.
+    - `passive` is the flag to ignore `event.preventDefault()` method in the event listener.
+    - `once` is the flag to remove the event listener automatically after the first call.
+
+#### eventTarget.removeEventListener(type, callback, options)
+
+Unregister an event listener.
+
+- `type` is a string. This is the event name to unregister.
+- `callback` is a function. This is the event listener to unregister.
+- `options` is a boolean or an object `{ capture?: boolean }`. If this is a boolean, it's same meaning as `{ capture: options }`.
+    - `capture` is the flag to register the event listener for capture phase.
+
+#### eventTarget.dispatchEvent(event)
+
+Dispatch an event.
+
+- `event` is a [Event](https://dom.spec.whatwg.org/#event) object or an object `{ type: string, [key: string]: any }`. The latter is non-standard but useful. In both cases, listeners receive the event as implementing [Event](https://dom.spec.whatwg.org/#event) interface.
+
+### defineEventAttribute(proto, type)
+
+Define an event attribute (e.g. `onclick`) to `proto`. This is non-standard.
+
+- `proto` is an object (assuming it's a prototype object). This function defines a getter/setter pair for the event attribute.
+- `type` is a string. This is the event name to define.
+
+For example:
+
+```js
+class AbortSignal extends EventTarget {
+    constructor() {
+        this.aborted = false
+    }
+}
+// Define `onabort` property.
+defineEventAttribute(AbortSignal.prototype, "abort")
+```
+
+### EventTarget(types)
+
+Define a custom `EventTarget` class with event attributes. This is non-standard.
+
+- `types` is a string or an array of strings. This is the event name to define.
+
+For example:
+
+```js
+// This has `onabort` property.
+class AbortSignal extends EventTarget("abort") {
+    constructor() {
+        this.aborted = false
+    }
+}
+```
+
+## 📚 Examples
+
+### ES2015 and later
+
+> https://jsfiddle.net/636vea92/
+
+```js
+const {EventTarget, defineEventAttribute} = EventTargetShim
+
+// Define a derived class.
+class Foo extends EventTarget {
+    // ...
+}
+
+// Define `foo.onhello` property.
+defineEventAttribute(Foo.prototype, "hello")
+
+// Register event listeners.
+const foo = new Foo()
+foo.addEventListener("hello", (e) => {
+    console.log("hello", e)
+})
+foo.onhello = (e) => {
+    console.log("onhello", e)
+}
+
+// Dispatching events
+foo.dispatchEvent(new CustomEvent("hello", { detail: "detail" }))
+```
+
+### Typescript
+
+```ts
+import { EventTarget, defineEventAttribute } from "event-target-shim";
+
+// Define events
+type FooEvents = {
+    hello: CustomEvent
+}
+type FooEventAttributes = {
+    onhello: CustomEvent
+}
+
+// Define a derived class.
+class Foo extends EventTarget<FooEvents, FooEventAttributes> {
+    // ...
+}
+// Define `foo.onhello` property's implementation.
+defineEventAttribute(Foo.prototype, "hello")
+
+// Register event listeners.
+const foo = new Foo()
+foo.addEventListener("hello", (e) => {
+    console.log("hello", e.detail)
+})
+foo.onhello = (e) => {
+    console.log("onhello", e.detail)
+}
+
+// Dispatching events
+foo.dispatchEvent(new CustomEvent("hello", { detail: "detail" }))
+```
+
+Unfortunately, both `FooEvents` and `FooEventAttributes` are needed because TypeScript doesn't allow the mutation of string literal types. If TypeScript allowed us to compute `"onhello"` from `"hello"` in types, `FooEventAttributes` will be optional.
+
+This `EventTarget` type is compatible with `EventTarget` interface of `lib.dom.d.ts`.
+
+#### To disallow unknown events
+
+By default, methods such as `addEventListener` accept unknown events. You can disallow unknown events by the third type parameter `"strict"`.
+
+```ts
+type FooEvents = {
+    hello: CustomEvent
+}
+class Foo extends EventTarget<FooEvents, {}, "strict"> {
+    // ...
+}
+
+// OK because `hello` is defined in FooEvents.
+foo.addEventListener("hello", (e) => {
+})
+// Error because `unknown` is not defined in FooEvents.
+foo.addEventListener("unknown", (e) => {
+})
+```
+
+However, if you use `"strict"` parameter, it loses compatibility with `EventTarget` interface of `lib.dom.d.ts`.
+
+#### To infer the type of `dispatchEvent()` method
+
+TypeScript cannot infer the event type of `dispatchEvent()` method properly from the argument in most cases. You can improve this behavior with the following steps:
+
+1. Use the third type parameter `"strict"`. This prevents inferring to `dispatchEvent<string>()`.
+2. Make the `type` property of event definitions stricter.
+
+```ts
+type FooEvents = {
+    hello: CustomEvent & { type: "hello" }
+    hey: Event & { type: "hey" }
+}
+class Foo extends EventTarget<FooEvents, {}, "strict"> {
+    // ...
+}
+
+// Error because `detail` property is lacking.
+foo.dispatchEvent({ type: "hello" })
+```
+
+### ES5
+
+> https://jsfiddle.net/522zc9de/
+
+```js
+// Define a derived class.
+function Foo() {
+    EventTarget.call(this)
+}
+Foo.prototype = Object.create(EventTarget.prototype, {
+    constructor: { value: Foo, configurable: true, writable: true }
+    // ...
+})
+
+// Define `foo.onhello` property.
+defineEventAttribute(Foo.prototype, "hello")
+
+// Register event listeners.
+var foo = new Foo()
+foo.addEventListener("hello", function(e) {
+    console.log("hello", e)
+})
+foo.onhello = function(e) {
+    console.log("onhello", e)
+}
+
+// Dispatching events
+function isSupportEventConstrucor() { // IE does not support.
+    try {
+        new CusomEvent("hello")
+        return true
+    } catch (_err) {
+        return false
+    }
+}
+if (isSupportEventConstrucor()) {
+    foo.dispatchEvent(new CustomEvent("hello", { detail: "detail" }))
+} else {
+    var e = document.createEvent("CustomEvent")
+    e.initCustomEvent("hello", false, false, "detail")
+    foo.dispatchEvent(e)
+}
+```
+
+## 📰 Changelog
+
+- See [GitHub releases](https://github.com/mysticatea/event-target-shim/releases).
+
+## 🍻 Contributing
+
+Contributing is welcome ❤️
+
+Please use GitHub issues/PRs.
+
+### Development tools
+
+- `npm install` installs dependencies for development.
+- `npm test` runs tests and measures code coverage.
+- `npm run clean` removes temporary files of tests.
+- `npm run coverage` opens code coverage of the previous test with your default browser.
+- `npm run lint` runs ESLint.
+- `npm run build` generates `dist` codes.
+- `npm run watch` runs tests on each file change.

package/demo/node_modules/event-target-shim/index.d.ts

@@ -0,0 +1,399 @@
+export as namespace EventTargetShim
+
+/**
+ * `Event` interface.
+ * @see https://dom.spec.whatwg.org/#event
+ */
+export interface Event {
+    /**
+     * The type of this event.
+     */
+    readonly type: string
+
+    /**
+     * The target of this event.
+     */
+    readonly target: EventTarget<{}, {}, "standard"> | null
+
+    /**
+     * The current target of this event.
+     */
+    readonly currentTarget: EventTarget<{}, {}, "standard"> | null
+
+    /**
+     * The target of this event.
+     * @deprecated
+     */
+    readonly srcElement: any | null
+
+    /**
+     * The composed path of this event.
+     */
+    composedPath(): EventTarget<{}, {}, "standard">[]
+
+    /**
+     * Constant of NONE.
+     */
+    readonly NONE: number
+
+    /**
+     * Constant of CAPTURING_PHASE.
+     */
+    readonly CAPTURING_PHASE: number
+
+    /**
+     * Constant of BUBBLING_PHASE.
+     */
+    readonly BUBBLING_PHASE: number
+
+    /**
+     * Constant of AT_TARGET.
+     */
+    readonly AT_TARGET: number
+
+    /**
+     * Indicates which phase of the event flow is currently being evaluated.
+     */
+    readonly eventPhase: number
+
+    /**
+     * Stop event bubbling.
+     */
+    stopPropagation(): void
+
+    /**
+     * Stop event bubbling.
+     */
+    stopImmediatePropagation(): void
+
+    /**
+     * Initialize event.
+     * @deprecated
+     */
+    initEvent(type: string, bubbles?: boolean, cancelable?: boolean): void
+
+    /**
+     * The flag indicating bubbling.
+     */
+    readonly bubbles: boolean
+
+    /**
+     * Stop event bubbling.
+     * @deprecated
+     */
+    cancelBubble: boolean
+
+    /**
+     * Set or get cancellation flag.
+     * @deprecated
+     */
+    returnValue: boolean
+
+    /**
+     * The flag indicating whether the event can be canceled.
+     */
+    readonly cancelable: boolean
+
+    /**
+     * Cancel this event.
+     */
+    preventDefault(): void
+
+    /**
+     * The flag to indicating whether the event was canceled.
+     */
+    readonly defaultPrevented: boolean
+
+    /**
+     * The flag to indicating if event is composed.
+     */
+    readonly composed: boolean
+
+    /**
+     * Indicates whether the event was dispatched by the user agent.
+     */
+    readonly isTrusted: boolean
+
+    /**
+     * The unix time of this event.
+     */
+    readonly timeStamp: number
+}
+
+/**
+ * The constructor of `EventTarget` interface.
+ */
+export type EventTargetConstructor<
+    TEvents extends EventTarget.EventDefinition = {},
+    TEventAttributes extends EventTarget.EventDefinition = {},
+    TMode extends EventTarget.Mode = "loose"
+> = {
+    prototype: EventTarget<TEvents, TEventAttributes, TMode>
+    new(): EventTarget<TEvents, TEventAttributes, TMode>
+}
+
+/**
+ * `EventTarget` interface.
+ * @see https://dom.spec.whatwg.org/#interface-eventtarget
+ */
+export type EventTarget<
+    TEvents extends EventTarget.EventDefinition = {},
+    TEventAttributes extends EventTarget.EventDefinition = {},
+    TMode extends EventTarget.Mode = "loose"
+> = EventTarget.EventAttributes<TEventAttributes> & {
+    /**
+     * Add a given listener to this event target.
+     * @param eventName The event name to add.
+     * @param listener The listener to add.
+     * @param options The options for this listener.
+     */
+    addEventListener<TEventType extends EventTarget.EventType<TEvents, TMode>>(
+        type: TEventType,
+        listener:
+            | EventTarget.Listener<EventTarget.PickEvent<TEvents, TEventType>>
+            | null,
+        options?: boolean | EventTarget.AddOptions
+    ): void
+
+    /**
+     * Remove a given listener from this event target.
+     * @param eventName The event name to remove.
+     * @param listener The listener to remove.
+     * @param options The options for this listener.
+     */
+    removeEventListener<TEventType extends EventTarget.EventType<TEvents, TMode>>(
+        type: TEventType,
+        listener:
+            | EventTarget.Listener<EventTarget.PickEvent<TEvents, TEventType>>
+            | null,
+        options?: boolean | EventTarget.RemoveOptions
+    ): void
+
+    /**
+     * Dispatch a given event.
+     * @param event The event to dispatch.
+     * @returns `false` if canceled.
+     */
+    dispatchEvent<TEventType extends EventTarget.EventType<TEvents, TMode>>(
+        event: EventTarget.EventData<TEvents, TEventType, TMode>
+    ): boolean
+}
+
+export const EventTarget: EventTargetConstructor & {
+    /**
+     * Create an `EventTarget` instance with detailed event definition.
+     *
+     * The detailed event definition requires to use `defineEventAttribute()`
+     * function later.
+     *
+     * Unfortunately, the second type parameter `TEventAttributes` was needed
+     * because we cannot compute string literal types.
+     *
+     * @example
+     * const signal = new EventTarget<{ abort: Event }, { onabort: Event }>()
+     * defineEventAttribute(signal, "abort")
+     */
+    new <
+        TEvents extends EventTarget.EventDefinition,
+        TEventAttributes extends EventTarget.EventDefinition,
+        TMode extends EventTarget.Mode = "loose"
+    >(): EventTarget<TEvents, TEventAttributes, TMode>
+
+    /**
+     * Define an `EventTarget` constructor with attribute events and detailed event definition.
+     *
+     * Unfortunately, the second type parameter `TEventAttributes` was needed
+     * because we cannot compute string literal types.
+     *
+     * @example
+     * class AbortSignal extends EventTarget<{ abort: Event }, { onabort: Event }>("abort") {
+     *      abort(): void {}
+     * }
+     *
+     * @param events Optional event attributes (e.g. passing in `"click"` adds `onclick` to prototype).
+     */
+    <
+        TEvents extends EventTarget.EventDefinition = {},
+        TEventAttributes extends EventTarget.EventDefinition = {},
+        TMode extends EventTarget.Mode = "loose"
+    >(events: string[]): EventTargetConstructor<
+        TEvents,
+        TEventAttributes,
+        TMode
+    >
+
+    /**
+     * Define an `EventTarget` constructor with attribute events and detailed event definition.
+     *
+     * Unfortunately, the second type parameter `TEventAttributes` was needed
+     * because we cannot compute string literal types.
+     *
+     * @example
+     * class AbortSignal extends EventTarget<{ abort: Event }, { onabort: Event }>("abort") {
+     *      abort(): void {}
+     * }
+     *
+     * @param events Optional event attributes (e.g. passing in `"click"` adds `onclick` to prototype).
+     */
+    <
+        TEvents extends EventTarget.EventDefinition = {},
+        TEventAttributes extends EventTarget.EventDefinition = {},
+        TMode extends EventTarget.Mode = "loose"
+    >(event0: string, ...events: string[]): EventTargetConstructor<
+        TEvents,
+        TEventAttributes,
+        TMode
+    >
+}
+
+export namespace EventTarget {
+    /**
+     * Options of `removeEventListener()` method.
+     */
+    export interface RemoveOptions {
+        /**
+         * The flag to indicate that the listener is for the capturing phase.
+         */
+        capture?: boolean
+    }
+
+    /**
+     * Options of `addEventListener()` method.
+     */
+    export interface AddOptions extends RemoveOptions {
+        /**
+         * The flag to indicate that the listener doesn't support
+         * `event.preventDefault()` operation.
+         */
+        passive?: boolean
+        /**
+         * The flag to indicate that the listener will be removed on the first
+         * event.
+         */
+        once?: boolean
+    }
+
+    /**
+     * The type of regular listeners.
+     */
+    export interface FunctionListener<TEvent> {
+        (event: TEvent): void
+    }
+
+    /**
+     * The type of object listeners.
+     */
+    export interface ObjectListener<TEvent> {
+        handleEvent(event: TEvent): void
+    }
+
+    /**
+     * The type of listeners.
+     */
+    export type Listener<TEvent> =
+        | FunctionListener<TEvent>
+        | ObjectListener<TEvent>
+
+    /**
+     * Event definition.
+     */
+    export type EventDefinition = {
+        readonly [key: string]: Event
+    }
+
+    /**
+     * Mapped type for event attributes.
+     */
+    export type EventAttributes<TEventAttributes extends EventDefinition> = {
+        [P in keyof TEventAttributes]:
+            | FunctionListener<TEventAttributes[P]>
+            | null
+    }
+
+    /**
+     * The type of event data for `dispatchEvent()` method.
+     */
+    export type EventData<
+        TEvents extends EventDefinition,
+        TEventType extends keyof TEvents | string,
+        TMode extends Mode
+    > =
+        TEventType extends keyof TEvents
+            ? (
+                // Require properties which are not generated automatically.
+                & Pick<
+                    TEvents[TEventType],
+                    Exclude<keyof TEvents[TEventType], OmittableEventKeys>
+                >
+                // Properties which are generated automatically are optional.
+                & Partial<Pick<Event, OmittableEventKeys>>
+            )
+            : (
+                TMode extends "standard"
+                    ? Event
+                    : Event | NonStandardEvent
+            )
+
+    /**
+     * The string literal types of the properties which are generated
+     * automatically in `dispatchEvent()` method.
+     */
+    export type OmittableEventKeys = Exclude<keyof Event, "type">
+
+    /**
+     * The type of event data.
+     */
+    export type NonStandardEvent = {
+        [key: string]: any
+        type: string
+    }
+
+    /**
+     * The type of listeners.
+     */
+    export type PickEvent<
+        TEvents extends EventDefinition,
+        TEventType extends keyof TEvents | string,
+    > =
+        TEventType extends keyof TEvents
+            ? TEvents[TEventType]
+            : Event
+
+    /**
+     * Event type candidates.
+     */
+    export type EventType<
+        TEvents extends EventDefinition,
+        TMode extends Mode
+    > =
+        TMode extends "strict"
+            ? keyof TEvents
+            : keyof TEvents | string
+
+    /**
+     * - `"strict"` ..... Methods don't accept unknown events.
+     *                    `dispatchEvent()` accepts partial objects.
+     * - `"loose"` ...... Methods accept unknown events.
+     *                    `dispatchEvent()` accepts partial objects.
+     * - `"standard"` ... Methods accept unknown events.
+     *                    `dispatchEvent()` doesn't accept partial objects.
+     */
+    export type Mode = "strict" | "standard" | "loose"
+}
+
+/**
+ * Specialized `type` property.
+ */
+export type Type<T extends string> = { type: T }
+
+/**
+ * Define an event attribute (e.g. `eventTarget.onclick`).
+ * @param prototype The event target prototype to define an event attribute.
+ * @param eventName The event name to define.
+ */
+export function defineEventAttribute(
+    prototype: EventTarget,
+    eventName: string
+): void
+
+export default EventTarget