@ronin/compiler 0.10.2-leo-ron-1083-experimental-211 → 0.10.2-leo-ron-1083-experimental-213

package/README.md

@@ -70,6 +70,24 @@ executed and their results can be formatted by the compiler as well:
 const results: Array<Result> = transaction.prepareResults(rows);
 ```
 
+#### Root Model
+
+Before you can run any statements generated by the compiler that are altering the database schema, you need to create the table of the so-called "root model", which is used to store metadata for all other models.
+
+This table is called `ronin_master`, which mimics the default `sqlite_master` table provided by SQLite. You can generate its respective SQL statements like so:
+
+```typescript
+import { Transaction, ROOT_MODEL } from '@ronin/compiler';
+
+const transaction = new Transaction([
+  {
+    create: { model: ROOT_MODEL }
+  }
+]);
+```
+
+Afterward, run the statements located in `transaction.statements` to create the table for the root model. Once that is done, your database is prepared to run any statements generated by the compiler.
+
 #### Types
 
 In total, the following types are being exported:
@@ -110,12 +128,13 @@ new Transaction(queries, {
   // names themselves are aliased.
   //
   // This ensures the cleanest possible SQL statements in conjunction with the default
-  // behavior of SQLite (and all other SQL databases), where the result of a statement is
-  // a list (array) of values, which are inherently not prone to conflicts.
+  // behavior of SQL databases, where the result of a statement is a list (array) of
+  // values, which are inherently not prone to conflicts.
   //
   // If the driver being used instead returns an object for every row, the driver must
   // ensure the uniqueness of every key in that object, which means prefixing duplicated
   // column names with the name of the respective table, if multiple tables are joined.
+  //
   // Drivers that return objects for rows offer this behavior as an option that is
   // usually called "expand columns". If the driver being used does not offer such an
   // option, you can instead activate the option in the compiler, which results in longer
@@ -134,7 +153,7 @@ bun run dev
 
 Whenever you make a change to the source code, it will then automatically be transpiled again.
 
-### Mental Model
+### Architecture
 
 The interface of creating new `Transaction` instances (thereby creating new transactions) was chosen in order to define the smallest workload unit that the compiler can operate on.
 

package/dist/index.d.ts

@@ -5979,7 +5979,7 @@ interface Model<T extends Array<ModelField> = Array<ModelField>> {
     triggers?: Array<ModelTrigger<T>>;
     presets?: Array<ModelPreset>;
 }
-type PublicModel<T extends Array<ModelField> = Array<ModelField>> = Omit<Partial<Model<T>>, 'slug' | 'identifiers' | 'system' | 'table' | 'tableAlias'> & {
+type PublicModel<T extends Array<ModelField> = Array<ModelField>> = Omit<Partial<Model<T>>, 'slug' | 'identifiers' | 'system' | 'tableAlias'> & {
     slug: Required<Model['slug']>;
     identifiers?: Partial<Model['identifiers']>;
 };
@@ -6035,4 +6035,6 @@ declare class Transaction {
     prepareResults(results: Array<Array<Row>>): Array<Result>;
 }
 
-export { type PublicModel as Model, type ModelField, type ModelIndex, type ModelPreset, type ModelTrigger, type Query, type Result, type Statement, Transaction };
+declare const CLEAN_ROOT_MODEL: PublicModel;
+
+export { type PublicModel as Model, type ModelField, type ModelIndex, type ModelPreset, type ModelTrigger, type Query, CLEAN_ROOT_MODEL as ROOT_MODEL, type Result, type Statement, Transaction };

package/dist/index.js

@@ -93,6 +93,9 @@ var flatten = (obj, prefix = "", res = {}) => {
   }
   return res;
 };
+var omit = (obj, properties) => Object.fromEntries(
+  Object.entries(obj).filter(([key]) => !properties.includes(key))
+);
 var expand = (obj) => {
   return Object.entries(obj).reduce((res, [key, val]) => {
     key.split(".").reduce((acc, part, i, arr) => {
@@ -693,7 +696,7 @@ var transformMetaQuery = (models, dependencyStatements, statementParams, query)
   if (!(modelSlug && slug)) return query;
   const model = action === "create" && entity === "model" ? null : getModelBySlug(models, modelSlug);
   if (entity === "model") {
-    let queryTypeDetails;
+    let queryTypeDetails = {};
     if (action === "create") {
       const newModel = jsonValue;
       const modelWithFields = addDefaultModelFields(newModel, true);
@@ -749,6 +752,8 @@ var transformMetaQuery = (models, dependencyStatements, statementParams, query)
         return handleSystemModel(models, dependencyStatements, "drop", systemModel);
       });
     }
+    const modelSlug2 = "to" in queryTypeDetails ? queryTypeDetails?.to?.slug : "with" in queryTypeDetails ? queryTypeDetails?.with?.slug : void 0;
+    if (modelSlug2 === "model") return null;
     const queryTypeAction = action === "create" ? "add" : action === "alter" ? "set" : "remove";
     return {
       [queryTypeAction]: {
@@ -1340,6 +1345,7 @@ var compileQueryInput = (defaultQuery, models, statementParams, options) => {
     statementParams,
     defaultQuery
   );
+  if (query === null) return { dependencies: [], main: dependencyStatements[0] };
   const parsedQuery = splitQuery(query);
   const { queryType, queryModel, queryInstructions } = parsedQuery;
   const model = getModelBySlug(models, queryModel);
@@ -1577,6 +1583,8 @@ var Transaction = class {
     });
   }
 };
+var CLEAN_ROOT_MODEL = omit(ROOT_MODEL, ["system"]);
 export {
+  CLEAN_ROOT_MODEL as ROOT_MODEL,
   Transaction
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ronin/compiler",
-  "version": "0.10.2-leo-ron-1083-experimental-211",
+  "version": "0.10.2-leo-ron-1083-experimental-213",
   "type": "module",
   "description": "Compiles RONIN queries to SQL statements.",
   "publishConfig": {