prisma-schema-auditor 1.0.1

package/dist/core/report/toText.d.ts

@@ -0,0 +1,6 @@
+import type { AuditResult } from './reportTypes.js';
+/**
+ * Format an AuditResult as human-readable text.
+ */
+export declare function toText(result: AuditResult): string;
+//# sourceMappingURL=toText.d.ts.map

package/dist/core/report/toText.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"toText.d.ts","sourceRoot":"","sources":["../../../src/core/report/toText.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAEpD;;GAEG;AACH,wBAAgB,MAAM,CAAC,MAAM,EAAE,WAAW,GAAG,MAAM,CA+ClD"}

package/dist/core/report/toText.js

@@ -0,0 +1,46 @@
+/**
+ * Format an AuditResult as human-readable text.
+ */
+export function toText(result) {
+    const lines = [];
+    lines.push('=== Prisma Schema Audit ===');
+    lines.push('');
+    if (result.metadata.timestamp !== null) {
+        lines.push(`Timestamp: ${result.metadata.timestamp}`);
+    }
+    lines.push(`Schema:    ${result.metadata.schemaPath}`);
+    lines.push(`Models:    ${String(result.metadata.modelCount)}`);
+    lines.push(`Findings:  ${String(result.metadata.findingCount)}`);
+    lines.push('');
+    // Contract summary
+    lines.push('--- Constraint Contract ---');
+    for (const model of result.contract.models) {
+        lines.push(`  Model: ${model.name}`);
+        if (model.primaryKey !== null) {
+            lines.push(`    PK: (${model.primaryKey.fields.join(', ')})`);
+        }
+        for (const uq of model.uniqueConstraints) {
+            const label = uq.name !== null ? ` [${uq.name}]` : '';
+            lines.push(`    Unique${label}: (${uq.fields.join(', ')})`);
+        }
+        for (const fk of model.foreignKeys) {
+            lines.push(`    FK: (${fk.fields.join(', ')}) -> ${fk.referencedModel}(${fk.referencedFields.join(', ')}) onDelete=${fk.onDelete} onUpdate=${fk.onUpdate}`);
+        }
+    }
+    lines.push('');
+    // Findings
+    if (result.findings.length > 0) {
+        lines.push('--- Findings ---');
+        for (const f of result.findings) {
+            const field = f.field !== null ? `.${f.field}` : '';
+            lines.push(`  [${f.severity.toUpperCase()}] ${f.rule} @ ${f.model}${field}`);
+            lines.push(`    ${f.message}`);
+        }
+    }
+    else {
+        lines.push('No normalization findings.');
+    }
+    lines.push('');
+    return lines.join('\n');
+}
+//# sourceMappingURL=toText.js.map

package/dist/core/report/toText.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"toText.js","sourceRoot":"","sources":["../../../src/core/report/toText.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,UAAU,MAAM,CAAC,MAAmB;IACxC,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,KAAK,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;IAC1C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,IAAI,MAAM,CAAC,QAAQ,CAAC,SAAS,KAAK,IAAI,EAAE,CAAC;QACvC,KAAK,CAAC,IAAI,CAAC,cAAc,MAAM,CAAC,QAAQ,CAAC,SAAS,EAAE,CAAC,CAAC;IACxD,CAAC;IACD,KAAK,CAAC,IAAI,CAAC,cAAc,MAAM,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;IACvD,KAAK,CAAC,IAAI,CAAC,cAAc,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;IAC/D,KAAK,CAAC,IAAI,CAAC,cAAc,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;IACjE,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,mBAAmB;IACnB,KAAK,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;IAC1C,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QAC3C,KAAK,CAAC,IAAI,CAAC,YAAY,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;QACrC,IAAI,KAAK,CAAC,UAAU,KAAK,IAAI,EAAE,CAAC;YAC9B,KAAK,CAAC,IAAI,CAAC,YAAY,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAChE,CAAC;QACD,KAAK,MAAM,EAAE,IAAI,KAAK,CAAC,iBAAiB,EAAE,CAAC;YACzC,MAAM,KAAK,GAAG,EAAE,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;YACtD,KAAK,CAAC,IAAI,CAAC,aAAa,KAAK,MAAM,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC9D,CAAC;QACD,KAAK,MAAM,EAAE,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC;YACnC,KAAK,CAAC,IAAI,CACR,YAAY,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,eAAe,IAAI,EAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC,QAAQ,aAAa,EAAE,CAAC,QAAQ,EAAE,CAChJ,CAAC;QACJ,CAAC;IACH,CAAC;IACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,WAAW;IACX,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC/B,KAAK,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAC/B,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;YAChC,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACpD,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,KAAK,GAAG,KAAK,EAAE,CAAC,CAAC;YAC7E,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QACjC,CAAC;IACH,CAAC;SAAM,CAAC;QACN,KAAK,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;IAC3C,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,18 @@
+export type { AuditResult, AuditMetadata, ConstraintContract, ModelContract, FieldContract, PrimaryKeyConstraint, UniqueConstraint, ForeignKeyConstraint, Finding, RuleCode, Severity, NormalForm, OutputFormat, ReferentialAction, } from './core/report/reportTypes.js';
+export type { AuditModel, AuditField, AuditPrimaryKey, AuditUniqueIndex, ParseResult, } from './core/prismaSchema/types.js';
+export type { FunctionalDependency } from './core/analysis/inferFds.js';
+export type { CandidateKey } from './core/analysis/computeKeys.js';
+export type { InvariantsFile, InvariantFd } from './core/invariants/schema.js';
+import type { AuditResult } from './core/report/reportTypes.js';
+/** Options for the audit function. */
+export interface AuditOptions {
+    readonly schemaPath: string;
+    readonly invariantsPath?: string | undefined;
+    readonly noTimestamp?: boolean | undefined;
+}
+/**
+ * Run a full audit on a Prisma schema file.
+ * Returns the constraint contract and normalization findings.
+ */
+export declare function audit(schemaPathOrOptions: string | AuditOptions, noTimestamp?: boolean): Promise<AuditResult>;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,WAAW,EACX,aAAa,EACb,kBAAkB,EAClB,aAAa,EACb,aAAa,EACb,oBAAoB,EACpB,gBAAgB,EAChB,oBAAoB,EACpB,OAAO,EACP,QAAQ,EACR,QAAQ,EACR,UAAU,EACV,YAAY,EACZ,iBAAiB,GAClB,MAAM,8BAA8B,CAAC;AAEtC,YAAY,EACV,UAAU,EACV,UAAU,EACV,eAAe,EACf,gBAAgB,EAChB,WAAW,GACZ,MAAM,8BAA8B,CAAC;AAEtC,YAAY,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACxE,YAAY,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AACnE,YAAY,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAS/E,OAAO,KAAK,EAAE,WAAW,EAAW,MAAM,8BAA8B,CAAC;AAEzE,sCAAsC;AACtC,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7C,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAC5C;AAED;;;GAGG;AACH,wBAAsB,KAAK,CACzB,mBAAmB,EAAE,MAAM,GAAG,YAAY,EAC1C,WAAW,UAAQ,GAClB,OAAO,CAAC,WAAW,CAAC,CAuCtB"}

package/dist/index.js

@@ -0,0 +1,46 @@
+import { parseSchema } from './core/prismaSchema/parse.js';
+import { extractContract } from './core/prismaSchema/contract.js';
+import { inferFunctionalDependencies } from './core/analysis/inferFds.js';
+import { check1nf } from './core/analysis/normalizeChecks/check1nf.js';
+import { check2nf } from './core/analysis/normalizeChecks/check2nf.js';
+import { check3nf } from './core/analysis/normalizeChecks/check3nf.js';
+import { parseInvariantsFile, invariantsToFds, validateInvariantsAgainstContract } from './core/invariants/parse.js';
+/**
+ * Run a full audit on a Prisma schema file.
+ * Returns the constraint contract and normalization findings.
+ */
+export async function audit(schemaPathOrOptions, noTimestamp = false) {
+    const options = typeof schemaPathOrOptions === 'string'
+        ? { schemaPath: schemaPathOrOptions, noTimestamp }
+        : schemaPathOrOptions;
+    const shouldOmitTimestamp = options.noTimestamp === true;
+    const parsed = await parseSchema(options.schemaPath);
+    const contract = extractContract(parsed);
+    const schemaFds = inferFunctionalDependencies(contract);
+    // Merge invariant-declared FDs if provided
+    let allFds = schemaFds;
+    let invariantFindings = [];
+    if (options.invariantsPath !== undefined) {
+        const invariants = parseInvariantsFile(options.invariantsPath);
+        const invariantFds = invariantsToFds(invariants);
+        allFds = [...schemaFds, ...invariantFds];
+        invariantFindings = validateInvariantsAgainstContract(invariants, contract);
+    }
+    const findings = [
+        ...check1nf(contract),
+        ...check2nf(contract, allFds),
+        ...check3nf(contract, allFds),
+        ...invariantFindings,
+    ];
+    return {
+        contract,
+        findings,
+        metadata: {
+            schemaPath: options.schemaPath,
+            timestamp: shouldOmitTimestamp ? null : new Date().toISOString(),
+            modelCount: contract.models.length,
+            findingCount: findings.length,
+        },
+    };
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AA6BA,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAClE,OAAO,EAAE,2BAA2B,EAAE,MAAM,6BAA6B,CAAC;AAC1E,OAAO,EAAE,QAAQ,EAAE,MAAM,6CAA6C,CAAC;AACvE,OAAO,EAAE,QAAQ,EAAE,MAAM,6CAA6C,CAAC;AACvE,OAAO,EAAE,QAAQ,EAAE,MAAM,6CAA6C,CAAC;AACvE,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,iCAAiC,EAAE,MAAM,4BAA4B,CAAC;AAUrH;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,KAAK,CACzB,mBAA0C,EAC1C,WAAW,GAAG,KAAK;IAEnB,MAAM,OAAO,GACX,OAAO,mBAAmB,KAAK,QAAQ;QACrC,CAAC,CAAC,EAAE,UAAU,EAAE,mBAAmB,EAAE,WAAW,EAAE;QAClD,CAAC,CAAC,mBAAmB,CAAC;IAE1B,MAAM,mBAAmB,GAAG,OAAO,CAAC,WAAW,KAAK,IAAI,CAAC;IAEzD,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACrD,MAAM,QAAQ,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;IACzC,MAAM,SAAS,GAAG,2BAA2B,CAAC,QAAQ,CAAC,CAAC;IAExD,2CAA2C;IAC3C,IAAI,MAAM,GAAG,SAAS,CAAC;IACvB,IAAI,iBAAiB,GAAuB,EAAE,CAAC;IAC/C,IAAI,OAAO,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;QACzC,MAAM,UAAU,GAAG,mBAAmB,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QAC/D,MAAM,YAAY,GAAG,eAAe,CAAC,UAAU,CAAC,CAAC;QACjD,MAAM,GAAG,CAAC,GAAG,SAAS,EAAE,GAAG,YAAY,CAAC,CAAC;QACzC,iBAAiB,GAAG,iCAAiC,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IAC9E,CAAC;IAED,MAAM,QAAQ,GAAG;QACf,GAAG,QAAQ,CAAC,QAAQ,CAAC;QACrB,GAAG,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;QAC7B,GAAG,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;QAC7B,GAAG,iBAAiB;KACrB,CAAC;IAEF,OAAO;QACL,QAAQ;QACR,QAAQ;QACR,QAAQ,EAAE;YACR,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,SAAS,EAAE,mBAAmB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;YAChE,UAAU,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM;YAClC,YAAY,EAAE,QAAQ,CAAC,MAAM;SAC9B;KACF,CAAC;AACJ,CAAC"}

package/dist/util/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Sort an array by a key function. Returns a new array.
+ */
+export declare function sortBy<T>(arr: readonly T[], keyFn: (item: T) => string): T[];
+//# sourceMappingURL=index.d.ts.map

package/dist/util/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/util/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,SAAS,CAAC,EAAE,EAAE,KAAK,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,MAAM,GAAG,CAAC,EAAE,CAQ5E"}

package/dist/util/index.js

@@ -0,0 +1,15 @@
+/**
+ * Sort an array by a key function. Returns a new array.
+ */
+export function sortBy(arr, keyFn) {
+    return [...arr].sort((a, b) => {
+        const ka = keyFn(a);
+        const kb = keyFn(b);
+        if (ka < kb)
+            return -1;
+        if (ka > kb)
+            return 1;
+        return 0;
+    });
+}
+//# sourceMappingURL=index.js.map

package/dist/util/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/util/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,UAAU,MAAM,CAAI,GAAiB,EAAE,KAA0B;IACrE,OAAO,CAAC,GAAG,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QAC5B,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACpB,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACpB,IAAI,EAAE,GAAG,EAAE;YAAE,OAAO,CAAC,CAAC,CAAC;QACvB,IAAI,EAAE,GAAG,EAAE;YAAE,OAAO,CAAC,CAAC;QACtB,OAAO,CAAC,CAAC;IACX,CAAC,CAAC,CAAC;AACL,CAAC"}

package/package.json

@@ -0,0 +1,84 @@
+{
+  "name": "prisma-schema-auditor",
+  "version": "1.0.1",
+  "description": "Static analysis for Prisma schemas: deterministic constraint contracts + normalization lint findings (1NF/2NF; 3NF+ via invariants)",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "bin": {
+    "prisma-schema-auditor": "./dist/cli.js"
+  },
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "typecheck": "tsc -p tsconfig.test.json",
+    "lint": "eslint src tests",
+    "lint:fix": "eslint src tests --fix",
+    "knip": "knip",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "ci": "pnpm audit --prod && pnpm run typecheck && pnpm run lint && pnpm run knip && pnpm run test",
+    "prepublishOnly": "pnpm run build",
+    "version": "pnpm run build"
+  },
+  "keywords": [
+    "prisma",
+    "schema",
+    "audit",
+    "normalization",
+    "constraint",
+    "1nf",
+    "2nf",
+    "3nf",
+    "static-analysis",
+    "typescript"
+  ],
+  "author": "EddieRydell",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/EddieRydell/prisma-schema-auditor.git"
+  },
+  "homepage": "https://github.com/EddieRydell/prisma-schema-auditor#readme",
+  "bugs": {
+    "url": "https://github.com/EddieRydell/prisma-schema-auditor/issues"
+  },
+  "peerDependencies": {
+    "@prisma/internals": ">=7.0.0",
+    "prisma": ">=7.0.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.0.0",
+    "@prisma/internals": "^7.0.0",
+    "@types/node": "^25.2.1",
+    "@vitest/coverage-v8": "^4.0.18",
+    "eslint": "^9.0.0",
+    "knip": "^5.0.0",
+    "prisma": "^7.0.0",
+    "semantic-release": "^25.0.3",
+    "typescript": "^5.7.0",
+    "typescript-eslint": "^8.0.0",
+    "vitest": "^4.0.18"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "dependencies": {
+    "zod": "^4.3.6"
+  }
+}