@ganju/utils 0.0.15 → 0.0.17

package/dist/dataTypes.js

@@ -0,0 +1,160 @@
+"use strict";
+// The shapes and limits shared by a project's database object (apps/data),
+// the workers that call it, and the tests. Pure: nothing here touches SQLite.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toTableInput = exports.DATA_HISTORY_DAYS = exports.DATA_IMPACT_MAX_IDS = exports.DATA_IMPACT_MAX_ROWS = exports.DATA_COPY_STEP_ROWS = exports.DATA_REBUILD_MAX_ROWS = exports.DATA_MAX_GROUPS = exports.DATA_MAX_GROUP_BY = exports.DATA_MAX_AGGREGATES = exports.DATA_MAX_SORT_KEYS = exports.DATA_MAX_IN_VALUES = exports.DATA_MAX_ENUM_VALUES = exports.DATA_MAX_LABEL = exports.DATA_MAX_DESCRIPTION = exports.DATA_MAX_VALUE_BYTES = exports.DATA_MAX_ROWS_PER_WRITE = exports.DATA_MAX_INSERT_ROWS = exports.DATA_MAX_WRITE_OPERATIONS = exports.DATA_LARGE_TABLE_ROWS = exports.DATA_MAX_RESULT_BYTES = exports.DATA_MAX_PAGE = exports.DATA_DEFAULT_PAGE = exports.DATA_MAX_TABLES = exports.DATA_MAX_COLUMNS = exports.DATA_MAX_STATEMENT_BYTES = exports.DATA_MAX_PARAMS = exports.isDataError = exports.DataError = exports.DATA_ERROR_CODES = exports.DATA_ON_DELETE = exports.DATA_ACCESS_RANK = exports.DATA_ACCESS_LEVELS = exports.DATA_COLUMN_TYPES = void 0;
+exports.DATA_COLUMN_TYPES = [
+    'text',
+    'long_text',
+    'integer',
+    'decimal',
+    'boolean',
+    'date',
+    'datetime',
+    'enum',
+    'json',
+    'email',
+    'url',
+    'phone',
+    'relation',
+    'file'
+];
+// What the assistant may do with a table when the caller is restricted (a
+// channel bot). Owners, the dashboard, the CLI and functions see every table.
+exports.DATA_ACCESS_LEVELS = ['none', 'read', 'add', 'full'];
+exports.DATA_ACCESS_RANK = {
+    none: 0,
+    read: 1,
+    add: 2,
+    full: 3
+};
+exports.DATA_ON_DELETE = ['restrict', 'cascade', 'set_null'];
+exports.DATA_ERROR_CODES = [
+    'invalid',
+    'not_found',
+    'forbidden',
+    'conflict',
+    'constraint',
+    'guard',
+    'too_large',
+    'full',
+    'read_only',
+    'deleted',
+    'not_initialised',
+    'restore',
+    'internal'
+];
+// The one error the database object returns. Its message is written for the
+// person or model that made the call, never raw SQLite text.
+class DataError extends Error {
+    code;
+    details;
+    constructor(message, code = 'invalid', details) {
+        super(message);
+        this.name = 'DataError';
+        this.code = code;
+        this.details = details;
+    }
+    // What the API answers with; its error handler reads both.
+    get status() {
+        return DATA_ERROR_STATUS[this.code];
+    }
+    toBody() {
+        return { code: this.code, ...(this.details ? { details: this.details } : {}) };
+    }
+}
+exports.DataError = DataError;
+const DATA_ERROR_STATUS = {
+    invalid: 400,
+    not_found: 404,
+    forbidden: 403,
+    conflict: 409,
+    constraint: 409,
+    guard: 409,
+    too_large: 400,
+    full: 409,
+    read_only: 403,
+    deleted: 409,
+    not_initialised: 404,
+    restore: 400,
+    internal: 500
+};
+const isDataError = (error) => error instanceof DataError;
+exports.isDataError = isDataError;
+// Limits. SQLite in a Durable Object allows 100 columns per table, 100 bound
+// parameters per statement and 100 KB per statement; the rest are ours.
+exports.DATA_MAX_PARAMS = 100;
+exports.DATA_MAX_STATEMENT_BYTES = 90_000;
+// 100 minus id, created_at, updated_at, version, created_by, updated_by and
+// participant_id.
+exports.DATA_MAX_COLUMNS = 93;
+exports.DATA_MAX_TABLES = 50;
+exports.DATA_DEFAULT_PAGE = 20;
+exports.DATA_MAX_PAGE = 500;
+exports.DATA_MAX_RESULT_BYTES = 1024 * 1024;
+// Past this many rows, an aggregate or a sort on an unindexed column needs a
+// filter on an indexed one: the object serves one request at a time.
+exports.DATA_LARGE_TABLE_ROWS = 200_000;
+exports.DATA_MAX_WRITE_OPERATIONS = 50;
+exports.DATA_MAX_INSERT_ROWS = 500;
+exports.DATA_MAX_ROWS_PER_WRITE = 5_000;
+exports.DATA_MAX_VALUE_BYTES = 1_000_000;
+exports.DATA_MAX_DESCRIPTION = 300;
+exports.DATA_MAX_LABEL = 100;
+exports.DATA_MAX_ENUM_VALUES = 100;
+exports.DATA_MAX_IN_VALUES = 50;
+exports.DATA_MAX_SORT_KEYS = 3;
+exports.DATA_MAX_AGGREGATES = 5;
+exports.DATA_MAX_GROUP_BY = 3;
+exports.DATA_MAX_GROUPS = 100;
+// A type change copies the table in one request up to this size. A larger
+// table is copied in the background, this many rows a step (tens of
+// milliseconds, so other requests are served in between), and writes that
+// would change its rows wait until it is done.
+exports.DATA_REBUILD_MAX_ROWS = 100_000;
+exports.DATA_COPY_STEP_ROWS = 5_000;
+// A delete preview follows cascades through up to this many rows; past it,
+// its counts are lower bounds.
+exports.DATA_IMPACT_MAX_ROWS = 200_000;
+exports.DATA_IMPACT_MAX_IDS = exports.DATA_MAX_ROWS_PER_WRITE;
+exports.DATA_HISTORY_DAYS = 90;
+// The table as the owner would write it again: what `ganju.data.json` and an
+// export's schema.json hold.
+const toTableInput = (table) => ({
+    name: table.name,
+    label: table.label,
+    description: table.description,
+    displayColumn: table.displayColumn,
+    access: table.access,
+    customerScoped: table.customerScoped,
+    history: table.history,
+    columns: table.columns.map(column => {
+        const out = { name: column.name, type: column.type };
+        if (column.label)
+            out.label = column.label;
+        if (column.description)
+            out.description = column.description;
+        if (column.required)
+            out.required = true;
+        if (column.unique)
+            out.unique = true;
+        if (column.filterable)
+            out.filterable = true;
+        if (column.searchable)
+            out.searchable = true;
+        if (column.personal)
+            out.personal = true;
+        if (column.values)
+            out.values = column.values;
+        if (column.table)
+            out.table = column.table;
+        if (column.onDelete)
+            out.onDelete = column.onDelete;
+        if (column.min !== null)
+            out.min = column.min;
+        if (column.default !== undefined)
+            out.default = column.default;
+        return out;
+    })
+});
+exports.toTableInput = toTableInput;