@staticcms/proxy-server-lite/src/middlewares/types.ts

Proxy server to be used with Static CMS proxy backend

export type DefaultParams = {
  branch: string;
};

export type EntriesByFolderParams = {
  folder: string;
  extension: string;
};

export type EntriesByFilesParams = {
  files: { path: string }[];
};

export type GetEntryParams = {
  path: string;
};

export type DeleteEntryParams = {
  collection: string;
  slug: string;
};

export type DataFile = { slug: string; path: string; raw: string; newPath?: string };

export type Asset = { path: string; content: string; encoding: 'base64' };

export type PersistEntryParams = {
  cmsLabelPrefix?: string;
  entry?: DataFile;
  dataFiles?: DataFile[];
  assets: Asset[];
  options: {
    collectionName?: string;
    commitMessage: string;
    useWorkflow?: boolean;
    status?: string;
  };
};

export type GetMediaParams = {
  mediaFolder: string;
  publicFolder: string;
};

export type GetMediaFileParams = {
  path: string;
};

export type PersistMediaParams = {
  asset: Asset;
  options: {
    commitMessage: string;
  };
};

export type DeleteFileParams = {
  path: string;
  options: {
    commitMessage: string;
  };
};

export type DeleteFilesParams = {
  paths: string[];
  options: {
    commitMessage: string;
  };
};

export type FsItem = {
  file: string;
  isDirectory: boolean;
};

/**
 * Editorial Workflow
 */
export type UnpublishedEntryParams = {
  id?: string;
  collection?: string;
  slug?: string;
  cmsLabelPrefix?: string;
};

export type UnpublishedEntryDataFileParams = {
  collection: string;
  slug: string;
  id: string;
  path: string;
};

export type UnpublishedEntryMediaFileParams = {
  collection: string;
  slug: string;
  id: string;
  path: string;
};

export type UpdateUnpublishedEntryStatusParams = {
  collection: string;
  slug: string;
  newStatus: string;
  cmsLabelPrefix?: string;
};

export type PublishUnpublishedEntryParams = {
  collection: string;
  slug: string;
};