Skip to content

adapters.md

Latest commit

 

History

History
83 lines (66 loc) · 4.12 KB

adapters.md

File metadata and controls

83 lines (66 loc) · 4.12 KB
Raw

Adapter Architecture

Adapters provide a unified interface for fetching bundles from different source types.

IRepositoryAdapter Interface

interface IRepositoryAdapter {
    readonly type: string;
    readonly source: RegistrySource;
    fetchBundles(onPartialBundles?: (bundles: Bundle[]) => void | Promise<void>): Promise<Bundle[]>;
    downloadBundle(bundle: Bundle): Promise<Buffer>;
    fetchMetadata(): Promise<SourceMetadata>;
    validate(): Promise<ValidationResult>;
    requiresAuthentication(): boolean;
    getManifestUrl(bundleId: string, version?: string): string;
    getDownloadUrl(bundleId: string, version?: string): string;
    forceAuthentication?(): Promise<void>;
}

Adapter Types

Adapter Source Type Installation Method Status
GitHubAdapter github URL-based (getDownloadUrl) Active
LocalAdapter local Buffer-based (downloadBundle) Active
AwesomeCopilotAdapter awesome-copilot Buffer-based (builds zip on-the-fly) Active
LocalAwesomeCopilotAdapter local-awesome-copilot Buffer-based Active
ApmAdapter apm URL-based Active
LocalApmAdapter local-apm Buffer-based Active

Source types are defined in src/types/registry.ts:

export type SourceType = 'github' | 'local' | 
    'awesome-copilot' | 'local-awesome-copilot' | 'apm' | 'local-apm';

Freshness note: LocalAwesomeCopilotAdapter does not cache its bundle list. fetchBundles() re-reads collection files from disk on every call so local edits (including readmes) are reflected immediately during development.

Readme revision reuse: For remote sources, RegistryManager carries a cached readme over to a freshly synced bundle only when the bundle's readmeRevision is unchanged; otherwise the readme is re-downloaded. This keeps readmes fresh while avoiding redundant downloads on every sync. Adapters set readmeRevision to a value that changes when the readme content can change — the GitHub adapter uses the release tag, and the Awesome Copilot adapter uses the configured branch's head commit sha (so a stale readme is refreshed once the branch advances). If an adapter cannot resolve a revision, it leaves readmeRevision unset and the readme is re-downloaded on every sync.

Readme asset resolution (GitHub): The GitHub adapter does not guess the readme filename. GitHub names each release asset after the uploaded file's basename, and a collection may declare any readme path (e.g. docs/collection-overview.md), so the deployment manifest records the readme asset basename in its readme field (written by lib/bin/generate-manifest.js). processSingleRelease reads manifest.readme and matches it against the release assets; if the manifest omits readme, no readme is attached.

Two Installation Paths

URL-Based (install()):

  • Pre-packaged zip bundles on remote servers
  • Direct download from URL
  • Used by: GitHub, AwesomeCopilot

Buffer-Based (installFromBuffer()):

  • Dynamically created bundles
  • Builds zip in memory
  • Used by: AwesomeCopilot, Local

Adding a New Adapter

// 1. Extend RepositoryAdapter base class
export class MyAdapter extends RepositoryAdapter {
    readonly type = 'my-type';
    
    async fetchBundles(): Promise<Bundle[]> { /* ... */ }
    async downloadBundle(bundle: Bundle): Promise<Buffer> { /* ... */ }
    async fetchMetadata(): Promise<SourceMetadata> { /* ... */ }
    async validate(): Promise<ValidationResult> { /* ... */ }
    getManifestUrl(bundleId: string, version?: string): string { /* ... */ }
    getDownloadUrl(bundleId: string, version?: string): string { /* ... */ }
}

// 2. Register in factory
RepositoryAdapterFactory.register('my-type', MyAdapter);

// 3. Add to SourceType union in src/types/registry.ts
export type SourceType = 'github' | 'local' | 
    'awesome-copilot' | 'local-awesome-copilot' | 'apm' | 'local-apm' | 'my-type';

See Also