@ronin/compiler 0.18.8 → 0.18.9-ronin-error-experimental-453

package/dist/index.d.ts

@@ -4,8 +4,16 @@ declare const DML_QUERY_TYPES_READ: readonly ["get", "count"];
 declare const DML_QUERY_TYPES_WRITE: 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 reading the database schema. */
+declare const DDL_QUERY_TYPES_READ: readonly ["list"];
+/** Query types used for writing the database schema. */
+declare const DDL_QUERY_TYPES_WRITE: readonly ["create", "alter", "drop"];
 /** Query types used for interacting with the database schema. */
 declare const DDL_QUERY_TYPES: readonly ["list", "create", "alter", "drop"];
+/** All read query types. */
+declare const QUERY_TYPES_READ: readonly ["get", "count", "list"];
+/** All write query types. */
+declare const QUERY_TYPES_WRITE: readonly ["set", "add", "remove", "create", "alter", "drop"];
 /** All query types. */
 declare const QUERY_TYPES: readonly ["get", "count", "set", "add", "remove", "list", "create", "alter", "drop"];
 /**
@@ -390,20 +398,20 @@ 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' | 'INVALID_FIELD_VALUE' | 'EXISTING_MODEL_ENTITY' | 'REQUIRED_MODEL_ENTITY' | 'MUTUALLY_EXCLUSIVE_INSTRUCTIONS' | 'MISSING_INSTRUCTION' | 'MISSING_FIELD';
+type CompilerErrorCode = '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' | 'INVALID_FIELD_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;
+    code: CompilerErrorCode;
     field?: string;
     fields?: Array<string>;
     issues?: Array<Issue>;
     queries?: Array<Query> | null;
 }
-declare class RoninError extends Error {
+declare class CompilerError extends Error {
     code: Details['code'];
     field?: Details['field'];
     fields?: Details['fields'];
@@ -466,4 +474,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, DDL_QUERY_TYPES, DML_QUERY_TYPES, DML_QUERY_TYPES_READ, DML_QUERY_TYPES_WRITE, type DropQuery, type ExpandedResult, type GetInstructions, type GetQuery, type GetInstructions as GetQueryInstructions, type ListQuery, type PublicModel as Model, type ModelField, type ModelIndex, type ModelPreset, QUERY_SYMBOLS, QUERY_TYPES, 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, type ResultRecordBase, 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, CompilerError, type CountInstructions, type CountQuery, type CountInstructions as CountQueryInstructions, type CreateQuery, DDL_QUERY_TYPES, DDL_QUERY_TYPES_READ, DDL_QUERY_TYPES_WRITE, DML_QUERY_TYPES, DML_QUERY_TYPES_READ, DML_QUERY_TYPES_WRITE, type DropQuery, type ExpandedResult, type GetInstructions, type GetQuery, type GetInstructions as GetQueryInstructions, type ListQuery, type PublicModel as Model, type ModelField, type ModelIndex, type ModelPreset, QUERY_SYMBOLS, QUERY_TYPES, QUERY_TYPES_READ, QUERY_TYPES_WRITE, 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, type ResultRecordBase, type SetInstructions, type SetQuery, type SetInstructions as SetQueryInstructions, type Statement, type StoredObject, Transaction, type WithInstruction, getQuerySymbol };

package/dist/index.js

@@ -5,7 +5,20 @@ var DML_QUERY_TYPES = [
   ...DML_QUERY_TYPES_READ,
   ...DML_QUERY_TYPES_WRITE
 ];
-var DDL_QUERY_TYPES = ["list", "create", "alter", "drop"];
+var DDL_QUERY_TYPES_READ = ["list"];
+var DDL_QUERY_TYPES_WRITE = ["create", "alter", "drop"];
+var DDL_QUERY_TYPES = [
+  ...DDL_QUERY_TYPES_READ,
+  ...DDL_QUERY_TYPES_WRITE
+];
+var QUERY_TYPES_READ = [
+  ...DML_QUERY_TYPES_READ,
+  ...DDL_QUERY_TYPES_READ
+];
+var QUERY_TYPES_WRITE = [
+  ...DML_QUERY_TYPES_WRITE,
+  ...DDL_QUERY_TYPES_WRITE
+];
 var QUERY_TYPES = [...DML_QUERY_TYPES, ...DDL_QUERY_TYPES];
 var QUERY_SYMBOLS = {
   // Represents a sub query.
@@ -44,7 +57,7 @@ var MODEL_ENTITY_ERROR_CODES = {
   index: "INDEX_NOT_FOUND",
   preset: "PRESET_NOT_FOUND"
 };
-var RoninError = class extends Error {
+var CompilerError = class extends Error {
   code;
   field;
   fields;
@@ -52,7 +65,7 @@ var RoninError = class extends Error {
   queries;
   constructor(details) {
     super(details.message);
-    this.name = "RoninError";
+    this.name = "CompilerError";
     this.code = details.code;
     this.field = details.field;
     this.fields = details.fields;
@@ -198,13 +211,13 @@ var generatePaginationCursor = (model, orderedBy, record) => {
 // src/instructions/before-after.ts
 var handleBeforeOrAfter = (model, statementParams, queryType, instructions) => {
   if (!(instructions.before || instructions.after)) {
-    throw new RoninError({
+    throw new CompilerError({
       message: "The `before` or `after` instruction must not be empty.",
       code: "MISSING_INSTRUCTION"
     });
   }
   if (instructions.before && instructions.after) {
-    throw new RoninError({
+    throw new CompilerError({
       message: "The `before` and `after` instructions cannot co-exist. Choose one.",
       code: "MUTUALLY_EXCLUSIVE_INSTRUCTIONS"
     });
@@ -213,7 +226,7 @@ var handleBeforeOrAfter = (model, statementParams, queryType, instructions) => {
     let message = "When providing a pagination cursor in the `before` or `after`";
     message += " instruction, a `limitedTo` instruction must be provided as well, to";
     message += " define the page size.";
-    throw new RoninError({
+    throw new CompilerError({
       message,
       code: "MISSING_INSTRUCTION"
     });
@@ -1025,7 +1038,7 @@ var handleUsing = (model, instructions) => {
     const arg = normalizedUsing[presetSlug];
     const preset = model.presets?.[presetSlug];
     if (!preset) {
-      throw new RoninError({
+      throw new CompilerError({
         message: `Preset "${presetSlug}" does not exist in model "${model.name}".`,
         code: "PRESET_NOT_FOUND"
       });
@@ -1175,7 +1188,7 @@ var compileQueryInput = (defaultQuery, models, statementParams, options) => {
     const instructionName = queryType === "add" ? "with" : "to";
     const instructionValue = instructions[instructionName];
     if (!(instructionValue && isObject(instructionValue)) || Object.keys(instructionValue).length === 0) {
-      throw new RoninError({
+      throw new CompilerError({
         message: `When using a \`${queryType}\` query, the \`${instructionName}\` instruction must be a non-empty object.`,
         code: instructionName === "to" ? "INVALID_TO_VALUE" : "INVALID_WITH_VALUE",
         queries: [query]
@@ -1205,7 +1218,7 @@ var compileQueryInput = (defaultQuery, models, statementParams, options) => {
   }
   if (instructions && (typeof instructions.before !== "undefined" || typeof instructions.after !== "undefined")) {
     if (single) {
-      throw new RoninError({
+      throw new CompilerError({
         message: "The `before` and `after` instructions are not supported when querying for a single record.",
         code: "INVALID_BEFORE_OR_AFTER_INSTRUCTION",
         queries: [query]
@@ -1377,7 +1390,7 @@ var composeConditions = (models, model, statementParams, instructionName, value,
         if (modelField && fieldIsJSON && !valueIsJSON && value !== null) {
           const messagePrefix = "The provided field value is not";
           const message = modelField.type === "json" ? `${messagePrefix} valid JSON. Only objects and arrays should be provided. Other types of values should be stored in their respective primitive field types.` : `${messagePrefix} a valid Blob reference.`;
-          throw new RoninError({
+          throw new CompilerError({
             message,
             field: modelField?.slug,
             code: "INVALID_FIELD_VALUE"
@@ -1441,7 +1454,7 @@ var composeConditions = (models, model, statementParams, instructionName, value,
     );
     return conditions.join(" OR ");
   }
-  throw new RoninError({
+  throw new CompilerError({
     message: `The \`with\` instruction must not contain an empty field. The following fields are empty: \`${options.fieldSlug}\`. If you meant to query by an empty field, try using \`null\` instead.`,
     code: "INVALID_WITH_VALUE",
     queries: null
@@ -1511,7 +1524,7 @@ var getModelBySlug = (models, slug) => {
     return model2.slug === slug || model2.pluralSlug === slug;
   });
   if (!model) {
-    throw new RoninError({
+    throw new CompilerError({
       message: `No matching model with either Slug or Plural Slug of "${slug}" could be found.`,
       code: "MODEL_NOT_FOUND"
     });
@@ -1549,7 +1562,7 @@ function getFieldFromModel(model, fieldPath, source, shouldThrow = true) {
   modelField = modelFields.find((field) => field.slug === fieldPath);
   if (!modelField) {
     if (shouldThrow) {
-      throw new RoninError({
+      throw new CompilerError({
         message: `${errorPrefix} does not exist in model "${model.name}".`,
         code: "FIELD_NOT_FOUND",
         field: fieldPath,
@@ -1695,7 +1708,7 @@ var getFieldStatement = (models, model, field) => {
     if (symbol) value = `(${parseFieldExpression(model, "to", symbol.value)})`;
     if (field.type === "json") {
       if (!isObject(field.defaultValue)) {
-        throw new RoninError({
+        throw new CompilerError({
           message: `The default value of JSON field "${field.slug}" must be an object.`,
           code: "INVALID_MODEL_VALUE",
           field: "fields"
@@ -1955,13 +1968,13 @@ var transformMetaQuery = (models, dependencyStatements, statementParams, query,
   const pluralType = PLURAL_MODEL_ENTITIES[entity];
   const existingEntity = existingModel[pluralType]?.[slug];
   if ((action === "alter" || action === "drop") && !existingEntity) {
-    throw new RoninError({
+    throw new CompilerError({
       message: `No ${entity} with slug "${slug}" defined in model "${existingModel.name}".`,
       code: MODEL_ENTITY_ERROR_CODES[entity]
     });
   }
   if (action === "create" && existingEntity) {
-    throw new RoninError({
+    throw new CompilerError({
       message: `A ${entity} with the slug "${slug}" already exists.`,
       code: "EXISTING_MODEL_ENTITY",
       fields: ["slug"]
@@ -1998,7 +2011,7 @@ var transformMetaQuery = (models, dependencyStatements, statementParams, query,
       const systemFields = getSystemFields(existingModel.idPrefix);
       const isSystemField = slug in systemFields;
       if (isSystemField) {
-        throw new RoninError({
+        throw new CompilerError({
           message: `The ${entity} "${slug}" is a system ${entity} and cannot be removed.`,
           code: "REQUIRED_MODEL_ENTITY"
         });
@@ -2016,7 +2029,7 @@ var transformMetaQuery = (models, dependencyStatements, statementParams, query,
     let statement = `${statementAction}${index?.unique ? " UNIQUE" : ""} INDEX "${indexName}"`;
     if (action === "create") {
       if (!Array.isArray(index.fields) || index.fields.length === 0) {
-        throw new RoninError({
+        throw new CompilerError({
           message: `When ${actionReadable} ${PLURAL_MODEL_ENTITIES[entity]}, at least one field must be provided.`,
           code: "INVALID_MODEL_VALUE",
           field: PLURAL_MODEL_ENTITIES[entity]
@@ -2396,14 +2409,18 @@ var Transaction = class {
 };
 var CLEAN_ROOT_MODEL = omit(ROOT_MODEL, ["system"]);
 export {
+  CompilerError,
   DDL_QUERY_TYPES,
+  DDL_QUERY_TYPES_READ,
+  DDL_QUERY_TYPES_WRITE,
   DML_QUERY_TYPES,
   DML_QUERY_TYPES_READ,
   DML_QUERY_TYPES_WRITE,
   QUERY_SYMBOLS,
   QUERY_TYPES,
+  QUERY_TYPES_READ,
+  QUERY_TYPES_WRITE,
   CLEAN_ROOT_MODEL as ROOT_MODEL,
-  RoninError,
   Transaction,
   getQuerySymbol
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ronin/compiler",
-  "version": "0.18.8",
+  "version": "0.18.9-ronin-error-experimental-453",
   "type": "module",
   "description": "Compiles RONIN queries to SQL statements.",
   "publishConfig": {