@fgv/ts-extras 5.1.0-7 → 5.1.0-8

package/dist/packlets/conversion/converters.js

@@ -60,8 +60,41 @@ export const isoDate = new Conversion.BaseConverter((from) => {
     else if (from instanceof Date) {
         return succeed(from);
     }
+    else if (from instanceof DateTime) {
+        if (from.isValid) {
+            return succeed(from.toJSDate());
+        }
+        return fail(`Invalid date: ${from.invalidExplanation}`);
+    }
     return fail(`Cannot convert ${JSON.stringify(from)} to Date`);
 });
+/**
+ * A `Converter` which converts an iso formatted string, a number or a `Date` object to
+ * a `DateTime` object.
+ * @public
+ */
+export const isoDateTime = new Conversion.BaseConverter((from) => {
+    if (typeof from === 'string') {
+        const dt = DateTime.fromISO(from);
+        if (dt.isValid) {
+            return succeed(dt);
+        }
+        return fail(`Invalid date: ${dt.invalidExplanation}`);
+    }
+    else if (typeof from === 'number') {
+        return succeed(DateTime.fromMillis(from));
+    }
+    else if (from instanceof Date) {
+        return succeed(DateTime.fromJSDate(from));
+    }
+    else if (from instanceof DateTime) {
+        if (from.isValid) {
+            return succeed(from);
+        }
+        return fail(`Invalid date: ${from.invalidExplanation}`);
+    }
+    return fail(`Cannot convert ${JSON.stringify(from)} to DateTime`);
+});
 /**
  * A helper function to create a `Converter` which converts `unknown` to {@link Experimental.ExtendedArray | ExtendedArray<T>}.
  * @remarks

package/dist/ts-extras.d.ts

@@ -1,5 +1,6 @@
 import { Conversion } from '@fgv/ts-utils';
 import { Converter } from '@fgv/ts-utils';
+import { DateTime } from 'luxon';
 import { FileTree } from '@fgv/ts-json-base';
 import { Hash as Hash_2 } from '@fgv/ts-utils';
 import { JsonValue } from '@fgv/ts-json-base';
@@ -210,7 +211,8 @@ declare namespace Converters {
         extendedArrayOf,
         rangeTypeOf,
         rangeOf,
-        isoDate
+        isoDate,
+        isoDateTime
     }
 }
 export { Converters }
@@ -1399,6 +1401,13 @@ declare function isKeyStoreFile(json: unknown): boolean;
  */
 declare const isoDate: Converter<Date, unknown>;
 
+/**
+ * A `Converter` which converts an iso formatted string, a number or a `Date` object to
+ * a `DateTime` object.
+ * @public
+ */
+declare const isoDateTime: Converter<DateTime, unknown>;
+
 /**
  * Represents a variable reference extracted from a Mustache template.
  * @public

package/lib/packlets/conversion/converters.d.ts

@@ -1,4 +1,5 @@
 import { Conversion, Converter, Result } from '@fgv/ts-utils';
+import { DateTime } from 'luxon';
 import { ExtendedArray, RangeOf, RangeOfProperties } from '../experimental';
 /**
  * Helper function to create a `StringConverter` which converts
@@ -17,6 +18,12 @@ export declare function templateString(defaultContext?: unknown): Conversion.Str
  * @public
  */
 export declare const isoDate: Converter<Date, unknown>;
+/**
+ * A `Converter` which converts an iso formatted string, a number or a `Date` object to
+ * a `DateTime` object.
+ * @public
+ */
+export declare const isoDateTime: Converter<DateTime, unknown>;
 /**
  * A helper function to create a `Converter` which converts `unknown` to {@link Experimental.ExtendedArray | ExtendedArray<T>}.
  * @remarks

package/lib/packlets/conversion/converters.js

@@ -24,7 +24,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isoDate = void 0;
+exports.isoDateTime = exports.isoDate = void 0;
 exports.templateString = templateString;
 exports.extendedArrayOf = extendedArrayOf;
 exports.rangeTypeOf = rangeTypeOf;
@@ -70,8 +70,41 @@ exports.isoDate = new ts_utils_1.Conversion.BaseConverter((from) => {
     else if (from instanceof Date) {
         return (0, ts_utils_1.succeed)(from);
     }
+    else if (from instanceof luxon_1.DateTime) {
+        if (from.isValid) {
+            return (0, ts_utils_1.succeed)(from.toJSDate());
+        }
+        return (0, ts_utils_1.fail)(`Invalid date: ${from.invalidExplanation}`);
+    }
     return (0, ts_utils_1.fail)(`Cannot convert ${JSON.stringify(from)} to Date`);
 });
+/**
+ * A `Converter` which converts an iso formatted string, a number or a `Date` object to
+ * a `DateTime` object.
+ * @public
+ */
+exports.isoDateTime = new ts_utils_1.Conversion.BaseConverter((from) => {
+    if (typeof from === 'string') {
+        const dt = luxon_1.DateTime.fromISO(from);
+        if (dt.isValid) {
+            return (0, ts_utils_1.succeed)(dt);
+        }
+        return (0, ts_utils_1.fail)(`Invalid date: ${dt.invalidExplanation}`);
+    }
+    else if (typeof from === 'number') {
+        return (0, ts_utils_1.succeed)(luxon_1.DateTime.fromMillis(from));
+    }
+    else if (from instanceof Date) {
+        return (0, ts_utils_1.succeed)(luxon_1.DateTime.fromJSDate(from));
+    }
+    else if (from instanceof luxon_1.DateTime) {
+        if (from.isValid) {
+            return (0, ts_utils_1.succeed)(from);
+        }
+        return (0, ts_utils_1.fail)(`Invalid date: ${from.invalidExplanation}`);
+    }
+    return (0, ts_utils_1.fail)(`Cannot convert ${JSON.stringify(from)} to DateTime`);
+});
 /**
  * A helper function to create a `Converter` which converts `unknown` to {@link Experimental.ExtendedArray | ExtendedArray<T>}.
  * @remarks

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fgv/ts-extras",
-  "version": "5.1.0-7",
+  "version": "5.1.0-8",
   "description": "Assorted Typescript Utilities",
   "main": "lib/index.js",
   "types": "dist/ts-extras.d.ts",
@@ -86,10 +86,10 @@
     "@types/js-yaml": "~4.0.9",
     "typedoc": "~0.28.16",
     "typedoc-plugin-markdown": "~4.9.0",
-    "@fgv/heft-dual-rig": "5.1.0-7",
-    "@fgv/typedoc-compact-theme": "5.1.0-7",
-    "@fgv/ts-utils-jest": "5.1.0-7",
-    "@fgv/ts-utils": "5.1.0-7"
+    "@fgv/typedoc-compact-theme": "5.1.0-8",
+    "@fgv/ts-utils-jest": "5.1.0-8",
+    "@fgv/heft-dual-rig": "5.1.0-8",
+    "@fgv/ts-utils": "5.1.0-8"
   },
   "dependencies": {
     "luxon": "^3.7.2",
@@ -97,10 +97,10 @@
     "papaparse": "^5.4.1",
     "fflate": "~0.8.2",
     "js-yaml": "~4.1.1",
-    "@fgv/ts-json-base": "5.1.0-7"
+    "@fgv/ts-json-base": "5.1.0-8"
   },
   "peerDependencies": {
-    "@fgv/ts-utils": "5.1.0-7"
+    "@fgv/ts-utils": "5.1.0-8"
   },
   "repository": {
     "type": "git",