@stack-spot/portal-network 0.184.0 → 0.185.0

package/src/error/DefaultAPIError.ts

@@ -1,151 +1,151 @@
-import { Dictionary } from '@stack-spot/portal-translate'
-import { every, isString } from 'lodash'
-import { actionDetails } from './dictionary/action-details'
-import { baseDictionary } from './dictionary/base'
-import { cntFields } from './dictionary/cnt-fields'
-import { workspaceDetails } from './dictionary/workspace-details'
-import { workspaceFields } from './dictionary/workspace-fields'
-import { ignoredTitleErrorCodes } from './IgnoredErrorCodes'
-import { ErrorDetailsProperties, StackspotAPIError } from './StackspotAPIError'
-import { ErrorResponse, LanguageSuggestedMessageKeys, ValidationDetails } from './types'
-
-// these details don't say anything the status already doesn't and we'd better use local translations for them.
-const ignoredDescriptions = [
-  'internal server error', 'not found', 'gateway timeout', 'temporally unavailable', 'forbidden', 'unauthorized', 'bad request',
-]
-
-const fieldDictionary = {
-  cnt: cntFields,
-  wks: workspaceFields,
-}
-
-const detailsDictionary = {
-  wks: workspaceDetails,
-  actionapi: actionDetails,
-}
-
-function getTitle(status: number, raw: ErrorResponse, dictionary: Dictionary, language: 'pt' | 'en') {
-  if (ignoredTitleErrorCodes.includes(raw.code)) return ' '
-  if (dictionary[language][raw.code]) return dictionary[language][raw.code]
-  if (raw.details && !ignoredDescriptions.includes(raw.details)) return raw.details
-  return (baseDictionary as Dictionary)[language][status] || baseDictionary[language].defaultTitle
-}
-
-function getValues(detail: ValidationDetails) {
-  return detail.values && every(detail.values, isString) ? `\n${detail.values.join('\n')}` : ''
-}
-
-function getSuggestedMessages(suggestedMessage: ErrorResponse['suggestedMessages'] | null | undefined, language?: 'pt' | 'en') {
-  const parseLanguage: Record<'pt' | 'en', LanguageSuggestedMessageKeys> = { pt: 'ptBr', en: 'enUs' }
-  return suggestedMessage?.[parseLanguage?.[language || 'en']]
-}
-
-const UNIT_REGEX_TEMPLATE = /{\d}/g
-const RANGE_REGEX_TEMPLATE = /{1-n}/g
-
-function containsNumberInBraces(input: string) {
-  return UNIT_REGEX_TEMPLATE.test(input) || RANGE_REGEX_TEMPLATE.test(input)
-}
-
-export function interpolateErrors(message: string, values: string[], fieldValuesFileContent: Record<string, string>) {
-  return message
-    .replace(UNIT_REGEX_TEMPLATE, (value) => {
-      const position = +value.replace(/{|}/g, '')
-      const index = position - 1
-
-      const fieldValue = values[index]
-      return fieldValuesFileContent[fieldValue] || fieldValue
-    })
-    .replace(RANGE_REGEX_TEMPLATE, () => values.toString())
-}
-
-
-function createMessage(status: number, raw: ErrorResponse, dictionary: Dictionary, language?: 'pt' | 'en'): ErrorDetailsProperties {
-  const title = getTitle(status, raw, dictionary, language || 'en')
-  const api = raw.code?.split(/[-_]/)[0]
-  const dictDetails = (detailsDictionary[api?.toLowerCase() as keyof typeof detailsDictionary] ?? {})[language || 'en']
-  const dictionaryDetails = raw.code && dictDetails ? dictDetails[raw.code] : {}
-
-  if (raw?.validationDetails?.length) {
-
-    const suggestedMessages = raw.validationDetails.map((detail) =>
-      getSuggestedMessages(detail?.suggestedMessages, language)).filter((msg) => !!msg)
-
-    if (suggestedMessages.length) {
-      return { description: suggestedMessages.join('\n'), ...dictionaryDetails }
-    }
-
-    const details = raw.validationDetails?.map((detail) => {
-      const dict: Record<string, string> =
-        (fieldDictionary[api?.toLowerCase() as keyof typeof fieldDictionary] ?? {})[language || 'en'] ?? {}
-      const codeTranslatedMessage = raw.code !== detail.code && dictionary[language || 'en'][detail.code]
-
-      if (codeTranslatedMessage && containsNumberInBraces(codeTranslatedMessage) && (detail.values?.length || detail.field?.length)) {
-        const value = detail.values?.length ? detail.values : (detail.field ? [detail.field] : [])
-        return interpolateErrors(codeTranslatedMessage, value, dict)
-      }
-
-      const name = dict[detail.code] || detail.field || codeTranslatedMessage || detail.details || ''
-      return `${name}${getValues(detail)}`
-    })?.filter(d => !!d)
-    return { description: details ? `${title}\n${details?.join('\n')}` : title, ...dictionaryDetails }
-  }
-
-  if (raw?.suggestedMessages) {
-    const suggestedMessages = getSuggestedMessages(raw?.suggestedMessages, language)
-    if (suggestedMessages) {
-      return { description: suggestedMessages, ...dictionaryDetails }
-    }
-  }
-
-  return { description: title, ...dictionaryDetails }
-}
-
-/**
- * This represents the Error thrown by most Stackspot APIs.
- */
-export class DefaultAPIError extends StackspotAPIError {
-  /**
-   * The error object as defined by the Stackspot API. If the response doesn't match the expected format this will be undefined.
-   */
-  data?: ErrorResponse
-  /**
-   * The response data, if this matches the expected format expected by a Stackspot Error, it will be the same as `data`.
-   */
-  raw?: any
-
-  constructor(
-    /**
-     * The response's data
-     */
-    rawResponse: any,
-    /**
-     * The response's status
-     */
-    status: number,
-    /**
-     * A dictionary for translating error codes and descriptions.
-     */
-    dictionary: Dictionary,
-    /**
-     * The response's headers.
-     */
-    headers?: Headers,
-  ) {
-    let parsedResponse
-    try {
-      parsedResponse = JSON.parse(rawResponse)
-    } catch (error) {
-      parsedResponse = rawResponse
-    }
-
-    super({
-      status: status,
-      code: parsedResponse.code,
-      message: language => createMessage(status, parsedResponse, dictionary, language),
-      headers,
-    })
-    this.raw = parsedResponse
-    if (this.raw?.code !== undefined && this.raw?.status !== undefined && this.raw?.details !== undefined) this.data = parsedResponse
-  }
-}
+import { Dictionary } from '@stack-spot/portal-translate'
+import { every, isString } from 'lodash'
+import { actionDetails } from './dictionary/action-details'
+import { baseDictionary } from './dictionary/base'
+import { cntFields } from './dictionary/cnt-fields'
+import { workspaceDetails } from './dictionary/workspace-details'
+import { workspaceFields } from './dictionary/workspace-fields'
+import { ignoredTitleErrorCodes } from './IgnoredErrorCodes'
+import { ErrorDetailsProperties, StackspotAPIError } from './StackspotAPIError'
+import { ErrorResponse, LanguageSuggestedMessageKeys, ValidationDetails } from './types'
+
+// these details don't say anything the status already doesn't and we'd better use local translations for them.
+const ignoredDescriptions = [
+  'internal server error', 'not found', 'gateway timeout', 'temporally unavailable', 'forbidden', 'unauthorized', 'bad request',
+]
+
+const fieldDictionary = {
+  cnt: cntFields,
+  wks: workspaceFields,
+}
+
+const detailsDictionary = {
+  wks: workspaceDetails,
+  actionapi: actionDetails,
+}
+
+function getTitle(status: number, raw: ErrorResponse, dictionary: Dictionary, language: 'pt' | 'en') {
+  if (ignoredTitleErrorCodes.includes(raw.code)) return ' '
+  if (dictionary[language][raw.code]) return dictionary[language][raw.code]
+  if (raw.details && !ignoredDescriptions.includes(raw.details)) return raw.details
+  return (baseDictionary as Dictionary)[language][status] || baseDictionary[language].defaultTitle
+}
+
+function getValues(detail: ValidationDetails) {
+  return detail.values && every(detail.values, isString) ? `\n${detail.values.join('\n')}` : ''
+}
+
+function getSuggestedMessages(suggestedMessage: ErrorResponse['suggestedMessages'] | null | undefined, language?: 'pt' | 'en') {
+  const parseLanguage: Record<'pt' | 'en', LanguageSuggestedMessageKeys> = { pt: 'ptBr', en: 'enUs' }
+  return suggestedMessage?.[parseLanguage?.[language || 'en']]
+}
+
+const UNIT_REGEX_TEMPLATE = /{\d}/g
+const RANGE_REGEX_TEMPLATE = /{1-n}/g
+
+function containsNumberInBraces(input: string) {
+  return UNIT_REGEX_TEMPLATE.test(input) || RANGE_REGEX_TEMPLATE.test(input)
+}
+
+export function interpolateErrors(message: string, values: string[], fieldValuesFileContent: Record<string, string>) {
+  return message
+    .replace(UNIT_REGEX_TEMPLATE, (value) => {
+      const position = +value.replace(/{|}/g, '')
+      const index = position - 1
+
+      const fieldValue = values[index]
+      return fieldValuesFileContent[fieldValue] || fieldValue
+    })
+    .replace(RANGE_REGEX_TEMPLATE, () => values.toString())
+}
+
+
+function createMessage(status: number, raw: ErrorResponse, dictionary: Dictionary, language?: 'pt' | 'en'): ErrorDetailsProperties {
+  const title = getTitle(status, raw, dictionary, language || 'en')
+  const api = raw.code?.split(/[-_]/)[0]
+  const dictDetails = (detailsDictionary[api?.toLowerCase() as keyof typeof detailsDictionary] ?? {})[language || 'en']
+  const dictionaryDetails = raw.code && dictDetails ? dictDetails[raw.code] : {}
+
+  if (raw?.validationDetails?.length) {
+
+    const suggestedMessages = raw.validationDetails.map((detail) =>
+      getSuggestedMessages(detail?.suggestedMessages, language)).filter((msg) => !!msg)
+
+    if (suggestedMessages.length) {
+      return { description: suggestedMessages.join('\n'), ...dictionaryDetails }
+    }
+
+    const details = raw.validationDetails?.map((detail) => {
+      const dict: Record<string, string> =
+        (fieldDictionary[api?.toLowerCase() as keyof typeof fieldDictionary] ?? {})[language || 'en'] ?? {}
+      const codeTranslatedMessage = raw.code !== detail.code && dictionary[language || 'en'][detail.code]
+
+      if (codeTranslatedMessage && containsNumberInBraces(codeTranslatedMessage) && (detail.values?.length || detail.field?.length)) {
+        const value = detail.values?.length ? detail.values : (detail.field ? [detail.field] : [])
+        return interpolateErrors(codeTranslatedMessage, value, dict)
+      }
+
+      const name = dict[detail.code] || detail.field || codeTranslatedMessage || detail.details || ''
+      return `${name}${getValues(detail)}`
+    })?.filter(d => !!d)
+    return { description: details ? `${title}\n${details?.join('\n')}` : title, ...dictionaryDetails }
+  }
+
+  if (raw?.suggestedMessages) {
+    const suggestedMessages = getSuggestedMessages(raw?.suggestedMessages, language)
+    if (suggestedMessages) {
+      return { description: suggestedMessages, ...dictionaryDetails }
+    }
+  }
+
+  return { description: title, ...dictionaryDetails }
+}
+
+/**
+ * This represents the Error thrown by most Stackspot APIs.
+ */
+export class DefaultAPIError extends StackspotAPIError {
+  /**
+   * The error object as defined by the Stackspot API. If the response doesn't match the expected format this will be undefined.
+   */
+  data?: ErrorResponse
+  /**
+   * The response data, if this matches the expected format expected by a Stackspot Error, it will be the same as `data`.
+   */
+  raw?: any
+
+  constructor(
+    /**
+     * The response's data
+     */
+    rawResponse: any,
+    /**
+     * The response's status
+     */
+    status: number,
+    /**
+     * A dictionary for translating error codes and descriptions.
+     */
+    dictionary: Dictionary,
+    /**
+     * The response's headers.
+     */
+    headers?: Headers,
+  ) {
+    let parsedResponse
+    try {
+      parsedResponse = JSON.parse(rawResponse)
+    } catch (error) {
+      parsedResponse = rawResponse
+    }
+
+    super({
+      status: status,
+      code: parsedResponse.code,
+      message: language => createMessage(status, parsedResponse, dictionary, language),
+      headers,
+    })
+    this.raw = parsedResponse
+    if (this.raw?.code !== undefined && this.raw?.status !== undefined && this.raw?.details !== undefined) this.data = parsedResponse
+  }
+}

package/src/error/FileUploadError.ts

@@ -1,18 +1,18 @@
-import { HttpValidationError } from '../api/ai'
-import { StackspotAPIError } from './StackspotAPIError'
-
-export class FileUploadError extends StackspotAPIError {
-  readonly fileName: string
-
-  constructor(fileName: string, error: any) {
-    super({
-      status: error.status,
-      headers: error.headers,
-      stack: error.stack,
-      message: error instanceof StackspotAPIError
-        ? error.message
-        : (error.data as HttpValidationError | undefined)?.detail?.map(d => d.msg)?.join('\n'),
-    })
-    this.fileName = fileName
-  }
-}
+import { HttpValidationError } from '../api/ai'
+import { StackspotAPIError } from './StackspotAPIError'
+
+export class FileUploadError extends StackspotAPIError {
+  readonly fileName: string
+
+  constructor(fileName: string, error: any) {
+    super({
+      status: error.status,
+      headers: error.headers,
+      stack: error.stack,
+      message: error instanceof StackspotAPIError
+        ? error.message
+        : (error.data as HttpValidationError | undefined)?.detail?.map(d => d.msg)?.join('\n'),
+    })
+    this.fileName = fileName
+  }
+}

package/src/error/IgnoredErrorCodes.ts

@@ -1,3 +1,3 @@
-
-// A list o errors we would not like to render on screen as title messages. 
-export const ignoredTitleErrorCodes = ['WKS_CONTEXT_ATTRIBUTE_TYPE_ERROR']
+
+// A list o errors we would not like to render on screen as title messages. 
+export const ignoredTitleErrorCodes = ['WKS_CONTEXT_ATTRIBUTE_TYPE_ERROR']

package/src/error/StackspotAPIError.ts

@@ -1,101 +1,101 @@
-import { getLanguage, ptEn } from '@stack-spot/portal-translate'
-
-export type InternationalizedMessage = (language: 'pt' | 'en') => string | ErrorDetailsProperties
-
-export interface ErrorDetailsProperties {
-  /**
-   * The error title
-   */
-  title?: string,
-  /**
-   * The error description
-   */
-  description?: string,
-  /**
-   * Label for link
-   */
-  linkLabel?: string,
-  /**
-   * Text for href of link 
-   */
-  linkHref?: string,
-}
-
-interface ErrorProperties {
-  /**
-   * The response's status.
-   */
-  status: number,
-  /**
-   * The response's headers.
-   */
-  headers?: Headers,
-  /**
-   * The error code defined by the API, if any.
-   */
-  code?: string,
-  /**
-   * The error message: may be a simple string or a function that returns a string depending on the language passed as parameter.
-   * 
-   * If not provided, will attempt to use the error code or 'unknown'.
-   */
-  message?: InternationalizedMessage | string | ErrorDetailsProperties,
-  /**
-   * The error's stack trace, if any.
-   */
-  stack?: string,
-  
-}
-
-function getMessage(error: ErrorProperties['message']) {
-  const message = typeof error === 'function' ? error('en') : error
-  return typeof message === 'string' ? message : message?.description
-}
-
-export class StackspotAPIError extends Error {
-  /**
-   * The response's status.
-   */
-  status: number
-  /**
-   * The response's headers.
-   */
-  headers: Headers | undefined
-  /**
-   * The error code defined by the API, if any.
-   */
-  code: string | undefined
-  private intl?: InternationalizedMessage
-
-  constructor({ status, code, headers, message, stack }: ErrorProperties) {
-    super(`Stackspot API error (network ${status}): ${getMessage(message)}`)
-    this.status = status
-    this.code = code
-    this.headers = headers
-    this.stack = stack
-    this.intl = typeof message === 'string' || typeof message === 'object' ?  () => message : message
-  }
-
-  /**
-   * Translates the error to the given language.
-   * @param language 
-   * @returns an error message
-   */
-  translate(language = getLanguage(ptEn)): string {
-    const unknown = language === 'en' ? 'unknown error' : 'erro desconhecido'
-    
-    const error = this.intl?.(language) 
-    const message = typeof error === 'string' ? error : error?.description
-    return message ?? this.message ?? this.code ?? (this.status === 0 ? unknown : `${this.status}`)
-  }
-
-  translateDetails(language = getLanguage(ptEn)): ErrorDetailsProperties {
-    const unknown = language === 'en' ? 'unknown error' : 'erro desconhecido'
-    const errorMessage = this.intl?.(language)
-    if (typeof errorMessage === 'string')
-      return { description: errorMessage }
-    if (typeof errorMessage === 'object')
-      return errorMessage
-    return { description: this.message ?? this.code ?? (this.status === 0 ? unknown : `${this.status}`) }
-  }
-}
+import { getLanguage, ptEn } from '@stack-spot/portal-translate'
+
+export type InternationalizedMessage = (language: 'pt' | 'en') => string | ErrorDetailsProperties
+
+export interface ErrorDetailsProperties {
+  /**
+   * The error title
+   */
+  title?: string,
+  /**
+   * The error description
+   */
+  description?: string,
+  /**
+   * Label for link
+   */
+  linkLabel?: string,
+  /**
+   * Text for href of link 
+   */
+  linkHref?: string,
+}
+
+interface ErrorProperties {
+  /**
+   * The response's status.
+   */
+  status: number,
+  /**
+   * The response's headers.
+   */
+  headers?: Headers,
+  /**
+   * The error code defined by the API, if any.
+   */
+  code?: string,
+  /**
+   * The error message: may be a simple string or a function that returns a string depending on the language passed as parameter.
+   * 
+   * If not provided, will attempt to use the error code or 'unknown'.
+   */
+  message?: InternationalizedMessage | string | ErrorDetailsProperties,
+  /**
+   * The error's stack trace, if any.
+   */
+  stack?: string,
+  
+}
+
+function getMessage(error: ErrorProperties['message']) {
+  const message = typeof error === 'function' ? error('en') : error
+  return typeof message === 'string' ? message : message?.description
+}
+
+export class StackspotAPIError extends Error {
+  /**
+   * The response's status.
+   */
+  status: number
+  /**
+   * The response's headers.
+   */
+  headers: Headers | undefined
+  /**
+   * The error code defined by the API, if any.
+   */
+  code: string | undefined
+  private intl?: InternationalizedMessage
+
+  constructor({ status, code, headers, message, stack }: ErrorProperties) {
+    super(`Stackspot API error (network ${status}): ${getMessage(message)}`)
+    this.status = status
+    this.code = code
+    this.headers = headers
+    this.stack = stack
+    this.intl = typeof message === 'string' || typeof message === 'object' ?  () => message : message
+  }
+
+  /**
+   * Translates the error to the given language.
+   * @param language 
+   * @returns an error message
+   */
+  translate(language = getLanguage(ptEn)): string {
+    const unknown = language === 'en' ? 'unknown error' : 'erro desconhecido'
+    
+    const error = this.intl?.(language) 
+    const message = typeof error === 'string' ? error : error?.description
+    return message ?? this.message ?? this.code ?? (this.status === 0 ? unknown : `${this.status}`)
+  }
+
+  translateDetails(language = getLanguage(ptEn)): ErrorDetailsProperties {
+    const unknown = language === 'en' ? 'unknown error' : 'erro desconhecido'
+    const errorMessage = this.intl?.(language)
+    if (typeof errorMessage === 'string')
+      return { description: errorMessage }
+    if (typeof errorMessage === 'object')
+      return errorMessage
+    return { description: this.message ?? this.code ?? (this.status === 0 ? unknown : `${this.status}`) }
+  }
+}

package/src/error/StreamCanceledError.ts

@@ -1,10 +1,10 @@
-import { StreamError } from './StreamError'
-
-export class StreamCanceledError extends StreamError {
-  constructor() {
-    super(language => language === 'pt'
-      ? 'Erro: a mensagem foi abortada pelo usuário.'
-      : 'Error: the message was aborted by the user.',
-    )
-  }
-}
+import { StreamError } from './StreamError'
+
+export class StreamCanceledError extends StreamError {
+  constructor() {
+    super(language => language === 'pt'
+      ? 'Erro: a mensagem foi abortada pelo usuário.'
+      : 'Error: the message was aborted by the user.',
+    )
+  }
+}

package/src/error/StreamError.ts

@@ -1,7 +1,7 @@
-import { InternationalizedMessage, StackspotAPIError } from './StackspotAPIError'
-
-export class StreamError extends StackspotAPIError {
-  constructor(message: InternationalizedMessage) {
-    super({ status: 0, message })
-  }
-}
+import { InternationalizedMessage, StackspotAPIError } from './StackspotAPIError'
+
+export class StreamError extends StackspotAPIError {
+  constructor(message: InternationalizedMessage) {
+    super({ status: 0, message })
+  }
+}

package/src/error/StreamJsonError.ts

@@ -1,10 +1,10 @@
-import { StreamError } from './StreamError'
-
-export class StreamJsonError extends StreamError {
-  constructor() {
-    super(language => language === 'pt'
-      ? 'Erro no formato do stream. O conteúdo não é um JSON válido.'
-      : 'Stream format error. The streamed content is not a valid JSON.',
-    )
-  }
-}
+import { StreamError } from './StreamError'
+
+export class StreamJsonError extends StreamError {
+  constructor() {
+    super(language => language === 'pt'
+      ? 'Erro no formato do stream. O conteúdo não é um JSON válido.'
+      : 'Stream format error. The streamed content is not a valid JSON.',
+    )
+  }
+}