Allow for inlining statement values

[leo]

This change adds an option to the compiler that makes it possible to inline all SQL statement values:

compileQuery(query, schemas, {
  inlineValues: true
});

This option is useful for cases where the SQL output will be manually verified by a developer, such as when prompting RONIN to generate the migration protocol as SQL. In that case, a human will review the SQL before it is run, so it must be as clean as possible, and include all values right there, in place.

Furthermore, as you can see above, the exported method was renamed from compileQueryInput to compileQuery and no longer supports any internal options — only publicly available options.

[linear]

RON-1083 Improve query compiler further before release

Now that RON-1049 has landed, I am placing my personal list of future improvements for the query transformer on Linear, to prevent it from getting lost as I will begin working on the output transformer.

We have to tackle those improvements before launching the transformer publicly.

• Ensure that the root export does not allow for passing options. This is currently only the case because the package invokes itself in the case of sub queries. We should have a separate function to accomplish that.
• Evaluate improved foreign key actions
• Rename excluding to something that makes it clear that it now acts like SELECT in SQL.
• Rename to to something that works for both create and set. Previously, create used with, which doesn't make sense, since with allows for asserting fields. to is more accurate since that only allows for providing values. Alternatively, add another instruction that is only used by create, which would also allow us to land RON-503, because set does not need support for arrays at the root level.
• Consider making group fields use underscores instead of periods, as discussed on Slack.
• Make sure that "dropping all records of a schema" does not cause a type error.
• Consider allowing a query to be used as the default value of a field.
• Consider only requiring slug for schemas, not pluralSlug. Potentially pluralSlug should become the default and be called slug, and then singularSlug could exist for the singular case. Either way, since they are auto-generated, developers should not worry about them in most cases — only if they want to.
• Consider spreading the error tests in errors.test.ts over the query instruction test files, because meta.test.ts also asserts errors already.
• Set up a linting rule to avoid duplicate test names, because Bun doesn't seem to complain about this natively, which means we can't know whether we have duplicated test names without checking the whole list of 85 tests manually or with a script for each one.
• Make including: 'all' work again, but first figure out the syntax. In prod, we support including: 'all', but perhaps we should instead allow globs or a regex so that a list of fields can be matched easily? That could also be used in excluding.
• Revise all errors one more time to ensure they are consistent.

Open Questions

• How can people overwrite entire JSON structures? Since, currently, providing an object for a JSON field in a query will perform a json_patch update.
• Should the default meta field for createdBy and updatedBy be removed, since the accounts are stored in the database of the RONIN space, which is an entirely different database? Perhaps we could handle this by displaying the most recent change event of a record on the dashboard instead, or rather the author of that event.
• Should we allow for overwriting the createdAt and updatedAt metadata fields?
• Do we even need zod for validating queries if the transformer already has to validate a lot of things that zod can't do? It almost seems as if the transformer is zod.

[github-actions]

Released an experimental package:

bun add @ronin/compiler@leo-ron-1083-experimental

This package will be removed after the pull request has been merged.