blossom-client-sdk 0.9.0 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # blossom-client-sdk
2
2
 
3
+ ## 1.0.0
4
+
5
+ ### Major Changes
6
+
7
+ - 8350d95: Remove dependency on cross-fetch and require NodeJS >= 18 for native `fetch` API
8
+
9
+ ### Minor Changes
10
+
11
+ - 383a13b: Add `multiServerUpload` method
12
+
13
+ ## 0.9.1
14
+
15
+ ### Patch Changes
16
+
17
+ - Add support for nodejs Buffer type
18
+
3
19
  ## 0.9.0
4
20
 
5
21
  ### Minor Changes
package/README.md CHANGED
@@ -195,7 +195,56 @@ for (let server of servers) {
195
195
  }
196
196
  ```
197
197
 
198
- ### Upload and Mirror
198
+ ### Uploading and mirroring to multiple servers
199
+
200
+ The `multiServerUpload` method can be used to upload a single blob to multiple servers
201
+
202
+ Example of uploading to each server one at time
203
+
204
+ ```ts
205
+ import { multiServerUpload } from "blossom-server-sdk";
206
+
207
+ async function signer(event: any) {
208
+ // @ts-expect-error
209
+ return await window.nostr.signEvent(event);
210
+ }
211
+
212
+ const servers = ["https://cdn.server-a.com", "https://cdn.example.com", "https://cdn.other.com"];
213
+ const file = new File(["testing"], "test.txt");
214
+
215
+ // create async generator for upload
216
+ const upload = multiServerUpload(servers, file, signer);
217
+
218
+ let successful = 0;
219
+
220
+ while (true) {
221
+ let result: Awaited<ReturnType<typeof upload.next>> | undefined = undefined;
222
+
223
+ // attempt to upload
224
+ try {
225
+ result = await upload.next();
226
+ successful++;
227
+ } catch (error) {
228
+ if (error instanceof Error) console.log(`Failed to upload ${error.message}`);
229
+ }
230
+
231
+ if (result) {
232
+ // if upload was successful log progress
233
+ if (!result.done) {
234
+ console.log(`Uploaded to ${result.value.server} ${result.value.progress * 100}%`);
235
+ } else if (result.done && result.value) {
236
+ console.log(`Successfully uploaded ${result.value.sha256} to ${servers} servers`);
237
+
238
+ // exit while loop (important)
239
+ break;
240
+ } else {
241
+ throw Error("Failed to upload blob to any servers");
242
+ }
243
+ }
244
+ }
245
+ ```
246
+
247
+ ### Upload and Mirror manually
199
248
 
200
249
  ```js
201
250
  import { BlossomClient } from "blossom-client-sdk";
package/lib/client.d.ts CHANGED
@@ -1,3 +1,4 @@
1
+ /// <reference types="node" resolution-mode="require"/>
1
2
  export type EventTemplate = {
2
3
  created_at: number;
3
4
  kind: number;
@@ -32,8 +33,8 @@ export declare class HTTPError extends Error {
32
33
  } | string);
33
34
  static handleErrorResponse(res: Response): Promise<void>;
34
35
  }
35
- type ServerType = string | URL;
36
- type UploadType = Blob | File;
36
+ export type ServerType = string | URL;
37
+ export type UploadType = Blob | File | Buffer;
37
38
  export declare class BlossomClient {
38
39
  server: URL;
39
40
  signer?: Signer;
@@ -56,7 +57,7 @@ export declare class BlossomClient {
56
57
  getGetAuth(message: string, serverOrHash: string, expiration?: number): Promise<SignedEvent>;
57
58
  getBlob(hash: string, auth?: SignedEvent | boolean): Promise<Blob>;
58
59
  getUploadAuth(file: UploadType, message?: string, expiration?: number): Promise<SignedEvent>;
59
- uploadBlob(file: File, auth?: SignedEvent | boolean): Promise<BlobDescriptor>;
60
+ uploadBlob(file: UploadType, auth?: SignedEvent | boolean): Promise<BlobDescriptor>;
60
61
  getMirrorAuth(sha256: string, message?: string, expiration?: number): Promise<SignedEvent>;
61
62
  mirrorBlob(sha256: string, url: string | URL, auth?: SignedEvent | boolean): Promise<BlobDescriptor>;
62
63
  static hasBlob(server: ServerType, hash: string): Promise<boolean>;
@@ -69,4 +70,3 @@ export declare class BlossomClient {
69
70
  getDeleteAuth(hash: string, message?: string, expiration?: number): Promise<SignedEvent>;
70
71
  deleteBlob(hash: string, auth?: SignedEvent | boolean): Promise<string>;
71
72
  }
72
- export {};
package/lib/client.js CHANGED
@@ -1,10 +1,11 @@
1
- import fetch from "cross-fetch";
2
1
  import { bytesToHex } from "@noble/hashes/utils";
3
- import { readFileAsArrayBuffer as readBlobAsArrayBuffer } from "./helpers.js";
4
2
  const now = () => Math.floor(new Date().valueOf() / 1000);
5
3
  const oneHour = () => now() + 60 * 60;
6
4
  export const AUTH_EVENT_KIND = 24242;
7
5
  export class HTTPError extends Error {
6
+ response;
7
+ status;
8
+ body;
8
9
  constructor(response, body) {
9
10
  super(typeof body === "string" ? body : body.message);
10
11
  this.response = response;
@@ -25,12 +26,21 @@ export class HTTPError extends Error {
25
26
  }
26
27
  }
27
28
  export class BlossomClient {
29
+ server;
30
+ signer;
28
31
  constructor(server, signer) {
29
32
  this.server = new URL("/", server);
30
33
  this.signer = signer;
31
34
  }
32
35
  static async getFileSha256(file) {
33
- const buffer = file instanceof File ? await file.arrayBuffer() : await readBlobAsArrayBuffer(file);
36
+ let buffer;
37
+ if (file instanceof File || file instanceof Blob) {
38
+ buffer = await file.arrayBuffer();
39
+ }
40
+ else {
41
+ // nodejs Buffer
42
+ buffer = file.buffer;
43
+ }
34
44
  let hash;
35
45
  if (crypto.subtle) {
36
46
  const hashBuffer = await crypto.subtle.digest("SHA-256", buffer);
package/lib/helpers.d.ts CHANGED
@@ -1,3 +1,2 @@
1
1
  /** returns the last sha256 in a URL */
2
2
  export declare function getHashFromURL(url: string | URL): string | null;
3
- export declare function readFileAsArrayBuffer(file: Blob | File): Promise<ArrayBuffer>;
package/lib/helpers.js CHANGED
@@ -7,18 +7,3 @@ export function getHashFromURL(url) {
7
7
  return hashes[hashes.length - 1][0];
8
8
  return null;
9
9
  }
10
- export function readFileAsArrayBuffer(file) {
11
- return new Promise((resolve, reject) => {
12
- const reader = new FileReader();
13
- reader.onload = (e) => {
14
- const result = e.target?.result;
15
- if (result == undefined || typeof result !== "object") {
16
- reject();
17
- return;
18
- }
19
- resolve(result);
20
- };
21
- reader.onerror = (error) => reject(error);
22
- reader.readAsArrayBuffer(file);
23
- });
24
- }
package/lib/index.d.ts CHANGED
@@ -2,3 +2,4 @@ export * from "./client.js";
2
2
  export * from "./helpers.js";
3
3
  export * from "./image.js";
4
4
  export * from "./nostr.js";
5
+ export * from "./upload.js";
package/lib/index.js CHANGED
@@ -2,3 +2,4 @@ export * from "./client.js";
2
2
  export * from "./helpers.js";
3
3
  export * from "./image.js";
4
4
  export * from "./nostr.js";
5
+ export * from "./upload.js";
@@ -0,0 +1,13 @@
1
+ import { BlobDescriptor, ServerType, Signer, UploadType } from "./client.js";
2
+ /**
3
+ * Creates an AsyncGenerator that can be used to upload a blob to multiple servers
4
+ * @param servers A Set or Array of servers to upload to
5
+ * @param file The blob to be uploaded
6
+ * @param signer An async function used for signing nostr events
7
+ * @returns The BlobDescriptor if successful
8
+ */
9
+ export declare function multiServerUpload(servers: Iterable<ServerType>, file: UploadType, signer: Signer): AsyncGenerator<{
10
+ blob: BlobDescriptor;
11
+ progress: number;
12
+ server: ServerType;
13
+ }, BlobDescriptor | undefined, unknown>;
package/lib/upload.js ADDED
@@ -0,0 +1,37 @@
1
+ import { BlossomClient } from "./client.js";
2
+ /**
3
+ * Creates an AsyncGenerator that can be used to upload a blob to multiple servers
4
+ * @param servers A Set or Array of servers to upload to
5
+ * @param file The blob to be uploaded
6
+ * @param signer An async function used for signing nostr events
7
+ * @returns The BlobDescriptor if successful
8
+ */
9
+ export async function* multiServerUpload(servers, file, signer) {
10
+ const auth = await BlossomClient.getUploadAuth(file, signer);
11
+ let blob = undefined;
12
+ let total = Array.from(servers).length;
13
+ let uploaded = 0;
14
+ for (const server of servers) {
15
+ if (blob) {
16
+ // mirror blob to server
17
+ try {
18
+ let b = await BlossomClient.mirrorBlob(server, blob.url, auth);
19
+ uploaded++;
20
+ yield { blob: b, progress: uploaded / total, server };
21
+ }
22
+ catch (error) {
23
+ // not all servers support mirroring, attempt to upload
24
+ let b = await BlossomClient.uploadBlob(server, file, auth);
25
+ uploaded++;
26
+ yield { blob: b, progress: uploaded / total, server };
27
+ }
28
+ }
29
+ else {
30
+ // attempt initial upload
31
+ blob = await BlossomClient.uploadBlob(server, file, auth);
32
+ uploaded++;
33
+ yield { blob, progress: uploaded / total, server };
34
+ }
35
+ }
36
+ return blob;
37
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "blossom-client-sdk",
3
- "version": "0.9.0",
3
+ "version": "1.0.0",
4
4
  "description": "A simple client for manage blobs on blossom servers",
5
5
  "type": "module",
6
6
  "main": "./lib/index.js",
@@ -38,13 +38,15 @@
38
38
  "types": "./lib/nostr.d.ts"
39
39
  }
40
40
  },
41
+ "engines": {
42
+ "node": ">=18"
43
+ },
41
44
  "dependencies": {
42
- "@noble/hashes": "^1.4.0",
43
- "cross-fetch": "^4.0.0"
45
+ "@noble/hashes": "^1.4.0"
44
46
  },
45
47
  "devDependencies": {
46
48
  "@changesets/cli": "^2.27.1",
47
- "prettier": "^3.2.5",
49
+ "prettier": "^3.3.3",
48
50
  "typedoc": "^0.25.12",
49
51
  "typescript": "^5.3.3"
50
52
  }