@mappedin/viewer 0.35.2-3613294.0 → 0.35.2-69c7cd1.0

package/dist/index.js

@@ -7704,6 +7704,26 @@ const m7e = "Loading...", y7e = "Stairs", C7e = "Elevator", v7e = "Connection",
   "context-menu": {
     "directions-to-point": "Directions to this point",
     "share-point": "Share this point"
+  },
+  "operation-hours": {
+    midnight: "Midnight",
+    noon: "Noon",
+    "open-24-hours": "Open 24 Hours",
+    closed: "Closed",
+    "sunday-short": "Sun",
+    "monday-short": "Mon",
+    "tuesday-short": "Tue",
+    "wednesday-short": "Wed",
+    "thursday-short": "Thu",
+    "friday-short": "Fri",
+    "saturday-short": "Sat",
+    "sunday-time": "{{time}} Sunday",
+    "monday-time": "{{time}} Monday",
+    "tuesday-time": "{{time}} Tuesday",
+    "wednesday-time": "{{time}} Wednesday",
+    "thursday-time": "{{time}} Thursday",
+    "friday-time": "{{time}} Friday",
+    "saturday-time": "{{time}} Saturday"
   }
 }, N7e = {
   "access-features": "Access Features",

package/dist/types/src/lib/time/opening-hours.d.ts

@@ -0,0 +1,72 @@
+import Time from './time';
+import { TOpeningHours } from './types';
+/**
+ * Class with a time and day of the week.
+ */
+declare class TimeOfWeek {
+    #private;
+    constructor(time: Time, day: number);
+    get day(): number;
+    get time(): Time;
+    toLocaleString(locale: string, options?: Partial<{
+        includeDay: boolean;
+    }>): string;
+}
+/**
+ * A set of opening hours for a location defined in local time within a specific timezone.
+ */
+declare class OpeningHours {
+    #private;
+    /**
+     * Create a new OpeningHours object.
+     */
+    constructor(openingHours: TOpeningHours, tz: string);
+    /**
+     * Return a {@link Time} object in the store's timezone. Defaults to the current date.
+     */
+    getTime(date?: Date): Time;
+    /**
+     * Return a day of the week as a number in the store's timezone. Defaults to the current date.
+     */
+    getDay(date?: Date): number;
+    /**
+     * Return an array of localized, formatted string representations of the opening hours for each
+     * day of the week. The first entry in the array is the provided date's opening hours. If no
+     * date is provided, the current date is used.
+     */
+    toLocaleStrings(locale: string, date?: Date): (readonly [string, string])[];
+    /**
+     * Return true if the opening hours are open 24/7.
+     */
+    isOpen247(): boolean;
+    /**
+     * Return true if the opening hours are always closed.
+     */
+    isClosed247(): boolean;
+    /**
+     * Returns true if a given {@link Date} is within the opening hours. Defaults to checking the
+     * current date.
+     */
+    isOpen(date?: Date): boolean;
+    /**
+     * Return true if a given {@link Date} is within 1 hour of the opening hours. Returns false if
+     * the store is already open. Defaults to checking the current date.
+     */
+    isOpeningSoon(date?: Date): boolean;
+    /**
+     * Return true if a given {@link Date} is within 1 hour of the closing hours. Returns false if
+     * the store is already closed. Defaults to checking the current date.
+     */
+    isClosingSoon(date?: Date): boolean;
+    /**
+     * Returns the next time the store will open from a given date. Defaults to checking the current
+     * date.
+     */
+    opensAt(date?: Date): TimeOfWeek | null;
+    /**
+     * Returns the next time the store will close from a given date. Defaults to checking the current
+     * date.
+     */
+    closesAt(date?: Date): TimeOfWeek | null;
+}
+export default OpeningHours;

package/dist/types/src/lib/time/opening-hours.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/src/lib/time/time.d.ts

@@ -0,0 +1,64 @@
+/**
+ * A time in minutes and hours, without a date.
+ */
+declare class Time {
+    #private;
+    /**
+     * Create a new Time object. If no arguments are provided, the current time is used.
+     * If a Date is provided, the time is set to the time of the provided date. If two
+     * numbers are provided, the time is set to the given hours and minutes.
+     */
+    constructor();
+    constructor(date: Date);
+    constructor(hour: number, minute: number);
+    /**
+     * Get the hours of this time.
+     */
+    get hours(): number;
+    /**
+     * Get the minutes of this time.
+     */
+    get minutes(): number;
+    /**
+     * Returns true if this time is midnight. This can be either 00:00 or 24:00.
+     */
+    isMidnight(): boolean;
+    /**
+     * Returns true if this time is noon.
+     */
+    isNoon(): boolean;
+    /**
+     * Returns true if this time is equal to another time. 00:00 and 24:00 are considered
+     * to be equal.
+     */
+    isEqual(other: Time): boolean;
+    /**
+     * Returns true if this time is later than another time, assuming the times are on the
+     * same day. 00:00 is considered to be earlier than any other time; 24:00 is considered
+     * to be later than any other time.
+     */
+    isLaterThan(other: Time): boolean;
+    /**
+     * Returns true if this time is later than or equal to another time. Unlike {@link isLaterThan},
+     * 00:00 is considered to be equal to 24:00.
+     */
+    isLaterThanOrEqual(other: Time): boolean;
+    /**
+     * Returns true if the given time is between the start and end time, inclusive.
+     *
+     * Assumes the start time is on the same day. If the end time is earlier than the start time,
+     * it is assumed to be on the next day. If the start time is equal to the end time, it is
+     * assumed to include the entire day and this function will always return true.
+     */
+    isBetween(start: Time, end: Time): boolean;
+    /**
+     * Return the number of minutes forward in time required to reach another time. If the
+     * other time is earlier than this time, it is assumed to be on the next day.
+     */
+    minutesTo(other: Time): number;
+    /**
+     * Return a localized, formatted string representation of the time.
+     */
+    toLocaleString(locale?: string, options?: Intl.DateTimeFormatOptions): string;
+}
+export default Time;

package/dist/types/src/lib/time/time.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/src/lib/time/types.d.ts

@@ -0,0 +1,33 @@
+/**
+ * An array representing a time range in hours and minutes. If the second time is earlier
+ * than the first time, it is assumed to be on the next day.
+ */
+export type TTimeRange = [number, number, number, number];
+/**
+ * Opening hours for a single day. For a store with hours, it is either a {@link TTimeRange}
+ * or a pair of {@link TTimeRange}s, or null if the store is closed for the day. The second
+ * time range, if specified, must begin after the first time range ends. Otherwise, the meaning
+ * is undefined.
+ */
+export type TSingleDayOpeningHours = [TTimeRange] | [TTimeRange, TTimeRange] | null;
+/**
+ * A collection of {@link TSingleDayOpeningHours} for Sunday to Saturday.
+ */
+export type TRegularOpeningHours = [
+    TSingleDayOpeningHours,
+    TSingleDayOpeningHours,
+    TSingleDayOpeningHours,
+    TSingleDayOpeningHours,
+    TSingleDayOpeningHours,
+    TSingleDayOpeningHours,
+    TSingleDayOpeningHours
+];
+/**
+ * A collection of {@link TSingleDayOpeningHours} for every day of the week and for
+ * holidays. The first entry is for Sunday, the second for Monday, etc. The last entry
+ * is for holidays.
+ */
+export type TOpeningHours = TRegularOpeningHours | [
+    ...TRegularOpeningHours,
+    TSingleDayOpeningHours
+];

package/dist/types/src/lib/time/utils.d.ts

@@ -0,0 +1,34 @@
+import Time from './time';
+import { TSingleDayOpeningHours, TTimeRange } from './types';
+/**
+ * Returns true if the given locale uses a 24-hour time format.
+ */
+export declare const is24HourTime: (locale: string) => boolean;
+/**
+ * Convert the name of a day of the week to a number between 0 and 6. Returns -1 if the day is not
+ * valid.
+ */
+export declare const dayOfWeekNum: (day: string) => number;
+/**
+ * Get the current timezone of the client.
+ */
+export declare const getTZ: () => string;
+/**
+ * Given a timezone and a date, return the hours, minutes, and day of week in that timezone.
+ * Day of week is 0-6, where 0 is Sunday. If no timezone is specified, uses the client's local
+ * timezone. If no date is specified, uses the current date.
+ */
+export declare const getTimePartsAtTZ: (tz: string, date: Date) => {
+    hours: number;
+    minutes: number;
+    dayOfWeek: number;
+};
+/**
+ * Given a single day's opening hours, return the start and end times. If the opening
+ * hours are a pair of time ranges, return the start and end times for both ranges.
+ * Returns null if the store is closed for the day.
+ */
+export declare function singleDayOpeningHoursTimes(hours: null): null;
+export declare function singleDayOpeningHoursTimes(hours: [TTimeRange]): [Time, Time];
+export declare function singleDayOpeningHoursTimes(hours: [TTimeRange, TTimeRange]): [Time, Time, Time, Time];
+export declare function singleDayOpeningHoursTimes(hours: TSingleDayOpeningHours): [Time, Time] | [Time, Time, Time, Time] | null;

package/dist/types/src/lib/time/utils.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/src/lib/utils/language-utils.d.ts

@@ -0,0 +1 @@
+export declare const getLocale: (locale?: string) => string;

package/dist/types/src/test-utils/test-suite.d.ts

@@ -0,0 +1,18 @@
+/**
+ * A set of given and expected values for testing.
+ */
+export type TTestCondition<Given, Expected> = readonly [Given, Expected];
+/**
+ * A test case with a name and a {@link TTestCondition}s.
+ */
+export type TTestCase<Given, Expected> = [string, readonly TTestCondition<Given, Expected>[]];
+/**
+ * A suite of {@link TTestCase}s.
+ */
+export type TTestSuite<Given, Expected> = readonly TTestCase<Given, Expected>[];
+/**
+ * Run a callback with tests for each {@link TTestCase} in a {@link TTestSuite}. This is useful for
+ * running many tests with the same exact format, where the input and output can be easily abstracted.
+ */
+declare const testSuite: <Given, Expected>(name: string, config: TTestSuite<Given, Expected>, cb: (language: string, value: TTestCondition<Given, Expected>) => void) => void;
+export default testSuite;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mappedin/viewer",
-  "version": "0.35.2-3613294.0",
+  "version": "0.35.2-69c7cd1.0",
   "type": "module",
   "browser": "./dist/index.js",
   "license": "UNLICENSED",