@ma.vu/appdate 0.0.6 → 0.0.8

package/README.md

@@ -13,6 +13,8 @@ bun run index.ts
 ```
 
 To use: 
+- [docs](https://ultrox.github.io/appdate/classes/AppDate.html)
+
 ```
 npm install @ma.vu/appdate
 ```

package/dist/index.cjs

@@ -0,0 +1,2 @@
+"use client";
+"use strict";var T=Object.create;var D=Object.defineProperty;var j=Object.getOwnPropertyDescriptor;var L=Object.getOwnPropertyNames;var M=Object.getPrototypeOf,S=Object.prototype.hasOwnProperty;var w=(a,t)=>{for(var e in t)D(a,e,{get:t[e],enumerable:!0})},c=(a,t,e,i)=>{if(t&&typeof t=="object"||typeof t=="function")for(let o of L(t))!S.call(a,o)&&o!==e&&D(a,o,{get:()=>t[o],enumerable:!(i=j(t,o))||i.enumerable});return a};var s=(a,t,e)=>(e=a!=null?T(M(a)):{},c(t||!a||!a.__esModule?D(e,"default",{value:a,enumerable:!0}):e,a)),Y=a=>c(D({},"__esModule",{value:!0}),a);var k={};w(k,{AppDate:()=>d,formatLocalTime:()=>b,getLocalizedDateString:()=>z,isDateString:()=>h,setAppDateLanguage:()=>O,setTimezone:()=>A});module.exports=Y(k);var r=s(require("dayjs"),1),E=require("dayjs/locale/de"),p=s(require("dayjs/plugin/customParseFormat.js"),1),l=s(require("dayjs/plugin/isBetween.js"),1),y=s(require("dayjs/plugin/localizedFormat.js"),1),f=s(require("dayjs/plugin/timezone.js"),1),g=s(require("dayjs/plugin/utc.js"),1);r.default.extend(g.default);r.default.extend(f.default);r.default.extend(p.default);r.default.extend(l.default);r.default.extend(y.default);async function O(a){switch(a){case"de":{let t=await import("dayjs/locale/de-ch");r.default.locale(t.default);break}case"fr":{let t=await import("dayjs/locale/fr-ch");r.default.locale(t.default);break}case"en":default:{let t=await import("dayjs/locale/en");r.default.locale(t.default);break}}}var n="Europe/Zurich";function A(a){n=a}var u="HH:mm",m="HH:mm:ssZ",d=class a{timezone;dayjsDate;static INVALID_DATE=(0,r.default)("");constructor(t,e,{invalid:i}={invalid:!1}){if(this.timezone=t,i){this.dayjsDate=a.INVALID_DATE;return}try{if(typeof e=="string"&&!h(e))throw new Error("Invalid Date string, we expect YYYY-DD-MM");this.dayjsDate=r.default.tz(e,t)}catch{console.warn("Could not parse date:",e),this.dayjsDate=a.INVALID_DATE}}static invalid(){return new a(n,"",{invalid:!0})}static now(){return new a(n,(0,r.default)())}static fromDateString(t){return new a(n,t)}static fromEpochSeconds(t){let e=r.default.unix(t);return new a(n,e)}static fromEpochMillis(t){let e=(0,r.default)(t);return new a(n,e)}static fromLocalTime(t){try{let e=r.default.tz(t,u,n);return new a(n,e)}catch(e){return e instanceof Error&&console.warn(`fromLocalTime(): ${e.message}`),a.invalid()}}static fromUtcString(t){let e=r.default.utc(t);return new a(n,e)}static fromUtcTime(t){let e=r.default.utc(t,m);return new a(n,e)}static minDate(){return a.fromDateString("1900-01-01")}static maxDate(){return a.fromDateString("2200-12-31")}add(t,e){let i=this.dayjsDate.add(t,e);return new a(n,i)}subtract(t,e){let i=this.dayjsDate.subtract(t,e);return new a(n,i)}startOf(t){let e=this.dayjsDate.startOf(t);return new a(n,e)}endOf(t){let e=this.dayjsDate.endOf(t);return new a(n,e)}tomorrow(){return this.add(1,"day")}isValid(){return this.dayjsDate.isValid()}isBefore(t,e){return this.dayjsDate.isBefore(t.dayjsDate,e)}isSame(t,e){return this.dayjsDate.isSame(t.dayjsDate,e)}isToday(){return this.dayjsDate.endOf("d").isSame((0,r.default)().endOf("d"))}isAfter(t,e){return this.dayjsDate.isAfter(t.dayjsDate,e)}isBetween(t=a.minDate(),e=a.maxDate(),i,o){return this.dayjsDate.isBetween(t.dayjsDate,e.dayjsDate,i,o??"[)")}isFirstDayOfWeek(){return this.dayjsDate.day()===1}isWorkingDay(){return x.includes(this.dayjsDate.day())}nextWorkingDay(){let t=this.add(1,"day");return t.isWorkingDay()?t:t.nextWorkingDay()}previousWorkingDay(){let t=this.subtract(1,"day");return t.isWorkingDay()?t:t.previousWorkingDay()}addWorkingDays(t){return t<=0||!Number.isInteger(t)?this:this.nextWorkingDay().addWorkingDays(t-1)}toLocalTime(){return this.format(u)}toUtcTime(){return this.dayjsDate.utc().format(m)}toDateString(){return this.format("YYYY-MM-DD")}toLocalizedDateString({includeDayOfWeek:t=!1}={}){let e=this.dayjsDate.format("L");return t?this.dayjsDate.format("dd, ")+e:e}toUtcDateString(){return this.dayjsDate.utc().format("YYYY-MM-DD")}toUtcString(){return this.dayjsDate.utc().format()}toEpochSeconds(){return this.dayjsDate.unix()}toEpochMillis(){return this.dayjsDate.valueOf()}format(t="YYYY-MM-DDTHH:mm:ssZ[Z]"){return this.dayjsDate.format(t)}formatShort({includeDayOfWeek:t=!0}={}){return t?this.format("dd, DD.MM."):this.format("DD.MM.")}formatDateTime({includeDayOfWeek:t=!0}={}){let e=this.toLocalizedDateString({includeDayOfWeek:t}),i=this.toLocalTime();return`${e}, ${i}`}},x=[1,2,3,4,5];function z(a,t){return d.fromDateString(a).toLocalizedDateString(t)}function b(a){return d.fromLocalTime(a).toLocalTime()}function h(a){return a?(0,r.default)(a,"YYYY-MM-DD",!0).isValid():!1}0&&(module.exports={AppDate,formatLocalTime,getLocalizedDateString,isDateString,setAppDateLanguage,setTimezone});

package/dist/index.d.cts

@@ -0,0 +1,268 @@
+import { Dayjs, ManipulateType, OpUnitType } from 'dayjs';
+
+/**
+ * Given language string, formaters, months, weeks
+ * will be localized to provided language
+ * de: 10.10.2010
+ * en: 10/10/2010
+ */
+declare function setAppDateLanguage(lang: "de" | "en" | "fr"): Promise<void>;
+/**
+ * Change zone in runtime
+ */
+declare function setTimezone(timezone: string): void;
+type DateString = `${string}-${string}-${string}`;
+/**
+ * AppDate: A timezone-aware date and time abstraction.
+ *
+ * IMPORTANT: Always use this wrapped abstraction instead of moment or
+ * new Date directly. You should not polute the application with randomly used
+ * date methods.
+ *
+ * This class wraps the dayjs library to provide a consistent interface for
+ * working with dates and times in a specific timezone. It offers methods for
+ * date manipulation, comparison, and formatting, while maintaining timezone
+ * context.
+ *
+ * Key features:
+ * - Timezone awareness: All operations respect the specified timezone.
+ * - Immutability:       Operations return new instances, preserving the original.
+ * - Consistent API:     Provides a uniform interface for date operations.
+ * - Error handling:     Gracefully handles invalid dates and parsing errors.
+ *
+ * Use AppDate to ensure consistent date handling across your application,
+ * especially when dealing with different timezones or complex date logic.
+ *
+ * @example
+ * const today = AppDate.now();
+ * const futureDate = today.add(5, 'days');
+ * console.log(futureDate.toLocalizedDateString());
+ */
+declare class AppDate {
+    readonly timezone: string;
+    readonly dayjsDate: Dayjs;
+    private static readonly INVALID_DATE;
+    /**
+     * constructor is private, so new LocalString("something")
+     * outside class is not posible
+     */
+    private constructor();
+    /**
+     * Creates an invalid AppDate instance.
+     * Usiful for: Error handeling, default values, avoids
+     * null object pattern and plays nicely with validation
+     */
+    static invalid(): AppDate;
+    static now(): AppDate;
+    /**
+     * Creates a AppDate instance from a date string.
+     *
+     * @param date - A string representing a date in "YYYY-MM-DD" format.
+     * @returns A new AppDate instance set to the given date.
+     *
+     * If the date string is invalid or cannot be parsed, it returns an invalid AppDate instance.
+     * The time part of the created AppDate will be set to midnight in the local timezone.
+     *
+     * @example
+     * const date = AppDate.fromDateString("2023-05-21");
+     */
+    static fromDateString(date: string): AppDate;
+    /**
+     * Creates a AppDate instance from a epoch seconds.
+     *
+     * @param seconds - A number representing a epoch seconds.
+     * @returns A new AppDate instance set to the given epoch seconds.
+     *
+     * @example
+     * ```typescript
+     * const date = AppDate.fromEpochSeconds(1714732800);
+     * console.log(date.toLocalizedDateString()); // "04.01.2026"
+     * ```
+     */
+    static fromEpochSeconds(seconds: number): AppDate;
+    /**
+     * Creates a AppDate instance from a epoch milliseconds.
+     *
+     * @param ms - A number representing a epoch milliseconds.
+     * @returns A new AppDate instance set to the given epoch milliseconds.
+     *
+     * @example
+     * ```typescript
+     * const date = AppDate.fromEpochMillis(1714732800000);
+     * console.log(date.toLocalizedDateString()); // "04.01.2026"
+     * ```
+    }
+    */
+    static fromEpochMillis(ms: number): AppDate;
+    /**
+     * Creates a AppDate instance from a local time string.
+     *
+     * @param time - A string representing a local time in any valid (24h) time format.
+     * @returns A new AppDate instance set to the given time on the todays date.
+     *
+     * If the time string is invalid, it returns an invalid AppDate instance.
+     * The date part defaults to the current date in the local timezone.
+     *
+     * @example
+     * const date = AppDate.fromLocalTime("14:30"); Today's date, 14:30 or (02:30 PM)
+     */
+    static fromLocalTime(time: string): AppDate;
+    /**
+     *
+     * @param date - A string representing a UTC date in "YYYY-MM-DD" format.
+     * @returns A new AppDate instance set to the given UTC date.
+     *
+     * @example
+     * const date = AppDate.fromUtcString("2026-01-04");
+     * console.log(date.toLocalizedDateString()); // "04.01.2026"
+     * ```
+     */
+    static fromUtcString(date?: string): AppDate;
+    /**
+     * Creates a AppDate instance from a UTC time string.
+     *
+     * @param time - A string representing a UTC time in "HH:mm:ssZ" format.
+     * @returns A new AppDate instance set to the given UTC time.
+     *
+     * @example
+     * const time = AppDate.fromUtcTime("14:30:00+00:00");
+     * console.log(time.toLocalizedDateString()); // "04.01.2026"
+     * ```
+     */
+    static fromUtcTime(time: string): AppDate;
+    /**
+     *
+     * @returns A new AppDate instance set to the minimum supported date (1900-01-01).
+     *
+     * @example
+     * const minDate = AppDate.minDate();
+     * console.log(minDate.toLocalizedDateString()); // "01.01.1900"
+     * ```
+     */
+    static minDate(): AppDate;
+    /**
+     * Returns the maximum supported date (2200-12-31).
+     *
+     * @returns A new AppDate instance set to the maximum supported date.
+     *
+     * @example
+     * const maxDate = AppDate.maxDate();
+     * console.log(maxDate.toLocalizedDateString()); // "31.12.2200"
+     * ```
+     */
+    static maxDate(): AppDate;
+    add(value: number, unit?: ManipulateType): AppDate;
+    subtract(value: number, unit?: ManipulateType): AppDate;
+    startOf(unit: OpUnitType): AppDate;
+    endOf(unit: OpUnitType): AppDate;
+    tomorrow(): AppDate;
+    isValid(): boolean;
+    isBefore(other: AppDate, unit?: OpUnitType): boolean;
+    isSame(other: AppDate, unit?: OpUnitType): boolean;
+    /**
+     * returns true if date is current day
+     */
+    isToday(): boolean;
+    isAfter(other: AppDate, unit?: OpUnitType): boolean;
+    isBetween(from?: AppDate, to?: AppDate, unit?: OpUnitType, inclusivity?: `${"(" | "["}${")" | "]"}`): boolean;
+    isFirstDayOfWeek(): boolean;
+    isWorkingDay(): boolean;
+    nextWorkingDay(): AppDate;
+    previousWorkingDay(): AppDate;
+    addWorkingDays(days: number): AppDate;
+    /*** Formatters ***/
+    /**
+     * Converts Date in following string format: HH:mm (20:10)
+     */
+    toLocalTime(): string;
+    /**
+     * Returns time in UTC format: HH:mm:ssZ
+     */
+    toUtcTime(): string;
+    /**
+     * Converts the current date to a string: YYYY-MM-DD
+     *
+     * @returns A string representing the current date in "YYYY-MM-DD" format.
+     *
+     * @example
+     * const date = AppDate.now();
+     * console.log(date.toDateString()); // "2026-01-04"
+     * ```
+     */
+    toDateString(): DateString;
+    /**
+     * Locale friendly format:
+     * ```
+     * de, ch = 20.10.1985
+     * us     = 10/20/1985
+     * {includeDayOfWeek: true}
+     * de, ch = Son, 20.10.1985
+     * us     = Sun, 10/20/1985
+  
+     * ```
+     */
+    toLocalizedDateString({ includeDayOfWeek, }?: LocalizedFormatOptions): string;
+    toUtcDateString(): DateString;
+    toUtcString(): string;
+    /**
+     * Converts the current date to a epoch seconds (unix timestamp).
+     *
+     * @returns The epoch seconds.
+     *
+     * @example
+     * const date = AppDate.now();
+     * console.log(date.toEpochSeconds()); // 1714732800
+     * ```
+     */
+    toEpochSeconds(): number;
+    /**
+     * Converts the current date to a epoch milliseconds (timestamp in milliseconds).
+     *
+     * @returns The epoch milliseconds.
+     *
+     * @example
+     * const date = AppDate.now();
+     * console.log(date.toEpochMillis()); // 1714732800000
+     * ```
+     */
+    toEpochMillis(): number;
+    /**
+     * Get the formatted date according to the string of tokens passed in.
+     *
+     * To escape characters, wrap them in square brackets (e.g. [MM]).
+     *
+     * @see {@link https://day.js.org/docs/en/display/format|Day.js format documentation}
+     *
+     */
+    format(template?: FormatTemplate): string;
+    /**
+     *
+     * @param options - Optional settings for short formatting.
+     * @returns The short formatted date string.
+     *
+     * @example
+     * const date = AppDate.now();
+     * console.log(date.formatShort({ includeDayOfWeek: true })); // "Su, 04.01."
+     * console.log(date.formatShort({ includeDayOfWeek: false })); // "04.01."
+     * ```
+     */
+    formatShort({ includeDayOfWeek }?: LocalizedFormatOptions): string;
+    formatDateTime({ includeDayOfWeek }?: LocalizedFormatOptions): string;
+}
+interface LocalizedFormatOptions {
+    includeDayOfWeek?: boolean;
+}
+interface GetNDaysOptions {
+    startDate?: AppDate;
+    excludeStartDate?: boolean;
+}
+declare function getLocalizedDateString(date: string, options?: LocalizedFormatOptions): string;
+declare function formatLocalTime(time: string): string;
+/**
+ * returns true if given argument is in YYYY-MM-DD format
+ * otherwise false
+ */
+declare function isDateString(date: string | undefined | null | Dayjs): date is DateString;
+type FormatTemplate = "YY" | "YYYY" | "M" | "MM" | "MMM" | "MMMM" | "D" | "DD" | "d" | "dd" | "ddd" | "dddd" | "H" | "HH" | "h" | "hh" | "m" | "mm" | "s" | "ss" | "SSS" | "Z" | "ZZ" | "A" | "a" | "LT" | "LTS" | /* en: 10/10/2020, de: 10.10.2020 */ "L" | "LL" | "LLL" | "LLLL" | "l" | "ll" | "lll" | "llll" | (string & {});
+
+export { AppDate, type GetNDaysOptions, type LocalizedFormatOptions, formatLocalTime, getLocalizedDateString, isDateString, setAppDateLanguage, setTimezone };

package/dist/index.d.ts

@@ -0,0 +1,268 @@
+import { Dayjs, ManipulateType, OpUnitType } from 'dayjs';
+
+/**
+ * Given language string, formaters, months, weeks
+ * will be localized to provided language
+ * de: 10.10.2010
+ * en: 10/10/2010
+ */
+declare function setAppDateLanguage(lang: "de" | "en" | "fr"): Promise<void>;
+/**
+ * Change zone in runtime
+ */
+declare function setTimezone(timezone: string): void;
+type DateString = `${string}-${string}-${string}`;
+/**
+ * AppDate: A timezone-aware date and time abstraction.
+ *
+ * IMPORTANT: Always use this wrapped abstraction instead of moment or
+ * new Date directly. You should not polute the application with randomly used
+ * date methods.
+ *
+ * This class wraps the dayjs library to provide a consistent interface for
+ * working with dates and times in a specific timezone. It offers methods for
+ * date manipulation, comparison, and formatting, while maintaining timezone
+ * context.
+ *
+ * Key features:
+ * - Timezone awareness: All operations respect the specified timezone.
+ * - Immutability:       Operations return new instances, preserving the original.
+ * - Consistent API:     Provides a uniform interface for date operations.
+ * - Error handling:     Gracefully handles invalid dates and parsing errors.
+ *
+ * Use AppDate to ensure consistent date handling across your application,
+ * especially when dealing with different timezones or complex date logic.
+ *
+ * @example
+ * const today = AppDate.now();
+ * const futureDate = today.add(5, 'days');
+ * console.log(futureDate.toLocalizedDateString());
+ */
+declare class AppDate {
+    readonly timezone: string;
+    readonly dayjsDate: Dayjs;
+    private static readonly INVALID_DATE;
+    /**
+     * constructor is private, so new LocalString("something")
+     * outside class is not posible
+     */
+    private constructor();
+    /**
+     * Creates an invalid AppDate instance.
+     * Usiful for: Error handeling, default values, avoids
+     * null object pattern and plays nicely with validation
+     */
+    static invalid(): AppDate;
+    static now(): AppDate;
+    /**
+     * Creates a AppDate instance from a date string.
+     *
+     * @param date - A string representing a date in "YYYY-MM-DD" format.
+     * @returns A new AppDate instance set to the given date.
+     *
+     * If the date string is invalid or cannot be parsed, it returns an invalid AppDate instance.
+     * The time part of the created AppDate will be set to midnight in the local timezone.
+     *
+     * @example
+     * const date = AppDate.fromDateString("2023-05-21");
+     */
+    static fromDateString(date: string): AppDate;
+    /**
+     * Creates a AppDate instance from a epoch seconds.
+     *
+     * @param seconds - A number representing a epoch seconds.
+     * @returns A new AppDate instance set to the given epoch seconds.
+     *
+     * @example
+     * ```typescript
+     * const date = AppDate.fromEpochSeconds(1714732800);
+     * console.log(date.toLocalizedDateString()); // "04.01.2026"
+     * ```
+     */
+    static fromEpochSeconds(seconds: number): AppDate;
+    /**
+     * Creates a AppDate instance from a epoch milliseconds.
+     *
+     * @param ms - A number representing a epoch milliseconds.
+     * @returns A new AppDate instance set to the given epoch milliseconds.
+     *
+     * @example
+     * ```typescript
+     * const date = AppDate.fromEpochMillis(1714732800000);
+     * console.log(date.toLocalizedDateString()); // "04.01.2026"
+     * ```
+    }
+    */
+    static fromEpochMillis(ms: number): AppDate;
+    /**
+     * Creates a AppDate instance from a local time string.
+     *
+     * @param time - A string representing a local time in any valid (24h) time format.
+     * @returns A new AppDate instance set to the given time on the todays date.
+     *
+     * If the time string is invalid, it returns an invalid AppDate instance.
+     * The date part defaults to the current date in the local timezone.
+     *
+     * @example
+     * const date = AppDate.fromLocalTime("14:30"); Today's date, 14:30 or (02:30 PM)
+     */
+    static fromLocalTime(time: string): AppDate;
+    /**
+     *
+     * @param date - A string representing a UTC date in "YYYY-MM-DD" format.
+     * @returns A new AppDate instance set to the given UTC date.
+     *
+     * @example
+     * const date = AppDate.fromUtcString("2026-01-04");
+     * console.log(date.toLocalizedDateString()); // "04.01.2026"
+     * ```
+     */
+    static fromUtcString(date?: string): AppDate;
+    /**
+     * Creates a AppDate instance from a UTC time string.
+     *
+     * @param time - A string representing a UTC time in "HH:mm:ssZ" format.
+     * @returns A new AppDate instance set to the given UTC time.
+     *
+     * @example
+     * const time = AppDate.fromUtcTime("14:30:00+00:00");
+     * console.log(time.toLocalizedDateString()); // "04.01.2026"
+     * ```
+     */
+    static fromUtcTime(time: string): AppDate;
+    /**
+     *
+     * @returns A new AppDate instance set to the minimum supported date (1900-01-01).
+     *
+     * @example
+     * const minDate = AppDate.minDate();
+     * console.log(minDate.toLocalizedDateString()); // "01.01.1900"
+     * ```
+     */
+    static minDate(): AppDate;
+    /**
+     * Returns the maximum supported date (2200-12-31).
+     *
+     * @returns A new AppDate instance set to the maximum supported date.
+     *
+     * @example
+     * const maxDate = AppDate.maxDate();
+     * console.log(maxDate.toLocalizedDateString()); // "31.12.2200"
+     * ```
+     */
+    static maxDate(): AppDate;
+    add(value: number, unit?: ManipulateType): AppDate;
+    subtract(value: number, unit?: ManipulateType): AppDate;
+    startOf(unit: OpUnitType): AppDate;
+    endOf(unit: OpUnitType): AppDate;
+    tomorrow(): AppDate;
+    isValid(): boolean;
+    isBefore(other: AppDate, unit?: OpUnitType): boolean;
+    isSame(other: AppDate, unit?: OpUnitType): boolean;
+    /**
+     * returns true if date is current day
+     */
+    isToday(): boolean;
+    isAfter(other: AppDate, unit?: OpUnitType): boolean;
+    isBetween(from?: AppDate, to?: AppDate, unit?: OpUnitType, inclusivity?: `${"(" | "["}${")" | "]"}`): boolean;
+    isFirstDayOfWeek(): boolean;
+    isWorkingDay(): boolean;
+    nextWorkingDay(): AppDate;
+    previousWorkingDay(): AppDate;
+    addWorkingDays(days: number): AppDate;
+    /*** Formatters ***/
+    /**
+     * Converts Date in following string format: HH:mm (20:10)
+     */
+    toLocalTime(): string;
+    /**
+     * Returns time in UTC format: HH:mm:ssZ
+     */
+    toUtcTime(): string;
+    /**
+     * Converts the current date to a string: YYYY-MM-DD
+     *
+     * @returns A string representing the current date in "YYYY-MM-DD" format.
+     *
+     * @example
+     * const date = AppDate.now();
+     * console.log(date.toDateString()); // "2026-01-04"
+     * ```
+     */
+    toDateString(): DateString;
+    /**
+     * Locale friendly format:
+     * ```
+     * de, ch = 20.10.1985
+     * us     = 10/20/1985
+     * {includeDayOfWeek: true}
+     * de, ch = Son, 20.10.1985
+     * us     = Sun, 10/20/1985
+  
+     * ```
+     */
+    toLocalizedDateString({ includeDayOfWeek, }?: LocalizedFormatOptions): string;
+    toUtcDateString(): DateString;
+    toUtcString(): string;
+    /**
+     * Converts the current date to a epoch seconds (unix timestamp).
+     *
+     * @returns The epoch seconds.
+     *
+     * @example
+     * const date = AppDate.now();
+     * console.log(date.toEpochSeconds()); // 1714732800
+     * ```
+     */
+    toEpochSeconds(): number;
+    /**
+     * Converts the current date to a epoch milliseconds (timestamp in milliseconds).
+     *
+     * @returns The epoch milliseconds.
+     *
+     * @example
+     * const date = AppDate.now();
+     * console.log(date.toEpochMillis()); // 1714732800000
+     * ```
+     */
+    toEpochMillis(): number;
+    /**
+     * Get the formatted date according to the string of tokens passed in.
+     *
+     * To escape characters, wrap them in square brackets (e.g. [MM]).
+     *
+     * @see {@link https://day.js.org/docs/en/display/format|Day.js format documentation}
+     *
+     */
+    format(template?: FormatTemplate): string;
+    /**
+     *
+     * @param options - Optional settings for short formatting.
+     * @returns The short formatted date string.
+     *
+     * @example
+     * const date = AppDate.now();
+     * console.log(date.formatShort({ includeDayOfWeek: true })); // "Su, 04.01."
+     * console.log(date.formatShort({ includeDayOfWeek: false })); // "04.01."
+     * ```
+     */
+    formatShort({ includeDayOfWeek }?: LocalizedFormatOptions): string;
+    formatDateTime({ includeDayOfWeek }?: LocalizedFormatOptions): string;
+}
+interface LocalizedFormatOptions {
+    includeDayOfWeek?: boolean;
+}
+interface GetNDaysOptions {
+    startDate?: AppDate;
+    excludeStartDate?: boolean;
+}
+declare function getLocalizedDateString(date: string, options?: LocalizedFormatOptions): string;
+declare function formatLocalTime(time: string): string;
+/**
+ * returns true if given argument is in YYYY-MM-DD format
+ * otherwise false
+ */
+declare function isDateString(date: string | undefined | null | Dayjs): date is DateString;
+type FormatTemplate = "YY" | "YYYY" | "M" | "MM" | "MMM" | "MMMM" | "D" | "DD" | "d" | "dd" | "ddd" | "dddd" | "H" | "HH" | "h" | "hh" | "m" | "mm" | "s" | "ss" | "SSS" | "Z" | "ZZ" | "A" | "a" | "LT" | "LTS" | /* en: 10/10/2020, de: 10.10.2020 */ "L" | "LL" | "LLL" | "LLLL" | "l" | "ll" | "lll" | "llll" | (string & {});
+
+export { AppDate, type GetNDaysOptions, type LocalizedFormatOptions, formatLocalTime, getLocalizedDateString, isDateString, setAppDateLanguage, setTimezone };

package/dist/index.js

@@ -0,0 +1,2 @@
+"use client";
+import r from"dayjs";import"dayjs/locale/de";import c from"dayjs/plugin/customParseFormat.js";import u from"dayjs/plugin/isBetween.js";import m from"dayjs/plugin/localizedFormat.js";import p from"dayjs/plugin/timezone.js";import l from"dayjs/plugin/utc.js";r.extend(l);r.extend(p);r.extend(c);r.extend(u);r.extend(m);async function w(a){switch(a){case"de":{let t=await import("dayjs/locale/de-ch");r.locale(t.default);break}case"fr":{let t=await import("dayjs/locale/fr-ch");r.locale(t.default);break}case"en":default:{let t=await import("dayjs/locale/en");r.locale(t.default);break}}}var n="Europe/Zurich";function Y(a){n=a}var d="HH:mm",D="HH:mm:ssZ",s=class a{timezone;dayjsDate;static INVALID_DATE=r("");constructor(t,e,{invalid:i}={invalid:!1}){if(this.timezone=t,i){this.dayjsDate=a.INVALID_DATE;return}try{if(typeof e=="string"&&!f(e))throw new Error("Invalid Date string, we expect YYYY-DD-MM");this.dayjsDate=r.tz(e,t)}catch{console.warn("Could not parse date:",e),this.dayjsDate=a.INVALID_DATE}}static invalid(){return new a(n,"",{invalid:!0})}static now(){return new a(n,r())}static fromDateString(t){return new a(n,t)}static fromEpochSeconds(t){let e=r.unix(t);return new a(n,e)}static fromEpochMillis(t){let e=r(t);return new a(n,e)}static fromLocalTime(t){try{let e=r.tz(t,d,n);return new a(n,e)}catch(e){return e instanceof Error&&console.warn(`fromLocalTime(): ${e.message}`),a.invalid()}}static fromUtcString(t){let e=r.utc(t);return new a(n,e)}static fromUtcTime(t){let e=r.utc(t,D);return new a(n,e)}static minDate(){return a.fromDateString("1900-01-01")}static maxDate(){return a.fromDateString("2200-12-31")}add(t,e){let i=this.dayjsDate.add(t,e);return new a(n,i)}subtract(t,e){let i=this.dayjsDate.subtract(t,e);return new a(n,i)}startOf(t){let e=this.dayjsDate.startOf(t);return new a(n,e)}endOf(t){let e=this.dayjsDate.endOf(t);return new a(n,e)}tomorrow(){return this.add(1,"day")}isValid(){return this.dayjsDate.isValid()}isBefore(t,e){return this.dayjsDate.isBefore(t.dayjsDate,e)}isSame(t,e){return this.dayjsDate.isSame(t.dayjsDate,e)}isToday(){return this.dayjsDate.endOf("d").isSame(r().endOf("d"))}isAfter(t,e){return this.dayjsDate.isAfter(t.dayjsDate,e)}isBetween(t=a.minDate(),e=a.maxDate(),i,o){return this.dayjsDate.isBetween(t.dayjsDate,e.dayjsDate,i,o??"[)")}isFirstDayOfWeek(){return this.dayjsDate.day()===1}isWorkingDay(){return y.includes(this.dayjsDate.day())}nextWorkingDay(){let t=this.add(1,"day");return t.isWorkingDay()?t:t.nextWorkingDay()}previousWorkingDay(){let t=this.subtract(1,"day");return t.isWorkingDay()?t:t.previousWorkingDay()}addWorkingDays(t){return t<=0||!Number.isInteger(t)?this:this.nextWorkingDay().addWorkingDays(t-1)}toLocalTime(){return this.format(d)}toUtcTime(){return this.dayjsDate.utc().format(D)}toDateString(){return this.format("YYYY-MM-DD")}toLocalizedDateString({includeDayOfWeek:t=!1}={}){let e=this.dayjsDate.format("L");return t?this.dayjsDate.format("dd, ")+e:e}toUtcDateString(){return this.dayjsDate.utc().format("YYYY-MM-DD")}toUtcString(){return this.dayjsDate.utc().format()}toEpochSeconds(){return this.dayjsDate.unix()}toEpochMillis(){return this.dayjsDate.valueOf()}format(t="YYYY-MM-DDTHH:mm:ssZ[Z]"){return this.dayjsDate.format(t)}formatShort({includeDayOfWeek:t=!0}={}){return t?this.format("dd, DD.MM."):this.format("DD.MM.")}formatDateTime({includeDayOfWeek:t=!0}={}){let e=this.toLocalizedDateString({includeDayOfWeek:t}),i=this.toLocalTime();return`${e}, ${i}`}},y=[1,2,3,4,5];function O(a,t){return s.fromDateString(a).toLocalizedDateString(t)}function A(a){return s.fromLocalTime(a).toLocalTime()}function f(a){return a?r(a,"YYYY-MM-DD",!0).isValid():!1}export{s as AppDate,A as formatLocalTime,O as getLocalizedDateString,f as isDateString,w as setAppDateLanguage,Y as setTimezone};

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.0.6",
+  "version": "0.0.8",
   "name": "@ma.vu/appdate",
   "private": false,
   "main": "dist/index.js",
@@ -22,7 +22,9 @@
   "scripts": {
     "build": "tsup",
     "test": "bun test",
-    "docs": "typedoc src/index.ts"
+    "docs": "typedoc src/index.ts",
+    "bump": "npm version patch",
+    "prepublishOnly": "bun run build && bun run docs"
   },
   "devDependencies": {
     "bun-types": "latest",