@stripchatdev/ext-helper 0.0.1 → 0.1.0

package/dist/index.d.ts

@@ -88,8 +88,6 @@ export declare type TV1ActionResult = {
     code: number;
 };
 
-export declare type TV1AvailableGenders = 'male' | 'female' | 'tranny' | 'maleFemale' | 'males' | 'females' | 'trannies' | 'maleTranny' | 'femaleTranny';
-
 declare type TV1ChatMethods = {
     'v1.chat.message.send': {
         params: {
@@ -166,37 +164,78 @@ declare type TV1ExtMethods = {
 };
 
 export declare type TV1ExtModel = {
+    /** Model's avatar url */
     avatarUrlThumb: string;
+    /** @deprecated use isExclusivePrivateEnabled instead. This property will be removed soon */
     doP2p: boolean;
+    /** @deprecated use isPrivateEnabled instead. This property will be removed soon */
     doPrivate: boolean;
-    doSpy: boolean;
-    gender: TV1AvailableGenders;
+    /** Broadcasting gender. Could be one of the male, female, tranny or group */
+    gender: TV1Genders;
     id: TUserId;
+    /** Is exclusive private mode enabled on the stream */
+    isExclusivePrivateEnabled: boolean;
+    /** Is non nude model */
     isNonNude: boolean;
+    /** Is private mode enabled on the stream */
+    isPrivateEnabled: boolean;
+    /** Is spy mode enabled on the stream */
+    isSpyEnabled: boolean;
+    /** Model's name from her profile. If not set, an empty string will be returned */
     name: string;
+    /** Status of the show. Possible values:
+     *
+     * - `idle` - model is online but not streaming
+     * - `public` - model is broadcasting public show
+     * - `private` - model is in private show
+     * - `exclusivePrivate` - model is in exclusive private show
+     * - `off` - model is offline
+     * - `groupShow` - model is in group show that is not a ticket show
+     * - `ticketShow` - model is in ticket show
+     * */
     status: TV1ModelStatus;
+    /** Model's username */
     username: string;
 };
 
 export declare type TV1ExtSettings = unknown;
 
 export declare type TV1ExtUser = {
+    /** User previously purchased tokens */
+    hasPaidBefore: boolean;
+    /** User has tokens */
+    hasTokens: boolean;
+    /** User currently has Ultimate membership */
+    hasUltimateSubscription: boolean;
+    /** User ID. */
     id: TUserId;
-    isExGreen: boolean;
-    isGreen: boolean;
+    /** Current user is a model. */
     isModel: boolean;
-    isRegular: boolean;
-    isStudio: boolean;
-    isUltimate: boolean;
+    /**
+     * Current show/session state for this user.
+     *
+     * - `public` — public broadcast context
+     * - `private` — private show context
+     * - `exclusivePrivate` — exclusive private show context
+     * - `groupShow` — group show context
+     * - `ticketShow` — ticket show context
+     * - `off` — offline
+     * - `spy` — spying on a private show
+     */
     status: TV1UserStatus;
+    /** User username. */
     username: string;
+    /** User activity ranking data when available. */
     userRanking?: {
-        isEx: boolean;
+        /** League representation of the user's activity level. Could be `grey`, `bronze`, `silver`, `gold`, `diamond`, `royal` or `legend`. */
         league: TV1UserLeague;
+        /** Activity level from 1 to 100. */
         level: number;
-    } | null;
+    };
 };
 
+export declare type TV1Genders = 'male' | 'female' | 'group' | 'tranny';
+
 export declare type TV1Methods = TV1ExtMethods & TV1SystemMethods & TV1PaymentMethods & TV1ModelMethods & TV1ChatMethods & TV1PrivateMethods;
 
 declare type TV1ModelEvents = {
@@ -219,7 +258,7 @@ declare type TV1ModelMethods = {
     };
 };
 
-export declare type TV1ModelStatus = (typeof V1_SHOW_STATUSES)[keyof typeof V1_SHOW_STATUSES];
+export declare type TV1ModelStatus = Exclude<(typeof V1_SHOW_STATUSES)[keyof typeof V1_SHOW_STATUSES], 'spy'>;
 
 declare type TV1PaymentEvents = {
     'v1.payment.tokens.spend.succeeded': {
@@ -258,9 +297,19 @@ declare type TV1SystemMethods = {
 
 export declare type TV1TokenSpendData = TUnknownDictionary;
 
+/**
+ * User activity league. Ordered from lowest to highest activity rank:
+ * - `grey` — new or low-activity users (level 1–9)
+ * - `bronze` — early active users (level 10–19)
+ * - `silver` — regularly active users (level 20–34)
+ * - `gold` — highly active users (level 35–54)
+ * - `diamond` — very highly active users (level 55–79)
+ * - `royal` — elite activity users (level 80–99)
+ * - `legend` — top activity users (level 100)
+ */
 declare type TV1UserLeague = 'grey' | 'bronze' | 'silver' | 'gold' | 'diamond' | 'royal' | 'legend';
 
-export declare type TV1UserStatus = (typeof V1_SHOW_STATUSES)[keyof typeof V1_SHOW_STATUSES];
+export declare type TV1UserStatus = Exclude<(typeof V1_SHOW_STATUSES)[keyof typeof V1_SHOW_STATUSES], 'idle'>;
 
 export declare type TV1WhisperData = TUnknownDictionary;
 
@@ -272,6 +321,7 @@ export declare const V1_SHOW_STATUSES: {
     readonly STATUS_EXCLUSIVE_PRIVATE: "exclusivePrivate";
     readonly STATUS_PUBLIC: "public";
     readonly STATUS_IDLE: "idle";
+    readonly STATUS_SPY: "spy";
 };
 
 export { }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stripchatdev/ext-helper",
   "private": false,
-  "version": "0.0.1",
+  "version": "0.1.0",
   "type": "module",
   "module": "./dist/ext-helper.js",
   "types": "./dist/index.d.ts",
@@ -16,7 +16,7 @@
     "dist"
   ],
   "publishConfig": {
-    "registry": "https://registry.npmjs.org/",
+    "registry": "https://gitlab.stripchat.dev/api/v4/projects/1902/packages/npm/",
     "access": "public"
   },
   "sideEffects": false,