@ahoo-wang/wow-client 9.2.0-rc.0

package/dist/client/query/snapshot/snapshotQueryClient.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"snapshotQueryClient.cjs","names":["autoGeneratedError","singleQuery","filter","listQuery","_decorate","post","SnapshotQueryEndpointPaths","_decorateParam","body","attribute","_decorateMetadata","QUERY_STREAM_ENDPOINT","api","require_builders","require_queryable","require_endpoints","require_bindMethods","require_decorateMetadata","require_decorateParam","require_decorate","require_endpointPaths","_ahoo_wang_fetcher_decorator","SnapshotQueryClient","apiMetadata","query","attributes","abort","filter","listQuery","pagedQuery","singleQuery","id","ids"],"sources":["../../../../src/client/query/snapshot/snapshotQueryClient.ts"],"sourcesContent":["/*\n * Copyright [2021-present] [ahoo wang <ahoowang@qq.com> (https://github.com/Ahoo-Wang)].\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *      http://www.apache.org/licenses/LICENSE-2.0\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { SnapshotQueryApi } from './snapshotQueryApi.js';\nimport { SnapshotQueryEndpointPaths } from './endpointPaths.js';\nimport type { AggregationQuery } from '../../../dsl/aggregation/index.js';\nimport { filter, type FilterExpression } from '../../../dsl/filter/index.js';\nimport type {\n  Condition,\n  ListQueryRequest,\n  PagedQueryRequest,\n  SingleQueryRequest,\n} from '../requests.js';\nimport {\n  listQuery,\n  type PagedList,\n  singleQuery,\n} from '../../../dsl/queryable.js';\nimport type { MaterializedSnapshot } from './snapshot.js';\nimport type { DynamicDocument } from '../../../dsl/documents.js';\nimport type { CursorPage, CursorQuery } from '../../../dsl/cursorQuery.js';\nimport { QUERY_STREAM_ENDPOINT } from '../../../transport/endpoints.js';\nimport type {\n  ApiMetadata,\n  ApiMetadataCapable,\n} from '@ahoo-wang/fetcher-decorator';\nimport {\n  api,\n  attribute,\n  autoGeneratedError,\n  body,\n  post,\n} from '@ahoo-wang/fetcher-decorator';\nimport { bindMethods } from '../../bindMethods.js';\n\n/**\n * A client for querying snapshot data through HTTP endpoints.\n * Provides methods for various query operations such as counting, listing, paging, and retrieving single snapshots.\n *\n * @example\n * ```typescript\n * // Define the state interface\n * interface CartItem {\n *   productId: string;\n *   quantity: number;\n * }\n *\n * interface CartState {\n *   items: CartItem[];\n * }\n *\n * // Create client options configuration\n * const clientOptions: ApiMetadata = {\n *   fetcher: new Fetcher({ baseURL: 'http://localhost:8080/' }),\n *   basePath: 'owner/{ownerId}/cart'\n * };\n *\n * // Create a snapshot query client instance\n * const snapshotQueryClient = new SnapshotQueryClient<CartState>(clientOptions);\n *\n * // Count snapshots\n * const count = await snapshotQueryClient.count(filter.matchAll());\n *\n * // List snapshots\n * const listQuery: FilterListQuery = {\n *   filter: filter.matchAll()\n * };\n * const list = await snapshotQueryClient.list(listQuery);\n *\n * // List snapshots as stream\n * const listStream = await snapshotQueryClient.listStream(listQuery);\n * for await (const snapshot of listStream) {\n *   console.log('Received:', snapshot);\n * }\n *\n * // List snapshot states\n * const stateList = await snapshotQueryClient.listState(listQuery);\n *\n * // List snapshot states as stream\n * const stateListStream = await snapshotQueryClient.listStateStream(listQuery);\n * for await (const state of stateListStream) {\n *   console.log('Received state:', state);\n * }\n *\n * // Paged snapshots\n * const pagedQuery: FilterPagedQuery = {\n *   filter: filter.matchAll(),\n *   pagination: { index: 1, size: 10 }\n * };\n * const paged = await snapshotQueryClient.paged(pagedQuery);\n *\n * // Paged snapshot states\n * const pagedState = await snapshotQueryClient.pagedState(pagedQuery);\n *\n * // Single snapshot\n * const singleQuery: FilterSingleQuery = {\n *   filter: filter.matchAll()\n * };\n * const single = await snapshotQueryClient.single(singleQuery);\n *\n * // Single snapshot state\n * const singleState = await snapshotQueryClient.singleState(singleQuery);\n * ```\n *\n * @template S The type of the snapshot state\n */\n@api()\nexport class SnapshotQueryClient<S, FIELDS extends string = string>\n  implements SnapshotQueryApi<S, FIELDS>, ApiMetadataCapable\n{\n  /**\n   * Creates a new SnapshotQueryClient instance.\n   */\n  constructor(public readonly apiMetadata?: ApiMetadata) {\n    bindMethods(this);\n  }\n\n  /** Runs a snapshot aggregation and returns all result rows. */\n  @post(SnapshotQueryEndpointPaths.AGGREGATION)\n  /* v8 ignore start */\n  aggregate<\n    Row extends object = DynamicDocument,\n    AGGREGATION_FIELDS extends string = string,\n  >(\n    @body() query: AggregationQuery<FIELDS, AGGREGATION_FIELDS>,\n    @attribute() attributes?: Record<string, unknown>,\n    abort?: AbortController | AbortSignal,\n  ): Promise<Row[]> {\n    throw autoGeneratedError(query, attributes, abort);\n  }\n  /* v8 ignore stop */\n\n  /** Runs a snapshot aggregation and streams the result rows, one per server-sent event. */\n  @post(SnapshotQueryEndpointPaths.AGGREGATION, QUERY_STREAM_ENDPOINT)\n  /* v8 ignore start */\n  aggregateStream<\n    Row extends object = DynamicDocument,\n    AGGREGATION_FIELDS extends string = string,\n  >(\n    @body() query: AggregationQuery<FIELDS, AGGREGATION_FIELDS>,\n    @attribute() attributes?: Record<string, unknown>,\n    abort?: AbortController | AbortSignal,\n  ): Promise<ReadableStream<Row>> {\n    throw autoGeneratedError(query, attributes, abort);\n  }\n  /* v8 ignore stop */\n\n  /** Retrieves the next cursor page of materialized snapshots. */\n  @post(SnapshotQueryEndpointPaths.CURSOR)\n  /* v8 ignore start */\n  cursor<T extends Partial<MaterializedSnapshot<S>> = MaterializedSnapshot<S>>(\n    @body() query: CursorQuery<FIELDS>,\n    @attribute() attributes?: Record<string, unknown>,\n    abort?: AbortController | AbortSignal,\n  ): Promise<CursorPage<T>> {\n    throw autoGeneratedError(query, attributes, abort);\n  }\n  /* v8 ignore stop */\n\n  /** Retrieves the next cursor page of snapshot states. */\n  @post(SnapshotQueryEndpointPaths.CURSOR_STATE)\n  /* v8 ignore start */\n  cursorState<T extends Partial<S> = S>(\n    @body() query: CursorQuery<FIELDS>,\n    @attribute() attributes?: Record<string, unknown>,\n    abort?: AbortController | AbortSignal,\n  ): Promise<CursorPage<T>> {\n    throw autoGeneratedError(query, attributes, abort);\n  }\n  /* v8 ignore stop */\n\n  /**\n   * Counts the number of snapshots that match the given filter.\n   *\n   * @param filter - The filter expression or legacy condition\n   * @param attributes - Optional shared attributes that can be accessed by interceptors\n   *                     throughout the request lifecycle. These attributes allow passing\n   *                     custom data between different interceptors.\n   * @param abort - Cancels the request: an `AbortController`, or an `AbortSignal` such as `AbortSignal.timeout(ms)` or the `signal` a data-fetching library passes.\n   * @returns A promise that resolves to the count of matching snapshots\n   *\n   * @example\n   * ```typescript\n   * const count = await snapshotQueryClient.count(filter.matchAll());\n   * console.log('Total snapshots:', count);\n   * ```\n   */\n  @post(SnapshotQueryEndpointPaths.COUNT)\n  /* v8 ignore start */\n  count(\n    // compat(wow<9): accepts the deprecated Condition, which Wow < 8.11 needs; narrow to FilterExpression in v10.\n    @body() filter: FilterExpression<FIELDS> | Condition<FIELDS>,\n    @attribute() attributes?: Record<string, unknown>,\n    abort?: AbortController | AbortSignal,\n  ): Promise<number> {\n    throw autoGeneratedError(filter, attributes, abort);\n  }\n  /* v8 ignore stop */\n\n  /**\n   * Retrieves a list of materialized snapshots based on the provided query parameters.\n   *\n   * @param listQuery - The query parameters for listing snapshots\n   * @param attributes - Optional shared attributes that can be accessed by interceptors\n   *                     throughout the request lifecycle. These attributes allow passing\n   *                     custom data between different interceptors.\n   * @param abort - Cancels the request: an `AbortController`, or an `AbortSignal` such as `AbortSignal.timeout(ms)` or the `signal` a data-fetching library passes.\n   * @returns A promise that resolves to an array of partial materialized snapshots\n   *\n   * @example\n   * ```typescript\n   * const listQuery: FilterListQuery = {\n   *   filter: filter.matchAll()\n   * };\n   * const list = await snapshotQueryClient.list(listQuery);\n   * for (const snapshot of list) {\n   *   console.log('Snapshot:', snapshot);\n   * }\n   * ```\n   */\n  @post(SnapshotQueryEndpointPaths.LIST)\n  /* v8 ignore start */\n  list<T extends Partial<MaterializedSnapshot<S>> = MaterializedSnapshot<S>>(\n    @body() listQuery: ListQueryRequest<FIELDS>,\n    @attribute() attributes?: Record<string, unknown>,\n    abort?: AbortController | AbortSignal,\n  ): Promise<T[]> {\n    throw autoGeneratedError(listQuery, attributes, abort);\n  }\n  /* v8 ignore stop */\n\n  /**\n   * Retrieves a stream of materialized snapshots based on the provided query parameters.\n   *\n   * @param listQuery - The query parameters for listing snapshots\n   * @param attributes - Optional shared attributes that can be accessed by interceptors\n   *                     throughout the request lifecycle. These attributes allow passing\n   *                     custom data between different interceptors.\n   * @param abort - Cancels the request: an `AbortController`, or an `AbortSignal` such as `AbortSignal.timeout(ms)` or the `signal` a data-fetching library passes.\n   * @returns A promise that resolves to a readable stream of partial materialized snapshots\n   *\n   * @example\n   * ```typescript\n   * const listQuery: FilterListQuery = {\n   *   filter: filter.matchAll()\n   * };\n   * const listStream = await snapshotQueryClient.listStream(listQuery);\n   * for await (const snapshot of listStream) {\n   *   console.log('Received snapshot:', snapshot);\n   * }\n   * ```\n   */\n  @post(SnapshotQueryEndpointPaths.LIST, QUERY_STREAM_ENDPOINT)\n  /* v8 ignore start */\n  listStream<\n    T extends Partial<MaterializedSnapshot<S>> = MaterializedSnapshot<S>,\n  >(\n    @body() listQuery: ListQueryRequest<FIELDS>,\n    @attribute() attributes?: Record<string, unknown>,\n    abort?: AbortController | AbortSignal,\n  ): Promise<ReadableStream<T>> {\n    throw autoGeneratedError(listQuery, attributes, abort);\n  }\n  /* v8 ignore stop */\n\n  /**\n   * Retrieves a list of snapshot states based on the provided query parameters.\n   *\n   * @param listQuery - The query parameters for listing snapshot states\n   * @param attributes - Optional shared attributes that can be accessed by interceptors\n   *                     throughout the request lifecycle. These attributes allow passing\n   *                     custom data between different interceptors.\n   * @param abort - Cancels the request: an `AbortController`, or an `AbortSignal` such as `AbortSignal.timeout(ms)` or the `signal` a data-fetching library passes.\n   * @returns A promise that resolves to an array of partial snapshot states\n   *\n   * @example\n   * ```typescript\n   * const listQuery: FilterListQuery = {\n   *   filter: filter.matchAll()\n   * };\n   * const list = await snapshotQueryClient.listState(listQuery);\n   * for (const state of list) {\n   *   console.log('State:', state);\n   * }\n   * ```\n   */\n  @post(SnapshotQueryEndpointPaths.LIST_STATE)\n  /* v8 ignore start */\n  listState<T extends Partial<S> = S>(\n    @body() listQuery: ListQueryRequest<FIELDS>,\n    @attribute() attributes?: Record<string, unknown>,\n    abort?: AbortController | AbortSignal,\n  ): Promise<T[]> {\n    throw autoGeneratedError(listQuery, attributes, abort);\n  }\n  /* v8 ignore stop */\n\n  /**\n   * Retrieves a stream of snapshot states based on the provided query parameters.\n   *\n   * @param listQuery - The query parameters for listing snapshot states\n   * @param attributes - Optional shared attributes that can be accessed by interceptors\n   *                     throughout the request lifecycle. These attributes allow passing\n   *                     custom data between different interceptors.\n   * @param abort - Cancels the request: an `AbortController`, or an `AbortSignal` such as `AbortSignal.timeout(ms)` or the `signal` a data-fetching library passes.\n   * @returns A promise that resolves to a readable stream of partial snapshot states\n   *\n   * @example\n   * ```typescript\n   * const listQuery: FilterListQuery = {\n   *   filter: filter.matchAll()\n   * };\n   * const listStream = await snapshotQueryClient.listStateStream(listQuery);\n   * for await (const state of listStream) {\n   *   console.log('Received state:', state);\n   * }\n   * ```\n   */\n  @post(SnapshotQueryEndpointPaths.LIST_STATE, QUERY_STREAM_ENDPOINT)\n  /* v8 ignore start */\n  listStateStream<T extends Partial<S> = S>(\n    @body() listQuery: ListQueryRequest<FIELDS>,\n    @attribute() attributes?: Record<string, unknown>,\n    abort?: AbortController | AbortSignal,\n  ): Promise<ReadableStream<T>> {\n    throw autoGeneratedError(listQuery, attributes, abort);\n  }\n  /* v8 ignore stop */\n\n  /**\n   * Retrieves a paged list of materialized snapshots based on the provided query parameters.\n   *\n   * @param pagedQuery - The query parameters for paging snapshots\n   * @param attributes - Optional shared attributes that can be accessed by interceptors\n   *                     throughout the request lifecycle. These attributes allow passing\n   *                     custom data between different interceptors.\n   * @param abort - Cancels the request: an `AbortController`, or an `AbortSignal` such as `AbortSignal.timeout(ms)` or the `signal` a data-fetching library passes.\n   * @returns A promise that resolves to a paged list of partial materialized snapshots\n   *\n   * @example\n   * ```typescript\n   * const pagedQuery: FilterPagedQuery = {\n   *   filter: filter.matchAll(),\n   *   pagination: { index: 1, size: 10 }\n   * };\n   * const paged = await snapshotQueryClient.paged(pagedQuery);\n   * console.log('Total:', paged.total);\n   * for (const snapshot of paged.list) {\n   *   console.log('Snapshot:', snapshot);\n   * }\n   * ```\n   */\n  @post(SnapshotQueryEndpointPaths.PAGED)\n  /* v8 ignore start */\n  paged<T extends Partial<MaterializedSnapshot<S>> = MaterializedSnapshot<S>>(\n    @body() pagedQuery: PagedQueryRequest<FIELDS>,\n    @attribute() attributes?: Record<string, unknown>,\n    abort?: AbortController | AbortSignal,\n  ): Promise<PagedList<T>> {\n    throw autoGeneratedError(pagedQuery, attributes, abort);\n  }\n  /* v8 ignore stop */\n\n  /**\n   * Retrieves a paged list of snapshot states based on the provided query parameters.\n   *\n   * @param pagedQuery - The query parameters for paging snapshot states\n   * @param attributes - Optional shared attributes that can be accessed by interceptors\n   *                     throughout the request lifecycle. These attributes allow passing\n   *                     custom data between different interceptors.\n   * @param abort - Cancels the request: an `AbortController`, or an `AbortSignal` such as `AbortSignal.timeout(ms)` or the `signal` a data-fetching library passes.\n   * @returns A promise that resolves to a paged list of partial snapshot states\n   *\n   * @example\n   * ```typescript\n   * const pagedQuery: FilterPagedQuery = {\n   *   filter: filter.matchAll(),\n   *   pagination: { index: 1, size: 10 }\n   * };\n   * const pagedState = await snapshotQueryClient.pagedState(pagedQuery);\n   * for (const state of pagedState.list) {\n   *   console.log('State:', state);\n   * }\n   * ```\n   */\n  @post(SnapshotQueryEndpointPaths.PAGED_STATE)\n  /* v8 ignore start */\n  pagedState<T extends Partial<S> = S>(\n    @body() pagedQuery: PagedQueryRequest<FIELDS>,\n    @attribute() attributes?: Record<string, unknown>,\n    abort?: AbortController | AbortSignal,\n  ): Promise<PagedList<T>> {\n    throw autoGeneratedError(pagedQuery, attributes, abort);\n  }\n  /* v8 ignore stop */\n\n  /**\n   * Retrieves a single materialized snapshot based on the provided query parameters.\n   *\n   * @param singleQuery - The query parameters for retrieving a single snapshot\n   * @param attributes - Optional shared attributes that can be accessed by interceptors\n   *                     throughout the request lifecycle. These attributes allow passing\n   *                     custom data between different interceptors.\n   * @param abort - Cancels the request: an `AbortController`, or an `AbortSignal` such as `AbortSignal.timeout(ms)` or the `signal` a data-fetching library passes.\n   * @returns A promise that resolves to a partial materialized snapshot\n   *\n   * @example\n   * ```typescript\n   * const singleQuery: FilterSingleQuery = {\n   *   filter: filter.matchAll()\n   * };\n   * const single = await snapshotQueryClient.single(singleQuery);\n   * console.log('Snapshot:', single);\n   * ```\n   */\n  @post(SnapshotQueryEndpointPaths.SINGLE)\n  /* v8 ignore start */\n  single<T extends Partial<MaterializedSnapshot<S>> = MaterializedSnapshot<S>>(\n    @body() singleQuery: SingleQueryRequest<FIELDS>,\n    @attribute() attributes?: Record<string, unknown>,\n    abort?: AbortController | AbortSignal,\n  ): Promise<T> {\n    throw autoGeneratedError(singleQuery, attributes, abort);\n  }\n  /* v8 ignore stop */\n\n  /**\n   * Retrieves a single snapshot state based on the provided query parameters.\n   *\n   * @param singleQuery - The query parameters for retrieving a single snapshot state\n   * @param attributes - Optional shared attributes that can be accessed by interceptors\n   *                     throughout the request lifecycle. These attributes allow passing\n   *                     custom data between different interceptors.\n   * @param abort - Cancels the request: an `AbortController`, or an `AbortSignal` such as `AbortSignal.timeout(ms)` or the `signal` a data-fetching library passes.\n   * @returns A promise that resolves to a partial snapshot state\n   *\n   * @example\n   * ```typescript\n   * const singleQuery: FilterSingleQuery = {\n   *   filter: filter.matchAll()\n   * };\n   * const singleState = await snapshotQueryClient.singleState(singleQuery);\n   * console.log('State:', singleState);\n   * ```\n   */\n  @post(SnapshotQueryEndpointPaths.SINGLE_STATE)\n  /* v8 ignore start */\n  singleState<T extends Partial<S> = S>(\n    @body() singleQuery: SingleQueryRequest<FIELDS>,\n    @attribute() attributes?: Record<string, unknown>,\n    abort?: AbortController | AbortSignal,\n  ): Promise<T> {\n    throw autoGeneratedError(singleQuery, attributes, abort);\n  }\n  /* v8 ignore stop */\n\n  /**\n   * Retrieves a single materialized snapshot by its ID.\n   *\n   * @param id - The unique identifier of the snapshot to retrieve\n   * @param attributes - Optional shared attributes that can be accessed by interceptors\n   *                     throughout the request lifecycle. These attributes allow passing\n   *                     custom data between different interceptors.\n   * @param abort - Cancels the request: an `AbortController`, or an `AbortSignal` such as `AbortSignal.timeout(ms)` or the `signal` a data-fetching library passes.\n   * @returns A promise that resolves to the materialized snapshot with the specified ID\n   *\n   * @example\n   * ```typescript\n   * const snapshot = await snapshotQueryClient.getById('snapshot-123');\n   * console.log('Snapshot:', snapshot);\n   * ```\n   */\n  getById(\n    id: string,\n    attributes?: Record<string, unknown>,\n    abort?: AbortController | AbortSignal,\n  ): Promise<MaterializedSnapshot<S>> {\n    const query = singleQuery<FIELDS>({ filter: filter.aggregateId(id) });\n    return this.single(query, attributes, abort);\n  }\n\n  /**\n   * Retrieves a single snapshot state by its ID.\n   *\n   * @param id - The unique identifier of the snapshot whose state to retrieve\n   * @param attributes - Optional shared attributes that can be accessed by interceptors\n   *                     throughout the request lifecycle. These attributes allow passing\n   *                     custom data between different interceptors.\n   * @param abort - Cancels the request: an `AbortController`, or an `AbortSignal` such as `AbortSignal.timeout(ms)` or the `signal` a data-fetching library passes.\n   * @returns A promise that resolves to the snapshot state with the specified ID\n   *\n   * @example\n   * ```typescript\n   * const state = await snapshotQueryClient.getStateById('snapshot-123');\n   * console.log('State:', state);\n   * ```\n   */\n  getStateById(\n    id: string,\n    attributes?: Record<string, unknown>,\n    abort?: AbortController | AbortSignal,\n  ): Promise<S> {\n    const query = singleQuery<FIELDS>({ filter: filter.aggregateId(id) });\n    return this.singleState(query, attributes, abort);\n  }\n\n  /**\n   * Retrieves multiple materialized snapshots by their IDs.\n   *\n   * One request, filtered by `filter.aggregateIds(ids)` with `limit` set to\n   * the number of ids; an empty `ids` sends nothing and resolves to `[]`. The\n   * server refuses more ids than its filter value limit and its maximum list\n   * size (1000 each by default), so split a larger set into batches.\n   *\n   * @param ids - An array of unique identifiers of the snapshots to retrieve\n   * @param attributes - Optional shared attributes that can be accessed by interceptors\n   *                     throughout the request lifecycle. These attributes allow passing\n   *                     custom data between different interceptors.\n   * @param abort - Cancels the request: an `AbortController`, or an `AbortSignal` such as `AbortSignal.timeout(ms)` or the `signal` a data-fetching library passes.\n   * @returns A promise that resolves to an array of materialized snapshots with the specified IDs\n   *\n   * @example\n   * ```typescript\n   * const snapshots = await snapshotQueryClient.getByIds(['snapshot-123', 'snapshot-456']);\n   * for (const snapshot of snapshots) {\n   *   console.log('Snapshot:', snapshot);\n   * }\n   * ```\n   */\n  getByIds(\n    ids: string[],\n    attributes?: Record<string, unknown>,\n    abort?: AbortController | AbortSignal,\n  ): Promise<MaterializedSnapshot<S>[]> {\n    if (ids.length === 0) return Promise.resolve([]);\n    const query = listQuery<FIELDS>({\n      filter: filter.aggregateIds(ids),\n      limit: ids.length,\n    });\n    return this.list(query, attributes, abort);\n  }\n\n  /**\n   * Retrieves multiple snapshot states by their IDs.\n   *\n   * One request, filtered by `filter.aggregateIds(ids)` with `limit` set to\n   * the number of ids; an empty `ids` sends nothing and resolves to `[]`. The\n   * server refuses more ids than its filter value limit and its maximum list\n   * size (1000 each by default), so split a larger set into batches.\n   *\n   * @param ids - An array of unique identifiers of the snapshots whose states to retrieve\n   * @param attributes - Optional shared attributes that can be accessed by interceptors\n   *                     throughout the request lifecycle. These attributes allow passing\n   *                     custom data between different interceptors.\n   * @param abort - Cancels the request: an `AbortController`, or an `AbortSignal` such as `AbortSignal.timeout(ms)` or the `signal` a data-fetching library passes.\n   * @returns A promise that resolves to an array of snapshot states with the specified IDs\n   *\n   * @example\n   * ```typescript\n   * const states = await snapshotQueryClient.getStateByIds(['snapshot-123', 'snapshot-456']);\n   * for (const state of states) {\n   *   console.log('State:', state);\n   * }\n   * ```\n   */\n  getStateByIds(\n    ids: string[],\n    attributes?: Record<string, unknown>,\n    abort?: AbortController | AbortSignal,\n  ): Promise<S[]> {\n    if (ids.length === 0) return Promise.resolve([]);\n    const query = listQuery<FIELDS>({\n      filter: filter.aggregateIds(ids),\n      limit: ids.length,\n    });\n    return this.listState(query, attributes, abort);\n  }\n}\n"],"mappings":"2gBAqHO,IAAMsB,EAAN,KAEP,CAIE,YAAY,EAA2C,CAA3B,KAAA,YAAAC,EAC1BP,EAAA,YAAY,IAAI,CAClB,CAGA,UAME,EACA,EACA,EACgB,CAChB,MAAA,EAAMhB,EAAAA,mBAAAA,CAAmBwB,EAAOC,EAAYC,CAAK,CACnD,CAIA,gBAME,EACA,EACA,EAC8B,CAC9B,MAAA,EAAM1B,EAAAA,mBAAAA,CAAmBwB,EAAOC,EAAYC,CAAK,CACnD,CAIA,OAGE,EACA,EACA,EACwB,CACxB,MAAA,EAAM1B,EAAAA,mBAAAA,CAAmBwB,EAAOC,EAAYC,CAAK,CACnD,CAIA,YAGE,EACA,EACA,EACwB,CACxB,MAAA,EAAM1B,EAAAA,mBAAAA,CAAmBwB,EAAOC,EAAYC,CAAK,CACnD,CAmBA,MAIE,EACA,EACA,EACiB,CACjB,MAAA,EAAM1B,EAAAA,mBAAAA,CAAmB2B,EAAQF,EAAYC,CAAK,CACpD,CAwBA,KAGE,EACA,EACA,EACc,CACd,MAAA,EAAM1B,EAAAA,mBAAAA,CAAmB4B,EAAWH,EAAYC,CAAK,CACvD,CAwBA,WAKE,EACA,EACA,EAC4B,CAC5B,MAAA,EAAM1B,EAAAA,mBAAAA,CAAmB4B,EAAWH,EAAYC,CAAK,CACvD,CAwBA,UAGE,EACA,EACA,EACc,CACd,MAAA,EAAM1B,EAAAA,mBAAAA,CAAmB4B,EAAWH,EAAYC,CAAK,CACvD,CAwBA,gBAGE,EACA,EACA,EAC4B,CAC5B,MAAA,EAAM1B,EAAAA,mBAAAA,CAAmB4B,EAAWH,EAAYC,CAAK,CACvD,CA0BA,MAGE,EACA,EACA,EACuB,CACvB,MAAA,EAAM1B,EAAAA,mBAAAA,CAAmB6B,EAAYJ,EAAYC,CAAK,CACxD,CAyBA,WAGE,EACA,EACA,EACuB,CACvB,MAAA,EAAM1B,EAAAA,mBAAAA,CAAmB6B,EAAYJ,EAAYC,CAAK,CACxD,CAsBA,OAGE,EACA,EACA,EACY,CACZ,MAAA,EAAM1B,EAAAA,mBAAAA,CAAmB8B,EAAaL,EAAYC,CAAK,CACzD,CAsBA,YAGE,EACA,EACA,EACY,CACZ,MAAA,EAAM1B,EAAAA,mBAAAA,CAAmB8B,EAAaL,EAAYC,CAAK,CACzD,CAmBA,QACE,EACA,EACA,EACkC,CAClC,IAAMF,EAAQvB,EAAAA,YAAoB,CAAE,OAAQC,EAAAA,OAAO,YAAY6B,CAAE,CAAE,CAAC,EACpE,OAAO,KAAK,OAAOP,EAAOC,EAAYC,CAAK,CAC7C,CAkBA,aACE,EACA,EACA,EACY,CACZ,IAAMF,EAAQvB,EAAAA,YAAoB,CAAE,OAAQC,EAAAA,OAAO,YAAY6B,CAAE,CAAE,CAAC,EACpE,OAAO,KAAK,YAAYP,EAAOC,EAAYC,CAAK,CAClD,CAyBA,SACE,EACA,EACA,EACoC,CACpC,GAAIM,EAAI,SAAW,EAAG,OAAO,QAAQ,QAAQ,CAAC,CAAC,EAC/C,IAAMR,EAAQrB,EAAAA,UAAkB,CAC9B,OAAQD,EAAAA,OAAO,aAAa8B,CAAG,EAC/B,MAAOA,EAAI,MACb,CAAC,EACD,OAAO,KAAK,KAAKR,EAAOC,EAAYC,CAAK,CAC3C,CAyBA,cACE,EACA,EACA,EACc,CACd,GAAIM,EAAI,SAAW,EAAG,OAAO,QAAQ,QAAQ,CAAC,CAAC,EAC/C,IAAMR,EAAQrB,EAAAA,UAAkB,CAC9B,OAAQD,EAAAA,OAAO,aAAa8B,CAAG,EAC/B,MAAOA,EAAI,MACb,CAAC,EACD,OAAO,KAAK,UAAUR,EAAOC,EAAYC,CAAK,CAChD,CACF,cA3cGrB,EAAAA,EAAAA,KAAAA,CAAKC,EAAAA,2BAA2B,WAAW,EAMzCC,EAAAA,QAAA,GAAA,EAAAC,EAAAA,KAAAA,CAAK,CAAA,EACLD,EAAAA,QAAA,GAAA,EAAAE,EAAAA,UAAAA,CAAU,CAAA,+NAQZJ,EAAAA,EAAAA,KAAAA,CAAKC,EAAAA,2BAA2B,YAAaK,EAAAA,qBAAqB,EAMhEJ,EAAAA,QAAA,GAAA,EAAAC,EAAAA,KAAAA,CAAK,CAAA,EACLD,EAAAA,QAAA,GAAA,EAAAE,EAAAA,UAAAA,CAAU,CAAA,qOAQZJ,EAAAA,EAAAA,KAAAA,CAAKC,EAAAA,2BAA2B,MAAM,EAGpCC,EAAAA,QAAA,GAAA,EAAAC,EAAAA,KAAAA,CAAK,CAAA,EACLD,EAAAA,QAAA,GAAA,EAAAE,EAAAA,UAAAA,CAAU,CAAA,4NAQZJ,EAAAA,EAAAA,KAAAA,CAAKC,EAAAA,2BAA2B,YAAY,EAG1CC,EAAAA,QAAA,GAAA,EAAAC,EAAAA,KAAAA,CAAK,CAAA,EACLD,EAAAA,QAAA,GAAA,EAAAE,EAAAA,UAAAA,CAAU,CAAA,iOAuBZJ,EAAAA,EAAAA,KAAAA,CAAKC,EAAAA,2BAA2B,KAAK,EAInCC,EAAAA,QAAA,GAAA,EAAAC,EAAAA,KAAAA,CAAK,CAAA,EACLD,EAAAA,QAAA,GAAA,EAAAE,EAAAA,UAAAA,CAAU,CAAA,2NA4BZJ,EAAAA,EAAAA,KAAAA,CAAKC,EAAAA,2BAA2B,IAAI,EAGlCC,EAAAA,QAAA,GAAA,EAAAC,EAAAA,KAAAA,CAAK,CAAA,EACLD,EAAAA,QAAA,GAAA,EAAAE,EAAAA,UAAAA,CAAU,CAAA,0NA4BZJ,EAAAA,EAAAA,KAAAA,CAAKC,EAAAA,2BAA2B,KAAMK,EAAAA,qBAAqB,EAKzDJ,EAAAA,QAAA,GAAA,EAAAC,EAAAA,KAAAA,CAAK,CAAA,EACLD,EAAAA,QAAA,GAAA,EAAAE,EAAAA,UAAAA,CAAU,CAAA,gOA4BZJ,EAAAA,EAAAA,KAAAA,CAAKC,EAAAA,2BAA2B,UAAU,EAGxCC,EAAAA,QAAA,GAAA,EAAAC,EAAAA,KAAAA,CAAK,CAAA,EACLD,EAAAA,QAAA,GAAA,EAAAE,EAAAA,UAAAA,CAAU,CAAA,+NA4BZJ,EAAAA,EAAAA,KAAAA,CAAKC,EAAAA,2BAA2B,WAAYK,EAAAA,qBAAqB,EAG/DJ,EAAAA,QAAA,GAAA,EAAAC,EAAAA,KAAAA,CAAK,CAAA,EACLD,EAAAA,QAAA,GAAA,EAAAE,EAAAA,UAAAA,CAAU,CAAA,qOA8BZJ,EAAAA,EAAAA,KAAAA,CAAKC,EAAAA,2BAA2B,KAAK,EAGnCC,EAAAA,QAAA,GAAA,EAAAC,EAAAA,KAAAA,CAAK,CAAA,EACLD,EAAAA,QAAA,GAAA,EAAAE,EAAAA,UAAAA,CAAU,CAAA,2NA6BZJ,EAAAA,EAAAA,KAAAA,CAAKC,EAAAA,2BAA2B,WAAW,EAGzCC,EAAAA,QAAA,GAAA,EAAAC,EAAAA,KAAAA,CAAK,CAAA,EACLD,EAAAA,QAAA,GAAA,EAAAE,EAAAA,UAAAA,CAAU,CAAA,gOA0BZJ,EAAAA,EAAAA,KAAAA,CAAKC,EAAAA,2BAA2B,MAAM,EAGpCC,EAAAA,QAAA,GAAA,EAAAC,EAAAA,KAAAA,CAAK,CAAA,EACLD,EAAAA,QAAA,GAAA,EAAAE,EAAAA,UAAAA,CAAU,CAAA,4NA0BZJ,EAAAA,EAAAA,KAAAA,CAAKC,EAAAA,2BAA2B,YAAY,EAG1CC,EAAAA,QAAA,GAAA,EAAAC,EAAAA,KAAAA,CAAK,CAAA,EACLD,EAAAA,QAAA,GAAA,EAAAE,EAAAA,UAAAA,CAAU,CAAA,qNAvVd,EAAAL,EAAAA,QAAA,EAAA,EAAAQ,EAAAA,IAAAA,CAAI,EAAAF,EAAAA,QAAA,oBAAA,CAAA,MAAA,CAAA,CAAA,EAAAY,CAAA"}

package/dist/client/query/snapshot/snapshotQueryClient.d.cts

@@ -0,0 +1,369 @@
+import { SnapshotQueryApi } from './snapshotQueryApi.cjs';
+import { AggregationQuery } from '../../../dsl/aggregation/index.cjs';
+import { FilterExpression } from '../../../dsl/filter/index.cjs';
+import { Condition, ListQueryRequest, PagedQueryRequest, SingleQueryRequest } from '../requests.cjs';
+import { PagedList } from '../../../dsl/queryable.cjs';
+import { MaterializedSnapshot } from './snapshot.cjs';
+import { DynamicDocument } from '../../../dsl/documents.cjs';
+import { CursorPage, CursorQuery } from '../../../dsl/cursorQuery.cjs';
+import { ApiMetadata, ApiMetadataCapable } from '@ahoo-wang/fetcher-decorator';
+/**
+ * A client for querying snapshot data through HTTP endpoints.
+ * Provides methods for various query operations such as counting, listing, paging, and retrieving single snapshots.
+ *
+ * @example
+ * ```typescript
+ * // Define the state interface
+ * interface CartItem {
+ *   productId: string;
+ *   quantity: number;
+ * }
+ *
+ * interface CartState {
+ *   items: CartItem[];
+ * }
+ *
+ * // Create client options configuration
+ * const clientOptions: ApiMetadata = {
+ *   fetcher: new Fetcher({ baseURL: 'http://localhost:8080/' }),
+ *   basePath: 'owner/{ownerId}/cart'
+ * };
+ *
+ * // Create a snapshot query client instance
+ * const snapshotQueryClient = new SnapshotQueryClient<CartState>(clientOptions);
+ *
+ * // Count snapshots
+ * const count = await snapshotQueryClient.count(filter.matchAll());
+ *
+ * // List snapshots
+ * const listQuery: FilterListQuery = {
+ *   filter: filter.matchAll()
+ * };
+ * const list = await snapshotQueryClient.list(listQuery);
+ *
+ * // List snapshots as stream
+ * const listStream = await snapshotQueryClient.listStream(listQuery);
+ * for await (const snapshot of listStream) {
+ *   console.log('Received:', snapshot);
+ * }
+ *
+ * // List snapshot states
+ * const stateList = await snapshotQueryClient.listState(listQuery);
+ *
+ * // List snapshot states as stream
+ * const stateListStream = await snapshotQueryClient.listStateStream(listQuery);
+ * for await (const state of stateListStream) {
+ *   console.log('Received state:', state);
+ * }
+ *
+ * // Paged snapshots
+ * const pagedQuery: FilterPagedQuery = {
+ *   filter: filter.matchAll(),
+ *   pagination: { index: 1, size: 10 }
+ * };
+ * const paged = await snapshotQueryClient.paged(pagedQuery);
+ *
+ * // Paged snapshot states
+ * const pagedState = await snapshotQueryClient.pagedState(pagedQuery);
+ *
+ * // Single snapshot
+ * const singleQuery: FilterSingleQuery = {
+ *   filter: filter.matchAll()
+ * };
+ * const single = await snapshotQueryClient.single(singleQuery);
+ *
+ * // Single snapshot state
+ * const singleState = await snapshotQueryClient.singleState(singleQuery);
+ * ```
+ *
+ * @template S The type of the snapshot state
+ */
+export declare class SnapshotQueryClient<S, FIELDS extends string = string> implements SnapshotQueryApi<S, FIELDS>, ApiMetadataCapable {
+    readonly apiMetadata?: ApiMetadata | undefined;
+    /**
+     * Creates a new SnapshotQueryClient instance.
+     */
+    constructor(apiMetadata?: ApiMetadata | undefined);
+    /** Runs a snapshot aggregation and returns all result rows. */
+    aggregate<Row extends object = DynamicDocument, AGGREGATION_FIELDS extends string = string>(query: AggregationQuery<FIELDS, AGGREGATION_FIELDS>, attributes?: Record<string, unknown>, abort?: AbortController | AbortSignal): Promise<Row[]>;
+    /** Runs a snapshot aggregation and streams the result rows, one per server-sent event. */
+    aggregateStream<Row extends object = DynamicDocument, AGGREGATION_FIELDS extends string = string>(query: AggregationQuery<FIELDS, AGGREGATION_FIELDS>, attributes?: Record<string, unknown>, abort?: AbortController | AbortSignal): Promise<ReadableStream<Row>>;
+    /** Retrieves the next cursor page of materialized snapshots. */
+    cursor<T extends Partial<MaterializedSnapshot<S>> = MaterializedSnapshot<S>>(query: CursorQuery<FIELDS>, attributes?: Record<string, unknown>, abort?: AbortController | AbortSignal): Promise<CursorPage<T>>;
+    /** Retrieves the next cursor page of snapshot states. */
+    cursorState<T extends Partial<S> = S>(query: CursorQuery<FIELDS>, attributes?: Record<string, unknown>, abort?: AbortController | AbortSignal): Promise<CursorPage<T>>;
+    /**
+     * Counts the number of snapshots that match the given filter.
+     *
+     * @param filter - The filter expression or legacy condition
+     * @param attributes - Optional shared attributes that can be accessed by interceptors
+     *                     throughout the request lifecycle. These attributes allow passing
+     *                     custom data between different interceptors.
+     * @param abort - Cancels the request: an `AbortController`, or an `AbortSignal` such as `AbortSignal.timeout(ms)` or the `signal` a data-fetching library passes.
+     * @returns A promise that resolves to the count of matching snapshots
+     *
+     * @example
+     * ```typescript
+     * const count = await snapshotQueryClient.count(filter.matchAll());
+     * console.log('Total snapshots:', count);
+     * ```
+     */
+    count(filter: FilterExpression<FIELDS> | Condition<FIELDS>, attributes?: Record<string, unknown>, abort?: AbortController | AbortSignal): Promise<number>;
+    /**
+     * Retrieves a list of materialized snapshots based on the provided query parameters.
+     *
+     * @param listQuery - The query parameters for listing snapshots
+     * @param attributes - Optional shared attributes that can be accessed by interceptors
+     *                     throughout the request lifecycle. These attributes allow passing
+     *                     custom data between different interceptors.
+     * @param abort - Cancels the request: an `AbortController`, or an `AbortSignal` such as `AbortSignal.timeout(ms)` or the `signal` a data-fetching library passes.
+     * @returns A promise that resolves to an array of partial materialized snapshots
+     *
+     * @example
+     * ```typescript
+     * const listQuery: FilterListQuery = {
+     *   filter: filter.matchAll()
+     * };
+     * const list = await snapshotQueryClient.list(listQuery);
+     * for (const snapshot of list) {
+     *   console.log('Snapshot:', snapshot);
+     * }
+     * ```
+     */
+    list<T extends Partial<MaterializedSnapshot<S>> = MaterializedSnapshot<S>>(listQuery: ListQueryRequest<FIELDS>, attributes?: Record<string, unknown>, abort?: AbortController | AbortSignal): Promise<T[]>;
+    /**
+     * Retrieves a stream of materialized snapshots based on the provided query parameters.
+     *
+     * @param listQuery - The query parameters for listing snapshots
+     * @param attributes - Optional shared attributes that can be accessed by interceptors
+     *                     throughout the request lifecycle. These attributes allow passing
+     *                     custom data between different interceptors.
+     * @param abort - Cancels the request: an `AbortController`, or an `AbortSignal` such as `AbortSignal.timeout(ms)` or the `signal` a data-fetching library passes.
+     * @returns A promise that resolves to a readable stream of partial materialized snapshots
+     *
+     * @example
+     * ```typescript
+     * const listQuery: FilterListQuery = {
+     *   filter: filter.matchAll()
+     * };
+     * const listStream = await snapshotQueryClient.listStream(listQuery);
+     * for await (const snapshot of listStream) {
+     *   console.log('Received snapshot:', snapshot);
+     * }
+     * ```
+     */
+    listStream<T extends Partial<MaterializedSnapshot<S>> = MaterializedSnapshot<S>>(listQuery: ListQueryRequest<FIELDS>, attributes?: Record<string, unknown>, abort?: AbortController | AbortSignal): Promise<ReadableStream<T>>;
+    /**
+     * Retrieves a list of snapshot states based on the provided query parameters.
+     *
+     * @param listQuery - The query parameters for listing snapshot states
+     * @param attributes - Optional shared attributes that can be accessed by interceptors
+     *                     throughout the request lifecycle. These attributes allow passing
+     *                     custom data between different interceptors.
+     * @param abort - Cancels the request: an `AbortController`, or an `AbortSignal` such as `AbortSignal.timeout(ms)` or the `signal` a data-fetching library passes.
+     * @returns A promise that resolves to an array of partial snapshot states
+     *
+     * @example
+     * ```typescript
+     * const listQuery: FilterListQuery = {
+     *   filter: filter.matchAll()
+     * };
+     * const list = await snapshotQueryClient.listState(listQuery);
+     * for (const state of list) {
+     *   console.log('State:', state);
+     * }
+     * ```
+     */
+    listState<T extends Partial<S> = S>(listQuery: ListQueryRequest<FIELDS>, attributes?: Record<string, unknown>, abort?: AbortController | AbortSignal): Promise<T[]>;
+    /**
+     * Retrieves a stream of snapshot states based on the provided query parameters.
+     *
+     * @param listQuery - The query parameters for listing snapshot states
+     * @param attributes - Optional shared attributes that can be accessed by interceptors
+     *                     throughout the request lifecycle. These attributes allow passing
+     *                     custom data between different interceptors.
+     * @param abort - Cancels the request: an `AbortController`, or an `AbortSignal` such as `AbortSignal.timeout(ms)` or the `signal` a data-fetching library passes.
+     * @returns A promise that resolves to a readable stream of partial snapshot states
+     *
+     * @example
+     * ```typescript
+     * const listQuery: FilterListQuery = {
+     *   filter: filter.matchAll()
+     * };
+     * const listStream = await snapshotQueryClient.listStateStream(listQuery);
+     * for await (const state of listStream) {
+     *   console.log('Received state:', state);
+     * }
+     * ```
+     */
+    listStateStream<T extends Partial<S> = S>(listQuery: ListQueryRequest<FIELDS>, attributes?: Record<string, unknown>, abort?: AbortController | AbortSignal): Promise<ReadableStream<T>>;
+    /**
+     * Retrieves a paged list of materialized snapshots based on the provided query parameters.
+     *
+     * @param pagedQuery - The query parameters for paging snapshots
+     * @param attributes - Optional shared attributes that can be accessed by interceptors
+     *                     throughout the request lifecycle. These attributes allow passing
+     *                     custom data between different interceptors.
+     * @param abort - Cancels the request: an `AbortController`, or an `AbortSignal` such as `AbortSignal.timeout(ms)` or the `signal` a data-fetching library passes.
+     * @returns A promise that resolves to a paged list of partial materialized snapshots
+     *
+     * @example
+     * ```typescript
+     * const pagedQuery: FilterPagedQuery = {
+     *   filter: filter.matchAll(),
+     *   pagination: { index: 1, size: 10 }
+     * };
+     * const paged = await snapshotQueryClient.paged(pagedQuery);
+     * console.log('Total:', paged.total);
+     * for (const snapshot of paged.list) {
+     *   console.log('Snapshot:', snapshot);
+     * }
+     * ```
+     */
+    paged<T extends Partial<MaterializedSnapshot<S>> = MaterializedSnapshot<S>>(pagedQuery: PagedQueryRequest<FIELDS>, attributes?: Record<string, unknown>, abort?: AbortController | AbortSignal): Promise<PagedList<T>>;
+    /**
+     * Retrieves a paged list of snapshot states based on the provided query parameters.
+     *
+     * @param pagedQuery - The query parameters for paging snapshot states
+     * @param attributes - Optional shared attributes that can be accessed by interceptors
+     *                     throughout the request lifecycle. These attributes allow passing
+     *                     custom data between different interceptors.
+     * @param abort - Cancels the request: an `AbortController`, or an `AbortSignal` such as `AbortSignal.timeout(ms)` or the `signal` a data-fetching library passes.
+     * @returns A promise that resolves to a paged list of partial snapshot states
+     *
+     * @example
+     * ```typescript
+     * const pagedQuery: FilterPagedQuery = {
+     *   filter: filter.matchAll(),
+     *   pagination: { index: 1, size: 10 }
+     * };
+     * const pagedState = await snapshotQueryClient.pagedState(pagedQuery);
+     * for (const state of pagedState.list) {
+     *   console.log('State:', state);
+     * }
+     * ```
+     */
+    pagedState<T extends Partial<S> = S>(pagedQuery: PagedQueryRequest<FIELDS>, attributes?: Record<string, unknown>, abort?: AbortController | AbortSignal): Promise<PagedList<T>>;
+    /**
+     * Retrieves a single materialized snapshot based on the provided query parameters.
+     *
+     * @param singleQuery - The query parameters for retrieving a single snapshot
+     * @param attributes - Optional shared attributes that can be accessed by interceptors
+     *                     throughout the request lifecycle. These attributes allow passing
+     *                     custom data between different interceptors.
+     * @param abort - Cancels the request: an `AbortController`, or an `AbortSignal` such as `AbortSignal.timeout(ms)` or the `signal` a data-fetching library passes.
+     * @returns A promise that resolves to a partial materialized snapshot
+     *
+     * @example
+     * ```typescript
+     * const singleQuery: FilterSingleQuery = {
+     *   filter: filter.matchAll()
+     * };
+     * const single = await snapshotQueryClient.single(singleQuery);
+     * console.log('Snapshot:', single);
+     * ```
+     */
+    single<T extends Partial<MaterializedSnapshot<S>> = MaterializedSnapshot<S>>(singleQuery: SingleQueryRequest<FIELDS>, attributes?: Record<string, unknown>, abort?: AbortController | AbortSignal): Promise<T>;
+    /**
+     * Retrieves a single snapshot state based on the provided query parameters.
+     *
+     * @param singleQuery - The query parameters for retrieving a single snapshot state
+     * @param attributes - Optional shared attributes that can be accessed by interceptors
+     *                     throughout the request lifecycle. These attributes allow passing
+     *                     custom data between different interceptors.
+     * @param abort - Cancels the request: an `AbortController`, or an `AbortSignal` such as `AbortSignal.timeout(ms)` or the `signal` a data-fetching library passes.
+     * @returns A promise that resolves to a partial snapshot state
+     *
+     * @example
+     * ```typescript
+     * const singleQuery: FilterSingleQuery = {
+     *   filter: filter.matchAll()
+     * };
+     * const singleState = await snapshotQueryClient.singleState(singleQuery);
+     * console.log('State:', singleState);
+     * ```
+     */
+    singleState<T extends Partial<S> = S>(singleQuery: SingleQueryRequest<FIELDS>, attributes?: Record<string, unknown>, abort?: AbortController | AbortSignal): Promise<T>;
+    /**
+     * Retrieves a single materialized snapshot by its ID.
+     *
+     * @param id - The unique identifier of the snapshot to retrieve
+     * @param attributes - Optional shared attributes that can be accessed by interceptors
+     *                     throughout the request lifecycle. These attributes allow passing
+     *                     custom data between different interceptors.
+     * @param abort - Cancels the request: an `AbortController`, or an `AbortSignal` such as `AbortSignal.timeout(ms)` or the `signal` a data-fetching library passes.
+     * @returns A promise that resolves to the materialized snapshot with the specified ID
+     *
+     * @example
+     * ```typescript
+     * const snapshot = await snapshotQueryClient.getById('snapshot-123');
+     * console.log('Snapshot:', snapshot);
+     * ```
+     */
+    getById(id: string, attributes?: Record<string, unknown>, abort?: AbortController | AbortSignal): Promise<MaterializedSnapshot<S>>;
+    /**
+     * Retrieves a single snapshot state by its ID.
+     *
+     * @param id - The unique identifier of the snapshot whose state to retrieve
+     * @param attributes - Optional shared attributes that can be accessed by interceptors
+     *                     throughout the request lifecycle. These attributes allow passing
+     *                     custom data between different interceptors.
+     * @param abort - Cancels the request: an `AbortController`, or an `AbortSignal` such as `AbortSignal.timeout(ms)` or the `signal` a data-fetching library passes.
+     * @returns A promise that resolves to the snapshot state with the specified ID
+     *
+     * @example
+     * ```typescript
+     * const state = await snapshotQueryClient.getStateById('snapshot-123');
+     * console.log('State:', state);
+     * ```
+     */
+    getStateById(id: string, attributes?: Record<string, unknown>, abort?: AbortController | AbortSignal): Promise<S>;
+    /**
+     * Retrieves multiple materialized snapshots by their IDs.
+     *
+     * One request, filtered by `filter.aggregateIds(ids)` with `limit` set to
+     * the number of ids; an empty `ids` sends nothing and resolves to `[]`. The
+     * server refuses more ids than its filter value limit and its maximum list
+     * size (1000 each by default), so split a larger set into batches.
+     *
+     * @param ids - An array of unique identifiers of the snapshots to retrieve
+     * @param attributes - Optional shared attributes that can be accessed by interceptors
+     *                     throughout the request lifecycle. These attributes allow passing
+     *                     custom data between different interceptors.
+     * @param abort - Cancels the request: an `AbortController`, or an `AbortSignal` such as `AbortSignal.timeout(ms)` or the `signal` a data-fetching library passes.
+     * @returns A promise that resolves to an array of materialized snapshots with the specified IDs
+     *
+     * @example
+     * ```typescript
+     * const snapshots = await snapshotQueryClient.getByIds(['snapshot-123', 'snapshot-456']);
+     * for (const snapshot of snapshots) {
+     *   console.log('Snapshot:', snapshot);
+     * }
+     * ```
+     */
+    getByIds(ids: string[], attributes?: Record<string, unknown>, abort?: AbortController | AbortSignal): Promise<MaterializedSnapshot<S>[]>;
+    /**
+     * Retrieves multiple snapshot states by their IDs.
+     *
+     * One request, filtered by `filter.aggregateIds(ids)` with `limit` set to
+     * the number of ids; an empty `ids` sends nothing and resolves to `[]`. The
+     * server refuses more ids than its filter value limit and its maximum list
+     * size (1000 each by default), so split a larger set into batches.
+     *
+     * @param ids - An array of unique identifiers of the snapshots whose states to retrieve
+     * @param attributes - Optional shared attributes that can be accessed by interceptors
+     *                     throughout the request lifecycle. These attributes allow passing
+     *                     custom data between different interceptors.
+     * @param abort - Cancels the request: an `AbortController`, or an `AbortSignal` such as `AbortSignal.timeout(ms)` or the `signal` a data-fetching library passes.
+     * @returns A promise that resolves to an array of snapshot states with the specified IDs
+     *
+     * @example
+     * ```typescript
+     * const states = await snapshotQueryClient.getStateByIds(['snapshot-123', 'snapshot-456']);
+     * for (const state of states) {
+     *   console.log('State:', state);
+     * }
+     * ```
+     */
+    getStateByIds(ids: string[], attributes?: Record<string, unknown>, abort?: AbortController | AbortSignal): Promise<S[]>;
+}