pinata 1.4.0 → 1.5.0

package/dist/index.d.mts

@@ -1,5 +1,5 @@
 type PinataConfig = {
-    pinataJwt: string | undefined;
+    pinataJwt?: string;
     pinataGateway?: string;
     pinataGatewayKey?: string;
     customHeaders?: Record<string, string>;
@@ -34,6 +34,7 @@ type PinataMetadata = {
 type UpdateFileOptions = {
     id: string;
     name?: string;
+    keyvalues?: Record<string, string>;
 };
 type UploadOptions = {
     metadata?: PinataMetadata;
@@ -51,6 +52,7 @@ type FileListItem = {
     size: number;
     number_of_files: number;
     mime_type: string;
+    keyvalues: Record<string, string>;
     group_id: string | null;
     created_at: string;
 };
@@ -64,6 +66,7 @@ type FileListQuery = {
     mimeType?: string;
     cid?: string;
     cidPending?: boolean;
+    metadata?: Record<string, string>;
     order?: "ASC" | "DESC";
     limit?: number;
     pageToken?: string;
@@ -294,6 +297,7 @@ declare class PinataSDK {
     groups: Groups;
     constructor(config?: PinataConfig);
     setNewHeaders(headers: Record<string, string>): void;
+    setNewJwt(jwt: string): void;
     testAuthentication(): Promise<AuthTestResponse>;
 }
 declare class Files {
@@ -341,6 +345,7 @@ declare class FilterFiles {
     order(order: "ASC" | "DESC"): FilterFiles;
     limit(limit: number): FilterFiles;
     cidPending(cidPending: boolean): FilterFiles;
+    metadata(keyvalues: Record<string, string>): FilterFiles;
     pageToken(pageToken: string): FilterFiles;
     then(onfulfilled?: ((value: FileListResponse) => any) | null): Promise<any>;
     private fetchPage;

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 type PinataConfig = {
-    pinataJwt: string | undefined;
+    pinataJwt?: string;
     pinataGateway?: string;
     pinataGatewayKey?: string;
     customHeaders?: Record<string, string>;
@@ -34,6 +34,7 @@ type PinataMetadata = {
 type UpdateFileOptions = {
     id: string;
     name?: string;
+    keyvalues?: Record<string, string>;
 };
 type UploadOptions = {
     metadata?: PinataMetadata;
@@ -51,6 +52,7 @@ type FileListItem = {
     size: number;
     number_of_files: number;
     mime_type: string;
+    keyvalues: Record<string, string>;
     group_id: string | null;
     created_at: string;
 };
@@ -64,6 +66,7 @@ type FileListQuery = {
     mimeType?: string;
     cid?: string;
     cidPending?: boolean;
+    metadata?: Record<string, string>;
     order?: "ASC" | "DESC";
     limit?: number;
     pageToken?: string;
@@ -294,6 +297,7 @@ declare class PinataSDK {
     groups: Groups;
     constructor(config?: PinataConfig);
     setNewHeaders(headers: Record<string, string>): void;
+    setNewJwt(jwt: string): void;
     testAuthentication(): Promise<AuthTestResponse>;
 }
 declare class Files {
@@ -341,6 +345,7 @@ declare class FilterFiles {
     order(order: "ASC" | "DESC"): FilterFiles;
     limit(limit: number): FilterFiles;
     cidPending(cidPending: boolean): FilterFiles;
+    metadata(keyvalues: Record<string, string>): FilterFiles;
     pageToken(pageToken: string): FilterFiles;
     then(onfulfilled?: ((value: FileListResponse) => any) | null): Promise<any>;
     private fetchPage;

package/dist/index.js

@@ -63,7 +63,10 @@ var testAuthentication = async (config) => {
     endpoint = config.endpointUrl;
   }
   if (config.customHeaders && Object.keys(config.customHeaders).length > 0) {
-    headers = { ...config.customHeaders };
+    headers = {
+      Authorization: `Bearer ${config.pinataJwt}`,
+      ...config.customHeaders
+    };
   } else {
     headers = {
       Authorization: `Bearer ${config.pinataJwt}`,
@@ -121,7 +124,10 @@ var uploadFile = async (config, file, options) => {
   }
   let headers;
   if (config.customHeaders && Object.keys(config.customHeaders).length > 0) {
-    headers = { ...config.customHeaders };
+    headers = {
+      Authorization: `Bearer ${jwt}`,
+      ...config.customHeaders
+    };
   } else {
     headers = {
       Authorization: `Bearer ${jwt}`,
@@ -184,7 +190,10 @@ var uploadBase64 = async (config, base64String, options) => {
   }
   let headers;
   if (config.customHeaders && Object.keys(config.customHeaders).length > 0) {
-    headers = { ...config.customHeaders };
+    headers = {
+      Authorization: `Bearer ${jwt}`,
+      ...config.customHeaders
+    };
   } else {
     headers = {
       Authorization: `Bearer ${jwt}`,
@@ -259,7 +268,10 @@ var uploadUrl = async (config, url, options) => {
   }
   let headers;
   if (config.customHeaders && Object.keys(config.customHeaders).length > 0) {
-    headers = { ...config.customHeaders };
+    headers = {
+      Authorization: `Bearer ${jwt}`,
+      ...config.customHeaders
+    };
   } else {
     headers = {
       Authorization: `Bearer ${jwt}`,
@@ -322,7 +334,10 @@ var uploadJson = async (config, jsonData, options) => {
   }
   let headers;
   if (config.customHeaders && Object.keys(config.customHeaders).length > 0) {
-    headers = { ...config.customHeaders };
+    headers = {
+      Authorization: `Bearer ${jwt}`,
+      ...config.customHeaders
+    };
   } else {
     headers = {
       Authorization: `Bearer ${jwt}`,
@@ -381,11 +396,14 @@ var deleteFile = async (config, files) => {
   const responses = [];
   let headers;
   if (config.customHeaders && Object.keys(config.customHeaders).length > 0) {
-    headers = { ...config.customHeaders };
+    headers = {
+      Authorization: `Bearer ${config.pinataJwt}`,
+      ...config.customHeaders
+    };
   } else {
     headers = {
       Authorization: `Bearer ${config.pinataJwt}`,
-      Source: "sdk/unpin"
+      Source: "sdk/deleteFile"
     };
   }
   let endpoint = "https://api.pinata.cloud/v3";
@@ -443,7 +461,17 @@ var listFiles = async (config, options) => {
   }
   const params = new URLSearchParams();
   if (options) {
-    const { name, group, cid, order, limit, mimeType, pageToken, cidPending } = options;
+    const {
+      name,
+      group,
+      cid,
+      order,
+      limit,
+      mimeType,
+      pageToken,
+      cidPending,
+      metadata
+    } = options;
     if (limit)
       params.append("limit", limit.toString());
     if (name)
@@ -460,6 +488,11 @@ var listFiles = async (config, options) => {
       params.append("pageToken", pageToken);
     if (cidPending)
       params.append("cidPending", "true");
+    if (metadata && typeof metadata === "object") {
+      Object.entries(metadata).forEach(([key, value]) => {
+        params.append(`metadata[${key}]`, value.toString());
+      });
+    }
   }
   let endpoint = "https://api.pinata.cloud/v3";
   if (config.endpointUrl) {
@@ -469,7 +502,10 @@ var listFiles = async (config, options) => {
   try {
     let headers;
     if (config.customHeaders && Object.keys(config.customHeaders).length > 0) {
-      headers = { ...config.customHeaders };
+      headers = {
+        Authorization: `Bearer ${config.pinataJwt}`,
+        ...config.customHeaders
+      };
     } else {
       headers = {
         Authorization: `Bearer ${config.pinataJwt}`,
@@ -514,12 +550,26 @@ var updateFile = async (config, options) => {
   if (!config) {
     throw new ValidationError("Pinata configuration is missing");
   }
-  const data = JSON.stringify({
-    name: options.name
-  });
+  if (!options.name && (!options.keyvalues || Object.keys(options.keyvalues).length === 0)) {
+    throw new ValidationError(
+      "At least one of 'name' or 'keyvalues' must be provided"
+    );
+  }
+  const data = {};
+  if (options.name !== void 0) {
+    data.name = options.name;
+  }
+  if (options.keyvalues && Object.keys(options.keyvalues).length > 0) {
+    data.keyvalues = options.keyvalues;
+  }
+  const body = JSON.stringify(data);
   let headers;
   if (config.customHeaders && Object.keys(config.customHeaders).length > 0) {
-    headers = { ...config.customHeaders };
+    headers = {
+      Authorization: `Bearer ${config.pinataJwt}`,
+      "Content-Type": "application/json",
+      ...config.customHeaders
+    };
   } else {
     headers = {
       Authorization: `Bearer ${config.pinataJwt}`,
@@ -535,7 +585,7 @@ var updateFile = async (config, options) => {
     const request = await fetch(`${endpoint}/files/${options.id}`, {
       method: "PUT",
       headers,
-      body: data
+      body
     });
     if (!request.ok) {
       const errorData = await request.text();
@@ -613,12 +663,23 @@ var getCid = async (config, cid, options) => {
   if (config.endpointUrl) {
     endpoint = config.endpointUrl;
   }
+  let headers;
+  if (config.customHeaders && Object.keys(config.customHeaders).length > 0) {
+    headers = {
+      Authorization: `Bearer ${config.pinataJwt}`,
+      "Content-Type": "application/json",
+      ...config.customHeaders
+    };
+  } else {
+    headers = {
+      "Content-Type": "application/json",
+      Authorization: `Bearer ${config.pinataJwt}`,
+      Source: "sdk/getCid"
+    };
+  }
   const signedUrlRequest = await fetch(`${endpoint}/files/sign`, {
     method: "POST",
-    headers: {
-      "Content-Type": "application/json",
-      Authorization: `Bearer ${config?.pinataJwt}`
-    },
+    headers,
     body: payload
   });
   const signedUrl = await signedUrlRequest.json();
@@ -672,7 +733,11 @@ var createKey = async (config, options) => {
   }
   let headers;
   if (config.customHeaders && Object.keys(config.customHeaders).length > 0) {
-    headers = { ...config.customHeaders };
+    headers = {
+      Authorization: `Bearer ${config.pinataJwt}`,
+      "Content-Type": "application/json",
+      ...config.customHeaders
+    };
   } else {
     headers = {
       Authorization: `Bearer ${config.pinataJwt}`,
@@ -726,7 +791,11 @@ var listKeys = async (config, options) => {
   }
   let headers;
   if (config.customHeaders && Object.keys(config.customHeaders).length > 0) {
-    headers = { ...config.customHeaders };
+    headers = {
+      Authorization: `Bearer ${config.pinataJwt}`,
+      "Content-Type": "application/json",
+      ...config.customHeaders
+    };
   } else {
     headers = {
       Authorization: `Bearer ${config.pinataJwt}`,
@@ -800,6 +869,11 @@ var revokeKeys = async (config, keys) => {
   }
   let headers;
   if (config.customHeaders && Object.keys(config.customHeaders).length > 0) {
+    headers = {
+      Authorization: `Bearer ${config.pinataJwt}`,
+      "Content-Type": "application/json",
+      ...config.customHeaders
+    };
     headers = { ...config.customHeaders };
   } else {
     headers = {
@@ -869,7 +943,11 @@ var createGroup = async (config, options) => {
   });
   let headers;
   if (config.customHeaders && Object.keys(config.customHeaders).length > 0) {
-    headers = { ...config.customHeaders };
+    headers = {
+      Authorization: `Bearer ${config.pinataJwt}`,
+      "Content-Type": "application/json",
+      ...config.customHeaders
+    };
   } else {
     headers = {
       Authorization: `Bearer ${config.pinataJwt}`,
@@ -923,7 +1001,11 @@ var listGroups = async (config, options) => {
   }
   let headers;
   if (config.customHeaders && Object.keys(config.customHeaders).length > 0) {
-    headers = { ...config.customHeaders };
+    headers = {
+      Authorization: `Bearer ${config.pinataJwt}`,
+      "Content-Type": "application/json",
+      ...config.customHeaders
+    };
   } else {
     headers = {
       Authorization: `Bearer ${config.pinataJwt}`,
@@ -991,7 +1073,11 @@ var getGroup = async (config, options) => {
   }
   let headers;
   if (config.customHeaders && Object.keys(config.customHeaders).length > 0) {
-    headers = { ...config.customHeaders };
+    headers = {
+      Authorization: `Bearer ${config.pinataJwt}`,
+      "Content-Type": "application/json",
+      ...config.customHeaders
+    };
   } else {
     headers = {
       Authorization: `Bearer ${config.pinataJwt}`,
@@ -1050,7 +1136,11 @@ var updateGroup = async (config, options) => {
   });
   let headers;
   if (config.customHeaders && Object.keys(config.customHeaders).length > 0) {
-    headers = { ...config.customHeaders };
+    headers = {
+      Authorization: `Bearer ${config.pinataJwt}`,
+      "Content-Type": "application/json",
+      ...config.customHeaders
+    };
   } else {
     headers = {
       Authorization: `Bearer ${config.pinataJwt}`,
@@ -1104,6 +1194,11 @@ var deleteGroup = async (config, options) => {
   }
   let headers;
   if (config.customHeaders && Object.keys(config.customHeaders).length > 0) {
+    headers = {
+      Authorization: `Bearer ${config.pinataJwt}`,
+      "Content-Type": "application/json",
+      ...config.customHeaders
+    };
     headers = { ...config.customHeaders };
   } else {
     headers = {
@@ -1159,7 +1254,11 @@ var swapCid = async (config, options) => {
   });
   let headers;
   if (config.customHeaders && Object.keys(config.customHeaders).length > 0) {
-    headers = { ...config.customHeaders };
+    headers = {
+      Authorization: `Bearer ${config.pinataJwt}`,
+      "Content-Type": "application/json",
+      ...config.customHeaders
+    };
   } else {
     headers = {
       Authorization: `Bearer ${config.pinataJwt}`,
@@ -1227,7 +1326,11 @@ var swapHistory = async (config, options) => {
   }
   let headers;
   if (config.customHeaders && Object.keys(config.customHeaders).length > 0) {
-    headers = { ...config.customHeaders };
+    headers = {
+      Authorization: `Bearer ${config.pinataJwt}`,
+      "Content-Type": "application/json",
+      ...config.customHeaders
+    };
   } else {
     headers = {
       Authorization: `Bearer ${config.pinataJwt}`,
@@ -1292,7 +1395,11 @@ var deleteSwap = async (config, cid) => {
   }
   let headers;
   if (config.customHeaders && Object.keys(config.customHeaders).length > 0) {
-    headers = { ...config.customHeaders };
+    headers = {
+      Authorization: `Bearer ${config.pinataJwt}`,
+      "Content-Type": "application/json",
+      ...config.customHeaders
+    };
   } else {
     headers = {
       Authorization: `Bearer ${config.pinataJwt}`,
@@ -1402,13 +1509,24 @@ var createSignedURL = async (config, options, imgOpts) => {
   if (config.endpointUrl) {
     endpoint = config.endpointUrl;
   }
+  let headers;
+  if (config.customHeaders && Object.keys(config.customHeaders).length > 0) {
+    headers = {
+      Authorization: `Bearer ${config.pinataJwt}`,
+      "Content-Type": "application/json",
+      ...config.customHeaders
+    };
+  } else {
+    headers = {
+      "Content-Type": "application/json",
+      Authorization: `Bearer ${config.pinataJwt}`,
+      Source: "sdk/createSignURL"
+    };
+  }
   try {
     const request = await fetch(`${endpoint}/files/sign`, {
       method: "POST",
-      headers: {
-        "Content-Type": "application/json",
-        Authorization: `Bearer ${config?.pinataJwt}`
-      },
+      headers,
       body: payload
     });
     if (!request.ok) {
@@ -1473,6 +1591,17 @@ var PinataSDK = class {
     this.keys.updateConfig(this.config);
     this.groups.updateConfig(this.config);
   }
+  setNewJwt(jwt) {
+    if (!this.config) {
+      this.config = { pinataJwt: "" };
+    }
+    this.config.pinataJwt = jwt;
+    this.files.updateConfig(this.config);
+    this.upload.updateConfig(this.config);
+    this.gateways.updateConfig(this.config);
+    this.keys.updateConfig(this.config);
+    this.groups.updateConfig(this.config);
+  }
   testAuthentication() {
     return testAuthentication(this.config);
   }
@@ -1607,6 +1736,10 @@ var FilterFiles = class {
     this.query.cidPending = cidPending;
     return this;
   }
+  metadata(keyvalues) {
+    this.query.metadata = keyvalues;
+    return this;
+  }
   pageToken(pageToken) {
     this.query.pageToken = pageToken;
     return this;