@lumeweb/pinner 0.0.1 → 0.1.1

package/dist/cjs/adapters/pinata/v2/adapter-interface.d.cts

@@ -0,0 +1,198 @@
+import { AccessLinkOptions, DeleteResponse, FileListItem, FileListResponse, GetGroupOptions, GroupCIDOptions, GroupListResponse, GroupOptions, GroupResponseItem, PinByCIDResponse, PinQueueItem, PinQueueResponse, PinataConfig, SignedUploadUrlOptions, SwapCidOptions, SwapCidResponse, SwapHistoryOptions, TimeIntervalAnalyticsQuery, TimeIntervalAnalyticsResponse, TopAnalyticsQuery, TopAnalyticsResponse, UpdateFileOptions, UpdateGroupFilesResponse, UpdateGroupOptions, UploadCIDOptions, UploadOptions, UploadResponse } from "./types.cjs";
+
+//#region src/adapters/pinata/v2/adapter-interface.d.ts
+
+/**
+ * Upload builder interface
+ */
+interface UploadBuilder<TResult> {
+  name(name: string): this;
+  keyvalues(keyvalues: Record<string, string>): this;
+  execute(): Promise<TResult>;
+}
+/**
+ * Filter files builder interface
+ */
+interface FilterFiles {
+  name(name: string): FilterFiles;
+  group(group: string): FilterFiles;
+  cid(cid: string): FilterFiles;
+  mimeType(mimeType: string): FilterFiles;
+  order(order: "ASC" | "DESC"): FilterFiles;
+  limit(limit: number): FilterFiles;
+  cidPending(cidPending: boolean): FilterFiles;
+  keyvalues(keyvalues: Record<string, string>): FilterFiles;
+  noGroup(noGroup: boolean): FilterFiles;
+  pageToken(pageToken: string): FilterFiles;
+  then(onfulfilled?: ((value: FileListResponse) => any) | null, onrejected?: ((reason: any) => any) | null): Promise<any>;
+  all(): Promise<FileListItem[]>;
+  [Symbol.asyncIterator](): AsyncGenerator<FileListItem, void, unknown>;
+}
+/**
+ * Filter queue builder interface
+ */
+interface FilterQueue {
+  cid(cid: string): FilterQueue;
+  status(status: "prechecking" | "retrieving" | "expired" | "backfilled" | "over_free_limit" | "over_max_size" | "invalid_object" | "bad_host_node"): FilterQueue;
+  pageLimit(limit: number): FilterQueue;
+  pageToken(pageToken: string): FilterQueue;
+  sort(sort: "ASC" | "DSC"): FilterQueue;
+  then(onfulfilled?: ((value: PinQueueResponse) => any) | null, onrejected?: ((reason: any) => any) | null): Promise<any>;
+  all(): Promise<PinQueueItem[]>;
+  [Symbol.asyncIterator](): AsyncGenerator<PinQueueItem, void, unknown>;
+}
+/**
+ * Filter groups builder interface
+ */
+interface FilterGroups {
+  name(name: string): FilterGroups;
+  limit(limit: number): FilterGroups;
+  pageToken(pageToken: string): FilterGroups;
+  isPublic(isPublic: boolean): FilterGroups;
+  then(onfulfilled?: ((value: GroupListResponse) => any) | null, onrejected?: ((reason: any) => any) | null): Promise<any>;
+  all(): Promise<GroupResponseItem[]>;
+  [Symbol.asyncIterator](): AsyncGenerator<GroupResponseItem, void, unknown>;
+}
+/**
+ * Public upload interface
+ */
+interface PublicUpload {
+  file(file: File, options?: UploadOptions): UploadBuilder<UploadResponse>;
+  fileArray(files: 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>;
+  cid(cid: string, options?: UploadCIDOptions): UploadBuilder<PinByCIDResponse>;
+  createSignedURL(options: SignedUploadUrlOptions): Promise<string>;
+}
+/**
+ * Private upload interface
+ */
+interface PrivateUpload {
+  file(file: File, options?: UploadOptions): UploadBuilder<UploadResponse>;
+  fileArray(files: 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>;
+  cid(cid: string, options?: UploadCIDOptions): UploadBuilder<PinByCIDResponse>;
+  createSignedURL(options: SignedUploadUrlOptions): Promise<string>;
+}
+/**
+ * Public files interface
+ */
+interface PublicFiles {
+  list(): FilterFiles;
+  get(id: string): Promise<FileListItem>;
+  delete(files: string[]): Promise<DeleteResponse[]>;
+  update(options: UpdateFileOptions): Promise<FileListItem>;
+  addSwap(options: SwapCidOptions): Promise<SwapCidResponse>;
+  getSwapHistory(options: SwapHistoryOptions): Promise<SwapCidResponse[]>;
+  deleteSwap(cid: string): Promise<string>;
+  queue(): FilterQueue;
+  deletePinRequest(requestId: string): Promise<string>;
+}
+/**
+ * Private files interface
+ */
+interface PrivateFiles {
+  list(): FilterFiles;
+  get(id: string): Promise<FileListItem>;
+  delete(files: string[]): Promise<DeleteResponse[]>;
+  update(options: UpdateFileOptions): Promise<FileListItem>;
+  addSwap(options: SwapCidOptions): Promise<SwapCidResponse>;
+  getSwapHistory(options: SwapHistoryOptions): Promise<SwapCidResponse[]>;
+  deleteSwap(cid: string): Promise<string>;
+  queue(): FilterQueue;
+  deletePinRequest(requestId: string): Promise<string>;
+}
+/**
+ * Public gateways interface
+ */
+interface PublicGateways {
+  get(cid: string): any;
+  convert(url: string, gatewayPrefix?: string): Promise<string>;
+}
+/**
+ * Private gateways interface
+ */
+interface PrivateGateways {
+  get(cid: string): any;
+  createAccessLink(options: AccessLinkOptions): any;
+}
+/**
+ * Public groups interface
+ */
+interface PublicGroups {
+  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>;
+}
+/**
+ * Private groups interface
+ */
+interface PrivateGroups {
+  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>;
+}
+/**
+ * Analytics interface
+ */
+interface Analytics {
+  requests(query: TopAnalyticsQuery): Promise<TopAnalyticsResponse>;
+  bandwidth(query: TimeIntervalAnalyticsQuery): Promise<TimeIntervalAnalyticsResponse>;
+}
+/**
+ * Pinata 2.x Adapter Interface
+ * Matches Pinata SDK 2.x API exactly
+ */
+interface PinataAdapter {
+  /**
+   * Configuration
+   */
+  config: PinataConfig;
+  updateConfig(newConfig: PinataConfig): void;
+  /**
+   * Upload with public/private separation
+   */
+  upload: {
+    public: PublicUpload;
+    private: PrivateUpload;
+  };
+  /**
+   * Files with public/private separation
+   */
+  files: {
+    public: PublicFiles;
+    private: PrivateFiles;
+  };
+  /**
+   * Gateways with public/private separation
+   */
+  gateways: {
+    public: PublicGateways;
+    private: PrivateGateways;
+  };
+  /**
+   * Groups with public/private separation
+   */
+  groups: {
+    public: PublicGroups;
+    private: PrivateGroups;
+  };
+  /**
+   * Analytics (no public/private)
+   */
+  analytics: Analytics;
+}
+//#endregion
+export { PinataAdapter };
+//# sourceMappingURL=adapter-interface.d.cts.map