feat: add metadata to store messages

aleph-im · Dec 10, 2024 · 39d0368 · 39d0368
1 parent 4449b06
commit 39d0368
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/packages/message/src/store/impl.ts b/packages/message/src/store/impl.ts
@@ -44,6 +44,7 @@ export class StoreMessageClient {
     fileHash,
     fileObject,
     extraFields,
+    metadata,
     sync = false,
   }: RequireOnlyOne<StorePublishConfiguration, 'fileObject' | 'fileHash'>): Promise<StoreMessage> {
     if (!fileObject && !fileHash) throw new Error('You need to specify a File to upload or a Hash to pin.')
@@ -67,6 +68,7 @@ export class StoreMessageClient {
       item_hash: hash,
       time: timestamp,
       extra_fields: extraFields,
+      metadata,
     }
 
     const builtMessage = buildStoreMessage({

diff --git a/packages/message/src/store/types.ts b/packages/message/src/store/types.ts
@@ -9,6 +9,7 @@ export type StoreContent = BaseContent & {
   content_type?: string
   ref?: string
   extra_fields?: Record<string, unknown>
+  metadata?: Record<string, unknown>
 }
 
 // -------- PIN ----------
@@ -48,6 +49,8 @@ export type StorePinConfiguration = {
  *
  * extraFields:     Extra fields to add to the Store message.
  *
+ * metadata:        Metadata about the stored content.
+ *
  * sync:            If true, the function will wait for the message to be confirmed by the API server.
  */
 export type StorePublishConfiguration = {
@@ -57,5 +60,6 @@ export type StorePublishConfiguration = {
   fileHash?: string
   storageEngine?: ItemType.ipfs | ItemType.storage
   extraFields?: Record<string, unknown>
+  metadata?: Record<string, unknown>
   sync?: boolean
 }