@clockworkdog/cogs-client 2.4.0 → 2.7.0

package/dist/helpers/urls.d.ts

@@ -1,12 +1,6 @@
-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.
+ * Get the URL of an asset hosted by the COGS server.
  */
 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,22 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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 = void 0;
+exports.assetUrl = assetUrl;
+exports.preloadUrl = preloadUrl;
 exports.COGS_SERVER_PORT = 12095;
-function assetUrl(file, useHttp2AssetsServer) {
+/**
+ * Get the URL of an asset hosted by the COGS server.
+ */
+function assetUrl(file) {
     const location = typeof window !== 'undefined' ? window.location : undefined;
     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}`;
-    }
+    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) {
     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()]));
 }
-exports.preloadUrl = preloadUrl;

package/dist/index.js

@@ -18,13 +18,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 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 __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };

package/dist/types/CogsClientMessage.d.ts

@@ -19,7 +19,6 @@ interface TextHintsUpdateMessage {
 interface CogsEnvironmentMessage {
     type: 'cogs_environment';
     cogsVersion: string;
-    http2AssetsServer: boolean;
 }
 export interface DataStoreItemsClientMessage {
     type: 'data_store_items';

package/dist/types/CogsPluginManifest.d.ts

@@ -123,6 +123,8 @@ export interface CogsPluginManifestJson {
     /**
      * COGS-managed key/value data store settings
      *
+     * Added in COGS 5.4
+     *
      * Allows certain key/value pairs to be saved to disk in the project folder alongside the plugin.
      * Any key that is not listed here can still be used.
      */

package/package.json

@@ -1,50 +1,50 @@
 {
   "name": "@clockworkdog/cogs-client",
-  "version": "v2.4.0",
-  "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",
-    "build-docs": "typedoc --out docs --name @clockworkdog/cogs-client src/index.ts",
-    "release": "yarn publish --access public"
-  },
-  "keywords": [],
+  "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.7.0",
+  "keywords": [],
   "license": "MIT",
-  "devDependencies": {
-    "@types/howler": "2.2.7",
-    "@types/node": "^18.14.1",
-    "@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",
-    "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"
-  },
-  "description": "Connect to COGS to build a custom Media Master",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/clockwork-dog/cogs-client-lib.git"
+    "url": "git+https://github.com/clockwork-dog/cogs-sdk.git"
   },
   "bugs": {
-    "url": "https://github.com/clockwork-dog/cogs-client-lib/issues"
+    "url": "https://github.com/clockwork-dog/cogs-sdk/issues"
   },
-  "homepage": "https://cogs.show",
   "files": [
     "dist/**/*"
-  ]
-}
+  ],
+  "main": "dist/index.js",
+  "unpkg": "dist/browser/index.js",
+  "scripts": {
+    "test": "yarn types && yarn lint",
+    "types": "tsc --noEmit",
+    "lint": "eslint .",
+    "build": "yarn build:ts && yarn build:browser",
+    "build:ts": "tsc",
+    "build:browser": "browserify --debug --standalone COGS dist/index.js -o dist/browser/index.js",
+    "watch-build": "tsc -w",
+    "build-docs": "typedoc --out ../../docs/javascript --name @clockworkdog/cogs-client src/index.ts",
+    "release": "yarn npm publish --access public"
+  },
+  "dependencies": {
+    "@clockworkdog/media-stream-library-browser": "11.1.1-fixes.7",
+    "howler": "clockwork-dog/howler.js#fix-looping-clips",
+    "reconnecting-websocket": "^4.4.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.17.0",
+    "@types/howler": "2.2.12",
+    "@types/node": "^22.10.2",
+    "browserify": "^17.0.1",
+    "eslint": "^9.17.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "prettier": "^3.4.2",
+    "typedoc": "^0.27.5",
+    "typescript": "~5.7.2",
+    "typescript-eslint": "^8.18.1"
+  }
+}

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2023 Clockwork Dog
-
-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:
-
-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.