@item-enonic-types/lib-time 1.3.0 → 1.5.0

package/README.md

@@ -19,7 +19,7 @@ repositories {
 }
 
 dependencies {
-  include "no.item:lib-xp-time:1.3.0"
+  include "no.item:lib-xp-time:1.5.0"
 }
 ```
 
@@ -140,6 +140,7 @@ The following classes is exposed/exported from `"/lib/time"`:
 * `Month`
 * `OffsetDateTime`
 * `OffsetTime`
+* `Year`
 * `ZonedDateTime`
 * `ZoneId`
 * `ZoneOffset`

package/day-of-week.d.ts

@@ -1,3 +1,5 @@
+import { TextStyle } from "./format/text-style";
+import { Locale } from "./util";
 /**
  *  DayOfWeek is an enum representing the 7 days of the week - Monday, Tuesday, Wednesday, Thursday, Friday, Saturday and Sunday.
  * @see {@link https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/DayOfWeek.html}
@@ -5,11 +7,19 @@
 export declare const DayOfWeek: DayOfWeekConstructor;
 export type WeekDayNumber = 1 | 2 | 3 | 4 | 5 | 6 | 7;
 export interface DayOfWeekConstructor {
+    MONDAY: DayOfWeek;
+    TUESDAY: DayOfWeek;
+    WEDNESDAY: DayOfWeek;
+    THURSDAY: DayOfWeek;
+    FRIDAY: DayOfWeek;
+    SATURDAY: DayOfWeek;
+    SUNDAY: DayOfWeek;
     of(dayOfWeek: WeekDayNumber): DayOfWeek;
     valueOf(name: string): DayOfWeek;
     values(): DayOfWeek[];
 }
 export interface DayOfWeek {
+    getDisplayName(style: TextStyle, locale: Locale): string;
     getValue(): WeekDayNumber;
     minus(days: number): DayOfWeek;
     plus(days: number): DayOfWeek;

package/format/text-style.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Enumeration of the style of text formatting and parsing.
+ *
+ * Text styles define three sizes for the formatted text - 'full', 'short' and 'narrow'. Each of these three sizes is available in both 'standard' and 'stand-alone' variations.
+ *
+ * The difference between the three sizes is obvious in most languages. For example, in English the 'full' month is 'January', the 'short' month is 'Jan' and the 'narrow' month is 'J'. Note that the narrow size is often not unique. For example, 'January', 'June' and 'July' all have the 'narrow' text 'J'.
+ *
+ * The difference between the 'standard' and 'stand-alone' forms is trickier to describe as there is no difference in English. However, in other languages there is a difference in the word used when the text is used alone, as opposed to in a complete date. For example, the word used for a month when used alone in a date picker is different to the word used for month in association with a day and year in a date.
+ * @see {@link https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/format/TextStyle.html}
+ */
+export declare const TextStyle: TextStyleConstructor;
+export interface TextStyleConstructor {
+    FULL: TextStyle;
+    FULL_STANDALONE: TextStyle;
+    NARROW: TextStyle;
+    NARROW_STANDALONE: TextStyle;
+    SHORT: TextStyle;
+    SHORT_STANDALONE: TextStyle;
+    valueOf(name: string): TextStyle;
+    values(): TextStyle[];
+}
+export interface TextStyle {
+    asNormal(): TextStyle;
+    asStandalone(): TextStyle;
+    isStandalone(): boolean;
+}

package/index.d.ts

@@ -3,12 +3,14 @@ export { LocalDateTime } from "/lib/time/local-date-time";
 export { ZonedDateTime } from "/lib/time/zoned-date-time";
 export { Locale, LanguageRange } from "/lib/time/util";
 export { DateTimeFormatter } from "/lib/time/format/date-time-formatter";
+export { TextStyle } from "/lib/time/format/text-style";
 export { Instant } from "/lib/time/instant";
 export { LocalDate } from "/lib/time/local-date";
 export { LocalTime } from "/lib/time/local-time";
-export { Month } from "/lib/time/month";
+export { Month, type MonthNumber } from "/lib/time/month";
 export { OffsetDateTime } from "/lib/time/offset-date-time";
 export { OffsetTime } from "/lib/time/offset-time";
+export { Year } from "/lib/time/year";
 export { ZoneId } from "/lib/time/zone-id";
 export { ZoneOffset } from "/lib/time/zone-offset";
 /**

package/month.d.ts

@@ -1,3 +1,5 @@
+import type { TextStyle } from "./format/text-style";
+import type { Locale } from "./util";
 /**
  * A month-of-year, such as 'July'.
  *
@@ -7,7 +9,20 @@
 export declare const Month: MonthConstructor;
 export type MonthNumber = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
 export interface MonthConstructor {
+    JANUARY: Month;
+    FEBRUARY: Month;
+    MARCH: Month;
+    APRIL: Month;
+    MAY: Month;
+    JUNE: Month;
+    JULY: Month;
+    AUGUST: Month;
+    SEPTEMBER: Month;
+    OCTOBER: Month;
+    NOVEMBER: Month;
+    DECEMBER: Month;
     of(month: MonthNumber): Month;
+    valueOf(name: string): Month;
 }
 export interface Month {
     getValue(): MonthNumber;
@@ -15,6 +30,7 @@ export interface Month {
     hashCode(): number;
     firstDayOfYear(leapYear: boolean): number;
     firstMonthOfQuarter(): Month;
+    getDisplayName(style: TextStyle, locale: Locale): string;
     length(leapYear: boolean): number;
     maxLength(): number;
     minLength(): number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@item-enonic-types/lib-time",
-  "version": "1.3.0",
+  "version": "1.5.0",
   "description": "Type definitions for lib-time",
   "license": "MIT",
   "files": [
@@ -11,8 +11,8 @@
   "devDependencies": {
     "@changesets/cli": "^2.29.8",
     "@item-enonic-types/lib-testing": "^7.13.0",
-    "@swc/core": "^1.15.4",
-    "@types/node": "^25.0.1",
+    "@swc/core": "^1.15.8",
+    "@types/node": "^25.0.3",
     "eslint": "^9.39.2",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-prettier": "^5.5.4",
@@ -21,7 +21,7 @@
     "prettier": "^3.7.4",
     "tsup": "^8.5.1",
     "typescript": "^5.9.3",
-    "typescript-eslint": "^8.49.0"
+    "typescript-eslint": "^8.52.0"
   },
   "dependencies": {
     "@item-enonic-types/nashorn-env": "^0.0.2"

package/year.d.ts

@@ -0,0 +1,30 @@
+import type { ZoneId } from "./zone-id";
+import type { LocalDate } from "./local-date";
+import type { DateTimeFormatter } from "./format/date-time-formatter";
+/**
+ * A year in the ISO-8601 calendar system, such as 2007.
+ * Year is an immutable date-time object that represents a year. Any field that can be derived from a year can be obtained.
+ * @see {@link https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/Year.html}
+ */
+export declare const Year: YearConstructor;
+export interface YearConstructor {
+    now(): Year;
+    now(zone: ZoneId): Year;
+    of(isoYear: number): Year;
+    parse(text: string): Year;
+    parse(text: string, formatter: DateTimeFormatter): Year;
+    isLeap(year: number): boolean;
+}
+export interface Year {
+    getValue(): number;
+    toString(): string;
+    hashCode(): number;
+    atDay(dayOfYear: number): LocalDate;
+    compareTo(other: Year): boolean;
+    format(formatter: DateTimeFormatter): string;
+    isAfter(other: Year): boolean;
+    isBefore(other: Year): boolean;
+    isLeap(): boolean;
+    minusYears(yearsToSubtract: number): Year;
+    plusYears(yearsToAdd: number): Year;
+}