@edge-markets/connect 1.0.0

package/dist/index.js

@@ -0,0 +1,348 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  ALL_EDGE_SCOPES: () => ALL_EDGE_SCOPES,
+  EDGE_ENVIRONMENTS: () => EDGE_ENVIRONMENTS,
+  EDGE_SCOPES: () => EDGE_SCOPES,
+  EdgeApiError: () => EdgeApiError,
+  EdgeAuthenticationError: () => EdgeAuthenticationError,
+  EdgeConsentRequiredError: () => EdgeConsentRequiredError,
+  EdgeError: () => EdgeError,
+  EdgeInsufficientScopeError: () => EdgeInsufficientScopeError,
+  EdgeNetworkError: () => EdgeNetworkError,
+  EdgeNotFoundError: () => EdgeNotFoundError,
+  EdgePopupBlockedError: () => EdgePopupBlockedError,
+  EdgePopupClosedError: () => EdgePopupClosedError,
+  EdgeStateMismatchError: () => EdgeStateMismatchError,
+  EdgeTokenExchangeError: () => EdgeTokenExchangeError,
+  EdgeValidationError: () => EdgeValidationError,
+  OTP_METHODS: () => OTP_METHODS,
+  SCOPE_DESCRIPTIONS: () => SCOPE_DESCRIPTIONS,
+  SCOPE_ICONS: () => SCOPE_ICONS,
+  SDK_NAME: () => SDK_NAME,
+  SDK_VERSION: () => SDK_VERSION,
+  TRANSFER_STATUSES: () => TRANSFER_STATUSES,
+  TRANSFER_TYPES: () => TRANSFER_TYPES,
+  formatScopeForEnvironment: () => formatScopeForEnvironment,
+  formatScopesForEnvironment: () => formatScopesForEnvironment,
+  getAvailableEnvironments: () => getAvailableEnvironments,
+  getEnvironmentConfig: () => getEnvironmentConfig,
+  isApiError: () => isApiError,
+  isAuthenticationError: () => isAuthenticationError,
+  isConsentRequiredError: () => isConsentRequiredError,
+  isEdgeError: () => isEdgeError,
+  isNetworkError: () => isNetworkError,
+  isProductionEnvironment: () => isProductionEnvironment,
+  isValidScope: () => isValidScope,
+  parseScope: () => parseScope
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/types/api.types.ts
+var TRANSFER_TYPES = ["debit", "credit"];
+var TRANSFER_STATUSES = [
+  "pending_verification",
+  "completed",
+  "failed",
+  "expired"
+];
+var OTP_METHODS = ["sms", "totp"];
+
+// src/config/environments.ts
+var EDGE_ENVIRONMENTS = {
+  production: {
+    authDomain: "auth.edgeboost.com",
+    apiBaseUrl: "https://api.edgeboost.com/connect/v1",
+    oauthBaseUrl: "https://api.edgeboost.com",
+    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",
+    displayName: "Staging",
+    isProduction: false
+  },
+  sandbox: {
+    authDomain: "sandbox-auth.edgeboost.com",
+    apiBaseUrl: "https://sandbox-api.edgeboost.com/connect/v1",
+    oauthBaseUrl: "https://sandbox-api.edgeboost.com",
+    userClientUrl: "https://sandbox.edgeboost.com",
+    displayName: "Sandbox",
+    isProduction: false
+  }
+};
+function getEnvironmentConfig(environment) {
+  return EDGE_ENVIRONMENTS[environment];
+}
+function isProductionEnvironment(environment) {
+  return EDGE_ENVIRONMENTS[environment].isProduction;
+}
+function getAvailableEnvironments() {
+  return Object.keys(EDGE_ENVIRONMENTS);
+}
+
+// src/config/scopes.ts
+var EDGE_SCOPES = {
+  /**
+   * Read user profile information (name, email).
+   * Required for: `GET /v1/user`
+   */
+  USER_READ: "user.read",
+  /**
+   * Read account balance.
+   * Required for: `GET /v1/balance`
+   */
+  BALANCE_READ: "balance.read",
+  /**
+   * Initiate and verify fund transfers.
+   * Required for: `POST /v1/transfer`, `POST /v1/transfer/:id/verify`, `GET /v1/transfers`
+   */
+  TRANSFER_WRITE: "transfer.write"
+};
+var ALL_EDGE_SCOPES = Object.values(EDGE_SCOPES);
+var SCOPE_DESCRIPTIONS = {
+  [EDGE_SCOPES.USER_READ]: "View your profile information (name and email)",
+  [EDGE_SCOPES.BALANCE_READ]: "View your EdgeBoost account balance",
+  [EDGE_SCOPES.TRANSFER_WRITE]: "Transfer funds to and from your EdgeBoost account"
+};
+var SCOPE_ICONS = {
+  [EDGE_SCOPES.USER_READ]: "user",
+  [EDGE_SCOPES.BALANCE_READ]: "wallet",
+  [EDGE_SCOPES.TRANSFER_WRITE]: "arrow-left-right"
+};
+function formatScopeForEnvironment(scope, environment) {
+  const prefix = environment === "production" ? "edge-connect" : `edge-connect-${environment}`;
+  return `${prefix}/${scope}`;
+}
+function formatScopesForEnvironment(scopes, environment) {
+  return [...scopes].map((scope) => formatScopeForEnvironment(scope, environment));
+}
+function parseScope(fullScope) {
+  const parts = fullScope.split("/");
+  if (parts.length !== 2) return null;
+  const baseScope = parts[1];
+  return Object.values(EDGE_SCOPES).includes(baseScope) ? baseScope : null;
+}
+function isValidScope(scope) {
+  return Object.values(EDGE_SCOPES).includes(scope);
+}
+
+// src/errors/edge.error.ts
+var EdgeError = class _EdgeError extends Error {
+  constructor(code, message, statusCode, details) {
+    super(message);
+    this.name = "EdgeError";
+    this.code = code;
+    this.statusCode = statusCode;
+    this.details = details;
+    if (Error.captureStackTrace) {
+      Error.captureStackTrace(this, _EdgeError);
+    }
+    Object.setPrototypeOf(this, new.target.prototype);
+  }
+  /**
+   * Creates a user-friendly error message for display.
+   */
+  toUserMessage() {
+    return this.message;
+  }
+  /**
+   * Converts error to a plain object for logging/serialization.
+   */
+  toJSON() {
+    return {
+      name: this.name,
+      code: this.code,
+      message: this.message,
+      statusCode: this.statusCode,
+      details: this.details
+    };
+  }
+};
+var EdgeAuthenticationError = class extends EdgeError {
+  constructor(message, details) {
+    super(
+      "authentication_failed",
+      message || "Authentication failed or access token is invalid/expired",
+      401,
+      details
+    );
+    this.name = "EdgeAuthenticationError";
+  }
+};
+var EdgeTokenExchangeError = class extends EdgeError {
+  constructor(message, details) {
+    super(
+      "token_exchange_failed",
+      message || "Failed to exchange authorization code for tokens",
+      400,
+      details
+    );
+    this.name = "EdgeTokenExchangeError";
+  }
+};
+var EdgeConsentRequiredError = class extends EdgeError {
+  constructor(clientId, consentUrl, message) {
+    super(
+      "consent_required",
+      message || "User has not granted consent to this application",
+      403,
+      { clientId, consentUrl }
+    );
+    this.name = "EdgeConsentRequiredError";
+    this.clientId = clientId;
+    this.consentUrl = consentUrl;
+  }
+};
+var EdgeInsufficientScopeError = class extends EdgeError {
+  constructor(missingScopes, message) {
+    super(
+      "insufficient_scope",
+      message || `Missing required scopes: ${missingScopes.join(", ")}`,
+      403,
+      { missingScopes }
+    );
+    this.name = "EdgeInsufficientScopeError";
+    this.missingScopes = missingScopes;
+  }
+};
+var EdgeApiError = class extends EdgeError {
+  constructor(code, message, statusCode, details) {
+    super(code, message, statusCode, details);
+    this.name = "EdgeApiError";
+  }
+};
+var EdgeNotFoundError = class extends EdgeError {
+  constructor(resourceType, resourceId) {
+    super("not_found", `${resourceType} not found: ${resourceId}`, 404, { resourceType, resourceId });
+    this.name = "EdgeNotFoundError";
+    this.resourceType = resourceType;
+    this.resourceId = resourceId;
+  }
+};
+var EdgeValidationError = class extends EdgeError {
+  constructor(message, validationErrors) {
+    super("validation_failed", message, 400, { validationErrors });
+    this.name = "EdgeValidationError";
+    this.validationErrors = validationErrors;
+  }
+};
+var EdgePopupBlockedError = class extends EdgeError {
+  constructor() {
+    super(
+      "popup_blocked",
+      "Popup was blocked by the browser. Please allow popups for this site and try again."
+    );
+    this.name = "EdgePopupBlockedError";
+  }
+  toUserMessage() {
+    return "Please allow popups for this site to connect your EdgeBoost account.";
+  }
+};
+var EdgePopupClosedError = class extends EdgeError {
+  constructor() {
+    super("popup_closed", "User closed the authentication popup");
+    this.name = "EdgePopupClosedError";
+  }
+};
+var EdgeStateMismatchError = class extends EdgeError {
+  constructor() {
+    super(
+      "state_mismatch",
+      "Security error: state parameter mismatch. Please try again."
+    );
+    this.name = "EdgeStateMismatchError";
+  }
+};
+var EdgeNetworkError = class extends EdgeError {
+  constructor(message, cause) {
+    super("network_error", message || "Network request failed. Please check your connection.", void 0, {
+      originalError: cause?.message
+    });
+    this.name = "EdgeNetworkError";
+    this.cause = cause;
+  }
+};
+function isEdgeError(error) {
+  return error instanceof EdgeError;
+}
+function isAuthenticationError(error) {
+  return error instanceof EdgeAuthenticationError;
+}
+function isConsentRequiredError(error) {
+  return error instanceof EdgeConsentRequiredError;
+}
+function isApiError(error) {
+  return error instanceof EdgeApiError;
+}
+function isNetworkError(error) {
+  return error instanceof EdgeNetworkError;
+}
+
+// src/index.ts
+var SDK_VERSION = "1.0.0";
+var SDK_NAME = "@edge-markets/connect";
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ALL_EDGE_SCOPES,
+  EDGE_ENVIRONMENTS,
+  EDGE_SCOPES,
+  EdgeApiError,
+  EdgeAuthenticationError,
+  EdgeConsentRequiredError,
+  EdgeError,
+  EdgeInsufficientScopeError,
+  EdgeNetworkError,
+  EdgeNotFoundError,
+  EdgePopupBlockedError,
+  EdgePopupClosedError,
+  EdgeStateMismatchError,
+  EdgeTokenExchangeError,
+  EdgeValidationError,
+  OTP_METHODS,
+  SCOPE_DESCRIPTIONS,
+  SCOPE_ICONS,
+  SDK_NAME,
+  SDK_VERSION,
+  TRANSFER_STATUSES,
+  TRANSFER_TYPES,
+  formatScopeForEnvironment,
+  formatScopesForEnvironment,
+  getAvailableEnvironments,
+  getEnvironmentConfig,
+  isApiError,
+  isAuthenticationError,
+  isConsentRequiredError,
+  isEdgeError,
+  isNetworkError,
+  isProductionEnvironment,
+  isValidScope,
+  parseScope
+});

package/dist/index.mjs

@@ -0,0 +1,288 @@
+// src/types/api.types.ts
+var TRANSFER_TYPES = ["debit", "credit"];
+var TRANSFER_STATUSES = [
+  "pending_verification",
+  "completed",
+  "failed",
+  "expired"
+];
+var OTP_METHODS = ["sms", "totp"];
+
+// src/config/environments.ts
+var EDGE_ENVIRONMENTS = {
+  production: {
+    authDomain: "auth.edgeboost.com",
+    apiBaseUrl: "https://api.edgeboost.com/connect/v1",
+    oauthBaseUrl: "https://api.edgeboost.com",
+    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",
+    displayName: "Staging",
+    isProduction: false
+  },
+  sandbox: {
+    authDomain: "sandbox-auth.edgeboost.com",
+    apiBaseUrl: "https://sandbox-api.edgeboost.com/connect/v1",
+    oauthBaseUrl: "https://sandbox-api.edgeboost.com",
+    userClientUrl: "https://sandbox.edgeboost.com",
+    displayName: "Sandbox",
+    isProduction: false
+  }
+};
+function getEnvironmentConfig(environment) {
+  return EDGE_ENVIRONMENTS[environment];
+}
+function isProductionEnvironment(environment) {
+  return EDGE_ENVIRONMENTS[environment].isProduction;
+}
+function getAvailableEnvironments() {
+  return Object.keys(EDGE_ENVIRONMENTS);
+}
+
+// src/config/scopes.ts
+var EDGE_SCOPES = {
+  /**
+   * Read user profile information (name, email).
+   * Required for: `GET /v1/user`
+   */
+  USER_READ: "user.read",
+  /**
+   * Read account balance.
+   * Required for: `GET /v1/balance`
+   */
+  BALANCE_READ: "balance.read",
+  /**
+   * Initiate and verify fund transfers.
+   * Required for: `POST /v1/transfer`, `POST /v1/transfer/:id/verify`, `GET /v1/transfers`
+   */
+  TRANSFER_WRITE: "transfer.write"
+};
+var ALL_EDGE_SCOPES = Object.values(EDGE_SCOPES);
+var SCOPE_DESCRIPTIONS = {
+  [EDGE_SCOPES.USER_READ]: "View your profile information (name and email)",
+  [EDGE_SCOPES.BALANCE_READ]: "View your EdgeBoost account balance",
+  [EDGE_SCOPES.TRANSFER_WRITE]: "Transfer funds to and from your EdgeBoost account"
+};
+var SCOPE_ICONS = {
+  [EDGE_SCOPES.USER_READ]: "user",
+  [EDGE_SCOPES.BALANCE_READ]: "wallet",
+  [EDGE_SCOPES.TRANSFER_WRITE]: "arrow-left-right"
+};
+function formatScopeForEnvironment(scope, environment) {
+  const prefix = environment === "production" ? "edge-connect" : `edge-connect-${environment}`;
+  return `${prefix}/${scope}`;
+}
+function formatScopesForEnvironment(scopes, environment) {
+  return [...scopes].map((scope) => formatScopeForEnvironment(scope, environment));
+}
+function parseScope(fullScope) {
+  const parts = fullScope.split("/");
+  if (parts.length !== 2) return null;
+  const baseScope = parts[1];
+  return Object.values(EDGE_SCOPES).includes(baseScope) ? baseScope : null;
+}
+function isValidScope(scope) {
+  return Object.values(EDGE_SCOPES).includes(scope);
+}
+
+// src/errors/edge.error.ts
+var EdgeError = class _EdgeError extends Error {
+  constructor(code, message, statusCode, details) {
+    super(message);
+    this.name = "EdgeError";
+    this.code = code;
+    this.statusCode = statusCode;
+    this.details = details;
+    if (Error.captureStackTrace) {
+      Error.captureStackTrace(this, _EdgeError);
+    }
+    Object.setPrototypeOf(this, new.target.prototype);
+  }
+  /**
+   * Creates a user-friendly error message for display.
+   */
+  toUserMessage() {
+    return this.message;
+  }
+  /**
+   * Converts error to a plain object for logging/serialization.
+   */
+  toJSON() {
+    return {
+      name: this.name,
+      code: this.code,
+      message: this.message,
+      statusCode: this.statusCode,
+      details: this.details
+    };
+  }
+};
+var EdgeAuthenticationError = class extends EdgeError {
+  constructor(message, details) {
+    super(
+      "authentication_failed",
+      message || "Authentication failed or access token is invalid/expired",
+      401,
+      details
+    );
+    this.name = "EdgeAuthenticationError";
+  }
+};
+var EdgeTokenExchangeError = class extends EdgeError {
+  constructor(message, details) {
+    super(
+      "token_exchange_failed",
+      message || "Failed to exchange authorization code for tokens",
+      400,
+      details
+    );
+    this.name = "EdgeTokenExchangeError";
+  }
+};
+var EdgeConsentRequiredError = class extends EdgeError {
+  constructor(clientId, consentUrl, message) {
+    super(
+      "consent_required",
+      message || "User has not granted consent to this application",
+      403,
+      { clientId, consentUrl }
+    );
+    this.name = "EdgeConsentRequiredError";
+    this.clientId = clientId;
+    this.consentUrl = consentUrl;
+  }
+};
+var EdgeInsufficientScopeError = class extends EdgeError {
+  constructor(missingScopes, message) {
+    super(
+      "insufficient_scope",
+      message || `Missing required scopes: ${missingScopes.join(", ")}`,
+      403,
+      { missingScopes }
+    );
+    this.name = "EdgeInsufficientScopeError";
+    this.missingScopes = missingScopes;
+  }
+};
+var EdgeApiError = class extends EdgeError {
+  constructor(code, message, statusCode, details) {
+    super(code, message, statusCode, details);
+    this.name = "EdgeApiError";
+  }
+};
+var EdgeNotFoundError = class extends EdgeError {
+  constructor(resourceType, resourceId) {
+    super("not_found", `${resourceType} not found: ${resourceId}`, 404, { resourceType, resourceId });
+    this.name = "EdgeNotFoundError";
+    this.resourceType = resourceType;
+    this.resourceId = resourceId;
+  }
+};
+var EdgeValidationError = class extends EdgeError {
+  constructor(message, validationErrors) {
+    super("validation_failed", message, 400, { validationErrors });
+    this.name = "EdgeValidationError";
+    this.validationErrors = validationErrors;
+  }
+};
+var EdgePopupBlockedError = class extends EdgeError {
+  constructor() {
+    super(
+      "popup_blocked",
+      "Popup was blocked by the browser. Please allow popups for this site and try again."
+    );
+    this.name = "EdgePopupBlockedError";
+  }
+  toUserMessage() {
+    return "Please allow popups for this site to connect your EdgeBoost account.";
+  }
+};
+var EdgePopupClosedError = class extends EdgeError {
+  constructor() {
+    super("popup_closed", "User closed the authentication popup");
+    this.name = "EdgePopupClosedError";
+  }
+};
+var EdgeStateMismatchError = class extends EdgeError {
+  constructor() {
+    super(
+      "state_mismatch",
+      "Security error: state parameter mismatch. Please try again."
+    );
+    this.name = "EdgeStateMismatchError";
+  }
+};
+var EdgeNetworkError = class extends EdgeError {
+  constructor(message, cause) {
+    super("network_error", message || "Network request failed. Please check your connection.", void 0, {
+      originalError: cause?.message
+    });
+    this.name = "EdgeNetworkError";
+    this.cause = cause;
+  }
+};
+function isEdgeError(error) {
+  return error instanceof EdgeError;
+}
+function isAuthenticationError(error) {
+  return error instanceof EdgeAuthenticationError;
+}
+function isConsentRequiredError(error) {
+  return error instanceof EdgeConsentRequiredError;
+}
+function isApiError(error) {
+  return error instanceof EdgeApiError;
+}
+function isNetworkError(error) {
+  return error instanceof EdgeNetworkError;
+}
+
+// src/index.ts
+var SDK_VERSION = "1.0.0";
+var SDK_NAME = "@edge-markets/connect";
+export {
+  ALL_EDGE_SCOPES,
+  EDGE_ENVIRONMENTS,
+  EDGE_SCOPES,
+  EdgeApiError,
+  EdgeAuthenticationError,
+  EdgeConsentRequiredError,
+  EdgeError,
+  EdgeInsufficientScopeError,
+  EdgeNetworkError,
+  EdgeNotFoundError,
+  EdgePopupBlockedError,
+  EdgePopupClosedError,
+  EdgeStateMismatchError,
+  EdgeTokenExchangeError,
+  EdgeValidationError,
+  OTP_METHODS,
+  SCOPE_DESCRIPTIONS,
+  SCOPE_ICONS,
+  SDK_NAME,
+  SDK_VERSION,
+  TRANSFER_STATUSES,
+  TRANSFER_TYPES,
+  formatScopeForEnvironment,
+  formatScopesForEnvironment,
+  getAvailableEnvironments,
+  getEnvironmentConfig,
+  isApiError,
+  isAuthenticationError,
+  isConsentRequiredError,
+  isEdgeError,
+  isNetworkError,
+  isProductionEnvironment,
+  isValidScope,
+  parseScope
+};

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@edge-markets/connect",
+  "version": "1.0.0",
+  "description": "Core types, configuration, and utilities for EDGE Connect SDK",
+  "author": "EdgeBoost",
+  "license": "MIT",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    }
+  },
+  "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",
+    "typescript": "^5.3.0",
+    "vitest": "^1.0.0"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "keywords": [
+    "edgeboost",
+    "edge-connect",
+    "sdk",
+    "oauth",
+    "fintech",
+    "typescript"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/edgeboost/edge-connect-sdk.git",
+    "directory": "packages/core"
+  },
+  "engines": {
+    "node": ">=18"
+  }
+}
+