@metapic/nestjs-utils 1.0.1 → 1.0.2

package/README.md

@@ -1,7 +1,25 @@
 # nestjs-utils
 
-Utilities and helpers for [Nest.js](https://nestjs.com/) + [TypeORM](https://typeorm.io/).
+Utility helpers for [Nest.js](https://nestjs.com/) projects. Comes with opinionated defaults for [TypeORM](https://typeorm.io/), [Swagger](https://docs.nestjs.com/openapi/introduction) and serialisation:
+
+- Symbols (e.g. DTO property names) always **camelCase**.
+- API JSON payload property names always **snake_case**.
+- Database column names always **snake_case**.
+
+See the [example app](./example) for a fully wired showcase of all features.
+
+**Important**: Serialisation uses [class-transformer](https://github.com/typestack/class-transformer)/[class-validator](https://github.com/typestack/class-validator) (see [Nest.js docs](https://docs.nestjs.com/techniques/serialization)). You can use the following helpers for easy setup (see also [`example/src/app.module.ts`](./example/src/app.module.ts))
+
+```ts
+import { Module } from '@nestjs/common'
+import { SERIALIZATION_INTERCEPTOR, VALIDATION_PIPE } from '@metapic/nestjs-utils'
+
+@Module({
+  providers: [SERIALIZATION_INTERCEPTOR, VALIDATION_PIPE],
+})
+export class AppModule {}
+```
 
 ## Testing
 
-All testing is done via [the e2e tests in the example project](./example/test).
+All testing runs through the example app’s e2e suite: [example/test](example/test).

package/dist/index.d.ts

@@ -1,3 +1,5 @@
+export * from './nestjs.js';
 export * from './pagination.js';
 export * from './serialization.js';
+export * from './swagger.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA;AAC/B,cAAc,oBAAoB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,oBAAoB,CAAA;AAClC,cAAc,cAAc,CAAA"}

package/dist/index.js

@@ -1,3 +1,5 @@
+export * from './nestjs.js';
 export * from './pagination.js';
 export * from './serialization.js';
+export * from './swagger.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA;AAC/B,cAAc,oBAAoB,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,oBAAoB,CAAA;AAClC,cAAc,cAAc,CAAA"}

package/dist/nestjs.d.ts

@@ -0,0 +1,10 @@
+import { ClassSerializerInterceptor, ValidationPipe } from '@nestjs/common';
+export declare const SERIALIZATION_INTERCEPTOR: {
+    provide: string;
+    useClass: typeof ClassSerializerInterceptor;
+};
+export declare const VALIDATION_PIPE: {
+    provide: string;
+    useValue: ValidationPipe;
+};
+//# sourceMappingURL=nestjs.d.ts.map

package/dist/nestjs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"nestjs.d.ts","sourceRoot":"","sources":["../src/nestjs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAc,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAGvF,eAAO,MAAM,yBAAyB;;;CAGrC,CAAA;AAED,eAAO,MAAM,eAAe;;;CAO3B,CAAA"}

package/dist/nestjs.js

@@ -0,0 +1,15 @@
+import { ClassSerializerInterceptor, HttpStatus, ValidationPipe } from '@nestjs/common';
+import { APP_INTERCEPTOR, APP_PIPE } from '@nestjs/core';
+export const SERIALIZATION_INTERCEPTOR = {
+    provide: APP_INTERCEPTOR,
+    useClass: ClassSerializerInterceptor,
+};
+export const VALIDATION_PIPE = {
+    provide: APP_PIPE,
+    useValue: new ValidationPipe({
+        transform: true,
+        transformOptions: { enableImplicitConversion: true },
+        errorHttpStatusCode: HttpStatus.UNPROCESSABLE_ENTITY,
+    }),
+};
+//# sourceMappingURL=nestjs.js.map

package/dist/nestjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nestjs.js","sourceRoot":"","sources":["../src/nestjs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AACvF,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAA;AAExD,MAAM,CAAC,MAAM,yBAAyB,GAAG;IACvC,OAAO,EAAE,eAAe;IACxB,QAAQ,EAAE,0BAA0B;CACrC,CAAA;AAED,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,OAAO,EAAE,QAAQ;IACjB,QAAQ,EAAE,IAAI,cAAc,CAAC;QAC3B,SAAS,EAAE,IAAI;QACf,gBAAgB,EAAE,EAAE,wBAAwB,EAAE,IAAI,EAAE;QACpD,mBAAmB,EAAE,UAAU,CAAC,oBAAoB;KACrD,CAAC;CACH,CAAA"}