Interface Implementation

packages/decap-cms-lib-util/src/implementation.ts:195–293

};

export interface Implementation {
  authComponent: () => void;
  restoreUser: (user: User) => Promise<User>;

  authenticate: (credentials: Credentials) => Promise<User>;
  logout: () => Promise<void> | void | null;
  getToken: () => Promise<string | null>;

  getEntry: (path: string) => Promise<ImplementationEntry>;
  entriesByFolder: (
    folder: string,
    extension: string,
    depth: number,
  ) => Promise<ImplementationEntry[]>;
  entriesByFiles: (files: ImplementationFile[]) => Promise<ImplementationEntry[]>;

  getMediaDisplayURL?: (displayURL: DisplayURL) => Promise<string>;
  getMedia: (folder?: string) => Promise<ImplementationMediaFile[]>;
  getMediaFile: (path: string) => Promise<ImplementationMediaFile>;

  persistEntry: (entry: Entry, opts: PersistOptions) => Promise<void>;
  persistMedia: (file: AssetProxy, opts: PersistOptions) => Promise<ImplementationMediaFile>;
  deleteFiles: (paths: string[], commitMessage: string) => Promise<void>;

  getNotes?: (collection: string, slug: string) => Promise<Note[]>;
  addNote?: (
    collection: string,
    slug: string,
    note: Omit<Note, 'id'>,
    entryTitle?: string,
  ) => Promise<Note>;
  updateNote?: (
    collection: string,
    slug: string,
    noteId: string,
    updates: Partial<Note>,
  ) => Promise<Note>;
  deleteNote?: (collection: string, slug: string, noteId: string) => Promise<void>;
  toggleNoteResolution?: (collection: string, slug: string, noteId: string) => Promise<Note>;
  syncNotes?: (collection: string, slug: string, localNotes: Note[]) => Promise<Note[]>;
  reopenIssueForUnpublishedEntry?: (collection: string, slug: string) => Promise<void>;

  getPRMetadata?: (
    collection: string,
    slug: string,
  ) => Promise<{
    id: string;
    url: string;
    author: string;
    createdAt: string;
  } | null>;

  unpublishedEntries: () => Promise<string[]>;
  unpublishedEntry: (args: {
    id?: string;
    collection?: string;
    slug?: string;
  }) => Promise<UnpublishedEntry>;