@stripchatdev/ext-helper 0.1.48 → 0.1.49

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -132,7 +132,9 @@ declare type TV1ActionParamValue = string | number | boolean | null | undefined
132
132
  };
133
133
 
134
134
  declare type TV1ActionRequestParams = {
135
+ /** Name of the action as declared in the manifest actions array */
135
136
  actionName: string;
137
+ /** Key-value parameters passed to the action. Used for URL/header placeholders and request body */
136
138
  params: Record<string, TV1ActionParamValue>;
137
139
  };
138
140
 
@@ -291,15 +293,18 @@ declare type TV1ExtLoggedInUser = {
291
293
  };
292
294
 
293
295
  declare type TV1ExtMethods = {
296
+ /** Triggers a backend action defined in the manifest.json. Stripchat executes the action server side and returns the response */
294
297
  'v1.ext.actions.call': {
295
298
  params: TV1ActionRequestParams;
296
299
  result: TV1ActionResult;
297
300
  };
298
301
  'v1.ext.activity.request': {
299
302
  params: {
303
+ /** Duration of the activity reservation in milliseconds. Must be a positive finite number up to `30000` (30 seconds) */
300
304
  durationMs: number;
301
305
  };
302
306
  result: {
307
+ /** Identifier of the started activity */
303
308
  activityId: string;
304
309
  };
305
310
  };
@@ -604,9 +609,11 @@ declare type TV1SessionMethods = {
604
609
  params: null;
605
610
  result: null;
606
611
  };
612
+ /** Returns the current long-term session. */
607
613
  'v1.session.get': {
608
614
  params: null;
609
615
  result: {
616
+ /** Current session snapshot. Returns `null` if the session doesn't exist **/
610
617
  session: TV1Session | null;
611
618
  };
612
619
  };
@@ -66,7 +66,9 @@ declare type TV1ActionParamValue = string | number | boolean | null | undefined
66
66
  };
67
67
 
68
68
  declare type TV1ActionRequestParams = {
69
+ /** Name of the action as declared in the manifest actions array */
69
70
  actionName: string;
71
+ /** Key-value parameters passed to the action. Used for URL/header placeholders and request body */
70
72
  params: Record<string, TV1ActionParamValue>;
71
73
  };
72
74
 
@@ -225,15 +227,18 @@ declare type TV1ExtLoggedInUser = {
225
227
  };
226
228
 
227
229
  declare type TV1ExtMethods = {
230
+ /** Triggers a backend action defined in the manifest.json. Stripchat executes the action server side and returns the response */
228
231
  'v1.ext.actions.call': {
229
232
  params: TV1ActionRequestParams;
230
233
  result: TV1ActionResult;
231
234
  };
232
235
  'v1.ext.activity.request': {
233
236
  params: {
237
+ /** Duration of the activity reservation in milliseconds. Must be a positive finite number up to `30000` (30 seconds) */
234
238
  durationMs: number;
235
239
  };
236
240
  result: {
241
+ /** Identifier of the started activity */
237
242
  activityId: string;
238
243
  };
239
244
  };
@@ -538,9 +543,11 @@ declare type TV1SessionMethods = {
538
543
  params: null;
539
544
  result: null;
540
545
  };
546
+ /** Returns the current long-term session. */
541
547
  'v1.session.get': {
542
548
  params: null;
543
549
  result: {
550
+ /** Current session snapshot. Returns `null` if the session doesn't exist **/
544
551
  session: TV1Session | null;
545
552
  };
546
553
  };
package/dist/index.d.ts CHANGED
@@ -102,7 +102,9 @@ export declare type TV1ActionParamValue = string | number | boolean | null | und
102
102
  };
103
103
 
104
104
  export declare type TV1ActionRequestParams = {
105
+ /** Name of the action as declared in the manifest actions array */
105
106
  actionName: string;
107
+ /** Key-value parameters passed to the action. Used for URL/header placeholders and request body */
106
108
  params: Record<string, TV1ActionParamValue>;
107
109
  };
108
110
 
@@ -261,15 +263,18 @@ export declare type TV1ExtLoggedInUser = {
261
263
  };
262
264
 
263
265
  declare type TV1ExtMethods = {
266
+ /** Triggers a backend action defined in the manifest.json. Stripchat executes the action server side and returns the response */
264
267
  'v1.ext.actions.call': {
265
268
  params: TV1ActionRequestParams;
266
269
  result: TV1ActionResult;
267
270
  };
268
271
  'v1.ext.activity.request': {
269
272
  params: {
273
+ /** Duration of the activity reservation in milliseconds. Must be a positive finite number up to `30000` (30 seconds) */
270
274
  durationMs: number;
271
275
  };
272
276
  result: {
277
+ /** Identifier of the started activity */
273
278
  activityId: string;
274
279
  };
275
280
  };
@@ -574,9 +579,11 @@ declare type TV1SessionMethods = {
574
579
  params: null;
575
580
  result: null;
576
581
  };
582
+ /** Returns the current long-term session. */
577
583
  'v1.session.get': {
578
584
  params: null;
579
585
  result: {
586
+ /** Current session snapshot. Returns `null` if the session doesn't exist **/
580
587
  session: TV1Session | null;
581
588
  };
582
589
  };
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@stripchatdev/ext-helper",
3
3
  "private": false,
4
- "version": "0.1.48",
4
+ "version": "0.1.49",
5
5
  "license": "Apache-2.0",
6
6
  "type": "module",
7
7
  "module": "./dist/ext-helper.js",