@salesforce/capg-client 0.1.0-beta.1

package/dist/utils/error-classifier.js

@@ -0,0 +1,90 @@
+/*
+ * Copyright 2026, Salesforce, Inc. All rights reserved.
+ * See LICENSE.txt for license terms.
+ */
+/**
+ * Error Classification Utility
+ *
+ * Classifies unknown errors into appropriate CAPG error types based on
+ * status codes, error codes, and other error properties.
+ *
+ * @packageDocumentation
+ * @since v1.0.0
+ * @internal
+ */
+import { CAPGError, CAPGAuthError, CAPGNetworkError, CAPGAPIError } from '../errors/index.js';
+/**
+ * Redact credentials from a string to prevent leakage in logs/errors
+ *
+ * Removes:
+ * - Bearer tokens: 'Bearer abc123...' → 'Bearer ***'
+ * - Authorization headers: 'Authorization: Bearer xyz' → 'Authorization: ***'
+ * - Access tokens: 'access_token=abc123' → 'access_token=***'
+ *
+ * @param message - String that may contain credentials
+ * @returns Redacted string with credentials replaced by ***
+ *
+ * @internal
+ */
+export function redactCredentials(message) {
+    return message
+        .replace(/Bearer\s+[A-Za-z0-9_\-.!]+/gi, 'Bearer ***')
+        .replace(/Authorization:\s*[^\s]+/gi, 'Authorization: ***')
+        .replace(/access_token[=:]\s*[^\s&]+/gi, 'access_token=***');
+}
+/**
+ * Classify unknown error into appropriate CAPG error type
+ *
+ * Classifies errors by type:
+ * - 401 → CAPGAuthError (not retryable)
+ * - ETIMEDOUT, ECONNREFUSED, ENOTFOUND → CAPGNetworkError (retryable)
+ * - 4xx/5xx → CAPGAPIError with status code
+ * - Unknown → CAPGError
+ *
+ * @param error - Error from external operation (query, network, etc.)
+ * @param context - Context information (username, operation name, etc.)
+ * @returns CAPGError or subclass
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   await connection.query(soql);
+ * } catch (error: unknown) {
+ *   const capgError = classifyError(error, { username: 'user@example.com' });
+ *   return err(capgError);
+ * }
+ * ```
+ *
+ * @internal
+ */
+export function classifyError(error, context) {
+    // Type guard: ensure error is an object before accessing properties
+    if (error == null || typeof error !== 'object') {
+        return new CAPGError('UNKNOWN_ERROR', `Unexpected error during ${context?.operation ?? 'operation'}`, 'Check the error details and try again', undefined, false);
+    }
+    const errorObj = error;
+    // Handle axios error format (error.response.status) and direct status codes
+    const statusCode = errorObj?.response?.status ?? errorObj?.statusCode ?? errorObj?.status;
+    const errorCode = errorObj?.code;
+    const errorMessage = errorObj?.response?.data?.message;
+    // Redact credentials from username before using in error messages
+    const username = redactCredentials(context?.username ?? 'unknown');
+    const operation = context?.operation ?? 'operation';
+    // Authentication errors (401, 403)
+    if (statusCode === 401 || statusCode === 403) {
+        return new CAPGAuthError(`Authentication failed for org '${username}'. Please re-authenticate.`, error instanceof Error ? error : undefined);
+    }
+    // Network errors (timeout, connection refused, DNS failure)
+    if (errorCode === 'ETIMEDOUT' || errorCode === 'ECONNREFUSED' || errorCode === 'ENOTFOUND') {
+        return new CAPGNetworkError(`Network error while ${operation}`, undefined, error instanceof Error ? error : undefined);
+    }
+    // API errors (4xx, 5xx)
+    if (statusCode && statusCode >= 400) {
+        // Include error message from response data if available
+        const message = errorMessage ? `${errorMessage}` : `API error while ${operation} (HTTP ${statusCode})`;
+        return new CAPGAPIError(statusCode, message, undefined, error instanceof Error ? error : undefined);
+    }
+    // Unknown error
+    return new CAPGError('UNKNOWN_ERROR', `Unexpected error while ${operation}`, 'Check the error details and try again', error instanceof Error ? error : undefined, false);
+}
+//# sourceMappingURL=error-classifier.js.map

package/dist/utils/error-classifier.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error-classifier.js","sourceRoot":"","sources":["../../src/utils/error-classifier.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;GASG;AAEH,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAE9F;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,iBAAiB,CAAC,OAAe;IAC/C,OAAO,OAAO;SACX,OAAO,CAAC,8BAA8B,EAAE,YAAY,CAAC;SACrD,OAAO,CAAC,2BAA2B,EAAE,oBAAoB,CAAC;SAC1D,OAAO,CAAC,8BAA8B,EAAE,kBAAkB,CAAC,CAAC;AACjE,CAAC;AA4BD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,UAAU,aAAa,CAAC,KAAc,EAAE,OAAmD;IAC/F,oEAAoE;IACpE,IAAI,KAAK,IAAI,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC/C,OAAO,IAAI,SAAS,CAClB,eAAe,EACf,2BAA2B,OAAO,EAAE,SAAS,IAAI,WAAW,EAAE,EAC9D,uCAAuC,EACvC,SAAS,EACT,KAAK,CACN,CAAC;IACJ,CAAC;IAED,MAAM,QAAQ,GAAG,KAAsB,CAAC;IACxC,4EAA4E;IAC5E,MAAM,UAAU,GAAG,QAAQ,EAAE,QAAQ,EAAE,MAAM,IAAI,QAAQ,EAAE,UAAU,IAAI,QAAQ,EAAE,MAAM,CAAC;IAC1F,MAAM,SAAS,GAAG,QAAQ,EAAE,IAAI,CAAC;IACjC,MAAM,YAAY,GAAG,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,CAAC;IACvD,kEAAkE;IAClE,MAAM,QAAQ,GAAG,iBAAiB,CAAC,OAAO,EAAE,QAAQ,IAAI,SAAS,CAAC,CAAC;IACnE,MAAM,SAAS,GAAG,OAAO,EAAE,SAAS,IAAI,WAAW,CAAC;IAEpD,mCAAmC;IACnC,IAAI,UAAU,KAAK,GAAG,IAAI,UAAU,KAAK,GAAG,EAAE,CAAC;QAC7C,OAAO,IAAI,aAAa,CACtB,kCAAkC,QAAQ,4BAA4B,EACtE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAC3C,CAAC;IACJ,CAAC;IAED,4DAA4D;IAC5D,IAAI,SAAS,KAAK,WAAW,IAAI,SAAS,KAAK,cAAc,IAAI,SAAS,KAAK,WAAW,EAAE,CAAC;QAC3F,OAAO,IAAI,gBAAgB,CACzB,uBAAuB,SAAS,EAAE,EAClC,SAAS,EACT,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAC3C,CAAC;IACJ,CAAC;IAED,wBAAwB;IACxB,IAAI,UAAU,IAAI,UAAU,IAAI,GAAG,EAAE,CAAC;QACpC,wDAAwD;QACxD,MAAM,OAAO,GAAG,YAAY,CAAC,CAAC,CAAC,GAAG,YAAY,EAAE,CAAC,CAAC,CAAC,mBAAmB,SAAS,UAAU,UAAU,GAAG,CAAC;QACvG,OAAO,IAAI,YAAY,CAAC,UAAU,EAAE,OAAO,EAAE,SAAS,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IACtG,CAAC;IAED,gBAAgB;IAChB,OAAO,IAAI,SAAS,CAClB,eAAe,EACf,0BAA0B,SAAS,EAAE,EACrC,uCAAuC,EACvC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,EAC1C,KAAK,CACN,CAAC;AACJ,CAAC"}

package/package.json

@@ -0,0 +1,143 @@
+{
+  "name": "@salesforce/capg-client",
+  "version": "0.1.0-beta.1",
+  "description": "TypeScript client library for CAPG (Coding Agent Policy Governance) data fetching",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "wireit",
+    "test": "vitest",
+    "test:run": "wireit",
+    "test:unit": "wireit",
+    "test:coverage": "wireit",
+    "lint": "wireit",
+    "format": "wireit",
+    "format:check": "prettier --check \"src/**/*.ts\" \"test/**/*.ts\"",
+    "docs": "typedoc src/index.ts --out api-docs",
+    "clean": "rm -rf dist coverage .wireit .eslintcache* *.tsbuildinfo api-docs",
+    "prepare": "husky",
+    "prepublishOnly": "npm run build && npm run test:run && npm run lint"
+  },
+  "keywords": [
+    "salesforce",
+    "capg",
+    "governance",
+    "policy",
+    "devops"
+  ],
+  "author": "DX Command Center Team",
+  "license": "SEE LICENSE IN LICENSE.txt",
+  "files": [
+    "dist/**",
+    "LICENSE.txt",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "peerDependencies": {
+    "@salesforce/core": "^8.0.0"
+  },
+  "devDependencies": {
+    "@salesforce/prettier-config": "^0.0.3",
+    "@types/node": "^20.0.0",
+    "@typescript-eslint/eslint-plugin": "^7.0.0",
+    "@typescript-eslint/parser": "^7.0.0",
+    "@vitest/coverage-v8": "^3.0.7",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-config-salesforce-typescript": "^3.4.0",
+    "eslint-plugin-jsdoc": "^46.10.1",
+    "eslint-plugin-security": "^3.0.0",
+    "husky": "^9.1.6",
+    "prettier": "^3.3.3",
+    "pretty-quick": "^4.0.0",
+    "typedoc": "^0.27.0",
+    "typescript": "^5.6.2",
+    "vitest": "^3.0.7",
+    "wireit": "^0.14.9"
+  },
+  "dependencies": {
+    "axios": "^1.6.0",
+    "zod": "^3.22.0"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "wireit": {
+    "build": {
+      "command": "tsc --build --incremental",
+      "files": [
+        "src/**/*.ts",
+        "tsconfig.json"
+      ],
+      "output": [
+        "dist/**",
+        "tsconfig.tsbuildinfo"
+      ],
+      "clean": "if-file-deleted",
+      "dependencies": [
+        "lint"
+      ]
+    },
+    "format": {
+      "command": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
+      "files": [
+        "src/**/*.ts",
+        "test/**/*.ts",
+        ".prettierrc.cjs"
+      ],
+      "output": []
+    },
+    "lint": {
+      "command": "eslint --fix ./src ./test --ext .ts --cache --cache-location .eslintcache",
+      "files": [
+        "src/**/*.ts",
+        "test/**/*.ts",
+        ".eslintrc.json",
+        "tsconfig.json"
+      ],
+      "output": [],
+      "dependencies": [
+        "format"
+      ]
+    },
+    "test:unit": {
+      "command": "vitest run --dir ./test/unit",
+      "files": [
+        "src/**/*.ts",
+        "test/unit/**/*.ts",
+        "vitest.config.ts"
+      ],
+      "output": [
+        "coverage/**"
+      ],
+      "dependencies": [
+        "build"
+      ]
+    },
+    "test:run": {
+      "description": "Run all tests and exit",
+      "dependencies": [
+        "test:unit",
+        "lint"
+      ]
+    },
+    "test:coverage": {
+      "command": "vitest run --coverage --dir ./test/unit",
+      "files": [
+        "src/**/*.ts",
+        "test/unit/**/*.ts",
+        "vitest.config.ts"
+      ],
+      "output": [
+        "coverage/**"
+      ],
+      "dependencies": [
+        "build"
+      ]
+    }
+  }
+}