@kubun/plugin-blob-api 0.17.0 → 0.18.0

package/lib/index.d.ts

@@ -18,15 +18,28 @@ export type AttachmentInfo = {
 };
 export type BeginFetchParams = {
     attachmentID: string;
+    documentID: string;
     chunkSize: number;
     chunkDigests: Array<Uint8Array>;
 };
 export type StageChunkParams = {
     attachmentID: string;
+    documentID: string;
     index: number;
     offset: number;
     bytes: Uint8Array;
 };
+export type CompleteFetchParams = {
+    attachmentID: string;
+    documentID: string;
+};
+export type BindDownloadedAttachmentParams = {
+    attachmentID: string;
+    documentID: string;
+    chunkSize: number;
+    chunkDigests: Array<Uint8Array>;
+    readChunk(index: number): Promise<Uint8Array>;
+};
 export type BlobAPI = {
     writeAttachment(input: ReadableStream<Uint8Array>, options?: WriteAttachmentOptions): Promise<string>;
     writeAttachmentTx(stores: StoreProvider, input: ReadableStream<Uint8Array>, options?: WriteAttachmentOptions): Promise<string>;
@@ -36,5 +49,19 @@ export type BlobAPI = {
     beginFetch(params: BeginFetchParams): Promise<void>;
     getPresentChunks(attachmentID: string): Promise<Array<number>>;
     stageChunk(params: StageChunkParams): Promise<void>;
-    completeFetch(attachmentID: string): Promise<void>;
+    completeFetch(params: CompleteFetchParams): Promise<void>;
+    hasSource(attachmentID: string, documentID: string): Promise<boolean>;
+    holdsDocumentAttachments(documentID: string): Promise<boolean>;
+    sweepDocumentTx(stores: StoreProvider, documentID: string): Promise<void>;
+};
+export type BlobTransferAPI = {
+    bindDownloadedAttachment(params: BindDownloadedAttachmentParams): Promise<boolean>;
+};
+export type BlobPluginAPI = BlobAPI & BlobTransferAPI;
+export type FetchDocumentAttachmentOptions = {
+    documentID: string;
+    groupID?: string;
+};
+export type BlobPeerFetchAPI = {
+    fetchDocumentAttachment(attachmentID: string, options: FetchDocumentAttachmentOptions): Promise<void>;
 };

package/lib/index.js

@@ -2,4 +2,6 @@
 // `engine.getAPI('blob')`, plus the parameter types its methods take. Types only —
 // importing this creates no runtime edge on the blob plugin. The plugin implements
 // these and re-exports them for its own use.
+// What the p2p plugin offers the blob plugin under 'p2p': fetching a document's
+// attachment bytes from a holder that serves them through that document.
 export { };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubun/plugin-blob-api",
-  "version": "0.17.0",
+  "version": "0.18.0",
   "keywords": [],
   "license": "see LICENSE.md",
   "sideEffects": false,
@@ -15,9 +15,9 @@
     "LICENSE.md"
   ],
   "dependencies": {
-    "@kubun/blob-backend": "^0.17.0",
-    "@kubun/db": "^0.17.0",
-    "@kubun/store-blob": "^0.17.0"
+    "@kubun/blob-backend": "^0.18.0",
+    "@kubun/db": "^0.18.0",
+    "@kubun/store-blob": "^0.18.0"
   },
   "publishConfig": {
     "access": "public"