@aigne/afs-registry 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,191 @@
+import { AFSBaseProvider, AFSEntry, AFSExecResult, AFSExplainOptions, AFSExplainResult, AFSListOptions, AFSListResult, AFSReadOptions, AFSReadResult, AFSRoot, AFSSearchOptions, AFSSearchResult, AFSStatOptions, AFSStatResult, RouteContext } from "@aigne/afs";
+
+//#region src/index.d.ts
+/**
+ * A single provider manifest entry in the registry.
+ *
+ * Aligned with the core ProviderManifest (serialized form: schema as JSON Schema
+ * instead of Zod, camelCase field names).
+ */
+interface ProviderManifest {
+  name: string;
+  description: string;
+  category: string;
+  /** URI template with {param} placeholders, e.g. "s3://{bucket}/{prefix+?}" */
+  uriTemplate: string;
+  /** JSON Schema describing provider parameters (serialized from Zod) */
+  schema?: Record<string, unknown>;
+  tags?: string[];
+  useCases?: string[];
+}
+/**
+ * Options for constructing an AFSRegistry provider.
+ */
+interface AFSRegistryOptions {
+  /** Static provider manifests (for testing / offline use). Overrides url if provided. */
+  providers?: ProviderManifest[];
+  /** Remote URL to fetch provider manifests from. Falls back to bundled data on failure. */
+  url?: string;
+}
+/**
+ * AFS Registry Provider — virtual file tree for discovering and mounting providers.
+ *
+ * File tree:
+ * ```
+ * /
+ * ├── providers/{name}/manifest.json
+ * ├── providers/{name}/README.md
+ * ├── providers/{name}/.actions/mount
+ * ├── by-category/{category}/{name}/
+ * ├── by-tag/{tag}/{name}/
+ * └── .actions/search
+ * ```
+ */
+declare class AFSRegistry extends AFSBaseProvider {
+  readonly name = "registry";
+  readonly description = "AFS Provider Registry \u2014 discover and install available providers.\n- Browse providers by name, category, or tag\n- Read provider manifests, README docs, and configuration schemas\n- Search providers by keyword (name, description, tags, use cases)\n- Exec actions: `search` (full-text query), `mount` (per-provider, install to AFS)\n- Path structure: `/providers/{name}/manifest.json`, `/by-category/{cat}`, `/by-tag/{tag}`";
+  readonly accessMode: "readwrite";
+  private providers;
+  private remoteUrl?;
+  private fetchPromise?;
+  private loadProviderFn?;
+  constructor(options?: AFSRegistryOptions);
+  private fetchRemoteProviders;
+  private ensureLoaded;
+  onMount(root: AFSRoot): void;
+  list(path: string, options?: AFSListOptions): Promise<AFSListResult>;
+  read(path: string, options?: AFSReadOptions): Promise<AFSReadResult>;
+  stat(path: string, options?: AFSStatOptions): Promise<AFSStatResult>;
+  search(path: string, query: string, options?: AFSSearchOptions): Promise<AFSSearchResult>;
+  exec(path: string, args: Record<string, unknown>, options: Record<string, unknown>): Promise<AFSExecResult>;
+  explain(path: string, options?: AFSExplainOptions): Promise<AFSExplainResult>;
+  private buildByCategory;
+  private buildByTag;
+  private findProvider;
+  listRoot(_ctx: RouteContext): Promise<{
+    data: AFSEntry[];
+  }>;
+  listProviders(_ctx: RouteContext): Promise<{
+    data: AFSEntry[];
+  }>;
+  listProviderContents(ctx: RouteContext<{
+    name: string;
+  }>): Promise<{
+    data: AFSEntry[];
+  }>;
+  listCategories(_ctx: RouteContext): Promise<{
+    data: AFSEntry[];
+  }>;
+  listCategoryProviders(ctx: RouteContext<{
+    category: string;
+  }>): Promise<{
+    data: AFSEntry[];
+  }>;
+  listTags(_ctx: RouteContext): Promise<{
+    data: AFSEntry[];
+  }>;
+  listCategoryProviderChildren(ctx: RouteContext<{
+    category: string;
+    name: string;
+  }>): Promise<{
+    data: AFSEntry[];
+  }>;
+  listTagProviders(ctx: RouteContext<{
+    tag: string;
+  }>): Promise<{
+    data: AFSEntry[];
+  }>;
+  listTagProviderChildren(ctx: RouteContext<{
+    tag: string;
+    name: string;
+  }>): Promise<{
+    data: AFSEntry[];
+  }>;
+  listFileNode(ctx: RouteContext<{
+    name: string;
+  }>): Promise<{
+    data: AFSEntry[];
+  }>;
+  readRoot(_ctx: RouteContext): Promise<AFSEntry | undefined>;
+  readProviders(_ctx: RouteContext): Promise<AFSEntry | undefined>;
+  readProvider(ctx: RouteContext<{
+    name: string;
+  }>): Promise<AFSEntry | undefined>;
+  readManifest(ctx: RouteContext<{
+    name: string;
+  }>): Promise<AFSEntry | undefined>;
+  readReadme(ctx: RouteContext<{
+    name: string;
+  }>): Promise<AFSEntry | undefined>;
+  readByCategory(_ctx: RouteContext): Promise<AFSEntry | undefined>;
+  readCategory(ctx: RouteContext<{
+    category: string;
+  }>): Promise<AFSEntry | undefined>;
+  readCategoryProvider(ctx: RouteContext<{
+    category: string;
+    name: string;
+  }>): Promise<AFSEntry | undefined>;
+  readByTag(_ctx: RouteContext): Promise<AFSEntry | undefined>;
+  readTag(ctx: RouteContext<{
+    tag: string;
+  }>): Promise<AFSEntry | undefined>;
+  readTagProvider(ctx: RouteContext<{
+    tag: string;
+    name: string;
+  }>): Promise<AFSEntry | undefined>;
+  readCapabilities(_ctx: RouteContext): Promise<AFSEntry | undefined>;
+  rootMeta(_ctx: RouteContext): Promise<AFSEntry>;
+  providersMeta(_ctx: RouteContext): Promise<AFSEntry>;
+  providerMeta(ctx: RouteContext<{
+    name: string;
+  }>): Promise<AFSEntry>;
+  manifestMeta(ctx: RouteContext<{
+    name: string;
+  }>): Promise<AFSEntry>;
+  readmeMeta(ctx: RouteContext<{
+    name: string;
+  }>): Promise<AFSEntry>;
+  byCategoryMeta(_ctx: RouteContext): Promise<AFSEntry>;
+  categoryMeta(ctx: RouteContext<{
+    category: string;
+  }>): Promise<AFSEntry>;
+  categoryProviderMeta(ctx: RouteContext<{
+    category: string;
+    name: string;
+  }>): Promise<AFSEntry>;
+  byTagMeta(_ctx: RouteContext): Promise<AFSEntry>;
+  tagMeta(ctx: RouteContext<{
+    tag: string;
+  }>): Promise<AFSEntry>;
+  tagProviderMeta(ctx: RouteContext<{
+    tag: string;
+    name: string;
+  }>): Promise<AFSEntry>;
+  listRootActions(_ctx: RouteContext): Promise<{
+    data: AFSEntry[];
+  }>;
+  searchProviders(_ctx: RouteContext, args: Record<string, unknown>): Promise<AFSExecResult>;
+  /**
+   * Build mount action inputSchema for a provider
+   */
+  private buildMountSchema;
+  listProviderActions(ctx: RouteContext<{
+    name: string;
+  }>): Promise<{
+    data: AFSEntry[];
+  }>;
+  readMountAction(ctx: RouteContext<{
+    name: string;
+  }>): Promise<AFSEntry | undefined>;
+  mountProvider(ctx: RouteContext<{
+    name: string;
+  }>, args: Record<string, unknown>): Promise<AFSExecResult>;
+  searchRoot(_ctx: RouteContext, query: string, options?: {
+    limit?: number;
+  }): Promise<AFSSearchResult>;
+  explainPath(_ctx: RouteContext): Promise<AFSExplainResult>;
+  statPath(ctx: RouteContext): Promise<AFSStatResult>;
+}
+//#endregion
+export { AFSRegistry, AFSRegistryOptions, ProviderManifest };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/index.ts"],"mappings":";;;;;AAoCA;;;;UAAiB,gBAAA;EACf,IAAA;EACA,WAAA;EACA,QAAA;EAIA;EAFA,WAAA;EAGA;EADA,MAAA,GAAS,MAAA;EACT,IAAA;EACA,QAAA;AAAA;;;;UAMe,kBAAA;EAEH;EAAZ,SAAA,GAAY,gBAAA;EAET;EAAH,GAAA;AAAA;;;;;;;;;;;;;;;cAiBW,WAAA,SAAoB,eAAA;EAAA,SACtB,IAAA;EAAA,SACA,WAAA;EAAA,SAEA,UAAA;EAAA,QAED,SAAA;EAAA,QACA,SAAA;EAAA,QACA,YAAA;EAAA,QACA,cAAA;cAMI,OAAA,GAAS,kBAAA;EAAA,QAeP,oBAAA;EAAA,QA8BA,YAAA;EAOd,OAAA,CAAQ,IAAA,EAAM,OAAA;EAMC,IAAA,CAAK,IAAA,UAAc,OAAA,GAAU,cAAA,GAAiB,OAAA,CAAQ,aAAA;EAKtD,IAAA,CAAK,IAAA,UAAc,OAAA,GAAU,cAAA,GAAiB,OAAA,CAAQ,aAAA;EAKtD,IAAA,CAAK,IAAA,UAAc,OAAA,GAAU,cAAA,GAAiB,OAAA,CAAQ,aAAA;EAKtD,MAAA,CACb,IAAA,UACA,KAAA,UACA,OAAA,GAAU,gBAAA,GACT,OAAA,CAAQ,eAAA;EAKI,IAAA,CACb,IAAA,UACA,IAAA,EAAM,MAAA,mBACN,OAAA,EAAS,MAAA,oBACR,OAAA,CAAQ,aAAA;EAKI,OAAA,CAAQ,IAAA,UAAc,OAAA,GAAU,iBAAA,GAAoB,OAAA,CAAQ,gBAAA;EAAA,QAOnE,eAAA;EAAA,QAUA,UAAA;EAAA,QAYA,YAAA;EAOF,QAAA,CAAS,IAAA,EAAM,YAAA,GAAY,OAAA;UAkBxB,QAAA;EAAA;EAKH,aAAA,CAAc,IAAA,EAAM,YAAA,GAAY,OAAA;UAU3B,QAAA;EAAA;EAKL,oBAAA,CAAqB,GAAA,EAAK,YAAA;IAAe,IAAA;EAAA,KAAe,OAAA;UAgBrD,QAAA;EAAA;EAKH,cAAA,CAAe,IAAA,EAAM,YAAA,GAAY,OAAA;UAM5B,QAAA;EAAA;EAKL,qBAAA,CAAsB,GAAA,EAAK,YAAA;IAAe,QAAA;EAAA,KAAmB,OAAA;UASxD,QAAA;EAAA;EAKL,QAAA,CAAS,IAAA,EAAM,YAAA,GAAY,OAAA;UAMtB,QAAA;EAAA;EAKL,4BAAA,CAA6B,GAAA,EAAK,YAAA;IAAe,QAAA;IAAkB,IAAA;EAAA,KAAe,OAAA;UAIjE,QAAA;EAAA;EAIjB,gBAAA,CAAiB,GAAA,EAAK,YAAA;IAAe,GAAA;EAAA,KAAc,OAAA;UAS9C,QAAA;EAAA;EAKL,uBAAA,CAAwB,GAAA,EAAK,YAAA;IAAe,GAAA;IAAa,IAAA;EAAA,KAAe,OAAA;UAIvD,QAAA;EAAA;EAKjB,YAAA,CAAa,GAAA,EAAK,YAAA;IAAe,IAAA;EAAA,KAAe,OAAA;UAG/B,QAAA;EAAA;EAMjB,QAAA,CAAS,IAAA,EAAM,YAAA,GAAe,OAAA,CAAQ,QAAA;EAUtC,aAAA,CAAc,IAAA,EAAM,YAAA,GAAe,OAAA,CAAQ,QAAA;EAU3C,YAAA,CAAa,GAAA,EAAK,YAAA;IAAe,IAAA;EAAA,KAAkB,OAAA,CAAQ,QAAA;EAY3D,YAAA,CAAa,GAAA,EAAK,YAAA;IAAe,IAAA;EAAA,KAAkB,OAAA,CAAQ,QAAA;EAY3D,UAAA,CAAW,GAAA,EAAK,YAAA;IAAe,IAAA;EAAA,KAAkB,OAAA,CAAQ,QAAA;EA4CzD,cAAA,CAAe,IAAA,EAAM,YAAA,GAAe,OAAA,CAAQ,QAAA;EAU5C,YAAA,CAAa,GAAA,EAAK,YAAA;IAAe,QAAA;EAAA,KAAsB,OAAA,CAAQ,QAAA;EAY/D,oBAAA,CACJ,GAAA,EAAK,YAAA;IAAe,QAAA;IAAkB,IAAA;EAAA,KACrC,OAAA,CAAQ,QAAA;EAaL,SAAA,CAAU,IAAA,EAAM,YAAA,GAAe,OAAA,CAAQ,QAAA;EAUvC,OAAA,CAAQ,GAAA,EAAK,YAAA;IAAe,GAAA;EAAA,KAAiB,OAAA,CAAQ,QAAA;EAYrD,eAAA,CACJ,GAAA,EAAK,YAAA;IAAe,GAAA;IAAa,IAAA;EAAA,KAChC,OAAA,CAAQ,QAAA;EAaL,gBAAA,CAAiB,IAAA,EAAM,YAAA,GAAe,OAAA,CAAQ,QAAA;EAuB9C,QAAA,CAAS,IAAA,EAAM,YAAA,GAAe,OAAA,CAAQ,QAAA;EAiBtC,aAAA,CAAc,IAAA,EAAM,YAAA,GAAe,OAAA,CAAQ,QAAA;EAU3C,YAAA,CAAa,GAAA,EAAK,YAAA;IAAe,IAAA;EAAA,KAAkB,OAAA,CAAQ,QAAA;EAgB3D,YAAA,CAAa,GAAA,EAAK,YAAA;IAAe,IAAA;EAAA,KAAkB,OAAA,CAAQ,QAAA;EAY3D,UAAA,CAAW,GAAA,EAAK,YAAA;IAAe,IAAA;EAAA,KAAkB,OAAA,CAAQ,QAAA;EAYzD,cAAA,CAAe,IAAA,EAAM,YAAA,GAAe,OAAA,CAAQ,QAAA;EAU5C,YAAA,CAAa,GAAA,EAAK,YAAA;IAAe,QAAA;EAAA,KAAsB,OAAA,CAAQ,QAAA;EAY/D,oBAAA,CACJ,GAAA,EAAK,YAAA;IAAe,QAAA;IAAkB,IAAA;EAAA,KACrC,OAAA,CAAQ,QAAA;EAaL,SAAA,CAAU,IAAA,EAAM,YAAA,GAAe,OAAA,CAAQ,QAAA;EAUvC,OAAA,CAAQ,GAAA,EAAK,YAAA;IAAe,GAAA;EAAA,KAAiB,OAAA,CAAQ,QAAA;EAYrD,eAAA,CAAgB,GAAA,EAAK,YAAA;IAAe,GAAA;IAAa,IAAA;EAAA,KAAkB,OAAA,CAAQ,QAAA;EAe3E,eAAA,CAAgB,IAAA,EAAM,YAAA,GAAY,OAAA;UAuB/B,QAAA;EAAA;EAKH,eAAA,CAAgB,IAAA,EAAM,YAAA,EAAc,IAAA,EAAM,MAAA,oBAA0B,OAAA,CAAQ,aAAA;EAsG/E;;;EAAA,QAxFK,gBAAA;EAmCF,mBAAA,CAAoB,GAAA,EAAK,YAAA;IAAe,IAAA;EAAA,KAAe,OAAA;UAuBpD,QAAA;EAAA;EAKH,eAAA,CAAgB,GAAA,EAAK,YAAA;IAAe,IAAA;EAAA,KAAkB,OAAA,CAAQ,QAAA;EAsB9D,aAAA,CACJ,GAAA,EAAK,YAAA;IAAe,IAAA;EAAA,IACpB,IAAA,EAAM,MAAA,oBACL,OAAA,CAAQ,aAAA;EA+DL,UAAA,CACJ,IAAA,EAAM,YAAA,EACN,KAAA,UACA,OAAA;IAAY,KAAA;EAAA,IACX,OAAA,CAAQ,eAAA;EA2BL,WAAA,CAAY,IAAA,EAAM,YAAA,GAAe,OAAA,CAAQ,gBAAA;EAkCzC,QAAA,CAAS,GAAA,EAAK,YAAA,GAAe,OAAA,CAAQ,aAAA;AAAA"}