Interface SyncProvider

packages/core/src/sync/index.ts:49–71

export type SyncedMetadata = Omit<z.infer<typeof ModelMetadata>, "id">;

export interface SyncProvider<SourceModel> {
  id: string;
  name: string;
  modelsDir: string;
  metadataNamespace?: string;
  skipCreates?: boolean;
  deleteMissing?: boolean;
  preserveSymlinks?: boolean;
  preserveBaseModels?: boolean;
  sameModel?(current: ExistingModel, desired: SyncedModel): boolean;
  missingNotice?(paths: string[]): string[];
  sourceID?(model: SourceModel): string;
  skippedNotice?(ids: string[]): string[];
  fetchModels(): Promise<unknown>;
  parseModels(raw: unknown): SourceModel[];
  translateModel(
    model: SourceModel,
    context: {
      existing(id: string): ExistingModel | undefined;
      authored(id: string): ExistingModel | undefined;
    },
  ): { id: string; model: SyncedModel; metadata?: { id: string; model: SyncedMetadata } } | undefined;
}

export interface SyncResult {
  id: string;