@hot-updater/plugin-core 0.36.7 → 1.0.0-rc.1

package/dist/createDatabasePlugin.d.cts

@@ -1,70 +1,26 @@
-import { DatabaseBundleQueryOptions, DatabasePlugin, DatabasePluginHooks, HotUpdaterContext, Paginated } from "./types/index.cjs";
-import { Bundle, GetBundlesArgs, UpdateInfo } from "@hot-updater/core";
-
+import { DatabasePlugin } from "./types/databasePlugin.cjs";
+import { DatabasePluginImplementation } from "./types/databaseOperations.cjs";
+import { DatabasePluginInputError, DatabasePluginInputErrorCode } from "./databasePluginCrudValidationErrors.cjs";
 //#region src/createDatabasePlugin.d.ts
-interface AbstractDatabasePlugin<TContext = unknown> {
-  supportsCursorPagination?: boolean;
-  getBundleById: (bundleId: string, context?: HotUpdaterContext<TContext>) => Promise<Bundle | null>;
-  getUpdateInfo?: (args: GetBundlesArgs, context?: HotUpdaterContext<TContext>) => Promise<UpdateInfo | null>;
-  getBundles: (options: DatabaseBundleQueryOptions & {
-    offset?: number;
-  }, context?: HotUpdaterContext<TContext>) => Promise<Paginated<Bundle[]>>;
-  getChannels: (context?: HotUpdaterContext<TContext>) => Promise<string[]>;
-  onUnmount?: () => Promise<void>;
-  commitBundle: (params: {
-    changedSets: {
-      operation: "insert" | "update" | "delete";
-      data: Bundle;
-    }[];
-  }, context?: HotUpdaterContext<TContext>) => Promise<void>;
+declare class DatabaseAtomicCommitUnsupportedError extends Error {
+  readonly pluginName: string;
+  readonly name = "DatabaseAtomicCommitUnsupportedError";
+  constructor(pluginName: string);
 }
 /**
- * Database plugin methods without name
- */
-type DatabasePluginMethods<TContext = unknown> = Omit<AbstractDatabasePlugin<TContext>, never>;
-/**
- * Factory function that creates database plugin methods
- */
-type DatabasePluginFactory<TConfig, TContext = unknown> = (config: TConfig) => DatabasePluginMethods<TContext>;
-/**
- * Configuration options for creating a database plugin
- */
-interface CreateDatabasePluginOptions<TConfig, TContext = unknown> {
-  /**
-   * The name of the database plugin (e.g., "postgres", "d1Database")
-   */
-  name: string;
-  /**
-   * Function that creates the database plugin methods
-   */
-  factory: DatabasePluginFactory<TConfig, TContext>;
-}
-/**
- * Creates a database plugin with lazy initialization and automatic hook execution.
- *
- * This factory function abstracts the double currying pattern used by all database plugins,
- * ensuring consistent lazy initialization behavior across different database providers.
- * Hooks are automatically executed at appropriate times without requiring manual invocation.
+ * Internal provider signal for a delete rejected by a live reference.
  *
- * @param options - Configuration options for the database plugin
- * @returns A double-curried function that lazily initializes the database plugin
- *
- * @example
- * ```typescript
- * export const postgres = createDatabasePlugin<PostgresConfig>({
- *   name: "postgres",
- *   factory: (config) => {
- *     const db = new Kysely(config);
- *     return {
- *       async getBundleById(bundleId) { ... },
- *       async getBundles(options) { ... },
- *       async getChannels() { ... },
- *       async commitBundle({ changedSets }) { ... }
- *     };
- *   }
- * });
- * ```
+ * Provider implementations throw this after translating their native
+ * foreign-key or reference-condition error. The public database contract
+ * observes only the indexed `referenced` commit conflict.
  */
-declare function createDatabasePlugin<TConfig, TContext = unknown>(options: CreateDatabasePluginOptions<TConfig, TContext>): (config: TConfig, hooks?: DatabasePluginHooks) => (() => DatabasePlugin<TContext>);
+declare class DatabaseRowReferencedError extends Error {
+  readonly name = "DatabaseRowReferencedError";
+  constructor();
+}
+type CreateDatabasePluginOptions = DatabasePlugin;
+type DatabasePluginAdapter = Omit<DatabasePlugin, "name">;
+declare const createDatabasePluginAdapter: (name: string, implementation: DatabasePluginImplementation) => DatabasePluginAdapter;
+declare const createDatabasePlugin: (options: CreateDatabasePluginOptions) => DatabasePlugin;
 //#endregion
-export { AbstractDatabasePlugin, CreateDatabasePluginOptions, createDatabasePlugin };
+export { CreateDatabasePluginOptions, DatabaseAtomicCommitUnsupportedError, DatabasePluginAdapter, DatabaseRowReferencedError, createDatabasePlugin, createDatabasePluginAdapter };

package/dist/createDatabasePlugin.d.mts

@@ -1,70 +1,26 @@
-import { DatabaseBundleQueryOptions, DatabasePlugin, DatabasePluginHooks, HotUpdaterContext, Paginated } from "./types/index.mjs";
-import { Bundle, GetBundlesArgs, UpdateInfo } from "@hot-updater/core";
-
+import { DatabasePlugin } from "./types/databasePlugin.mjs";
+import { DatabasePluginImplementation } from "./types/databaseOperations.mjs";
+import { DatabasePluginInputError, DatabasePluginInputErrorCode } from "./databasePluginCrudValidationErrors.mjs";
 //#region src/createDatabasePlugin.d.ts
-interface AbstractDatabasePlugin<TContext = unknown> {
-  supportsCursorPagination?: boolean;
-  getBundleById: (bundleId: string, context?: HotUpdaterContext<TContext>) => Promise<Bundle | null>;
-  getUpdateInfo?: (args: GetBundlesArgs, context?: HotUpdaterContext<TContext>) => Promise<UpdateInfo | null>;
-  getBundles: (options: DatabaseBundleQueryOptions & {
-    offset?: number;
-  }, context?: HotUpdaterContext<TContext>) => Promise<Paginated<Bundle[]>>;
-  getChannels: (context?: HotUpdaterContext<TContext>) => Promise<string[]>;
-  onUnmount?: () => Promise<void>;
-  commitBundle: (params: {
-    changedSets: {
-      operation: "insert" | "update" | "delete";
-      data: Bundle;
-    }[];
-  }, context?: HotUpdaterContext<TContext>) => Promise<void>;
+declare class DatabaseAtomicCommitUnsupportedError extends Error {
+  readonly pluginName: string;
+  readonly name = "DatabaseAtomicCommitUnsupportedError";
+  constructor(pluginName: string);
 }
 /**
- * Database plugin methods without name
- */
-type DatabasePluginMethods<TContext = unknown> = Omit<AbstractDatabasePlugin<TContext>, never>;
-/**
- * Factory function that creates database plugin methods
- */
-type DatabasePluginFactory<TConfig, TContext = unknown> = (config: TConfig) => DatabasePluginMethods<TContext>;
-/**
- * Configuration options for creating a database plugin
- */
-interface CreateDatabasePluginOptions<TConfig, TContext = unknown> {
-  /**
-   * The name of the database plugin (e.g., "postgres", "d1Database")
-   */
-  name: string;
-  /**
-   * Function that creates the database plugin methods
-   */
-  factory: DatabasePluginFactory<TConfig, TContext>;
-}
-/**
- * Creates a database plugin with lazy initialization and automatic hook execution.
- *
- * This factory function abstracts the double currying pattern used by all database plugins,
- * ensuring consistent lazy initialization behavior across different database providers.
- * Hooks are automatically executed at appropriate times without requiring manual invocation.
+ * Internal provider signal for a delete rejected by a live reference.
  *
- * @param options - Configuration options for the database plugin
- * @returns A double-curried function that lazily initializes the database plugin
- *
- * @example
- * ```typescript
- * export const postgres = createDatabasePlugin<PostgresConfig>({
- *   name: "postgres",
- *   factory: (config) => {
- *     const db = new Kysely(config);
- *     return {
- *       async getBundleById(bundleId) { ... },
- *       async getBundles(options) { ... },
- *       async getChannels() { ... },
- *       async commitBundle({ changedSets }) { ... }
- *     };
- *   }
- * });
- * ```
+ * Provider implementations throw this after translating their native
+ * foreign-key or reference-condition error. The public database contract
+ * observes only the indexed `referenced` commit conflict.
  */
-declare function createDatabasePlugin<TConfig, TContext = unknown>(options: CreateDatabasePluginOptions<TConfig, TContext>): (config: TConfig, hooks?: DatabasePluginHooks) => (() => DatabasePlugin<TContext>);
+declare class DatabaseRowReferencedError extends Error {
+  readonly name = "DatabaseRowReferencedError";
+  constructor();
+}
+type CreateDatabasePluginOptions = DatabasePlugin;
+type DatabasePluginAdapter = Omit<DatabasePlugin, "name">;
+declare const createDatabasePluginAdapter: (name: string, implementation: DatabasePluginImplementation) => DatabasePluginAdapter;
+declare const createDatabasePlugin: (options: CreateDatabasePluginOptions) => DatabasePlugin;
 //#endregion
-export { AbstractDatabasePlugin, CreateDatabasePluginOptions, createDatabasePlugin };
+export { CreateDatabasePluginOptions, DatabaseAtomicCommitUnsupportedError, DatabasePluginAdapter, DatabaseRowReferencedError, createDatabasePlugin, createDatabasePluginAdapter };