@aglyn/plugins-marketplace 1.15.0 → 1.15.2

package/src/lib/server/connections/routes.d.ts

@@ -0,0 +1,77 @@
+/**
+ * @license
+ * Copyright 2026 Aglyn LLC
+ *
+ * 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.
+ */
+import type { PluginApiRequestSubject } from '@aglyn/aglyn/server';
+export declare function routeJson(body: unknown, status?: number): Response;
+export declare function routeError(status: number, error: string, extra?: Record<string, unknown>): Response;
+/** Whether `uid` holds "Manage a site's plugin connections" on the site. */
+export declare function holdsSiteConnectionsKey(host: Record<string, unknown>, uid: string): boolean;
+export interface SiteActor {
+    uid: string;
+    hostId: string;
+    orgId: string;
+    org: Record<string, unknown>;
+    host: Record<string, unknown>;
+    planAllows: boolean;
+}
+/**
+ * THE GATE EVERY SITE ROUTE CLIMBS. The console's dispatcher has already
+ * refused a site with the marketplace switched off or unreleased, a lockdown
+ * and a caller over the write limit. What it cannot know is the member, the
+ * key and the plan:
+ *
+ *   401  no bearer token, or one the verifier refused
+ *   403  an unverified address (an impersonation session is exempt)
+ *   400  no site named
+ *   404  no such site
+ *   403  without "Manage a site's plugin connections" on the site — held by
+ *        the member themselves: the grant is the business's own account at
+ *        the provider, so staff support does not connect one
+ *   403  a plan without connections, when the route asks for it
+ */
+export declare function siteConnectionsGate(request: Request, params: Record<string, unknown>, options: {
+    requirePlan: boolean;
+}): Promise<SiteActor | Response>;
+export declare function connectStartRoute(request: Request): Promise<Response>;
+/** The workspace and member a provider's redirect is for, read off the signed state. */
+export declare function connectCallbackSubject(request: Request): PluginApiRequestSubject | null;
+export declare function connectCallbackRoute(request: Request): Promise<Response>;
+export declare function resourcesRoute(request: Request): Promise<Response>;
+export declare function chooseRoute(request: Request): Promise<Response>;
+export declare function disconnectRoute(request: Request): Promise<Response>;
+export declare function statusRoute(request: Request): Promise<Response>;
+/** A second "Sync now" within this of the last sync that ran is answered with the connection as it is. */
+export declare const PLUGIN_CONNECTION_SYNC_NOW_COOLDOWN_MS = 60000;
+/**
+ * POST `{ hostId, listingId, connectionId }` (AGL-4194): runs the
+ * connection's declared sync once, now, as the scheduled sync would, and
+ * answers `{ connection, synced }` — the view after the run, which carries a
+ * failure as `status` and `lastError`, so a provider error is a 200 with
+ * `synced: false`, not a 502. Site key and plan.
+ *
+ *   409 `not-connected`, `reconnect`, `choose-first` (a resource not chosen)
+ *       or `no-sync` (the pinned version declares no sync)
+ *   429 `too-soon` within a minute of the last sync, with the view
+ */
+export declare function syncNowRoute(request: Request): Promise<Response>;
+/**
+ * GET: whether each connection the listing's latest version declares has its
+ * OAuth app set. POST `{ listingId, connectionId, clientId, clientSecret }`
+ * sets or replaces the pair; `{ listingId, connectionId, clear: true }`
+ * removes it. Never answers either value. Asks "Set a listing's connection
+ * credentials" of a member of the workspace that published the listing.
+ */
+export declare function credentialsRoute(request: Request): Promise<Response>;