anilink-api-wrapper 1.28.0 → 1.29.1

package/README.md

@@ -55,6 +55,20 @@ const aniLink = new AniLink();
 
 AniLink for AniList is divided into two main sections: `anilist.query` and `anilist.mutation`. The `anilist.query` section contains methods for querying data from the AniList API, while the `anilist.mutation` section contains methods for mutating data.
 
+#### Custom Queries and Mutations
+
+If needed there is a custom section `anilist.custom` that allows the user to pass a custom query or mutation to the AniList API.
+
+The method accepts two parameters: the query or mutation string and an optional variables object.
+
+```typescript
+const viewer = await aniLink.anilist.custom('query {Viewer {id}}');
+
+const mutation = 'mutation ($about: String) {UpdateUser (about: $about) {id}}';
+const variables = { about: "New about text" };
+const response = await aniLink.anilist.custom(mutation, variables);
+```
+
 #### Query Methods
 
 The `anilist.query` section is further divided into main query methods and page query methods. The main query methods return a single piece of data, while the page query methods return pages of data.

package/dist/AniLink.js

@@ -72,6 +72,7 @@ const SaveThreadComment_1 = require("./apis/anilist/mutation/SaveThreadComment")
 const DeleteThreadComment_1 = require("./apis/anilist/mutation/DeleteThreadComment");
 const UpdateAniChartSettings_1 = require("./apis/anilist/mutation/UpdateAniChartSettings");
 const UpdateAniChartHighlights_1 = require("./apis/anilist/mutation/UpdateAniChartHighlights");
+const Custom_1 = require("./apis/anilist/Custom");
 /**
  * `AniLink` is a class for interacting with the APIs.
  * It provides methods for querying and mutating data.
@@ -89,6 +90,7 @@ class AniLink {
      * ```
      */
     constructor(authToken) {
+        const customInstance = new Custom_1.CustomRequest(authToken);
         const userQueryInstance = new User_1.UserQuery(authToken);
         const mediaQueryInstance = new Media_1.MediaQuery(authToken);
         const mediaTrendQueryInstance = new MediaTrend_1.MediaTrendQuery(authToken);
@@ -161,6 +163,7 @@ class AniLink {
         const updateAniChartSettingsMutationInstance = new UpdateAniChartSettings_1.UpdateAniChartSettingsMutation(authToken);
         const updateAniChartHighlightsMutationInstance = new UpdateAniChartHighlights_1.UpdateAniChartHighlightsMutation(authToken);
         this.anilist = {
+            custom: customInstance.custom.bind(customInstance),
             query: {
                 user: userQueryInstance.user.bind(userQueryInstance),
                 media: mediaQueryInstance.media.bind(mediaQueryInstance),

package/dist/apis/anilist/Custom.js

@@ -0,0 +1,42 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomRequest = void 0;
+const APIWrapper_1 = require("../../base/APIWrapper");
+const RequestHandler_1 = require("../../base/RequestHandler");
+/**
+ * `CustomRequest` is a class representing a custom query or mutation by the user.
+ */
+class CustomRequest extends APIWrapper_1.APIWrapper {
+    /**
+     * Constructs a new `ActivityQuery` instance.
+     *
+     * @param authToken - The authentication token.
+     */
+    constructor(authToken) {
+        super('https://graphql.anilist.co');
+        this.authToken = authToken;
+    }
+    /**
+     * `custom` is a method that sends a custom query or mutation by the user.
+     *
+     * @param query - The query for the request.
+     * @param variables - The variables for the request. This parameter is optional.
+     * @returns The response from the query request.
+     */
+    custom(query_1) {
+        return __awaiter(this, arguments, void 0, function* (query, variables = {}) {
+            const data = { query, variables };
+            return yield (0, RequestHandler_1.sendRequest)(this.baseURL, 'POST', data, this.authToken);
+        });
+    }
+}
+exports.CustomRequest = CustomRequest;

package/dist/base/ValidateVariables.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateVariables = void 0;
+exports.validateVariables = validateVariables;
 /**
  * Validates the provided variables against the expected types.
  *
@@ -123,4 +123,3 @@ function validateVariables(variables, variableTypeMappings) {
         throw new Error(errors.join('\n'));
     }
 }
-exports.validateVariables = validateVariables;

package/package.json

@@ -1,46 +1,46 @@
-{
-  "name": "anilink-api-wrapper",
-  "version": "1.28.0",
-  "description": "API wrapper for AniManga sites such as Anilist, MyAnimeList, Kitsu.",
-  "main": "dist/AniLink.js",
-  "scripts": {
-    "test": "jest",
-    "build": "rimraf dist && tsc",
-    "generate-docs": "typedoc --entryPoints ./src --entryPointStrategy expand --out docs --plugin typedoc-theme-hierarchy --theme hierarchy && node add-ga.js",
-    "prepublishOnly": "npm run build"
-  },
-  "keywords": [
-    "anilist",
-    "myanimelist",
-    "kitsu",
-    "api",
-    "wrapper",
-    "anilist-api",
-    "anilist-query",
-    "anilist-mutation",
-    "anilist-graphql"
-  ],
-  "author": "RLAlpha49",
-  "license": "MIT",
-  "devDependencies": {
-    "@babel/preset-typescript": "^7.24.1",
-    "@types/jest": "^29.5.12",
-    "babel-jest": "^29.7.0",
-    "dotenv": "^16.4.5",
-    "eslint": "^8.57.0",
-    "eslint-config-standard-with-typescript": "^43.0.1",
-    "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-n": "^15.7.0",
-    "eslint-plugin-promise": "^6.1.1",
-    "jest": "^29.7.0",
-    "rimraf": "^5.0.5",
-    "standard": "^17.1.0",
-    "ts-jest": "^29.1.2",
-    "typedoc": "^0.25.13",
-    "typedoc-theme-hierarchy": "^4.1.2",
-    "typescript": "^5.4.5"
-  },
-  "dependencies": {
-    "axios": "^1.6.8"
-  }
-}
+{
+  "name": "anilink-api-wrapper",
+  "version": "1.29.1",
+  "description": "API wrapper for AniManga sites such as Anilist, MyAnimeList, Kitsu.",
+  "main": "dist/AniLink.js",
+  "scripts": {
+    "test": "jest",
+    "build": "rimraf dist && tsc",
+    "generate-docs": "typedoc --entryPoints ./src --entryPointStrategy expand --out docs --plugin typedoc-theme-hierarchy --theme hierarchy && node add-ga.js",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "anilist",
+    "myanimelist",
+    "kitsu",
+    "api",
+    "wrapper",
+    "anilist-api",
+    "anilist-query",
+    "anilist-mutation",
+    "anilist-graphql"
+  ],
+  "author": "RLAlpha49",
+  "license": "MIT",
+  "devDependencies": {
+    "@babel/preset-typescript": "^7.24.7",
+    "@types/jest": "^29.5.12",
+    "babel-jest": "^29.7.0",
+    "dotenv": "^16.4.5",
+    "eslint": "^8.57.0",
+    "eslint-config-standard-with-typescript": "^43.0.1",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-n": "^16.6.2",
+    "eslint-plugin-promise": "^6.6.0",
+    "jest": "^29.7.0",
+    "rimraf": "^6.0.1",
+    "standard": "^17.1.0",
+    "ts-jest": "^29.2.5",
+    "typedoc": "^0.26.6",
+    "typedoc-theme-hierarchy": "^5.0.3",
+    "typescript": "^5.5.4"
+  },
+  "dependencies": {
+    "axios": "^1.7.5"
+  }
+}