@aventara/core 1.0.0-rc.0 → 1.0.0-rc.10

package/dist/operations/database-refusal.d.ts

@@ -0,0 +1,51 @@
+import type { AvValidationCode } from "./validation-code.js";
+/**
+ * Why the database refused a caller's value, each with the validation code and the
+ * issue message an adapter answers it with.
+ */
+export declare const DATABASE_REFUSALS: {
+    readonly tooLong: {
+        readonly code: "V1004";
+        readonly message: "The database refused this value: it is longer than the database can hold for its column.";
+    };
+    readonly outOfRange: {
+        readonly code: "V1004";
+        readonly message: "The database refused this value: it is outside the range its column can hold.";
+    };
+    readonly datetimeOutOfRange: {
+        readonly code: "V1004";
+        readonly message: "The database refused this value: the date and time is outside the range the database can hold.";
+    };
+    readonly divisionByZero: {
+        readonly code: "V1004";
+        readonly message: "The database refused this value: it divides by zero.";
+    };
+    readonly computedNull: {
+        readonly code: "V1004";
+        readonly message: "The database refused this value: the write computes no value for a column that requires one, as a division by zero does.";
+    };
+    readonly invalidInput: {
+        readonly code: "V1001";
+        readonly message: "The database refused this value: it is not valid input for its column's type.";
+    };
+    readonly nulInText: {
+        readonly code: "V1001";
+        readonly message: "The database refused this value: its text cannot contain the NUL character (U+0000).";
+    };
+    readonly nulInJson: {
+        readonly code: "V1001";
+        readonly message: "The database refused this value: its JSON cannot contain the NUL character (U+0000).";
+    };
+    readonly trailingEscape: {
+        readonly code: "V1001";
+        readonly message: "The database refused this value: a text match cannot end with the escape character \\.";
+    };
+    readonly backReference: {
+        readonly code: "V1012";
+        readonly message: "The data source refused this nested write: a record written through a relation cannot write that relation or its reference fields back.";
+    };
+};
+/** A reason the database refused a caller's value: a key of {@link DATABASE_REFUSALS}. */
+export type AvDatabaseRefusal = keyof typeof DATABASE_REFUSALS;
+/** Whether `message` is the message of a database refusal answered under `code`. */
+export declare function isDatabaseRefusalMessage(code: AvValidationCode, message: string): boolean;

package/dist/operations/database-refusal.js

@@ -0,0 +1,45 @@
+export const DATABASE_REFUSALS = {
+    tooLong: {
+        code: "V1004",
+        message: "The database refused this value: it is longer than the database can hold for its column.",
+    },
+    outOfRange: {
+        code: "V1004",
+        message: "The database refused this value: it is outside the range its column can hold.",
+    },
+    datetimeOutOfRange: {
+        code: "V1004",
+        message: "The database refused this value: the date and time is outside the range the database can hold.",
+    },
+    divisionByZero: {
+        code: "V1004",
+        message: "The database refused this value: it divides by zero.",
+    },
+    computedNull: {
+        code: "V1004",
+        message: "The database refused this value: the write computes no value for a column that requires one, as a division by zero does.",
+    },
+    invalidInput: {
+        code: "V1001",
+        message: "The database refused this value: it is not valid input for its column's type.",
+    },
+    nulInText: {
+        code: "V1001",
+        message: "The database refused this value: its text cannot contain the NUL character (U+0000).",
+    },
+    nulInJson: {
+        code: "V1001",
+        message: "The database refused this value: its JSON cannot contain the NUL character (U+0000).",
+    },
+    trailingEscape: {
+        code: "V1001",
+        message: "The database refused this value: a text match cannot end with the escape character \\.",
+    },
+    backReference: {
+        code: "V1012",
+        message: "The data source refused this nested write: a record written through a relation cannot write that relation or its reference fields back.",
+    },
+};
+export function isDatabaseRefusalMessage(code, message) {
+    return Object.values(DATABASE_REFUSALS).some((refusal) => refusal.code === code && refusal.message === message);
+}