@russ-b/nestjs-common-tools 1.14.0 → 1.14.1

package/README.md

@@ -1,5 +1,4 @@
 # nestjs-common-tools
-NestJS Common Tools
 
 A small toolbox for NestJS with helpers that often come up in day-to-day development.
 
@@ -15,9 +14,25 @@ npm install @russ-b/nestjs-common-tools
 
 Depending on which features you use, make sure the relevant peer dependencies are also installed in your project.
 
+## Public entrypoints
+
+This package uses subpath exports for most features.
+
+| Import path | What it contains |
+|-------------|------------------|
+| `@russ-b/nestjs-common-tools` | root exports such as `services` |
+| `@russ-b/nestjs-common-tools/class-transformer` | reusable `class-transformer` decorators and helpers |
+| `@russ-b/nestjs-common-tools/modules` | NestJS modules such as `S3Module` |
+| `@russ-b/nestjs-common-tools/validators` | validation decorators and constraints |
+| `@russ-b/nestjs-common-tools/typeorm` | TypeORM filters, helpers, transformers, and types |
+| `@russ-b/nestjs-common-tools/logger` | logger builder and logger-related interfaces/types |
+| `@russ-b/nestjs-common-tools/common/util` | generic utility helpers |
+| `@russ-b/nestjs-common-tools/common/pagination` | pagination DTOs and helpers |
+| `@russ-b/nestjs-common-tools/common/filters` | shared filter exports |
+
 ## Class Transformer Helpers
 
-This package can also expose small reusable decorators for `class-transformer`.
+This package also exposes small reusable decorators for `class-transformer`.
 
 ### `ToStringArray`
 
@@ -37,17 +52,17 @@ It will:
 - split string values by comma
 - trim extra spaces around items
 - remove empty values
-- flatten array inputs like `['cars, bikes', 'boats']` into `['cars', 'bikes', 'boats']`
+- normalize a string like `'cars, bikes, boats'` into `['cars', 'bikes', 'boats']`
 
-### `ToOptionalBoolean`
+### `ToBooleanFromString`
 
-`ToOptionalBoolean()` is useful for DTO fields that may arrive as `'true'` or `'false'` strings and should become real booleans.
+`ToBooleanFromString()` is useful for DTO fields that may arrive as `'true'` or `'false'` strings and should become real booleans.
 
 ```typescript
-import { ToOptionalBoolean } from '@russ-b/nestjs-common-tools/class-transformer';
+import { ToBooleanFromString } from '@russ-b/nestjs-common-tools/class-transformer';
 
 export class SearchDto {
-  @ToOptionalBoolean()
+  @ToBooleanFromString()
   archived?: boolean;
 }
 ```
@@ -94,7 +109,6 @@ import { S3Module } from '@russ-b/nestjs-common-tools/modules';
         region: config.get<string>('AWS_REGION') ?? 'eu-central-1',
         bucket: config.get<string>('S3_BUCKET'),
         endpoint: config.get<string>('S3_ENDPOINT'),
-        forcePathStyle: config.get<string>('S3_FORCE_PATH_STYLE') === 'true',
         logger: config.get<string>('S3_DEBUG') === 'true',
       }),
     }),
@@ -120,8 +134,12 @@ AWS_SECRET_ACCESS_KEY=your-secret-key
 S3_BUCKET=my-app-bucket
 ```
 
+The AWS SDK reads values from process environment, not directly from a `.env` file, so make sure your application loads those variables before creating the client.
+
 `endpoint` is optional and is mostly useful for S3-compatible providers such as MinIO or LocalStack.
 
+`forcePathStyle` defaults to `true` in this module. That is usually convenient for MinIO and LocalStack. If you want standard AWS virtual-hosted URLs, set `forcePathStyle: false`.
+
 ### Optional logging
 
 By default, the module stays silent and does not write S3 operation logs.
@@ -239,7 +257,9 @@ A custom validator for NestJS that validates if an entity exists in the database
 
 ```typescript
 // main.ts
+import { NestFactory } from '@nestjs/core';
 import { useContainer } from 'class-validator';
+import { AppModule } from './app.module';
 
 async function bootstrap() {
   const app = await NestFactory.create(AppModule);
@@ -257,7 +277,6 @@ async function bootstrap() {
 ```typescript
 // app.module.ts
 import { Module } from '@nestjs/common';
-import { TypeOrmModule } from '@nestjs/typeorm';
 import { EntityConstraint } from '@russ-b/nestjs-common-tools/validators';
 
 @Module({

package/dist/class-transformer/index.d.ts

@@ -1,2 +1,2 @@
 export * from './to-string-array.decorator';
-export * from './to-optional-boolean.decorator';
+export * from './to-boolean-from-string.decorator';

package/dist/class-transformer/index.js

@@ -15,5 +15,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./to-string-array.decorator"), exports);
-__exportStar(require("./to-optional-boolean.decorator"), exports);
+__exportStar(require("./to-boolean-from-string.decorator"), exports);
 //# sourceMappingURL=index.js.map

package/dist/class-transformer/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/class-transformer/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8DAA4C;AAC5C,kEAAgD"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/class-transformer/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8DAA4C;AAC5C,qEAAmD"}

package/dist/class-transformer/to-boolean-from-string.decorator.d.ts

@@ -0,0 +1,3 @@
+import { TransformFnParams } from 'class-transformer';
+export declare function ToBooleanFromString(): PropertyDecorator;
+export declare const parseBooleanFromStringTransformer: ({ value, }: TransformFnParams) => unknown;

package/dist/class-transformer/{to-optional-boolean.decorator.js → to-boolean-from-string.decorator.js}

@@ -1,14 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseOptionalBooleanTransformer = void 0;
-exports.ToOptionalBoolean = ToOptionalBoolean;
+exports.parseBooleanFromStringTransformer = void 0;
+exports.ToBooleanFromString = ToBooleanFromString;
 const class_transformer_1 = require("class-transformer");
-function ToOptionalBoolean() {
-    return (0, class_transformer_1.Transform)(exports.parseOptionalBooleanTransformer);
+function ToBooleanFromString() {
+    return (0, class_transformer_1.Transform)(exports.parseBooleanFromStringTransformer);
 }
-const parseOptionalBooleanTransformer = ({ value, }) => normalizeOptionalBoolean(value);
-exports.parseOptionalBooleanTransformer = parseOptionalBooleanTransformer;
-function normalizeOptionalBoolean(value) {
+const parseBooleanFromStringTransformer = ({ value, }) => normalizeBooleanFromString(value);
+exports.parseBooleanFromStringTransformer = parseBooleanFromStringTransformer;
+function normalizeBooleanFromString(value) {
     if (value === undefined) {
         return undefined;
     }
@@ -26,4 +26,4 @@ function normalizeOptionalBoolean(value) {
     }
     return value;
 }
-//# sourceMappingURL=to-optional-boolean.decorator.js.map
+//# sourceMappingURL=to-boolean-from-string.decorator.js.map

package/dist/class-transformer/to-boolean-from-string.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"to-boolean-from-string.decorator.js","sourceRoot":"","sources":["../../src/class-transformer/to-boolean-from-string.decorator.ts"],"names":[],"mappings":";;;AAEA,kDAEC;AAJD,yDAAiE;AAEjE,SAAgB,mBAAmB;IACjC,OAAO,IAAA,6BAAS,EAAC,yCAAiC,CAAC,CAAC;AACtD,CAAC;AAEM,MAAM,iCAAiC,GAAG,CAAC,EAChD,KAAK,GACa,EAAW,EAAE,CAAC,0BAA0B,CAAC,KAAK,CAAC,CAAC;AAFvD,QAAA,iCAAiC,qCAEsB;AAEpE,SAAS,0BAA0B,CAAC,KAAc;IAChD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE,CAAC;QAC/B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,MAAM,eAAe,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QAEnD,IAAI,eAAe,KAAK,MAAM,EAAE,CAAC;YAC/B,OAAO,IAAI,CAAC;QACd,CAAC;QAED,IAAI,eAAe,KAAK,OAAO,EAAE,CAAC;YAChC,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@russ-b/nestjs-common-tools",
-  "version": "1.14.0",
+  "version": "1.14.1",
   "description": "NestJS utility tools",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/dist/class-transformer/to-optional-boolean.decorator.d.ts

@@ -1,3 +0,0 @@
-import { TransformFnParams } from 'class-transformer';
-export declare function ToOptionalBoolean(): PropertyDecorator;
-export declare const parseOptionalBooleanTransformer: ({ value, }: TransformFnParams) => unknown;

package/dist/class-transformer/to-optional-boolean.decorator.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"to-optional-boolean.decorator.js","sourceRoot":"","sources":["../../src/class-transformer/to-optional-boolean.decorator.ts"],"names":[],"mappings":";;;AAEA,8CAEC;AAJD,yDAAiE;AAEjE,SAAgB,iBAAiB;IAC/B,OAAO,IAAA,6BAAS,EAAC,uCAA+B,CAAC,CAAC;AACpD,CAAC;AAEM,MAAM,+BAA+B,GAAG,CAAC,EAC9C,KAAK,GACa,EAAW,EAAE,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC;AAFrD,QAAA,+BAA+B,mCAEsB;AAElE,SAAS,wBAAwB,CAAC,KAAc;IAC9C,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE,CAAC;QAC/B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,MAAM,eAAe,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QAEnD,IAAI,eAAe,KAAK,MAAM,EAAE,CAAC;YAC/B,OAAO,IAAI,CAAC;QACd,CAAC;QAED,IAAI,eAAe,KAAK,OAAO,EAAE,CAAC;YAChC,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC"}