@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 });

  const 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.17.0

Other

• chore: drop coverage CI action a18463

Dependency updates

• build(deps): bump file-type from 20.4.0 to 20.4.1 (#3612)
  • Release notes
• build(deps): bump @aws-sdk/client-s3 from 3.758.0 to 3.779.0 (#3617, #3621, #3629)
  • Release notes
• build(deps): bump @aws-sdk/lib-storage from 3.758.0 to 3.779.0 (#3617, #3621, #3629)
  • Release notes
• build(deps): bump mime-types from 2.1.35 to 3.0.1 (#3624)
  • Major version bump
  • Release notes