@api-client/core 0.12.10 → 0.12.11

package/data/models/example-generator-api.json

@@ -42470,13 +42470,13 @@
 "@id": "#219"
 },
 {
-"@id": "#210"
+"@id": "#216"
 },
 {
-"@id": "#213"
+"@id": "#210"
 },
 {
-"@id": "#216"
+"@id": "#213"
 },
 {
 "@id": "#219"
@@ -43892,7 +43892,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "type: 'GENERAL'\ncountryDialCode : '+32'\nareaCode : '22'\nsubscriberNumber: '12.87.00'\nformatted: '+32-(0)22 000000'\n",
+"doc:raw": "type: 'GENERAL'\ncountryDialCode : '+32'\nareaCode : '21'\nsubscriberNumber: '12.87.00'\nformatted: '+32-(0)21 302099'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43913,7 +43913,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "type: 'GENERAL'\ncountryDialCode : '+32'\nareaCode : '21'\nsubscriberNumber: '12.87.00'\nformatted: '+32-(0)21 302099'\n",
+"doc:raw": "-\n  type: 'GENERAL'\n  value: 'info@company.be'\n-\n  type: 'IT_DEPT'\n  value: 'it-service@company.be'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43934,7 +43934,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "-\n  type: 'GENERAL'\n  value: 'info@company.be'\n-\n  type: 'IT_DEPT'\n  value: 'it-service@company.be'\n",
+"doc:raw": "type: 'GENERAL'\ncountryDialCode : '+32'\nareaCode : '22'\nsubscriberNumber: '12.87.00'\nformatted: '+32-(0)22 000000'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -44781,12 +44781,12 @@
 {
 "@id": "#215/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#215",
-"sourcemaps:value": "[(1,0)-(6,0)]"
+"sourcemaps:value": "[(1,0)-(7,0)]"
 },
 {
 "@id": "#218/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#218",
-"sourcemaps:value": "[(1,0)-(7,0)]"
+"sourcemaps:value": "[(1,0)-(6,0)]"
 },
 {
 "@id": "#221/source-map/lexical/element_0",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@api-client/core",
   "description": "The API Client's core client library. Works in NodeJS and in a ES enabled browser.",
-  "version": "0.12.10",
+  "version": "0.12.11",
   "license": "Apache-2.0",
   "exports": {
     "./browser.js": {

package/src/exceptions/exception.ts

@@ -1,3 +1,13 @@
+export interface ExceptionSchema {
+  name: string
+  message: string
+  status?: number
+  code?: string
+  help?: string
+  stack?: string
+  [key: string]: string | number | undefined
+}
+
 /**
  * Create a custom error class with the ability to define the error
  * code, status, and the help text.
@@ -46,7 +56,44 @@ export class Exception extends Error {
    */
   status: number
 
-  constructor(message?: string, options?: ErrorOptions & { code?: string; status?: number }) {
+  /**
+   * Create a new exception instance.
+   * It tries to extract the error code and status from the
+   * `init` object. If not found, it uses the default message.
+   * @param init - An object containing error details
+   * @param defaultMessage - A default message to use if `init.message` is not provided
+   * @returns An instance of the Exception class
+   * @example
+   * ```js
+   * const error = Exception.fromApiError({
+   *   code: 'E_FILE_NOT_FOUND',
+   *   status: 404,
+   *   message: 'File not found',
+   *   help: 'Please check the file path and try again'
+   * }, 'An error occurred while processing your request')
+   * ```
+   */
+  static fromRawException(init: object, defaultMessage: string): Exception {
+    const typed = init as Record<string, string | number>
+    const options: ErrorOptions & { code?: string; status?: number } = {}
+    if (typed.code) {
+      options.code = typed.code as string
+    }
+    if (typed.status) {
+      options.status = Number(typed.status)
+    }
+    const message = typed.message ?? defaultMessage
+    const result = new this(message as string, options)
+    if (typed.help) {
+      result.setHelp(typed.help as string)
+    }
+    if (typed.name) {
+      result.name = typed.name as string
+    }
+    return result
+  }
+
+  constructor(message?: string, options?: ErrorOptions & { code?: string; status?: number; help?: string }) {
     super(message, options)
 
     const ErrorConstructor = this.constructor as typeof Exception
@@ -60,7 +107,7 @@ export class Exception extends Error {
       this.code = code
     }
 
-    const help = ErrorConstructor.help
+    const help = options?.help || ErrorConstructor.help
     if (help !== undefined) {
       this.help = help
     }
@@ -94,8 +141,8 @@ export class Exception extends Error {
     return `${this.name}: ${this.message}`
   }
 
-  toJSON() {
-    const result: Record<string, string | number> = {
+  toJSON(): ExceptionSchema {
+    const result: ExceptionSchema = {
       name: this.name,
       message: this.message,
     }

package/src/proxy/HttpProjectProxy.ts

@@ -1,11 +1,11 @@
 import { IProjectRunnerOptions } from '../runtime/node/InteropInterfaces.js'
 import { Kind as HttpProjectKind, HttpProject, IHttpProject } from '../models/HttpProject.js'
-import { ApiError } from '../runtime/store/Errors.js'
 import { StoreSdk } from '../runtime/store/StoreSdkNode.js'
 import { ProjectSerialRunner } from '../runtime/node/ProjectSerialRunner.js'
 import { ProjectParallelRunner } from '../runtime/node/ProjectParallelRunner.js'
 import Proxy, { IProxyResult } from './Proxy.js'
 import { IProjectExecutionLog } from '../models/ProjectExecution.js'
+import { Exception } from '../exceptions/exception.js'
 
 interface ProxyInit {
   kind: typeof HttpProjectKind
@@ -44,52 +44,48 @@ export default class HttpProjectProxy extends Proxy {
 
   protected async configureStore(init: IHttpProjectStoreProxyInit, token: string, baseUri: string): Promise<void> {
     const { pid, options, organization } = init
+    const INVALID_REQUEST = 'Invalid request'
+    const code = 'E_INVALID_REQUEST'
     if (!pid) {
-      throw new ApiError({
-        error: true,
-        message: 'Invalid request',
-        detail: 'The "pid" parameter is required.',
-        code: 400,
+      throw new Exception(INVALID_REQUEST, {
+        help: 'The "pid" parameter is required.',
+        status: 400,
+        code,
       })
     }
     if (!organization) {
-      throw new ApiError({
-        error: true,
-        message: 'Invalid request',
-        detail: 'The "organization" parameter is required.',
-        code: 400,
+      throw new Exception(INVALID_REQUEST, {
+        help: 'The "organization" parameter is required.',
+        status: 400,
+        code,
       })
     }
     if (!options) {
-      throw new ApiError({
-        error: true,
-        message: 'Invalid request',
-        detail: 'The "options" parameter is required.',
-        code: 400,
+      throw new Exception(INVALID_REQUEST, {
+        help: 'The "options" parameter is required.',
+        status: 400,
+        code,
       })
     }
     if (!token) {
-      throw new ApiError({
-        error: true,
-        message: 'Invalid request',
-        detail: 'Set the authentication credentials.',
-        code: 400,
+      throw new Exception(INVALID_REQUEST, {
+        help: 'Set the authentication credentials.',
+        status: 400,
+        code,
       })
     }
     if (!baseUri) {
-      throw new ApiError({
-        error: true,
-        message: 'Invalid request',
-        detail: 'The store uri is missing.',
-        code: 400,
+      throw new Exception(INVALID_REQUEST, {
+        help: 'The store uri is missing.',
+        status: 400,
+        code,
       })
     }
     if (!baseUri.startsWith('http')) {
-      throw new ApiError({
-        error: true,
-        message: 'Invalid request',
-        detail: 'The store uri is invalid.',
-        code: 400,
+      throw new Exception(INVALID_REQUEST, {
+        help: 'The store uri is invalid.',
+        status: 400,
+        code,
       })
     }
     const sdk = new StoreSdk(baseUri)
@@ -100,10 +96,10 @@ export default class HttpProjectProxy extends Proxy {
       project = data.media as IHttpProject
     } catch (cause) {
       const e = cause as Error
-      throw new ApiError(e.message, 400)
+      throw new Exception(e.message, { status: 400 })
     }
     if (project.key !== pid) {
-      throw new ApiError(`Unable to read the project.`, 500)
+      throw new Exception(`Unable to read the project.`, { status: 500 })
     }
     this.options = options
     this.project = new HttpProject(project)
@@ -111,20 +107,20 @@ export default class HttpProjectProxy extends Proxy {
 
   protected async configureProject(init: IHttpProjectProxyInit): Promise<void> {
     const { project, options } = init
+    const INVALID_REQUEST = 'Invalid request'
+    const code = 'E_INVALID_REQUEST'
     if (!options) {
-      throw new ApiError({
-        error: true,
-        message: 'Invalid request',
-        detail: 'The "options" parameter is required.',
-        code: 400,
+      throw new Exception(INVALID_REQUEST, {
+        help: 'The "options" parameter is required.',
+        status: 400,
+        code,
       })
     }
     if (!project) {
-      throw new ApiError({
-        error: true,
-        message: 'Invalid request',
-        detail: 'The "project" parameter is required.',
-        code: 400,
+      throw new Exception(INVALID_REQUEST, {
+        help: 'The "project" parameter is required.',
+        status: 400,
+        code,
       })
     }
     this.options = options

package/src/proxy/RequestProxy.ts

@@ -3,12 +3,12 @@ import { IRequestAuthorization } from '../models/RequestAuthorization.js'
 import { IRequestConfig } from '../models/RequestConfig.js'
 import Proxy, { IProxyResult } from './Proxy.js'
 import { HttpCertificate } from '../models/ClientCertificate.js'
-import { ApiError } from '../runtime/store/Errors.js'
 import { DummyLogger } from '../lib/logging/DummyLogger.js'
 import { HttpRequestRunner } from '../runtime/http-runner/HttpRequestRunner.js'
 import { IRequestLog } from '../models/RequestLog.js'
 import { IHttpFlow } from '../models/http-flows/HttpFlows.js'
 import { IHttpAssertion } from '../models/http-flows/HttpAssertion.js'
+import { Exception } from '../exceptions/exception.js'
 
 export interface IRequestProxyInit {
   kind: typeof HttpRequestKind
@@ -54,20 +54,20 @@ export default class RequestProxy extends Proxy {
 
   async configure(init: IRequestProxyInit): Promise<void> {
     const { request } = init
+    const INVALID_REQUEST = 'Invalid request'
+    const code = 'E_INVALID_REQUEST'
     if (!request) {
-      throw new ApiError({
-        error: true,
-        message: 'Invalid request',
-        detail: 'The "request" parameter is required.',
-        code: 400,
+      throw new Exception(INVALID_REQUEST, {
+        help: 'The "request" parameter is required.',
+        status: 400,
+        code,
       })
     }
     if (!request.url) {
-      throw new ApiError({
-        error: true,
-        message: 'Invalid request',
-        detail: 'The "request.url" parameter is required.',
-        code: 400,
+      throw new Exception(INVALID_REQUEST, {
+        help: 'The "request.url" parameter is required.',
+        status: 400,
+        code,
       })
     }
     this.init = init