pinata 2.1.2 → 2.2.0

package/dist/index.d.mts

@@ -227,7 +227,9 @@ type UpdateGroupFilesResponse = {
 type KeyPermissions = {
     admin?: boolean;
     endpoints?: Endpoints;
+    resources?: ResourcePermission[];
 };
+type ResourcePermission = "org:read" | "org:write" | "org:files:read" | "org:files:write" | "org:groups:read" | "org:groups:write" | "org:gateways:read" | "org:gateways:write" | "org:analytics:read" | "org:analytics:write";
 type Endpoints = {
     data?: DataEndponts;
     pinning?: PinningEndpoints;
@@ -334,6 +336,8 @@ type SignedUploadUrlOptions = {
     name?: string;
     keyvalues?: Record<string, string>;
     vectorize?: boolean;
+    maxFileSize?: number;
+    mimeTypes?: string[];
 };
 type UploadCIDOptions = {
     metadata?: PinataMetadata;
@@ -727,7 +731,7 @@ declare class PrivateUpload {
     config: PinataConfig | undefined;
     constructor(config?: PinataConfig);
     updateConfig(newConfig: PinataConfig): void;
-    file(file: FileObject, options?: UploadOptions): UploadBuilder<UploadResponse>;
+    file(file: File, options?: UploadOptions): UploadBuilder<UploadResponse>;
     base64(base64String: string, options?: UploadOptions): UploadBuilder<UploadResponse>;
     url(url: string, options?: UploadOptions): UploadBuilder<UploadResponse>;
     json(data: object, options?: UploadOptions): UploadBuilder<UploadResponse>;
@@ -800,4 +804,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, 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 };
+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 ResourcePermission, 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

@@ -227,7 +227,9 @@ type UpdateGroupFilesResponse = {
 type KeyPermissions = {
     admin?: boolean;
     endpoints?: Endpoints;
+    resources?: ResourcePermission[];
 };
+type ResourcePermission = "org:read" | "org:write" | "org:files:read" | "org:files:write" | "org:groups:read" | "org:groups:write" | "org:gateways:read" | "org:gateways:write" | "org:analytics:read" | "org:analytics:write";
 type Endpoints = {
     data?: DataEndponts;
     pinning?: PinningEndpoints;
@@ -334,6 +336,8 @@ type SignedUploadUrlOptions = {
     name?: string;
     keyvalues?: Record<string, string>;
     vectorize?: boolean;
+    maxFileSize?: number;
+    mimeTypes?: string[];
 };
 type UploadCIDOptions = {
     metadata?: PinataMetadata;
@@ -727,7 +731,7 @@ declare class PrivateUpload {
     config: PinataConfig | undefined;
     constructor(config?: PinataConfig);
     updateConfig(newConfig: PinataConfig): void;
-    file(file: FileObject, options?: UploadOptions): UploadBuilder<UploadResponse>;
+    file(file: File, options?: UploadOptions): UploadBuilder<UploadResponse>;
     base64(base64String: string, options?: UploadOptions): UploadBuilder<UploadResponse>;
     url(url: string, options?: UploadOptions): UploadBuilder<UploadResponse>;
     json(data: object, options?: UploadOptions): UploadBuilder<UploadResponse>;
@@ -800,4 +804,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, 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 };
+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 ResourcePermission, 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

@@ -18,8 +18,8 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
-var src_exports = {};
-__export(src_exports, {
+var index_exports = {};
+__export(index_exports, {
   AuthenticationError: () => AuthenticationError,
   NetworkError: () => NetworkError,
   PinataError: () => PinataError,
@@ -66,7 +66,7 @@ __export(src_exports, {
   vectorizeFile: () => vectorizeFile,
   vectorizeQuery: () => vectorizeQuery
 });
-module.exports = __toCommonJS(src_exports);
+module.exports = __toCommonJS(index_exports);
 
 // src/utils/custom-errors.ts
 var PinataError = class extends Error {
@@ -118,32 +118,19 @@ var analyticsDateInterval = async (config, options) => {
       date_interval,
       sort_by
     } = options;
-    if (cid)
-      params.append("cid", cid);
-    if (gateway_domain)
-      params.append("gateway_domain", gateway_domain);
-    if (start_date)
-      params.append("start_date", start_date);
-    if (end_date)
-      params.append("end_date", end_date);
-    if (file_name)
-      params.append("file_name", file_name);
-    if (user_agent)
-      params.append("user_agent", user_agent.toString());
-    if (country)
-      params.append("country", country.toString());
-    if (region)
-      params.append("region", region);
-    if (referer)
-      params.append("referer", referer.toString());
-    if (limit)
-      params.append("limit", limit.toString());
-    if (sort_order)
-      params.append("sort_order", sort_order);
-    if (sort_by)
-      params.append("sort_by", sort_by);
-    if (date_interval)
-      params.append("by", date_interval);
+    if (cid) params.append("cid", cid);
+    if (gateway_domain) params.append("gateway_domain", gateway_domain);
+    if (start_date) params.append("start_date", start_date);
+    if (end_date) params.append("end_date", end_date);
+    if (file_name) params.append("file_name", file_name);
+    if (user_agent) params.append("user_agent", user_agent.toString());
+    if (country) params.append("country", country.toString());
+    if (region) params.append("region", region);
+    if (referer) params.append("referer", referer.toString());
+    if (limit) params.append("limit", limit.toString());
+    if (sort_order) params.append("sort_order", sort_order);
+    if (sort_by) params.append("sort_by", sort_by);
+    if (date_interval) params.append("by", date_interval);
   }
   let endpoint = "https://api.pinata.cloud/v3";
   if (config.endpointUrl) {
@@ -235,28 +222,17 @@ var analyticsTopUsage = async (config, options) => {
     if (cid) {
       params.append("cid", cid);
     }
-    if (start_date)
-      params.append("start_date", start_date);
-    if (end_date)
-      params.append("end_date", end_date);
-    if (file_name)
-      params.append("file_name", file_name);
-    if (user_agent)
-      params.append("user_agent", user_agent.toString());
-    if (country)
-      params.append("country", country.toString());
-    if (region)
-      params.append("region", region);
-    if (referer)
-      params.append("referer", referer.toString());
-    if (limit)
-      params.append("limit", limit.toString());
-    if (sort_order)
-      params.append("sort_order", sort_order);
-    if (sort_by)
-      params.append("sort_by", sort_by);
-    if (attribute)
-      params.append("by", attribute);
+    if (start_date) params.append("start_date", start_date);
+    if (end_date) params.append("end_date", end_date);
+    if (file_name) params.append("file_name", file_name);
+    if (user_agent) params.append("user_agent", user_agent.toString());
+    if (country) params.append("country", country.toString());
+    if (region) params.append("region", region);
+    if (referer) params.append("referer", referer.toString());
+    if (limit) params.append("limit", limit.toString());
+    if (sort_order) params.append("sort_order", sort_order);
+    if (sort_by) params.append("sort_by", sort_by);
+    if (attribute) params.append("by", attribute);
   }
   let endpoint = "https://api.pinata.cloud/v3";
   if (config.endpointUrl) {
@@ -626,24 +602,15 @@ var listFiles = async (config, privacy, options) => {
       metadata,
       noGroup
     } = options;
-    if (limit)
-      params.append("limit", limit.toString());
-    if (name)
-      params.append("name", name);
-    if (group)
-      params.append("group", group);
-    if (cid)
-      params.append("cid", cid);
-    if (mimeType)
-      params.append("mimeType", mimeType);
-    if (order)
-      params.append("order", order);
-    if (pageToken)
-      params.append("pageToken", pageToken);
-    if (cidPending)
-      params.append("cidPending", "true");
-    if (noGroup)
-      params.append("group", "null");
+    if (limit) params.append("limit", limit.toString());
+    if (name) params.append("name", name);
+    if (group) params.append("group", group);
+    if (cid) params.append("cid", cid);
+    if (mimeType) params.append("mimeType", mimeType);
+    if (order) params.append("order", order);
+    if (pageToken) 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(`keyvalues[${key.toString()}]`, value.toString());
@@ -1240,16 +1207,11 @@ var queue = async (config, options) => {
   });
   if (options) {
     const { cid, status, sort, limit, pageToken } = options;
-    if (cid)
-      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());
+    if (cid) 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/v3";
   if (config.endpointUrl) {
@@ -1382,28 +1344,20 @@ var getCid = async (config, cid, gatewayType, options) => {
   let newUrl = `${config?.pinataGateway}/${gatewayType}/${cid}`;
   const params = new URLSearchParams();
   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.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.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);
+    if (options.onError === true) params.append("img-onerror", "redirect");
+    if (options.metadata) params.append("img-metadata", options.metadata);
   }
   if (config?.pinataGatewayKey) {
     params.append("pinataGatewayToken", config.pinataGatewayKey);
@@ -1654,28 +1608,20 @@ var createAccessLink = async (config, options, imgOpts) => {
   let newUrl = `${baseUrl}/files/${options.cid}`;
   const params = new URLSearchParams();
   if (imgOpts) {
-    if (imgOpts.width)
-      params.append("img-width", imgOpts.width.toString());
-    if (imgOpts.height)
-      params.append("img-height", imgOpts.height.toString());
-    if (imgOpts.dpr)
-      params.append("img-dpr", imgOpts.dpr.toString());
-    if (imgOpts.fit)
-      params.append("img-fit", imgOpts.fit);
-    if (imgOpts.gravity)
-      params.append("img-gravity", imgOpts.gravity);
+    if (imgOpts.width) params.append("img-width", imgOpts.width.toString());
+    if (imgOpts.height) params.append("img-height", imgOpts.height.toString());
+    if (imgOpts.dpr) params.append("img-dpr", imgOpts.dpr.toString());
+    if (imgOpts.fit) params.append("img-fit", imgOpts.fit);
+    if (imgOpts.gravity) params.append("img-gravity", imgOpts.gravity);
     if (imgOpts.quality)
       params.append("img-quality", imgOpts.quality.toString());
-    if (imgOpts.format)
-      params.append("img-format", imgOpts.format);
+    if (imgOpts.format) params.append("img-format", imgOpts.format);
     if (imgOpts.animation !== void 0)
       params.append("img-anim", imgOpts.animation.toString());
     if (imgOpts.sharpen)
       params.append("img-sharpen", imgOpts.sharpen.toString());
-    if (imgOpts.onError === true)
-      params.append("img-onerror", "redirect");
-    if (imgOpts.metadata)
-      params.append("img-metadata", imgOpts.metadata);
+    if (imgOpts.onError === true) params.append("img-onerror", "redirect");
+    if (imgOpts.metadata) params.append("img-metadata", imgOpts.metadata);
   }
   const queryString = params.toString();
   if (queryString) {
@@ -2063,14 +2009,10 @@ var listGroups = async (config, privacy, options) => {
   const params = new URLSearchParams();
   if (options) {
     const { pageToken, name, limit, isPublic } = options;
-    if (pageToken)
-      params.append("pageToken", pageToken.toString());
-    if (isPublic)
-      params.append("isPublic", isPublic.toString());
-    if (name)
-      params.append("name", name);
-    if (limit !== void 0)
-      params.append("limit", limit.toString());
+    if (pageToken) params.append("pageToken", pageToken.toString());
+    if (isPublic) params.append("isPublic", isPublic.toString());
+    if (name) params.append("name", name);
+    if (limit !== void 0) params.append("limit", limit.toString());
   }
   let endpoint = "https://api.pinata.cloud/v3";
   if (config.endpointUrl) {
@@ -2366,16 +2308,13 @@ var listKeys = async (config, options) => {
   const params = new URLSearchParams();
   if (options) {
     const { offset, name, revoked, limitedUse, exhausted } = options;
-    if (offset)
-      params.append("offset", offset.toString());
-    if (revoked !== void 0)
-      params.append("revoked", revoked.toString());
+    if (offset) params.append("offset", offset.toString());
+    if (revoked !== void 0) params.append("revoked", revoked.toString());
     if (limitedUse !== void 0)
       params.append("limitedUse", limitedUse.toString());
     if (exhausted !== void 0)
       params.append("exhausted", exhausted.toString());
-    if (name)
-      params.append("name", name);
+    if (name) params.append("name", name);
   }
   let endpoint = "https://api.pinata.cloud/v3";
   if (config.endpointUrl) {
@@ -2682,6 +2621,12 @@ var createSignedUploadURL = async (config, options, network) => {
   if (network) {
     payload.network = network;
   }
+  if (options.maxFileSize) {
+    payload.max_file_size = options.maxFileSize;
+  }
+  if (options.mimeTypes) {
+    payload.allow_mime_types = options.mimeTypes;
+  }
   let endpoint = "https://uploads.pinata.cloud/v3";
   if (config.uploadUrl) {
     endpoint = config.uploadUrl;
@@ -3649,10 +3594,8 @@ var AnalyticsBandwidth = class extends AnalyticsFilter {
     this.config = newConfig;
   }
   customDates(start, end) {
-    if (start)
-      this.query.start_date = start;
-    if (end)
-      this.query.end_date = end;
+    if (start) this.query.start_date = start;
+    if (end) this.query.end_date = end;
     return this;
   }
   from(domain) {
@@ -3734,10 +3677,8 @@ var AnalyticsRequests = class extends AnalyticsFilter {
     this.config = newConfig;
   }
   customDates(start, end) {
-    if (start)
-      this.query.start_date = start;
-    if (end)
-      this.query.end_date = end;
+    if (start) this.query.start_date = start;
+    if (end) this.query.end_date = end;
     return this;
   }
   from(domain) {