@edge-markets/connect 1.0.0 → 1.2.0

package/README.md

@@ -132,3 +132,9 @@ isApiError(error)            // API error
 MIT
 
 
+
+
+
+
+
+

package/dist/index.d.mts

@@ -2430,86 +2430,21 @@ interface EdgeLinkExit {
     };
 }
 
-/**
- * EDGE Connect Environment Configuration
- *
- * Defines the URLs and settings for each deployment environment.
- * Partners select an environment when initializing the SDK.
- *
- * @module @edge-markets/connect/config
- */
-/**
- * Available EDGE Connect environments.
- *
- * - `production`: Live environment with real money
- * - `staging`: Test environment with test accounts (use during development)
- * - `sandbox`: Isolated environment with mock data (coming soon)
- *
- * @example
- * ```typescript
- * const edge = new EdgeConnectServer({
- *   clientId: process.env.EDGE_CLIENT_ID,
- *   clientSecret: process.env.EDGE_CLIENT_SECRET,
- *   environment: 'staging', // <-- autocomplete shows all options
- * })
- * ```
- */
-type EdgeEnvironment = 'production' | 'staging' | 'sandbox';
-/**
- * Configuration for a specific environment.
- */
+type EdgeEnvironment = 'production' | 'staging' | 'sandbox' | 'development';
 interface EdgeEnvironmentConfig {
-    /** Legacy: Cognito domain for OAuth token endpoints. */
-    authDomain: string;
-    /** Base URL for the Connect API endpoints (without trailing slash). */
+    /**
+     * @deprecated cognitoDomain is no longer used. Token exchange now goes through EdgeBoost API.
+     */
+    cognitoDomain: string;
     apiBaseUrl: string;
-    /** Base URL for OAuth token operations (without trailing slash). */
     oauthBaseUrl: string;
-    /** URL for the EdgeBoost user client (for Link popup). */
     userClientUrl: string;
-    /** Human-readable name for debugging/logging. */
     displayName: string;
-    /** Whether this environment uses real money. */
     isProduction: boolean;
 }
-/**
- * Environment configurations.
- *
- * These URLs are updated when infrastructure changes.
- * Partners shouldn't need to modify these directly.
- */
 declare const EDGE_ENVIRONMENTS: Readonly<Record<EdgeEnvironment, EdgeEnvironmentConfig>>;
-/**
- * Gets the configuration for a specific environment.
- *
- * @param environment - The environment to get config for
- * @returns The environment configuration
- *
- * @example
- * ```typescript
- * const config = getEnvironmentConfig('staging')
- * console.log(`Using ${config.displayName} at ${config.apiBaseUrl}`)
- * ```
- */
 declare function getEnvironmentConfig(environment: EdgeEnvironment): EdgeEnvironmentConfig;
-/**
- * Checks if an environment is the production environment.
- *
- * @param environment - The environment to check
- * @returns true if this is the production environment
- *
- * @example
- * ```typescript
- * if (isProductionEnvironment('staging')) {
- *   // false - staging is not production
- * }
- * ```
- */
 declare function isProductionEnvironment(environment: EdgeEnvironment): boolean;
-/**
- * Gets all available environment names.
- * Useful for building environment selectors in admin UIs.
- */
 declare function getAvailableEnvironments(): readonly EdgeEnvironment[];
 
 /**
@@ -2588,12 +2523,15 @@ declare const SCOPE_ICONS: Readonly<Record<EdgeScope, string>>;
 /**
  * Builds the full scope string for a given environment.
  *
- * Different environments may use different scope prefixes in Cognito.
+ * Different environments may use different scope prefixes in the API Gateway.
  * This function handles the prefix automatically.
  *
+ * Note: 'development' environment uses 'staging' scope prefix because it
+ * connects to the staging API Gateway for local testing.
+ *
  * @param scope - The scope to format
  * @param environment - The target environment
- * @returns The full scope string for Cognito
+ * @returns The full scope string for API Gateway authorization
  *
  * @example
  * ```typescript
@@ -2602,9 +2540,12 @@ declare const SCOPE_ICONS: Readonly<Record<EdgeScope, string>>;
  *
  * formatScopeForEnvironment('user.read', 'production')
  * // Returns: 'edge-connect/user.read'
+ *
+ * formatScopeForEnvironment('user.read', 'development')
+ * // Returns: 'edge-connect-staging/user.read' (maps to staging)
  * ```
  */
-declare function formatScopeForEnvironment(scope: EdgeScope, environment: 'production' | 'staging' | 'sandbox'): string;
+declare function formatScopeForEnvironment(scope: EdgeScope, environment: 'production' | 'staging' | 'sandbox' | 'development'): string;
 /**
  * Formats multiple scopes for an environment.
  *
@@ -2612,7 +2553,7 @@ declare function formatScopeForEnvironment(scope: EdgeScope, environment: 'produ
  * @param environment - The target environment
  * @returns Array of full scope strings
  */
-declare function formatScopesForEnvironment(scopes: readonly EdgeScope[] | EdgeScope[], environment: 'production' | 'staging' | 'sandbox'): string[];
+declare function formatScopesForEnvironment(scopes: readonly EdgeScope[] | EdgeScope[], environment: 'production' | 'staging' | 'sandbox' | 'development'): string[];
 /**
  * Parses a full scope string to extract the base scope.
  *

package/dist/index.d.ts

@@ -2430,86 +2430,21 @@ interface EdgeLinkExit {
     };
 }
 
-/**
- * EDGE Connect Environment Configuration
- *
- * Defines the URLs and settings for each deployment environment.
- * Partners select an environment when initializing the SDK.
- *
- * @module @edge-markets/connect/config
- */
-/**
- * Available EDGE Connect environments.
- *
- * - `production`: Live environment with real money
- * - `staging`: Test environment with test accounts (use during development)
- * - `sandbox`: Isolated environment with mock data (coming soon)
- *
- * @example
- * ```typescript
- * const edge = new EdgeConnectServer({
- *   clientId: process.env.EDGE_CLIENT_ID,
- *   clientSecret: process.env.EDGE_CLIENT_SECRET,
- *   environment: 'staging', // <-- autocomplete shows all options
- * })
- * ```
- */
-type EdgeEnvironment = 'production' | 'staging' | 'sandbox';
-/**
- * Configuration for a specific environment.
- */
+type EdgeEnvironment = 'production' | 'staging' | 'sandbox' | 'development';
 interface EdgeEnvironmentConfig {
-    /** Legacy: Cognito domain for OAuth token endpoints. */
-    authDomain: string;
-    /** Base URL for the Connect API endpoints (without trailing slash). */
+    /**
+     * @deprecated cognitoDomain is no longer used. Token exchange now goes through EdgeBoost API.
+     */
+    cognitoDomain: string;
     apiBaseUrl: string;
-    /** Base URL for OAuth token operations (without trailing slash). */
     oauthBaseUrl: string;
-    /** URL for the EdgeBoost user client (for Link popup). */
     userClientUrl: string;
-    /** Human-readable name for debugging/logging. */
     displayName: string;
-    /** Whether this environment uses real money. */
     isProduction: boolean;
 }
-/**
- * Environment configurations.
- *
- * These URLs are updated when infrastructure changes.
- * Partners shouldn't need to modify these directly.
- */
 declare const EDGE_ENVIRONMENTS: Readonly<Record<EdgeEnvironment, EdgeEnvironmentConfig>>;
-/**
- * Gets the configuration for a specific environment.
- *
- * @param environment - The environment to get config for
- * @returns The environment configuration
- *
- * @example
- * ```typescript
- * const config = getEnvironmentConfig('staging')
- * console.log(`Using ${config.displayName} at ${config.apiBaseUrl}`)
- * ```
- */
 declare function getEnvironmentConfig(environment: EdgeEnvironment): EdgeEnvironmentConfig;
-/**
- * Checks if an environment is the production environment.
- *
- * @param environment - The environment to check
- * @returns true if this is the production environment
- *
- * @example
- * ```typescript
- * if (isProductionEnvironment('staging')) {
- *   // false - staging is not production
- * }
- * ```
- */
 declare function isProductionEnvironment(environment: EdgeEnvironment): boolean;
-/**
- * Gets all available environment names.
- * Useful for building environment selectors in admin UIs.
- */
 declare function getAvailableEnvironments(): readonly EdgeEnvironment[];
 
 /**
@@ -2588,12 +2523,15 @@ declare const SCOPE_ICONS: Readonly<Record<EdgeScope, string>>;
 /**
  * Builds the full scope string for a given environment.
  *
- * Different environments may use different scope prefixes in Cognito.
+ * Different environments may use different scope prefixes in the API Gateway.
  * This function handles the prefix automatically.
  *
+ * Note: 'development' environment uses 'staging' scope prefix because it
+ * connects to the staging API Gateway for local testing.
+ *
  * @param scope - The scope to format
  * @param environment - The target environment
- * @returns The full scope string for Cognito
+ * @returns The full scope string for API Gateway authorization
  *
  * @example
  * ```typescript
@@ -2602,9 +2540,12 @@ declare const SCOPE_ICONS: Readonly<Record<EdgeScope, string>>;
  *
  * formatScopeForEnvironment('user.read', 'production')
  * // Returns: 'edge-connect/user.read'
+ *
+ * formatScopeForEnvironment('user.read', 'development')
+ * // Returns: 'edge-connect-staging/user.read' (maps to staging)
  * ```
  */
-declare function formatScopeForEnvironment(scope: EdgeScope, environment: 'production' | 'staging' | 'sandbox'): string;
+declare function formatScopeForEnvironment(scope: EdgeScope, environment: 'production' | 'staging' | 'sandbox' | 'development'): string;
 /**
  * Formats multiple scopes for an environment.
  *
@@ -2612,7 +2553,7 @@ declare function formatScopeForEnvironment(scope: EdgeScope, environment: 'produ
  * @param environment - The target environment
  * @returns Array of full scope strings
  */
-declare function formatScopesForEnvironment(scopes: readonly EdgeScope[] | EdgeScope[], environment: 'production' | 'staging' | 'sandbox'): string[];
+declare function formatScopesForEnvironment(scopes: readonly EdgeScope[] | EdgeScope[], environment: 'production' | 'staging' | 'sandbox' | 'development'): string[];
 /**
  * Parses a full scope string to extract the base scope.
  *

package/dist/index.js

@@ -70,32 +70,46 @@ var OTP_METHODS = ["sms", "totp"];
 // src/config/environments.ts
 var EDGE_ENVIRONMENTS = {
   production: {
-    authDomain: "auth.edgeboost.com",
+    cognitoDomain: "https://edge-connect.auth.us-east-1.amazoncognito.com",
     apiBaseUrl: "https://api.edgeboost.com/connect/v1",
-    oauthBaseUrl: "https://api.edgeboost.com",
+    oauthBaseUrl: "https://api.edgeboost.com/api/v3/oauth",
     userClientUrl: "https://app.edgeboost.com",
     displayName: "Production",
     isProduction: true
   },
   staging: {
-    // Legacy: Cognito User Pool for staging (not used with new self-issued tokens)
-    authDomain: "edge-connect-staging.auth.us-east-1.amazoncognito.com",
-    // API Gateway via ngrok - Connect API endpoints (NestJS mounted at /connect)
-    apiBaseUrl: "https://revocable-overvaliantly-emmalyn.ngrok-free.app/connect/v1",
-    // API Gateway via ngrok - OAuth token endpoint (NestJS mounted at /connect)
-    oauthBaseUrl: "https://revocable-overvaliantly-emmalyn.ngrok-free.app/connect",
-    // User client for OAuth login/consent
-    userClientUrl: "https://edgeboost-user-client.ngrok.io",
+    cognitoDomain: "https://edge-connect-staging.auth.us-east-1.amazoncognito.com",
+    apiBaseUrl: "https://staging-api.edgeboost.io/connect/v1",
+    oauthBaseUrl: "https://staging-api.edgeboost.io/api/v3/oauth",
+    userClientUrl: "https://connect-staging.edgeboost.io",
     displayName: "Staging",
     isProduction: false
   },
   sandbox: {
-    authDomain: "sandbox-auth.edgeboost.com",
+    cognitoDomain: "https://edge-connect-sandbox.auth.us-east-1.amazoncognito.com",
     apiBaseUrl: "https://sandbox-api.edgeboost.com/connect/v1",
-    oauthBaseUrl: "https://sandbox-api.edgeboost.com",
+    oauthBaseUrl: "https://sandbox-api.edgeboost.com/api/v3/oauth",
     userClientUrl: "https://sandbox.edgeboost.com",
     displayName: "Sandbox",
     isProduction: false
+  },
+  /**
+   * Development environment for local testing with API Gateway.
+   *
+   * Architecture:
+   * - apiBaseUrl: Goes through API Gateway → ngrok → local backend (JWT validated by API Gateway)
+   * - oauthBaseUrl: Goes directly to ngrok → local backend (consent/token exchange)
+   * - userClientUrl: ngrok tunnel to local edgeboost-user-client (consent popup)
+   *
+   * The ngrok URL is configured in edgeboost-api/ngrok.yml with a static domain.
+   */
+  development: {
+    cognitoDomain: "https://edge-connect-staging.auth.us-east-1.amazoncognito.com",
+    apiBaseUrl: "https://connect-staging.edgeboost.io/connect/v1",
+    oauthBaseUrl: "https://revocable-overvaliantly-emmalyn.ngrok-free.app/oauth",
+    userClientUrl: "https://edgeboost-user-client.ngrok-free.app",
+    displayName: "Development",
+    isProduction: false
   }
 };
 function getEnvironmentConfig(environment) {
@@ -138,7 +152,8 @@ var SCOPE_ICONS = {
   [EDGE_SCOPES.TRANSFER_WRITE]: "arrow-left-right"
 };
 function formatScopeForEnvironment(scope, environment) {
-  const prefix = environment === "production" ? "edge-connect" : `edge-connect-${environment}`;
+  const effectiveEnv = environment === "development" ? "staging" : environment;
+  const prefix = effectiveEnv === "production" ? "edge-connect" : `edge-connect-${effectiveEnv}`;
   return `${prefix}/${scope}`;
 }
 function formatScopesForEnvironment(scopes, environment) {

package/dist/index.mjs

@@ -11,32 +11,46 @@ var OTP_METHODS = ["sms", "totp"];
 // src/config/environments.ts
 var EDGE_ENVIRONMENTS = {
   production: {
-    authDomain: "auth.edgeboost.com",
+    cognitoDomain: "https://edge-connect.auth.us-east-1.amazoncognito.com",
     apiBaseUrl: "https://api.edgeboost.com/connect/v1",
-    oauthBaseUrl: "https://api.edgeboost.com",
+    oauthBaseUrl: "https://api.edgeboost.com/api/v3/oauth",
     userClientUrl: "https://app.edgeboost.com",
     displayName: "Production",
     isProduction: true
   },
   staging: {
-    // Legacy: Cognito User Pool for staging (not used with new self-issued tokens)
-    authDomain: "edge-connect-staging.auth.us-east-1.amazoncognito.com",
-    // API Gateway via ngrok - Connect API endpoints (NestJS mounted at /connect)
-    apiBaseUrl: "https://revocable-overvaliantly-emmalyn.ngrok-free.app/connect/v1",
-    // API Gateway via ngrok - OAuth token endpoint (NestJS mounted at /connect)
-    oauthBaseUrl: "https://revocable-overvaliantly-emmalyn.ngrok-free.app/connect",
-    // User client for OAuth login/consent
-    userClientUrl: "https://edgeboost-user-client.ngrok.io",
+    cognitoDomain: "https://edge-connect-staging.auth.us-east-1.amazoncognito.com",
+    apiBaseUrl: "https://staging-api.edgeboost.io/connect/v1",
+    oauthBaseUrl: "https://staging-api.edgeboost.io/api/v3/oauth",
+    userClientUrl: "https://connect-staging.edgeboost.io",
     displayName: "Staging",
     isProduction: false
   },
   sandbox: {
-    authDomain: "sandbox-auth.edgeboost.com",
+    cognitoDomain: "https://edge-connect-sandbox.auth.us-east-1.amazoncognito.com",
     apiBaseUrl: "https://sandbox-api.edgeboost.com/connect/v1",
-    oauthBaseUrl: "https://sandbox-api.edgeboost.com",
+    oauthBaseUrl: "https://sandbox-api.edgeboost.com/api/v3/oauth",
     userClientUrl: "https://sandbox.edgeboost.com",
     displayName: "Sandbox",
     isProduction: false
+  },
+  /**
+   * Development environment for local testing with API Gateway.
+   *
+   * Architecture:
+   * - apiBaseUrl: Goes through API Gateway → ngrok → local backend (JWT validated by API Gateway)
+   * - oauthBaseUrl: Goes directly to ngrok → local backend (consent/token exchange)
+   * - userClientUrl: ngrok tunnel to local edgeboost-user-client (consent popup)
+   *
+   * The ngrok URL is configured in edgeboost-api/ngrok.yml with a static domain.
+   */
+  development: {
+    cognitoDomain: "https://edge-connect-staging.auth.us-east-1.amazoncognito.com",
+    apiBaseUrl: "https://connect-staging.edgeboost.io/connect/v1",
+    oauthBaseUrl: "https://revocable-overvaliantly-emmalyn.ngrok-free.app/oauth",
+    userClientUrl: "https://edgeboost-user-client.ngrok-free.app",
+    displayName: "Development",
+    isProduction: false
   }
 };
 function getEnvironmentConfig(environment) {
@@ -79,7 +93,8 @@ var SCOPE_ICONS = {
   [EDGE_SCOPES.TRANSFER_WRITE]: "arrow-left-right"
 };
 function formatScopeForEnvironment(scope, environment) {
-  const prefix = environment === "production" ? "edge-connect" : `edge-connect-${environment}`;
+  const effectiveEnv = environment === "development" ? "staging" : environment;
+  const prefix = effectiveEnv === "production" ? "edge-connect" : `edge-connect-${effectiveEnv}`;
   return `${prefix}/${scope}`;
 }
 function formatScopesForEnvironment(scopes, environment) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@edge-markets/connect",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "description": "Core types, configuration, and utilities for EDGE Connect SDK",
   "author": "EdgeBoost",
   "license": "MIT",
@@ -20,14 +20,6 @@
       }
     }
   },
-  "scripts": {
-    "build": "tsup src/index.ts --format cjs,esm --dts --clean",
-    "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
-    "generate:types": "openapi-typescript http://localhost:9080/api/v3/api/docs-json -o src/types/generated.ts",
-    "typecheck": "tsc --noEmit",
-    "test": "vitest",
-    "test:run": "vitest run"
-  },
   "devDependencies": {
     "openapi-typescript": "^7.0.0",
     "tsup": "^8.0.0",
@@ -53,6 +45,13 @@
   },
   "engines": {
     "node": ">=18"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts --clean",
+    "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
+    "generate:types": "openapi-typescript http://localhost:9080/api/v3/api/docs-json -o src/types/generated.ts",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest --passWithNoTests",
+    "test:run": "vitest run --passWithNoTests"
   }
-}
-
+}