@idea-ionic/agenda 7.2.3 → 7.2.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@idea-ionic/agenda",
-  "version": "7.2.3",
+  "version": "7.2.4",
   "description": "IDEA Ionic agenda (calendar)",
   "dependencies": {
     "color-parse": "^2.0.0",

package/src/agenda.component.d.ts

@@ -0,0 +1,237 @@
+import { EventEmitter, OnInit, ChangeDetectorRef } from '@angular/core';
+import { IonContent, Platform } from '@ionic/angular';
+import { Subject } from 'rxjs';
+import { CalendarEvent, CalendarEventTimesChangedEvent, CalendarMonthViewBeforeRenderEvent, CalendarView, CalendarWeekViewBeforeRenderEvent } from 'angular-calendar';
+import { IDEATranslationsService } from '@idea-ionic/common';
+import * as i0 from "@angular/core";
+export declare class IDEAAgendaComponent implements OnInit {
+    private cdr;
+    private platform;
+    t: IDEATranslationsService;
+    /**
+     * The events to display in the calendar.
+     */
+    events: AgendaEvent[];
+    /**
+     * An array of day indexes (0 = sunday, 1 = monday, etc.) that will be hidden on the view.
+     */
+    excludeDays: number[];
+    /**
+     * The day start hours in 24 hour time. Must be 0-23
+     */
+    dayStartHour: number;
+    /**
+     * The day start hours in 24 hour time. Must be 0-23
+     */
+    dayEndHour: number;
+    /**
+     * The number of segments in an hour. Must divide equally into 60.
+     */
+    hourSegments: number;
+    /**
+     * Whether to open the current day's details right away in month view.
+     */
+    activeDayIsOpen: boolean;
+    /**
+     * The view mode for the agenda.
+     */
+    view: CalendarView;
+    /**
+     * The allowed view mode for the agenda.
+     */
+    allowedViews: CalendarView[];
+    /**
+     * Whether to block any day/slot in the past.
+     */
+    onlyFuture: boolean;
+    /**
+     * Some notes to show underneath the calendar's header.
+     */
+    titleNotes: string;
+    /**
+     * The template for new events created by drag&drop.
+     */
+    newEventTemplate: AgendaEvent;
+    /**
+     * Whether (and how) to allow the creation of events by drag&drop.
+     * If enabled, on mobile it requires the `parentContent` to be set for a correct execution.
+     */
+    allowDragToCreate: DragToCreateOptions;
+    /**
+     * The parent ion-content, in case we want to control its scrollability for drag&drop features.
+     */
+    parentContent: IonContent;
+    /**
+     * Trigger when an event is selected.
+     */
+    selectEvent: EventEmitter<AgendaEvent>;
+    /**
+     * Trigger when a day is selected.
+     */
+    selectDay: EventEmitter<Date>;
+    /**
+     * Trigger when a time slot is selected.
+     */
+    selectSlot: EventEmitter<Date>;
+    /**
+     * Trigger when a new event is added by drag and drop.
+     */
+    newEventByDrag: EventEmitter<AgendaEvent>;
+    /**
+     * Trigger when an event changed date (drag&drop or resize).
+     */
+    changeEvent: EventEmitter<AgendaEvent>;
+    /**
+     * Trigger when the view date of reference changed (because we moved inside the calendar).
+     */
+    changeDate: EventEmitter<Date>;
+    /**
+     * Trigger before the rendering of the week or day view.
+     */
+    beforeWeekOrDayViewRenderEmitter: EventEmitter<CalendarWeekViewBeforeRenderEvent>;
+    /**
+     * Trigger before the rendering of the month view.
+     */
+    beforeMonthViewRenderEmitter: EventEmitter<CalendarMonthViewBeforeRenderEvent>;
+    /**
+     * Helper to use the enum in the UX.
+     */
+    CalendarView: typeof CalendarView;
+    /**
+     * The currently selected date.
+     */
+    viewDate: Date;
+    /**
+     * A controller to refresh the current view.
+     */
+    refresh: Subject<void>;
+    /**
+     * The locale used to format dates.
+     * @hide
+     */
+    locale: string;
+    /**
+     * The starting day for the week, according to the locale (0 = sunday).
+     * @hide
+     */
+    weekStartsOn: 0 | 1 | 2 | 3 | 4 | 5 | 6;
+    Attendance: typeof EventAttendance;
+    darkMode: boolean;
+    constructor(cdr: ChangeDetectorRef, platform: Platform, t: IDEATranslationsService);
+    ngOnInit(): void;
+    isMobile(): boolean;
+    /**
+     * Run some checks before the month view is rendered (e.g. disable invalid days).
+     */
+    beforeMonthViewRender(event: CalendarMonthViewBeforeRenderEvent): void;
+    /**
+     * Run some checks before the week/day view is rendered (e.g. disable invalid days).
+     */
+    beforeWeekOrDayViewRender(event: CalendarWeekViewBeforeRenderEvent): void;
+    /**
+     * Check whether a date is valid based on the configured parameters.
+     */
+    dateIsValid(date: any, sameDayIsValid?: boolean): boolean;
+    /**
+     * Change the current view for the agenda.
+     */
+    setView(view: CalendarView): void;
+    /**
+     * Emit the change of the view date and close the detail component of the month view, if needed.
+     */
+    viewDateChanged(newDate: Date): void;
+    /**
+     * A day was selected: manage the detailed view.
+     */
+    changeDay({ date, events }: {
+        date: Date;
+        events: AgendaEvent[];
+    }): void;
+    /**
+     * The time of an event was changed.
+     */
+    eventTimesChanged({ event, newStart, newEnd }: CalendarEventTimesChangedEvent): void;
+    /**
+     * Given a color, it returns an opaque version of it.
+     */
+    getAlternateColor(color: string, amount: number, opacity?: number): string | undefined;
+    /**
+     * Get the content of the tooltip based on the event.
+     */
+    getTooltipContent(event: AgendaEvent): string;
+    /**
+     * Get a shortened version of the description as preview.
+     */
+    getPreviewDescription(description: string): string;
+    /**
+     * Handle the drag&drop to create a new event.
+     */
+    startDragToCreate(event: Event, segmentDate: Date, segmentElement: HTMLElement): void;
+    private getFixedEndDateWithMinimumSegmentDuration;
+    static ɵfac: i0.ɵɵFactoryDeclaration<IDEAAgendaComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<IDEAAgendaComponent, "idea-agenda", never, { "events": { "alias": "events"; "required": false; }; "excludeDays": { "alias": "excludeDays"; "required": false; }; "dayStartHour": { "alias": "dayStartHour"; "required": false; }; "dayEndHour": { "alias": "dayEndHour"; "required": false; }; "hourSegments": { "alias": "hourSegments"; "required": false; }; "activeDayIsOpen": { "alias": "activeDayIsOpen"; "required": false; }; "view": { "alias": "view"; "required": false; }; "allowedViews": { "alias": "allowedViews"; "required": false; }; "onlyFuture": { "alias": "onlyFuture"; "required": false; }; "titleNotes": { "alias": "titleNotes"; "required": false; }; "newEventTemplate": { "alias": "newEventTemplate"; "required": false; }; "allowDragToCreate": { "alias": "allowDragToCreate"; "required": false; }; "parentContent": { "alias": "parentContent"; "required": false; }; }, { "selectEvent": "selectEvent"; "selectDay": "selectDay"; "selectSlot": "selectSlot"; "newEventByDrag": "newEventByDrag"; "changeEvent": "changeEvent"; "changeDate": "changeDate"; "beforeWeekOrDayViewRenderEmitter": "beforeWeekOrDayViewRenderEmitter"; "beforeMonthViewRenderEmitter": "beforeMonthViewRenderEmitter"; }, never, never, false, never>;
+}
+/**
+ * A richer version of the classic CalendarEvent.
+ */
+export interface AgendaEvent extends CalendarEvent {
+    /**
+     * A brief description for the event (e.g. customer, address, etc.).
+     */
+    description?: string;
+    /**
+     * The location of the event.
+     */
+    location?: string;
+    /**
+     * A list of URLs of images to show as small avatars.
+     */
+    avatars?: {
+        id: string;
+        url: string;
+        title: string;
+    }[];
+    /**
+     * A list of ion-icons to show.
+     */
+    icons?: {
+        name: string;
+        title: string;
+    }[];
+    /**
+     * The colors of the event displayed.
+     */
+    color?: {
+        primary: string;
+        secondary?: string;
+    } | any;
+    /**
+     * Whether the event is external; external events are less important UI-wise.
+     */
+    external?: boolean;
+    /**
+     * The attendance status to this event, if any.
+     */
+    attendance?: EventAttendance;
+    /**
+     * A standard and unique id for the event, valid across multiple sources.
+     */
+    iCalUID?: string;
+}
+/**
+ * Possible attendance statuses for the event.
+ */
+export declare enum EventAttendance {
+    DECLINED = -1,
+    NEEDS_ACTION = 0,
+    TENTATIVE = 1,
+    ACCEPTED = 2
+}
+/**
+ * The options to allow (or not) drag&drop to create a new event.
+ */
+export declare enum DragToCreateOptions {
+    DISABLED = 0,
+    ONLY_SAME_DAY = 1,
+    FREE = 2
+}

package/src/agenda.module.d.ts

@@ -0,0 +1,15 @@
+import * as i0 from "@angular/core";
+import * as i1 from "./agenda.component";
+import * as i2 from "./calendar.component";
+import * as i3 from "./calendarItem.component";
+import * as i4 from "./calendarCreation.component";
+import * as i5 from "@angular/common";
+import * as i6 from "@angular/forms";
+import * as i7 from "@ionic/angular";
+import * as i8 from "@idea-ionic/common";
+import * as i9 from "angular-calendar";
+export declare class IDEAAgendaModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<IDEAAgendaModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<IDEAAgendaModule, [typeof i1.IDEAAgendaComponent, typeof i2.IDEACalendarComponent, typeof i3.IDEACalendarItemComponent, typeof i4.IDEACalendarCreationComponent], [typeof i5.CommonModule, typeof i6.FormsModule, typeof i7.IonicModule, typeof i8.IDEATranslationsModule, typeof i8.IDEAColorPickerModule, typeof i8.IDEACheckerModule, typeof i8.IDEAUserAvatarModule, typeof i9.CalendarModule], [typeof i1.IDEAAgendaComponent, typeof i2.IDEACalendarComponent, typeof i3.IDEACalendarItemComponent, typeof i4.IDEACalendarCreationComponent]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<IDEAAgendaModule>;
+}

package/src/calendar.component.d.ts

@@ -0,0 +1,68 @@
+import { OnInit } from '@angular/core';
+import { ModalController, AlertController } from '@ionic/angular';
+import { Calendar, Check, Membership } from 'idea-toolbox';
+import { IDEALoadingService, IDEAAWSAPIService, IDEATinCanService, IDEAMessageService, IDEATranslationsService } from '@idea-ionic/common';
+import { IDEACalendarsService } from './calendars.service';
+import * as i0 from "@angular/core";
+export declare class IDEACalendarComponent implements OnInit {
+    calendars: IDEACalendarsService;
+    modalCtrl: ModalController;
+    alertCtrl: AlertController;
+    tc: IDEATinCanService;
+    loading: IDEALoadingService;
+    message: IDEAMessageService;
+    API: IDEAAWSAPIService;
+    t: IDEATranslationsService;
+    /**
+     * The calendar to manage.
+     */
+    calendar: Calendar;
+    /**
+     * Whether we want to enable advanced permissions (based on the memberships) on the calendar.
+     */
+    advancedPermissions: boolean;
+    /**
+     * Whether the calendar color is an important detail or it shouldn't be shown.
+     */
+    hideColor: boolean;
+    /**
+     * Working copy of the calendar, to update only when confirmed.
+     */
+    _calendar: Calendar;
+    /**
+     * Helper to allow selecting memberships.
+     */
+    membershipsChecks: Check[];
+    /**
+     * The current membership.
+     */
+    membership: Membership;
+    /**
+     * Errors while validating the entity.
+     */
+    errors: Set<string>;
+    /**
+     * The default color for a calendar.
+     */
+    DEFAULT_COLOR: string;
+    constructor(calendars: IDEACalendarsService, modalCtrl: ModalController, alertCtrl: AlertController, tc: IDEATinCanService, loading: IDEALoadingService, message: IDEAMessageService, API: IDEAAWSAPIService, t: IDEATranslationsService);
+    ngOnInit(): void;
+    /**
+     * Set the support array to display errors in the UI.
+     */
+    hasFieldAnError(field: string): boolean;
+    /**
+     * Save a calendar with the new info.
+     */
+    save(): Promise<void>;
+    /**
+     * Delete the calendar.
+     */
+    delete(): void;
+    /**
+     * Close the component.
+     */
+    close(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<IDEACalendarComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<IDEACalendarComponent, "idea-calendar", never, { "calendar": { "alias": "calendar"; "required": false; }; "advancedPermissions": { "alias": "advancedPermissions"; "required": false; }; "hideColor": { "alias": "hideColor"; "required": false; }; }, {}, never, never, false, never>;
+}

package/src/calendarCreation.component.d.ts

@@ -0,0 +1,70 @@
+import { OnInit } from '@angular/core';
+import { ModalController } from '@ionic/angular';
+import { Calendar, ExternalCalendarSources, Membership } from 'idea-toolbox';
+import { IDEALoadingService, IDEAAWSAPIService, IDEATinCanService, IDEAMessageService, IDEATranslationsService } from '@idea-ionic/common';
+import { IDEACalendarsService } from './calendars.service';
+import * as i0 from "@angular/core";
+export declare class IDEACalendarCreationComponent implements OnInit {
+    calendars: IDEACalendarsService;
+    modalCtrl: ModalController;
+    tc: IDEATinCanService;
+    loading: IDEALoadingService;
+    message: IDEAMessageService;
+    API: IDEAAWSAPIService;
+    t: IDEATranslationsService;
+    /**
+     * Whether we want to allow the creation of only a particular type of calendar, based on the scope.
+     */
+    fixScope: CalendarScopes;
+    /**
+     * Whether we want to allow the creation of local calendars.
+     */
+    onlyExternalCalendars: boolean;
+    /**
+     * The current membership (generic).
+     */
+    membership: Membership;
+    /**
+     * The calendar to create.
+     */
+    calendar: Calendar;
+    /**
+     * The default color for a new calendar.
+     */
+    DEFAULT_COLOR: string;
+    /**
+     * The possible external services for the new calendar.
+     */
+    SOURCES: string[];
+    constructor(calendars: IDEACalendarsService, modalCtrl: ModalController, tc: IDEATinCanService, loading: IDEALoadingService, message: IDEAMessageService, API: IDEAAWSAPIService, t: IDEATranslationsService);
+    ngOnInit(): void;
+    /**
+     * If allowed by the component configuration, reset the scope of the calendar (private/shared).
+     */
+    resetScope(): void;
+    /**
+     * Whether we can change the scope of the calendar (private/shared).
+     */
+    canChangeScope(): boolean;
+    /**
+     * Whether the scope has been set already.
+     */
+    scopeIsSet(): boolean;
+    /**
+     * Add a new calendar based on the configuration set.
+     */
+    saveNewCalendar(service?: ExternalCalendarSources): Promise<void>;
+    /**
+     * Close the component.
+     */
+    close(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<IDEACalendarCreationComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<IDEACalendarCreationComponent, "idea-calendar-creation", never, { "fixScope": { "alias": "fixScope"; "required": false; }; "onlyExternalCalendars": { "alias": "onlyExternalCalendars"; "required": false; }; }, {}, never, never, false, never>;
+}
+/**
+ * The possible scopes of the calendar.
+ */
+export declare enum CalendarScopes {
+    SHARED = "shared",// teamId
+    PRIVATE = "private"
+}

package/src/calendarItem.component.d.ts

@@ -0,0 +1,46 @@
+import { EventEmitter } from '@angular/core';
+import { AlertController, ModalController } from '@ionic/angular';
+import { Calendar } from 'idea-toolbox';
+import { IDEALoadingService, IDEAMessageService, IDEATranslationsService } from '@idea-ionic/common';
+import { IDEACalendarsService } from './calendars.service';
+import * as i0 from "@angular/core";
+export declare class IDEACalendarItemComponent {
+    calendars: IDEACalendarsService;
+    alertCtrl: AlertController;
+    modalCtrl: ModalController;
+    message: IDEAMessageService;
+    loading: IDEALoadingService;
+    t: IDEATranslationsService;
+    /**
+     * The calendar to show.
+     */
+    calendar: Calendar;
+    /**
+     * Whether the component is disabled.
+     */
+    disabled: boolean;
+    /**
+     * Whether we want to enable advanced permissions (based on the memberships) on the calendar.
+     */
+    advancedPermissions: boolean;
+    /**
+     * Whether the calendar color is an important detail or it shouldn't be shown.
+     */
+    hideColor: boolean;
+    /**
+     * Report to parent components a change.
+     */
+    somethingChanged: EventEmitter<Calendar>;
+    constructor(calendars: IDEACalendarsService, alertCtrl: AlertController, modalCtrl: ModalController, message: IDEAMessageService, loading: IDEALoadingService, t: IDEATranslationsService);
+    /**
+     * Open the modal to manage the calendar.
+     */
+    manageCalendar(): void;
+    /**
+     * Continue the auth flow to link an external service and set an external calendar;
+     * otherwise, the calendar can be deleted.
+     */
+    linkExtCalendarOrDelete(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<IDEACalendarItemComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<IDEACalendarItemComponent, "idea-calendar-item", never, { "calendar": { "alias": "calendar"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "advancedPermissions": { "alias": "advancedPermissions"; "required": false; }; "hideColor": { "alias": "hideColor"; "required": false; }; }, { "somethingChanged": "somethingChanged"; }, never, never, false, never>;
+}

package/src/calendars.service.d.ts

@@ -0,0 +1,79 @@
+import { AlertController, ModalController } from '@ionic/angular';
+import { Calendar, ExternalCalendarSources } from 'idea-toolbox';
+import { IDEALoadingService, IDEAAWSAPIService, IDEAMessageService, IDEATranslationsService } from '@idea-ionic/common';
+import * as i0 from "@angular/core";
+/**
+ * Note: to test locally, you need to temporarily change the redirect URI:
+ *  - in the lambda `idea_calendars`, e.g. `SCARLETT_URL`;
+ *  - in the client config file: `APP_URL`.
+ * In both cases, the value should be set to `http://localhost:8100` (or according to the local URL).
+ */
+export declare class IDEACalendarsService {
+    modalCtrl: ModalController;
+    alertCtrl: AlertController;
+    message: IDEAMessageService;
+    loading: IDEALoadingService;
+    API: IDEAAWSAPIService;
+    t: IDEATranslationsService;
+    constructor(modalCtrl: ModalController, alertCtrl: AlertController, message: IDEAMessageService, loading: IDEALoadingService, API: IDEAAWSAPIService, t: IDEATranslationsService);
+    /**
+     * Get the ion-icon of an external service from its name.
+     */
+    getServiceIcon(service: ExternalCalendarSources): string;
+    /**
+     * Get the base URL for API request (shared/private calendar).
+     */
+    getRequestURL(calendar: Calendar): string;
+    /**
+     * Create a new calendar.
+     */
+    postCalendar(cal: Calendar): Promise<Calendar>;
+    /**
+     * Update an existing calendar.
+     */
+    putCalendar(cal: Calendar): Promise<Calendar>;
+    /**
+     * Delete a calendar.
+     */
+    deleteCalendar(cal: Calendar): Promise<void>;
+    /**
+     * Associate an external calendar with the given calendar.
+     */
+    setExternalCalendar(cal: Calendar, externalId: string): Promise<Calendar>;
+    /**
+     * Link the calendar with the chosen external service (auth flow).
+     */
+    linkExtService(cal: Calendar): Promise<void>;
+    /**
+     * Get the external calendars list of the external service.
+     */
+    getExternalCalendars(cal: Calendar): Promise<ExtCalendar[]>;
+    /**
+     * If the external service is linked, choose an external calendar and set it for the chosen calendar.
+     * @return the updated calendar.
+     */
+    chooseAndSetExternalCalendar(cal: Calendar): Promise<Calendar>;
+    /**
+     * Open the modal to pick a calendar from the external service.
+     * @return the id of the external calendar.
+     */
+    private openModalAndPickExternalCalendar;
+    /**
+     * First sync of the extenal calendar.
+     */
+    syncCalendar(cal: Calendar): Promise<void>;
+    /**
+     * Helper to recursively sync an the extenal calendar.
+     */
+    private syncCalendarHelper;
+    static ɵfac: i0.ɵɵFactoryDeclaration<IDEACalendarsService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<IDEACalendarsService>;
+}
+/**
+ * Helper structure to define external services' calendars (basic info).
+ */
+interface ExtCalendar {
+    id: string;
+    name: string;
+}
+export {};

package/src/dateFormatter.provider.d.ts

@@ -0,0 +1,13 @@
+import { CalendarDateFormatter, DateFormatterParams } from 'angular-calendar';
+import * as i0 from "@angular/core";
+export declare class CustomDateFormatter extends CalendarDateFormatter {
+    monthViewColumnHeader: ({ date, locale }: DateFormatterParams) => string;
+    monthViewTitle: ({ date, locale }: DateFormatterParams) => string;
+    weekViewHour: ({ date, locale }: DateFormatterParams) => string;
+    weekViewColumnHeader: ({ date, locale }: DateFormatterParams) => string;
+    weekViewTitle: ({ date, locale }: DateFormatterParams) => string;
+    dayViewHour: ({ date, locale }: DateFormatterParams) => string;
+    dayViewTitle: ({ date, locale }: DateFormatterParams) => string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<CustomDateFormatter, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<CustomDateFormatter>;
+}