@peekling/runtime 0.1.0 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +59 -8
- package/dist/canvas-renderer.d.ts +17 -0
- package/dist/canvas-renderer.d.ts.map +1 -0
- package/dist/canvas-renderer.js +192 -0
- package/dist/canvas.d.ts +5 -0
- package/dist/canvas.d.ts.map +1 -0
- package/dist/canvas.js +6 -0
- package/dist/configuration-validation.d.ts.map +1 -1
- package/dist/configuration-validation.js +176 -1
- package/dist/content.d.ts +3 -0
- package/dist/content.d.ts.map +1 -1
- package/dist/content.js +33 -7
- package/dist/index.d.ts +2 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/input.d.ts.map +1 -1
- package/dist/input.js +4 -1
- package/dist/interaction.d.ts +37 -0
- package/dist/interaction.d.ts.map +1 -0
- package/dist/interaction.js +204 -0
- package/dist/overrides.d.ts +8 -0
- package/dist/overrides.d.ts.map +1 -1
- package/dist/overrides.js +18 -16
- package/dist/path-sampler.d.ts +9 -0
- package/dist/path-sampler.d.ts.map +1 -0
- package/dist/path-sampler.js +47 -0
- package/dist/peekling.css +1 -1
- package/dist/peekling.css.sri +1 -1
- package/dist/peekling.js +1365 -86
- package/dist/peekling.js.sri +1 -1
- package/dist/peekling.min.js +1 -1
- package/dist/peekling.min.js.sri +1 -1
- package/dist/plan-compiler.d.ts +2 -0
- package/dist/plan-compiler.d.ts.map +1 -1
- package/dist/plan-compiler.js +71 -14
- package/dist/plan.d.ts +27 -1
- package/dist/plan.d.ts.map +1 -1
- package/dist/plan.js +281 -22
- package/dist/registry.js +2 -2
- package/dist/renderer.d.ts +18 -1
- package/dist/renderer.d.ts.map +1 -1
- package/dist/renderer.js +1 -0
- package/dist/runtime-validation.d.ts.map +1 -1
- package/dist/runtime-validation.js +35 -0
- package/dist/runtime.d.ts +49 -3
- package/dist/runtime.d.ts.map +1 -1
- package/dist/runtime.js +365 -14
- package/dist/targets.d.ts +11 -0
- package/dist/targets.d.ts.map +1 -0
- package/dist/targets.js +106 -0
- package/dist/types.d.ts +61 -1
- package/dist/types.d.ts.map +1 -1
- package/package.json +5 -1
package/dist/runtime.d.ts
CHANGED
|
@@ -1,6 +1,33 @@
|
|
|
1
|
+
import { type CharacterIndicator } from "./interaction.js";
|
|
2
|
+
import { type CharacterRendererFactory } from "./renderer.js";
|
|
1
3
|
import type { RuntimeStyleAsset } from "./styles.js";
|
|
2
|
-
import { type DiagnosticRecord, type EmitResult, type HostContent, type HostBindings, type NativeManifest, type NormalizedPack, type Point, type Plan, type OverrideHandle, type OverrideInput, type SurfaceTheme } from "./types.js";
|
|
4
|
+
import { type DiagnosticRecord, type EmitResult, type HostContent, type HostBindings, type NativeManifest, type NormalizedPack, type Point, type PeeklingPreset, type Plan, type OverrideHandle, type OverrideInput, type SurfaceTheme, type TargetAnchor } from "./types.js";
|
|
3
5
|
export type PeeklingPosition = "bottom-left" | "bottom-right" | "center" | Readonly<Point>;
|
|
6
|
+
export type PeeklingPressAction = "toggle-content" | "show-content" | "hide-content" | "emit" | "none";
|
|
7
|
+
export interface PeeklingInteractionOptions {
|
|
8
|
+
/** Defaults to toggle-content. Setting pressEvent defaults this to emit. */
|
|
9
|
+
press?: PeeklingPressAction;
|
|
10
|
+
/** Bounded application Event emitted by the emit press action. */
|
|
11
|
+
pressEvent?: string;
|
|
12
|
+
drag?: boolean;
|
|
13
|
+
throw?: boolean;
|
|
14
|
+
dragState?: string;
|
|
15
|
+
riseState?: string;
|
|
16
|
+
fallState?: string;
|
|
17
|
+
landState?: string;
|
|
18
|
+
gravity?: number;
|
|
19
|
+
maxThrowSpeed?: number;
|
|
20
|
+
bounce?: number;
|
|
21
|
+
floorInset?: number;
|
|
22
|
+
label?: string;
|
|
23
|
+
contentInitiallyHidden?: boolean;
|
|
24
|
+
clearIndicatorOnPress?: boolean;
|
|
25
|
+
catchTarget?: string;
|
|
26
|
+
catchAnchor?: TargetAnchor;
|
|
27
|
+
catchMargin?: number;
|
|
28
|
+
catchEvent?: string;
|
|
29
|
+
}
|
|
30
|
+
export type PeeklingIndicator = CharacterIndicator;
|
|
4
31
|
export interface PeeklingOptions {
|
|
5
32
|
/** Serializable options contract version. Defaults to 1. */
|
|
6
33
|
format?: 1;
|
|
@@ -15,6 +42,14 @@ export interface PeeklingOptions {
|
|
|
15
42
|
styles?: RuntimeStyleAsset;
|
|
16
43
|
/** Host-owned immutable Plan. Packs remain data-only. */
|
|
17
44
|
plan?: Plan;
|
|
45
|
+
/** Named simple behavior compiled into the same canonical Plan. */
|
|
46
|
+
preset?: PeeklingPreset;
|
|
47
|
+
/** Host-approved element geometry available to target-aware motion. */
|
|
48
|
+
targets?: Readonly<Record<string, string>>;
|
|
49
|
+
/** Direct manipulation is enabled by default. Set false to remove the hit target. */
|
|
50
|
+
interaction?: false | PeeklingInteractionOptions;
|
|
51
|
+
/** Optional notification state rendered on the owned character hit target. */
|
|
52
|
+
indicator?: PeeklingIndicator;
|
|
18
53
|
/** Host-owned accessible text and links referenced by plan contentId values. */
|
|
19
54
|
content?: HostContent;
|
|
20
55
|
/** Property-only host surface mounts. */
|
|
@@ -64,21 +99,32 @@ export interface PeeklingInstance {
|
|
|
64
99
|
override(value: OverrideInput): OverrideHandle;
|
|
65
100
|
pause(): void;
|
|
66
101
|
resume(): void;
|
|
102
|
+
/** Re-resolve configured target selectors after host layout changes. */
|
|
103
|
+
refreshTargets(): void;
|
|
104
|
+
setIndicator(indicator: PeeklingIndicator | null): void;
|
|
105
|
+
/** Show or hide every content surface owned by this character. */
|
|
106
|
+
setContentVisible(visible: boolean): boolean;
|
|
107
|
+
/** Toggle every content surface owned by this character. */
|
|
108
|
+
toggleContent(): boolean;
|
|
67
109
|
destroy(): void;
|
|
68
110
|
}
|
|
69
111
|
/** Package-internal implementation. It is not a supported import. */
|
|
70
112
|
export declare class PeeklingRuntime implements PeeklingInstance {
|
|
71
113
|
#private;
|
|
72
|
-
static hatch(input: PeeklingHatchInput | PeeklingOptions): PeeklingRuntime;
|
|
114
|
+
static hatch(input: PeeklingHatchInput | PeeklingOptions, rendererFactory?: CharacterRendererFactory): PeeklingRuntime;
|
|
73
115
|
/** Package-internal presentation update used only by the Web Component. */
|
|
74
116
|
updateComponentName(value: PeeklingOptions["name"]): boolean;
|
|
75
117
|
readonly ready: Promise<this>;
|
|
76
118
|
readonly finished: Promise<PeeklingFinishResult>;
|
|
77
|
-
constructor(options?: PeeklingOptions);
|
|
119
|
+
constructor(options?: PeeklingOptions, rendererFactory?: CharacterRendererFactory);
|
|
78
120
|
emit(name: string, payload?: unknown): EmitResult;
|
|
79
121
|
override(value: OverrideInput): OverrideHandle;
|
|
80
122
|
pause(): void;
|
|
81
123
|
resume(): void;
|
|
124
|
+
refreshTargets(): void;
|
|
125
|
+
setIndicator(indicator: PeeklingIndicator | null): void;
|
|
126
|
+
setContentVisible(visible: boolean): boolean;
|
|
127
|
+
toggleContent(): boolean;
|
|
82
128
|
destroy(): void;
|
|
83
129
|
}
|
|
84
130
|
/** Create one independently owned companion instance. */
|
package/dist/runtime.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"runtime.d.ts","sourceRoot":"","sources":["../src/runtime.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"runtime.d.ts","sourceRoot":"","sources":["../src/runtime.ts"],"names":[],"mappings":"AAEA,OAAO,EAEL,KAAK,kBAAkB,EACxB,MAAM,kBAAkB,CAAC;AA6B1B,OAAO,EAGL,KAAK,wBAAwB,EAC9B,MAAM,eAAe,CAAC;AAOvB,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AACrD,OAAO,EAGL,KAAK,gBAAgB,EAErB,KAAK,UAAU,EACf,KAAK,WAAW,EAChB,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,KAAK,cAAc,EACnB,KAAK,KAAK,EACV,KAAK,cAAc,EACnB,KAAK,IAAI,EAET,KAAK,cAAc,EACnB,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,YAAY,EAGlB,MAAM,YAAY,CAAC;AAsGpB,MAAM,MAAM,gBAAgB,GAC1B,aAAa,GAAG,cAAc,GAAG,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;AAE9D,MAAM,MAAM,mBAAmB,GAC7B,gBAAgB,GAAG,cAAc,GAAG,cAAc,GAAG,MAAM,GAAG,MAAM,CAAC;AAEvE,MAAM,WAAW,0BAA0B;IACzC,4EAA4E;IAC5E,KAAK,CAAC,EAAE,mBAAmB,CAAC;IAC5B,kEAAkE;IAClE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,YAAY,CAAC;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,MAAM,iBAAiB,GAAG,kBAAkB,CAAC;AAEnD,MAAM,WAAW,eAAe;IAC9B,4DAA4D;IAC5D,MAAM,CAAC,EAAE,CAAC,CAAC;IACX,wFAAwF;IACxF,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,cAAc,GAAG,cAAc,CAAC;IACvC,0EAA0E;IAC1E,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,0EAA0E;IAC1E,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,4EAA4E;IAC5E,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAC3B,yDAAyD;IACzD,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,mEAAmE;IACnE,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,uEAAuE;IACvE,OAAO,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAC3C,qFAAqF;IACrF,WAAW,CAAC,EAAE,KAAK,GAAG,0BAA0B,CAAC;IACjD,8EAA8E;IAC9E,SAAS,CAAC,EAAE,iBAAiB,CAAC;IAC9B,gFAAgF;IAChF,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,yCAAyC;IACzC,QAAQ,CAAC,EAAE,YAAY,CAAC;IACxB,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB,aAAa,CAAC,EAAE;QACd,eAAe,CAAC,EAAE,OAAO,CAAC;QAC1B,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB,CAAC;IACF,WAAW,CAAC,EAAE;QACZ,mFAAmF;QACnF,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,OAAO,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;KAC/D,CAAC;IACF,+DAA+D;IAC/D,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC,gBAAgB,CAAC,KAAK,IAAI,CAAC;IACtD,iEAAiE;IACjE,IAAI,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,qFAAqF;IACrF,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IAC5B,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACpB,UAAU,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACvB,YAAY,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IACzC,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,MAAM,qBAAqB,GAC7B;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE,GACrB;IAAE,IAAI,EAAE,cAAc,GAAG,cAAc,CAAA;CAAE,GACzC;IAAE,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC;AAExB,MAAM,MAAM,kBAAkB,GAC5B,MAAM,GAAG,CAAC,eAAe,GAAG,qBAAqB,CAAC,CAAC;AAErD,MAAM,MAAM,oBAAoB,GAAG,WAAW,GAAG,UAAU,GAAG,QAAQ,CAAC;AAEvE,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,MAAM,EAAE,oBAAoB,CAAC;CACvC;AA6CD,0EAA0E;AAC1E,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC1C,qEAAqE;IACrE,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACjD,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,UAAU,CAAC;IAClD,QAAQ,CAAC,KAAK,EAAE,aAAa,GAAG,cAAc,CAAC;IAC/C,KAAK,IAAI,IAAI,CAAC;IACd,MAAM,IAAI,IAAI,CAAC;IACf,wEAAwE;IACxE,cAAc,IAAI,IAAI,CAAC;IACvB,YAAY,CAAC,SAAS,EAAE,iBAAiB,GAAG,IAAI,GAAG,IAAI,CAAC;IACxD,kEAAkE;IAClE,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC;IAC7C,4DAA4D;IAC5D,aAAa,IAAI,OAAO,CAAC;IACzB,OAAO,IAAI,IAAI,CAAC;CACjB;AAED,qEAAqE;AACrE,qBAAa,eAAgB,YAAW,gBAAgB;;IACtD,MAAM,CAAC,KAAK,CACV,KAAK,EAAE,kBAAkB,GAAG,eAAe,EAC3C,eAAe,GAAE,wBAA8C,GAC9D,eAAe,CAKjB;IAED,2EAA2E;IAC3E,mBAAmB,CAAC,KAAK,EAAE,eAAe,CAAC,MAAM,CAAC,GAAG,OAAO,CA4B3D;IAED,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9B,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAyDjD,YACE,OAAO,GAAE,eAAoB,EAC7B,eAAe,GAAE,wBAA8C,EAyFhE;IAED,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,UAAU,CAsBhD;IAED,QAAQ,CAAC,KAAK,EAAE,aAAa,GAAG,cAAc,CA0B7C;IAED,KAAK,IAAI,IAAI,CAIZ;IAED,MAAM,IAAI,IAAI,CAIb;IAED,cAAc,IAAI,IAAI,CAErB;IAED,YAAY,CAAC,SAAS,EAAE,iBAAiB,GAAG,IAAI,GAAG,IAAI,CAItD;IAED,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAM3C;IAED,aAAa,IAAI,OAAO,CAMvB;IAED,OAAO,IAAI,IAAI,CAEd;CAirCF;AAED,yDAAyD;AACzD,wBAAgB,KAAK,CAAC,KAAK,EAAE,kBAAkB,GAAG,gBAAgB,CAEjE;AAQD,wBAAgB,sBAAsB,CACpC,QAAQ,EAAE,WAAW,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC,EAClD,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,EACnB,YAAY,EAAE,MAAM,GACnB,KAAK,CA6BP"}
|