pinata 2.0.1 → 2.1.0

package/README.md

@@ -4,9 +4,6 @@
 
 The new all-in-one Pinata SDK
 
-> [!IMPORTANT]
-> The `v1.*.*` release is a breaking change and does not support IPFS. Please use the [`pinata-web3`](https://github.com/PinataCloud/pinata-web3) SDK.
-
 ## Quickstart
 
 [View the full documentation here](https://docs.pinata.cloud/sdk-beta/getting-started)
@@ -45,7 +42,7 @@ const pinata = new PinataSDK({
 async function main() {
   try {
     const file = new File(["hello"], "Testing.txt", { type: "text/plain" });
-    const upload = await pinata.upload.file(file);
+    const upload = await pinata.upload.public.file(file);
     console.log(upload);
   } catch (error) {
     console.log(error);
@@ -59,14 +56,17 @@ This will return an object like the following:
 
 ```typescript
 {
-    id: "349f1bb2-5d59-4cab-9966-e94c028a05b7",
-    name: "file.txt",
-    cid: "bafybeihgxdzljxb26q6nf3r3eifqeedsvt2eubqtskghpme66cgjyw4fra",
-    size: 4682779,
-    number_of_files: 1,
-    mime_type: "text/plain",
-    user_id: "7a484d2c-4219-4f80-9d9d-86b42461e71a",
-    group_id: null
+  id: "0195a5c4-242f-7c01-bee8-f34a9e8e804b",
+  user_id: "87ef31fe-519b-4ffe-90d9-987771247827",
+  group_id: null,
+  name: "hello.txt",
+  cid: "bafkreid7qoywk77r7rj3slobqfekdvs57qwuwh5d2z3sqsw52iabe3mqne",
+  created_at: "2025-03-17T20:20:50.057Z",
+  size: 12,
+  number_of_files: 1,
+  mime_type: "text/plain",
+  vectorized: false,
+  network: "public",
 }
 ```
 
@@ -84,7 +84,7 @@ const pinata = new PinataSDK({
 
 async function main() {
   try {
-    const data = await pinata.gateways.get("bafkreibm6jg3ux5qumhcn2b3flc3tyu6dmlb4xa7u5bf44yegnrjhc4yeq");
+    const data = await pinata.gateways.public.get("bafkreibm6jg3ux5qumhcn2b3flc3tyu6dmlb4xa7u5bf44yegnrjhc4yeq");
     console.log(data)
   } catch (error) {
     console.log(error);

package/dist/index.d.mts

@@ -103,7 +103,7 @@ type FileListQuery = {
 type PinQueueQuery = {
     sort?: "ASC" | "DSC";
     status?: "prechecking" | "retrieving" | "expired" | "over_free_limit" | "over_max_size" | "invalid_object" | "bad_host_node";
-    ipfs_pin_hash?: string;
+    cid?: string;
     limit?: number;
     pageToken?: string;
 };
@@ -325,6 +325,7 @@ type UploadOptions = {
     groupId?: string;
     vectorize?: boolean;
     url?: string;
+    peerAddresses?: string[];
 };
 type SignedUploadUrlOptions = {
     date?: number;
@@ -343,8 +344,12 @@ type UploadCIDOptions = {
 type PinByCIDResponse = {
     id: string;
     cid: string;
-    status: "prechecking" | "retrieving";
+    date_queued: string;
     name: string;
+    status: string;
+    keyvalues: Record<string, any> | null;
+    host_nodes: string[] | null;
+    group_id: string | null;
 };
 
 declare const analyticsDateInterval: (config: PinataConfig | undefined, options?: TimeIntervalAnalyticsQuery) => Promise<TimeIntervalAnalyticsResponse>;
@@ -377,6 +382,8 @@ declare const vectorizeQuery: (config: PinataConfig | undefined, options: Vector
 
 declare const queue: (config: PinataConfig | undefined, options?: PinQueueQuery) => Promise<PinQueueResponse>;
 
+declare const deletePinRequest: (config: PinataConfig | undefined, id: string) => Promise<string>;
+
 declare const getCid: (config: PinataConfig | undefined, cid: string, gatewayType?: "ipfs" | "files", options?: OptimizeImageOptions) => Promise<GetCIDResponse>;
 
 declare const convertIPFSUrl: (config: PinataConfig | undefined, url: string, gatewayPrefix?: string) => Promise<string>;
@@ -656,6 +663,7 @@ declare class PublicFiles {
     getSwapHistory(options: SwapHistoryOptions): Promise<SwapCidResponse[]>;
     deleteSwap(cid: string): Promise<string>;
     queue(): FilterQueue;
+    deletePinRequest(requestId: string): Promise<string>;
 }
 
 declare class PrivateFiles {
@@ -792,4 +800,4 @@ declare function getFileIdFromUrl(url: string): string;
 
 declare const formatConfig: (config: PinataConfig | undefined) => PinataConfig | undefined;
 
-export { type AccessLinkOptions, type AnalyticsQuery, AuthenticationError, type ContainsCIDResponse, type ContentType, type DataEndponts, type DeleteResponse, type Endpoints, type FileListItem, type FileListQuery, type FileListResponse, type FileObject, type GetCIDResponse, type GetGroupOptions, type GroupCIDOptions, type GroupListResponse, type GroupOptions, type GroupQueryOptions, type GroupResponseItem, type JsonBody, type KeyListItem, type KeyListQuery, type KeyListResponse, type KeyOptions, type KeyPermissions, type KeyResponse, NetworkError, type OptimizeImageOptions, type PinByCIDResponse, type PinQueueItem, type PinQueueQuery, type PinQueueResponse, type PinataConfig, PinataError, type PinataMetadata, PinataSDK, type PinningEndpoints, type RevokeKeyResponse, type SignatureOptions, type SignatureResponse, type SignedUploadUrlOptions, type SwapCidOptions, type SwapCidResponse, type SwapHistoryOptions, type TimeIntervalAnalyticsQuery, type TimeIntervalAnalyticsResponse, type TimePeriodItem, type TopAnalyticsItem, type TopAnalyticsQuery, type TopAnalyticsResponse, type UpdateFileOptions, type UpdateGroupFilesResponse, type UpdateGroupOptions, type UploadCIDOptions, type UploadOptions, type UploadResponse, type UserPinnedDataResponse, ValidationError, type VectorQueryMatch, type VectorizeFileResponse, type VectorizeQuery, type VectorizeQueryResponse, addToGroup, analyticsDateInterval, analyticsTopUsage, containsCID, convertIPFSUrl, convertToDesiredGateway, createAccessLink, createGroup, createKey, createSignedUploadURL, deleteFile, deleteFileVectors, deleteGroup, deleteSwap, formatConfig, getCid, getFileIdFromUrl, getGroup, listFiles, listGroups, listKeys, pinnedFileCount, queue, removeFromGroup, revokeKeys, swapCid, swapHistory, testAuthentication, totalStorageUsage, updateFile, updateGroup, uploadBase64, uploadCid, uploadFile, uploadFileArray, uploadJson, uploadUrl, vectorizeFile, vectorizeQuery };
+export { type AccessLinkOptions, type AnalyticsQuery, AuthenticationError, type ContainsCIDResponse, type ContentType, type DataEndponts, type DeleteResponse, type Endpoints, type FileListItem, type FileListQuery, type FileListResponse, type FileObject, type GetCIDResponse, type GetGroupOptions, type GroupCIDOptions, type GroupListResponse, type GroupOptions, type GroupQueryOptions, type GroupResponseItem, type JsonBody, type KeyListItem, type KeyListQuery, type KeyListResponse, type KeyOptions, type KeyPermissions, type KeyResponse, NetworkError, type OptimizeImageOptions, type PinByCIDResponse, type PinQueueItem, type PinQueueQuery, type PinQueueResponse, type PinataConfig, PinataError, type PinataMetadata, PinataSDK, type PinningEndpoints, type RevokeKeyResponse, type SignatureOptions, type SignatureResponse, type SignedUploadUrlOptions, type SwapCidOptions, type SwapCidResponse, type SwapHistoryOptions, type TimeIntervalAnalyticsQuery, type TimeIntervalAnalyticsResponse, type TimePeriodItem, type TopAnalyticsItem, type TopAnalyticsQuery, type TopAnalyticsResponse, type UpdateFileOptions, type UpdateGroupFilesResponse, type UpdateGroupOptions, type UploadCIDOptions, type UploadOptions, type UploadResponse, type UserPinnedDataResponse, ValidationError, type VectorQueryMatch, type VectorizeFileResponse, type VectorizeQuery, type VectorizeQueryResponse, addToGroup, analyticsDateInterval, analyticsTopUsage, containsCID, convertIPFSUrl, convertToDesiredGateway, createAccessLink, createGroup, createKey, createSignedUploadURL, deleteFile, deleteFileVectors, deleteGroup, deletePinRequest, deleteSwap, formatConfig, getCid, getFileIdFromUrl, getGroup, listFiles, listGroups, listKeys, pinnedFileCount, queue, removeFromGroup, revokeKeys, swapCid, swapHistory, testAuthentication, totalStorageUsage, updateFile, updateGroup, uploadBase64, uploadCid, uploadFile, uploadFileArray, uploadJson, uploadUrl, vectorizeFile, vectorizeQuery };

package/dist/index.d.ts

@@ -103,7 +103,7 @@ type FileListQuery = {
 type PinQueueQuery = {
     sort?: "ASC" | "DSC";
     status?: "prechecking" | "retrieving" | "expired" | "over_free_limit" | "over_max_size" | "invalid_object" | "bad_host_node";
-    ipfs_pin_hash?: string;
+    cid?: string;
     limit?: number;
     pageToken?: string;
 };
@@ -325,6 +325,7 @@ type UploadOptions = {
     groupId?: string;
     vectorize?: boolean;
     url?: string;
+    peerAddresses?: string[];
 };
 type SignedUploadUrlOptions = {
     date?: number;
@@ -343,8 +344,12 @@ type UploadCIDOptions = {
 type PinByCIDResponse = {
     id: string;
     cid: string;
-    status: "prechecking" | "retrieving";
+    date_queued: string;
     name: string;
+    status: string;
+    keyvalues: Record<string, any> | null;
+    host_nodes: string[] | null;
+    group_id: string | null;
 };
 
 declare const analyticsDateInterval: (config: PinataConfig | undefined, options?: TimeIntervalAnalyticsQuery) => Promise<TimeIntervalAnalyticsResponse>;
@@ -377,6 +382,8 @@ declare const vectorizeQuery: (config: PinataConfig | undefined, options: Vector
 
 declare const queue: (config: PinataConfig | undefined, options?: PinQueueQuery) => Promise<PinQueueResponse>;
 
+declare const deletePinRequest: (config: PinataConfig | undefined, id: string) => Promise<string>;
+
 declare const getCid: (config: PinataConfig | undefined, cid: string, gatewayType?: "ipfs" | "files", options?: OptimizeImageOptions) => Promise<GetCIDResponse>;
 
 declare const convertIPFSUrl: (config: PinataConfig | undefined, url: string, gatewayPrefix?: string) => Promise<string>;
@@ -656,6 +663,7 @@ declare class PublicFiles {
     getSwapHistory(options: SwapHistoryOptions): Promise<SwapCidResponse[]>;
     deleteSwap(cid: string): Promise<string>;
     queue(): FilterQueue;
+    deletePinRequest(requestId: string): Promise<string>;
 }
 
 declare class PrivateFiles {
@@ -792,4 +800,4 @@ declare function getFileIdFromUrl(url: string): string;
 
 declare const formatConfig: (config: PinataConfig | undefined) => PinataConfig | undefined;
 
-export { type AccessLinkOptions, type AnalyticsQuery, AuthenticationError, type ContainsCIDResponse, type ContentType, type DataEndponts, type DeleteResponse, type Endpoints, type FileListItem, type FileListQuery, type FileListResponse, type FileObject, type GetCIDResponse, type GetGroupOptions, type GroupCIDOptions, type GroupListResponse, type GroupOptions, type GroupQueryOptions, type GroupResponseItem, type JsonBody, type KeyListItem, type KeyListQuery, type KeyListResponse, type KeyOptions, type KeyPermissions, type KeyResponse, NetworkError, type OptimizeImageOptions, type PinByCIDResponse, type PinQueueItem, type PinQueueQuery, type PinQueueResponse, type PinataConfig, PinataError, type PinataMetadata, PinataSDK, type PinningEndpoints, type RevokeKeyResponse, type SignatureOptions, type SignatureResponse, type SignedUploadUrlOptions, type SwapCidOptions, type SwapCidResponse, type SwapHistoryOptions, type TimeIntervalAnalyticsQuery, type TimeIntervalAnalyticsResponse, type TimePeriodItem, type TopAnalyticsItem, type TopAnalyticsQuery, type TopAnalyticsResponse, type UpdateFileOptions, type UpdateGroupFilesResponse, type UpdateGroupOptions, type UploadCIDOptions, type UploadOptions, type UploadResponse, type UserPinnedDataResponse, ValidationError, type VectorQueryMatch, type VectorizeFileResponse, type VectorizeQuery, type VectorizeQueryResponse, addToGroup, analyticsDateInterval, analyticsTopUsage, containsCID, convertIPFSUrl, convertToDesiredGateway, createAccessLink, createGroup, createKey, createSignedUploadURL, deleteFile, deleteFileVectors, deleteGroup, deleteSwap, formatConfig, getCid, getFileIdFromUrl, getGroup, listFiles, listGroups, listKeys, pinnedFileCount, queue, removeFromGroup, revokeKeys, swapCid, swapHistory, testAuthentication, totalStorageUsage, updateFile, updateGroup, uploadBase64, uploadCid, uploadFile, uploadFileArray, uploadJson, uploadUrl, vectorizeFile, vectorizeQuery };
+export { type AccessLinkOptions, type AnalyticsQuery, AuthenticationError, type ContainsCIDResponse, type ContentType, type DataEndponts, type DeleteResponse, type Endpoints, type FileListItem, type FileListQuery, type FileListResponse, type FileObject, type GetCIDResponse, type GetGroupOptions, type GroupCIDOptions, type GroupListResponse, type GroupOptions, type GroupQueryOptions, type GroupResponseItem, type JsonBody, type KeyListItem, type KeyListQuery, type KeyListResponse, type KeyOptions, type KeyPermissions, type KeyResponse, NetworkError, type OptimizeImageOptions, type PinByCIDResponse, type PinQueueItem, type PinQueueQuery, type PinQueueResponse, type PinataConfig, PinataError, type PinataMetadata, PinataSDK, type PinningEndpoints, type RevokeKeyResponse, type SignatureOptions, type SignatureResponse, type SignedUploadUrlOptions, type SwapCidOptions, type SwapCidResponse, type SwapHistoryOptions, type TimeIntervalAnalyticsQuery, type TimeIntervalAnalyticsResponse, type TimePeriodItem, type TopAnalyticsItem, type TopAnalyticsQuery, type TopAnalyticsResponse, type UpdateFileOptions, type UpdateGroupFilesResponse, type UpdateGroupOptions, type UploadCIDOptions, type UploadOptions, type UploadResponse, type UserPinnedDataResponse, ValidationError, type VectorQueryMatch, type VectorizeFileResponse, type VectorizeQuery, type VectorizeQueryResponse, addToGroup, analyticsDateInterval, analyticsTopUsage, containsCID, convertIPFSUrl, convertToDesiredGateway, createAccessLink, createGroup, createKey, createSignedUploadURL, deleteFile, deleteFileVectors, deleteGroup, deletePinRequest, deleteSwap, formatConfig, getCid, getFileIdFromUrl, getGroup, listFiles, listGroups, listKeys, pinnedFileCount, queue, removeFromGroup, revokeKeys, swapCid, swapHistory, testAuthentication, totalStorageUsage, updateFile, updateGroup, uploadBase64, uploadCid, uploadFile, uploadFileArray, uploadJson, uploadUrl, vectorizeFile, vectorizeQuery };

package/dist/index.js

@@ -38,6 +38,7 @@ __export(src_exports, {
   deleteFile: () => deleteFile,
   deleteFileVectors: () => deleteFileVectors,
   deleteGroup: () => deleteGroup,
+  deletePinRequest: () => deletePinRequest,
   deleteSwap: () => deleteSwap,
   formatConfig: () => formatConfig,
   getCid: () => getCid,
@@ -1238,21 +1239,23 @@ var queue = async (config, options) => {
     includesCount: "false"
   });
   if (options) {
-    const { ipfs_pin_hash: cid, status, sort, limit } = options;
+    const { cid, status, sort, limit, pageToken } = options;
     if (cid)
-      params.append("ipfs_pin_hash", cid.toString());
+      params.append("cid", cid.toString());
     if (status)
       params.append("status", status.toString());
     if (sort)
       params.append("sort", sort.toString());
     if (limit)
       params.append("limit", limit.toString());
+    if (pageToken)
+      params.append("pageToken", pageToken.toString());
   }
-  let endpoint = "https://api.pinata.cloud";
+  let endpoint = "https://api.pinata.cloud/v3";
   if (config.endpointUrl) {
     endpoint = config.endpointUrl;
   }
-  const url = `${endpoint}/pinning/pinJobs?${params.toString()}`;
+  const url = `${endpoint}/files/public/pin_by_cid?${params.toString()}`;
   let headers;
   if (config.customHeaders && Object.keys(config.customHeaders).length > 0) {
     headers = {
@@ -1294,15 +1297,7 @@ var queue = async (config, options) => {
       });
     }
     const res = await request.json();
-    const resData = {
-      rows: res.rows.map((row) => ({
-        ...row,
-        cid: row.ipfs_pin_hash,
-        ipfs_pin_hash: void 0
-      })),
-      next_page_token: ""
-      // Assuming API returns this
-    };
+    const resData = res.data;
     return resData;
   } catch (error) {
     if (error instanceof PinataError) {
@@ -1315,6 +1310,69 @@ var queue = async (config, options) => {
   }
 };
 
+// src/core/functions/files/deletePinRequest.ts
+var deletePinRequest = async (config, id) => {
+  if (!config) {
+    throw new ValidationError("Pinata configuration is missing");
+  }
+  let headers;
+  if (config.customHeaders && Object.keys(config.customHeaders).length > 0) {
+    headers = {
+      Authorization: `Bearer ${config.pinataJwt}`,
+      ...config.customHeaders
+    };
+  } else {
+    headers = {
+      Authorization: `Bearer ${config.pinataJwt}`,
+      Source: "sdk/deletePinRequest"
+    };
+  }
+  let endpoint = "https://api.pinata.cloud/v3";
+  if (config.endpointUrl) {
+    endpoint = config.endpointUrl;
+  }
+  try {
+    const response = await fetch(`${endpoint}/files/public/pin_by_cid/${id}`, {
+      method: "DELETE",
+      headers
+    });
+    if (!response.ok) {
+      const errorData = await response.text();
+      if (response.status === 401) {
+        throw new AuthenticationError(
+          `Authentication failed: ${errorData}`,
+          response.status,
+          {
+            error: errorData,
+            code: "HTTP_ERROR",
+            metadata: {
+              requestUrl: response.url
+            }
+          }
+        );
+      }
+      throw new NetworkError(`HTTP error`, response.status, {
+        error: errorData,
+        code: "HTTP_ERROR",
+        metadata: {
+          requestUrl: response.url
+        }
+      });
+    }
+    return "OK";
+  } catch (error) {
+    if (error instanceof PinataError) {
+      throw error;
+    }
+    if (error instanceof Error) {
+      throw new PinataError(`Error deleting pin by request: ${error.message}`);
+    }
+    throw new PinataError(
+      "An unknown error occurred while deleting pin by CID request"
+    );
+  }
+};
+
 // src/core/functions/gateway/getCid.ts
 var getCid = async (config, cid, gatewayType, options) => {
   if (!config) {
@@ -1550,12 +1608,12 @@ async function convertToDesiredGateway(sourceUrl, desiredGatewayPrefix) {
     throw new Error("url does not contain CID");
   }
   if (!sourceUrl.startsWith("https") && !sourceUrl.startsWith("ipfs://")) {
-    return `${desiredGatewayPrefix}/files/${sourceUrl}`;
+    return `${desiredGatewayPrefix}/ipfs/${sourceUrl}`;
   }
   const urlObj = new URL(sourceUrl);
   const path = urlObj.pathname + urlObj.search + urlObj.hash;
   if (sourceUrl.startsWith(`ipfs://${results.cid}`)) {
-    return `${desiredGatewayPrefix}/files/${results.cid}${path}`;
+    return `${desiredGatewayPrefix}/ipfs/${results.cid}${path}`;
   }
   if (sourceUrl.includes(`/ipfs/${results.cid}`)) {
     return `${desiredGatewayPrefix}${path}`;
@@ -1564,7 +1622,7 @@ async function convertToDesiredGateway(sourceUrl, desiredGatewayPrefix) {
     return `${desiredGatewayPrefix}${path}`;
   }
   if (urlObj.hostname.includes(results.cid)) {
-    return `${desiredGatewayPrefix}/files/${results.cid}${path}`;
+    return `${desiredGatewayPrefix}/ipfs/${results.cid}${path}`;
   }
   throw new Error(
     "unsupported URL pattern, please submit a github issue with the URL utilized"
@@ -3406,23 +3464,20 @@ var uploadCid = async (config, cid, options) => {
       Source: "sdk/cid"
     };
   }
-  const data = JSON.stringify({
-    hashToPin: cid,
-    pinataMetadata: {
-      name: options?.metadata ? options?.metadata?.name : cid,
-      keyvalues: options?.metadata?.keyvalues
-    },
-    pinataOptions: {
-      hostNodes: options?.peerAddresses ? options.peerAddresses : "",
-      groupId: options?.groupId
-    }
-  });
-  let endpoint = "https://api.pinata.cloud";
+  const requestBody = {
+    cid,
+    name: options?.metadata ? options?.metadata?.name : cid,
+    keyvalues: options?.metadata?.keyvalues,
+    group_id: options?.groupId,
+    host_nodes: options?.peerAddresses
+  };
+  const data = JSON.stringify(requestBody);
+  let endpoint = "https://api.pinata.cloud/v3";
   if (config.endpointUrl) {
     endpoint = config.endpointUrl;
   }
   try {
-    const request = await fetch(`${endpoint}/pinning/pinByHash`, {
+    const request = await fetch(`${endpoint}/files/public/pin_by_cid`, {
       method: "POST",
       headers,
       body: data
@@ -3451,12 +3506,7 @@ var uploadCid = async (config, cid, options) => {
       });
     }
     const res = await request.json();
-    const resData = {
-      id: res.id,
-      cid: res.ipfsHash,
-      name: res.name,
-      status: res.status
-    };
+    const resData = res.data;
     return resData;
   } catch (error) {
     if (error instanceof PinataError) {
@@ -4204,7 +4254,7 @@ var FilterQueue = class {
     this.config = config;
   }
   cid(cid) {
-    this.query.ipfs_pin_hash = cid;
+    this.query.cid = cid;
     return this;
   }
   status(status) {
@@ -4297,6 +4347,9 @@ var PublicFiles = class {
   queue() {
     return new FilterQueue(this.config);
   }
+  deletePinRequest(requestId) {
+    return deletePinRequest(this.config, requestId);
+  }
 };
 
 // src/core/classes/files/PrivateFiles.ts
@@ -4412,7 +4465,7 @@ var UploadBuilder = class {
     if (this.uploadUrl) {
       options.url = this.uploadUrl;
     }
-    if (this.peerAddresses && "peerAddresses" in options) {
+    if (this.peerAddresses) {
       options.peerAddresses = this.peerAddresses;
     }
     this.args[this.args.length - 1] = options;
@@ -4859,6 +4912,7 @@ var PinataSDK = class {
   deleteFile,
   deleteFileVectors,
   deleteGroup,
+  deletePinRequest,
   deleteSwap,
   formatConfig,
   getCid,