pinata 2.2.2 → 2.4.0

package/dist/index.d.ts

@@ -1,3 +1,6 @@
+import { D as DeleteResponse, V as VectorizeFileResponse, F as FileListQuery, a as FileListResponse, S as SwapCidOptions, b as SwapCidResponse, c as SwapHistoryOptions, U as UpdateFileOptions, d as FileListItem, e as VectorizeQuery, f as VectorizeQueryResponse, G as GetCIDResponse, P as PinQueueQuery, g as PinQueueResponse, O as OptimizeImageOptions, A as AccessLinkOptions, h as UploadOptions, i as UploadResponse, j as SignedUploadUrlOptions, J as JsonBody, k as UploadCIDOptions, l as PinByCIDResponse, m as PinQueueItem } from './index-CQFQEo3K.js';
+export { s as AuthenticationError, q as ContainsCIDResponse, C as ContentType, n as FileObject, N as NetworkError, r as PinataError, o as PinataMetadata, R as ReactUploadOptions, x as UploadResult, y as UseUploadReturn, t as ValidationError, p as VectorQueryMatch, u as containsCID, v as convert, v as convertToDesiredGateway, w as useUpload } from './index-CQFQEo3K.js';
+
 type PinataConfig = {
     pinataJwt?: string;
     pinataGateway?: string;
@@ -53,141 +56,6 @@ type UserPinnedDataResponse = {
     pin_size_with_replications_total: number;
 };
 
-type FileObject = {
-    name: string;
-    size: number;
-    type: string;
-    lastModified: number;
-    arrayBuffer: () => Promise<ArrayBuffer>;
-};
-type JsonBody = Record<string, unknown>;
-type PinataMetadata = {
-    name?: string;
-    keyvalues?: Record<string, string>;
-};
-type UpdateFileOptions = {
-    id: string;
-    name?: string;
-    keyvalues?: Record<string, string>;
-};
-type DeleteResponse = {
-    id: string;
-    status: string;
-};
-type FileListItem = {
-    id: string;
-    name: string | null;
-    cid: "pending" | string;
-    size: number;
-    number_of_files: number;
-    mime_type: string;
-    keyvalues: Record<string, string>;
-    group_id: string | null;
-    created_at: string;
-};
-type FileListResponse = {
-    files: FileListItem[];
-    next_page_token: string;
-};
-type FileListQuery = {
-    name?: string;
-    group?: string;
-    noGroup?: boolean;
-    mimeType?: string;
-    cid?: string;
-    cidPending?: boolean;
-    metadata?: Record<string, string>;
-    order?: "ASC" | "DESC";
-    limit?: number;
-    pageToken?: string;
-};
-type PinQueueQuery = {
-    sort?: "ASC" | "DSC";
-    status?: "prechecking" | "retrieving" | "expired" | "backfilled" | "over_free_limit" | "over_max_size" | "invalid_object" | "bad_host_node";
-    cid?: string;
-    limit?: number;
-    pageToken?: string;
-};
-type PinQueueItem = {
-    id: string;
-    cid?: string;
-    ipfs_pin_hash?: string;
-    date_queued: string;
-    name: string;
-    status: string;
-    keyvalues: any;
-    host_nodes: string[];
-    pin_policy: {
-        regions: {
-            id: string;
-            desiredReplicationCount: number;
-        }[];
-        version: number;
-    };
-};
-type PinQueueResponse = {
-    jobs: PinQueueItem[];
-    next_page_token: string;
-};
-type SwapCidOptions = {
-    cid: string;
-    swapCid: string;
-};
-type SwapHistoryOptions = {
-    cid: string;
-    domain: string;
-};
-type SwapCidResponse = {
-    mapped_cid: string;
-    created_at: string;
-};
-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[];
-};
-
-type ContentType = "application/json" | "application/xml" | "text/plain" | "text/html" | "text/css" | "text/javascript" | "application/javascript" | "image/jpeg" | "image/png" | "image/gif" | "image/svg+xml" | "audio/mpeg" | "audio/ogg" | "video/mp4" | "application/pdf" | "application/octet-stream" | string | null;
-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 AccessLinkOptions = {
-    cid: string;
-    date?: number;
-    expires: number;
-    gateway?: string;
-};
-type ContainsCIDResponse = {
-    containsCid: boolean;
-    cid: string | null;
-};
-
 type GroupOptions = {
     name: string;
     isPublic?: boolean;
@@ -307,56 +175,6 @@ type SignatureResponse = {
     signature: string;
 };
 
-type UploadResponse = {
-    id: string;
-    name: string;
-    cid: string;
-    size: number;
-    created_at: string;
-    number_of_files: number;
-    mime_type: string;
-    group_id: string | null;
-    keyvalues: {
-        [key: string]: string;
-    };
-    vectorized: boolean;
-    network: string;
-};
-type UploadOptions = {
-    metadata?: PinataMetadata;
-    keys?: string;
-    groupId?: string;
-    vectorize?: boolean;
-    url?: string;
-    peerAddresses?: string[];
-};
-type SignedUploadUrlOptions = {
-    date?: number;
-    expires: number;
-    groupId?: string;
-    name?: string;
-    keyvalues?: Record<string, string>;
-    vectorize?: boolean;
-    maxFileSize?: number;
-    mimeTypes?: string[];
-};
-type UploadCIDOptions = {
-    metadata?: PinataMetadata;
-    peerAddresses?: string[];
-    keys?: string;
-    groupId?: string;
-};
-type PinByCIDResponse = {
-    id: string;
-    cid: string;
-    date_queued: string;
-    name: string;
-    status: string;
-    keyvalues: Record<string, any> | null;
-    host_nodes: string[] | null;
-    group_id: string | null;
-};
-
 declare const analyticsDateInterval: (config: PinataConfig | undefined, options?: TimeIntervalAnalyticsQuery) => Promise<TimeIntervalAnalyticsResponse>;
 
 declare const analyticsTopUsage: (config: PinataConfig | undefined, options?: TopAnalyticsQuery) => Promise<TopAnalyticsResponse>;
@@ -703,6 +521,7 @@ declare class UploadBuilder<T> {
     private groupId;
     private vector;
     private uploadUrl;
+    private isStreamable;
     private peerAddresses;
     constructor(config: PinataConfig | undefined, uploadFunction: (config: PinataConfig | undefined, ...args: any[]) => Promise<T>, ...args: any[]);
     name(name: string): UploadBuilder<T>;
@@ -711,6 +530,7 @@ declare class UploadBuilder<T> {
     vectorize(): UploadBuilder<T>;
     url(url: string): UploadBuilder<T>;
     group(groupId: string): UploadBuilder<T>;
+    streamable(): UploadBuilder<T>;
     peerAddress(peerAddresses: 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>;
 }
@@ -778,31 +598,8 @@ declare class PinataSDK {
     testAuthentication(): Promise<string>;
 }
 
-interface ErrorDetails {
-    error?: string;
-    code?: string;
-    metadata?: Record<string, any>;
-}
-declare class PinataError extends Error {
-    statusCode?: number | undefined;
-    details?: ErrorDetails | undefined;
-    constructor(message: string, statusCode?: number | undefined, details?: ErrorDetails | undefined);
-}
-declare class NetworkError extends PinataError {
-    constructor(message: string, statusCode?: number, details?: ErrorDetails);
-}
-declare class AuthenticationError extends PinataError {
-    constructor(message: string, statusCode?: number, details?: ErrorDetails);
-}
-declare class ValidationError extends PinataError {
-    constructor(message: string, details?: ErrorDetails);
-}
-
-declare function containsCID(input: string): Promise<ContainsCIDResponse>;
-declare function convertToDesiredGateway(sourceUrl: string, desiredGatewayPrefix: string | undefined): Promise<string>;
-
 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 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 };
+export { AccessLinkOptions, type AnalyticsQuery, type DataEndponts, DeleteResponse, type Endpoints, FileListItem, FileListQuery, FileListResponse, GetCIDResponse, type GetGroupOptions, type GroupCIDOptions, type GroupListResponse, type GroupOptions, type GroupQueryOptions, type GroupResponseItem, JsonBody, type KeyListItem, type KeyListQuery, type KeyListResponse, type KeyOptions, type KeyPermissions, type KeyResponse, OptimizeImageOptions, PinByCIDResponse, PinQueueItem, PinQueueQuery, PinQueueResponse, type PinataConfig, PinataSDK, type PinningEndpoints, type ResourcePermission, type RevokeKeyResponse, type SignatureOptions, type SignatureResponse, SignedUploadUrlOptions, SwapCidOptions, SwapCidResponse, SwapHistoryOptions, type TimeIntervalAnalyticsQuery, type TimeIntervalAnalyticsResponse, type TimePeriodItem, type TopAnalyticsItem, type TopAnalyticsQuery, type TopAnalyticsResponse, UpdateFileOptions, type UpdateGroupFilesResponse, type UpdateGroupOptions, UploadCIDOptions, UploadOptions, UploadResponse, type UserPinnedDataResponse, VectorizeFileResponse, VectorizeQuery, VectorizeQueryResponse, addToGroup, analyticsDateInterval, analyticsTopUsage, convertIPFSUrl, 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 };