@stripchatdev/ext-helper 0.1.44 → 0.1.46

package/dist/helpers/react.js

@@ -0,0 +1,16 @@
+import { useState as a, useSyncExternalStore as n } from "react";
+import { createSlotStateClient as r } from "./index.js";
+const c = ({
+  channel: s,
+  extHelper: o
+}) => {
+  const [t] = a(() => r({ channel: s, extHelper: o })), e = n(t.subscribe, t.getSnapshot);
+  return {
+    isLoading: e.isLoading,
+    setState: t.setState,
+    state: e.state
+  };
+};
+export {
+  c as useSlotState
+};

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 export declare const createExtHelper: () => ExtHelper;
 
-declare class ExtHelper {
+declare class ExtHelper implements TExtHelper {
     private rpcClient;
     private subscriber;
     private crashReporter;
@@ -42,6 +42,13 @@ export declare type TEvents = TV1Events;
 /** UUID */
 export declare type TExtensionId = string;
 
+declare type TExtHelper = {
+    bootstrap(): void;
+    makeRequest<M extends Extract<keyof TApiContract['methods'], string>>(method: M, params: TApiContract['methods'][M]['params']): Promise<TApiContract['methods'][M]['result']>;
+    subscribe<E extends Extract<keyof TApiContract['events'], string>>(eventName: E, handler: TAnyPubSubHandler<TApiContract['events'][E]>): void;
+    unsubscribe<E extends Extract<keyof TApiContract['events'], string>>(eventName: E, handler?: TAnyPubSubHandler<TApiContract['events'][E]>): void;
+};
+
 declare type TExtHelperProps = {
     frameId: string;
     serverId: string;
@@ -74,8 +81,8 @@ export declare type TModelId = TUserId;
 /**
  * Status of the movable overlay.
  * `active` - pulsing green
- * `inactive` - orange
- * `connecting` - green
+ * `inactive` - green
+ * `connecting` - orange
  * `error` - red
  */
 export declare type TMovableOverlayStatus = 'active' | 'inactive' | 'connecting' | 'error';
@@ -461,7 +468,8 @@ declare type TV1ModelMethods = {
     };
 };
 
-export declare type TV1ModelStatus = Exclude<(typeof V1_SHOW_STATUSES)[keyof typeof V1_SHOW_STATUSES], 'spy'>;
+/** Status that indicates which type of show model is producing now */
+export declare type TV1ModelStatus = Exclude<TV1ShowStatus, 'spy'>;
 
 declare type TV1MonitoringMethods = {
     'v1.monitoring.report.error': {
@@ -627,6 +635,8 @@ export declare type TV1SessionUpdate = {
 
 export declare type TV1SessionWhisperData = TUnknownDictionary;
 
+export declare type TV1ShowStatus = (typeof V1_SHOW_STATUSES)[keyof typeof V1_SHOW_STATUSES];
+
 declare type TV1StorageMethods = {
     'v1.storage.int.get': {
         params: {
@@ -970,18 +980,27 @@ export declare type TV1UsersFanClubSubscribed = {
     tier: TV1FanClubTier;
 };
 
-export declare type TV1UserStatus = Exclude<(typeof V1_SHOW_STATUSES)[keyof typeof V1_SHOW_STATUSES], 'idle'>;
+/** Status that indicates which type of show user is watching now */
+export declare type TV1UserStatus = Exclude<TV1ShowStatus, 'idle'>;
 
 export declare type TV1WhisperData = TUnknownDictionary;
 
 export declare const V1_SHOW_STATUSES: {
+    /** Ticket show */
     readonly STATUS_TICKET_SHOW: "ticketShow";
+    /** Group show */
     readonly STATUS_GROUP_SHOW: "groupShow";
+    /** Model is not on the site */
     readonly STATUS_OFF: "off";
+    /** Private show */
     readonly STATUS_PRIVATE: "private";
+    /** Exclusive private show */
     readonly STATUS_EXCLUSIVE_PRIVATE: "exclusivePrivate";
+    /** Public show */
     readonly STATUS_PUBLIC: "public";
+    /** Model is idle but on the site */
     readonly STATUS_IDLE: "idle";
+    /** In spy mode */
     readonly STATUS_SPY: "spy";
 };
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stripchatdev/ext-helper",
   "private": false,
-  "version": "0.1.44",
+  "version": "0.1.46",
   "license": "Apache-2.0",
   "type": "module",
   "module": "./dist/ext-helper.js",
@@ -9,7 +9,7 @@
   "scripts": {
     "build:code": "vite build",
     "build:clean": "rm -rf ./dist ./dist-types",
-    "build:types": "tsc -b --force && api-extractor run --local",
+    "build:types": "tsc -b --force && api-extractor run --local -c api-extractor.json && api-extractor run --local -c api-extractor.helpers.json && api-extractor run --local -c api-extractor.helpers-react.json",
     "build:clean-artefacts": "rm -rf ./dist-types",
     "build": "npm run build:clean && npm run build:code && npm run build:types && npm run build:clean-artefacts"
   },
@@ -27,9 +27,27 @@
       "types": "./dist/index.d.ts",
       "import": "./dist/ext-helper.js",
       "default": "./dist/ext-helper.js"
+    },
+    "./helpers": {
+      "types": "./dist/helpers/index.d.ts",
+      "import": "./dist/helpers/index.js",
+      "default": "./dist/helpers/index.js"
+    },
+    "./helpers/react": {
+      "types": "./dist/helpers/react.d.ts",
+      "import": "./dist/helpers/react.js",
+      "default": "./dist/helpers/react.js"
     }
   },
   "dependencies": {
     "ulid": "*"
+  },
+  "peerDependencies": {
+    "react": ">=18"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    }
   }
 }