@scenarist/core 0.0.1 → 0.1.0

package/dist/types/scenario.d.ts

@@ -0,0 +1,141 @@
+import type { HttpMethod, ScenaristScenario } from '../schemas/index.js';
+/**
+ * HTTP request data for response selection.
+ * Framework adapters extract this from their specific request objects.
+ * Used by ResponseSelector to match requests against MockDefinition criteria.
+ */
+export type HttpRequestContext = {
+    readonly method: HttpMethod;
+    readonly url: string;
+    readonly body?: unknown;
+    readonly headers: Readonly<Record<string, string>>;
+    readonly query: Readonly<Record<string, string>>;
+    /**
+     * Path parameters extracted from URL pattern matching.
+     *
+     * MSW compatibility:
+     * - Simple params (:id) → string
+     * - Repeating params (:path+) → ReadonlyArray<string>
+     * - Absent optional params (:id?) → key omitted from object
+     */
+    readonly params?: Readonly<Record<string, string | ReadonlyArray<string>>>;
+};
+/**
+ * Mock paired with its extracted URL path parameters.
+ * Used to pass both the mock definition and its params through the pipeline.
+ *
+ * When URL matching succeeds, params are extracted from the URL pattern.
+ * After ResponseSelector chooses a mock, those params are added to HttpRequestContext
+ * so template replacement can use them via {{params.key}} syntax.
+ *
+ * Example:
+ * ```typescript
+ * // Mock with pattern: '/users/:id'
+ * // Request URL: '/users/123'
+ * // Result: { mock: {...}, params: { id: '123' } }
+ * ```
+ */
+export type ScenaristMockWithParams = {
+    readonly mock: import('../schemas/index.js').ScenaristMock;
+    readonly params?: Readonly<Record<string, string | ReadonlyArray<string>>>;
+};
+/**
+ * State capture configuration for stateful mocks (Phase 3).
+ * Maps state keys to path expressions for extracting values from requests.
+ *
+ * Path syntax:
+ * - 'body.field' - Extract from request body
+ * - 'headers.field' - Extract from request headers
+ * - 'query.field' - Extract from query parameters
+ *
+ * Array syntax:
+ * - 'stateKey[]' - Append to array (creates array if doesn't exist)
+ * - 'stateKey' - Overwrite value
+ *
+ * Example:
+ * ```typescript
+ * captureState: {
+ *   'cartItems[]': 'body.item',  // Append item to cartItems array
+ *   'userId': 'headers.x-user-id' // Store user ID from header
+ * }
+ * ```
+ *
+ * NOTE: CaptureState type is now schema-inferred from ScenaristCaptureConfigSchema.
+ */
+/**
+ * Serializable mock definition.
+ * Represents an HTTP mock that can be converted to MSW handlers at runtime.
+ *
+ * A mock must have EITHER `response` (single response) OR `sequence` (ordered responses).
+ *
+ * NOTE: MockDefinition type is now schema-inferred from ScenaristMockSchema.
+ */
+/**
+ * Serializable scenario definition.
+ * This is pure data that can be:
+ * - Stored in Redis for distributed testing
+ * - Saved to files for version control
+ * - Fetched from remote APIs
+ * - Stored in databases
+ *
+ * At runtime, ScenaristMocks are converted to MSW HttpHandlers.
+ *
+ * NOTE: ScenarioDefinition type is now schema-inferred from ScenaristScenarioSchema.
+ */
+/**
+ * Represents an active scenario for a specific test ID.
+ * Stores only references to enable serialization to Redis/storage.
+ *
+ * To get the full scenario definition, look up scenarioId in the registry.
+ */
+export type ActiveScenario = {
+    readonly scenarioId: string;
+};
+/**
+ * Result type for operations that can fail.
+ * Prefer this over throwing exceptions for expected error cases.
+ */
+export type ScenaristResult<T, E = Error> = {
+    readonly success: true;
+    readonly data: T;
+} | {
+    readonly success: false;
+    readonly error: E;
+};
+/**
+ * Scenarios object type enforced across all adapters.
+ * Ensures scenarios are defined as a named object for type inference.
+ *
+ * This enables TypeScript to extract scenario IDs from object keys,
+ * providing autocomplete and type safety in adapter APIs.
+ *
+ * @example
+ * ```typescript
+ * const scenarios = {
+ *   cartWithState: { id: 'cartWithState', name: 'Cart with State', ... },
+ *   premiumUser: { id: 'premiumUser', name: 'Premium User', ... },
+ * } as const satisfies ScenaristScenarios;
+ * ```
+ */
+export type ScenaristScenarios = Record<string, ScenaristScenario>;
+/**
+ * Extract scenario IDs from scenarios object for type safety.
+ * Enables TypeScript autocomplete for scenario names in tests and adapters.
+ *
+ * The `& string` ensures the result is always a string type (not `string | number | symbol`).
+ *
+ * @template T - Scenarios object type
+ *
+ * @example
+ * ```typescript
+ * const scenarios = {
+ *   cartWithState: { ... },
+ *   premiumUser: { ... },
+ * } as const;
+ *
+ * type MyScenarioIds = ScenarioIds<typeof scenarios>;
+ * // Result: 'cartWithState' | 'premiumUser'
+ * ```
+ */
+export type ScenarioIds<T extends ScenaristScenarios> = keyof T & string;
+//# sourceMappingURL=scenario.d.ts.map

package/dist/types/scenario.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scenario.d.ts","sourceRoot":"","sources":["../../src/types/scenario.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAEzE;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC;IAC5B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACnD,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACjD;;;;;;;OAOG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;CAC5E,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC,QAAQ,CAAC,IAAI,EAAE,OAAO,qBAAqB,EAAE,aAAa,CAAC;IAC3D,QAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;CAC5E,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH;;;;;;;GAOG;AAEH;;;;;;;;;;;GAWG;AAEH;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,EAAE,CAAC,GAAG,KAAK,IACpC;IAAE,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAA;CAAE,GAC5C;IAAE,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAA;CAAE,CAAC;AAEnD;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAEnE;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,kBAAkB,IAAI,MAAM,CAAC,GAAG,MAAM,CAAC"}

package/dist/types/scenario.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,10 +1,70 @@
 {
   "name": "@scenarist/core",
-  "version": "0.0.1",
-  "description": "OIDC trusted publishing setup package for @scenarist/core",
+  "version": "0.1.0",
+  "description": "Internal: Hexagonal architecture core for scenario-based testing with MSW",
+  "author": "Paul Hammond (citypaul) <paul@packsoftware.co.uk>",
+  "license": "MIT",
+  "homepage": "https://github.com/citypaul/scenarist#readme",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/citypaul/scenarist.git",
+    "directory": "internal/core"
+  },
+  "bugs": {
+    "url": "https://github.com/citypaul/scenarist/issues"
+  },
   "keywords": [
-    "oidc",
-    "trusted-publishing",
-    "setup"
-  ]
-}
+    "msw",
+    "mock-service-worker",
+    "testing",
+    "scenario-testing",
+    "test-isolation",
+    "e2e-testing",
+    "integration-testing",
+    "hexagonal-architecture",
+    "typescript"
+  ],
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "dependencies": {
+    "msw": "^2.12.1",
+    "redos-detector": "^6.1.2",
+    "zod": "^4.1.12"
+  },
+  "devDependencies": {
+    "@vitest/coverage-v8": "^4.0.8",
+    "@vitest/ui": "^4.0.8",
+    "eslint": "^9.39.1",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.8",
+    "@scenarist/eslint-config": "0.0.0",
+    "@scenarist/typescript-config": "0.0.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "eslint .",
+    "typecheck": "tsc --project tsconfig.typecheck.json --noEmit"
+  }
+}