@particle-academy/google-calendar-ui 0.0.0 → 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,199 @@
+import * as _particle_academy_fancy_flow_connectors from '@particle-academy/fancy-flow/connectors';
+import { ConnectorMeta, OutputField } from '@particle-academy/fancy-flow/connectors';
+import { NodeKindDefinition } from '@particle-academy/fancy-flow/engine';
+
+/**
+ * GENERATED FILE — do not edit.
+ *
+ * Emitted from provider/manifest.json by weaver's generator.
+ * A hand-edit here is destroyed by the next protocol sync, which is worse than
+ * being rejected, because it works until it silently does not. Fix
+ * provider/manifest.json (or weaver's template/) and regenerate:
+ *
+ *     npm run provider -- google_calendar
+ */
+/**
+ * Google Calendar's identity on the authoring surface, shared by every Google
+ * Calendar node.
+ *
+ * This file must import nothing from the js package: a PHP or Python project
+ * installs the ui package and never that one, and the import would be a
+ * dangling module the moment it did.
+ *
+ * ## The sandbox trap
+ *
+ * Google has no sandbox for Calendar. A test calendar is a real one in a real
+ * account, so every watch and every read is real -- point this at a scratch
+ * calendar, not a production one. The faker is the only way to develop against
+ * it without touching an account.
+ */
+
+/**
+ * The connector API version this package was GENERATED against.
+ *
+ * A literal, never imported — an imported constant lets an upgrade rewrite the
+ * very claim it exists to detect.
+ */
+declare const CONNECTOR_API_VERSION = 1;
+/** The parts of a connector's identity that belong to the SERVICE, not the node. */
+declare const GOOGLE_CALENDAR_SERVICE: {
+    readonly service: "google_calendar";
+    readonly serviceTitle: "Google Calendar";
+    readonly domain: "calendar";
+    readonly sandbox: "none";
+};
+/** The credentials a Google Calendar connection holds. */
+declare const GOOGLE_CALENDAR_CREDENTIALS: readonly [{
+    readonly key: "clientId";
+    readonly label: "OAuth client ID";
+    readonly scope: "provider";
+    readonly secret: false;
+    readonly help: "From Google Cloud Console -> APIs & Services -> Credentials. ONE value for the whole installation, not per connected account.";
+}, {
+    readonly key: "clientSecret";
+    readonly label: "OAuth client secret";
+    readonly scope: "provider";
+    readonly secret: true;
+    readonly help: "The client secret for the same OAuth app. One value for the whole installation.";
+}, {
+    readonly key: "accessToken";
+    readonly label: "Access token";
+    readonly scope: "account";
+    readonly secret: true;
+    readonly help: "Per connected Google account, and it expires after ONE HOUR. The host refreshes it with the refresh token.";
+}, {
+    readonly key: "refreshToken";
+    readonly label: "Refresh token";
+    readonly scope: "account";
+    readonly secret: true;
+    readonly help: "Per connected Google account. Google issues one only when the consent request asks for offline access; without it the connection dies within the hour.";
+}, {
+    readonly key: "channelToken";
+    readonly label: "Channel token";
+    readonly scope: "account";
+    readonly secret: true;
+    readonly help: "A secret the host chooses per connected account and sends as `token` on every events.watch. Google echoes it back in the X-Goog-Channel-Token header of every notification, and that echo is the ONLY thing that authenticates a delivery -- Google does not sign them. Up to 256 characters.";
+}];
+/**
+ * The OAuth2 exchange Google Calendar requires — DECLARED here, performed by
+ * the host.
+ *
+ * A consent screen needs a browser, a redirect URI and somewhere to persist
+ * the result, and all three belong to the host; a package that ran the dance
+ * itself would have to own a web server. So this says precisely enough for a
+ * host to do it.
+ *
+ * The access token lasts 3600 seconds. A host that never refreshes will work
+ * all afternoon and be broken by morning, which is why the lifetime is stated
+ * rather than left to be discovered.
+ *
+ * Its refresh tokens do NOT rotate: the same one is reusable, so a refresh may
+ * safely be retried and may run concurrently. That is stated rather than
+ * assumed because the opposite — a provider that spends the token and revokes
+ * the grant on a replay — looks identical until it happens.
+ */
+declare const GOOGLE_CALENDAR_OAUTH: {
+    readonly flow: "authorization_code";
+    readonly authorizeUrl: "https://accounts.google.com/o/oauth2/v2/auth";
+    readonly tokenUrl: "https://oauth2.googleapis.com/token";
+    readonly scopes: readonly ["https://www.googleapis.com/auth/calendar.events"];
+    readonly accessTokenCredential: "accessToken";
+    readonly refreshTokenCredential: "refreshToken";
+    readonly refreshTokenRotates: false;
+    readonly accessTokenTtlSeconds: 3600;
+};
+/** Build a Google Calendar node's connector metadata from the operation it performs. */
+declare function googleCalendarMeta(role: ConnectorMeta["role"], operation: string, docs: string): ConnectorMeta;
+
+declare const GOOGLE_CALENDAR_CHANNEL_STOP_KIND = "@particle-academy/google_calendar_channel_stop";
+declare const GOOGLE_CALENDAR_CHANNEL_STOP_OPERATION = "channel_stop";
+declare const GOOGLE_CALENDAR_CHANNEL_STOP_META: _particle_academy_fancy_flow_connectors.ConnectorMeta;
+/**
+ * What this node emits — the "ingredients" a downstream node can reference.
+ *
+ * fancy-flow reads `outputShape` off the kind and offers it in the variable
+ * picker, so declaring it is the whole of the work: an author configuring the
+ * next node picks `{{ $json.data.id }}` off a list instead of typing a path
+ * and hoping.
+ */
+declare const GOOGLE_CALENDAR_CHANNEL_STOP_OUTPUT: OutputField[];
+declare const googleCalendarChannelStopKind: NodeKindDefinition;
+
+declare const GOOGLE_CALENDAR_CHANNEL_WATCH_KIND = "@particle-academy/google_calendar_channel_watch";
+declare const GOOGLE_CALENDAR_CHANNEL_WATCH_OPERATION = "channel_watch";
+declare const GOOGLE_CALENDAR_CHANNEL_WATCH_META: _particle_academy_fancy_flow_connectors.ConnectorMeta;
+/**
+ * What this node emits — the "ingredients" a downstream node can reference.
+ *
+ * fancy-flow reads `outputShape` off the kind and offers it in the variable
+ * picker, so declaring it is the whole of the work: an author configuring the
+ * next node picks `{{ $json.data.id }}` off a list instead of typing a path
+ * and hoping.
+ */
+declare const GOOGLE_CALENDAR_CHANNEL_WATCH_OUTPUT: OutputField[];
+declare const googleCalendarChannelWatchKind: NodeKindDefinition;
+
+declare const GOOGLE_CALENDAR_EVENT_GET_KIND = "@particle-academy/google_calendar_event_get";
+declare const GOOGLE_CALENDAR_EVENT_GET_OPERATION = "event_get";
+declare const GOOGLE_CALENDAR_EVENT_GET_META: _particle_academy_fancy_flow_connectors.ConnectorMeta;
+/**
+ * What this node emits — the "ingredients" a downstream node can reference.
+ *
+ * fancy-flow reads `outputShape` off the kind and offers it in the variable
+ * picker, so declaring it is the whole of the work: an author configuring the
+ * next node picks `{{ $json.data.id }}` off a list instead of typing a path
+ * and hoping.
+ */
+declare const GOOGLE_CALENDAR_EVENT_GET_OUTPUT: OutputField[];
+declare const googleCalendarEventGetKind: NodeKindDefinition;
+
+declare const GOOGLE_CALENDAR_EVENT_LIST_KIND = "@particle-academy/google_calendar_event_list";
+declare const GOOGLE_CALENDAR_EVENT_LIST_OPERATION = "event_list";
+declare const GOOGLE_CALENDAR_EVENT_LIST_META: _particle_academy_fancy_flow_connectors.ConnectorMeta;
+/**
+ * What this node emits — the "ingredients" a downstream node can reference.
+ *
+ * fancy-flow reads `outputShape` off the kind and offers it in the variable
+ * picker, so declaring it is the whole of the work: an author configuring the
+ * next node picks `{{ $json.data.id }}` off a list instead of typing a path
+ * and hoping.
+ */
+declare const GOOGLE_CALENDAR_EVENT_LIST_OUTPUT: OutputField[];
+declare const googleCalendarEventListKind: NodeKindDefinition;
+
+declare const GOOGLE_CALENDAR_EVENTS_CHANGED_TRIGGER_KIND = "@particle-academy/google_calendar_events_changed_trigger";
+declare const GOOGLE_CALENDAR_EVENTS_CHANGED_TRIGGER_OPERATION = "events_changed";
+declare const GOOGLE_CALENDAR_EVENTS_CHANGED_TRIGGER_META: _particle_academy_fancy_flow_connectors.ConnectorMeta;
+/**
+ * What this node emits — the "ingredients" a downstream node can reference.
+ *
+ * fancy-flow reads `outputShape` off the kind and offers it in the variable
+ * picker, so declaring it is the whole of the work: an author configuring the
+ * next node picks `{{ $json.data.id }}` off a list instead of typing a path
+ * and hoping.
+ */
+declare const GOOGLE_CALENDAR_EVENTS_CHANGED_TRIGGER_OUTPUT: OutputField[];
+declare const googleCalendarEventsChangedTriggerKind: NodeKindDefinition;
+
+/**
+ * GENERATED FILE — do not edit.
+ *
+ * Emitted from provider/manifest.json by weaver's generator.
+ * A hand-edit here is destroyed by the next protocol sync, which is worse than
+ * being rejected, because it works until it silently does not. Fix
+ * provider/manifest.json (or weaver's template/) and regenerate:
+ *
+ *     npm run provider -- google_calendar
+ */
+/**
+ * Google Calendar's node kinds for fancy-flow.
+ *
+ * Install this on every host. The TypeScript executors live in the js
+ * package's `./flow` subpath; PHP and Python hosts run their own and need only
+ * this.
+ */
+
+/** Every Google Calendar kind, for a host that registers the lot. */
+declare const GOOGLE_CALENDAR_KINDS: NodeKindDefinition[];
+
+export { CONNECTOR_API_VERSION, GOOGLE_CALENDAR_CHANNEL_STOP_KIND, GOOGLE_CALENDAR_CHANNEL_STOP_META, GOOGLE_CALENDAR_CHANNEL_STOP_OPERATION, GOOGLE_CALENDAR_CHANNEL_STOP_OUTPUT, GOOGLE_CALENDAR_CHANNEL_WATCH_KIND, GOOGLE_CALENDAR_CHANNEL_WATCH_META, GOOGLE_CALENDAR_CHANNEL_WATCH_OPERATION, GOOGLE_CALENDAR_CHANNEL_WATCH_OUTPUT, GOOGLE_CALENDAR_CREDENTIALS, GOOGLE_CALENDAR_EVENTS_CHANGED_TRIGGER_KIND, GOOGLE_CALENDAR_EVENTS_CHANGED_TRIGGER_META, GOOGLE_CALENDAR_EVENTS_CHANGED_TRIGGER_OPERATION, GOOGLE_CALENDAR_EVENTS_CHANGED_TRIGGER_OUTPUT, GOOGLE_CALENDAR_EVENT_GET_KIND, GOOGLE_CALENDAR_EVENT_GET_META, GOOGLE_CALENDAR_EVENT_GET_OPERATION, GOOGLE_CALENDAR_EVENT_GET_OUTPUT, GOOGLE_CALENDAR_EVENT_LIST_KIND, GOOGLE_CALENDAR_EVENT_LIST_META, GOOGLE_CALENDAR_EVENT_LIST_OPERATION, GOOGLE_CALENDAR_EVENT_LIST_OUTPUT, GOOGLE_CALENDAR_KINDS, GOOGLE_CALENDAR_OAUTH, GOOGLE_CALENDAR_SERVICE, googleCalendarChannelStopKind, googleCalendarChannelWatchKind, googleCalendarEventGetKind, googleCalendarEventListKind, googleCalendarEventsChangedTriggerKind, googleCalendarMeta };

package/dist/index.d.ts

@@ -0,0 +1,199 @@
+import * as _particle_academy_fancy_flow_connectors from '@particle-academy/fancy-flow/connectors';
+import { ConnectorMeta, OutputField } from '@particle-academy/fancy-flow/connectors';
+import { NodeKindDefinition } from '@particle-academy/fancy-flow/engine';
+
+/**
+ * GENERATED FILE — do not edit.
+ *
+ * Emitted from provider/manifest.json by weaver's generator.
+ * A hand-edit here is destroyed by the next protocol sync, which is worse than
+ * being rejected, because it works until it silently does not. Fix
+ * provider/manifest.json (or weaver's template/) and regenerate:
+ *
+ *     npm run provider -- google_calendar
+ */
+/**
+ * Google Calendar's identity on the authoring surface, shared by every Google
+ * Calendar node.
+ *
+ * This file must import nothing from the js package: a PHP or Python project
+ * installs the ui package and never that one, and the import would be a
+ * dangling module the moment it did.
+ *
+ * ## The sandbox trap
+ *
+ * Google has no sandbox for Calendar. A test calendar is a real one in a real
+ * account, so every watch and every read is real -- point this at a scratch
+ * calendar, not a production one. The faker is the only way to develop against
+ * it without touching an account.
+ */
+
+/**
+ * The connector API version this package was GENERATED against.
+ *
+ * A literal, never imported — an imported constant lets an upgrade rewrite the
+ * very claim it exists to detect.
+ */
+declare const CONNECTOR_API_VERSION = 1;
+/** The parts of a connector's identity that belong to the SERVICE, not the node. */
+declare const GOOGLE_CALENDAR_SERVICE: {
+    readonly service: "google_calendar";
+    readonly serviceTitle: "Google Calendar";
+    readonly domain: "calendar";
+    readonly sandbox: "none";
+};
+/** The credentials a Google Calendar connection holds. */
+declare const GOOGLE_CALENDAR_CREDENTIALS: readonly [{
+    readonly key: "clientId";
+    readonly label: "OAuth client ID";
+    readonly scope: "provider";
+    readonly secret: false;
+    readonly help: "From Google Cloud Console -> APIs & Services -> Credentials. ONE value for the whole installation, not per connected account.";
+}, {
+    readonly key: "clientSecret";
+    readonly label: "OAuth client secret";
+    readonly scope: "provider";
+    readonly secret: true;
+    readonly help: "The client secret for the same OAuth app. One value for the whole installation.";
+}, {
+    readonly key: "accessToken";
+    readonly label: "Access token";
+    readonly scope: "account";
+    readonly secret: true;
+    readonly help: "Per connected Google account, and it expires after ONE HOUR. The host refreshes it with the refresh token.";
+}, {
+    readonly key: "refreshToken";
+    readonly label: "Refresh token";
+    readonly scope: "account";
+    readonly secret: true;
+    readonly help: "Per connected Google account. Google issues one only when the consent request asks for offline access; without it the connection dies within the hour.";
+}, {
+    readonly key: "channelToken";
+    readonly label: "Channel token";
+    readonly scope: "account";
+    readonly secret: true;
+    readonly help: "A secret the host chooses per connected account and sends as `token` on every events.watch. Google echoes it back in the X-Goog-Channel-Token header of every notification, and that echo is the ONLY thing that authenticates a delivery -- Google does not sign them. Up to 256 characters.";
+}];
+/**
+ * The OAuth2 exchange Google Calendar requires — DECLARED here, performed by
+ * the host.
+ *
+ * A consent screen needs a browser, a redirect URI and somewhere to persist
+ * the result, and all three belong to the host; a package that ran the dance
+ * itself would have to own a web server. So this says precisely enough for a
+ * host to do it.
+ *
+ * The access token lasts 3600 seconds. A host that never refreshes will work
+ * all afternoon and be broken by morning, which is why the lifetime is stated
+ * rather than left to be discovered.
+ *
+ * Its refresh tokens do NOT rotate: the same one is reusable, so a refresh may
+ * safely be retried and may run concurrently. That is stated rather than
+ * assumed because the opposite — a provider that spends the token and revokes
+ * the grant on a replay — looks identical until it happens.
+ */
+declare const GOOGLE_CALENDAR_OAUTH: {
+    readonly flow: "authorization_code";
+    readonly authorizeUrl: "https://accounts.google.com/o/oauth2/v2/auth";
+    readonly tokenUrl: "https://oauth2.googleapis.com/token";
+    readonly scopes: readonly ["https://www.googleapis.com/auth/calendar.events"];
+    readonly accessTokenCredential: "accessToken";
+    readonly refreshTokenCredential: "refreshToken";
+    readonly refreshTokenRotates: false;
+    readonly accessTokenTtlSeconds: 3600;
+};
+/** Build a Google Calendar node's connector metadata from the operation it performs. */
+declare function googleCalendarMeta(role: ConnectorMeta["role"], operation: string, docs: string): ConnectorMeta;
+
+declare const GOOGLE_CALENDAR_CHANNEL_STOP_KIND = "@particle-academy/google_calendar_channel_stop";
+declare const GOOGLE_CALENDAR_CHANNEL_STOP_OPERATION = "channel_stop";
+declare const GOOGLE_CALENDAR_CHANNEL_STOP_META: _particle_academy_fancy_flow_connectors.ConnectorMeta;
+/**
+ * What this node emits — the "ingredients" a downstream node can reference.
+ *
+ * fancy-flow reads `outputShape` off the kind and offers it in the variable
+ * picker, so declaring it is the whole of the work: an author configuring the
+ * next node picks `{{ $json.data.id }}` off a list instead of typing a path
+ * and hoping.
+ */
+declare const GOOGLE_CALENDAR_CHANNEL_STOP_OUTPUT: OutputField[];
+declare const googleCalendarChannelStopKind: NodeKindDefinition;
+
+declare const GOOGLE_CALENDAR_CHANNEL_WATCH_KIND = "@particle-academy/google_calendar_channel_watch";
+declare const GOOGLE_CALENDAR_CHANNEL_WATCH_OPERATION = "channel_watch";
+declare const GOOGLE_CALENDAR_CHANNEL_WATCH_META: _particle_academy_fancy_flow_connectors.ConnectorMeta;
+/**
+ * What this node emits — the "ingredients" a downstream node can reference.
+ *
+ * fancy-flow reads `outputShape` off the kind and offers it in the variable
+ * picker, so declaring it is the whole of the work: an author configuring the
+ * next node picks `{{ $json.data.id }}` off a list instead of typing a path
+ * and hoping.
+ */
+declare const GOOGLE_CALENDAR_CHANNEL_WATCH_OUTPUT: OutputField[];
+declare const googleCalendarChannelWatchKind: NodeKindDefinition;
+
+declare const GOOGLE_CALENDAR_EVENT_GET_KIND = "@particle-academy/google_calendar_event_get";
+declare const GOOGLE_CALENDAR_EVENT_GET_OPERATION = "event_get";
+declare const GOOGLE_CALENDAR_EVENT_GET_META: _particle_academy_fancy_flow_connectors.ConnectorMeta;
+/**
+ * What this node emits — the "ingredients" a downstream node can reference.
+ *
+ * fancy-flow reads `outputShape` off the kind and offers it in the variable
+ * picker, so declaring it is the whole of the work: an author configuring the
+ * next node picks `{{ $json.data.id }}` off a list instead of typing a path
+ * and hoping.
+ */
+declare const GOOGLE_CALENDAR_EVENT_GET_OUTPUT: OutputField[];
+declare const googleCalendarEventGetKind: NodeKindDefinition;
+
+declare const GOOGLE_CALENDAR_EVENT_LIST_KIND = "@particle-academy/google_calendar_event_list";
+declare const GOOGLE_CALENDAR_EVENT_LIST_OPERATION = "event_list";
+declare const GOOGLE_CALENDAR_EVENT_LIST_META: _particle_academy_fancy_flow_connectors.ConnectorMeta;
+/**
+ * What this node emits — the "ingredients" a downstream node can reference.
+ *
+ * fancy-flow reads `outputShape` off the kind and offers it in the variable
+ * picker, so declaring it is the whole of the work: an author configuring the
+ * next node picks `{{ $json.data.id }}` off a list instead of typing a path
+ * and hoping.
+ */
+declare const GOOGLE_CALENDAR_EVENT_LIST_OUTPUT: OutputField[];
+declare const googleCalendarEventListKind: NodeKindDefinition;
+
+declare const GOOGLE_CALENDAR_EVENTS_CHANGED_TRIGGER_KIND = "@particle-academy/google_calendar_events_changed_trigger";
+declare const GOOGLE_CALENDAR_EVENTS_CHANGED_TRIGGER_OPERATION = "events_changed";
+declare const GOOGLE_CALENDAR_EVENTS_CHANGED_TRIGGER_META: _particle_academy_fancy_flow_connectors.ConnectorMeta;
+/**
+ * What this node emits — the "ingredients" a downstream node can reference.
+ *
+ * fancy-flow reads `outputShape` off the kind and offers it in the variable
+ * picker, so declaring it is the whole of the work: an author configuring the
+ * next node picks `{{ $json.data.id }}` off a list instead of typing a path
+ * and hoping.
+ */
+declare const GOOGLE_CALENDAR_EVENTS_CHANGED_TRIGGER_OUTPUT: OutputField[];
+declare const googleCalendarEventsChangedTriggerKind: NodeKindDefinition;
+
+/**
+ * GENERATED FILE — do not edit.
+ *
+ * Emitted from provider/manifest.json by weaver's generator.
+ * A hand-edit here is destroyed by the next protocol sync, which is worse than
+ * being rejected, because it works until it silently does not. Fix
+ * provider/manifest.json (or weaver's template/) and regenerate:
+ *
+ *     npm run provider -- google_calendar
+ */
+/**
+ * Google Calendar's node kinds for fancy-flow.
+ *
+ * Install this on every host. The TypeScript executors live in the js
+ * package's `./flow` subpath; PHP and Python hosts run their own and need only
+ * this.
+ */
+
+/** Every Google Calendar kind, for a host that registers the lot. */
+declare const GOOGLE_CALENDAR_KINDS: NodeKindDefinition[];
+
+export { CONNECTOR_API_VERSION, GOOGLE_CALENDAR_CHANNEL_STOP_KIND, GOOGLE_CALENDAR_CHANNEL_STOP_META, GOOGLE_CALENDAR_CHANNEL_STOP_OPERATION, GOOGLE_CALENDAR_CHANNEL_STOP_OUTPUT, GOOGLE_CALENDAR_CHANNEL_WATCH_KIND, GOOGLE_CALENDAR_CHANNEL_WATCH_META, GOOGLE_CALENDAR_CHANNEL_WATCH_OPERATION, GOOGLE_CALENDAR_CHANNEL_WATCH_OUTPUT, GOOGLE_CALENDAR_CREDENTIALS, GOOGLE_CALENDAR_EVENTS_CHANGED_TRIGGER_KIND, GOOGLE_CALENDAR_EVENTS_CHANGED_TRIGGER_META, GOOGLE_CALENDAR_EVENTS_CHANGED_TRIGGER_OPERATION, GOOGLE_CALENDAR_EVENTS_CHANGED_TRIGGER_OUTPUT, GOOGLE_CALENDAR_EVENT_GET_KIND, GOOGLE_CALENDAR_EVENT_GET_META, GOOGLE_CALENDAR_EVENT_GET_OPERATION, GOOGLE_CALENDAR_EVENT_GET_OUTPUT, GOOGLE_CALENDAR_EVENT_LIST_KIND, GOOGLE_CALENDAR_EVENT_LIST_META, GOOGLE_CALENDAR_EVENT_LIST_OPERATION, GOOGLE_CALENDAR_EVENT_LIST_OUTPUT, GOOGLE_CALENDAR_KINDS, GOOGLE_CALENDAR_OAUTH, GOOGLE_CALENDAR_SERVICE, googleCalendarChannelStopKind, googleCalendarChannelWatchKind, googleCalendarEventGetKind, googleCalendarEventListKind, googleCalendarEventsChangedTriggerKind, googleCalendarMeta };