@lumeweb/pinner 0.1.0 → 0.1.3

package/dist/esm/adapters/pinata/shared/types.d.ts

@@ -0,0 +1,218 @@
+//#region src/adapters/pinata/shared/types.d.ts
+/**
+ * Pinata SDK 1.x Types
+ * Source: https://github.com/PinataCloud/pinata/commit/c141177ff3036e46fa7b95fcc68c159b58817836
+ * - src/core/types.ts
+ *
+ * Copyright © 2024 Pinata Cloud Technologies
+ * Type definitions adapted from Pinata SDK for compatibility.
+ * Original Pinata SDK: https://github.com/PinataCloud/pinata
+ */
+/**
+ * Pinata configuration options
+ */
+type PinataConfig = {
+  pinataJwt?: string;
+  pinataGateway?: string;
+  pinataGatewayKey?: string;
+  customHeaders?: Record<string, string>;
+  endpointUrl?: string;
+  uploadUrl?: string;
+};
+/**
+ * Upload response from Pinata
+ */
+type UploadResponse = {
+  id: string;
+  name: string;
+  cid: string;
+  size: number;
+  created_at: string;
+  number_of_files: number;
+  mime_type: string;
+  user_id: string;
+  group_id: string | null;
+  is_duplicate: true | null;
+  vectorized: true | null;
+};
+/**
+ * Pinata metadata options
+ */
+type PinataMetadata = {
+  name?: string;
+  keyvalues?: Record<string, string>;
+};
+/**
+ * Upload options
+ */
+type UploadOptions = {
+  metadata?: PinataMetadata;
+  keys?: string;
+  groupId?: string;
+  vectorize?: boolean;
+  url?: string;
+};
+/**
+ * File list item
+ */
+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;
+};
+/**
+ * File list response
+ */
+type FileListResponse = {
+  files: FileListItem[];
+  next_page_token: string;
+};
+/**
+ * File list query options
+ */
+type FileListQuery = {
+  name?: string;
+  group?: string;
+  noGroup?: boolean;
+  mimeType?: string;
+  cid?: string;
+  cidPending?: boolean;
+  metadata?: Record<string, string>;
+  order?: "ASC" | "DESC";
+  limit?: number;
+  pageToken?: number;
+};
+/**
+ * Pin job query options
+ */
+type PinJobQuery = {
+  sort?: "ASC" | "DSC";
+  status?: "prechecking" | "retrieving" | "expired" | "over_free_limit" | "over_max_size" | "invalid_object" | "bad_host_node";
+  ipfs_pin_hash?: string;
+  limit?: number;
+  offset?: number;
+};
+/**
+ * Pin job item
+ */
+type PinJobItem = {
+  id: 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;
+  };
+};
+/**
+ * Pin job response
+ */
+type PinJobResponse = {
+  rows: PinJobItem[];
+};
+/**
+ * Signed URL options
+ */
+type SignedUrlOptions = {
+  cid: string;
+  date?: number;
+  expires: number;
+  gateway?: string;
+};
+/**
+ * Analytics query options
+ */
+type AnalyticsQuery = {
+  gateway_domain: string;
+  start_date: string;
+  end_date: string;
+  cid?: string;
+  file_name?: string;
+  user_agent?: string;
+  country?: string;
+  region?: string;
+  referer?: string;
+  limit?: number;
+  sort_order?: "asc" | "desc";
+};
+/**
+ * Top analytics query options
+ */
+type TopAnalyticsQuery = AnalyticsQuery & {
+  sort_by: "requests" | "bandwidth";
+  attribute: "cid" | "country" | "region" | "user_agent" | "referer" | "file_name";
+};
+/**
+ * Top analytics response
+ */
+type TopAnalyticsResponse = {
+  data: TopAnalyticsItem[];
+};
+/**
+ * Top analytics item
+ */
+type TopAnalyticsItem = {
+  value: string;
+  requests: number;
+  bandwidth: number;
+};
+/**
+ * Time interval analytics query options
+ */
+type TimeIntervalAnalyticsQuery = AnalyticsQuery & {
+  sort_by?: "requests" | "bandwidth";
+  date_interval: "day" | "week";
+};
+/**
+ * Time period item
+ */
+type TimePeriodItem = {
+  period_start_time: string;
+  requests: number;
+  bandwidth: number;
+};
+/**
+ * Time interval analytics response
+ */
+type TimeIntervalAnalyticsResponse = {
+  total_requests: number;
+  total_bandwidth: number;
+  time_periods: TimePeriodItem[];
+};
+/**
+ * Swap CID options
+ */
+type SwapCidOptions = {
+  cid: string;
+  swapCid: string;
+};
+/**
+ * Swap history options
+ */
+type SwapHistoryOptions = {
+  cid: string;
+  domain: string;
+};
+/**
+ * Swap CID response
+ */
+type SwapCidResponse = {
+  mapped_cid: string;
+  created_at: string;
+};
+//#endregion
+export { AnalyticsQuery, FileListItem, FileListQuery, FileListResponse, PinJobItem, PinJobQuery, PinJobResponse, PinataConfig, PinataMetadata, SignedUrlOptions, SwapCidOptions, SwapCidResponse, SwapHistoryOptions, TimeIntervalAnalyticsQuery, TimeIntervalAnalyticsResponse, TimePeriodItem, TopAnalyticsItem, TopAnalyticsQuery, TopAnalyticsResponse, UploadOptions, UploadResponse };
+//# sourceMappingURL=types.d.ts.map

package/dist/esm/adapters/pinata/shared/utils.d.ts

@@ -0,0 +1 @@
+import { CID } from "multiformats/cid";

package/dist/esm/adapters/pinata/shared/utils.js

@@ -0,0 +1,78 @@
+import { CID } from "multiformats/cid";
+
+//#region src/adapters/pinata/shared/utils.ts
+/**
+* Shared utilities for Pinata adapters
+*/
+/**
+* Parse CID string to CID object
+*/
+function parseCID(cidString) {
+	try {
+		return CID.parse(cidString);
+	} catch (error) {
+		throw new Error(`Invalid CID: ${cidString}`);
+	}
+}
+/**
+* Create upload response object
+*/
+function createUploadResponse(result, name) {
+	return {
+		id: result.cid,
+		name: name || "",
+		cid: result.cid,
+		size: result.size,
+		created_at: result.createdAt.toISOString(),
+		number_of_files: 1,
+		mime_type: "application/octet-stream",
+		user_id: "",
+		group_id: null,
+		is_duplicate: null,
+		vectorized: null
+	};
+}
+/**
+* Create file list item from remote pin
+*/
+function createFileListItem(remotePin) {
+	return {
+		id: remotePin.cid.toString(),
+		name: remotePin.name || null,
+		cid: remotePin.cid.toString(),
+		size: remotePin.size || 0,
+		number_of_files: 1,
+		mime_type: "application/octet-stream",
+		keyvalues: remotePin.metadata || {},
+		group_id: null,
+		created_at: remotePin.created.toISOString()
+	};
+}
+/**
+* Create pin job item from remote pin
+*/
+function createPinJobItem(remotePin) {
+	return {
+		id: remotePin.cid.toString(),
+		ipfs_pin_hash: remotePin.cid.toString(),
+		date_queued: remotePin.created.toISOString(),
+		name: remotePin.name || "",
+		status: remotePin.status || "pinned",
+		keyvalues: remotePin.metadata || {},
+		host_nodes: [],
+		pin_policy: {
+			regions: [],
+			version: 1
+		}
+	};
+}
+/**
+* Throw error for unsupported features
+*/
+function notSupported(feature) {
+	throw new Error(`${feature} are not supported by Pinner`);
+}
+
+//#endregion
+export { createFileListItem, createPinJobItem, createUploadResponse, notSupported, parseCID };
+//# sourceMappingURL=utils.js.map

package/dist/esm/adapters/pinata/shared/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","names":[],"sources":["../../../../../src/adapters/pinata/shared/utils.ts"],"sourcesContent":["/**\n * Shared utilities for Pinata adapters\n */\n\nimport { CID } from \"multiformats/cid\";\n\n/**\n * Parse CID string to CID object\n */\nexport function parseCID(cidString: string): CID {\n\ttry {\n\t\treturn CID.parse(cidString);\n\t} catch (error) {\n\t\tthrow new Error(`Invalid CID: ${cidString}`);\n\t}\n}\n\n/**\n * Convert Date to ISO string\n */\nexport function toISOString(date: Date): string {\n\treturn date.toISOString();\n}\n\n/**\n * Create upload response object\n */\nexport function createUploadResponse(\n\tresult: {\n\t\tcid: string;\n\t\tsize: number;\n\t\tcreatedAt: Date;\n\t},\n\tname?: string,\n): any {\n\treturn {\n\t\tid: result.cid,\n\t\tname: name || \"\",\n\t\tcid: result.cid,\n\t\tsize: result.size,\n\t\tcreated_at: result.createdAt.toISOString(),\n\t\tnumber_of_files: 1,\n\t\tmime_type: \"application/octet-stream\",\n\t\tuser_id: \"\",\n\t\tgroup_id: null,\n\t\tis_duplicate: null,\n\t\tvectorized: null,\n\t};\n}\n\n/**\n * Create file list item from remote pin\n */\nexport function createFileListItem(\n\tremotePin: any,\n): any {\n\treturn {\n\t\tid: remotePin.cid.toString(),\n\t\tname: remotePin.name || null,\n\t\tcid: remotePin.cid.toString(),\n\t\tsize: remotePin.size || 0,\n\t\tnumber_of_files: 1,\n\t\tmime_type: \"application/octet-stream\",\n\t\tkeyvalues: remotePin.metadata || {},\n\t\tgroup_id: null,\n\t\tcreated_at: remotePin.created.toISOString(),\n\t};\n}\n\n/**\n * Create pin job item from remote pin\n */\nexport function createPinJobItem(\n\tremotePin: any,\n): any {\n\treturn {\n\t\tid: remotePin.cid.toString(),\n\t\tipfs_pin_hash: remotePin.cid.toString(),\n\t\tdate_queued: remotePin.created.toISOString(),\n\t\tname: remotePin.name || \"\",\n\t\tstatus: remotePin.status || \"pinned\",\n\t\tkeyvalues: remotePin.metadata || {},\n\t\thost_nodes: [],\n\t\tpin_policy: {\n\t\t\tregions: [],\n\t\t\tversion: 1,\n\t\t},\n\t};\n}\n\n/**\n * Throw error for unsupported features\n */\nexport function notSupported(feature: string): never {\n\tthrow new Error(`${feature} are not supported by Pinner`);\n}\n"],"mappings":";;;;;;;;;AASA,SAAgB,SAAS,WAAwB;AAChD,KAAI;AACH,SAAO,IAAI,MAAM,UAAU;UACnB,OAAO;AACf,QAAM,IAAI,MAAM,gBAAgB,YAAY;;;;;;AAc9C,SAAgB,qBACf,QAKA,MACM;AACN,QAAO;EACN,IAAI,OAAO;EACX,MAAM,QAAQ;EACd,KAAK,OAAO;EACZ,MAAM,OAAO;EACb,YAAY,OAAO,UAAU,aAAa;EAC1C,iBAAiB;EACjB,WAAW;EACX,SAAS;EACT,UAAU;EACV,cAAc;EACd,YAAY;EACZ;;;;;AAMF,SAAgB,mBACf,WACM;AACN,QAAO;EACN,IAAI,UAAU,IAAI,UAAU;EAC5B,MAAM,UAAU,QAAQ;EACxB,KAAK,UAAU,IAAI,UAAU;EAC7B,MAAM,UAAU,QAAQ;EACxB,iBAAiB;EACjB,WAAW;EACX,WAAW,UAAU,YAAY,EAAE;EACnC,UAAU;EACV,YAAY,UAAU,QAAQ,aAAa;EAC3C;;;;;AAMF,SAAgB,iBACf,WACM;AACN,QAAO;EACN,IAAI,UAAU,IAAI,UAAU;EAC5B,eAAe,UAAU,IAAI,UAAU;EACvC,aAAa,UAAU,QAAQ,aAAa;EAC5C,MAAM,UAAU,QAAQ;EACxB,QAAQ,UAAU,UAAU;EAC5B,WAAW,UAAU,YAAY,EAAE;EACnC,YAAY,EAAE;EACd,YAAY;GACX,SAAS,EAAE;GACX,SAAS;GACT;EACD;;;;;AAMF,SAAgB,aAAa,SAAwB;AACpD,OAAM,IAAI,MAAM,GAAG,QAAQ,8BAA8B"}

package/dist/esm/adapters/pinata/v2/adapter-interface.d.ts

@@ -0,0 +1,197 @@
+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.js";
+
+//#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.ts.map

package/dist/esm/adapters/pinata/v2/adapter.d.ts

@@ -0,0 +1,16 @@
+import { Pinner } from "../../../pinner.js";
+import { PinataConfig } from "./types.js";
+import { PinataAdapter } from "./adapter-interface.js";
+
+//#region src/adapters/pinata/v2/adapter.d.ts
+/**
+ * Create Pinata Adapter
+ *
+ * @param pinner - Pinner client instance
+ * @param config - Pinata configuration
+ * @returns PinataAdapter
+ */
+declare function pinataAdapter(pinner: Pinner, config?: PinataConfig): PinataAdapter;
+//#endregion
+export { pinataAdapter };
+//# sourceMappingURL=adapter.d.ts.map