nuxt-graphql-middleware 2.0.3 → 2.1.2

package/README.md

@@ -246,6 +246,11 @@ export default (pluginContext) => {
 You have access to the context via the first parameter. The second parameter
 provides the fetch options, which you have to return.
 
+It's also possible to return a Promise, useful if you need to handle things
+like a token refresh. Be aware that this method is called before every query or
+mutation request, so make sure it doesn't take too much time.
+
+
 ### Integrate with nuxt-auth
 
 Add a `beforeRequest` method in a custom plugin:

package/dist/module.mjs

@@ -146,7 +146,7 @@ function codegen(graphqlServer, options) {
           plugins: [{ "schema-ast": configSchemaAst }],
           config: configSchemaAst
         },
-        [path.resolve(options.typesOutputPath, "graphql-schema.d.ts")]: {
+        [path.resolve(options.typesOutputPath, "graphql-schema.ts")]: {
           plugins: [{ typescript: typescriptConfig }],
           config: typescriptConfig
         }
@@ -156,14 +156,15 @@ function codegen(graphqlServer, options) {
   function generateTypes() {
     const config = {
       ...typescriptConfig,
-      onlyOperationTypes: true
+      onlyOperationTypes: true,
+      ...options.schemaOptions || {}
     };
     return generate({
       schema: schemaPath,
       pluginLoader,
       documents: path.resolve(options.resolvedQueriesPath, "./*.graphql"),
       generates: {
-        [path.resolve(options.typesOutputPath, "graphql-operations.d.ts")]: {
+        [path.resolve(options.typesOutputPath, "graphql-operations.ts")]: {
           plugins: ["typescript", { "typescript-operations": config }],
           config
         }

package/dist/plugin.mjs

@@ -21,6 +21,11 @@ class GraphqlMiddlewarePlugin {
   beforeRequest(fn) {
     this.beforeRequestFn = fn;
   }
+  clearCache() {
+    if (this.cache) {
+      this.cache.clear();
+    }
+  }
   query(name, variables, headers = {}) {
     const params = new URLSearchParams({
       name,
@@ -32,7 +37,7 @@ class GraphqlMiddlewarePlugin {
       return Promise.resolve(this.cache.get(url));
     }
     log("query", url, "Fetching");
-    let fetchOptions = {
+    const defaultOptions = {
       method: "GET",
       credentials: "include",
       headers: {
@@ -42,28 +47,33 @@ class GraphqlMiddlewarePlugin {
         ...this.getPluginHeaderValue()
       }
     };
-    if (this.beforeRequestFn) {
-      fetchOptions = this.beforeRequestFn(this.context, fetchOptions);
-    }
-    return fetch(url, fetchOptions).then((response) => {
-      if (response.ok) {
-        return response.json();
-      }
-      throw new Error("Server Error");
-    }).then((data) => {
-      if (this.cache && this.cache.size > 30) {
-        const key = this.cache.keys().next().value;
-        this.cache.delete(key);
-      }
-      this.cache?.set(url, data);
-      return data;
+    return this.doBeforeRequest(defaultOptions).then((fetchOptions) => {
+      return fetch(url, fetchOptions).then((response) => {
+        if (response.ok) {
+          return response.json();
+        }
+        throw new Error("Server Error");
+      }).then((data) => {
+        if (this.cache && this.cache.size > 30) {
+          const key = this.cache.keys().next().value;
+          this.cache.delete(key);
+        }
+        this.cache?.set(url, data);
+        return data;
+      });
     });
   }
+  doBeforeRequest(fetchOptions) {
+    if (!this.beforeRequestFn) {
+      return Promise.resolve(fetchOptions);
+    }
+    return Promise.resolve(this.beforeRequestFn(this.context, fetchOptions));
+  }
   mutate(name, variables, headers = {}) {
     const params = new URLSearchParams({
       name
     });
-    let fetchOptions = {
+    let defaultOptions = {
       method: "POST",
       credentials: "include",
       headers: {
@@ -74,10 +84,9 @@ class GraphqlMiddlewarePlugin {
       },
       body: JSON.stringify(variables)
     };
-    if (this.beforeRequestFn) {
-      fetchOptions = this.beforeRequestFn(this.context, fetchOptions);
-    }
-    return fetch(this.baseURL + "/mutate?" + params.toString(), fetchOptions).then((response) => response.json());
+    return this.doBeforeRequest(defaultOptions).then((fetchOptions) => {
+      return fetch(this.baseURL + "/mutate?" + params.toString(), fetchOptions).then((response) => response.json());
+    });
   }
 }
 const graphqlMiddlewarePlugin = (context, inject) => {

package/dist/types/codegen.d.ts

@@ -0,0 +1,13 @@
+export interface GraphqlMiddlewareCodegenConfig {
+    enabled?: boolean;
+    skipSchemaDownload?: boolean;
+    resolvedQueriesPath: string;
+    schemaOutputPath: string;
+    typesOutputPath: string;
+    schemaOptions: any;
+}
+export default function (graphqlServer: string, options: GraphqlMiddlewareCodegenConfig): {
+    generateSchema: () => Promise<any>;
+    generateTypes: () => Promise<any>;
+};
+//# sourceMappingURL=codegen.d.ts.map

package/dist/types/codegen.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"codegen.d.ts","sourceRoot":"","sources":["../../src/codegen.ts"],"names":[],"mappings":"AAsBA,MAAM,WAAW,8BAA8B;IAC7C,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B,mBAAmB,EAAE,MAAM,CAAA;IAC3B,gBAAgB,EAAE,MAAM,CAAA;IACxB,eAAe,EAAE,MAAM,CAAA;IACvB,aAAa,EAAE,GAAG,CAAA;CACnB;AAED,MAAM,CAAC,OAAO,WACZ,aAAa,EAAE,MAAM,EACrB,OAAO,EAAE,8BAA8B;;;EAoDxC"}

package/dist/types/graphqlImport.d.ts

@@ -0,0 +1,2 @@
+export default function (path: string, resolver: any): any;
+//# sourceMappingURL=graphqlImport.d.ts.map

package/dist/types/graphqlImport.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"graphqlImport.d.ts","sourceRoot":"","sources":["../../src/graphqlImport.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,OAAO,WAAW,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,OASnD"}

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from './module';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA"}

package/dist/types/module.d.ts

@@ -0,0 +1,18 @@
+import { Module } from '@nuxt/types';
+import { GraphqlMiddlewarePluginConfig } from './templates/plugin';
+import { GraphqlServerMiddlewareConfig } from './serverMiddleware';
+import { GraphqlMiddlewareCodegenConfig } from './codegen';
+export interface GraphqlMiddlewareConfig {
+    graphqlServer: string;
+    typescript?: GraphqlMiddlewareCodegenConfig;
+    endpointNamespace?: string;
+    debug: boolean;
+    queries: Record<string, string>;
+    mutations: Record<string, string>;
+    outputPath: string;
+    plugin?: GraphqlMiddlewarePluginConfig;
+    server?: GraphqlServerMiddlewareConfig;
+}
+declare const graphqlMiddleware: Module;
+export default graphqlMiddleware;
+//# sourceMappingURL=module.d.ts.map

package/dist/types/module.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"module.d.ts","sourceRoot":"","sources":["../../src/module.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAEpC,OAAO,EAAE,6BAA6B,EAAE,MAAM,oBAAoB,CAAA;AAClE,OAAyB,EACvB,6BAA6B,EAC9B,MAAM,oBAAoB,CAAA;AAE3B,OAAgB,EAAE,8BAA8B,EAAE,MAAM,WAAW,CAAA;AAMnE,MAAM,WAAW,uBAAuB;IACtC,aAAa,EAAE,MAAM,CAAA;IACrB,UAAU,CAAC,EAAE,8BAA8B,CAAA;IAC3C,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,KAAK,EAAE,OAAO,CAAA;IACd,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACjC,UAAU,EAAE,MAAM,CAAA;IAClB,MAAM,CAAC,EAAE,6BAA6B,CAAA;IACtC,MAAM,CAAC,EAAE,6BAA6B,CAAA;CACvC;AAiED,QAAA,MAAM,iBAAiB,EAAE,MAgKxB,CAAA;AAED,eAAe,iBAAiB,CAAA"}

package/dist/types/serverMiddleware.d.ts

@@ -0,0 +1,13 @@
+import { Request, RequestHandler } from 'express';
+export interface GraphqlServerMiddlewareConfig {
+    middleware?: RequestHandler;
+    fetchOptions?: any;
+    buildHeaders?: (req: Request, name: string, type: string) => any;
+    buildEndpoint?: (req: Request) => string;
+    onQueryResponse?: any;
+    onQueryError?: any;
+    onMutationResponse?: any;
+    onMutationError?: any;
+}
+export default function createServerMiddleware(graphqlServer: string, queries: Map<string, any>, mutations: Map<string, any>, config?: GraphqlServerMiddlewareConfig): import("express-serve-static-core").Express;
+//# sourceMappingURL=serverMiddleware.d.ts.map

package/dist/types/serverMiddleware.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"serverMiddleware.d.ts","sourceRoot":"","sources":["../../src/serverMiddleware.ts"],"names":[],"mappings":"AAAA,OAAgB,EAAE,OAAO,EAAE,cAAc,EAAY,MAAM,SAAS,CAAA;AAcpE,MAAM,WAAW,6BAA6B;IAC5C,UAAU,CAAC,EAAE,cAAc,CAAA;IAC3B,YAAY,CAAC,EAAE,GAAG,CAAA;IAClB,YAAY,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,GAAG,CAAA;IAChE,aAAa,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,MAAM,CAAA;IACxC,eAAe,CAAC,EAAE,GAAG,CAAA;IACrB,YAAY,CAAC,EAAE,GAAG,CAAA;IAClB,kBAAkB,CAAC,EAAE,GAAG,CAAA;IACxB,eAAe,CAAC,EAAE,GAAG,CAAA;CACtB;AAkBD,MAAM,CAAC,OAAO,UAAU,sBAAsB,CAC5C,aAAa,EAAE,MAAM,EACrB,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,EACzB,SAAS,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,EAC3B,MAAM,CAAC,EAAE,6BAA6B,+CA0FvC"}

package/dist/types/templates/plugin.d.ts

@@ -0,0 +1,26 @@
+import { Context, Plugin } from '@nuxt/types';
+export interface GraphqlMiddlewarePluginConfig {
+    enabled?: boolean;
+    port?: number;
+    cacheInBrowser?: boolean;
+    cacheInServer?: boolean;
+}
+export declare class GraphqlMiddlewarePlugin {
+    baseURL: string;
+    headers: any;
+    beforeRequestFn: Function | undefined;
+    cache?: Map<string, any>;
+    context: any;
+    constructor(baseURL: string, headers: any, useCache: boolean, context: Context);
+    getPluginHeaderValue(): {
+        'Nuxt-Graphql-Middleware-Route': any;
+    };
+    beforeRequest(fn: Function): void;
+    clearCache(): void;
+    query(name: string, variables?: any, headers?: any): Promise<any>;
+    doBeforeRequest(fetchOptions: Record<string, any>): Promise<any>;
+    mutate(name: string, variables?: any, headers?: any): Promise<any>;
+}
+declare const graphqlMiddlewarePlugin: Plugin;
+export default graphqlMiddlewarePlugin;
+//# sourceMappingURL=plugin.d.ts.map

package/dist/types/templates/plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../../src/templates/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAW7C,MAAM,WAAW,6BAA6B;IAC5C,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,aAAa,CAAC,EAAE,OAAO,CAAA;CACxB;AAED,qBAAa,uBAAuB;IAClC,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,GAAG,CAAA;IACZ,eAAe,EAAE,QAAQ,GAAG,SAAS,CAAA;IACrC,KAAK,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IACxB,OAAO,EAAE,GAAG,CAAA;gBAGV,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,GAAG,EACZ,QAAQ,EAAE,OAAO,EACjB,OAAO,EAAE,OAAO;IAUlB,oBAAoB;;;IAMpB,aAAa,CAAC,EAAE,EAAE,QAAQ;IAI1B,UAAU;IASV,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,GAAG,EAAE,OAAO,GAAE,GAAQ;IA+CtD,eAAe,CAAC,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAWjD,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,GAAG,EAAE,OAAO,GAAE,GAAQ;CAuBxD;AAED,QAAA,MAAM,uBAAuB,EAAE,MAyB9B,CAAA;AAED,eAAe,uBAAuB,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-graphql-middleware",
-  "version": "2.0.3",
+  "version": "2.1.2",
   "description": "Module to perform GraphQL requests as a server middleware.",
   "repository": {
     "type": "git",
@@ -26,7 +26,8 @@
     "module.cjs",
     "dist/*.js",
     "dist/*.mjs",
-    "dist/*.d.ts"
+    "dist/*.d.ts",
+    "dist/types/*"
   ],
   "scripts": {
     "build": "unbuild && npm run generate-types",
@@ -41,14 +42,14 @@
     "@graphql-codegen/typescript-operations": "^2.2.1",
     "@graphql-fragment-import/lib": "^1.2.0",
     "express": "^4.17.1",
-    "graphql": "^15.6.0",
+    "graphql": "^16.0.1",
     "graphql-request": "^3.6.1"
   },
   "devDependencies": {
     "@nuxt/types": "^2.15.8",
     "@nuxtjs/eslint-config-typescript": "latest",
     "@types/mkdirp": "^1.0.2",
-    "@types/node": "^16.11.9",
+    "@types/node": "^16.11.10",
     "consola": "^2.15.3",
     "eslint": "latest",
     "eslint-config-prettier": "latest",
@@ -56,7 +57,7 @@
     "mkdirp": "^1.0.4",
     "mkdist": "latest",
     "nuxt": "^2.15.8",
-    "prettier": "^2.4.1",
+    "prettier": "^2.5.0",
     "typescript": "^4.5.2",
     "unbuild": "^0.5.13",
     "vue": "^2.6.14"

package/types/index.d.ts

@@ -24,3 +24,9 @@ declare module '@nuxt/types' {
     graphqlMiddleware?: GraphqlMiddlewareConfig
   }
 }
+
+declare module '@nuxt/schema' {
+  interface NuxtConfig {
+    graphqlMiddleware?: GraphqlMiddlewareConfig
+  }
+}