@gabroberge/nestjs-dataloader 1.3.0

package/CHANGELOG.md

@@ -0,0 +1,56 @@
+# @gabroberge/nestjs-dataloader
+
+## 1.3.0
+
+### Minor Changes
+
+- a135b75: fix workflows
+- a135b75: upgrade dependencies
+
+## 1.2.1
+
+### Patch Changes
+
+- a62cfc0: fix typings
+
+## 1.2.0
+
+### Minor Changes
+
+- 57a8404: fix decorator metadata not being emitted
+
+## 1.1.2
+
+### Patch Changes
+
+- 42e8273: update readme
+
+## 1.1.1
+
+### Patch Changes
+
+- d41793f: update readme
+
+## 1.1.0
+
+### Minor Changes
+
+- 5d1400f: add dataloader decorator
+
+## 1.0.0
+
+### Major Changes
+
+- 6cfb2ae: implemented dataloader library for nestjs
+
+## 0.0.2
+
+### Patch Changes
+
+- 20b4a79: update readme
+
+## 0.0.1
+
+### Patch Changes
+
+- db3832c: initial commit

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Gabriel Roberge
+
+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,98 @@
+# NestJS Dataloader
+
+NestJS dataloader simplifies adding [graphql/dataloader](https://github.com/graphql/dataloader) to your NestJS project. DataLoader aims to solve the common N+1 loading problem.
+
+## Installation
+
+Install with pnpm
+
+```bash
+pnpm add @gabroberge/nestjs-dataloader
+```
+
+Install with yarn
+
+```bash
+yarn add @gabroberge/nestjs-dataloader
+```
+
+Install with npm
+
+```bash
+npm install --save @gabroberge/nestjs-dataloader
+```
+
+## Usage
+
+### NestDataLoader Creation
+
+We start by extends the `NestDataLoader` abstract class. This tells `DataLoader` how to load our objects.
+
+```typescript
+import  DataLoader from 'dataloader';
+import { Injectable } from '@nestjs/common';
+import { NestDataLoader } from '@gabroberge/nestjs-dataloader';
+...
+
+@Injectable()
+export class AccountLoader extends NestDataLoader<string, Account> {
+  constructor(private readonly accountService: AccountService) { }
+
+  generateDataLoader(): DataLoader<string, Account> {
+    return new DataLoader<string, Account>(keys => this.accountService.findByIds(keys));
+  }
+}
+```
+
+The first generic of the interface is the type of ID the datastore uses. The second generic is the type of object that will be returned. In the above instance, we want `DataLoader` to return instances of the `Account` class.
+
+### Providing the NestDataLoader
+
+For each NestDataLoader we create, we need to provide it to our module.
+
+```typescript
+import { Module } from '@nestjs/common';
+import { APP_INTERCEPTOR } from '@nestjs/core';
+import { NestDataLoaderInterceptor } from '@gabroberge/nestjs-dataloader'
+...
+
+@Module({
+  providers: [
+    AccountResolver,
+    AccountLoader,
+    {
+      provide: APP_INTERCEPTOR,
+      useClass: NestDataLoaderInterceptor,
+    },
+  ],
+
+})
+export class ResolversModule { }
+```
+
+### Using the NestDataLoader
+
+Now that we have a dataloader and our module is aware of it, we need to pass it as a parameter to an endpoint in our graphQL resolver.
+
+```typescript
+import DataLoader from 'dataloader';
+import { Loader } from '@gabroberge/nestjs-dataloader';
+...
+
+@Resolver(Account)
+export class AccountResolver {
+
+    @Query(() => [Account])
+    public getAccounts(
+        @Args({ name: 'ids', type: () => [String] }) ids: string[],
+        @Loader(AccountLoader) accountLoader: DataLoader<Account['id'], Account>): Promise<Account[]> {
+        return accountLoader.loadMany(ids);
+    }
+}
+```
+
+The important thing to note is that the parameter of the `@Loader` decorator is the entity/class of the `NestDataLoader` we want to be injected to the method. The DataLoader library will handle bulk retrieval and caching of our requests. Note that the caching is stored on a per-request basis.
+
+## Contributing
+
+Pull requests are always welcome. For major changes, please open an issue first to discuss what you would like to change.

package/dist/index.d.mts

@@ -0,0 +1,34 @@
+import * as _nestjs_common from '@nestjs/common';
+import { Type, NestInterceptor, ExecutionContext, CallHandler } from '@nestjs/common';
+import { ContextId, ModuleRef } from '@nestjs/core';
+import DataLoader from 'dataloader';
+import { Observable } from 'rxjs';
+
+declare const NEST_LOADER_CONTEXT_KEY = "NEST_LOADER_CONTEXT_KEY";
+
+declare abstract class NestDataLoader<Key extends string | number, Item> {
+    abstract generateDataLoader(): DataLoader<Key, Item | Item[]>;
+    mapFromArrayToArray<KeyStrategy extends (item: Item) => Key>(array: Item[], keyStrategy: KeyStrategy): Map<Key, Item[]>;
+    mapFromArrayToObject<KeyStrategy extends (item: Item) => Key>(array: Item[], keyStrategy: KeyStrategy): Map<Key, Item>;
+}
+
+type LoaderContext = {
+    contextId: ContextId;
+    getLoader(data: LoaderData | string): Promise<DataLoader<any, any>>;
+};
+type LoaderData = Type<NestDataLoader<any, any>>;
+type InjectionContext = {
+    [key: string]: DataLoader<any, any> | LoaderContext | undefined;
+    [NEST_LOADER_CONTEXT_KEY]?: LoaderContext;
+};
+
+declare const Loader: (...dataOrPipes: (LoaderData | _nestjs_common.PipeTransform<any, any> | _nestjs_common.Type<_nestjs_common.PipeTransform<any, any>>)[]) => ParameterDecorator;
+
+declare class NestDataLoaderInterceptor implements NestInterceptor {
+    private readonly moduleRef;
+    constructor(moduleRef: ModuleRef);
+    intercept(context: ExecutionContext, next: CallHandler): Observable<unknown>;
+    private getLoader;
+}
+
+export { type InjectionContext, Loader, type LoaderContext, type LoaderData, NestDataLoader, NestDataLoaderInterceptor };

package/dist/index.d.ts

@@ -0,0 +1,34 @@
+import * as _nestjs_common from '@nestjs/common';
+import { Type, NestInterceptor, ExecutionContext, CallHandler } from '@nestjs/common';
+import { ContextId, ModuleRef } from '@nestjs/core';
+import DataLoader from 'dataloader';
+import { Observable } from 'rxjs';
+
+declare const NEST_LOADER_CONTEXT_KEY = "NEST_LOADER_CONTEXT_KEY";
+
+declare abstract class NestDataLoader<Key extends string | number, Item> {
+    abstract generateDataLoader(): DataLoader<Key, Item | Item[]>;
+    mapFromArrayToArray<KeyStrategy extends (item: Item) => Key>(array: Item[], keyStrategy: KeyStrategy): Map<Key, Item[]>;
+    mapFromArrayToObject<KeyStrategy extends (item: Item) => Key>(array: Item[], keyStrategy: KeyStrategy): Map<Key, Item>;
+}
+
+type LoaderContext = {
+    contextId: ContextId;
+    getLoader(data: LoaderData | string): Promise<DataLoader<any, any>>;
+};
+type LoaderData = Type<NestDataLoader<any, any>>;
+type InjectionContext = {
+    [key: string]: DataLoader<any, any> | LoaderContext | undefined;
+    [NEST_LOADER_CONTEXT_KEY]?: LoaderContext;
+};
+
+declare const Loader: (...dataOrPipes: (LoaderData | _nestjs_common.PipeTransform<any, any> | _nestjs_common.Type<_nestjs_common.PipeTransform<any, any>>)[]) => ParameterDecorator;
+
+declare class NestDataLoaderInterceptor implements NestInterceptor {
+    private readonly moduleRef;
+    constructor(moduleRef: ModuleRef);
+    intercept(context: ExecutionContext, next: CallHandler): Observable<unknown>;
+    private getLoader;
+}
+
+export { type InjectionContext, Loader, type LoaderContext, type LoaderData, NestDataLoader, NestDataLoaderInterceptor };

package/dist/index.js

@@ -0,0 +1,162 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+var __async = (__this, __arguments, generator) => {
+  return new Promise((resolve, reject) => {
+    var fulfilled = (value) => {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var rejected = (value) => {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    step((generator = generator.apply(__this, __arguments)).next());
+  });
+};
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  Loader: () => Loader,
+  NestDataLoader: () => NestDataLoader,
+  NestDataLoaderInterceptor: () => NestDataLoaderInterceptor
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/loader.decorator.ts
+var import_common2 = require("@nestjs/common");
+var import_core2 = require("@nestjs/core");
+var import_graphql2 = require("@nestjs/graphql");
+
+// src/constants.ts
+var NEST_LOADER_CONTEXT_KEY = "NEST_LOADER_CONTEXT_KEY";
+
+// src/nest-loader.interceptor.ts
+var import_common = require("@nestjs/common");
+var import_core = require("@nestjs/core");
+var import_graphql = require("@nestjs/graphql");
+function _ts_decorate(decorators, target, key, desc) {
+  var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+  if (typeof Reflect === "object" && typeof Reflect.decorate === "function")
+    r = Reflect.decorate(decorators, target, key, desc);
+  else
+    for (var i = decorators.length - 1; i >= 0; i--)
+      if (d = decorators[i])
+        r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+  return c > 3 && r && Object.defineProperty(target, key, r), r;
+}
+__name(_ts_decorate, "_ts_decorate");
+function _ts_metadata(k, v) {
+  if (typeof Reflect === "object" && typeof Reflect.metadata === "function")
+    return Reflect.metadata(k, v);
+}
+__name(_ts_metadata, "_ts_metadata");
+var _NestDataLoaderInterceptor = class _NestDataLoaderInterceptor {
+  constructor(moduleRef) {
+    __publicField(this, "moduleRef");
+    this.moduleRef = moduleRef;
+  }
+  intercept(context, next) {
+    const gqlExecutionContext = import_graphql.GqlExecutionContext.create(context);
+    const injectionContext = gqlExecutionContext.getContext();
+    if (injectionContext[NEST_LOADER_CONTEXT_KEY] === void 0) {
+      injectionContext[NEST_LOADER_CONTEXT_KEY] = {
+        contextId: import_core.ContextIdFactory.create(),
+        getLoader: this.getLoader.bind(this, injectionContext)
+      };
+    }
+    return next.handle();
+  }
+  getLoader(injectionContext, type) {
+    return __async(this, null, function* () {
+      var _a;
+      if (injectionContext[type] === void 0) {
+        const nestLoader = yield this.moduleRef.resolve(type, (_a = injectionContext[NEST_LOADER_CONTEXT_KEY]) == null ? void 0 : _a.contextId, {
+          strict: false
+        });
+        injectionContext[type] = nestLoader.generateDataLoader();
+      }
+      return injectionContext[type];
+    });
+  }
+};
+__name(_NestDataLoaderInterceptor, "NestDataLoaderInterceptor");
+var NestDataLoaderInterceptor = _NestDataLoaderInterceptor;
+NestDataLoaderInterceptor = _ts_decorate([
+  (0, import_common.Injectable)(),
+  _ts_metadata("design:type", Function),
+  _ts_metadata("design:paramtypes", [
+    typeof import_core.ModuleRef === "undefined" ? Object : import_core.ModuleRef
+  ])
+], NestDataLoaderInterceptor);
+
+// src/loader.decorator.ts
+var Loader = (0, import_common2.createParamDecorator)((data, context) => __async(void 0, null, function* () {
+  const gqlExecutionContext = import_graphql2.GqlExecutionContext.create(context);
+  const injectionContext = gqlExecutionContext.getContext();
+  const loaderContext = injectionContext[NEST_LOADER_CONTEXT_KEY];
+  if (loaderContext !== void 0)
+    return loaderContext.getLoader(data);
+  throw new import_common2.InternalServerErrorException(`You should provide interceptor ${NestDataLoaderInterceptor.name} globally with ${import_core2.APP_INTERCEPTOR}`);
+}));
+
+// src/nest-dataloader.ts
+var _NestDataLoader = class _NestDataLoader {
+  mapFromArrayToArray(array, keyStrategy) {
+    return array.reduce((map, item) => {
+      const key = keyStrategy(item);
+      const existingGroup = map.get(key);
+      if (existingGroup) {
+        existingGroup.push(item);
+      } else {
+        map.set(key, [
+          item
+        ]);
+      }
+      return map;
+    }, /* @__PURE__ */ new Map());
+  }
+  mapFromArrayToObject(array, keyStrategy) {
+    return array.reduce((map, item) => {
+      map.set(keyStrategy(item), item);
+      return map;
+    }, /* @__PURE__ */ new Map());
+  }
+};
+__name(_NestDataLoader, "NestDataLoader");
+var NestDataLoader = _NestDataLoader;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Loader,
+  NestDataLoader,
+  NestDataLoaderInterceptor
+});

package/dist/index.mjs

@@ -0,0 +1,135 @@
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+var __async = (__this, __arguments, generator) => {
+  return new Promise((resolve, reject) => {
+    var fulfilled = (value) => {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var rejected = (value) => {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    step((generator = generator.apply(__this, __arguments)).next());
+  });
+};
+
+// src/loader.decorator.ts
+import { createParamDecorator, InternalServerErrorException } from "@nestjs/common";
+import { APP_INTERCEPTOR } from "@nestjs/core";
+import { GqlExecutionContext as GqlExecutionContext2 } from "@nestjs/graphql";
+
+// src/constants.ts
+var NEST_LOADER_CONTEXT_KEY = "NEST_LOADER_CONTEXT_KEY";
+
+// src/nest-loader.interceptor.ts
+import { Injectable } from "@nestjs/common";
+import { ContextIdFactory, ModuleRef } from "@nestjs/core";
+import { GqlExecutionContext } from "@nestjs/graphql";
+function _ts_decorate(decorators, target, key, desc) {
+  var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+  if (typeof Reflect === "object" && typeof Reflect.decorate === "function")
+    r = Reflect.decorate(decorators, target, key, desc);
+  else
+    for (var i = decorators.length - 1; i >= 0; i--)
+      if (d = decorators[i])
+        r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+  return c > 3 && r && Object.defineProperty(target, key, r), r;
+}
+__name(_ts_decorate, "_ts_decorate");
+function _ts_metadata(k, v) {
+  if (typeof Reflect === "object" && typeof Reflect.metadata === "function")
+    return Reflect.metadata(k, v);
+}
+__name(_ts_metadata, "_ts_metadata");
+var _NestDataLoaderInterceptor = class _NestDataLoaderInterceptor {
+  constructor(moduleRef) {
+    __publicField(this, "moduleRef");
+    this.moduleRef = moduleRef;
+  }
+  intercept(context, next) {
+    const gqlExecutionContext = GqlExecutionContext.create(context);
+    const injectionContext = gqlExecutionContext.getContext();
+    if (injectionContext[NEST_LOADER_CONTEXT_KEY] === void 0) {
+      injectionContext[NEST_LOADER_CONTEXT_KEY] = {
+        contextId: ContextIdFactory.create(),
+        getLoader: this.getLoader.bind(this, injectionContext)
+      };
+    }
+    return next.handle();
+  }
+  getLoader(injectionContext, type) {
+    return __async(this, null, function* () {
+      var _a;
+      if (injectionContext[type] === void 0) {
+        const nestLoader = yield this.moduleRef.resolve(type, (_a = injectionContext[NEST_LOADER_CONTEXT_KEY]) == null ? void 0 : _a.contextId, {
+          strict: false
+        });
+        injectionContext[type] = nestLoader.generateDataLoader();
+      }
+      return injectionContext[type];
+    });
+  }
+};
+__name(_NestDataLoaderInterceptor, "NestDataLoaderInterceptor");
+var NestDataLoaderInterceptor = _NestDataLoaderInterceptor;
+NestDataLoaderInterceptor = _ts_decorate([
+  Injectable(),
+  _ts_metadata("design:type", Function),
+  _ts_metadata("design:paramtypes", [
+    typeof ModuleRef === "undefined" ? Object : ModuleRef
+  ])
+], NestDataLoaderInterceptor);
+
+// src/loader.decorator.ts
+var Loader = createParamDecorator((data, context) => __async(void 0, null, function* () {
+  const gqlExecutionContext = GqlExecutionContext2.create(context);
+  const injectionContext = gqlExecutionContext.getContext();
+  const loaderContext = injectionContext[NEST_LOADER_CONTEXT_KEY];
+  if (loaderContext !== void 0)
+    return loaderContext.getLoader(data);
+  throw new InternalServerErrorException(`You should provide interceptor ${NestDataLoaderInterceptor.name} globally with ${APP_INTERCEPTOR}`);
+}));
+
+// src/nest-dataloader.ts
+var _NestDataLoader = class _NestDataLoader {
+  mapFromArrayToArray(array, keyStrategy) {
+    return array.reduce((map, item) => {
+      const key = keyStrategy(item);
+      const existingGroup = map.get(key);
+      if (existingGroup) {
+        existingGroup.push(item);
+      } else {
+        map.set(key, [
+          item
+        ]);
+      }
+      return map;
+    }, /* @__PURE__ */ new Map());
+  }
+  mapFromArrayToObject(array, keyStrategy) {
+    return array.reduce((map, item) => {
+      map.set(keyStrategy(item), item);
+      return map;
+    }, /* @__PURE__ */ new Map());
+  }
+};
+__name(_NestDataLoader, "NestDataLoader");
+var NestDataLoader = _NestDataLoader;
+export {
+  Loader,
+  NestDataLoader,
+  NestDataLoaderInterceptor
+};

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@gabroberge/nestjs-dataloader",
+  "version": "1.3.0",
+  "description": "A NestJS decorator for dataloader",
+  "private": false,
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "lint-staged": {
+    "*.{js,ts}": [
+      "pnpm format"
+    ]
+  },
+  "keywords": [
+    "nestjs",
+    "dataloader",
+    "graphql",
+    "typescript"
+  ],
+  "author": "Gabriel Roberge",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/gabroberge/nestjs-dataloader.git"
+  },
+  "homepage": "https://github.com/gabroberge/nestjs-dataloader#readme",
+  "bugs": "https://github.com/gabroberge/nestjs-dataloader/issues",
+  "peerDependencies": {
+    "@nestjs/common": "^10.0.1",
+    "@nestjs/core": "^10.0.1",
+    "@nestjs/graphql": "^12.0.1",
+    "dataloader": "^2.2.2",
+    "rxjs": "^7.8.1"
+  },
+  "devDependencies": {
+    "@changesets/cli": "^2.26.2",
+    "@nestjs/common": "^10.2.10",
+    "@nestjs/core": "^10.2.10",
+    "@nestjs/graphql": "^12.0.11",
+    "@nestjs/testing": "^10.2.10",
+    "@types/node": "^20.10.0",
+    "dataloader": "^2.2.2",
+    "husky": "^8.0.3",
+    "prettier": "^3.1.0",
+    "rxjs": "^7.8.1",
+    "tsup": "^8.0.1",
+    "typescript": "^5.3.2",
+    "unplugin-swc": "^1.4.3",
+    "vitest": "^0.34.6"
+  },
+  "scripts": {
+    "dev": "vitest",
+    "test": "vitest run",
+    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "format": "prettier --write \"src/**/*.ts\" \"tests/**/*.spec.ts\"",
+    "lint": "tsc",
+    "ci": "pnpm lint && pnpm test && pnpm build",
+    "release": "pnpm run ci && changeset publish"
+  }
+}