@sprucelabs/heartwood-view-controllers 119.0.2 → 119.1.0

package/build/esm/tests/MockAudioController.d.ts

@@ -0,0 +1,19 @@
+import { AudioController } from '../types/heartwood.types';
+export default class MockAudioController implements AudioController {
+    private status;
+    private volume;
+    private sourceUrl?;
+    constructor();
+    setVolume(volume: number): void;
+    getVolume(): Promise<number>;
+    assertVolumeSetTo(expected: number): void;
+    setSourceUrl(url: string): void;
+    assertSourceUrlSetTo(expected: string): void;
+    play(): void;
+    assertIsPlaying(): void;
+    assertIsNotPlaying(): void;
+    pause(): void;
+    assertIsPaused(): void;
+    assertIsStopped(): void;
+    stop(): void;
+}

package/build/esm/tests/MockAudioController.js

@@ -0,0 +1,56 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { assert } from '@sprucelabs/test-utils';
+export default class MockAudioController {
+    constructor() {
+        this.status = 'pending';
+        this.volume = 0;
+    }
+    setVolume(volume) {
+        this.volume = volume;
+    }
+    getVolume() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.volume;
+        });
+    }
+    assertVolumeSetTo(expected) {
+        assert.isEqual(this.volume, expected, `Volume was not set to expected. Try audio.setVolume(${expected})`);
+    }
+    setSourceUrl(url) {
+        this.sourceUrl = url;
+    }
+    assertSourceUrlSetTo(expected) {
+        assert.isEqual(this.sourceUrl, expected, `Source URL was not set to expected. Try audio.setSourceUrl('${expected}')`);
+    }
+    play() {
+        this.status = 'playing';
+    }
+    assertIsPlaying() {
+        assert.isEqual(this.status, 'playing', `Audio is not playing when it should be. Try audio.play()`);
+    }
+    assertIsNotPlaying() {
+        assert.isNotEqual(this.status, 'playing', `Audio is playing when it should not be. Try audio.stop() or audio.pause() or don't start it at all.`);
+    }
+    pause() {
+        assert.isEqual(this.status, 'playing', `Audio is not playing so you can't pause.`);
+        this.status = 'paused';
+    }
+    assertIsPaused() {
+        assert.isEqual(this.status, 'paused', `Audio is not paused when it should be. Try audio.pause()`);
+    }
+    assertIsStopped() {
+        assert.isEqual(this.status, 'stopped', `Audio was not stopped. Try audio.stope()`);
+    }
+    stop() {
+        assert.isEqual(this.status, 'playing', "Audio is not playing so you can't stop it.");
+        this.status = 'stopped';
+    }
+}

package/build/esm/tests/SpyDevice.d.ts

@@ -1,4 +1,5 @@
 import { CachedValue, Device, TheaterSettingValueTypes, TheatreSettingName } from '../types/heartwood.types';
+import MockAudioController from './MockAudioController';
 export default class SpyDevice implements Device {
     lastCommand?: string;
     vibrateCount: number;
@@ -20,6 +21,7 @@ export default class SpyDevice implements Device {
     turnTorchOn(brightness?: number): void;
     getTorchBrightness(): number;
     turnTorchOff(): void;
+    AudioController(): MockAudioController;
 }
 interface TrackedCommand {
     command: string;

package/build/esm/tests/SpyDevice.js

@@ -8,6 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { SchemaError } from '@sprucelabs/schema';
+import MockAudioController from './MockAudioController.js';
 export default class SpyDevice {
     constructor() {
         this.vibrateCount = 0;
@@ -61,4 +62,7 @@ export default class SpyDevice {
     turnTorchOff() {
         this.brightness = 0;
     }
+    AudioController() {
+        return new MockAudioController();
+    }
 }

package/build/esm/types/heartwood.types.d.ts

@@ -537,12 +537,13 @@ export type TimezoneName = ITimezoneName;
  */
 export type Locale = ILocale;
 export type CachedValue = string | number | Record<string, any> | boolean | null;
-export type TheatreSettingName = 'kiosk-mode' | 'load-url' | 'log-destination';
 export interface TheaterSettingValueTypes {
     'kiosk-mode': boolean | null;
     'load-url': string | null;
     'log-destination': string | null;
+    'audio-volume': number | null;
 }
+export type TheatreSettingName = keyof TheaterSettingValueTypes;
 export interface Device {
     openUrl(url: string): void;
     vibrate(): void;
@@ -554,6 +555,15 @@ export interface Device {
     turnTorchOff(): void;
     setTheatreSetting<N extends TheatreSettingName>(name: N, value: TheaterSettingValueTypes[N]): void;
     getTheatreSetting<N extends TheatreSettingName>(name: N): Promise<TheaterSettingValueTypes[N] | null>;
+    AudioController(): AudioController;
+}
+export interface AudioController {
+    play(): void;
+    pause(): void;
+    stop(): void;
+    setVolume(volume: number): void;
+    getVolume(): Promise<number | null>;
+    setSourceUrl(url: string): void;
 }
 export interface AuthorizerCanOptions<ContractId extends PermissionContractId, Ids extends PermissionId<ContractId> = PermissionId<ContractId>> {
     contractId: ContractId;

package/build/tests/MockAudioController.d.ts

@@ -0,0 +1,19 @@
+import { AudioController } from '../types/heartwood.types';
+export default class MockAudioController implements AudioController {
+    private status;
+    private volume;
+    private sourceUrl?;
+    constructor();
+    setVolume(volume: number): void;
+    getVolume(): Promise<number>;
+    assertVolumeSetTo(expected: number): void;
+    setSourceUrl(url: string): void;
+    assertSourceUrlSetTo(expected: string): void;
+    play(): void;
+    assertIsPlaying(): void;
+    assertIsNotPlaying(): void;
+    pause(): void;
+    assertIsPaused(): void;
+    assertIsStopped(): void;
+    stop(): void;
+}

package/build/tests/MockAudioController.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const test_utils_1 = require("@sprucelabs/test-utils");
+class MockAudioController {
+    constructor() {
+        this.status = 'pending';
+        this.volume = 0;
+    }
+    setVolume(volume) {
+        this.volume = volume;
+    }
+    async getVolume() {
+        return this.volume;
+    }
+    assertVolumeSetTo(expected) {
+        test_utils_1.assert.isEqual(this.volume, expected, `Volume was not set to expected. Try audio.setVolume(${expected})`);
+    }
+    setSourceUrl(url) {
+        this.sourceUrl = url;
+    }
+    assertSourceUrlSetTo(expected) {
+        test_utils_1.assert.isEqual(this.sourceUrl, expected, `Source URL was not set to expected. Try audio.setSourceUrl('${expected}')`);
+    }
+    play() {
+        this.status = 'playing';
+    }
+    assertIsPlaying() {
+        test_utils_1.assert.isEqual(this.status, 'playing', `Audio is not playing when it should be. Try audio.play()`);
+    }
+    assertIsNotPlaying() {
+        test_utils_1.assert.isNotEqual(this.status, 'playing', `Audio is playing when it should not be. Try audio.stop() or audio.pause() or don't start it at all.`);
+    }
+    pause() {
+        test_utils_1.assert.isEqual(this.status, 'playing', `Audio is not playing so you can't pause.`);
+        this.status = 'paused';
+    }
+    assertIsPaused() {
+        test_utils_1.assert.isEqual(this.status, 'paused', `Audio is not paused when it should be. Try audio.pause()`);
+    }
+    assertIsStopped() {
+        test_utils_1.assert.isEqual(this.status, 'stopped', `Audio was not stopped. Try audio.stope()`);
+    }
+    stop() {
+        test_utils_1.assert.isEqual(this.status, 'playing', "Audio is not playing so you can't stop it.");
+        this.status = 'stopped';
+    }
+}
+exports.default = MockAudioController;

package/build/tests/SpyDevice.d.ts

@@ -1,4 +1,5 @@
 import { CachedValue, Device, TheaterSettingValueTypes, TheatreSettingName } from '../types/heartwood.types';
+import MockAudioController from './MockAudioController';
 export default class SpyDevice implements Device {
     lastCommand?: string;
     vibrateCount: number;
@@ -20,6 +21,7 @@ export default class SpyDevice implements Device {
     turnTorchOn(brightness?: number): void;
     getTorchBrightness(): number;
     turnTorchOff(): void;
+    AudioController(): MockAudioController;
 }
 interface TrackedCommand {
     command: string;

package/build/tests/SpyDevice.js

@@ -1,6 +1,10 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 const schema_1 = require("@sprucelabs/schema");
+const MockAudioController_1 = __importDefault(require("./MockAudioController"));
 class SpyDevice {
     constructor() {
         this.vibrateCount = 0;
@@ -52,5 +56,8 @@ class SpyDevice {
     turnTorchOff() {
         this.brightness = 0;
     }
+    AudioController() {
+        return new MockAudioController_1.default();
+    }
 }
 exports.default = SpyDevice;

package/build/types/heartwood.types.d.ts

@@ -537,12 +537,13 @@ export type TimezoneName = ITimezoneName;
  */
 export type Locale = ILocale;
 export type CachedValue = string | number | Record<string, any> | boolean | null;
-export type TheatreSettingName = 'kiosk-mode' | 'load-url' | 'log-destination';
 export interface TheaterSettingValueTypes {
     'kiosk-mode': boolean | null;
     'load-url': string | null;
     'log-destination': string | null;
+    'audio-volume': number | null;
 }
+export type TheatreSettingName = keyof TheaterSettingValueTypes;
 export interface Device {
     openUrl(url: string): void;
     vibrate(): void;
@@ -554,6 +555,15 @@ export interface Device {
     turnTorchOff(): void;
     setTheatreSetting<N extends TheatreSettingName>(name: N, value: TheaterSettingValueTypes[N]): void;
     getTheatreSetting<N extends TheatreSettingName>(name: N): Promise<TheaterSettingValueTypes[N] | null>;
+    AudioController(): AudioController;
+}
+export interface AudioController {
+    play(): void;
+    pause(): void;
+    stop(): void;
+    setVolume(volume: number): void;
+    getVolume(): Promise<number | null>;
+    setSourceUrl(url: string): void;
 }
 export interface AuthorizerCanOptions<ContractId extends PermissionContractId, Ids extends PermissionId<ContractId> = PermissionId<ContractId>> {
     contractId: ContractId;

package/package.json

@@ -13,7 +13,7 @@
   "sideEffects": false,
   "license": "MIT",
   "description": "All the power of Heartwood in one, convenient package.",
-  "version": "119.0.2",
+  "version": "119.1.0",
   "skill": {
     "namespace": "HeartwoodViewControllers",
     "commandOverrides": {