@kubun/connector-google-calendar 0.17.3 → 0.18.0

package/lib/model.js

@@ -1,31 +1,29 @@
 import { connectorClusters, connectorModelIDs, externalEntityDefinition } from '@kubun/connector';
-import { modelIDs, modelsClusters } from '@kubun/models';
+import { calendarClusters, calendarModelDefinitions, calendarModelIDs } from '@kubun/models-calendar';
+import { coreClusters, coreModelDefinitions, coreModelIDs } from '@kubun/models-core';
 import { GraphBuilder } from '@kubun/protocol';
-import { docIDSchema, timeZoneSchema, urlSchema } from '@kubun/scalars';
+import { docIDSchema, urlSchema } from '@kubun/scalars';
+const calendarKindProviderFields = calendarModelDefinitions.find((definition)=>definition.name === 'CalendarKind')?.providerMergePolicy?.group;
+const eventKindProviderFields = calendarModelDefinitions.find((definition)=>definition.name === 'EventKind')?.providerMergePolicy?.group;
+const schedulableProviderFields = coreModelDefinitions.find((definition)=>definition.name === 'Schedulable')?.providerMergePolicy?.group;
+if (calendarKindProviderFields == null || eventKindProviderFields == null || schedulableProviderFields == null) {
+    throw new Error('Calendar provider fields are missing');
+}
+// The shared calendar fields (name, description, color, timeZone, accessRole)
+// come from CalendarKind; only what is Google's own is declared here.
 export const googleCalendarDefinition = {
     name: 'GoogleCalendar',
     behavior: 'default',
     interfaces: [
-        connectorModelIDs.ExternalEntity
+        connectorModelIDs.ExternalEntity,
+        calendarModelIDs.CalendarKind
     ],
     schema: {
         type: 'object',
         properties: {
-            summary: {
-                type: 'string'
-            },
-            description: {
-                type: 'string'
-            },
-            timeZone: {
-                $ref: '#/definitions/TimeZone'
-            },
             primary: {
                 type: 'boolean'
             },
-            backgroundColor: {
-                type: 'string'
-            },
             accountKey: {
                 type: 'string',
                 minLength: 43,
@@ -45,61 +43,43 @@ export const googleCalendarDefinition = {
             }
         },
         required: [
-            'summary',
             'sourceService',
             'sourceID',
             'lastSyncedAt'
         ],
         additionalProperties: false,
         definitions: {
-            ...externalEntityDefinition.schema.definitions,
-            TimeZone: timeZoneSchema
+            ...externalEntityDefinition.schema.definitions
         }
     },
-    fieldsMeta: {}
+    fieldsMeta: {},
+    providerMergePolicy: {
+        group: [
+            ...calendarKindProviderFields,
+            'primary',
+            'sourceService',
+            'sourceID',
+            'sourceURL'
+        ]
+    }
 };
 export const googleCalendarEventDefinition = {
     name: 'GoogleCalendarEvent',
     behavior: 'default',
+    // The event fields (title, times, participants, recurrence, reminders...)
+    // come from EventKind and Schedulable, and the local tags from Taggable;
+    // only what is Google's own is declared here.
     interfaces: [
         connectorModelIDs.ExternalEntity,
-        modelIDs.EventKind
+        calendarModelIDs.EventKind,
+        coreModelIDs.Taggable
     ],
     schema: {
         type: 'object',
         properties: {
-            title: {
-                type: 'string',
-                minLength: 1,
-                maxLength: 200
-            },
-            startAt: {
-                $ref: '#/definitions/DateTime'
-            },
-            endAt: {
-                $ref: '#/definitions/DateTime'
-            },
-            allDay: {
-                type: 'boolean'
-            },
-            timeZone: {
-                $ref: '#/definitions/TimeZone'
-            },
-            description: {
-                type: 'string'
-            },
-            location: {
-                type: 'string'
-            },
-            status: {
-                $ref: '#/definitions/EventStatus'
-            },
             htmlLink: {
                 $ref: '#/definitions/HtmlLink'
             },
-            recurringEventID: {
-                type: 'string'
-            },
             eventID: {
                 type: 'string'
             },
@@ -126,9 +106,6 @@ export const googleCalendarEventDefinition = {
             }
         },
         required: [
-            'title',
-            'startAt',
-            'allDay',
             'calendarID',
             'calendar',
             'sourceService',
@@ -146,18 +123,8 @@ export const googleCalendarEventDefinition = {
                 minLength: 1,
                 maxLength: 1400
             },
-            TimeZone: timeZoneSchema,
             HtmlLink: urlSchema,
-            CalendarDocID: docIDSchema,
-            EventStatus: {
-                type: 'string',
-                title: 'EventStatus',
-                enum: [
-                    'CONFIRMED',
-                    'TENTATIVE',
-                    'CANCELLED'
-                ]
-            }
+            CalendarDocID: docIDSchema
         }
     },
     fieldsMeta: {
@@ -166,20 +133,15 @@ export const googleCalendarEventDefinition = {
             model: '#0'
         }
     },
-    // lastSyncedAt is a device-local sync-bookkeeping annotation, not fetched
-    // provider content, so it stays outside the group.
+    // lastSyncedAt is a device-local sync-bookkeeping annotation and tags a
+    // local user annotation, neither fetched provider content, so both stay
+    // outside the group.
     providerMergePolicy: {
         group: [
             'title',
-            'startAt',
-            'endAt',
-            'allDay',
-            'timeZone',
-            'description',
-            'location',
-            'status',
+            ...schedulableProviderFields,
+            ...eventKindProviderFields.filter((field)=>field !== 'title' && field !== 'calendar'),
             'htmlLink',
-            'recurringEventID',
             'eventID',
             'calendarID',
             'calendar',
@@ -196,7 +158,8 @@ export const googleCalendarEventDefinition = {
 const builder = new GraphBuilder({
     externalClusters: {
         ...connectorClusters,
-        ...modelsClusters
+        ...coreClusters,
+        ...calendarClusters
     }
 });
 builder.add(googleCalendarDefinition); // #0

package/lib/provider.d.ts

@@ -9,9 +9,23 @@ export type GoogleCalendarProviderConfig = {
 };
 export type CalendarCheckpoint = {
     calendarListSyncToken?: string;
+    completed?: Array<string>;
+    roll?: {
+        windowEnd: string;
+        startedAt: string;
+        completed: Array<string>;
+    };
     calendars: Record<string, {
         eventsSyncToken?: string;
+        relist?: {
+            relistID: string;
+            pageToken?: string;
+            startedFetchHLC: string;
+            seen: Array<string>;
+        };
     }>;
     windowStart?: string;
+    windowEnd?: string;
+    windowRolledAt?: string;
 };
 export declare function createGoogleCalendarProvider(config: GoogleCalendarProviderConfig): ServerDataProvider;