@squidcloud/google-calendar-client 1.0.146-beta

package/dist/connectors/google_calendar/common/src/google-calendar-types.d.ts

@@ -0,0 +1,131 @@
+/**
+ * OAuth2 scopes (ie level of access) required for Google Calendar integration.
+ * Use these scopes when requesting the OAuth2 auth code from Google. Provided here for convenience only.
+ *
+ */
+export declare const GOOGLE_CALENDAR_SCOPES: readonly ["openid", "email", "https://www.googleapis.com/auth/calendar.events"];
+/**
+ * Represents an attendee of a calendar event
+ */
+export interface CalendarEventAttendee {
+    email: string;
+    status: string;
+}
+/**
+ * Represents a formatted calendar event with all relevant details
+ */
+export interface CalendarEvent {
+    id: string;
+    summary: string;
+    description?: string;
+    start: string;
+    end: string;
+    location?: string;
+    attendees?: Array<CalendarEventAttendee>;
+    htmlLink?: string;
+}
+/**
+ * Request parameters for retrieving calendar events
+ */
+export interface GetCalendarEventsRequest {
+    /** The ID of the Google Calendar integration in the Squid console. */
+    integrationId: string;
+    /**
+     * User-specific identifier to retrieve the correct OAuth tokens.
+     */
+    identifier: string;
+    /** Start date for the event query. Defaults to today. */
+    startDate?: Date;
+    /** End date for the event query. Defaults to 7 days from start. */
+    endDate?: Date;
+    /** Maximum number of events to return. Defaults to 50. */
+    maxResults?: number;
+    /** Calendar ID to query. Defaults to "primary". */
+    calendarId?: string;
+}
+/**
+ * Attendee information for a calendar event
+ */
+export interface EventAttendee {
+    /** Email address of the attendee */
+    email: string;
+    /** Display name of the attendee (optional) */
+    displayName?: string;
+}
+/**
+ * Event reminder/notification
+ */
+export interface EventReminder {
+    /** Reminder method: 'email' or 'popup' */
+    method: 'email' | 'popup';
+    /** Number of minutes before the event when the reminder should trigger */
+    minutes: number;
+}
+/**
+ * Recurrence rule frequency
+ */
+export type RecurrenceFrequency = 'DAILY' | 'WEEKLY' | 'MONTHLY' | 'YEARLY';
+/**
+ * Recurrence rule for repeating events
+ */
+export interface RecurrenceRule {
+    /** How often the event repeats */
+    frequency: RecurrenceFrequency;
+    /** Number of occurrences after which to stop repeating. Mutually exclusive with until. */
+    count?: number;
+    /** Date until which the event repeats. Mutually exclusive with count. */
+    until?: Date;
+    /** Interval between recurrences (e.g., every 2 weeks). Defaults to 1. */
+    interval?: number;
+    /** For WEEKLY frequency, which days of the week (e.g., ['MO', 'WE', 'FR']). */
+    byDay?: Array<'MO' | 'TU' | 'WE' | 'TH' | 'FR' | 'SA' | 'SU'>;
+}
+/**
+ * Event visibility settings
+ */
+export type EventVisibility = 'default' | 'public' | 'private';
+/**
+ * Request parameters for upserting (creating or updating) a calendar event
+ */
+export interface UpsertCalendarEventRequest {
+    /** The ID of the Google Calendar integration in the Squid console. */
+    integrationId: string;
+    /**
+     * User-specific identifier to retrieve the correct OAuth tokens.
+     */
+    identifier: string;
+    /** Event ID for updating an existing event. If not provided, creates a new event. */
+    eventId?: string;
+    /** Calendar ID where the event should be created/updated. Defaults to "primary". */
+    calendarId?: string;
+    /** Title/summary of the event (required) */
+    summary: string;
+    /** Detailed description of the event (optional) */
+    description?: string;
+    /** Event start time. For all-day events, use date without time. */
+    start: Date;
+    /** Event end time. For all-day events, use date without time. */
+    end: Date;
+    /** Whether this is an all-day event. If true, start/end are treated as dates only. */
+    isAllDay?: boolean;
+    /** Geographic location of the event as free-form text (optional) */
+    location?: string;
+    /** List of attendees to invite to the event (optional) */
+    attendees?: Array<EventAttendee>;
+    /** Timezone for the event (e.g., "America/Los_Angeles"). Defaults to user's calendar timezone. */
+    timeZone?: string;
+    /** Add Google Meet video conferencing to the event. If true, creates a Google Meet link. */
+    addMeetLink?: boolean;
+    /** List of reminders/notifications for the event (optional) */
+    reminders?: Array<EventReminder>;
+    /** Recurrence rule for repeating events (optional) */
+    recurrence?: RecurrenceRule;
+    /** Visibility of the event. Defaults to "default". */
+    visibility?: EventVisibility;
+    /** Whether guests can modify the event. Defaults to false. */
+    guestsCanModify?: boolean;
+    /** Whether guests can invite others. Defaults to true. */
+    guestsCanInviteOthers?: boolean;
+    /** Whether guests can see other guests. Defaults to true. */
+    guestsCanSeeOtherGuests?: boolean;
+}

package/dist/connectors/google_calendar/googlecalendar-client/src/google-calendar-client.d.ts

@@ -0,0 +1,51 @@
+import { GetAccessTokenResponse, Squid } from '@squidcloud/client';
+import { CalendarEvent, GetCalendarEventsRequest, UpsertCalendarEventRequest } from '../../common/src/google-calendar-types';
+/**
+ * Client for interacting with the Google Calendar connector.
+ * Provides methods to save OAuth tokens and constants for OAuth setup.
+ */
+export declare class SquidGoogleCalendarClient {
+    private readonly squid;
+    private readonly integrationId;
+    /**
+     * OAuth2 scopes required for Google Calendar integration.
+     * Use these when generating the OAuth authorization URL.
+     */
+    static readonly SCOPES: readonly ["openid", "email", "https://www.googleapis.com/auth/calendar.events"];
+    /**
+     * Creates a new Google Calendar client instance.
+     *
+     * @param squid - Squid client instance
+     * @param integrationId - The ID of the Google Calendar integration in the Squid console
+     */
+    constructor(squid: Squid, integrationId: string);
+    /**
+     * Save an OAuth authorization code and exchange it for access/refresh tokens.
+     * Call this after the user completes the OAuth flow and receives the auth code.
+     * Squid will save the access/refresh tokens for future use when requesting Calendar data from Google
+  
+     * This function requires Squid to be initialized with an API key
+     *
+     * @param authCode - OAuth2 authorization code from Google
+     * @param identifier - User-specific identifier (e.g., user ID)
+     * @returns Access token and expiration time
+     */
+    saveAuthCode(authCode: string, identifier: string): Promise<GetAccessTokenResponse>;
+    /**
+     * Retrieve calendar events within a specified time range.
+     * Returns structured event data including details like summary, description, start/end times, location, and attendees.
+     *
+     * @param request - Request parameters for retrieving calendar events
+     * @returns Array of calendar events with detailed information
+     */
+    getCalendarEvents(request: Omit<GetCalendarEventsRequest, 'integrationId'>): Promise<Array<CalendarEvent>>;
+    /**
+     * Upsert (create or update) a calendar event.
+     * If eventId is provided in the request, updates the existing event. Otherwise, creates a new event.
+     * Supports both timed events and all-day events.
+     *
+     * @param request - Event details and metadata
+     * @returns The ID of the created or updated event
+     */
+    upsertCalendarEvent(request: Omit<UpsertCalendarEventRequest, 'integrationId'>): Promise<string>;
+}

package/dist/connectors/google_calendar/googlecalendar-client/src/index.d.ts

@@ -0,0 +1,2 @@
+export * from '../../common/src/google-calendar-types';
+export * from './google-calendar-client';

package/dist/index.js

@@ -0,0 +1 @@
+(()=>{"use strict";var e={d:(t,n)=>{for(var a in n)e.o(n,a)&&!e.o(t,a)&&Object.defineProperty(t,a,{enumerable:!0,get:n[a]})},o:(e,t)=>Object.prototype.hasOwnProperty.call(e,t),r:e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})}},t={};e.r(t),e.d(t,{GOOGLE_CALENDAR_SCOPES:()=>n,SquidGoogleCalendarClient:()=>a});const n=["openid","email","https://www.googleapis.com/auth/calendar.events"];class a{static{this.SCOPES=n}constructor(e,t){this.squid=e,this.integrationId=t}async saveAuthCode(e,t){return await this.squid.externalAuth(this.integrationId).saveAuthCode(e,t)}async getCalendarEvents(e){const t={...e,integrationId:this.integrationId};return await this.squid.executeFunction("getCalendarEvents",t)}async upsertCalendarEvent(e){const t={...e,integrationId:this.integrationId};return await this.squid.executeFunction("upsertCalendarEvent",t)}}var r=exports;for(var i in t)r[i]=t[i];t.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();