@opengeni/connect 0.2.0-canary.0

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Cloudgeni-ai
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,112 @@
+# Browser authorization handoff
+
+Browser hosts can use `createBrowserConnectNavigation(window)` with the helper
+below. Importing the package does not access `window`. Popup mode opens a fresh
+blank window, clears its opener before provider navigation, and retains a close
+handle. If isolation fails, it closes the blank window and reports a generic
+error; a blocked popup does not silently redirect. Full redirect remains an
+explicit host choice. Browser security policies may sever the popup handle;
+completion is still obtained from the backend, never from that handle.
+
+`authorizeConnectAttempt(transport, attempt, navigation, options)` accepts an
+injected `ConnectNavigation` adapter and either `popup` or `redirect` mode.
+Call popup mode directly from a user gesture: opening is synchronous, a blocked
+popup throws explicitly, and only backend polling determines the result. The
+popup is closed when polling settles. Cancellation stops polling, not the
+durable server attempt; cancel that explicitly through the controller if desired.
+
+For redirect mode, retain the opaque attempt ID in host-owned state before
+calling the helper. It passes the authorization URL unchanged and returns `null`;
+recover the attempt and poll after returning. No completion query parameters or
+window messages are required or trusted. Authorization destinations must use
+HTTPS without embedded credentials. Provider adapters run on the server;
+optional setup and account presentation lives in `@opengeni/react/connect`.
+
+# @opengeni/connect
+
+Framework-neutral state for a durable OpenGeni connection setup attempt. This
+package contains no React, browser storage, provider SDK, or server credentials.
+Use `ConnectController` with an authenticated `ConnectTransport`; use
+`@opengeni/react/connect` to observe that same controller from React.
+
+The controller forwards the exact return URL, models credentials committed
+separately from integration installed, preserves revision/idempotency fences,
+and rejects responses for another workspace or attempt. Popup messages and
+navigation are not proof of completion: recover or refresh the durable attempt
+through the transport. List pending attempts through `transport.pending` when
+the opener or browser state is lost.
+
+Controller snapshots retain only a fixed generic transport-failure message, not
+raw error messages, causes or request objects that could contain credentials.
+Method rejections still reach the direct caller unchanged; hosts must redact
+those errors before logging or displaying them. Backend attempt projections
+must likewise remain credential-free.
+
+Create one controller for the selected workspace and dispose it when the host
+replaces that workspace or its authenticated user. Observer unmount is not
+controller disposal. Secret form values go only to `advance`; snapshots never
+retain submitted values. The transport must sanitize server error responses.
+
+The implementation branch now has durable curated OAuth begin/read endpoints
+and SDK `beginConnect`, `getConnectAttempt`, and `listPendingConnectAttempts`.
+Use these on the trusted host backend through an `asUser` client. Retain the
+attempt ID before navigation. The callback returns to the exact stored host URL
+without appended parameters; querying the attempt distinguishes committed
+credentials from finished integration installation. Repeated callbacks replay a
+receipt without repeating the provider token exchange.
+
+Curated attempts also support SDK `advanceConnectAttempt` and
+`cancelConnectAttempt`. Advance with `retry` to obtain a preview after OAuth;
+then install with its revision/content hash and explicitly selected operation
+IDs. Changed source returns a fresh preview for review. Cancellation stops setup
+without revoking credentials already saved. The unstyled setup form exposes
+these review/install controls and labels each operation's risk category.
+
+On the trusted host backend, `client.asUser(externalId).connectTransport()`
+supplies the complete transport interface using the client's fixed actor,
+contract checks, error handling and abort signal support. Never send that
+organization-key client to the browser. A browser transport must call the host's
+authenticated backend, which derives the actor from its own session and checks
+workspace access; browser-supplied actor IDs are not proof of identity.
+
+Catalog readiness reflects curated provider configuration and current access.
+Accounts expose connection metadata, not credentials. `disconnect` uses the
+existing local connection-revocation endpoint: it removes OpenGeni access, not
+upstream provider consent. Aborting an in-flight mutation stops observation and
+does not guarantee that the server rolled it back; recover durable attempts
+before deciding whether to retry. A signal already aborted before dispatch
+prevents the SDK request from being sent.
+
+The server catalog reports provider readiness and ownership requirements. Native
+setup and embedding products share the controller and React setup surface.
+Reconnect uses an observed account/version; provider-specific installation and
+resource selection remain explicit next actions. Controller tests alone do not
+prove backend authorization or vendor OAuth conformance.
+
+Model-account device flows retain their existing pool APIs and can share
+`pollDeviceAuthorization` and the optional React `DeviceAuthorization` surface.
+
+`findConnectRecoveryAccount(accounts, connectionId)` resolves timeline auth-needed
+events to the exact fresh account, including social-domain IDs. It never guesses
+by provider or label. Missing accounts need explicit user selection; host-managed
+credentials recover through the product's own account flow.
+
+`@opengeni/react/connect` also exports `ConnectSetup`, an unstyled setup form.
+Pass the controller and an `onAuthorize(attempt)` callback (called directly from
+the click handler, so it can open a popup). It labels ownership, requires explicit
+account selection, clears credential inputs before awaiting submission, and
+never preselects installation operations. `onBrowseResources` lets the host own
+paginated selections; the built-in form refuses to submit an incomplete page.
+`ConnectChooser` from the same React export supplies an optional unstyled
+provider/ownership form. Pass `controller` and the exact `returnUrl`; it uses
+`transport.catalog` readiness, disables unavailable providers and requires an
+explicit ownership choice. Replace the controller on actor/workspace changes;
+stale catalog responses are discarded. Hosts still provide navigation, account
+management and pending-attempt recovery. Backend readiness and authorization
+remain mandatory; browser-disabled options are not an access-control boundary.
+
+`controller.waitForAction({ timeoutMs })` polls the selected attempt and publishes
+the resulting action or terminal state to subscribers (also exposed by
+`useConnect`). It rejects revisions older than the selected snapshot, never
+retries mutations, and stops when the controller is disposed or another attempt
+is selected. A timeout stops observation, not the durable server operation.

package/dist/authorization.d.ts

@@ -0,0 +1,16 @@
+import type { ConnectAttempt, ConnectTransport } from "./types.js";
+/** Inject navigation so hosts own routing and this package needs no DOM globals. */
+export type ConnectNavigation = {
+    openPopup(url: string): {
+        close(): void;
+    } | null;
+    redirect(url: string): void;
+};
+/** Invoke directly from a user gesture for popup mode. Persist the opaque
+ * attempt ID in host-owned state before redirect mode, then recover/poll on
+ * return. Neither URL parameters nor popup messages prove completion. */
+export declare function authorizeConnectAttempt(transport: Pick<ConnectTransport, "get">, attempt: ConnectAttempt, navigation: ConnectNavigation, options: {
+    mode: "popup" | "redirect";
+    signal?: AbortSignal;
+    timeoutMs?: number;
+}): Promise<ConnectAttempt | null>;

package/dist/browser-navigation.d.ts

@@ -0,0 +1,19 @@
+import type { ConnectNavigation } from "./authorization.js";
+/** Structural browser surface so importing Connect never reads DOM globals. */
+export type ConnectBrowserWindow = {
+    open(url: string, target: string, features: string): {
+        opener: unknown;
+        location: {
+            replace(url: string): void;
+        };
+        close(): void;
+    } | null;
+    location: {
+        assign(url: string): void;
+    };
+};
+/** Pass window from the host's browser entry point. Opens a fresh blank window
+ * synchronously and severs its opener BEFORE any provider content can load.
+ * Never uses a reusable named target or relies on provider window messages.
+ * The caller retains only the close capability for backend-polling cleanup. */
+export declare function createBrowserConnectNavigation(browser: ConnectBrowserWindow): ConnectNavigation;

package/dist/device.d.ts

@@ -0,0 +1,17 @@
+/** Shared device-code behavior for model-account domains. These accounts keep
+ * their existing APIs and ownership semantics; they are not generic credentials.
+ * Keep opaque provider state on the host backend when reload recovery is needed. */
+export declare function pollDeviceAuthorization<T extends {
+    status: string;
+    intervalSeconds?: number;
+}>(options: {
+    poll: () => Promise<T>;
+    expired: T;
+    initialIntervalSeconds: number;
+    expiresAtMs: number;
+    signal: AbortSignal;
+    retryable?: (error: unknown) => boolean;
+    now?: () => number;
+    wait?: (delayMs: number, signal: AbortSignal) => Promise<boolean>;
+    maxRetryDelaySeconds?: number;
+}): Promise<T | null>;

package/dist/index.d.ts

@@ -0,0 +1,49 @@
+export * from "./types.js";
+export { pollDeviceAuthorization } from "./device.js";
+export { findConnectRecoveryAccount } from "./recovery.js";
+export { pollConnectAttempt } from "./poll.js";
+export { authorizeConnectAttempt, type ConnectNavigation } from "./authorization.js";
+export { createBrowserConnectNavigation, type ConnectBrowserWindow } from "./browser-navigation.js";
+import type { ConnectAdvance, ConnectAttempt, ConnectOwnership, ConnectTransport } from "./types.js";
+export type ConnectSnapshot = {
+    attempt: ConnectAttempt | null;
+    busy: boolean;
+    error: Error | null;
+};
+/** A transport-injected, framework-neutral view of one durable setup attempt.
+ * OAuth redirects are hints to navigate; completion is read from the backend.
+ * Secret form values are never stored in a snapshot or browser persistence. */
+export declare class ConnectController {
+    readonly transport: ConnectTransport;
+    readonly workspaceId: string;
+    private snapshot;
+    private readonly listeners;
+    private generation;
+    private request;
+    private disposed;
+    constructor(transport: ConnectTransport, workspaceId: string);
+    getSnapshot: () => ConnectSnapshot;
+    subscribe: (listener: () => void) => (() => void);
+    begin(input: {
+        providerId: string;
+        ownership: ConnectOwnership;
+        returnUrl: string;
+        idempotencyKey: string;
+        reconnectAccountId?: string;
+        installationTarget?: import("./types.js").ConnectInstallationTarget;
+    }): Promise<ConnectAttempt>;
+    recover(attemptId: string): Promise<ConnectAttempt>;
+    refresh(): Promise<ConnectAttempt>;
+    advance(action: ConnectAdvance, idempotencyKey: string): Promise<ConnectAttempt>;
+    /** Observe backend progress without replaying a setup mutation. Disposal or
+     * selecting another attempt aborts the read loop and fences its late result. */
+    waitForAction(options?: {
+        timeoutMs?: number;
+    }): Promise<ConnectAttempt>;
+    cancel(idempotencyKey: string): Promise<ConnectAttempt>;
+    dispose(): void;
+    private assertActive;
+    private requireAttempt;
+    private publish;
+    private run;
+}