@sisques-labs/nestjs-kit 0.1.0 → 0.1.1

package/README.md

@@ -141,19 +141,11 @@ For contributors working on this repository:
 
 ## Module Setup
 
-Import **`SharedModule`** in your root or core module. It is **`@Global()`** and only registers cross-cutting pieces that do not require a database (for example **`MutationResponseGraphQLMapper`** and shared GraphQL enum registration). It does **not** import MongoDB or TypeORM—you add those only if you need them.
+The library is **opt-in by feature**. Import **`MongoModule`**, **`TypeOrmModule`**, GraphQL pieces (DTOs, **`registerSharedGraphqlEnums`**, mappers, plugins), and domain exports only when you need them.
 
-```typescript
-import { Module } from '@nestjs/common';
-import { SharedModule } from '@sisques-labs/nestjs-kit';
+**`SharedModule`** is an optional **empty** `Module` kept for backward compatibility; it registers **no** providers and is **not** `@Global()`.
 
-@Module({
-  imports: [SharedModule],
-})
-export class AppModule {}
-```
-
-**Optional database modules** (import alongside `SharedModule` when you use them):
+**Optional database modules:**
 
 - **`MongoModule`** — provides `MongoMasterService` (`MONGODB_URI`, `MONGODB_DATABASE` via `ConfigService`).
 - **`TypeOrmModule`** — registers `TypeOrmModule.forRootAsync` using `DATABASE_*` config; requires **`ConfigModule`** in the app (for example `ConfigModule.forRoot({ isGlobal: true })`).
@@ -161,16 +153,11 @@ export class AppModule {}
 ```typescript
 import { Module } from '@nestjs/common';
 import { ConfigModule } from '@nestjs/config';
-import {
-  SharedModule,
-  MongoModule,
-  TypeOrmModule,
-} from '@sisques-labs/nestjs-kit';
+import { MongoModule, TypeOrmModule } from '@sisques-labs/nestjs-kit';
 
 @Module({
   imports: [
     ConfigModule.forRoot({ isGlobal: true }),
-    SharedModule,
     MongoModule, // omit if you do not use MongoDB
     TypeOrmModule, // omit if you do not use TypeORM
   ],
@@ -607,6 +594,14 @@ type UserTypeormDto = BaseTypeormDto & {
 
 ## Transport Layer (GraphQL)
 
+If you use **`@nestjs/graphql`**, call **`registerSharedGraphqlEnums()`** once before schema generation (for example at the top of `main.ts` before `NestFactory.create`, or from a small module imported by `AppModule`). Add **`MutationResponseGraphQLMapper`** and **`ComplexityPlugin`** to your own GraphQL module’s **`providers`** when you use them—this package does **not** register them via **`SharedModule`**.
+
+```typescript
+import { registerSharedGraphqlEnums } from '@sisques-labs/nestjs-kit';
+
+registerSharedGraphqlEnums();
+```
+
 ### Input DTOs
 
 #### `BaseFindByCriteriaInput`
@@ -689,11 +684,16 @@ deleteUsers(@Args('ids', { type: () => [String] }) ids: string[]): Promise<Mutat
 
 ### Mappers
 
-`MutationResponseGraphQLMapper` is a NestJS injectable service provided by `SharedModule` that maps domain results to `MutationResponseDto`.
+`MutationResponseGraphQLMapper` is a NestJS injectable that maps domain results to `MutationResponseDto`. Register it in the module that declares your resolvers (or a dedicated GraphQL module).
 
 ```typescript
 import { MutationResponseGraphQLMapper } from '@sisques-labs/nestjs-kit';
 
+@Module({
+  providers: [MutationResponseGraphQLMapper, UserResolver],
+})
+export class UserGraphqlModule {}
+
 @Resolver()
 export class UserResolver {
   constructor(private readonly mutationMapper: MutationResponseGraphQLMapper) {}
@@ -710,7 +710,7 @@ export class UserResolver {
 
 ### Complexity Plugin
 
-`ComplexityPlugin` is an **Apollo Server plugin** (`@Plugin()` from `@nestjs/apollo`) that rejects operations whose estimated complexity exceeds **1000** (see `graphql-query-complexity`). It is **exported** from this package but **not** registered inside `SharedModule`—add it to your GraphQL module’s **`providers`** (or equivalent) so Nest discovers the plugin.
+`ComplexityPlugin` is an **Apollo Server plugin** (`@Plugin()` from `@nestjs/apollo`) that rejects operations whose estimated complexity exceeds **1000** (see `graphql-query-complexity`). It is **exported** from this package—add it to your GraphQL module’s **`providers`** (or equivalent) so Nest discovers the plugin.
 
 To assign complexity weights to fields use the `@Complexity` decorator from `@nestjs/graphql`:
 
@@ -741,6 +741,8 @@ export class GraphqlPluginsModule {}
 
 ## Enums
 
+TypeScript enums are exported for domain and GraphQL use. For GraphQL schema generation, call **`registerSharedGraphqlEnums()`** once (see [Transport Layer (GraphQL)](#transport-layer-graphql)).
+
 ```typescript
 import {
   FilterOperator,

package/dist/index.d.ts

@@ -1,4 +1,3 @@
-export * from './shared/shared.module';
 export * from './shared/application/commands/base/base-command.handler';
 export * from './shared/application/commands/interfaces/base-command-handler.interface';
 export * from './shared/application/commands/update/base-update/base-update.command-handler';
@@ -66,8 +65,8 @@ export * from './shared/domain/value-objects/url/url.vo';
 export * from './shared/domain/value-objects/uuid/uuid.vo';
 export * from './shared/domain/view-models/base-view-model/base-view-model';
 export * from './shared/infrastructure/database/base-database.repository';
-export * from './shared/infrastructure/logging/formats/shared-winston.formats';
 export * from './shared/infrastructure/logging/factories/create-shared-winston-logger-options';
+export * from './shared/infrastructure/logging/formats/shared-winston.formats';
 export * from './shared/infrastructure/logging/interfaces/shared-winston-logger-factory-options.interface';
 export * from './shared/infrastructure/database/mongodb/base-mongo/base-mongo-database.repository';
 export * from './shared/infrastructure/database/mongodb/base-mongo/base-mongo-master/base-mongo-master.repository';
@@ -80,6 +79,7 @@ export * from './shared/infrastructure/database/typeorm/entities/base-typeorm.en
 export * from './shared/infrastructure/database/typeorm/services/typeorm-master/typeorm-master.service';
 export * from './shared/infrastructure/database/typeorm/typeorm-module-options.factory';
 export * from './shared/infrastructure/database/typeorm/typeorm.module';
+export * from './shared/transport/graphql/register-shared-graphql-enums';
 export * from './shared/transport/graphql/dtos/requests/base-filter/base-filter.input';
 export * from './shared/transport/graphql/dtos/requests/base-find-by-criteria/base-find-by-criteria.input';
 export * from './shared/transport/graphql/dtos/requests/base-pagination/base-pagination.input';

package/dist/index.js

@@ -14,7 +14,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./shared/shared.module"), exports);
 __exportStar(require("./shared/application/commands/base/base-command.handler"), exports);
 __exportStar(require("./shared/application/commands/interfaces/base-command-handler.interface"), exports);
 __exportStar(require("./shared/application/commands/update/base-update/base-update.command-handler"), exports);
@@ -82,8 +81,8 @@ __exportStar(require("./shared/domain/value-objects/url/url.vo"), exports);
 __exportStar(require("./shared/domain/value-objects/uuid/uuid.vo"), exports);
 __exportStar(require("./shared/domain/view-models/base-view-model/base-view-model"), exports);
 __exportStar(require("./shared/infrastructure/database/base-database.repository"), exports);
-__exportStar(require("./shared/infrastructure/logging/formats/shared-winston.formats"), exports);
 __exportStar(require("./shared/infrastructure/logging/factories/create-shared-winston-logger-options"), exports);
+__exportStar(require("./shared/infrastructure/logging/formats/shared-winston.formats"), exports);
 __exportStar(require("./shared/infrastructure/logging/interfaces/shared-winston-logger-factory-options.interface"), exports);
 __exportStar(require("./shared/infrastructure/database/mongodb/base-mongo/base-mongo-database.repository"), exports);
 __exportStar(require("./shared/infrastructure/database/mongodb/base-mongo/base-mongo-master/base-mongo-master.repository"), exports);
@@ -96,6 +95,7 @@ __exportStar(require("./shared/infrastructure/database/typeorm/entities/base-typ
 __exportStar(require("./shared/infrastructure/database/typeorm/services/typeorm-master/typeorm-master.service"), exports);
 __exportStar(require("./shared/infrastructure/database/typeorm/typeorm-module-options.factory"), exports);
 __exportStar(require("./shared/infrastructure/database/typeorm/typeorm.module"), exports);
+__exportStar(require("./shared/transport/graphql/register-shared-graphql-enums"), exports);
 __exportStar(require("./shared/transport/graphql/dtos/requests/base-filter/base-filter.input"), exports);
 __exportStar(require("./shared/transport/graphql/dtos/requests/base-find-by-criteria/base-find-by-criteria.input"), exports);
 __exportStar(require("./shared/transport/graphql/dtos/requests/base-pagination/base-pagination.input"), exports);

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AACA,yDAAuC;AAIvC,0FAAwE;AACxE,0GAAwF;AACxF,+GAA6F;AAC7F,kHAAgG;AAChG,oGAAkF;AAKlF,2FAAyE;AAGzE,oEAAkD;AAClD,mFAAiE;AAGjE,6EAA2D;AAC3D,qFAAmE;AACnE,4EAA0D;AAC1D,mGAAiF;AACjF,uGAAqF;AAGrF,8EAA4D;AAG5D,4EAA0D;AAC1D,qHAAmG;AACnG,iHAA+F;AAC/F,2HAAyG;AACzG,iHAA+F;AAC/F,2HAAyG;AACzG,6GAA2F;AAC3F,2GAAyF;AACzF,+GAA6F;AAC7F,mHAAiG;AACjG,mHAAiG;AACjG,iIAA+G;AAC/G,uHAAqG;AACrG,iHAA+F;AAC/F,mHAAiG;AACjG,uHAAqG;AACrG,6GAA2F;AAC3F,+GAA6F;AAG7F,0FAAwE;AACxE,2FAAyE;AACzE,sFAAoE;AACpE,8FAA4E;AAC5E,8FAA4E;AAC5E,+FAA6E;AAC7E,qFAAmE;AACnE,uGAAqF;AACrF,wGAAsF;AACtF,qFAAmE;AAGnE,6FAA2E;AAG3E,uFAAqE;AACrE,mFAAiE;AACjE,+EAA6D;AAC7D,6EAA2D;AAC3D,yFAAuE;AACvE,+EAA6D;AAC7D,6EAA2D;AAC3D,2EAAyD;AACzD,yEAAuD;AACvD,6EAA2D;AAC3D,2FAAyE;AACzE,iFAA+D;AAC/D,iFAA+D;AAC/D,+FAA6E;AAC7E,qFAAmE;AACnE,yFAAuE;AACvE,+EAA6D;AAC7D,6EAA2D;AAC3D,iFAA+D;AAC/D,qFAAmE;AACnE,2EAAyD;AACzD,6EAA2D;AAG3D,8FAA4E;AAI5E,4FAA0E;AAG1E,iGAA+E;AAC/E,iHAA+F;AAC/F,6HAA2G;AAG3G,qHAAmG;AACnG,qIAAmH;AACnH,+FAA6E;AAC7E,0FAAwE;AACxE,sHAAoG;AAGpG,2IAAyH;AACzH,iGAA+E;AAC/E,wGAAsF;AACtF,0HAAwG;AACxG,0GAAwF;AACxF,0FAAwE;AAKxE,yGAAuF;AACvF,6HAA2G;AAC3G,iHAA+F;AAC/F,qGAAmF;AACnF,6GAA2F;AAG3F,4HAA0G;AAC1G,4GAA0F;AAC1F,kHAAgG;AAChG,6FAA2E;AAG3E,gHAA8F;AAG9F,uFAAqE"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAEA,0FAAwE;AACxE,0GAAwF;AACxF,+GAA6F;AAC7F,kHAAgG;AAChG,oGAAkF;AAKlF,2FAAyE;AAGzE,oEAAkD;AAClD,mFAAiE;AAGjE,6EAA2D;AAC3D,qFAAmE;AACnE,4EAA0D;AAC1D,mGAAiF;AACjF,uGAAqF;AAGrF,8EAA4D;AAG5D,4EAA0D;AAC1D,qHAAmG;AACnG,iHAA+F;AAC/F,2HAAyG;AACzG,iHAA+F;AAC/F,2HAAyG;AACzG,6GAA2F;AAC3F,2GAAyF;AACzF,+GAA6F;AAC7F,mHAAiG;AACjG,mHAAiG;AACjG,iIAA+G;AAC/G,uHAAqG;AACrG,iHAA+F;AAC/F,mHAAiG;AACjG,uHAAqG;AACrG,6GAA2F;AAC3F,+GAA6F;AAG7F,0FAAwE;AACxE,2FAAyE;AACzE,sFAAoE;AACpE,8FAA4E;AAC5E,8FAA4E;AAC5E,+FAA6E;AAC7E,qFAAmE;AACnE,uGAAqF;AACrF,wGAAsF;AACtF,qFAAmE;AAGnE,6FAA2E;AAG3E,uFAAqE;AACrE,mFAAiE;AACjE,+EAA6D;AAC7D,6EAA2D;AAC3D,yFAAuE;AACvE,+EAA6D;AAC7D,6EAA2D;AAC3D,2EAAyD;AACzD,yEAAuD;AACvD,6EAA2D;AAC3D,2FAAyE;AACzE,iFAA+D;AAC/D,iFAA+D;AAC/D,+FAA6E;AAC7E,qFAAmE;AACnE,yFAAuE;AACvE,+EAA6D;AAC7D,6EAA2D;AAC3D,iFAA+D;AAC/D,qFAAmE;AACnE,2EAAyD;AACzD,6EAA2D;AAG3D,8FAA4E;AAI5E,4FAA0E;AAG1E,iHAA+F;AAC/F,iGAA+E;AAC/E,6HAA2G;AAG3G,qHAAmG;AACnG,qIAAmH;AACnH,+FAA6E;AAC7E,0FAAwE;AACxE,sHAAoG;AAGpG,2IAAyH;AACzH,iGAA+E;AAC/E,wGAAsF;AACtF,0HAAwG;AACxG,0GAAwF;AACxF,0FAAwE;AAKxE,2FAAyE;AAGzE,yGAAuF;AACvF,6HAA2G;AAC3G,iHAA+F;AAC/F,qGAAmF;AACnF,6GAA2F;AAG3F,4HAA0G;AAC1G,4GAA0F;AAC1F,kHAAgG;AAChG,6FAA2E;AAG3E,gHAA8F;AAG9F,uFAAqE"}

package/dist/shared/transport/graphql/register-shared-graphql-enums.d.ts

@@ -0,0 +1 @@
+export declare function registerSharedGraphqlEnums(): void;

package/dist/shared/transport/graphql/register-shared-graphql-enums.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerSharedGraphqlEnums = registerSharedGraphqlEnums;
+const graphql_1 = require("@nestjs/graphql");
+const filter_operator_enum_1 = require("../../domain/enums/filter-operator.enum");
+const length_unit_enum_1 = require("../../domain/enums/length-unit/length-unit.enum");
+const sort_direction_enum_1 = require("../../domain/enums/sort-direction.enum");
+const user_role_enum_1 = require("../../domain/enums/user-context/user/user-role/user-role.enum");
+const user_status_enum_1 = require("../../domain/enums/user-context/user/user-status/user-status.enum");
+const DEFINITIONS = [
+    {
+        enum: filter_operator_enum_1.FilterOperator,
+        name: 'FilterOperator',
+        description: 'The operator to filter by',
+    },
+    {
+        enum: sort_direction_enum_1.SortDirection,
+        name: 'SortDirection',
+        description: 'The direction to sort by',
+    },
+    {
+        enum: length_unit_enum_1.LengthUnitEnum,
+        name: 'LengthUnitEnum',
+        description: 'The unit of the length',
+    },
+    {
+        enum: user_role_enum_1.UserRoleEnum,
+        name: 'UserRoleEnum',
+        description: 'The role of the user',
+    },
+    {
+        enum: user_status_enum_1.UserStatusEnum,
+        name: 'UserStatusEnum',
+        description: 'The status of the user',
+    },
+];
+let registered = false;
+function registerSharedGraphqlEnums() {
+    if (registered) {
+        return;
+    }
+    registered = true;
+    for (const { enum: enumType, name, description } of DEFINITIONS) {
+        (0, graphql_1.registerEnumType)(enumType, { name, description });
+    }
+}
+//# sourceMappingURL=register-shared-graphql-enums.js.map

package/dist/shared/transport/graphql/register-shared-graphql-enums.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"register-shared-graphql-enums.js","sourceRoot":"","sources":["../../../../src/shared/transport/graphql/register-shared-graphql-enums.ts"],"names":[],"mappings":";;AA0CA,gEAQC;AAlDD,6CAAmD;AAEnD,kFAA4E;AAC5E,sFAAoF;AACpF,gFAA0E;AAC1E,kGAAgG;AAChG,wGAAsG;AAEtG,MAAM,WAAW,GAAG;IAClB;QACE,IAAI,EAAE,qCAAc;QACpB,IAAI,EAAE,gBAAgB;QACtB,WAAW,EAAE,2BAA2B;KACzC;IACD;QACE,IAAI,EAAE,mCAAa;QACnB,IAAI,EAAE,eAAe;QACrB,WAAW,EAAE,0BAA0B;KACxC;IACD;QACE,IAAI,EAAE,iCAAc;QACpB,IAAI,EAAE,gBAAgB;QACtB,WAAW,EAAE,wBAAwB;KACtC;IACD;QACE,IAAI,EAAE,6BAAY;QAClB,IAAI,EAAE,cAAc;QACpB,WAAW,EAAE,sBAAsB;KACpC;IACD;QACE,IAAI,EAAE,iCAAc;QACpB,IAAI,EAAE,gBAAgB;QACtB,WAAW,EAAE,wBAAwB;KACtC;CACO,CAAC;AAEX,IAAI,UAAU,GAAG,KAAK,CAAC;AAMvB,SAAgB,0BAA0B;IACxC,IAAI,UAAU,EAAE,CAAC;QACf,OAAO;IACT,CAAC;IACD,UAAU,GAAG,IAAI,CAAC;IAClB,KAAK,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,WAAW,EAAE,CAAC;QAChE,IAAA,0BAAgB,EAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;IACpD,CAAC;AACH,CAAC"}