@valentinkolb/filegate 2.4.0 → 2.5.3

package/src/lib/scanner.ts

@@ -1,121 +0,0 @@
-import { readdir, stat } from "node:fs/promises";
-import { join, relative } from "node:path";
-import { config } from "../config";
-import { validatePath } from "./path";
-import {
-  indexFile,
-  getScanState,
-  setScanState,
-  touchIndexedAtUnderDir,
-  removeStaleEntries,
-} from "./index";
-
-export type ScanResult = {
-  scanned: number;
-  skipped: number;
-  added: number;
-  moved: number;
-  removed: number;
-  durationMs: number;
-};
-
-const emptyResult = (): ScanResult => ({
-  scanned: 0,
-  skipped: 0,
-  added: 0,
-  moved: 0,
-  removed: 0,
-  durationMs: 0,
-});
-
-export const scanBasePath = async (basePath: string): Promise<ScanResult> => {
-  const start = performance.now();
-  const scanStart = Date.now();
-  const result = emptyResult();
-
-  const queue: string[] = [basePath];
-  const concurrency = Math.max(1, config.indexScanConcurrency);
-
-  const processDir = async (dirPath: string) => {
-    const dirStat = await stat(dirPath).catch(() => null);
-    if (!dirStat || !dirStat.isDirectory()) return;
-
-    const relDir = relative(basePath, dirPath);
-    const scanState = await getScanState(basePath, relDir);
-
-    if (scanState && scanState.mtimeMs === dirStat.mtimeMs) {
-      result.skipped++;
-      await touchIndexedAtUnderDir(basePath, relDir, scanStart);
-      await setScanState(basePath, relDir, dirStat.mtimeMs, scanStart);
-      return;
-    }
-
-    result.scanned++;
-
-    const entries = await readdir(dirPath, { withFileTypes: true });
-    for (const entry of entries) {
-      const entryPath = join(dirPath, entry.name);
-      const entryStat = await stat(entryPath).catch(() => null);
-      if (!entryStat) continue;
-
-      const relPath = relative(basePath, entryPath);
-      const outcome = await indexFile(
-        basePath,
-        relPath,
-        {
-          dev: entryStat.dev,
-          ino: entryStat.ino,
-          size: entryStat.size,
-          mtimeMs: entryStat.mtimeMs,
-          isDirectory: entryStat.isDirectory(),
-        },
-        scanStart,
-      );
-
-      if (outcome.action === "added") result.added++;
-      if (outcome.action === "moved") result.moved++;
-
-      if (entry.isDirectory()) {
-        queue.push(entryPath);
-      }
-    }
-
-    await setScanState(basePath, relDir, dirStat.mtimeMs, scanStart);
-  };
-
-  const workers = Array.from({ length: concurrency }, async () => {
-    while (true) {
-      const dir = queue.shift();
-      if (!dir) break;
-      await processDir(dir);
-    }
-  });
-
-  await Promise.all(workers);
-
-  result.removed = await removeStaleEntries(basePath, scanStart);
-  result.durationMs = Math.round(performance.now() - start);
-
-  return result;
-};
-
-export const scanAll = async (): Promise<ScanResult> => {
-  const start = performance.now();
-  const aggregate = emptyResult();
-
-  for (const base of config.allowedPaths) {
-    const baseResult = await validatePath(base, { allowBasePath: true });
-    if (!baseResult.ok) {
-      throw new Error(`invalid base path: ${baseResult.error}`);
-    }
-    const result = await scanBasePath(baseResult.basePath);
-    aggregate.scanned += result.scanned;
-    aggregate.skipped += result.skipped;
-    aggregate.added += result.added;
-    aggregate.moved += result.moved;
-    aggregate.removed += result.removed;
-  }
-
-  aggregate.durationMs = Math.round(performance.now() - start);
-  return aggregate;
-};

package/src/lib/validator.ts

@@ -1,21 +0,0 @@
-import { validator } from "hono-openapi";
-import type { ZodType } from "zod";
-import type { ValidationTargets, Context } from "hono";
-
-/**
- * Zod validator middleware with OpenAPI support.
- * Returns 400 with error details on validation failure.
- */
-export const v = <Target extends keyof ValidationTargets, T extends ZodType>(target: Target, schema: T) =>
-  validator(target, schema, (result, c: Context) => {
-    if (!result.success) {
-      const issues = result.error as readonly { message: string; path?: readonly unknown[] }[];
-      const msg = issues
-        ?.map((issue) => {
-          const path = issue.path?.map((p) => String(p)).join(".");
-          return path ? `${path}: ${issue.message}` : issue.message;
-        })
-        .join(", ");
-      return c.json({ error: msg || "validation failed" }, 400);
-    }
-  });

package/src/schemas.ts

@@ -1,376 +0,0 @@
-import { z } from "zod";
-
-// ============================================================================
-// Common
-// ============================================================================
-
-export const ErrorSchema = z
-  .object({
-    error: z.string().describe("Error message describing what went wrong"),
-  })
-  .describe("Error response returned when a request fails");
-
-export const FileTypeSchema = z.enum(["file", "directory"]).describe("Type of filesystem entry");
-
-export const FileInfoSchema = z
-  .object({
-    name: z.string().describe("Filename or directory name"),
-    path: z.string().describe("Relative path from the base directory"),
-    type: FileTypeSchema,
-    size: z.number().describe("File size in bytes, or total directory size for directories"),
-    mtime: z.iso.datetime().describe("Last modification time in ISO 8601 format"),
-    isHidden: z.boolean().describe("True if the name starts with a dot"),
-    mimeType: z.string().optional().describe("MIME type of the file (only for files)"),
-    fileId: z.string().optional().describe("Stable file identifier (UUID v7)"),
-  })
-  .describe("Information about a file or directory");
-
-export const DirInfoSchema = FileInfoSchema.extend({
-  items: z.array(FileInfoSchema).describe("List of files and directories in this directory"),
-  total: z.number().describe("Total number of items in the directory"),
-}).describe("Directory information including its contents");
-
-// ============================================================================
-// Query Params
-// ============================================================================
-
-export const PathQuerySchema = z
-  .object({
-    path: z.string().min(1).optional().describe("Absolute path to the file or directory"),
-    id: z.string().min(1).optional().describe("Stable file identifier (UUID v7)"),
-  })
-  .refine((v) => (v.path ? !v.id : !!v.id), {
-    message: "exactly one of 'path' or 'id' must be provided",
-  })
-  .describe("Query parameters for path-based operations");
-
-export const ContentQuerySchema = z
-  .object({
-    path: z.string().min(1).optional().describe("Absolute path to the file or directory to download"),
-    id: z.string().min(1).optional().describe("Stable file identifier (UUID v7)"),
-    inline: z
-      .string()
-      .optional()
-      .transform((v) => v === "true")
-      .describe("If 'true', display in browser instead of downloading (Content-Disposition: inline)"),
-  })
-  .refine((v) => (v.path ? !v.id : !!v.id), {
-    message: "exactly one of 'path' or 'id' must be provided",
-  })
-  .describe("Query parameters for content download");
-
-export const InfoQuerySchema = z
-  .object({
-    path: z.string().min(1).optional().describe("Absolute path to the file or directory"),
-    id: z.string().min(1).optional().describe("Stable file identifier (UUID v7)"),
-    showHidden: z
-      .string()
-      .optional()
-      .transform((v) => v === "true")
-      .describe("If 'true', include hidden files (starting with dot) in directory listings"),
-    computeSizes: z
-      .string()
-      .optional()
-      .transform((v) => v === "true")
-      .describe("If 'true', compute recursive sizes for directories (slower, default: false)"),
-  })
-  .refine((v) => (v.path ? !v.id : !!v.id), {
-    message: "exactly one of 'path' or 'id' must be provided",
-  })
-  .describe("Query parameters for file/directory info");
-
-export const SearchQuerySchema = z
-  .object({
-    paths: z.string().min(1).describe("Comma-separated list of base paths to search in"),
-    pattern: z.string().min(1).max(500).describe("Glob pattern to match files (e.g., '*.txt', '**/*.pdf')"),
-    showHidden: z
-      .string()
-      .optional()
-      .transform((v) => v === "true")
-      .describe("If 'true', include hidden files in search results"),
-    limit: z
-      .string()
-      .optional()
-      .transform((v) => (v ? parseInt(v, 10) : undefined))
-      .describe("Maximum number of results to return"),
-    files: z
-      .string()
-      .optional()
-      .transform((v) => v !== "false")
-      .describe("If 'false', exclude files from results (default: true)"),
-    directories: z
-      .string()
-      .optional()
-      .transform((v) => v === "true")
-      .describe("If 'true', include directories in results (default: false)"),
-  })
-  .describe("Query parameters for glob-based file search");
-
-/** Count recursive wildcards (**) in a glob pattern */
-export const countRecursiveWildcards = (pattern: string): number => {
-  return (pattern.match(/\*\*/g) || []).length;
-};
-
-// ============================================================================
-// Request Bodies
-// ============================================================================
-
-export const MkdirBodySchema = z
-  .object({
-    path: z.string().min(1).describe("Absolute path of the directory to create"),
-    ownerUid: z.number().int().optional().describe("Unix user ID to set as owner"),
-    ownerGid: z.number().int().optional().describe("Unix group ID to set as owner"),
-    mode: z
-      .string()
-      .regex(/^[0-7]{3,4}$/)
-      .optional()
-      .describe("Unix permission mode (e.g., '755' or '0755')"),
-  })
-  .describe("Request body for creating a directory");
-
-export const TransferModeSchema = z
-  .enum(["move", "copy"])
-  .describe("Transfer operation type: 'move' (rename) or 'copy' (duplicate)");
-
-export const TransferBodySchema = z
-  .object({
-    from: z.string().min(1).describe("Source path of the file or directory"),
-    to: z.string().min(1).describe("Destination path for the file or directory"),
-    mode: TransferModeSchema,
-    ensureUniqueName: z
-      .boolean()
-      .default(true)
-      .describe("If true, append -01, -02, etc. to avoid overwriting existing files (default: true)"),
-    ownerUid: z.number().int().optional().describe("Unix user ID for ownership (required for cross-base copy)"),
-    ownerGid: z.number().int().optional().describe("Unix group ID for ownership (required for cross-base copy)"),
-    fileMode: z
-      .string()
-      .regex(/^[0-7]{3,4}$/)
-      .optional()
-      .describe("Unix permission mode for files (e.g., '644', required for cross-base copy)"),
-    dirMode: z
-      .string()
-      .regex(/^[0-7]{3,4}$/)
-      .optional()
-      .describe("Unix permission mode for directories (e.g., '755', defaults to fileMode if not set)"),
-  })
-  .describe("Request body for moving or copying files/directories");
-
-export const UploadStartBodySchema = z
-  .object({
-    path: z.string().min(1).describe("Directory path where the file will be uploaded"),
-    filename: z.string().min(1).describe("Name of the file to upload"),
-    size: z.number().int().positive().describe("Total size of the file in bytes"),
-    checksum: z
-      .string()
-      .regex(/^sha256:[a-f0-9]{64}$/)
-      .describe("SHA-256 checksum of the entire file (format: 'sha256:<64 hex chars>')"),
-    chunkSize: z.number().int().positive().describe("Size of each chunk in bytes"),
-    ownerUid: z.number().int().optional().describe("Unix user ID to set as owner"),
-    ownerGid: z.number().int().optional().describe("Unix group ID to set as owner"),
-    mode: z
-      .string()
-      .regex(/^[0-7]{3,4}$/)
-      .optional()
-      .describe("Unix permission mode for the uploaded file (e.g., '644')"),
-    dirMode: z
-      .string()
-      .regex(/^[0-7]{3,4}$/)
-      .optional()
-      .describe("Unix permission mode for auto-created parent directories (e.g., '755')"),
-  })
-  .describe("Request body to start or resume a chunked upload");
-
-// ============================================================================
-// Response Schemas
-// ============================================================================
-
-export const SearchResultSchema = z
-  .object({
-    basePath: z.string().describe("Base path that was searched"),
-    files: z.array(FileInfoSchema).describe("List of matching files and directories"),
-    total: z.number().describe("Number of matches found in this base path"),
-    hasMore: z.boolean().describe("True if there are more results beyond the limit"),
-  })
-  .describe("Search results for a single base path");
-
-export const SearchResponseSchema = z
-  .object({
-    results: z.array(SearchResultSchema).describe("Search results grouped by base path"),
-    totalFiles: z.number().describe("Total number of matches across all base paths"),
-  })
-  .describe("Complete search response with results from all searched paths");
-
-export const RescanResponseSchema = z
-  .object({
-    scanned: z.number().describe("Directories scanned"),
-    skipped: z.number().describe("Directories skipped (mtime unchanged)"),
-    added: z.number().describe("New files indexed"),
-    moved: z.number().describe("Moves detected"),
-    removed: z.number().describe("Stale index entries removed"),
-    durationMs: z.number().describe("Total scan duration in milliseconds"),
-  })
-  .describe("Index rescan result");
-
-export const IndexStatsSchema = z
-  .object({
-    totalFiles: z.number().describe("Number of indexed files"),
-    totalDirs: z.number().describe("Number of indexed directories"),
-    dbSizeBytes: z.number().describe("Database size in bytes (0 if unavailable)"),
-    lastScanAt: z.number().nullable().describe("Last scan timestamp (ms since epoch)"),
-  })
-  .describe("Index statistics");
-
-export const BulkResolveBodySchema = z
-  .object({
-    ids: z.array(z.string().min(1)).describe("List of file IDs to resolve"),
-  })
-  .describe("Bulk resolve request");
-
-export const BulkResolveResponseSchema = z
-  .record(z.string(), z.string().nullable())
-  .describe("Map of file ID to absolute path or null if missing");
-
-export const UploadStartResponseSchema = z
-  .object({
-    uploadId: z
-      .string()
-      .regex(/^[a-f0-9]{16}$/)
-      .describe("Unique identifier for this upload session"),
-    totalChunks: z.number().describe("Total number of chunks expected"),
-    chunkSize: z.number().describe("Size of each chunk in bytes"),
-    uploadedChunks: z.array(z.number()).describe("Indices of chunks already uploaded (for resume)"),
-    completed: z.literal(false).describe("Always false for start response"),
-  })
-  .describe("Response when starting or resuming a chunked upload");
-
-export const UploadChunkProgressSchema = z
-  .object({
-    chunkIndex: z.number().describe("Index of the chunk that was just uploaded"),
-    uploadedChunks: z.array(z.number()).describe("All chunk indices uploaded so far"),
-    completed: z.literal(false).describe("False while upload is still in progress"),
-  })
-  .describe("Response after uploading a chunk (upload not yet complete)");
-
-export const UploadChunkCompleteSchema = z
-  .object({
-    completed: z.literal(true).describe("True when all chunks have been uploaded"),
-    file: FileInfoSchema.extend({
-      checksum: z.string().describe("SHA-256 checksum of the assembled file"),
-    }).describe("Information about the completed file"),
-  })
-  .describe("Response after uploading the final chunk");
-
-export const UploadChunkResponseSchema = z
-  .union([UploadChunkProgressSchema, UploadChunkCompleteSchema])
-  .describe("Response after uploading a chunk (either progress or completion)");
-
-// ============================================================================
-// Header Schemas
-// ============================================================================
-
-export const UploadFileHeadersSchema = z
-  .object({
-    "x-file-path": z.string().min(1).describe("Directory path where the file will be uploaded"),
-    "x-file-name": z.string().min(1).describe("Name of the file to upload"),
-    "x-owner-uid": z.string().regex(/^\d+$/).transform(Number).optional().describe("Unix user ID to set as owner"),
-    "x-owner-gid": z.string().regex(/^\d+$/).transform(Number).optional().describe("Unix group ID to set as owner"),
-    "x-file-mode": z
-      .string()
-      .regex(/^[0-7]{3,4}$/)
-      .optional()
-      .describe("Unix permission mode for the file (e.g., '644')"),
-    "x-dir-mode": z
-      .string()
-      .regex(/^[0-7]{3,4}$/)
-      .optional()
-      .describe("Unix permission mode for auto-created directories (e.g., '755')"),
-  })
-  .describe("Headers for simple file upload");
-
-export const UploadChunkHeadersSchema = z
-  .object({
-    "x-upload-id": z
-      .string()
-      .regex(/^[a-f0-9]{16}$/)
-      .describe("Upload session ID from the start response"),
-    "x-chunk-index": z.string().regex(/^\d+$/).transform(Number).describe("Zero-based index of this chunk"),
-    "x-chunk-checksum": z
-      .string()
-      .regex(/^sha256:[a-f0-9]{64}$/)
-      .optional()
-      .describe("SHA-256 checksum of this chunk for verification (format: 'sha256:<64 hex chars>')"),
-  })
-  .describe("Headers for uploading a chunk");
-
-// ============================================================================
-// Thumbnail Schemas
-// ============================================================================
-
-export const ThumbnailFitSchema = z
-  .enum(["cover", "contain", "fill", "inside", "outside"])
-  .describe(
-    "Scaling mode: cover (crop to fill), contain (fit within), fill (stretch), inside (fit, never upscale), outside (cover, never downscale)",
-  );
-
-export const ThumbnailPositionSchema = z
-  .enum(["center", "top", "bottom", "left", "right", "entropy", "attention"])
-  .describe("Crop position for 'cover' fit: cardinal directions, or 'entropy'/'attention' for smart cropping");
-
-export const ThumbnailFormatSchema = z.enum(["webp", "jpeg", "png", "avif"]).describe("Output image format");
-
-export const ImageThumbnailQuerySchema = z
-  .object({
-    path: z.string().min(1).optional().describe("Absolute path to the image file"),
-    id: z.string().min(1).optional().describe("Stable file identifier (UUID v7)"),
-    width: z
-      .string()
-      .optional()
-      .transform((v) => (v ? parseInt(v, 10) : 200))
-      .refine((v) => v >= 1 && v <= 2000, "width must be between 1 and 2000")
-      .describe("Thumbnail width in pixels (default: 200, max: 2000)"),
-    height: z
-      .string()
-      .optional()
-      .transform((v) => (v ? parseInt(v, 10) : 200))
-      .refine((v) => v >= 1 && v <= 2000, "height must be between 1 and 2000")
-      .describe("Thumbnail height in pixels (default: 200, max: 2000)"),
-    fit: z
-      .string()
-      .optional()
-      .transform((v) => (v as z.infer<typeof ThumbnailFitSchema>) || "cover")
-      .describe("Scaling mode (default: cover)"),
-    position: z
-      .string()
-      .optional()
-      .transform((v) => (v as z.infer<typeof ThumbnailPositionSchema>) || "center")
-      .describe("Crop position for cover fit (default: center)"),
-    format: z
-      .string()
-      .optional()
-      .transform((v) => (v as z.infer<typeof ThumbnailFormatSchema>) || "webp")
-      .describe("Output format (default: webp)"),
-    quality: z
-      .string()
-      .optional()
-      .transform((v) => (v ? parseInt(v, 10) : 80))
-      .refine((v) => v >= 1 && v <= 100, "quality must be between 1 and 100")
-      .describe("Output quality 1-100 (default: 80)"),
-  })
-  .refine((v) => (v.path ? !v.id : !!v.id), {
-    message: "exactly one of 'path' or 'id' must be provided",
-  })
-  .describe("Query parameters for image thumbnail generation");
-
-export type ImageThumbnailQuery = z.infer<typeof ImageThumbnailQuerySchema>;
-
-// ============================================================================
-// Types
-// ============================================================================
-
-export type FileInfo = z.infer<typeof FileInfoSchema>;
-export type DirInfo = z.infer<typeof DirInfoSchema>;
-export type SearchResult = z.infer<typeof SearchResultSchema>;
-export type UploadStartBody = z.infer<typeof UploadStartBodySchema>;
-export type UploadFileHeaders = z.infer<typeof UploadFileHeadersSchema>;
-export type UploadChunkHeaders = z.infer<typeof UploadChunkHeadersSchema>;