@nil-/doc 0.2.45 → 0.2.47

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @nil-/doc
 
+## 0.2.47
+
+### Patch Changes
+
+-   [doc][docu] minor adjustments to documentation ([#79](https://github.com/njaldea/mono/pull/79))
+
+-   [doc][new] added support for flattened prop schema ([#79](https://github.com/njaldea/mono/pull/79))
+
+## 0.2.46
+
+### Patch Changes
+
+-   [doc][break] added event control support ([#77](https://github.com/njaldea/mono/pull/77))
+
 ## 0.2.45
 
 ### Patch Changes

package/components/block/Controls.svelte

@@ -1,11 +1,12 @@
 
 <script>import { getControls, getControlsState } from "./context";
 export let props = [];
+export let events = [];
 export let hide = false;
 export let position = void 0;
 const controls = getControls();
 $:
-  $controls = props;
+  $controls = { props, events };
 const state = getControlsState();
 $:
   $state.hide = hide;

package/components/block/Controls.svelte.d.ts

@@ -1,8 +1,9 @@
 import { SvelteComponentTyped } from "svelte";
-import type { Control } from "./controls/types";
+import type { Prop } from "./controls/types";
 declare const __propDef: {
     props: {
-        props?: Control[] | undefined;
+        props?: Prop[] | undefined;
+        events?: string[] | undefined;
         hide?: boolean | undefined;
         position?: undefined | "bottom" | "right";
     };

package/components/block/Instance.svelte

@@ -74,13 +74,27 @@
 import { cquery } from "./action";
 import { getControls, getControlsState } from "./context";
 import { getTheme } from "../context";
-import Controls from "./controls/Controls.svelte";
+import Props from "./controls/props/Props.svelte";
+import Events from "./controls/events/Events.svelte";
 import { resolve } from "./utils";
 const controls = getControls();
 const controlsState = getControlsState();
 const dark = getTheme();
 $:
-  expanded = $controls.length > 0 && !$controlsState.hide;
+  hasProps = $controls.props.length > 0;
+$:
+  hasEvents = $controls.events.length > 0;
+let cvisible = null;
+$:
+  if (cvisible == null && hasProps) {
+    cvisible = "props";
+  } else if (cvisible == null && hasEvents) {
+    cvisible = "events";
+  } else if (!hasProps && !hasEvents) {
+    cvisible = null;
+  }
+$:
+  expanded = !$controlsState.hide && cvisible != null;
 export let defaults = void 0;
 export let noreset = false;
 export let scale = false;
@@ -88,12 +102,15 @@ let key = false;
 beforeUpdate(() => key = !key);
 const resolveArgs = resolve;
 let bound = {};
-const updateBound = (d) => {
-  bound = resolve(d ?? {}, {});
-};
+const updateBound = (d) => bound = resolve(d ?? {}, {});
 $:
   updateBound(defaults);
+let handlers;
 </script>
+<!--
+    @component
+    See [documentation](https://mono-doc.vercel.app/3-Components/2-Block/1-Content/1-Instance) for more details.
+-->
 <div
     class="instance"
     class:scale
@@ -107,18 +124,32 @@ $:
 >
     {#if noreset}
         <div class="content scrollable" class:dark={$dark}>
-            <slot props={resolveArgs(defaults ?? {}, bound)} {key} />
+            <slot props={resolveArgs(defaults ?? {}, bound)} events={handlers} {key} />
         </div>
     {:else}
         {#key key}
             <div class="content scrollable" class:dark={$dark}>
-                <slot props={resolveArgs(defaults ?? {}, bound)} {key} />
+                <slot props={resolveArgs(defaults ?? {}, bound)} events={handlers} {key} />
             </div>
         {/key}
     {/if}
     {#if expanded}
         <div class="misc scrollable" class:dark={$dark}>
-            <Controls infos={$controls} bind:values={bound} />
+            <Props infos={$controls.props} bind:values={bound} visible={cvisible == "props"}>
+                <div on:dblclick={() => hasEvents && (cvisible = "events")}>
+                    <div>Properties</div>
+                    <div>Value</div>
+                    <div>Use</div>
+                </div>
+            </Props>
+            <Events events={$controls.events} bind:handlers visible={cvisible == "events"}>
+                {#if cvisible == "events"}
+                    <div on:dblclick={() => hasProps && (cvisible = "props")}>
+                        <div>Events</div>
+                        <div>Detail</div>
+                    </div>
+                {/if}
+            </Events>
         </div>
     {/if}
 </div>

package/components/block/Instance.svelte.d.ts

@@ -1,7 +1,7 @@
 import { SvelteComponentTyped } from "svelte";
-declare class __sveltets_Render<Args> {
+declare class __sveltets_Render<PropArgs> {
     props(): {
-        defaults?: Args | undefined;
+        defaults?: PropArgs | undefined;
         noreset?: boolean | undefined;
         scale?: boolean | undefined;
     };
@@ -10,14 +10,16 @@ declare class __sveltets_Render<Args> {
     };
     slots(): {
         default: {
-            props: Args;
+            props: PropArgs;
+            events: Record<string, (ev: CustomEvent<unknown>) => void>;
             key: boolean;
         };
     };
 }
-export type InstanceProps<Args> = ReturnType<__sveltets_Render<Args>['props']>;
-export type InstanceEvents<Args> = ReturnType<__sveltets_Render<Args>['events']>;
-export type InstanceSlots<Args> = ReturnType<__sveltets_Render<Args>['slots']>;
-export default class Instance<Args> extends SvelteComponentTyped<InstanceProps<Args>, InstanceEvents<Args>, InstanceSlots<Args>> {
+export type InstanceProps<PropArgs> = ReturnType<__sveltets_Render<PropArgs>['props']>;
+export type InstanceEvents<PropArgs> = ReturnType<__sveltets_Render<PropArgs>['events']>;
+export type InstanceSlots<PropArgs> = ReturnType<__sveltets_Render<PropArgs>['slots']>;
+/** See [documentation](https://mono-doc.vercel.app/3-Components/2-Block/1-Content/1-Instance) for more details. */
+export default class Instance<PropArgs> extends SvelteComponentTyped<InstanceProps<PropArgs>, InstanceEvents<PropArgs>, InstanceSlots<PropArgs>> {
 }
 export {};

package/components/block/Template.svelte

@@ -30,7 +30,8 @@ const cast = (t) => t;
         {scale}
         let:key
         let:props
+        let:events
     >
-        <slot id={param.id} tag={param.tag} props={cast(props)} {key} />
+        <slot id={param.id} tag={param.tag} props={cast(props)} {events} {key} />
     </Instance>
 {/each}

package/components/block/Template.svelte.d.ts

@@ -14,6 +14,7 @@ declare class __sveltets_Render<Args> {
             id: number;
             tag: string;
             props: Args;
+            events: Record<string, (ev: CustomEvent<unknown>) => void>;
             key: boolean;
         };
     };

package/components/block/context.d.ts

@@ -1,5 +1,5 @@
 import type { Writable } from "svelte/store";
-import type { Control } from "./controls/types";
+import type { Prop, Event } from "./controls/types";
 import type { ValueType } from "./types";
 export type Params = {
     id: number;
@@ -11,7 +11,12 @@ export type ControlState = {
     position?: "bottom" | "right";
 };
 export declare const initParams: () => Writable<Params[]>, getParams: () => Writable<Params[]>;
-export declare const initControls: () => Writable<Control[]>, getControls: () => Writable<Control[]>;
+type Controls = {
+    props: Prop[];
+    events: Event[];
+};
+export declare const initControls: () => Writable<Controls>, getControls: () => Writable<Controls>;
 export declare const initDefaults: () => Writable<Record<string, ValueType>>, getDefaults: () => Writable<Record<string, ValueType>>;
 export declare const initControlsState: () => Writable<ControlState>, getControlsState: () => Writable<ControlState>;
 export declare const initOrientation: () => Writable<boolean>, getOrientation: () => Writable<boolean>;
+export {};

package/components/block/context.js

@@ -8,7 +8,10 @@ const create = (defaulter) => {
     };
 };
 export const { init: initParams, get: getParams } = create(() => []);
-export const { init: initControls, get: getControls } = create(() => []);
+export const { init: initControls, get: getControls } = create(() => ({
+    props: [],
+    events: []
+}));
 export const { init: initDefaults, get: getDefaults } = create(() => ({}));
 export const { init: initControlsState, get: getControlsState } = create(() => ({
     hide: false

package/components/block/controls/events/Events.svelte

@@ -0,0 +1,69 @@
+<style>
+    .count {
+        display: grid;
+        place-items: center;
+        text-align: center;
+        font-size: 0.8rem;
+    }
+</style>
+
+<script>import Styler from "./misc/Styler.svelte";
+export let visible;
+export let events;
+export let handlers;
+let history = [];
+const stringify = (detail) => {
+  if (detail) {
+    if (typeof detail === "string") {
+      return detail;
+    }
+    return JSON.stringify(detail);
+  }
+  return "";
+};
+const wrap = (ext) => {
+  const obj = {};
+  if (ext != null) {
+    for (const name of ext) {
+      obj[name] = (ev) => {
+        const detail = stringify(ev.detail);
+        if (history.length > 0) {
+          const last = history[history.length - 1];
+          if (last.name === name && last.detail === detail && last.count < 99) {
+            last.count += 1;
+            history = history;
+            return;
+          }
+        }
+        history.push({ name, detail, count: 1 });
+        if (history.length > 10) {
+          history.shift();
+        }
+        history = history;
+      };
+    }
+  }
+  return obj;
+};
+$:
+  handlers = wrap(events);
+</script>
+{#if visible}
+    <Styler>
+        <slot />
+        {#each history as { count, detail, name }, i (i)}
+            <div>
+                <div>
+                    <div>{name}</div>
+                    <div class="count">
+                        {#if count > 1}
+                            [{count.toString().padStart(2, "0")}]
+                        {/if}
+                    </div>
+                </div>
+                <div>{detail}</div>
+            </div>
+        {/each}
+    </Styler>
+{/if}
+

package/components/block/controls/events/Events.svelte.d.ts

@@ -0,0 +1,21 @@
+import { SvelteComponentTyped } from "svelte";
+import type { Event } from "../types";
+declare const __propDef: {
+    props: {
+        visible: boolean;
+        events: Event[];
+        handlers: Record<string, (ev: CustomEvent<unknown>) => void> | undefined;
+    };
+    events: {
+        [evt: string]: CustomEvent<any>;
+    };
+    slots: {
+        default: {};
+    };
+};
+export type EventsProps = typeof __propDef.props;
+export type EventsEvents = typeof __propDef.events;
+export type EventsSlots = typeof __propDef.slots;
+export default class Events extends SvelteComponentTyped<EventsProps, EventsEvents, EventsSlots> {
+}
+export {};

package/components/block/controls/events/misc/Styler.svelte

@@ -0,0 +1,83 @@
+<script>import { getTheme } from "../../../../context";
+const dark = getTheme();
+</script>
+<style>
+    div {
+        width: 100%;
+        height: 330px;
+        min-width: 500px;
+        overflow: hidden;
+        display: grid;
+        grid-auto-rows: 30px;
+        box-sizing: border-box;
+    }
+
+    div :global(*),
+    div :global(*::before),
+    div :global(*::after) {
+        box-sizing: inherit;
+    }
+
+    div > :global(div) {
+        display: grid;
+        width: 100%;
+        padding: 2px 0px;
+        grid-template-columns: 1fr 2fr;
+    }
+
+    div > :global(div > div) {
+        padding: 0px 10px;
+    }
+
+    div > :global(div:first-child) {
+        text-align: center;
+    }
+
+    div > :global(div:not(:first-child) > div:first-child) {
+        display: grid;
+        grid-template-columns: 1fr 30px;
+    }
+
+    /* colors */
+    div {
+        --pri-color: hsl(0, 0%, 100%);
+        --sec-color: hsl(210, 29%, 97%);
+        --hover-color: hsl(210, 100%, 90%);
+    }
+
+    div.dark {
+        --pri-color: hsl(213, 26%, 7%);
+        --sec-color: hsl(213, 26%, 11%);
+        --hover-color: hsl(203, 100%, 15%);
+    }
+
+    div {
+        transition: background-color 150ms;
+        background-repeat: repeat;
+        background-size: 100% 60px;
+        background-image: linear-gradient(to bottom, var(--pri-color) 30px, var(--sec-color) 30px);
+    }
+
+    div > :global(div:nth-child(n + 2):hover) {
+        background-color: var(--hover-color);
+    }
+</style>
+
+
+<!--
+    <div> this component
+        <div> Header
+            <div></div>
+            <div></div>
+        </div>
+        <div> Controls
+            <div></div>
+            <div></div>
+        </div>
+        ...
+    </div>
+-->
+<div class:dark={$dark}>
+    <slot />
+</div>
+

package/components/block/controls/props/Component.svelte

@@ -0,0 +1,49 @@
+
+<script>import Text from "./Text.svelte";
+import Number from "./Number.svelte";
+import Range from "./Range.svelte";
+import Switch from "./Switch.svelte";
+import Select from "./Select.svelte";
+import Tuple from "./Tuple.svelte";
+import Object from "./Object.svelte";
+export let value;
+export let info;
+export let depth;
+export let disabled = false;
+export let visible = false;
+</script>
+{#if info instanceof Array}
+    {@const type = info[1]}
+    {#if "object" === type}
+        <Object {info} bind:value {depth} {disabled} {visible} />
+    {:else if "tuple" === type}
+        <Tuple {info} bind:value {depth} {disabled} {visible} />
+    {:else if "text" === type}
+        <Text {info} bind:value {depth} {disabled} {visible} />
+    {:else if "number" === type}
+        <Number {info} bind:value {depth} {disabled} {visible} />
+    {:else if "range" === type}
+        <Range {info} bind:value {depth} {disabled} {visible} />
+    {:else if "select" === type}
+        <Select {info} bind:value {depth} {disabled} {visible} />
+    {:else if "switch" === type}
+        <Switch {info} bind:value {depth} {disabled} {visible} />
+    {/if}
+{:else}
+    {@const type = info.type}
+    {#if "object" === type}
+        <Object {info} bind:value {depth} {disabled} {visible} />
+    {:else if "tuple" === type}
+        <Tuple {info} bind:value {depth} {disabled} {visible} />
+    {:else if "text" === type}
+        <Text {info} bind:value {depth} {disabled} {visible} />
+    {:else if "number" === type}
+        <Number {info} bind:value {depth} {disabled} {visible} />
+    {:else if "range" === type}
+        <Range {info} bind:value {depth} {disabled} {visible} />
+    {:else if "select" === type}
+        <Select {info} bind:value {depth} {disabled} {visible} />
+    {:else if "switch" === type}
+        <Switch {info} bind:value {depth} {disabled} {visible} />
+    {/if}
+{/if}

package/components/block/controls/{Component.svelte.d.ts → props/Component.svelte.d.ts}

@@ -1,9 +1,9 @@
 import { SvelteComponentTyped } from "svelte";
-import type { Control } from "./types";
+import type { Prop } from "../types";
 declare const __propDef: {
     props: {
         value: any;
-        info: Control;
+        info: Prop;
         depth: number;
         disabled?: boolean | undefined;
         visible?: boolean | undefined;

package/components/block/controls/{Number.svelte → props/Number.svelte}

@@ -1,6 +1,6 @@
 
 <script>import { getDefault } from "./misc/defaulter";
-import Name from "./misc/Name.svelte";
+import NameHeader from "./misc/Name.svelte";
 export let value;
 export let info;
 export let depth;
@@ -10,10 +10,12 @@ let ivalue = value ?? getDefault(info);
 let enabled = value !== void 0;
 $:
   value = enabled && !disabled ? ivalue : void 0;
+$:
+  name = info instanceof Array ? info[0] : info.name;
 </script>
 {#if visible}
     <div>
-        <Name name={info.name} {depth} />
+        <NameHeader {name} {depth} />
         <div><input type="number" bind:value={ivalue} disabled={!enabled || disabled} /></div>
         <div><input type="checkbox" bind:checked={enabled} {disabled} /></div>
     </div>

package/components/block/controls/{Number.svelte.d.ts → props/Number.svelte.d.ts}

@@ -1,9 +1,9 @@
 import { SvelteComponentTyped } from "svelte";
-import type { ControlNumber } from "./types";
+import type { Name, PropNumber, FlatPropNumber } from "../types";
 declare const __propDef: {
     props: {
         value: number | undefined;
-        info: ControlNumber;
+        info: (Name & PropNumber) | [string, ...FlatPropNumber];
         depth: number;
         disabled?: boolean | undefined;
         visible?: boolean | undefined;

package/components/block/controls/{Object.svelte → props/Object.svelte}

@@ -13,13 +13,15 @@ let expand = info.values.length > 0 ? true : void 0;
 $:
   value = !disabled && enabled ? ivalue : void 0;
 $:
-  values = info.values;
+  values = info instanceof Array ? info[2] : info.values;
+$:
+  name = info instanceof Array ? info[0] : info.name;
 </script>
-<Header name={info.name} bind:expand bind:checked={enabled} {depth} {disabled} {visible} />
+<Header {name} bind:expand bind:checked={enabled} {depth} {disabled} {visible} />
 {#each values as info, i (i)}
     <Component
         {info}
-        bind:value={ivalue[info.name]}
+        bind:value={ivalue[name]}
         depth={depth + 10}
         disabled={!enabled || disabled}
         visible={visible && expand && enabled && !disabled}

package/components/block/controls/{Object.svelte.d.ts → props/Object.svelte.d.ts}

@@ -1,10 +1,10 @@
 import { SvelteComponentTyped } from "svelte";
-import type { ValueType } from "../types";
-import type { ControlObject } from "./types";
+import type { ValueType } from "../../types";
+import type { Name, PropObject, FlatPropObject } from "../types";
 declare const __propDef: {
     props: {
         value: Record<string, ValueType> | undefined;
-        info: ControlObject;
+        info: (Name & PropObject) | [string, ...FlatPropObject];
         depth: number;
         disabled?: boolean | undefined;
         visible?: boolean | undefined;

package/components/block/controls/props/Props.svelte

@@ -0,0 +1,19 @@
+
+<script>import Component from "./Component.svelte";
+import Styler from "./misc/Styler.svelte";
+export let infos;
+export let values;
+export let visible;
+</script>
+<Styler>
+    {#if visible}
+        <slot />
+    {/if}
+    {#each infos as info}
+        {#if info instanceof Array}
+            <Component {info} bind:value={values[info[0]]} depth={10} {visible} />
+        {:else}
+            <Component {info} bind:value={values[info.name]} depth={10} {visible} />
+        {/if}
+    {/each}
+</Styler>

package/components/block/controls/props/Props.svelte.d.ts

@@ -0,0 +1,22 @@
+import { SvelteComponentTyped } from "svelte";
+import type { ValueType } from "../../types";
+import type { Prop } from "../types";
+declare const __propDef: {
+    props: {
+        infos: Prop[];
+        values: Record<string, ValueType>;
+        visible: boolean;
+    };
+    events: {
+        [evt: string]: CustomEvent<any>;
+    };
+    slots: {
+        default: {};
+    };
+};
+export type PropsProps = typeof __propDef.props;
+export type PropsEvents = typeof __propDef.events;
+export type PropsSlots = typeof __propDef.slots;
+export default class Props extends SvelteComponentTyped<PropsProps, PropsEvents, PropsSlots> {
+}
+export {};

package/components/block/controls/{Range.svelte → props/Range.svelte}

@@ -33,7 +33,7 @@
 </style>
 
 <script>import { getDefault } from "./misc/defaulter";
-import Name from "./misc/Name.svelte";
+import NameHeader from "./misc/Name.svelte";
 export let value;
 export let info;
 export let depth;
@@ -45,10 +45,18 @@ $:
   value = enabled && !disabled ? ivalue : void 0;
 $:
   flag = !enabled || disabled;
+$:
+  name = info instanceof Array ? info[0] : info.name;
+$:
+  min = info instanceof Array ? info[2] : info.min;
+$:
+  max = info instanceof Array ? info[3] : info.max;
+$:
+  step = info instanceof Array ? info[4] : info.step;
 </script>
 {#if visible}
     <div>
-        <Name name={info.name} {depth} />
+        <NameHeader {name} {depth} />
         <div class="input">
             <div class="tooltip" class:disabled={flag}>
                 Current Value: {ivalue}
@@ -57,9 +65,9 @@ $:
             <input
                 type="range"
                 bind:value={ivalue}
-                min={info.min}
-                max={info.max}
-                step={info.step}
+                {min}
+                {max}
+                {step}
                 disabled={flag}
             />
         </div>

package/components/block/controls/{Range.svelte.d.ts → props/Range.svelte.d.ts}

@@ -1,9 +1,9 @@
 import { SvelteComponentTyped } from "svelte";
-import type { ControlRange } from "./types";
+import type { Name, PropRange, FlatPropRange } from "../types";
 declare const __propDef: {
     props: {
         value: number | undefined;
-        info: ControlRange;
+        info: (Name & PropRange) | [string, ...FlatPropRange];
         depth: number;
         disabled?: boolean | undefined;
         visible?: boolean | undefined;

package/components/block/controls/{Select.svelte → props/Select.svelte}

@@ -1,6 +1,6 @@
 
 <script>import { getDefault } from "./misc/defaulter";
-import Name from "./misc/Name.svelte";
+import NameHeader from "./misc/Name.svelte";
 export let value;
 export let info;
 export let depth;
@@ -10,14 +10,18 @@ let ivalue = value ?? getDefault(info);
 let enabled = value !== void 0;
 $:
   value = enabled && !disabled ? ivalue : void 0;
+$:
+  name = info instanceof Array ? info[0] : info.name;
+$:
+  values = info instanceof Array ? info[2] : info.values;
 </script>
 {#if visible}
     <div>
-        <Name name={info.name} {depth} />
+        <NameHeader {name} {depth} />
         <div>
             <select bind:value={ivalue} disabled={!enabled || disabled}>
-                {#each info.values as value}
-                    <option {value}>{value}</option>
+                {#each values as v}
+                    <option value={v}>{v}</option>
                 {/each}
             </select>
         </div>