@ahoo-wang/fetcher-wow 1.6.2 → 1.6.3

package/dist/query/cursorQuery.d.ts

@@ -0,0 +1,53 @@
+import { FieldSort, SortDirection } from './sort';
+import { ListQuery } from './queryable';
+import { Condition } from './condition';
+/**
+ * Represents a cursor-based pagination query configuration.
+ * This interface defines the structure for implementing cursor-based pagination,
+ * which is an efficient way to paginate through large datasets.
+ */
+export interface CursorQuery {
+    /** Field name used for cursor-based sorting and filtering */
+    field: string;
+    /**
+     * Cursor ID marking the starting point (exclusive)
+     * Uses CURSOR_ID_START constant for initial query
+     */
+    cursorId?: string;
+    /** Sort direction for pagination traversal (ascending or descending) */
+    direction?: SortDirection;
+    /** Base query object to be enhanced with cursor-based parameters */
+    query: ListQuery;
+}
+/** Special cursor ID value representing the starting point of a dataset */
+export declare const CURSOR_ID_START = "~";
+/**
+ * Generates a cursor condition for filtering records relative to the cursor position
+ * @param params - Cursor parameters excluding the base query
+ * @param params.field - The field to apply the cursor condition on
+ * @param params.cursorId - The cursor ID to compare against (defaults to CURSOR_ID_START)
+ * @param params.direction - Sort direction which determines the comparison operator (defaults to SortDirection.DESC)
+ * @returns Condition object for filtering records based on cursor position
+ */
+export declare function cursorCondition({ field, cursorId, direction, }: Omit<CursorQuery, 'query'>): Condition;
+/**
+ * Creates a sort configuration based on cursor parameters
+ * @param params - Cursor parameters excluding the base query
+ * @param params.field - The field to sort by
+ * @param params.direction - Sort direction (defaults to SortDirection.DESC)
+ * @returns FieldSort configuration for cursor-based pagination
+ */
+export declare function cursorSort({ field, direction }: Omit<CursorQuery, 'query'>): FieldSort;
+/**
+ * Enhances a base query with cursor-based pagination parameters
+ * This function combines the cursor condition with the existing query condition
+ * and sets the sorting according to the cursor parameters.
+ * @param options - Complete cursor query configuration
+ * @param options.field - The field used for cursor-based sorting and filtering
+ * @param options.cursorId - The cursor ID marking the starting point (exclusive)
+ * @param options.direction - Sort direction for pagination traversal
+ * @param options.query - Base query object to be enhanced with cursor-based parameters
+ * @returns Enhanced query with cursor-based filtering and sorting
+ */
+export declare function cursorQuery(options: CursorQuery): ListQuery;
+//# sourceMappingURL=cursorQuery.d.ts.map

package/dist/query/cursorQuery.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cursorQuery.d.ts","sourceRoot":"","sources":["../../src/query/cursorQuery.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAO,SAAS,EAAU,MAAM,aAAa,CAAC;AAErD;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B,6DAA6D;IAC7D,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,wEAAwE;IACxE,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B,oEAAoE;IACpE,KAAK,EAAE,SAAS,CAAC;CAClB;AAED,2EAA2E;AAC3E,eAAO,MAAM,eAAe,MAAM,CAAC;AAEnC;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,EACE,KAAK,EACL,QAA0B,EAC1B,SAA8B,GAC/B,EAAE,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,GAAG,SAAS,CAQxE;AAED;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,EAAE,KAAK,EAAE,SAA8B,EAAE,EAAE,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,GAAG,SAAS,CAE3G;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,WAAW,GAAG,SAAS,CAS3D"}

package/dist/query/index.d.ts

@@ -7,4 +7,5 @@ export * from './queryApi';
 export * from './sort';
 export * from './event';
 export * from './snapshot';
+export * from './cursorQuery';
 //# sourceMappingURL=index.d.ts.map

package/dist/query/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/query/index.ts"],"names":[],"mappings":"AAaA,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/query/index.ts"],"names":[],"mappings":"AAaA,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ahoo-wang/fetcher-wow",
-  "version": "1.6.2",
+  "version": "1.6.3",
   "description": "Support for Wow(https://github.com/Ahoo-Wang/Wow) in Fetcher",
   "keywords": [
     "fetch",
@@ -38,8 +38,8 @@
     "dist"
   ],
   "dependencies": {
-    "@ahoo-wang/fetcher": "1.6.2",
-    "@ahoo-wang/fetcher-eventstream": "1.6.2"
+    "@ahoo-wang/fetcher": "1.6.3",
+    "@ahoo-wang/fetcher-eventstream": "1.6.3"
   },
   "devDependencies": {
     "@vitest/coverage-v8": "^3.2.4",