pinata 1.4.1 → 1.6.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>;
@@ -30,10 +30,12 @@ type FileObject = {
 type JsonBody = Record<string, unknown>;
 type PinataMetadata = {
     name?: string;
+    keyvalues?: Record<string, string>;
 };
 type UpdateFileOptions = {
     id: string;
     name?: string;
+    keyvalues?: Record<string, string>;
 };
 type UploadOptions = {
     metadata?: PinataMetadata;
@@ -51,6 +53,7 @@ type FileListItem = {
     size: number;
     number_of_files: number;
     mime_type: string;
+    keyvalues: Record<string, string>;
     group_id: string | null;
     created_at: string;
 };
@@ -61,9 +64,11 @@ type FileListResponse = {
 type FileListQuery = {
     name?: string;
     group?: string;
+    noGroup?: boolean;
     mimeType?: string;
     cid?: string;
     cidPending?: boolean;
+    metadata?: Record<string, string>;
     order?: "ASC" | "DESC";
     limit?: number;
     pageToken?: string;
@@ -294,6 +299,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 +347,8 @@ declare class FilterFiles {
     order(order: "ASC" | "DESC"): FilterFiles;
     limit(limit: number): FilterFiles;
     cidPending(cidPending: boolean): FilterFiles;
+    metadata(keyvalues: Record<string, string>): FilterFiles;
+    noGroup(noGroup: boolean): 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>;
@@ -30,10 +30,12 @@ type FileObject = {
 type JsonBody = Record<string, unknown>;
 type PinataMetadata = {
     name?: string;
+    keyvalues?: Record<string, string>;
 };
 type UpdateFileOptions = {
     id: string;
     name?: string;
+    keyvalues?: Record<string, string>;
 };
 type UploadOptions = {
     metadata?: PinataMetadata;
@@ -51,6 +53,7 @@ type FileListItem = {
     size: number;
     number_of_files: number;
     mime_type: string;
+    keyvalues: Record<string, string>;
     group_id: string | null;
     created_at: string;
 };
@@ -61,9 +64,11 @@ type FileListResponse = {
 type FileListQuery = {
     name?: string;
     group?: string;
+    noGroup?: boolean;
     mimeType?: string;
     cid?: string;
     cidPending?: boolean;
+    metadata?: Record<string, string>;
     order?: "ASC" | "DESC";
     limit?: number;
     pageToken?: string;
@@ -294,6 +299,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 +347,8 @@ declare class FilterFiles {
     order(order: "ASC" | "DESC"): FilterFiles;
     limit(limit: number): FilterFiles;
     cidPending(cidPending: boolean): FilterFiles;
+    metadata(keyvalues: Record<string, string>): FilterFiles;
+    noGroup(noGroup: boolean): 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}`,
@@ -119,9 +122,15 @@ var uploadFile = async (config, file, options) => {
   if (options?.groupId) {
     data.append("group_id", options.groupId);
   }
+  if (options?.metadata?.keyvalues) {
+    data.append("keyvalues", JSON.stringify(options.metadata.keyvalues));
+  }
   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}`,
@@ -182,9 +191,15 @@ var uploadBase64 = async (config, base64String, options) => {
   if (options?.groupId) {
     data.append("group_id", options.groupId);
   }
+  if (options?.metadata?.keyvalues) {
+    data.append("keyvalues", JSON.stringify(options.metadata.keyvalues));
+  }
   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}`,
@@ -257,9 +272,15 @@ var uploadUrl = async (config, url, options) => {
   if (options?.groupId) {
     data.append("group_id", options.groupId);
   }
+  if (options?.metadata?.keyvalues) {
+    data.append("keyvalues", JSON.stringify(options.metadata.keyvalues));
+  }
   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}`,
@@ -320,9 +341,15 @@ var uploadJson = async (config, jsonData, options) => {
   if (options?.groupId) {
     data.append("group_id", options.groupId);
   }
+  if (options?.metadata?.keyvalues) {
+    data.append("keyvalues", JSON.stringify(options.metadata.keyvalues));
+  }
   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,7 +408,10 @@ 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}`,
@@ -443,7 +473,18 @@ 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,
+      noGroup
+    } = options;
     if (limit)
       params.append("limit", limit.toString());
     if (name)
@@ -460,6 +501,13 @@ var listFiles = async (config, options) => {
       params.append("pageToken", pageToken);
     if (cidPending)
       params.append("cidPending", "true");
+    if (noGroup)
+      params.append("group", "null");
+    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 +517,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 +565,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 +600,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();
@@ -615,7 +680,11 @@ var getCid = async (config, cid, 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 = {
       "Content-Type": "application/json",
@@ -679,7 +748,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}`,
@@ -733,7 +806,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}`,
@@ -807,6 +884,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 = {
@@ -876,7 +958,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}`,
@@ -930,7 +1016,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}`,
@@ -998,7 +1088,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}`,
@@ -1057,7 +1151,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}`,
@@ -1111,6 +1209,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 = {
@@ -1166,7 +1269,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}`,
@@ -1234,7 +1341,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}`,
@@ -1299,7 +1410,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}`,
@@ -1411,7 +1526,11 @@ var createSignedURL = async (config, options, imgOpts) => {
   }
   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 = {
       "Content-Type": "application/json",
@@ -1487,6 +1606,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);
   }
@@ -1621,6 +1751,14 @@ var FilterFiles = class {
     this.query.cidPending = cidPending;
     return this;
   }
+  metadata(keyvalues) {
+    this.query.metadata = keyvalues;
+    return this;
+  }
+  noGroup(noGroup) {
+    this.query.noGroup = noGroup;
+    return this;
+  }
   pageToken(pageToken) {
     this.query.pageToken = pageToken;
     return this;