@fgv/ts-extras 5.1.0-1 → 5.1.0-11

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/dist/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.57.6"
+      "packageVersion": "7.57.7"
     }
   ]
 }

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-1",
+  "version": "5.1.0-11",
   "description": "Assorted Typescript Utilities",
   "main": "lib/index.js",
   "types": "dist/ts-extras.d.ts",
@@ -42,18 +42,6 @@
       }
     }
   },
-  "scripts": {
-    "build": "heft build --clean",
-    "clean": "heft clean",
-    "test": "heft test --clean",
-    "build-docs": "typedoc --options ./config/typedoc.json",
-    "build-all": "rushx build; rushx build-docs",
-    "test-handles": "jest --runInBand --detectOpenHandles",
-    "clean-jest": "jest --clear-cache",
-    "coverage": "jest --coverage",
-    "lint": "eslint src --ext .ts",
-    "fixlint": "eslint src --ext .ts --fix"
-  },
   "sideEffects": false,
   "keywords": [
     "typescript",
@@ -66,7 +54,6 @@
   },
   "homepage": "https://github.com/ErikFortune/fgv/tree/main/libraries/ts-extras#ts-utils",
   "devDependencies": {
-    "@fgv/heft-dual-rig": "workspace:*",
     "@jest/expect-utils": "^29.7.0",
     "@microsoft/api-documenter": "^7.28.2",
     "@microsoft/api-extractor": "^7.55.2",
@@ -90,31 +77,45 @@
     "typescript": "5.9.3",
     "eslint-plugin-n": "^17.23.1",
     "jest-snapshot": "~29.7.0",
-    "@rushstack/heft": "1.2.6",
-    "@rushstack/heft-node-rig": "2.11.26",
+    "@rushstack/heft": "1.2.7",
+    "@rushstack/heft-node-rig": "2.11.27",
     "@rushstack/eslint-config": "4.6.4",
     "@types/heft-jest": "1.0.6",
     "@rushstack/heft-jest-plugin": "1.2.6",
     "eslint-plugin-tsdoc": "~0.5.2",
-    "@fgv/ts-utils-jest": "workspace:*",
-    "@fgv/ts-utils": "workspace:*",
     "@types/js-yaml": "~4.0.9",
     "typedoc": "~0.28.16",
-    "typedoc-plugin-markdown": "~4.9.0"
+    "typedoc-plugin-markdown": "~4.9.0",
+    "@fgv/heft-dual-rig": "5.1.0-11",
+    "@fgv/ts-utils-jest": "5.1.0-11",
+    "@fgv/typedoc-compact-theme": "5.1.0-11",
+    "@fgv/ts-utils": "5.1.0-11"
   },
   "dependencies": {
     "luxon": "^3.7.2",
     "mustache": "^4.2.0",
     "papaparse": "^5.4.1",
     "fflate": "~0.8.2",
-    "@fgv/ts-json-base": "workspace:*",
-    "js-yaml": "~4.1.1"
+    "js-yaml": "~4.1.1",
+    "@fgv/ts-json-base": "5.1.0-11"
   },
   "peerDependencies": {
-    "@fgv/ts-utils": "workspace:*"
+    "@fgv/ts-utils": "5.1.0-11"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/ErikFortune/fgv.git"
+  },
+  "scripts": {
+    "build": "heft build --clean",
+    "clean": "heft clean",
+    "test": "heft test --clean",
+    "build-docs": "typedoc --options ./config/typedoc.json",
+    "build-all": "rushx build; rushx build-docs",
+    "test-handles": "jest --runInBand --detectOpenHandles",
+    "clean-jest": "jest --clear-cache",
+    "coverage": "jest --coverage",
+    "lint": "eslint src --ext .ts",
+    "fixlint": "eslint src --ext .ts --fix"
   }
-}
+}