@ronin/compiler 0.8.2 → 0.8.4

package/dist/index.d.ts

@@ -5880,23 +5880,23 @@ type ModelFieldReference = ModelFieldBasics & {
     };
 };
 type ModelField = ModelFieldNormal | ModelFieldReference;
-type ModelIndexField = {
+type ModelIndexField<T extends Array<ModelField> = Array<ModelField>> = {
     /** The collating sequence used for text placed inside the field. */
     collation?: ModelFieldCollation;
     /** How the records in the index should be ordered. */
     order?: 'ASC' | 'DESC';
 } & ({
     /** The field slug for which the index should be created. */
-    slug: string;
+    slug: T[number]['slug'];
 } | {
     /** The field expression for which the index should be created. */
     expression: string;
 });
-type ModelIndex = {
+type ModelIndex<T extends Array<ModelField> = Array<ModelField>> = {
     /**
      * The list of fields in the model for which the index should be created.
      */
-    fields: Array<ModelIndexField>;
+    fields: Array<ModelIndexField<T>>;
     /**
      * The identifier of the index.
      */
@@ -5911,14 +5911,14 @@ type ModelIndex = {
      */
     filter?: WithInstruction;
 };
-type ModelTriggerField = {
+type ModelTriggerField<T extends Array<ModelField> = Array<ModelField>> = {
     /**
      * The slug of the field that should cause the trigger to fire if the value of the
      * field has changed.
      */
-    slug: string;
+    slug: T[number]['slug'];
 };
-type ModelTrigger = {
+type ModelTrigger<T extends Array<ModelField> = Array<ModelField>> = {
     /** The type of query for which the trigger should fire. */
     action: 'INSERT' | 'UPDATE' | 'DELETE';
     /** When the trigger should fire in the case that a matching query is executed. */
@@ -5926,7 +5926,7 @@ type ModelTrigger = {
     /** A list of queries that should be executed when the trigger fires. */
     effects: Array<Query>;
     /** A list of field slugs for which the trigger should fire. */
-    fields?: Array<ModelTriggerField>;
+    fields?: Array<ModelTriggerField<T>>;
     /**
      * An object containing query instructions used to determine whether the trigger should
      * fire, or not.
@@ -5939,14 +5939,14 @@ type ModelPreset = {
     /** The query instructions that should be applied when the preset is used. */
     instructions: GetInstructions;
 };
-interface Model {
+interface Model<T extends Array<ModelField> = Array<ModelField>> {
     name: string;
     pluralName: string;
     slug: string;
     pluralSlug: string;
     identifiers: {
-        name: string;
-        slug: string;
+        name: T[number]['slug'];
+        slug: T[number]['slug'];
     };
     idPrefix: string;
     /** The name of the table in SQLite. */
@@ -5962,12 +5962,12 @@ interface Model {
      * the associative model should be mounted on the source model.
      */
     associationSlug?: string;
-    fields: Array<ModelField>;
-    indexes?: Array<ModelIndex>;
-    triggers?: Array<ModelTrigger>;
+    fields: T;
+    indexes?: Array<ModelIndex<T>>;
+    triggers?: Array<ModelTrigger<T>>;
     presets?: Array<ModelPreset>;
 }
-type PublicModel = Omit<Partial<Model>, 'slug' | 'identifiers' | 'associationSlug' | 'table' | 'tableAlias'> & {
+type PublicModel<T extends Array<ModelField> = Array<ModelField>> = Omit<Partial<Model<T>>, 'slug' | 'identifiers' | 'associationSlug' | 'table' | 'tableAlias'> & {
     slug: Required<Model['slug']>;
     identifiers?: Partial<Model['identifiers']>;
 };

package/dist/index.js

@@ -318,6 +318,151 @@ var handleWith = (models, model, statementParams, instruction, parentModel) => {
   return `(${subStatement})`;
 };
 
+// src/utils/meta.ts
+var PLURAL_MODEL_ENTITIES = {
+  field: "fields",
+  index: "indexes",
+  trigger: "triggers",
+  preset: "presets"
+};
+var transformMetaQuery = (models, dependencyStatements, statementParams, query) => {
+  if (query.create) {
+    const init = query.create.model;
+    const details = "to" in query.create ? { slug: init, ...query.create.to } : init;
+    const modelWithFields = addDefaultModelFields(details, true);
+    const modelWithPresets = addDefaultModelPresets(models, modelWithFields);
+    const instructions = {
+      to: modelWithPresets
+    };
+    addModelQueries(models, dependencyStatements, {
+      queryType: "add",
+      queryModel: "model",
+      queryInstructions: instructions
+    });
+    return {
+      add: {
+        model: instructions
+      }
+    };
+  }
+  if (query.drop) {
+    const slug = query.drop.model;
+    const instructions = {
+      with: { slug }
+    };
+    addModelQueries(models, dependencyStatements, {
+      queryType: "remove",
+      queryModel: "model",
+      queryInstructions: instructions
+    });
+    return {
+      remove: {
+        model: instructions
+      }
+    };
+  }
+  if (query.alter) {
+    const slug = query.alter.model;
+    if ("to" in query.alter) {
+      const modelWithFields = addDefaultModelFields(query.alter.to, false);
+      const modelWithPresets = addDefaultModelPresets(models, modelWithFields);
+      const instructions = {
+        with: { slug },
+        to: modelWithPresets
+      };
+      addModelQueries(models, dependencyStatements, {
+        queryType: "set",
+        queryModel: "model",
+        queryInstructions: instructions
+      });
+      return {
+        set: {
+          model: instructions
+        }
+      };
+    }
+    if ("create" in query.alter) {
+      const type2 = Object.keys(query.alter.create)[0];
+      const pluralType2 = PLURAL_MODEL_ENTITIES[type2];
+      const item = query.alter.create[type2];
+      const completeItem = { slug: item.slug || `${type2}Slug`, ...item };
+      addModelQueries(models, dependencyStatements, {
+        queryType: "add",
+        queryModel: type2,
+        queryInstructions: {
+          to: {
+            model: { slug },
+            ...completeItem
+          }
+        }
+      });
+      const value = prepareStatementValue(statementParams, completeItem);
+      const json2 = `json_insert(${RONIN_MODEL_SYMBOLS.FIELD}${pluralType2}, '$.${completeItem.slug}', ${value})`;
+      const expression2 = { [RONIN_MODEL_SYMBOLS.EXPRESSION]: json2 };
+      return {
+        set: {
+          model: {
+            with: { slug },
+            to: {
+              [pluralType2]: expression2
+            }
+          }
+        }
+      };
+    }
+    if ("alter" in query.alter) {
+      const type2 = Object.keys(query.alter.alter)[0];
+      const pluralType2 = PLURAL_MODEL_ENTITIES[type2];
+      const itemSlug2 = query.alter.alter[type2];
+      const newItem = query.alter.alter.to;
+      addModelQueries(models, dependencyStatements, {
+        queryType: "set",
+        queryModel: type2,
+        queryInstructions: {
+          with: { model: { slug }, slug: itemSlug2 },
+          to: newItem
+        }
+      });
+      const value = prepareStatementValue(statementParams, newItem);
+      const json2 = `json_patch(${RONIN_MODEL_SYMBOLS.FIELD}${pluralType2}, '$.${itemSlug2}', ${value})`;
+      const expression2 = { [RONIN_MODEL_SYMBOLS.EXPRESSION]: json2 };
+      return {
+        set: {
+          model: {
+            with: { slug },
+            to: {
+              [pluralType2]: expression2
+            }
+          }
+        }
+      };
+    }
+    const type = Object.keys(query.alter.drop)[0];
+    const pluralType = PLURAL_MODEL_ENTITIES[type];
+    const itemSlug = query.alter.drop[type];
+    addModelQueries(models, dependencyStatements, {
+      queryType: "remove",
+      queryModel: type,
+      queryInstructions: {
+        with: { model: { slug }, slug: itemSlug }
+      }
+    });
+    const json = `json_insert(${RONIN_MODEL_SYMBOLS.FIELD}${pluralType}, '$.${itemSlug}')`;
+    const expression = { [RONIN_MODEL_SYMBOLS.EXPRESSION]: json };
+    return {
+      set: {
+        model: {
+          with: { slug },
+          to: {
+            [pluralType]: expression
+          }
+        }
+      }
+    };
+  }
+  return query;
+};
+
 // src/utils/model.ts
 import title from "title";
 var getModelBySlug = (models, slug) => {
@@ -465,6 +610,8 @@ var SYSTEM_MODELS = [
       name: "name",
       slug: "slug"
     },
+    // This name mimics the `sqlite_schema` table in SQLite.
+    table: "ronin_schema",
     fields: [
       { slug: "name", type: "string" },
       { slug: "pluralName", type: "string" },
@@ -475,98 +622,16 @@ var SYSTEM_MODELS = [
       { slug: "identifiers", type: "group" },
       { slug: "identifiers.name", type: "string" },
       { slug: "identifiers.slug", type: "string" },
-      { slug: "fields", type: "json" },
-      { slug: "indexes", type: "json" },
-      { slug: "triggers", type: "json" },
-      { slug: "presets", type: "json" }
-    ]
-  },
-  {
-    slug: "field",
-    identifiers: {
-      name: "name",
-      slug: "slug"
-    },
-    fields: [
-      { slug: "name", type: "string" },
-      { slug: "slug", type: "string", required: true },
-      { slug: "type", type: "string", required: true },
-      {
-        slug: "model",
-        type: "link",
-        target: "model",
-        required: true
-      },
-      { slug: "required", type: "boolean" },
-      { slug: "defaultValue", type: "string" },
-      { slug: "unique", type: "boolean" },
-      { slug: "autoIncrement", type: "boolean" },
-      // Only allowed for fields of type "link".
-      { slug: "target", type: "string" },
-      { slug: "kind", type: "string" },
-      { slug: "actions", type: "group" },
-      { slug: "actions.onDelete", type: "string" },
-      { slug: "actions.onUpdate", type: "string" }
-    ]
-  },
-  {
-    slug: "index",
-    identifiers: {
-      name: "slug",
-      slug: "slug"
-    },
-    fields: [
-      { slug: "slug", type: "string", required: true },
-      {
-        slug: "model",
-        type: "link",
-        target: "model",
-        required: true
-      },
-      { slug: "unique", type: "boolean" },
-      { slug: "filter", type: "json" },
-      { slug: "fields", type: "json", required: true }
-    ]
-  },
-  {
-    slug: "trigger",
-    identifiers: {
-      name: "slug",
-      slug: "slug"
-    },
-    fields: [
-      { slug: "slug", type: "string", required: true },
-      {
-        slug: "model",
-        type: "link",
-        target: "model",
-        required: true
-      },
-      { slug: "when", type: "string", required: true },
-      { slug: "action", type: "string", required: true },
-      { slug: "filter", type: "json" },
-      { slug: "effects", type: "json", required: true },
-      { slug: "fields", type: "json" }
-    ]
-  },
-  {
-    slug: "preset",
-    fields: [
-      { slug: "slug", type: "string", required: true },
-      {
-        slug: "model",
-        type: "link",
-        target: "model",
-        required: true
-      },
-      { slug: "instructions", type: "json", required: true }
+      // Providing an empty object as a default value allows us to use `json_insert`
+      // without needing to fall back to an empty object in the insertion statement,
+      // which makes the statement shorter.
+      { slug: "fields", type: "json", defaultValue: "{}" },
+      { slug: "indexes", type: "json", defaultValue: "{}" },
+      { slug: "triggers", type: "json", defaultValue: "{}" },
+      { slug: "presets", type: "json", defaultValue: "{}" }
     ]
   }
-].map((model) => addDefaultModelFields(model, true));
-var SYSTEM_MODEL_SLUGS = SYSTEM_MODELS.flatMap(({ slug, pluralSlug }) => [
-  slug,
-  pluralSlug
-]);
+];
 var addSystemModels = (models) => {
   const associativeModels = models.flatMap((model) => {
     const addedModels = [];
@@ -715,27 +780,26 @@ var getFieldStatement = (models, model, field) => {
 var addModelQueries = (models, dependencyStatements, queryDetails) => {
   const { queryType, queryModel, queryInstructions } = queryDetails;
   if (!["add", "set", "remove"].includes(queryType)) return;
-  if (!SYSTEM_MODEL_SLUGS.includes(queryModel)) return;
+  if (!["model", "field", "index", "trigger", "preset"].includes(queryModel)) return;
   const instructionName = mappedInstructions[queryType];
   const instructionList = queryInstructions[instructionName];
-  const kind = getModelBySlug(SYSTEM_MODELS, queryModel).pluralSlug;
   let tableAction = "ALTER";
   let queryTypeReadable = null;
   switch (queryType) {
     case "add": {
-      if (kind === "models" || kind === "indexes" || kind === "triggers") {
+      if (queryModel === "model" || queryModel === "index" || queryModel === "trigger") {
         tableAction = "CREATE";
       }
       queryTypeReadable = "creating";
       break;
     }
     case "set": {
-      if (kind === "models") tableAction = "ALTER";
+      if (queryModel === "model") tableAction = "ALTER";
       queryTypeReadable = "updating";
       break;
     }
     case "remove": {
-      if (kind === "models" || kind === "indexes" || kind === "triggers") {
+      if (queryModel === "model" || queryModel === "index" || queryModel === "trigger") {
         tableAction = "DROP";
       }
       queryTypeReadable = "deleting";
@@ -745,10 +809,10 @@ var addModelQueries = (models, dependencyStatements, queryDetails) => {
   const slug = instructionList?.slug?.being || instructionList?.slug;
   const modelInstruction = instructionList?.model;
   const modelSlug = modelInstruction?.slug?.being || modelInstruction?.slug;
-  const usableSlug = kind === "models" ? slug : modelSlug;
+  const usableSlug = queryModel === "model" ? slug : modelSlug;
   const tableName = convertToSnakeCase(pluralize(usableSlug));
-  const targetModel = kind === "models" && queryType === "add" ? null : getModelBySlug(models, usableSlug);
-  if (kind === "indexes") {
+  const targetModel = queryModel === "model" && queryType === "add" ? null : getModelBySlug(models, usableSlug);
+  if (queryModel === "index") {
     const indexName = convertToSnakeCase(slug);
     const unique = instructionList?.unique;
     const filterQuery = instructionList?.filter;
@@ -782,7 +846,7 @@ var addModelQueries = (models, dependencyStatements, queryDetails) => {
     dependencyStatements.push({ statement: statement2, params });
     return;
   }
-  if (kind === "triggers") {
+  if (queryModel === "trigger") {
     const triggerName = convertToSnakeCase(slug);
     const params = [];
     let statement2 = `${tableAction} TRIGGER "${triggerName}"`;
@@ -796,7 +860,7 @@ var addModelQueries = (models, dependencyStatements, queryDetails) => {
       if (fields) {
         if (action !== "UPDATE") {
           throw new RoninError({
-            message: `When ${queryTypeReadable} ${kind}, targeting specific fields requires the \`UPDATE\` action.`,
+            message: `When ${queryTypeReadable} ${PLURAL_MODEL_ENTITIES[queryModel]}, targeting specific fields requires the \`UPDATE\` action.`,
             code: "INVALID_MODEL_VALUE",
             fields: ["action"]
           });
@@ -835,7 +899,7 @@ var addModelQueries = (models, dependencyStatements, queryDetails) => {
     return;
   }
   const statement = `${tableAction} TABLE "${tableName}"`;
-  if (kind === "models") {
+  if (queryModel === "model") {
     if (queryType === "add") {
       const newModel = queryInstructions.to;
       const { fields } = newModel;
@@ -861,7 +925,7 @@ var addModelQueries = (models, dependencyStatements, queryDetails) => {
     }
     return;
   }
-  if (kind === "fields") {
+  if (queryModel === "field") {
     if (queryType === "add") {
       if (!instructionList.type) instructionList.type = "string";
       dependencyStatements.push({
@@ -1381,122 +1445,6 @@ var compileQueryInput = (query, models, statementParams, options) => {
   };
 };
 
-// src/utils/meta.ts
-var transformMetaQuery = (models, dependencyStatements, query) => {
-  if (query.create) {
-    const init = query.create.model;
-    const details = "to" in query.create ? { slug: init, ...query.create.to } : init;
-    const modelWithFields = addDefaultModelFields(details, true);
-    const modelWithPresets = addDefaultModelPresets(models, modelWithFields);
-    const instructions = {
-      to: modelWithPresets
-    };
-    addModelQueries(models, dependencyStatements, {
-      queryType: "add",
-      queryModel: "model",
-      queryInstructions: instructions
-    });
-    return {
-      add: {
-        model: instructions
-      }
-    };
-  }
-  if (query.drop) {
-    const slug = query.drop.model;
-    const instructions = {
-      with: { slug }
-    };
-    addModelQueries(models, dependencyStatements, {
-      queryType: "remove",
-      queryModel: "model",
-      queryInstructions: instructions
-    });
-    return {
-      remove: {
-        model: instructions
-      }
-    };
-  }
-  if (query.alter) {
-    const slug = query.alter.model;
-    if ("to" in query.alter) {
-      const modelWithFields = addDefaultModelFields(query.alter.to, false);
-      const modelWithPresets = addDefaultModelPresets(models, modelWithFields);
-      const instructions2 = {
-        with: { slug },
-        to: modelWithPresets
-      };
-      addModelQueries(models, dependencyStatements, {
-        queryType: "set",
-        queryModel: "model",
-        queryInstructions: instructions2
-      });
-      return {
-        set: {
-          model: instructions2
-        }
-      };
-    }
-    if ("create" in query.alter) {
-      const type2 = Object.keys(query.alter.create)[0];
-      const item = query.alter.create[type2];
-      const completeItem = { slug: item.slug || `${type2}_slug`, ...item };
-      const instructions2 = {
-        to: {
-          model: { slug },
-          ...completeItem
-        }
-      };
-      addModelQueries(models, dependencyStatements, {
-        queryType: "add",
-        queryModel: type2,
-        queryInstructions: instructions2
-      });
-      return {
-        add: {
-          [type2]: instructions2
-        }
-      };
-    }
-    if ("alter" in query.alter) {
-      const type2 = Object.keys(query.alter.alter)[0];
-      const itemSlug2 = query.alter.alter[type2];
-      const newItem = query.alter.alter.to;
-      const instructions2 = {
-        with: { model: { slug }, slug: itemSlug2 },
-        to: newItem
-      };
-      addModelQueries(models, dependencyStatements, {
-        queryType: "set",
-        queryModel: type2,
-        queryInstructions: instructions2
-      });
-      return {
-        set: {
-          [type2]: instructions2
-        }
-      };
-    }
-    const type = Object.keys(query.alter.drop)[0];
-    const itemSlug = query.alter.drop[type];
-    const instructions = {
-      with: { model: { slug }, slug: itemSlug }
-    };
-    addModelQueries(models, dependencyStatements, {
-      queryType: "remove",
-      queryModel: type,
-      queryInstructions: instructions
-    });
-    return {
-      remove: {
-        [type]: instructions
-      }
-    };
-  }
-  return query;
-};
-
 // src/index.ts
 var compileQueries = (queries, models, options) => {
   const modelList = addSystemModels(models).map((model) => {
@@ -1508,15 +1456,17 @@ var compileQueries = (queries, models, options) => {
   const dependencyStatements = [];
   const mainStatements = [];
   for (const query of queries) {
+    const statementValues = options?.inlineParams ? null : [];
     const transformedQuery = transformMetaQuery(
       modelListWithPresets,
       dependencyStatements,
+      statementValues,
       query
     );
     const result = compileQueryInput(
       transformedQuery,
       modelListWithPresets,
-      options?.inlineParams ? null : []
+      statementValues
     );
     dependencyStatements.push(...result.dependencies);
     mainStatements.push(result.main);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ronin/compiler",
-  "version": "0.8.2",
+  "version": "0.8.4",
   "type": "module",
   "description": "Compiles RONIN queries to SQL statements.",
   "publishConfig": {