@rytass/wms-module-graphql 0.1.4 → 0.2.0

package/docs/integration-guide.md

@@ -68,6 +68,24 @@ The reference consumer ([`wms-standalone`](#13-reference-implementation-wms-stan
 
 The frontend package (`wms-module-react`) is **ESM-only** (`"type": "module"`). Bundlers that target Next.js / Vite / webpack 5 handle this transparently; classic CJS-only Node tools do not.
 
+### 2.1 pnpm build-script approval
+
+If you are on **pnpm 9 or newer**, the first `pnpm install` will refuse to run native build scripts for several transitive dependencies and surface `ERR_PNPM_IGNORED_BUILDS`. This is pnpm's supply-chain protection, not a WMS issue, but it is the very first error a fresh integrator hits.
+
+Resolve it once by approving the packages WMS transitively needs to build:
+
+```bash
+pnpm approve-builds
+# Or, in pnpm-workspace.yaml:
+# allowBuilds:
+#   '@apollo/protobufjs': true
+#   '@nestjs/core': true
+#   '@parcel/watcher': true
+#   sharp: true
+```
+
+After approval, `pnpm install` completes cleanly. The exact list pnpm asks you to approve depends on your other dependencies; the four above are the ones triggered by WMS's NestJS + Apollo + native-image stack.
+
 ---
 
 ## 3. Quick start (60 seconds)
@@ -208,6 +226,35 @@ WmsModuleGraphqlModule.forRootAsync(
 
 See [API Reference - wms-module-graphql](./api-reference.md) for the full `forRootAsync` signature.
 
+### Adding your own resolvers alongside WMS
+
+`WmsModuleGraphqlModule` calls `GraphQLModule.forRootAsync(...)` internally — that registration is workspace-global, so you cannot register a second `GraphQLModule` (see §13.1). What you **can** do is put your own resolvers in **sibling NestJS modules** imported in `AppModule`:
+
+```ts
+// apps/api/src/modules/posts/posts.module.ts
+import { Module } from '@nestjs/common';
+import { TypeOrmModule } from '@nestjs/typeorm';
+import { Post } from './post.entity';
+import { PostResolver } from './post.resolver';
+
+@Module({
+  imports: [TypeOrmModule.forFeature([Post])],
+  providers: [PostResolver],
+})
+export class PostsModule {}
+
+// apps/api/src/app/app.module.ts
+@Module({
+  imports: [
+    /* ... TypeOrm, Config, WmsModuleGraphqlModule ... */
+    PostsModule,   // your sibling module
+  ],
+})
+export class AppModule {}
+```
+
+NestJS's GraphQL module discovers every `@Resolver()` class from every imported module via DI and merges them into the **same** schema. So your `Post`/`User` resolvers coexist in one schema with the WMS resolvers automatically — no extra wiring needed. The §13.1 "one GraphQLModule" constraint only forbids a second `GraphQLModule.forRoot(...)` registration, not additional resolvers.
+
 ### 4.3 `.env`
 
 Keep DB credentials in `.env` (and add it to `.gitignore`).

package/index.cjs.js

@@ -2,13 +2,13 @@
 
 var tslib = require('tslib');
 var common = require('@nestjs/common');
-var graphql = require('@nestjs/graphql');
 var wmsModuleCore = require('@rytass/wms-module-core');
 var crypto = require('crypto');
 var _ = require('lodash');
 var lruCache = require('lru-cache');
 var typeorm = require('typeorm');
 var DataLoader = require('dataloader');
+var graphql = require('@nestjs/graphql');
 var wmsBaseNestjsModule = require('@rytass/wms-base-nestjs-module');
 var warehouseMap_entity = require('@rytass/wms-base-nestjs-module/models/warehouse-map.entity');
 
@@ -17,7 +17,7 @@ function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
 var ___default = /*#__PURE__*/_interopDefault(_);
 var DataLoader__default = /*#__PURE__*/_interopDefault(DataLoader);
 
-let LoaderService = class LoaderService {
+exports.LoaderService = class LoaderService {
     dataSource;
     cache;
     constructor(dataSource) {
@@ -171,18 +171,18 @@ let LoaderService = class LoaderService {
         });
     }
 };
-LoaderService = tslib.__decorate([
+exports.LoaderService = tslib.__decorate([
     common.Injectable(),
     tslib.__metadata("design:paramtypes", [typeorm.DataSource])
-], LoaderService);
+], exports.LoaderService);
 
 let HelperModule = class HelperModule {
 };
 HelperModule = tslib.__decorate([
     common.Global(),
     common.Module({
-        providers: [LoaderService],
-        exports: [LoaderService],
+        providers: [exports.LoaderService],
+        exports: [exports.LoaderService],
     })
 ], HelperModule);
 
@@ -202,6 +202,14 @@ common.createParamDecorator((data, context) => {
     return null;
 });
 
+function createWmsLoaders(loaderService) {
+    return {
+        batchSingle: loaderService.batchEntity(),
+        batchMany: loaderService.batchEntities(),
+        batchManyWithPagination: loaderService.batchEntitiesWithPagination(),
+    };
+}
+
 const IdGenFunction = (input) => {
     const hash = crypto.createHash('sha256');
     hash.update(input);
@@ -6232,43 +6240,13 @@ const exportDependencies = [
     MapRangeUnionResolver,
 ];
 exports.WmsModuleGraphqlModule = WmsModuleGraphqlModule_1 = class WmsModuleGraphqlModule {
-    static forRootAsync(options, gqlOptions) {
+    static forRootAsync(options) {
         const coreModule = wmsModuleCore.WmsModuleCoreModule.forRootAsync(options);
         return {
             module: WmsModuleGraphqlModule_1,
-            imports: [
-                coreModule,
-                HelperModule,
-                graphql.GraphQLModule.forRootAsync({
-                    ...gqlOptions,
-                    imports: [HelperModule, ...(gqlOptions.imports || [])],
-                    inject: [LoaderService, ...(gqlOptions.inject || [])],
-                    useFactory: async (loaderService, ...args) => {
-                        const loaders = {
-                            batchSingle: loaderService.batchEntity(),
-                            batchMany: loaderService.batchEntities(),
-                            batchManyWithPagination: loaderService.batchEntitiesWithPagination(),
-                        };
-                        const originalFactory = gqlOptions.useFactory
-                            ? await gqlOptions.useFactory(...args)
-                            : {};
-                        return {
-                            ...originalFactory,
-                            context: async (contextArg) => {
-                                const context = typeof gqlOptions.useFactory === 'function'
-                                    ? {
-                                        loaders,
-                                        ...(typeof contextArg === 'object' ? contextArg : {}),
-                                    }
-                                    : { loaders, ...contextArg };
-                                return context;
-                            },
-                        };
-                    },
-                }),
-            ],
+            imports: [coreModule, HelperModule],
             providers: exportDependencies,
-            exports: [graphql.GraphQLModule, coreModule],
+            exports: [...exportDependencies, HelperModule, coreModule],
         };
     }
 };
@@ -6277,3 +6255,5 @@ exports.WmsModuleGraphqlModule = WmsModuleGraphqlModule_1 = tslib.__decorate([
         providers: exportDependencies,
     })
 ], exports.WmsModuleGraphqlModule);
+
+exports.createWmsLoaders = createWmsLoaders;

package/index.d.ts

@@ -1 +1,5 @@
 export * from './lib/graphql.module';
+export { LoaderService } from './lib/helpers/loader.service';
+export type { LoaderOptions, LoaderOptionsWithPagination, } from './lib/helpers/loader.service';
+export type { LoaderType } from './lib/helpers/dataloader.type';
+export { createWmsLoaders, type WmsLoaders, } from './lib/helpers/create-wms-loaders';

package/index.js

@@ -1 +1,3 @@
 export { WmsModuleGraphqlModule } from './lib/graphql.module.js';
+export { LoaderService } from './lib/helpers/loader.service.js';
+export { createWmsLoaders } from './lib/helpers/create-wms-loaders.js';

package/lib/graphql.module.d.ts

@@ -1,6 +1,5 @@
 import { DynamicModule } from '@nestjs/common';
-import { GqlModuleAsyncOptions } from '@nestjs/graphql';
 import type { WmsModuleCoreModuleAsyncOptions } from '@rytass/wms-module-core';
 export declare class WmsModuleGraphqlModule {
-    static forRootAsync(options: WmsModuleCoreModuleAsyncOptions, gqlOptions: GqlModuleAsyncOptions): DynamicModule;
+    static forRootAsync(options: WmsModuleCoreModuleAsyncOptions): DynamicModule;
 }

package/lib/graphql.module.js

@@ -1,8 +1,7 @@
 import { __decorate } from 'tslib';
 import { Module } from '@nestjs/common';
-import { GraphQLModule } from '@nestjs/graphql';
 import { WmsModuleCoreModule } from '@rytass/wms-module-core';
-import { LoaderService } from './helpers/loader.service.js';
+import './helpers/loader.service.js';
 import { HelperModule } from './helpers/helper.module.js';
 import './helpers/query-path.js';
 import { LoaderMutation } from './mutations/loader.mutation.js';
@@ -108,43 +107,13 @@ const exportDependencies = [
     MapRangeUnionResolver,
 ];
 let WmsModuleGraphqlModule = WmsModuleGraphqlModule_1 = class WmsModuleGraphqlModule {
-    static forRootAsync(options, gqlOptions) {
+    static forRootAsync(options) {
         const coreModule = WmsModuleCoreModule.forRootAsync(options);
         return {
             module: WmsModuleGraphqlModule_1,
-            imports: [
-                coreModule,
-                HelperModule,
-                GraphQLModule.forRootAsync({
-                    ...gqlOptions,
-                    imports: [HelperModule, ...(gqlOptions.imports || [])],
-                    inject: [LoaderService, ...(gqlOptions.inject || [])],
-                    useFactory: async (loaderService, ...args) => {
-                        const loaders = {
-                            batchSingle: loaderService.batchEntity(),
-                            batchMany: loaderService.batchEntities(),
-                            batchManyWithPagination: loaderService.batchEntitiesWithPagination(),
-                        };
-                        const originalFactory = gqlOptions.useFactory
-                            ? await gqlOptions.useFactory(...args)
-                            : {};
-                        return {
-                            ...originalFactory,
-                            context: async (contextArg) => {
-                                const context = typeof gqlOptions.useFactory === 'function'
-                                    ? {
-                                        loaders,
-                                        ...(typeof contextArg === 'object' ? contextArg : {}),
-                                    }
-                                    : { loaders, ...contextArg };
-                                return context;
-                            },
-                        };
-                    },
-                }),
-            ],
+            imports: [coreModule, HelperModule],
             providers: exportDependencies,
-            exports: [GraphQLModule, coreModule],
+            exports: [...exportDependencies, HelperModule, coreModule],
         };
     }
 };

package/lib/helpers/create-wms-loaders.d.ts

@@ -0,0 +1,4 @@
+import type { LoaderType } from './dataloader.type';
+import type { LoaderService } from './loader.service';
+export type WmsLoaders = LoaderType<unknown>['loaders'];
+export declare function createWmsLoaders(loaderService: LoaderService): WmsLoaders;

package/lib/helpers/create-wms-loaders.js

@@ -0,0 +1,9 @@
+function createWmsLoaders(loaderService) {
+    return {
+        batchSingle: loaderService.batchEntity(),
+        batchMany: loaderService.batchEntities(),
+        batchManyWithPagination: loaderService.batchEntitiesWithPagination(),
+    };
+}
+
+export { createWmsLoaders };

package/lib/helpers/index.d.ts

@@ -2,3 +2,4 @@ export * from './dataloader.type';
 export * from './loader.service';
 export * from './helper.module';
 export * from './query-path';
+export * from './create-wms-loaders';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rytass/wms-module-graphql",
-  "version": "0.1.4",
+  "version": "0.2.0",
   "description": "Rytass WMS Module — GraphQL schema, resolvers and DTOs for warehouse management",
   "keywords": [
     "rytass",
@@ -49,7 +49,7 @@
     "@nestjs/apollo": ">=13.0.0 <13.2.0",
     "@nestjs/common": "^11.0.0",
     "@nestjs/graphql": "^13.0.0",
-    "@rytass/wms-module-core": "^0.1.4",
+    "@rytass/wms-module-core": "^0.1.6",
     "graphql": "^16.0.0",
     "reflect-metadata": "^0.1.13 || ^0.2.0",
     "rxjs": "^7.8.0"