@item-enonic-types/lib-time 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Item Consulting AS
+
+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,120 @@
+# Time library for Enonic XP
+
+This library enables the usage of classes from the [`java.time`](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/package-summary.html) package from Enonic XP application code.
+Other JavaScript-based time libraries like _Moment.js_ or _date-fns_ will negatively impact your bundle size and build time. This library is only a **thin TypeScript-wrapper** around the excellent core `java.time` library already present in your system!
+
+[![](https://jitpack.io/v/no.item/lib-xp-time.svg)](https://jitpack.io/#no.item/lib-xp-time)
+
+<img src="https://github.com/ItemConsulting/lib-xp-time/raw/main/docs/icon.svg?sanitize=true" width="150">
+
+## Installation
+
+To install this library you need to add a new dependency to your app's build.gradle file.
+
+### Gradle
+
+```groovy
+repositories {
+  maven { url 'https://jitpack.io' }
+}
+
+dependencies {
+  include "no.item:lib-xp-time:0.1.0"
+}
+```
+
+### TypeScript
+
+To update the version of *enonic-types* in *package.json* using npm, run the following command:
+```bash
+npm install --save-dev @item-enonic-types/lib-time
+```
+
+You can add the following changes to your *tsconfig.json* to get TypeScript-support.
+
+```diff
+{
+  "compilerOptions": {
++   "baseUrl": "./",
++   "paths": {
++     "/lib/xp/*": ["./node_modules/@enonic-types/lib-*"],
++     "/lib/*": [ "./node_modules/@item-enonic-types/lib-*" ,"./src/main/resources/lib/*"],
++   }
+  }
+}
+```
+
+### Usage
+
+You can import `java.time` and  `java.time.format` classes from `"/lib/time"`.
+
+*Example of date math on a `LocalDateTime` using `"/lib/time"`:*
+
+```typescript
+import { LocalDateTime, DateTimeFormatter } from "/lib/time";
+
+const today = LocalDateTime.parse("2023-02-21T12:15:30");
+const inThreeWeeks = today.plusWeeks(3);
+const dateStr = inThreeWeeks.format(DateTimeFormatter.ofPattern("dd-MM-yyyy hh:mm:ss"));
+// dateStr = "14-03-2023 12:15:30"
+```
+
+*Example of doing time math using a `ZonedDateTime`:*
+
+```typescript
+import { ZonedDateTime } from "/lib/time";
+
+const date = ZonedDateTime.parse("2023-02-21T12:15:30+01:00");
+const fiftyMinutesAgo = date.minusMinutes(50);
+const time = fiftyMinutesAgo.toLocalTime();
+// time = "11:25:30"
+```
+
+*This library also exposes a utility function `formatDate()` to simply format a date:*
+
+```typescript
+import { formatDate } from "/lib/time";
+
+const today = t.formatDate({
+  date: "2023-02-21",
+  pattern: "dd-MM-yyyy",
+  locale: "no"
+});
+// today = "21-02-2023"
+```
+
+### Constants exposed from `"/lib/time"`
+The following classes is exposed/exported from `"/lib/time"`:
+* `DateTimeFormatter`
+* `DayOfWeek`
+* `Instant`
+* `LocalDate`
+* `LocalDateTime`
+* `Locale`
+* `LocalTime`
+* `Month`
+* `OffsetDateTime`
+* `OffsetTime`
+* `ZonedDateTime`
+* `ZoneId`
+* `ZoneOffset`
+
+### Building
+
+To build the project run the following code
+
+```bash
+./gradlew build
+```
+
+### Deploy locally
+
+Deploy locally for testing purposes:
+
+```bash
+./gradlew publishToMavenLocal
+```
+## Deploy to Jitpack
+
+Go to the [Jitpack page for lib-xp-time](https://jitpack.io/#no.item/lib-xp-time) to deploy from GitHub (after
+[creating a new versioned release](https://github.com/ItemConsulting/lib-xp-time/releases/new)).

package/day-of-week.d.ts

@@ -0,0 +1,2 @@
+export const __esModule: boolean;
+export const DayOfWeek: any;

package/format/date-time-formatter.d.ts

@@ -0,0 +1,2 @@
+export const __esModule: boolean;
+export const DateTimeFormatter: any;

package/index.d.ts

@@ -0,0 +1,225 @@
+declare const _exports: {
+    readonly DayOfWeek: any;
+    readonly __esModule: boolean;
+    readonly LocalDateTime: any;
+    readonly ZonedDateTime: any;
+    readonly Locale: any;
+    readonly DateTimeFormatter: any;
+    readonly Instant: any;
+    readonly LocalDate: any;
+    readonly LocalTime: any;
+    readonly Month: any;
+    readonly OffsetDateTime: any;
+    readonly OffsetTime: any;
+    readonly ZoneId: any;
+    readonly ZoneOffset: any;
+    formatDate: (_a: any) => any;
+} | {
+    readonly DateTimeFormatter: any;
+    readonly __esModule: boolean;
+    readonly DayOfWeek: any;
+    readonly LocalDateTime: any;
+    readonly ZonedDateTime: any;
+    readonly Locale: any;
+    readonly Instant: any;
+    readonly LocalDate: any;
+    readonly LocalTime: any;
+    readonly Month: any;
+    readonly OffsetDateTime: any;
+    readonly OffsetTime: any;
+    readonly ZoneId: any;
+    readonly ZoneOffset: any;
+    formatDate: (_a: any) => any;
+} | {
+    readonly Instant: any;
+    readonly __esModule: boolean;
+    readonly DayOfWeek: any;
+    readonly LocalDateTime: any;
+    readonly ZonedDateTime: any;
+    readonly Locale: any;
+    readonly DateTimeFormatter: any;
+    readonly LocalDate: any;
+    readonly LocalTime: any;
+    readonly Month: any;
+    readonly OffsetDateTime: any;
+    readonly OffsetTime: any;
+    readonly ZoneId: any;
+    readonly ZoneOffset: any;
+    formatDate: (_a: any) => any;
+} | {
+    readonly LocalDate: any;
+    readonly __esModule: boolean;
+    readonly DayOfWeek: any;
+    readonly LocalDateTime: any;
+    readonly ZonedDateTime: any;
+    readonly Locale: any;
+    readonly DateTimeFormatter: any;
+    readonly Instant: any;
+    readonly LocalTime: any;
+    readonly Month: any;
+    readonly OffsetDateTime: any;
+    readonly OffsetTime: any;
+    readonly ZoneId: any;
+    readonly ZoneOffset: any;
+    formatDate: (_a: any) => any;
+} | {
+    readonly LocalDateTime: any;
+    readonly __esModule: boolean;
+    readonly DayOfWeek: any;
+    readonly ZonedDateTime: any;
+    readonly Locale: any;
+    readonly DateTimeFormatter: any;
+    readonly Instant: any;
+    readonly LocalDate: any;
+    readonly LocalTime: any;
+    readonly Month: any;
+    readonly OffsetDateTime: any;
+    readonly OffsetTime: any;
+    readonly ZoneId: any;
+    readonly ZoneOffset: any;
+    formatDate: (_a: any) => any;
+} | {
+    readonly LocalTime: any;
+    readonly __esModule: boolean;
+    readonly DayOfWeek: any;
+    readonly LocalDateTime: any;
+    readonly ZonedDateTime: any;
+    readonly Locale: any;
+    readonly DateTimeFormatter: any;
+    readonly Instant: any;
+    readonly LocalDate: any;
+    readonly Month: any;
+    readonly OffsetDateTime: any;
+    readonly OffsetTime: any;
+    readonly ZoneId: any;
+    readonly ZoneOffset: any;
+    formatDate: (_a: any) => any;
+} | {
+    readonly Month: any;
+    readonly __esModule: boolean;
+    readonly DayOfWeek: any;
+    readonly LocalDateTime: any;
+    readonly ZonedDateTime: any;
+    readonly Locale: any;
+    readonly DateTimeFormatter: any;
+    readonly Instant: any;
+    readonly LocalDate: any;
+    readonly LocalTime: any;
+    readonly OffsetDateTime: any;
+    readonly OffsetTime: any;
+    readonly ZoneId: any;
+    readonly ZoneOffset: any;
+    formatDate: (_a: any) => any;
+} | {
+    readonly OffsetDateTime: any;
+    readonly __esModule: boolean;
+    readonly DayOfWeek: any;
+    readonly LocalDateTime: any;
+    readonly ZonedDateTime: any;
+    readonly Locale: any;
+    readonly DateTimeFormatter: any;
+    readonly Instant: any;
+    readonly LocalDate: any;
+    readonly LocalTime: any;
+    readonly Month: any;
+    readonly OffsetTime: any;
+    readonly ZoneId: any;
+    readonly ZoneOffset: any;
+    formatDate: (_a: any) => any;
+} | {
+    readonly OffsetTime: any;
+    readonly __esModule: boolean;
+    readonly DayOfWeek: any;
+    readonly LocalDateTime: any;
+    readonly ZonedDateTime: any;
+    readonly Locale: any;
+    readonly DateTimeFormatter: any;
+    readonly Instant: any;
+    readonly LocalDate: any;
+    readonly LocalTime: any;
+    readonly Month: any;
+    readonly OffsetDateTime: any;
+    readonly ZoneId: any;
+    readonly ZoneOffset: any;
+    formatDate: (_a: any) => any;
+} | {
+    readonly Locale: any;
+    readonly __esModule: boolean;
+    readonly DayOfWeek: any;
+    readonly LocalDateTime: any;
+    readonly ZonedDateTime: any;
+    readonly DateTimeFormatter: any;
+    readonly Instant: any;
+    readonly LocalDate: any;
+    readonly LocalTime: any;
+    readonly Month: any;
+    readonly OffsetDateTime: any;
+    readonly OffsetTime: any;
+    readonly ZoneId: any;
+    readonly ZoneOffset: any;
+    formatDate: (_a: any) => any;
+} | {
+    /***/ readonly ZoneId: any;
+    readonly __esModule: boolean;
+    readonly DayOfWeek: any;
+    readonly LocalDateTime: any;
+    readonly ZonedDateTime: any;
+    readonly Locale: any;
+    readonly DateTimeFormatter: any;
+    readonly Instant: any;
+    readonly LocalDate: any;
+    readonly LocalTime: any;
+    readonly Month: any;
+    readonly OffsetDateTime: any;
+    readonly OffsetTime: any;
+    readonly ZoneOffset: any;
+    formatDate: (_a: any) => any;
+} | {
+    readonly ZoneOffset: any;
+    readonly __esModule: boolean;
+    readonly DayOfWeek: any;
+    readonly LocalDateTime: any;
+    readonly ZonedDateTime: any;
+    readonly Locale: any;
+    readonly DateTimeFormatter: any;
+    readonly Instant: any;
+    readonly LocalDate: any;
+    readonly LocalTime: any;
+    readonly Month: any;
+    readonly OffsetDateTime: any;
+    readonly OffsetTime: any;
+    readonly ZoneId: any;
+    formatDate: (_a: any) => any;
+} | {
+    readonly ZonedDateTime: any;
+    readonly __esModule: boolean;
+    readonly DayOfWeek: any;
+    readonly LocalDateTime: any;
+    readonly Locale: any;
+    readonly DateTimeFormatter: any;
+    readonly Instant: any;
+    readonly LocalDate: any;
+    readonly LocalTime: any;
+    readonly Month: any;
+    readonly OffsetDateTime: any;
+    readonly OffsetTime: any;
+    readonly ZoneId: any;
+    readonly ZoneOffset: any;
+    formatDate: (_a: any) => any;
+};
+export = _exports;
+export const __esModule: boolean;
+export const DayOfWeek: any;
+export const LocalDateTime: any;
+export const ZonedDateTime: any;
+export const Locale: any;
+export const DateTimeFormatter: any;
+export const Instant: any;
+export const LocalDate: any;
+export const LocalTime: any;
+export const Month: any;
+export const OffsetDateTime: any;
+export const OffsetTime: any;
+export const ZoneId: any;
+export const ZoneOffset: any;
+export function formatDate(_a: any): any;

package/instant.d.ts

@@ -0,0 +1,2 @@
+export const __esModule: boolean;
+export const Instant: any;

package/local-date-time.d.ts

@@ -0,0 +1,2 @@
+export const __esModule: boolean;
+export const LocalDateTime: any;

package/local-date.d.ts

@@ -0,0 +1,2 @@
+export const __esModule: boolean;
+export const LocalDate: any;

package/local-time.d.ts

@@ -0,0 +1,2 @@
+export const __esModule: boolean;
+export const LocalTime: any;

package/month.d.ts

@@ -0,0 +1,2 @@
+export const __esModule: boolean;
+export const Month: any;

package/offset-date-time.d.ts

@@ -0,0 +1,2 @@
+export const __esModule: boolean;
+export const OffsetDateTime: any;

package/offset-time.d.ts

@@ -0,0 +1,2 @@
+export const __esModule: boolean;
+export const OffsetTime: any;

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@item-enonic-types/lib-time",
+  "version": "0.1.1",
+  "description": "Type definitions for lib-time",
+  "license": "MIT",
+  "files": [
+    "*.d.ts",
+    "format/*.d.ts",
+    "tsconfig.json"
+  ],
+  "scripts": {
+    "build:server": "webpack --config webpack.server.config.js --color",
+    "build": "run-p -c build:*",
+    "dist:server": "cross-env NODE_ENV=production webpack --config webpack.server.config.js --color",
+    "dist": "run-p -c dist:*",
+    "lint": "eslint --fix 'src/**/*.ts'",
+    "prepublishOnly": "tsc --declarationDir build/types --emitDeclarationOnly true --declaration true && cp -r ./build/types/build/resources/main/lib/time/* .",
+    "postpublish": "rm ./*.d.ts && rm -r ./format"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.19.6",
+    "@babel/plugin-proposal-class-properties": "^7.18.6",
+    "@babel/preset-env": "^7.19.4",
+    "@babel/register": "^7.18.9",
+    "@typescript-eslint/eslint-plugin": "^5.41.0",
+    "@typescript-eslint/parser": "^5.41.0",
+    "babel-loader": "^8.2.5",
+    "browserslist": "^4.21.4",
+    "browserslist-config-enonic": "^1.0.7",
+    "cross-env": "^7.0.3",
+    "eslint": "^8.26.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "glob": "^8.0.3",
+    "npm-run-all": "^4.1.5",
+    "prettier": "^2.7.1",
+    "ramda": "^0.28.0",
+    "ts-loader": "^9.4.1",
+    "typescript": "^4.8.4",
+    "webpack": "^5.74.0",
+    "webpack-cli": "^4.10.0",
+    "@item-enonic-types/lib-testing": "^7.11.3",
+    "enonic-types": "^7.11.3"
+  },
+  "browserslist": [
+    "extends browserslist-config-enonic"
+  ],
+  "engines": {
+    "node": ">= 16.13.1",
+    "npm": ">= 8.1.2"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,23 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "target": "es5",
+    "sourceMap": true,
+    "allowJs": true,
+    "noImplicitAny": true,
+    "noImplicitReturns": true,
+    "noImplicitThis": true,
+    "strictNullChecks": true,
+    "baseUrl": "./",
+    "paths": {
+      "/lib/xp/*": ["node_modules/@enonic-types/lib-*"],
+      "/lib/*": [ "./node_modules/@item-enonic-types/lib-*" ,"./src/main/resources/lib/*"]
+    },
+    "declaration": true,
+    "declarationDir": "build/types"
+  },
+  "types": [
+    "types"
+  ]
+}

package/util.d.ts

@@ -0,0 +1,2 @@
+export const __esModule: boolean;
+export const Locale: any;

package/zone-id.d.ts

@@ -0,0 +1,2 @@
+export const __esModule: boolean;
+export const ZoneId: any;

package/zone-offset.d.ts

@@ -0,0 +1,2 @@
+export const __esModule: boolean;
+export const ZoneOffset: any;

package/zoned-date-time.d.ts

@@ -0,0 +1,2 @@
+export const __esModule: boolean;
+export const ZonedDateTime: any;