@clockworkdog/cogs-client 0.3.1

package/dist/helpers/urls.d.ts

@@ -0,0 +1,3 @@
+export declare const COGS_SERVER_PORT = 12095;
+export declare function assetUrl(file: string): string;
+export declare function preloadUrl(url: string): Promise<string>;

package/dist/helpers/urls.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.preloadUrl = exports.assetUrl = exports.COGS_SERVER_PORT = void 0;
+exports.COGS_SERVER_PORT = 12095;
+function assetUrl(file) {
+    const location = typeof window !== 'undefined' ? window.location : undefined;
+    return `${location === null || location === void 0 ? void 0 : location.protocol}//${location === null || location === void 0 ? void 0 : location.hostname}:${exports.COGS_SERVER_PORT}/assets/${encodeURIComponent(file)}`;
+}
+exports.assetUrl = assetUrl;
+function preloadUrl(url) {
+    return new Promise((resolve, reject) => {
+        const req = new XMLHttpRequest();
+        req.open('GET', url, true);
+        req.responseType = 'blob';
+        req.onload = function () {
+            if (req.status === 200) {
+                const blob = this.response;
+                const objectURL = URL.createObjectURL(blob);
+                resolve(objectURL);
+            }
+            else {
+                reject(Error(`Failed to preload ${url}. Error code: ${req.status}`));
+            }
+        };
+        req.onerror = (error) => {
+            reject(Error(`Failed to preload ${url}:  ${error}`));
+        };
+        req.send();
+    });
+}
+exports.preloadUrl = preloadUrl;

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+export { default as CogsConnection } from './CogsConnection';
+export { default as CogsClientMessage } from './types/CogsClientMessage';
+export { default as MediaClipStateMessage } from './types/MediaClipStateMessage';
+export * from './types/valueTypes';
+export { default as MediaObjectFit } from './types/MediaObjectFit';
+export { default as CogsAudioPlayer } from './AudioPlayer';
+export { default as CogsVideoPlayer } from './VideoPlayer';
+export * from './types/AudioState';
+export { assetUrl } from './helpers/urls';
+export { preloadUrl } from './helpers/urls';

package/dist/index.js

@@ -0,0 +1,28 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.preloadUrl = exports.assetUrl = exports.CogsVideoPlayer = exports.CogsAudioPlayer = exports.CogsConnection = void 0;
+var CogsConnection_1 = require("./CogsConnection");
+Object.defineProperty(exports, "CogsConnection", { enumerable: true, get: function () { return __importDefault(CogsConnection_1).default; } });
+__exportStar(require("./types/valueTypes"), exports);
+var AudioPlayer_1 = require("./AudioPlayer");
+Object.defineProperty(exports, "CogsAudioPlayer", { enumerable: true, get: function () { return __importDefault(AudioPlayer_1).default; } });
+var VideoPlayer_1 = require("./VideoPlayer");
+Object.defineProperty(exports, "CogsVideoPlayer", { enumerable: true, get: function () { return __importDefault(VideoPlayer_1).default; } });
+__exportStar(require("./types/AudioState"), exports);
+var urls_1 = require("./helpers/urls");
+Object.defineProperty(exports, "assetUrl", { enumerable: true, get: function () { return urls_1.assetUrl; } });
+var urls_2 = require("./helpers/urls");
+Object.defineProperty(exports, "preloadUrl", { enumerable: true, get: function () { return urls_2.preloadUrl; } });

package/dist/types/AllMediaClipStatesMessage.d.ts

@@ -0,0 +1,5 @@
+export declare type MediaStatus = 'playing' | 'paused' | 'stopped';
+export default interface AllMediaClipStatesMessage {
+    mediaType: 'audio' | 'video';
+    files: [string, MediaStatus][];
+}

package/dist/types/AllMediaClipStatesMessage.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/AudioState.d.ts

@@ -0,0 +1,39 @@
+export declare type ActiveAudioClipState = {
+    type: 'paused';
+} | {
+    type: 'pause_requested';
+    fade: number | undefined;
+} | {
+    type: 'pausing';
+} | {
+    type: 'playing';
+} | {
+    type: 'play_requested';
+} | {
+    type: 'stopping';
+} | {
+    type: 'stop_requested';
+    fade: number | undefined;
+};
+export interface AudioClip {
+    config: {
+        preload: boolean;
+        ephemeral: boolean;
+    };
+    activeClips: {
+        [soundId: number]: ActiveClip;
+    };
+}
+export interface ActiveClip {
+    state: ActiveAudioClipState;
+    loop: boolean;
+    volume: number;
+    playId: string;
+}
+export interface AudioState {
+    isPlaying: boolean;
+    globalVolume: number;
+    clips: {
+        [path: string]: AudioClip;
+    };
+}

package/dist/types/AudioState.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/CogsClientMessage.d.ts

@@ -0,0 +1,85 @@
+import MediaObjectFit from './MediaObjectFit';
+import { ShowPhase } from './valueTypes';
+interface ShowResetMessage {
+    type: 'show_reset';
+}
+interface ShowPhaseMessage {
+    type: 'show_phase';
+    phase: ShowPhase;
+}
+interface AdjustableTimerUpdateMessage {
+    type: 'adjustable_timer_update';
+    ticking: boolean;
+    durationMillis: number;
+}
+interface TextHintsUpdateMessage {
+    type: 'text_hints_update';
+    lastSentHint: string;
+}
+export declare type Media = {
+    type: 'audio';
+    preload: boolean;
+} | {
+    type: 'video';
+    preload: boolean | 'auto' | 'metadata' | 'none';
+};
+interface MediaClientConfigMessage {
+    type: 'media_config_update';
+    globalVolume: number;
+    audioOutput?: string;
+    files: {
+        [path: string]: Media;
+    };
+}
+declare type MediaClientMessage = {
+    type: 'audio_play';
+    playId: string;
+    file: string;
+    fade?: number;
+    loop?: true;
+    volume: number;
+} | {
+    type: 'audio_pause';
+    file: string;
+    fade?: number;
+} | {
+    type: 'audio_stop';
+    file?: string;
+    fade?: number;
+} | {
+    type: 'audio_set_clip_volume';
+    file: string;
+    volume: number;
+    fade?: number;
+} | {
+    type: 'video_play';
+    playId: string;
+    file: string;
+    loop?: true;
+    volume: number;
+    fit: MediaObjectFit;
+} | {
+    type: 'video_pause';
+} | {
+    type: 'video_stop';
+} | {
+    type: 'video_set_volume';
+    volume: number;
+} | {
+    type: 'video_set_fit';
+    fit: MediaObjectFit;
+} | {
+    type: 'image_show';
+    file: string;
+    fit: MediaObjectFit;
+    hideOthers?: boolean;
+} | {
+    type: 'image_hide';
+    file?: string;
+} | {
+    type: 'image_set_fit';
+    file: string;
+    fit: MediaObjectFit;
+};
+export declare type CogsClientMessage<CustomConfig = {}> = ShowResetMessage | ShowPhaseMessage | AdjustableTimerUpdateMessage | TextHintsUpdateMessage | (MediaClientConfigMessage & CustomConfig) | MediaClientMessage;
+export default CogsClientMessage;

package/dist/types/CogsClientMessage.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/MediaClipStateMessage.d.ts

@@ -0,0 +1,7 @@
+export declare type MediaStatus = 'playing' | 'paused' | 'stopped';
+export default interface MediaClipStateMessage {
+    playId: string;
+    mediaType: 'audio' | 'video';
+    file: string;
+    status: MediaStatus;
+}

package/dist/types/MediaClipStateMessage.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/MediaObjectFit.d.ts

@@ -0,0 +1,2 @@
+export declare type MediaObjectFit = 'contain' | 'cover' | 'none';
+export default MediaObjectFit;

package/dist/types/MediaObjectFit.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/VideoState.d.ts

@@ -0,0 +1,26 @@
+import { MediaObjectFit } from '..';
+export declare enum ActiveVideoClipState {
+    Paused = "paused",
+    Playing = "playing"
+}
+export interface VideoClip {
+    config: {
+        preload: 'auto' | 'metadata' | 'none';
+        ephemeral: boolean;
+        fit: MediaObjectFit;
+    };
+}
+export interface ActiveClip {
+    path: string;
+    state: ActiveVideoClipState;
+    loop: boolean;
+    volume: number;
+}
+export interface VideoState {
+    isPlaying: boolean;
+    globalVolume: number;
+    clips: {
+        [path: string]: VideoClip;
+    };
+    activeClip?: ActiveClip;
+}

package/dist/types/VideoState.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActiveVideoClipState = void 0;
+var ActiveVideoClipState;
+(function (ActiveVideoClipState) {
+    ActiveVideoClipState["Paused"] = "paused";
+    ActiveVideoClipState["Playing"] = "playing";
+})(ActiveVideoClipState = exports.ActiveVideoClipState || (exports.ActiveVideoClipState = {}));

package/dist/types/valueTypes.d.ts

@@ -0,0 +1,18 @@
+export declare type PortValue = string | number | boolean;
+export declare type ConfigValue = string | number | boolean;
+export declare type EventValue = string | number | boolean;
+export declare enum ShowPhase {
+    Setup = "setup",
+    Preshow = "pre-show",
+    InProgress = "in progress",
+    Finished = "finished"
+}
+export declare type EventKeyValue<TypeMap extends {
+    [key: string]: EventValue | null;
+}, Key extends keyof TypeMap = keyof TypeMap> = Key extends string ? TypeMap[Key] extends null ? {
+    key: Key;
+    value: undefined;
+} : {
+    key: Key;
+    value: TypeMap[Key];
+} : never;

package/dist/types/valueTypes.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ShowPhase = void 0;
+var ShowPhase;
+(function (ShowPhase) {
+    ShowPhase["Setup"] = "setup";
+    ShowPhase["Preshow"] = "pre-show";
+    ShowPhase["InProgress"] = "in progress";
+    ShowPhase["Finished"] = "finished";
+})(ShowPhase = exports.ShowPhase || (exports.ShowPhase = {}));

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@clockworkdog/cogs-client",
+  "version": "v0.3.1",
+  "main": "dist/index.js",
+  "unpkg": "dist/browser/index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "lint": "yarn lint:json && yarn lint:ts",
+    "lint:json": "prettier --list-different .eslintrc *.json",
+    "lint:ts": "eslint --ext .js,.ts --ignore-path .gitignore .",
+    "build": "tsc && browserify --debug --standalone COGS dist/index.js -o dist/browser/index.js",
+    "watch-build": "tsc -w",
+    "release": "yarn publish --access public"
+  },
+  "keywords": [],
+  "author": "Clockwork Dog <info@clockwork.dog>",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/howler": "2.2.7",
+    "@typescript-eslint/eslint-plugin": "^4.12.0",
+    "@typescript-eslint/parser": "^4.12.0",
+    "browserify": "^17.0.0",
+    "eslint": "^7.17.0",
+    "eslint-config-prettier": "^7.1.0",
+    "eslint-plugin-prettier": "^3.3.1",
+    "prettier": "^2.2.1",
+    "typescript": "^4.1.3"
+  },
+  "dependencies": {
+    "howler": "2.2.1",
+    "reconnecting-websocket": "^4.4.0"
+  },
+  "description": "Connect to COGS to build a custom Media Master",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/clockwork-dog/cogs-client-lib.git"
+  },
+  "bugs": {
+    "url": "https://github.com/clockwork-dog/cogs-client-lib/issues"
+  },
+  "homepage": "https://cogs.show",
+  "files": [
+    "dist/**/*"
+  ]
+}