@rvoh/psychic 2.1.0 → 2.2.1-alpha.1

package/dist/types/src/bin/helpers/OpenApiSpecDiff.d.ts

@@ -0,0 +1,138 @@
+import type { DefaultPsychicOpenapiOptions } from '../../psychic-app/index.js';
+/**
+ * Interface to hold the result of a comparison
+ * between the current local OpenAPI specification and the head branch
+ * for a given OpenAPI file
+ */
+export interface ComparisonResult {
+    file: string;
+    hasChanges: boolean;
+    breaking: string[];
+    changelog: string[];
+    error?: string;
+}
+/**
+ * Interface to hold the configuration for oasdiff
+ */
+export interface OasDiffConfig {
+    command: string;
+    baseArgs: string[];
+    headBranch: string;
+}
+export type PsychicOpenapiConfig = DefaultPsychicOpenapiOptions;
+/**
+ * Class-based OpenAPI specification diff tool
+ *
+ * Compares current OpenAPI specs against the head branch using oasdiff
+ *
+ * Example usages:
+ *
+ * Instance-based usage
+ *    const diffTool = new OpenApiSpecDiff()
+ *    diffTool.compare(openapiConfigs)
+ *
+ * Factory method usage
+ *    const diffTool = OpenApiSpecDiff.create()
+ *    diffTool.compare(openapiConfigs)
+ *
+ * Static method usage (backward compatibility)
+ *    OpenApiSpecDiff.compare(openapiConfigs)
+ */
+export declare class OpenApiSpecDiff {
+    /**
+     * The configuration for the oasdiff command
+     */
+    private oasdiffConfig?;
+    /**
+     * Compares a list of OpenAPI specifications between the current branch and the head branch.
+     *
+     * Uses `oasdiff` under the hood to detect breaking and non-breaking changes for each file,
+     * helping you review and validate API updates with confidence before merging.
+     *
+     * This tool only runs for configurations where `checkDiffs` is enabled.
+     *
+     * @param openapiConfigs - An array of tuples containing the OpenAPI file name and its configuration.
+     * @example
+     * ```ts
+     * const openapiConfigs: [string, PsychicOpenapiConfig][] = [
+     *   ['openapi', { outputFilepath: 'openapi.json' }],
+     * ]
+     * OpenApiSpecDiff.compare(openapiConfigs)
+     * ```
+     */
+    compare(openapiConfigs: [string, PsychicOpenapiConfig][]): void;
+    /**
+     * Checks if oasdiff is installed locally
+     */
+    private hasOasDiffInstalled;
+    /**
+     * Fetch the head branch of a remote using git remote show origin
+     * default to main if not set
+     */
+    private getHeadBranch;
+    /**
+     * Validates that oasdiff is installed and builds the oasdiff config
+     */
+    private getOasDiffConfig;
+    /**
+     * Runs oasdiff command and returns the output
+     */
+    private runOasDiffCommand;
+    /**
+     * Compares two OpenAPI files using oasdiff
+     */
+    private compareSpecs;
+    /**
+     * Creates a temporary file path for the head branch content
+     */
+    private createTempFilePath;
+    /**
+     * Retrieves head branch content for a file
+     */
+    private getHeadBranchContent;
+    /**
+     * Compares a single OpenAPI file against head branch
+     */
+    private compareConfig;
+    /**
+     * Process and display the comparison results
+     */
+    private processResults;
+    /**
+     * Log error for a comparison result
+     */
+    private logError;
+    /**
+     * Log changes for a comparison result
+     */
+    private logChanges;
+    /**
+     * Log breaking changes for a comparison result
+     */
+    private logBreakingChanges;
+    /**
+     * Log changelog for a comparison result
+     */
+    private logChangelog;
+    /**
+     * Log no changes for a comparison result
+     */
+    private logNoChanges;
+    /**
+     * Log final summary and handle exit conditions
+     */
+    private logSummary;
+    /**
+     * Static factory method for convenience
+     */
+    static create(): OpenApiSpecDiff;
+    /**
+     * Static method to maintain compatibility with functional approach
+     */
+    static compare(openapiConfigs: [string, PsychicOpenapiConfig][]): void;
+}
+export declare class BreakingChangesDetectedInOpenApiSpecError extends Error {
+    private readonly oasdiffConfig;
+    constructor(oasdiffConfig: OasDiffConfig);
+    get message(): string;
+}

package/dist/types/src/bin/index.d.ts

@@ -1,3 +1,4 @@
+export { BreakingChangesDetectedInOpenApiSpecError } from './helpers/OpenApiSpecDiff.js';
 export default class PsychicBin {
     static generateController(controllerName: string, actions: string[]): Promise<void>;
     static generateResource(route: string, fullyQualifiedModelName: string, columnsWithTypes: string[], options: {
@@ -14,6 +15,7 @@ export default class PsychicBin {
     }): Promise<void>;
     static postSync(): Promise<void>;
     static syncTypes(): Promise<void>;
+    static openapiDiff(): void;
     static syncOpenapiTypescriptFiles(): Promise<void>;
     static syncOpenapiJson(): Promise<void>;
     static syncRoutes(): Promise<void>;

package/dist/types/src/controller/index.d.ts

@@ -76,7 +76,7 @@ export default class PsychicController {
     /**
      * @internal
      *
-     * Used for displaying routes when running `yarn psy routes`
+     * Used for displaying routes when running `pnpm psy routes`
      * cli command
      */
     static get disaplayName(): string;

package/dist/types/src/psychic-app/index.d.ts

@@ -491,6 +491,34 @@ interface PsychicOpenapiBaseOptions {
      * ```
      */
     validate?: OpenapiValidateOption;
+    /**
+     * Enables automatic comparison of OpenAPI specifications between the current
+     * working branch and the main/master/head branch.
+     *
+     * When set to `true`, Psychic will perform a diff check between the OpenAPI spec
+     * in the current branch and the one in the main/master/head branch. This is done using the
+     * `OpenApiSpecDiff` tool, which analyzes structural and semantic differences
+     * between the two specs.
+     *
+     * This feature is useful for catching unintended changes to your API contract
+     * before they are merged, especially breaking changes that could affect downstream
+     * consumers or integrations.
+     *
+     * Typical use cases include CI/CD validation, pull request checks, or local
+     * development sanity checks.
+     *
+     * Example usage:
+     * ```ts
+     * psy.set('openapi', {
+     *   ...
+     *   checkDiffs: true,
+     *   ...
+     * });
+     * ```
+     *
+  
+     */
+    checkDiffs?: boolean;
 }
 interface PsychicOpenapiInfo {
     version: string;

package/package.json

@@ -2,7 +2,7 @@
   "type": "module",
   "name": "@rvoh/psychic",
   "description": "Typescript web framework",
-  "version": "2.1.0",
+  "version": "2.2.1-alpha.1",
   "author": "RVOHealth",
   "repository": {
     "type": "git",
@@ -48,28 +48,29 @@
     "dist/**/*"
   ],
   "scripts": {
-    "client": "yarn --cwd=./client start",
-    "client:fspec": "VITE_PSYCHIC_ENV=test BROWSER=none yarn --cwd=./client start",
-    "psy": "NODE_ENV=${NODE_ENV:-test} yarn psyts",
+    "client": "cd client && pnpm start",
+    "client:fspec": "cd client && VITE_PSYCHIC_ENV=test BROWSER=none pnpm start",
+    "psy": "NODE_ENV=${NODE_ENV:-test} pnpm psyts",
     "psyjs": "node ./dist/test-app/src/cli/index.js",
     "psyts": "NODE_ENV=${NODE_ENV:-test} tsx ./test-app/src/cli/index.ts",
     "gpsy": "tsx ./global-cli/main.ts",
     "build": "echo \"building cjs...\" && rm -rf dist && npx tsc -p ./tsconfig.cjs.build.json && echo \"building esm...\" && npx tsc -p ./tsconfig.esm.build.json",
     "build:test-app": "rm -rf dist && echo \"building test app to esm...\" && npx tsc -p ./tsconfig.esm.build.test-app.json && echo \"building test app to cjs...\" && npx tsc -p ./tsconfig.cjs.build.test-app.json",
-    "types:esm:trace": "rm -rf dist && npx tsc -p ./tsconfig.esm.build.json --generateTrace ./typetrace --diagnostics && yarn analyze-trace ./typetrace --skipMillis 100 --forceMillis 300",
+    "types:esm:trace": "rm -rf dist && npx tsc -p ./tsconfig.esm.build.json --generateTrace ./typetrace --diagnostics && pnpm analyze-trace ./typetrace --skipMillis 100 --forceMillis 300",
     "dev": "nodemon --quiet --no-stdin",
     "console": "tsx ./test-app/src/conf/repl.ts",
     "uspec": "vitest --config ./spec/unit/vite.config.ts",
     "fspec": "vitest run --config=./spec/features/vite.config.ts",
-    "format": "yarn run prettier . --write",
-    "lint": "yarn run eslint --no-warn-ignored \"src/**/*.ts\" \"spec/**/*.ts\" \"test-app/**/*.ts\" && yarn run prettier . --check",
-    "prepack": "yarn build"
+    "format": "pnpm prettier . --write",
+    "lint": "pnpm eslint --no-warn-ignored \"src/**/*.ts\" \"spec/**/*.ts\" \"test-app/**/*.ts\" && pnpm prettier . --check",
+    "prepack": "pnpm build"
   },
   "dependencies": {
     "@types/cookie-parser": "^1.4.8",
     "@types/cors": "^2.8.17",
     "ajv": "^8.17.1",
     "ajv-formats": "^3.0.1",
+    "body-parser": "^2.2.1",
     "commander": "^12.1.0",
     "cookie-parser": "^1.4.7",
     "cors": "^2.8.5",
@@ -85,11 +86,12 @@
     "openapi-typescript": "^7.8.0"
   },
   "devDependencies": {
-    "@eslint/js": "^9.19.0",
+    "@eslint/js": "^9.39.1",
     "@jest-mock/express": "^3.0.0",
     "@rvoh/dream": "^2.0.3",
     "@rvoh/dream-spec-helpers": "^2.0.0",
     "@rvoh/psychic-spec-helpers": "^2.0.0",
+    "@types/body-parser": "^1.19.6",
     "@types/express": "^5.0.6",
     "@types/express-session": "^1.18.2",
     "@types/node": "^22.17.1",
@@ -97,13 +99,14 @@
     "@types/passport-local": "^1",
     "@types/pg": "^8.11.8",
     "@types/supertest": "^6.0.3",
+    "@typescript-eslint/parser": "^8.48.1",
     "@typescript/analyze-trace": "^0.10.1",
-    "eslint": "^9.19.0",
+    "eslint": "^9.39.1",
     "express": "^5.2.1",
     "express-session": "^1.18.2",
     "jsdom": "^26.1.0",
     "kysely": "^0.28.5",
-    "kysely-codegen": "~0.17.0",
+    "kysely-codegen": "~0.19.0",
     "luxon-jest-matchers": "^0.1.14",
     "nodemon": "^3.1.11",
     "openapi-typescript": "^7.8.0",
@@ -117,9 +120,9 @@
     "tsx": "^4.19.3",
     "typedoc": "^0.26.6",
     "typescript": "^5.5.4",
-    "typescript-eslint": "=7.18.0",
+    "typescript-eslint": "^8.48.1",
     "vitest": "^4.0.9",
     "winston": "^3.14.2"
   },
-  "packageManager": "yarn@4.7.0"
+  "packageManager": "pnpm@10.24.0+sha512.01ff8ae71b4419903b65c60fb2dc9d34cf8bb6e06d03bde112ef38f7a34d6904c424ba66bea5cdcf12890230bf39f9580473140ed9c946fef328b6e5238a345a"
 }