@pie-lib/delivery-events-svelte 0.1.1-next.0 → 0.2.0-next.2

package/dist/delivery-element.d.ts

@@ -0,0 +1,47 @@
+export interface DeliveryElementOptions<Model, Session> {
+    /**
+     * Whether `session` is a complete response to `model`. It is the `complete`
+     * flag of every `model-set` and `session-changed` the element dispatches, which
+     * is what a player gates the item's answered state on.
+     */
+    isComplete(model: Model | undefined, session: Session | undefined): boolean;
+}
+/**
+ * The delivery custom element a player mounts: it owns the session the player
+ * hands it and announces every change to it.
+ */
+export interface DeliveryElement<Model = unknown, Session = unknown> extends HTMLElement {
+    model: Model | undefined;
+    /** The session object the player set, with every update written into it. */
+    session: Session | undefined;
+    /**
+     * The component's `onSessionChange` prop, which it calls with each update:
+     * writes the update and dispatches `session-changed`.
+     */
+    onSessionChange: (session: Session) => void;
+    /** `isComplete` for the current model and session. A subclass adds its own conditions here. */
+    isComplete(): boolean;
+    /**
+     * Writes `next` into the player's session and hands the component `next`,
+     * a fresh reference its `$derived` reads re-run on. Dispatches nothing.
+     */
+    writeSession(next: Session): void;
+    dispatchSessionChanged(): void;
+}
+export type DeliveryElementConstructor<Model = unknown, Session = unknown> = new () => DeliveryElement<Model, Session>;
+/**
+ * The delivery custom element for `Component`, a Svelte component compiled
+ * with `customElement` that declares `model`, `session` and an
+ * `onSessionChange` callback prop.
+ *
+ * The session contract lives here, once, for every Svelte element: the update
+ * is written into the object the player handed the element (`writeSessionInPlace`),
+ * and `session-changed` and `model-set` are dispatched under the tag the player
+ * registered the element with, carrying `complete` from `options.isComplete`.
+ *
+ * `onSessionChange` is an ordinary prop of the component, which the element
+ * assigns in its constructor through the accessor Svelte generates for it; a
+ * component mounted with `mount()` takes it like any other prop. A subclass
+ * assigns its own callback props the same way.
+ */
+export declare function defineDeliveryElement<Model = unknown, Session = unknown>(Component: object, options: DeliveryElementOptions<Model, Session>): DeliveryElementConstructor<Model, Session>;

package/dist/index.d.ts

@@ -1,7 +1,8 @@
 /**
  * @pie-lib/delivery-events-svelte
  *
- * Shared host/session bridge utilities for Svelte delivery custom elements.
+ * The delivery custom element shell and session write-through for Svelte elements.
  */
-export * from './session-bridge.js';
+export * from './delivery-element.js';
+export * from './write-session-in-place.js';
 export { ModelSetEvent, SessionChangedEvent } from '@pie-element/shared-player-events';

package/dist/index.js

@@ -1,3 +1,4 @@
-import { ModelSetEvent as e, SessionChangedEvent as t } from "./index2.js";
-import { forwardSessionChange as n, resolveDeliveryHost as r, writeSessionInPlace as i } from "./index3.js";
-export { e as ModelSetEvent, t as SessionChangedEvent, n as forwardSessionChange, r as resolveDeliveryHost, i as writeSessionInPlace };
+import { writeSessionInPlace as e } from "./index2.js";
+import { defineDeliveryElement as t } from "./index3.js";
+import { ModelSetEvent as n, SessionChangedEvent as r } from "@pie-element/shared-player-events";
+export { n as ModelSetEvent, r as SessionChangedEvent, t as defineDeliveryElement, e as writeSessionInPlace };

package/dist/index2.js

@@ -1,33 +1,17 @@
-//#region ../../shared/player-events/dist/index.js
-var e = class e extends CustomEvent {
-	static {
-		this.TYPE = "model-set";
+//#region src/write-session-in-place.ts
+function e(e) {
+	return !!e && typeof e == "object" && !Array.isArray(e);
+}
+function t(t, n) {
+	if (t === n) return t;
+	if (!e(t) || !e(n) || Object.isFrozen(t) || !Object.isExtensible(t)) return n;
+	try {
+		for (let e of Object.keys(t)) e in n || delete t[e];
+		Object.assign(t, n);
+	} catch {
+		return n;
 	}
-	constructor(t, n, r) {
-		super(e.TYPE, {
-			bubbles: !0,
-			composed: !0,
-			detail: {
-				complete: n,
-				component: t,
-				hasModel: r
-			}
-		}), this.component = t, this.complete = n;
-	}
-}, t = class e extends CustomEvent {
-	static {
-		this.TYPE = "session-changed";
-	}
-	constructor(t, n) {
-		super(e.TYPE, {
-			bubbles: !0,
-			composed: !0,
-			detail: {
-				complete: n,
-				component: t
-			}
-		}), this.component = t, this.complete = n;
-	}
-};
+	return t;
+}
 //#endregion
-export { e as ModelSetEvent, t as SessionChangedEvent };
+export { t as writeSessionInPlace };

package/dist/index3.js

@@ -1,38 +1,42 @@
-import { SessionChangedEvent as e } from "./index2.js";
-//#region src/session-bridge.ts
-var t = (e) => {
-	let t = e;
-	return t ? typeof t.onSessionChange == "function" || typeof t.onAudioStarted == "function" || typeof t.onAudioEnded == "function" : !1;
-};
-function n(e, n = {}) {
-	let r = n.hostPredicate ?? t, i = e;
-	for (; i;) {
-		if (r(i)) return i;
-		i = i.parentElement;
+import { writeSessionInPlace as e } from "./index2.js";
+import { ModelSetEvent as t, SessionChangedEvent as n } from "@pie-element/shared-player-events";
+//#region src/delivery-element.ts
+function r(r, i) {
+	let a = r.element;
+	if (!a) throw TypeError("defineDeliveryElement: the component was not compiled with `customElement`");
+	class o extends a {
+		#e;
+		#t;
+		constructor() {
+			super(), this.onSessionChange = (e) => {
+				this.writeSession(e), this.dispatchSessionChanged();
+			};
+		}
+		set model(e) {
+			this.#e = e, super.model = e, queueMicrotask(() => {
+				this.dispatchEvent(new t(this.tagName.toLowerCase(), this.isComplete(), this.#e !== void 0));
+			});
+		}
+		get model() {
+			return this.#e;
+		}
+		set session(e) {
+			this.#t = e, super.session = e, this.dispatchSessionChanged();
+		}
+		get session() {
+			return this.#t;
+		}
+		isComplete() {
+			return i.isComplete(this.#e, this.#t);
+		}
+		writeSession(t) {
+			this.#t = e(this.#t, t), super.session = t;
+		}
+		dispatchSessionChanged() {
+			this.dispatchEvent(new n(this.tagName.toLowerCase(), this.isComplete()));
+		}
 	}
-	if (typeof document < "u" && n.fallbackSelector) {
-		let e = document.querySelector(n.fallbackSelector);
-		if (r(e)) return e;
-	}
-	return null;
-}
-function r(e) {
-	return !!e && typeof e == "object" && !Array.isArray(e);
-}
-function i(e, t) {
-	if (e === t) return e;
-	if (!r(e) || !r(t) || Object.isFrozen(e) || !Object.isExtensible(e)) return t;
-	try {
-		for (let n of Object.keys(e)) n in t || delete e[n];
-		Object.assign(e, t);
-	} catch {
-		return t;
-	}
-	return e;
-}
-function a({ sourceEl: t, fallbackSelector: r, component: i, complete: a, session: o }) {
-	let s = n(t, { fallbackSelector: r });
-	return s ? typeof s.onSessionChange == "function" ? (s.onSessionChange(o), s) : (s.dispatchEvent(new e(i, a)), s) : null;
+	return o;
 }
 //#endregion
-export { a as forwardSessionChange, n as resolveDeliveryHost, i as writeSessionInPlace };
+export { r as defineDeliveryElement };

package/dist/{session-bridge.d.ts → write-session-in-place.d.ts}

@@ -1,19 +1,3 @@
-export type DeliveryHostElement = HTMLElement & {
-    session?: unknown;
-    onSessionChange?: (session: unknown) => void;
-    onAudioStarted?: () => void;
-    onAudioEnded?: () => void;
-};
-type HostPredicate = (node: unknown) => boolean;
-export interface ResolveDeliveryHostOptions {
-    fallbackSelector?: string;
-    hostPredicate?: HostPredicate;
-}
-/**
- * Walk up the DOM from a source element and find the nearest delivery host wrapper.
- * Falls back to selector lookup to support detached nested render roots.
- */
-export declare function resolveDeliveryHost(sourceEl?: HTMLElement | null, options?: ResolveDeliveryHostOptions): DeliveryHostElement | null;
 /**
  * Assign a delivery update into the session object the player owns, keeping the
  * reference.
@@ -37,16 +21,3 @@ export declare function resolveDeliveryHost(sourceEl?: HTMLElement | null, optio
  * learner's update with it before the element ever stored it.
  */
 export declare function writeSessionInPlace(target: unknown, next: unknown): unknown;
-export interface ForwardSessionChangeOptions {
-    sourceEl?: HTMLElement | null;
-    fallbackSelector?: string;
-    component: string;
-    complete: boolean;
-    session: unknown;
-}
-/**
- * Forward a delivery session update using the host callback when available.
- * If no callback is exposed, dispatch the canonical session-changed metadata event.
- */
-export declare function forwardSessionChange({ sourceEl, fallbackSelector, component, complete, session, }: ForwardSessionChangeOptions): DeliveryHostElement | null;
-export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pie-lib/delivery-events-svelte",
-  "version": "0.1.1-next.0",
+  "version": "0.2.0-next.2",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/pie-framework/pie-elements-ng.git",