@photostax/core 0.1.3 → 0.1.5

package/README.md

@@ -41,6 +41,10 @@ for (const stack of stacks) {
   console.log(`  Back: ${stack.back}`);
   console.log(`  EXIF Make: ${stack.metadata.exifTags['Make']}`);
 }
+
+// Paginate results (20 items starting at offset 0)
+const page = repo.scanPaginated(0, 20);
+console.log(`Showing ${page.items.length} of ${page.totalCount} total`);
 ```
 
 ## API Overview
@@ -56,6 +60,8 @@ The main class for accessing photo stacks.
 | `readImage(path)` | Read raw image bytes as Buffer |
 | `writeMetadata(id, metadata)` | Write metadata to a stack |
 | `search(query)` | Find stacks matching a query |
+| `scanPaginated(offset, limit)` | Scan with pagination (offset/limit) |
+| `searchPaginated(query, offset, limit)` | Search with pagination (offset/limit) |
 
 ### PhotoStack
 
@@ -91,6 +97,18 @@ interface SearchQuery {
 }
 ```
 
+### PaginatedResult
+
+```typescript
+interface PaginatedResult {
+  items: PhotoStack[];          // Items in this page
+  totalCount: number;           // Total items across all pages
+  offset: number;               // Offset used for this page
+  limit: number;                // Limit used for this page
+  hasMore: boolean;             // Whether more items exist beyond this page
+}
+```
+
 ### Utility Functions
 
 | Function | Description |

package/index.d.ts

@@ -1,131 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-
-/* auto-generated by NAPI-RS */
-
-/**
- * Metadata associated with a photo stack.
- *
- * Combines EXIF tags (from image files), XMP tags (embedded or sidecar),
- * and custom tags (from the sidecar database) into a unified view.
- */
-export interface JsMetadata {
-  /** Standard EXIF tags from the image file (Make, Model, DateTime, etc.) */
-  exifTags: Record<string, string>
-  /** XMP/Dublin Core metadata tags */
-  xmpTags: Record<string, string>
-  /** Custom application metadata stored in the sidecar database */
-  customTags: Record<string, any>
-}
-/**
- * A unified representation of a single scanned photo from an Epson FastFoto scanner.
- *
- * Groups the original scan, enhanced version, and back-of-photo image into
- * a single logical unit with associated metadata.
- */
-export interface JsPhotoStack {
-  /** Unique identifier derived from the base filename */
-  id: string
-  /** Path to the original front scan (may be null) */
-  original?: string
-  /** Path to the enhanced/color-corrected scan (may be null) */
-  enhanced?: string
-  /** Path to the back-of-photo scan (may be null) */
-  back?: string
-  /** Combined metadata from all sources */
-  metadata: JsMetadata
-}
-/** A key-value pair for search filters. */
-export interface JsKeyValue {
-  /** The tag name to filter on */
-  key: string
-  /** The value substring to search for */
-  value: string
-}
-/**
- * Query parameters for searching photo stacks.
- *
- * All filters use AND logic - a stack must match all specified criteria.
- */
-export interface JsSearchQuery {
-  /** Free-text search across ID and all metadata */
-  text?: string
-  /** EXIF tag filters (all must match) */
-  exifFilters?: Array<JsKeyValue>
-  /** Custom tag filters (all must match) */
-  customFilters?: Array<JsKeyValue>
-  /** Filter by presence of back scan */
-  hasBack?: boolean
-  /** Filter by presence of enhanced scan */
-  hasEnhanced?: boolean
-}
-/** Options for creating a PhotostaxRepository. */
-export interface RepositoryOptions {
-  /**
-   * Whether to recurse into subdirectories (default: false).
-   *
-   * Set to `true` when the photo library uses FastFoto's folder-based
-   * organisation (e.g. `1984_Mexico/`, `SteveJones/`).
-   */
-  recursive?: boolean
-}
-/**
- * A repository for accessing Epson FastFoto photo stacks from a local directory.
- *
- * Provides methods to scan, retrieve, and modify photo stacks and their metadata.
- */
-export declare class PhotostaxRepository {
-  /**
-   * Create a new repository rooted at the given directory path.
-   *
-   * @param directoryPath - Path to the directory containing FastFoto photo files
-   * @param options - Optional configuration (e.g. `{ recursive: true }`)
-   * @throws Error if the path is invalid
-   */
-  constructor(directoryPath: string, options?: RepositoryOptions | undefined | null)
-  /**
-   * Scan the repository and return all discovered photo stacks.
-   *
-   * Groups files by FastFoto naming convention and enriches each stack
-   * with EXIF, XMP, and sidecar metadata.
-   *
-   * @returns Array of photo stacks found in the repository
-   * @throws Error if the directory cannot be accessed
-   */
-  scan(): Array<JsPhotoStack>
-  /**
-   * Retrieve a single photo stack by its ID.
-   *
-   * @param id - The stack identifier (base filename without suffix)
-   * @returns The photo stack with the given ID
-   * @throws Error if the stack is not found or cannot be accessed
-   */
-  getStack(id: string): JsPhotoStack
-  /**
-   * Read the raw bytes of an image file.
-   *
-   * @param path - Path to the image file (from a PhotoStack)
-   * @returns Buffer containing the image bytes
-   * @throws Error if the file cannot be read
-   */
-  readImage(path: string): Buffer
-  /**
-   * Write metadata tags to a photo stack.
-   *
-   * XMP tags are written to the image file (or sidecar for TIFF).
-   * Custom and EXIF tags are stored in the sidecar database.
-   *
-   * @param stackId - The ID of the stack to update
-   * @param metadata - The metadata to write
-   * @throws Error if the stack is not found or metadata cannot be written
-   */
-  writeMetadata(stackId: string, metadata: JsMetadata): void
-  /**
-   * Search for photo stacks matching the given query.
-   *
-   * @param query - Search criteria (all filters are AND'd together)
-   * @returns Array of matching photo stacks
-   * @throws Error if the repository cannot be scanned
-   */
-  search(query: JsSearchQuery): Array<JsPhotoStack>
-}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@photostax/core",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "Unified photo stack library for Epson FastFoto repositories - Node.js binding",
   "main": "index.js",
   "types": "index.d.ts",
@@ -22,9 +22,9 @@
     "prepublishOnly": "napi prepublish -t npm"
   },
   "devDependencies": {
-    "@napi-rs/cli": "^2.0.0",
+    "@napi-rs/cli": "^3.0.0",
     "@types/jest": "^29.0.0",
-    "@types/node": "^20.0.0",
+    "@types/node": "^25.0.0",
     "jest": "^29.0.0",
     "ts-jest": "^29.0.0",
     "typescript": "^5.0.0"
@@ -45,8 +45,9 @@
     "jpeg"
   ],
   "optionalDependencies": {
-    "@photostax/core-win32-x64-msvc": "0.1.3",
-    "@photostax/core-darwin-x64": "0.1.3",
-    "@photostax/core-linux-x64-gnu": "0.1.3"
+    "@photostax/core-darwin-x64": "0.1.5",
+    "@photostax/core-darwin-arm64": "0.1.5",
+    "@photostax/core-win32-x64-msvc": "0.1.5",
+    "@photostax/core-linux-x64-gnu": "0.1.5"
   }
 }