rettiwt-api 1.1.7 → 1.2.0

package/.github/workflows/build-docs.yml

@@ -1,27 +1,28 @@
 name: build-documentation
 run-name: Building the documentation for the release
 on:
-  push:
-    branches:
-      release
+    push:
+        branches: release
+
 jobs:
-  documentation:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: '18.x'
-      # Installing dependencies
-      - run: npm install
+    # Creating the documentation
+    documentation:
+        runs-on: ubuntu-latest
+        permissions:
+            contents: write
+        steps:
+            - uses: actions/checkout@v3
+            - uses: actions/setup-node@v3
+              with:
+                  node-version: '18.x'
+            # Installing dependencies
+            - run: npm install
 
-      # Generating documentations
-      - run: npx typedoc src/index.ts
+            # Generating documentations
+            - run: npx typedoc src/index.ts
 
-      # Commiting the documentations
-      - uses: stefanzweifel/git-auto-commit-action@v4
-        with:
-          commit_message: Updated documentations
-          branch: release
+            # Commiting the documentations
+            - uses: stefanzweifel/git-auto-commit-action@v4
+              with:
+                  commit_message: Updated documentations
+                  branch: release

package/.github/workflows/publish-to-npm.yml

@@ -0,0 +1,29 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
+
+name: Publish Node.js Package to NPM
+
+on:
+    release:
+        types: [created]
+
+jobs:
+    # Pulishes this package to npm
+    publish-npm:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v3
+            - uses: actions/setup-node@v3
+              with:
+                  node-version: '18.x'
+                  registry-url: https://registry.npmjs.org/
+            # Installing dependencies
+            - run: npm install
+
+            # Building the package
+            - run: npm run build
+
+            # Publishing
+            - run: npm publish
+              env:
+                  NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/README.md

@@ -1,72 +1,84 @@
 # Rettiwt-API
+
 An API for fetching data from TwitterAPI, without any rate limits!
 
-#### **This API is not a replacement of official Twitter API, since it does not scale**  
-#### **It works well for small applications like the one side project you started and are never gonna finish**  
-#### **If you want something that will scale as you application grows, Twitter API is the way to go**  
+#### **This API is not a replacement of official Twitter API, since it does not scale**
+
+#### **It works well for small applications like the one side project you started and are never gonna finish**
+
+#### **If you want something that will scale as you application grows, Twitter API is the way to go**
 
 #### **The API can either be used as a GraphQL Server or as a standalone npm library**
 
 #### **For complete documentation and API reference, head over to the [documentation](https://rishikant181.github.io/Rettiwt-API/)**
 
 ## 1. GraphQL Server
+
 Using the API as a GraphQL enables complex nested queries to fetch data from twitter.  
 To use the API as a server,
 
 1.  Clone the repo's release branch
-2.  Build the project using 'npm run build'  
-3.  Set the environment variables:  
-        -   APP_PORT -> The port number where the server will listen to  
-        -   DEVELOPMENT -> Whether to run the server in development mode or not  
-4.  Start the server using 'npm run start'  
+2.  Build the project using 'npm run build'
+3.  Set the environment variables:
+    -   APP_PORT -> The port number where the server will listen to
+    -   DEVELOPMENT -> Whether to run the server in development mode or not
+4.  Start the server using 'npm run start'
 5.  Make graphql requests to server listening on localhost:port/graphql
 
 **You can go to localhost:port/graphql to see the graphql schema**
 
 ## 2. NPM Package
+
 The API can also be used as a standalone npm package.  
 The limitation is that, large number of data cannot be fetched automatically, and the data needs to fetched in batches, by using cursors.
 Further nested queries are not possible.  
 To use the API as an npm package,
 
-1.  In your node project, install the package using 'npm install --save rettiwt-api'.  
-2.  import { Rettiwt } from 'rettiwt-api'.  
-    const rettiwt = Rettiwt().  
-3.  Use the created [Rettiwt](https://rishikant181.github.io/Rettiwt-API/functions/Rettiwt.html) instance to fetch data from Twitter.  
+1.  In your node project, install the package using 'npm install --save rettiwt-api'.
+2.  import { Rettiwt } from 'rettiwt-api'.
+    ```
+    const rettiwt = Rettiwt({
+        <put your authentication tokens here. For details, refer to section below>
+    }).
+    ```
+3.  Use the created [Rettiwt](https://rishikant181.github.io/Rettiwt-API/functions/Rettiwt.html) instance to fetch data from Twitter.
+
+**The authentication tokens can be generated in the following way:**
 
-This creates an instance of Rettiwt which can be used to fetch data from Twitter. This instance works as guest and no form of authentication is used. However, guest mode implies functionalities such fetching of user followings, followers, likes and tweet likes, retweets, quotes and replies is not possible. Whatever data can be viewed in Twitter without loggin in, can be accessed this way.  
+#### A. GraphQL Server:
 
-If you wan't full functionality, you need to use the cookie of a logged in Twitter account, which can be retrieved in the following way:  
+1.  Make the following query to the GraphQL server:
 
-#### A. GraphQL Server:  
-1.  Make the following query to the GraphQL server:  
 ```
-        query {  
-                Login(email: "your_twitter_email", userName: "your_twitter_username", password: "your_twitter_password") {  
-                        auth_token  
-                        ct0  
-                        kdt  
-                        twid  
-                }  
-        }  
+        query {
+                Login(email: "your_twitter_email", userName: "your_twitter_username", password: "your_twitter_password") {
+                        auth_token
+                        ct0
+                        kdt
+                        twid
+                }
+        }
 ```
-1.  This will give you 4 tokens: 'auth_token', 'ct0', 'kdt' and 'twid'.  
-2.  Pass the four tokens in the headers while making any request made to the GraphQL server for fetching data.  
 
-#### B. NPM Library:  
-1.  Use the [Rettiwt().account.login](https://rishikant181.github.io/Rettiwt-API/classes/AccountService.html#login) method to get back 4 tokens: 'auth_token', 'ct0', 'kdt' and 'twid'.  
-2.  Use these four tokens to initialize a new [Rettiwt](https://rishikant181.github.io/Rettiwt-API/functions/Rettiwt.html) instance as follows:  
+1.  This will give you 4 tokens: 'auth_token', 'ct0', 'kdt' and 'twid'.
+2.  Pass the four tokens in the headers while making any request made to the GraphQL server for fetching data.
+
+#### B. NPM Library:
+
+1.  Use the [Rettiwt().account.login](https://rishikant181.github.io/Rettiwt-API/classes/AccountService.html#login) method to get back 4 tokens: 'auth_token', 'ct0', 'kdt' and 'twid'.
+2.  Use these four tokens to initialize a new [Rettiwt](https://rishikant181.github.io/Rettiwt-API/functions/Rettiwt.html) instance as follows:
+
 ```
-        const rettiwt = new Rettiwt({  
-                auth_token: "received_auth_token",  
-                ct0: "received_ct0_token",  
-                kdt: "received_kdt_token",  
-                twid: "received_twid_token"  
-        });  
+        const rettiwt = new Rettiwt({
+                auth_token: "received_auth_token",
+                ct0: "received_ct0_token",
+                kdt: "received_kdt_token",
+                twid: "received_twid_token"
+        });
 ```
-3.  Use the created [Rettiwt](https://rishikant181.github.io/Rettiwt-API/functions/Rettiwt.html) instance to fetch data.  
 
-### **If you don't want to risk your twitter account getting banned, using cookies is completely optional and you can omit passing cookie and use the API as guest**  
-### **No likes, followers, followings, retweets, replies, tweet likes, quotes can be fetched without using cookie!**  
-### **It's completely safe to use the API as a guest and not using cookies, since that way, no form of authentication is used**
-### **If you decide to use cookies for full functionality, I'M NOT RESPONSIBLE IF YOU GET YOUR TWITTER ACCOUNT BANNED!**
+3.  Use the created [Rettiwt](https://rishikant181.github.io/Rettiwt-API/functions/Rettiwt.html) instance to fetch data.
+
+### **Due to changes in Twitter API, all methods now require logging in and using the tokens for authentication**
+
+### **I'M NOT RESPONSIBLE IF YOU GET YOUR TWITTER ACCOUNT BANNED!**

package/dist/config/env.d.ts

@@ -1,5 +1,5 @@
-export declare const config: {
-    port: number;
-    is_development: boolean;
-    twitter_auth_token: string;
-};
+export declare const config: {
+    port: number;
+    is_development: boolean;
+    twitter_auth_token: string;
+};

package/dist/config/env.js

@@ -1,9 +1,9 @@
-"use strict";
-exports.__esModule = true;
-exports.config = void 0;
-exports.config = {
-    port: Number(process.env.APP_PORT),
-    is_development: (process.env.DEVELOPMENT == 'true'),
-    twitter_auth_token: 'Bearer AAAAAAAAAAAAAAAAAAAAANRILgAAAAAAnNwIzUejRCOuH5E6I8xnZz4puTs%3D1Zv7ttfk8LF81IUq16cHjhLTvJu4FA33AGWWjCpTnA'
-};
+"use strict";
+exports.__esModule = true;
+exports.config = void 0;
+exports.config = {
+    port: Number(process.env.APP_PORT),
+    is_development: (process.env.DEVELOPMENT == 'true'),
+    twitter_auth_token: 'Bearer AAAAAAAAAAAAAAAAAAAAANRILgAAAAAAnNwIzUejRCOuH5E6I8xnZz4puTs%3D1Zv7ttfk8LF81IUq16cHjhLTvJu4FA33AGWWjCpTnA'
+};
 //# sourceMappingURL=env.js.map

package/dist/enums/Errors.d.ts

@@ -1,20 +1,20 @@
-/**
- * Different types of error messages related to authentication returned by services.
- *
- * @public
- */
-export declare enum AuthenticationErrors {
-    NotAuthenticated = "Cannot fetch this data without authentication",
-    InvalidEmail = "No Twitter account found for the given email address",
-    InvalidUsername = "Incorrect username given for the given Twitter account",
-    InvalidPassword = "Incorrect password given for the given Twitter account"
-}
-/**
- * Different type of error messages related to data that are returned by services.
- *
- * @public
- */
-export declare enum DataErrors {
-    UserNotFound = "An account with given username/id was not found",
-    TweetNotFound = "A tweet with the given id was not found"
-}
+/**
+ * Different types of error messages related to authentication returned by services.
+ *
+ * @public
+ */
+export declare enum AuthenticationErrors {
+    NotAuthenticated = "Cannot fetch this data without authentication",
+    InvalidEmail = "No Twitter account found for the given email address",
+    InvalidUsername = "Incorrect username given for the given Twitter account",
+    InvalidPassword = "Incorrect password given for the given Twitter account"
+}
+/**
+ * Different type of error messages related to data that are returned by services.
+ *
+ * @public
+ */
+export declare enum DataErrors {
+    UserNotFound = "An account with given username/id was not found",
+    TweetNotFound = "A tweet with the given id was not found"
+}

package/dist/enums/Errors.js

@@ -1,28 +1,28 @@
-"use strict";
-exports.__esModule = true;
-exports.DataErrors = exports.AuthenticationErrors = void 0;
-/**
- * Different types of error messages related to authentication returned by services.
- *
- * @public
- */
-var AuthenticationErrors;
-(function (AuthenticationErrors) {
-    AuthenticationErrors["NotAuthenticated"] = "Cannot fetch this data without authentication";
-    AuthenticationErrors["InvalidEmail"] = "No Twitter account found for the given email address";
-    AuthenticationErrors["InvalidUsername"] = "Incorrect username given for the given Twitter account";
-    AuthenticationErrors["InvalidPassword"] = "Incorrect password given for the given Twitter account";
-})(AuthenticationErrors = exports.AuthenticationErrors || (exports.AuthenticationErrors = {}));
-;
-/**
- * Different type of error messages related to data that are returned by services.
- *
- * @public
- */
-var DataErrors;
-(function (DataErrors) {
-    DataErrors["UserNotFound"] = "An account with given username/id was not found";
-    DataErrors["TweetNotFound"] = "A tweet with the given id was not found";
-})(DataErrors = exports.DataErrors || (exports.DataErrors = {}));
-;
+"use strict";
+exports.__esModule = true;
+exports.DataErrors = exports.AuthenticationErrors = void 0;
+/**
+ * Different types of error messages related to authentication returned by services.
+ *
+ * @public
+ */
+var AuthenticationErrors;
+(function (AuthenticationErrors) {
+    AuthenticationErrors["NotAuthenticated"] = "Cannot fetch this data without authentication";
+    AuthenticationErrors["InvalidEmail"] = "No Twitter account found for the given email address";
+    AuthenticationErrors["InvalidUsername"] = "Incorrect username given for the given Twitter account";
+    AuthenticationErrors["InvalidPassword"] = "Incorrect password given for the given Twitter account";
+})(AuthenticationErrors = exports.AuthenticationErrors || (exports.AuthenticationErrors = {}));
+;
+/**
+ * Different type of error messages related to data that are returned by services.
+ *
+ * @public
+ */
+var DataErrors;
+(function (DataErrors) {
+    DataErrors["UserNotFound"] = "An account with given username/id was not found";
+    DataErrors["TweetNotFound"] = "A tweet with the given id was not found";
+})(DataErrors = exports.DataErrors || (exports.DataErrors = {}));
+;
 //# sourceMappingURL=Errors.js.map

package/dist/enums/HTTP.d.ts

@@ -1,17 +1,17 @@
-/**
- * The different types of http status codes
- *
- * @internal
- */
-export declare enum HttpStatus {
-    BadRequest = 400,
-    Unauthorized = 401,
-    Forbidden = 403,
-    NotFound = 404,
-    MethodNotAllowed = 405,
-    RequestTimeout = 408,
-    TooManyRequests = 429,
-    InternalServerError = 500,
-    BadGateway = 502,
-    ServiceUnavailable = 503
-}
+/**
+ * The different types of http status codes
+ *
+ * @internal
+ */
+export declare enum HttpStatus {
+    BadRequest = 400,
+    Unauthorized = 401,
+    Forbidden = 403,
+    NotFound = 404,
+    MethodNotAllowed = 405,
+    RequestTimeout = 408,
+    TooManyRequests = 429,
+    InternalServerError = 500,
+    BadGateway = 502,
+    ServiceUnavailable = 503
+}

package/dist/enums/HTTP.js

@@ -1,23 +1,23 @@
-"use strict";
-exports.__esModule = true;
-exports.HttpStatus = void 0;
-/**
- * The different types of http status codes
- *
- * @internal
- */
-var HttpStatus;
-(function (HttpStatus) {
-    HttpStatus[HttpStatus["BadRequest"] = 400] = "BadRequest";
-    HttpStatus[HttpStatus["Unauthorized"] = 401] = "Unauthorized";
-    HttpStatus[HttpStatus["Forbidden"] = 403] = "Forbidden";
-    HttpStatus[HttpStatus["NotFound"] = 404] = "NotFound";
-    HttpStatus[HttpStatus["MethodNotAllowed"] = 405] = "MethodNotAllowed";
-    HttpStatus[HttpStatus["RequestTimeout"] = 408] = "RequestTimeout";
-    HttpStatus[HttpStatus["TooManyRequests"] = 429] = "TooManyRequests";
-    HttpStatus[HttpStatus["InternalServerError"] = 500] = "InternalServerError";
-    HttpStatus[HttpStatus["BadGateway"] = 502] = "BadGateway";
-    HttpStatus[HttpStatus["ServiceUnavailable"] = 503] = "ServiceUnavailable";
-})(HttpStatus = exports.HttpStatus || (exports.HttpStatus = {}));
-;
+"use strict";
+exports.__esModule = true;
+exports.HttpStatus = void 0;
+/**
+ * The different types of http status codes
+ *
+ * @internal
+ */
+var HttpStatus;
+(function (HttpStatus) {
+    HttpStatus[HttpStatus["BadRequest"] = 400] = "BadRequest";
+    HttpStatus[HttpStatus["Unauthorized"] = 401] = "Unauthorized";
+    HttpStatus[HttpStatus["Forbidden"] = 403] = "Forbidden";
+    HttpStatus[HttpStatus["NotFound"] = 404] = "NotFound";
+    HttpStatus[HttpStatus["MethodNotAllowed"] = 405] = "MethodNotAllowed";
+    HttpStatus[HttpStatus["RequestTimeout"] = 408] = "RequestTimeout";
+    HttpStatus[HttpStatus["TooManyRequests"] = 429] = "TooManyRequests";
+    HttpStatus[HttpStatus["InternalServerError"] = 500] = "InternalServerError";
+    HttpStatus[HttpStatus["BadGateway"] = 502] = "BadGateway";
+    HttpStatus[HttpStatus["ServiceUnavailable"] = 503] = "ServiceUnavailable";
+})(HttpStatus = exports.HttpStatus || (exports.HttpStatus = {}));
+;
 //# sourceMappingURL=HTTP.js.map

package/dist/graphql/enums/Errors.d.ts

@@ -1,21 +1,21 @@
-/**
- * Different types error messages for validation errors returned by GraphQL API.
- *
- * @public
- */
-export declare enum ValidationErrors {
-    NoUserIdentification = "Either userName or id must be given"
-}
-/**
- * Different type of error messages related to data that are returned by GraphQL API.
- *
- * @public
- */
-export declare enum DataErrors {
-    NoTweetsFound = "No tweets matching the given criteria found",
-    NoLikersFound = "No likers found for the tweet with the given id",
-    NoRetweetersFound = "No retweeters found for the tweet with the given id",
-    NoUserTweetsFound = "No tweets were found for the user with the given id",
-    NoFollowsFound = "No follow details were found for the user with the given id",
-    NoLikedTweetsFound = "No liked tweets were found for the user with the given id"
-}
+/**
+ * Different types error messages for validation errors returned by GraphQL API.
+ *
+ * @public
+ */
+export declare enum ValidationErrors {
+    NoUserIdentification = "Either userName or id must be given"
+}
+/**
+ * Different type of error messages related to data that are returned by GraphQL API.
+ *
+ * @public
+ */
+export declare enum DataErrors {
+    NoTweetsFound = "No tweets matching the given criteria found",
+    NoLikersFound = "No likers found for the tweet with the given id",
+    NoRetweetersFound = "No retweeters found for the tweet with the given id",
+    NoUserTweetsFound = "No tweets were found for the user with the given id",
+    NoFollowsFound = "No follow details were found for the user with the given id",
+    NoLikedTweetsFound = "No liked tweets were found for the user with the given id"
+}

package/dist/graphql/enums/Errors.js

@@ -1,29 +1,29 @@
-"use strict";
-exports.__esModule = true;
-exports.DataErrors = exports.ValidationErrors = void 0;
-/**
- * Different types error messages for validation errors returned by GraphQL API.
- *
- * @public
- */
-var ValidationErrors;
-(function (ValidationErrors) {
-    ValidationErrors["NoUserIdentification"] = "Either userName or id must be given";
-})(ValidationErrors = exports.ValidationErrors || (exports.ValidationErrors = {}));
-;
-/**
- * Different type of error messages related to data that are returned by GraphQL API.
- *
- * @public
- */
-var DataErrors;
-(function (DataErrors) {
-    DataErrors["NoTweetsFound"] = "No tweets matching the given criteria found";
-    DataErrors["NoLikersFound"] = "No likers found for the tweet with the given id";
-    DataErrors["NoRetweetersFound"] = "No retweeters found for the tweet with the given id";
-    DataErrors["NoUserTweetsFound"] = "No tweets were found for the user with the given id";
-    DataErrors["NoFollowsFound"] = "No follow details were found for the user with the given id";
-    DataErrors["NoLikedTweetsFound"] = "No liked tweets were found for the user with the given id";
-})(DataErrors = exports.DataErrors || (exports.DataErrors = {}));
-;
+"use strict";
+exports.__esModule = true;
+exports.DataErrors = exports.ValidationErrors = void 0;
+/**
+ * Different types error messages for validation errors returned by GraphQL API.
+ *
+ * @public
+ */
+var ValidationErrors;
+(function (ValidationErrors) {
+    ValidationErrors["NoUserIdentification"] = "Either userName or id must be given";
+})(ValidationErrors = exports.ValidationErrors || (exports.ValidationErrors = {}));
+;
+/**
+ * Different type of error messages related to data that are returned by GraphQL API.
+ *
+ * @public
+ */
+var DataErrors;
+(function (DataErrors) {
+    DataErrors["NoTweetsFound"] = "No tweets matching the given criteria found";
+    DataErrors["NoLikersFound"] = "No likers found for the tweet with the given id";
+    DataErrors["NoRetweetersFound"] = "No retweeters found for the tweet with the given id";
+    DataErrors["NoUserTweetsFound"] = "No tweets were found for the user with the given id";
+    DataErrors["NoFollowsFound"] = "No follow details were found for the user with the given id";
+    DataErrors["NoLikedTweetsFound"] = "No liked tweets were found for the user with the given id";
+})(DataErrors = exports.DataErrors || (exports.DataErrors = {}));
+;
 //# sourceMappingURL=Errors.js.map

package/dist/graphql/queries/RootQuery.d.ts

@@ -1,4 +1,4 @@
-import { GraphQLObjectType } from 'graphql';
-export declare const rootQuery: GraphQLObjectType<any, any, {
-    [key: string]: any;
-}>;
+import { GraphQLObjectType } from 'graphql';
+export declare const rootQuery: GraphQLObjectType<any, any, {
+    [key: string]: any;
+}>;