pinata 1.5.0 → 1.7.0

package/dist/index.d.mts

@@ -30,6 +30,7 @@ type FileObject = {
 type JsonBody = Record<string, unknown>;
 type PinataMetadata = {
     name?: string;
+    keyvalues?: Record<string, string>;
 };
 type UpdateFileOptions = {
     id: string;
@@ -63,6 +64,7 @@ type FileListResponse = {
 type FileListQuery = {
     name?: string;
     group?: string;
+    noGroup?: boolean;
     mimeType?: string;
     cid?: string;
     cidPending?: boolean;
@@ -261,7 +263,11 @@ type GroupQueryOptions = {
 };
 type GroupCIDOptions = {
     groupId: string;
-    cids: string[];
+    files: string[];
+};
+type UpdateGroupFilesResponse = {
+    id: string;
+    status: string;
 };
 type SignatureOptions = {
     cid: string;
@@ -346,6 +352,7 @@ declare class 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;
@@ -403,6 +410,8 @@ declare class Groups {
     create(options: GroupOptions): Promise<GroupResponseItem>;
     list(): FilterGroups;
     get(options: GetGroupOptions): Promise<GroupResponseItem>;
+    addFiles(options: GroupCIDOptions): Promise<UpdateGroupFilesResponse[]>;
+    removeFiles(options: GroupCIDOptions): Promise<UpdateGroupFilesResponse[]>;
     update(options: UpdateGroupOptions): Promise<GroupResponseItem>;
     delete(options: GetGroupOptions): Promise<string>;
 }
@@ -421,4 +430,4 @@ declare class FilterGroups {
     all(): Promise<GroupResponseItem[]>;
 }
 
-export { type AuthTestResponse, type ContainsCIDResponse, type ContentType, type DataEndponts, type DeleteResponse, type Endpoints, type FileListItem, type FileListQuery, type FileListResponse, type FileObject, type GatewayAnalyticsQuery, 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 TimeIntervalGatewayAnalyticsQuery, type TimeIntervalGatewayAnalyticsResponse, type TimePeriodItem, type TopGatewayAnalyticsItem, type TopGatewayAnalyticsQuery, type UpdateFileOptions, type UpdateGroupOptions, type UploadOptions, type UploadResponse, type UserPinnedDataResponse };
+export { type AuthTestResponse, type ContainsCIDResponse, type ContentType, type DataEndponts, type DeleteResponse, type Endpoints, type FileListItem, type FileListQuery, type FileListResponse, type FileObject, type GatewayAnalyticsQuery, 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 TimeIntervalGatewayAnalyticsQuery, type TimeIntervalGatewayAnalyticsResponse, type TimePeriodItem, type TopGatewayAnalyticsItem, type TopGatewayAnalyticsQuery, type UpdateFileOptions, type UpdateGroupFilesResponse, type UpdateGroupOptions, type UploadOptions, type UploadResponse, type UserPinnedDataResponse };

package/dist/index.d.ts

@@ -30,6 +30,7 @@ type FileObject = {
 type JsonBody = Record<string, unknown>;
 type PinataMetadata = {
     name?: string;
+    keyvalues?: Record<string, string>;
 };
 type UpdateFileOptions = {
     id: string;
@@ -63,6 +64,7 @@ type FileListResponse = {
 type FileListQuery = {
     name?: string;
     group?: string;
+    noGroup?: boolean;
     mimeType?: string;
     cid?: string;
     cidPending?: boolean;
@@ -261,7 +263,11 @@ type GroupQueryOptions = {
 };
 type GroupCIDOptions = {
     groupId: string;
-    cids: string[];
+    files: string[];
+};
+type UpdateGroupFilesResponse = {
+    id: string;
+    status: string;
 };
 type SignatureOptions = {
     cid: string;
@@ -346,6 +352,7 @@ declare class 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;
@@ -403,6 +410,8 @@ declare class Groups {
     create(options: GroupOptions): Promise<GroupResponseItem>;
     list(): FilterGroups;
     get(options: GetGroupOptions): Promise<GroupResponseItem>;
+    addFiles(options: GroupCIDOptions): Promise<UpdateGroupFilesResponse[]>;
+    removeFiles(options: GroupCIDOptions): Promise<UpdateGroupFilesResponse[]>;
     update(options: UpdateGroupOptions): Promise<GroupResponseItem>;
     delete(options: GetGroupOptions): Promise<string>;
 }
@@ -421,4 +430,4 @@ declare class FilterGroups {
     all(): Promise<GroupResponseItem[]>;
 }
 
-export { type AuthTestResponse, type ContainsCIDResponse, type ContentType, type DataEndponts, type DeleteResponse, type Endpoints, type FileListItem, type FileListQuery, type FileListResponse, type FileObject, type GatewayAnalyticsQuery, 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 TimeIntervalGatewayAnalyticsQuery, type TimeIntervalGatewayAnalyticsResponse, type TimePeriodItem, type TopGatewayAnalyticsItem, type TopGatewayAnalyticsQuery, type UpdateFileOptions, type UpdateGroupOptions, type UploadOptions, type UploadResponse, type UserPinnedDataResponse };
+export { type AuthTestResponse, type ContainsCIDResponse, type ContentType, type DataEndponts, type DeleteResponse, type Endpoints, type FileListItem, type FileListQuery, type FileListResponse, type FileObject, type GatewayAnalyticsQuery, 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 TimeIntervalGatewayAnalyticsQuery, type TimeIntervalGatewayAnalyticsResponse, type TimePeriodItem, type TopGatewayAnalyticsItem, type TopGatewayAnalyticsQuery, type UpdateFileOptions, type UpdateGroupFilesResponse, type UpdateGroupOptions, type UploadOptions, type UploadResponse, type UserPinnedDataResponse };

package/dist/index.js

@@ -122,6 +122,9 @@ 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 = {
@@ -188,6 +191,9 @@ 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 = {
@@ -266,6 +272,9 @@ 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 = {
@@ -332,6 +341,9 @@ 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 = {
@@ -470,7 +482,8 @@ var listFiles = async (config, options) => {
       mimeType,
       pageToken,
       cidPending,
-      metadata
+      metadata,
+      noGroup
     } = options;
     if (limit)
       params.append("limit", limit.toString());
@@ -488,6 +501,8 @@ 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());
@@ -1125,6 +1140,82 @@ var getGroup = async (config, options) => {
   }
 };
 
+// src/core/groups/addToGroup.ts
+var addToGroup = async (config, options) => {
+  if (!config) {
+    throw new ValidationError("Pinata configuration is missing");
+  }
+  const wait3 = (milliseconds) => {
+    return new Promise((resolve) => {
+      setTimeout(resolve, milliseconds);
+    });
+  };
+  const responses = [];
+  let headers;
+  if (config.customHeaders && Object.keys(config.customHeaders).length > 0) {
+    headers = {
+      Authorization: `Bearer ${config.pinataJwt}`,
+      "Content-Type": "application/json",
+      ...config.customHeaders
+    };
+  } else {
+    headers = {
+      Authorization: `Bearer ${config.pinataJwt}`,
+      "Content-Type": "application/json",
+      Source: "sdk/addToGroup"
+    };
+  }
+  let endpoint = "https://api.pinata.cloud/v3";
+  if (config.endpointUrl) {
+    endpoint = config.endpointUrl;
+  }
+  for (const id of options.files) {
+    try {
+      const response = await fetch(
+        `${endpoint}/files/groups/${options.groupId}/ids/${id}`,
+        {
+          method: "PUT",
+          headers
+        }
+      );
+      await wait3(300);
+      if (!response.ok) {
+        const errorData = await response.text();
+        if (response.status === 401) {
+          throw new AuthenticationError(
+            `Authentication failed: ${errorData}`,
+            response.status,
+            errorData
+          );
+        }
+        throw new NetworkError(
+          `HTTP error: ${errorData}`,
+          response.status,
+          errorData
+        );
+      }
+      responses.push({
+        id,
+        status: response.statusText
+      });
+    } catch (error) {
+      let errorMessage;
+      if (error instanceof PinataError) {
+        errorMessage = error.message;
+      } else if (error instanceof Error) {
+        errorMessage = `Error adding file ${id} to group: ${error.message}`;
+      } else {
+        errorMessage = `An unknown error occurred while adding file ${id} to group`;
+      }
+      responses.push({
+        id,
+        status: errorMessage
+      });
+    }
+  }
+  return responses;
+};
+
 // src/core/groups/updateGroup.ts
 var updateGroup = async (config, options) => {
   if (!config) {
@@ -1187,6 +1278,82 @@ var updateGroup = async (config, options) => {
   }
 };
 
+// src/core/groups/removeFromGroup.ts
+var removeFromGroup = async (config, options) => {
+  if (!config) {
+    throw new ValidationError("Pinata configuration is missing");
+  }
+  const wait3 = (milliseconds) => {
+    return new Promise((resolve) => {
+      setTimeout(resolve, milliseconds);
+    });
+  };
+  const responses = [];
+  let headers;
+  if (config.customHeaders && Object.keys(config.customHeaders).length > 0) {
+    headers = {
+      Authorization: `Bearer ${config.pinataJwt}`,
+      "Content-Type": "application/json",
+      ...config.customHeaders
+    };
+  } else {
+    headers = {
+      Authorization: `Bearer ${config.pinataJwt}`,
+      "Content-Type": "application/json",
+      Source: "sdk/addToGroup"
+    };
+  }
+  let endpoint = "https://api.pinata.cloud/v3";
+  if (config.endpointUrl) {
+    endpoint = config.endpointUrl;
+  }
+  for (const id of options.files) {
+    try {
+      const response = await fetch(
+        `${endpoint}/files/groups/${options.groupId}/ids/${id}`,
+        {
+          method: "DELETE",
+          headers
+        }
+      );
+      await wait3(300);
+      if (!response.ok) {
+        const errorData = await response.text();
+        if (response.status === 401) {
+          throw new AuthenticationError(
+            `Authentication failed: ${errorData}`,
+            response.status,
+            errorData
+          );
+        }
+        throw new NetworkError(
+          `HTTP error: ${errorData}`,
+          response.status,
+          errorData
+        );
+      }
+      responses.push({
+        id,
+        status: response.statusText
+      });
+    } catch (error) {
+      let errorMessage;
+      if (error instanceof PinataError) {
+        errorMessage = error.message;
+      } else if (error instanceof Error) {
+        errorMessage = `Error adding file ${id} to group: ${error.message}`;
+      } else {
+        errorMessage = `An unknown error occurred while adding file ${id} to group`;
+      }
+      responses.push({
+        id,
+        status: errorMessage
+      });
+    }
+  }
+  return responses;
+};
+
 // src/core/groups/deleteGroup.ts
 var deleteGroup = async (config, options) => {
   if (!config) {
@@ -1740,6 +1907,10 @@ var FilterFiles = class {
     this.query.metadata = keyvalues;
     return this;
   }
+  noGroup(noGroup) {
+    this.query.noGroup = noGroup;
+    return this;
+  }
   pageToken(pageToken) {
     this.query.pageToken = pageToken;
     return this;
@@ -1971,12 +2142,12 @@ var Groups = class {
   get(options) {
     return getGroup(this.config, options);
   }
-  // addFiles(options: GroupCIDOptions): Promise<string> {
-  // 	return addToGroup(this.config, options);
-  // }
-  // removeFiles(options: GroupCIDOptions): Promise<string> {
-  // 	return removeFromGroup(this.config, options);
-  // }
+  addFiles(options) {
+    return addToGroup(this.config, options);
+  }
+  removeFiles(options) {
+    return removeFromGroup(this.config, options);
+  }
   update(options) {
     return updateGroup(this.config, options);
   }