@omnifyjp/omnify 5.1.0 → 5.1.1

package/omnify-config-schema.json

@@ -63,6 +63,10 @@
       "$ref": "#/definitions/FileConfig",
       "description": "File upload configuration for polymorphic file attachments"
     },
+    "audit": {
+      "$ref": "#/definitions/AuditConfig",
+      "description": "Audit columns (created_by_id / updated_by_id / deleted_by_id) and audit-log history table feature (issue #94)"
+    },
     "verbose": {
       "type": "boolean",
       "default": false,
@@ -101,6 +105,50 @@
         }
       }
     },
+    "AuditConfig": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "model": {
+          "type": "string",
+          "description": "Schema name of the actor / user model (must have options.authenticatable: true). Required when log: true."
+        },
+        "createdBy": {
+          "type": "boolean",
+          "default": false,
+          "description": "Global default for the created_by_id audit column. Per-schema options.audit.createdBy overrides."
+        },
+        "updatedBy": {
+          "type": "boolean",
+          "default": false,
+          "description": "Global default for the updated_by_id audit column. Per-schema options.audit.updatedBy overrides."
+        },
+        "deletedBy": {
+          "type": "boolean",
+          "default": false,
+          "description": "Global default for the deleted_by_id audit column. Per-schema options.audit.deletedBy overrides."
+        },
+        "log": {
+          "type": "boolean",
+          "default": false,
+          "description": "Toggle the audits-history table feature globally (issue #94). Per-schema options.audit.log overrides. Records every model lifecycle event into a single polymorphic audits table."
+        },
+        "logExclude": {
+          "type": "array",
+          "items": { "type": "string" },
+          "description": "Additional sensitive columns scrubbed from old_values / new_values BEFORE audit row is written. Built-in defaults (password, remember_token, api_token, two_factor_secret, two_factor_recovery_codes) are always merged in — your list ADDS to them, never replaces."
+        },
+        "logRetention": {
+          "type": "string",
+          "pattern": "^[0-9]+[dwmy]$",
+          "description": "Prunable retention period: '90d', '12w', '6m', '1y'. Empty string keeps audits forever (no scheduled prune)."
+        },
+        "logQueue": {
+          "type": "string",
+          "description": "Laravel queue connection name for WriteAuditLog dispatch. Empty string forces synchronous dispatch — only acceptable in dev / low-traffic apps. Production should set a queue backed by a real driver (redis, sqs, etc.)."
+        }
+      }
+    },
     "PackageConfig": {
       "type": "object",
       "properties": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@omnifyjp/omnify",
-  "version": "5.1.0",
+  "version": "5.1.1",
   "description": "Schema-driven code generation for Laravel, TypeScript, and SQL",
   "license": "MIT",
   "repository": {
@@ -36,10 +36,10 @@
     "zod": "^3.24.0"
   },
   "optionalDependencies": {
-    "@omnifyjp/omnify-darwin-arm64": "5.1.0",
-    "@omnifyjp/omnify-darwin-x64": "5.1.0",
-    "@omnifyjp/omnify-linux-x64": "5.1.0",
-    "@omnifyjp/omnify-linux-arm64": "5.1.0",
-    "@omnifyjp/omnify-win32-x64": "5.1.0"
+    "@omnifyjp/omnify-darwin-arm64": "5.1.1",
+    "@omnifyjp/omnify-darwin-x64": "5.1.1",
+    "@omnifyjp/omnify-linux-x64": "5.1.1",
+    "@omnifyjp/omnify-linux-arm64": "5.1.1",
+    "@omnifyjp/omnify-win32-x64": "5.1.1"
   }
 }

package/types/config.d.ts

@@ -95,6 +95,61 @@ export interface CodegenConfig {
   laravel?: CodegenLaravelConfig;
 }
 
+/**
+ * Audit configuration. Two related features in one block:
+ *
+ *  - The `created_by_id` / `updated_by_id` / `deleted_by_id` columns
+ *    auto-populated from `auth()->user()` (createdBy / updatedBy /
+ *    deletedBy toggles).
+ *  - The `audits` history table that records every model lifecycle
+ *    event into a single polymorphic table for compliance / debugging
+ *    (issue #94 — log / logExclude / logRetention / logQueue).
+ *
+ * Per-schema overrides live under `options.audit:` in each schema YAML.
+ */
+export interface AuditConfig {
+  /**
+   * Schema name of the actor / user model (typically `User`). Required
+   * when `log: true` because the audits row records the polymorphic
+   * `(user_type, user_id)` of the writer. The referenced schema MUST
+   * have `options.authenticatable: true`.
+   */
+  model?: string;
+  /** Global default for the `created_by_id` audit column. */
+  createdBy?: boolean;
+  /** Global default for the `updated_by_id` audit column. */
+  updatedBy?: boolean;
+  /** Global default for the `deleted_by_id` audit column. */
+  deletedBy?: boolean;
+  /**
+   * Toggle the audits-history table feature globally. Per-schema
+   * `options.audit.log` overrides. Records created / updated / deleted
+   * / restored events into a single polymorphic `audits` table.
+   */
+  log?: boolean;
+  /**
+   * Additional sensitive columns scrubbed from `old_values` /
+   * `new_values` BEFORE the audit row is built. Built-in defaults
+   * (`password`, `remember_token`, `api_token`, `two_factor_secret`,
+   * `two_factor_recovery_codes`) are always merged in — your list ADDS
+   * to them, never replaces.
+   */
+  logExclude?: string[];
+  /**
+   * Prunable retention period (`90d` / `12w` / `6m` / `1y`). Empty
+   * string keeps audits forever (no scheduled prune). Format is
+   * validated; bad input fails generation.
+   */
+  logRetention?: string;
+  /**
+   * Laravel queue connection name for the WriteAuditLog job. Empty
+   * string forces synchronous dispatch — only acceptable in dev /
+   * low-traffic apps. Production should use a queue backed by a real
+   * driver (redis, sqs, etc.).
+   */
+  logQueue?: string;
+}
+
 /** External schema package configuration. */
 export interface PackageConfig {
   /** Path to package root (short form: auto-discovers omnify.yaml inside). */
@@ -137,6 +192,8 @@ export interface OmnifyConfig {
   compoundTypes?: string[];
   /** Code generation configuration (connection-independent). */
   codegen?: CodegenConfig;
+  /** Audit columns + audit-log history table feature (issue #94). */
+  audit?: AuditConfig;
   /** Package mode: stable deterministic timestamps for all Laravel migrations. Issue #60. */
   package?: boolean;
   /** Enable verbose output during generation. */