@clockworkdog/cogs-client 2.0.0-beta.5 → 2.1.0

package/dist/helpers/urls.d.ts

@@ -1,3 +1,12 @@
+export declare const COGS_ASSETS_SERVER_PORT = 12094;
 export declare const COGS_SERVER_PORT = 12095;
+/**
+ * @deprecated Use {@link CogsConnection#getAssetUrl} instead. Or pass a boolean to say if you want a
+ * HTTP/2 asset URL or not.
+ */
 export declare function assetUrl(file: string): string;
+/**
+ * Returns a URL for the asset. This is different based on if HTTP/2 is requested or not
+ */
+export declare function assetUrl(file: string, useHttp2AssetsServer: boolean): string;
 export declare function preloadUrl(url: string): Promise<string>;

package/dist/helpers/urls.js

@@ -1,10 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.preloadUrl = exports.assetUrl = exports.COGS_SERVER_PORT = void 0;
+exports.preloadUrl = exports.assetUrl = exports.COGS_SERVER_PORT = exports.COGS_ASSETS_SERVER_PORT = void 0;
+exports.COGS_ASSETS_SERVER_PORT = 12094;
 exports.COGS_SERVER_PORT = 12095;
-function assetUrl(file) {
+function assetUrl(file, useHttp2AssetsServer) {
     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)}`;
+    const path = `/assets/${encodeURIComponent(file)}`;
+    if (useHttp2AssetsServer) {
+        return `https://${location === null || location === void 0 ? void 0 : location.hostname}:${exports.COGS_ASSETS_SERVER_PORT}${path}`;
+    }
+    else {
+        return `${location === null || location === void 0 ? void 0 : location.protocol}//${location === null || location === void 0 ? void 0 : location.hostname}:${exports.COGS_SERVER_PORT}${path}`;
+    }
 }
 exports.assetUrl = assetUrl;
 async function preloadUrl(url) {

package/dist/types/CogsClientMessage.d.ts

@@ -16,6 +16,11 @@ interface TextHintsUpdateMessage {
     type: 'text_hints_update';
     lastSentHint: string;
 }
+interface CogsEnvironmentMessage {
+    type: 'cogs_environment';
+    cogsVersion: string;
+    http2AssetsServer: boolean;
+}
 export type Media = {
     type: 'audio';
     preload: boolean;
@@ -81,5 +86,5 @@ type MediaClientMessage = {
     file: string;
     fit: MediaObjectFit;
 };
-export type CogsClientMessage<CustomConfig = {}> = ShowResetMessage | ShowPhaseMessage | AdjustableTimerUpdateMessage | TextHintsUpdateMessage | (MediaClientConfigMessage & CustomConfig) | MediaClientMessage;
+export type CogsClientMessage<CustomConfig = {}> = ShowResetMessage | ShowPhaseMessage | AdjustableTimerUpdateMessage | TextHintsUpdateMessage | (MediaClientConfigMessage & CustomConfig) | CogsEnvironmentMessage | MediaClientMessage;
 export default CogsClientMessage;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clockworkdog/cogs-client",
-  "version": "v2.0.0-beta.5",
+  "version": "v2.1.0",
   "main": "dist/index.js",
   "unpkg": "dist/browser/index.js",
   "scripts": {
@@ -10,6 +10,7 @@
     "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",
+    "build-docs": "typedoc --out docs --name @clockworkdog/cogs-client src/index.ts",
     "release": "yarn publish --access public"
   },
   "keywords": [],
@@ -25,10 +26,12 @@
     "eslint-config-prettier": "^7.1.0",
     "eslint-plugin-prettier": "^3.3.1",
     "prettier": "^2.2.1",
+    "typedoc": "^0.25.7",
     "typescript": "^5.1.6"
   },
   "dependencies": {
     "@clockworkdog/media-stream-library-browser": "^11.1.1-fixes.6",
+    "compare-versions": "^6.1.0",
     "howler": "clockwork-dog/howler.js#fix-looping-clips",
     "reconnecting-websocket": "^4.4.0"
   },