@hot-updater/plugin-core 0.16.3 → 0.16.5

package/dist/createBlobDatabasePlugin.d.ts

@@ -0,0 +1,42 @@
+import type { DatabasePluginHooks } from "./types";
+/**
+ * @prefix {string} - The prefix to filter the objects in the storage.
+ */
+export type ListObjectsFn = (prefix: string) => Promise<string[]>;
+/**
+ * @key {string} - The key of the object to load.
+ */
+export type LoadObjectFn = <T>(key: string) => Promise<T | null>;
+/**
+ * @key {string} - The key of the object to upload.
+ * @data {any} - The data to upload as a Javascript Object.
+ */
+export type UploadObjectFn = (key: string, data: any) => Promise<void>;
+/**
+ * @key {string} - The key of the object to delete.
+ */
+export type DeleteObjectFn = (key: string) => Promise<void>;
+/**
+ * @paths {string[]} - The paths to invalidate in the CDN.
+ */
+export type InvalidatePathsFn = (paths: string[]) => Promise<void>;
+/**
+ *
+ * @param name - The name of the database plugin
+ * @param listObjects - Function to list objects in the storage
+ * @param loadObject - Function to load an JSON object from the storage
+ * @param uploadObject - Function to upload an JSON object to the storage
+ * @param deleteObject  - Function to delete an object from the storage
+ * @param invalidatePaths - Function to invalidate paths in the CDN
+ * @param hooks - Optional hooks for additional functionality - see createDatabasePlugin
+ * @returns
+ */
+export declare const createBlobDatabasePlugin: ({ name, listObjects, loadObject, uploadObject, deleteObject, invalidatePaths, hooks, }: {
+    name: string;
+    listObjects: ListObjectsFn;
+    loadObject: LoadObjectFn;
+    uploadObject: UploadObjectFn;
+    deleteObject: DeleteObjectFn;
+    invalidatePaths: InvalidatePathsFn;
+    hooks?: DatabasePluginHooks;
+}) => (options: import("./types").BasePluginArgs) => import("./types").DatabasePlugin;

package/dist/createBlobDatabasePlugin.spec.d.ts

@@ -0,0 +1 @@
+export {};