Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🐛 Can't run npx schema-generator due to missing types which should be exported by eventbridge-toolbox #46

Open
SolP-Aleios opened this issue Oct 25, 2023 · 0 comments

Comments

@SolP-Aleios
Copy link
Collaborator

Description
When using eventbridge-toolbox-schema-generator's npx schema-generator command, I receive an error indicating that the types module from eventbridge-toolbox cannot be found.

Expected Behaviour
Schemas generated and added to the event catalog successfully

Current Behaviour
Throw's the following error:

Found testContract1. ts
/Users/solomonparker/wizzair/platform-demo/node_modules/.pnpm/[email protected]/node_modules/ts-json-schema-generator/dist/factory/program…js:89
throw new DiagnosticError_1.DiagnosticError (diagnostics);
DiagnosticError: Cannot find module 'src/classes/types'
or its corresponding
type declarations.
at createProgram (/Users/solomonparker/wizzair/platform-demo/node_modules/_pnpm/[email protected]/node_modules/ts-json-schema-generator/dist/f
actory/program. js:89:19)
at createGenerator (/Users/solomonparker/wizzair/platform-demo/node_modules/_pnpm/[email protected]/node_modules/ts-json-schema-generator/dist /factory/generator.js:9:49)
at file:///Users/solomonparker/wizzair/platform-demo/node_modules/_pnpm/@[email protected]/node_modules/@aleios-cloud
/eventbridge-toolbox-schema-generator/dist/generate-docs-js:47:28
at Array.forEach (<anonymous>)
at file:///Users/solomonparker/wizzair/platform-demo/node_modules/_pnpm/@[email protected]/node_modules/@aleios-cloud
/eventbridge-toolbox-schema-generator/dist/generate-docs-js:20:14
at FReqCallback.oncomplete (node: fs:200:23)

Reproduction Steps

  1. Install eventbridge toolbox and eventbridge toolbox schema generator as project dependencies (also had to install ts-json-schema-generator which should be a dependency in eventbridge-toolbox-scehma-generator)
  2. Create a directory containing .ts files which export contracts (interfaces extending the Contract type from eventbridge-toolbox)
  3. Run npx @eventcatalog/create-eventcatalog@latest demo-event-catalog
  4. Remove the example events from the events folder, as well as everything in the services and domains folders
  5. Run npx schema-generator <path from root to your event contracts> <path from root to event catalog events>

Possible Solution
Amend the tsconfig in eventbridge-toolbox to ensure that types are packaged correctly. This may be easier if the example-architecture was in a separate repo or if the eventbridge-toolbox repo was restructured as a monorepo; this would also have helped catch this issue earlier.

Additional Context
Contracts used when the issue was encountered:

import { Contract } from "@aleios-cloud/eventbridge-toolbox";

export interface testContract extends Contract {
  detail: {
    "detail-version": 1;
    data: { message: string; name: string };
  };
  "detail-type": "testContractDetail";
}
import { Contract } from "@aleios-cloud/eventbridge-toolbox";

export interface testContract extends Contract {
  detail: {
    "detail-version": 2;
    data: { message: string; name: string };
  };
  "detail-type": "testContractDetail";
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant