@uecsio/pages-api 1.2.1 → 1.3.0

package/README.md

@@ -86,7 +86,83 @@ The package automatically provides a REST API with the following endpoints:
 - `PUT /pages/:id` - Update a page
 - `DELETE /pages/:id` - Delete a page
 
-### 4. Customize the Page Entity
+### 4. Database Migrations
+
+The package includes database migrations that are automatically discovered by the consuming application. The migrations will be executed externally via your TypeORM settings.
+
+#### Automatic Discovery (Recommended)
+
+The consuming application automatically discovers all `@uecsio` packages and their migrations:
+
+```typescript
+// No manual configuration needed - migrations are auto-discovered!
+@Module({
+  imports: [
+    TypeOrmModule.forRoot({
+      type: 'postgres',
+      host: 'localhost',
+      port: 5432,
+      username: 'postgres',
+      password: 'password',
+      database: 'your_database',
+      // Migrations and entities are automatically discovered from @uecsio packages
+      synchronize: false, // Always false for production
+    }),
+    PagesModule,
+  ],
+})
+export class AppModule {}
+```
+
+#### Manual Integration (Alternative)
+
+If you prefer manual control, you can still integrate manually:
+
+```typescript
+import { PagesMigrationConfig } from '@uecsio/pages-api';
+
+@Module({
+  imports: [
+    TypeOrmModule.forRoot({
+      type: 'postgres',
+      host: 'localhost',
+      port: 5432,
+      username: 'postgres',
+      password: 'password',
+      database: 'your_database',
+      entities: [...PagesMigrationConfig.entities],
+      migrations: [...PagesMigrationConfig.migrations],
+      migrationsTableName: 'migrations', // Standard migration table
+      synchronize: false, // Always false for production
+    }),
+    PagesModule,
+  ],
+})
+export class AppModule {}
+```
+
+**Note:** This module uses the standard `migrations` table name, so it will work seamlessly with other modules that also use the same migration table.
+
+#### Available migrations
+
+The package provides the following migration:
+- `CreatePagesTable1700000000000` - Creates the pages table with all required columns and indexes
+
+#### Migration execution
+
+Migrations will be executed automatically by TypeORM when you run:
+```bash
+# Generate new migrations
+npm run typeorm migration:generate
+
+# Run pending migrations
+npm run typeorm migration:run
+
+# Revert last migration
+npm run typeorm migration:revert
+```
+
+### 5. Customize the Page Entity
 
 You can extend the Page entity for your specific needs:
 

package/dist/index.d.ts

@@ -4,6 +4,7 @@ export * from './controllers/pages.controller';
 export * from './dto/create-page.dto';
 export * from './dto/update-page.dto';
 export * from './entities/page.entity';
+export * from './migrations/migration.config';
 export { Page } from './entities/page.entity';
 export { CreatePageDto } from './dto/create-page.dto';
 export { UpdatePageDto } from './dto/update-page.dto';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,0BAA0B,CAAC;AACzC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC;AAGvC,OAAO,EAAE,IAAI,EAAE,MAAM,wBAAwB,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AACjE,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,0BAA0B,CAAC;AACzC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC;AAGvC,cAAc,+BAA+B,CAAC;AAG9C,OAAO,EAAE,IAAI,EAAE,MAAM,wBAAwB,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AACjE,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC"}

package/dist/index.js

@@ -21,6 +21,7 @@ __exportStar(require("./controllers/pages.controller"), exports);
 __exportStar(require("./dto/create-page.dto"), exports);
 __exportStar(require("./dto/update-page.dto"), exports);
 __exportStar(require("./entities/page.entity"), exports);
+__exportStar(require("./migrations/migration.config"), exports);
 var page_entity_1 = require("./entities/page.entity");
 Object.defineProperty(exports, "Page", { enumerable: true, get: function () { return page_entity_1.Page; } });
 var create_page_dto_1 = require("./dto/create-page.dto");

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AACA,iDAA+B;AAC/B,2DAAyC;AACzC,iEAA+C;AAC/C,wDAAsC;AACtC,wDAAsC;AACtC,yDAAuC;AAGvC,sDAA8C;AAArC,mGAAA,IAAI,OAAA;AACb,yDAAsD;AAA7C,gHAAA,aAAa,OAAA;AACtB,yDAAsD;AAA7C,gHAAA,aAAa,OAAA;AACtB,0DAAwD;AAA/C,6GAAA,YAAY,OAAA;AACrB,mEAAiE;AAAxD,mHAAA,eAAe,OAAA;AACxB,+CAA6C;AAApC,2GAAA,WAAW,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AACA,iDAA+B;AAC/B,2DAAyC;AACzC,iEAA+C;AAC/C,wDAAsC;AACtC,wDAAsC;AACtC,yDAAuC;AAGvC,gEAA8C;AAG9C,sDAA8C;AAArC,mGAAA,IAAI,OAAA;AACb,yDAAsD;AAA7C,gHAAA,aAAa,OAAA;AACtB,yDAAsD;AAA7C,gHAAA,aAAa,OAAA;AACtB,0DAAwD;AAA/C,6GAAA,YAAY,OAAA;AACrB,mEAAiE;AAAxD,mHAAA,eAAe,OAAA;AACxB,+CAA6C;AAApC,2GAAA,WAAW,OAAA"}

package/dist/migrations/1700000000000-CreatePagesTable.d.ts

@@ -0,0 +1,6 @@
+import { MigrationInterface, QueryRunner } from 'typeorm';
+export declare class CreatePagesTable1700000000000 implements MigrationInterface {
+    up(queryRunner: QueryRunner): Promise<void>;
+    down(queryRunner: QueryRunner): Promise<void>;
+}
+//# sourceMappingURL=1700000000000-CreatePagesTable.d.ts.map

package/dist/migrations/1700000000000-CreatePagesTable.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"1700000000000-CreatePagesTable.d.ts","sourceRoot":"","sources":["../../src/migrations/1700000000000-CreatePagesTable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAqB,MAAM,SAAS,CAAC;AAE7E,qBAAa,6BAA8B,YAAW,kBAAkB;IACzD,EAAE,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAwG3C,IAAI,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;CAG3D"}

package/dist/migrations/1700000000000-CreatePagesTable.js

@@ -0,0 +1,99 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreatePagesTable1700000000000 = void 0;
+const typeorm_1 = require("typeorm");
+class CreatePagesTable1700000000000 {
+    async up(queryRunner) {
+        await queryRunner.createTable(new typeorm_1.Table({
+            name: 'pages',
+            columns: [
+                {
+                    name: 'id',
+                    type: 'int',
+                    isPrimary: true,
+                    isGenerated: true,
+                    generationStrategy: 'increment',
+                },
+                {
+                    name: 'title',
+                    type: 'varchar',
+                    length: '255',
+                    isNullable: false,
+                },
+                {
+                    name: 'url',
+                    type: 'varchar',
+                    length: '500',
+                    isNullable: false,
+                },
+                {
+                    name: 'content',
+                    type: 'text',
+                    isNullable: true,
+                },
+                {
+                    name: 'meta_title',
+                    type: 'varchar',
+                    length: '255',
+                    isNullable: true,
+                },
+                {
+                    name: 'meta_keywords',
+                    type: 'text',
+                    isNullable: true,
+                },
+                {
+                    name: 'meta_description',
+                    type: 'text',
+                    isNullable: true,
+                },
+                {
+                    name: 'status',
+                    type: 'int',
+                    default: 1,
+                    isNullable: false,
+                },
+                {
+                    name: 'activate_from',
+                    type: 'timestamp',
+                    isNullable: true,
+                },
+                {
+                    name: 'activate_to',
+                    type: 'timestamp',
+                    isNullable: true,
+                },
+                {
+                    name: 'created_at',
+                    type: 'timestamp',
+                    default: 'CURRENT_TIMESTAMP',
+                    isNullable: false,
+                },
+                {
+                    name: 'updated_at',
+                    type: 'timestamp',
+                    default: 'CURRENT_TIMESTAMP',
+                    onUpdate: 'CURRENT_TIMESTAMP',
+                    isNullable: false,
+                },
+            ],
+        }), true);
+        await queryRunner.createIndex('pages', new typeorm_1.TableIndex({
+            name: 'IDX_PAGES_STATUS',
+            columnNames: ['status'],
+        }));
+        await queryRunner.createIndex('pages', new typeorm_1.TableIndex({
+            name: 'IDX_PAGES_ACTIVATE_FROM',
+            columnNames: ['activate_from'],
+        }));
+        await queryRunner.createIndex('pages', new typeorm_1.TableIndex({
+            name: 'IDX_PAGES_ACTIVATE_TO',
+            columnNames: ['activate_to'],
+        }));
+    }
+    async down(queryRunner) {
+        await queryRunner.dropTable('pages');
+    }
+}
+exports.CreatePagesTable1700000000000 = CreatePagesTable1700000000000;
+//# sourceMappingURL=1700000000000-CreatePagesTable.js.map

package/dist/migrations/1700000000000-CreatePagesTable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"1700000000000-CreatePagesTable.js","sourceRoot":"","sources":["../../src/migrations/1700000000000-CreatePagesTable.ts"],"names":[],"mappings":";;;AAAA,qCAA6E;AAE7E,MAAa,6BAA6B;IACjC,KAAK,CAAC,EAAE,CAAC,WAAwB;QACtC,MAAM,WAAW,CAAC,WAAW,CAC3B,IAAI,eAAK,CAAC;YACR,IAAI,EAAE,OAAO;YACb,OAAO,EAAE;gBACP;oBACE,IAAI,EAAE,IAAI;oBACV,IAAI,EAAE,KAAK;oBACX,SAAS,EAAE,IAAI;oBACf,WAAW,EAAE,IAAI;oBACjB,kBAAkB,EAAE,WAAW;iBAChC;gBACD;oBACE,IAAI,EAAE,OAAO;oBACb,IAAI,EAAE,SAAS;oBACf,MAAM,EAAE,KAAK;oBACb,UAAU,EAAE,KAAK;iBAClB;gBACD;oBACE,IAAI,EAAE,KAAK;oBACX,IAAI,EAAE,SAAS;oBACf,MAAM,EAAE,KAAK;oBACb,UAAU,EAAE,KAAK;iBAClB;gBACD;oBACE,IAAI,EAAE,SAAS;oBACf,IAAI,EAAE,MAAM;oBACZ,UAAU,EAAE,IAAI;iBACjB;gBACD;oBACE,IAAI,EAAE,YAAY;oBAClB,IAAI,EAAE,SAAS;oBACf,MAAM,EAAE,KAAK;oBACb,UAAU,EAAE,IAAI;iBACjB;gBACD;oBACE,IAAI,EAAE,eAAe;oBACrB,IAAI,EAAE,MAAM;oBACZ,UAAU,EAAE,IAAI;iBACjB;gBACD;oBACE,IAAI,EAAE,kBAAkB;oBACxB,IAAI,EAAE,MAAM;oBACZ,UAAU,EAAE,IAAI;iBACjB;gBACD;oBACE,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,KAAK;oBACX,OAAO,EAAE,CAAC;oBACV,UAAU,EAAE,KAAK;iBAClB;gBACD;oBACE,IAAI,EAAE,eAAe;oBACrB,IAAI,EAAE,WAAW;oBACjB,UAAU,EAAE,IAAI;iBACjB;gBACD;oBACE,IAAI,EAAE,aAAa;oBACnB,IAAI,EAAE,WAAW;oBACjB,UAAU,EAAE,IAAI;iBACjB;gBACD;oBACE,IAAI,EAAE,YAAY;oBAClB,IAAI,EAAE,WAAW;oBACjB,OAAO,EAAE,mBAAmB;oBAC5B,UAAU,EAAE,KAAK;iBAClB;gBACD;oBACE,IAAI,EAAE,YAAY;oBAClB,IAAI,EAAE,WAAW;oBACjB,OAAO,EAAE,mBAAmB;oBAC5B,QAAQ,EAAE,mBAAmB;oBAC7B,UAAU,EAAE,KAAK;iBAClB;aACF;SACF,CAAC,EACF,IAAI,CACL,CAAC;QAEF,MAAM,WAAW,CAAC,WAAW,CAC3B,OAAO,EACP,IAAI,oBAAU,CAAC;YACb,IAAI,EAAE,kBAAkB;YACxB,WAAW,EAAE,CAAC,QAAQ,CAAC;SACxB,CAAC,CACH,CAAC;QAEF,MAAM,WAAW,CAAC,WAAW,CAC3B,OAAO,EACP,IAAI,oBAAU,CAAC;YACb,IAAI,EAAE,yBAAyB;YAC/B,WAAW,EAAE,CAAC,eAAe,CAAC;SAC/B,CAAC,CACH,CAAC;QAEF,MAAM,WAAW,CAAC,WAAW,CAC3B,OAAO,EACP,IAAI,oBAAU,CAAC;YACb,IAAI,EAAE,uBAAuB;YAC7B,WAAW,EAAE,CAAC,aAAa,CAAC;SAC7B,CAAC,CACH,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,IAAI,CAAC,WAAwB;QACxC,MAAM,WAAW,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IACvC,CAAC;CACF;AA5GD,sEA4GC"}

package/dist/migrations/migration.config.d.ts

@@ -0,0 +1,10 @@
+import { Page } from '../entities/page.entity';
+import { CreatePagesTable1700000000000 } from './1700000000000-CreatePagesTable';
+export declare const PagesMigrationConfig: {
+    entities: (typeof Page)[];
+    migrations: (typeof CreatePagesTable1700000000000)[];
+    migrationsTableName: string;
+};
+export { CreatePagesTable1700000000000 };
+export { Page };
+//# sourceMappingURL=migration.config.d.ts.map

package/dist/migrations/migration.config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"migration.config.d.ts","sourceRoot":"","sources":["../../src/migrations/migration.config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,yBAAyB,CAAC;AAC/C,OAAO,EAAE,6BAA6B,EAAE,MAAM,kCAAkC,CAAC;AAMjF,eAAO,MAAM,oBAAoB;;;;CAIhC,CAAC;AAKF,OAAO,EAAE,6BAA6B,EAAE,CAAC;AAKzC,OAAO,EAAE,IAAI,EAAE,CAAC"}

package/dist/migrations/migration.config.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Page = exports.CreatePagesTable1700000000000 = exports.PagesMigrationConfig = void 0;
+const page_entity_1 = require("../entities/page.entity");
+Object.defineProperty(exports, "Page", { enumerable: true, get: function () { return page_entity_1.Page; } });
+const _1700000000000_CreatePagesTable_1 = require("./1700000000000-CreatePagesTable");
+Object.defineProperty(exports, "CreatePagesTable1700000000000", { enumerable: true, get: function () { return _1700000000000_CreatePagesTable_1.CreatePagesTable1700000000000; } });
+exports.PagesMigrationConfig = {
+    entities: [page_entity_1.Page],
+    migrations: [_1700000000000_CreatePagesTable_1.CreatePagesTable1700000000000],
+    migrationsTableName: 'migrations',
+};
+//# sourceMappingURL=migration.config.js.map

package/dist/migrations/migration.config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"migration.config.js","sourceRoot":"","sources":["../../src/migrations/migration.config.ts"],"names":[],"mappings":";;;AAAA,yDAA+C;AAqBtC,qFArBA,kBAAI,OAqBA;AApBb,sFAAiF;AAexE,8GAfA,+DAA6B,OAeA;AATzB,QAAA,oBAAoB,GAAG;IAClC,QAAQ,EAAE,CAAC,kBAAI,CAAC;IAChB,UAAU,EAAE,CAAC,+DAA6B,CAAC;IAC3C,mBAAmB,EAAE,YAAY;CAClC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uecsio/pages-api",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "description": "A reusable NestJS API Pages module for content management",
   "keywords": [
     "nestjs",
@@ -29,26 +29,26 @@
     "clean": "rimraf dist"
   },
   "peerDependencies": {
-    "@nestjs/common": "^10.0.0",
-    "@nestjs/core": "^10.0.0",
-    "@nestjs/typeorm": "^10.0.0",
+    "@nestjs/common": "^11.0.0",
+    "@nestjs/core": "^11.0.0",
+    "@nestjs/typeorm": "^11.0.0",
     "typeorm": "^0.3.0",
     "class-validator": "^0.14.0",
     "class-transformer": "^0.5.1",
     "@nestjs-library/crud": "^0.13.1"
   },
   "devDependencies": {
-    "@nestjs/common": "^10.0.0",
-    "@nestjs/core": "^10.0.0",
-    "@nestjs/testing": "^10.0.0",
-    "@nestjs/typeorm": "^10.0.0",
-    "@types/jest": "^29.0.0",
-    "@types/node": "^20.0.0",
-    "jest": "^29.0.0",
-    "ts-jest": "^29.0.0",
-    "typescript": "^5.0.0",
-    "typeorm": "^0.3.0",
-    "class-validator": "^0.14.0",
+    "@nestjs/common": "^11.0.0",
+    "@nestjs/core": "^11.0.0",
+    "@nestjs/testing": "^11.0.0",
+    "@nestjs/typeorm": "^11.0.0",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^22.0.0",
+    "jest": "^30.0.0",
+    "ts-jest": "^29.2.5",
+    "typescript": "^5.7.3",
+    "typeorm": "^0.3.26",
+    "class-validator": "^0.14.2",
     "class-transformer": "^0.5.1",
     "@nestjs-library/crud": "^0.13.1",
     "rimraf": "^5.0.0"