@stack-spot/portal-network 0.42.2 → 0.44.0

package/src/apis.json

@@ -154,7 +154,7 @@
     "url": {
       "dev": "https://cloud-cloud-platform-api.dev.stackspot.com",
       "stg": "https://cloud-cloud-platform-api.stg.stackspot.com",
-      "prd": "https://cloud-cloud-platform-api.stackspot.com"
+      "prd": "https://cloud-cloud-platform-api.prd.stackspot.com"
     },
     "docs": "/v3/api-docs"
   }

package/src/client/content.ts

@@ -1,19 +1,21 @@
 import { HttpError } from '@oazapfts/runtime'
-import { addAction, addLink, addWorkspace, associateActionToPlugin, changeVisibility, createStudio, defaults, 
+import {
+  addAction, addLink, addWorkspace, associateActionToPlugin, changeVisibility, createStudio, defaults,
   deleteAction, deleteActionVersion, deleteLink, deletePluginVersion, deleteStudio, deleteV1StacksVersionsByStackVersionId,
-  delWorkspace, deprecateActionVersion, deprecatePluginVersion, deprecateStackVersionBy, downloadAction, getActionBySlug, 
-  getActionsVersions, getActionVersionById, getAllActionVersions, getApplicationDetailsView, getApplicationsUsesPlugin, 
-  getAvailableActionVersionsByActionSlug, getDependentPluginsVersions, 
-  getGetPluginView, getInfrastructureEnvironmentsUsesPlugin, 
-  getListOfInputs, getPluginInfrastructureView, getPluginModalView, getPluginVersions, getPluginVersionsNotInUse, 
+  delWorkspace, deprecateActionVersion, deprecatePluginVersion, deprecateStackVersionBy, downloadAction, getActionBySlug,
+  getActionsVersions, getActionVersionById, getAllActionVersions, getApplicationDetailsView, getApplicationsUsesPlugin,
+  getAvailableActionVersionsByActionSlug, getDependentPluginsVersions,
+  getGetPluginView, getInfrastructureEnvironmentsUsesPlugin,
+  getListOfInputs, getPluginInfrastructureView, getPluginModalView, getPluginVersions, getPluginVersionsNotInUse,
   getPluginVersionUsageSummary, getStackUsesPlugin, getStackVersionById, getStackVersionListByIds, getStackWorkspaceDetailView,
-  getStackWorkspaces, getStarterStackVersionsAndPluginsVersions, getStarterUsesPlugin, getStudioByIdOrSlug, getStudios1, 
-  getStudiosToCreateButton, getStudioTabs, getUnusedStackVersions, getWorkflow, getWorkflowByStudioSlug, getWorkflowDoc, 
-  listActions, listActions1, 
+  getStackWorkspaces, getStarterStackVersionsAndPluginsVersions, getStarterUsesPlugin, getStudioByIdOrSlug, getStudios, getStudios1,
+  getStudiosToCreateButton, getStudioTabs, getUnusedStackVersions, getWorkflow, getWorkflowByStudioSlug, getWorkflowDoc,
+  listActions, listActions1,
   listActionsByFilters1, listConnectionInterfaceTypes, listLinksByStackVersion, listPlugins, listPluginVersionByIdsController,
-  listReasons, listStacksByFilters, listStarters, listWorkflowVersion, 
+  listReasons, listStacksByFilters, listStarters, listWorkflowVersion,
   listWorkspaces, patchStarterV2, removeActionFromPlugin, stackModalViewSummary,
-  stackVersionUsageSummary, updateStudio, updateStudioTabs } from '../api/content'
+  stackVersionUsageSummary, updateStudio, updateStudioTabs,
+} from '../api/content'
 import apis from '../apis.json'
 import { DefaultAPIError } from '../error/DefaultAPIError'
 import { cntDictionary } from '../error/dictionary/cnt'
@@ -50,6 +52,10 @@ class ContentClient extends ReactQueryNetworkClient {
    * Gets all studios
    */
   studios = this.query(removeAuthorizationParam(getStudios1))
+  /**
+   * Gets all studios
+   */
+  studiosWithPagination = this.query(removeAuthorizationParam(getStudios))
   /**
    * Gets all studios
    */
@@ -102,7 +108,7 @@ class ContentClient extends ReactQueryNetworkClient {
    * Gets stacks from a given studio
    */
   stacksFromStudios = this.query(listStacksByFilters)
-  
+
   //Workflow
   /**
    * Gets workflows from a given studio
@@ -283,7 +289,7 @@ class ContentClient extends ReactQueryNetworkClient {
   /**
    * Gets the inputs of a specific Action. This fn is only used for permission purposes.
    */
-  actionInputs = this.query(getListOfInputs) as 
+  actionInputs = this.query(getListOfInputs) as
     OperationObject<Parameters<typeof getListOfInputs>[0]>
   /**
    * Gets action versions by ids

package/src/error/DefaultAPIError.ts

@@ -1,10 +1,12 @@
 import { Dictionary, Language } from '@stack-spot/portal-translate'
 import { every, isString } from 'lodash'
 import { ErrorResponse, ValidationDetails } from '../api/account'
-import { StackspotAPIError } from './StackspotAPIError'
+import { ErrorDetailsProperties, StackspotAPIError } from './StackspotAPIError'
 import { baseDictionary } from './dictionary/base'
 import { cntFields } from './dictionary/cnt-fields'
 import { workspaceFields } from './dictionary/workspace-fields'
+import { workspaceDetails } from './dictionary/workspace-details'
+import { actionDetails } from './dictionary/action-details'
 
 // these details don't say anything the status already doesn't and we'd better use local translations for them.
 const ignoredDescriptions = [
@@ -16,6 +18,11 @@ const fieldDictionary = {
   wks: workspaceFields,
 }
 
+const detailsDictionary = {
+  wks: workspaceDetails,
+  actionapi: actionDetails,
+}
+
 function getTitle(status: number, raw: ErrorResponse, dictionary: Dictionary, language: Language) {
   if (dictionary[language][raw.code]) return dictionary[language][raw.code]
   if (raw.details && !ignoredDescriptions.includes(raw.details)) return raw.details
@@ -26,16 +33,22 @@ function getValues(detail: ValidationDetails) {
   return detail.values && every(detail.values, isString) ? `\n${detail.values.join('\n')}` : ''
 }
 
-function createMessage(status: number, raw: ErrorResponse, dictionary: Dictionary, language: Language) {
-  const title = getTitle(status, raw, dictionary, language)
-  if (!raw.validationDetails?.length) return title
+function createMessage(status: number, raw: ErrorResponse, dictionary: Dictionary, language?: Language): 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) return { description : title, ...dictionaryDetails }
+  
   const details = raw.validationDetails?.map((detail) => {
-    const dict: Record<string, string> = (fieldDictionary[api?.toLowerCase() as keyof typeof fieldDictionary] ?? {})[language] ?? {}
-    const name = dict[detail.code] || detail.field || (raw.code !== detail.code && dictionary[language][detail.code]) || detail.details || ''
+    const dict: Record<string, string> = (fieldDictionary[api?.toLowerCase() as keyof typeof fieldDictionary] ?? {})[language || 'en'] ?? {}
+    const name = dict[detail.code] || detail.field || 
+    (raw.code !== detail.code && dictionary[language || 'en'][detail.code]) || detail.details || ''
     return `${name}${getValues(detail)}`
   })?.filter(d => !!d)
-  return details ? `${title}\n${details?.join('\n')}` : title
+
+  return { description: details ? `${title}\n${details?.join('\n')}` : title, ...dictionaryDetails }
 }
 
 /**

package/src/error/StackspotAPIError.ts

@@ -1,6 +1,25 @@
 import { Language, getLanguage } from '@stack-spot/portal-translate'
 
-export type InternationalizedMessage = (language: Language) => string
+export type InternationalizedMessage = (language: Language) => 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 {
   /**
@@ -20,11 +39,17 @@ interface ErrorProperties {
    * 
    * If not provided, will attempt to use the error code or 'unknown'.
    */
-  message?: InternationalizedMessage | string,
+  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 {
@@ -43,12 +68,12 @@ export class StackspotAPIError extends Error {
   private intl?: InternationalizedMessage
 
   constructor({ status, code, headers, message, stack }: ErrorProperties) {
-    super(`Stackspot API error (network ${status}): ${typeof message === 'string' ? message : message?.('en') || message?.('pt') || code || 'unknown'}`)
+    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' ? () => message : message
+    this.intl = typeof message === 'string' || typeof message === 'object' ?  () => message : message
   }
 
   /**
@@ -56,8 +81,21 @@ export class StackspotAPIError extends Error {
    * @param language 
    * @returns an error message
    */
-  translate(language: Language = getLanguage()) {
+  translate(language: Language = getLanguage()): 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: Language = getLanguage()): ErrorDetailsProperties {
     const unknown = language === 'en' ? 'unknown error' : 'erro desconhecido'
-    return this.intl?.(language) ?? this.message ?? this.code ?? (this.status === 0 ? unknown : `${this.status}`)
+    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/dictionary/action-details.ts

@@ -0,0 +1,20 @@
+
+export const actionDetails: Record<string, Record<string, object>> = {
+  en: {
+    ACTIONAPI_5004_GITHUB_SAML_ERROR : 
+    {
+      title: 'SSO Authorization pending',
+      description: 'Authorize SSO on GitHub to continue',
+      linkLabel: 'Check documentation',
+      linkHref: 'https://docs.stackspot.com/en/home/account/guides/scm-integration/scm-github#integrate-github-with-stackspot',
+    },
+  },
+  pt: {
+    ACTIONAPI_5004_GITHUB_SAML_ERROR :{
+      title: 'Autorização SSO pendente',
+      description: 'Autorize o SSO no GitHub para continuar',
+      linkLabel: 'Ver Documentação',
+      linkHref: 'https://docs.stackspot.com/home/account/guides/scm-integration/scm-github#integrar-o-github-com-a-stackspot',
+    },
+  },
+} 

package/src/error/dictionary/workspace-details.ts

@@ -0,0 +1,15 @@
+
+export const workspaceDetails: Record<string, Record<string, object>> = {
+  en: {
+    WKS_API_WORKFLOW_UNAUTHORIZED: {
+      title: 'Invalid token',
+      description: 'Check your authorizations on GitHub and the token on StackSpot',
+    },
+  },
+  pt: {
+    WKS_API_WORKFLOW_UNAUTHORIZED: {
+      title: 'Token inválido',
+      description: 'Confira suas autorizações no Github e o token na StackSpot',
+    },
+  },
+}