@manablox/db 0.1.0 → 0.3.0

package/dist/index.d.ts

@@ -0,0 +1,123 @@
+import { A as menusRelations, B as accounts, C as spaces, D as contentsRelations, E as assetsRelations, F as menus, G as users, H as memberships, I as contentTypes, J as assetVariants, K as verifications, L as contentVersions, M as spacesRelations, N as usersRelations, O as membershipsRelations, P as menuItems, R as contents, S as webhooks, T as assetVariantsRelations, U as roles, V as apikeys, W as sessions, Y as assets, _ as index_d_exports, a as ContentRow, b as workflows, c as MembershipRow, d as PushSubscriptionRow, f as RoleRow, g as WorkflowRunRow, h as WorkflowRow, i as ContentInsert, j as rolesRelations, k as menuItemsRelations, l as MenuItemRow, m as UserRow, n as AssetUsageRow, o as ContentTypeRow, p as SpaceRow, q as assetUsages, r as AssetVariantRow, s as ContentVersionRow, t as AssetRow, u as MenuRow, v as pushSubscriptions, w as assetUsagesRelations, x as webhookDeliveries, y as workflowRuns, z as publishedContents } from "./index-rZ24t-Ln.js";
+import { A as AssetRepository, B as buildContentWhere, C as ContentRepository, D as buildTree, E as TreeNode, F as ContentSort, G as Executor, H as Database, I as ContentTable, J as createDatabase, K as Sql, L as FieldFilter, M as Paginated, N as paginate, O as AssetUsageRepository, P as ContentFilter, R as Pagination, S as ContentTypeRepository, T as SQL, U as DatabaseHandle, V as buildOrderBy, W as DatabaseOptions, _ as MenuItemInput, a as WorkflowRunCreateData, b as MenuWriteData, c as WebhookDeliveryRow, d as SpaceRole, f as UserCreateData, g as SpaceWriteData, h as SpaceRepository, i as WorkflowRepository, j as AssetWriteData, k as AssetFilter, l as WebhookRepository, m as UserUpdateData, n as createRepositories, o as WorkflowWriteData, p as UserRepository, q as Transaction, r as RUNS_KEPT_PER_WORKFLOW, s as WebhookDeliveryData, t as Repositories, u as WebhookRow, v as MenuItemNode, w as ContentWriteData, x as ResolvedMenuItem, y as MenuRepository, z as PgColumn } from "./index-Cyf_N5K3.js";
+import { ErrorKey } from "@manablox/core";
+//#region src/bootstrap.d.ts
+/**
+ * Extensions the schema depends on. Run before the generated migrations, which
+ * reference `ltree` columns and `pg_trgm` operator classes.
+ */
+export declare function applyBootstrapSql(sql: Sql): Promise<void>;
+//#endregion
+//#region src/columns.d.ts
+/**
+ * `ltree` — the materialised ancestor path of a content node. A subtree move is one
+ * `UPDATE ... SET path = :newParent || subpath(path, nlevel(:oldParent))`.
+ */
+export declare const ltree: {
+  (): import("drizzle-orm/pg-core").PgCustomColumnBuilder<{
+    name: "";
+    dataType: 'custom';
+    columnType: 'PgCustomColumn';
+    data: string;
+    driverParam: string;
+    enumValues: undefined;
+  }>;
+  <TConfig extends Record<string, any> & unknown>(fieldConfig?: TConfig | undefined): import("drizzle-orm/pg-core").PgCustomColumnBuilder<{
+    name: "";
+    dataType: 'custom';
+    columnType: 'PgCustomColumn';
+    data: string;
+    driverParam: string;
+    enumValues: undefined;
+  }>;
+  <TName extends string>(dbName: TName, fieldConfig?: unknown): import("drizzle-orm/pg-core").PgCustomColumnBuilder<{
+    name: TName;
+    dataType: 'custom';
+    columnType: 'PgCustomColumn';
+    data: string;
+    driverParam: string;
+    enumValues: undefined;
+  }>;
+};
+/** `tsvector` — generated from `title` + `search_text`, never written directly. */
+export declare const tsvector: {
+  (): import("drizzle-orm/pg-core").PgCustomColumnBuilder<{
+    name: "";
+    dataType: 'custom';
+    columnType: 'PgCustomColumn';
+    data: string;
+    driverParam: string;
+    enumValues: undefined;
+  }>;
+  <TConfig extends Record<string, any> & unknown>(fieldConfig?: TConfig | undefined): import("drizzle-orm/pg-core").PgCustomColumnBuilder<{
+    name: "";
+    dataType: 'custom';
+    columnType: 'PgCustomColumn';
+    data: string;
+    driverParam: string;
+    enumValues: undefined;
+  }>;
+  <TName extends string>(dbName: TName, fieldConfig?: unknown): import("drizzle-orm/pg-core").PgCustomColumnBuilder<{
+    name: TName;
+    dataType: 'custom';
+    columnType: 'PgCustomColumn';
+    data: string;
+    driverParam: string;
+    enumValues: undefined;
+  }>;
+};
+/**
+ * ltree labels accept only `[A-Za-z0-9_]`, so UUID hyphens are swapped for underscores.
+ * The transform is total and reversible.
+ */
+export declare const idToLabel: (id: string) => string;
+export declare const labelToId: (label: string) => string;
+/** Builds the path of a node from its ancestors' ids (root first) plus its own. */
+export declare const buildPath: (ancestorIds: string[], selfId: string) => string;
+/** Splits a stored path back into ids, root first, self last. */
+export declare const parsePath: (path: string) => string[];
+export declare const pathDepth: (path: string) => number;
+//#endregion
+//#region src/errors.d.ts
+/**
+ * Postgres reports a unique-constraint violation as SQLSTATE `23505` with the constraint
+ * name in the message. Drizzle wraps the driver error, so the code and the message sit on
+ * `cause`, while the outer message is only ever "Failed query: insert into …".
+ */
+export declare function isUniqueViolation(error: unknown, constraint: string): boolean;
+export interface UniqueViolationMapping {
+  /** The constraint name, or a distinctive part of it. */
+  constraint: string;
+  /** The detail reported for the field, e.g. `content.slug.duplicate`. */
+  key: ErrorKey;
+  path?: (string | number)[];
+  params?: Record<string, unknown>;
+  /** The error's own key. */
+  errorKey: ErrorKey;
+}
+/**
+ * Turns a unique violation on one constraint into the validation error the client would
+ * have received had the check run before the write, and rethrows anything else untouched.
+ * Use as `.catch((error) => rethrowUniqueViolation(error, { … }))`.
+ */
+export declare function rethrowUniqueViolation(error: unknown, mapping: UniqueViolationMapping): never;
+/**
+ * A preset for one constraint: `const taken = uniqueViolation({ … })` once beside the
+ * service, then `.catch(taken({ machineName }))` on every write that can trip it. The
+ * params are the only part that differs per call, so they are the only argument left.
+ */
+export declare function uniqueViolation(preset: Omit<UniqueViolationMapping, 'params'>): (params: Record<string, unknown>) => (error: unknown) => never;
+//#endregion
+//#region src/migrate.d.ts
+/** The SQL files shipped with this package, next to `src/`. */
+export declare const MIGRATIONS_FOLDER: string;
+/**
+ * Brings a database up to the schema this version of the package expects.
+ *
+ * The same call the compose stack's `migrate` service and the `manablox migrate` CLI
+ * make, so an instance run from a dependency and one run from the repository apply the
+ * same files in the same order. Idempotent: drizzle records what it has applied.
+ */
+export declare function runMigrations(handle: DatabaseHandle): Promise<void>;
+//#endregion
+export { AssetFilter, AssetRepository, AssetRow, AssetUsageRepository, AssetUsageRow, AssetVariantRow, AssetWriteData, ContentFilter, ContentInsert, ContentRepository, ContentRow, ContentSort, ContentTable, ContentTypeRepository, ContentTypeRow, ContentVersionRow, ContentWriteData, Database, DatabaseHandle, DatabaseOptions, Executor, FieldFilter, MembershipRow, MenuItemInput, MenuItemNode, MenuItemRow, MenuRepository, MenuRow, MenuWriteData, Paginated, Pagination, type PgColumn, PushSubscriptionRow, RUNS_KEPT_PER_WORKFLOW, Repositories, ResolvedMenuItem, RoleRow, type SQL, SpaceRepository, SpaceRole, SpaceRow, SpaceWriteData, Sql, Transaction, TreeNode, UserCreateData, UserRepository, UserRow, UserUpdateData, WebhookDeliveryData, WebhookDeliveryRow, WebhookRepository, WebhookRow, WorkflowRepository, WorkflowRow, WorkflowRunCreateData, WorkflowRunRow, WorkflowWriteData, accounts, apikeys, assetUsages, assetUsagesRelations, assetVariants, assetVariantsRelations, assets, assetsRelations, buildContentWhere, buildOrderBy, buildTree, contentTypes, contentVersions, contents, contentsRelations, createDatabase, createRepositories, memberships, membershipsRelations, menuItems, menuItemsRelations, menus, menusRelations, paginate, publishedContents, pushSubscriptions, roles, rolesRelations, index_d_exports as schema, sessions, spaces, spacesRelations, users, usersRelations, verifications, webhookDeliveries, webhooks, workflowRuns, workflows };

package/dist/index.js

@@ -0,0 +1,60 @@
+import { _ as applyBootstrapSql, a as UserRepository, c as ContentTypeRepository, d as AssetUsageRepository, f as AssetRepository, g as createDatabase, h as paginate, i as WebhookRepository, l as ContentRepository, m as buildOrderBy, n as RUNS_KEPT_PER_WORKFLOW, o as SpaceRepository, p as buildContentWhere, r as WorkflowRepository, s as MenuRepository, t as createRepositories, u as buildTree } from "./repositories-DYjzuuF6.js";
+import { A as contentVersions, B as tsvector, C as roles, D as assetUsages, E as verifications, F as idToLabel, I as labelToId, L as ltree, M as publishedContents, N as spaces, O as assetVariants, P as buildPath, R as parsePath, S as memberships, T as users, _ as menuItems, a as webhookDeliveries, b as accounts, c as assetVariantsRelations, d as membershipsRelations, f as menuItemsRelations, g as usersRelations, h as spacesRelations, i as workflows, j as contents, k as assets, l as assetsRelations, m as rolesRelations, n as pushSubscriptions, o as webhooks, p as menusRelations, r as workflowRuns, s as assetUsagesRelations, t as schema_exports, u as contentsRelations, v as menus, w as sessions, x as apikeys, y as contentTypes, z as pathDepth } from "./schema-Bb4p16Yz.js";
+import { ManabloxError } from "@manablox/core";
+import { dirname, resolve } from "node:path";
+import { fileURLToPath } from "node:url";
+import { migrate } from "drizzle-orm/postgres-js/migrator";
+//#region src/errors.ts
+/**
+* Postgres reports a unique-constraint violation as SQLSTATE `23505` with the constraint
+* name in the message. Drizzle wraps the driver error, so the code and the message sit on
+* `cause`, while the outer message is only ever "Failed query: insert into …".
+*/
+function isUniqueViolation(error, constraint) {
+	const cause = error?.cause;
+	const code = error?.code ?? cause?.code;
+	const detail = `${cause?.message ?? ""} ${error?.message ?? ""}`;
+	return code === "23505" && detail.includes(constraint);
+}
+/**
+* Turns a unique violation on one constraint into the validation error the client would
+* have received had the check run before the write, and rethrows anything else untouched.
+* Use as `.catch((error) => rethrowUniqueViolation(error, { … }))`.
+*/
+function rethrowUniqueViolation(error, mapping) {
+	if (!isUniqueViolation(error, mapping.constraint)) throw error;
+	const detail = {
+		key: mapping.key,
+		...mapping.path ? { path: mapping.path } : {},
+		...mapping.params ? { params: mapping.params } : {}
+	};
+	throw ManabloxError.validation([detail], mapping.errorKey);
+}
+/**
+* A preset for one constraint: `const taken = uniqueViolation({ … })` once beside the
+* service, then `.catch(taken({ machineName }))` on every write that can trip it. The
+* params are the only part that differs per call, so they are the only argument left.
+*/
+function uniqueViolation(preset) {
+	return (params) => (error) => rethrowUniqueViolation(error, {
+		...preset,
+		params
+	});
+}
+//#endregion
+//#region src/migrate.ts
+/** The SQL files shipped with this package, next to `src/`. */
+const MIGRATIONS_FOLDER = resolve(dirname(fileURLToPath(import.meta.url)), "../migrations");
+/**
+* Brings a database up to the schema this version of the package expects.
+*
+* The same call the compose stack's `migrate` service and the `manablox migrate` CLI
+* make, so an instance run from a dependency and one run from the repository apply the
+* same files in the same order. Idempotent: drizzle records what it has applied.
+*/
+async function runMigrations(handle) {
+	await applyBootstrapSql(handle.sql);
+	await migrate(handle.db, { migrationsFolder: MIGRATIONS_FOLDER });
+}
+//#endregion
+export { AssetRepository, AssetUsageRepository, ContentRepository, ContentTypeRepository, MIGRATIONS_FOLDER, MenuRepository, RUNS_KEPT_PER_WORKFLOW, SpaceRepository, UserRepository, WebhookRepository, WorkflowRepository, accounts, apikeys, applyBootstrapSql, assetUsages, assetUsagesRelations, assetVariants, assetVariantsRelations, assets, assetsRelations, buildContentWhere, buildOrderBy, buildPath, buildTree, contentTypes, contentVersions, contents, contentsRelations, createDatabase, createRepositories, idToLabel, isUniqueViolation, labelToId, ltree, memberships, membershipsRelations, menuItems, menuItemsRelations, menus, menusRelations, paginate, parsePath, pathDepth, publishedContents, pushSubscriptions, rethrowUniqueViolation, roles, rolesRelations, runMigrations, schema_exports as schema, sessions, spaces, spacesRelations, tsvector, uniqueViolation, users, usersRelations, verifications, webhookDeliveries, webhooks, workflowRuns, workflows };