@compas/code-gen

@compas/code-gen

Code generators for routers, validators, SQL queries, API clients and more. Take a look at the documentation.

As a server

mainFn(import.meta, main);

async function main() {
  const app = new App();

  const T = new TypeCreator("post");
  const R = T.router("/post");

  app.add(
    new TypeCreator("database")
      .object("post")
      .keys({
        title: T.string().searchable(),
        body: T.string(),
      })
      .enableQueries({ withDates: true }),

    T.crud("/post").entity(T.reference("database", "post")).routes({
      listRoute: true,
      singleRoute: true,
      createRoute: true,
      updateRoute: true,
      deleteRoute: true,
    }),
  );

  await app.generate({
    outputDirectory: "./src/generated/application",
    dumpStructure: true,
    dumpApiStructure: true,
    dumpPostgres: true,
    enabledGenerators: ["validator", "router", "sql", "apiClient"],
  });
}

As a client

mainFn(import.meta, main);

async function main() {
  const app = new App({ verbose: true });

  let fromRemote = await loadApiStructureFromRemote(
    Axios,
    "https://some.compas.powered.backend",
  );

  app.extend(fromRemote);

  await app.generate({
    outputDirectory: "./src/generated",
    isBrowser: true,
    enabledGenerators: ["type", "apiClient", "reactQuery"],
  });

  await spawn("yarn", ["format"]);
}

Changelog

v0.1.0

Breaking changes

• fix(server): rename formLimit option to urlencodedLimit in createBodyParsers d600ac
  • Rename your usage of formLimit to urlencodedLimit in the first argument to createBodyParsers
• feat(server,code-gen): combine json & multipart 'createBodyParsers' into a single 'createBodyParser' df9e43
  • Removed createBodyParsers use createBodyParser instead.
  • createBodyParser by default does not parse multipart bodies. This should be explicitly enabled with multipart: true. Configure its options with 'multipartOptions' to set a custom maxFileSize for example.
  • Changed the jsonLimit default to '5mb'.
  • The generated Koa router now accepts a single body parser instead of the previous body parser pair returned by 'createBodyParsers'.
  • The updated usage looks something like:

  app.use(
    router(
      createBodyParser({
        multipart: true,
        multipartOptions: {
          maxFileSize: 15 * 1024 * 2024,
        },
      }),
    ),
  );
  

• feat(code-gen): promote experimental to stable (#2559) 247aa0
  • Removes support for old code-gen. Use the new target based code-gen instead. See the new docs and migration guide.
  • It is expected that future Compas release fully break structure compatibility with legacy clients, so make sure to migrate as soon as possible.
  • Update any @compas/code-gen/experimental import to @compas/code-gen

Features

• feat(code-gen/experimental: few percent speedup of array validation 26fb77
• feat(code-gen/experimental): generate serializable query keys in the react-query wrapper 8d74da
• feat(code-gen/experimental): generate type docs strings as JSDoc blocks a94ee5
• feat(code-gen): allow CRUD generation for entities with file relations 727b50

Bug fixes

• fix(code-gen/experimental): correctly resolve code-gen version when generating OpenAPI specs 28fa44

Other

• chore: cleanup release notes and changelogs 143743

Dependency updates

• build(deps): bump tar from 6.1.13 to 6.1.14 (#2547)
  • Release notes
• build(deps): bump pino from 8.11.0 to 8.12.1 (#2546, #2552)
  • Release notes
• build(deps): bump @babel/core from 7.21.4 to 7.21.8 (#2549)
  • Release notes
• build(deps): bump @aws-sdk/client-s3 from 3.321.1 to 3.327.0 (#2558)
  • Release notes
• build(deps): bump @babel/eslint-parser from 7.21.3 to 7.21.8 (#2550)
  • Release notes
• build(deps): bump @aws-sdk/lib-storage from 3.321.1 to 3.327.0 (#2557)
  • Release notes
• build(deps): bump eslint-plugin-jsdoc from 43.1.1 to 43.2.0 (#2560)
  • Release notes
• build(deps): bump eslint from 8.39.0 to 8.40.0 (#2562)
  • Release notes