pinata 1.8.0 → 1.9.0

package/dist/index.d.mts

@@ -19,6 +19,8 @@ type UploadResponse = {
     mime_type: string;
     user_id: string;
     group_id: string | null;
+    is_duplicate: true | null;
+    vectorized: true | null;
 };
 type FileObject = {
     name: string;
@@ -41,6 +43,7 @@ type UploadOptions = {
     metadata?: PinataMetadata;
     keys?: string;
     groupId?: string;
+    vectorize?: boolean;
 };
 type DeleteResponse = {
     id: string;
@@ -296,6 +299,23 @@ type ContainsCIDResponse = {
     containsCid: boolean;
     cid: string | null;
 };
+type VectorizeFileResponse = {
+    status: boolean;
+};
+type VectorizeQuery = {
+    groupId: string;
+    query: string;
+    returnFile?: boolean;
+};
+type VectorQueryMatch = {
+    file_id: string;
+    cid: string;
+    score: number;
+};
+type VectorizeQueryResponse = {
+    count: number;
+    matches: VectorQueryMatch[];
+};
 
 declare class PinataSDK {
     config: PinataConfig | undefined;
@@ -320,6 +340,9 @@ declare class Files {
     addSwap(options: SwapCidOptions): Promise<SwapCidResponse>;
     getSwapHistory(options: SwapHistoryOptions): Promise<SwapCidResponse[]>;
     deleteSwap(cid: string): Promise<string>;
+    vectorize(fileId: string): Promise<VectorizeFileResponse>;
+    queryVectors(options: VectorizeQuery): Promise<VectorizeQueryResponse | GetCIDResponse>;
+    deleteVectors(fileId: string): Promise<VectorizeFileResponse>;
 }
 declare class UploadBuilder<T> {
     private config;
@@ -328,9 +351,11 @@ declare class UploadBuilder<T> {
     private metadata;
     private keys;
     private groupId;
+    private vector;
     constructor(config: PinataConfig | undefined, uploadFunction: (config: PinataConfig | undefined, ...args: any[]) => Promise<T>, ...args: any[]);
     addMetadata(metadata: PinataMetadata): UploadBuilder<T>;
     key(jwt: string): UploadBuilder<T>;
+    vectorize(): UploadBuilder<T>;
     group(groupId: string): UploadBuilder<T>;
     then<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null | undefined, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null | undefined): Promise<TResult1 | TResult2>;
 }
@@ -499,4 +524,4 @@ declare class TimeIntervalAnalyticsBuilder extends AnalyticsBuilder<TimeInterval
     all(): Promise<TimeIntervalAnalyticsResponse>;
 }
 
-export { type AnalyticsQuery, type AuthTestResponse, 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, type OptimizeImageOptions, type PinJobItem, type PinJobQuery, type PinJobResponse, type PinataConfig, type PinataMetadata, PinataSDK, type PinningEndpoints, type RevokeKeyResponse, type SignatureOptions, type SignatureResponse, type SignedUrlOptions, 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 UploadOptions, type UploadResponse, type UserPinnedDataResponse };
+export { type AnalyticsQuery, type AuthTestResponse, 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, type OptimizeImageOptions, type PinJobItem, type PinJobQuery, type PinJobResponse, type PinataConfig, type PinataMetadata, PinataSDK, type PinningEndpoints, type RevokeKeyResponse, type SignatureOptions, type SignatureResponse, type SignedUrlOptions, 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 UploadOptions, type UploadResponse, type UserPinnedDataResponse, type VectorQueryMatch, type VectorizeFileResponse, type VectorizeQuery, type VectorizeQueryResponse };

package/dist/index.d.ts

@@ -19,6 +19,8 @@ type UploadResponse = {
     mime_type: string;
     user_id: string;
     group_id: string | null;
+    is_duplicate: true | null;
+    vectorized: true | null;
 };
 type FileObject = {
     name: string;
@@ -41,6 +43,7 @@ type UploadOptions = {
     metadata?: PinataMetadata;
     keys?: string;
     groupId?: string;
+    vectorize?: boolean;
 };
 type DeleteResponse = {
     id: string;
@@ -296,6 +299,23 @@ type ContainsCIDResponse = {
     containsCid: boolean;
     cid: string | null;
 };
+type VectorizeFileResponse = {
+    status: boolean;
+};
+type VectorizeQuery = {
+    groupId: string;
+    query: string;
+    returnFile?: boolean;
+};
+type VectorQueryMatch = {
+    file_id: string;
+    cid: string;
+    score: number;
+};
+type VectorizeQueryResponse = {
+    count: number;
+    matches: VectorQueryMatch[];
+};
 
 declare class PinataSDK {
     config: PinataConfig | undefined;
@@ -320,6 +340,9 @@ declare class Files {
     addSwap(options: SwapCidOptions): Promise<SwapCidResponse>;
     getSwapHistory(options: SwapHistoryOptions): Promise<SwapCidResponse[]>;
     deleteSwap(cid: string): Promise<string>;
+    vectorize(fileId: string): Promise<VectorizeFileResponse>;
+    queryVectors(options: VectorizeQuery): Promise<VectorizeQueryResponse | GetCIDResponse>;
+    deleteVectors(fileId: string): Promise<VectorizeFileResponse>;
 }
 declare class UploadBuilder<T> {
     private config;
@@ -328,9 +351,11 @@ declare class UploadBuilder<T> {
     private metadata;
     private keys;
     private groupId;
+    private vector;
     constructor(config: PinataConfig | undefined, uploadFunction: (config: PinataConfig | undefined, ...args: any[]) => Promise<T>, ...args: any[]);
     addMetadata(metadata: PinataMetadata): UploadBuilder<T>;
     key(jwt: string): UploadBuilder<T>;
+    vectorize(): UploadBuilder<T>;
     group(groupId: string): UploadBuilder<T>;
     then<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null | undefined, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null | undefined): Promise<TResult1 | TResult2>;
 }
@@ -499,4 +524,4 @@ declare class TimeIntervalAnalyticsBuilder extends AnalyticsBuilder<TimeInterval
     all(): Promise<TimeIntervalAnalyticsResponse>;
 }
 
-export { type AnalyticsQuery, type AuthTestResponse, 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, type OptimizeImageOptions, type PinJobItem, type PinJobQuery, type PinJobResponse, type PinataConfig, type PinataMetadata, PinataSDK, type PinningEndpoints, type RevokeKeyResponse, type SignatureOptions, type SignatureResponse, type SignedUrlOptions, 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 UploadOptions, type UploadResponse, type UserPinnedDataResponse };
+export { type AnalyticsQuery, type AuthTestResponse, 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, type OptimizeImageOptions, type PinJobItem, type PinJobQuery, type PinJobResponse, type PinataConfig, type PinataMetadata, PinataSDK, type PinningEndpoints, type RevokeKeyResponse, type SignatureOptions, type SignatureResponse, type SignedUrlOptions, 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 UploadOptions, type UploadResponse, type UserPinnedDataResponse, type VectorQueryMatch, type VectorizeFileResponse, type VectorizeQuery, type VectorizeQueryResponse };

package/dist/index.js

@@ -198,11 +198,33 @@ var uploadFile = async (config, file, options) => {
       const fileInfoReq = await fetch(`${dataEndpoint}/files/${fileId}`, {
         method: "GET",
         headers: {
-          Authorization: `Bearer ${process.env.PINATA_JWT}`
+          Authorization: `Bearer ${jwt}`
         }
       });
       const fileInfo = await fileInfoReq.json();
       const data2 = fileInfo.data;
+      if (options?.vectorize) {
+        const vectorReq = await fetch(
+          `${endpoint}/vectorize/files/${data2.id}`,
+          {
+            method: "POST",
+            headers: {
+              Authorization: `Bearer ${jwt}`
+            }
+          }
+        );
+        if (vectorReq.ok) {
+          data2.vectorized = true;
+          return data2;
+        } else {
+          const errorData = await vectorReq.text();
+          throw new NetworkError(
+            `HTTP error during vectorization: ${errorData}`,
+            vectorReq.status,
+            errorData
+          );
+        }
+      }
       return data2;
     }
   }
@@ -250,6 +272,28 @@ var uploadFile = async (config, file, options) => {
     }
     const res = await request.json();
     const resData = res.data;
+    if (options?.vectorize) {
+      const vectorReq = await fetch(
+        `${endpoint}/vectorize/files/${resData.id}`,
+        {
+          method: "POST",
+          headers: {
+            Authorization: `Bearer ${jwt}`
+          }
+        }
+      );
+      if (vectorReq.ok) {
+        resData.vectorized = true;
+        return resData;
+      } else {
+        const errorData = await vectorReq.text();
+        throw new NetworkError(
+          `HTTP error during vectorization: ${errorData}`,
+          vectorReq.status,
+          errorData
+        );
+      }
+    }
     return resData;
   } catch (error) {
     if (error instanceof PinataError) {
@@ -319,6 +363,28 @@ var uploadBase64 = async (config, base64String, options) => {
     }
     const res = await request.json();
     const resData = res.data;
+    if (options?.vectorize) {
+      const vectorReq = await fetch(
+        `${endpoint}/vectorize/files/${resData.id}`,
+        {
+          method: "POST",
+          headers: {
+            Authorization: `Bearer ${jwt}`
+          }
+        }
+      );
+      if (vectorReq.ok) {
+        resData.vectorized = true;
+        return resData;
+      } else {
+        const errorData = await vectorReq.text();
+        throw new NetworkError(
+          `HTTP error during vectorization: ${errorData}`,
+          vectorReq.status,
+          errorData
+        );
+      }
+    }
     return resData;
   } catch (error) {
     if (error instanceof PinataError) {
@@ -400,6 +466,28 @@ var uploadUrl = async (config, url, options) => {
     }
     const res = await request.json();
     const resData = res.data;
+    if (options?.vectorize) {
+      const vectorReq = await fetch(
+        `${endpoint}/vectorize/files/${resData.id}`,
+        {
+          method: "POST",
+          headers: {
+            Authorization: `Bearer ${jwt}`
+          }
+        }
+      );
+      if (vectorReq.ok) {
+        resData.vectorized = true;
+        return resData;
+      } else {
+        const errorData = await vectorReq.text();
+        throw new NetworkError(
+          `HTTP error during vectorization: ${errorData}`,
+          vectorReq.status,
+          errorData
+        );
+      }
+    }
     return resData;
   } catch (error) {
     if (error instanceof PinataError) {
@@ -469,6 +557,28 @@ var uploadJson = async (config, jsonData, options) => {
     }
     const res = await request.json();
     const resData = res.data;
+    if (options?.vectorize) {
+      const vectorReq = await fetch(
+        `${endpoint}/vectorize/files/${resData.id}`,
+        {
+          method: "POST",
+          headers: {
+            Authorization: `Bearer ${jwt}`
+          }
+        }
+      );
+      if (vectorReq.ok) {
+        resData.vectorized = true;
+        return resData;
+      } else {
+        const errorData = await vectorReq.text();
+        throw new NetworkError(
+          `HTTP error during vectorization: ${errorData}`,
+          vectorReq.status,
+          errorData
+        );
+      }
+    }
     return resData;
   } catch (error) {
     if (error instanceof PinataError) {
@@ -2016,6 +2126,191 @@ var createSignedURL = async (config, options, imgOpts) => {
   }
 };
 
+// src/core/files/vectorizeFile.ts
+var vectorizeFile = async (config, fileId) => {
+  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/vectorizeFile"
+    };
+  }
+  let endpoint = "https://uploads.pinata.cloud/v3";
+  if (config.uploadUrl) {
+    endpoint = config.uploadUrl;
+  }
+  try {
+    const request = await fetch(`${endpoint}/vectorize/files/${fileId}`, {
+      method: "POST",
+      headers
+    });
+    if (!request.ok) {
+      const errorData = await request.text();
+      if (request.status === 401 || request.status === 403) {
+        throw new AuthenticationError(
+          `Authentication failed: ${errorData}`,
+          request.status,
+          errorData
+        );
+      }
+      throw new NetworkError(
+        `HTTP error: ${errorData}`,
+        request.status,
+        errorData
+      );
+    }
+    const res = await request.json();
+    return res;
+  } catch (error) {
+    if (error instanceof PinataError) {
+      throw error;
+    }
+    if (error instanceof Error) {
+      throw new PinataError(
+        `Error processing vectorize file: ${error.message}`
+      );
+    }
+    throw new PinataError("An unknown error occurred while vectorizing file");
+  }
+};
+
+// src/core/files/vectorizeQuery.ts
+var vectorizeQuery = async (config, options) => {
+  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/vectorQuery"
+    };
+  }
+  let endpoint = "https://uploads.pinata.cloud/v3";
+  if (config.uploadUrl) {
+    endpoint = config.uploadUrl;
+  }
+  const body = JSON.stringify({
+    text: options.query
+  });
+  try {
+    const request = await fetch(
+      `${endpoint}/vectorize/groups/${options.groupId}/query`,
+      {
+        method: "POST",
+        headers,
+        body
+      }
+    );
+    if (!request.ok) {
+      const errorData = await request.text();
+      if (request.status === 401 || request.status === 403) {
+        throw new AuthenticationError(
+          `Authentication failed: ${errorData}`,
+          request.status,
+          errorData
+        );
+      }
+      throw new NetworkError(
+        `HTTP error: ${errorData}`,
+        request.status,
+        errorData
+      );
+    }
+    const res = await request.json();
+    const resData = res.data;
+    if (options.returnFile) {
+      if (resData.matches.length === 0) {
+        throw new PinataError(`No files returned in query to fetch`);
+      }
+      console.log(config.pinataGateway);
+      const cid = resData.matches[0].cid;
+      const fileRes = await getCid(config, cid, void 0);
+      return fileRes;
+    }
+    return resData;
+  } catch (error) {
+    if (error instanceof PinataError) {
+      throw error;
+    }
+    if (error instanceof Error) {
+      throw new PinataError(
+        `Error processing vectorize file: ${error.message}`
+      );
+    }
+    throw new PinataError("An unknown error occurred while vectorizing file");
+  }
+};
+
+// src/core/files/deleteFileVectors.ts
+var deleteFileVectors = async (config, fileId) => {
+  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/vectorizeFile"
+    };
+  }
+  let endpoint = "https://uploads.pinata.cloud/v3";
+  if (config.uploadUrl) {
+    endpoint = config.uploadUrl;
+  }
+  try {
+    const request = await fetch(`${endpoint}/vectorize/files/${fileId}`, {
+      method: "DELETE",
+      headers
+    });
+    if (!request.ok) {
+      const errorData = await request.text();
+      if (request.status === 401 || request.status === 403) {
+        throw new AuthenticationError(
+          `Authentication failed: ${errorData}`,
+          request.status,
+          errorData
+        );
+      }
+      throw new NetworkError(
+        `HTTP error: ${errorData}`,
+        request.status,
+        errorData
+      );
+    }
+    const res = await request.json();
+    return res;
+  } catch (error) {
+    if (error instanceof PinataError) {
+      throw error;
+    }
+    if (error instanceof Error) {
+      throw new PinataError(
+        `Error processing vectorize file: ${error.message}`
+      );
+    }
+    throw new PinataError("An unknown error occurred while vectorizing file");
+  }
+};
+
 // src/core/pinataSDK.ts
 var formatConfig = (config) => {
   let gateway = config?.pinataGateway;
@@ -2091,6 +2386,15 @@ var Files = class {
   deleteSwap(cid) {
     return deleteSwap(this.config, cid);
   }
+  vectorize(fileId) {
+    return vectorizeFile(this.config, fileId);
+  }
+  queryVectors(options) {
+    return vectorizeQuery(this.config, options);
+  }
+  deleteVectors(fileId) {
+    return deleteFileVectors(this.config, fileId);
+  }
 };
 var UploadBuilder = class {
   constructor(config, uploadFunction, ...args) {
@@ -2106,6 +2410,10 @@ var UploadBuilder = class {
     this.keys = jwt;
     return this;
   }
+  vectorize() {
+    this.vector = true;
+    return this;
+  }
   // cidVersion(v: 0 | 1): UploadBuilder<T> {
   // 	this.version = v;
   // 	return this;
@@ -2125,6 +2433,9 @@ var UploadBuilder = class {
     if (this.groupId) {
       options.groupId = this.groupId;
     }
+    if (this.vector) {
+      options.vectorize = this.vector;
+    }
     this.args[this.args.length - 1] = options;
     return this.uploadFunction(this.config, ...this.args).then(
       onfulfilled,
@@ -2265,42 +2576,6 @@ var Gateways = class {
   createSignedURL(options) {
     return new OptimizeImageCreateSignedURL(this.config, options);
   }
-  // topUsageAnalytics(options: {
-  // 	domain: string;
-  // 	start: string;
-  // 	end: string;
-  // 	sortBy: "requests" | "bandwidth";
-  // 	attribute:
-  // 		| "cid"
-  // 		| "country"
-  // 		| "region"
-  // 		| "user_agent"
-  // 		| "referer"
-  // 		| "file_name";
-  // }): TopGatewayAnalyticsBuilder {
-  // 	return new TopGatewayAnalyticsBuilder(
-  // 		this.config,
-  // 		options.domain,
-  // 		options.start,
-  // 		options.end,
-  // 		options.sortBy,
-  // 		options.attribute,
-  // 	);
-  // }
-  // dateIntervalAnalytics(options: {
-  // 	domain: string;
-  // 	start: string;
-  // 	end: string;
-  // 	interval: "day" | "week";
-  // }): TimeIntervalGatewayAnalyticsBuilder {
-  // 	return new TimeIntervalGatewayAnalyticsBuilder(
-  // 		this.config,
-  // 		options.domain,
-  // 		options.start,
-  // 		options.end,
-  // 		options.interval,
-  // 	);
-  // }
 };
 var OptimizeImageGetCid = class {
   constructor(config, cid) {
@@ -2526,28 +2801,6 @@ var Analytics = class {
     this.requests.updateConfig(newConfig);
     this.bandwidth.updateConfig(newConfig);
   }
-  // detailed(options: {
-  // 	domain: string;
-  // 	start: string;
-  // 	end: string;
-  // 	sortBy: "requests" | "bandwidth";
-  // 	attribute:
-  // 		| "cid"
-  // 		| "country"
-  // 		| "region"
-  // 		| "user_agent"
-  // 		| "referer"
-  // 		| "file_name";
-  // }): TopAnalyticsBuilder {
-  // 	return new TopAnalyticsBuilder(
-  // 		this.config,
-  // 		options.domain,
-  // 		options.start,
-  // 		options.end,
-  // 		options.sortBy,
-  // 		options.attribute,
-  // 	);
-  // }
   summary(options) {
     return new TimeIntervalAnalyticsBuilder(
       this.config,