@oomol-lab/open-connector 1.6.5 → 1.8.0

package/src/providers/googledrive/trigger-on-file-change.js

@@ -0,0 +1,258 @@
+import { eventsPollOutputs, maximumPollEventsPerPage, PermanentPollError, PollConnectionError, TransientPollError, } from "../../triggers/common/poll.js";
+import { snapshot } from "./trigger-on-file-change.definition.js";
+const folderMimeType = "application/vnd.google-apps.folder";
+const listFields = "nextPageToken,incompleteSearch,files(id,name,mimeType,createdTime,modifiedTime,parents,trashed,webViewLink,driveId,size,version,lastModifyingUser(displayName,emailAddress))";
+const transientReasons = new Set([
+    "rateLimitExceeded",
+    "userRateLimitExceeded",
+    "dailyLimitExceeded",
+    "sharingRateLimitExceeded",
+]);
+const permanentReasons = new Set(["insufficientFilePermissions", "appNotAuthorizedToFile"]);
+export const googleDriveFileChange = {
+    buildOutputs: eventsPollOutputs,
+    snapshot,
+    async poll(context) {
+        const config = resolveConfig(context.config);
+        if (context.checkpoint === null)
+            return seed(context, config);
+        const checkpoint = readCheckpoint(context.checkpoint);
+        if (checkpoint.changeType !== config.changeType) {
+            return {
+                checkpoint: seeded(context.now, config.changeType),
+                events: [],
+            };
+        }
+        return pollFolder(context, config, checkpoint);
+    },
+};
+function resolveConfig(value) {
+    return {
+        changeType: value.changeType,
+        driveId: value.driveId,
+        folderId: value.folderId,
+        itemTypes: new Set(value.itemTypes),
+        maxFilesPerPoll: value.maxFilesPerPoll,
+        mimeTypes: value.mimeTypes,
+        namePrefix: value.namePrefix,
+    };
+}
+function readCheckpoint(value) {
+    const checkpoint = record(value);
+    if (typeof checkpoint?.since != "string" || Number.isNaN(Date.parse(checkpoint.since))) {
+        throw new PermanentPollError("Google Drive checkpoint is invalid; recreate the Trigger.");
+    }
+    const boundary = checkpoint.boundaryKeys;
+    return {
+        since: checkpoint.since,
+        ...(typeof checkpoint.floor == "string" ? { floor: checkpoint.floor } : {}),
+        ...(typeof checkpoint.pageToken == "string" ? { pageToken: checkpoint.pageToken } : {}),
+        ...(typeof checkpoint.pageQuery == "string" ? { pageQuery: checkpoint.pageQuery } : {}),
+        ...(typeof checkpoint.changeType == "string" ? { changeType: checkpoint.changeType } : {}),
+        ...(typeof checkpoint.maxSeen == "string" ? { maxSeen: checkpoint.maxSeen } : {}),
+        ...(Array.isArray(boundary)
+            ? { boundaryKeys: boundary.filter((key) => typeof key == "string") }
+            : {}),
+    };
+}
+async function seed(context, config) {
+    const result = await get(context, `/drive/v3/files/${encodeURIComponent(config.folderId)}`, {
+        fields: "id,name,mimeType,driveId,trashed",
+        supportsAllDrives: "true",
+    });
+    success(result, "folder probe");
+    const probe = record(result.data);
+    if (probe == null)
+        throw new TransientPollError("Google Drive folder probe returned no payload.");
+    if (probe.mimeType !== folderMimeType)
+        throw new PermanentPollError("Google Drive folderId does not point to a folder.");
+    if (probe.trashed === true)
+        throw new PermanentPollError("The Google Drive folder is in the trash.");
+    if (config.driveId.length > 0 && (probe.driveId ?? "") !== config.driveId) {
+        throw new PermanentPollError("The configured Google Drive shared drive does not contain this folder.");
+    }
+    return { checkpoint: seeded(context.now, config.changeType), events: [] };
+}
+function seeded(now, change) {
+    const since = now.toISOString();
+    return { changeType: change, floor: since, since };
+}
+async function pollFolder(context, config, checkpoint) {
+    const query = filesQuery(config, checkpoint.since, checkpoint.floor);
+    const fingerprint = `${config.driveId}|${query}`;
+    const pageToken = checkpoint.pageQuery == fingerprint ? checkpoint.pageToken : undefined;
+    const result = await get(context, "/drive/v3/files", {
+        corpora: config.driveId.length == 0 ? "allDrives" : "drive",
+        driveId: config.driveId.length == 0 ? undefined : config.driveId,
+        fields: listFields,
+        includeItemsFromAllDrives: "true",
+        pageSize: Math.min(config.maxFilesPerPoll, maximumPollEventsPerPage),
+        pageToken,
+        q: query,
+        spaces: "drive",
+        supportsAllDrives: "true",
+    });
+    success(result, "files list");
+    const page = (record(result.data) ?? {});
+    const delivered = new Set(checkpoint.boundaryKeys ?? []);
+    const events = [];
+    const consumed = [];
+    let maxSeen = pageToken == null ? undefined : checkpoint.maxSeen;
+    for (const file of page.files ?? []) {
+        if (file.id == null || file.id.length == 0)
+            continue;
+        const timestamp = trackedTime(file, config.changeType);
+        if (timestamp == null)
+            continue;
+        const value = event(file, file.id, timestamp, config.changeType);
+        consumed.push(value.dedupeKey);
+        if (later(timestamp, maxSeen))
+            maxSeen = timestamp;
+        if (!delivered.has(value.dedupeKey))
+            events.push(value);
+    }
+    if (page.incompleteSearch === true) {
+        const drain = pageToken == null ? {} : pageState(pageToken, fingerprint, maxSeen);
+        return {
+            checkpoint: checkpointValue(checkpoint, config.changeType, checkpoint.since, consumed, drain),
+            events,
+        };
+    }
+    if (page.nextPageToken) {
+        return {
+            checkpoint: checkpointValue(checkpoint, config.changeType, checkpoint.since, consumed, pageState(page.nextPageToken, fingerprint, maxSeen)),
+            events,
+            hasMore: true,
+        };
+    }
+    const since = maxSeen ?? checkpoint.since;
+    return {
+        checkpoint: checkpointValue(checkpoint, config.changeType, since, consumed),
+        events,
+    };
+}
+function pageState(pageToken, pageQuery, maxSeen) {
+    return { pageQuery, pageToken, ...(maxSeen == null ? {} : { maxSeen }) };
+}
+function checkpointValue(previous, change, since, consumed, page = {}) {
+    const boundaryKeys = [...new Set([...(previous.boundaryKeys ?? []), ...consumed])]
+        .map((key) => ({ at: Date.parse(key.slice(key.indexOf(":") + 1)), key }))
+        .filter(({ at }) => at >= windowStart(since, previous.floor))
+        .toSorted((left, right) => right.at - left.at)
+        .slice(0, 200)
+        .map(({ key }) => key);
+    return {
+        changeType: change,
+        since,
+        ...floorField(previous.floor, since),
+        ...page,
+        ...(boundaryKeys.length == 0 ? {} : { boundaryKeys }),
+    };
+}
+function filesQuery(config, since, floorValue) {
+    const field = config.changeType == "created" ? "createdTime" : "modifiedTime";
+    const terms = [
+        `'${escape(config.folderId)}' in parents`,
+        "trashed = false",
+        `${field} >= '${new Date(windowStart(since, floorValue)).toISOString()}'`,
+    ];
+    if (!config.itemTypes.has("folder"))
+        terms.push(`mimeType != '${folderMimeType}'`);
+    else if (!config.itemTypes.has("file"))
+        terms.push(`mimeType = '${folderMimeType}'`);
+    if (config.mimeTypes.length > 0)
+        terms.push(`(${config.mimeTypes.map((type) => `mimeType = '${escape(type)}'`).join(" or ")})`);
+    if (config.namePrefix.length > 0)
+        terms.push(`name contains '${escape(config.namePrefix)}'`);
+    return terms.join(" and ");
+}
+function windowStart(since, floorValue) {
+    const start = Date.parse(since) - 60_000;
+    const minimum = floorValue == null ? Number.NaN : Date.parse(floorValue);
+    return Number.isNaN(minimum) ? start : Math.max(start, minimum);
+}
+function floorField(value, since) {
+    if (value == null || Number.isNaN(Date.parse(value)) || Date.parse(since) - 60_000 >= Date.parse(value))
+        return {};
+    return { floor: value };
+}
+function trackedTime(file, change) {
+    const value = change == "created" ? file.createdTime : file.modifiedTime;
+    return value == null || value.length == 0 || Number.isNaN(Date.parse(value)) ? undefined : value;
+}
+function event(file, id, timestamp, change) {
+    const itemType = file.mimeType == folderMimeType ? "folder" : "file";
+    const user = file.lastModifyingUser;
+    return {
+        dedupeKey: `${id}:${timestamp}`,
+        payload: {
+            createdTime: file.createdTime ?? null,
+            driveId: file.driveId ?? null,
+            eventType: `${itemType}_${change}`,
+            fileId: id,
+            itemType,
+            lastModifyingUser: user == null ? null : { displayName: user.displayName ?? "", emailAddress: user.emailAddress ?? "" },
+            mimeType: file.mimeType ?? "",
+            modifiedTime: file.modifiedTime ?? null,
+            name: file.name ?? "",
+            parents: file.parents ?? [],
+            ...(file.size == null ? {} : { size: file.size }),
+            webViewLink: file.webViewLink ?? null,
+        },
+    };
+}
+async function get(context, endpoint, query) {
+    try {
+        return await context.connector.execute({
+            endpoint,
+            method: "GET",
+            query: Object.fromEntries(Object.entries(query).filter((entry) => entry[1] != null)),
+        }, context.signal);
+    }
+    catch (cause) {
+        throw new TransientPollError(`Google Drive proxy request to ${endpoint} failed.`, { cause });
+    }
+}
+function success(result, operation) {
+    if (result.status >= 200 && result.status < 300)
+        return;
+    if (result.status == 400 || result.status == 404)
+        throw new PermanentPollError(`Google Drive ${operation} rejected the configuration.`);
+    if (result.status == 401)
+        throw new PollConnectionError(`Google Drive ${operation} rejected the Connection.`);
+    if (result.status == 403) {
+        const values = reasons(result.data);
+        if (values.some((reason) => transientReasons.has(reason)))
+            throw new TransientPollError(`Google Drive ${operation} was rate limited.`);
+        if (values.some((reason) => permanentReasons.has(reason)))
+            throw new PermanentPollError(`Google Drive ${operation} was rejected by an ACL.`);
+        if (insufficientScopes(result.data))
+            throw new PollConnectionError(`Google Drive ${operation} needs additional scopes.`);
+    }
+    throw new TransientPollError(`Google Drive ${operation} failed with status ${result.status}.`);
+}
+function reasons(data) {
+    const error = record(record(data)?.error);
+    const nested = [error?.errors, error?.details].flatMap((value) => (Array.isArray(value) ? value : []));
+    return [...nested.map((value) => record(value)?.reason), error?.status].filter((value) => typeof value == "string");
+}
+function insufficientScopes(data) {
+    if (reasons(data).includes("ACCESS_TOKEN_SCOPE_INSUFFICIENT"))
+        return true;
+    const message = record(record(data)?.error)?.message;
+    return typeof message == "string" && message.toLowerCase().includes("insufficient authentication scopes");
+}
+function escape(value) {
+    return value.replaceAll("\\", "\\\\").replaceAll("'", "\\'");
+}
+function later(candidate, current) {
+    const candidateMs = Date.parse(candidate);
+    if (Number.isNaN(candidateMs))
+        return false;
+    return current == null || Number.isNaN(Date.parse(current)) || candidateMs > Date.parse(current);
+}
+function record(value) {
+    return value != null && typeof value == "object" && !Array.isArray(value)
+        ? value
+        : undefined;
+}

package/src/providers/googleforms/executors.js

@@ -1,6 +1,6 @@
 import { compactObject, objectArray, optionalBoolean, optionalInteger, optionalRecord, optionalString, } from "../../core/cast.js";
-import { defineGoogleProviderExecutors, googleBearerProxyAuth, googleServiceAccountValidator } from "../google-auth.js";
-import { googleJsonRequest } from "../google-runtime.js";
+import { defineGoogleProviderExecutors, googleBearerProxyAuth, googleServiceAccountValidator, } from "../googledrive/runtime-auth.js";
+import { googleJsonRequest } from "../googledrive/runtime-request.js";
 import { defineProviderProxy, providerInputError, ProviderRequestError } from "../provider-runtime.js";
 import { googleFormsOAuthScopes } from "./scopes.js";
 export const googleFormsApiBaseUrl = "https://forms.googleapis.com/v1/forms";

package/src/providers/googleforms/scopes.d.ts

@@ -1,7 +1,4 @@
 export declare const googleFormsReadScope = "https://www.googleapis.com/auth/forms.body.readonly";
 export declare const googleFormsWriteScope = "https://www.googleapis.com/auth/forms.body";
 export declare const googleFormsResponsesReadScope = "https://www.googleapis.com/auth/forms.responses.readonly";
-export declare const googleOpenIdScope = "openid";
-export declare const googleEmailScope = "email";
-export declare const googleProfileScope = "profile";
 export declare const googleFormsOAuthScopes: string[];

package/src/providers/googleforms/scopes.js

@@ -1,14 +1,10 @@
+import { googleIdentityScopes } from "../googleads/scopes.js";
 export const googleFormsReadScope = "https://www.googleapis.com/auth/forms.body.readonly";
 export const googleFormsWriteScope = "https://www.googleapis.com/auth/forms.body";
 export const googleFormsResponsesReadScope = "https://www.googleapis.com/auth/forms.responses.readonly";
-export const googleOpenIdScope = "openid";
-export const googleEmailScope = "email";
-export const googleProfileScope = "profile";
 export const googleFormsOAuthScopes = [
     googleFormsReadScope,
     googleFormsWriteScope,
     googleFormsResponsesReadScope,
-    googleOpenIdScope,
-    googleEmailScope,
-    googleProfileScope,
+    ...googleIdentityScopes,
 ];

package/src/providers/googlemeet/executors.js

@@ -1,6 +1,6 @@
 import { compactObject, looseArray, optionalInteger, optionalRecord, optionalString, requiredRecord, } from "../../core/cast.js";
-import { defineGoogleProviderExecutors, googleBearerProxyAuth, googleServiceAccountValidator } from "../google-auth.js";
-import { googleJsonRequest } from "../google-runtime.js";
+import { defineGoogleProviderExecutors, googleBearerProxyAuth, googleServiceAccountValidator, } from "../googledrive/runtime-auth.js";
+import { googleJsonRequest } from "../googledrive/runtime-request.js";
 import { defineProviderProxy, providerProxyEndpointPrefixes, ProviderRequestError } from "../provider-runtime.js";
 import { googleMeetApiBaseUrl, googleMeetApiOrigin, googleMeetUserInfoUrl } from "./constants.js";
 import { googleMeetOAuthScopes } from "./scopes.js";

package/src/providers/googlemeet/scopes.d.ts

@@ -1,9 +1,6 @@
 export declare const googleMeetSpaceCreatedScope = "https://www.googleapis.com/auth/meetings.space.created";
 export declare const googleMeetSpaceReadonlyScope = "https://www.googleapis.com/auth/meetings.space.readonly";
 export declare const googleMeetSpaceSettingsScope = "https://www.googleapis.com/auth/meetings.space.settings";
-export declare const googleOpenIdScope = "openid";
-export declare const googleEmailScope = "email";
-export declare const googleProfileScope = "profile";
 export declare const googleMeetCreateScopes: string[];
 export declare const googleMeetReadScopes: string[];
 export declare const googleMeetSettingsScopes: string[];

package/src/providers/googlemeet/scopes.js

@@ -1,9 +1,7 @@
+import { googleIdentityScopes } from "../googleads/scopes.js";
 export const googleMeetSpaceCreatedScope = "https://www.googleapis.com/auth/meetings.space.created";
 export const googleMeetSpaceReadonlyScope = "https://www.googleapis.com/auth/meetings.space.readonly";
 export const googleMeetSpaceSettingsScope = "https://www.googleapis.com/auth/meetings.space.settings";
-export const googleOpenIdScope = "openid";
-export const googleEmailScope = "email";
-export const googleProfileScope = "profile";
 export const googleMeetCreateScopes = [googleMeetSpaceCreatedScope];
 export const googleMeetReadScopes = [googleMeetSpaceReadonlyScope];
 export const googleMeetSettingsScopes = [googleMeetSpaceSettingsScope];
@@ -11,7 +9,5 @@ export const googleMeetOAuthScopes = [
     googleMeetSpaceCreatedScope,
     googleMeetSpaceReadonlyScope,
     googleMeetSpaceSettingsScope,
-    googleOpenIdScope,
-    googleEmailScope,
-    googleProfileScope,
+    ...googleIdentityScopes,
 ];

package/src/providers/googlesheets/executors.d.ts

@@ -1,4 +1,6 @@
 import type { CredentialValidators, ProviderExecutors, ProviderProxyExecutor } from "../../core/types.ts";
+import type { IntegrationDefinition } from "../../triggers/common/integration.ts";
+import type { PollDefinition } from "../../triggers/common/poll.ts";
 import type { ProviderActionHandlers } from "../provider-runtime.ts";
 import type { OAuthProviderContext } from "../provider-runtime.ts";
 type ActionContext = OAuthProviderContext;
@@ -7,4 +9,5 @@ export declare const googlesheetsActionHandlers: ProviderActionHandlers<"googles
 export declare const executors: ProviderExecutors;
 export declare const credentialValidators: CredentialValidators;
 export declare const proxy: ProviderProxyExecutor;
+export declare const triggers: readonly (IntegrationDefinition | PollDefinition)[];
 export {};

package/src/providers/googlesheets/executors.js

@@ -1,4 +1,4 @@
-import { defineGoogleProviderExecutors, googleBearerProxyAuth, googleServiceAccountValidator } from "../google-auth.js";
+import { defineGoogleProviderExecutors, googleBearerProxyAuth, googleServiceAccountValidator, } from "../googledrive/runtime-auth.js";
 import { defineProviderProxy } from "../provider-runtime.js";
 import { addSheet, appendDimension, autoResizeDimensions, clearBasicFilter, copySheetToOtherSpreadsheet, createChart, deleteDimension, deleteSheet, findReplace, formatCell, insertDimension, mutateConditionalFormatRules, setBasicFilter, setDataValidationRule, updateDimensionProperties, updateSheetProperties, updateSpreadsheetProperties, } from "./runtime-batch-update.js";
 import { createGoogleSheet, getConditionalFormatRules, getDataValidationRules, getSheetNames, getSpreadsheetByDataFilter, getSpreadsheetInfo, searchDeveloperMetadata, searchSpreadsheets, } from "./runtime-metadata.js";
@@ -7,6 +7,7 @@ import { aggregateColumnData, createSpreadsheetColumn, createSpreadsheetRow, loo
 import { batchGetValues, batchGetValuesByDataFilter, getValues } from "./runtime-values.js";
 import { appendValues, batchClearValues, batchClearValuesByDataFilter, batchUpdateValuesByDataFilter, clearValues, updateValues, updateValuesBatch, } from "./runtime-values.js";
 import { googlesheetsOAuthScopes } from "./scopes.js";
+import { googleSheetsRowAdded } from "./trigger-on-row-added.js";
 const service = "googlesheets";
 const implementedActionHandlers = {
     search_spreadsheets(input, { accessToken, fetcher }) {
@@ -158,3 +159,4 @@ export const proxy = defineProviderProxy({
     baseUrl: "https://sheets.googleapis.com/v4",
     auth: googleBearerProxyAuth(googlesheetsOAuthScopes),
 });
+export const triggers = [googleSheetsRowAdded];

package/src/providers/googlesheets/scopes.js

@@ -1,3 +1,4 @@
+import { googleIdentityScopes } from "../googleads/scopes.js";
 export const googleSheetsReadonlyScope = "https://www.googleapis.com/auth/spreadsheets.readonly";
 export const googleSheetsFullScope = "https://www.googleapis.com/auth/spreadsheets";
 export const googleDriveReadonlyScope = "https://www.googleapis.com/auth/drive.readonly";
@@ -9,4 +10,5 @@ export const googlesheetsOAuthScopes = [
     googleSheetsFullScope,
     googleDriveReadonlyScope,
     googleDriveFullScope,
+    ...googleIdentityScopes,
 ];

package/src/providers/googlesheets/trigger-on-row-added.d.ts

@@ -0,0 +1,2 @@
+import type { PollDefinition } from "../../triggers/common/poll.ts";
+export declare const googleSheetsRowAdded: PollDefinition;

package/src/providers/googlesheets/trigger-on-row-added.definition.d.ts

@@ -0,0 +1,4 @@
+import type { TriggerKeySnapshot } from "../../triggers/common/types.ts";
+export declare const snapshot: TriggerKeySnapshot & {
+    readonly type: "poll";
+};

package/src/providers/googlesheets/trigger-on-row-added.definition.js

@@ -0,0 +1,54 @@
+import { jsonSchema as s } from "../../core/json-schema.js";
+const eventSchema = s.object({
+    row: { type: "object" },
+    rowNumber: s.integer(),
+    sheetId: s.integer(),
+    sheetTitle: s.string(),
+    spreadsheetId: s.string(),
+    values: s.array({}),
+}, { additionalProperties: false, required: ["spreadsheetId", "sheetId", "sheetTitle", "rowNumber", "row", "values"] });
+export const snapshot = {
+    configInputs: [
+        {
+            handle: "columnRange",
+            jsonSchema: s.string({ pattern: "^[A-Za-z]{1,3}(?::[A-Za-z]{1,3})?$" }),
+            nullable: false,
+            value: "A:ZZZ",
+        },
+        {
+            handle: "dateTimeRender",
+            jsonSchema: s.stringEnum(["FORMATTED_STRING", "SERIAL_NUMBER"]),
+            nullable: false,
+            value: "FORMATTED_STRING",
+        },
+        {
+            handle: "firstDataRow",
+            jsonSchema: s.integer({ minimum: 1 }),
+            nullable: false,
+            value: 2,
+        },
+        { handle: "headerRow", jsonSchema: s.integer({ minimum: 1 }), nullable: false, value: 1 },
+        {
+            handle: "maxRowsPerPoll",
+            jsonSchema: s.integer({ maximum: 500, minimum: 1 }),
+            nullable: false,
+            value: 100,
+        },
+        { handle: "sheet", jsonSchema: s.string({ minLength: 1 }), nullable: false },
+        { handle: "spreadsheetId", jsonSchema: s.string({ minLength: 1 }), nullable: false },
+        {
+            handle: "valueRender",
+            jsonSchema: s.stringEnum(["UNFORMATTED_VALUE", "FORMATTED_VALUE", "FORMULA"]),
+            nullable: false,
+            value: "UNFORMATTED_VALUE",
+        },
+    ],
+    definitionVersion: 2,
+    description: "Polls a sheet and triggers once for every new row appended below the last row already seen.",
+    displayName: "New Row Added",
+    key: "googlesheets.on_row_added",
+    name: "on_row_added",
+    outputs: [{ handle: "events", jsonSchema: s.array(eventSchema), nullable: false }],
+    provider: "googlesheets",
+    type: "poll",
+};