cross-seed 7.0.0-21 → 7.0.0-23

package/dist/libraryInventory.d.ts

@@ -0,0 +1,176 @@
+import type { File, SearcheeClient, SearcheeWithInfoHash, SearcheeWithoutInfoHash } from "./searchee.js";
+import type { WithRequired } from "./utils.js";
+export declare enum LibraryItemSource {
+    CLIENT = "torrentClient",
+    TORRENT = "torrentFile",
+    DATA = "dataDir"
+}
+export type LibraryItemSourceValue = `${LibraryItemSource}`;
+export declare enum LibraryScanStatus {
+    RUNNING = "running",
+    SUCCEEDED = "succeeded",
+    FAILED = "failed"
+}
+export interface LibraryScan {
+    id: number;
+    source: LibraryItemSource;
+    sourceInstance: string | null;
+    status: LibraryScanStatus;
+    startedAt: number;
+    finishedAt: number | null;
+    error: string | null;
+    itemsSeen: number;
+    itemsUpserted: number;
+    itemsRemoved: number;
+}
+export interface LibraryItemInput {
+    source: LibraryItemSource;
+    sourceKey: string;
+    sourceInstance?: string | null;
+    clientHost?: string | null;
+    infoHash?: string | null;
+    path?: string | null;
+    name: string;
+    title: string;
+    files: File[];
+    length: number;
+    savePath?: string | null;
+    category?: string | null;
+    tags?: string[] | null;
+    trackers?: string[] | null;
+    contentFingerprint?: string | null;
+}
+export interface LibraryFileInput {
+    source: LibraryItemSource;
+    sourceInstance?: string | null;
+    itemSourceKey: string;
+    path: string;
+    name: string;
+    length: number;
+}
+export interface LibraryInventoryFile {
+    path: string;
+    name: string;
+    length: number;
+}
+export interface LibraryInventoryItem {
+    id: number;
+    source: LibraryItemSourceValue;
+    sourceInstance: string | null;
+    sourceKey: string;
+    clientHost: string | null;
+    infoHash: string | null;
+    path: string | null;
+    name: string;
+    title: string;
+    length: number;
+    savePath: string | null;
+    category: string | null;
+    tags: string[] | null;
+    trackers: string[] | null;
+    contentFingerprint: string | null;
+    firstSeenAt: string;
+    lastSeenAt: string;
+    lastIndexedAt: string;
+    updatedAt: string;
+    fileCount: number;
+    files?: LibraryInventoryFile[];
+}
+export interface LibrarySourceCount {
+    source: LibraryItemSourceValue;
+    count: number;
+}
+export interface LibraryScanStatusSummary {
+    source: LibraryItemSourceValue;
+    sourceInstance: string | null;
+    status: LibraryScanStatus;
+    startedAt: string;
+    finishedAt: string | null;
+    error: string | null;
+    itemsSeen: number;
+    itemsUpserted: number;
+    itemsRemoved: number;
+    activeItems: number;
+    activeFiles: number;
+}
+type SyncLibraryItemsOptions = {
+    scanId?: number;
+    source: LibraryItemSource;
+    sourceInstance?: string | null;
+    itemsToUpsert?: LibraryItemInput[];
+    filesToUpsert?: LibraryFileInput[];
+    sourceKeysSeen?: string[];
+    pruneMissing?: boolean;
+    now?: number;
+};
+type LibraryItemSortBy = "lastSeenAt" | "title" | "length" | "source";
+type LibraryItemSortDirection = "asc" | "desc";
+export declare function createClientLibrarySourceKey(input: {
+    clientHost: string;
+    infoHash: string;
+}): string;
+export declare function createTorrentLibrarySourceKey(filePath: string): string;
+export declare function createDataLibrarySourceKey(path: string): string;
+export declare function createClientLibraryItemInput(searchee: SearcheeClient): LibraryItemInput;
+export declare function createTorrentLibraryItemInput(searchee: SearcheeWithInfoHash, filePath: string, sourceInstance: string, options?: {
+    contentFingerprint?: string | null;
+}): LibraryItemInput;
+export declare function createDataLibraryItemInput(searchee: WithRequired<SearcheeWithoutInfoHash, "path">, sourceInstance: string): LibraryItemInput;
+export declare function createLibraryFileInputs(item: LibraryItemInput): LibraryFileInput[];
+export declare function beginLibraryScan(input: {
+    source: LibraryItemSource;
+    sourceInstance?: string | null;
+    now?: number;
+}): Promise<LibraryScan>;
+export declare function getLibraryScan(id: number): Promise<LibraryScan | null>;
+export declare function listLibraryItems(options: {
+    source?: LibraryItemSourceValue;
+    sourceInstance?: string | null;
+    search?: string;
+    includeFiles?: boolean;
+    limit?: number;
+    offset?: number;
+    cursor?: string | null;
+    sortBy?: LibraryItemSortBy;
+    sortDirection?: LibraryItemSortDirection;
+}): Promise<{
+    items: LibraryInventoryItem[];
+    total: number;
+    limit: number;
+    offset: number;
+    nextCursor: string | null;
+    sourceCounts: LibrarySourceCount[];
+}>;
+export declare function getLibraryScanStatuses(options?: {
+    source?: LibraryItemSourceValue;
+    sourceInstance?: string | null;
+}): Promise<LibraryScanStatusSummary[]>;
+export declare function upsertLibraryItems(scanId: number, items: LibraryItemInput[], options?: {
+    now?: number;
+}): Promise<void>;
+export declare function markLibraryItemsSeen(scanId: number, sourceKeys: string[], options?: {
+    now?: number;
+}): Promise<void>;
+export declare function upsertLibraryFiles(scanId: number, files: LibraryFileInput[], options?: {
+    now?: number;
+}): Promise<void>;
+export declare function pruneMissingLibraryFiles(scanId: number, options?: {
+    now?: number;
+}): Promise<number>;
+export declare function pruneMissingLibraryFilesForItems(scanId: number, itemSourceKeys: string[], options?: {
+    now?: number;
+}): Promise<number>;
+export declare function completeLibraryScan(scanId: number, options?: {
+    now?: number;
+}): Promise<LibraryScan>;
+export declare function failLibraryScan(scanId: number, error: unknown, options?: {
+    now?: number;
+}): Promise<LibraryScan>;
+export declare function pruneMissingLibraryItems(scanId: number, options?: {
+    now?: number;
+}): Promise<number>;
+export declare function markLibraryItemsMissingBySourceKeys(sourceKeys: string[], options?: {
+    now?: number;
+}): Promise<number>;
+export declare function syncLibraryItems(options: SyncLibraryItemsOptions): Promise<LibraryScan>;
+export {};