@graphql-box/worker-client 4.1.6 → 5.0.1

package/package.json

@@ -1,62 +1,74 @@
 {
   "name": "@graphql-box/worker-client",
-  "version": "4.1.6",
   "description": "The GraphQL Box web worker client module.",
-  "author": "Dylan Aubrey <dylanaubrey@gmail.com>",
+  "version": "5.0.1",
+  "author": "Dylan Aubrey",
   "license": "MIT",
   "homepage": "https://github.com/badbatch/graphql-box",
-  "bugs": {
-    "url": "https://github.com/badbatch/graphql-box/issues"
-  },
   "repository": {
+    "directory": "packages/worker-client",
     "type": "git",
-    "url": "https://github.com/badbatch/graphql-box",
-    "directory": "packages/worker-client"
+    "url": "https://github.com/badbatch/graphql-box"
+  },
+  "bugs": "https://github.com/badbatch/graphql-box/issues",
+  "type": "module",
+  "main": "./dist/cjs/index.cjs",
+  "module": "./dist/esm/index.mjs",
+  "types": "./dist/types/cjs/index.d.cts",
+  "exports": {
+    "types": {
+      "import": "./dist/types/esm/index.d.ts",
+      "require": "./dist/types/cjs/index.d.cts"
+    },
+    "import": "./dist/esm/index.mjs",
+    "require": "./dist/cjs/index.cjs"
   },
   "publishConfig": {
     "access": "public"
   },
-  "main": "lib/main/index.js",
-  "module": "lib/module/index.mjs",
-  "browser": "lib/browser/index.js",
-  "types": "lib/types/index.d.ts",
-  "keywords": [
-    "graphql-box",
-    "graphql",
-    "client",
-    "server",
-    "isomorphic"
-  ],
-  "scripts": {
-    "compile": "concurrently npm:compile:*",
-    "compile-watch": "concurrently npm:compile-watch:*",
-    "compile-watch:main": "yarn run compile:main --watch",
-    "compile-watch:types": "yarn run compile:types --watch",
-    "compile:browser": "cross-env BABEL_ENV=browser rollup -c ../../rollup.config.js",
-    "compile:main": "cross-env BABEL_ENV=main babel ./src --out-dir ./lib/main --extensions \".ts\" --source-maps --config-file ../../babel.config.js",
-    "compile:module": "cross-env BABEL_ENV=module babel ./src --out-dir ./lib/module --extensions \".ts\" --out-file-extension \".mjs\" --source-maps --config-file ../../babel.config.js",
-    "compile:types": "tsc --build",
-    "docs": "typedoc --includes ./src/main --out ./docs --options ../../typedoc.js",
-    "watch": "cross-env BABEL_ENV=browser rollup -c ../../rollup.config.js -w"
-  },
-  "peerDependencies": {
-    "@babel/runtime": "< 8",
-    "@graphql-box/core": "< 5",
-    "@graphql-box/helpers": "< 5",
-    "core-js": "< 4",
-    "lodash": "< 5"
-  },
   "dependencies": {
-    "@cachemap/constants": "^4.0.2",
-    "@cachemap/core": "^4.0.4",
-    "@cachemap/core-worker": "^4.0.3",
-    "eventemitter3": "^4.0.0",
+    "@types/uuid": "^9.0.3",
+    "eventemitter3": "^5.0.1",
     "iterall": "^1.3.0",
-    "uuid": "^7.0.1"
+    "uuid": "^9.0.1",
+    "@graphql-box/core": "5.0.0",
+    "@graphql-box/helpers": "5.0.0"
+  },
+  "peerDependencies": {
+    "@babel/runtime": "<8",
+    "@cachemap/core": "<6",
+    "@cachemap/core-worker": "<6",
+    "core-js": "<4",
+    "graphql": "<17",
+    "lodash-es": "<5",
+    "@graphql-box/client": "5.0.1"
   },
   "devDependencies": {
-    "@graphql-box/client": "^4.0.0",
-    "@graphql-box/debug-manager": "^4.0.0",
-    "@graphql-box/test-utils": "^4.0.0"
+    "@babel/runtime": "^7.20.13",
+    "@cachemap/core": "^5.0.6",
+    "@cachemap/core-worker": "^5.0.6",
+    "@types/lodash-es": "^4.14.191",
+    "core-js": "^3.27.2",
+    "cts-types": "^0.0.5",
+    "del-cli": "^5.1.0",
+    "graphql": "^16.8.1",
+    "lodash-es": "^4.17.21",
+    "@graphql-box/client": "5.0.1"
+  },
+  "keywords": [
+    "client",
+    "graphql",
+    "graphql-box",
+    "isomorphic",
+    "server"
+  ],
+  "scripts": {
+    "build": "pnpm run clean:dist && pnpm run compile",
+    "clean:deps": "del-cli ./node_modules",
+    "clean:dist": "del-cli ./dist",
+    "compile": "pnpm run /^compile:.*/",
+    "compile:cjs": "MODULE_SYSTEM=cjs rollup -c ../../rollup.config.cjs",
+    "compile:esm": "rollup -c ../../rollup.config.cjs",
+    "compile:types": "tsc --project ./tsconfig.build.json && cts-types build dist/types/esm dist/types/cjs"
   }
 }

package/src/constants.ts

@@ -0,0 +1,5 @@
+export const CACHEMAP = 'cachemap' as const;
+export const GRAPHQL_BOX = 'graphqlBox' as const;
+export const MESSAGE = 'message' as const;
+export const REQUEST = 'request' as const;
+export const SUBSCRIBE = 'subscribe' as const;

package/src/debug/{log-request/index.ts → logRequest.ts}

@@ -1,20 +1,32 @@
-import { REQUEST_EXECUTED, REQUEST_RESOLVED, RequestContext } from "@graphql-box/core";
-import { isAsyncIterable } from "iterall";
-import operationNameRegex from "../../helpers/operationNameRegex";
-
-export default function logRequest() {
-  return (
-    _target: any,
-    _propertyName: string,
-    descriptor: TypedPropertyDescriptor<(...args: any[]) => Promise<any>>,
-  ): void => {
+import {
+  type PartialRequestResult,
+  REQUEST_EXECUTED,
+  REQUEST_RESOLVED,
+  type RequestContext,
+  type RequestOptions,
+} from '@graphql-box/core';
+import { isAsyncIterable } from 'iterall';
+import { operationNameRegex } from '../helpers/operationNameRegex.ts';
+import { type WorkerClient } from '../main.ts';
+
+type Descriptor = (
+  request: string,
+  options: RequestOptions,
+  context: RequestContext
+) => Promise<PartialRequestResult | AsyncIterableIterator<PartialRequestResult | undefined>>;
+
+export const logRequest = () => {
+  return (_target: WorkerClient, _propertyName: string, descriptor: TypedPropertyDescriptor<Descriptor>): void => {
     const method = descriptor.value;
-    if (!method) return;
 
-    descriptor.value = async function descriptorValue(...args: any[]): Promise<any> {
-      try {
-        return new Promise(async resolve => {
-          const { debugManager, ...otherContext } = args[2] as RequestContext;
+    if (!method) {
+      return;
+    }
+
+    descriptor.value = async function descriptorValue(...args: Parameters<Descriptor>): ReturnType<Descriptor> {
+      return new Promise(resolve => {
+        void (async () => {
+          const { debugManager, ...otherContext } = args[2];
 
           if (!debugManager) {
             resolve(await method.apply(this, args));
@@ -47,10 +59,8 @@ export default function logRequest() {
             result,
             stats: { duration, endTime, startTime },
           });
-        });
-      } catch (error) {
-        return Promise.reject(error);
-      }
+        })();
+      });
     };
   };
-}
+};

package/src/debug/logSubscription.ts

@@ -0,0 +1,50 @@
+import {
+  type PartialRequestResult,
+  type RequestContext,
+  type RequestOptions,
+  SUBSCRIPTION_EXECUTED,
+} from '@graphql-box/core';
+import { operationNameRegex } from '../helpers/operationNameRegex.ts';
+import { type WorkerClient } from '../main.ts';
+
+type Descriptor = (
+  request: string,
+  options: RequestOptions,
+  context: RequestContext
+) => Promise<PartialRequestResult | AsyncIterableIterator<PartialRequestResult | undefined>>;
+
+export const logSubscription = () => {
+  return (_target: WorkerClient, _propertyName: string, descriptor: TypedPropertyDescriptor<Descriptor>): void => {
+    const method = descriptor.value;
+
+    if (!method) {
+      return;
+    }
+
+    descriptor.value = async function descriptorValue(...args: Parameters<Descriptor>): ReturnType<Descriptor> {
+      return new Promise(resolve => {
+        void (async () => {
+          const { debugManager, ...otherContext } = args[2];
+
+          if (!debugManager) {
+            resolve(await method.apply(this, args));
+            return;
+          }
+
+          const derivedOperationName = operationNameRegex(args[0]);
+          const startTime = debugManager.now();
+
+          debugManager.log(SUBSCRIPTION_EXECUTED, {
+            context: { ...otherContext, operationName: derivedOperationName },
+            options: args[1],
+            request: args[0],
+            stats: { startTime },
+          });
+
+          const result = await method.apply(this, args);
+          resolve(result);
+        })();
+      });
+    };
+  };
+};

package/src/helpers/isGraphqlBoxMessageRequestPayload.ts

@@ -0,0 +1,7 @@
+import { type PostMessage as CachemapMessageRequestPayload } from '@cachemap/core-worker';
+import { GRAPHQL_BOX } from '../constants.ts';
+import type { MessageRequestPayload } from '../types.ts';
+
+export const isGraphqlBoxMessageRequestPayload = (
+  payload: MessageRequestPayload | CachemapMessageRequestPayload
+): payload is MessageRequestPayload => payload.type === GRAPHQL_BOX;

package/src/helpers/operationNameRegex.test.ts

@@ -1,7 +1,7 @@
-import operationNameRegex from "./operationNameRegex";
+import { operationNameRegex } from './operationNameRegex.ts';
 
-describe("operationNameRegex", () => {
-  test("when request does not have operation type", () => {
+describe('operationNameRegex', () => {
+  describe('when request does not have operation type', () => {
     const request = `
       {
         human(id: "1000") {
@@ -11,10 +11,12 @@ describe("operationNameRegex", () => {
       }
     `;
 
-    expect(operationNameRegex(request)).toBe("");
+    it('should return the correct value', () => {
+      expect(operationNameRegex(request)).toBe('');
+    });
   });
 
-  test("when request does not have operation name", () => {
+  describe('when request does not have operation name', () => {
     const request = `
       query {
         human(id: "1000") {
@@ -24,10 +26,12 @@ describe("operationNameRegex", () => {
       }
     `;
 
-    expect(operationNameRegex(request)).toBe("");
+    it('should return the correct value', () => {
+      expect(operationNameRegex(request)).toBe('');
+    });
   });
 
-  test("when request has operation name but no arguments", () => {
+  describe('when request has operation name but no arguments', () => {
     const request = `
       query HeroNameAndFriends {
         hero(episode: $episode) {
@@ -39,10 +43,12 @@ describe("operationNameRegex", () => {
       }
     `;
 
-    expect(operationNameRegex(request)).toBe("HeroNameAndFriends");
+    it('should return the correct value', () => {
+      expect(operationNameRegex(request)).toBe('HeroNameAndFriends');
+    });
   });
 
-  test("when request has operation name and arguments", () => {
+  describe('when request has operation name and arguments', () => {
     const request = `
       query HeroNameAndFriends($episode: Episode = JEDI) {
         hero(episode: $episode) {
@@ -54,10 +60,12 @@ describe("operationNameRegex", () => {
       }
     `;
 
-    expect(operationNameRegex(request)).toBe("HeroNameAndFriends");
+    it('should return the correct value', () => {
+      expect(operationNameRegex(request)).toBe('HeroNameAndFriends');
+    });
   });
 
-  test("when request is mutation", () => {
+  describe('when request is mutation', () => {
     const request = `
       mutation CreateReviewForEpisode($ep: Episode!, $review: ReviewInput!) {
         createReview(episode: $ep, review: $review) {
@@ -67,10 +75,12 @@ describe("operationNameRegex", () => {
       }
     `;
 
-    expect(operationNameRegex(request)).toBe("CreateReviewForEpisode");
+    it('should return the correct value', () => {
+      expect(operationNameRegex(request)).toBe('CreateReviewForEpisode');
+    });
   });
 
-  test("when request is subscription", () => {
+  describe('when request is subscription', () => {
     const request = `
       subscription OnCommentAdded($postID: ID!) {
         commentAdded(postID: $postID) {
@@ -80,6 +90,8 @@ describe("operationNameRegex", () => {
       }
     `;
 
-    expect(operationNameRegex(request)).toBe("OnCommentAdded");
+    it('should return the correct value', () => {
+      expect(operationNameRegex(request)).toBe('OnCommentAdded');
+    });
   });
 });

package/src/helpers/operationNameRegex.ts

@@ -1,4 +1,4 @@
-export default (request: string) => {
+export const operationNameRegex = (request: string) => {
   const output = /(query|mutation|subscription) ([A-Za-z]+)(\(| {)/.exec(request);
-  return output ? output[2] : "";
+  return output ? output[2] : '';
 };

package/src/index.ts

@@ -1,3 +1,4 @@
-export * from "./defs";
-export { default } from "./main";
-export { default as registerWorker } from "./register-worker";
+export * from './constants.ts';
+export * from './main.ts';
+export * from './registerWorker.ts';
+export * from './types.ts';