@lumeweb/pinner 0.1.0 → 0.1.3

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

@@ -0,0 +1,3 @@
+import { AccessLinkOptions, AnalyticsQuery, CidVersion, DeleteResponse, FileListItem, FileListResponse, GetGroupOptions, GroupCIDOptions, GroupListResponse, GroupOptions, GroupResponseItem, PinByCIDResponse, PinQueueItem, PinQueueResponse, PinataConfig, PinataMetadata, SignedUploadUrlOptions, SwapCidOptions, SwapCidResponse, SwapHistoryOptions, TimeIntervalAnalyticsQuery, TimeIntervalAnalyticsResponse, TimePeriodItem, TopAnalyticsItem, TopAnalyticsQuery, TopAnalyticsResponse, UpdateFileOptions, UpdateGroupFilesResponse, UpdateGroupOptions, UploadCIDOptions, UploadOptions, UploadResponse } from "./types.js";
+import { PinataAdapter } from "./adapter-interface.js";
+import { pinataAdapter } from "./adapter.js";

package/dist/esm/adapters/pinata/v2/index.js

@@ -0,0 +1 @@
+import { pinataAdapter } from "./adapter.js";

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

@@ -0,0 +1,308 @@
+//#region src/adapters/pinata/v2/types.d.ts
+/**
+ * Pinata SDK 2.x Types
+ * Source: https://github.com/PinataCloud/pinata/commit/cdc0c06116aaadaf7c4b287a2673cd23b6ba1125
+ * - src/core/types/index.ts
+ *
+ * Copyright © 2024 Pinata Cloud Technologies
+ * Type definitions adapted from Pinata SDK for compatibility.
+ * Original Pinata SDK: https://github.com/PinataCloud/pinata
+ */
+/**
+ * CID version type
+ */
+type CidVersion = "v0" | "v1";
+/**
+ * Pinata configuration options
+ */
+type PinataConfig = {
+  pinataJwt?: string;
+  pinataGateway?: string;
+  pinataGatewayKey?: string;
+  customHeaders?: Record<string, string>;
+  endpointUrl?: string;
+  uploadUrl?: string;
+  legacyUploadUrl?: string;
+};
+/**
+ * Pinata metadata
+ */
+type PinataMetadata = {
+  name?: string;
+  keyvalues?: Record<string, string>;
+};
+/**
+ * Upload options
+ */
+type UploadOptions = {
+  metadata?: PinataMetadata;
+  keys?: string;
+  groupId?: string;
+  vectorize?: boolean;
+  url?: string;
+  streamable?: boolean;
+  peerAddresses?: string[];
+  car?: boolean;
+  cid_version?: CidVersion;
+};
+/**
+ * Upload response
+ */
+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: Record<string, string>;
+  vectorized: boolean;
+  network: string;
+};
+/**
+ * Upload CID options
+ */
+type UploadCIDOptions = {
+  metadata?: PinataMetadata;
+  peerAddresses?: string[];
+  keys?: string;
+  groupId?: string;
+};
+/**
+ * Pin by CID response
+ */
+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;
+};
+/**
+ * Signed upload URL options
+ */
+type SignedUploadUrlOptions = {
+  date?: number;
+  expires: number;
+  groupId?: string;
+  name?: string;
+  keyvalues?: Record<string, string>;
+  vectorize?: boolean;
+  maxFileSize?: number;
+  mimeTypes?: string[];
+  streamable?: boolean;
+  car?: boolean;
+  cid_version?: CidVersion;
+};
+/**
+ * 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;
+};
+/**
+ * Update file options
+ */
+type UpdateFileOptions = {
+  id: string;
+  name?: string;
+  keyvalues?: Record<string, string>;
+};
+/**
+ * Delete response
+ */
+type DeleteResponse = {
+  id: string;
+  status: string;
+};
+/**
+ * Pin queue item
+ */
+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;
+  };
+};
+/**
+ * Pin queue response
+ */
+type PinQueueResponse = {
+  jobs: PinQueueItem[];
+  next_page_token: string;
+};
+/**
+ * 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;
+};
+/**
+ * Access link options
+ */
+type AccessLinkOptions = {
+  cid: string;
+  date?: number;
+  expires: number;
+  gateway?: string;
+};
+/**
+ * Group options
+ */
+type GroupOptions = {
+  name: string;
+  isPublic?: boolean;
+};
+/**
+ * Update group options
+ */
+type UpdateGroupOptions = {
+  groupId: string;
+  name?: string;
+  isPublic?: boolean;
+};
+/**
+ * Get group options
+ */
+type GetGroupOptions = {
+  groupId: string;
+};
+/**
+ * Group response item
+ */
+type GroupResponseItem = {
+  id: string;
+  is_public: boolean;
+  name: string;
+  createdAt: string;
+};
+/**
+ * Group list response
+ */
+type GroupListResponse = {
+  groups: GroupResponseItem[];
+  next_page_token: string;
+};
+/**
+ * Group CID options
+ */
+type GroupCIDOptions = {
+  groupId: string;
+  files: string[];
+};
+/**
+ * Update group files response
+ */
+type UpdateGroupFilesResponse = {
+  id: string;
+  status: string;
+};
+/**
+ * Analytics query
+ */
+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
+ */
+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
+ */
+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[];
+};
+//#endregion
+export { AccessLinkOptions, AnalyticsQuery, CidVersion, DeleteResponse, FileListItem, FileListResponse, GetGroupOptions, GroupCIDOptions, GroupListResponse, GroupOptions, GroupResponseItem, PinByCIDResponse, PinQueueItem, PinQueueResponse, PinataConfig, PinataMetadata, SignedUploadUrlOptions, SwapCidOptions, SwapCidResponse, SwapHistoryOptions, TimeIntervalAnalyticsQuery, TimeIntervalAnalyticsResponse, TimePeriodItem, TopAnalyticsItem, TopAnalyticsQuery, TopAnalyticsResponse, UpdateFileOptions, UpdateGroupFilesResponse, UpdateGroupOptions, UploadCIDOptions, UploadOptions, UploadResponse };
+//# sourceMappingURL=types.d.ts.map

package/dist/esm/api/generated/schemas/iPNSKeyListResponse.d.ts

@@ -0,0 +1,46 @@
+//#region src/api/generated/schemas/iPNSKeyListResponse.d.ts
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Portal IPFS Plugin API
+ *
+## Portal IPFS Plugin API
+
+A comprehensive API for IPFS content management, including pinning services, file operations, IPNS key management, and website hosting.
+
+### IPFS Pinning Service API Compatibility
+
+This API is fully compatible with the [IPFS Pinning Service API specification](https://github.com/ipfs/pinning-services-api-spec), an implementation-agnostic API standard for pinning service providers. This ensures interoperability with existing IPFS pinning clients and tools.
+
+### Features
+
+- **Pinning**: Add, list, update, and remove pinned content
+- **Content**: Upload files, retrieve IPFS content, and manage metadata
+- **IPNS**: Manage IPNS keys and publish content
+- **Files**: Browse and manage pinned files with directory navigation
+- **Websites**: Create and manage website hosting with DNS and SSL automation
+
+### Authentication
+
+All API endpoints require authentication using JWT tokens obtained from the Portal authentication service.
+
+### Rate Limiting
+
+API requests are rate-limited based on user account tier. See Portal documentation for current limits.
+
+### Documentation
+
+For detailed API usage examples and integration guides, visit the Portal documentation website.
+
+ * OpenAPI spec version: 1.0.0
+ */
+interface IPNSKeyListResponse {
+  created: string;
+  id: number;
+  ipns_name: string;
+  name: string;
+  peer_id: string;
+}
+//#endregion
+export { IPNSKeyListResponse };
+//# sourceMappingURL=iPNSKeyListResponse.d.ts.map

package/dist/esm/api/generated/schemas/iPNSKeyListResponseResponse.d.ts

@@ -0,0 +1,10 @@
+import { IPNSKeyListResponse } from "./iPNSKeyListResponse.js";
+
+//#region src/api/generated/schemas/iPNSKeyListResponseResponse.d.ts
+interface IPNSKeyListResponseResponse {
+  data: IPNSKeyListResponse[];
+  total: number;
+}
+//#endregion
+export { IPNSKeyListResponseResponse };
+//# sourceMappingURL=iPNSKeyListResponseResponse.d.ts.map

package/dist/esm/api/generated/schemas/iPNSKeyRequest.d.ts

@@ -0,0 +1,43 @@
+//#region src/api/generated/schemas/iPNSKeyRequest.d.ts
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Portal IPFS Plugin API
+ *
+## Portal IPFS Plugin API
+
+A comprehensive API for IPFS content management, including pinning services, file operations, IPNS key management, and website hosting.
+
+### IPFS Pinning Service API Compatibility
+
+This API is fully compatible with the [IPFS Pinning Service API specification](https://github.com/ipfs/pinning-services-api-spec), an implementation-agnostic API standard for pinning service providers. This ensures interoperability with existing IPFS pinning clients and tools.
+
+### Features
+
+- **Pinning**: Add, list, update, and remove pinned content
+- **Content**: Upload files, retrieve IPFS content, and manage metadata
+- **IPNS**: Manage IPNS keys and publish content
+- **Files**: Browse and manage pinned files with directory navigation
+- **Websites**: Create and manage website hosting with DNS and SSL automation
+
+### Authentication
+
+All API endpoints require authentication using JWT tokens obtained from the Portal authentication service.
+
+### Rate Limiting
+
+API requests are rate-limited based on user account tier. See Portal documentation for current limits.
+
+### Documentation
+
+For detailed API usage examples and integration guides, visit the Portal documentation website.
+
+ * OpenAPI spec version: 1.0.0
+ */
+interface IPNSKeyRequest {
+  key?: string;
+  name: string;
+}
+//#endregion
+export { IPNSKeyRequest };
+//# sourceMappingURL=iPNSKeyRequest.d.ts.map

package/dist/esm/api/generated/schemas/iPNSKeyResponse.d.ts

@@ -0,0 +1,46 @@
+//#region src/api/generated/schemas/iPNSKeyResponse.d.ts
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Portal IPFS Plugin API
+ *
+## Portal IPFS Plugin API
+
+A comprehensive API for IPFS content management, including pinning services, file operations, IPNS key management, and website hosting.
+
+### IPFS Pinning Service API Compatibility
+
+This API is fully compatible with the [IPFS Pinning Service API specification](https://github.com/ipfs/pinning-services-api-spec), an implementation-agnostic API standard for pinning service providers. This ensures interoperability with existing IPFS pinning clients and tools.
+
+### Features
+
+- **Pinning**: Add, list, update, and remove pinned content
+- **Content**: Upload files, retrieve IPFS content, and manage metadata
+- **IPNS**: Manage IPNS keys and publish content
+- **Files**: Browse and manage pinned files with directory navigation
+- **Websites**: Create and manage website hosting with DNS and SSL automation
+
+### Authentication
+
+All API endpoints require authentication using JWT tokens obtained from the Portal authentication service.
+
+### Rate Limiting
+
+API requests are rate-limited based on user account tier. See Portal documentation for current limits.
+
+### Documentation
+
+For detailed API usage examples and integration guides, visit the Portal documentation website.
+
+ * OpenAPI spec version: 1.0.0
+ */
+interface IPNSKeyResponse {
+  created: string;
+  id: number;
+  ipns_name: string;
+  name: string;
+  peer_id: string;
+}
+//#endregion
+export { IPNSKeyResponse };
+//# sourceMappingURL=iPNSKeyResponse.d.ts.map

package/dist/esm/api/generated/schemas/iPNSPublishRequest.d.ts

@@ -0,0 +1,44 @@
+//#region src/api/generated/schemas/iPNSPublishRequest.d.ts
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Portal IPFS Plugin API
+ *
+## Portal IPFS Plugin API
+
+A comprehensive API for IPFS content management, including pinning services, file operations, IPNS key management, and website hosting.
+
+### IPFS Pinning Service API Compatibility
+
+This API is fully compatible with the [IPFS Pinning Service API specification](https://github.com/ipfs/pinning-services-api-spec), an implementation-agnostic API standard for pinning service providers. This ensures interoperability with existing IPFS pinning clients and tools.
+
+### Features
+
+- **Pinning**: Add, list, update, and remove pinned content
+- **Content**: Upload files, retrieve IPFS content, and manage metadata
+- **IPNS**: Manage IPNS keys and publish content
+- **Files**: Browse and manage pinned files with directory navigation
+- **Websites**: Create and manage website hosting with DNS and SSL automation
+
+### Authentication
+
+All API endpoints require authentication using JWT tokens obtained from the Portal authentication service.
+
+### Rate Limiting
+
+API requests are rate-limited based on user account tier. See Portal documentation for current limits.
+
+### Documentation
+
+For detailed API usage examples and integration guides, visit the Portal documentation website.
+
+ * OpenAPI spec version: 1.0.0
+ */
+interface IPNSPublishRequest {
+  cid: string;
+  key_id: number;
+  ttl?: string;
+}
+//#endregion
+export { IPNSPublishRequest };
+//# sourceMappingURL=iPNSPublishRequest.d.ts.map

package/dist/esm/api/generated/schemas/iPNSPublishResponse.d.ts

@@ -0,0 +1,46 @@
+//#region src/api/generated/schemas/iPNSPublishResponse.d.ts
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Portal IPFS Plugin API
+ *
+## Portal IPFS Plugin API
+
+A comprehensive API for IPFS content management, including pinning services, file operations, IPNS key management, and website hosting.
+
+### IPFS Pinning Service API Compatibility
+
+This API is fully compatible with the [IPFS Pinning Service API specification](https://github.com/ipfs/pinning-services-api-spec), an implementation-agnostic API standard for pinning service providers. This ensures interoperability with existing IPFS pinning clients and tools.
+
+### Features
+
+- **Pinning**: Add, list, update, and remove pinned content
+- **Content**: Upload files, retrieve IPFS content, and manage metadata
+- **IPNS**: Manage IPNS keys and publish content
+- **Files**: Browse and manage pinned files with directory navigation
+- **Websites**: Create and manage website hosting with DNS and SSL automation
+
+### Authentication
+
+All API endpoints require authentication using JWT tokens obtained from the Portal authentication service.
+
+### Rate Limiting
+
+API requests are rate-limited based on user account tier. See Portal documentation for current limits.
+
+### Documentation
+
+For detailed API usage examples and integration guides, visit the Portal documentation website.
+
+ * OpenAPI spec version: 1.0.0
+ */
+interface IPNSPublishResponse {
+  name: string;
+  published: string;
+  sequence: number;
+  validity: string;
+  value: string;
+}
+//#endregion
+export { IPNSPublishResponse };
+//# sourceMappingURL=iPNSPublishResponse.d.ts.map

package/dist/esm/api/generated/schemas/iPNSResolveResponse.d.ts

@@ -0,0 +1,47 @@
+//#region src/api/generated/schemas/iPNSResolveResponse.d.ts
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Portal IPFS Plugin API
+ *
+## Portal IPFS Plugin API
+
+A comprehensive API for IPFS content management, including pinning services, file operations, IPNS key management, and website hosting.
+
+### IPFS Pinning Service API Compatibility
+
+This API is fully compatible with the [IPFS Pinning Service API specification](https://github.com/ipfs/pinning-services-api-spec), an implementation-agnostic API standard for pinning service providers. This ensures interoperability with existing IPFS pinning clients and tools.
+
+### Features
+
+- **Pinning**: Add, list, update, and remove pinned content
+- **Content**: Upload files, retrieve IPFS content, and manage metadata
+- **IPNS**: Manage IPNS keys and publish content
+- **Files**: Browse and manage pinned files with directory navigation
+- **Websites**: Create and manage website hosting with DNS and SSL automation
+
+### Authentication
+
+All API endpoints require authentication using JWT tokens obtained from the Portal authentication service.
+
+### Rate Limiting
+
+API requests are rate-limited based on user account tier. See Portal documentation for current limits.
+
+### Documentation
+
+For detailed API usage examples and integration guides, visit the Portal documentation website.
+
+ * OpenAPI spec version: 1.0.0
+ */
+interface IPNSResolveResponse {
+  expired: boolean;
+  expires: string;
+  name: string;
+  path: string;
+  sequence: number;
+  value: string;
+}
+//#endregion
+export { IPNSResolveResponse };
+//# sourceMappingURL=iPNSResolveResponse.d.ts.map

package/dist/esm/api/generated/schemas/sSLStatusInfo.d.ts

@@ -0,0 +1,45 @@
+//#region src/api/generated/schemas/sSLStatusInfo.d.ts
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Portal IPFS Plugin API
+ *
+## Portal IPFS Plugin API
+
+A comprehensive API for IPFS content management, including pinning services, file operations, IPNS key management, and website hosting.
+
+### IPFS Pinning Service API Compatibility
+
+This API is fully compatible with the [IPFS Pinning Service API specification](https://github.com/ipfs/pinning-services-api-spec), an implementation-agnostic API standard for pinning service providers. This ensures interoperability with existing IPFS pinning clients and tools.
+
+### Features
+
+- **Pinning**: Add, list, update, and remove pinned content
+- **Content**: Upload files, retrieve IPFS content, and manage metadata
+- **IPNS**: Manage IPNS keys and publish content
+- **Files**: Browse and manage pinned files with directory navigation
+- **Websites**: Create and manage website hosting with DNS and SSL automation
+
+### Authentication
+
+All API endpoints require authentication using JWT tokens obtained from the Portal authentication service.
+
+### Rate Limiting
+
+API requests are rate-limited based on user account tier. See Portal documentation for current limits.
+
+### Documentation
+
+For detailed API usage examples and integration guides, visit the Portal documentation website.
+
+ * OpenAPI spec version: 1.0.0
+ */
+interface SSLStatusInfo {
+  error?: string;
+  issued_at?: string;
+  last_updated_at?: string;
+  status: string;
+}
+//#endregion
+export { SSLStatusInfo };
+//# sourceMappingURL=sSLStatusInfo.d.ts.map

package/dist/esm/api/generated/schemas/websiteConfigResponse.d.ts

@@ -0,0 +1,43 @@
+//#region src/api/generated/schemas/websiteConfigResponse.d.ts
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Portal IPFS Plugin API
+ *
+## Portal IPFS Plugin API
+
+A comprehensive API for IPFS content management, including pinning services, file operations, IPNS key management, and website hosting.
+
+### IPFS Pinning Service API Compatibility
+
+This API is fully compatible with the [IPFS Pinning Service API specification](https://github.com/ipfs/pinning-services-api-spec), an implementation-agnostic API standard for pinning service providers. This ensures interoperability with existing IPFS pinning clients and tools.
+
+### Features
+
+- **Pinning**: Add, list, update, and remove pinned content
+- **Content**: Upload files, retrieve IPFS content, and manage metadata
+- **IPNS**: Manage IPNS keys and publish content
+- **Files**: Browse and manage pinned files with directory navigation
+- **Websites**: Create and manage website hosting with DNS and SSL automation
+
+### Authentication
+
+All API endpoints require authentication using JWT tokens obtained from the Portal authentication service.
+
+### Rate Limiting
+
+API requests are rate-limited based on user account tier. See Portal documentation for current limits.
+
+### Documentation
+
+For detailed API usage examples and integration guides, visit the Portal documentation website.
+
+ * OpenAPI spec version: 1.0.0
+ */
+interface WebsiteConfigResponse {
+  gateway_domain?: string;
+  nameservers?: string[];
+}
+//#endregion
+export { WebsiteConfigResponse };
+//# sourceMappingURL=websiteConfigResponse.d.ts.map