rettiwt-api 1.4.0 → 2.0.0

package/.eslintignore

@@ -0,0 +1,3 @@
+node_modules/
+dist/
+docs/

package/.eslintrc.js

@@ -0,0 +1,54 @@
+module.exports = {
+	parser: '@typescript-eslint/parser',
+	parserOptions: {
+		project: 'tsconfig.json',
+		tsconfigRootDir: __dirname,
+		sourceType: 'module',
+	},
+	plugins: ['@typescript-eslint/eslint-plugin', 'eslint-plugin-tsdoc'],
+	extends: ['plugin:@typescript-eslint/recommended', 'plugin:@typescript-eslint/recommended-requiring-type-checking'],
+	root: true,
+	env: {
+		node: true,
+		jest: true,
+	},
+	ignorePatterns: ['.eslintrc.js'],
+	rules: {
+		'@typescript-eslint/naming-convention': [
+			'warn',
+			{
+				selector: ['class'],
+				format: ['PascalCase'],
+			},
+			{
+				selector: 'interface',
+				format: ['PascalCase'],
+				prefix: ['I'],
+			},
+			{
+				selector: 'enum',
+				format: ['PascalCase'],
+				prefix: ['E'],
+			},
+			{
+				selector: ['variableLike', 'memberLike'],
+				format: ['camelCase'],
+			},
+			{
+				selector: 'enumMember',
+				format: ['UPPER_CASE'],
+			},
+		],
+		'@typescript-eslint/explicit-function-return-type': 'error',
+		'@typescript-eslint/explicit-module-boundary-types': 'error',
+		'@typescript-eslint/no-explicit-any': 'warn',
+		'@typescript-eslint/no-extraneous-class': [
+			'warn',
+			{
+				allowEmpty: true,
+			},
+		],
+		'@typescript-eslint/no-inferrable-types': 'off',
+		'tsdoc/syntax': 'warn',
+	},
+};

package/.github/workflows/documentation.yml

@@ -1,27 +1,47 @@
 name: Documentation
 run-name: Building the documentation for the release
+
 on:
     push:
         branches: release
 
 jobs:
-    documentation:
+    # Builds and packages the documentation
+    build:
         runs-on: ubuntu-latest
-        permissions:
-            contents: write
         steps:
+            # Setting up Node
             - uses: actions/checkout@v3
             - uses: actions/setup-node@v3
               with:
                   node-version: '18.x'
+
             # Installing dependencies
             - run: yarn
-
-            # Generating documentations
             - run: npx typedoc src/index.ts
 
-            # Commiting the documentations
-            - uses: stefanzweifel/git-auto-commit-action@v4
+            # Packaging the static site as artifact
+            - uses: actions/upload-pages-artifact@v2
               with:
-                  commit_message: Updated documentations
-                  branch: release
+                  path: ./docs
+
+    # Deploys the packaged documentation
+    deploy:
+        # Building and packaging the documentation
+        needs: build
+
+        # Granting necessary permissions
+        permissions:
+            pages: write
+            id-token: write
+
+        # Setting up GH pages environment
+        environment:
+            name: github-pages
+            url: ${{ steps.deployment.outputs.page_url }}
+
+        runs-on: ubuntu-latest
+        steps:
+            # Deploying to gh pages
+            - id: deployment
+              uses: actions/deploy-pages@v2

package/.github/workflows/publish.yml

@@ -1,6 +1,3 @@
-# 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
 run-name: Publishing the package to NPM
 
@@ -9,16 +6,24 @@ on:
         types: [created]
 
 jobs:
+    # Packages and publishes the package to NPM
     publish-npm:
         runs-on: ubuntu-latest
         steps:
+            # Setting up Node
             - uses: actions/checkout@v3
             - uses: actions/setup-node@v3
               with:
                   node-version: '18.x'
                   registry-url: https://registry.npmjs.org/
+
+            # Installing dependencies
             - run: yarn
+
+            # Building the package
             - run: yarn run build
+
+            # Publishing to NPM
             - run: npm publish
               env:
                   NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/.prettierignore

@@ -0,0 +1,3 @@
+node_modules/
+dist/
+docs/

package/.prettierrc

@@ -0,0 +1,13 @@
+{
+	"arrowParens": "always",
+	"bracketSpacing": true,
+	"endOfLine": "auto",
+	"printWidth": 120,
+	"quoteProps": "consistent",
+	"semi": true,
+	"singleQuote": true,
+	"tabWidth": 4,
+	"trailingComma": "all",
+	"useTabs": true,
+	"vueIndentScriptAndStyle": true
+}

package/README.md

@@ -1,84 +1,82 @@
 # Rettiwt-API
 
-An API for fetching data from TwitterAPI, without any rate limits!
+An API for fetching data from Twitter for free!
 
-#### **This API is not a replacement of official Twitter API, since it does not scale**
+## Prerequisites
 
-#### **It works well for small applications like the one side project you started and are never gonna finish**
+-   NodeJS 18.14.2
+-   A working Twitter account
 
-#### **If you want something that will scale as you application grows, Twitter API is the way to go**
+## Installation
 
-#### **The API can either be used as a GraphQL Server or as a standalone npm library**
+1. Initialize a new Node.JS project using the command `npm init`.
+2. Install the package either via npm or yarn:
+    - For npm, use the command `npm install --save rettiwt-api`
+    - For yarn, use the command `yarn add rettiwt-api`
 
-#### **For complete documentation and API reference, head over to the [documentation](https://rishikant181.github.io/Rettiwt-API/)**
+Although the above process initializes a new project, that is, in fact, not necessary and you may add it to an existing Node.JS project and omit the first step altogether.
 
-## 1. GraphQL Server
+## Getting started
 
-Using the API as a GraphQL enables complex nested queries to fetch data from twitter.  
-To use the API as a server,
+1. Generate credentials using [rettiwt-auth](https://www.npmjs.com/package/rettiwt-auth) package, by following these [steps](https://rishikant181.github.io/Rettiwt-Auth/#md:cli-usage).
+2. Copy the value of the 'cookies' field from the generated credentials and store it somewhere safe. Let's call this our API_KEY.
+3. Create a new instance of Rettiwt, passing in the API key:  
+   `const rettiwt = Rettiwt(API_KEY);`
+4. Use the created [Rettiwt](https://rishikant181.github.io/Rettiwt-API/classes/Rettiwt.html) instance to fetch data from Twitter.
 
-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'
-5.  Make graphql requests to server listening on localhost:port/graphql
+**Note:** The API_KEY (cookie) that we generated, is a very sensitive information and provides all access to the Twitter account. Therefore, it is generally recommended to store it as an environment variable and use it from there.
 
-**You can go to localhost:port/graphql to see the graphql schema**
+## Usage
 
-## 2. NPM Package
+The following examples may help you to get started using the library:
 
-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({
-        <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:**
-
-#### A. GraphQL Server:
-
-1.  Make the following query to the GraphQL server:
+### 1. Getting the details of a target Twitter user
 
 ```
-        query {
-                Login(email: "your_twitter_email", userName: "your_twitter_username", password: "your_twitter_password") {
-                        auth_token
-                        ct0
-                        kdt
-                        twid
-                }
-        }
+// Creating a new Rettiwt instance using the API_KEY
+const rettiwt = Rettiwt(API_KEY);
+
+// Fetching the details of the user whose username is <username>
+rettiwt.user.details('<username>')
+.then(details => {
+	...
+})
+.catch(error => {
+	...
+});
 ```
 
-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:
+### 2. Getting the list of tweets that match a given filter
 
 ```
-        const rettiwt = new Rettiwt({
-                auth_token: "received_auth_token",
-                ct0: "received_ct0_token",
-                kdt: "received_kdt_token",
-                twid: "received_twid_token"
-        });
+// Creating a new Rettiwt instance using the API_KEY
+const rettiwt = Rettiwt(API_KEY);
+
+/**
+ * Fetching the list of tweets that:
+ * 	- are made by a user with username <username>,
+ * 	- contain the words <word1> and <word2>
+ */
+rettiwt.tweet.search({
+	fromUsers: ['<username>'],
+	words: ['<word1>', '<word2>']
+})
+.then(data => {
+	...
+})
+.catch(err => {
+	...
+})
 ```
 
-3.  Use the created [Rettiwt](https://rishikant181.github.io/Rettiwt-API/functions/Rettiwt.html) instance to fetch data.
+For more information regarding the different available filter options, please refer to [TweetFilter](https://rishikant181.github.io/Rettiwt-API/classes/TweetFilter.html).
+
+## API Reference
+
+The complete API reference can be found at [this](https://rishikant181.github.io/Rettiwt-API/) page.
 
-### **Due to changes in Twitter API, all methods now require logging in and using the tokens for authentication**
+## Additional information
 
-### **I'M NOT RESPONSIBLE IF YOU GET YOUR TWITTER ACCOUNT BANNED!**
+-   This API uses the cookies of a Twitter account to fetch data from Twitter and as such, there is always a chance (altough a measly one) of getting the account banned by Twitter algorithm.
+-   From personal experience, not a single one of my accounts has ever been banned by using this library, and this is coming from someone who has been using his primary Twitter account to fetch large amounts of data from Twitter for over 1.5 years now, since the conception of this project.
+-   There have been no reports of accounts getting banned, but you have been warned, even though the chances of getting banned is negligible, it is not zero!

package/dist/Rettiwt.d.ts

@@ -0,0 +1,19 @@
+import { TweetService } from './services/TweetService';
+import { UserService } from './services/UserService';
+/**
+ * The class for fetching data from Twitter.
+ *
+ * @public
+ */
+export declare class Rettiwt {
+    /** The instance used to fetch data related to tweets. */
+    tweet: TweetService;
+    /** The instance used to fetch data related to users. */
+    user: UserService;
+    /**
+     * Initializes a new Rettiwt instance using the given api key.
+     *
+     * @param apiKey - The apiKey (cookie) to be used for authenticating Rettiwt against Twitter.
+     */
+    constructor(apiKey: string);
+}

package/dist/Rettiwt.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Rettiwt = void 0;
+// PACKAGE
+var rettiwt_auth_1 = require("rettiwt-auth");
+// SERVICES
+var TweetService_1 = require("./services/TweetService");
+var UserService_1 = require("./services/UserService");
+/**
+ * The class for fetching data from Twitter.
+ *
+ * @public
+ */
+var Rettiwt = /** @class */ (function () {
+    /**
+     * Initializes a new Rettiwt instance using the given api key.
+     *
+     * @param apiKey - The apiKey (cookie) to be used for authenticating Rettiwt against Twitter.
+     */
+    function Rettiwt(apiKey) {
+        // Preparing auth credentials
+        var cred = new rettiwt_auth_1.AuthCredential(apiKey.split(';'));
+        // Initalizing service instances
+        this.tweet = new TweetService_1.TweetService(cred);
+        this.user = new UserService_1.UserService(cred);
+    }
+    return Rettiwt;
+}());
+exports.Rettiwt = Rettiwt;
+//# sourceMappingURL=Rettiwt.js.map

package/dist/Rettiwt.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Rettiwt.js","sourceRoot":"","sources":["../src/Rettiwt.ts"],"names":[],"mappings":";;;AAAA,UAAU;AACV,6CAA8C;AAE9C,WAAW;AACX,wDAAuD;AACvD,sDAAqD;AAErD;;;;GAIG;AACH;IAOC;;;;OAIG;IACH,iBAAY,MAAc;QACzB,6BAA6B;QAC7B,IAAM,IAAI,GAAmB,IAAI,6BAAc,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;QAEnE,gCAAgC;QAChC,IAAI,CAAC,KAAK,GAAG,IAAI,2BAAY,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,CAAC,IAAI,GAAG,IAAI,yBAAW,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;IACF,cAAC;AAAD,CAAC,AApBD,IAoBC;AApBY,0BAAO"}

package/dist/enums/ApiErrors.d.ts

@@ -0,0 +1,30 @@
+/**
+ * The different types of api error messages.
+ *
+ * @public
+ */
+export declare enum EApiErrors {
+    COULD_NOT_AUTHENTICATE = "Failed to authenticate",
+    RESOURCE_NOT_FOUND = "Requested resource not found",
+    MISSING_PARAMETER = "Missing named parameter",
+    USER_NOT_FOUND = "Requested user not found",
+    USER_SUSPENDED = "Requested user has been suspended",
+    ACCOUNT_SUSPENDED = "Account has been suspended",
+    RATE_LIMIT_EXCEEDED = "Rate limit exceeded",
+    INTERNAL_ERROR = "Internal server error",
+    TIME_ERROR = "Mismatched data/time with server",
+    ALREADY_FAVORITED = "Tweet already favorited",
+    STATUS_NOT_FOUND = "Requested tweeet not found",
+    NOT_AUTHORIZED = "Not authorized to view tweet",
+    DAILY_STATUS_LIMIT_EXCEEDED = "Exceeded daily tweet update limit",
+    TWEET_LENGTH_EXCEEDED = "Exceeded tweet text maximum length",
+    DUPLICATE_STATUS = "Tweet already posted",
+    BAD_AUTHENTICATION = "Invalid authentication data",
+    RESOURCE_NOT_ALLOWED = "Not authorized to access requested resource",
+    AUTOMATED_REQUEST_ERROR = "Automated request detected",
+    ACCOUNT_LOCKED = "Account has been locked",
+    ALREADY_RETWEETED = "Tweet already retweeted",
+    TWEET_NOT_FOUND = "Requested tweet not found",
+    TWEET_VIOLATED_RULES = "Requestd tweet has been removed for rules violation",
+    DISABLED_TWEET_ACTIONS = "Reqeusted action disabled on the tweet"
+}

package/dist/enums/ApiErrors.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EApiErrors = void 0;
+/**
+ * The different types of api error messages.
+ *
+ * @public
+ */
+var EApiErrors;
+(function (EApiErrors) {
+    EApiErrors["COULD_NOT_AUTHENTICATE"] = "Failed to authenticate";
+    EApiErrors["RESOURCE_NOT_FOUND"] = "Requested resource not found";
+    EApiErrors["MISSING_PARAMETER"] = "Missing named parameter";
+    EApiErrors["USER_NOT_FOUND"] = "Requested user not found";
+    EApiErrors["USER_SUSPENDED"] = "Requested user has been suspended";
+    EApiErrors["ACCOUNT_SUSPENDED"] = "Account has been suspended";
+    EApiErrors["RATE_LIMIT_EXCEEDED"] = "Rate limit exceeded";
+    EApiErrors["INTERNAL_ERROR"] = "Internal server error";
+    EApiErrors["TIME_ERROR"] = "Mismatched data/time with server";
+    EApiErrors["ALREADY_FAVORITED"] = "Tweet already favorited";
+    EApiErrors["STATUS_NOT_FOUND"] = "Requested tweeet not found";
+    EApiErrors["NOT_AUTHORIZED"] = "Not authorized to view tweet";
+    EApiErrors["DAILY_STATUS_LIMIT_EXCEEDED"] = "Exceeded daily tweet update limit";
+    EApiErrors["TWEET_LENGTH_EXCEEDED"] = "Exceeded tweet text maximum length";
+    EApiErrors["DUPLICATE_STATUS"] = "Tweet already posted";
+    EApiErrors["BAD_AUTHENTICATION"] = "Invalid authentication data";
+    EApiErrors["RESOURCE_NOT_ALLOWED"] = "Not authorized to access requested resource";
+    EApiErrors["AUTOMATED_REQUEST_ERROR"] = "Automated request detected";
+    EApiErrors["ACCOUNT_LOCKED"] = "Account has been locked";
+    EApiErrors["ALREADY_RETWEETED"] = "Tweet already retweeted";
+    EApiErrors["TWEET_NOT_FOUND"] = "Requested tweet not found";
+    EApiErrors["TWEET_VIOLATED_RULES"] = "Requestd tweet has been removed for rules violation";
+    EApiErrors["DISABLED_TWEET_ACTIONS"] = "Reqeusted action disabled on the tweet";
+})(EApiErrors || (exports.EApiErrors = EApiErrors = {}));
+//# sourceMappingURL=ApiErrors.js.map

package/dist/enums/ApiErrors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiErrors.js","sourceRoot":"","sources":["../../src/enums/ApiErrors.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACH,IAAY,UAwBX;AAxBD,WAAY,UAAU;IACrB,+DAAiD,CAAA;IACjD,iEAAmD,CAAA;IACnD,2DAA6C,CAAA;IAC7C,yDAA2C,CAAA;IAC3C,kEAAoD,CAAA;IACpD,8DAAgD,CAAA;IAChD,yDAA2C,CAAA;IAC3C,sDAAwC,CAAA;IACxC,6DAA+C,CAAA;IAC/C,2DAA6C,CAAA;IAC7C,6DAA+C,CAAA;IAC/C,6DAA+C,CAAA;IAC/C,+EAAiE,CAAA;IACjE,0EAA4D,CAAA;IAC5D,uDAAyC,CAAA;IACzC,gEAAkD,CAAA;IAClD,kFAAoE,CAAA;IACpE,oEAAsD,CAAA;IACtD,wDAA0C,CAAA;IAC1C,2DAA6C,CAAA;IAC7C,2DAA6C,CAAA;IAC7C,0FAA4E,CAAA;IAC5E,+EAAiE,CAAA;AAClE,CAAC,EAxBW,UAAU,0BAAV,UAAU,QAwBrB"}

package/dist/enums/HTTP.d.ts

@@ -3,15 +3,15 @@
  *
  * @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
+export declare enum EHttpStatus {
+    BAD_REQUEST = 400,
+    UNAUTHORIZED = 401,
+    FORBIDDEN = 403,
+    NOT_FOUND = 404,
+    METHOD_NOT_ALLOWED = 405,
+    REQUEST_TIMEOUT = 408,
+    TOO_MANY_REQUESTS = 429,
+    INTERNAL_SERVER_ERROR = 500,
+    BAD_GATEWAY = 502,
+    SERVICE_UNAVAILABLE = 503
 }

package/dist/enums/HTTP.js

@@ -1,23 +1,22 @@
 "use strict";
-exports.__esModule = true;
-exports.HttpStatus = void 0;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EHttpStatus = 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 = {}));
-;
+var EHttpStatus;
+(function (EHttpStatus) {
+    EHttpStatus[EHttpStatus["BAD_REQUEST"] = 400] = "BAD_REQUEST";
+    EHttpStatus[EHttpStatus["UNAUTHORIZED"] = 401] = "UNAUTHORIZED";
+    EHttpStatus[EHttpStatus["FORBIDDEN"] = 403] = "FORBIDDEN";
+    EHttpStatus[EHttpStatus["NOT_FOUND"] = 404] = "NOT_FOUND";
+    EHttpStatus[EHttpStatus["METHOD_NOT_ALLOWED"] = 405] = "METHOD_NOT_ALLOWED";
+    EHttpStatus[EHttpStatus["REQUEST_TIMEOUT"] = 408] = "REQUEST_TIMEOUT";
+    EHttpStatus[EHttpStatus["TOO_MANY_REQUESTS"] = 429] = "TOO_MANY_REQUESTS";
+    EHttpStatus[EHttpStatus["INTERNAL_SERVER_ERROR"] = 500] = "INTERNAL_SERVER_ERROR";
+    EHttpStatus[EHttpStatus["BAD_GATEWAY"] = 502] = "BAD_GATEWAY";
+    EHttpStatus[EHttpStatus["SERVICE_UNAVAILABLE"] = 503] = "SERVICE_UNAVAILABLE";
+})(EHttpStatus || (exports.EHttpStatus = EHttpStatus = {}));
 //# sourceMappingURL=HTTP.js.map

package/dist/enums/HTTP.js.map

@@ -1 +1 @@
-{"version":3,"file":"HTTP.js","sourceRoot":"","sources":["../../src/enums/HTTP.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACH,IAAY,UAWX;AAXD,WAAY,UAAU;IAClB,yDAAgB,CAAA;IAChB,6DAAkB,CAAA;IAClB,uDAAe,CAAA;IACf,qDAAc,CAAA;IACd,qEAAsB,CAAA;IACtB,iEAAoB,CAAA;IACpB,mEAAqB,CAAA;IACrB,2EAAyB,CAAA;IACzB,yDAAgB,CAAA;IAChB,yEAAwB,CAAA;AAC5B,CAAC,EAXW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAWrB;AAAA,CAAC"}
+{"version":3,"file":"HTTP.js","sourceRoot":"","sources":["../../src/enums/HTTP.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACH,IAAY,WAWX;AAXD,WAAY,WAAW;IACtB,6DAAiB,CAAA;IACjB,+DAAkB,CAAA;IAClB,yDAAe,CAAA;IACf,yDAAe,CAAA;IACf,2EAAwB,CAAA;IACxB,qEAAqB,CAAA;IACrB,yEAAuB,CAAA;IACvB,iFAA2B,CAAA;IAC3B,6DAAiB,CAAA;IACjB,6EAAyB,CAAA;AAC1B,CAAC,EAXW,WAAW,2BAAX,WAAW,QAWtB"}

package/dist/helper/JsonUtils.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Search for all the sub-objects (even deep-nested ones) that have the given key-value pair(filter).
+ *
+ * @param data - The data on which search is to be performed.
+ * @param key - The key of the key-value pair to search.
+ * @param value - The value of the key-value pait to search.
+ * @returns The list of sub-objects from the given object, having the given key-value pair.
+ *
+ * @internal
+ */
+export declare function findByFilter<T>(data: NonNullable<unknown>, key: string, value: string): T[];
+/**
+ * @param text - The text to be normalized.
+ * @returns The text after being formatted to remove unnecessary characters.
+ *
+ * @internal
+ */
+export declare function normalizeText(text: string): string;
+/**
+ * Searches for the key which has the given value in the given object.
+ *
+ * @param data - The data on which search is to be performed.
+ * @param value - The value to search.
+ * @returns The key with the given value.
+ */
+export declare function findKeyByValue(data: NonNullable<unknown>, value: string): string | undefined;

package/dist/helper/JsonUtils.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.findKeyByValue = exports.normalizeText = exports.findByFilter = void 0;
+/**
+ * Search for all the sub-objects (even deep-nested ones) that have the given key-value pair(filter).
+ *
+ * @param data - The data on which search is to be performed.
+ * @param key - The key of the key-value pair to search.
+ * @param value - The value of the key-value pait to search.
+ * @returns The list of sub-objects from the given object, having the given key-value pair.
+ *
+ * @internal
+ */
+function findByFilter(data, key, value) {
+    /**
+     * The list containing all the objects matching given filter.
+     */
+    var res = [];
+    /**
+     * If the data is an array, recursively run the function of each element of the array and merge the results.
+     */
+    if (Array.isArray(data)) {
+        /**
+         * findByFilter returns an array.
+         * map() also returns an array.
+         * Therefore, map(item =\> findByFilter(.......)) returns an array of arrays.
+         * Therefore, using ... operator to spread the 2-D array in 1-D array.
+         */
+        res = res.concat.apply(res, data.map(function (item) { return findByFilter(item, key, value); }));
+    }
+    // If the data is an object
+    else if (typeof data == 'object') {
+        /**
+         * If the object includes the key and the value specified by the key matches the filter, add it to the result.
+         */
+        if (Object.keys(data).includes(key) && data[key] == value) {
+            res.push(data);
+        }
+        /**
+         * Recursively run the function on each value specified by each key in the object, for subsequent matches.
+         */
+        for (var _i = 0, _a = Object.entries(data); _i < _a.length; _i++) {
+            var _b = _a[_i], v = _b[1];
+            res = res.concat(findByFilter(v, key, value));
+        }
+    }
+    return res;
+}
+exports.findByFilter = findByFilter;
+/**
+ * @param text - The text to be normalized.
+ * @returns The text after being formatted to remove unnecessary characters.
+ *
+ * @internal
+ */
+function normalizeText(text) {
+    var normalizedText = ''; // To store the normalized text
+    // Removing unnecessary full stops, and other characters
+    normalizedText = text.replace(/\n/g, '.').replace(/[.]+[\s+.\s+]+/g, '. ');
+    // Adding full-stop to the end if does not exist already
+    normalizedText = normalizedText.endsWith('.') ? normalizedText : normalizedText + '.';
+    return normalizedText;
+}
+exports.normalizeText = normalizeText;
+/**
+ * Searches for the key which has the given value in the given object.
+ *
+ * @param data - The data on which search is to be performed.
+ * @param value - The value to search.
+ * @returns The key with the given value.
+ */
+function findKeyByValue(data, value) {
+    // Finding the key-value pairs that have the given value
+    var kvPair = Object.entries(data).filter(function (_a) {
+        var v = _a[1];
+        return v == value;
+    })[0];
+    // If a match is found
+    if (kvPair) {
+        return kvPair[0];
+    }
+    // If no match is found
+    else {
+        return undefined;
+    }
+}
+exports.findKeyByValue = findKeyByValue;
+//# sourceMappingURL=JsonUtils.js.map

package/dist/helper/JsonUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"JsonUtils.js","sourceRoot":"","sources":["../../src/helper/JsonUtils.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;GASG;AACH,SAAgB,YAAY,CAAI,IAA0B,EAAE,GAAW,EAAE,KAAa;IACrF;;OAEG;IACH,IAAI,GAAG,GAAQ,EAAE,CAAC;IAElB;;OAEG;IACH,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QACxB;;;;;WAKG;QACH,GAAG,GAAG,GAAG,CAAC,MAAM,OAAV,GAAG,EAAW,IAAI,CAAC,GAAG,CAAC,UAAC,IAAI,IAAK,OAAA,YAAY,CAAI,IAA4B,EAAE,GAAG,EAAE,KAAK,CAAC,EAAzD,CAAyD,CAAC,CAAC,CAAC;KACnG;IACD,2BAA2B;SACtB,IAAI,OAAO,IAAI,IAAI,QAAQ,EAAE;QACjC;;WAEG;QACH,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,GAAwB,CAAC,IAAI,KAAK,EAAE;YAC/E,GAAG,CAAC,IAAI,CAAC,IAAS,CAAC,CAAC;SACpB;QAED;;WAEG;QACH,KAAoB,UAAoB,EAApB,KAAA,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAApB,cAAoB,EAApB,IAAoB,EAAE;YAA/B,IAAA,WAAK,EAAF,CAAC,QAAA;YACd,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,YAAY,CAAI,CAAyB,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;SACzE;KACD;IAED,OAAO,GAAG,CAAC;AACZ,CAAC;AApCD,oCAoCC;AAED;;;;;GAKG;AACH,SAAgB,aAAa,CAAC,IAAY;IACzC,IAAI,cAAc,GAAW,EAAE,CAAC,CAAC,+BAA+B;IAEhE,wDAAwD;IACxD,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC;IAE3E,wDAAwD;IACxD,cAAc,GAAG,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,cAAc,GAAG,GAAG,CAAC;IAEtF,OAAO,cAAc,CAAC;AACvB,CAAC;AAVD,sCAUC;AAED;;;;;;GAMG;AACH,SAAgB,cAAc,CAAC,IAA0B,EAAE,KAAa;IACvE,wDAAwD;IACxD,IAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,UAAC,EAAK;YAAF,CAAC,QAAA;QAAM,OAAA,CAAC,IAAI,KAAK;IAAV,CAAU,CAAC,CAAC,CAAC,CAAC,CAAC;IAErE,sBAAsB;IACtB,IAAI,MAAM,EAAE;QACX,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC;KACjB;IACD,uBAAuB;SAClB;QACJ,OAAO,SAAS,CAAC;KACjB;AACF,CAAC;AAZD,wCAYC"}