@marinoscar/platform-api 0.0.0-stage → 0.1.0-next.4

package/dist/testing/host/test-platform-host.js

@@ -0,0 +1,81 @@
+"use strict";
+// =============================================================================
+// A platform host for PACKAGE tests (issue #696, PP-2.7)
+// =============================================================================
+//
+// ⚠ NEVER FOR AN APP. The access decorators below trust a request header: the
+// caller names its own permissions in `x-test-permissions`. That is exactly
+// what a package test needs (drive 401/403/200 through a real Nest app without
+// the app's JWT stack) and exactly what production must never do. An app
+// builds its host from its own auth decorators (`definePlatformHost`).
+// =============================================================================
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TEST_REQUIRED_PERMISSIONS_KEY = exports.TEST_PERMISSIONS_HEADER = void 0;
+exports.createTestPlatformHost = createTestPlatformHost;
+const common_1 = require("@nestjs/common");
+const index_1 = require("../../core/index");
+/**
+ * The request header the test host reads: a comma-separated permission list.
+ * Absent means "not signed in" (401); present means signed in with exactly
+ * those permissions.
+ *
+ * @stability experimental
+ */
+exports.TEST_PERMISSIONS_HEADER = 'x-test-permissions';
+/**
+ * Metadata key under which the test host records the permissions a handler
+ * requires, so a package test can assert what a controller declares.
+ *
+ * @stability experimental
+ */
+exports.TEST_REQUIRED_PERMISSIONS_KEY = 'platform:test-required-permissions';
+function headerOf(context) {
+    const request = context.switchToHttp().getRequest();
+    const raw = request?.headers?.[exports.TEST_PERMISSIONS_HEADER];
+    return Array.isArray(raw) ? raw.join(',') : raw;
+}
+class TestAccessGuard {
+    required;
+    constructor(required) {
+        this.required = required;
+    }
+    canActivate(context) {
+        const header = headerOf(context);
+        if (header === undefined)
+            throw new common_1.UnauthorizedException('No x-test-permissions header');
+        const held = new Set(header
+            .split(',')
+            .map((p) => p.trim())
+            .filter(Boolean));
+        const missing = this.required.filter((p) => !held.has(p));
+        if (missing.length > 0)
+            throw new common_1.ForbiddenException(`Missing permission(s): ${missing.join(', ')}`);
+        return true;
+    }
+}
+/**
+ * A {@link PlatformHost} whose access decorators read the
+ * `x-test-permissions` request header: no header is 401, a missing permission
+ * is 403. For package tests only, never for apps.
+ *
+ * @returns a validated host (built with `definePlatformHost`).
+ *
+ * @example
+ * ```ts
+ * const module = await Test.createTestingModule({
+ *   imports: [DoctorModule.forRoot({ host: createTestPlatformHost() })],
+ * }).compile();
+ * // GET /admin/doctor with `x-test-permissions: system_settings:read` -> 200
+ * ```
+ *
+ * @stability experimental
+ */
+function createTestPlatformHost() {
+    return (0, index_1.definePlatformHost)({
+        access: {
+            requirePermissions: (permissions) => (0, common_1.applyDecorators)((0, common_1.SetMetadata)(exports.TEST_REQUIRED_PERMISSIONS_KEY, [...permissions]), (0, common_1.UseGuards)(new TestAccessGuard([...permissions]))),
+            requireAuthenticated: () => (0, common_1.applyDecorators)((0, common_1.SetMetadata)(exports.TEST_REQUIRED_PERMISSIONS_KEY, []), (0, common_1.UseGuards)(new TestAccessGuard([]))),
+        },
+    });
+}
+//# sourceMappingURL=test-platform-host.js.map

package/dist/testing/host/test-platform-host.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-platform-host.js","sourceRoot":"","sources":["../../../src/testing/host/test-platform-host.ts"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,yDAAyD;AACzD,gFAAgF;AAChF,EAAE;AACF,8EAA8E;AAC9E,4EAA4E;AAC5E,+EAA+E;AAC/E,yEAAyE;AACzE,uEAAuE;AACvE,gFAAgF;;;AAyEhF,wDAYC;AAnFD,2CAQwB;AAExB,4CAAsD;AAGtD;;;;;;GAMG;AACU,QAAA,uBAAuB,GAAG,oBAAoB,CAAC;AAE5D;;;;;GAKG;AACU,QAAA,6BAA6B,GAAG,oCAAoC,CAAC;AAElF,SAAS,QAAQ,CAAC,OAAyB;IACzC,MAAM,OAAO,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,UAAU,EAA+D,CAAC;IACjH,MAAM,GAAG,GAAG,OAAO,EAAE,OAAO,EAAE,CAAC,+BAAuB,CAAC,CAAC;IACxD,OAAO,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;AAClD,CAAC;AAED,MAAM,eAAe;IACU;IAA7B,YAA6B,QAA2B;QAA3B,aAAQ,GAAR,QAAQ,CAAmB;IAAG,CAAC;IAE5D,WAAW,CAAC,OAAyB;QACnC,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC;QACjC,IAAI,MAAM,KAAK,SAAS;YAAE,MAAM,IAAI,8BAAqB,CAAC,8BAA8B,CAAC,CAAC;QAC1F,MAAM,IAAI,GAAG,IAAI,GAAG,CAClB,MAAM;aACH,KAAK,CAAC,GAAG,CAAC;aACV,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;aACpB,MAAM,CAAC,OAAO,CAAC,CACnB,CAAC;QACF,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1D,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;YAAE,MAAM,IAAI,2BAAkB,CAAC,0BAA0B,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACrG,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,sBAAsB;IACpC,OAAO,IAAA,0BAAkB,EAAC;QACxB,MAAM,EAAE;YACN,kBAAkB,EAAE,CAAC,WAAW,EAAE,EAAE,CAClC,IAAA,wBAAe,EACb,IAAA,oBAAW,EAAC,qCAA6B,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,EAC5D,IAAA,kBAAS,EAAC,IAAI,eAAe,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CACjD;YACH,oBAAoB,EAAE,GAAG,EAAE,CACzB,IAAA,wBAAe,EAAC,IAAA,oBAAW,EAAC,qCAA6B,EAAE,EAAE,CAAC,EAAE,IAAA,kBAAS,EAAC,IAAI,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC;SACtG;KACF,CAAC,CAAC;AACL,CAAC"}

package/dist/testing/index.d.ts

@@ -0,0 +1,40 @@
+import type { CronEnqueueOnlyOptions } from './suites/cron-enqueue-only';
+import type { UserOwnedDataOptions } from './suites/user-owned-data';
+export { formatConformanceSummary, runPlatformConformance } from './run-platform-conformance';
+export type { ConformanceSummaryEntry, PlatformConformanceOptions } from './run-platform-conformance';
+export { conformanceSuites } from './conformance-suites';
+export { resolveConformanceTestApi } from './test-api';
+export type { ConformanceAppSuite, ConformanceCase, ConformanceContext, ConformanceFinding, ConformanceReport, ConformanceSkip, ConformanceSuite, ConformanceTestApi, } from './conformance-suite';
+export { cronEnqueueOnlySuite } from './suites/cron-enqueue-only';
+export type { CronEnqueueOnlyOptions } from './suites/cron-enqueue-only';
+export { createTestPlatformHost, InMemoryAuditSink, InMemorySystemSettingsStore, TEST_PERMISSIONS_HEADER, TEST_REQUIRED_PERMISSIONS_KEY, } from './host/index';
+export { userOwnedDataSuite } from './suites/user-owned-data';
+export type { UserOwnedDataOptions } from './suites/user-owned-data';
+export { effectiveOnDelete, parsePrismaSchema, readSchemaDatamodel, readSchemaText } from './prisma-schema';
+export type { DatamodelField, DatamodelModel, DatamodelRelation } from './prisma-schema';
+/**
+ * The suites {@link runPlatformConformance} can run, by option key: each
+ * entry is the suite's options (the app passes them, or `{ skip: 'reason' }`
+ * to opt out; see {@link PlatformConformanceOptions.suites}). An interface so a slice
+ * that ships a suite adds its key by module augmentation (the telemetry slice's
+ * `telemetry`, declared in `@marinoscar/platform-api/telemetry/testing`) and
+ * the runner is not edited.
+ *
+ * @example
+ * ```ts
+ * declare module '@marinoscar/platform-api/testing' {
+ *   interface PlatformConformanceSuiteOptions {
+ *     myFeature?: MyFeatureOptions;
+ *   }
+ * }
+ * ```
+ *
+ * @stability experimental
+ */
+export interface PlatformConformanceSuiteOptions {
+    /** The `cron-enqueue-only` suite: its options, or `{ skip: 'reason' }` to opt out. */
+    cronEnqueueOnly?: CronEnqueueOnlyOptions;
+    /** The `user-owned-data` suite: its options, or `{ skip: 'reason' }` to opt out. */
+    userOwnedData?: UserOwnedDataOptions;
+}
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/testing/index.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AACzE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAErE,OAAO,EAAE,wBAAwB,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AAC9F,YAAY,EAAE,uBAAuB,EAAE,0BAA0B,EAAE,MAAM,4BAA4B,CAAC;AACtG,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,yBAAyB,EAAE,MAAM,YAAY,CAAC;AACvD,YAAY,EACV,mBAAmB,EACnB,eAAe,EACf,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,eAAe,EACf,gBAAgB,EAChB,kBAAkB,GACnB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAClE,YAAY,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AAIzE,OAAO,EACL,sBAAsB,EACtB,iBAAiB,EACjB,2BAA2B,EAC3B,uBAAuB,EACvB,6BAA6B,GAC9B,MAAM,cAAc,CAAC;AAItB,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAC9D,YAAY,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AACrE,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAC5G,YAAY,EAAE,cAAc,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAIzF;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,+BAA+B;IAC9C,sFAAsF;IACtF,eAAe,CAAC,EAAE,sBAAsB,CAAC;IACzC,oFAAoF;IACpF,aAAa,CAAC,EAAE,oBAAoB,CAAC;CACtC"}

package/dist/testing/index.js

@@ -0,0 +1,35 @@
+"use strict";
+// `@marinoscar/platform-api/testing`: the conformance harness. Documented in ./README.md.
+//
+// Peer-free on purpose: nothing under src/testing imports Jest or Vitest, so
+// one harness serves the Jest API and the Vitest web and CLI apps
+// (test/testing/peer-free.spec.ts).
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readSchemaText = exports.readSchemaDatamodel = exports.parsePrismaSchema = exports.effectiveOnDelete = exports.userOwnedDataSuite = exports.TEST_REQUIRED_PERMISSIONS_KEY = exports.TEST_PERMISSIONS_HEADER = exports.InMemorySystemSettingsStore = exports.InMemoryAuditSink = exports.createTestPlatformHost = exports.cronEnqueueOnlySuite = exports.resolveConformanceTestApi = exports.conformanceSuites = exports.runPlatformConformance = exports.formatConformanceSummary = void 0;
+var run_platform_conformance_1 = require("./run-platform-conformance");
+Object.defineProperty(exports, "formatConformanceSummary", { enumerable: true, get: function () { return run_platform_conformance_1.formatConformanceSummary; } });
+Object.defineProperty(exports, "runPlatformConformance", { enumerable: true, get: function () { return run_platform_conformance_1.runPlatformConformance; } });
+var conformance_suites_1 = require("./conformance-suites");
+Object.defineProperty(exports, "conformanceSuites", { enumerable: true, get: function () { return conformance_suites_1.conformanceSuites; } });
+var test_api_1 = require("./test-api");
+Object.defineProperty(exports, "resolveConformanceTestApi", { enumerable: true, get: function () { return test_api_1.resolveConformanceTestApi; } });
+var cron_enqueue_only_1 = require("./suites/cron-enqueue-only");
+Object.defineProperty(exports, "cronEnqueueOnlySuite", { enumerable: true, get: function () { return cron_enqueue_only_1.cronEnqueueOnlySuite; } });
+// Test doubles for the host ports (issue #696): a header-driven platform host
+// and in-memory audit and settings ports, for PACKAGE tests only.
+var index_1 = require("./host/index");
+Object.defineProperty(exports, "createTestPlatformHost", { enumerable: true, get: function () { return index_1.createTestPlatformHost; } });
+Object.defineProperty(exports, "InMemoryAuditSink", { enumerable: true, get: function () { return index_1.InMemoryAuditSink; } });
+Object.defineProperty(exports, "InMemorySystemSettingsStore", { enumerable: true, get: function () { return index_1.InMemorySystemSettingsStore; } });
+Object.defineProperty(exports, "TEST_PERMISSIONS_HEADER", { enumerable: true, get: function () { return index_1.TEST_PERMISSIONS_HEADER; } });
+Object.defineProperty(exports, "TEST_REQUIRED_PERMISSIONS_KEY", { enumerable: true, get: function () { return index_1.TEST_REQUIRED_PERMISSIONS_KEY; } });
+// The `user-owned-data` suite (issue #699; origin #688) and the small Prisma
+// schema reader behind it (models, fields, relations, onDelete).
+var user_owned_data_1 = require("./suites/user-owned-data");
+Object.defineProperty(exports, "userOwnedDataSuite", { enumerable: true, get: function () { return user_owned_data_1.userOwnedDataSuite; } });
+var prisma_schema_1 = require("./prisma-schema");
+Object.defineProperty(exports, "effectiveOnDelete", { enumerable: true, get: function () { return prisma_schema_1.effectiveOnDelete; } });
+Object.defineProperty(exports, "parsePrismaSchema", { enumerable: true, get: function () { return prisma_schema_1.parsePrismaSchema; } });
+Object.defineProperty(exports, "readSchemaDatamodel", { enumerable: true, get: function () { return prisma_schema_1.readSchemaDatamodel; } });
+Object.defineProperty(exports, "readSchemaText", { enumerable: true, get: function () { return prisma_schema_1.readSchemaText; } });
+//# sourceMappingURL=index.js.map

package/dist/testing/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/testing/index.ts"],"names":[],"mappings":";AAAA,0FAA0F;AAC1F,EAAE;AACF,6EAA6E;AAC7E,kEAAkE;AAClE,oCAAoC;;;AAKpC,uEAA8F;AAArF,oIAAA,wBAAwB,OAAA;AAAE,kIAAA,sBAAsB,OAAA;AAEzD,2DAAyD;AAAhD,uHAAA,iBAAiB,OAAA;AAC1B,uCAAuD;AAA9C,qHAAA,yBAAyB,OAAA;AAWlC,gEAAkE;AAAzD,yHAAA,oBAAoB,OAAA;AAG7B,8EAA8E;AAC9E,kEAAkE;AAClE,sCAMsB;AALpB,+GAAA,sBAAsB,OAAA;AACtB,0GAAA,iBAAiB,OAAA;AACjB,oHAAA,2BAA2B,OAAA;AAC3B,gHAAA,uBAAuB,OAAA;AACvB,sHAAA,6BAA6B,OAAA;AAG/B,6EAA6E;AAC7E,iEAAiE;AACjE,4DAA8D;AAArD,qHAAA,kBAAkB,OAAA;AAE3B,iDAA4G;AAAnG,kHAAA,iBAAiB,OAAA;AAAE,kHAAA,iBAAiB,OAAA;AAAE,oHAAA,mBAAmB,OAAA;AAAE,+GAAA,cAAc,OAAA"}

package/dist/testing/prisma-schema.d.ts

@@ -0,0 +1,99 @@
+/**
+ * A relation's arguments, as written in `@relation(...)`.
+ *
+ * @stability experimental
+ */
+export interface DatamodelRelation {
+    /** The relation name, when one is given (`@relation("Name", ...)` or `name: "Name"`). */
+    readonly name?: string;
+    /** Foreign key fields on this side; empty on the back-relation side. */
+    readonly fields: readonly string[];
+    /** The referenced fields on the other model. */
+    readonly references: readonly string[];
+    /** The `onDelete` written in the schema, if any. See {@link effectiveOnDelete}. */
+    readonly onDelete?: string;
+}
+/**
+ * One field of a parsed model.
+ *
+ * @stability experimental
+ */
+export interface DatamodelField {
+    /** The field name. */
+    readonly name: string;
+    /** The type name without `?` or `[]`: `String`, `User`, `Role`... */
+    readonly type: string;
+    /** Whether the type ends in `[]`. */
+    readonly isList: boolean;
+    /** Whether the type ends in `?`. */
+    readonly isOptional: boolean;
+    /** Present when the field has a `@relation(...)` attribute. */
+    readonly relation?: DatamodelRelation;
+}
+/**
+ * One parsed model.
+ *
+ * @stability experimental
+ */
+export interface DatamodelModel {
+    /** The model name. */
+    readonly name: string;
+    /** Its fields, in schema order. */
+    readonly fields: readonly DatamodelField[];
+}
+/** Removes a `//` comment (including `///` doc comments), ignoring `//` inside a string literal. */
+export declare function stripLineComment(line: string): string;
+/**
+ * Parses the models of a Prisma schema.
+ *
+ * @param source - the schema text (one file, or several joined).
+ * @returns the models in schema order; enums, views, generators and datasources are skipped.
+ *
+ * @stability experimental
+ * @example
+ * ```ts
+ * parsePrismaSchema('model Note {\n  id String @id\n}').map((m) => m.name); // ['Note']
+ * ```
+ */
+export declare function parsePrismaSchema(source: string): DatamodelModel[];
+/**
+ * The text of a schema: one file, or every `*.prisma` file of a folder in
+ * name order (the order Prisma loads them, which is the order of the
+ * generated client's models).
+ *
+ * @param path - a `schema.prisma` file or a folder of `*.prisma` files.
+ *
+ * @stability experimental
+ * @example
+ * ```ts
+ * const text = readSchemaText(join(__dirname, '..', '..', 'prisma', 'schema'));
+ * ```
+ */
+export declare function readSchemaText(path: string): string;
+/**
+ * The models of the schema at `path` (a file or a folder).
+ *
+ * @param path - see {@link readSchemaText}.
+ *
+ * @stability experimental
+ * @example
+ * ```ts
+ * const models = readSchemaDatamodel(join(__dirname, '..', '..', 'prisma', 'schema'));
+ * ```
+ */
+export declare function readSchemaDatamodel(path: string): DatamodelModel[];
+/**
+ * The referential action Postgres actually applies: the one written, or
+ * Prisma's default (`SetNull` for an optional relation, `Restrict` for a
+ * required one).
+ *
+ * @param field - a relation field.
+ *
+ * @stability experimental
+ * @example
+ * ```ts
+ * effectiveOnDelete({ name: 'user', type: 'User', isList: false, isOptional: true, relation: { fields: ['userId'], references: ['id'] } }); // 'SetNull'
+ * ```
+ */
+export declare function effectiveOnDelete(field: DatamodelField): string;
+//# sourceMappingURL=prisma-schema.d.ts.map

package/dist/testing/prisma-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prisma-schema.d.ts","sourceRoot":"","sources":["../../src/testing/prisma-schema.ts"],"names":[],"mappings":"AAuBA;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,yFAAyF;IACzF,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,wEAAwE;IACxE,QAAQ,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;IACnC,gDAAgD;IAChD,QAAQ,CAAC,UAAU,EAAE,SAAS,MAAM,EAAE,CAAC;IACvC,mFAAmF;IACnF,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,sBAAsB;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,qEAAqE;IACrE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,qCAAqC;IACrC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,oCAAoC;IACpC,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAC7B,+DAA+D;IAC/D,QAAQ,CAAC,QAAQ,CAAC,EAAE,iBAAiB,CAAC;CACvC;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,sBAAsB;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,mCAAmC;IACnC,QAAQ,CAAC,MAAM,EAAE,SAAS,cAAc,EAAE,CAAC;CAC5C;AAED,oGAAoG;AACpG,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAarD;AA2BD;;;;;;;;;;;GAWG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,cAAc,EAAE,CAyClE;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAOnD;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,cAAc,EAAE,CAElE;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,cAAc,GAAG,MAAM,CAE/D"}

package/dist/testing/prisma-schema.js

@@ -0,0 +1,175 @@
+"use strict";
+// =============================================================================
+// A minimal reader for a Prisma schema's models and relations (#688, moved to
+// the testing slice by #699)
+// =============================================================================
+//
+// WHY PARSE THE FILE: the `userOwnedData` suite needs each relation's foreign
+// key fields and `onDelete`. Prisma 7's generated client still exports
+// `Prisma.dmmf.datamodel`, but its relation fields carry only `name`, `kind`,
+// `type` and `relationName`: no `relationFromFields`, no `relationOnDelete`.
+// The schema file is the only place they are written down. Parsing it also
+// keeps this package free of any generated client and of `@prisma/internals`.
+//
+// Deliberately small: models, their fields, and `@relation(...)` arguments.
+// Enums, views, generators, datasources and block attributes (`@@...`) are
+// skipped. `extend model` blocks are not read (the app's composed schema has
+// none). The package's spec pins what it understands; the reference app's
+// apps/api/test/prisma/schema-datamodel.spec.ts proves it agrees with the
+// generated client on the real schema.
+// =============================================================================
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stripLineComment = stripLineComment;
+exports.parsePrismaSchema = parsePrismaSchema;
+exports.readSchemaText = readSchemaText;
+exports.readSchemaDatamodel = readSchemaDatamodel;
+exports.effectiveOnDelete = effectiveOnDelete;
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
+/** Removes a `//` comment (including `///` doc comments), ignoring `//` inside a string literal. */
+function stripLineComment(line) {
+    let inString = false;
+    for (let i = 0; i < line.length; i += 1) {
+        const ch = line[i];
+        if (ch === '\\' && inString) {
+            i += 1;
+        }
+        else if (ch === '"') {
+            inString = !inString;
+        }
+        else if (!inString && ch === '/' && line[i + 1] === '/') {
+            return line.slice(0, i);
+        }
+    }
+    return line;
+}
+function listArgument(args, key) {
+    const match = new RegExp(`\\b${key}\\s*:\\s*\\[([^\\]]*)\\]`).exec(args);
+    if (!match)
+        return [];
+    return match[1]
+        .split(',')
+        .map((part) => part.trim())
+        .filter((part) => part.length > 0);
+}
+function parseRelation(attributes) {
+    const match = /@relation\(([^)]*)\)/.exec(attributes);
+    if (!match) {
+        return /@relation\b/.test(attributes) ? { fields: [], references: [] } : undefined;
+    }
+    const args = match[1];
+    const named = /\bname\s*:\s*"([^"]*)"/.exec(args) ?? /^\s*"([^"]*)"/.exec(args);
+    const onDelete = /\bonDelete\s*:\s*(\w+)/.exec(args);
+    return {
+        ...(named ? { name: named[1] } : {}),
+        fields: listArgument(args, 'fields'),
+        references: listArgument(args, 'references'),
+        ...(onDelete ? { onDelete: onDelete[1] } : {}),
+    };
+}
+/**
+ * Parses the models of a Prisma schema.
+ *
+ * @param source - the schema text (one file, or several joined).
+ * @returns the models in schema order; enums, views, generators and datasources are skipped.
+ *
+ * @stability experimental
+ * @example
+ * ```ts
+ * parsePrismaSchema('model Note {\n  id String @id\n}').map((m) => m.name); // ['Note']
+ * ```
+ */
+function parsePrismaSchema(source) {
+    const models = [];
+    let current;
+    let otherBlock = false;
+    for (const raw of source.split(/\r?\n/)) {
+        const line = stripLineComment(raw).trim();
+        if (line === '')
+            continue;
+        if (current === undefined && !otherBlock) {
+            const model = /^model\s+(\w+)\s*\{$/.exec(line);
+            if (model) {
+                current = { name: model[1], fields: [] };
+            }
+            else if (/^\w+\s+\w+\s*\{$/.test(line)) {
+                otherBlock = true; // enum, view, type, generator, datasource
+            }
+            continue;
+        }
+        if (line === '}') {
+            if (current)
+                models.push(current);
+            current = undefined;
+            otherBlock = false;
+            continue;
+        }
+        if (otherBlock || current === undefined || line.startsWith('@@'))
+            continue;
+        const field = /^(\w+)\s+(\w+)(\[\])?(\?)?(.*)$/.exec(line);
+        if (!field)
+            continue;
+        const relation = parseRelation(field[5]);
+        current.fields.push({
+            name: field[1],
+            type: field[2],
+            isList: field[3] === '[]',
+            isOptional: field[4] === '?',
+            ...(relation ? { relation } : {}),
+        });
+    }
+    return models;
+}
+/**
+ * The text of a schema: one file, or every `*.prisma` file of a folder in
+ * name order (the order Prisma loads them, which is the order of the
+ * generated client's models).
+ *
+ * @param path - a `schema.prisma` file or a folder of `*.prisma` files.
+ *
+ * @stability experimental
+ * @example
+ * ```ts
+ * const text = readSchemaText(join(__dirname, '..', '..', 'prisma', 'schema'));
+ * ```
+ */
+function readSchemaText(path) {
+    if (!(0, node_fs_1.statSync)(path).isDirectory())
+        return (0, node_fs_1.readFileSync)(path, 'utf8');
+    return (0, node_fs_1.readdirSync)(path)
+        .filter((name) => name.endsWith('.prisma'))
+        .sort()
+        .map((name) => (0, node_fs_1.readFileSync)((0, node_path_1.join)(path, name), 'utf8'))
+        .join('\n');
+}
+/**
+ * The models of the schema at `path` (a file or a folder).
+ *
+ * @param path - see {@link readSchemaText}.
+ *
+ * @stability experimental
+ * @example
+ * ```ts
+ * const models = readSchemaDatamodel(join(__dirname, '..', '..', 'prisma', 'schema'));
+ * ```
+ */
+function readSchemaDatamodel(path) {
+    return parsePrismaSchema(readSchemaText(path));
+}
+/**
+ * The referential action Postgres actually applies: the one written, or
+ * Prisma's default (`SetNull` for an optional relation, `Restrict` for a
+ * required one).
+ *
+ * @param field - a relation field.
+ *
+ * @stability experimental
+ * @example
+ * ```ts
+ * effectiveOnDelete({ name: 'user', type: 'User', isList: false, isOptional: true, relation: { fields: ['userId'], references: ['id'] } }); // 'SetNull'
+ * ```
+ */
+function effectiveOnDelete(field) {
+    return field.relation?.onDelete ?? (field.isOptional ? 'SetNull' : 'Restrict');
+}
+//# sourceMappingURL=prisma-schema.js.map

package/dist/testing/prisma-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prisma-schema.js","sourceRoot":"","sources":["../../src/testing/prisma-schema.ts"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,8EAA8E;AAC9E,6BAA6B;AAC7B,gFAAgF;AAChF,EAAE;AACF,8EAA8E;AAC9E,uEAAuE;AACvE,8EAA8E;AAC9E,6EAA6E;AAC7E,2EAA2E;AAC3E,8EAA8E;AAC9E,EAAE;AACF,4EAA4E;AAC5E,2EAA2E;AAC3E,6EAA6E;AAC7E,0EAA0E;AAC1E,0EAA0E;AAC1E,uCAAuC;AACvC,gFAAgF;;AAoDhF,4CAaC;AAuCD,8CAyCC;AAeD,wCAOC;AAaD,kDAEC;AAeD,8CAEC;AArMD,qCAA8D;AAC9D,yCAAiC;AAgDjC,oGAAoG;AACpG,SAAgB,gBAAgB,CAAC,IAAY;IAC3C,IAAI,QAAQ,GAAG,KAAK,CAAC;IACrB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QACxC,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QACnB,IAAI,EAAE,KAAK,IAAI,IAAI,QAAQ,EAAE,CAAC;YAC5B,CAAC,IAAI,CAAC,CAAC;QACT,CAAC;aAAM,IAAI,EAAE,KAAK,GAAG,EAAE,CAAC;YACtB,QAAQ,GAAG,CAAC,QAAQ,CAAC;QACvB,CAAC;aAAM,IAAI,CAAC,QAAQ,IAAI,EAAE,KAAK,GAAG,IAAI,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;YAC1D,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAC1B,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,YAAY,CAAC,IAAY,EAAE,GAAW;IAC7C,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,MAAM,GAAG,0BAA0B,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzE,IAAI,CAAC,KAAK;QAAE,OAAO,EAAE,CAAC;IACtB,OAAO,KAAK,CAAC,CAAC,CAAE;SACb,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;SAC1B,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;AACvC,CAAC;AAED,SAAS,aAAa,CAAC,UAAkB;IACvC,MAAM,KAAK,GAAG,sBAAsB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACtD,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;IACrF,CAAC;IACD,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC;IACvB,MAAM,KAAK,GAAG,wBAAwB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAChF,MAAM,QAAQ,GAAG,wBAAwB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrD,OAAO;QACL,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACrC,MAAM,EAAE,YAAY,CAAC,IAAI,EAAE,QAAQ,CAAC;QACpC,UAAU,EAAE,YAAY,CAAC,IAAI,EAAE,YAAY,CAAC;QAC5C,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAChD,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,iBAAiB,CAAC,MAAc;IAC9C,MAAM,MAAM,GAAqB,EAAE,CAAC;IACpC,IAAI,OAA+D,CAAC;IACpE,IAAI,UAAU,GAAG,KAAK,CAAC;IAEvB,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;QACxC,MAAM,IAAI,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;QAC1C,IAAI,IAAI,KAAK,EAAE;YAAE,SAAS;QAE1B,IAAI,OAAO,KAAK,SAAS,IAAI,CAAC,UAAU,EAAE,CAAC;YACzC,MAAM,KAAK,GAAG,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAChD,IAAI,KAAK,EAAE,CAAC;gBACV,OAAO,GAAG,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;YAC5C,CAAC;iBAAM,IAAI,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBACzC,UAAU,GAAG,IAAI,CAAC,CAAC,0CAA0C;YAC/D,CAAC;YACD,SAAS;QACX,CAAC;QAED,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;YACjB,IAAI,OAAO;gBAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAClC,OAAO,GAAG,SAAS,CAAC;YACpB,UAAU,GAAG,KAAK,CAAC;YACnB,SAAS;QACX,CAAC;QAED,IAAI,UAAU,IAAI,OAAO,KAAK,SAAS,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YAAE,SAAS;QAE3E,MAAM,KAAK,GAAG,iCAAiC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC3D,IAAI,CAAC,KAAK;YAAE,SAAS;QACrB,MAAM,QAAQ,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC,CAAE,CAAC,CAAC;QAC1C,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC;YAClB,IAAI,EAAE,KAAK,CAAC,CAAC,CAAE;YACf,IAAI,EAAE,KAAK,CAAC,CAAC,CAAE;YACf,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,IAAI;YACzB,UAAU,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,GAAG;YAC5B,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAClC,CAAC,CAAC;IACL,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,cAAc,CAAC,IAAY;IACzC,IAAI,CAAC,IAAA,kBAAQ,EAAC,IAAI,CAAC,CAAC,WAAW,EAAE;QAAE,OAAO,IAAA,sBAAY,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACrE,OAAO,IAAA,qBAAW,EAAC,IAAI,CAAC;SACrB,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;SAC1C,IAAI,EAAE;SACN,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,sBAAY,EAAC,IAAA,gBAAI,EAAC,IAAI,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC;SACrD,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,mBAAmB,CAAC,IAAY;IAC9C,OAAO,iBAAiB,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC;AACjD,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,iBAAiB,CAAC,KAAqB;IACrD,OAAO,KAAK,CAAC,QAAQ,EAAE,QAAQ,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;AACjF,CAAC"}

package/dist/testing/run-platform-conformance.d.ts

@@ -0,0 +1,77 @@
+import type { ConformanceSkip, ConformanceTestApi } from './conformance-suite';
+import type { PlatformConformanceSuiteOptions } from './index';
+/**
+ * What an app passes to {@link runPlatformConformance}.
+ *
+ * @extensionPoint option
+ * @stability experimental
+ */
+export interface PlatformConformanceOptions {
+    /** Absolute directories holding the app's non-test TypeScript sources, for example `[join(__dirname, '../../src')]`. */
+    sourceRoots: readonly string[];
+    /**
+     * One entry per suite. Pass the suite's options to run it, or
+     * `{ skip: 'reason' }` to opt out: the reason is required (an empty one, or
+     * `false`, throws) and is printed in the run summary, so the opt-out stays
+     * visible. A suite left out does not run; an unknown key throws, so a typo
+     * cannot disable a check. A suite that ships with a slice is registered by
+     * importing that slice's testing entry (the telemetry suite:
+     * `@marinoscar/platform-api/telemetry/testing`).
+     */
+    suites: {
+        [K in keyof PlatformConformanceSuiteOptions]?: Exclude<PlatformConformanceSuiteOptions[K], false> | ConformanceSkip;
+    };
+    /** Defaults to the globals `describe`/`it`/`expect` (Jest, or Vitest with `globals: true`). */
+    testApi?: ConformanceTestApi;
+    /**
+     * Where the summary table of suites run and skipped goes. Default: standard
+     * output, unless `testApi` is injected (then nothing is printed).
+     */
+    summaryOutput?: (table: string) => void;
+}
+/**
+ * Registers one `describe` block per enabled conformance suite. Call it at the
+ * top level of a spec file; the app keeps its own data (exemptions, minimums)
+ * and the package owns the scan.
+ *
+ * @param options - see {@link PlatformConformanceOptions}.
+ * @throws Error `unknown conformance suite` when `options.suites` names a suite that is not registered.
+ * @throws Error when no test API is available, or `sourceRoots` is empty.
+ *
+ * @example
+ * ```ts
+ * // apps/api/test/conformance.spec.ts
+ * runPlatformConformance({
+ *   sourceRoots: [join(__dirname, '..', '..', 'src')],
+ *   suites: { cronEnqueueOnly: { exempt: EXEMPT, minCronFiles: 8 } },
+ * });
+ * ```
+ *
+ * @extensionPoint option
+ * @stability experimental
+ */
+export declare function runPlatformConformance(options: PlatformConformanceOptions): void;
+/**
+ * One row of the run summary.
+ *
+ * @stability experimental
+ */
+export interface ConformanceSummaryEntry {
+    /** The suite id. */
+    id: string;
+    /** `run` when the app enabled it, `skipped` when it opted out with a reason. */
+    status: 'run' | 'skipped';
+    /** The app's reason, for a skipped suite. */
+    reason?: string;
+}
+/**
+ * The summary table `runPlatformConformance` prints: every suite the app
+ * enabled or opted out of, and why it was skipped.
+ *
+ * @param entries - one per suite, in the order the app listed them.
+ * @returns a plain-text table, one line per suite under a header.
+ *
+ * @stability experimental
+ */
+export declare function formatConformanceSummary(entries: readonly ConformanceSummaryEntry[]): string;
+//# sourceMappingURL=run-platform-conformance.d.ts.map

package/dist/testing/run-platform-conformance.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"run-platform-conformance.d.ts","sourceRoot":"","sources":["../../src/testing/run-platform-conformance.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAGV,eAAe,EAEf,kBAAkB,EACnB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,SAAS,CAAC;AAK/D;;;;;GAKG;AACH,MAAM,WAAW,0BAA0B;IACzC,wHAAwH;IACxH,WAAW,EAAE,SAAS,MAAM,EAAE,CAAC;IAC/B;;;;;;;;OAQG;IACH,MAAM,EAAE;SACL,CAAC,IAAI,MAAM,+BAA+B,CAAC,CAAC,EAAE,OAAO,CAAC,+BAA+B,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,GAAG,eAAe;KACpH,CAAC;IACF,+FAA+F;IAC/F,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAC7B;;;OAGG;IACH,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;CACzC;AAkBD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,0BAA0B,GAAG,IAAI,CA8EhF;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACtC,oBAAoB;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,gFAAgF;IAChF,MAAM,EAAE,KAAK,GAAG,SAAS,CAAC;IAC1B,6CAA6C;IAC7C,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;;GAQG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,SAAS,uBAAuB,EAAE,GAAG,MAAM,CAO5F"}