MCPcopy Create free account
hub / github.com/decaporg/decap-cms / Implementation

Interface Implementation

packages/decap-cms-lib-util/src/implementation.ts:202–317  ·  view source on GitHub ↗

Source from the content-addressed store, hash-verified

200};
201
202export interface Implementation {
203 authComponent: () => void;
204 restoreUser: (user: User) => Promise<User>;
205
206 authenticate: (credentials: Credentials) => Promise<User>;
207 logout: () => Promise<void> | void | null;
208 getToken: () => Promise<string | null>;
209
210 getEntry: (path: string) => Promise<ImplementationEntry>;
211 entriesByFolder: (
212 folder: string,
213 extension: string,
214 depth: number,
215 ) => Promise<ImplementationEntry[]>;
216 entriesByFiles: (files: ImplementationFile[]) => Promise<ImplementationEntry[]>;
217
218 getMediaDisplayURL?: (displayURL: DisplayURL) => Promise<string>;
219 getMedia: (folder?: string) => Promise<ImplementationMediaFile[]>;
220 getMediaFile: (path: string) => Promise<ImplementationMediaFile>;
221
222 persistEntry: (entry: Entry, opts: PersistOptions) => Promise<void>;
223 persistMedia: (file: AssetProxy, opts: PersistOptions) => Promise<ImplementationMediaFile>;
224 deleteFiles: (paths: string[], commitMessage: string) => Promise<void>;
225
226 getNotes?: (collection: string, slug: string) => Promise<Note[]>;
227 addNote?: (
228 collection: string,
229 slug: string,
230 note: Omit<Note, 'id'>,
231 entryTitle?: string,
232 ) => Promise<Note>;
233 updateNote?: (
234 collection: string,
235 slug: string,
236 noteId: string,
237 updates: Partial<Note>,
238 ) => Promise<Note>;
239 deleteNote?: (collection: string, slug: string, noteId: string) => Promise<void>;
240 toggleNoteResolution?: (collection: string, slug: string, noteId: string) => Promise<Note>;
241 syncNotes?: (collection: string, slug: string, localNotes: Note[]) => Promise<Note[]>;
242 reopenIssueForUnpublishedEntry?: (collection: string, slug: string) => Promise<void>;
243
244 getPRMetadata?: (
245 collection: string,
246 slug: string,
247 ) => Promise<{
248 id: string;
249 url: string;
250 author: string;
251 createdAt: string;
252 } | null>;
253
254 unpublishedEntries: () => Promise<string[]>;
255 unpublishedEntry: (args: {
256 id?: string;
257 collection?: string;
258 slug?: string;
259 }) => Promise<UnpublishedEntry>;

Callers

nothing calls this directly

Implementers 9

ProxyBackendpackages/decap-cms-backend-proxy/src/i
Azurepackages/decap-cms-backend-azure/src/i
GitHubpackages/decap-cms-backend-github/src/
Giteapackages/decap-cms-backend-gitea/src/i
TestBackendpackages/decap-cms-backend-test/src/im
GitLabpackages/decap-cms-backend-gitlab/src/
GitGatewaypackages/decap-cms-backend-git-gateway
Forgejopackages/decap-cms-backend-forgejo/src
BitbucketBackendpackages/decap-cms-backend-bitbucket/s

Calls

no outgoing calls

Tested by

no test coverage detected