@aigne/afs-gcs 1.11.0-beta.6

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,246 @@
+import { AFSAccessMode, AFSBaseProvider, AFSDeleteResult, AFSEntry, AFSExecResult, AFSListResult, AFSModuleLoadParams, AFSStatResult, AFSWriteEntryPayload, AFSWriteResult, RouteContext } from "@aigne/afs";
+import * as zod0 from "zod";
+import { z } from "zod";
+
+//#region src/types.d.ts
+/**
+ * Configuration options for AFSGCS
+ */
+interface AFSGCSOptions {
+  /** Module name (used as mount path segment) */
+  name?: string;
+  /** Module description */
+  description?: string;
+  /** GCS bucket name */
+  bucket: string;
+  /** Key prefix (optional) */
+  prefix?: string;
+  /** GCP project ID */
+  projectId?: string;
+  /** Access mode */
+  accessMode?: "readonly" | "readwrite";
+  /** Custom endpoint for GCS-compatible services (fake-gcs-server) */
+  endpoint?: string;
+  /** Path to service account key file */
+  keyFilename?: string;
+  /** Explicit credentials (for programmatic access) */
+  credentials?: {
+    clientEmail: string;
+    privateKey: string;
+  };
+  /** Cache TTL in seconds (0 = no cache) */
+  cacheTtl?: number;
+}
+/**
+ * Parsed GCS URI
+ */
+interface ParsedGCSUri {
+  bucket: string;
+  prefix: string;
+}
+//#endregion
+//#region src/gcs-afs.d.ts
+/**
+ * AFSGCS Provider using Base Provider pattern
+ *
+ * Provides access to Google Cloud Storage through AFS.
+ * Uses decorator routing (@List, @Read, @Write, @Delete, @Meta, @Actions).
+ *
+ * @example
+ * ```typescript
+ * const gcs = new AFSGCS({
+ *   bucket: "my-bucket",
+ *   prefix: "data",
+ *   projectId: "my-project",
+ * });
+ *
+ * // Mount to AFS
+ * afs.mount(gcs);
+ *
+ * // 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 AFSGCS extends AFSBaseProvider {
+  readonly name: string;
+  readonly description?: string;
+  readonly accessMode: AFSAccessMode;
+  private options;
+  private storage;
+  private bucket;
+  private listCache?;
+  private statCache?;
+  constructor(options: AFSGCSOptions);
+  /**
+   * Schema for configuration validation
+   */
+  static schema(): zod0.ZodEffects<zod0.ZodObject<{
+    name: zod0.ZodType<string | undefined, zod0.ZodTypeDef, string | undefined>;
+    description: zod0.ZodType<string | undefined, zod0.ZodTypeDef, string | undefined>;
+    bucket: zod0.ZodEffects<zod0.ZodString, string, string>;
+    prefix: zod0.ZodType<string | undefined, zod0.ZodTypeDef, string | undefined>;
+    projectId: zod0.ZodType<string | undefined, zod0.ZodTypeDef, string | undefined>;
+    accessMode: zod0.ZodType<"readonly" | "readwrite" | undefined, zod0.ZodTypeDef, "readonly" | "readwrite" | undefined>;
+    endpoint: zod0.ZodType<string | undefined, zod0.ZodTypeDef, string | undefined>;
+    keyFilename: zod0.ZodType<string | undefined, zod0.ZodTypeDef, string | undefined>;
+    credentials: zod0.ZodType<{
+      clientEmail: string;
+      privateKey: string;
+    } | undefined, zod0.ZodTypeDef, {
+      clientEmail: string;
+      privateKey: string;
+    } | undefined>;
+    cacheTtl: zod0.ZodType<number | undefined, zod0.ZodTypeDef, number | undefined>;
+  }, "strict", zod0.ZodTypeAny, {
+    bucket: string;
+    name?: string | undefined;
+    description?: string | undefined;
+    prefix?: string | undefined;
+    projectId?: string | undefined;
+    accessMode?: "readonly" | "readwrite" | undefined;
+    endpoint?: string | undefined;
+    keyFilename?: string | undefined;
+    credentials?: {
+      clientEmail: string;
+      privateKey: string;
+    } | undefined;
+    cacheTtl?: number | undefined;
+  }, {
+    bucket: string;
+    name?: string | undefined;
+    description?: string | undefined;
+    prefix?: string | undefined;
+    projectId?: string | undefined;
+    accessMode?: "readonly" | "readwrite" | undefined;
+    endpoint?: string | undefined;
+    keyFilename?: string | undefined;
+    credentials?: {
+      clientEmail: string;
+      privateKey: string;
+    } | undefined;
+    cacheTtl?: number | undefined;
+  }>, {
+    bucket: string;
+    name?: string | undefined;
+    description?: string | undefined;
+    prefix?: string | undefined;
+    projectId?: string | undefined;
+    accessMode?: "readonly" | "readwrite" | undefined;
+    endpoint?: string | undefined;
+    keyFilename?: string | undefined;
+    credentials?: {
+      clientEmail: string;
+      privateKey: string;
+    } | undefined;
+    cacheTtl?: number | undefined;
+  }, any>;
+  /**
+   * Load from configuration file
+   */
+  static load(params: AFSModuleLoadParams): Promise<AFSGCS>;
+  /**
+   * Build the full GCS key from a path
+   */
+  private buildGCSKey;
+  /**
+   * Generate a unique ID for a GCS 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;
+    generation: 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>;
+  signDownloadActionHandler(ctx: RouteContext<{
+    path: string;
+  }>, args: Record<string, unknown>): Promise<AFSExecResult>;
+  signUploadActionHandler(ctx: RouteContext<{
+    path: string;
+  }>, args: Record<string, unknown>): Promise<AFSExecResult>;
+  composeActionHandler(ctx: RouteContext<{
+    path: string;
+  }>, args: Record<string, unknown>): Promise<AFSExecResult>;
+  rewriteActionHandler(ctx: RouteContext<{
+    path: string;
+  }>, args: Record<string, unknown>): Promise<AFSExecResult>;
+  /**
+   * Generate a signed URL for downloading an object
+   * @deprecated Use action /.actions/sign-download instead
+   */
+  getSignedDownloadUrl(path: string, options?: {
+    expiresIn?: number;
+  }): Promise<string>;
+  /**
+   * Generate a signed URL for uploading an object
+   * @deprecated Use action /.actions/sign-upload instead
+   */
+  getSignedUploadUrl(path: string, options?: {
+    expiresIn?: number;
+    contentType?: string;
+  }): Promise<string>;
+  /**
+   * List all versions (generations) of an object
+   * @deprecated Use list on /:path/@versions instead
+   */
+  listVersions(path: string): Promise<Array<{
+    generation: string;
+    isLive: boolean;
+    timeCreated?: Date;
+    size: number;
+    etag?: string;
+  }>>;
+  /**
+   * Read a specific version (generation) of an object
+   * @deprecated Use read on /:path/@versions/:generation instead
+   */
+  readVersion(path: string, generation: string): Promise<{
+    content: string;
+    metadata: Record<string, unknown>;
+  }>;
+  /**
+   * Create a directory marker
+   * @deprecated Use write with empty content instead
+   */
+  mkdir(path: string): Promise<void>;
+}
+//#endregion
+export { AFSGCS, type AFSGCSOptions, type ParsedGCSUri };
+//# 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/gcs-afs.ts"],"mappings":";;;;;;AAUA;;UAAiB,aAAA;EAAa;EAE5B,IAAA;EAGA;EAAA,WAAA;EAMA;EAHA,MAAA;EASA;EANA,MAAA;EAYA;EATA,SAAA;EAaE;EAVF,UAAA;EAeA;EAZA,QAAA;EAYQ;EATR,WAAA;EAgE2B;EA7D3B,WAAA;IACE,WAAA;IACA,UAAA;EAAA;;EAIF,QAAA;AAAA;;;;UAuDe,YAAA;EACf,MAAA;EACA,MAAA;AAAA;;;;;;;;;;;;;;;;;;AAFF;;;;;;;;ACpBA;cAAa,MAAA,SAAe,eAAA;EAAA,SACR,IAAA;EAAA,SACA,WAAA;EAAA,SACA,UAAA,EAAY,aAAA;EAAA,QAEtB,OAAA;EAAA,QACA,OAAA;EAAA,QACA,MAAA;EAAA,QACA,SAAA;EAAA,QACA,SAAA;cAEI,OAAA,EAAS,aAAA;;;;SA+Bd,MAAA,CAAA,GAAM,IAAA,CAAA,UAAA,MAAA,SAAA;2CA/BqB,IAAA,CAAA,UAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAy7B/B;;;EAAA,OAn5BU,IAAA,CAAK,MAAA,EAAQ,mBAAA,GAAsB,OAAA,CAAQ,MAAA;EAo+BtD;;;EAAA,QA19BM,WAAA;EAugCmB;;;EAAA,QA//BnB,UAAA;EAnEkB;;;EAAA,QA0ElB,eAAA;EAvEsB;;;EAwF9B,UAAA,CAAA;EASM,WAAA,CAAY,GAAA,EAAK,YAAA;IAAe,IAAA;EAAA,KAAmB,OAAA,CAAQ,aAAA;EAzF5C;;;EAAA,QA4JP,iBAAA;EA0JR,mBAAA,CAAoB,GAAA,EAAK,YAAA;IAAe,IAAA;EAAA,KAAkB,OAAA,CAAQ,aAAA;EAgDlE,WAAA,CAAY,GAAA,EAAK,YAAA;IAAe,IAAA;EAAA,KAAkB,OAAA,CAAQ,QAAA;EA8H1D,kBAAA,CACJ,GAAA,EAAK,YAAA;IAAe,IAAA;IAAc,UAAA;EAAA,KACjC,OAAA,CAAQ,QAAA;EA0CL,WAAA,CAAY,GAAA,EAAK,YAAA;IAAe,IAAA;EAAA,KAAmB,OAAA,CAAQ,QAAA;EAmJ3D,WAAA,CAAY,GAAA,EAAK,YAAA;IAAe,IAAA;EAAA,KAAmB,OAAA,CAAQ,aAAA;EAoB3D,YAAA,CACJ,GAAA,EAAK,YAAA;IAAe,IAAA;EAAA,IACpB,OAAA,EAAS,oBAAA,GACR,OAAA,CAAQ,cAAA;EAiEL,aAAA,CAAc,GAAA,EAAK,YAAA;IAAe,IAAA;EAAA,KAAkB,OAAA,CAAQ,eAAA;EA4C5D,kBAAA,CAAmB,GAAA,EAAK,YAAA;IAAe,IAAA;EAAA,KAAkB,OAAA,CAAQ,aAAA;EAiCjE,yBAAA,CACJ,GAAA,EAAK,YAAA;IAAe,IAAA;EAAA,IACpB,IAAA,EAAM,MAAA,oBACL,OAAA,CAAQ,aAAA;EA0BL,uBAAA,CACJ,GAAA,EAAK,YAAA;IAAe,IAAA;EAAA,IACpB,IAAA,EAAM,MAAA,oBACL,OAAA,CAAQ,aAAA;EA4BL,oBAAA,CACJ,GAAA,EAAK,YAAA;IAAe,IAAA;EAAA,IACpB,IAAA,EAAM,MAAA,oBACL,OAAA,CAAQ,aAAA;EA+CL,oBAAA,CACJ,GAAA,EAAK,YAAA;IAAe,IAAA;EAAA,IACpB,IAAA,EAAM,MAAA,oBACL,OAAA,CAAQ,aAAA;;;;;EAqDL,oBAAA,CAAqB,IAAA,UAAc,OAAA;IAAY,SAAA;EAAA,IAAuB,OAAA;;;;;EAYtE,kBAAA,CACJ,IAAA,UACA,OAAA;IAAY,SAAA;IAAoB,WAAA;EAAA,IAC/B,OAAA;;;;;EAYG,YAAA,CAAa,IAAA,WAAe,OAAA,CAChC,KAAA;IACE,UAAA;IACA,MAAA;IACA,WAAA,GAAc,IAAA;IACd,IAAA;IACA,IAAA;EAAA;;;;;EAqBE,WAAA,CACJ,IAAA,UACA,UAAA,WACC,OAAA;IAAU,OAAA;IAAiB,QAAA,EAAU,MAAA;EAAA;;;;;EAgBlC,KAAA,CAAM,IAAA,WAAe,OAAA;AAAA"}