pinata 0.3.0 → 0.3.1

package/dist/index.d.mts

@@ -268,6 +268,18 @@ type SignatureResponse = {
     cid: string;
     signature: string;
 };
+type SwapCidOptions = {
+    cid: string;
+    swapCid: string;
+};
+type SwapHistoryOptions = {
+    cid: string;
+    domain: string;
+};
+type SwapCidResponse = {
+    mappedCid: string;
+    createdAt: string;
+};
 
 declare class PinataSDK {
     config: PinataConfig | undefined;
@@ -355,6 +367,9 @@ declare class Gateways {
         end: string;
         interval: "day" | "week";
     }): TimeIntervalGatewayAnalyticsBuilder;
+    swapCid(options: SwapCidOptions): Promise<SwapCidResponse>;
+    swapHistory(options: SwapHistoryOptions): Promise<SwapCidResponse[]>;
+    deleteSwap(cid: string): Promise<string>;
 }
 declare class FilterPinJobs {
     private config;
@@ -475,4 +490,4 @@ declare class TimeIntervalGatewayAnalyticsBuilder extends GatewayAnalyticsBuilde
     all(): Promise<TimeIntervalGatewayAnalyticsResponse>;
 }
 
-export { type AuthTestResponse, type ContentType, type DataEndponts, type Endpoints, type FileObject, type GatewayAnalyticsQuery, type GetCIDResponse, type GetGroupOptions, type GroupCIDOptions, type GroupOptions, type GroupQueryOptions, type GroupResponseItem, type JsonBody, type KeyListItem, type KeyListQuery, type KeyListResponse, type KeyOptions, type KeyPermissions, type KeyResponse, type PinByCIDResponse, type PinJobItem, type PinJobQuery, type PinJobResponse, type PinListItem, type PinListQuery, type PinListResponse, type PinResponse, type PinataConfig, type PinataMetadata, type PinataMetadataUpdate, PinataSDK, type PinningEndpoints, type RevokeKeyResponse, type SignatureOptions, type SignatureResponse, type TimeIntervalGatewayAnalyticsQuery, type TimeIntervalGatewayAnalyticsResponse, type TimePeriodItem, type TopGatewayAnalyticsItem, type TopGatewayAnalyticsQuery, type UnpinResponse, type UpdateGroupOptions, type UploadCIDOptions, type UploadOptions, type UserPinnedDataResponse };
+export { type AuthTestResponse, type ContentType, type DataEndponts, type Endpoints, type FileObject, type GatewayAnalyticsQuery, type GetCIDResponse, type GetGroupOptions, type GroupCIDOptions, type GroupOptions, type GroupQueryOptions, type GroupResponseItem, type JsonBody, type KeyListItem, type KeyListQuery, type KeyListResponse, type KeyOptions, type KeyPermissions, type KeyResponse, type PinByCIDResponse, type PinJobItem, type PinJobQuery, type PinJobResponse, type PinListItem, type PinListQuery, type PinListResponse, type PinResponse, type PinataConfig, type PinataMetadata, type PinataMetadataUpdate, PinataSDK, type PinningEndpoints, type RevokeKeyResponse, type SignatureOptions, type SignatureResponse, type SwapCidOptions, type SwapCidResponse, type SwapHistoryOptions, type TimeIntervalGatewayAnalyticsQuery, type TimeIntervalGatewayAnalyticsResponse, type TimePeriodItem, type TopGatewayAnalyticsItem, type TopGatewayAnalyticsQuery, type UnpinResponse, type UpdateGroupOptions, type UploadCIDOptions, type UploadOptions, type UserPinnedDataResponse };

package/dist/index.d.ts

@@ -268,6 +268,18 @@ type SignatureResponse = {
     cid: string;
     signature: string;
 };
+type SwapCidOptions = {
+    cid: string;
+    swapCid: string;
+};
+type SwapHistoryOptions = {
+    cid: string;
+    domain: string;
+};
+type SwapCidResponse = {
+    mappedCid: string;
+    createdAt: string;
+};
 
 declare class PinataSDK {
     config: PinataConfig | undefined;
@@ -355,6 +367,9 @@ declare class Gateways {
         end: string;
         interval: "day" | "week";
     }): TimeIntervalGatewayAnalyticsBuilder;
+    swapCid(options: SwapCidOptions): Promise<SwapCidResponse>;
+    swapHistory(options: SwapHistoryOptions): Promise<SwapCidResponse[]>;
+    deleteSwap(cid: string): Promise<string>;
 }
 declare class FilterPinJobs {
     private config;
@@ -475,4 +490,4 @@ declare class TimeIntervalGatewayAnalyticsBuilder extends GatewayAnalyticsBuilde
     all(): Promise<TimeIntervalGatewayAnalyticsResponse>;
 }
 
-export { type AuthTestResponse, type ContentType, type DataEndponts, type Endpoints, type FileObject, type GatewayAnalyticsQuery, type GetCIDResponse, type GetGroupOptions, type GroupCIDOptions, type GroupOptions, type GroupQueryOptions, type GroupResponseItem, type JsonBody, type KeyListItem, type KeyListQuery, type KeyListResponse, type KeyOptions, type KeyPermissions, type KeyResponse, type PinByCIDResponse, type PinJobItem, type PinJobQuery, type PinJobResponse, type PinListItem, type PinListQuery, type PinListResponse, type PinResponse, type PinataConfig, type PinataMetadata, type PinataMetadataUpdate, PinataSDK, type PinningEndpoints, type RevokeKeyResponse, type SignatureOptions, type SignatureResponse, type TimeIntervalGatewayAnalyticsQuery, type TimeIntervalGatewayAnalyticsResponse, type TimePeriodItem, type TopGatewayAnalyticsItem, type TopGatewayAnalyticsQuery, type UnpinResponse, type UpdateGroupOptions, type UploadCIDOptions, type UploadOptions, type UserPinnedDataResponse };
+export { type AuthTestResponse, type ContentType, type DataEndponts, type Endpoints, type FileObject, type GatewayAnalyticsQuery, type GetCIDResponse, type GetGroupOptions, type GroupCIDOptions, type GroupOptions, type GroupQueryOptions, type GroupResponseItem, type JsonBody, type KeyListItem, type KeyListQuery, type KeyListResponse, type KeyOptions, type KeyPermissions, type KeyResponse, type PinByCIDResponse, type PinJobItem, type PinJobQuery, type PinJobResponse, type PinListItem, type PinListQuery, type PinListResponse, type PinResponse, type PinataConfig, type PinataMetadata, type PinataMetadataUpdate, PinataSDK, type PinningEndpoints, type RevokeKeyResponse, type SignatureOptions, type SignatureResponse, type SwapCidOptions, type SwapCidResponse, type SwapHistoryOptions, type TimeIntervalGatewayAnalyticsQuery, type TimeIntervalGatewayAnalyticsResponse, type TimePeriodItem, type TopGatewayAnalyticsItem, type TopGatewayAnalyticsQuery, type UnpinResponse, type UpdateGroupOptions, type UploadCIDOptions, type UploadOptions, type UserPinnedDataResponse };

package/dist/index.js

@@ -2079,6 +2079,207 @@ var analyticsDateInterval = async (config, options) => {
   }
 };
 
+// src/core/gateway/swapCid.ts
+var swapCid = async (config, options) => {
+  if (!config || !config.pinataJwt) {
+    throw new ValidationError("Pinata configuration or JWT is missing");
+  }
+  const data = JSON.stringify({
+    swapCid: options.swapCid
+  });
+  let headers;
+  if (config.customHeaders && Object.keys(config.customHeaders).length > 0) {
+    headers = { ...config.customHeaders };
+  } else {
+    headers = {
+      Authorization: `Bearer ${config.pinataJwt}`,
+      "Content-Type": "application/json",
+      Source: "sdk/swapCid"
+    };
+  }
+  let endpoint = "https://api.pinata.cloud";
+  if (config.endpointUrl) {
+    endpoint = config.endpointUrl;
+  }
+  try {
+    const request = await fetch(`${endpoint}/v3/ipfs/swap/${options.cid}`, {
+      method: "PUT",
+      headers,
+      body: data
+    });
+    if (!request.ok) {
+      const errorData = await request.json();
+      if (request.status === 401) {
+        throw new AuthenticationError(
+          "Authentication failed",
+          request.status,
+          errorData
+        );
+      }
+      if (request.status === 403) {
+        throw new PinataError(
+          "Unauthorized CID Swap",
+          request.status,
+          errorData
+        );
+      }
+      if (request.status === 404) {
+        throw new PinataError(
+          "CID not pinned to account",
+          request.status,
+          errorData
+        );
+      }
+      throw new NetworkError(
+        `HTTP error! status: ${request.status}`,
+        request.status,
+        errorData
+      );
+    }
+    const res = await request.json();
+    const resData = res.data;
+    return resData;
+  } catch (error) {
+    if (error instanceof PinataError) {
+      throw error;
+    }
+    if (error instanceof Error) {
+      throw new PinataError(`Error processing CID Swap: ${error.message}`);
+    }
+    throw new PinataError("An unknown error occurred while swapping CID");
+  }
+};
+
+// src/core/gateway/swapHistory.ts
+var swapHistory = async (config, options) => {
+  if (!config || !config.pinataJwt) {
+    throw new ValidationError("Pinata configuration or JWT is missing");
+  }
+  let headers;
+  if (config.customHeaders && Object.keys(config.customHeaders).length > 0) {
+    headers = { ...config.customHeaders };
+  } else {
+    headers = {
+      Authorization: `Bearer ${config.pinataJwt}`,
+      "Content-Type": "application/json",
+      Source: "sdk/swapHistory"
+    };
+  }
+  let endpoint = "https://api.pinata.cloud";
+  if (config.endpointUrl) {
+    endpoint = config.endpointUrl;
+  }
+  try {
+    const request = await fetch(
+      `${endpoint}/v3/ipfs/swap/${options.cid}?domain=${options.domain}`,
+      {
+        method: "GET",
+        headers
+      }
+    );
+    if (!request.ok) {
+      const errorData = await request.json();
+      if (request.status === 401) {
+        throw new AuthenticationError(
+          "Authentication failed",
+          request.status,
+          errorData
+        );
+      }
+      if (request.status === 404) {
+        throw new PinataError(
+          "CID does not have history",
+          request.status,
+          errorData
+        );
+      }
+      throw new NetworkError(
+        `HTTP error! status: ${request.status}`,
+        request.status,
+        errorData
+      );
+    }
+    const res = await request.json();
+    const resData = res.data;
+    return resData;
+  } catch (error) {
+    if (error instanceof PinataError) {
+      throw error;
+    }
+    if (error instanceof Error) {
+      throw new PinataError(`Error fetching swap history: ${error.message}`);
+    }
+    throw new PinataError(
+      "An unknown error occurred while fetching swap history"
+    );
+  }
+};
+
+// src/core/gateway/deleteSwap.ts
+var deleteSwap = async (config, cid) => {
+  if (!config || !config.pinataJwt) {
+    throw new ValidationError("Pinata configuration or JWT is missing");
+  }
+  let headers;
+  if (config.customHeaders && Object.keys(config.customHeaders).length > 0) {
+    headers = { ...config.customHeaders };
+  } else {
+    headers = {
+      Authorization: `Bearer ${config.pinataJwt}`,
+      "Content-Type": "application/json",
+      Source: "sdk/deleteSwap"
+    };
+  }
+  let endpoint = "https://api.pinata.cloud";
+  if (config.endpointUrl) {
+    endpoint = config.endpointUrl;
+  }
+  try {
+    const request = await fetch(`${endpoint}/v3/ipfs/swap/${cid}`, {
+      method: "DELETE",
+      headers
+    });
+    if (!request.ok) {
+      const errorData = await request.json();
+      if (request.status === 401) {
+        throw new AuthenticationError(
+          "Authentication failed",
+          request.status,
+          errorData
+        );
+      }
+      if (request.status === 403) {
+        throw new PinataError(
+          "Unauthorized CID Swap Deletion",
+          request.status,
+          errorData
+        );
+      }
+      if (request.status === 404) {
+        throw new PinataError(
+          "CID not pinned to account",
+          request.status,
+          errorData
+        );
+      }
+      throw new NetworkError(
+        `HTTP error! status: ${request.status}`,
+        request.status,
+        errorData
+      );
+    }
+    return request.statusText;
+  } catch (error) {
+    if (error instanceof PinataError) {
+      throw error;
+    }
+    if (error instanceof Error) {
+      throw new PinataError(`Error processing deleteSwap: ${error.message}`);
+    }
+    throw new PinataError("An unknown error occurred while deleting swap");
+  }
+};
+
 // src/core/pinataSDK.ts
 var formatConfig = (config) => {
   let gateway = config?.pinataGateway;
@@ -2335,6 +2536,15 @@ var Gateways = class {
       options.interval
     );
   }
+  swapCid(options) {
+    return swapCid(this.config, options);
+  }
+  swapHistory(options) {
+    return swapHistory(this.config, options);
+  }
+  deleteSwap(cid) {
+    return deleteSwap(this.config, cid);
+  }
 };
 var FilterPinJobs = class {
   constructor(config) {