async-neocities/lib/api-endpoints.d.ts

A library and bin to deploy to neocities

export function getApiKey({ siteName, ownerPassword }: {
    siteName: string;
    ownerPassword: string[];
}): Promise<ApiKeyResponse>;
export function uploadSiteFiles({ apiKey, files }: {
    apiKey: string;
    files: FileUpload[];
}): Promise<UploadResults>;
export function previewDeployToNeocities({ directory, apiKey, includeUnsupportedFiles, protectedFileFilter, uploadSort }: {
    directory: string;
    apiKey: string;
    includeUnsupportedFiles?: boolean | undefined;
    protectedFileFilter?: ((path: string) => boolean) | undefined;
    uploadSort?: Comparator<FileUpload> | undefined;
}): Promise<AsyncNeocitiesDiff>;
export function deployToNeocities({ directory, apiKey, cleanup, includeUnsupportedFiles, protectedFileFilter, uploadSort }: {
    directory: string;
    apiKey: string;
    cleanup?: boolean | undefined;
    includeUnsupportedFiles?: boolean | undefined;
    protectedFileFilter?: ((path: string) => boolean) | undefined;
    uploadSort?: Comparator<FileUpload> | undefined;
}): Promise<DeployResults>;
export function deleteSiteFiles({ apiKey, fileNames }: {
    apiKey: string;
    fileNames: string[];
}): Promise<DeleteResult>;
export function listFilesForSite({ apiKey, path }: {
    apiKey: string;
    path?: string | undefined;
}): Promise<SiteFileList>;
export function getInfo({ apiKey, siteName }: {
    apiKey: string;
    siteName?: string | undefined;
}): Promise<SiteInfo>;
export type UploadResult = {
    type: "uploadResult";
    body: MessageResult;
    files: FileUpload[];
};
export type UploadResults = {
    errors: Array<Error>;
    results: Array<UploadResult>;
};
export type DeployResult = UploadResult | DeleteResult;
export type DeployResults = {
    results: DeployResult[];
    errors: Error[];
    diff: AsyncNeocitiesDiff;
};
export type Comparator<T> = (a: T, b: T) => number;
export type DeleteResult = {
    type: "deleteResult";
    body: MessageResult;
    fileNames: string[];
};
import type { ApiKeyResponse } from './neocities.js';
import type { FileUpload } from './neocities.js';
import type { AsyncNeocitiesDiff } from './folder-diff.js';
import type { SiteFileList } from './neocities.js';
import type { SiteInfo } from './neocities.js';
import type { MessageResult } from './neocities.js';
//# sourceMappingURL=api-endpoints.d.ts.map