@clockworkdog/cogs-client 2.11.1 → 3.0.0-alpha.0

package/dist/types/CogsClientMessage.d.ts

@@ -1,4 +1,5 @@
 import MediaObjectFit from './MediaObjectFit';
+import { MediaSurfaceState } from './MediaSchema';
 import ShowPhase from './ShowPhase';
 interface ShowResetMessage {
     type: 'show_reset';
@@ -46,7 +47,17 @@ export interface MediaClientConfig {
     preferOptimizedVideo?: boolean;
     preferOptimizedImages?: boolean;
 }
-type MediaClientMessage = {
+/**
+ * @deprecated Legacy media client events
+ *
+ * media_strategy: 'events' was added to this interface in @clockworkdog/cogs-client@2.12.0
+ *
+ * If the media_strategy property is missing, cogs-client can detect that it is connected to an
+ * older version of COGS that does not support state-based media client messages.
+ */
+type MediaEventClientMessage = {
+    media_strategy: 'events';
+} & ({
     type: 'audio_play';
     playId: string;
     file: string;
@@ -95,6 +106,13 @@ type MediaClientMessage = {
     type: 'image_set_fit';
     file: string;
     fit: MediaObjectFit;
+});
+type MediaStateClientMessage = {
+    media_strategy: 'state';
+} & {
+    type: 'media_state';
+    state: MediaSurfaceState;
 };
+type MediaClientMessage = MediaEventClientMessage | MediaStateClientMessage;
 export type CogsClientMessage<CustomConfig = {}> = ShowResetMessage | ShowPhaseMessage | AdjustableTimerUpdateMessage | TextHintsUpdateMessage | (MediaClientConfigMessage & CustomConfig) | CogsEnvironmentMessage | MediaClientMessage | DataStoreItemsClientMessage;
 export default CogsClientMessage;

package/dist/types/CogsClientMessage.js

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

package/dist/types/CogsPluginManifest.js

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

package/dist/types/ManifestTypes.js

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

package/dist/types/MediaClipStateMessage.js

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

package/dist/types/MediaObjectFit.js

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

package/dist/types/MediaSchema.d.ts

@@ -0,0 +1,199 @@
+import { z } from 'zod';
+export type TemporalProperties = z.infer<typeof TemporalProperties>;
+declare const TemporalProperties: z.ZodObject<{
+    t: z.ZodNumber;
+    rate: z.ZodNumber;
+}, z.core.$strip>;
+export type VisualProperties = z.infer<typeof VisualProperties>;
+declare const VisualProperties: z.ZodObject<{
+    opacity: z.ZodNumber;
+}, z.core.$strip>;
+export type AudialProperties = z.infer<typeof AudialProperties>;
+declare const AudialProperties: z.ZodObject<{
+    volume: z.ZodNumber;
+}, z.core.$strip>;
+export type ImageMetadata = z.infer<typeof ImageMetadata>;
+declare const ImageMetadata: z.ZodObject<{
+    type: z.ZodLiteral<"image">;
+    file: z.ZodString;
+    fit: z.ZodUnion<readonly [z.ZodLiteral<"contain">, z.ZodLiteral<"cover">, z.ZodLiteral<"none">]>;
+}, z.core.$strip>;
+export type AudioMetadata = z.infer<typeof AudioMetadata>;
+declare const AudioMetadata: z.ZodObject<{
+    type: z.ZodLiteral<"audio">;
+    file: z.ZodString;
+    audioOutput: z.ZodString;
+}, z.core.$strip>;
+export type VideoMetadata = z.infer<typeof VideoMetadata>;
+declare const VideoMetadata: z.ZodObject<{
+    type: z.ZodLiteral<"video">;
+    file: z.ZodString;
+    audioOutput: z.ZodString;
+    fit: z.ZodUnion<readonly [z.ZodLiteral<"contain">, z.ZodLiteral<"cover">, z.ZodLiteral<"none">]>;
+}, z.core.$strip>;
+export type NullKeyframe = z.infer<typeof NullKeyframe>;
+declare const NullKeyframe: z.ZodTuple<[z.ZodNumber, z.ZodNull], null>;
+/**
+ * Keyframes are indexed by a timestamp given in ms
+ */
+export type InitialImageKeyframe = z.infer<typeof InitialImageKeyframe>;
+declare const InitialImageKeyframe: z.ZodTuple<[z.ZodNumber, z.ZodObject<{
+    set: z.ZodOptional<z.ZodObject<{
+        opacity: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+}, z.core.$strip>], null>;
+/**
+ * Keyframes are indexed by a timestamp given in ms
+ */
+export type ImageKeyframe = z.infer<typeof ImageKeyframe>;
+declare const ImageKeyframe: z.ZodTuple<[z.ZodNumber, z.ZodObject<{
+    set: z.ZodOptional<z.ZodObject<{
+        opacity: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+    lerp: z.ZodOptional<z.ZodObject<{
+        opacity: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+}, z.core.$strip>], null>;
+/**
+ * Keyframes are indexed by a timestamp given in ms
+ */
+export type InitialAudioKeyframe = z.infer<typeof InitialAudioKeyframe>;
+declare const InitialAudioKeyframe: z.ZodTuple<[z.ZodNumber, z.ZodObject<{
+    set: z.ZodOptional<z.ZodObject<{
+        volume: z.ZodOptional<z.ZodNumber>;
+        t: z.ZodOptional<z.ZodNumber>;
+        rate: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+}, z.core.$strip>], null>;
+/**
+ * Keyframes are indexed by a timestamp given in ms
+ */
+export type AudioKeyframe = z.infer<typeof AudioKeyframe>;
+declare const AudioKeyframe: z.ZodTuple<[z.ZodNumber, z.ZodObject<{
+    set: z.ZodOptional<z.ZodObject<{
+        volume: z.ZodOptional<z.ZodNumber>;
+        t: z.ZodOptional<z.ZodNumber>;
+        rate: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+    lerp: z.ZodOptional<z.ZodObject<{
+        volume: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+}, z.core.$strip>], null>;
+/**
+ * Keyframes are indexed by a timestamp given in ms
+ */
+export type InitialVideoKeyframe = z.infer<typeof InitialVideoKeyframe>;
+declare const InitialVideoKeyframe: z.ZodTuple<[z.ZodNumber, z.ZodObject<{
+    set: z.ZodOptional<z.ZodObject<{
+        opacity: z.ZodOptional<z.ZodNumber>;
+        volume: z.ZodOptional<z.ZodNumber>;
+        t: z.ZodOptional<z.ZodNumber>;
+        rate: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+}, z.core.$strip>], null>;
+/**
+ * Keyframes are indexed by a timestamp given in ms
+ */
+export type VideoKeyframe = z.infer<typeof VideoKeyframe>;
+declare const VideoKeyframe: z.ZodTuple<[z.ZodNumber, z.ZodObject<{
+    set: z.ZodOptional<z.ZodObject<{
+        opacity: z.ZodOptional<z.ZodNumber>;
+        volume: z.ZodOptional<z.ZodNumber>;
+        t: z.ZodOptional<z.ZodNumber>;
+        rate: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+    lerp: z.ZodOptional<z.ZodObject<{
+        opacity: z.ZodOptional<z.ZodNumber>;
+        volume: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+}, z.core.$strip>], null>;
+export declare const MediaSurfaceStateSchema: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodObject<{
+    keyframes: z.ZodTuple<[z.ZodTuple<[z.ZodNumber, z.ZodObject<{
+        set: z.ZodOptional<z.ZodObject<{
+            opacity: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>>;
+        lerp: z.ZodOptional<z.ZodObject<{
+            opacity: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>], null>], z.ZodUnion<readonly [z.ZodTuple<[z.ZodNumber, z.ZodObject<{
+        set: z.ZodOptional<z.ZodObject<{
+            opacity: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>], null>, z.ZodTuple<[z.ZodNumber, z.ZodNull], null>]>>;
+    type: z.ZodLiteral<"image">;
+    file: z.ZodString;
+    fit: z.ZodUnion<readonly [z.ZodLiteral<"contain">, z.ZodLiteral<"cover">, z.ZodLiteral<"none">]>;
+}, z.core.$strip>, z.ZodObject<{
+    keyframes: z.ZodTuple<[z.ZodTuple<[z.ZodNumber, z.ZodObject<{
+        set: z.ZodOptional<z.ZodObject<{
+            volume: z.ZodOptional<z.ZodNumber>;
+            t: z.ZodOptional<z.ZodNumber>;
+            rate: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>>;
+        lerp: z.ZodOptional<z.ZodObject<{
+            volume: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>], null>], z.ZodUnion<readonly [z.ZodTuple<[z.ZodNumber, z.ZodObject<{
+        set: z.ZodOptional<z.ZodObject<{
+            volume: z.ZodOptional<z.ZodNumber>;
+            t: z.ZodOptional<z.ZodNumber>;
+            rate: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>], null>, z.ZodTuple<[z.ZodNumber, z.ZodNull], null>]>>;
+    type: z.ZodLiteral<"audio">;
+    file: z.ZodString;
+    audioOutput: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    keyframes: z.ZodTuple<[z.ZodTuple<[z.ZodNumber, z.ZodObject<{
+        set: z.ZodOptional<z.ZodObject<{
+            opacity: z.ZodOptional<z.ZodNumber>;
+            volume: z.ZodOptional<z.ZodNumber>;
+            t: z.ZodOptional<z.ZodNumber>;
+            rate: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>>;
+        lerp: z.ZodOptional<z.ZodObject<{
+            opacity: z.ZodOptional<z.ZodNumber>;
+            volume: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>], null>], z.ZodUnion<readonly [z.ZodTuple<[z.ZodNumber, z.ZodObject<{
+        set: z.ZodOptional<z.ZodObject<{
+            opacity: z.ZodOptional<z.ZodNumber>;
+            volume: z.ZodOptional<z.ZodNumber>;
+            t: z.ZodOptional<z.ZodNumber>;
+            rate: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>], null>, z.ZodTuple<[z.ZodNumber, z.ZodNull], null>]>>;
+    type: z.ZodLiteral<"video">;
+    file: z.ZodString;
+    audioOutput: z.ZodString;
+    fit: z.ZodUnion<readonly [z.ZodLiteral<"contain">, z.ZodLiteral<"cover">, z.ZodLiteral<"none">]>;
+}, z.core.$strip>]>>;
+export type ImageOptions = VisualProperties;
+export type AudioOptions = TemporalProperties & AudialProperties;
+export type VideoOptions = TemporalProperties & VisualProperties & AudialProperties;
+export type ImageState = {
+    type: 'image';
+    file: string;
+    fit: 'cover' | 'contain' | 'none';
+    keyframes: [InitialImageKeyframe, ...Array<ImageKeyframe | NullKeyframe>];
+};
+export type AudioState = {
+    type: 'audio';
+    file: string;
+    audioOutput: string;
+    keyframes: [InitialAudioKeyframe, ...Array<AudioKeyframe | NullKeyframe>];
+};
+export type VideoState = {
+    type: 'video';
+    file: string;
+    fit: 'cover' | 'contain' | 'none';
+    audioOutput: string;
+    keyframes: [InitialVideoKeyframe, ...Array<VideoKeyframe | NullKeyframe>];
+};
+export type MediaClipState = ImageState | AudioState | VideoState;
+export type MediaSurfaceState = Record<string, MediaClipState>;
+export type UnionsEqual<A, B> = Exclude<A, B> extends never ? (Exclude<B, A> extends never ? true : false) : false;
+export declare const defaultImageOptions: ImageOptions;
+export declare const defaultAudioOptions: AudioOptions;
+export declare const defaultVideoOptions: VideoOptions;
+export {};

package/dist/types/MediaSchema.js

@@ -0,0 +1,153 @@
+import { z } from 'zod';
+const TemporalProperties = z.object({
+    t: z.number().gte(0),
+    rate: z.number().gte(0),
+});
+const VisualProperties = z.object({
+    opacity: z.number().gte(0).lte(1),
+});
+const AudialProperties = z.object({
+    volume: z.number().gte(0).lte(1),
+});
+const ImageMetadata = z.object({
+    type: z.literal('image'),
+    file: z.string(),
+    fit: z.union([z.literal('contain'), z.literal('cover'), z.literal('none')]),
+});
+const AudioMetadata = z.object({
+    type: z.literal('audio'),
+    file: z.string(),
+    audioOutput: z.string(),
+});
+const VideoMetadata = z.object({
+    type: z.literal('video'),
+    file: z.string(),
+    audioOutput: z.string(),
+    fit: z.union([z.literal('contain'), z.literal('cover'), z.literal('none')]),
+});
+const NullKeyframe = z.tuple([z.number(), z.null()]);
+const InitialImageKeyframe = z.tuple([
+    z.number(),
+    z
+        .object({
+        set: z
+            .object({
+            ...VisualProperties.shape,
+        })
+            .partial(),
+    })
+        .partial(),
+]);
+const ImageKeyframe = z.tuple([
+    z.number(),
+    z
+        .object({
+        set: z
+            .object({
+            ...VisualProperties.shape,
+        })
+            .partial(),
+        lerp: z
+            .object({
+            ...VisualProperties.shape,
+        })
+            .partial(),
+    })
+        .partial(),
+]);
+const InitialAudioKeyframe = z.tuple([
+    z.number(),
+    z
+        .object({
+        set: z
+            .object({
+            ...TemporalProperties.shape,
+            ...AudialProperties.shape,
+        })
+            .partial(),
+    })
+        .partial(),
+]);
+const AudioKeyframe = z.tuple([
+    z.number(),
+    z
+        .object({
+        set: z
+            .object({
+            ...TemporalProperties.shape,
+            ...AudialProperties.shape,
+        })
+            .partial(),
+        lerp: z
+            .object({
+            ...AudialProperties.shape,
+        })
+            .partial(),
+    })
+        .partial(),
+]);
+const InitialVideoKeyframe = z.tuple([
+    z.number(),
+    z
+        .object({
+        set: z
+            .object({
+            ...TemporalProperties.shape,
+            ...AudialProperties.shape,
+            ...VisualProperties.shape,
+        })
+            .partial(),
+    })
+        .partial(),
+]);
+const VideoKeyframe = z.tuple([
+    z.number(),
+    z
+        .object({
+        set: z
+            .object({
+            ...TemporalProperties.shape,
+            ...AudialProperties.shape,
+            ...VisualProperties.shape,
+        })
+            .partial(),
+        lerp: z
+            .object({
+            ...AudialProperties.shape,
+            ...VisualProperties.shape,
+        })
+            .partial(),
+    })
+        .partial(),
+]);
+const ImageClip = z.object({
+    ...ImageMetadata.shape,
+    keyframes: z.tuple([ImageKeyframe], z.union([InitialImageKeyframe, NullKeyframe])),
+});
+const AudioClip = z.object({
+    ...AudioMetadata.shape,
+    keyframes: z.tuple([AudioKeyframe], z.union([InitialAudioKeyframe, NullKeyframe])),
+});
+const VideoClip = z.object({
+    ...VideoMetadata.shape,
+    keyframes: z.tuple([VideoKeyframe], z.union([InitialVideoKeyframe, NullKeyframe])),
+});
+export const MediaSurfaceStateSchema = z.record(z.string(), z.union([ImageClip, AudioClip, VideoClip]));
+true;
+true;
+true;
+true;
+export const defaultImageOptions = {
+    opacity: 1,
+};
+export const defaultAudioOptions = {
+    t: 0,
+    rate: 1,
+    volume: 1,
+};
+export const defaultVideoOptions = {
+    t: 0,
+    rate: 1,
+    volume: 1,
+    opacity: 1,
+};

package/dist/types/ShowPhase.js

@@ -1,5 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
 var ShowPhase;
 (function (ShowPhase) {
     ShowPhase["Setup"] = "setup";
@@ -7,4 +5,4 @@ var ShowPhase;
     ShowPhase["InProgress"] = "in progress";
     ShowPhase["Finished"] = "finished";
 })(ShowPhase || (ShowPhase = {}));
-exports.default = ShowPhase;
+export default ShowPhase;

package/dist/types/VideoState.js

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

package/dist/types/utils.js

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

package/dist/utils/urls.js

@@ -1,18 +1,13 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.COGS_SERVER_PORT = void 0;
-exports.assetUrl = assetUrl;
-exports.preloadUrl = preloadUrl;
-exports.COGS_SERVER_PORT = 12095;
+export const COGS_SERVER_PORT = 12095;
 /**
  * Get the URL of an asset hosted by the COGS server.
  */
-function assetUrl(file) {
+export function assetUrl(file) {
     const location = typeof window !== 'undefined' ? window.location : undefined;
     const path = `/assets/${encodeURIComponent(file)}`;
-    return `${location === null || location === void 0 ? void 0 : location.protocol}//${location === null || location === void 0 ? void 0 : location.hostname}:${exports.COGS_SERVER_PORT}${path}`;
+    return `${location?.protocol}//${location?.hostname}:${COGS_SERVER_PORT}${path}`;
 }
-async function preloadUrl(url) {
+export async function preloadUrl(url) {
     const response = await fetch(url);
     // We used arrayBuffer()` instead of `blob()` because the latter seems to fail on Pis when preloading some files
     return URL.createObjectURL(new Blob([await response.arrayBuffer()]));

package/package.json

@@ -3,7 +3,7 @@
   "description": "Connect to COGS to build a custom Media Master",
   "author": "Clockwork Dog <info@clockwork.dog>",
   "homepage": "https://github.com/clockwork-dog/cogs-sdk/tree/main/packages/javascript",
-  "version": "2.11.1",
+  "version": "3.0.0-alpha.0",
   "keywords": [],
   "license": "MIT",
   "repository": {
@@ -18,8 +18,8 @@
   ],
   "main": "dist/index.js",
   "exports": {
-    "default": "./dist/index.js",
-    "unpkg": "./dist/browser/index.umd.js"
+    "unpkg": "./dist/browser/index.umd.js",
+    "default": "./dist/index.js"
   },
   "scripts": {
     "test": "yarn types && yarn lint && vitest",
@@ -30,12 +30,14 @@
     "build:browser": "vite build",
     "watch-build": "tsc -w",
     "build-docs": "typedoc --out ../../docs/javascript --name @clockworkdog/cogs-client src/index.ts",
-    "release": "yarn npm publish --access public"
+    "release": "yarn npm publish --access public",
+    "prerelease": "yarn npm publish --access public --tag=next"
   },
   "dependencies": {
-    "@clockworkdog/timesync": "^2.11.1",
+    "@clockworkdog/timesync": "^3.0.0-alpha.0",
     "howler": "clockwork-dog/howler.js#fix-looping-clips",
-    "reconnecting-websocket": "^4.4.0"
+    "reconnecting-websocket": "^4.4.0",
+    "zod": "^4.1.13"
   },
   "devDependencies": {
     "@eslint/js": "^9.17.0",
@@ -52,5 +54,6 @@
     "typescript-eslint": "^8.18.1",
     "vite": "^7.1.12",
     "vitest": "^4.0.6"
-  }
+  },
+  "stableVersion": "0.0.0"
 }