pinata 0.3.4 → 0.4.0

package/dist/index.d.mts

@@ -124,6 +124,19 @@ type GetCIDResponse = {
     data?: JSON | string | Blob | null;
     contentType: ContentType;
 };
+type OptimizeImageOptions = {
+    width?: number;
+    height?: number;
+    dpr?: number;
+    fit?: "scaleDown" | "contain" | "cover" | "crop" | "pad";
+    gravity?: "auto" | "side" | string;
+    quality?: number;
+    format?: "auto" | "webp";
+    animation?: boolean;
+    sharpen?: number;
+    onError?: boolean;
+    metadata?: "keep" | "copyright" | "none";
+};
 type GatewayAnalyticsQuery = {
     gateway_domain: string;
     start_date: string;
@@ -280,6 +293,10 @@ type SwapCidResponse = {
     mappedCid: string;
     createdAt: string;
 };
+type ContainsCIDResponse = {
+    containsCid: boolean;
+    cid: string | null;
+};
 
 declare class PinataSDK {
     config: PinataConfig | undefined;
@@ -352,8 +369,9 @@ declare class Gateways {
     config: PinataConfig | undefined;
     constructor(config?: PinataConfig);
     updateConfig(newConfig: PinataConfig): void;
-    get(cid: string): Promise<GetCIDResponse>;
-    convert(url: string): Promise<string>;
+    get(cid: string): OptimizeImage;
+    convert(url: string, gatewayPrefix?: string): Promise<string>;
+    containsCID(cid: string): Promise<ContainsCIDResponse>;
     topUsageAnalytics(options: {
         domain: string;
         start: string;
@@ -371,6 +389,14 @@ declare class Gateways {
     swapHistory(options: SwapHistoryOptions): Promise<SwapCidResponse[]>;
     deleteSwap(cid: string): Promise<string>;
 }
+declare class OptimizeImage {
+    private config;
+    private cid;
+    private options;
+    constructor(config: PinataConfig | undefined, cid: string);
+    optimizeImage(options: OptimizeImageOptions): OptimizeImage;
+    then(onfulfilled?: ((value: GetCIDResponse) => any) | null): Promise<any>;
+}
 declare class FilterPinJobs {
     private config;
     private query;
@@ -445,7 +471,7 @@ declare class FilterGroups {
     offset(offset: number): FilterGroups;
     name(nameContains: string): FilterGroups;
     limit(limit: number): FilterGroups;
-    then(onfulfilled?: ((value: GroupResponseItem[]) => any) | null): Promise<any>;
+    then(onfulfilled?: ((value: GroupResponseItem[]) => any) | null): Promise<GroupResponseItem[]>;
     private rateLimit;
     [Symbol.asyncIterator](): AsyncGenerator<GroupResponseItem, void, unknown>;
     all(): Promise<GroupResponseItem[]>;
@@ -490,4 +516,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 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 };
+export { type AuthTestResponse, type ContainsCIDResponse, 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 OptimizeImageOptions, 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

@@ -124,6 +124,19 @@ type GetCIDResponse = {
     data?: JSON | string | Blob | null;
     contentType: ContentType;
 };
+type OptimizeImageOptions = {
+    width?: number;
+    height?: number;
+    dpr?: number;
+    fit?: "scaleDown" | "contain" | "cover" | "crop" | "pad";
+    gravity?: "auto" | "side" | string;
+    quality?: number;
+    format?: "auto" | "webp";
+    animation?: boolean;
+    sharpen?: number;
+    onError?: boolean;
+    metadata?: "keep" | "copyright" | "none";
+};
 type GatewayAnalyticsQuery = {
     gateway_domain: string;
     start_date: string;
@@ -280,6 +293,10 @@ type SwapCidResponse = {
     mappedCid: string;
     createdAt: string;
 };
+type ContainsCIDResponse = {
+    containsCid: boolean;
+    cid: string | null;
+};
 
 declare class PinataSDK {
     config: PinataConfig | undefined;
@@ -352,8 +369,9 @@ declare class Gateways {
     config: PinataConfig | undefined;
     constructor(config?: PinataConfig);
     updateConfig(newConfig: PinataConfig): void;
-    get(cid: string): Promise<GetCIDResponse>;
-    convert(url: string): Promise<string>;
+    get(cid: string): OptimizeImage;
+    convert(url: string, gatewayPrefix?: string): Promise<string>;
+    containsCID(cid: string): Promise<ContainsCIDResponse>;
     topUsageAnalytics(options: {
         domain: string;
         start: string;
@@ -371,6 +389,14 @@ declare class Gateways {
     swapHistory(options: SwapHistoryOptions): Promise<SwapCidResponse[]>;
     deleteSwap(cid: string): Promise<string>;
 }
+declare class OptimizeImage {
+    private config;
+    private cid;
+    private options;
+    constructor(config: PinataConfig | undefined, cid: string);
+    optimizeImage(options: OptimizeImageOptions): OptimizeImage;
+    then(onfulfilled?: ((value: GetCIDResponse) => any) | null): Promise<any>;
+}
 declare class FilterPinJobs {
     private config;
     private query;
@@ -445,7 +471,7 @@ declare class FilterGroups {
     offset(offset: number): FilterGroups;
     name(nameContains: string): FilterGroups;
     limit(limit: number): FilterGroups;
-    then(onfulfilled?: ((value: GroupResponseItem[]) => any) | null): Promise<any>;
+    then(onfulfilled?: ((value: GroupResponseItem[]) => any) | null): Promise<GroupResponseItem[]>;
     private rateLimit;
     [Symbol.asyncIterator](): AsyncGenerator<GroupResponseItem, void, unknown>;
     all(): Promise<GroupResponseItem[]>;
@@ -490,4 +516,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 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 };
+export { type AuthTestResponse, type ContainsCIDResponse, 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 OptimizeImageOptions, 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

@@ -865,15 +865,44 @@ async function convertToDesiredGateway(sourceUrl, desiredGatewayPrefix) {
 }
 
 // src/core/gateway/getCid.ts
-var getCid = async (config, cid) => {
+var getCid = async (config, cid, options) => {
   if (!config) {
     throw new ValidationError("Pinata configuration is missing");
   }
   let data;
   let newUrl;
   newUrl = await convertToDesiredGateway(cid, config?.pinataGateway);
+  const params = new URLSearchParams();
   if (config?.pinataGatewayKey) {
-    newUrl = `${newUrl}?pinataGatewayToken=${config?.pinataGatewayKey}`;
+    params.append("pinataGatewayToken", config.pinataGatewayKey);
+  }
+  if (options) {
+    if (options.width)
+      params.append("img-width", options.width.toString());
+    if (options.height)
+      params.append("img-height", options.height.toString());
+    if (options.dpr)
+      params.append("img-dpr", options.dpr.toString());
+    if (options.fit)
+      params.append("img-fit", options.fit);
+    if (options.gravity)
+      params.append("img-gravity", options.gravity);
+    if (options.quality)
+      params.append("img-quality", options.quality.toString());
+    if (options.format)
+      params.append("img-format", options.format);
+    if (options.animation !== void 0)
+      params.append("img-anim", options.animation.toString());
+    if (options.sharpen)
+      params.append("img-sharpen", options.sharpen.toString());
+    if (options.onError === true)
+      params.append("img-onerror", "redirect");
+    if (options.metadata)
+      params.append("img-metadata", options.metadata);
+  }
+  const queryString = params.toString();
+  if (queryString) {
+    newUrl += `?${queryString}`;
   }
   try {
     const request = await fetch(newUrl);
@@ -919,9 +948,10 @@ var getCid = async (config, cid) => {
 };
 
 // src/core/gateway/convertIPFSUrl.ts
-var convertIPFSUrl = async (config, url) => {
+var convertIPFSUrl = async (config, url, gatewayPrefix) => {
   let newUrl;
-  newUrl = await convertToDesiredGateway(url, config?.pinataGateway);
+  let prefix = gatewayPrefix || config?.pinataGateway || "https://gateway.pinata.cloud";
+  newUrl = await convertToDesiredGateway(url, prefix);
   if (config?.pinataGatewayKey) {
     `${newUrl}?pinataGatewayToken=${config?.pinataGatewayKey}`;
   }
@@ -2507,10 +2537,13 @@ var Gateways = class {
     this.config = newConfig;
   }
   get(cid) {
-    return getCid(this.config, cid);
+    return new OptimizeImage(this.config, cid);
   }
-  convert(url) {
-    return convertIPFSUrl(this.config, url);
+  convert(url, gatewayPrefix) {
+    return convertIPFSUrl(this.config, url, gatewayPrefix);
+  }
+  containsCID(cid) {
+    return containsCID(cid);
   }
   topUsageAnalytics(options) {
     return new TopGatewayAnalyticsBuilder(
@@ -2541,6 +2574,20 @@ var Gateways = class {
     return deleteSwap(this.config, cid);
   }
 };
+var OptimizeImage = class {
+  constructor(config, cid) {
+    this.options = {};
+    this.config = config;
+    this.cid = cid;
+  }
+  optimizeImage(options) {
+    this.options = { ...this.options, ...options };
+    return this;
+  }
+  then(onfulfilled) {
+    return getCid(this.config, this.cid, this.options).then(onfulfilled);
+  }
+};
 var FilterPinJobs = class {
   constructor(config) {
     this.query = {};