@baleada/logic 0.22.5 → 0.22.6

package/README.md

@@ -2,4 +2,4 @@
 
 UI logic for the Baleada toolkit.
 
-[See the Baleada docs](https://baleada/netlify.com) for more guidance.
+[See the Baleada docs](https://baleada.dev) for more guidance.

package/lib/index.cjs

@@ -220,6 +220,15 @@ function createToEntries() {
     return entries;
   };
 }
+function createToKeys() {
+  return (object) => {
+    const keys = [];
+    for (const key in object) {
+      keys.push(key);
+    }
+    return keys;
+  };
+}
 function createMatchesKeycombo(keycombo) {
   return (event) => eventMatchesKeycombo(event, narrowKeycombo(keycombo));
 }
@@ -500,7 +509,10 @@ class Recognizeable {
       getMetadata: () => this.metadata,
       setMetadata: (metadata) => this.computedMetadata = metadata,
       recognized: () => this.recognized(),
-      denied: () => this.denied()
+      denied: () => this.denied(),
+      recognizedUntilReady: () => this.recognizedUntilReady(),
+      deniedUntilReady: () => this.deniedUntilReady(),
+      ready: () => this.ready()
     };
     this.ready();
   }
@@ -514,6 +526,12 @@ class Recognizeable {
   denied() {
     this.computedStatus = "denied";
   }
+  recognizedUntilReady() {
+    this.computedStatus = "recognized until ready";
+  }
+  deniedUntilReady() {
+    this.computedStatus = "denied until ready";
+  }
   computedStatus;
   ready() {
     this.computedStatus = "ready";
@@ -536,7 +554,8 @@ class Recognizeable {
     return this;
   }
   recognize(sequenceItem, { onRecognized } = {}) {
-    this.recognizing();
+    if (!this.status.includes("until ready"))
+      this.recognizing();
     const type = this.toType(sequenceItem), excess = predicateNumber(this.maxSequenceLength) ? Math.max(0, this.sequence.length - this.maxSequenceLength) : 0, newSequence = createConcat(
       createSlice(excess)(this.sequence),
       [sequenceItem]
@@ -546,7 +565,9 @@ class Recognizeable {
     });
     this.effects.get(type)?.(sequenceItem, { ...this.effectApi });
     switch (this.status) {
+      case "ready":
       case "denied":
+      case "denied until ready":
         this.resetComputedMetadata();
         this.setSequence([]);
         break;
@@ -690,10 +711,23 @@ class Listenable {
     this.active.add({ target, id: [this.type, effect] });
   }
   recognizeableListen(effect, options) {
+    let effectStatus = "ready";
     const guardedEffect = (sequenceItem) => {
       this.recognizeable.recognize(sequenceItem, { onRecognized: (sequenceItem2) => effect(sequenceItem2) });
-      if (this.recognizeable.status === "recognized") {
-        effect(sequenceItem);
+      switch (this.recognizeable.status) {
+        case "recognized until ready":
+          if (effectStatus === "ready") {
+            effect(sequenceItem);
+            effectStatus = "performed";
+          }
+          break;
+        case "recognized":
+          effect(sequenceItem);
+          effectStatus = "ready";
+          break;
+        default:
+          effectStatus = "ready";
+          break;
       }
     };
     for (const type of this.recognizeableEffectsKeys) {
@@ -834,9 +868,8 @@ function eventMatchesKeycombo(event, keycombo) {
   return lazyCollections.every(({ name, type }, index) => {
     switch (type) {
       case "singleCharacter":
-        if (name === "!") {
+        if (name === "!")
           return event.key === "!";
-        }
         const keyToTest = event.altKey && fromComboItemNameToType(event.key) === "custom" ? fromCodeToSingleCharacter(event.code) : event.key.toLowerCase();
         return name.startsWith("!") ? keyToTest !== toKey(name.slice(1)).toLowerCase() : keyToTest === toKey(name).toLowerCase();
       case "other":
@@ -3289,6 +3322,7 @@ exports.createSort = createSort;
 exports.createSwap = createSwap;
 exports.createToEntries = createToEntries;
 exports.createToFocusable = createToFocusable;
+exports.createToKeys = createToKeys;
 exports.createUnique = createUnique;
 exports.easingsNetInBack = easingsNetInBack;
 exports.easingsNetInCirc = easingsNetInCirc;

package/lib/index.d.ts

@@ -156,10 +156,13 @@ type RecognizeableEffectApi<Type extends ListenableSupportedType, Metadata exten
     setMetadata: (metadata: Metadata) => void;
     recognized: () => void;
     denied: () => void;
+    recognizedUntilReady: () => void;
+    deniedUntilReady: () => void;
+    ready: () => void;
     getSequence: () => ListenEffectParam<Type>[];
     onRecognized: (sequenceItem: ListenEffectParam<Type>) => any;
 };
-type RecognizeableStatus = 'recognized' | 'recognizing' | 'denied' | 'ready';
+type RecognizeableStatus = 'recognized' | 'recognizing' | 'denied' | 'ready' | 'recognized until ready' | 'denied until ready';
 type RecognizeOptions<Type extends ListenableSupportedType, Metadata extends Record<any, any>> = {
     onRecognized?: (sequenceItem: ListenEffectParam<Type>) => any;
 };
@@ -172,6 +175,8 @@ declare class Recognizeable<Type extends ListenableSupportedType, Metadata exten
     private resetComputedMetadata;
     private recognized;
     private denied;
+    private recognizedUntilReady;
+    private deniedUntilReady;
     private computedStatus;
     private ready;
     get sequence(): ListenEffectParam<Type>[];
@@ -788,6 +793,7 @@ type MapFunction<Key, Value, Returned> = (transform: Map<Key, Value>) => Returne
 declare function createRename<Key, Value>(from: Key, to: Key): MapFunction<Key, Value, Map<Key, Value>>;
 type ObjectFunction<Key extends string | number | symbol, Value, Returned> = (transform: Record<Key, Value>) => Returned;
 declare function createToEntries<Key extends string | number | symbol, Value>(): ObjectFunction<Key, Value, [Key, Value][]>;
+declare function createToKeys<Key extends string | number | symbol>(): ObjectFunction<Key, any, [Key, any][]>;
 type EventFunction<Evt extends Event, Returned> = (event: Evt) => Returned;
 declare function createMatchesKeycombo(keycombo: string): EventFunction<KeyboardEvent, boolean>;
 declare function createMatchesMousecombo(mousecombo: string): EventFunction<MouseEvent, boolean>;
@@ -801,4 +807,4 @@ declare class Pipeable {
     pipeAsync(...fns: ((...args: any[]) => Promise<any>)[]): Promise<any>;
 }
 
-export { AnimateFrame, AnimateFrameEffect, AnimateOptions, Animateable, AnimateableKeyframe, AnimateableOptions, AnimateableStatus, ArrayFunction, ArrayFunctionAsync, Broadcastable, BroadcastableOptions, BroadcastableStatus, CompleteOptions, Completeable, CompleteableOptions, CompleteableStatus, Copyable, CopyableOptions, CopyableStatus, Delayable, DelayableEffect, DelayableOptions, DelayableStatus, Drawable, DrawableOptions, DrawableState, DrawableStatus, ElementFunction, EventFunction, FetchOptions, FetchOptionsApi, Fetchable, FetchableOptions, FetchableStatus, Fullscreenable, FullscreenableGetElement, FullscreenableOptions, FullscreenableStatus, Grantable, GrantableOptions, GrantableStatus, ListenEffect, ListenEffectParam, ListenOptions, Listenable, ListenableActive, ListenableKeycombo, ListenableMousecombo, ListenableOptions, ListenablePointercombo, ListenableStatus, ListenableSupportedEventType, ListenableSupportedType, MapFunction, Navigateable, NavigateableOptions, NavigateableStatus, NumberFunction, ObjectFunction, Pickable, PickableOptions, PickableStatus, Pipeable, RecognizeOptions, Recognizeable, RecognizeableEffect, RecognizeableOptions, RecognizeableStatus, Resolveable, ResolveableGetPromise, ResolveableOptions, ResolveableStatus, Sanitizeable, SanitizeableOptions, SanitizeableStatus, Searchable, SearchableOptions, SearchableStatus, Shareable, ShareableOptions, ShareableStatus, Storeable, StoreableOptions, StoreableStatus, StringFunction, createClamp, createClip, createConcat, createDetermine, createFilter, createFilterAsync, createForEachAsync, createInsert, createMap, createMapAsync, createMatchesKeycombo, createMatchesMousecombo, createMatchesPointercombo, createReduce, createReduceAsync, createRemove, createRename, createReorder, createReplace, createReverse, createSlice, createSlug, createSort, createSwap, createToEntries, createToFocusable, createUnique, easingsNetInBack, easingsNetInCirc, easingsNetInCubic, easingsNetInExpo, easingsNetInOutBack, easingsNetInOutCirc, easingsNetInOutCubic, easingsNetInOutExpo, easingsNetInOutQuad, easingsNetInOutQuint, easingsNetInOutSine, easingsNetInQuad, easingsNetInQuart, easingsNetInQuint, easingsNetInSine, easingsNetOutBack, easingsNetOutCirc, easingsNetOutCubic, easingsNetOutExpo, easingsNetOutQuad, easingsNetOutQuint, easingsNetOutSine, linear, materialAccelerated, materialDecelerated, materialStandard, toD, toFlattenedD, toMessageListenParams, verouEase, verouEaseIn, verouEaseInOut, verouEaseOut };
+export { AnimateFrame, AnimateFrameEffect, AnimateOptions, Animateable, AnimateableKeyframe, AnimateableOptions, AnimateableStatus, ArrayFunction, ArrayFunctionAsync, Broadcastable, BroadcastableOptions, BroadcastableStatus, CompleteOptions, Completeable, CompleteableOptions, CompleteableStatus, Copyable, CopyableOptions, CopyableStatus, Delayable, DelayableEffect, DelayableOptions, DelayableStatus, Drawable, DrawableOptions, DrawableState, DrawableStatus, ElementFunction, EventFunction, FetchOptions, FetchOptionsApi, Fetchable, FetchableOptions, FetchableStatus, Fullscreenable, FullscreenableGetElement, FullscreenableOptions, FullscreenableStatus, Grantable, GrantableOptions, GrantableStatus, ListenEffect, ListenEffectParam, ListenOptions, Listenable, ListenableActive, ListenableKeycombo, ListenableMousecombo, ListenableOptions, ListenablePointercombo, ListenableStatus, ListenableSupportedEventType, ListenableSupportedType, MapFunction, Navigateable, NavigateableOptions, NavigateableStatus, NumberFunction, ObjectFunction, Pickable, PickableOptions, PickableStatus, Pipeable, RecognizeOptions, Recognizeable, RecognizeableEffect, RecognizeableOptions, RecognizeableStatus, Resolveable, ResolveableGetPromise, ResolveableOptions, ResolveableStatus, Sanitizeable, SanitizeableOptions, SanitizeableStatus, Searchable, SearchableOptions, SearchableStatus, Shareable, ShareableOptions, ShareableStatus, Storeable, StoreableOptions, StoreableStatus, StringFunction, createClamp, createClip, createConcat, createDetermine, createFilter, createFilterAsync, createForEachAsync, createInsert, createMap, createMapAsync, createMatchesKeycombo, createMatchesMousecombo, createMatchesPointercombo, createReduce, createReduceAsync, createRemove, createRename, createReorder, createReplace, createReverse, createSlice, createSlug, createSort, createSwap, createToEntries, createToFocusable, createToKeys, createUnique, easingsNetInBack, easingsNetInCirc, easingsNetInCubic, easingsNetInExpo, easingsNetInOutBack, easingsNetInOutCirc, easingsNetInOutCubic, easingsNetInOutExpo, easingsNetInOutQuad, easingsNetInOutQuint, easingsNetInOutSine, easingsNetInQuad, easingsNetInQuart, easingsNetInQuint, easingsNetInSine, easingsNetOutBack, easingsNetOutCirc, easingsNetOutCubic, easingsNetOutExpo, easingsNetOutQuad, easingsNetOutQuint, easingsNetOutSine, linear, materialAccelerated, materialDecelerated, materialStandard, toD, toFlattenedD, toMessageListenParams, verouEase, verouEaseIn, verouEaseInOut, verouEaseOut };

package/lib/index.js

@@ -218,6 +218,15 @@ function createToEntries() {
     return entries;
   };
 }
+function createToKeys() {
+  return (object) => {
+    const keys = [];
+    for (const key in object) {
+      keys.push(key);
+    }
+    return keys;
+  };
+}
 function createMatchesKeycombo(keycombo) {
   return (event) => eventMatchesKeycombo(event, narrowKeycombo(keycombo));
 }
@@ -498,7 +507,10 @@ class Recognizeable {
       getMetadata: () => this.metadata,
       setMetadata: (metadata) => this.computedMetadata = metadata,
       recognized: () => this.recognized(),
-      denied: () => this.denied()
+      denied: () => this.denied(),
+      recognizedUntilReady: () => this.recognizedUntilReady(),
+      deniedUntilReady: () => this.deniedUntilReady(),
+      ready: () => this.ready()
     };
     this.ready();
   }
@@ -512,6 +524,12 @@ class Recognizeable {
   denied() {
     this.computedStatus = "denied";
   }
+  recognizedUntilReady() {
+    this.computedStatus = "recognized until ready";
+  }
+  deniedUntilReady() {
+    this.computedStatus = "denied until ready";
+  }
   computedStatus;
   ready() {
     this.computedStatus = "ready";
@@ -534,7 +552,8 @@ class Recognizeable {
     return this;
   }
   recognize(sequenceItem, { onRecognized } = {}) {
-    this.recognizing();
+    if (!this.status.includes("until ready"))
+      this.recognizing();
     const type = this.toType(sequenceItem), excess = predicateNumber(this.maxSequenceLength) ? Math.max(0, this.sequence.length - this.maxSequenceLength) : 0, newSequence = createConcat(
       createSlice(excess)(this.sequence),
       [sequenceItem]
@@ -544,7 +563,9 @@ class Recognizeable {
     });
     this.effects.get(type)?.(sequenceItem, { ...this.effectApi });
     switch (this.status) {
+      case "ready":
       case "denied":
+      case "denied until ready":
         this.resetComputedMetadata();
         this.setSequence([]);
         break;
@@ -688,10 +709,23 @@ class Listenable {
     this.active.add({ target, id: [this.type, effect] });
   }
   recognizeableListen(effect, options) {
+    let effectStatus = "ready";
     const guardedEffect = (sequenceItem) => {
       this.recognizeable.recognize(sequenceItem, { onRecognized: (sequenceItem2) => effect(sequenceItem2) });
-      if (this.recognizeable.status === "recognized") {
-        effect(sequenceItem);
+      switch (this.recognizeable.status) {
+        case "recognized until ready":
+          if (effectStatus === "ready") {
+            effect(sequenceItem);
+            effectStatus = "performed";
+          }
+          break;
+        case "recognized":
+          effect(sequenceItem);
+          effectStatus = "ready";
+          break;
+        default:
+          effectStatus = "ready";
+          break;
       }
     };
     for (const type of this.recognizeableEffectsKeys) {
@@ -832,9 +866,8 @@ function eventMatchesKeycombo(event, keycombo) {
   return every(({ name, type }, index) => {
     switch (type) {
       case "singleCharacter":
-        if (name === "!") {
+        if (name === "!")
           return event.key === "!";
-        }
         const keyToTest = event.altKey && fromComboItemNameToType(event.key) === "custom" ? fromCodeToSingleCharacter(event.code) : event.key.toLowerCase();
         return name.startsWith("!") ? keyToTest !== toKey(name.slice(1)).toLowerCase() : keyToTest === toKey(name).toLowerCase();
       case "other":
@@ -3242,4 +3275,4 @@ class Storeable {
   }
 }
 
-export { Animateable, Broadcastable, Completeable, Copyable, Delayable, Drawable, Fetchable, Fullscreenable, Grantable, Listenable, Navigateable, Pickable, Pipeable, Recognizeable, Resolveable, Sanitizeable, Searchable, Shareable, Storeable, createClamp, createClip, createConcat, createDetermine, createFilter, createFilterAsync, createForEachAsync, createInsert, createMap, createMapAsync, createMatchesKeycombo, createMatchesMousecombo, createMatchesPointercombo, createReduce, createReduceAsync, createRemove, createRename, createReorder, createReplace, createReverse, createSlice, createSlug, createSort, createSwap, createToEntries, createToFocusable, createUnique, easingsNetInBack, easingsNetInCirc, easingsNetInCubic, easingsNetInExpo, easingsNetInOutBack, easingsNetInOutCirc, easingsNetInOutCubic, easingsNetInOutExpo, easingsNetInOutQuad, easingsNetInOutQuint, easingsNetInOutSine, easingsNetInQuad, easingsNetInQuart, easingsNetInQuint, easingsNetInSine, easingsNetOutBack, easingsNetOutCirc, easingsNetOutCubic, easingsNetOutExpo, easingsNetOutQuad, easingsNetOutQuint, easingsNetOutSine, linear, materialAccelerated, materialDecelerated, materialStandard, toD, toFlattenedD, toMessageListenParams, verouEase, verouEaseIn, verouEaseInOut, verouEaseOut };
+export { Animateable, Broadcastable, Completeable, Copyable, Delayable, Drawable, Fetchable, Fullscreenable, Grantable, Listenable, Navigateable, Pickable, Pipeable, Recognizeable, Resolveable, Sanitizeable, Searchable, Shareable, Storeable, createClamp, createClip, createConcat, createDetermine, createFilter, createFilterAsync, createForEachAsync, createInsert, createMap, createMapAsync, createMatchesKeycombo, createMatchesMousecombo, createMatchesPointercombo, createReduce, createReduceAsync, createRemove, createRename, createReorder, createReplace, createReverse, createSlice, createSlug, createSort, createSwap, createToEntries, createToFocusable, createToKeys, createUnique, easingsNetInBack, easingsNetInCirc, easingsNetInCubic, easingsNetInExpo, easingsNetInOutBack, easingsNetInOutCirc, easingsNetInOutCubic, easingsNetInOutExpo, easingsNetInOutQuad, easingsNetInOutQuint, easingsNetInOutSine, easingsNetInQuad, easingsNetInQuart, easingsNetInQuint, easingsNetInSine, easingsNetOutBack, easingsNetOutCirc, easingsNetOutCubic, easingsNetOutExpo, easingsNetOutQuad, easingsNetOutQuint, easingsNetOutSine, linear, materialAccelerated, materialDecelerated, materialStandard, toD, toFlattenedD, toMessageListenParams, verouEase, verouEaseIn, verouEaseInOut, verouEaseOut };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@baleada/logic",
-  "version": "0.22.5",
+  "version": "0.22.6",
   "description": "UI logic for the Baleada toolkit",
   "main": "lib/index.cjs",
   "module": "lib/index.js",
@@ -41,9 +41,9 @@
   "bugs": {
     "url": "https://github.com/baleada/logic/issues"
   },
-  "homepage": "https://baleada.netlify.com",
+  "homepage": "https://baleada.dev",
   "devDependencies": {
-    "@baleada/prepare": "^0.5.29",
+    "@baleada/prepare": "^0.5.30",
     "@types/node": "^14.14.41",
     "@vitejs/plugin-vue": "^3.2.0",
     "esbuild": "^0.15.13",
@@ -58,7 +58,7 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.20.6",
-    "@sindresorhus/slugify": "^2.1.1",
+    "@sindresorhus/slugify": "^2.2.0",
     "@snigo.dev/color": "^0.0.6",
     "@types/dompurify": "^2.4.0",
     "@types/requestidlecallback": "^0.3.5",