@nestjs-cms/core 0.0.0-stage → 0.1.1

package/.env.example

@@ -0,0 +1,21 @@
+NODE_ENV=development
+PORT=3000
+HOST=127.0.0.1
+CORS_ORIGINS=
+# Optional shared API key for development/integration; rights/auth module is out of scope.
+ADMIN_API_KEY=
+DB_TYPE=postgres
+DB_HOST=127.0.0.1
+DB_PORT=5432
+DB_USERNAME=cms
+DB_PASSWORD=cms_dev_password
+DB_DATABASE=cms
+# Dev only. Use migrations in production.
+DB_SYNCHRONIZE=true
+S3_REGION=us-east-1
+S3_BUCKET=cms-attachments
+S3_ENDPOINT=http://127.0.0.1:9000
+S3_FORCE_PATH_STYLE=true
+S3_ACCESS_KEY_ID=minioadmin
+S3_SECRET_ACCESS_KEY=minioadmin123
+ATTACHMENT_MAX_BYTES=20971520

package/README.md

@@ -1,3 +1,342 @@
-# Temporary Holding Version
+# @nestjs-cms/core
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Add a resource-driven CMS backend to a NestJS application. Define each resource in one file; the module discovers it and provides validated CRUD APIs, filters, lifecycle hooks, and S3-backed attachments.
+
+## Quick start
+
+Requires Node.js 22+, npm, and a PostgreSQL database. The package supports NestJS 11 with the Express adapter.
+
+### 1. Create a NestJS project and install the package
+
+```sh
+npx @nestjs/cli@11 new nestjs-cms-demo --package-manager npm
+cd nestjs-cms-demo
+npm install @nestjs-cms/core
+```
+
+The npm package includes compiled JavaScript and TypeScript declarations. Imports use `"@nestjs-cms/core"`.
+
+The package includes Zod, TypeORM, PostgreSQL/MySQL drivers, dotenv, and the S3 client. The NestJS project supplies the NestJS runtime dependencies.
+
+### 2. Create a resource
+
+```sh
+mkdir -p src/resources
+```
+
+Create `src/resources/pages.ts`:
+
+```ts
+import { defineResource, z } from "@nestjs-cms/core";
+
+export default defineResource({
+  name: "pages",
+  schema: z
+    .object({
+      title: z.string().trim().min(1).max(200),
+      status: z.enum(["draft", "published"]).default("draft"),
+    })
+    .strict(),
+  columns: {
+    title: { type: String, length: 200 },
+    status: { type: String, length: 20 },
+  },
+  filterable: ["title", "status"],
+  sortable: ["title", "createdAt"],
+});
+```
+
+Keep the folder inside `src` so the standard Nest compiler builds it into `dist/resources`. Each additional resource requires only one new file in this folder. No resource index or per-resource registration is needed.
+
+### 3. Import the CMS module once
+
+Add `ResourceModule.forRoot(...)` to the `imports` array in `src/app.module.ts`:
+
+```ts
+import { Module } from "@nestjs/common";
+import { join } from "node:path";
+import { ResourceModule } from "@nestjs-cms/core";
+
+@Module({
+  imports: [
+    ResourceModule.forRoot({ resourcesPath: join(__dirname, "resources") }),
+  ],
+})
+export class AppModule {}
+```
+
+You can keep your existing controllers, providers, and other imports. The module's API-key guard and error filter apply only to CMS routes.
+
+### 4. Configure `.env`
+
+Create `.env` in the new project's root:
+
+```dotenv
+NODE_ENV=development
+PORT=3000
+DB_TYPE=postgres
+DB_HOST=127.0.0.1
+DB_PORT=5432
+DB_USERNAME=cms
+DB_PASSWORD=cms_dev_password
+DB_DATABASE=cms
+DB_SYNCHRONIZE=true
+ADMIN_API_KEY=
+CORS_ORIGINS=
+```
+
+Use credentials for an existing PostgreSQL database. The package loads `.env` automatically. With `DB_SYNCHRONIZE=true`, it creates the resource tables in that database during startup. Use migrations instead in production.
+
+If you need a local database and port 5432 is available:
+
+```sh
+docker run --name nestjs-cms-demo-postgres -d \
+  -e POSTGRES_USER=cms -e POSTGRES_PASSWORD=cms_dev_password -e POSTGRES_DB=cms \
+  -p 127.0.0.1:5432:5432 postgres:17-alpine
+```
+
+Wait for PostgreSQL to be ready before starting the application. The example above supports plain resource CRUD. **Attachments also require working S3/MinIO storage and an attachment field in the resource definition.**
+
+### 4a. Configure storage for attachments
+
+For local MinIO, add these settings to your application's `.env`:
+
+```dotenv
+S3_REGION=us-east-1
+S3_BUCKET=cms-attachments
+S3_ENDPOINT=http://127.0.0.1:9000
+S3_FORCE_PATH_STYLE=true
+S3_ACCESS_KEY_ID=minioadmin
+S3_SECRET_ACCESS_KEY=minioadmin123
+ATTACHMENT_MAX_BYTES=20971520
+```
+
+These credentials match this library's development Compose setup. From the `nestjs-cms` repository checkout, start storage with:
+
+```sh
+docker compose up -d --build minio minio-init
+```
+
+Wait for MinIO to become healthy and `minio-init` to finish successfully; it creates the private `cms-attachments` bucket. The npm package does not start storage or include the Compose setup. You can also use an existing MinIO server: supply its endpoint and credentials and create the bucket beforehand. The endpoint above assumes the application runs on your host machine.
+
+For AWS S3 instead, use your bucket's region and name, omit `S3_ENDPOINT`, and set `S3_FORCE_PATH_STYLE=false`. Supply both credential variables, or omit both when using an IAM role. See [AWS S3 configuration](docs/operations.md#aws-s3-configuration) for permissions.
+
+In `src/resources/pages.ts`, add this property to the existing `defineResource({...})` object:
+
+```ts
+attachments: [
+  { field: "cover", mimeTypes: ["image/jpeg", "image/png", "image/webp"] },
+],
+```
+
+Attachment fields are declared separately from the Zod schema and database columns. After restarting the application and creating a page, upload a file using its record ID:
+
+```sh
+curl -X POST http://localhost:3000/api/pages/RECORD_ID/attachments/cover \
+  -F 'file=@/absolute/path/to/cover.png'
+```
+
+Replace `RECORD_ID` and the file path with your values. If `ADMIN_API_KEY` is configured, include the `X-API-Key` header. Uploads and downloads always pass through the backend attachment API; the browser never connects directly to S3/MinIO.
+
+Without working object storage, the application can start and plain resource CRUD still works. Storage is contacted when an attachment operation needs it: uploads fail with HTTP 503 (`Object storage upload unavailable`), and downloads of existing attachments fail with HTTP 503 (`Attachment content unavailable`). There is no local-filesystem fallback. Omitting the S3 settings does not disable attachments; the client uses the default region/bucket and AWS credential chain, which only works if that environment already has access to the matching storage.
+
+### 5. Start the application
+
+```sh
+npm run start:dev
+```
+
+```sh
+curl http://localhost:3000/api/_resources
+curl -X POST http://localhost:3000/api/pages \
+  -H 'Content-Type: application/json' \
+  -d '{"title":"About us"}'
+curl http://localhost:3000/api/pages
+```
+
+After adding or removing resource files, rebuild/restart the application. The standard Nest CLI TypeScript build emits the resource files separately; bundlers require additional configuration to preserve those files for runtime discovery.
+
+For production, run the host project's `npm run build` and `npm run start:prod`, disable schema synchronization, and apply reviewed migrations. The library does not run or install its demo migrations in your application.
+
+### Optional: CORS and shutdown hooks
+
+Same-origin frontends do not require CORS. To apply `CORS_ORIGINS` for a separate frontend and enable graceful shutdown, call the helper in your application's existing `src/main.ts`:
+
+```ts
+import { configureCmsApp } from "@nestjs-cms/core";
+
+// After NestFactory.create(AppModule), before app.listen(...):
+configureCmsApp(app);
+```
+
+Set `CORS_ORIGINS=http://localhost:5173`, for example. Your host application still controls its listening port, bind address, and bootstrap process. If it already manages CORS and shutdown hooks, keep that configuration instead.
+
+## Migrating from `nestjs-cms`
+
+The backend package is now named `@nestjs-cms/core`. Once the scoped package is
+published, existing applications can switch with:
+
+```sh
+npm uninstall nestjs-cms
+npm install @nestjs-cms/core
+```
+
+Replace imports from `"nestjs-cms"` with `"@nestjs-cms/core"`, including type
+imports. The API is unchanged by this rename. The admin package remains
+`@nestjs-cms/admin`; the GitHub repository remains `kongyim/nestjs-cms`.
+
+## Install a local package
+
+From this library's checkout:
+
+```sh
+npm ci
+npm pack
+```
+
+This builds `nestjs-cms-core-0.1.0.tgz`, including JavaScript and TypeScript declarations. In the new NestJS project, replace the npm installation step with:
+
+```sh
+npm install /absolute/path/to/nestjs-cms-core-0.1.0.tgz
+```
+
+The package excludes the demo application, demo resources, demo migrations, tests, and local secrets. Packing does not publish anything to a registry.
+
+## Install from GitHub (optional)
+
+To use an unpublished revision, install from GitHub instead of npm. This requires
+Git and a GitHub SSH key with access to the repository:
+
+```sh
+npm install git+ssh://git@github.com/kongyim/nestjs-cms.git
+```
+
+The package's `prepare` script builds TypeScript during Git installation. Keep
+npm lifecycle scripts enabled. Append `#<tag-or-commit>` to the Git URL to select
+an existing revision. Imports still use `"@nestjs-cms/core"`.
+
+### Troubleshooting: Cannot find module `@nestjs-cms/core`
+
+Run `npm ls @nestjs-cms/core` in the consuming application and check that
+`node_modules/@nestjs-cms/core/dist/src/index.js` and `index.d.ts` exist. To reinstall
+the published package, stop the development server and run:
+
+```sh
+npm uninstall @nestjs-cms/core
+npm install @nestjs-cms/core
+npm run start:dev
+```
+
+For Git installations, missing compiled files can indicate an older revision or
+a failed `prepare` script. Reinstall with `--foreground-scripts` to see build
+output, or use a locally packed package as described above.
+
+## Publishing updates to npm
+
+For the first release under the new name, run `npm run release:check` and
+`npm run release` from the repository root. Version `0.1.0` can be used because
+`@nestjs-cms/core` is a separate npm package from `nestjs-cms` (provided that
+version has not already been published under the new name).
+
+After confirming `npm view @nestjs-cms/core version` returns the new release,
+the owner of the old package can mark it deprecated:
+
+```sh
+npm deprecate 'nestjs-cms@*' 'Renamed to @nestjs-cms/core. Install @nestjs-cms/core and update your imports.'
+```
+
+This keeps existing versions available while directing users to the new package.
+For subsequent releases, follow the steps below.
+
+
+Run the following commands in the package you changed: the repository root for
+`@nestjs-cms/core`, or `packages/admin` for `@nestjs-cms/admin`. The packages have
+independent versions; release only the packages you changed.
+
+```sh
+npm ci
+npm run release:check
+npm run version:patch
+npm run release
+```
+
+- `release:check` runs tests, builds the package, and previews the files to publish
+  without uploading anything. Review that file list before continuing. For backend
+  changes involving the database or storage, also run `npm run test:integration`
+  with the required services running.
+- `version:patch` updates `package.json` and `package-lock.json` automatically
+  (for example, `0.1.0` → `0.1.1`). No manual version editing is needed.
+  Use `version:minor` for a feature release (`0.1.0` → `0.2.0`) or
+  `version:major` for a major release (`0.1.0` → `1.0.0`). During `0.x`
+  development, document breaking changes explicitly and use a minor release;
+  from `1.0.0` onward, use a major release for breaking changes.
+- `release` publishes the current version publicly. Tests run again through
+  `prepublishOnly`, and the existing packaging hook builds the package before
+  upload. If needed, run `npm login --auth-type=web` first and complete npm's
+  authentication prompts.
+
+Every published update needs a new version, including README-only updates on npm.
+A published name/version cannot be reused. These scripts do not create Git commits
+or tags: review and commit the code, README, and version/lockfile changes, then
+push them to GitHub to keep the release source recorded.
+
+If publication fails after the version bump, fix the problem and run
+`npm run release` again without bumping again, provided that version was not
+published. If the outcome is unclear, check `npm view <package-name>@<version> version`
+first. The version scripts only change local files; `release:check` does not bump
+versions, and `release` does not bump automatically.
+
+See [npm version](https://docs.npmjs.com/cli/commands/npm-version/) for version
+updates and [npm publish](https://docs.npmjs.com/cli/commands/npm-publish/) for
+publication rules.
+
+## Documentation
+
+- [Resource definitions, hooks, and service methods](docs/resources.md)
+- [API contract and frontend examples](docs/api.md)
+- [Environment, databases, storage, and deployment](docs/operations.md)
+
+`ResourceService` is exported for use in other application services. It provides CRUD and `createAttachment`, `findAttachment`, `downloadAttachment`, and `removeAttachment`. All browser attachment traffic goes through the backend API.
+
+User login, roles, and resource rights are not implemented. Setting `ADMIN_API_KEY` requires `X-API-Key` on CMS requests; production currently requires a key of at least 32 characters. This is an integration mechanism, not a full authentication system.
+
+## Develop this library
+
+The repository also contains a demo application with `categories` and `articles`. These instructions are for library contributors, not package consumers:
+
+```sh
+npm ci
+cp .env.example .env
+docker compose up -d --build
+# Wait for postgres/minio to be healthy and minio-init to exit with code 0.
+npm run seed
+npm run dev
+```
+
+The first MinIO build compiles a pinned source release and takes longer than subsequent starts. The demo API runs at `http://localhost:3000/api`, and the MinIO console at `http://localhost:9001`.
+
+```sh
+npm run format
+npm run format:check
+npm run build
+npm test
+npm run test:integration
+# Optional MySQL verification:
+docker compose --profile mysql up -d mysql
+DB_TYPE=mysql DB_PORT=3307 npm run test:integration
+```
+
+Integration tests use the dedicated `cms_test` database and real MinIO services. The repository's VS Code settings enable formatting on save when the recommended Prettier extension is installed. These editor settings are not installed into consuming applications.
+
+## Scope
+
+The package implements resource discovery, CRUD, filters, transactional hooks, and backend-managed attachments. Import/export, image resizing, encrypted/hashed fields, automatic relation expansion, and resource permissions are not included. Multilingual and nested fields use JSON. See the [comparison with the original project](docs/resources.md#comparison-with-the-original-project) for differences from `polyu-souvenirs`.
+
+## Reusable admin frontend
+
+The companion React package lives in [packages/admin](packages/admin/README.md).
+It provides the portal UI, explicitly configured sections in navigation order,
+nested JSON fields, deferred attachments, and inline password actions. It is
+packaged independently as `@nestjs-cms/admin`; the core backend package does not
+install frontend dependencies. See the package README for build/install steps,
+Next.js setup, and authentication/transport adapters.

package/dist/src/api-key.guard.d.ts

@@ -0,0 +1,4 @@
+import { CanActivate, ExecutionContext } from "@nestjs/common";
+export declare class ApiKeyGuard implements CanActivate {
+    canActivate(context: ExecutionContext): boolean;
+}

package/dist/src/api-key.guard.js

@@ -0,0 +1,29 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiKeyGuard = void 0;
+const common_1 = require("@nestjs/common");
+const node_crypto_1 = require("node:crypto");
+const config_1 = require("./config");
+let ApiKeyGuard = class ApiKeyGuard {
+    canActivate(context) {
+        if (!config_1.config.ADMIN_API_KEY)
+            return true;
+        const header = context.switchToHttp().getRequest().headers["x-api-key"];
+        const expected = Buffer.from(config_1.config.ADMIN_API_KEY);
+        const actual = Buffer.from(typeof header === "string" ? header : "");
+        if (actual.length !== expected.length || !(0, node_crypto_1.timingSafeEqual)(actual, expected))
+            throw new common_1.UnauthorizedException();
+        return true;
+    }
+};
+exports.ApiKeyGuard = ApiKeyGuard;
+exports.ApiKeyGuard = ApiKeyGuard = __decorate([
+    (0, common_1.Injectable)()
+], ApiKeyGuard);
+//# sourceMappingURL=api-key.guard.js.map

package/dist/src/api-key.guard.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-key.guard.js","sourceRoot":"","sources":["../../src/api-key.guard.ts"],"names":[],"mappings":";;;;;;;;;AAAA,2CAKwB;AACxB,6CAA8C;AAC9C,qCAAkC;AAE3B,IAAM,WAAW,GAAjB,MAAM,WAAW;IACtB,WAAW,CAAC,OAAyB;QACnC,IAAI,CAAC,eAAM,CAAC,aAAa;YAAE,OAAO,IAAI,CAAC;QACvC,MAAM,MAAM,GAAY,OAAO,CAAC,YAAY,EAAE,CAAC,UAAU,EAAE,CAAC,OAAO,CACjE,WAAW,CACZ,CAAC;QACF,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,eAAM,CAAC,aAAa,CAAC,CAAC;QACnD,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QACrE,IAAI,MAAM,CAAC,MAAM,KAAK,QAAQ,CAAC,MAAM,IAAI,CAAC,IAAA,6BAAe,EAAC,MAAM,EAAE,QAAQ,CAAC;YACzE,MAAM,IAAI,8BAAqB,EAAE,CAAC;QACpC,OAAO,IAAI,CAAC;IACd,CAAC;CACF,CAAA;AAZY,kCAAW;sBAAX,WAAW;IADvB,IAAA,mBAAU,GAAE;GACA,WAAW,CAYvB"}

package/dist/src/config.d.ts

@@ -0,0 +1,43 @@
+import "dotenv/config";
+export declare function readConfig(input?: NodeJS.ProcessEnv): {
+    NODE_ENV: "development" | "test" | "production";
+    PORT: number;
+    HOST: string;
+    CORS_ORIGINS: string;
+    ADMIN_API_KEY: string;
+    DB_TYPE: "postgres" | "mysql";
+    DB_HOST: string;
+    DB_USERNAME: string;
+    DB_PASSWORD: string;
+    DB_DATABASE: string;
+    DB_SYNCHRONIZE: boolean;
+    S3_REGION: string;
+    S3_BUCKET: string;
+    S3_FORCE_PATH_STYLE: boolean;
+    ATTACHMENT_MAX_BYTES: number;
+    DB_PORT?: number | undefined;
+    S3_ENDPOINT?: string | undefined;
+    S3_ACCESS_KEY_ID?: string | undefined;
+    S3_SECRET_ACCESS_KEY?: string | undefined;
+};
+export declare const config: {
+    NODE_ENV: "development" | "test" | "production";
+    PORT: number;
+    HOST: string;
+    CORS_ORIGINS: string;
+    ADMIN_API_KEY: string;
+    DB_TYPE: "postgres" | "mysql";
+    DB_HOST: string;
+    DB_USERNAME: string;
+    DB_PASSWORD: string;
+    DB_DATABASE: string;
+    DB_SYNCHRONIZE: boolean;
+    S3_REGION: string;
+    S3_BUCKET: string;
+    S3_FORCE_PATH_STYLE: boolean;
+    ATTACHMENT_MAX_BYTES: number;
+    DB_PORT?: number | undefined;
+    S3_ENDPOINT?: string | undefined;
+    S3_ACCESS_KEY_ID?: string | undefined;
+    S3_SECRET_ACCESS_KEY?: string | undefined;
+};

package/dist/src/config.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.config = void 0;
+exports.readConfig = readConfig;
+require("dotenv/config");
+const zod_1 = require("zod");
+const bool = zod_1.z.enum(["true", "false"]).transform((v) => v === "true");
+const env = zod_1.z.object({
+    NODE_ENV: zod_1.z
+        .enum(["development", "test", "production"])
+        .default("development"),
+    PORT: zod_1.z.coerce.number().int().min(1).max(65535).default(3000),
+    HOST: zod_1.z.string().default("127.0.0.1"),
+    CORS_ORIGINS: zod_1.z.string().default("http://localhost:5173"),
+    ADMIN_API_KEY: zod_1.z.string().default(""),
+    DB_TYPE: zod_1.z.enum(["postgres", "mysql"]).default("postgres"),
+    DB_HOST: zod_1.z.string().default("127.0.0.1"),
+    DB_PORT: zod_1.z.coerce.number().int().positive().optional(),
+    DB_USERNAME: zod_1.z.string().default("cms"),
+    DB_PASSWORD: zod_1.z.string().default("cms_dev_password"),
+    DB_DATABASE: zod_1.z.string().default("cms"),
+    DB_SYNCHRONIZE: bool.default(false),
+    S3_REGION: zod_1.z.string().default("us-east-1"),
+    S3_BUCKET: zod_1.z.string().min(3).default("cms-attachments"),
+    S3_ENDPOINT: zod_1.z.url().optional(),
+    S3_FORCE_PATH_STYLE: bool.default(false),
+    S3_ACCESS_KEY_ID: zod_1.z.string().optional(),
+    S3_SECRET_ACCESS_KEY: zod_1.z.string().optional(),
+    ATTACHMENT_MAX_BYTES: zod_1.z.coerce
+        .number()
+        .int()
+        .positive()
+        .max(1024 ** 3)
+        .default(20 * 1024 ** 2),
+});
+function readConfig(input = process.env) {
+    const config = env.parse(input);
+    if (!!config.S3_ACCESS_KEY_ID !== !!config.S3_SECRET_ACCESS_KEY)
+        throw new Error("Set both S3 credentials or neither (IAM credential chain)");
+    if (config.NODE_ENV === "production" && config.DB_SYNCHRONIZE)
+        throw new Error("DB_SYNCHRONIZE is forbidden in production");
+    if (config.NODE_ENV === "production" && config.ADMIN_API_KEY.length < 32)
+        throw new Error("Production requires ADMIN_API_KEY of at least 32 characters until an authentication module is installed");
+    return config;
+}
+exports.config = readConfig();
+//# sourceMappingURL=config.js.map

package/dist/src/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/config.ts"],"names":[],"mappings":";;;AA+BA,gCAaC;AA5CD,yBAAuB;AACvB,6BAAwB;AACxB,MAAM,IAAI,GAAG,OAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC;AACtE,MAAM,GAAG,GAAG,OAAC,CAAC,MAAM,CAAC;IACnB,QAAQ,EAAE,OAAC;SACR,IAAI,CAAC,CAAC,aAAa,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC;SAC3C,OAAO,CAAC,aAAa,CAAC;IACzB,IAAI,EAAE,OAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;IAC7D,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC;IACrC,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,uBAAuB,CAAC;IACzD,aAAa,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;IACrC,OAAO,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;IAC1D,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC;IACxC,OAAO,EAAE,OAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IACtD,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;IACtC,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,kBAAkB,CAAC;IACnD,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;IACtC,cAAc,EAAE,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;IACnC,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC;IAC1C,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC;IACvD,WAAW,EAAE,OAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAC/B,mBAAmB,EAAE,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;IACxC,gBAAgB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACvC,oBAAoB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3C,oBAAoB,EAAE,OAAC,CAAC,MAAM;SAC3B,MAAM,EAAE;SACR,GAAG,EAAE;SACL,QAAQ,EAAE;SACV,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC;SACd,OAAO,CAAC,EAAE,GAAG,IAAI,IAAI,CAAC,CAAC;CAC3B,CAAC,CAAC;AACH,SAAgB,UAAU,CAAC,QAA2B,OAAO,CAAC,GAAG;IAC/D,MAAM,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAChC,IAAI,CAAC,CAAC,MAAM,CAAC,gBAAgB,KAAK,CAAC,CAAC,MAAM,CAAC,oBAAoB;QAC7D,MAAM,IAAI,KAAK,CACb,2DAA2D,CAC5D,CAAC;IACJ,IAAI,MAAM,CAAC,QAAQ,KAAK,YAAY,IAAI,MAAM,CAAC,cAAc;QAC3D,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;IAC/D,IAAI,MAAM,CAAC,QAAQ,KAAK,YAAY,IAAI,MAAM,CAAC,aAAa,CAAC,MAAM,GAAG,EAAE;QACtE,MAAM,IAAI,KAAK,CACb,yGAAyG,CAC1G,CAAC;IACJ,OAAO,MAAM,CAAC;AAChB,CAAC;AACY,QAAA,MAAM,GAAG,UAAU,EAAE,CAAC"}

package/dist/src/database/create-data-source.d.ts

@@ -0,0 +1,4 @@
+import "reflect-metadata";
+import { DataSource, DataSourceOptions } from "typeorm";
+import { ResourceDefinition } from "../resource/resource.types";
+export declare function createCmsDataSource(resources: ResourceDefinition[], options?: Pick<DataSourceOptions, "migrations">): DataSource;

package/dist/src/database/create-data-source.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createCmsDataSource = createCmsDataSource;
+require("reflect-metadata");
+const typeorm_1 = require("typeorm");
+const config_1 = require("../config");
+const resource_registry_1 = require("../resource/resource.registry");
+const attachment_entity_1 = require("../storage/attachment.entity");
+function createCmsDataSource(resources, options = {}) {
+    return new typeorm_1.DataSource({
+        type: config_1.config.DB_TYPE,
+        host: config_1.config.DB_HOST,
+        port: config_1.config.DB_PORT ?? (config_1.config.DB_TYPE === "mysql" ? 3306 : 5432),
+        username: config_1.config.DB_USERNAME,
+        password: config_1.config.DB_PASSWORD,
+        database: config_1.config.DB_DATABASE,
+        synchronize: config_1.config.DB_SYNCHRONIZE,
+        entities: [...resources.map(resource_registry_1.createEntity), attachment_entity_1.AttachmentEntity],
+        migrations: options.migrations ?? [],
+        ...(config_1.config.DB_TYPE === "mysql" ? { charset: "utf8mb4" } : {}),
+    });
+}
+//# sourceMappingURL=create-data-source.js.map

package/dist/src/database/create-data-source.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-data-source.js","sourceRoot":"","sources":["../../../src/database/create-data-source.ts"],"names":[],"mappings":";;AAOA,kDAgBC;AAvBD,4BAA0B;AAC1B,qCAAwD;AACxD,sCAAmC;AAEnC,qEAA6D;AAC7D,oEAAgE;AAEhE,SAAgB,mBAAmB,CACjC,SAA+B,EAC/B,UAAiD,EAAE;IAEnD,OAAO,IAAI,oBAAU,CAAC;QACpB,IAAI,EAAE,eAAM,CAAC,OAAO;QACpB,IAAI,EAAE,eAAM,CAAC,OAAO;QACpB,IAAI,EAAE,eAAM,CAAC,OAAO,IAAI,CAAC,eAAM,CAAC,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;QAClE,QAAQ,EAAE,eAAM,CAAC,WAAW;QAC5B,QAAQ,EAAE,eAAM,CAAC,WAAW;QAC5B,QAAQ,EAAE,eAAM,CAAC,WAAW;QAC5B,WAAW,EAAE,eAAM,CAAC,cAAc;QAClC,QAAQ,EAAE,CAAC,GAAG,SAAS,CAAC,GAAG,CAAC,gCAAY,CAAC,EAAE,oCAAgB,CAAC;QAC5D,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,EAAE;QACpC,GAAG,CAAC,eAAM,CAAC,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC9D,CAAC,CAAC;AACL,CAAC"}

package/dist/src/error.filter.d.ts

@@ -0,0 +1,6 @@
+import { ArgumentsHost, ExceptionFilter } from "@nestjs/common";
+import { Response } from "express";
+export declare class ErrorFilter implements ExceptionFilter {
+    private readonly logger;
+    catch(error: unknown, host: ArgumentsHost): Response<any, Record<string, any>>;
+}

package/dist/src/error.filter.js

@@ -0,0 +1,54 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var ErrorFilter_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ErrorFilter = void 0;
+const common_1 = require("@nestjs/common");
+const typeorm_1 = require("typeorm");
+let ErrorFilter = ErrorFilter_1 = class ErrorFilter {
+    logger = new common_1.Logger(ErrorFilter_1.name);
+    catch(error, host) {
+        const response = host.switchToHttp().getResponse();
+        if (error instanceof common_1.HttpException)
+            return response.status(error.getStatus()).json(error.getResponse());
+        if (error instanceof typeorm_1.QueryFailedError) {
+            const code = String(error.driverError.code);
+            if ([
+                "23505",
+                "ER_DUP_ENTRY",
+                "23503",
+                "ER_ROW_IS_REFERENCED_2",
+                "ER_NO_REFERENCED_ROW_2",
+            ].includes(code))
+                return response.status(409).json({
+                    statusCode: 409,
+                    message: "Unique or reference constraint conflict",
+                });
+            if ([
+                "22P02",
+                "22003",
+                "22007",
+                "ER_TRUNCATED_WRONG_VALUE",
+                "ER_WRONG_VALUE",
+                "ER_DATA_OUT_OF_RANGE",
+            ].includes(code))
+                return response
+                    .status(400)
+                    .json({ statusCode: 400, message: "Invalid query value" });
+        }
+        this.logger.error(error instanceof Error ? error.message : "Unexpected error");
+        return response
+            .status(500)
+            .json({ statusCode: 500, message: "Internal server error" });
+    }
+};
+exports.ErrorFilter = ErrorFilter;
+exports.ErrorFilter = ErrorFilter = ErrorFilter_1 = __decorate([
+    (0, common_1.Catch)()
+], ErrorFilter);
+//# sourceMappingURL=error.filter.js.map

package/dist/src/error.filter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.filter.js","sourceRoot":"","sources":["../../src/error.filter.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,2CAMwB;AACxB,qCAA2C;AAGpC,IAAM,WAAW,mBAAjB,MAAM,WAAW;IACL,MAAM,GAAG,IAAI,eAAM,CAAC,aAAW,CAAC,IAAI,CAAC,CAAC;IACvD,KAAK,CAAC,KAAc,EAAE,IAAmB;QACvC,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC,WAAW,EAAY,CAAC;QAC7D,IAAI,KAAK,YAAY,sBAAa;YAChC,OAAO,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;QACtE,IAAI,KAAK,YAAY,0BAAgB,EAAE,CAAC;YACtC,MAAM,IAAI,GAAG,MAAM,CAAE,KAAK,CAAC,WAAiC,CAAC,IAAI,CAAC,CAAC;YACnE,IACE;gBACE,OAAO;gBACP,cAAc;gBACd,OAAO;gBACP,wBAAwB;gBACxB,wBAAwB;aACzB,CAAC,QAAQ,CAAC,IAAI,CAAC;gBAEhB,OAAO,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;oBAC/B,UAAU,EAAE,GAAG;oBACf,OAAO,EAAE,yCAAyC;iBACnD,CAAC,CAAC;YACL,IACE;gBACE,OAAO;gBACP,OAAO;gBACP,OAAO;gBACP,0BAA0B;gBAC1B,gBAAgB;gBAChB,sBAAsB;aACvB,CAAC,QAAQ,CAAC,IAAI,CAAC;gBAEhB,OAAO,QAAQ;qBACZ,MAAM,CAAC,GAAG,CAAC;qBACX,IAAI,CAAC,EAAE,UAAU,EAAE,GAAG,EAAE,OAAO,EAAE,qBAAqB,EAAE,CAAC,CAAC;QACjE,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,kBAAkB,CAC5D,CAAC;QACF,OAAO,QAAQ;aACZ,MAAM,CAAC,GAAG,CAAC;aACX,IAAI,CAAC,EAAE,UAAU,EAAE,GAAG,EAAE,OAAO,EAAE,uBAAuB,EAAE,CAAC,CAAC;IACjE,CAAC;CACF,CAAA;AA1CY,kCAAW;sBAAX,WAAW;IADvB,IAAA,cAAK,GAAE;GACK,WAAW,CA0CvB"}

package/dist/src/index.d.ts

@@ -0,0 +1,12 @@
+import "reflect-metadata";
+export { z } from "zod";
+export { ResourceModule } from "./resource/resource.module";
+export type { ResourceModuleOptions } from "./resource/resource.module";
+export { ResourceService } from "./resource/resource.service";
+export { ResourceRegistry } from "./resource/resource.registry";
+export { defineResource } from "./resource/resource.types";
+export type { ResourceDefinition, ResourceHook, HookContext, HookAction, RecordData, AttachmentField, UploadedAttachment, } from "./resource/resource.types";
+export { loadResources } from "./resource/resource.loader";
+export { createCmsDataSource } from "./database/create-data-source";
+export { AttachmentService } from "./storage/attachment.service";
+export { configureCmsApp } from "./setup";

package/dist/src/index.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configureCmsApp = exports.AttachmentService = exports.createCmsDataSource = exports.loadResources = exports.defineResource = exports.ResourceRegistry = exports.ResourceService = exports.ResourceModule = exports.z = void 0;
+require("reflect-metadata");
+var zod_1 = require("zod");
+Object.defineProperty(exports, "z", { enumerable: true, get: function () { return zod_1.z; } });
+var resource_module_1 = require("./resource/resource.module");
+Object.defineProperty(exports, "ResourceModule", { enumerable: true, get: function () { return resource_module_1.ResourceModule; } });
+var resource_service_1 = require("./resource/resource.service");
+Object.defineProperty(exports, "ResourceService", { enumerable: true, get: function () { return resource_service_1.ResourceService; } });
+var resource_registry_1 = require("./resource/resource.registry");
+Object.defineProperty(exports, "ResourceRegistry", { enumerable: true, get: function () { return resource_registry_1.ResourceRegistry; } });
+var resource_types_1 = require("./resource/resource.types");
+Object.defineProperty(exports, "defineResource", { enumerable: true, get: function () { return resource_types_1.defineResource; } });
+var resource_loader_1 = require("./resource/resource.loader");
+Object.defineProperty(exports, "loadResources", { enumerable: true, get: function () { return resource_loader_1.loadResources; } });
+var create_data_source_1 = require("./database/create-data-source");
+Object.defineProperty(exports, "createCmsDataSource", { enumerable: true, get: function () { return create_data_source_1.createCmsDataSource; } });
+var attachment_service_1 = require("./storage/attachment.service");
+Object.defineProperty(exports, "AttachmentService", { enumerable: true, get: function () { return attachment_service_1.AttachmentService; } });
+var setup_1 = require("./setup");
+Object.defineProperty(exports, "configureCmsApp", { enumerable: true, get: function () { return setup_1.configureCmsApp; } });
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,4BAA0B;AAC1B,2BAAwB;AAAf,wFAAA,CAAC,OAAA;AACV,8DAA4D;AAAnD,iHAAA,cAAc,OAAA;AAEvB,gEAA8D;AAArD,mHAAA,eAAe,OAAA;AACxB,kEAAgE;AAAvD,qHAAA,gBAAgB,OAAA;AACzB,4DAA2D;AAAlD,gHAAA,cAAc,OAAA;AAUvB,8DAA2D;AAAlD,gHAAA,aAAa,OAAA;AACtB,oEAAoE;AAA3D,yHAAA,mBAAmB,OAAA;AAC5B,mEAAiE;AAAxD,uHAAA,iBAAiB,OAAA;AAC1B,iCAA0C;AAAjC,wGAAA,eAAe,OAAA"}