pinata 1.7.1 → 1.8.0

package/dist/index.d.mts

@@ -123,7 +123,7 @@ type SignedUrlOptions = {
     expires: number;
     gateway?: string;
 };
-type GatewayAnalyticsQuery = {
+type AnalyticsQuery = {
     gateway_domain: string;
     start_date: string;
     end_date: string;
@@ -136,16 +136,19 @@ type GatewayAnalyticsQuery = {
     limit?: number;
     sort_order?: "asc" | "desc";
 };
-type TopGatewayAnalyticsQuery = GatewayAnalyticsQuery & {
+type TopAnalyticsQuery = AnalyticsQuery & {
     sort_by: "requests" | "bandwidth";
     attribute: "cid" | "country" | "region" | "user_agent" | "referer" | "file_name";
 };
-type TopGatewayAnalyticsItem = {
+type TopAnalyticsResponse = {
+    data: TopAnalyticsItem[];
+};
+type TopAnalyticsItem = {
     value: string;
     requests: number;
     bandwidth: number;
 };
-type TimeIntervalGatewayAnalyticsQuery = GatewayAnalyticsQuery & {
+type TimeIntervalAnalyticsQuery = AnalyticsQuery & {
     sort_by?: "requests" | "bandwidth";
     date_interval: "day" | "week";
 };
@@ -154,7 +157,7 @@ type TimePeriodItem = {
     requests: number;
     bandwidth: number;
 };
-type TimeIntervalGatewayAnalyticsResponse = {
+type TimeIntervalAnalyticsResponse = {
     total_requests: number;
     total_bandwidth: number;
     time_periods: TimePeriodItem[];
@@ -301,6 +304,7 @@ declare class PinataSDK {
     gateways: Gateways;
     keys: Keys;
     groups: Groups;
+    analytics: Analytics;
     constructor(config?: PinataConfig);
     setNewHeaders(headers: Record<string, string>): void;
     setNewJwt(jwt: string): void;
@@ -429,5 +433,70 @@ declare class FilterGroups {
     [Symbol.asyncIterator](): AsyncGenerator<GroupResponseItem, void, unknown>;
     all(): Promise<GroupResponseItem[]>;
 }
+declare class Analytics {
+    config: PinataConfig | undefined;
+    requests: AnalyticsRequests;
+    bandwidth: AnalyticsBandwidth;
+    constructor(config?: PinataConfig);
+    updateConfig(newConfig: PinataConfig): void;
+    summary(options: {
+        domain: string;
+        start: string;
+        end: string;
+        interval: "day" | "week";
+    }): TimeIntervalAnalyticsBuilder;
+}
+declare class AnalyticsFilter {
+    protected config: PinataConfig | undefined;
+    protected query: TopAnalyticsQuery;
+    constructor(config: PinataConfig | undefined, domain: string, start: string, end: string);
+    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;
+    days(numberOfDays: number): this;
+    then(onfulfilled?: ((value: TopAnalyticsResponse) => any) | null): Promise<any>;
+}
+declare class AnalyticsRequests extends AnalyticsFilter {
+    constructor(config?: PinataConfig);
+    updateConfig(newConfig: PinataConfig): void;
+    customDates(start?: string, end?: string): this;
+    from(domain: string): this;
+}
+declare class AnalyticsBandwidth extends AnalyticsFilter {
+    constructor(config?: PinataConfig);
+    updateConfig(newConfig: PinataConfig): void;
+    customDates(start?: string, end?: string): this;
+    from(domain: string): this;
+}
+declare class AnalyticsBuilder<T extends AnalyticsQuery, 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;
+    protected getAnalytics(): Promise<R>;
+    then(onfulfilled?: ((value: R) => any) | null): Promise<any>;
+}
+declare class TimeIntervalAnalyticsBuilder extends AnalyticsBuilder<TimeIntervalAnalyticsQuery, TimeIntervalAnalyticsResponse> {
+    constructor(config: PinataConfig | undefined, domain: string, start: string, end: string, dateInterval: "day" | "week");
+    sortBy(sortBy: "requests" | "bandwidth"): this;
+    protected getAnalytics(): Promise<TimeIntervalAnalyticsResponse>;
+    all(): Promise<TimeIntervalAnalyticsResponse>;
+}
 
-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 };
+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 };

package/dist/index.d.ts

@@ -123,7 +123,7 @@ type SignedUrlOptions = {
     expires: number;
     gateway?: string;
 };
-type GatewayAnalyticsQuery = {
+type AnalyticsQuery = {
     gateway_domain: string;
     start_date: string;
     end_date: string;
@@ -136,16 +136,19 @@ type GatewayAnalyticsQuery = {
     limit?: number;
     sort_order?: "asc" | "desc";
 };
-type TopGatewayAnalyticsQuery = GatewayAnalyticsQuery & {
+type TopAnalyticsQuery = AnalyticsQuery & {
     sort_by: "requests" | "bandwidth";
     attribute: "cid" | "country" | "region" | "user_agent" | "referer" | "file_name";
 };
-type TopGatewayAnalyticsItem = {
+type TopAnalyticsResponse = {
+    data: TopAnalyticsItem[];
+};
+type TopAnalyticsItem = {
     value: string;
     requests: number;
     bandwidth: number;
 };
-type TimeIntervalGatewayAnalyticsQuery = GatewayAnalyticsQuery & {
+type TimeIntervalAnalyticsQuery = AnalyticsQuery & {
     sort_by?: "requests" | "bandwidth";
     date_interval: "day" | "week";
 };
@@ -154,7 +157,7 @@ type TimePeriodItem = {
     requests: number;
     bandwidth: number;
 };
-type TimeIntervalGatewayAnalyticsResponse = {
+type TimeIntervalAnalyticsResponse = {
     total_requests: number;
     total_bandwidth: number;
     time_periods: TimePeriodItem[];
@@ -301,6 +304,7 @@ declare class PinataSDK {
     gateways: Gateways;
     keys: Keys;
     groups: Groups;
+    analytics: Analytics;
     constructor(config?: PinataConfig);
     setNewHeaders(headers: Record<string, string>): void;
     setNewJwt(jwt: string): void;
@@ -429,5 +433,70 @@ declare class FilterGroups {
     [Symbol.asyncIterator](): AsyncGenerator<GroupResponseItem, void, unknown>;
     all(): Promise<GroupResponseItem[]>;
 }
+declare class Analytics {
+    config: PinataConfig | undefined;
+    requests: AnalyticsRequests;
+    bandwidth: AnalyticsBandwidth;
+    constructor(config?: PinataConfig);
+    updateConfig(newConfig: PinataConfig): void;
+    summary(options: {
+        domain: string;
+        start: string;
+        end: string;
+        interval: "day" | "week";
+    }): TimeIntervalAnalyticsBuilder;
+}
+declare class AnalyticsFilter {
+    protected config: PinataConfig | undefined;
+    protected query: TopAnalyticsQuery;
+    constructor(config: PinataConfig | undefined, domain: string, start: string, end: string);
+    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;
+    days(numberOfDays: number): this;
+    then(onfulfilled?: ((value: TopAnalyticsResponse) => any) | null): Promise<any>;
+}
+declare class AnalyticsRequests extends AnalyticsFilter {
+    constructor(config?: PinataConfig);
+    updateConfig(newConfig: PinataConfig): void;
+    customDates(start?: string, end?: string): this;
+    from(domain: string): this;
+}
+declare class AnalyticsBandwidth extends AnalyticsFilter {
+    constructor(config?: PinataConfig);
+    updateConfig(newConfig: PinataConfig): void;
+    customDates(start?: string, end?: string): this;
+    from(domain: string): this;
+}
+declare class AnalyticsBuilder<T extends AnalyticsQuery, 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;
+    protected getAnalytics(): Promise<R>;
+    then(onfulfilled?: ((value: R) => any) | null): Promise<any>;
+}
+declare class TimeIntervalAnalyticsBuilder extends AnalyticsBuilder<TimeIntervalAnalyticsQuery, TimeIntervalAnalyticsResponse> {
+    constructor(config: PinataConfig | undefined, domain: string, start: string, end: string, dateInterval: "day" | "week");
+    sortBy(sortBy: "requests" | "bandwidth"): this;
+    protected getAnalytics(): Promise<TimeIntervalAnalyticsResponse>;
+    all(): Promise<TimeIntervalAnalyticsResponse>;
+}
 
-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 };
+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 };