@vercel/connect 0.4.3 → 0.5.0

package/dist/connector.d.ts

@@ -0,0 +1,32 @@
+import { type ConnectOptions } from './token.js';
+/**
+ * Connector metadata as returned by Vercel Connect. This is the stable, useful
+ * subset of the connector object the management APIs return.
+ */
+export interface ConnectorMetadata {
+    /** Opaque Vercel Connect connector id (e.g. `scl_…`). */
+    id: string;
+    /** Human-readable Vercel Connect connector UID. */
+    uid: string;
+    name: string;
+    /** Connector type identifier (e.g. `snowflake`, `oauth`). */
+    type: string;
+    /** Service the connector integrates with. */
+    service: string;
+    /** Fully-qualified URL for the connector's service when derivable. */
+    clientUrl?: string;
+    createdAt: number;
+    updatedAt: number;
+    /** Vendor-specific public configuration. */
+    vendor: Record<string, unknown>;
+}
+/**
+ * Fetch a connector's metadata from Vercel Connect.
+ *
+ * Authenticates with the deployment's Vercel OIDC token (same as
+ * {@link getToken}); the connector must be attached to the requesting
+ * deployment's project and enabled for its environment.
+ *
+ * @param connector - The connector id or UID.
+ */
+export declare function getConnectorMetadata(connector: string, options?: ConnectOptions): Promise<ConnectorMetadata>;

package/dist/connector.js

@@ -0,0 +1,27 @@
+import { getVercelOidcToken } from '@vercel/oidc';
+import { createConnectErrorFromResponse, } from './token.js';
+/**
+ * Fetch a connector's metadata from Vercel Connect.
+ *
+ * Authenticates with the deployment's Vercel OIDC token (same as
+ * {@link getToken}); the connector must be attached to the requesting
+ * deployment's project and enabled for its environment.
+ *
+ * @param connector - The connector id or UID.
+ */
+export async function getConnectorMetadata(connector, options) {
+    const vercelToken = options?.vercelToken ?? (await getVercelOidcToken());
+    const endpoint = `https://api.vercel.com/v1/connect/connectors/${encodeURIComponent(connector)}`;
+    const response = await fetch(endpoint, {
+        method: 'GET',
+        headers: {
+            Accept: 'application/json',
+            Authorization: `Bearer ${vercelToken}`,
+        },
+    });
+    if (!response.ok) {
+        throw await createConnectErrorFromResponse(response, 'Failed to get connector');
+    }
+    const { data, ...rest } = (await response.json());
+    return { ...rest, vendor: data ?? {} };
+}

package/dist/eve/index.d.ts

@@ -10,4 +10,5 @@ export { connect, type EveAuthorizationInput, type EveAuthorizationOptions, type
 export { CONNECT_OAUTH_ISSUER, connectOAuth, type ConnectOAuthAudienceEnvironment, type ConnectOAuthEnvironment, type ConnectOAuthOptions, } from './connect-oauth.js';
 export { connectGitHubCredentials, type ConnectGitHubCredentialsParams, } from './github-credentials.js';
 export { connectLinearCredentials, type ConnectLinearCredentialsParams, } from './linear-credentials.js';
+export { connectPhotonCredentials, type ConnectPhotonCredentialProvider, type PhotonCredentials, type ConnectPhotonCredentialsParams, } from './photon-credentials.js';
 export { connectSlackCredentials, type ConnectSlackCredentialsParams, } from './slack-credentials.js';

package/dist/eve/index.js

@@ -10,4 +10,5 @@ export { connect, } from './connection-authorization.js';
 export { CONNECT_OAUTH_ISSUER, connectOAuth, } from './connect-oauth.js';
 export { connectGitHubCredentials, } from './github-credentials.js';
 export { connectLinearCredentials, } from './linear-credentials.js';
+export { connectPhotonCredentials, } from './photon-credentials.js';
 export { connectSlackCredentials, } from './slack-credentials.js';

package/dist/eve/photon-credentials.d.ts

@@ -0,0 +1,34 @@
+import { type ConnectOptions, type ConnectTokenParams } from '../index.js';
+/** Photon project credentials resolved by {@link connectPhotonCredentials}. */
+export interface PhotonCredentials {
+    projectId: string;
+    projectSecret: string;
+}
+/** Lazy Photon credential provider returned by {@link connectPhotonCredentials}. */
+export type ConnectPhotonCredentialProvider = () => Promise<PhotonCredentials>;
+/**
+ * Token parameters accepted by {@link connectPhotonCredentials}.
+ *
+ * Mirrors {@link ConnectTokenParams} from `@vercel/connect`, minus
+ * `subject` — Photon project credentials are app-scoped, so `subject`
+ * is pinned to `{ type: "app" }` by this helper and cannot be overridden.
+ */
+export type ConnectPhotonCredentialsParams = Omit<ConnectTokenParams, 'subject'>;
+/**
+ * Build a lazy Photon credential provider backed by a Vercel Connect
+ * connector.
+ *
+ * Photon connectors issue the project secret as an app-scoped token and the
+ * project ID as public token metadata. The returned provider resolves both
+ * fields when the Photon client or adapter first needs them.
+ *
+ * ```ts
+ * import { connectPhotonCredentials } from '@vercel/connect/eve';
+ * import { createiMessageAdapter } from '@photon-ai/chat-adapter-imessage';
+ *
+ * const imessage = createiMessageAdapter({
+ *   credentials: connectPhotonCredentials('photon/my-project'),
+ * });
+ * ```
+ */
+export declare function connectPhotonCredentials(connector: string, params?: ConnectPhotonCredentialsParams, options?: ConnectOptions): ConnectPhotonCredentialProvider;

package/dist/eve/photon-credentials.js

@@ -0,0 +1,31 @@
+import { getTokenResponse, } from '../index.js';
+/**
+ * Build a lazy Photon credential provider backed by a Vercel Connect
+ * connector.
+ *
+ * Photon connectors issue the project secret as an app-scoped token and the
+ * project ID as public token metadata. The returned provider resolves both
+ * fields when the Photon client or adapter first needs them.
+ *
+ * ```ts
+ * import { connectPhotonCredentials } from '@vercel/connect/eve';
+ * import { createiMessageAdapter } from '@photon-ai/chat-adapter-imessage';
+ *
+ * const imessage = createiMessageAdapter({
+ *   credentials: connectPhotonCredentials('photon/my-project'),
+ * });
+ * ```
+ */
+export function connectPhotonCredentials(connector, params = {}, options) {
+    return async () => {
+        const response = await getTokenResponse(connector, { ...params, subject: { type: 'app' } }, options);
+        const projectId = response.metadata?.projectId;
+        if (typeof projectId !== 'string' || projectId.length === 0) {
+            throw new Error('Photon connector returned invalid credentials.');
+        }
+        return {
+            projectId,
+            projectSecret: response.token,
+        };
+    };
+}

package/dist/index.d.ts

@@ -2,3 +2,4 @@ export { deleteTokenCacheEntry, getToken, getTokenResponse, revokeToken, Connect
 export { startAuthorization, type ConnectAuthorizationOptions, type ConnectAuthorizationResponse, } from './authorization.js';
 export { experimental_startInstallation, type ConnectInstallationOptions, type ConnectInstallationParams, type ConnectInstallationResponse, } from './installation.js';
 export type { ConnectAuthorizationDetail } from './authorization-details.js';
+export { getConnectorMetadata, type ConnectorMetadata, } from './connector.js';

package/dist/index.js

@@ -1,3 +1,4 @@
 export { deleteTokenCacheEntry, getToken, getTokenResponse, revokeToken, ConnectError, NoValidTokenError, UserAuthorizationRequiredError, ConnectorInstallationRequiredError, } from './token.js';
 export { startAuthorization, } from './authorization.js';
 export { experimental_startInstallation, } from './installation.js';
+export { getConnectorMetadata, } from './connector.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vercel/connect",
-  "version": "0.4.3",
+  "version": "0.5.0",
   "license": "Apache-2.0",
   "type": "module",
   "repository": {