@zola_do/typeorm 0.2.8 → 0.2.12

package/README.md

@@ -12,7 +12,7 @@ TypeORM configuration helpers and service for NestJS applications.
 
 - **Environment-based Configuration** — Database settings from environment variables
 - **Auto-entity Discovery** — Automatically loads entities and migrations
-- **DataSource Options** — TypeORM 0.3+ compatible configuration
+- **DataSource Options** — TypeORM 0.3+ and 1.0 compatible configuration
 - **Config Service** — Injectable service for database access
 
 ## Installation
@@ -28,9 +28,13 @@ npm install @zola_do/nestjs-shared
 ### Dependencies
 
 ```bash
-npm install @nestjs/typeorm typeorm typeorm-extension dotenv
+npm install @nestjs/typeorm typeorm dotenv
 ```
 
+`typeorm-extension` is optional (for seeding CLI). `@zola_do/typeorm` exports a local `SeederOptions` type so seed config works without importing `typeorm-extension`.
+
+**TypeORM 1.0:** Use `@nestjs/typeorm` ≥ 11.0.1 and Node.js 20+. Peer range supports `^0.3.0 || ^1.0.0`.
+
 ## Read replicas (TypeORM `replication`)
 
 `@zola_do/typeorm` exposes `dataSourceOptions` as a starting point. For read scaling, use TypeORM's [`replication`](https://typeorm.io/data-source-options#postgres--cockroachdb--sap-hana--sql.js) option in the object you pass to `TypeOrmModule.forRoot`: supply `master` (writer) and `slaves` (readers). Environment variables are then modeled in your app (for example `DATABASE_REPLICA_HOSTS` parsed to an array) rather than hard-coded in the library.
@@ -52,9 +56,9 @@ APP_NAME=myapp
 ### 2. Register in AppModule
 
 ```typescript
-import { Module } from "@nestjs/common";
-import { TypeOrmModule } from "@nestjs/typeorm";
-import { dataSourceOptions } from "@zola_do/typeorm";
+import { Module } from '@nestjs/common';
+import { TypeOrmModule } from '@nestjs/typeorm';
+import { dataSourceOptions } from '@zola_do/typeorm';
 
 @Module({
   imports: [TypeOrmModule.forRoot(dataSourceOptions)],
@@ -65,15 +69,15 @@ export class AppModule {}
 ### 3. Use Entities
 
 ```typescript
-import { CommonEntity } from "@zola_do/nestjs-shared";
-import { Entity, Column } from "typeorm";
+import { CommonEntity } from '@zola_do/nestjs-shared';
+import { Entity, Column } from 'typeorm';
 
-@Entity("products")
+@Entity('products')
 export class Product extends CommonEntity {
   @Column()
   name: string;
 
-  @Column("decimal", { precision: 10, scale: 2 })
+  @Column('decimal', { precision: 10, scale: 2 })
   price: number;
 }
 ```
@@ -85,12 +89,12 @@ export class Product extends CommonEntity {
 All entities should extend `CommonEntity` for consistent audit fields:
 
 ```typescript
-import { CommonEntity } from "@zola_do/nestjs-shared";
-import { Entity, Column, PrimaryGeneratedColumn } from "typeorm";
+import { CommonEntity } from '@zola_do/nestjs-shared';
+import { Entity, Column, PrimaryGeneratedColumn } from 'typeorm';
 
-@Entity("products")
+@Entity('products')
 export class Product extends CommonEntity {
-  @PrimaryGeneratedColumn("uuid")
+  @PrimaryGeneratedColumn('uuid')
   id: string;
 
   @Column()
@@ -114,9 +118,9 @@ export class Product extends CommonEntity {
 #### Basic Entity
 
 ```typescript
-@Entity("categories")
+@Entity('categories')
 export class Category extends CommonEntity {
-  @PrimaryGeneratedColumn("uuid")
+  @PrimaryGeneratedColumn('uuid')
   id: string;
 
   @Column()
@@ -133,22 +137,22 @@ export class Category extends CommonEntity {
 #### Entity with Relations
 
 ```typescript
-@Entity("orders")
+@Entity('orders')
 export class Order extends CommonEntity {
-  @PrimaryGeneratedColumn("uuid")
+  @PrimaryGeneratedColumn('uuid')
   id: string;
 
   @Column()
   customerId: string;
 
-  @Column("decimal", { precision: 10, scale: 2 })
+  @Column('decimal', { precision: 10, scale: 2 })
   total: number;
 
-  @Column({ default: "pending" })
+  @Column({ default: 'pending' })
   status: string;
 
   @ManyToOne(() => Customer, (customer) => customer.orders)
-  @JoinColumn({ name: "customerId" })
+  @JoinColumn({ name: 'customerId' })
   customer: Customer;
 
   @OneToMany(() => OrderItem, (item) => item.order)
@@ -159,20 +163,20 @@ export class Order extends CommonEntity {
 #### Entity with Indexes
 
 ```typescript
-@Entity("products", {
+@Entity('products', {
   indexes: [
-    { name: "idx_product_name", columns: ["name"] },
-    { name: "idx_product_status_price", columns: ["status", "price"] },
+    { name: 'idx_product_name', columns: ['name'] },
+    { name: 'idx_product_status_price', columns: ['status', 'price'] },
   ],
 })
 export class Product extends CommonEntity {
   @Column()
   name: string;
 
-  @Column({ default: "active" })
+  @Column({ default: 'active' })
   status: string;
 
-  @Column("decimal", { precision: 10, scale: 2 })
+  @Column('decimal', { precision: 10, scale: 2 })
   price: number;
 }
 ```
@@ -182,7 +186,7 @@ export class Product extends CommonEntity {
 Access individual configuration values:
 
 ```typescript
-import { TypeOrmConfigHelper } from "@zola_do/typeorm";
+import { TypeOrmConfigHelper } from '@zola_do/typeorm';
 
 console.log(TypeOrmConfigHelper.DATABASE_HOST); // 'localhost'
 console.log(TypeOrmConfigHelper.DATABASE_PORT); // 5432
@@ -207,8 +211,8 @@ console.log(TypeOrmConfigHelper.DATABASE_PASSWORD); // 'secret'
 Injectable service for direct database access:
 
 ```typescript
-import { Injectable } from "@nestjs/common";
-import { TypeOrmService } from "@zola_do/typeorm";
+import { Injectable } from '@nestjs/common';
+import { TypeOrmService } from '@zola_do/typeorm';
 
 @Injectable()
 export class AnalyticsService {
@@ -256,7 +260,7 @@ import { dataSourceOptions } from '@zola_do/typeorm';
 
 ```typescript
 // app.module.ts
-import { dataSourceOptions } from "@zola_do/typeorm";
+import { dataSourceOptions } from '@zola_do/typeorm';
 
 @Module({
   imports: [
@@ -264,7 +268,7 @@ import { dataSourceOptions } from "@zola_do/typeorm";
       ...dataSourceOptions,
       synchronize: false,
       migrationsRun: true,
-      logging: ["error", "warn"],
+      logging: ['error', 'warn'],
     }),
   ],
 })
@@ -294,12 +298,12 @@ Entities and migrations are auto-discovered:
 ```typescript
 // dataSourceOptions.entities supports glob patterns
 entities: [
-  __dirname + "/../../**/*.entity.js", // Compiled output
-  "**/*.entity.js", // Source files
+  __dirname + '/../../**/*.entity.js', // Compiled output
+  '**/*.entity.js', // Source files
 ];
 
 // dataSourceOptions.migrations supports glob patterns
-migrations: [__dirname + "/../../**/*.migration.js"];
+migrations: [__dirname + '/../../**/*.migration.js'];
 ```
 
 ### Entity File Location
@@ -330,24 +334,24 @@ npx typeorm migration:run -d dist/typeorm/data-source.js
 ### Create Migration Manually
 
 ```typescript
-import { MigrationInterface, QueryRunner, Table } from "typeorm";
+import { MigrationInterface, QueryRunner, Table } from 'typeorm';
 
 export class CreateProducts1704064000000 implements MigrationInterface {
   public async up(queryRunner: QueryRunner): Promise<void> {
     await queryRunner.createTable(
       new Table({
-        name: "products",
+        name: 'products',
         columns: [
           {
-            name: "id",
-            type: "uuid",
+            name: 'id',
+            type: 'uuid',
             isPrimary: true,
-            generationStrategy: "uuid",
+            generationStrategy: 'uuid',
           },
-          { name: "name", type: "varchar" },
-          { name: "price", type: "decimal", precision: 10, scale: 2 },
-          { name: "created_at", type: "timestamp", default: "now()" },
-          { name: "updated_at", type: "timestamp", default: "now()" },
+          { name: 'name', type: 'varchar' },
+          { name: 'price', type: 'decimal', precision: 10, scale: 2 },
+          { name: 'created_at', type: 'timestamp', default: 'now()' },
+          { name: 'updated_at', type: 'timestamp', default: 'now()' },
         ],
       }),
       true,
@@ -355,7 +359,7 @@ export class CreateProducts1704064000000 implements MigrationInterface {
   }
 
   public async down(queryRunner: QueryRunner): Promise<void> {
-    await queryRunner.dropTable("products");
+    await queryRunner.dropTable('products');
   }
 }
 ```
@@ -375,14 +379,14 @@ TypeOrmConfigHelper.DATABASE_PASSWORD;
 ### DataSource
 
 ```typescript
-import { dataSourceOptions } from "@zola_do/typeorm";
+import { dataSourceOptions } from '@zola_do/typeorm';
 // Type: DataSourceOptions
 ```
 
 ### Service
 
 ```typescript
-import { TypeOrmService } from "@zola_do/typeorm";
+import { TypeOrmService } from '@zola_do/typeorm';
 
 @Injectable()
 class MyService {
@@ -401,7 +405,7 @@ class MyService {
 Check glob pattern in `dataSourceOptions.entities`. The pattern should match your compiled `.js` files:
 
 ```typescript
-entities: [__dirname + "/../../**/*.entity.js"];
+entities: [__dirname + '/../../**/*.entity.js'];
 ```
 
 ### Q: Migrations not running?

package/dist/index.d.ts

@@ -1,2 +1,3 @@
 export * from './typeorm-config-helper';
 export * from './typeorm.service';
+export * from './seeder-options';

package/dist/index.js

@@ -16,4 +16,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./typeorm-config-helper"), exports);
 __exportStar(require("./typeorm.service"), exports);
+__exportStar(require("./seeder-options"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0DAAwC;AACxC,oDAAkC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0DAAwC;AACxC,oDAAkC;AAClC,mDAAiC"}

package/dist/seeder-options.d.ts

@@ -0,0 +1,3 @@
+export interface SeederOptions {
+    seeds?: string[];
+}

package/dist/seeder-options.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=seeder-options.js.map

package/dist/seeder-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"seeder-options.js","sourceRoot":"","sources":["../src/seeder-options.ts"],"names":[],"mappings":""}

package/dist/typeorm-config-helper.d.ts

@@ -1,5 +1,5 @@
-import { SeederOptions } from 'typeorm-extension';
 import { DataSource, DataSourceOptions } from 'typeorm';
+import { SeederOptions } from './seeder-options';
 export declare const TypeOrmConfigHelper: {
     DATABASE_HOST: string;
     DATABASE_PORT: string;

package/dist/typeorm-config-helper.js

@@ -42,10 +42,7 @@ exports.dataSourceOptions = {
     database: exports.TypeOrmConfigHelper.DATABASE_NAME,
     username: exports.TypeOrmConfigHelper.DATABASE_USER,
     password: exports.TypeOrmConfigHelper.DATABASE_PASSWORD,
-    entities: [
-        entities,
-        views
-    ],
+    entities: [entities, views],
     migrations: [migrations],
     migrationsRun: true,
     seeds: [seeds],
@@ -55,8 +52,8 @@ exports.dataSourceOptions = {
     synchronize: false,
     autoLoadEntities: true,
     invalidWhereValuesBehavior: {
-        null: "sql-null",
-        undefined: "throw",
+        null: 'sql-null',
+        undefined: 'throw',
     },
 };
 const dataSources = new typeorm_1.DataSource(exports.dataSourceOptions);

package/dist/typeorm-config-helper.js.map

@@ -1 +1 @@
-{"version":3,"file":"typeorm-config-helper.js","sourceRoot":"","sources":["../src/typeorm-config-helper.ts"],"names":[],"mappings":";;;;AAAA,iCAAiC;AAEjC,qCAAwD;AACxD,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;AAGhC,MAAM,sBAAsB,GAAG,GAAG,EAAE;IAClC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,CAAC;QACnC,MAAM,IAAI,KAAK,CACb,iGAAiG,CAClG,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;QACxD,MAAM,IAAI,KAAK,CACb,oEAAoE,CACrE,CAAC;IACJ,CAAC;AACH,CAAC,CAAC;AAGF,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY,EAAE,CAAC;IAC1C,sBAAsB,EAAE,CAAC;AAC3B,CAAC;AAEY,QAAA,mBAAmB,GAAG;IACjC,aAAa,EAAE,MAAA,OAAO,CAAC,GAAG,CAAC,aAAa,mCAAI,WAAW;IACvD,aAAa,EAAE,MAAA,OAAO,CAAC,GAAG,CAAC,aAAa,mCAAI,MAAM;IAClD,aAAa,EAAE,MAAA,OAAO,CAAC,GAAG,CAAC,aAAa,mCAAI,OAAO,CAAC,GAAG,CAAC,QAAQ;IAChE,aAAa,EAAE,MAAA,OAAO,CAAC,GAAG,CAAC,aAAa,mCAAI,UAAU;IACtD,iBAAiB,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB;CACjD,CAAC;AAEF,MAAM,QAAQ,GACZ,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY;IACnC,CAAC,CAAC,gBAAgB;IAClB,CAAC,CAAC,0BAA0B,CAAC;AAGjC,MAAM,KAAK,GACT,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY;IACrC,CAAC,CAAC,cAAc;IAChB,CAAC,CAAC,wBAAwB,CAAC;AAE7B,MAAM,UAAU,GACd,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY;IACnC,CAAC,CAAC,sBAAsB;IACxB,CAAC,CAAC,8BAA8B,CAAC;AAErC,MAAM,KAAK,GACT,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY;IACnC,CAAC,CAAC,CAAC,MAAA,OAAO,CAAC,GAAG,CAAC,6BAA6B,mCAC1C,mCAAmC,CAAC;IACtC,CAAC,CAAC,CAAC,MAAA,OAAO,CAAC,GAAG,CAAC,sBAAsB,mCACnC,2CAA2C,CAAC,CAAC;AAEtC,QAAA,iBAAiB,GAAG;IAC/B,IAAI,EAAE,UAAU;IAChB,IAAI,EAAE,2BAAmB,CAAC,aAAa;IACvC,IAAI,EAAE,MAAM,CAAC,2BAAmB,CAAC,aAAa,CAAC;IAC/C,QAAQ,EAAE,2BAAmB,CAAC,aAAa;IAC3C,QAAQ,EAAE,2BAAmB,CAAC,aAAa;IAC3C,QAAQ,EAAE,2BAAmB,CAAC,iBAAiB;IAC/C,QAAQ,EAAE;QACR,QAAQ;QACR,KAAK;KACN;IACD,UAAU,EAAE,CAAC,UAAU,CAAC;IACxB,aAAa,EAAE,IAAI;IACnB,KAAK,EAAE,CAAC,KAAK,CAAC;IACd,mBAAmB,EAAE,oBAAoB;IACzC,MAAM,EAAE,kBAAkB;IAC1B,OAAO,EAAE,KAAK;IACd,WAAW,EAAE,KAAK;IAClB,gBAAgB,EAAE,IAAI;IACtB,0BAA0B,EAAE;QAC1B,IAAI,EAAE,UAAU;QAChB,SAAS,EAAE,OAAO;KACnB;CACmC,CAAC;AAEvC,MAAM,WAAW,GAAG,IAAI,oBAAU,CAAC,yBAAiB,CAAC,CAAC;AAEtD,kBAAe,WAAW,CAAC"}
+{"version":3,"file":"typeorm-config-helper.js","sourceRoot":"","sources":["../src/typeorm-config-helper.ts"],"names":[],"mappings":";;;;AAAA,iCAAiC;AACjC,qCAAwD;AAExD,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;AAGhC,MAAM,sBAAsB,GAAG,GAAG,EAAE;IAClC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,CAAC;QACnC,MAAM,IAAI,KAAK,CACb,iGAAiG,CAClG,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;QACxD,MAAM,IAAI,KAAK,CACb,oEAAoE,CACrE,CAAC;IACJ,CAAC;AACH,CAAC,CAAC;AAGF,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY,EAAE,CAAC;IAC1C,sBAAsB,EAAE,CAAC;AAC3B,CAAC;AAEY,QAAA,mBAAmB,GAAG;IACjC,aAAa,EAAE,MAAA,OAAO,CAAC,GAAG,CAAC,aAAa,mCAAI,WAAW;IACvD,aAAa,EAAE,MAAA,OAAO,CAAC,GAAG,CAAC,aAAa,mCAAI,MAAM;IAClD,aAAa,EAAE,MAAA,OAAO,CAAC,GAAG,CAAC,aAAa,mCAAI,OAAO,CAAC,GAAG,CAAC,QAAQ;IAChE,aAAa,EAAE,MAAA,OAAO,CAAC,GAAG,CAAC,aAAa,mCAAI,UAAU;IACtD,iBAAiB,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB;CACjD,CAAC;AAEF,MAAM,QAAQ,GACZ,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY;IACnC,CAAC,CAAC,gBAAgB;IAClB,CAAC,CAAC,0BAA0B,CAAC;AAEjC,MAAM,KAAK,GACT,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY;IACnC,CAAC,CAAC,cAAc;IAChB,CAAC,CAAC,wBAAwB,CAAC;AAE/B,MAAM,UAAU,GACd,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY;IACnC,CAAC,CAAC,sBAAsB;IACxB,CAAC,CAAC,8BAA8B,CAAC;AAErC,MAAM,KAAK,GACT,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY;IACnC,CAAC,CAAC,CAAC,MAAA,OAAO,CAAC,GAAG,CAAC,6BAA6B,mCAC1C,mCAAmC,CAAC;IACtC,CAAC,CAAC,CAAC,MAAA,OAAO,CAAC,GAAG,CAAC,sBAAsB,mCACnC,2CAA2C,CAAC,CAAC;AAEtC,QAAA,iBAAiB,GAAG;IAC/B,IAAI,EAAE,UAAU;IAChB,IAAI,EAAE,2BAAmB,CAAC,aAAa;IACvC,IAAI,EAAE,MAAM,CAAC,2BAAmB,CAAC,aAAa,CAAC;IAC/C,QAAQ,EAAE,2BAAmB,CAAC,aAAa;IAC3C,QAAQ,EAAE,2BAAmB,CAAC,aAAa;IAC3C,QAAQ,EAAE,2BAAmB,CAAC,iBAAiB;IAC/C,QAAQ,EAAE,CAAC,QAAQ,EAAE,KAAK,CAAC;IAC3B,UAAU,EAAE,CAAC,UAAU,CAAC;IACxB,aAAa,EAAE,IAAI;IACnB,KAAK,EAAE,CAAC,KAAK,CAAC;IACd,mBAAmB,EAAE,oBAAoB;IACzC,MAAM,EAAE,kBAAkB;IAC1B,OAAO,EAAE,KAAK;IACd,WAAW,EAAE,KAAK;IAClB,gBAAgB,EAAE,IAAI;IACtB,0BAA0B,EAAE;QAC1B,IAAI,EAAE,UAAU;QAChB,SAAS,EAAE,OAAO;KACnB;CACmC,CAAC;AAEvC,MAAM,WAAW,GAAG,IAAI,oBAAU,CAAC,yBAAiB,CAAC,CAAC;AAEtD,kBAAe,WAAW,CAAC"}

package/dist/typeorm.service.d.ts

@@ -1,5 +1,5 @@
 import { TypeOrmOptionsFactory, TypeOrmModuleOptions } from '@nestjs/typeorm';
-import { SeederOptions } from 'typeorm-extension';
+import { SeederOptions } from './seeder-options';
 export declare class TypeOrmConfigService implements TypeOrmOptionsFactory {
     createTypeOrmOptions(): TypeOrmModuleOptions & SeederOptions;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zola_do/typeorm",
-  "version": "0.2.8",
+  "version": "0.2.12",
   "description": "TypeORM configuration for NestJS",
   "author": "zolaDO",
   "license": "ISC",
@@ -32,10 +32,15 @@
   },
   "peerDependencies": {
     "@nestjs/common": "^10.0.0 || ^11.0.0",
-    "@nestjs/typeorm": "^10.0.0 || ^11.0.0",
-    "typeorm": "^0.3.0",
+    "@nestjs/typeorm": "^10.0.0 || ^11.0.1",
+    "typeorm": "^0.3.0 || ^1.0.0",
     "typeorm-extension": "^3.7.1"
   },
+  "peerDependenciesMeta": {
+    "typeorm-extension": {
+      "optional": true
+    }
+  },
   "dependencies": {
     "dotenv": "^17.3.1"
   },