@m2c2kit/addons 0.3.27 → 0.3.29

package/LICENSE

@@ -1,21 +1,13 @@
-MIT License
+Copyright 2023 Scott T. Yabiku
 
-Copyright (c) 2023 Scott T. Yabiku
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+    http://www.apache.org/licenses/LICENSE-2.0
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -1,6 +1,6 @@
 # @m2c2kit/addons
 
-[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![License: Apache-2.0](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://opensource.org/license/apache-2-0)
 [![CI/CD](https://github.com/m2c2-project/m2c2kit/actions/workflows/ci.yml/badge.svg)](https://github.com/m2c2-project/m2c2kit/actions/workflows/ci.yml)
 [![npm version](https://img.shields.io/npm/v/@m2c2kit/addons.svg)](https://www.npmjs.com/package/@m2c2kit/addons)
 

package/dist/index.d.ts

@@ -1366,4 +1366,5 @@ declare class Slider extends Composite implements SliderOptions {
     warmup(canvas: Canvas): void;
 }
 
-export { Button, type ButtonOptions, CountdownScene, type CountdownSceneOptions, CountdownTimer, type CountdownTimerEvent, type CountdownTimerOptions, Dialog, type DialogEvent, type DialogOptions, DialogResult, DrawPad, type DrawPadEvent, DrawPadEventType, type DrawPadItem, type DrawPadItemEvent, DrawPadItemEventType, type DrawPadOptions, type DrawPadStroke, Grid, type GridChild, type GridOptions, type InstructionScene, Instructions, type InstructionsOptions, type KeyConfiguration, type KeyTapMetadata, type LocaleOption, LocalePicker, type LocalePickerEvent, type LocalePickerIcon, type LocalePickerOptions, type LocalePickerResult, Slider, type SliderEvent, type SliderOptions, type StrokeInteraction, type TimerShape, VirtualKeyboard, type VirtualKeyboardEvent, type VirtualKeyboardOptions, type VirtualKeyboardRow };
+export { Button, CountdownScene, CountdownTimer, Dialog, DialogResult, DrawPad, DrawPadEventType, DrawPadItemEventType, Grid, Instructions, LocalePicker, Slider, VirtualKeyboard };
+export type { ButtonOptions, CountdownSceneOptions, CountdownTimerEvent, CountdownTimerOptions, DialogEvent, DialogOptions, DrawPadEvent, DrawPadItem, DrawPadItemEvent, DrawPadOptions, DrawPadStroke, GridChild, GridOptions, InstructionScene, InstructionsOptions, KeyConfiguration, KeyTapMetadata, LocaleOption, LocalePickerEvent, LocalePickerIcon, LocalePickerOptions, LocalePickerResult, SliderEvent, SliderOptions, StrokeInteraction, TimerShape, VirtualKeyboardEvent, VirtualKeyboardOptions, VirtualKeyboardRow };

package/dist/index.js

@@ -1,4 +1,4 @@
-import { M2c2KitHelpers, Composite, WebColors, Shape, EventStoreMode, Equal, Label, CanvasKitHelpers, M2EventType, Timer, MutablePath, Easings, Story, Transition, TransitionDirection, LabelHorizontalAlignmentMode, Scene, Dimensions, Sprite, Action } from '@m2c2kit/core';
+import { M2c2KitHelpers, Composite, WebColors, M2Error, Shape, EventStoreMode, Equal, Label, CanvasKitHelpers, M2EventType, Timer, MutablePath, Easings, Story, Transition, TransitionDirection, LabelHorizontalAlignmentMode, Scene, Dimensions, Sprite, Action } from '@m2c2kit/core';
 
 class Grid extends Composite {
   /**
@@ -26,25 +26,25 @@ class Grid extends Composite {
     if (options.size) {
       this.size = options.size;
     } else {
-      throw new Error("grid size must be specified");
+      throw new M2Error("grid size must be specified");
     }
     if (options.rows) {
       if (options.rows >= 1) {
         this.rows = options.rows;
       } else {
-        throw new Error("grid rows must be at least 1");
+        throw new M2Error("grid rows must be at least 1");
       }
     } else {
-      throw new Error("grid rows must be specified");
+      throw new M2Error("grid rows must be specified");
     }
     if (options.columns) {
       if (options.columns >= 1) {
         this.columns = options.columns;
       } else {
-        throw new Error("grid columns must be at least 1");
+        throw new M2Error("grid columns must be at least 1");
       }
     } else {
-      throw new Error("grid columns must be specified");
+      throw new M2Error("grid columns must be specified");
     }
     if (options.backgroundColor) {
       this.gridBackgroundColor = options.backgroundColor;
@@ -138,7 +138,7 @@ class Grid extends Composite {
     if (this.gridChildren.length > 0) {
       this.gridChildren.forEach((gridChild) => {
         if (!this.cellWidth || !this.cellHeight || !this.gridBackground) {
-          throw new Error(
+          throw new M2Error(
             "cellWidth, cellHeight, or gridBackground undefined or null"
           );
         }
@@ -153,7 +153,7 @@ class Grid extends Composite {
             )
           );
           if (!childNode) {
-            throw new Error("grid: child node not found");
+            throw new M2Error("grid: child node not found");
           }
           childNode?.parent?.removeChild(childNode);
           this.cellContainers[gridChild.row][gridChild.column].addChild(
@@ -171,7 +171,7 @@ class Grid extends Composite {
   }
   get gridBackground() {
     if (!this._gridBackground) {
-      throw new Error("gridBackground is null or undefined");
+      throw new M2Error("gridBackground is null or undefined");
     }
     return this._gridBackground;
   }
@@ -853,7 +853,7 @@ class Dialog extends Composite {
    * provided, name will be the new uuid
    */
   duplicate(newName) {
-    throw new Error(`duplicate not implemented. ${newName}`);
+    throw new M2Error(`duplicate not implemented. ${newName}`);
   }
   update() {
     super.update();
@@ -909,7 +909,7 @@ class DrawPad extends Composite {
       this.isUserInteractionEnabled = true;
     }
     if (!options.size) {
-      throw new Error("DrawPad size must be specified");
+      throw new M2Error("DrawPad size must be specified");
     }
     this.size = options.size;
     if (options.lineColor) {
@@ -994,7 +994,7 @@ class DrawPad extends Composite {
   handleTapDown(e) {
     if (this.isUserInteractionEnabled) {
       if (!this.drawShape?.path) {
-        throw new Error("DrawPad.handleTapDown(): no drawShape.path");
+        throw new M2Error("DrawPad.handleTapDown(): no drawShape.path");
       }
       const path = this.drawShape.path;
       if (this.continuousDrawingOnly && path.subpaths.length !== 0) {
@@ -1036,7 +1036,9 @@ class DrawPad extends Composite {
       this.size
     );
     if (!this.drawShape?.path) {
-      throw new Error("DrawPad.addInterpolatedStrokeMove(): no drawShape.path");
+      throw new M2Error(
+        "DrawPad.addInterpolatedStrokeMove(): no drawShape.path"
+      );
     }
     const path = this.drawShape.path;
     path.addLine(interpolatedPoint);
@@ -1119,7 +1121,7 @@ class DrawPad extends Composite {
   handlePointerMove(e) {
     if (this.isUserInteractionEnabled && this.isDrawingPointerDown) {
       if (!this.drawShape?.path) {
-        throw new Error("DrawPad.handlePointerMove(): no drawShape.path");
+        throw new M2Error("DrawPad.handlePointerMove(): no drawShape.path");
       }
       const path = this.drawShape.path;
       if (this.isDrawingPointerDown && !this.pointerIsDownAndPointerLeftDrawAreaWhenDown) {
@@ -1171,7 +1173,7 @@ class DrawPad extends Composite {
    */
   clear() {
     if (!this.drawShape?.path) {
-      throw new Error("DrawPad.clear(): no drawShape.path");
+      throw new M2Error("DrawPad.clear(): no drawShape.path");
     }
     const path = this.drawShape.path;
     path.clear();
@@ -1349,7 +1351,7 @@ class DrawPad extends Composite {
   takeScreenshot() {
     const drawArea = this.drawArea;
     if (!drawArea) {
-      throw new Error("DrawPad.takeScreenshot(): no drawArea");
+      throw new M2Error("DrawPad.takeScreenshot(): no drawArea");
     }
     const sx = (drawArea.absolutePosition.x - drawArea.size.width / 2) * m2c2Globals.canvasScale;
     const sy = (drawArea.absolutePosition.y - drawArea.size.height / 2) * m2c2Globals.canvasScale;
@@ -1370,11 +1372,11 @@ class DrawPad extends Composite {
       pixelData.length / sh
     );
     if (!croppedImage) {
-      throw new Error("DrawPad.takeScreenshot(): no croppedImage");
+      throw new M2Error("DrawPad.takeScreenshot(): no croppedImage");
     }
     const bytes = croppedImage.encodeToBytes();
     if (!bytes) {
-      throw new Error(
+      throw new M2Error(
         "DrawPad.takeScreenshot(): croppedImage.encodeToBytes() failed"
       );
     }
@@ -1493,7 +1495,9 @@ class DrawPad extends Composite {
     this.needsInitialization = true;
   }
   duplicate(newName) {
-    throw new Error(`DrawPad.duplicate(): Method not implemented. ${newName}`);
+    throw new M2Error(
+      `DrawPad.duplicate(): Method not implemented. ${newName}`
+    );
   }
 }
 M2c2KitHelpers.registerM2NodeClass(DrawPad);
@@ -1741,7 +1745,7 @@ class VirtualKeyboard extends Composite {
     });
   }
   duplicate(newName) {
-    throw new Error(`Method not implemented. ${newName}`);
+    throw new M2Error(`Method not implemented. ${newName}`);
   }
   handleKeyShapeTapDown(key, keyShape, tapEvent) {
     if (key.isShift) {
@@ -1899,7 +1903,7 @@ class VirtualKeyboard extends Composite {
     );
     const keyShape = this.keyShapes.find((k) => k.userData.code === event.code);
     if (!keyShape) {
-      throw new Error("keyShape is not defined");
+      throw new M2Error("keyShape is not defined");
     }
     this.shiftActivated = event.shiftKey;
     switch (event.compositeEventType) {
@@ -1916,7 +1920,7 @@ class VirtualKeyboard extends Composite {
         break;
       }
       default: {
-        throw new Error(
+        throw new M2Error(
           `Unknown VirtualKeyboardEvent: ${event.compositeEventType}`
         );
       }
@@ -1935,13 +1939,13 @@ class VirtualKeyboard extends Composite {
       keyShape.fillColor = this.keyDownColor;
       if (this.showKeyDownPreview) {
         if (!this.letterCircle || !this.letterCircleLabel) {
-          throw new Error("letterCircle is not defined");
+          throw new M2Error("letterCircle is not defined");
         }
         this.letterCircle.hidden = false;
         const keyBox = keyShape.parent;
         this.letterCircle.position.x = keyBox.position.x;
         if (keyShape.rect?.size?.height === void 0) {
-          throw new Error("keyShape.rect.height is undefined");
+          throw new M2Error("keyShape.rect.height is undefined");
         }
         this.letterCircle.position.y = keyBox.position.y - keyShape.rect.size.height * 1.2;
         const keyboard2 = this.internalKeyboardRowsToInternalKeyboardConfiguration(
@@ -1949,7 +1953,7 @@ class VirtualKeyboard extends Composite {
         );
         const key = keyboard2.flat().find((k) => k.code === event.code);
         if (!key) {
-          throw new Error("key is not defined");
+          throw new M2Error("key is not defined");
         }
         if (this.shiftActivated) {
           this.letterCircleLabel.text = key.labelTextShifted ?? key.code;
@@ -1970,7 +1974,7 @@ class VirtualKeyboard extends Composite {
     }
     keyShape.fillColor = this.keyColor;
     if (!this.letterCircle) {
-      throw new Error("letterCircle is not defined");
+      throw new M2Error("letterCircle is not defined");
     }
     this.letterCircle.hidden = true;
     if (!event.code.toLowerCase().includes("shift") && event.shiftKey) {
@@ -1991,7 +1995,7 @@ class VirtualKeyboard extends Composite {
     }
     keyShape.fillColor = this.keyColor;
     if (!this.letterCircle) {
-      throw new Error("letterCircle is not defined");
+      throw new M2Error("letterCircle is not defined");
     }
     this.letterCircle.hidden = true;
   }
@@ -2011,7 +2015,7 @@ class VirtualKeyboard extends Composite {
     keyboard.flatMap((k) => k).forEach((k) => {
       const keyLabel = this.keyLabels.find((l) => l.userData.code === k.code);
       if (!keyLabel) {
-        throw new Error("keyLabel is not defined");
+        throw new M2Error("keyLabel is not defined");
       }
       if (keyLabel.text !== void 0) {
         keyLabel.text = k.labelTextShifted ?? "";
@@ -2034,7 +2038,7 @@ class VirtualKeyboard extends Composite {
     keyboard.flatMap((k) => k).forEach((k) => {
       const keyLabel = this.keyLabels.find((l) => l.userData.code === k.code);
       if (!keyLabel) {
-        throw new Error("keyLabel is not defined");
+        throw new M2Error("keyLabel is not defined");
       }
       if (keyLabel.text !== void 0) {
         keyLabel.text = k.labelText ?? "";
@@ -2389,7 +2393,7 @@ class CountdownScene extends Scene {
   constructor(options) {
     super(options);
     if (options?.transitionDurationMilliseconds !== void 0 && options?.transition) {
-      throw new Error(
+      throw new M2Error(
         "Both transition and transitionDurationMilliseconds options were provided. Only one should be provided. If using a custom transition, then the duration of that transition must be specified within the custom transition."
       );
     }
@@ -2429,7 +2433,7 @@ class CountdownScene extends Scene {
       });
       this.addChild(timerShape);
     } else {
-      throw new Error("Invalid timer shape options.");
+      throw new M2Error("Invalid timer shape options.");
     }
     const timerInitialNumber = Math.floor(options.milliseconds / 1e3);
     const timerNumberLabel = new Label({
@@ -2628,7 +2632,7 @@ class LocalePicker extends Composite {
       });
     }
     if (this.localeOptions.length === 0) {
-      throw new Error("No locales available for LocalePicker");
+      throw new M2Error("No locales available for LocalePicker");
     }
     this.children.filter((child) => child.name !== "localePickerIcon").forEach((child) => this.removeChild(child));
     this.game.imageManager.loadImages([
@@ -3037,7 +3041,7 @@ class LocalePicker extends Composite {
    * provided, name will be the new uuid
    */
   duplicate(newName) {
-    throw new Error(`duplicate not implemented. ${newName}`);
+    throw new M2Error(`duplicate not implemented. ${newName}`);
   }
 }
 
@@ -3123,11 +3127,11 @@ class CountdownTimer extends Composite {
       });
       this.addChild(this.timerShapeNode);
     } else {
-      throw new Error("Invalid timer shape options.");
+      throw new M2Error("Invalid timer shape options.");
     }
     this.size = this.timerShapeNode.size;
     if (this.milliseconds % 1e3 !== 0) {
-      throw new Error(
+      throw new M2Error(
         "CountdownTimer milliseconds must be a multiple of 1000."
       );
     }
@@ -3220,10 +3224,10 @@ class CountdownTimer extends Composite {
    */
   start() {
     if (this.isRunning) {
-      throw new Error("CountdownTimer: cannot start. It is already running.");
+      throw new M2Error("CountdownTimer: cannot start. It is already running.");
     }
     if (this.hasStopped) {
-      throw new Error(
+      throw new M2Error(
         "CountdownTimer: It has stopped. You cannot start a stopped CountdownTimer. Instead, create a new CountdownTimer or call CountdownTimer.reset() before starting."
       );
     }
@@ -3269,7 +3273,7 @@ class CountdownTimer extends Composite {
   }
   handleCompositeEvent(event) {
     if (!this.timerNumberLabel) {
-      throw new Error("Timer number label not found.");
+      throw new M2Error("Timer number label not found.");
     }
     switch (event.compositeEventType) {
       case "CountdownTimerTick": {
@@ -3283,7 +3287,7 @@ class CountdownTimer extends Composite {
         break;
       }
       default:
-        throw new Error(
+        throw new M2Error(
           `Invalid TimerCountdown event type: ${event.compositeEventType}`
         );
     }
@@ -3434,7 +3438,7 @@ class CountdownTimer extends Composite {
    * provided, name will be the new uuid
    */
   duplicate(newName) {
-    throw new Error(`Method not implemented. ${newName}`);
+    throw new M2Error(`Method not implemented. ${newName}`);
   }
   update() {
     super.update();
@@ -3497,7 +3501,7 @@ class Slider extends Composite {
   }
   get thumbShape() {
     if (this._thumbShape === void 0) {
-      throw new Error("thumbShape is not defined.");
+      throw new M2Error("thumbShape is not defined.");
     }
     return this._thumbShape;
   }
@@ -3729,7 +3733,7 @@ class Slider extends Composite {
    * provided, name will be the new uuid
    */
   duplicate(newName) {
-    throw new Error(`Method not implemented. ${newName}`);
+    throw new M2Error(`Method not implemented. ${newName}`);
   }
   update() {
     super.update();
@@ -3745,7 +3749,7 @@ class Slider extends Composite {
   }
 }
 
-console.log("\u26AA @m2c2kit/addons version 0.3.27 (622f7241)");
+console.log("\u26AA @m2c2kit/addons version 0.3.29 (9f27c146)");
 
 export { Button, CountdownScene, CountdownTimer, Dialog, DialogResult, DrawPad, DrawPadEventType, DrawPadItemEventType, Grid, Instructions, LocalePicker, Slider, VirtualKeyboard };
 //# sourceMappingURL=index.js.map