@realnation/builder-shared-sdk 1.3.0 → 2.1.0

package/dist/interaction/index.d.ts

@@ -23,7 +23,8 @@ export declare const INTERACTION_KEYS: {
     readonly scale: "selected-scale";
     readonly opacity: "selected-opacity";
 };
-export type InteractionTrigger = 'hover' | 'click' | 'appear' | 'loop';
+/** `none` is the section's off switch: the element has no interaction state at all. */
+export type InteractionTrigger = 'none' | 'hover' | 'click' | 'appear' | 'loop';
 export declare const INTERACTION_TRIGGERS: readonly InteractionTrigger[];
 /** Anything the Builder stores for one element. Values arrive untyped from the API. */
 export type InteractionProperty = Record<string, unknown>;
@@ -47,14 +48,32 @@ export interface InteractionStyle {
 export type StyleKeyCase = 'camel' | 'kebab';
 /** Rewrites the compound property names; transition / transform / opacity are already valid CSS. */
 export declare function toKebabStyle(style: InteractionStyle): InteractionStyle;
+/** Whether the operator configured any second appearance at all. Untouched keys are absent. */
+export declare function hasSelectedAppearance(property: InteractionProperty | null | undefined): boolean;
+export interface InteractionEnabledOptions {
+    /**
+     * The caller decides when the element is selected, so the trigger has nothing
+     * to decide for it. Inferred from passing an explicit `active` to style().
+     */
+    selfDriven?: boolean;
+}
 /**
  * Whether the element has an interaction state at all.
  *
- * Easing is the section's master switch: `none` (the default) means the
- * element behaves exactly as it did before this feature existed. Every entry
- * point checks this first so unconfigured elements stay untouched.
+ * For elements the platform drives, the trigger is the master switch: it
+ * answers the first question, does this element react to anything? Easing only
+ * describes what the change looks like once something triggers it.
+ *
+ * For an element whose owner supplies its own `active` — personality-test's
+ * options, where "selected" means the answer the player picked — the trigger
+ * has nothing left to decide, and making the operator pick an arbitrary one
+ * just to switch the section on would be a riddle. There the switch is simply
+ * whether a second appearance was configured.
+ *
+ * Either way an element nobody configured behaves exactly as it did before
+ * this feature existed. Every entry point checks this first.
  */
-export declare function isInteractionEnabled(property: InteractionProperty | null | undefined): boolean;
+export declare function isInteractionEnabled(property: InteractionProperty | null | undefined, options?: InteractionEnabledOptions): boolean;
 export declare function interactionTriggerOf(property: InteractionProperty | null | undefined): InteractionTrigger;
 export declare function interactionDurationOf(property: InteractionProperty | null | undefined): number;
 /**
@@ -73,6 +92,8 @@ export interface InteractionStyleOptions {
     instant?: boolean;
     /** Key style of the returned object. Defaults to camelCase. */
     keys?: StyleKeyCase;
+    /** See isInteractionEnabled. Set by style() when the caller supplies `active`. */
+    selfDriven?: boolean;
 }
 /**
  * The style to merge onto an element for a given state.

package/dist/interaction/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/interaction/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,wEAAwE;AACxE,eAAO,MAAM,gBAAgB;;;;;;;;;;CAUnB,CAAC;AAEX,MAAM,MAAM,kBAAkB,GAAG,OAAO,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,CAAC;AACvE,eAAO,MAAM,oBAAoB,EAAE,SAAS,kBAAkB,EAAyC,CAAC;AAExG,uFAAuF;AACvF,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE1D;;;;;;;GAOG;AACH,MAAM,WAAW,gBAAgB;IAC/B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,iFAAiF;IACjF,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;CAC3C;AAED,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG,OAAO,CAAC;AAO7C,oGAAoG;AACpG,wBAAgB,YAAY,CAAC,KAAK,EAAE,gBAAgB,GAAG,gBAAgB,CAItE;AAOD;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,mBAAmB,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,CAG9F;AAED,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,mBAAmB,GAAG,IAAI,GAAG,SAAS,GAAG,kBAAkB,CAGzG;AAED,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,mBAAmB,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,CAE9F;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,mBAAmB,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,CAG5F;AAED,MAAM,WAAW,uBAAuB;IACtC;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,+DAA+D;IAC/D,IAAI,CAAC,EAAE,YAAY,CAAC;CACrB;AAED;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,mBAAmB,GAAG,IAAI,GAAG,SAAS,EAChD,MAAM,EAAE,OAAO,EACf,OAAO,GAAE,uBAA4B,GACpC,gBAAgB,CAoClB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/interaction/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,wEAAwE;AACxE,eAAO,MAAM,gBAAgB;;;;;;;;;;CAUnB,CAAC;AAEX,uFAAuF;AACvF,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,CAAC;AAChF,eAAO,MAAM,oBAAoB,EAAE,SAAS,kBAAkB,EAAiD,CAAC;AAEhH,uFAAuF;AACvF,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE1D;;;;;;;GAOG;AACH,MAAM,WAAW,gBAAgB;IAC/B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,iFAAiF;IACjF,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;CAC3C;AAED,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG,OAAO,CAAC;AAO7C,oGAAoG;AACpG,wBAAgB,YAAY,CAAC,KAAK,EAAE,gBAAgB,GAAG,gBAAgB,CAItE;AAeD,+FAA+F;AAC/F,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,mBAAmB,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,CAG/F;AAED,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,oBAAoB,CAClC,QAAQ,EAAE,mBAAmB,GAAG,IAAI,GAAG,SAAS,EAChD,OAAO,GAAE,yBAA8B,GACtC,OAAO,CAGT;AAED,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,mBAAmB,GAAG,IAAI,GAAG,SAAS,GAAG,kBAAkB,CAGzG;AAED,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,mBAAmB,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,CAE9F;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,mBAAmB,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,CAG5F;AAED,MAAM,WAAW,uBAAuB;IACtC;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,+DAA+D;IAC/D,IAAI,CAAC,EAAE,YAAY,CAAC;IACpB,kFAAkF;IAClF,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,mBAAmB,GAAG,IAAI,GAAG,SAAS,EAChD,MAAM,EAAE,OAAO,EACf,OAAO,GAAE,uBAA4B,GACpC,gBAAgB,CAsClB"}

package/dist/interaction/index.js

@@ -23,7 +23,7 @@ export const INTERACTION_KEYS = {
     scale: 'selected-scale',
     opacity: 'selected-opacity',
 };
-export const INTERACTION_TRIGGERS = ['hover', 'click', 'appear', 'loop'];
+export const INTERACTION_TRIGGERS = ['none', 'hover', 'click', 'appear', 'loop'];
 const KEBAB = {
     backgroundColor: 'background-color',
     borderColor: 'border-color',
@@ -39,21 +39,43 @@ const num = (value, fallback) => {
     const n = Number(value);
     return Number.isFinite(n) ? n : fallback;
 };
+const SELECTED_APPEARANCE_KEYS = [
+    INTERACTION_KEYS.bgColor,
+    INTERACTION_KEYS.borderColor,
+    INTERACTION_KEYS.rotation,
+    INTERACTION_KEYS.scale,
+    INTERACTION_KEYS.opacity,
+];
+/** Whether the operator configured any second appearance at all. Untouched keys are absent. */
+export function hasSelectedAppearance(property) {
+    if (!property)
+        return false;
+    return SELECTED_APPEARANCE_KEYS.some((k) => property[k] != null && property[k] !== '');
+}
 /**
  * Whether the element has an interaction state at all.
  *
- * Easing is the section's master switch: `none` (the default) means the
- * element behaves exactly as it did before this feature existed. Every entry
- * point checks this first so unconfigured elements stay untouched.
+ * For elements the platform drives, the trigger is the master switch: it
+ * answers the first question, does this element react to anything? Easing only
+ * describes what the change looks like once something triggers it.
+ *
+ * For an element whose owner supplies its own `active` — personality-test's
+ * options, where "selected" means the answer the player picked — the trigger
+ * has nothing left to decide, and making the operator pick an arbitrary one
+ * just to switch the section on would be a riddle. There the switch is simply
+ * whether a second appearance was configured.
+ *
+ * Either way an element nobody configured behaves exactly as it did before
+ * this feature existed. Every entry point checks this first.
  */
-export function isInteractionEnabled(property) {
-    if (!property)
-        return false;
-    return String(property[INTERACTION_KEYS.easing] ?? 'none') !== 'none';
+export function isInteractionEnabled(property, options = {}) {
+    if (options.selfDriven)
+        return hasSelectedAppearance(property);
+    return interactionTriggerOf(property) !== 'none';
 }
 export function interactionTriggerOf(property) {
-    const raw = String(property?.[INTERACTION_KEYS.trigger] ?? 'hover');
-    return INTERACTION_TRIGGERS.includes(raw) ? raw : 'hover';
+    const raw = String(property?.[INTERACTION_KEYS.trigger] ?? 'none');
+    return INTERACTION_TRIGGERS.includes(raw) ? raw : 'none';
 }
 export function interactionDurationOf(property) {
     return num(property?.[INTERACTION_KEYS.duration], 400);
@@ -78,10 +100,12 @@ export function interactionPeriodOf(property) {
  * an unset colour must inherit the normal appearance rather than reset it.
  */
 export function interactionStyle(property, active, options = {}) {
-    if (!isInteractionEnabled(property))
+    if (!isInteractionEnabled(property, { selfDriven: options.selfDriven }))
         return {};
     const bag = property;
-    const easing = String(bag[INTERACTION_KEYS.easing]);
+    // An instant change is still expressible: set the duration to zero. Easing
+    // only decides how the time is spent, so it never needs an "off" of its own.
+    const easing = String(bag[INTERACTION_KEYS.easing] ?? 'ease-out');
     const duration = interactionDurationOf(bag);
     const style = {};
     if (options.instant) {

package/dist/interaction/vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"vue.d.ts","sourceRoot":"","sources":["../../src/interaction/vue.ts"],"names":[],"mappings":"AA0BA,OAAO,KAAK,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAEtF,wFAAwF;AACxF,MAAM,WAAW,gBAAgB;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,mBAAmB,GAAG,IAAI,GAAG,SAAS,CAAC;CAClD;AAED,MAAM,WAAW,0BAA0B;IACzC,gFAAgF;IAChF,QAAQ,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,IAAI,EAAE,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC;IACnD,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC;IACvC,8EAA8E;IAC9E,SAAS,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,IAAI,KAAK,IAAI,CAAC;IACrC;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,YAAY,CAAC;CACrB;AAED,MAAM,WAAW,mBAAmB;IAClC;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,EAAE,mBAAmB,GAAG,IAAI,GAAG,SAAS,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,gBAAgB,CAAC;IACzG,oFAAoF;IACpF,IAAI,CAAC,QAAQ,EAAE,mBAAmB,GAAG,IAAI,GAAG,SAAS,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,IAAI,CAAC,CAAC;IAChG;;;;;;OAMG;IACH,IAAI,CAAC,OAAO,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC;IACxC,oEAAoE;IACpE,IAAI,IAAI,IAAI,CAAC;IACb,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IAC/B,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,GAAG,IAAI,CAAC;CAC3C;AAUD,wBAAgB,mBAAmB,CAAC,OAAO,GAAE,0BAA+B,GAAG,mBAAmB,CA8EjG"}
+{"version":3,"file":"vue.d.ts","sourceRoot":"","sources":["../../src/interaction/vue.ts"],"names":[],"mappings":"AA0BA,OAAO,KAAK,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAEtF,wFAAwF;AACxF,MAAM,WAAW,gBAAgB;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,mBAAmB,GAAG,IAAI,GAAG,SAAS,CAAC;CAClD;AAED,MAAM,WAAW,0BAA0B;IACzC,gFAAgF;IAChF,QAAQ,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,IAAI,EAAE,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC;IACnD,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC;IACvC,8EAA8E;IAC9E,SAAS,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,IAAI,KAAK,IAAI,CAAC;IACrC;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,YAAY,CAAC;CACrB;AAED,MAAM,WAAW,mBAAmB;IAClC;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,EAAE,mBAAmB,GAAG,IAAI,GAAG,SAAS,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,gBAAgB,CAAC;IACzG,oFAAoF;IACpF,IAAI,CAAC,QAAQ,EAAE,mBAAmB,GAAG,IAAI,GAAG,SAAS,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,IAAI,CAAC,CAAC;IAChG;;;;;;OAMG;IACH,IAAI,CAAC,OAAO,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC;IACxC,oEAAoE;IACpE,IAAI,IAAI,IAAI,CAAC;IACb,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IAC/B,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,GAAG,IAAI,CAAC;CAC3C;AAUD,wBAAgB,mBAAmB,CAAC,OAAO,GAAE,0BAA+B,GAAG,mBAAmB,CAoFjG"}

package/dist/interaction/vue.js

@@ -46,7 +46,13 @@ export function useInteractionState(options = {}) {
     const api = {
         style(property, key, forced) {
             const on = forced ?? active[key] ?? false;
-            return interactionStyle(property, on, { instant: instant[key] === true, keys: options.keys });
+            // Passing `active` at all is the declaration: this caller owns the timing,
+            // so the configured trigger is not what decides whether the state exists.
+            return interactionStyle(property, on, {
+                instant: instant[key] === true,
+                keys: options.keys,
+                selfDriven: forced !== undefined,
+            });
         },
         bind(property, key) {
             if (!isInteractionEnabled(property))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@realnation/builder-shared-sdk",
-  "version": "1.3.0",
+  "version": "2.1.0",
   "type": "module",
   "private": false,
   "exports": {