@hot-updater/cloudflare 1.0.0-rc.5 → 1.0.1

package/dist/worker/index.d.cts

@@ -1,28 +1,62 @@
-import { StoragePluginWith } from "@hot-updater/plugin-core";
-//#region src/worker/d1Database.d.ts
-type D1Result = {
+import { EngineDatabase, StorageAdapterWith } from "@hot-updater/plugin-core";
+//#region src/d1Executor.d.ts
+/** A D1 result, from the binding or the REST API. */
+interface D1ResultLike {
   readonly results?: readonly unknown[];
   readonly success?: boolean;
-};
+  readonly meta?: {
+    readonly changes?: number;
+  };
+}
+//#endregion
+//#region src/worker/d1Database.d.ts
 type D1BoundStatement = {
-  all: () => Promise<D1Result>;
+  all: () => Promise<D1ResultLike>;
 };
 type D1PreparedStatement = {
   bind: (...values: readonly unknown[]) => D1BoundStatement;
 };
 type D1Like = {
   prepare(sql: string): D1PreparedStatement;
-  batch(statements: D1BoundStatement[]): Promise<readonly D1Result[]>;
+  batch(statements: D1BoundStatement[]): Promise<readonly D1ResultLike[]>;
 };
-declare const d1Database: (database: D1Like) => import("@hot-updater/plugin-core").DatabasePlugin;
+/** Hot Updater's database on a D1 binding, inside a Worker. */
+declare const d1Database: (database: D1Like) => EngineDatabase;
+//#endregion
+//#region src/presignR2Url.d.ts
+/** R2's S3-compatible credentials. */
+interface R2Credentials {
+  readonly accessKeyId: string;
+  readonly secretAccessKey: string;
+}
 //#endregion
 //#region src/r2WorkerStorage.d.ts
-interface CloudflareWorkerStorageConfig {
+type CloudflareWorkerStorageConfig = {
   readonly bucket: R2Bucket;
   readonly bucketName: string;
   readonly basePath?: string;
-  readonly downloadUrlSigningKey: string;
-}
-declare const r2WorkerStorage: (config: CloudflareWorkerStorageConfig) => StoragePluginWith<"put" | "get" | "getDownloadUrl" | "exists" | "delete">;
+} & ({
+  /** The account whose R2 endpoint download URLs name. */
+  readonly accountId: string;
+  /**
+   * R2's S3-compatible credentials, which presign download URLs, as
+   * `r2Storage` from `@hot-updater/cloudflare` does: what a server needs
+   * to serve downloads.
+   */
+  readonly credentials: R2Credentials;
+} | {
+  readonly accountId?: undefined;
+  readonly credentials?: undefined;
+});
+/**
+ * Storage on the Worker's R2 binding. With R2's S3-compatible credentials,
+ * its download URLs are presigned and devices download from the bucket;
+ * without them, it has no `getDownloadUrl`, as a Console that only reads
+ * needs.
+ */
+declare function r2WorkerStorage(config: CloudflareWorkerStorageConfig & {
+  readonly credentials: R2Credentials;
+}): StorageAdapterWith<"put" | "get" | "getDownloadUrl" | "exists" | "delete">;
+declare function r2WorkerStorage(config: CloudflareWorkerStorageConfig): StorageAdapterWith<"put" | "get" | "exists" | "delete">;
 //#endregion
 export { type CloudflareWorkerStorageConfig, type D1Like, d1Database, r2WorkerStorage as r2Storage };

package/dist/worker/index.d.mts

@@ -1,28 +1,62 @@
-import { StoragePluginWith } from "@hot-updater/plugin-core";
-//#region src/worker/d1Database.d.ts
-type D1Result = {
+import { EngineDatabase, StorageAdapterWith } from "@hot-updater/plugin-core";
+//#region src/d1Executor.d.ts
+/** A D1 result, from the binding or the REST API. */
+interface D1ResultLike {
   readonly results?: readonly unknown[];
   readonly success?: boolean;
-};
+  readonly meta?: {
+    readonly changes?: number;
+  };
+}
+//#endregion
+//#region src/worker/d1Database.d.ts
 type D1BoundStatement = {
-  all: () => Promise<D1Result>;
+  all: () => Promise<D1ResultLike>;
 };
 type D1PreparedStatement = {
   bind: (...values: readonly unknown[]) => D1BoundStatement;
 };
 type D1Like = {
   prepare(sql: string): D1PreparedStatement;
-  batch(statements: D1BoundStatement[]): Promise<readonly D1Result[]>;
+  batch(statements: D1BoundStatement[]): Promise<readonly D1ResultLike[]>;
 };
-declare const d1Database: (database: D1Like) => import("@hot-updater/plugin-core").DatabasePlugin;
+/** Hot Updater's database on a D1 binding, inside a Worker. */
+declare const d1Database: (database: D1Like) => EngineDatabase;
+//#endregion
+//#region src/presignR2Url.d.ts
+/** R2's S3-compatible credentials. */
+interface R2Credentials {
+  readonly accessKeyId: string;
+  readonly secretAccessKey: string;
+}
 //#endregion
 //#region src/r2WorkerStorage.d.ts
-interface CloudflareWorkerStorageConfig {
+type CloudflareWorkerStorageConfig = {
   readonly bucket: R2Bucket;
   readonly bucketName: string;
   readonly basePath?: string;
-  readonly downloadUrlSigningKey: string;
-}
-declare const r2WorkerStorage: (config: CloudflareWorkerStorageConfig) => StoragePluginWith<"put" | "get" | "getDownloadUrl" | "exists" | "delete">;
+} & ({
+  /** The account whose R2 endpoint download URLs name. */
+  readonly accountId: string;
+  /**
+   * R2's S3-compatible credentials, which presign download URLs, as
+   * `r2Storage` from `@hot-updater/cloudflare` does: what a server needs
+   * to serve downloads.
+   */
+  readonly credentials: R2Credentials;
+} | {
+  readonly accountId?: undefined;
+  readonly credentials?: undefined;
+});
+/**
+ * Storage on the Worker's R2 binding. With R2's S3-compatible credentials,
+ * its download URLs are presigned and devices download from the bucket;
+ * without them, it has no `getDownloadUrl`, as a Console that only reads
+ * needs.
+ */
+declare function r2WorkerStorage(config: CloudflareWorkerStorageConfig & {
+  readonly credentials: R2Credentials;
+}): StorageAdapterWith<"put" | "get" | "getDownloadUrl" | "exists" | "delete">;
+declare function r2WorkerStorage(config: CloudflareWorkerStorageConfig): StorageAdapterWith<"put" | "get" | "exists" | "delete">;
 //#endregion
 export { type CloudflareWorkerStorageConfig, type D1Like, d1Database, r2WorkerStorage as r2Storage };