@ronin/compiler 0.17.12 → 0.17.13-leo-ron-1113-experimental-403

package/dist/index.d.ts

@@ -1,3 +1,11 @@
+/** Query types used for reading data. */
+declare const DML_READ_QUERY_TYPES: readonly ["get", "count"];
+/** Query types used for writing data. */
+declare const DML_WRITE_QUERY_TYPES: readonly ["set", "add", "remove"];
+/** Query types used for interacting with data. */
+declare const DML_QUERY_TYPES: readonly ["get", "count", "set", "add", "remove"];
+/** Query types used for interacting with the database schema. */
+declare const DDL_QUERY_TYPES: readonly ["create", "alter", "drop"];
 /**
  * A list of placeholders that can be located inside queries after those queries were
  * serialized into JSON objects.
@@ -15,46 +23,9 @@ declare const QUERY_SYMBOLS: {
     readonly FIELD_PARENT_NEW: "__RONIN_FIELD_PARENT_NEW_";
     readonly VALUE: "__RONIN_VALUE";
 };
-type RoninErrorCode = 'MODEL_NOT_FOUND' | 'FIELD_NOT_FOUND' | 'INDEX_NOT_FOUND' | 'TRIGGER_NOT_FOUND' | 'PRESET_NOT_FOUND' | 'INVALID_WITH_VALUE' | 'INVALID_TO_VALUE' | 'INVALID_INCLUDING_VALUE' | 'INVALID_FOR_VALUE' | 'INVALID_BEFORE_OR_AFTER_INSTRUCTION' | 'INVALID_MODEL_VALUE' | 'EXISTING_MODEL_ENTITY' | 'REQUIRED_MODEL_ENTITY' | 'MUTUALLY_EXCLUSIVE_INSTRUCTIONS' | 'MISSING_INSTRUCTION' | 'MISSING_FIELD';
-interface Issue {
-    message: string;
-    path: Array<string | number>;
-}
-interface Details {
-    message: string;
-    code: RoninErrorCode;
-    field?: string;
-    fields?: Array<string>;
-    issues?: Array<Issue>;
-    queries?: Array<Query> | null;
-}
-declare class RoninError extends Error {
-    code: Details['code'];
-    field?: Details['field'];
-    fields?: Details['fields'];
-    issues?: Details['issues'];
-    queries?: Details['queries'];
-    constructor(details: Details);
-}
-/**
- * Checks if the provided value contains a RONIN model symbol (a represenation of a
- * particular entity inside a query, such as an expression or a sub query) and returns
- * its type and value.
- *
- * @param value - The value that should be checked.
- *
- * @returns The type and value of the symbol, if the provided value contains one.
- */
-declare const getQuerySymbol: (value: unknown) => {
-    type: "query";
-    value: Query;
-} | {
-    type: "expression";
-    value: string;
-} | null;
 
-type QueryTypeEnum = 'get' | 'set' | 'add' | 'remove' | 'count';
-type ModelQueryTypeEnum = 'create' | 'alter' | 'drop';
+type QueryTypeEnum = (typeof DML_QUERY_TYPES)[number];
+type ModelQueryTypeEnum = (typeof DDL_QUERY_TYPES)[number];
 type ModelEntityEnum = 'field' | 'index' | 'trigger' | 'preset';
 type FieldValue = string | number | boolean | null | unknown;
 type FieldSelector = Record<string, FieldValue | StoredObject>;
@@ -150,23 +121,23 @@ type AlterQuery = {
     model: string;
     to?: Partial<Omit<PublicModel, 'fields' | 'indexes' | 'triggers' | 'presets' | 'idPrefix'>>;
     create?: {
-        field?: ModelField;
-        index?: ModelIndex;
-        trigger?: ModelTrigger;
-        preset?: ModelPreset;
+        field?: Omit<ModelField, 'system'>;
+        index?: Omit<ModelIndex, 'system'>;
+        trigger?: Omit<ModelTrigger, 'system'>;
+        preset?: Omit<ModelPreset, 'system'>;
     };
     alter?: {
         field?: string;
-        to?: Partial<ModelField>;
+        to?: Partial<Omit<ModelField, 'system'>>;
     } | {
         index?: string;
-        to?: Partial<ModelIndex>;
+        to?: Partial<Omit<ModelIndex, 'system'>>;
     } | {
         trigger?: string;
-        to?: Partial<ModelTrigger>;
+        to?: Omit<ModelTrigger, 'system'>;
     } | {
         preset?: string;
-        to?: Partial<ModelPreset>;
+        to?: Omit<ModelPreset, 'system'>;
     };
     drop?: Partial<Record<ModelEntityEnum, string>>;
 };
@@ -227,6 +198,8 @@ type ModelFieldBasics = {
     };
     /** An expression that gets evaluated every time a value is provided for the field. */
     check?: Expression;
+    /** Whether the field was automatically added by RONIN. */
+    system?: boolean;
 };
 type ModelField = ModelFieldBasics & ({
     /** The kind of value that should be stored inside the field. */
@@ -340,10 +313,14 @@ type ModelTrigger<T extends ModelEntityList<ModelField> = ModelEntityList<ModelF
     filter?: WithInstruction;
 };
 type ModelPreset = {
+    /** The visual display name of the preset. */
+    name?: string;
     /** The identifier that can be used for adding the preset to a query. */
     slug: string;
     /** The query instructions that should be applied when the preset is used. */
     instructions: GetInstructions;
+    /** Whether the preset was automatically added by RONIN. */
+    system?: boolean;
 };
 type ModelEntityList<T extends {
     slug: string;
@@ -420,6 +397,44 @@ type ExpandedResult<T = ResultRecord> = {
 };
 type Result<T = ResultRecord> = RegularResult<T> | ExpandedResult<T>;
 
+type RoninErrorCode = 'MODEL_NOT_FOUND' | 'FIELD_NOT_FOUND' | 'INDEX_NOT_FOUND' | 'TRIGGER_NOT_FOUND' | 'PRESET_NOT_FOUND' | 'INVALID_WITH_VALUE' | 'INVALID_TO_VALUE' | 'INVALID_INCLUDING_VALUE' | 'INVALID_FOR_VALUE' | 'INVALID_BEFORE_OR_AFTER_INSTRUCTION' | 'INVALID_MODEL_VALUE' | 'EXISTING_MODEL_ENTITY' | 'REQUIRED_MODEL_ENTITY' | 'MUTUALLY_EXCLUSIVE_INSTRUCTIONS' | 'MISSING_INSTRUCTION' | 'MISSING_FIELD';
+interface Issue {
+    message: string;
+    path: Array<string | number>;
+}
+interface Details {
+    message: string;
+    code: RoninErrorCode;
+    field?: string;
+    fields?: Array<string>;
+    issues?: Array<Issue>;
+    queries?: Array<Query> | null;
+}
+declare class RoninError extends Error {
+    code: Details['code'];
+    field?: Details['field'];
+    fields?: Details['fields'];
+    issues?: Details['issues'];
+    queries?: Details['queries'];
+    constructor(details: Details);
+}
+/**
+ * Checks if the provided value contains a RONIN model symbol (a represenation of a
+ * particular entity inside a query, such as an expression or a sub query) and returns
+ * its type and value.
+ *
+ * @param value - The value that should be checked.
+ *
+ * @returns The type and value of the symbol, if the provided value contains one.
+ */
+declare const getQuerySymbol: (value: unknown) => {
+    type: "query";
+    value: Query;
+} | {
+    type: "expression";
+    value: string;
+} | null;
+
 interface TransactionOptions {
     /** A list of models that already exist in the database. */
     models?: Array<PublicModel>;
@@ -458,4 +473,4 @@ declare class Transaction {
 
 declare const CLEAN_ROOT_MODEL: PublicModel;
 
-export { type AddInstructions, type AddQuery, type AddInstructions as AddQueryInstructions, type AlterQuery, type CombinedInstructions, type CountInstructions, type CountQuery, type CountInstructions as CountQueryInstructions, type CreateQuery, type DropQuery, type ExpandedResult, type GetInstructions, type GetQuery, type GetInstructions as GetQueryInstructions, type PublicModel as Model, type ModelField, type ModelIndex, type ModelPreset, type ModelTrigger, QUERY_SYMBOLS, type Query, type QueryInstructionType as QueryInstruction, type QuerySchemaType, type QueryType, CLEAN_ROOT_MODEL as ROOT_MODEL, type RegularResult, type RemoveInstructions, type RemoveQuery, type RemoveInstructions as RemoveQueryInstructions, type Result, type ResultRecord, RoninError, type SetInstructions, type SetQuery, type SetInstructions as SetQueryInstructions, type Statement, type StoredObject, Transaction, type WithInstruction, getQuerySymbol };
+export { type AddInstructions, type AddQuery, type AddInstructions as AddQueryInstructions, type AlterQuery, type CombinedInstructions, type CountInstructions, type CountQuery, type CountInstructions as CountQueryInstructions, type CreateQuery, DDL_QUERY_TYPES, DML_QUERY_TYPES, DML_READ_QUERY_TYPES, DML_WRITE_QUERY_TYPES, type DropQuery, type ExpandedResult, type GetInstructions, type GetQuery, type GetInstructions as GetQueryInstructions, type PublicModel as Model, type ModelField, type ModelIndex, type ModelPreset, type ModelTrigger, QUERY_SYMBOLS, type Query, type QueryInstructionType as QueryInstruction, type QuerySchemaType, type QueryType, CLEAN_ROOT_MODEL as ROOT_MODEL, type RegularResult, type RemoveInstructions, type RemoveQuery, type RemoveInstructions as RemoveQueryInstructions, type Result, type ResultRecord, RoninError, type SetInstructions, type SetQuery, type SetInstructions as SetQueryInstructions, type Statement, type StoredObject, Transaction, type WithInstruction, getQuerySymbol };

package/dist/index.js

@@ -1,4 +1,11 @@
-// src/utils/helpers.ts
+// src/utils/constants.ts
+var DML_READ_QUERY_TYPES = ["get", "count"];
+var DML_WRITE_QUERY_TYPES = ["set", "add", "remove"];
+var DML_QUERY_TYPES = [
+  ...DML_READ_QUERY_TYPES,
+  ...DML_WRITE_QUERY_TYPES
+];
+var DDL_QUERY_TYPES = ["create", "alter", "drop"];
 var QUERY_SYMBOLS = {
   // Represents a sub query.
   QUERY: "__RONIN_QUERY",
@@ -24,6 +31,8 @@ var CURRENT_TIME_EXPRESSION = {
   [QUERY_SYMBOLS.EXPRESSION]: `strftime('%Y-%m-%dT%H:%M:%f', 'now') || 'Z'`
 };
 var MOUNTING_PATH_SUFFIX = /(.*?)(\{(\d+)\})?$/;
+
+// src/utils/helpers.ts
 var composeMountingPath = (single, key, mountingPath) => {
   if (key === "ronin_root") {
     return mountingPath ? mountingPath.replace(
@@ -764,7 +773,9 @@ var addDefaultModelPresets = (list, model) => {
                 }
               }
             }
-          }
+          },
+          name: slugToName(fieldSlug),
+          system: true
         };
         defaultPresets[fieldSlug] = preset2;
         continue;
@@ -788,7 +799,9 @@ var addDefaultModelPresets = (list, model) => {
               }
             }
           }
-        }
+        },
+        name: slugToName(fieldSlug),
+        system: true
       };
       defaultPresets[fieldSlug] = preset;
     }
@@ -823,7 +836,9 @@ var addDefaultModelPresets = (list, model) => {
             }
           }
         }
-      }
+      },
+      name: slugToName(presetSlug),
+      system: true
     };
     defaultPresets[presetSlug] = preset;
   }
@@ -1186,7 +1201,7 @@ var compileQueryInput = (defaultQuery, models, statementParams, options) => {
   if (queryType === "get" && !isJoiningMultipleRows && (single || instructions?.limitedTo)) {
     statement += handleLimitedTo(single, instructions?.limitedTo);
   }
-  if (["add", "set", "remove"].includes(queryType) && returning) {
+  if (DML_WRITE_QUERY_TYPES.includes(queryType) && returning) {
     statement += `RETURNING ${columns}`;
   }
   const mainStatement = {
@@ -1511,25 +1526,30 @@ var getSystemFields = (idPrefix) => ({
       // 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))`
-    }
+    },
+    system: true
   },
   "ronin.createdAt": {
     name: "RONIN - Created At",
     type: "date",
-    defaultValue: CURRENT_TIME_EXPRESSION
+    defaultValue: CURRENT_TIME_EXPRESSION,
+    system: true
   },
   "ronin.createdBy": {
     name: "RONIN - Created By",
-    type: "string"
+    type: "string",
+    system: true
   },
   "ronin.updatedAt": {
     name: "RONIN - Updated At",
     type: "date",
-    defaultValue: CURRENT_TIME_EXPRESSION
+    defaultValue: CURRENT_TIME_EXPRESSION,
+    system: true
   },
   "ronin.updatedBy": {
     name: "RONIN - Updated By",
-    type: "string"
+    type: "string",
+    system: true
   }
 });
 var ROOT_MODEL = {
@@ -2356,6 +2376,10 @@ var Transaction = class {
 };
 var CLEAN_ROOT_MODEL = omit(ROOT_MODEL, ["system"]);
 export {
+  DDL_QUERY_TYPES,
+  DML_QUERY_TYPES,
+  DML_READ_QUERY_TYPES,
+  DML_WRITE_QUERY_TYPES,
   QUERY_SYMBOLS,
   CLEAN_ROOT_MODEL as ROOT_MODEL,
   RoninError,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ronin/compiler",
-  "version": "0.17.12",
+  "version": "0.17.13-leo-ron-1113-experimental-403",
   "type": "module",
   "description": "Compiles RONIN queries to SQL statements.",
   "publishConfig": {