@idea-ionic/agenda 5.29.1 → 6.0.0

package/src/calendarItem.component.d.ts

@@ -3,6 +3,7 @@ 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;
@@ -10,12 +11,36 @@ export declare class IDEACalendarItemComponent {
     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": "calendar"; "disabled": "disabled"; "advancedPermissions": "advancedPermissions"; "hideColor": "hideColor"; }, { "somethingChanged": "somethingChanged"; }, never, never>;
 }

package/src/calendars.service.d.ts

@@ -1,6 +1,13 @@
 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;
@@ -9,19 +16,62 @@ export declare class IDEACalendarsService {
     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;

package/src/dateFormatter.provider.d.ts

@@ -1,4 +1,5 @@
 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;
@@ -7,4 +8,6 @@ export declare class CustomDateFormatter extends CalendarDateFormatter {
     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>;
 }