@tc-libs/database 3.6.0 → 3.8.0

package/README.md

@@ -1,11 +1,90 @@
-# database
+# @tc-libs/database
 
-This library was generated with [Nx](https://nx.dev).
+Layer base Mongo/Mongoose del monorepo.
 
-## Building
+Il package contiene:
 
-Run `nx build database` to build the library.
+- `DatabaseOptionsModule` per costruire `MongooseModuleOptions`
+- abstract entity/repository riusabili
+- interfacce per query, sessioni, cache e pagination
+- costanti e decorator di supporto
 
-## Running unit tests
+## `DatabaseOptionsModule`
 
-Run `nx test database` to execute the unit tests via [Jest](https://jestjs.io).
+Serve per centralizzare la costruzione della connection string Mongo:
+
+```ts
+DatabaseOptionsModule.register({
+  proto: 'mongodb',
+  host: '127.0.0.1:27017',
+  port: 27017,
+  name: 'mydb',
+  user: 'mongo',
+  password: 'secret',
+  debug: false,
+});
+```
+
+Poi:
+
+```ts
+MongooseModule.forRootAsync({
+  imports: [DatabaseOptionsModule.register(...)],
+  useExisting: DatabaseOptionsService,
+});
+```
+
+## Repository base
+
+La classe piu importante e `DatabaseMongoRepositoryAbstract<Entity, EntityDocument>`.
+
+Fornisce:
+
+- CRUD standard
+- join/populate opzionale
+- `returnPlain`
+- supporto `ClientSession`
+- integrazione cache con `@tc-libs/app-cache`
+- `raw()` per aggregate pipeline
+- `startTransaction()`
+
+## Esempio repository custom
+
+```ts
+export class UserRepository extends DatabaseMongoRepositoryAbstract<
+  UserEntity,
+  UserDoc
+> {
+  protected readonly _logger = new Logger(UserRepository.name);
+
+  constructor(
+    @InjectModel(UserEntity.name) model: Model<UserEntity>,
+    @InjectConnection() connection: Connection,
+    cache: AppCacheService,
+  ) {
+    super(model, connection, cache);
+  }
+}
+```
+
+## Abstract entity
+
+- `DatabaseBaseEntityAbstract`
+- `DatabaseMongoEntityAbstract`
+
+Ti evitano di ridefinire sempre `_id`, `createdAt`, `updatedAt`.
+
+## Interfacce piu usate
+
+- `IDatabaseFindOneOptions`
+- `IDatabaseFindAllOptions`
+- `IDatabaseCreateOptions`
+- `IDatabaseManyOptions`
+- `IDatabaseFindOneAndUpdateOptions`
+
+## Sviluppo
+
+```bash
+nx build database
+nx test database
+```

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@tc-libs/database",
-  "version": "3.6.0",
+  "version": "3.8.0",
   "dependencies": {
-    "@tc-libs/app-cache": "3.6.0",
-    "@tc-libs/pagination": "3.6.0",
+    "@tc-libs/app-cache": "3.8.0",
+    "@tc-libs/pagination": "3.8.0",
     "@nestjs/mongoose": "^11.0.3",
     "mongoose": "^8.13.1",
     "@nestjs/common": "^11.0.12",

package/src/interfaces/index.d.ts

@@ -1,3 +1,4 @@
 export * from './database.interface';
 export * from './database.mongo.base.entity.interface';
 export * from './i18n.entity.interface';
+export * from './seo.entity.interface';

package/src/interfaces/index.js

@@ -4,4 +4,5 @@ const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./database.interface"), exports);
 tslib_1.__exportStar(require("./database.mongo.base.entity.interface"), exports);
 tslib_1.__exportStar(require("./i18n.entity.interface"), exports);
+tslib_1.__exportStar(require("./seo.entity.interface"), exports);
 //# sourceMappingURL=index.js.map

package/src/interfaces/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/database/src/interfaces/index.ts"],"names":[],"mappings":";;;AAAA,+DAAqC;AACrC,iFAAuD;AACvD,kEAAwC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/database/src/interfaces/index.ts"],"names":[],"mappings":";;;AAAA,+DAAqC;AACrC,iFAAuD;AACvD,kEAAwC;AACxC,iEAAuC"}

package/src/interfaces/seo.entity.interface.d.ts

@@ -0,0 +1,15 @@
+import { I18nEntity } from './i18n.entity.interface';
+export declare class SeoEntity {
+    title: I18nEntity;
+    description: I18nEntity;
+    tags?: I18nEntity[];
+}
+export declare const SeoEntitySchema: import("mongoose").Schema<SeoEntity, import("mongoose").Model<SeoEntity, any, any, any, import("mongoose").Document<unknown, any, SeoEntity> & SeoEntity & {
+    _id: import("mongoose").Types.ObjectId;
+} & {
+    __v: number;
+}, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, SeoEntity, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<SeoEntity>> & import("mongoose").FlatRecord<SeoEntity> & {
+    _id: import("mongoose").Types.ObjectId;
+} & {
+    __v: number;
+}>;

package/src/interfaces/seo.entity.interface.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SeoEntitySchema = exports.SeoEntity = void 0;
+const tslib_1 = require("tslib");
+const mongoose_1 = require("@nestjs/mongoose");
+let SeoEntity = class SeoEntity {
+};
+exports.SeoEntity = SeoEntity;
+exports.SeoEntity = SeoEntity = tslib_1.__decorate([
+    (0, mongoose_1.Schema)({ _id: false, timestamps: false, strict: false })
+], SeoEntity);
+exports.SeoEntitySchema = mongoose_1.SchemaFactory.createForClass(SeoEntity);
+//# sourceMappingURL=seo.entity.interface.js.map

package/src/interfaces/seo.entity.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"seo.entity.interface.js","sourceRoot":"","sources":["../../../../../packages/database/src/interfaces/seo.entity.interface.ts"],"names":[],"mappings":";;;;AAAA,+CAAyD;AAIlD,IAAM,SAAS,GAAf,MAAM,SAAS;CAIrB,CAAA;AAJY,8BAAS;oBAAT,SAAS;IADrB,IAAA,iBAAM,EAAC,EAAE,GAAG,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;GAC5C,SAAS,CAIrB;AAEY,QAAA,eAAe,GAAG,wBAAa,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC"}