@rightcapital/date-helpers 2.0.1-feature-add-date-helpers.58.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 RightCapital
+
+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,68 @@
+# `@rightcapital/date-helpers`
+
+A utility class providing various date formatting and parsing methods in TypeScript.
+
+## Features
+
+- Convert a date string to `Date` object with `parseDateString`.
+- Format dates into various string formats, such as ISO, US locale, and more.
+- Handle a variety of date string formats for both parsing and formatting.
+
+## Installation
+
+```bash
+pnpm add @rightcapital/date-helpers
+```
+
+## Usage
+
+### Parse Date String
+
+Convert a date string to a Date object using various possible formats.
+
+```typescript
+import { DateHelpers } from '@rightcapital/date-helpers';
+const date = DateHelpers.parseDateString('2023/01/01');
+```
+
+### Format to ISO Date String
+
+Format a date as an ISO date string.
+
+```typescript
+import { DateHelpers } from '@rightcapital/date-helpers';
+
+const isoDateString = DateHelpers.formatISO(new Date(2023, 0, 1));
+// Result: Sun Jan 01 2023 00:00:00 GMT+0000 (Coordinated Universal Time)
+```
+
+### Format to US Locale
+
+Format a date as a US locale date string.
+
+```typescript
+import { DateHelpers } from '@rightcapital/date-helpers';
+const usDateString = DateHelpers.formatUsLocaleDate(new Date(2023, 0, 31));
+// Result: "01/31/2023"
+```
+
+Formats a date as a US locale time string.
+
+```typescript
+import { DateHelpers } from '@rightcapital/date-helpers';
+const usDateString = DateHelpers.formatUsLocaleTime('2025/10/20 12:00:00');
+// Result: "10/20/2025 12:00:00"
+```
+
+### Format to "Month day, year"
+
+Formats a date as a string in the "Month day, year" format.
+
+```typescript
+const monthDayYearString = DateHelpers.formatMediumDate(new Date(2023, 0, 1));
+// Result: "Jan 1, 2023"
+```
+
+## API Reference
+
+[Here](/packages/date-helpers/docs/modules.md) is the API documentation for the modules included in the package.

package/lib/date-helpers.d.ts

@@ -0,0 +1,12 @@
+export type DateType = Date | string;
+export declare class DateHelpers {
+    static usLocaleDateFormat: string;
+    static usLocaleTimeFormat: string;
+    static isoDateFormat: string;
+    static parseDateString(input: string): Date;
+    static formatIsoDate(dateSource: DateType): string;
+    static formatUsLocaleDate(dateSource: DateType, dateFormat?: string): string;
+    static formatUsLocaleTime(dateSource: DateType, dateFormat?: string): string;
+    static formatMediumDate(dateSource: DateType): string;
+}
+//# sourceMappingURL=date-helpers.d.ts.map

package/lib/date-helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"date-helpers.d.ts","sourceRoot":"","sources":["../src/date-helpers.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,QAAQ,GAAG,IAAI,GAAG,MAAM,CAAC;AAUrC,qBAAa,WAAW;IAEtB,OAAc,kBAAkB,SAAgB;IAGhD,OAAc,kBAAkB,SAAyB;IAGzD,OAAc,aAAa,SAAgB;WAe7B,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;WAyDpC,aAAa,CAAC,UAAU,EAAE,QAAQ,GAAG,MAAM;WA6B3C,kBAAkB,CAC9B,UAAU,EAAE,QAAQ,EACpB,UAAU,CAAC,EAAE,MAAM,GAClB,MAAM;WA+BK,kBAAkB,CAC9B,UAAU,EAAE,QAAQ,EACpB,UAAU,CAAC,EAAE,MAAM,GAClB,MAAM;WA8BK,gBAAgB,CAAC,UAAU,EAAE,QAAQ,GAAG,MAAM;CAG7D"}

package/lib/date-helpers.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DateHelpers = void 0;
+const exceptions_1 = require("@rightcapital/exceptions");
+const browser_1 = require("@sentry/browser");
+const date_fns_1 = require("date-fns");
+const getParsedDate = (dateSource) => typeof dateSource === 'string'
+    ? DateHelpers.parseDateString(dateSource)
+    : dateSource;
+class DateHelpers {
+    static parseDateString(input) {
+        let output = (0, date_fns_1.parseISO)(input);
+        if ((0, date_fns_1.isValid)(output)) {
+            return output;
+        }
+        const possibleFormats = [
+            'MM/dd/yy',
+            DateHelpers.usLocaleDateFormat,
+            DateHelpers.isoDateFormat,
+            'yyyy/MM/dd',
+            'M/d/yyyy',
+            'MMM d, yyyy',
+            'MMM yyyy',
+            DateHelpers.usLocaleTimeFormat,
+        ];
+        possibleFormats.some((pattern) => {
+            output = (0, date_fns_1.parse)(input, pattern, new Date());
+            return (0, date_fns_1.isValid)(output);
+        });
+        if (!(0, date_fns_1.isValid)(output)) {
+            (0, browser_1.withScope)((scope) => {
+                scope.setLevel('error');
+                scope.setExtras({
+                    input,
+                });
+                (0, browser_1.captureException)(new exceptions_1.InvalidArgumentException(`Invalid Date: unable to parse date string - ${input}`));
+            });
+        }
+        return output;
+    }
+    static formatIsoDate(dateSource) {
+        if (dateSource === '') {
+            return dateSource;
+        }
+        return (0, date_fns_1.formatISO)(getParsedDate(dateSource), {
+            representation: 'date',
+        });
+    }
+    static formatUsLocaleDate(dateSource, dateFormat) {
+        if (dateSource === '') {
+            return dateSource;
+        }
+        if (dateFormat) {
+            return (0, date_fns_1.format)(getParsedDate(dateSource), dateFormat);
+        }
+        return (0, date_fns_1.format)(getParsedDate(dateSource), DateHelpers.usLocaleDateFormat);
+    }
+    static formatUsLocaleTime(dateSource, dateFormat) {
+        return DateHelpers.formatUsLocaleDate(dateSource, dateFormat !== null && dateFormat !== void 0 ? dateFormat : DateHelpers.usLocaleTimeFormat);
+    }
+    static formatMediumDate(dateSource) {
+        return (0, date_fns_1.format)(getParsedDate(dateSource), 'MMM d, yyyy');
+    }
+}
+exports.DateHelpers = DateHelpers;
+DateHelpers.usLocaleDateFormat = 'MM/dd/yyyy';
+DateHelpers.usLocaleTimeFormat = 'MM/dd/yyyy HH:mm:ss';
+DateHelpers.isoDateFormat = 'yyyy-MM-dd';
+//# sourceMappingURL=date-helpers.js.map

package/lib/date-helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"date-helpers.js","sourceRoot":"","sources":["../src/date-helpers.ts"],"names":[],"mappings":";;;AAAA,yDAAoE;AACpE,6CAAqE;AACrE,uCAAuE;AAIvE,MAAM,aAAa,GAAG,CAAC,UAAoB,EAAE,EAAE,CAC7C,OAAO,UAAU,KAAK,QAAQ;IAC5B,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,UAAU,CAAC;IACzC,CAAC,CAAC,UAAU,CAAC;AAKjB,MAAa,WAAW;IAuBf,MAAM,CAAC,eAAe,CAAC,KAAa;QACzC,IAAI,MAAM,GAAG,IAAA,mBAAQ,EAAC,KAAK,CAAC,CAAC;QAE7B,IAAI,IAAA,kBAAO,EAAC,MAAM,CAAC,EAAE;YACnB,OAAO,MAAM,CAAC;SACf;QAED,MAAM,eAAe,GAAG;YACtB,UAAU;YACV,WAAW,CAAC,kBAAkB;YAC9B,WAAW,CAAC,aAAa;YACzB,YAAY;YACZ,UAAU;YACV,aAAa;YACb,UAAU;YACV,WAAW,CAAC,kBAAkB;SAC/B,CAAC;QAEF,eAAe,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;YAC/B,MAAM,GAAG,IAAA,gBAAK,EAAC,KAAK,EAAE,OAAO,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;YAC3C,OAAO,IAAA,kBAAO,EAAC,MAAM,CAAC,CAAC;QACzB,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,IAAA,kBAAO,EAAC,MAAM,CAAC,EAAE;YACpB,IAAA,mBAAS,EAAC,CAAC,KAAY,EAAE,EAAE;gBACzB,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;gBACxB,KAAK,CAAC,SAAS,CAAC;oBACd,KAAK;iBACN,CAAC,CAAC;gBACH,IAAA,0BAAgB,EACd,IAAI,qCAAwB,CAC1B,+CAA+C,KAAK,EAAE,CACvD,CACF,CAAC;YACJ,CAAC,CAAC,CAAC;SACJ;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAmBM,MAAM,CAAC,aAAa,CAAC,UAAoB;QAE9C,IAAI,UAAU,KAAK,EAAE,EAAE;YACrB,OAAO,UAAU,CAAC;SACnB;QAED,OAAO,IAAA,oBAAS,EAAC,aAAa,CAAC,UAAU,CAAC,EAAE;YAC1C,cAAc,EAAE,MAAM;SACvB,CAAC,CAAC;IACL,CAAC;IAoBM,MAAM,CAAC,kBAAkB,CAC9B,UAAoB,EACpB,UAAmB;QAGnB,IAAI,UAAU,KAAK,EAAE,EAAE;YACrB,OAAO,UAAU,CAAC;SACnB;QAED,IAAI,UAAU,EAAE;YACd,OAAO,IAAA,iBAAM,EAAC,aAAa,CAAC,UAAU,CAAC,EAAE,UAAU,CAAC,CAAC;SACtD;QAED,OAAO,IAAA,iBAAM,EAAC,aAAa,CAAC,UAAU,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC,CAAC;IAC3E,CAAC;IAoBM,MAAM,CAAC,kBAAkB,CAC9B,UAAoB,EACpB,UAAmB;QAEnB,OAAO,WAAW,CAAC,kBAAkB,CACnC,UAAU,EACV,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,WAAW,CAAC,kBAAkB,CAC7C,CAAC;IACJ,CAAC;IAyBM,MAAM,CAAC,gBAAgB,CAAC,UAAoB;QACjD,OAAO,IAAA,iBAAM,EAAC,aAAa,CAAC,UAAU,CAAC,EAAE,aAAa,CAAC,CAAC;IAC1D,CAAC;;AAlLH,kCAmLC;AAjLe,8BAAkB,GAAG,YAAY,CAAC;AAGlC,8BAAkB,GAAG,qBAAqB,CAAC;AAG3C,yBAAa,GAAG,YAAY,CAAC"}

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@rightcapital/date-helpers",
+  "version": "2.0.1-feature-add-date-helpers.58.1.0",
+  "description": "Format dates with date-fns.",
+  "author": "RightCapital Ecosystem team <npm-publisher@rightcapital.com>",
+  "keywords": [
+    "date",
+    "date-fns",
+    "format",
+    "helpers",
+    "moment",
+    "parse",
+    "parser",
+    "TypeScript"
+  ],
+  "homepage": "https://www.rightcapital.com",
+  "license": "MIT",
+  "packageManager": "pnpm@8.8.0",
+  "main": "lib/index.js",
+  "typings": "lib/index.d.ts",
+  "directories": {
+    "lib": "lib",
+    "test": "__tests__"
+  },
+  "files": [
+    "lib"
+  ],
+  "dependencies": {
+    "date-fns": "2.30.0",
+    "@rightcapital/exceptions": "1.2.4-feature-add-date-helpers.58.1.0"
+  },
+  "peerDependencies": {
+    "@sentry/browser": "7.x",
+    "date-fns": "^2.29.3"
+  },
+  "devDependencies": {
+    "@sentry/browser": "7.73.0",
+    "typedoc": "0.25.2",
+    "typedoc-plugin-markdown": "3.16.0"
+  },
+  "scripts": {
+    "test": "jest",
+    "build": "tsc",
+    "docs": "pnpm exec typedoc --plugin typedoc-plugin-markdown --out docs src/date-helpers.ts",
+    "eslint": "eslint --cache 'src/**/*.ts*'",
+    "lint": "pnpm prettier && pnpm eslint",
+    "lint:fix": "pnpm prettier --write && eslint 'src/**/*.ts*' --fix",
+    "prettier": "prettier \"{src,__tests__}/**/*.{tsx,ts}\" -l"
+  }
+}