@ronin/compiler 0.16.3 → 0.16.4-leo-ron-1099-1-experimental-372

package/README.md

@@ -127,7 +127,12 @@ new Transaction(queries, {
   // Instead of returning an array of parameters for every statement (which allows for
   // preventing SQL injections), all parameters are inlined directly into the SQL strings.
   // This option should only be used if the generated SQL will be manually verified.
-  inlineParams: true
+  inlineParams: true,
+
+  // By default, the compiler relies on dynamic column default values for computing the
+  // values of all meta fields (such as `id`, `ronin.createdAt`, etc). In order to compute
+  // those values at the time of insertion instead, use this option.
+  inlineDefaults: true
 });
 ```
 

package/dist/index.d.ts

@@ -371,7 +371,6 @@ type ObjectRow = Record<string, unknown>;
 type ResultRecord = Record<string, unknown> & {
     id: string;
     ronin: {
-        locked: boolean;
         createdAt: string;
         createdBy: string | null;
         updatedAt: string;
@@ -405,6 +404,10 @@ interface TransactionOptions {
      * separating them out into a dedicated `params` array.
      */
     inlineParams?: boolean;
+    /**
+     * Whether to compute default field values as part of the generated statement.
+     */
+    inlineDefaults?: boolean;
 }
 declare class Transaction {
     #private;

package/dist/index.js

@@ -23,6 +23,12 @@ var RAW_FIELD_TYPES = ["string", "number", "boolean"];
 var CURRENT_TIME_EXPRESSION = {
   [QUERY_SYMBOLS.EXPRESSION]: `strftime('%Y-%m-%dT%H:%M:%f', 'now') || 'Z'`
 };
+var ID_EXPRESSION = (idPrefix) => ({
+  // Since default values in SQLite cannot rely on other columns, we unfortunately
+  // cannot rely on the `idPrefix` column here. Instead, we need to inject it directly
+  // into the expression as a static string.
+  [QUERY_SYMBOLS.EXPRESSION]: `'${idPrefix}_' || lower(substr(hex(randomblob(12)), 1, 16))`
+});
 var MOUNTING_PATH_SUFFIX = /(.*?)(\{(\d+)\})?$/;
 var composeMountingPath = (single, key, mountingPath) => {
   if (key === "ronin_root") {
@@ -257,7 +263,9 @@ var handleBeforeOrAfter = (model, statementParams, queryType, instructions) => {
 };
 
 // src/instructions/including.ts
-var handleIncluding = (models, model, statementParams, single, instruction, options = {}) => {
+var handleIncluding = (models, model, statementParams, single, instruction, options = {
+  inlineDefaults: false
+}) => {
   let statement = "";
   let tableSubQuery;
   for (const ephemeralFieldSlug in instruction) {
@@ -293,7 +301,7 @@ var handleIncluding = (models, model, statementParams, single, instruction, opti
         },
         models,
         statementParams,
-        { parentModel: model }
+        { parentModel: model, inlineDefaults: options.inlineDefaults }
       );
       relatedTableSelector = `(${subSelect.main.statement})`;
     }
@@ -322,7 +330,7 @@ var handleIncluding = (models, model, statementParams, single, instruction, opti
         statementParams,
         subSingle,
         modifiableQueryInstructions.including,
-        { mountingPath: subMountingPath }
+        { mountingPath: subMountingPath, inlineDefaults: options.inlineDefaults }
       );
       statement += ` ${subIncluding.statement}`;
     }
@@ -367,7 +375,7 @@ var handleOrderedBy = (model, instruction) => {
 };
 
 // src/instructions/selecting.ts
-var handleSelecting = (models, model, statementParams, single, instructions, options = {}) => {
+var handleSelecting = (models, model, statementParams, single, instructions, options = { inlineDefaults: false }) => {
   let isJoining = false;
   const selectedFields = filterSelectedFields(
     model,
@@ -395,7 +403,8 @@ var handleSelecting = (models, model, statementParams, single, instructions, opt
         const subQueryModel = getModelBySlug(models, queryModel);
         if (queryType === "count") {
           const subSelect = compileQueryInput(symbol2.value, models, statementParams, {
-            parentModel: { ...model, tableAlias: model.table }
+            parentModel: { ...model, tableAlias: model.table },
+            inlineDefaults: options.inlineDefaults
           });
           selectedFields.push({
             slug: key,
@@ -457,16 +466,23 @@ var handleSelecting = (models, model, statementParams, single, instructions, opt
 };
 
 // src/instructions/to.ts
-var handleTo = (models, model, statementParams, queryType, dependencyStatements, instructions, parentModel) => {
+var handleTo = (models, model, statementParams, queryType, dependencyStatements, instructions, options) => {
   const { with: withInstruction, to: toInstruction } = instructions;
   const defaultFields = {};
-  if (queryType === "set" || toInstruction.ronin) {
-    defaultFields.ronin = {
+  const inlineDefaultInsertionFields = queryType === "add" && options?.inlineDefaults;
+  if (inlineDefaultInsertionFields) {
+    defaultFields.id = toInstruction.id || ID_EXPRESSION(model.idPrefix);
+  }
+  if (queryType === "add" || queryType === "set" || toInstruction.ronin) {
+    const defaults = {
+      // If records are being created, set their creation time.
+      ...inlineDefaultInsertionFields ? { createdAt: CURRENT_TIME_EXPRESSION } : {},
       // If records are being updated, bump their update time.
-      ...queryType === "set" ? { updatedAt: CURRENT_TIME_EXPRESSION } : {},
+      ...queryType === "set" || inlineDefaultInsertionFields ? { updatedAt: CURRENT_TIME_EXPRESSION } : {},
       // Allow for overwriting the default values provided above.
       ...toInstruction.ronin
     };
+    if (Object.keys(defaults).length > 0) defaultFields.ronin = defaults;
   }
   const symbol = getQuerySymbol(toInstruction);
   if (symbol?.type === "query") {
@@ -492,7 +508,10 @@ var handleTo = (models, model, statementParams, queryType, dependencyStatements,
       });
       statement2 = `(${columns.join(", ")}) `;
     }
-    statement2 += compileQueryInput(symbol.value, models, statementParams).main.statement;
+    statement2 += compileQueryInput(symbol.value, models, statementParams, {
+      // biome-ignore lint/complexity/useSimplifiedLogicExpression: This is needed.
+      inlineDefaults: options?.inlineDefaults || false
+    }).main.statement;
     return statement2;
   }
   Object.assign(toInstruction, defaultFields);
@@ -520,7 +539,8 @@ var handleTo = (models, model, statementParams, queryType, dependencyStatements,
           },
           models,
           [],
-          { returning: false }
+          // biome-ignore lint/complexity/useSimplifiedLogicExpression: This is needed.
+          { returning: false, inlineDefaults: options?.inlineDefaults || false }
         ).main;
         dependencyStatements.push({ ...query, after: true });
       };
@@ -541,7 +561,7 @@ var handleTo = (models, model, statementParams, queryType, dependencyStatements,
     }
   }
   let statement = composeConditions(models, model, statementParams, "to", toInstruction, {
-    parentModel,
+    parentModel: options?.parentModel,
     type: queryType === "add" ? "fields" : void 0
   });
   if (queryType === "add") {
@@ -552,7 +572,7 @@ var handleTo = (models, model, statementParams, queryType, dependencyStatements,
       "to",
       toInstruction,
       {
-        parentModel,
+        parentModel: options?.parentModel,
         type: "values"
       }
     );
@@ -625,7 +645,11 @@ var compileQueryInput = (defaultQuery, models, statementParams, options) => {
     models,
     dependencyStatements,
     statementParams,
-    defaultQuery
+    defaultQuery,
+    {
+      // biome-ignore lint/complexity/useSimplifiedLogicExpression: This is needed.
+      inlineDefaults: options?.inlineDefaults || false
+    }
   );
   if (query === null)
     return { dependencies: [], main: dependencyStatements[0], selectedFields: [] };
@@ -655,7 +679,9 @@ var compileQueryInput = (defaultQuery, models, statementParams, options) => {
     {
       selecting: instructions?.selecting,
       including: instructions?.including
-    }
+    },
+    // biome-ignore lint/complexity/useSimplifiedLogicExpression: This is needed.
+    { inlineDefaults: options?.inlineDefaults || false }
   );
   let statement = "";
   switch (queryType) {
@@ -709,7 +735,7 @@ var compileQueryInput = (defaultQuery, models, statementParams, options) => {
       queryType,
       dependencyStatements,
       { with: instructions.with, to: instructionValue },
-      options?.parentModel
+      options
     );
     statement += `${toStatement} `;
   }
@@ -1458,17 +1484,7 @@ var getSystemFields = (idPrefix) => [
     name: "ID",
     type: "string",
     slug: "id",
-    defaultValue: {
-      // Since default values in SQLite cannot rely on other columns, we unfortunately
-      // cannot rely on the `idPrefix` column here. Instead, we need to inject it directly
-      // into the expression as a static string.
-      [QUERY_SYMBOLS.EXPRESSION]: `'${idPrefix}_' || lower(substr(hex(randomblob(12)), 1, 16))`
-    }
-  },
-  {
-    name: "RONIN - Locked",
-    type: "boolean",
-    slug: "ronin.locked"
+    defaultValue: ID_EXPRESSION(idPrefix)
   },
   {
     name: "RONIN - Created At",
@@ -1627,7 +1643,7 @@ var formatModelEntity = (type, entities) => {
   });
   return entries ? Object.fromEntries(entries) : void 0;
 };
-var handleSystemModel = (models, dependencyStatements, action, systemModel, newModel) => {
+var handleSystemModel = (models, dependencyStatements, action, inlineDefaults, systemModel, newModel) => {
   const { system: _, ...systemModelClean } = systemModel;
   const query = {
     [action]: { model: action === "create" ? systemModelClean : systemModelClean.slug }
@@ -1636,10 +1652,10 @@ var handleSystemModel = (models, dependencyStatements, action, systemModel, newM
     const { system: _2, ...newModelClean } = newModel;
     query.alter.to = newModelClean;
   }
-  const statement = compileQueryInput(query, models, []);
+  const statement = compileQueryInput(query, models, [], { inlineDefaults });
   dependencyStatements.push(...statement.dependencies);
 };
-var handleSystemModels = (models, dependencyStatements, previousModel, newModel) => {
+var handleSystemModels = (models, dependencyStatements, previousModel, newModel, inlineDefaults) => {
   const currentSystemModels = models.filter(({ system }) => {
     return system?.model === newModel.id;
   });
@@ -1663,19 +1679,32 @@ var handleSystemModels = (models, dependencyStatements, previousModel, newModel)
     const exists = newSystemModels.find(matchSystemModels.bind(null, systemModel));
     if (exists) {
       if (exists.slug !== systemModel.slug) {
-        handleSystemModel(models, dependencyStatements, "alter", systemModel, exists);
+        handleSystemModel(
+          models,
+          dependencyStatements,
+          "alter",
+          inlineDefaults,
+          systemModel,
+          exists
+        );
       }
       continue;
     }
-    handleSystemModel(models, dependencyStatements, "drop", systemModel);
+    handleSystemModel(models, dependencyStatements, "drop", inlineDefaults, systemModel);
   }
   for (const systemModel of newSystemModels) {
     const exists = currentSystemModels.find(matchSystemModels.bind(null, systemModel));
     if (exists) continue;
-    handleSystemModel(models, dependencyStatements, "create", systemModel);
+    handleSystemModel(
+      models,
+      dependencyStatements,
+      "create",
+      inlineDefaults,
+      systemModel
+    );
   }
 };
-var transformMetaQuery = (models, dependencyStatements, statementParams, query) => {
+var transformMetaQuery = (models, dependencyStatements, statementParams, query, options) => {
   const { queryType } = splitQuery(query);
   const subAltering = "alter" in query && query.alter && !("to" in query.alter);
   const action = subAltering && query.alter ? Object.keys(query.alter).filter((key) => key !== "model")[0] : queryType;
@@ -1748,7 +1777,9 @@ var transformMetaQuery = (models, dependencyStatements, statementParams, query)
               }
             }
           };
-          transformMetaQuery(models, dependencyStatements, null, query2);
+          transformMetaQuery(models, dependencyStatements, null, query2, {
+            inlineDefaults: options.inlineDefaults
+          });
         }
       }
       const modelWithObjects = Object.assign({}, modelWithPresets);
@@ -1758,7 +1789,13 @@ var transformMetaQuery = (models, dependencyStatements, statementParams, query)
       }
       queryTypeDetails = { with: modelWithObjects };
       getSystemModels(models, modelWithPresets).map((systemModel) => {
-        return handleSystemModel(models, dependencyStatements, "create", systemModel);
+        return handleSystemModel(
+          models,
+          dependencyStatements,
+          "create",
+          options.inlineDefaults,
+          systemModel
+        );
       });
     }
     if (action === "alter" && model) {
@@ -1781,14 +1818,26 @@ var transformMetaQuery = (models, dependencyStatements, statementParams, query)
         },
         to: modelWithPresets
       };
-      handleSystemModels(models, dependencyStatements, modelBeforeUpdate2, model);
+      handleSystemModels(
+        models,
+        dependencyStatements,
+        modelBeforeUpdate2,
+        model,
+        options.inlineDefaults
+      );
     }
     if (action === "drop" && model) {
       models.splice(models.indexOf(model), 1);
       dependencyStatements.push({ statement: `DROP TABLE "${model.table}"`, params: [] });
       queryTypeDetails = { with: { slug } };
       models.filter(({ system }) => system?.model === model.id).map((systemModel) => {
-        return handleSystemModel(models, dependencyStatements, "drop", systemModel);
+        return handleSystemModel(
+          models,
+          dependencyStatements,
+          "drop",
+          options.inlineDefaults,
+          systemModel
+        );
       });
     }
     const modelSlug2 = "to" in queryTypeDetails ? queryTypeDetails?.to?.slug : "with" in queryTypeDetails ? queryTypeDetails?.with?.slug : void 0;
@@ -1936,7 +1985,8 @@ var transformMetaQuery = (models, dependencyStatements, statementParams, query)
       const effectStatements = trigger.effects.map((effectQuery) => {
         return compileQueryInput(effectQuery, models, null, {
           returning: false,
-          parentModel: existingModel
+          parentModel: existingModel,
+          inlineDefaults: options.inlineDefaults
         }).main.statement;
       });
       statementParts.push("BEGIN");
@@ -1971,7 +2021,13 @@ var transformMetaQuery = (models, dependencyStatements, statementParams, query)
       targetEntity.splice(targetEntityIndex, 1);
     }
   }
-  handleSystemModels(models, dependencyStatements, modelBeforeUpdate, existingModel);
+  handleSystemModels(
+    models,
+    dependencyStatements,
+    modelBeforeUpdate,
+    existingModel,
+    options.inlineDefaults
+  );
   return {
     set: {
       model: {
@@ -2034,7 +2090,9 @@ var Transaction = class {
       const { dependencies, main, selectedFields } = compileQueryInput(
         query,
         modelsWithPresets,
-        options?.inlineParams ? null : []
+        options?.inlineParams ? null : [],
+        // biome-ignore lint/complexity/useSimplifiedLogicExpression: This is needed.
+        { inlineDefaults: options?.inlineDefaults || false }
       );
       const preDependencies = dependencies.filter(({ after }) => !after);
       const postDependencies = dependencies.map(({ after, ...rest }) => after ? rest : null).filter((item) => item != null);
@@ -2058,10 +2116,12 @@ var Transaction = class {
       const record = fields.reduce((acc, field, fieldIndex) => {
         let newSlug = field.mountingPath;
         let newValue = row[fieldIndex];
-        if (field.type === "json" || field.type === "blob") {
-          newValue = JSON.parse(newValue);
-        } else if (field.type === "boolean") {
-          newValue = Boolean(newValue);
+        if (newValue !== null) {
+          if (field.type === "json" || field.type === "blob") {
+            newValue = JSON.parse(newValue);
+          } else if (field.type === "boolean") {
+            newValue = Boolean(newValue);
+          }
         }
         if (isMeta && PLURAL_MODEL_ENTITIES_VALUES.includes(newSlug)) {
           newValue = newValue ? Object.entries(newValue).map(([slug, attributes]) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ronin/compiler",
-  "version": "0.16.3",
+  "version": "0.16.4-leo-ron-1099-1-experimental-372",
   "type": "module",
   "description": "Compiles RONIN queries to SQL statements.",
   "publishConfig": {