@stack-spot/portal-network 0.160.1 → 0.162.0

package/src/client/runtime-manager.ts

@@ -1,14 +1,14 @@
 import { HttpError } from '@oazapfts/runtime'
 import { defaults, getAppInfo, getAppsInRealm, getPluginDeployments, getRunByUlid, getRunsOnAllEnvs, getRunsOnEnv, getRunsRunning, getRunTaskPlugins, getRunTasks, runRollbackApp1, runRollbackInfra1 } from '../api/apiRuntime'
-import apis from '../apis.json'
 import { DefaultAPIError } from '../error/DefaultAPIError'
 import { rteDictionary } from '../error/dictionary/rte'
 import { StackspotAPIError } from '../error/StackspotAPIError'
 import { ReactQueryNetworkClient } from '../network/ReactQueryNetworkClient'
+import { getApiAddresses } from '../api-addresses'
 
 class RuntimeManagerClient extends ReactQueryNetworkClient {
   constructor() {
-    super(apis.apiRuntime.url, defaults)
+    super(getApiAddresses().apiRuntime.url, defaults)
   }
 
   protected buildStackSpotError(error: HttpError): StackspotAPIError {

package/src/client/secrets.ts

@@ -1,15 +1,15 @@
 import { HttpError } from '@oazapfts/runtime'
 
 import { createKey, defaults, deleteKey, deleteSecretValue, editKey, encrypt, getAll1, getAvailability, updateSecretValue } from '../api/secrets'
-import apis from '../apis.json'
 import { DefaultAPIError } from '../error/DefaultAPIError'
 import { secretsDictionary } from '../error/dictionary/secrets'
 import { StackspotAPIError } from '../error/StackspotAPIError'
 import { ReactQueryNetworkClient } from '../network/ReactQueryNetworkClient'
+import { getApiAddresses } from '../api-addresses'
 
 class SecretClient extends ReactQueryNetworkClient {
   constructor() {
-    super(apis.secrets.url, defaults)
+    super(getApiAddresses().secrets.url, defaults)
   }
 
   protected buildStackSpotError(error: HttpError): StackspotAPIError {

package/src/client/workflow.ts

@@ -1,15 +1,15 @@
 import { HttpError } from '@oazapfts/runtime'
 import { createApiServiceWorkflowsCreateApiDispatchPost, defaults, getExecutionDispatchRequestServiceWorkflowsExecutionIdRequestGet, getExecutionStatusServiceWorkflowsExecutionStatusExecutionIdGet, healthCheckServiceWorkflowsHealthCheckDispatchPost, runActionServiceWorkflowsRunActionDispatchPost, v1AcceptWorkflowExecutionJobSuspendedServiceV1ExecutionsExecutionIdJobsJobIdAcceptPost, v1GetWorkflowExecutionAttemptsV1ExecutionsExecutionIdAttemptsGet, v1GetWorkflowExecutionJobDetailServiceV1ExecutionsExecutionIdJobsJobIdGet, v1GetWorkflowExecutionJobGraphServiceV1ExecutionsExecutionIdGet, v1RefuseWorkflowExecutionJobSuspendedServiceV1ExecutionsExecutionIdJobsJobIdRefusePost, v1RetryWorkflowExecutionV1ExecutionsExecutionIdRetryPost } from '../api/workflows'
-import apis from '../apis.json'
 import { DefaultAPIError } from '../error/DefaultAPIError'
 import { actionDictionary } from '../error/dictionary/action'
 import { StackspotAPIError } from '../error/StackspotAPIError'
 import { ReactQueryNetworkClient } from '../network/ReactQueryNetworkClient'
 import { removeAuthorizationParam } from '../utils/remove-authorization-param'
+import { getApiAddresses } from '../api-addresses'
 
 class WorkflowClient extends ReactQueryNetworkClient {
   constructor() {
-    super(apis.workflows.url, defaults)
+    super(getApiAddresses().workflows.url, defaults)
   } 
 
   protected buildStackSpotError(error: HttpError): StackspotAPIError {

package/src/client/workspace-ai.ts

@@ -22,15 +22,15 @@ import {
   updateWorkspaceV1WorkspacesWorkspaceIdPatch,
   useShareableLinkV1ShareShareIdPatch,
 } from '../api/workspace-ai'
-import apis from '../apis.json'
 import { StackspotAPIError } from '../error/StackspotAPIError'
 import { ReactQueryNetworkClient } from '../network/ReactQueryNetworkClient'
 import { removeAuthorizationParam } from '../utils/remove-authorization-param'
 import { FixedAddResourceToWorkspaceAi, FixedWorkspaceAiPermissions, ReplaceResult } from './types'
+import { getApiAddresses } from '../api-addresses'
 
 class WorkspaceAiClient extends ReactQueryNetworkClient {
   constructor() {
-    super(apis['workspace-ai'].url, defaults)
+    super(getApiAddresses()['workspace-ai'].url, defaults)
   }
 
   protected buildStackSpotError(error: HttpError): StackspotAPIError {

package/src/client/workspace-manager.ts

@@ -72,7 +72,6 @@ import {
   workspaceVariableControllerfindByName,
   workspaceVariableControllerupsert,
 } from '../api/workspaceManager'
-import apis from '../apis.json'
 import { DefaultAPIError } from '../error/DefaultAPIError'
 import { workspaceDictionary } from '../error/dictionary/workspace'
 import { StackspotAPIError } from '../error/StackspotAPIError'
@@ -80,10 +79,11 @@ import { ReactQueryNetworkClient } from '../network/ReactQueryNetworkClient'
 import { contentClient } from './content'
 import { FixedFullInputContextResponse, FixedPaginatedActivityResponse, FixedPluginForAppCreationV2Response, FixedWorkflowForCreationResponse, ReplaceResult } from './types'
 import { workspaceClient } from './workspace'
+import { getApiAddresses } from '../api-addresses'
 
 class WorkspaceManagerClient extends ReactQueryNetworkClient {
   constructor() {
-    super(apis.workspaceManager.url, defaults)
+    super(getApiAddresses().workspaceManager.url, defaults)
   }
 
   protected buildStackSpotError(error: HttpError): StackspotAPIError {

package/src/client/workspace-search.ts

@@ -1,14 +1,14 @@
 import { HttpError } from '@oazapfts/runtime'
 import { clearUserHistory, defaults, deleteUserHistoryItem, getUserHistory, search } from '../api/workspaceSearchEngine'
-import apis from '../apis.json'
 import { DefaultAPIError } from '../error/DefaultAPIError'
 import { baseDictionary } from '../error/dictionary/base'
 import { StackspotAPIError } from '../error/StackspotAPIError'
 import { ReactQueryNetworkClient } from '../network/ReactQueryNetworkClient'
+import { getApiAddresses } from '../api-addresses'
 
 class WorkspaceSearchClient extends ReactQueryNetworkClient {
   constructor() {
-    super(apis.workspaceSearchEngine.url, defaults)
+    super(getApiAddresses().workspaceSearchEngine.url, defaults)
   }
 
   protected buildStackSpotError(error: HttpError): StackspotAPIError {

package/src/client/workspace.ts

@@ -82,16 +82,16 @@ import {
   workspaceVariableV2Controllerupsert,
 } from '../api/workspace'
 
-import apis from '../apis.json'
 import { DefaultAPIError } from '../error/DefaultAPIError'
 import { workspaceDictionary } from '../error/dictionary/workspace'
 import { StackspotAPIError } from '../error/StackspotAPIError'
 import { ReactQueryNetworkClient } from '../network/ReactQueryNetworkClient'
 import { OperationObject } from '../network/types'
+import { getApiAddresses } from '../api-addresses'
 
 class WorkspaceClient extends ReactQueryNetworkClient {
   constructor() {
-    super(apis.workspace.url, defaults)
+    super(getApiAddresses().workspace.url, defaults)
   }
 
   protected buildStackSpotError(error: HttpError): StackspotAPIError {

package/src/error/DefaultAPIError.ts

@@ -1,6 +1,5 @@
 import { Dictionary, Language } from '@stack-spot/portal-translate'
 import { every, isString } from 'lodash'
-import { ErrorResponse, ValidationDetails } from '../api/account'
 import { actionDetails } from './dictionary/action-details'
 import { baseDictionary } from './dictionary/base'
 import { cntFields } from './dictionary/cnt-fields'
@@ -8,6 +7,7 @@ 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 = [
@@ -35,6 +35,11 @@ function getValues(detail: ValidationDetails) {
   return detail.values && every(detail.values, isString) ? `\n${detail.values.join('\n')}` : ''
 }
 
+function getSuggestedMessages(suggestedMessage: ErrorResponse['suggestedMessages'] | null | undefined, language?: Language) {
+  const parseLanguage: Record<Language, LanguageSuggestedMessageKeys> = { pt: 'ptBr', en: 'enUs' }
+  return suggestedMessage?.[parseLanguage?.[language || 'en']]
+}
+
 const UNIT_REGEX_TEMPLATE = /{\d}/g
 const RANGE_REGEX_TEMPLATE = /{1-n}/g
 
@@ -61,21 +66,39 @@ function createMessage(status: number, raw: ErrorResponse, dictionary: Dictionar
   const dictDetails = (detailsDictionary[api?.toLowerCase() as keyof typeof detailsDictionary] ?? {})[language || 'en']
   const dictionaryDetails = raw.code && dictDetails ? dictDetails[raw.code] : {}
 
-  if (!raw.validationDetails?.length) return { description: title, ...dictionaryDetails }
+  if (raw?.validationDetails?.length) {
 
-  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]
+    const suggestedMessages = raw.validationDetails.map((detail) =>
+      getSuggestedMessages(detail?.suggestedMessages, language)).filter((msg) => !!msg)
 
-    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)
+    if (suggestedMessages.length) {
+      return { description: suggestedMessages.join('\n'), ...dictionaryDetails }
     }
 
-    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 }
+    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 }
 }
 
 /**

package/src/error/types.ts

@@ -0,0 +1,21 @@
+export type LanguageSuggestedMessageKeys = 'ptBr' | 'enUs';
+
+export type SuggestedMessage = {
+  [key in LanguageSuggestedMessageKeys]: string | null
+};
+
+export type ValidationDetails = {
+  code: string,
+  field?: string,
+  details?: string,
+  values?: string[],
+  suggestedMessages?: SuggestedMessage | null,
+};
+
+export type ErrorResponse = {
+  code: string,
+  status: number,
+  details: string,
+  validationDetails?: ValidationDetails[],
+  suggestedMessages?: SuggestedMessage | null,
+};

package/src/index.ts

@@ -1,5 +1,5 @@
 export { CancelledError } from '@tanstack/react-query'
-export { apiAddresses } from './api-addresses'
+export { apiAddresses, getApiAddresses, getBaseUrlWithOverride, setApisOverride } from './api-addresses'
 export { accountClient } from './client/account'
 export { agentClient } from './client/agent'
 export { agentToolsClient } from './client/agent-tools'

package/src/network/NetworkClient.ts

@@ -3,6 +3,7 @@ import { requestPermission } from '@stack-spot/opa'
 import { events } from 'fetch-event-stream'
 import { StackspotAPIError } from '../error/StackspotAPIError'
 import { Env, FetchEventStream, HTTPMethod, SessionManager } from './types'
+import { getBaseUrlWithOverride } from '../api-addresses'
 
 /**
  * A set of methods for performing network requests to an API.
@@ -54,6 +55,15 @@ export abstract class NetworkClient {
   private uninitializedError() {
     return new Error('Please, call "NetworkClient.setup(sessionManager, env)" before attempting to make a request.')
   }
+  
+  /**
+   * Resolves the final base URL for the current environment.
+   * If a local API override exists for the current environment and current resource (api name), it will be use instead.
+   * @returns the final baseURL for the current environment, considering overrides if available.
+   */
+  protected getBaseURL(): string {
+    return getBaseUrlWithOverride(this.baseURL, NetworkClient.env);
+  }
 
   /**
    * Builds a URL with the `baseUrl` of this network client and the `path` passed as parameter. 
@@ -65,7 +75,7 @@ export abstract class NetworkClient {
     // paths must not start with "/", otherwise, the base url will not be fully appended to it.
     const fixedPath = path.replace(/^\//, '')
     // the baseUrl must end with "/", otherwise, the last of its part will get replaced by the path, instead of concatenated with.
-    const fixedBaseUrl = this.baseURL[NetworkClient.env].replace(/([^/])$/, '$1/')
+    const fixedBaseUrl = this.getBaseURL().replace(/([^/])$/, '$1/')
     return new URL(fixedPath, fixedBaseUrl)
   }