@aigne/afs-s3 1.11.0-beta.10

package/LICENSE.md

@@ -0,0 +1,26 @@
+# Proprietary License
+
+Copyright (c) 2024-2025 ArcBlock, Inc. All Rights Reserved.
+
+This software and associated documentation files (the "Software") are proprietary
+and confidential. Unauthorized copying, modification, distribution, or use of
+this Software, via any medium, is strictly prohibited.
+
+The Software is provided for internal use only within ArcBlock, Inc. and its
+authorized affiliates.
+
+## No License Granted
+
+No license, express or implied, is granted to any party for any purpose.
+All rights are reserved by ArcBlock, Inc.
+
+## Public Artifact Distribution
+
+Portions of this Software may be released publicly under separate open-source
+licenses (such as MIT License) through designated public repositories. Such
+public releases are governed by their respective licenses and do not affect
+the proprietary nature of this repository.
+
+## Contact
+
+For licensing inquiries, contact: legal@arcblock.io

package/dist/index.d.mts

@@ -0,0 +1,202 @@
+import { AFSAccessMode, AFSBaseProvider, AFSDeleteResult, AFSEntry, AFSExecResult, AFSExplainResult, AFSListResult, AFSModuleLoadParams, AFSSearchResult, AFSStatResult, AFSWriteEntryPayload, AFSWriteResult, ProviderManifest, RouteContext } from "@aigne/afs";
+import { S3Client } from "@aws-sdk/client-s3";
+import { z } from "zod";
+
+//#region src/types.d.ts
+/**
+ * Configuration options for AFSS3
+ */
+interface AFSS3Options {
+  /** Module name (used as mount path segment) */
+  name?: string;
+  /** Module description */
+  description?: string;
+  /** S3 bucket name */
+  bucket: string;
+  /** Key prefix (optional) */
+  prefix?: string;
+  /** AWS region (defaults to environment) */
+  region?: string;
+  /** Access mode */
+  accessMode?: "readonly" | "readwrite";
+  /** Custom endpoint for S3-compatible services (MinIO, R2, B2) */
+  endpoint?: string;
+  /** Force path-style URLs (needed for some S3-compatible services) */
+  forcePathStyle?: boolean;
+  /** AWS credentials profile name */
+  profile?: string;
+  /** Explicit credentials (for testing or non-AWS environments) */
+  credentials?: {
+    accessKeyId: string;
+    secretAccessKey: string;
+    sessionToken?: string;
+  };
+  /** Cache TTL in seconds (0 = no cache, Phase 4) */
+  cacheTtl?: number;
+  /**
+   * Pre-configured S3 client (for testing or advanced use cases)
+   * If provided, endpoint/region/credentials/profile options are ignored.
+   */
+  client?: S3Client;
+}
+/**
+ * Parsed S3 URI
+ */
+interface ParsedS3Uri {
+  bucket: string;
+  prefix: string;
+}
+//#endregion
+//#region src/s3-afs.d.ts
+/**
+ * AFSS3 Provider using Base Provider pattern
+ *
+ * Provides access to AWS S3 and S3-compatible storage through AFS.
+ * Uses decorator routing (@List, @Read, @Write, @Delete, @Meta, @Actions).
+ *
+ * @example
+ * ```typescript
+ * const s3 = new AFSS3({
+ *   bucket: "my-bucket",
+ *   prefix: "data",
+ *   region: "us-east-1",
+ * });
+ *
+ * // Mount to AFS
+ * afs.mount(s3);
+ *
+ * // List objects
+ * const result = await afs.list("/modules/my-bucket/data");
+ *
+ * // Read object
+ * const content = await afs.read("/modules/my-bucket/data/file.json");
+ * ```
+ */
+declare class AFSS3 extends AFSBaseProvider {
+  readonly name: string;
+  readonly description?: string;
+  readonly accessMode: AFSAccessMode;
+  private options;
+  private client;
+  private listCache?;
+  private statCache?;
+  constructor(options: AFSS3Options & {
+    uri?: string;
+    token?: string;
+    auth?: unknown;
+  });
+  /**
+   * Schema for configuration validation
+   */
+  static schema(): z.ZodType<{
+    name: string | undefined;
+    description: string | undefined;
+    bucket: string;
+    prefix: string | undefined;
+    region: string | undefined;
+    accessMode: "readonly" | "readwrite" | undefined;
+    endpoint: string | undefined;
+    forcePathStyle: boolean | undefined;
+    profile: string | undefined;
+    credentials: {
+      accessKeyId: string;
+      secretAccessKey: string;
+      sessionToken: string | undefined;
+    } | undefined;
+    cacheTtl: number | undefined;
+  }, unknown, z.core.$ZodTypeInternals<{
+    name: string | undefined;
+    description: string | undefined;
+    bucket: string;
+    prefix: string | undefined;
+    region: string | undefined;
+    accessMode: "readonly" | "readwrite" | undefined;
+    endpoint: string | undefined;
+    forcePathStyle: boolean | undefined;
+    profile: string | undefined;
+    credentials: {
+      accessKeyId: string;
+      secretAccessKey: string;
+      sessionToken: string | undefined;
+    } | undefined;
+    cacheTtl: number | undefined;
+  }, unknown>>;
+  /**
+   * Provider manifest for URI-based discovery
+   */
+  static manifest(): ProviderManifest;
+  /**
+   * Load from configuration file
+   */
+  static load({
+    basePath,
+    config
+  }?: AFSModuleLoadParams): Promise<AFSS3>;
+  /**
+   * Build the full S3 key from a path
+   */
+  private buildS3Key;
+  /**
+   * Generate a unique ID for an S3 object
+   */
+  private generateId;
+  /**
+   * Invalidate caches for a given path
+   */
+  private invalidateCache;
+  /**
+   * Clear all caches
+   */
+  clearCache(): void;
+  listHandler(ctx: RouteContext<{
+    path?: string;
+  }>): Promise<AFSListResult>;
+  /**
+   * List with delimiter (single level)
+   */
+  private listWithDelimiter;
+  listVersionsHandler(ctx: RouteContext<{
+    path: string;
+  }>): Promise<AFSListResult>;
+  readHandler(ctx: RouteContext<{
+    path: string;
+  }>): Promise<AFSEntry>;
+  readVersionHandler(ctx: RouteContext<{
+    path: string;
+    versionId: string;
+  }>): Promise<AFSEntry>;
+  metaHandler(ctx: RouteContext<{
+    path?: string;
+  }>): Promise<AFSEntry>;
+  statHandler(ctx: RouteContext<{
+    path?: string;
+  }>): Promise<AFSStatResult>;
+  writeHandler(ctx: RouteContext<{
+    path: string;
+  }>, payload: AFSWriteEntryPayload): Promise<AFSWriteResult>;
+  deleteHandler(ctx: RouteContext<{
+    path: string;
+  }>): Promise<AFSDeleteResult>;
+  listActionsHandler(ctx: RouteContext<{
+    path: string;
+  }>): Promise<AFSListResult>;
+  selectActionHandler(ctx: RouteContext<{
+    path: string;
+  }>, args: Record<string, unknown>): Promise<AFSExecResult>;
+  presignDownloadActionHandler(ctx: RouteContext<{
+    path: string;
+  }>, args: Record<string, unknown>): Promise<AFSExecResult>;
+  presignUploadActionHandler(ctx: RouteContext<{
+    path: string;
+  }>, args: Record<string, unknown>): Promise<AFSExecResult>;
+  explainHandler(ctx: RouteContext<{
+    path?: string;
+  }>): Promise<AFSExplainResult>;
+  searchHandler(ctx: RouteContext<{
+    path?: string;
+  }>, query: string): Promise<AFSSearchResult>;
+  readCapabilities(_ctx: RouteContext): Promise<AFSEntry>;
+}
+//#endregion
+export { AFSS3, AFSS3 as default, type AFSS3Options, type ParsedS3Uri };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/types.ts","../src/s3-afs.ts"],"mappings":";;;;;AAWA;;;AAAA,UAAiB,YAAA;EAEf;EAAA,IAAA;EAMA;EAHA,WAAA;EASA;EANA,MAAA;EAYA;EATA,MAAA;EAeA;EAZA,MAAA;EAgBE;EAbF,UAAA;EAeE;EAZF,QAAA;EAsBA;EAnBA,cAAA;EAmBiB;EAhBjB,OAAA;EAuEe;EApEf,WAAA;IACE,WAAA;IACA,eAAA;IACA,YAAA;EAAA;;EAIF,QAAA;EC4CW;;;;EDtCX,MAAA,GAAS,QAAA;AAAA;;;;UAuDM,WAAA;EACf,MAAA;EACA,MAAA;AAAA;;;;;;;;;;;;;;;;;;;;;AAFF;;;;;;cCjBa,KAAA,SAAc,eAAA;EAAA,SACP,IAAA;EAAA,SACA,WAAA;EAAA,SACA,UAAA,EAAY,aAAA;EAAA,QAEtB,OAAA;EAAA,QACA,MAAA;EAAA,QACA,SAAA;EAAA,QACA,SAAA;cAEI,OAAA,EAAS,YAAA;IAAiB,GAAA;IAAc,KAAA;IAAgB,IAAA;EAAA;EA+DO;;;EAAA,OA9BpE,MAAA,CAAA,GAAM,CAAA,CAAA,OAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA65BF;;;EAAA,OAt5BJ,QAAA,CAAA,GAAY,gBAAA;EAm7BR;;;EAAA,OA55BE,IAAA,CAAA;IAAO,QAAA;IAAU;EAAA,IAAU,mBAAA,GAA2B,OAAA,CAAQ,KAAA;EA07Bf;;;EAAA,QAh7BpD,UAAA;EAwkCqB;;;EAAA,QAhkCrB,UAAA;EA3FgC;;;EAAA,QAmGhC,eAAA;EAjGU;;;EAkHlB,UAAA,CAAA;EASM,WAAA,CAAY,GAAA,EAAK,YAAA;IAAe,IAAA;EAAA,KAAmB,OAAA,CAAQ,aAAA;;;;UAsEnD,iBAAA;EAkIR,mBAAA,CAAoB,GAAA,EAAK,YAAA;IAAe,IAAA;EAAA,KAAkB,OAAA,CAAQ,aAAA;EA4ClE,WAAA,CAAY,GAAA,EAAK,YAAA;IAAe,IAAA;EAAA,KAAkB,OAAA,CAAQ,QAAA;EA8J1D,kBAAA,CACJ,GAAA,EAAK,YAAA;IAAe,IAAA;IAAc,SAAA;EAAA,KACjC,OAAA,CAAQ,QAAA;EAqCL,WAAA,CAAY,GAAA,EAAK,YAAA;IAAe,IAAA;EAAA,KAAmB,OAAA,CAAQ,QAAA;EAyK3D,WAAA,CAAY,GAAA,EAAK,YAAA;IAAe,IAAA;EAAA,KAAmB,OAAA,CAAQ,aAAA;EAuB3D,YAAA,CACJ,GAAA,EAAK,YAAA;IAAe,IAAA;EAAA,IACpB,OAAA,EAAS,oBAAA,GACR,OAAA,CAAQ,cAAA;EA2EL,aAAA,CAAc,GAAA,EAAK,YAAA;IAAe,IAAA;EAAA,KAAkB,OAAA,CAAQ,eAAA;EA0C5D,kBAAA,CAAmB,GAAA,EAAK,YAAA;IAAe,IAAA;EAAA,KAAkB,OAAA,CAAQ,aAAA;EA4DjE,mBAAA,CACJ,GAAA,EAAK,YAAA;IAAe,IAAA;EAAA,IACpB,IAAA,EAAM,MAAA,oBACL,OAAA,CAAQ,aAAA;EAwBL,4BAAA,CACJ,GAAA,EAAK,YAAA;IAAe,IAAA;EAAA,IACpB,IAAA,EAAM,MAAA,oBACL,OAAA,CAAQ,aAAA;EA0BL,0BAAA,CACJ,GAAA,EAAK,YAAA;IAAe,IAAA;EAAA,IACpB,IAAA,EAAM,MAAA,oBACL,OAAA,CAAQ,aAAA;EA8BL,cAAA,CAAe,GAAA,EAAK,YAAA;IAAe,IAAA;EAAA,KAAmB,OAAA,CAAQ,gBAAA;EA4F9D,aAAA,CACJ,GAAA,EAAK,YAAA;IAAe,IAAA;EAAA,IACpB,KAAA,WACC,OAAA,CAAQ,eAAA;EAyDL,gBAAA,CAAiB,IAAA,EAAM,YAAA,GAAe,OAAA,CAAQ,QAAA;AAAA"}