@arsedizioni/ars-utils 22.6.85 → 22.6.88

package/types/arsedizioni-ars-utils-core.date.d.ts

@@ -1,194 +1,193 @@
-import * as i0 from '@angular/core';
-import { EnvironmentProviders, InjectionToken } from '@angular/core';
-import { DateAdapter, MatDateFormats } from '@angular/material/core';
-import { Locale } from 'date-fns';
-import { HttpInterceptor, HttpRequest, HttpHandler, HttpEvent, HttpInterceptorFn } from '@angular/common/http';
-import { Observable } from 'rxjs';
-
-declare const MAT_DATE_FNS_FORMATS: MatDateFormats;
+import * as i0 from "@angular/core";
+import { EnvironmentProviders, InjectionToken } from "@angular/core";
+import { DateAdapter, MatDateFormats } from "@angular/material/core";
+import { Locale } from "date-fns";
+import { HttpEvent, HttpHandler, HttpInterceptor, HttpInterceptorFn, HttpRequest } from "@angular/common/http";
+import { Observable } from "rxjs";
+export declare const MAT_DATE_FNS_FORMATS: MatDateFormats;
 /**
  * date-fns adapter that integrates Angular Material's date picker with the date-fns library,
  * applying `Europe/Rome` timezone for all parsed and created dates.
  */
-declare class DateFnsAdapter extends DateAdapter<Date, Locale> {
-    constructor();
-    /**
-     * Wraps a date/instant into a Europe/Rome TZDate whose JSON serialisation emits a
-     * naive local datetime string ("yyyy-MM-dd'T'HH:mm:ss") instead of a UTC instant,
-     * so the wall-clock value the user entered is preserved end-to-end (no timezone shift).
-     * @param value - The source Date or Unix timestamp in milliseconds.
-     * @returns a Europe/Rome TZDate whose toJSON yields a naive local datetime string.
-     */
-    private static toLocal;
-    /**
-     * Returns the year component of the given date.
-     * @param date - The source date.
-     */
-    getYear(date: Date): number;
-    /**
-     * Returns the zero-based month index of the given date (0 = January).
-     * @param date - The source date.
-     */
-    getMonth(date: Date): number;
-    /**
-     * Returns the day-of-month of the given date (1-based).
-     * @param date - The source date.
-     */
-    getDate(date: Date): number;
-    /**
-     * Returns the day-of-week of the given date (0 = Sunday).
-     * @param date - The source date.
-     */
-    getDayOfWeek(date: Date): number;
-    /**
-     * Returns an array of 12 month name strings formatted for the active locale.
-     * @param style - One of `'long'`, `'short'`, or `'narrow'`.
-     */
-    getMonthNames(style: 'long' | 'short' | 'narrow'): string[];
-    /**
-     * Returns an array of 31 day-of-month label strings formatted using `Intl.DateTimeFormat`
-     * when available, falling back to plain numeric strings.
-     */
-    getDateNames(): string[];
-    /**
-     * Returns an array of 7 day-of-week name strings formatted for the active locale.
-     * @param style - One of `'long'`, `'short'`, or `'narrow'`.
-     */
-    getDayOfWeekNames(style: 'long' | 'short' | 'narrow'): string[];
-    /**
-     * Returns the four-digit year string for the given date.
-     * @param date - The source date.
-     */
-    getYearName(date: Date): string;
-    /**
-     * Returns the first day of the week for the active locale (0 = Sunday, 1 = Monday, …).
-     */
-    getFirstDayOfWeek(): number;
-    /**
-     * Returns the number of days in the month of the given date.
-     * @param date - The source date.
-     */
-    getNumDaysInMonth(date: Date): number;
-    /**
-     * Creates an independent copy of the given date.
-     * @param date - The date to clone.
-     */
-    clone(date: Date): Date;
-    /**
-     * Creates a `Date` in the `Europe/Rome` timezone for the given year, month, and day.
-     * Throws an `Error` when any component is out of range.
-     * @param year  - Full four-digit year.
-     * @param month - Zero-based month index (0 = January, 11 = December).
-     * @param date  - Day-of-month (1-based).
-     */
-    createDate(year: number, month: number, date: number): Date;
-    /**
-     * Returns the current date and time in the Europe/Rome timezone, preserving the wall-clock value.
-     */
-    today(): Date;
-    /**
-     * Parses a value into a `Date`.
-     * - Strings are first attempted as ISO 8601, then matched against each format in `parseFormat`.
-     * - Numbers are treated as Unix timestamps (milliseconds).
-     * - Existing `Date` instances are cloned.
-     * @param value       - The value to parse.
-     * @param parseFormat - A format string or an array of format strings (date-fns tokens).
-     * @returns A valid `Date` in `Europe/Rome`, an invalid sentinel, or `null` for unrecognised input.
-     */
-    parse(value: unknown, parseFormat: string | string[]): Date | null;
-    /**
-     * Formats a `Date` using the given date-fns display format string.
-     * Throws an `Error` when `date` is not valid.
-     * @param date          - The date to format.
-     * @param displayFormat - A date-fns format string (e.g. `'P'`, `'LLL uuuu'`).
-     */
-    format(date: Date, displayFormat: string): string;
-    /**
-     * Adds the given number of whole years to a date.
-     * @param date  - The base date.
-     * @param years - Number of years to add (can be negative).
-     */
-    addCalendarYears(date: Date, years: number): Date;
-    /**
-     * Adds the given number of whole months to a date.
-     * @param date   - The base date.
-     * @param months - Number of months to add (can be negative).
-     */
-    addCalendarMonths(date: Date, months: number): Date;
-    /**
-     * Adds the given number of whole days to a date.
-     * @param date - The base date.
-     * @param days - Number of days to add (can be negative).
-     */
-    addCalendarDays(date: Date, days: number): Date;
-    /**
-     * Serialises a date to an ISO 8601 date-only string (`yyyy-MM-dd`) using its Europe/Rome calendar day,
-     * independent of the browser timezone.
-     * @param date - The date to serialise.
-     * @returns the yyyy-MM-dd string for the date in Europe/Rome.
-     */
-    toIso8601(date: Date): string;
-    /**
-     * Returns the given value when it is a valid `Date`, or `null` for an empty string.
-     * Deserialises valid ISO 8601 strings into `Date` instances.
-     * Delegates all other values to the base-class implementation.
-     * @param value - The raw value to deserialise.
-     */
-    deserialize(value: unknown): Date | null;
-    /**
-     * Returns `true` when `obj` is an instance of `Date`.
-     * @param obj - The object to test.
-     */
-    isDateInstance(obj: unknown): boolean;
-    /**
-     * Returns `true` when `date` represents a valid point in time.
-     * @param date - The date to validate.
-     */
-    isValid(date: Date): boolean;
-    /**
-     * Returns a sentinel `Date` that represents an invalid date (`new Date(NaN)`).
-     */
-    invalid(): Date;
-    /**
-     * Returns the hours component (0-23) of the given date.
-     * @param date - The source date.
-     */
-    getHours(date: Date): number;
-    /**
-     * Returns the minutes component (0-59) of the given date.
-     * @param date - The source date.
-     */
-    getMinutes(date: Date): number;
-    /**
-     * Returns the seconds component (0-59) of the given date.
-     * @param date - The source date.
-     */
-    getSeconds(date: Date): number;
-    /**
-     * Returns a clone of `target` with its time-of-day set to the given hours/minutes/seconds,
-     * keeping the date part unchanged.
-     * @param target  - The date whose time should be set.
-     * @param hours   - New hours (0-23).
-     * @param minutes - New minutes (0-59).
-     * @param seconds - New seconds (0-59).
-     */
-    setTime(target: Date, hours: number, minutes: number, seconds: number): Date;
-    /**
-     * Adds the given number of seconds to a date.
-     * @param date   - The base date.
-     * @param amount - Number of seconds to add (can be negative).
-     */
-    addSeconds(date: Date, amount: number): Date;
-    /**
-     * Parses a time-only value into a `Date` (today's date, in `Europe/Rome`, with the parsed
-     * time-of-day set). The wall-clock time is preserved exactly as entered.
-     * @param value       - The value to parse (a string, or an existing `Date`).
-     * @param parseFormat - A format string or an array of format strings (date-fns tokens).
-     * @returns the parsed Date, an invalid sentinel, or null for unrecognised input.
-     */
-    parseTime(value: unknown, parseFormat: string | string[]): Date | null;
-    static ɵfac: i0.ɵɵFactoryDeclaration<DateFnsAdapter, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<any>;
+export declare class DateFnsAdapter extends DateAdapter<Date, Locale> {
+  constructor();
+  /**
+   * Wraps a date/instant into a Europe/Rome TZDate whose JSON serialisation emits a
+   * naive local datetime string ("yyyy-MM-dd'T'HH:mm:ss") instead of a UTC instant,
+   * so the wall-clock value the user entered is preserved end-to-end (no timezone shift).
+   * @param value - The source Date or Unix timestamp in milliseconds.
+   * @returns a Europe/Rome TZDate whose toJSON yields a naive local datetime string.
+   */
+  private static toLocal;
+  /**
+   * Returns the year component of the given date.
+   * @param date - The source date.
+   */
+  getYear(date: Date): number;
+  /**
+   * Returns the zero-based month index of the given date (0 = January).
+   * @param date - The source date.
+   */
+  getMonth(date: Date): number;
+  /**
+   * Returns the day-of-month of the given date (1-based).
+   * @param date - The source date.
+   */
+  getDate(date: Date): number;
+  /**
+   * Returns the day-of-week of the given date (0 = Sunday).
+   * @param date - The source date.
+   */
+  getDayOfWeek(date: Date): number;
+  /**
+   * Returns an array of 12 month name strings formatted for the active locale.
+   * @param style - One of `'long'`, `'short'`, or `'narrow'`.
+   */
+  getMonthNames(style: 'long' | 'short' | 'narrow'): string[];
+  /**
+   * Returns an array of 31 day-of-month label strings formatted using `Intl.DateTimeFormat`
+   * when available, falling back to plain numeric strings.
+   */
+  getDateNames(): string[];
+  /**
+   * Returns an array of 7 day-of-week name strings formatted for the active locale.
+   * @param style - One of `'long'`, `'short'`, or `'narrow'`.
+   */
+  getDayOfWeekNames(style: 'long' | 'short' | 'narrow'): string[];
+  /**
+   * Returns the four-digit year string for the given date.
+   * @param date - The source date.
+   */
+  getYearName(date: Date): string;
+  /**
+   * Returns the first day of the week for the active locale (0 = Sunday, 1 = Monday, …).
+   */
+  getFirstDayOfWeek(): number;
+  /**
+   * Returns the number of days in the month of the given date.
+   * @param date - The source date.
+   */
+  getNumDaysInMonth(date: Date): number;
+  /**
+   * Creates an independent copy of the given date.
+   * @param date - The date to clone.
+   */
+  clone(date: Date): Date;
+  /**
+   * Creates a `Date` in the `Europe/Rome` timezone for the given year, month, and day.
+   * Throws an `Error` when any component is out of range.
+   * @param year  - Full four-digit year.
+   * @param month - Zero-based month index (0 = January, 11 = December).
+   * @param date  - Day-of-month (1-based).
+   */
+  createDate(year: number, month: number, date: number): Date;
+  /**
+   * Returns the current date and time in the Europe/Rome timezone, preserving the wall-clock value.
+   */
+  today(): Date;
+  /**
+   * Parses a value into a `Date`.
+   * - Strings are first attempted as ISO 8601, then matched against each format in `parseFormat`.
+   * - Numbers are treated as Unix timestamps (milliseconds).
+   * - Existing `Date` instances are cloned.
+   * @param value       - The value to parse.
+   * @param parseFormat - A format string or an array of format strings (date-fns tokens).
+   * @returns A valid `Date` in `Europe/Rome`, an invalid sentinel, or `null` for unrecognised input.
+   */
+  parse(value: unknown, parseFormat: string | string[]): Date | null;
+  /**
+   * Formats a `Date` using the given date-fns display format string.
+   * Throws an `Error` when `date` is not valid.
+   * @param date          - The date to format.
+   * @param displayFormat - A date-fns format string (e.g. `'P'`, `'LLL uuuu'`).
+   */
+  format(date: Date, displayFormat: string): string;
+  /**
+   * Adds the given number of whole years to a date.
+   * @param date  - The base date.
+   * @param years - Number of years to add (can be negative).
+   */
+  addCalendarYears(date: Date, years: number): Date;
+  /**
+   * Adds the given number of whole months to a date.
+   * @param date   - The base date.
+   * @param months - Number of months to add (can be negative).
+   */
+  addCalendarMonths(date: Date, months: number): Date;
+  /**
+   * Adds the given number of whole days to a date.
+   * @param date - The base date.
+   * @param days - Number of days to add (can be negative).
+   */
+  addCalendarDays(date: Date, days: number): Date;
+  /**
+   * Serialises a date to an ISO 8601 date-only string (`yyyy-MM-dd`) using its Europe/Rome calendar day,
+   * independent of the browser timezone.
+   * @param date - The date to serialise.
+   * @returns the yyyy-MM-dd string for the date in Europe/Rome.
+   */
+  toIso8601(date: Date): string;
+  /**
+   * Returns the given value when it is a valid `Date`, or `null` for an empty string.
+   * Deserialises valid ISO 8601 strings into `Date` instances.
+   * Delegates all other values to the base-class implementation.
+   * @param value - The raw value to deserialise.
+   */
+  deserialize(value: unknown): Date | null;
+  /**
+   * Returns `true` when `obj` is an instance of `Date`.
+   * @param obj - The object to test.
+   */
+  isDateInstance(obj: unknown): boolean;
+  /**
+   * Returns `true` when `date` represents a valid point in time.
+   * @param date - The date to validate.
+   */
+  isValid(date: Date): boolean;
+  /**
+   * Returns a sentinel `Date` that represents an invalid date (`new Date(NaN)`).
+   */
+  invalid(): Date;
+  /**
+   * Returns the hours component (0-23) of the given date.
+   * @param date - The source date.
+   */
+  getHours(date: Date): number;
+  /**
+   * Returns the minutes component (0-59) of the given date.
+   * @param date - The source date.
+   */
+  getMinutes(date: Date): number;
+  /**
+   * Returns the seconds component (0-59) of the given date.
+   * @param date - The source date.
+   */
+  getSeconds(date: Date): number;
+  /**
+   * Returns a clone of `target` with its time-of-day set to the given hours/minutes/seconds,
+   * keeping the date part unchanged.
+   * @param target  - The date whose time should be set.
+   * @param hours   - New hours (0-23).
+   * @param minutes - New minutes (0-59).
+   * @param seconds - New seconds (0-59).
+   */
+  setTime(target: Date, hours: number, minutes: number, seconds: number): Date;
+  /**
+   * Adds the given number of seconds to a date.
+   * @param date   - The base date.
+   * @param amount - Number of seconds to add (can be negative).
+   */
+  addSeconds(date: Date, amount: number): Date;
+  /**
+   * Parses a time-only value into a `Date` (today's date, in `Europe/Rome`, with the parsed
+   * time-of-day set). The wall-clock time is preserved exactly as entered.
+   * @param value       - The value to parse (a string, or an existing `Date`).
+   * @param parseFormat - A format string or an array of format strings (date-fns tokens).
+   * @returns the parsed Date, an invalid sentinel, or null for unrecognised input.
+   */
+  parseTime(value: unknown, parseFormat: string | string[]): Date | null;
+  static ɵfac: i0.ɵɵFactoryDeclaration<DateFnsAdapter, never>;
+  static ɵprov: i0.ɵɵInjectableDeclaration<any>;
 }
 /**
  * Standalone providers for the ARS date-fns adapter.
@@ -202,16 +201,15 @@ declare class DateFnsAdapter extends DateAdapter<Date, Locale> {
  *   providers: [provideArsDateFns()]
  * });
  */
-declare function provideArsDateFns(): EnvironmentProviders;
-
+export declare function provideArsDateFns(): EnvironmentProviders;
 /** Default application timezone: all dates are serialised as Europe/Rome wall-clock values. */
-declare const DEFAULT_TIME_ZONE = "Europe/Rome";
+export declare const DEFAULT_TIME_ZONE = "Europe/Rome";
 /**
  * IANA timezone used to serialise dates towards the backend.
  * Override it in the application providers to run the same code in another zone:
  * `{ provide: ARS_TIME_ZONE, useValue: 'Europe/Zurich' }`.
  */
-declare const ARS_TIME_ZONE: InjectionToken<string>;
+export declare const ARS_TIME_ZONE: InjectionToken<string>;
 /**
  * Functional interceptor that closes the date serialisation boundary of the application, in both
  * directions: it writes the dates of every request and reads back those of every response.
@@ -250,7 +248,7 @@ declare const ARS_TIME_ZONE: InjectionToken<string>;
  *   evolutionAuthInterceptor(...),
  * ]));
  */
-declare const arsLocalDateInterceptor: HttpInterceptorFn;
+export declare const arsLocalDateInterceptor: HttpInterceptorFn;
 /**
  * Class-based twin of {@link arsLocalDateInterceptor}.
  *
@@ -264,17 +262,17 @@ declare const arsLocalDateInterceptor: HttpInterceptorFn;
  * without it Angular never reads `HTTP_INTERCEPTORS` and this interceptor is
  * silently skipped.
  */
-declare class ArsLocalDateInterceptor implements HttpInterceptor {
-    private readonly timeZone;
-    /**
-     * Normalises the dates of the request and revives those of the response.
-     * @param req  - The outgoing request.
-     * @param next - The next handler in the chain.
-     * @returns The stream of events, with the dates of the response body revived.
-     */
-    intercept(req: HttpRequest<unknown>, next: HttpHandler): Observable<HttpEvent<unknown>>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ArsLocalDateInterceptor, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<any>;
+export declare class ArsLocalDateInterceptor implements HttpInterceptor {
+  private readonly timeZone;
+  /**
+   * Normalises the dates of the request and revives those of the response.
+   * @param req  - The outgoing request.
+   * @param next - The next handler in the chain.
+   * @returns The stream of events, with the dates of the response body revived.
+   */
+  intercept(req: HttpRequest<unknown>, next: HttpHandler): Observable<HttpEvent<unknown>>;
+  static ɵfac: i0.ɵɵFactoryDeclaration<ArsLocalDateInterceptor, never>;
+  static ɵprov: i0.ɵɵInjectableDeclaration<any>;
 }
 /**
  * Standalone providers for date conversion towards and from the backend.
@@ -295,7 +293,7 @@ declare class ArsLocalDateInterceptor implements HttpInterceptor {
  *   provideHttpClient(withInterceptors([evolutionAuthInterceptor(...)]), withInterceptorsFromDi()),
  * ]
  */
-declare function provideArsLocalDates(timeZone?: string): EnvironmentProviders;
+export declare function provideArsLocalDates(timeZone?: string): EnvironmentProviders;
 /**
  * Formats a date as a date-only ISO string (`yyyy-MM-dd`) using its wall-clock
  * calendar day in the given timezone. Use it for query-string parameters and for
@@ -305,7 +303,7 @@ declare function provideArsLocalDates(timeZone?: string): EnvironmentProviders;
  * @param timeZone - IANA timezone name (default: `Europe/Rome`).
  * @returns The `yyyy-MM-dd` string, or `undefined` for empty/invalid input.
  */
-declare function toLocalDateOnlyString(value?: Date | null, timeZone?: string): string | undefined;
+export declare function toLocalDateOnlyString(value?: Date | null, timeZone?: string): string | undefined;
 /**
  * Formats a date as a naive local datetime string (`yyyy-MM-ddTHH:mm:ss`), the
  * same representation produced by the interceptor. Useful for query-string
@@ -315,6 +313,4 @@ declare function toLocalDateOnlyString(value?: Date | null, timeZone?: string):
  * @param timeZone - IANA timezone name (default: `Europe/Rome`).
  * @returns The naive datetime string, or `undefined` for empty/invalid input.
  */
-declare function toLocalDateTimeString(value?: Date | null, timeZone?: string): string | undefined;
-
-export { ARS_TIME_ZONE, ArsLocalDateInterceptor, DEFAULT_TIME_ZONE, DateFnsAdapter, MAT_DATE_FNS_FORMATS, arsLocalDateInterceptor, provideArsDateFns, provideArsLocalDates, toLocalDateOnlyString, toLocalDateTimeString };
+export declare function toLocalDateTimeString(value?: Date | null, timeZone?: string): string | undefined;