@fxhash/gql-client 0.0.1

package/README.md

@@ -0,0 +1,39 @@
+# `@fxhash/gql-client`
+
+The gql-client provides a simple GraphQL client which can be used with `@fxhash/gql` for running typed operations. The client works on front-ends and back-ends, although using a different package for front-end application would be best as this one doesn't come with the best-in-class toolkit for front-end applications.
+
+This package wraps [`@urql/core`](https://www.npmjs.com/package/@urql/core) by providing some default config working well with our stack.
+
+> **Note**
+>
+> - The client will automatically add the `x-hasura-admin-secret` http header if the env variable `HASURA_ADMIN_SECRET` is defined.
+> - The client will point to the hasura api scoped to the environment in which it's executed, based on `FXHASH_ENV` env variable (it uses the generic `@fxhash/config` package for such purpose)
+
+## Usage
+
+Install
+
+```sh
+pnpm add -E @fxhash/gql-client
+```
+
+Usage
+
+```ts
+import { gqlClient } from "@fxhash/gql-client"
+
+// making a query
+const { data, error } = await gqlClient.query(...)
+```
+
+## Client instanciation
+
+If needed, instanciating a client with custom options is available. The client will not automatically add the `x-hasura-admin-secret` header, it must be passed with the `hasuraAdminSecret` option.
+
+```ts
+import { createGqlClient } from "@fxhash/gql-client"
+
+const client = createGqlClient({
+  //... custom options here
+})
+```

package/dist/index.d.ts

@@ -0,0 +1,25 @@
+import { Client, ClientOptions } from '@urql/core';
+export { Client } from '@urql/core';
+
+type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
+type CreateHasuraClientOptions = Optional<ClientOptions, "exchanges" | "url"> & {
+    hasuraAdminSecret?: string;
+};
+/**
+ * Instanciates a new graphql client (using `@urql/core`), configuring a http
+ * header for authenticating the client against hasura if provided.
+ * @param hasuraAdminSecret The admin secret for hasura
+ * @returns @urql/core client
+ */
+declare function createGqlClient(options: CreateHasuraClientOptions): Client;
+/**
+ * Default hasura client instanciated with "best option" as a default. If
+ * `process.env.HASURA_ADMIN_SECRET` is defined, a header will be added with
+ * the hasura admin secret.
+ *
+ * @remark The function createHasuraClient() should be used if the default
+ * client instanciated is not suited.
+ */
+declare const gqlClient: Client;
+
+export { type CreateHasuraClientOptions, createGqlClient, gqlClient as default, gqlClient };

package/dist/index.js

@@ -0,0 +1,51 @@
+// src/index.ts
+import { config } from "@fxhash/config";
+import { Client, fetchExchange } from "@urql/core";
+import deepmerge from "deepmerge";
+var defaultClientOptions = {
+  url: config.apis.hasuraGql,
+  exchanges: [fetchExchange],
+  fetchOptions: {
+    headers: {},
+    credentials: "include"
+  }
+};
+function createGqlClient(options) {
+  const addHasuraAdminSecretHeaders = (reqInit) => {
+    if (options.hasuraAdminSecret) {
+      if (!reqInit.headers) {
+        reqInit.headers = {};
+      }
+      ;
+      reqInit.headers["x-hasura-admin-secret"] = options.hasuraAdminSecret;
+    }
+    return reqInit;
+  };
+  const _fetchOptions = options.fetchOptions;
+  delete options.fetchOptions;
+  const _options = deepmerge(defaultClientOptions, options);
+  if (typeof _fetchOptions === "function") {
+    _options.fetchOptions = () => {
+      return addHasuraAdminSecretHeaders({
+        ...defaultClientOptions.fetchOptions,
+        ..._fetchOptions()
+      });
+    };
+  } else {
+    _options.fetchOptions = addHasuraAdminSecretHeaders({
+      ...defaultClientOptions.fetchOptions,
+      ..._fetchOptions
+    });
+  }
+  return new Client(_options);
+}
+var gqlClient = createGqlClient({
+  hasuraAdminSecret: process.env.HASURA_ADMIN_SECRET
+});
+var index_default = gqlClient;
+export {
+  createGqlClient,
+  index_default as default,
+  gqlClient
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { config } from \"@fxhash/config\"\nimport { Client, ClientOptions, fetchExchange } from \"@urql/core\"\nimport deepmerge from \"deepmerge\"\n\nconst defaultClientOptions: ClientOptions = {\n  url: config.apis.hasuraGql,\n  exchanges: [fetchExchange],\n  fetchOptions: {\n    headers: {},\n    credentials: \"include\",\n  },\n}\n\ntype Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>\n\nexport type CreateHasuraClientOptions = Optional<\n  ClientOptions,\n  \"exchanges\" | \"url\"\n> & {\n  hasuraAdminSecret?: string\n}\n\n/**\n * Instanciates a new graphql client (using `@urql/core`), configuring a http\n * header for authenticating the client against hasura if provided.\n * @param hasuraAdminSecret The admin secret for hasura\n * @returns @urql/core client\n */\nexport function createGqlClient(options: CreateHasuraClientOptions) {\n  const addHasuraAdminSecretHeaders = (reqInit: RequestInit) => {\n    if (options.hasuraAdminSecret) {\n      if (!reqInit.headers) {\n        reqInit.headers = {}\n      }\n      ;(reqInit as any).headers[\"x-hasura-admin-secret\"] =\n        options.hasuraAdminSecret\n    }\n    return reqInit\n  }\n\n  const _fetchOptions = options.fetchOptions\n  delete options.fetchOptions\n  const _options = deepmerge(defaultClientOptions, options)\n\n  if (typeof _fetchOptions === \"function\") {\n    _options.fetchOptions = () => {\n      return addHasuraAdminSecretHeaders({\n        ...defaultClientOptions.fetchOptions,\n        ..._fetchOptions(),\n      })\n    }\n  } else {\n    _options.fetchOptions = addHasuraAdminSecretHeaders({\n      ...defaultClientOptions.fetchOptions,\n      ..._fetchOptions,\n    })\n  }\n\n  return new Client(_options)\n}\n\n/**\n * Default hasura client instanciated with \"best option\" as a default. If\n * `process.env.HASURA_ADMIN_SECRET` is defined, a header will be added with\n * the hasura admin secret.\n *\n * @remark The function createHasuraClient() should be used if the default\n * client instanciated is not suited.\n */\nexport const gqlClient = createGqlClient({\n  hasuraAdminSecret: process.env.HASURA_ADMIN_SECRET,\n})\nexport default gqlClient\n\n/**\n * Export utility types from `@urql/core`\n */\nexport { type Client } from \"@urql/core\"\n"],"mappings":";AAAA,SAAS,cAAc;AACvB,SAAS,QAAuB,qBAAqB;AACrD,OAAO,eAAe;AAEtB,IAAM,uBAAsC;AAAA,EAC1C,KAAK,OAAO,KAAK;AAAA,EACjB,WAAW,CAAC,aAAa;AAAA,EACzB,cAAc;AAAA,IACZ,SAAS,CAAC;AAAA,IACV,aAAa;AAAA,EACf;AACF;AAiBO,SAAS,gBAAgB,SAAoC;AAClE,QAAM,8BAA8B,CAAC,YAAyB;AAC5D,QAAI,QAAQ,mBAAmB;AAC7B,UAAI,CAAC,QAAQ,SAAS;AACpB,gBAAQ,UAAU,CAAC;AAAA,MACrB;AACA;AAAC,MAAC,QAAgB,QAAQ,uBAAuB,IAC/C,QAAQ;AAAA,IACZ;AACA,WAAO;AAAA,EACT;AAEA,QAAM,gBAAgB,QAAQ;AAC9B,SAAO,QAAQ;AACf,QAAM,WAAW,UAAU,sBAAsB,OAAO;AAExD,MAAI,OAAO,kBAAkB,YAAY;AACvC,aAAS,eAAe,MAAM;AAC5B,aAAO,4BAA4B;AAAA,QACjC,GAAG,qBAAqB;AAAA,QACxB,GAAG,cAAc;AAAA,MACnB,CAAC;AAAA,IACH;AAAA,EACF,OAAO;AACL,aAAS,eAAe,4BAA4B;AAAA,MAClD,GAAG,qBAAqB;AAAA,MACxB,GAAG;AAAA,IACL,CAAC;AAAA,EACH;AAEA,SAAO,IAAI,OAAO,QAAQ;AAC5B;AAUO,IAAM,YAAY,gBAAgB;AAAA,EACvC,mBAAmB,QAAQ,IAAI;AACjC,CAAC;AACD,IAAO,gBAAQ;","names":[]}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@fxhash/gql-client",
+  "version": "0.0.1",
+  "author": "fxhash",
+  "dependencies": {
+    "@urql/core": "4.1.4",
+    "deepmerge": "4.3.1",
+    "graphql": "16.10.0",
+    "@fxhash/config": "0.0.10"
+  },
+  "devDependencies": {
+    "@types/node": "20.11.30",
+    "tsup": "8.4.0",
+    "typescript": "5.8.2",
+    "@fxhash/tsconfig": "0.0.1"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": "fxhash/fxhash-package",
+  "type": "module",
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch"
+  }
+}