@outfitter/state 0.2.2 → 0.2.3

package/dist/index.d.ts

@@ -23,18 +23,18 @@ import { NotFoundError, Result, StorageError, ValidationError } from "@outfitter
 * ```
 */
 interface Cursor {
+	/** Unix timestamp (ms) when this cursor was created */
+	readonly createdAt: number;
+	/** Unix timestamp (ms) when this cursor expires (computed from createdAt + ttl) */
+	readonly expiresAt?: number;
 	/** Unique identifier for this cursor (UUID format) */
 	readonly id: string;
-	/** Current position/offset in the result set (zero-based) */
-	readonly position: number;
 	/** Optional user-defined metadata associated with this cursor */
 	readonly metadata?: Record<string, unknown>;
+	/** Current position/offset in the result set (zero-based) */
+	readonly position: number;
 	/** Time-to-live in milliseconds (optional, omitted if cursor never expires) */
 	readonly ttl?: number;
-	/** Unix timestamp (ms) when this cursor expires (computed from createdAt + ttl) */
-	readonly expiresAt?: number;
-	/** Unix timestamp (ms) when this cursor was created */
-	readonly createdAt: number;
 }
 /**
 * Options for creating a pagination cursor.
@@ -56,10 +56,10 @@ interface Cursor {
 interface CreateCursorOptions {
 	/** Custom cursor ID (UUID generated if not provided) */
 	id?: string;
-	/** Starting position in the result set (must be non-negative) */
-	position: number;
 	/** User-defined metadata to associate with the cursor */
 	metadata?: Record<string, unknown>;
+	/** Starting position in the result set (must be non-negative) */
+	position: number;
 	/** Time-to-live in milliseconds (cursor never expires if omitted) */
 	ttl?: number;
 }
@@ -92,10 +92,14 @@ interface CreateCursorOptions {
 */
 interface CursorStore {
 	/**
-	* Save or update a cursor in the store.
-	* @param cursor - The cursor to store (replaces existing if same ID)
+	* Remove all cursors from the store.
 	*/
-	set(cursor: Cursor): void;
+	clear(): void;
+	/**
+	* Delete a cursor by ID.
+	* @param id - The cursor ID to delete (no-op if not found)
+	*/
+	delete(id: string): void;
 	/**
 	* Retrieve a cursor by ID.
 	* @param id - The cursor ID to look up
@@ -109,15 +113,6 @@ interface CursorStore {
 	*/
 	has(id: string): boolean;
 	/**
-	* Delete a cursor by ID.
-	* @param id - The cursor ID to delete (no-op if not found)
-	*/
-	delete(id: string): void;
-	/**
-	* Remove all cursors from the store.
-	*/
-	clear(): void;
-	/**
 	* List all cursor IDs in the store (including expired).
 	* @returns Array of cursor IDs
 	*/
@@ -127,6 +122,11 @@ interface CursorStore {
 	* @returns Number of cursors that were pruned
 	*/
 	prune(): number;
+	/**
+	* Save or update a cursor in the store.
+	* @param cursor - The cursor to store (replaces existing if same ID)
+	*/
+	set(cursor: Cursor): void;
 }
 /**
 * A cursor store with namespace isolation.
@@ -198,17 +198,17 @@ interface PersistentStoreOptions {
 * ```
 */
 interface PersistentStore extends CursorStore {
+	/**
+	* Dispose of the store and cleanup resources.
+	* Call this when the store is no longer needed.
+	*/
+	dispose(): void;
 	/**
 	* Flush all in-memory cursors to disk.
 	* Uses atomic write (temp file + rename) to prevent corruption.
 	* @returns Promise that resolves when write is complete
 	*/
 	flush(): Promise<void>;
-	/**
-	* Dispose of the store and cleanup resources.
-	* Call this when the store is no longer needed.
-	*/
-	dispose(): void;
 }
 /**
 * Create a new pagination cursor.
@@ -503,6 +503,11 @@ declare const DEFAULT_PAGE_LIMIT = 25;
 * ```
 */
 interface PaginationStore {
+	/**
+	* Delete a cursor by ID.
+	* @param id - The cursor ID to delete
+	*/
+	delete(id: string): void;
 	/**
 	* Get a cursor by ID.
 	* @param id - The cursor ID to look up
@@ -515,11 +520,6 @@ interface PaginationStore {
 	* @param cursor - The cursor to store
 	*/
 	set(id: string, cursor: Cursor): void;
-	/**
-	* Delete a cursor by ID.
-	* @param id - The cursor ID to delete
-	*/
-	delete(id: string): void;
 }
 /**
 * Get the default pagination store (module-level singleton).
@@ -568,10 +568,10 @@ declare function createPaginationStore(): PaginationStore;
 * @typeParam T - The type of items being paginated
 */
 interface PaginationResult<T> {
-	/** The items in the current page */
-	page: T[];
 	/** The cursor for the next page, or null if this is the last page */
 	nextCursor: Cursor | null;
+	/** The items in the current page */
+	page: T[];
 }
 /**
 * Extract a page of items based on cursor position.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@outfitter/state",
   "description": "Pagination cursor persistence and state management for Outfitter",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "type": "module",
   "files": [
     "dist"
@@ -24,11 +24,12 @@
     "lint:fix": "biome lint --write ./src",
     "test": "bun test",
     "typecheck": "tsc --noEmit",
-    "clean": "rm -rf dist"
+    "clean": "rm -rf dist",
+    "prepublishOnly": "bun ../../scripts/check-publish-manifest.ts"
   },
   "dependencies": {
-    "@outfitter/contracts": "0.4.0",
-    "@outfitter/types": "0.2.2"
+    "@outfitter/contracts": "0.4.1",
+    "@outfitter/types": "0.2.3"
   },
   "devDependencies": {
     "@types/bun": "latest",