@kaiord/zwo 4.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Pablo Albaladejo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the “Software”), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,83 @@
+# @kaiord/zwo
+
+[![npm version](https://img.shields.io/npm/v/@kaiord/zwo.svg)](https://www.npmjs.com/package/@kaiord/zwo)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+ZWO format adapter for Kaiord workout data conversion. Provides reading, writing, and validation of Zwift workout XML files.
+
+## Installation
+
+```bash
+pnpm add @kaiord/core @kaiord/zwo
+```
+
+## Usage
+
+### With Core Providers (Recommended)
+
+```typescript
+import { createDefaultProviders } from "@kaiord/core";
+import { createZwoProviders } from "@kaiord/zwo";
+
+const providers = createDefaultProviders({
+  zwo: createZwoProviders(),
+});
+
+// ZWO to KRD
+const krd = await providers.convertZwiftToKrd!({ zwiftString });
+
+// KRD to ZWO
+const zwoString = await providers.convertKrdToZwift!({ krd });
+```
+
+### Standalone Adapter Access
+
+```typescript
+import {
+  createFastXmlZwiftReader,
+  createFastXmlZwiftWriter,
+  createZwiftValidator,
+} from "@kaiord/zwo";
+import { createConsoleLogger } from "@kaiord/core";
+
+const logger = createConsoleLogger();
+const validator = createZwiftValidator(logger);
+const reader = createFastXmlZwiftReader(logger, validator);
+const writer = createFastXmlZwiftWriter(logger, validator);
+```
+
+## API
+
+### `createZwoProviders(logger?: Logger): ZwoProviders`
+
+Creates ZWO adapter instances for use with `createDefaultProviders()`.
+
+### `createFastXmlZwiftReader(logger: Logger, validator: ZwiftValidator): ZwiftReader`
+
+Creates a ZWO file reader using fast-xml-parser.
+
+### `createFastXmlZwiftWriter(logger: Logger, validator: ZwiftValidator): ZwiftWriter`
+
+Creates a ZWO file writer using fast-xml-parser.
+
+### `createZwiftValidator(logger: Logger): ZwiftValidator`
+
+Creates a validator that uses XSD validation in Node.js and well-formedness checking in browsers.
+
+### `createXsdZwiftValidator(logger: Logger): ZwiftValidator`
+
+Creates a strict XSD schema validator (Node.js only).
+
+## Supported ZWO Features
+
+- SteadyState intervals
+- Warmup and Cooldown ramps
+- IntervalsT (structured intervals)
+- FreeRide segments
+- Power targets (FTP percentage)
+- Heart rate and cadence targets
+- Text events
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,33 @@
+import { Logger, ZwiftReader, ZwiftWriter, ZwiftValidator } from '@kaiord/core';
+
+type ZwoProviders = {
+    zwiftReader: ZwiftReader;
+    zwiftWriter: ZwiftWriter;
+    zwiftValidator: ZwiftValidator;
+};
+declare const createZwoProviders: (logger?: Logger) => ZwoProviders;
+
+declare const createFastXmlZwiftReader: (logger: Logger, validator: ZwiftValidator) => ZwiftReader;
+declare const createFastXmlZwiftWriter: (logger: Logger, validator: ZwiftValidator) => ZwiftWriter;
+
+/**
+ * Creates a Zwift validator that automatically chooses the appropriate validation strategy:
+ * - In Node.js: Full XSD schema validation
+ * - In browsers: XML well-formedness validation only
+ *
+ * This ensures the library works in both environments without requiring separate builds.
+ *
+ * @param logger - Logger instance for diagnostic messages
+ * @returns ZwiftValidator function
+ */
+declare const createZwiftValidator: (logger: Logger) => ZwiftValidator;
+/**
+ * Creates a Zwift validator with full XSD schema validation.
+ * Only available in Node.js environments.
+ *
+ * @param logger - Logger instance for diagnostic messages
+ * @returns ZwiftValidator function with XSD validation
+ */
+declare const createXsdZwiftValidator: (logger: Logger) => ZwiftValidator;
+
+export { type ZwoProviders, createFastXmlZwiftReader, createFastXmlZwiftWriter, createXsdZwiftValidator, createZwiftValidator, createZwoProviders };