feat: add method for checking if the current user can start live stre…

…ams (#54)

README.md

@@ -71,6 +71,7 @@ const api = new TikTokAPI(params, { signURL });
 * [.listFollowingFeed([params])](#listfollowingfeedparams)
 * [.joinLiveStream(id)](#joinlivestreamid)
 * [.leaveLiveStream(id)](#leavelivestreamid)
+* [.canStartLiveStream()](#canstartlivestream)
 
 #### .loginWithEmail(email, password)
 
@@ -484,6 +485,22 @@ api.leaveLiveStream('<room_id>')
 
 See the [live stream types](src/types/live-stream.d.ts) for the complete request/response objects.
 
+#### .canStartLiveStream()
+
+Determines if the current user is allowed to start a live stream.
+
+```javascript
+api.canStartLiveStream()
+  .then(res => console.log(res.data.can_be_live_podcast))
+  .catch(console.log);
+
+// Outputs:
+// true
+
+```
+
+See the [live stream types](src/types/live-stream.d.ts) for the complete request/response objects.
+
 ## Resources
 
 * [Reverse engineering the musical.ly API](https://medium.com/@szdc/reverse-engineering-the-musical-ly-api-662331008eb3)

src/index.ts

@@ -419,6 +419,12 @@ export default class TikTokAPI {
       },
     })
 
+  /**
+   * Determines if you are allowed to start a live stream.  Typically you need 1,000 followers.
+   */
+  canStartLiveStream = () =>
+    this.request.get<API.CanStartLiveStreamResponse | API.BaseResponseData>('aweme/v1/live/podcast/')
+
   /**
    * Transform using JSONBig to store big numbers accurately (e.g. user IDs) as strings.
    *

src/types/live-stream.d.ts

@@ -11,6 +11,11 @@ export interface JoinLiveStreamResponse extends BaseResponseData {
   room: LiveStream;
 }
 
+export interface CanStartLiveStreamResponse extends BaseResponseData {
+  /** True if your account can start a live stream */
+  can_be_live_podcast: boolean;
+}
+
 export interface LiveStream {
   /** The timestamp in seconds when the stream was created */
   create_time: number;

test/live-stream.spec.ts

@@ -2,7 +2,12 @@ import MockAdapter from 'axios-mock-adapter';
 import { assert } from 'chai';
 import { describe, it } from 'mocha';
 
-import TikTokAPI, { BaseResponseData, CommonUserDetails, JoinLiveStreamResponse } from '../src';
+import TikTokAPI, {
+  BaseResponseData,
+  CanStartLiveStreamResponse,
+  CommonUserDetails,
+  JoinLiveStreamResponse,
+} from '../src';
 import {
   loadTestData,
   mockConfig,
@@ -63,3 +68,23 @@ describe('#leaveLiveStream()', () => {
     assert.deepStrictEqual(res.data, expected);
   });
 });
+
+describe('#canStartLiveStream()', () => {
+  it('a successful response should match the interface', async () => {
+    const api = new TikTokAPI(mockParams, mockConfig);
+    const mock = new MockAdapter(api.request);
+    mock
+      .onGet(new RegExp('aweme/v1/live/podcast/\?.*'))
+      .reply(200, loadTestData('canStartLiveStream.json'), {});
+
+    const res = await api.canStartLiveStream();
+    const expected: CanStartLiveStreamResponse = {
+      extra: {
+        now: 1000000000000,
+      },
+      can_be_live_podcast: true,
+      status_code: 0,
+    };
+    assert.deepStrictEqual(res.data, expected);
+  });
+});

test/testdata/canStartLiveStream.json

@@ -0,0 +1,7 @@
+{
+  "extra": {
+    "now": 1000000000000
+  },
+  "can_be_live_podcast": true,
+  "status_code": 0
+}