@drupal-api-client/graphql-client 0.1.3

package/LICENSE.md

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Drupal API Client.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,9 @@
+# decoupled-router-client
+
+This package contains the `GraphqlClient` class which extends the base `ApiClient` class from the `@drupal-api-client/api-client` package. See https://www.drupal.org/project/api_client for more information about this project.
+
+## Installation
+
+```shell
+npm install @drupal-api-client/graphql-client
+```

package/dist/index.d.mts

@@ -0,0 +1,36 @@
+import { ApiClient, BaseUrl, ApiClientOptions } from '@drupal-api-client/api-client';
+
+/**
+ * Graphql Client class provides functionality specific to GraphQL servers.
+ * @see {@link ApiClientOptions}
+ * @see {@link BaseUrl}
+ */
+declare class GraphqlClient extends ApiClient {
+    /**
+     * Creates a new instance of the GraphqlClient.
+     * @param baseUrl - The base URL of the API. {@link BaseUrl}
+     * @param options - (Optional) Additional options for configuring the API client. {@link ApiClientOptions}
+     */
+    constructor(baseUrl: BaseUrl, options?: ApiClientOptions);
+    /**
+     * Retrieves data of a specific shape from GraphQL.
+     * @param query - a string containing the desired GraphQL Query.
+     * @returns A Promise that resolves to the requested JSON data.
+     *
+     * @example
+     * ```ts
+     * const query = await graphqlClient.query(
+     * `query GetArticles {
+     *   nodeArticles(first: 10) {
+     *     nodes {
+     *       title
+     *     }
+     *   }
+     * }`,
+     * );
+     * ```
+     */
+    query<T>(query: string): Promise<T>;
+}
+
+export { GraphqlClient };

package/dist/index.d.ts

@@ -0,0 +1,36 @@
+import { ApiClient, BaseUrl, ApiClientOptions } from '@drupal-api-client/api-client';
+
+/**
+ * Graphql Client class provides functionality specific to GraphQL servers.
+ * @see {@link ApiClientOptions}
+ * @see {@link BaseUrl}
+ */
+declare class GraphqlClient extends ApiClient {
+    /**
+     * Creates a new instance of the GraphqlClient.
+     * @param baseUrl - The base URL of the API. {@link BaseUrl}
+     * @param options - (Optional) Additional options for configuring the API client. {@link ApiClientOptions}
+     */
+    constructor(baseUrl: BaseUrl, options?: ApiClientOptions);
+    /**
+     * Retrieves data of a specific shape from GraphQL.
+     * @param query - a string containing the desired GraphQL Query.
+     * @returns A Promise that resolves to the requested JSON data.
+     *
+     * @example
+     * ```ts
+     * const query = await graphqlClient.query(
+     * `query GetArticles {
+     *   nodeArticles(first: 10) {
+     *     nodes {
+     *       title
+     *     }
+     *   }
+     * }`,
+     * );
+     * ```
+     */
+    query<T>(query: string): Promise<T>;
+}
+
+export { GraphqlClient };

package/dist/index.js

@@ -0,0 +1,7 @@
+'use strict';
+
+var apiClient = require('@drupal-api-client/api-client');
+
+var t=class extends apiClient.ApiClient{constructor(s,e){super(s,e);let{apiPrefix:r}=e||{};this.apiPrefix=r||"graphql";}async query(s){let{response:e,error:r}=await this.fetch(`${this.baseUrl}/${this.apiPrefix}`,{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify({query:`${s}`})});if(r)throw this.debug&&this.log("error",`GraphQL query failed, Error: ${r.message}`),r;return await e.json()}};
+
+exports.GraphqlClient = t;

package/dist/index.mjs

@@ -0,0 +1,5 @@
+import { ApiClient } from '@drupal-api-client/api-client';
+
+var t=class extends ApiClient{constructor(s,e){super(s,e);let{apiPrefix:r}=e||{};this.apiPrefix=r||"graphql";}async query(s){let{response:e,error:r}=await this.fetch(`${this.baseUrl}/${this.apiPrefix}`,{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify({query:`${s}`})});if(r)throw this.debug&&this.log("error",`GraphQL query failed, Error: ${r.message}`),r;return await e.json()}};
+
+export { t as GraphqlClient };

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@drupal-api-client/graphql-client",
+  "version": "0.1.3",
+  "license": "MIT",
+  "description": "Client to simplify interacting with Drupal GraphQL APIs",
+  "bugs": "https://www.drupal.org/project/issues/api_client",
+  "repository": {
+    "type": "git",
+    "url": "https://git.drupalcode.org/project/api_client.git",
+    "directory": "packages/graphql-client"
+  },
+  "homepage": "https://project.pages.drupalcode.org/api_client/",
+  "keywords": [
+    "drupal",
+    "graphql"
+  ],
+  "files": [
+    "dist/*"
+  ],
+  "types": "./dist/index.d.ts",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    }
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "^0.13.1",
+    "@vitest/coverage-v8": "^0.34.1",
+    "publint": "^0.2.0",
+    "tsup": "^7.3.0",
+    "vitest": "^0.34.6"
+  },
+  "typedocOptions": {
+    "entryPoints": [
+      "src/index.ts"
+    ],
+    "tsconfig": "./tsconfig.typedoc.json"
+  },
+  "dependencies": {
+    "msw": "2.0.8",
+    "nanostores": "^0.10.2",
+    "@drupal-api-client/api-client": "1.3.0"
+  },
+  "scripts": {
+    "arethetypeswrong": "pnpm attw --pack .",
+    "check:types": "pnpm arethetypeswrong && pnpm publint",
+    "build": "tsup src/index.ts",
+    "test": "vitest run --coverage",
+    "prettier": "prettier --check . --ignore-path ../../.prettierignore",
+    "prettier:fix": "prettier --check . --ignore-path ../../.prettierignore",
+    "eslint": "eslint --ext .ts src --ignore-path ../../.gitignore",
+    "eslint:fix": "eslint --ext .ts src --ignore-path ../../.gitignore --fix"
+  }
+}