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

package/dist/transport/eventStreams.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"eventStreams.cjs","names":["CommandStage","WowError","isErrorInfo","JsonEventStreamResultExtractor","require_wowError","require_command","_ahoo_wang_fetcher_eventstream","ROW_EVENT","COMMAND_STAGES","rowsUntilErrorEvent","isData","event","controller","QueryEventStreamResultExtractor","exchange","eventName","CommandResultEventStreamResultExtractor"],"sources":["../../src/transport/eventStreams.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 { ResultExtractor } from '@ahoo-wang/fetcher';\nimport {\n  JsonEventStreamResultExtractor,\n  type JsonServerSentEvent,\n} from '@ahoo-wang/fetcher-eventstream';\nimport { isErrorInfo, WowError } from '../error/wowError.js';\nimport { type CommandResult, CommandStage } from '../model/command.js';\n\n/**\n * The event name the server gives the rows of a query stream. Wow sends them\n * without an `event:` field, which the event-stream parser reads as\n * `message`.\n */\nconst ROW_EVENT = 'message';\n\nconst COMMAND_STAGES: ReadonlySet<string> = new Set(\n  Object.values(CommandStage),\n);\n\n/**\n * Unwraps the events `isData` accepts to their data, and errors the stream\n * with a `WowError` at the first one it does not.\n *\n * Wow's `event`, `id` and `retry` fields carry nothing an application reads:\n * a query row always arrives as `message`, a command result names its stage\n * in `stage`, and Wow does not resume a stream. So the stream a client\n * answers is the rows themselves.\n *\n * When a server-sent event stream fails midway, Wow still answers HTTP 200\n * and sends one last event whose name is the error code and whose data is\n * the `ErrorInfo`, then closes the stream (`WebFluxResponseStrategy`,\n * `errorResume`). Read as data it would pass for a row or a command result;\n * here it ends the stream the way a failed request ends a call.\n */\nfunction rowsUntilErrorEvent<T>(\n  isData: (eventName: string) => boolean,\n): TransformStream<JsonServerSentEvent<unknown>, T> {\n  return new TransformStream({\n    transform(event, controller) {\n      if (isData(event.event)) {\n        controller.enqueue(event.data as T);\n        return;\n      }\n      controller.error(\n        new WowError(\n          isErrorInfo(event.data)\n            ? event.data\n            : { errorCode: event.event, errorMsg: '' },\n        ),\n      );\n    },\n  });\n}\n\n/**\n * Internal: applications and generated code take the two extractors below\n * through the endpoint presets `QUERY_STREAM_ENDPOINT` and\n * `COMMAND_STREAM_ENDPOINT` (`endpoints.ts`); this file is not re-exported.\n *\n * The result extractor of the query streams (`listStream`,\n * `listStateStream`, `aggregateStream`, `loadStream`): the response as a\n * stream of rows, one per server-sent event, which errors with a\n * {@link WowError} when the server sends an error event.\n */\nexport const QueryEventStreamResultExtractor: ResultExtractor<\n  ReadableStream<unknown>\n> = async exchange =>\n  (await JsonEventStreamResultExtractor(exchange)).pipeThrough(\n    rowsUntilErrorEvent(eventName => eventName === ROW_EVENT),\n  );\n\n/**\n * The result extractor of `sendAndWaitStream`: the command results, one per\n * stage the command reached, which errors with a {@link WowError} when the\n * server sends an error event. A command result whose own `errorCode` is not\n * `Ok` is still a result — the command failed in its processing — and is\n * passed on as one.\n *\n * Generated command clients take it through `COMMAND_STREAM_ENDPOINT`.\n */\nexport const CommandResultEventStreamResultExtractor: ResultExtractor<\n  ReadableStream<CommandResult>\n> = async exchange =>\n  (await JsonEventStreamResultExtractor(exchange)).pipeThrough(\n    rowsUntilErrorEvent<CommandResult>(eventName =>\n      COMMAND_STAGES.has(eventName),\n    ),\n  );\n"],"mappings":"2HA0BA,IAAMO,EAAY,UAEZC,EAAsC,IAAI,IAC9C,OAAO,OAAOR,EAAAA,YAAY,CAC5B,EAiBA,SAASS,EACP,EACkD,CAClD,OAAO,IAAI,gBAAgB,CACzB,UAAU,EAAO,EAAY,CAC3B,GAAIC,EAAOC,EAAM,KAAK,EAAG,CACvBC,EAAW,QAAQD,EAAM,IAAS,EAClC,MACF,CACAC,EAAW,MACT,IAAIX,EAAAA,SACFC,EAAAA,YAAYS,EAAM,IAAI,EAClBA,EAAM,KACN,CAAE,UAAWA,EAAM,MAAO,SAAU,EAAG,CAC7C,CACF,CACF,CACF,CAAC,CACH,CAYA,IAAaE,EAET,KAAM,KACP,MAAA,EAAMV,EAAAA,+BAAAA,CAA+BW,CAAQ,EAAA,CAAG,YAC/CL,EAAoB,GAAaM,IAAcR,CAAS,CAC1D,EAWWS,EAET,KAAM,KACP,MAAA,EAAMb,EAAAA,+BAAAA,CAA+BW,CAAQ,EAAA,CAAG,YAC/CL,EAAmC,GACjCD,EAAe,IAAIO,CAAS,CAC9B,CACF"}

package/dist/transport/eventStreams.d.cts

@@ -0,0 +1,23 @@
+import { ResultExtractor } from '@ahoo-wang/fetcher';
+import { CommandResult } from '../model/command.cjs';
+/**
+ * Internal: applications and generated code take the two extractors below
+ * through the endpoint presets `QUERY_STREAM_ENDPOINT` and
+ * `COMMAND_STREAM_ENDPOINT` (`endpoints.ts`); this file is not re-exported.
+ *
+ * The result extractor of the query streams (`listStream`,
+ * `listStateStream`, `aggregateStream`, `loadStream`): the response as a
+ * stream of rows, one per server-sent event, which errors with a
+ * {@link WowError} when the server sends an error event.
+ */
+export declare const QueryEventStreamResultExtractor: ResultExtractor<ReadableStream<unknown>>;
+/**
+ * The result extractor of `sendAndWaitStream`: the command results, one per
+ * stage the command reached, which errors with a {@link WowError} when the
+ * server sends an error event. A command result whose own `errorCode` is not
+ * `Ok` is still a result — the command failed in its processing — and is
+ * passed on as one.
+ *
+ * Generated command clients take it through `COMMAND_STREAM_ENDPOINT`.
+ */
+export declare const CommandResultEventStreamResultExtractor: ResultExtractor<ReadableStream<CommandResult>>;

package/dist/transport/eventStreams.d.ts

@@ -0,0 +1,23 @@
+import { ResultExtractor } from '@ahoo-wang/fetcher';
+import { CommandResult } from '../model/command.js';
+/**
+ * Internal: applications and generated code take the two extractors below
+ * through the endpoint presets `QUERY_STREAM_ENDPOINT` and
+ * `COMMAND_STREAM_ENDPOINT` (`endpoints.ts`); this file is not re-exported.
+ *
+ * The result extractor of the query streams (`listStream`,
+ * `listStateStream`, `aggregateStream`, `loadStream`): the response as a
+ * stream of rows, one per server-sent event, which errors with a
+ * {@link WowError} when the server sends an error event.
+ */
+export declare const QueryEventStreamResultExtractor: ResultExtractor<ReadableStream<unknown>>;
+/**
+ * The result extractor of `sendAndWaitStream`: the command results, one per
+ * stage the command reached, which errors with a {@link WowError} when the
+ * server sends an error event. A command result whose own `errorCode` is not
+ * `Ok` is still a result — the command failed in its processing — and is
+ * passed on as one.
+ *
+ * Generated command clients take it through `COMMAND_STREAM_ENDPOINT`.
+ */
+export declare const CommandResultEventStreamResultExtractor: ResultExtractor<ReadableStream<CommandResult>>;

package/dist/transport/eventStreams.es.js

@@ -0,0 +1,22 @@
+import { WowError as e, isErrorInfo as t } from "../error/wowError.es.js";
+import { CommandStage as n } from "../model/command.es.js";
+import { JsonEventStreamResultExtractor as r } from "@ahoo-wang/fetcher-eventstream";
+//#region src/transport/eventStreams.ts
+var i = "message", a = new Set(Object.values(n));
+function o(n) {
+	return new TransformStream({ transform(r, i) {
+		if (n(r.event)) {
+			i.enqueue(r.data);
+			return;
+		}
+		i.error(new e(t(r.data) ? r.data : {
+			errorCode: r.event,
+			errorMsg: ""
+		}));
+	} });
+}
+var s = async (e) => (await r(e)).pipeThrough(o((e) => e === i)), c = async (e) => (await r(e)).pipeThrough(o((e) => a.has(e)));
+//#endregion
+export { c as CommandResultEventStreamResultExtractor, s as QueryEventStreamResultExtractor };
+
+//# sourceMappingURL=eventStreams.es.js.map

package/dist/transport/eventStreams.es.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"eventStreams.es.js","names":["ROW_EVENT","COMMAND_STAGES","CommandStage","rowsUntilErrorEvent","isData","event","WowError","isErrorInfo","QueryEventStreamResultExtractor","JsonEventStreamResultExtractor","exchange","eventName","CommandResultEventStreamResultExtractor"],"sources":["../../src/transport/eventStreams.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 { ResultExtractor } from '@ahoo-wang/fetcher';\nimport {\n  JsonEventStreamResultExtractor,\n  type JsonServerSentEvent,\n} from '@ahoo-wang/fetcher-eventstream';\nimport { isErrorInfo, WowError } from '../error/wowError.js';\nimport { type CommandResult, CommandStage } from '../model/command.js';\n\n/**\n * The event name the server gives the rows of a query stream. Wow sends them\n * without an `event:` field, which the event-stream parser reads as\n * `message`.\n */\nconst ROW_EVENT = 'message';\n\nconst COMMAND_STAGES: ReadonlySet<string> = new Set(\n  Object.values(CommandStage),\n);\n\n/**\n * Unwraps the events `isData` accepts to their data, and errors the stream\n * with a `WowError` at the first one it does not.\n *\n * Wow's `event`, `id` and `retry` fields carry nothing an application reads:\n * a query row always arrives as `message`, a command result names its stage\n * in `stage`, and Wow does not resume a stream. So the stream a client\n * answers is the rows themselves.\n *\n * When a server-sent event stream fails midway, Wow still answers HTTP 200\n * and sends one last event whose name is the error code and whose data is\n * the `ErrorInfo`, then closes the stream (`WebFluxResponseStrategy`,\n * `errorResume`). Read as data it would pass for a row or a command result;\n * here it ends the stream the way a failed request ends a call.\n */\nfunction rowsUntilErrorEvent<T>(\n  isData: (eventName: string) => boolean,\n): TransformStream<JsonServerSentEvent<unknown>, T> {\n  return new TransformStream({\n    transform(event, controller) {\n      if (isData(event.event)) {\n        controller.enqueue(event.data as T);\n        return;\n      }\n      controller.error(\n        new WowError(\n          isErrorInfo(event.data)\n            ? event.data\n            : { errorCode: event.event, errorMsg: '' },\n        ),\n      );\n    },\n  });\n}\n\n/**\n * Internal: applications and generated code take the two extractors below\n * through the endpoint presets `QUERY_STREAM_ENDPOINT` and\n * `COMMAND_STREAM_ENDPOINT` (`endpoints.ts`); this file is not re-exported.\n *\n * The result extractor of the query streams (`listStream`,\n * `listStateStream`, `aggregateStream`, `loadStream`): the response as a\n * stream of rows, one per server-sent event, which errors with a\n * {@link WowError} when the server sends an error event.\n */\nexport const QueryEventStreamResultExtractor: ResultExtractor<\n  ReadableStream<unknown>\n> = async exchange =>\n  (await JsonEventStreamResultExtractor(exchange)).pipeThrough(\n    rowsUntilErrorEvent(eventName => eventName === ROW_EVENT),\n  );\n\n/**\n * The result extractor of `sendAndWaitStream`: the command results, one per\n * stage the command reached, which errors with a {@link WowError} when the\n * server sends an error event. A command result whose own `errorCode` is not\n * `Ok` is still a result — the command failed in its processing — and is\n * passed on as one.\n *\n * Generated command clients take it through `COMMAND_STREAM_ENDPOINT`.\n */\nexport const CommandResultEventStreamResultExtractor: ResultExtractor<\n  ReadableStream<CommandResult>\n> = async exchange =>\n  (await JsonEventStreamResultExtractor(exchange)).pipeThrough(\n    rowsUntilErrorEvent<CommandResult>(eventName =>\n      COMMAND_STAGES.has(eventName),\n    ),\n  );\n"],"mappings":";;;;AA0BA,IAAMA,IAAY,WAEZC,IAAsC,IAAI,IAC9C,OAAO,OAAOC,CAAY,CAC5B;AAiBA,SAASC,EACP,GACkD;CAClD,OAAO,IAAI,gBAAgB,EACzB,UAAU,GAAO,GAAY;EAC3B,IAAIC,EAAOC,EAAM,KAAK,GAAG;GACvB,EAAW,QAAQA,EAAM,IAAS;GAClC;EACF;EACA,EAAW,MACT,IAAIC,EACFC,EAAYF,EAAM,IAAI,IAClBA,EAAM,OACN;GAAE,WAAWA,EAAM;GAAO,UAAU;EAAG,CAC7C,CACF;CACF,EACF,CAAC;AACH;AAYA,IAAaG,IAET,OAAM,OACP,MAAMC,EAA+BC,CAAQ,EAAA,CAAG,YAC/CP,GAAoB,MAAaQ,MAAcX,CAAS,CAC1D,GAWWY,IAET,OAAM,OACP,MAAMH,EAA+BC,CAAQ,EAAA,CAAG,YAC/CP,GAAmC,MACjCF,EAAe,IAAIU,CAAS,CAC9B,CACF"}

package/dist/transport/index.d.cts

@@ -0,0 +1 @@
+export * from './endpoints.cjs';

package/dist/transport/index.d.ts

@@ -0,0 +1 @@
+export * from './endpoints.js';

package/package.json

@@ -0,0 +1,110 @@
+{
+  "name": "@ahoo-wang/wow-client",
+  "version": "9.2.0-rc.0",
+  "description": "TypeScript client for Wow (https://github.com/Ahoo-Wang/Wow): commands, snapshot and event-stream queries, and the query DSL, built on Fetcher.",
+  "keywords": [
+    "wow",
+    "wow-client",
+    "cqrs",
+    "event-sourcing",
+    "ddd",
+    "microservice",
+    "typescript",
+    "fetch",
+    "http",
+    "client"
+  ],
+  "author": "Ahoo-Wang",
+  "license": "Apache-2.0",
+  "homepage": "https://wow.ahoo.me/reference/typescript/wow-client/",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Ahoo-Wang/Wow.git",
+    "directory": "typescript/wow-client"
+  },
+  "bugs": {
+    "url": "https://github.com/Ahoo-Wang/Wow/issues"
+  },
+  "type": "module",
+  "engines": {
+    "node": ">=22.12.0"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.es.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.es.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./dsl": {
+      "import": {
+        "types": "./dist/dsl.d.ts",
+        "default": "./dist/dsl.es.js"
+      },
+      "require": {
+        "types": "./dist/dsl.d.cts",
+        "default": "./dist/dsl.cjs"
+      }
+    },
+    "./legacy": {
+      "import": {
+        "types": "./dist/legacy/index.d.ts",
+        "default": "./dist/legacy.es.js"
+      },
+      "require": {
+        "types": "./dist/legacy/index.d.cts",
+        "default": "./dist/legacy.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "README.zh-CN.md"
+  ],
+  "sideEffects": false,
+  "peerDependencies": {
+    "@ahoo-wang/fetcher": "^5.1.5",
+    "@ahoo-wang/fetcher-decorator": "^5.1.5",
+    "@ahoo-wang/fetcher-eventstream": "^5.1.5"
+  },
+  "devDependencies": {
+    "@ahoo-wang/fetcher": "^5.1.5",
+    "@ahoo-wang/fetcher-decorator": "^5.1.5",
+    "@ahoo-wang/fetcher-eventstream": "^5.1.5",
+    "@eslint/js": "^10.0.1",
+    "@microsoft/api-extractor": "^7.59.3",
+    "@types/node": "^26.6.3",
+    "@vitest/coverage-v8": "4.1.11",
+    "@vitest/ui": "^4.1.11",
+    "eslint": "^10.11.0",
+    "globals": "^17.12.0",
+    "prettier": "3.9.9",
+    "typescript": "~6.0.3",
+    "typescript-eslint": "^8.70.1",
+    "unplugin-dts": "1.1.1",
+    "vite": "8.3.1",
+    "vite-bundle-analyzer": "^1.3.9",
+    "vitest": "^4.1.11"
+  },
+  "scripts": {
+    "build": "vite build && pnpm test:package",
+    "test:package": "node scripts/verify-package.mjs",
+    "test:ui": "vitest --ui",
+    "test": "vitest run --coverage && pnpm test:type && pnpm test:api",
+    "test:api": "node scripts/api-report.mjs",
+    "test:type": "tsc --noEmit -p test/tsconfig.types.json",
+    "lint": "eslint . --fix",
+    "clean": "rm -rf dist",
+    "analyze": "npx vite-bundle-analyzer -p auto",
+    "test:no-coverage": "vitest run --coverage.enabled=false && pnpm test:type && pnpm test:api"
+  }
+}