@finnair/v-validation-luxon 4.1.0 → 4.2.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [4.2.0](https://github.com/finnair/v-validation/compare/v4.1.0...v4.2.0) (2023-01-24)
+
+
+### Features
+
+* Support ISO 8601 time string as Duration ([#89](https://github.com/finnair/v-validation/issues/89)) ([75fb154](https://github.com/finnair/v-validation/commit/75fb154fa5283e7a51d3301097c7ed759beeabd8))
+
+
+
+
+
 # [4.1.0](https://github.com/finnair/v-validation/compare/v4.0.0...v4.1.0) (2022-11-22)
 
 **Note:** Version bump only for package @finnair/v-validation-luxon

package/README.md

@@ -74,18 +74,19 @@ DateTime instance which is public readonly fiedl. However there are a few conven
 
 ## Build-in Validators
 
-| Vluxon.             | Format                     | Description                                               |
-| ------------------- | -------------------------- | --------------------------------------------------------- |
-| localDate           | `yyyy-MM-dd`               | Local date (time normalized to midninght UTC).            |
-| localTime           | `HH:mm:ss`                 | Local time (date normalized to 1970-01-01).               |
-| dateTime            | `yyyy-MM-ddTHH:mm:ssZ`     | Date and time in local (parsed) time zone.                |
-| dateTimeUtc         | `yyyy-MM-ddTHH:mm:ssZ`     | Date and time in UTC time zone.                           |
-| dateTimeMillis      | `yyyy-MM-ddTHH:mm:ss.SSSZ` | Date and time with millis in local (parsed) time zone.    |
-| dateTimeMillisUtc   | `yyyy-MM-ddTHH:mm:ss.SSSZ` | Date and time with millis in UTC time zone.               |
-| dateTimeFromISO     | Any ISO                    | Plain Luxon DateTime from ISO format.                     |
-| dateTimeFromRFC2822 | RFC2822                    | Plain Luxon DateTime from RFC2822 format.                 |
-| dateTimeFromHTTP    | HTTP date-time             | Plain Luxon DateTime from HTTP format.                    |
-| dateTimeFromSQL     | SQL date-time              | Plain Luxon DateTime from SQL format.                     |
-| dateTimeFromSeconds | Unix timestamp (number)    | Plain Luxon DateTime from Unix timestamp in seconds.      |
-| dateTimeFromMillis  | Unix timestamp (number)    | Plain Luxon DateTime from Unix timestamp in milliseconds. |
-| duration            | ISO 8601 Duration          | Luxon `Duration` with pattern validation.                 |
+| Vluxon.             | Format                           | Description                                               |
+| ------------------- | -------------------------------- | --------------------------------------------------------- |
+| localDate           | `yyyy-MM-dd`                     | Local date (time normalized to midninght UTC).            |
+| localTime           | `HH:mm:ss`                       | Local time (date normalized to 1970-01-01).               |
+| dateTime            | `yyyy-MM-ddTHH:mm:ssZ`           | Date and time in local (parsed) time zone.                |
+| dateTimeUtc         | `yyyy-MM-ddTHH:mm:ssZ`           | Date and time in UTC time zone.                           |
+| dateTimeMillis      | `yyyy-MM-ddTHH:mm:ss.SSSZ`       | Date and time with millis in local (parsed) time zone.    |
+| dateTimeMillisUtc   | `yyyy-MM-ddTHH:mm:ss.SSSZ`       | Date and time with millis in UTC time zone.               |
+| dateTimeFromISO     | Any ISO                          | Plain Luxon DateTime from ISO format.                     |
+| dateTimeFromRFC2822 | RFC2822                          | Plain Luxon DateTime from RFC2822 format.                 |
+| dateTimeFromHTTP    | HTTP date-time                   | Plain Luxon DateTime from HTTP format.                    |
+| dateTimeFromSQL     | SQL date-time                    | Plain Luxon DateTime from SQL format.                     |
+| dateTimeFromSeconds | Unix timestamp (number)          | Plain Luxon DateTime from Unix timestamp in seconds.      |
+| dateTimeFromMillis  | Unix timestamp (number)          | Plain Luxon DateTime from Unix timestamp in milliseconds. |
+| duration            | ISO 8601 Duration                | Luxon `Duration.fromISO` with pattern validation.         |
+| timeDuration        | ISO 8601 time string as Duration | Luxon `Duration.fromISOTime`.                             |

package/dist/Vluxon.d.ts

@@ -38,6 +38,9 @@ declare function dateTimeFromSeconds(options?: DateTimeJSOptions): import("@finn
 export declare class DurationValidator extends Validator {
     validatePath(value: any, path: Path, ctx: ValidationContext): Promise<ValidationResult>;
 }
+export declare class TimeDurationValidator extends Validator {
+    validatePath(value: any, path: Path, ctx: ValidationContext): Promise<ValidationResult>;
+}
 export declare const Vluxon: {
     localDate: typeof localDate;
     localTime: typeof localTime;
@@ -53,5 +56,6 @@ export declare const Vluxon: {
     dateTimeFromSeconds: typeof dateTimeFromSeconds;
     dateTimeFromMillis: typeof dateTimeFromMillis;
     duration: () => DurationValidator;
+    timeDuration: () => TimeDurationValidator;
 };
 export {};

package/dist/Vluxon.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Vluxon = exports.DurationValidator = exports.validateLuxonNumber = exports.LuxonValidator = void 0;
+exports.Vluxon = exports.TimeDurationValidator = exports.DurationValidator = exports.validateLuxonNumber = exports.LuxonValidator = void 0;
 const v_validation_1 = require("@finnair/v-validation");
 const luxon_1 = require("luxon");
 const luxon_2 = require("./luxon");
@@ -197,6 +197,26 @@ class DurationValidator extends v_validation_1.Validator {
     }
 }
 exports.DurationValidator = DurationValidator;
+class TimeDurationValidator extends v_validation_1.Validator {
+    validatePath(value, path, ctx) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if ((0, v_validation_1.isNullOrUndefined)(value)) {
+                return ctx.failure(v_validation_1.defaultViolations.notNull(path), value);
+            }
+            else if (luxon_1.Duration.isDuration(value)) {
+                return ctx.success(value);
+            }
+            else if ((0, v_validation_1.isString)(value)) {
+                const duration = luxon_1.Duration.fromISOTime(value);
+                if (duration.isValid) {
+                    return ctx.success(duration);
+                }
+            }
+            return ctx.failure(new v_validation_1.TypeMismatch(path, 'TimeDuration', value), value);
+        });
+    }
+}
+exports.TimeDurationValidator = TimeDurationValidator;
 exports.Vluxon = {
     // DateTime wrapper validators
     localDate,
@@ -214,5 +234,6 @@ exports.Vluxon = {
     dateTimeFromSeconds,
     dateTimeFromMillis,
     duration: () => new DurationValidator(),
+    timeDuration: () => new TimeDurationValidator(),
 };
 Object.freeze(exports.Vluxon);

package/dist/test-luxon.js

@@ -4,3 +4,4 @@ const luxon_1 = require("luxon");
 const dt = luxon_1.DateTime.fromISO('2022-10-29T23:30:00').setZone(luxon_1.FixedOffsetZone.instance(-60), { keepLocalTime: true });
 console.log(dt);
 console.log(dt.setZone(luxon_1.FixedOffsetZone.utcInstance));
+console.log(luxon_1.Duration.fromISOTime('000900').toJSON());

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@finnair/v-validation-luxon",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "private": false,
   "description": "Luxon validators",
   "main": "dist/index.js",
@@ -31,5 +31,5 @@
   "peerDependencies": {
     "luxon": "^3.0.0"
   },
-  "gitHead": "7fa7827e86f5c6da14d89bf80a6b58408a84bf4d"
+  "gitHead": "1a9091a370951283c32bc5c6f3770399e7afb6df"
 }