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

package/dist/dsl/queryable.d.cts

@@ -0,0 +1,101 @@
+import { FilterCapable } from './filter/index.cjs';
+import { SortCapable } from './sort.cjs';
+import { Pagination } from './pagination.cjs';
+import { ProjectionCapable } from './projection.cjs';
+/** A query that filters, projects and sorts with Wow's `FilterExpression`. */
+export interface FilterQueryable<FIELDS extends string = string> extends FilterCapable<FIELDS>, ProjectionCapable<FIELDS>, SortCapable<FIELDS> {
+}
+/** The body of a `single` query: the first match of the filter, or nothing. */
+export interface FilterSingleQuery<FIELDS extends string = string> extends FilterQueryable<FIELDS> {
+}
+/** The body of a `list` or `listStream` query. */
+export interface FilterListQuery<FIELDS extends string = string> extends FilterQueryable<FIELDS> {
+    /**
+     * The most rows to return. The client sends no default: absent (or 0)
+     * leaves the choice to the server, and what the server does depends on its
+     * version.
+     *
+     * - Wow 9.1.5 and later apply the server's default list size over HTTP
+     *   (100 unless the server configures another).
+     * - Wow 8.11 to 9.1.3 reject the query with `IllegalArgument: HTTP list
+     *   query limit[0] must be between 1 and …` (HTTP 400 for a list, the error
+     *   event that ends a list stream), so pass `limit` explicitly against
+     *   those servers.
+     *
+     * Wow 8.11 and later also refuse a value above the server's maximum list
+     * size (1000 by default).
+     */
+    limit?: number;
+}
+/** The body of a `paged` query. */
+export interface FilterPagedQuery<FIELDS extends string = string> extends FilterQueryable<FIELDS> {
+    pagination?: Pagination;
+}
+/** What `singleQuery`, `listQuery` and `pagedQuery` take in common. */
+type QueryOptions<FIELDS extends string = string> = Partial<FilterQueryable<FIELDS>>;
+/**
+ * Builds the body of a `single` query.
+ *
+ * @param options.filter - What to match. Defaults to `filter.matchAll()`.
+ * @param options.projection - Which fields to return. Optional.
+ * @param options.sort - Which match counts as the first. Optional.
+ * @throws TypeError when `filter` is `null`.
+ *
+ * @example
+ * ```typescript
+ * singleQuery({ filter: filter.eq('status', 'ACTIVE') });
+ * ```
+ */
+export declare function singleQuery<FIELDS extends string = string>({ filter, projection, sort, }?: QueryOptions<FIELDS>): FilterSingleQuery<FIELDS>;
+/**
+ * Builds the body of a `list` or `listStream` query.
+ *
+ * @param options.filter - What to match. Defaults to `filter.matchAll()`.
+ * @param options.projection - Which fields to return. Optional.
+ * @param options.sort - The order of the rows. Optional.
+ * @param options.limit - The most rows to return. Absent is sent as absent:
+ *   Wow 9.1.5 and later apply the server's default list size, Wow 8.11 to
+ *   9.1.3 reject the query, so pass it for those servers; see
+ *   {@link FilterListQuery.limit}.
+ * @throws TypeError when `filter` is `null`.
+ *
+ * @example
+ * ```typescript
+ * listQuery({ filter: filter.eq('status', 'ACTIVE'), limit: 20 });
+ * ```
+ */
+export declare function listQuery<FIELDS extends string = string>({ filter, projection, sort, limit, }?: QueryOptions<FIELDS> & {
+    limit?: number;
+}): FilterListQuery<FIELDS>;
+/**
+ * Builds the body of a `paged` query.
+ *
+ * @param options.filter - What to match. Defaults to `filter.matchAll()`.
+ * @param options.projection - Which fields to return. Optional.
+ * @param options.sort - The order of the rows. Optional.
+ * @param options.pagination - Which page. Defaults to a copy of
+ *   {@link DEFAULT_PAGINATION}: the first page of ten.
+ * @throws TypeError when `filter` is `null`.
+ *
+ * @example
+ * ```typescript
+ * pagedQuery({ filter: filter.matchAll(), pagination: { index: 2, size: 20 } });
+ * ```
+ */
+export declare function pagedQuery<FIELDS extends string = string>({ filter, projection, sort, pagination, }?: QueryOptions<FIELDS> & {
+    pagination?: Pagination;
+}): FilterPagedQuery<FIELDS>;
+/** One page of a `paged` query: its rows, and how many match in total. */
+export interface PagedList<T> {
+    total: number;
+    list: T[];
+}
+/**
+ * Builds a `PagedList`, for a placeholder page or a test double.
+ *
+ * @param options.total - How many rows match in total. Defaults to the length
+ *   of `list`.
+ * @param options.list - The rows of this page. Defaults to a new empty array.
+ */
+export declare function pagedList<T>({ total, list, }?: Partial<PagedList<T>>): PagedList<T>;
+export {};

package/dist/dsl/queryable.d.ts

@@ -0,0 +1,101 @@
+import { FilterCapable } from './filter/index.js';
+import { SortCapable } from './sort.js';
+import { Pagination } from './pagination.js';
+import { ProjectionCapable } from './projection.js';
+/** A query that filters, projects and sorts with Wow's `FilterExpression`. */
+export interface FilterQueryable<FIELDS extends string = string> extends FilterCapable<FIELDS>, ProjectionCapable<FIELDS>, SortCapable<FIELDS> {
+}
+/** The body of a `single` query: the first match of the filter, or nothing. */
+export interface FilterSingleQuery<FIELDS extends string = string> extends FilterQueryable<FIELDS> {
+}
+/** The body of a `list` or `listStream` query. */
+export interface FilterListQuery<FIELDS extends string = string> extends FilterQueryable<FIELDS> {
+    /**
+     * The most rows to return. The client sends no default: absent (or 0)
+     * leaves the choice to the server, and what the server does depends on its
+     * version.
+     *
+     * - Wow 9.1.5 and later apply the server's default list size over HTTP
+     *   (100 unless the server configures another).
+     * - Wow 8.11 to 9.1.3 reject the query with `IllegalArgument: HTTP list
+     *   query limit[0] must be between 1 and …` (HTTP 400 for a list, the error
+     *   event that ends a list stream), so pass `limit` explicitly against
+     *   those servers.
+     *
+     * Wow 8.11 and later also refuse a value above the server's maximum list
+     * size (1000 by default).
+     */
+    limit?: number;
+}
+/** The body of a `paged` query. */
+export interface FilterPagedQuery<FIELDS extends string = string> extends FilterQueryable<FIELDS> {
+    pagination?: Pagination;
+}
+/** What `singleQuery`, `listQuery` and `pagedQuery` take in common. */
+type QueryOptions<FIELDS extends string = string> = Partial<FilterQueryable<FIELDS>>;
+/**
+ * Builds the body of a `single` query.
+ *
+ * @param options.filter - What to match. Defaults to `filter.matchAll()`.
+ * @param options.projection - Which fields to return. Optional.
+ * @param options.sort - Which match counts as the first. Optional.
+ * @throws TypeError when `filter` is `null`.
+ *
+ * @example
+ * ```typescript
+ * singleQuery({ filter: filter.eq('status', 'ACTIVE') });
+ * ```
+ */
+export declare function singleQuery<FIELDS extends string = string>({ filter, projection, sort, }?: QueryOptions<FIELDS>): FilterSingleQuery<FIELDS>;
+/**
+ * Builds the body of a `list` or `listStream` query.
+ *
+ * @param options.filter - What to match. Defaults to `filter.matchAll()`.
+ * @param options.projection - Which fields to return. Optional.
+ * @param options.sort - The order of the rows. Optional.
+ * @param options.limit - The most rows to return. Absent is sent as absent:
+ *   Wow 9.1.5 and later apply the server's default list size, Wow 8.11 to
+ *   9.1.3 reject the query, so pass it for those servers; see
+ *   {@link FilterListQuery.limit}.
+ * @throws TypeError when `filter` is `null`.
+ *
+ * @example
+ * ```typescript
+ * listQuery({ filter: filter.eq('status', 'ACTIVE'), limit: 20 });
+ * ```
+ */
+export declare function listQuery<FIELDS extends string = string>({ filter, projection, sort, limit, }?: QueryOptions<FIELDS> & {
+    limit?: number;
+}): FilterListQuery<FIELDS>;
+/**
+ * Builds the body of a `paged` query.
+ *
+ * @param options.filter - What to match. Defaults to `filter.matchAll()`.
+ * @param options.projection - Which fields to return. Optional.
+ * @param options.sort - The order of the rows. Optional.
+ * @param options.pagination - Which page. Defaults to a copy of
+ *   {@link DEFAULT_PAGINATION}: the first page of ten.
+ * @throws TypeError when `filter` is `null`.
+ *
+ * @example
+ * ```typescript
+ * pagedQuery({ filter: filter.matchAll(), pagination: { index: 2, size: 20 } });
+ * ```
+ */
+export declare function pagedQuery<FIELDS extends string = string>({ filter, projection, sort, pagination, }?: QueryOptions<FIELDS> & {
+    pagination?: Pagination;
+}): FilterPagedQuery<FIELDS>;
+/** One page of a `paged` query: its rows, and how many match in total. */
+export interface PagedList<T> {
+    total: number;
+    list: T[];
+}
+/**
+ * Builds a `PagedList`, for a placeholder page or a test double.
+ *
+ * @param options.total - How many rows match in total. Defaults to the length
+ *   of `list`.
+ * @param options.list - The rows of this page. Defaults to a new empty array.
+ */
+export declare function pagedList<T>({ total, list, }?: Partial<PagedList<T>>): PagedList<T>;
+export {};

package/dist/dsl/queryable.es.js

@@ -0,0 +1,40 @@
+import { filter as e } from "./filter/builders.es.js";
+import { DEFAULT_PAGINATION as t } from "./pagination.es.js";
+//#region src/dsl/queryable.ts
+function n(t) {
+	if (t === null) throw TypeError("filter cannot be null.");
+	return t ?? e.matchAll();
+}
+function r({ filter: e, projection: t, sort: r } = {}) {
+	return {
+		filter: n(e),
+		projection: t,
+		sort: r
+	};
+}
+function i({ filter: e, projection: t, sort: r, limit: i } = {}) {
+	return {
+		filter: n(e),
+		projection: t,
+		sort: r,
+		limit: i
+	};
+}
+function a({ filter: e, projection: r, sort: i, pagination: a = { ...t } } = {}) {
+	return {
+		filter: n(e),
+		projection: r,
+		sort: i,
+		pagination: a
+	};
+}
+function o({ total: e, list: t = [] } = {}) {
+	return {
+		total: e ?? t.length,
+		list: t
+	};
+}
+//#endregion
+export { i as listQuery, o as pagedList, a as pagedQuery, r as singleQuery };
+
+//# sourceMappingURL=queryable.es.js.map

package/dist/dsl/queryable.es.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"queryable.es.js","names":["filter","filters","queryFilter","filter$1","filter","singleQuery","listQuery","pagedQuery","DEFAULT_PAGINATION","pagedList","total","list"],"sources":["../../src/dsl/queryable.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 {\n  filter as filters,\n  type FilterCapable,\n  type FilterExpression,\n} from './filter/index.js';\nimport { type SortCapable } from './sort.js';\nimport { DEFAULT_PAGINATION, type Pagination } from './pagination.js';\nimport { type ProjectionCapable } from './projection.js';\n\n/** A query that filters, projects and sorts with Wow's `FilterExpression`. */\nexport interface FilterQueryable<FIELDS extends string = string>\n  extends\n    FilterCapable<FIELDS>,\n    ProjectionCapable<FIELDS>,\n    SortCapable<FIELDS> {}\n\n/** The body of a `single` query: the first match of the filter, or nothing. */\n// eslint-disable-next-line @typescript-eslint/no-empty-object-type\nexport interface FilterSingleQuery<\n  FIELDS extends string = string,\n> extends FilterQueryable<FIELDS> {}\n\n/** The body of a `list` or `listStream` query. */\nexport interface FilterListQuery<\n  FIELDS extends string = string,\n> extends FilterQueryable<FIELDS> {\n  /**\n   * The most rows to return. The client sends no default: absent (or 0)\n   * leaves the choice to the server, and what the server does depends on its\n   * version.\n   *\n   * - Wow 9.1.5 and later apply the server's default list size over HTTP\n   *   (100 unless the server configures another).\n   * - Wow 8.11 to 9.1.3 reject the query with `IllegalArgument: HTTP list\n   *   query limit[0] must be between 1 and …` (HTTP 400 for a list, the error\n   *   event that ends a list stream), so pass `limit` explicitly against\n   *   those servers.\n   *\n   * Wow 8.11 and later also refuse a value above the server's maximum list\n   * size (1000 by default).\n   */\n  limit?: number;\n}\n\n/** The body of a `paged` query. */\nexport interface FilterPagedQuery<\n  FIELDS extends string = string,\n> extends FilterQueryable<FIELDS> {\n  pagination?: Pagination;\n}\n\n/** What `singleQuery`, `listQuery` and `pagedQuery` take in common. */\ntype QueryOptions<FIELDS extends string = string> = Partial<\n  FilterQueryable<FIELDS>\n>;\n\nfunction queryFilter<FIELDS extends string>(\n  filter: FilterExpression<FIELDS> | undefined,\n): FilterExpression<FIELDS> {\n  if (filter === null) {\n    throw new TypeError('filter cannot be null.');\n  }\n  return filter ?? filters.matchAll();\n}\n\n/**\n * Builds the body of a `single` query.\n *\n * @param options.filter - What to match. Defaults to `filter.matchAll()`.\n * @param options.projection - Which fields to return. Optional.\n * @param options.sort - Which match counts as the first. Optional.\n * @throws TypeError when `filter` is `null`.\n *\n * @example\n * ```typescript\n * singleQuery({ filter: filter.eq('status', 'ACTIVE') });\n * ```\n */\nexport function singleQuery<FIELDS extends string = string>({\n  filter,\n  projection,\n  sort,\n}: QueryOptions<FIELDS> = {}): FilterSingleQuery<FIELDS> {\n  return { filter: queryFilter(filter), projection, sort };\n}\n\n/**\n * Builds the body of a `list` or `listStream` query.\n *\n * @param options.filter - What to match. Defaults to `filter.matchAll()`.\n * @param options.projection - Which fields to return. Optional.\n * @param options.sort - The order of the rows. Optional.\n * @param options.limit - The most rows to return. Absent is sent as absent:\n *   Wow 9.1.5 and later apply the server's default list size, Wow 8.11 to\n *   9.1.3 reject the query, so pass it for those servers; see\n *   {@link FilterListQuery.limit}.\n * @throws TypeError when `filter` is `null`.\n *\n * @example\n * ```typescript\n * listQuery({ filter: filter.eq('status', 'ACTIVE'), limit: 20 });\n * ```\n */\nexport function listQuery<FIELDS extends string = string>({\n  filter,\n  projection,\n  sort,\n  limit,\n}: QueryOptions<FIELDS> & { limit?: number } = {}): FilterListQuery<FIELDS> {\n  return { filter: queryFilter(filter), projection, sort, limit };\n}\n\n/**\n * Builds the body of a `paged` query.\n *\n * @param options.filter - What to match. Defaults to `filter.matchAll()`.\n * @param options.projection - Which fields to return. Optional.\n * @param options.sort - The order of the rows. Optional.\n * @param options.pagination - Which page. Defaults to a copy of\n *   {@link DEFAULT_PAGINATION}: the first page of ten.\n * @throws TypeError when `filter` is `null`.\n *\n * @example\n * ```typescript\n * pagedQuery({ filter: filter.matchAll(), pagination: { index: 2, size: 20 } });\n * ```\n */\nexport function pagedQuery<FIELDS extends string = string>({\n  filter,\n  projection,\n  sort,\n  pagination = { ...DEFAULT_PAGINATION },\n}: QueryOptions<FIELDS> & {\n  pagination?: Pagination;\n} = {}): FilterPagedQuery<FIELDS> {\n  return { filter: queryFilter(filter), projection, sort, pagination };\n}\n\n/** One page of a `paged` query: its rows, and how many match in total. */\nexport interface PagedList<T> {\n  total: number;\n  list: T[];\n}\n\n/**\n * Builds a `PagedList`, for a placeholder page or a test double.\n *\n * @param options.total - How many rows match in total. Defaults to the length\n *   of `list`.\n * @param options.list - The rows of this page. Defaults to a new empty array.\n */\nexport function pagedList<T>({\n  total,\n  list = [],\n}: Partial<PagedList<T>> = {}): PagedList<T> {\n  return { total: total ?? list.length, list };\n}\n"],"mappings":";;;AAqEA,SAASE,EACP,GAC0B;CAC1B,IAAIF,MAAW,MACb,MAAU,UAAU,wBAAwB;CAE9C,OAAOA,KAAUC,EAAQ,SAAS;AACpC;AAeA,SAAgBI,EAA4C,EAC1D,WACA,eACA,YACwB,CAAC,GAA8B;CACvD,OAAO;EAAE,QAAQH,EAAYE,CAAM;EAAG;EAAY;CAAK;AACzD;AAmBA,SAAgBE,EAA0C,EACxD,WACA,eACA,SACA,aAC6C,CAAC,GAA4B;CAC1E,OAAO;EAAE,QAAQJ,EAAYE,CAAM;EAAG;EAAY;EAAM;CAAM;AAChE;AAiBA,SAAgBG,EAA2C,EACzD,WACA,eACA,SACA,gBAAa,EAAE,GAAGC,EAAmB,MAGnC,CAAC,GAA6B;CAChC,OAAO;EAAE,QAAQN,EAAYE,CAAM;EAAG;EAAY;EAAM;CAAW;AACrE;AAeA,SAAgBK,EAAa,EAC3B,UACA,UAAO,CAAC,MACiB,CAAC,GAAiB;CAC3C,OAAO;EAAE,OAAOC,KAASC,EAAK;EAAQ;CAAK;AAC7C"}

package/dist/dsl/sort.cjs

@@ -0,0 +1,2 @@
+const e=require("./field.cjs");var t=function(e){return e.ASC=`ASC`,e.DESC=`DESC`,e}({});function n(t){return{field:e.queryField(t),direction:`ASC`}}function r(t){return{field:e.queryField(t),direction:`DESC`}}exports.SortDirection=t,exports.asc=n,exports.desc=r;
+//# sourceMappingURL=sort.cjs.map

package/dist/dsl/sort.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"sort.cjs","names":["queryField","require_field","SortDirection","\"ASC\"","\"DESC\"","asc","field","desc"],"sources":["../../src/dsl/sort.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 { queryField } from './field.js';\n\n/**\n * Enumeration of sort directions.\n * ASC for ascending order, DESC for descending order.\n */\nexport enum SortDirection {\n  ASC = 'ASC',\n  DESC = 'DESC',\n}\n\n/**\n * Interface for sort criteria.\n */\nexport interface FieldSort<FIELDS extends string = string> {\n  field: FIELDS;\n  direction: SortDirection;\n}\n\n/**\n * Creates a sort object with ascending direction for the specified field.\n * @param field - The field to sort by\n * @returns A Sort object with the specified field and ascending direction\n */\nexport function asc<FIELDS extends string = string>(\n  field: FIELDS,\n): FieldSort<FIELDS> {\n  return {\n    field: queryField(field),\n    direction: SortDirection.ASC,\n  };\n}\n\n/**\n * Creates a sort object with descending direction for the specified field.\n * @param field - The field to sort by\n * @returns A Sort object with the specified field and descending direction\n */\nexport function desc<FIELDS extends string = string>(\n  field: FIELDS,\n): FieldSort<FIELDS> {\n  return {\n    field: queryField(field),\n    direction: SortDirection.DESC,\n  };\n}\n\n/**\n * Interface for objects that support sorting.\n */\nexport interface SortCapable<FIELDS extends string = string> {\n  sort?: FieldSort<FIELDS>[];\n}\n"],"mappings":"+BAmBA,IAAYE,EAAL,SAAA,EAAA,OACL,GAAAC,IAAA,MACA,EAAAC,KAAA,QACF,EAAA,CAAA,CAAA,EAeA,SAAgBC,EACd,EACmB,CACnB,MAAO,CACL,MAAOL,EAAAA,WAAWM,CAAK,EACvB,UAAA,KACF,CACF,CAOA,SAAgBC,EACd,EACmB,CACnB,MAAO,CACL,MAAOP,EAAAA,WAAWM,CAAK,EACvB,UAAA,MACF,CACF"}

package/dist/dsl/sort.d.cts

@@ -0,0 +1,33 @@
+/**
+ * Enumeration of sort directions.
+ * ASC for ascending order, DESC for descending order.
+ */
+export declare enum SortDirection {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/**
+ * Interface for sort criteria.
+ */
+export interface FieldSort<FIELDS extends string = string> {
+    field: FIELDS;
+    direction: SortDirection;
+}
+/**
+ * Creates a sort object with ascending direction for the specified field.
+ * @param field - The field to sort by
+ * @returns A Sort object with the specified field and ascending direction
+ */
+export declare function asc<FIELDS extends string = string>(field: FIELDS): FieldSort<FIELDS>;
+/**
+ * Creates a sort object with descending direction for the specified field.
+ * @param field - The field to sort by
+ * @returns A Sort object with the specified field and descending direction
+ */
+export declare function desc<FIELDS extends string = string>(field: FIELDS): FieldSort<FIELDS>;
+/**
+ * Interface for objects that support sorting.
+ */
+export interface SortCapable<FIELDS extends string = string> {
+    sort?: FieldSort<FIELDS>[];
+}

package/dist/dsl/sort.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Enumeration of sort directions.
+ * ASC for ascending order, DESC for descending order.
+ */
+export declare enum SortDirection {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/**
+ * Interface for sort criteria.
+ */
+export interface FieldSort<FIELDS extends string = string> {
+    field: FIELDS;
+    direction: SortDirection;
+}
+/**
+ * Creates a sort object with ascending direction for the specified field.
+ * @param field - The field to sort by
+ * @returns A Sort object with the specified field and ascending direction
+ */
+export declare function asc<FIELDS extends string = string>(field: FIELDS): FieldSort<FIELDS>;
+/**
+ * Creates a sort object with descending direction for the specified field.
+ * @param field - The field to sort by
+ * @returns A Sort object with the specified field and descending direction
+ */
+export declare function desc<FIELDS extends string = string>(field: FIELDS): FieldSort<FIELDS>;
+/**
+ * Interface for objects that support sorting.
+ */
+export interface SortCapable<FIELDS extends string = string> {
+    sort?: FieldSort<FIELDS>[];
+}

package/dist/dsl/sort.es.js

@@ -0,0 +1,21 @@
+import { queryField as e } from "./field.es.js";
+//#region src/dsl/sort.ts
+var t = /* @__PURE__ */ function(e) {
+	return e.ASC = "ASC", e.DESC = "DESC", e;
+}({});
+function n(t) {
+	return {
+		field: e(t),
+		direction: "ASC"
+	};
+}
+function r(t) {
+	return {
+		field: e(t),
+		direction: "DESC"
+	};
+}
+//#endregion
+export { t as SortDirection, n as asc, r as desc };
+
+//# sourceMappingURL=sort.es.js.map

package/dist/dsl/sort.es.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sort.es.js","names":["SortDirection","\"ASC\"","\"DESC\"","asc","queryField","field","desc"],"sources":["../../src/dsl/sort.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 { queryField } from './field.js';\n\n/**\n * Enumeration of sort directions.\n * ASC for ascending order, DESC for descending order.\n */\nexport enum SortDirection {\n  ASC = 'ASC',\n  DESC = 'DESC',\n}\n\n/**\n * Interface for sort criteria.\n */\nexport interface FieldSort<FIELDS extends string = string> {\n  field: FIELDS;\n  direction: SortDirection;\n}\n\n/**\n * Creates a sort object with ascending direction for the specified field.\n * @param field - The field to sort by\n * @returns A Sort object with the specified field and ascending direction\n */\nexport function asc<FIELDS extends string = string>(\n  field: FIELDS,\n): FieldSort<FIELDS> {\n  return {\n    field: queryField(field),\n    direction: SortDirection.ASC,\n  };\n}\n\n/**\n * Creates a sort object with descending direction for the specified field.\n * @param field - The field to sort by\n * @returns A Sort object with the specified field and descending direction\n */\nexport function desc<FIELDS extends string = string>(\n  field: FIELDS,\n): FieldSort<FIELDS> {\n  return {\n    field: queryField(field),\n    direction: SortDirection.DESC,\n  };\n}\n\n/**\n * Interface for objects that support sorting.\n */\nexport interface SortCapable<FIELDS extends string = string> {\n  sort?: FieldSort<FIELDS>[];\n}\n"],"mappings":";;AAmBA,IAAYA,IAAL,yBAAA,GAAA;QACL,EAAAC,MAAA,OACA,EAAAC,OAAA;AACF,EAAA,CAAA,CAAA;AAeA,SAAgBC,EACd,GACmB;CACnB,OAAO;EACL,OAAOC,EAAWC,CAAK;EACvB,WAAA;CACF;AACF;AAOA,SAAgBC,EACd,GACmB;CACnB,OAAO;EACL,OAAOF,EAAWC,CAAK;EACvB,WAAA;CACF;AACF"}

package/dist/dsl.cjs

@@ -0,0 +1 @@
+Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require("./dsl/filter/operator.cjs"),t=require("./dsl/aggregation/types.cjs"),n=require("./dsl/deletionState.cjs"),r=require("./dsl/filter/builders.cjs"),i=require("./dsl/sort.cjs"),a=require("./dsl/aggregation/builders.cjs"),o=require("./dsl/projection.cjs"),s=require("./dsl/pagination.cjs"),c=require("./dsl/cursorQuery.cjs"),l=require("./dsl/queryable.cjs"),u=require("./dsl/descriptor.cjs"),d=require("./client/query/event/domainEventStream.cjs"),f=require("./client/query/snapshot/snapshot.cjs");exports.AGGREGATION_LIMITS=t.AGGREGATION_LIMITS,exports.AggregationDatePart=t.AggregationDatePart,exports.AggregationDateUnit=t.AggregationDateUnit,exports.AggregationExpressionOperator=t.AggregationExpressionOperator,exports.AggregationExpressionType=t.AggregationExpressionType,exports.AggregationFunction=t.AggregationFunction,exports.AggregationGroupType=t.AggregationGroupType,exports.AggregationMetricType=t.AggregationMetricType,exports.ComparisonOperator=t.ComparisonOperator,exports.DEFAULT_CURSOR_SIZE=c.DEFAULT_CURSOR_SIZE,exports.DEFAULT_PAGINATION=s.DEFAULT_PAGINATION,exports.DateDiffUnit=t.DateDiffUnit,exports.DeletionState=n.DeletionState,exports.DerivedExpressionType=t.DerivedExpressionType,exports.DomainEventStreamMetadataFields=d.DomainEventStreamMetadataFields,exports.FilterOperator=e.FilterOperator,exports.HavingExpressionType=t.HavingExpressionType,exports.MAX_CURSOR_SIZE=c.MAX_CURSOR_SIZE,exports.MAX_CURSOR_SORT_FIELDS=c.MAX_CURSOR_SORT_FIELDS,exports.PagingMode=u.PagingMode,exports.QueryConstraintTypes=u.QueryConstraintTypes,exports.QueryFieldRoles=u.QueryFieldRoles,exports.QueryModels=u.QueryModels,exports.QueryValueKind=u.QueryValueKind,exports.QueryValueTypes=u.QueryValueTypes,exports.SearchMode=e.SearchMode,exports.SensitivityLevel=u.SensitivityLevel,exports.SnapshotMetadataFields=f.SnapshotMetadataFields,exports.SortDirection=i.SortDirection,exports.StringComparison=e.StringComparison,exports.TimeUnit=e.TimeUnit,exports.aggregation=a.aggregation,exports.asc=i.asc,exports.cursorQuery=c.cursorQuery,exports.desc=i.desc,exports.filter=r.filter,exports.listQuery=l.listQuery,exports.pagedList=l.pagedList,exports.pagedQuery=l.pagedQuery,exports.pagination=s.pagination,exports.projection=o.projection,exports.singleQuery=l.singleQuery;

package/dist/dsl.d.cts

@@ -0,0 +1,23 @@
+/**
+ * `@ahoo-wang/wow-client/dsl`: the query DSL alone — `filter.*`,
+ * `aggregation.*`, sort, projection, pagination, cursor queries, the query
+ * factories and their types, the metadata field names of snapshots and event
+ * streams, and the types of the query capability descriptor.
+ *
+ * It loads no HTTP code: no Fetcher, no decorators, no `reflect-metadata`,
+ * and none of the global stream patches `@ahoo-wang/fetcher-eventstream`
+ * installs. An application that only builds queries — and sends them through
+ * a client of its own — imports this. The root entry exports all of it too.
+ */
+export * from './dsl/filter/index.cjs';
+export * from './dsl/aggregation/index.cjs';
+export * from './dsl/sort.cjs';
+export * from './dsl/projection.cjs';
+export * from './dsl/pagination.cjs';
+export * from './dsl/cursorQuery.cjs';
+export * from './dsl/queryable.cjs';
+export * from './dsl/deletionState.cjs';
+export * from './dsl/documents.cjs';
+export * from './dsl/descriptor.cjs';
+export { SnapshotMetadataFields } from './client/query/snapshot/snapshot.cjs';
+export { DomainEventStreamMetadataFields } from './client/query/event/domainEventStream.cjs';

package/dist/dsl.d.ts

@@ -0,0 +1,23 @@
+/**
+ * `@ahoo-wang/wow-client/dsl`: the query DSL alone — `filter.*`,
+ * `aggregation.*`, sort, projection, pagination, cursor queries, the query
+ * factories and their types, the metadata field names of snapshots and event
+ * streams, and the types of the query capability descriptor.
+ *
+ * It loads no HTTP code: no Fetcher, no decorators, no `reflect-metadata`,
+ * and none of the global stream patches `@ahoo-wang/fetcher-eventstream`
+ * installs. An application that only builds queries — and sends them through
+ * a client of its own — imports this. The root entry exports all of it too.
+ */
+export * from './dsl/filter/index.js';
+export * from './dsl/aggregation/index.js';
+export * from './dsl/sort.js';
+export * from './dsl/projection.js';
+export * from './dsl/pagination.js';
+export * from './dsl/cursorQuery.js';
+export * from './dsl/queryable.js';
+export * from './dsl/deletionState.js';
+export * from './dsl/documents.js';
+export * from './dsl/descriptor.js';
+export { SnapshotMetadataFields } from './client/query/snapshot/snapshot.js';
+export { DomainEventStreamMetadataFields } from './client/query/event/domainEventStream.js';

package/dist/dsl.es.js

@@ -0,0 +1,14 @@
+import { FilterOperator as e, SearchMode as t, StringComparison as n, TimeUnit as r } from "./dsl/filter/operator.es.js";
+import { AGGREGATION_LIMITS as i, AggregationDatePart as a, AggregationDateUnit as o, AggregationExpressionOperator as s, AggregationExpressionType as c, AggregationFunction as l, AggregationGroupType as u, AggregationMetricType as d, ComparisonOperator as f, DateDiffUnit as p, DerivedExpressionType as m, HavingExpressionType as h } from "./dsl/aggregation/types.es.js";
+import { DeletionState as g } from "./dsl/deletionState.es.js";
+import { filter as _ } from "./dsl/filter/builders.es.js";
+import { SortDirection as v, asc as y, desc as b } from "./dsl/sort.es.js";
+import { aggregation as x } from "./dsl/aggregation/builders.es.js";
+import { projection as S } from "./dsl/projection.es.js";
+import { DEFAULT_PAGINATION as C, pagination as w } from "./dsl/pagination.es.js";
+import { DEFAULT_CURSOR_SIZE as T, MAX_CURSOR_SIZE as E, MAX_CURSOR_SORT_FIELDS as D, cursorQuery as O } from "./dsl/cursorQuery.es.js";
+import { listQuery as k, pagedList as A, pagedQuery as j, singleQuery as M } from "./dsl/queryable.es.js";
+import { PagingMode as N, QueryConstraintTypes as P, QueryFieldRoles as F, QueryModels as I, QueryValueKind as L, QueryValueTypes as R, SensitivityLevel as z } from "./dsl/descriptor.es.js";
+import { DomainEventStreamMetadataFields as B } from "./client/query/event/domainEventStream.es.js";
+import { SnapshotMetadataFields as V } from "./client/query/snapshot/snapshot.es.js";
+export { i as AGGREGATION_LIMITS, a as AggregationDatePart, o as AggregationDateUnit, s as AggregationExpressionOperator, c as AggregationExpressionType, l as AggregationFunction, u as AggregationGroupType, d as AggregationMetricType, f as ComparisonOperator, T as DEFAULT_CURSOR_SIZE, C as DEFAULT_PAGINATION, p as DateDiffUnit, g as DeletionState, m as DerivedExpressionType, B as DomainEventStreamMetadataFields, e as FilterOperator, h as HavingExpressionType, E as MAX_CURSOR_SIZE, D as MAX_CURSOR_SORT_FIELDS, N as PagingMode, P as QueryConstraintTypes, F as QueryFieldRoles, I as QueryModels, L as QueryValueKind, R as QueryValueTypes, t as SearchMode, z as SensitivityLevel, V as SnapshotMetadataFields, v as SortDirection, n as StringComparison, r as TimeUnit, x as aggregation, y as asc, O as cursorQuery, b as desc, _ as filter, k as listQuery, A as pagedList, j as pagedQuery, w as pagination, S as projection, M as singleQuery };

package/dist/error/errorInfo.cjs

@@ -0,0 +1,2 @@
+var e=function(e){return e.RECOVERABLE=`RECOVERABLE`,e.UNKNOWN=`UNKNOWN`,e.UNRECOVERABLE=`UNRECOVERABLE`,e}({}),t=Object.freeze({SUCCEEDED:`Ok`,NOT_FOUND:`NotFound`,BAD_REQUEST:`BadRequest`,ILLEGAL_ARGUMENT:`IllegalArgument`,ILLEGAL_STATE:`IllegalState`,REQUEST_TIMEOUT:`RequestTimeout`,TOO_MANY_REQUESTS:`TooManyRequests`,DUPLICATE_REQUEST_ID:`DuplicateRequestId`,COMMAND_VALIDATION:`CommandValidation`,REWRITE_NO_COMMAND:`RewriteNoCommand`,EVENT_VERSION_CONFLICT:`EventVersionConflict`,DUPLICATE_AGGREGATE_ID:`DuplicateAggregateId`,COMMAND_EXPECT_VERSION_CONFLICT:`CommandExpectVersionConflict`,SOURCING_VERSION_CONFLICT:`SourcingVersionConflict`,ILLEGAL_ACCESS_DELETED_AGGREGATE:`IllegalAccessDeletedAggregate`,ILLEGAL_ACCESS_OWNER_AGGREGATE:`IllegalAccessOwnerAggregate`,ILLEGAL_ACCESS_SPACE_AGGREGATE:`IllegalAccessSpaceAggregate`,ILLEGAL_ACCESS_QUERY_SCOPE:`IllegalAccessQueryScope`,INTERNAL_SERVER_ERROR:`InternalServerError`,QUERY_SCHEMA_VALIDATION:`QuerySchemaValidation`,QUERY_SCHEMA_CONFLICT:`QuerySchemaConflict`,QUERY_SCHEMA_UNAVAILABLE:`QuerySchemaUnavailable`,BATCH_TASK_ERROR:`BatchTaskError`});exports.ErrorCodes=t,exports.RecoverableType=e;
+//# sourceMappingURL=errorInfo.cjs.map

package/dist/error/errorInfo.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"errorInfo.cjs","names":["RecoverableType","\"RECOVERABLE\"","\"UNKNOWN\"","\"UNRECOVERABLE\"","ErrorCodes"],"sources":["../../src/error/errorInfo.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 { QueryErrorCode } from './queryErrorCodes.js';\n\n/**\n * Enumerates the types of recoverability for errors or operations, allowing for classification and handling based on whether an error is transient and can be resolved by retrying.\n *\n * The [RecoverableType] enum provides a way to categorize errors into three distinct categories: [RECOVERABLE], [UNRECOVERABLE], and [UNKNOWN].\n * This categorization is essential for implementing robust error handling and retry mechanisms in applications,\n * ensuring that temporary issues are retried while permanent or unknown issues are handled appropriately.\n *\n */\nexport enum RecoverableType {\n  /**\n   * Represents an error type that indicates the operation or error can be retried.\n   *\n   * This enum value is used to classify errors in a way that allows for the implementation of retry logic. When an error\n   * is marked as [RECOVERABLE], it signifies that the error condition is temporary and might be resolved upon retrying the\n   * operation. This is particularly useful in scenarios where network issues, transient server errors, or other temporary\n   * conditions may cause an operation to fail, but with a high likelihood of success on subsequent attempts.\n   */\n  RECOVERABLE = 'RECOVERABLE',\n  /**\n   * Represents an unknown type of recoverability for an error or operation.\n   * This is used when the recoverability of an error cannot be determined or is not specified.\n   */\n  UNKNOWN = 'UNKNOWN',\n\n  /**\n   * Represents an error type that indicates the operation or error cannot be retried.\n   *\n   * This enum value is used to classify errors in a way that signifies the error condition is permanent and retrying the operation will not resolve the issue. It is particularly\n   *  useful for handling errors where the underlying problem is fundamental and cannot be resolved by simply retrying, such as invalid input, resource exhaustion, or other non-transient\n   *  issues.\n   */\n  UNRECOVERABLE = 'UNRECOVERABLE',\n}\n\n/**\n * Represents an error that occurs during the binding process, typically when data is being mapped to or from an object.\n * This class extends the [Named] interface, inheriting the `name` property which can be used to identify the source or context of the error.\n *\n * @param name The name or identifier for the context in which the error occurred.\n * @param msg A message describing the error.\n * @param code A stable, machine-readable code of the failed rule, when the server states one.\n */\nexport interface BindingError {\n  name: string;\n  msg: string;\n  /**\n   * A stable, machine-readable code of the rule that failed, when the server\n   * states one: a rejected query carries one of {@link QueryErrorCodes}.\n   * Absent otherwise, as for a command's validation errors.\n   */\n  code?: QueryErrorCode;\n}\n\n/**\n * Represents the information about an error, including whether the operation succeeded, the error code, and any associated messages or binding errors.\n *\n * This interface is designed to provide a standardized way of handling and representing errors across different parts of an application. It includes methods to check if the operation was successful, retrieve the error code\n * , and access any additional error details such as messages or binding errors.\n */\nexport interface ErrorInfo {\n  /**\n   * Represents the error code associated with an error. This value is used to identify the type of error that has occurred,\n   * which can be useful for debugging, logging, and handling errors in a standardized way.\n   */\n  errorCode: ErrorCode;\n  /**\n   * Represents the message associated with an error. This message provides a human-readable description of the error, which can be used for logging, debugging, or displaying to the user\n   * .\n   */\n  errorMsg: string;\n  /**\n   * Provides a list of [BindingError] instances that occurred during the binding process.\n   * Each [BindingError] contains information about the error, including its name and a message describing the issue.\n   * This property returns an empty list if no binding errors are present.\n   */\n  bindingErrors?: BindingError[];\n}\n\n/**\n * The error codes Wow itself answers with, as `ErrorInfo.errorCode`, as the\n * `Wow-Error-Code` response header, and as the event name of an error in a\n * server-sent event stream.\n *\n * Mirrors `ErrorCodes` in `wow-core/src/main/kotlin/me/ahoo/wow/exception/ErrorCodes.kt`\n * and the query schema and batch codes the server registers beside it.\n * Applications add their own codes; {@link ErrorCode} admits those too.\n */\nexport const ErrorCodes = Object.freeze({\n  /** The request succeeded. */\n  SUCCEEDED: 'Ok',\n  /** The requested resource does not exist (HTTP 404). */\n  NOT_FOUND: 'NotFound',\n  /** The request is malformed (HTTP 400). */\n  BAD_REQUEST: 'BadRequest',\n  /** An argument is invalid (HTTP 400). */\n  ILLEGAL_ARGUMENT: 'IllegalArgument',\n  /** The aggregate is in a state that refuses the command (HTTP 400). */\n  ILLEGAL_STATE: 'IllegalState',\n  /** The wait timed out (HTTP 408). */\n  REQUEST_TIMEOUT: 'RequestTimeout',\n  /** The server is rate limiting (HTTP 429). */\n  TOO_MANY_REQUESTS: 'TooManyRequests',\n  /** The command's request id was used before (HTTP 400). */\n  DUPLICATE_REQUEST_ID: 'DuplicateRequestId',\n  /** The command failed validation (HTTP 400); see `bindingErrors`. */\n  COMMAND_VALIDATION: 'CommandValidation',\n  /** A command rewriter produced no command. */\n  REWRITE_NO_COMMAND: 'RewriteNoCommand',\n  /** Another command changed the aggregate first (HTTP 409). */\n  EVENT_VERSION_CONFLICT: 'EventVersionConflict',\n  /** The aggregate id already exists (HTTP 400). */\n  DUPLICATE_AGGREGATE_ID: 'DuplicateAggregateId',\n  /** The aggregate is not at the version the command expected (HTTP 409). */\n  COMMAND_EXPECT_VERSION_CONFLICT: 'CommandExpectVersionConflict',\n  /** The event stream is not at the version sourcing expected (HTTP 409). */\n  SOURCING_VERSION_CONFLICT: 'SourcingVersionConflict',\n  /** The aggregate is deleted (HTTP 410). */\n  ILLEGAL_ACCESS_DELETED_AGGREGATE: 'IllegalAccessDeletedAggregate',\n  /** The aggregate belongs to another owner (HTTP 403). */\n  ILLEGAL_ACCESS_OWNER_AGGREGATE: 'IllegalAccessOwnerAggregate',\n  /** The aggregate belongs to another space. */\n  ILLEGAL_ACCESS_SPACE_AGGREGATE: 'IllegalAccessSpaceAggregate',\n  /** A query lacks the authenticated tenant scope the server requires (HTTP 403). */\n  ILLEGAL_ACCESS_QUERY_SCOPE: 'IllegalAccessQueryScope',\n  /** An unexpected server failure (HTTP 500). */\n  INTERNAL_SERVER_ERROR: 'InternalServerError',\n  /** A query does not fit the aggregate's query schema (HTTP 400). */\n  QUERY_SCHEMA_VALIDATION: 'QuerySchemaValidation',\n  /** The query schema conflicts with the stored one (HTTP 500). */\n  QUERY_SCHEMA_CONFLICT: 'QuerySchemaConflict',\n  /** The query schema is not available yet (HTTP 503). */\n  QUERY_SCHEMA_UNAVAILABLE: 'QuerySchemaUnavailable',\n  /** A batch task failed. */\n  BATCH_TASK_ERROR: 'BatchTaskError',\n} as const);\n\n/** One of the error codes Wow itself defines; see {@link ErrorCodes}. */\nexport type WowErrorCode = (typeof ErrorCodes)[keyof typeof ErrorCodes];\n\n/**\n * An error code: one of Wow's own, which editors complete, or any other an\n * application defines.\n */\n// eslint-disable-next-line @typescript-eslint/no-empty-object-type\nexport type ErrorCode = WowErrorCode | (string & {});\n"],"mappings":"AAuBA,IAAYA,EAAL,SAAA,EAAA,OASL,GAAAC,YAAA,cAKA,EAAAC,QAAA,UASA,EAAAC,cAAA,iBACF,EAAA,CAAA,CAAA,EAuDaC,EAAa,OAAO,OAAO,CAEtC,UAAW,KAEX,UAAW,WAEX,YAAa,aAEb,iBAAkB,kBAElB,cAAe,eAEf,gBAAiB,iBAEjB,kBAAmB,kBAEnB,qBAAsB,qBAEtB,mBAAoB,oBAEpB,mBAAoB,mBAEpB,uBAAwB,uBAExB,uBAAwB,uBAExB,gCAAiC,+BAEjC,0BAA2B,0BAE3B,iCAAkC,gCAElC,+BAAgC,8BAEhC,+BAAgC,8BAEhC,2BAA4B,0BAE5B,sBAAuB,sBAEvB,wBAAyB,wBAEzB,sBAAuB,sBAEvB,yBAA0B,yBAE1B,iBAAkB,gBACpB,CAAU"}

package/dist/error/errorInfo.d.cts

@@ -0,0 +1,139 @@
+import { QueryErrorCode } from './queryErrorCodes.cjs';
+/**
+ * Enumerates the types of recoverability for errors or operations, allowing for classification and handling based on whether an error is transient and can be resolved by retrying.
+ *
+ * The [RecoverableType] enum provides a way to categorize errors into three distinct categories: [RECOVERABLE], [UNRECOVERABLE], and [UNKNOWN].
+ * This categorization is essential for implementing robust error handling and retry mechanisms in applications,
+ * ensuring that temporary issues are retried while permanent or unknown issues are handled appropriately.
+ *
+ */
+export declare enum RecoverableType {
+    /**
+     * Represents an error type that indicates the operation or error can be retried.
+     *
+     * This enum value is used to classify errors in a way that allows for the implementation of retry logic. When an error
+     * is marked as [RECOVERABLE], it signifies that the error condition is temporary and might be resolved upon retrying the
+     * operation. This is particularly useful in scenarios where network issues, transient server errors, or other temporary
+     * conditions may cause an operation to fail, but with a high likelihood of success on subsequent attempts.
+     */
+    RECOVERABLE = "RECOVERABLE",
+    /**
+     * Represents an unknown type of recoverability for an error or operation.
+     * This is used when the recoverability of an error cannot be determined or is not specified.
+     */
+    UNKNOWN = "UNKNOWN",
+    /**
+     * Represents an error type that indicates the operation or error cannot be retried.
+     *
+     * This enum value is used to classify errors in a way that signifies the error condition is permanent and retrying the operation will not resolve the issue. It is particularly
+     *  useful for handling errors where the underlying problem is fundamental and cannot be resolved by simply retrying, such as invalid input, resource exhaustion, or other non-transient
+     *  issues.
+     */
+    UNRECOVERABLE = "UNRECOVERABLE"
+}
+/**
+ * Represents an error that occurs during the binding process, typically when data is being mapped to or from an object.
+ * This class extends the [Named] interface, inheriting the `name` property which can be used to identify the source or context of the error.
+ *
+ * @param name The name or identifier for the context in which the error occurred.
+ * @param msg A message describing the error.
+ * @param code A stable, machine-readable code of the failed rule, when the server states one.
+ */
+export interface BindingError {
+    name: string;
+    msg: string;
+    /**
+     * A stable, machine-readable code of the rule that failed, when the server
+     * states one: a rejected query carries one of {@link QueryErrorCodes}.
+     * Absent otherwise, as for a command's validation errors.
+     */
+    code?: QueryErrorCode;
+}
+/**
+ * Represents the information about an error, including whether the operation succeeded, the error code, and any associated messages or binding errors.
+ *
+ * This interface is designed to provide a standardized way of handling and representing errors across different parts of an application. It includes methods to check if the operation was successful, retrieve the error code
+ * , and access any additional error details such as messages or binding errors.
+ */
+export interface ErrorInfo {
+    /**
+     * Represents the error code associated with an error. This value is used to identify the type of error that has occurred,
+     * which can be useful for debugging, logging, and handling errors in a standardized way.
+     */
+    errorCode: ErrorCode;
+    /**
+     * Represents the message associated with an error. This message provides a human-readable description of the error, which can be used for logging, debugging, or displaying to the user
+     * .
+     */
+    errorMsg: string;
+    /**
+     * Provides a list of [BindingError] instances that occurred during the binding process.
+     * Each [BindingError] contains information about the error, including its name and a message describing the issue.
+     * This property returns an empty list if no binding errors are present.
+     */
+    bindingErrors?: BindingError[];
+}
+/**
+ * The error codes Wow itself answers with, as `ErrorInfo.errorCode`, as the
+ * `Wow-Error-Code` response header, and as the event name of an error in a
+ * server-sent event stream.
+ *
+ * Mirrors `ErrorCodes` in `wow-core/src/main/kotlin/me/ahoo/wow/exception/ErrorCodes.kt`
+ * and the query schema and batch codes the server registers beside it.
+ * Applications add their own codes; {@link ErrorCode} admits those too.
+ */
+export declare const ErrorCodes: Readonly<{
+    /** The request succeeded. */
+    readonly SUCCEEDED: "Ok";
+    /** The requested resource does not exist (HTTP 404). */
+    readonly NOT_FOUND: "NotFound";
+    /** The request is malformed (HTTP 400). */
+    readonly BAD_REQUEST: "BadRequest";
+    /** An argument is invalid (HTTP 400). */
+    readonly ILLEGAL_ARGUMENT: "IllegalArgument";
+    /** The aggregate is in a state that refuses the command (HTTP 400). */
+    readonly ILLEGAL_STATE: "IllegalState";
+    /** The wait timed out (HTTP 408). */
+    readonly REQUEST_TIMEOUT: "RequestTimeout";
+    /** The server is rate limiting (HTTP 429). */
+    readonly TOO_MANY_REQUESTS: "TooManyRequests";
+    /** The command's request id was used before (HTTP 400). */
+    readonly DUPLICATE_REQUEST_ID: "DuplicateRequestId";
+    /** The command failed validation (HTTP 400); see `bindingErrors`. */
+    readonly COMMAND_VALIDATION: "CommandValidation";
+    /** A command rewriter produced no command. */
+    readonly REWRITE_NO_COMMAND: "RewriteNoCommand";
+    /** Another command changed the aggregate first (HTTP 409). */
+    readonly EVENT_VERSION_CONFLICT: "EventVersionConflict";
+    /** The aggregate id already exists (HTTP 400). */
+    readonly DUPLICATE_AGGREGATE_ID: "DuplicateAggregateId";
+    /** The aggregate is not at the version the command expected (HTTP 409). */
+    readonly COMMAND_EXPECT_VERSION_CONFLICT: "CommandExpectVersionConflict";
+    /** The event stream is not at the version sourcing expected (HTTP 409). */
+    readonly SOURCING_VERSION_CONFLICT: "SourcingVersionConflict";
+    /** The aggregate is deleted (HTTP 410). */
+    readonly ILLEGAL_ACCESS_DELETED_AGGREGATE: "IllegalAccessDeletedAggregate";
+    /** The aggregate belongs to another owner (HTTP 403). */
+    readonly ILLEGAL_ACCESS_OWNER_AGGREGATE: "IllegalAccessOwnerAggregate";
+    /** The aggregate belongs to another space. */
+    readonly ILLEGAL_ACCESS_SPACE_AGGREGATE: "IllegalAccessSpaceAggregate";
+    /** A query lacks the authenticated tenant scope the server requires (HTTP 403). */
+    readonly ILLEGAL_ACCESS_QUERY_SCOPE: "IllegalAccessQueryScope";
+    /** An unexpected server failure (HTTP 500). */
+    readonly INTERNAL_SERVER_ERROR: "InternalServerError";
+    /** A query does not fit the aggregate's query schema (HTTP 400). */
+    readonly QUERY_SCHEMA_VALIDATION: "QuerySchemaValidation";
+    /** The query schema conflicts with the stored one (HTTP 500). */
+    readonly QUERY_SCHEMA_CONFLICT: "QuerySchemaConflict";
+    /** The query schema is not available yet (HTTP 503). */
+    readonly QUERY_SCHEMA_UNAVAILABLE: "QuerySchemaUnavailable";
+    /** A batch task failed. */
+    readonly BATCH_TASK_ERROR: "BatchTaskError";
+}>;
+/** One of the error codes Wow itself defines; see {@link ErrorCodes}. */
+export type WowErrorCode = (typeof ErrorCodes)[keyof typeof ErrorCodes];
+/**
+ * An error code: one of Wow's own, which editors complete, or any other an
+ * application defines.
+ */
+export type ErrorCode = WowErrorCode | (string & {});