@sylphx/sdk 0.8.0-rc.1 → 0.8.0

package/dist/server/index.d.ts

@@ -1,6 +1,4 @@
 import { SdkBillingPlan, SdkConsentType } from '@sylphx/contract';
-import { OAuthProvider } from '@sylphx/ui';
-export { OAuthProvider } from '@sylphx/ui';
 
 /**
  * REST Client for Sylphx Platform
@@ -194,7 +192,7 @@ declare class InvalidConnectionUrlError extends Error {
  * import { createClient } from '@sylphx/sdk'
  *
  * const sylphx = createClient(process.env.SYLPHX_URL!)
- * // Parses: sylphx://pk_prod_{hex}@bold-river-a1b2c3.sylphx.com
+ * // Parses: sylphx://pk_prod_{hex}@bold-river-a1b2c3.api.sylphx.com
  * ```
  */
 
@@ -213,7 +211,7 @@ interface SylphxConfig {
     readonly env: 'dev' | 'stg' | 'prod' | 'prev';
     /** Resource slug (first DNS label), e.g. 'bold-river-a1b2c3' */
     readonly slug: string;
-    /** Pre-computed API base URL, e.g. 'https://bold-river-a1b2c3.sylphx.com/v1' */
+    /** Pre-computed API base URL, e.g. 'https://bold-river-a1b2c3.api.sylphx.com/v1' */
     readonly baseUrl: string;
     /** Optional access token for authenticated requests */
     readonly accessToken?: string;
@@ -266,7 +264,7 @@ interface SylphxClientInput {
  * @example Connection URL (recommended)
  * ```typescript
  * const sylphx = createClient(process.env.NEXT_PUBLIC_SYLPHX_URL!)
- * // Parses: sylphx://pk_prod_{hex}@bold-river-a1b2c3.sylphx.com
+ * // Parses: sylphx://pk_prod_{hex}@bold-river-a1b2c3.api.sylphx.com
  * ```
  *
  * @example Explicit components
@@ -287,7 +285,7 @@ declare function createClient(input: string | SylphxClientInput): SylphxConfig;
  * @example Connection URL (recommended)
  * ```typescript
  * const sylphx = createServerClient(process.env.SYLPHX_SECRET_URL!)
- * // Parses: sylphx://sk_prod_{hex}@bold-river-a1b2c3.sylphx.com
+ * // Parses: sylphx://sk_prod_{hex}@bold-river-a1b2c3.api.sylphx.com
  * ```
  *
  * @example Explicit components
@@ -622,6 +620,32 @@ declare function validateAndSanitizeKey(key: string | undefined | null): string;
  */
 declare function isDevelopmentRuntime(): boolean;
 
+/**
+ * OAuth SDK — customer-app-facing social login (ADR-089 Phase 4a)
+ *
+ * Backed by `apps/runtime/src/server/runtime/routes/oauth.ts`:
+ *
+ *   POST /oauth/authorize   — initiate OAuth flow, returns provider URL
+ *
+ * The per-provider callback handler is a browser-side redirect endpoint
+ * on the runtime (`GET /oauth/callback/{provider}`); SDK consumers
+ * redirect the user to `authorizationUrl`, then receive a `code` on
+ * their own `redirect_uri` which they exchange via `signIn()` or
+ * `auth/login` with grant_type=authorization_code.
+ *
+ * PKCE is required per OAuth 2.1. Callers MUST generate `code_verifier`
+ * + `code_challenge` and persist the verifier in session / cookie for
+ * the subsequent token exchange — this SDK does not retain state.
+ *
+ * ## Distinction from `auth.oauth`
+ *
+ * `auth.oauth.*` (from `./auth`) targets platform-plane admin mint
+ * (`/auth/platform-jwt/mint`) used by Console / CLI. The functions
+ * here target the customer-app social-login flow.
+ */
+
+type OAuthProvider = OAuthProviderId | (string & {});
+
 /**
  * Functions Client — Serverless V8 Isolate Functions (ADR-043)
  *
@@ -1392,7 +1416,7 @@ declare function getStreams(): StreamsClient;
  * Sylphx Server SDK
  *
  * Server-side operations using REST API for type safety.
- * Uses connection URL (sylphx://sk_*@slug.sylphx.com) for authentication.
+ * Uses connection URL (sylphx://sk_*@tenant-slug.api.sylphx.com) for authentication.
  *
  * @example
  * ```typescript
@@ -1632,8 +1656,10 @@ interface FeatureFlagDefinition {
  * import { getFeatureFlags } from '@sylphx/sdk/server'
  *
  * export default async function RootLayout({ children }) {
+ *   const sylphx = createServerClient(process.env.SYLPHX_URL!)
  *   const flags = await getFeatureFlags({
- *     secretKey: process.env.SYLPHX_SECRET_KEY!,
+ *     secretKey: sylphx.secretKey!,
+ *     platformUrl: sylphx.baseUrl.replace(/\/v[0-9]+$/, ''),
  *   })
  *   return <FeatureFlagsProvider initialFlags={flags}>{children}</FeatureFlagsProvider>
  * }
@@ -1687,9 +1713,11 @@ interface GetAppConfigOptions {
  * import { getAppConfig } from '@sylphx/sdk/server'
  *
  * export default async function RootLayout({ children }) {
+ *   const sylphx = createServerClient(process.env.SYLPHX_URL!)
  *   const config = await getAppConfig({
- *     secretKey: process.env.SYLPHX_SECRET_KEY!,
+ *     secretKey: sylphx.secretKey!,
  *     appId: process.env.NEXT_PUBLIC_SYLPHX_APP_ID!,
+ *     platformUrl: sylphx.baseUrl.replace(/\/v[0-9]+$/, ''),
  *   })
  *
  *   return (
@@ -1839,4 +1867,4 @@ declare function getDatabaseConnection(options: AuthenticatedFetchOptions): Prom
  */
 declare function getDatabaseStatus(options: AuthenticatedFetchOptions): Promise<DatabaseStatusInfo>;
 
-export { type AIClient, type AIClientOptions, type AppConfig, type AppMetadata, type ChannelHelper, type ChatCompletionChunk, type ChatCompletionOptions, type ChatCompletionResponse, type ChatCompletionStreamOptions, type ChatMessage, type ConsentType, type DatabaseConnectionInfo, type DatabaseStatusInfo, type EmbeddingOptions, type EmbeddingResponse, type EngagementLeaderboardEntry, type EngagementLeaderboardResult, type EnvironmentType, type FeatureFlagDefinition, type FunctionDeployOptions, type FunctionDeployResult, type FunctionInvokeOptions, type FunctionListOptions, type FunctionLogEntry, type FunctionLogsOptions, type FunctionRecord, type FunctionRuntime, type FunctionStatus, FunctionsClient, type GetAppConfigOptions, InvalidConnectionUrlError, type KeyType, type KeyValidationResult, type KvClient, type KvClientOptions, type KvRateLimitResult, type KvSetOptions, type KvZMember, type ModelInfo, type ModelsResponse, type OAuthProviderInfo, type Plan, type ReferralLeaderboardEntry, type ReferralLeaderboardResult, type RestClient, type RestClientConfig as ServerClientConfig, type ServerConfig, type StreamHistoryOptions, type StreamMessage, type StreamsClient, type StreamsClientOptions, type SylphxClientInput, type SylphxConfig, type WebhookPayload, type WebhookVerifyOptions, type WebhookVerifyResult, createAI, createAuthenticatedServerClient, createClient, createKv, createServerClient, createServerRestClient, createStreams, createWebhookHandler, decodeUserId, detectEnvironment, detectKeyType, encodeUserId, getAI, getAppConfig, getAppMetadata, getConsentTypes, getCookieNamespace, getDatabaseConnection, getDatabaseStatus, getEngagementLeaderboard, getFeatureFlags, getJwks, getKv, getOAuthProviders, getOAuthProvidersWithInfo, getPlans, getReferralLeaderboard, getStreams, isAppId, isDevelopmentKey, isDevelopmentRuntime, isProductionKey, isSecretKey, resetJwksCache, validateAndSanitizeAppId, validateAndSanitizeKey, validateAndSanitizeSecretKey, validateAppId, validateKey, validateSecretKey, verifyAccessToken, verifyWebhook };
+export { type AIClient, type AIClientOptions, type AppConfig, type AppMetadata, type ChannelHelper, type ChatCompletionChunk, type ChatCompletionOptions, type ChatCompletionResponse, type ChatCompletionStreamOptions, type ChatMessage, type ConsentType, type DatabaseConnectionInfo, type DatabaseStatusInfo, type EmbeddingOptions, type EmbeddingResponse, type EngagementLeaderboardEntry, type EngagementLeaderboardResult, type EnvironmentType, type FeatureFlagDefinition, type FunctionDeployOptions, type FunctionDeployResult, type FunctionInvokeOptions, type FunctionListOptions, type FunctionLogEntry, type FunctionLogsOptions, type FunctionRecord, type FunctionRuntime, type FunctionStatus, FunctionsClient, type GetAppConfigOptions, InvalidConnectionUrlError, type KeyType, type KeyValidationResult, type KvClient, type KvClientOptions, type KvRateLimitResult, type KvSetOptions, type KvZMember, type ModelInfo, type ModelsResponse, type OAuthProvider, type OAuthProviderInfo, type Plan, type ReferralLeaderboardEntry, type ReferralLeaderboardResult, type RestClient, type RestClientConfig as ServerClientConfig, type ServerConfig, type StreamHistoryOptions, type StreamMessage, type StreamsClient, type StreamsClientOptions, type SylphxClientInput, type SylphxConfig, type WebhookPayload, type WebhookVerifyOptions, type WebhookVerifyResult, createAI, createAuthenticatedServerClient, createClient, createKv, createServerClient, createServerRestClient, createStreams, createWebhookHandler, decodeUserId, detectEnvironment, detectKeyType, encodeUserId, getAI, getAppConfig, getAppMetadata, getConsentTypes, getCookieNamespace, getDatabaseConnection, getDatabaseStatus, getEngagementLeaderboard, getFeatureFlags, getJwks, getKv, getOAuthProviders, getOAuthProvidersWithInfo, getPlans, getReferralLeaderboard, getStreams, isAppId, isDevelopmentKey, isDevelopmentRuntime, isProductionKey, isSecretKey, resetJwksCache, validateAndSanitizeAppId, validateAndSanitizeKey, validateAndSanitizeSecretKey, validateAppId, validateKey, validateSecretKey, verifyAccessToken, verifyWebhook };

package/dist/server/index.mjs

@@ -2112,7 +2112,7 @@ function parseConnectionUrl(url) {
 // src/config.ts
 var LEGACY_EMBEDDED_REF_PATTERN = /^(pk|sk)_(dev|stg|prod|prev)_[a-z0-9]{12}_[a-f0-9]+$/;
 var LEGACY_APP_KEY_PATTERN = /^app_(dev|stg|prod|prev)_/;
-var MIGRATION_MESSAGE = "API key format has changed. Use a sylphx:// connection URL instead.\n\nNew format: sylphx://pk_prod_{hex}@your-slug.sylphx.com\n\nGenerate new credentials from the Sylphx Console \u2192 Your App \u2192 Environments.\nSee https://docs.sylphx.com/migration for details.";
+var MIGRATION_MESSAGE = "API key format has changed. Use a sylphx:// connection URL instead.\n\nNew format: sylphx://pk_prod_{hex}@your-slug.api.sylphx.com\n\nGenerate new credentials from the Sylphx Console \u2192 Your App \u2192 Environments.\nSee https://docs.sylphx.com/migration for details.";
 function rejectLegacyKeyFormat(input) {
   const trimmed = input.trim().toLowerCase();
   if (LEGACY_APP_KEY_PATTERN.test(trimmed)) {
@@ -2155,7 +2155,7 @@ function createServerClient(input) {
 function createConfigFromUrl(url) {
   if (!url || typeof url !== "string") {
     throw new SylphxError(
-      "[Sylphx] Connection URL is required. Set SYLPHX_URL or NEXT_PUBLIC_SYLPHX_URL environment variable.\n\nFormat: sylphx://pk_prod_{hex}@your-slug.sylphx.com",
+      "[Sylphx] Connection URL is required. Set SYLPHX_URL or NEXT_PUBLIC_SYLPHX_URL environment variable.\n\nFormat: sylphx://pk_prod_{hex}@your-slug.api.sylphx.com",
       { code: "BAD_REQUEST" }
     );
   }
@@ -2164,7 +2164,7 @@ function createConfigFromUrl(url) {
   if (!trimmed.startsWith("sylphx://")) {
     if (CREDENTIAL_REGEX.test(trimmed)) {
       throw new SylphxError(
-        "[Sylphx] Received a bare credential instead of a connection URL.\n\nWrap it in a connection URL: sylphx://<credential>@<slug>.sylphx.com\nOr use createClient({ slug, publicKey }) for explicit components.",
+        "[Sylphx] Received a bare credential instead of a connection URL.\n\nWrap it in a connection URL: sylphx://<credential>@<slug>.api.sylphx.com\nOr use createClient({ slug, publicKey }) for explicit components.",
         { code: "BAD_REQUEST" }
       );
     }
@@ -2209,7 +2209,7 @@ function createConfigFromComponents(input) {
     const credentialType = match[1];
     const env = match[2];
     const slug = resolvedSlug.trim().toLowerCase();
-    const domain = input.domain?.trim() || "api.sylphx.com";
+    const domain = input.domain?.trim() || DEFAULT_SDK_API_HOST;
     const baseUrl = `https://${slug}.${domain}/v1`;
     return freezeConfig({
       credential: trimmedCred,
@@ -2232,7 +2232,7 @@ function createConfigFromComponents(input) {
       const platform = input.platformUrl.trim().replace(/\/$/, "");
       baseUrl = platform.includes("/v1") ? platform : `${platform}/v1`;
     } else {
-      const domain = input.domain?.trim() || "api.sylphx.com";
+      const domain = input.domain?.trim() || DEFAULT_SDK_API_HOST;
       baseUrl = `https://${slug}.${domain}/v1`;
     }
     return freezeConfig({