@clockworkdog/cogs-client-react 2.0.0 → 2.0.2

package/dist/hooks/useCogsEvent.d.ts

@@ -1,5 +1,5 @@
 import { CogsConnection, CogsIncomingEventTypes, ManifestTypes } from '@clockworkdog/cogs-client';
 import { ManifestFromConnection } from '../utils/types';
-export default function useCogsEvent<Connection extends CogsConnection<any>, EventName extends string & ManifestTypes.EventNameFromCogs<ManifestFromConnection<Connection>>>(connection: Connection, eventName: EventName, handleEvent: (event: Extract<CogsIncomingEventTypes<ManifestTypes.EventFromCogs<ManifestFromConnection<Connection>>>, {
+export default function useCogsEvent<Connection extends CogsConnection<any>, EventName extends string & ManifestTypes.EventNameFromCogs<ManifestFromConnection<Connection>>>(connection: Connection, eventName: EventName, handleEvent: (value: Extract<CogsIncomingEventTypes<ManifestTypes.EventFromCogs<ManifestFromConnection<Connection>>>, {
     name: EventName;
-}>) => void): void;
+}>['value'], name: EventName) => void): void;

package/dist/hooks/useCogsEvent.js

@@ -5,7 +5,7 @@ function useCogsEvent(connection, eventName, handleEvent) {
     (0, react_1.useEffect)(() => {
         const listener = (event) => {
             if (event.name === eventName) {
-                handleEvent(event.value);
+                handleEvent(event.value, eventName);
             }
         };
         connection.addEventListener('event', listener);

package/dist/index.d.ts

@@ -9,6 +9,7 @@ export { default as useCogsMessage } from './hooks/useCogsMessage';
 export { default as usePreloadedUrl } from './hooks/usePreloadedUrl';
 export { default as useShowPhase } from './hooks/useShowPhase';
 export { default as useWhenShowReset } from './hooks/useWhenShowReset';
+export * from './utils/types';
 export { default as useAudioClips } from './hooks/useAudioClips';
 export { default as useIsAudioPlaying } from './hooks/useIsAudioPlaying';
 export { default as RtspVideo, RtspVideoProps } from './components/RtspVideo';
@@ -16,5 +17,5 @@ export { default as VideoContainer } from './components/VideoContainer';
 export { default as useHint } from './hooks/useHint';
 export { default as Hint } from './components/Hint';
 export { default as Timer } from './components/Timer';
-export { default as useImages } from './hooks/useImages';
+export { default as useImages, Image } from './hooks/useImages';
 export { default as Images } from './components/Images';

package/dist/index.js

@@ -1,4 +1,18 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (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 };
 };
@@ -30,6 +44,7 @@ var useShowPhase_1 = require("./hooks/useShowPhase");
 Object.defineProperty(exports, "useShowPhase", { enumerable: true, get: function () { return __importDefault(useShowPhase_1).default; } });
 var useWhenShowReset_1 = require("./hooks/useWhenShowReset");
 Object.defineProperty(exports, "useWhenShowReset", { enumerable: true, get: function () { return __importDefault(useWhenShowReset_1).default; } });
+__exportStar(require("./utils/types"), exports);
 // Audio
 var useAudioClips_1 = require("./hooks/useAudioClips");
 Object.defineProperty(exports, "useAudioClips", { enumerable: true, get: function () { return __importDefault(useAudioClips_1).default; } });

package/dist/providers/CogsConnectionProvider.d.ts

@@ -65,6 +65,6 @@ export declare function useCogsConnection<Manifest extends CogsPluginManifest>()
  */
 export declare function useAudioPlayer<Manifest extends CogsPluginManifest>(): CogsAudioPlayer | null;
 /**
- * Get the video player from `<CogsConnectionProvider audioPlayer>`
+ * Get the video player from `<CogsConnectionProvider videoPlayer>`
  */
 export declare function useVideoPlayer<Manifest extends CogsPluginManifest>(): CogsVideoPlayer | null;

package/dist/providers/CogsConnectionProvider.js

@@ -137,7 +137,7 @@ function useAudioPlayer() {
 }
 exports.useAudioPlayer = useAudioPlayer;
 /**
- * Get the video player from `<CogsConnectionProvider audioPlayer>`
+ * Get the video player from `<CogsConnectionProvider videoPlayer>`
  */
 function useVideoPlayer() {
     return (0, react_1.useContext)(CogsConnectionContext).useVideoPlayer();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clockworkdog/cogs-client-react",
-  "version": "v2.0.0",
+  "version": "v2.0.2",
   "main": "dist/index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
@@ -27,7 +27,7 @@
     "eslint-plugin-react": "^7.22.0",
     "eslint-plugin-react-hooks": "^4.2.0",
     "prettier": "^2.2.1",
-    "typedoc": "^0.21.4",
+    "typedoc": "^0.25.7",
     "typescript": "^5.1.6"
   },
   "dependencies": {