@every-app/sdk 0.3.0-rc.8 → 0.3.0

package/dist/internal/capabilities.js

@@ -16,18 +16,15 @@
  *    proxy's rules: inference routes only, the model allowlist, the usage
  *    tap. Never a capability: its key would reach the account's credits
  *    and keys on the same host.
- *  - `oauth_client`: a provider's OAuth client (Google's, Microsoft's,
- *    Slack's), held the same way. The gateway completes the token endpoint
- *    calls only, putting the client on them; the app builds the authorize
- *    URL from the public client id (`integrationStatus()`), sends people
- *    back to a callback its manifest entry lists (`redirectPaths`), keeps
- *    the user tokens and calls the provider's API with them itself. Other
- *    providers' clients (GitHub, the social networks) are presets
- *    (./oauthPresets.ts): rows only once an operator adds one. A client shared by apps
- *    with different needs carries a `scopePolicy`: named scope sets an app
- *    lists in its manifest entry's `scopes`, which ./oauthScopes.ts turns
- *    into what the app may ask the provider for and what a token it is
- *    handed may carry.
+ *  - `oauth_client`: an OAuth provider whose client the gateway holds and
+ *    whose flow it runs. None is in the catalog: each is a registered row,
+ *    written from a preset (./oauthPresets.ts: Google, Microsoft, Slack,
+ *    GitHub and the rest) or an operator's spec. A person connects in an app,
+ *    for exactly the provider scopes the app's manifest entry lists
+ *    (`scopes`); the gateway keeps the tokens and puts the person's token
+ *    on the app's calls to the provider's `api` hosts. Each provider is a
+ *    spec (./oauthSpec.ts), its differences data; ./oauthScopes.ts holds
+ *    the one set of scope rules.
  *  - `service`: something the gateway does itself, with no upstream host
  *    an app names (sending email, listing the organization's members). An
  *    app lists it the same way and calls its routes,
@@ -70,8 +67,8 @@ export const CAPABILITIES = {
             "/v1/images/variations",
         ],
         unstoredRoutes: ["/v1/responses", "/v1/chat/completions"],
-        // More than inference needs both the operator (AI_PROXY_EXTRA_ROUTES)
-        // and the app's manifest (`ai.routes`): OpenAI paths only.
+        // More than inference needs the app's manifest (`ai.routes`): OpenAI
+        // paths only.
         extraRoutes: true,
         // Tool calling on chat completions needs `reasoning_effort: "none"`
         // on the GPT-6 family (the responses route takes tools as it is).
@@ -296,518 +293,6 @@ export const CAPABILITIES = {
         settings: [],
         optionalSettings: [],
     },
-    slack: {
-        mode: "oauth_client",
-        label: "Slack",
-        secrets: {
-            clientId: "SLACK_CLIENT_ID",
-            clientSecret: "SLACK_CLIENT_SECRET",
-        },
-        token: [
-            {
-                host: "slack.com",
-                path: "/api/oauth.v2.access",
-                methods: ["POST"],
-                inject: "form",
-            },
-        ],
-        access: ["write"],
-        console: "https://api.slack.com/apps",
-        setup: "setup/slack.md",
-        authorize: {
-            url: "https://slack.com/oauth/v2/authorize",
-            // The sets' union: the bot scopes in set order, then the one user
-            // scope no bot set carries. Postiz lists `channels.read`,
-            // `users.read`, `messages.write`, `channels.join` and `files.write`
-            // (it posts to channels it joins and uploads images); Open CRM adds
-            // `users.email`, `channels.manage` and `user-channels.manage` (its
-            // team agents match members to Slack users by email, create and
-            // manage the channels they post to, open DMs, and the installing
-            // person invites the bot to private channels).
-            scopes: [
-                "channels:read",
-                "groups:read",
-                "users:read",
-                "users:read.email",
-                "chat:write",
-                "chat:write.public",
-                "chat:write.customize",
-                "channels:join",
-                "channels:manage",
-                "groups:write",
-                "channels:write.invites",
-                "groups:write.invites",
-                "im:write",
-                "files:write",
-                "channels:write",
-            ],
-        },
-        scopePolicy: {
-            dialect: "slack",
-            // `oauth.v2.access` takes `code` with no `grant_type`; an app that
-            // opts into token rotation refreshes with `refresh_token`.
-            grantTypes: [null, "refresh_token"],
-            // Slack reads no `scope` on the token leg (the installation's scopes
-            // were fixed on the authorize URL), so the request goes as sent.
-            requestScope: "keep",
-            alwaysRequested: [],
-            tolerated: [],
-            deniedSegments: [],
-            // Slack authorizes by method name, not verb, and every method is one
-            // exact `/api/<method>` path on the host that also serves the token
-            // endpoint (which no set lists). A read set names its methods in
-            // `paths` (GET) and `posts` (POST) alike; a write set in `posts`
-            // only, with the one listing among them in `paths` too.
-            sets: {
-                "channels.read": {
-                    label: "Channels (read-only)",
-                    access: "read",
-                    scopes: ["channels:read", "groups:read"],
-                    routes: [
-                        {
-                            host: "slack.com",
-                            paths: [
-                                "/api/conversations.list",
-                                "/api/conversations.info",
-                                "/api/conversations.members",
-                                "/api/users.conversations",
-                            ],
-                            posts: [
-                                /^\/api\/conversations\.(list|info|members)$/,
-                                /^\/api\/users\.conversations$/,
-                            ],
-                        },
-                    ],
-                },
-                "users.read": {
-                    label: "Members (read-only)",
-                    access: "read",
-                    scopes: ["users:read"],
-                    routes: [
-                        {
-                            host: "slack.com",
-                            paths: [
-                                "/api/users.list",
-                                "/api/users.info",
-                                "/api/users.getPresence",
-                                "/api/bots.info",
-                            ],
-                            posts: [
-                                /^\/api\/users\.(list|info|getPresence)$/,
-                                /^\/api\/bots\.info$/,
-                            ],
-                        },
-                    ],
-                },
-                "users.email": {
-                    // Slack grants it only beside `users:read`: declare both sets.
-                    label: "Members' email addresses (read-only)",
-                    access: "read",
-                    scopes: ["users:read.email"],
-                    routes: [
-                        {
-                            host: "slack.com",
-                            paths: ["/api/users.lookupByEmail"],
-                            posts: [/^\/api\/users\.lookupByEmail$/],
-                        },
-                    ],
-                },
-                "messages.write": {
-                    label: "Messages (post as the app)",
-                    access: "write",
-                    scopes: ["chat:write", "chat:write.public", "chat:write.customize"],
-                    routes: [
-                        {
-                            host: "slack.com",
-                            // The scheduled-messages listing is the one read among them.
-                            paths: ["/api/chat.scheduledMessages.list"],
-                            posts: [
-                                /^\/api\/chat\.(postMessage|postEphemeral|update|delete|scheduleMessage|deleteScheduledMessage|scheduledMessages\.list)$/,
-                            ],
-                        },
-                    ],
-                },
-                "channels.join": {
-                    label: "Channels (join public ones)",
-                    access: "write",
-                    scopes: ["channels:join"],
-                    routes: [
-                        {
-                            host: "slack.com",
-                            paths: [],
-                            posts: [/^\/api\/conversations\.join$/],
-                        },
-                    ],
-                },
-                "channels.manage": {
-                    label: "Channels (create, manage and invite to; open DMs)",
-                    access: "write",
-                    scopes: [
-                        "channels:manage",
-                        "groups:write",
-                        "channels:write.invites",
-                        "groups:write.invites",
-                        "im:write",
-                    ],
-                    routes: [
-                        {
-                            host: "slack.com",
-                            paths: [],
-                            posts: [
-                                /^\/api\/conversations\.(create|rename|archive|unarchive|invite|open|kick|leave|setTopic|setPurpose|mark)$/,
-                            ],
-                        },
-                    ],
-                },
-                "files.write": {
-                    label: "Files (upload)",
-                    access: "write",
-                    scopes: ["files:write"],
-                    routes: [
-                        {
-                            host: "slack.com",
-                            paths: [],
-                            // The external upload flow; the retired `files.upload` stays off.
-                            posts: [
-                                /^\/api\/files\.(getUploadURLExternal|completeUploadExternal)$/,
-                            ],
-                        },
-                    ],
-                },
-                "user-channels.manage": {
-                    label: "Channels (as the installing person: read, manage, invite to)",
-                    access: "write",
-                    scopes: [],
-                    // Slack's `user_scope`: issued to the person's own token, which
-                    // Open CRM uses to invite the bot to private channels.
-                    userScopes: [
-                        "channels:read",
-                        "channels:write",
-                        "groups:read",
-                        "groups:write",
-                    ],
-                    routes: [
-                        {
-                            host: "slack.com",
-                            paths: [
-                                "/api/conversations.list",
-                                "/api/conversations.info",
-                                "/api/conversations.members",
-                                "/api/users.conversations",
-                            ],
-                            posts: [
-                                /^\/api\/conversations\.(list|info|members|create|rename|archive|unarchive|invite|kick|leave|setTopic|setPurpose|mark)$/,
-                                /^\/api\/users\.conversations$/,
-                            ],
-                        },
-                    ],
-                },
-            },
-        },
-        api: ["slack.com"],
-        // Slack refuses `code_challenge`; `auth.test` names the workspace and
-        // the installing person.
-        flow: {
-            tokenUrl: "https://slack.com/api/oauth.v2.access",
-            revokeUrl: "https://slack.com/api/auth.revoke",
-            pkce: false,
-            scopeDialect: "slack",
-            identity: {
-                url: "https://slack.com/api/auth.test",
-                label: "team",
-                id: "user_id",
-            },
-        },
-    },
-    // Clients several apps share with different needs, so each app lists the
-    // scope sets it uses: Open CRM reads a member's own mailbox and calendar
-    // (`gmail.read`, `calendar.read`; `identity`, `mail.read`), OpenSEO reads
-    // a site's Search Console and Analytics (`identity`, `search-console.read`,
-    // `analytics.read`). Every set is read-only. Google's is one Cloud project
-    // apart from the YouTube preset's; Gmail's read scope is restricted and needs
-    // Google's verification, and whether Search Console and Analytics share
-    // that consent screen with it is the operator's choice when verifying.
-    "google-workspace": {
-        mode: "oauth_client",
-        label: "Google (Gmail, Calendar, Search Console and Analytics)",
-        secrets: {
-            clientId: "GOOGLE_WORKSPACE_CLIENT_ID",
-            clientSecret: "GOOGLE_WORKSPACE_CLIENT_SECRET",
-        },
-        token: [
-            {
-                host: "oauth2.googleapis.com",
-                path: "/token",
-                methods: ["POST"],
-                inject: "form",
-            },
-        ],
-        access: ["write"],
-        console: "https://console.cloud.google.com/apis/credentials",
-        setup: "setup/google.md",
-        authorize: {
-            url: "https://accounts.google.com/o/oauth2/v2/auth",
-            scopes: [
-                "openid",
-                "email",
-                "profile",
-                "https://www.googleapis.com/auth/gmail.readonly",
-                "https://www.googleapis.com/auth/calendar.readonly",
-                "https://www.googleapis.com/auth/webmasters.readonly",
-                "https://www.googleapis.com/auth/analytics.readonly",
-            ],
-        },
-        scopePolicy: {
-            dialect: "google",
-            // Google documents no scope on either token leg: the response's
-            // `scope` is where the gateway learns what a token holds.
-            grantTypes: ["authorization_code", "refresh_token"],
-            requestScope: "drop",
-            alwaysRequested: [],
-            // Both spellings: Google documents `email`/`profile` and the userinfo
-            // URLs as the same grants, and echoes the URLs.
-            tolerated: [
-                "openid",
-                "email",
-                "profile",
-                "https://www.googleapis.com/auth/userinfo.email",
-                "https://www.googleapis.com/auth/userinfo.profile",
-            ],
-            // Gmail's and Calendar's `/batch/<api>/<version>` carry whole requests
-            // inside; Analytics' measurement protocol secrets are readable under
-            // the read-only scope.
-            deniedSegments: ["batch", "measurementProtocolSecrets"],
-            sets: {
-                identity: {
-                    label: "Google account (who you are)",
-                    access: "read",
-                    scopes: ["openid", "email", "profile"],
-                    routes: [
-                        { host: "openidconnect.googleapis.com", paths: ["/v1/userinfo"] },
-                        {
-                            host: "www.googleapis.com",
-                            paths: [
-                                "/oauth2/v2/userinfo",
-                                "/oauth2/v3/userinfo",
-                                "/userinfo/v2/me",
-                            ],
-                        },
-                    ],
-                },
-                "gmail.read": {
-                    label: "Gmail (read-only)",
-                    access: "read",
-                    scopes: ["https://www.googleapis.com/auth/gmail.readonly"],
-                    routes: [
-                        {
-                            host: "gmail.googleapis.com",
-                            paths: ["/gmail/v1/users/"],
-                            // Push notifications start and stop; `messages/send`, drafts
-                            // and `modify` are the other POSTs under the same prefix.
-                            posts: [/^\/gmail\/v1\/users\/[^/]+\/(watch|stop)$/],
-                        },
-                    ],
-                },
-                "calendar.read": {
-                    label: "Google Calendar (read-only)",
-                    access: "read",
-                    scopes: ["https://www.googleapis.com/auth/calendar.readonly"],
-                    routes: [
-                        {
-                            host: "www.googleapis.com",
-                            paths: ["/calendar/v3/"],
-                            posts: [
-                                /^\/calendar\/v3\/freeBusy$/,
-                                /^\/calendar\/v3\/calendars\/[^/]+\/events\/watch$/,
-                                /^\/calendar\/v3\/users\/me\/calendarList\/watch$/,
-                                /^\/calendar\/v3\/channels\/stop$/,
-                            ],
-                        },
-                    ],
-                },
-                "search-console.read": {
-                    label: "Search Console (read-only)",
-                    access: "read",
-                    scopes: ["https://www.googleapis.com/auth/webmasters.readonly"],
-                    // The v3 paths answer on both hosts; URL inspection is v1 only.
-                    // A site is one segment, `https%3A%2F%2Fexample.com%2F` or
-                    // `sc-domain%3Aexample.com`, which is why routes match the raw path.
-                    routes: [
-                        {
-                            host: "www.googleapis.com",
-                            paths: ["/webmasters/v3/"],
-                            posts: [
-                                /^\/webmasters\/v3\/sites\/[^/]+\/searchAnalytics\/query$/,
-                            ],
-                        },
-                        {
-                            host: "searchconsole.googleapis.com",
-                            paths: ["/webmasters/v3/"],
-                            posts: [
-                                /^\/webmasters\/v3\/sites\/[^/]+\/searchAnalytics\/query$/,
-                                /^\/v1\/urlInspection\/index:inspect$/,
-                            ],
-                        },
-                    ],
-                },
-                "analytics.read": {
-                    label: "Google Analytics (read-only)",
-                    access: "read",
-                    scopes: ["https://www.googleapis.com/auth/analytics.readonly"],
-                    routes: [
-                        {
-                            // Reports are POSTed queries.
-                            host: "analyticsdata.googleapis.com",
-                            paths: ["/v1beta/properties/"],
-                            posts: [
-                                /^\/v1beta\/properties\/[^/]+:(runReport|batchRunReports|runPivotReport|batchRunPivotReports|runRealtimeReport|checkCompatibility)$/,
-                            ],
-                        },
-                        {
-                            // Reads only: accounts, properties and what hangs off them
-                            // (data streams, key events, enhanced measurement settings).
-                            host: "analyticsadmin.googleapis.com",
-                            paths: [
-                                "/v1beta/accountSummaries",
-                                "/v1beta/accounts",
-                                "/v1beta/accounts/",
-                                "/v1beta/properties",
-                                "/v1beta/properties/",
-                                "/v1alpha/properties/",
-                            ],
-                        },
-                    ],
-                },
-            },
-        },
-        api: [
-            "gmail.googleapis.com",
-            "www.googleapis.com",
-            "searchconsole.googleapis.com",
-            "analyticsdata.googleapis.com",
-            "analyticsadmin.googleapis.com",
-            "openidconnect.googleapis.com",
-        ],
-        // The Gateway-owned flow: a refresh token needs `access_type=offline`,
-        // and `prompt=consent` makes Google issue one on every connect. No
-        // revoke: Google's `/revoke` is per person per client and would also
-        // kill the tokens an app-driven OpenSEO holds under the same client.
-        flow: {
-            tokenUrl: "https://oauth2.googleapis.com/token",
-            pkce: true,
-            scopeDialect: "google",
-            authorizeParams: { access_type: "offline", prompt: "consent" },
-            identity: {
-                url: "https://openidconnect.googleapis.com/v1/userinfo",
-                label: "email",
-                id: "sub",
-            },
-        },
-    },
-    "microsoft-365": {
-        mode: "oauth_client",
-        label: "Microsoft 365 (Outlook mail and calendar)",
-        secrets: {
-            clientId: "MICROSOFT_365_CLIENT_ID",
-            clientSecret: "MICROSOFT_365_CLIENT_SECRET",
-        },
-        token: [
-            {
-                // The multi-tenant endpoint: register the client for accounts in
-                // any organization and personal accounts. A single-tenant client
-                // answers only on its tenant's path, which this does not complete.
-                host: "login.microsoftonline.com",
-                path: "/common/oauth2/v2.0/token",
-                methods: ["POST"],
-                inject: "form",
-            },
-        ],
-        access: ["write"],
-        console: "https://entra.microsoft.com/#view/Microsoft_AAD_RegisteredApps/ApplicationsListBlade",
-        setup: "setup/microsoft-365.md",
-        authorize: {
-            url: "https://login.microsoftonline.com/common/oauth2/v2.0/authorize",
-            scopes: ["offline_access", "User.Read", "Mail.Read", "Calendars.Read"],
-        },
-        scopePolicy: {
-            dialect: "microsoft",
-            grantTypes: ["authorization_code", "refresh_token"],
-            // The token leg's `scope` is Microsoft's extension for naming the
-            // resource; the gateway sets it to the app's list so a token covers
-            // Graph alone.
-            requestScope: "replace",
-            // Refresh tokens; Entra never echoes it in a response's `scope`.
-            alwaysRequested: ["offline_access"],
-            // Compared case-insensitively, as Microsoft spells them both ways.
-            tolerated: ["openid", "profile", "email", "offline_access", "User.Read"],
-            // `$batch` carries whole requests inside; `beta` is another API.
-            deniedSegments: ["$batch", "beta"],
-            // `/v1.0/me/…` only: `/v1.0/users/<id>/…` reaches shared mailboxes
-            // and calendars under the same permissions.
-            sets: {
-                identity: {
-                    label: "Microsoft account (who you are)",
-                    access: "read",
-                    scopes: ["User.Read"],
-                    routes: [
-                        {
-                            host: "graph.microsoft.com",
-                            paths: ["/v1.0/me", "/oidc/userinfo"],
-                        },
-                    ],
-                },
-                "mail.read": {
-                    label: "Outlook mail (read-only)",
-                    access: "read",
-                    scopes: ["Mail.Read"],
-                    routes: [
-                        {
-                            host: "graph.microsoft.com",
-                            paths: [
-                                "/v1.0/me/messages",
-                                "/v1.0/me/messages/",
-                                "/v1.0/me/mailFolders",
-                                "/v1.0/me/mailFolders/",
-                            ],
-                        },
-                    ],
-                },
-                "calendar.read": {
-                    label: "Outlook calendar (read-only)",
-                    access: "read",
-                    scopes: ["Calendars.Read"],
-                    routes: [
-                        {
-                            host: "graph.microsoft.com",
-                            paths: [
-                                "/v1.0/me/calendar",
-                                "/v1.0/me/calendar/",
-                                "/v1.0/me/calendars",
-                                "/v1.0/me/calendars/",
-                                "/v1.0/me/events",
-                                "/v1.0/me/events/",
-                                "/v1.0/me/calendarView",
-                                "/v1.0/me/calendarView/",
-                            ],
-                            // Free/busy is a POSTed query.
-                            posts: [/^\/v1\.0\/me\/calendar\/getSchedule$/],
-                        },
-                    ],
-                },
-            },
-        },
-        api: ["graph.microsoft.com"],
-        flow: {
-            tokenUrl: "https://login.microsoftonline.com/common/oauth2/v2.0/token",
-            pkce: true,
-            scopeDialect: "microsoft",
-            identity: {
-                url: "https://graph.microsoft.com/v1.0/me",
-                label: "userPrincipalName",
-                id: "id",
-            },
-        },
-    },
     // The first fifty beyond the entries above (catalog/*.ts, PR 3 of the
     // provider registry), after them so the derived lists keep their order.
     ...CATALOG_ENTRIES,
@@ -831,7 +316,12 @@ export function capabilitySettings(capability) {
                 ...(capability.hostSetting ? [capability.hostSetting] : []),
             ];
         case "ai":
-            return [capability.auth.secret, ...(capability.alsoNeeds ?? [])];
+            // Every setting `auth` names, as for an API-key provider: a Basic
+            // username held as a setting is checked, bound and listed like the key.
+            return [
+                ...authSettingNames(capability.auth),
+                ...(capability.alsoNeeds ?? []),
+            ];
         case "service":
             return [...capability.settings, ...capability.optionalSettings];
         case "oauth_client":
@@ -864,7 +354,13 @@ export function capabilityIdsOf(lookup) {
  * to encode, or taken as already encoded when it holds no colon.
  */
 export function authorizationFor(capability, settings) {
-    return authorizationOf(capability.auth, settings);
+    // Only the settings the entry declares are visible: whatever `auth` reads
+    // beyond them (a setting no row check saw) is unset, and the call fails closed.
+    const declared = {};
+    for (const name of capabilitySettings(capability)) {
+        declared[name] = settings[name];
+    }
+    return authorizationOf(capability.auth, declared);
 }
 /** {@link authorizationFor} for an `auth` block alone (the SDK's AI fallback holds the block, not the entry). */
 export function authorizationOf(auth, settings) {
@@ -959,9 +455,8 @@ export function serviceRoutePath(id, route) {
 /**
  * The capability call an AppGateway path names, or null when the path names
  * an unknown capability (or an AI provider, which has its own route), a
- * host outside the provider's, a path that could leave that host, a path
- * that isn't one of an OAuth client's token endpoints, or a route a service
- * capability doesn't declare. `settings` resolves an API-key provider's
+ * host outside the provider's, a path that could leave that host, or a
+ * route a service capability doesn't declare. `settings` resolves an API-key provider's
  * `hostSetting` (a Shopify store's host); `lookup` is where the id is found,
  * the catalog alone by default.
  */
@@ -986,13 +481,12 @@ export function parseIntegrationProxyPath(pathname, search, settings, lookup = C
         };
     }
     if (capability.mode === "oauth_client") {
-        const upstream = capability.token.some((rule) => rule.host === host)
+        const upstream = capability.api.includes(host)
             ? httpsUpstream(host, path ?? "/", search)
             : null;
-        const endpoint = upstream && tokenEndpointFor(capability, upstream);
-        if (!upstream || !endpoint)
+        if (!upstream)
             return null;
-        return { kind: "oauth_client", id, capability, upstream, endpoint };
+        return { kind: "oauth_client", id, capability, upstream };
     }
     if (capability.mode !== "api_key")
         return null;
@@ -1013,21 +507,6 @@ function httpsUpstream(host, path, search) {
         return null;
     return upstream;
 }
-/**
- * The token endpoint `upstream` is, by its exact host and path, or null.
- * Its method is the caller's to check.
- */
-export function tokenEndpointFor(capability, upstream) {
-    if (upstream.protocol !== "https:")
-        return null;
-    return (capability.token.find(({ host, path }) => host === upstream.host && path === upstream.pathname) ?? null);
-}
-/** An OAuth client's token endpoints, as `POST https://host/path` lines for messages. */
-export function describeTokenEndpoints(capability) {
-    return capability.token
-        .map(({ host, path, methods }) => `${methods.join("/")} https://${host}${path}`)
-        .join(", ");
-}
 /**
  * The command that gives the gateway `capability`'s client:
  * `pnpm everyapp secret set <ID> <SECRET>`.

package/dist/internal/catalog/commerce.js

@@ -146,7 +146,7 @@ export const COMMERCE = {
         },
         tags: ["payments", "billing"],
     },
-    // Legacy admin custom apps only: Shopify no longer lets a store create one, and Dev Dashboard tokens expire daily (the hint says so; shipping it is Ben's call, TODO.md).
+    // Legacy admin custom apps only: Shopify no longer lets a store create one, and Dev Dashboard tokens expire daily (the hint says so; shipping it is Ben's call).
     shopify: {
         mode: "api_key",
         label: "Shopify",