pinata 0.4.0 → 1.0.1

package/dist/index.d.ts

@@ -8,18 +8,14 @@ type PinataConfig = {
 type AuthTestResponse = {
     message: string;
 };
-type PinResponse = {
-    IpfsHash: string;
-    PinSize: number;
-    Timestamp: string;
-    isDuplicate?: boolean;
-};
-type PinByCIDResponse = {
+type UploadResponse = {
     id: string;
-    ipfsHash: string;
-    status: "prechecking" | "retrieving";
     name: string;
-    updated?: boolean;
+    cid: string;
+    size: number;
+    number_of_files: number;
+    mime_type: string;
+    user_id: string;
 };
 type FileObject = {
     name: string;
@@ -31,67 +27,38 @@ type FileObject = {
 type JsonBody = Record<string, unknown>;
 type PinataMetadata = {
     name?: string;
-    keyValues?: Record<string, string | number>;
 };
-type PinataMetadataUpdate = {
-    cid: string;
+type UpdateFileOptions = {
+    id: string;
     name?: string;
-    keyValues?: Record<string, string | number>;
 };
 type UploadOptions = {
     metadata?: PinataMetadata;
-    pinType?: "async" | "sync" | "cidOnly";
-    keys?: string;
-    groupId?: string;
-    cidVersion?: 0 | 1;
-};
-type UploadCIDOptions = {
-    metadata?: PinataMetadata;
-    peerAddresses?: string[];
     keys?: string;
     groupId?: string;
 };
-type UnpinResponse = {
-    hash: string;
+type DeleteResponse = {
+    id: string;
     status: string;
 };
-type PinListItem = {
+type FileListItem = {
     id: string;
-    ipfs_pin_hash: string;
+    name: string | null;
+    cid: "pending" | string;
     size: number;
-    user_id: string;
-    date_pinned: string;
-    date_unpinned: string | null;
-    metadata: {
-        name: string | null;
-        keyvalues: {
-            [key: string]: any;
-        } | null;
-    };
-    regions: {
-        regionId: string;
-        currentReplicationCount: number;
-        desiredReplicationCount: number;
-    }[];
-    mime_type: string;
     number_of_files: number;
+    mime_type: string;
+    group_id: string;
+    created_at: string;
 };
-type PinListResponse = {
-    rows: PinListItem[];
+type FileListResponse = {
+    files: FileListItem[];
+    next_page_token: string;
 };
-type PinListQuery = {
-    cid?: string;
-    pinStart?: string;
-    pinEnd?: string;
-    pinSizeMin?: number;
-    pinSizeMax?: number;
-    pageLimit?: number;
-    pageOffset?: number;
-    name?: string;
-    groupId?: string;
-    key?: string;
-    value?: string | number;
-    operator?: "gt" | "gte" | "lt" | "lte" | "ne" | "eq" | "between" | "notBetween" | "like" | "notLike" | "iLike" | "notILike" | "regexp" | "iRegexp";
+type FileListQuery = {
+    limit?: number;
+    pageToken?: string;
+    cidPending?: boolean;
 };
 type PinJobQuery = {
     sort?: "ASC" | "DSC";
@@ -137,6 +104,11 @@ type OptimizeImageOptions = {
     onError?: boolean;
     metadata?: "keep" | "copyright" | "none";
 };
+type SignedUrlOptions = {
+    cid: string;
+    date?: number;
+    expires: number;
+};
 type GatewayAnalyticsQuery = {
     gateway_domain: string;
     start_date: string;
@@ -249,25 +221,31 @@ type RevokeKeyResponse = {
 };
 type GroupOptions = {
     name: string;
+    isPublic?: boolean;
 };
 type UpdateGroupOptions = {
-    name: string;
     groupId: string;
+    name?: string;
+    isPublic?: boolean;
 };
 type GetGroupOptions = {
     groupId: string;
 };
+type GroupListResponse = {
+    groups: GroupResponseItem[];
+    next_page_token: string;
+};
 type GroupResponseItem = {
     id: string;
-    user_id: string;
+    is_public: boolean;
     name: string;
-    updatedAt: string;
     createdAt: string;
 };
 type GroupQueryOptions = {
     nameContains?: string;
-    offset?: number;
     limit?: number;
+    pageToken?: string;
+    isPublic?: boolean;
 };
 type GroupCIDOptions = {
     groupId: string;
@@ -300,19 +278,22 @@ type ContainsCIDResponse = {
 
 declare class PinataSDK {
     config: PinataConfig | undefined;
+    files: Files;
     upload: Upload;
     gateways: Gateways;
-    usage: Usage;
     keys: Keys;
     groups: Groups;
-    signatures: Signatures;
     constructor(config?: PinataConfig);
     setNewHeaders(headers: Record<string, string>): void;
     testAuthentication(): Promise<AuthTestResponse>;
-    unpin(files: string[]): Promise<UnpinResponse[]>;
-    listFiles(): FilterFiles;
-    updateMetadata(options: PinataMetadataUpdate): Promise<string>;
-    pinJobs(): FilterPinJobs;
+}
+declare class Files {
+    config: PinataConfig | undefined;
+    constructor(config?: PinataConfig);
+    updateConfig(newConfig: PinataConfig): void;
+    list(): FilterFiles;
+    delete(files: string[]): Promise<DeleteResponse[]>;
+    update(options: UpdateFileOptions): Promise<FileListItem>;
 }
 declare class UploadBuilder<T> {
     private config;
@@ -320,107 +301,40 @@ declare class UploadBuilder<T> {
     private args;
     private metadata;
     private keys;
-    private peerAddresses;
-    private version;
     private groupId;
     constructor(config: PinataConfig | undefined, uploadFunction: (config: PinataConfig | undefined, ...args: any[]) => Promise<T>, ...args: any[]);
     addMetadata(metadata: PinataMetadata): UploadBuilder<T>;
     key(jwt: string): UploadBuilder<T>;
-    cidVersion(v: 0 | 1): UploadBuilder<T>;
     group(groupId: string): 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>;
 }
 declare class Upload {
     config: PinataConfig | undefined;
     constructor(config?: PinataConfig);
     updateConfig(newConfig: PinataConfig): void;
-    file(file: FileObject, options?: UploadOptions): UploadBuilder<PinResponse>;
-    fileArray(files: FileObject[], options?: UploadOptions): UploadBuilder<PinResponse>;
-    base64(base64String: string, options?: UploadOptions): UploadBuilder<PinResponse>;
-    url(url: string, options?: UploadOptions): UploadBuilder<PinResponse>;
-    json(data: object, options?: UploadOptions): UploadBuilder<PinResponse>;
-    cid(cid: string, options?: UploadCIDOptions): UploadBuilder<PinByCIDResponse>;
+    file(file: FileObject, 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>;
 }
 declare class FilterFiles {
     private config;
     private query;
-    private requestCount;
-    private lastRequestTime;
-    private readonly MAX_REQUESTS_PER_MINUTE;
-    private readonly MINUTE_IN_MS;
+    private currentPageToken;
     constructor(config: PinataConfig | undefined);
-    cid(cid: string): FilterFiles;
-    pinStart(date: string): FilterFiles;
-    pinEnd(date: string): FilterFiles;
-    pinSizeMin(size: number): FilterFiles;
-    pinSizeMax(size: number): FilterFiles;
-    pageLimit(limit: number): FilterFiles;
-    pageOffset(offset: number): FilterFiles;
-    name(name: string): FilterFiles;
-    group(groupId: string): FilterFiles;
-    keyValue(key: string, value: string | number, operator?: PinListQuery["operator"]): FilterFiles;
-    then(onfulfilled?: ((value: PinListItem[]) => any) | null): Promise<any>;
-    private rateLimit;
-    [Symbol.asyncIterator](): AsyncGenerator<PinListItem, void, unknown>;
-    all(): Promise<PinListItem[]>;
+    limit(limit: number): FilterFiles;
+    cidPending(cidPending: boolean): FilterFiles;
+    then(onfulfilled?: ((value: FileListItem[]) => any) | null): Promise<any>;
+    private fetchPage;
+    [Symbol.asyncIterator](): AsyncGenerator<FileListItem, void, unknown>;
+    all(): Promise<FileListItem[]>;
 }
 declare class Gateways {
     config: PinataConfig | undefined;
     constructor(config?: PinataConfig);
     updateConfig(newConfig: PinataConfig): void;
-    get(cid: string): OptimizeImage;
-    convert(url: string, gatewayPrefix?: string): Promise<string>;
-    containsCID(cid: string): Promise<ContainsCIDResponse>;
-    topUsageAnalytics(options: {
-        domain: string;
-        start: string;
-        end: string;
-        sortBy: "requests" | "bandwidth";
-        attribute: "cid" | "country" | "region" | "user_agent" | "referer" | "file_name";
-    }): TopGatewayAnalyticsBuilder;
-    dateIntervalAnalytics(options: {
-        domain: string;
-        start: string;
-        end: string;
-        interval: "day" | "week";
-    }): TimeIntervalGatewayAnalyticsBuilder;
-    swapCid(options: SwapCidOptions): Promise<SwapCidResponse>;
-    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;
-    private requestCount;
-    private lastRequestTime;
-    private readonly MAX_REQUESTS_PER_MINUTE;
-    private readonly MINUTE_IN_MS;
-    constructor(config: PinataConfig | undefined);
-    cid(cid: string): FilterPinJobs;
-    status(status: "prechecking" | "retrieving" | "expired" | "over_free_limit" | "over_max_size" | "invalid_object" | "bad_host_node"): FilterPinJobs;
-    pageLimit(limit: number): FilterPinJobs;
-    pageOffset(offset: number): FilterPinJobs;
-    sort(sort: "ASC" | "DSC"): FilterPinJobs;
-    then(onfulfilled?: ((value: PinJobItem[]) => any) | null): Promise<any>;
-    private rateLimit;
-    [Symbol.asyncIterator](): AsyncGenerator<PinJobItem, void, unknown>;
-    all(): Promise<PinJobItem[]>;
-}
-declare class Usage {
-    config: PinataConfig | undefined;
-    constructor(config?: PinataConfig);
-    updateConfig(newConfig: PinataConfig): void;
-    pinnedFileCount(): Promise<number>;
-    totalStorageSize(): Promise<number>;
+    get(cid: string): Promise<GetCIDResponse>;
+    createSignedURL(options: SignedUrlOptions): Promise<string>;
 }
 declare class Keys {
     config: PinataConfig | undefined;
@@ -433,10 +347,6 @@ declare class Keys {
 declare class FilterKeys {
     private config;
     private query;
-    private requestCount;
-    private lastRequestTime;
-    private readonly MAX_REQUESTS_PER_MINUTE;
-    private readonly MINUTE_IN_MS;
     constructor(config: PinataConfig | undefined);
     offset(offset: number): FilterKeys;
     revoked(revoked: boolean): FilterKeys;
@@ -444,7 +354,6 @@ declare class FilterKeys {
     exhausted(exhausted: boolean): FilterKeys;
     name(name: string): FilterKeys;
     then(onfulfilled?: ((value: KeyListItem[]) => any) | null): Promise<any>;
-    private rateLimit;
     [Symbol.asyncIterator](): AsyncGenerator<KeyListItem, void, unknown>;
     all(): Promise<KeyListItem[]>;
 }
@@ -455,65 +364,20 @@ declare class Groups {
     create(options: GroupOptions): Promise<GroupResponseItem>;
     list(): FilterGroups;
     get(options: GetGroupOptions): Promise<GroupResponseItem>;
-    addCids(options: GroupCIDOptions): Promise<string>;
-    removeCids(options: GroupCIDOptions): Promise<string>;
     update(options: UpdateGroupOptions): Promise<GroupResponseItem>;
     delete(options: GetGroupOptions): Promise<string>;
 }
 declare class FilterGroups {
     private config;
     private query;
-    private requestCount;
-    private lastRequestTime;
-    private readonly MAX_REQUESTS_PER_MINUTE;
-    private readonly MINUTE_IN_MS;
+    private nextPageToken;
     constructor(config: PinataConfig | undefined);
-    offset(offset: number): FilterGroups;
-    name(nameContains: string): FilterGroups;
     limit(limit: number): FilterGroups;
+    isPublic(isPublic: boolean): FilterGroups;
     then(onfulfilled?: ((value: GroupResponseItem[]) => any) | null): Promise<GroupResponseItem[]>;
-    private rateLimit;
+    private fetchPage;
     [Symbol.asyncIterator](): AsyncGenerator<GroupResponseItem, void, unknown>;
     all(): Promise<GroupResponseItem[]>;
 }
-declare class Signatures {
-    config: PinataConfig | undefined;
-    constructor(config?: PinataConfig);
-    updateConfig(newConfig: PinataConfig): void;
-    add(options: SignatureOptions): Promise<SignatureResponse>;
-    get(cid: string): Promise<SignatureResponse>;
-    delete(cid: string): Promise<string>;
-}
-declare class GatewayAnalyticsBuilder<T extends GatewayAnalyticsQuery, R> {
-    protected config: PinataConfig | undefined;
-    protected query: T;
-    private requestCount;
-    private lastRequestTime;
-    private readonly MAX_REQUESTS_PER_MINUTE;
-    private readonly MINUTE_IN_MS;
-    constructor(config: PinataConfig | undefined, query: T);
-    cid(cid: string): this;
-    fileName(fileName: string): this;
-    userAgent(userAgent: string): this;
-    country(country: string): this;
-    region(region: string): this;
-    referer(referer: string): this;
-    limit(limit: number): this;
-    sort(order: "asc" | "desc"): this;
-    private rateLimit;
-    protected getAnalytics(): Promise<R>;
-    then(onfulfilled?: ((value: R) => any) | null): Promise<any>;
-}
-declare class TopGatewayAnalyticsBuilder extends GatewayAnalyticsBuilder<TopGatewayAnalyticsQuery, TopGatewayAnalyticsItem[]> {
-    constructor(config: PinataConfig | undefined, domain: string, start: string, end: string, sortBy: "requests" | "bandwidth", attribute: "cid" | "country" | "region" | "user_agent" | "referer" | "file_name");
-    protected getAnalytics(): Promise<TopGatewayAnalyticsItem[]>;
-    all(): Promise<TopGatewayAnalyticsItem[]>;
-}
-declare class TimeIntervalGatewayAnalyticsBuilder extends GatewayAnalyticsBuilder<TimeIntervalGatewayAnalyticsQuery, TimeIntervalGatewayAnalyticsResponse> {
-    constructor(config: PinataConfig | undefined, domain: string, start: string, end: string, dateInterval: "day" | "week");
-    sortBy(sortBy: "requests" | "bandwidth"): this;
-    protected getAnalytics(): Promise<TimeIntervalGatewayAnalyticsResponse>;
-    all(): Promise<TimeIntervalGatewayAnalyticsResponse>;
-}
 
-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 };
+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 };