@stack-spot/portal-network 0.161.0 → 0.162.0

package/src/client/code-shift.ts

@@ -3,15 +3,12 @@ import { HttpError } from '@oazapfts/runtime'
 import {
   checkRoleRouteV1RolesRoleGet,
   createAccountSettingsV1SettingsPut,
-  createApplicationsBatchServiceV1ApplicationsBatchPost,
-  createApplicationServiceV1ApplicationsPost,
   createIntegrationServiceV1IntegrationsPost,
   createModuleServiceV1ModulesPost,
   createProgramGroupServiceV1ProgramGroupsPost,
   createReposBatchServiceV1ReposBatchPost,
   createRepositoryServiceV1ReposPost,
   defaults,
-  deleteApplicationServiceV1ApplicationsApplicationIdDelete,
   deleteIntegrationServiceV1IntegrationsIntegrationIdDelete,
   deleteProgramGroupServiceV1ProgramGroupsProgramGroupIdDelete,
   deleteRepositoryServiceV1ReposRepositoryIdDelete,
@@ -19,14 +16,13 @@ import {
   downloadReportV1ReportsReportIdDownloadGet,
   downloadSearchReposScmServiceV1ReposSearchScmSearchRepoIdDownloadGet,
   getAccountSettingsV1SettingsGet,
-  getApplicationByIdServiceV1ApplicationsApplicationIdGet,
   getIntegrationByIdServiceV1IntegrationsIntegrationIdGet,
   getProgramGroupByIdServiceV1ProgramGroupsProgramGroupIdGet,
+  getReportPullRequestContentV1ReportsReportIdPullRequestGet,
   getReportV1ReportsReportIdGet,
   getRepositoryByIdServiceV1ReposRepositoryIdGet,
   getStatusSearchReposScmServiceV1ReposSearchScmSearchRepoIdStatusGet,
-  listApplicationReportV1ApplicationsApplicationIdReportsGet,
-  listApplicationServiceV1ApplicationsGet,
+  listBranchesServiceV1ReposBranchesGet,
   listIntegrationServiceV1IntegrationsGet,
   listModulesServiceV1ModulesGet,
   listProgramGroupReportServiceV1ProgramGroupsProgramGroupIdReportsGet,
@@ -35,10 +31,11 @@ import {
   listRepositoryServiceV1ReposGet,
   listTagsServiceV1TagsGet,
   searchReposScmServiceV1ReposSearchScmGet,
-  updateApplicationServiceV1ApplicationsApplicationIdPut,
   updateIntegrationServiceV1IntegrationsIntegrationIdPut,
+  updateProgramGroupComponentsServiceV1ProgramGroupsProgramGroupIdComponentsPut,
   updateProgramGroupServiceV1ProgramGroupsProgramGroupIdPut,
   updateRepositoryServiceV1ReposRepositoryIdPut,
+  validateScmUrlServiceV1ReposValidateScmUrlPost,
 } from '../api/codeShift'
 import { DefaultAPIError } from '../error/DefaultAPIError'
 import { codeShiftDictionary } from '../error/dictionary/code-shift'
@@ -56,36 +53,6 @@ class CodeShift extends ReactQueryNetworkClient {
     return new DefaultAPIError(error.data, error.status, codeShiftDictionary, error.headers)
   }
 
-  /**
-   * @deprecated use createRepository instead
-   * Creates a code shift application.
-   */
-  createApplication = this.mutation(removeAuthorizationParam(createApplicationServiceV1ApplicationsPost))
-  /**
-   * @deprecated use createRepositoriesBatch instead
-   * Creates a code shift application in batch.
-   */
-  createApplicationBatch = this.mutation(removeAuthorizationParam(createApplicationsBatchServiceV1ApplicationsBatchPost))
-  /**
-   * @deprecated use repositories instead
-   * Gets code shift applications.
-   */
-  applications = this.query(removeAuthorizationParam(listApplicationServiceV1ApplicationsGet))
-  /**
-   * @deprecated use repository instead
-   * Gets code shift application
-   */
-  application = this.query(removeAuthorizationParam(getApplicationByIdServiceV1ApplicationsApplicationIdGet))
-  /**
-   * @deprecated use updateRepository instead
-   * Updates a code shift application
-   */
-  updateApplication = this.mutation(removeAuthorizationParam(updateApplicationServiceV1ApplicationsApplicationIdPut))
-  /**
-   * @deprecated use deleteRepository instead
-   * Deletes a code shift application.
-   */
-  deleteImportedApp = this.mutation(removeAuthorizationParam(deleteApplicationServiceV1ApplicationsApplicationIdDelete))
   /**
    * Creates a repository.
    */
@@ -110,6 +77,10 @@ class CodeShift extends ReactQueryNetworkClient {
    * Updates a repository
    */
   updateRepository = this.mutation(removeAuthorizationParam(updateRepositoryServiceV1ReposRepositoryIdPut))
+  /**
+   * Get a report for a pull request by id.
+   */
+  getReportPullRequestContent = this.query(removeAuthorizationParam(getReportPullRequestContentV1ReportsReportIdPullRequestGet))
   /**
    * Gets modules.
    */
@@ -122,11 +93,6 @@ class CodeShift extends ReactQueryNetworkClient {
    * Generates a report.
    */
   generateReport = this.mutation(removeAuthorizationParam(dispatchModuleServiceV1ModulesDispatchesPost))
-  /**
-   * @deprecated use repositoryReports instead
-   * Gets reports.
-   */
-  reports = this.query(removeAuthorizationParam(listApplicationReportV1ApplicationsApplicationIdReportsGet))
   /**
    * Gets repository reports.
    */
@@ -164,67 +130,68 @@ class CodeShift extends ReactQueryNetworkClient {
    * We do not use opa in this api, so this is the fn needed to check permissions.
    */
   validateRolePermissions = this.query(removeAuthorizationParam(checkRoleRouteV1RolesRoleGet))
-
   /**
    * Creates an integration
    */
   createIntegration = this.mutation(removeAuthorizationParam(createIntegrationServiceV1IntegrationsPost))
-
   /**
    * Lists integrations
    */
   listIntegration = this.query(removeAuthorizationParam(listIntegrationServiceV1IntegrationsGet))
-
   /**
    * Gets an integration by id
    */
   getIntegrationById = this.query(removeAuthorizationParam(getIntegrationByIdServiceV1IntegrationsIntegrationIdGet))
-
   /**
    * Updates an integration
    */
   updateIntegration = this.mutation(removeAuthorizationParam(updateIntegrationServiceV1IntegrationsIntegrationIdPut))
-
   /**
    * Deletes an integration
    */
   deleteIntegration = this.mutation(removeAuthorizationParam(deleteIntegrationServiceV1IntegrationsIntegrationIdDelete))
-
   /**
    * Creates a program group.
    */
   createProgramGroup = this.mutation(removeAuthorizationParam(createProgramGroupServiceV1ProgramGroupsPost))
-
   /**
    * Gets list of program groups.
    */
   listProgramGroups = this.query(removeAuthorizationParam(listProgramGroupServiceV1ProgramGroupsGet))
-
   /**
    * Gets a program group by id.
    */
   getProgramGroupById = this.query(removeAuthorizationParam(getProgramGroupByIdServiceV1ProgramGroupsProgramGroupIdGet))
-
   /**
- * List Program Group Report Service
- */
+   * List Program Group Report Service
+   */
   listProgramGroupReport = this.query(removeAuthorizationParam(listProgramGroupReportServiceV1ProgramGroupsProgramGroupIdReportsGet))
-
   /**
    * Updates a program group.
    */
   updateProgramGroup = this.mutation(removeAuthorizationParam(updateProgramGroupServiceV1ProgramGroupsProgramGroupIdPut))
-
+  /**
+   * Updates a program group components.
+   */
+  updateProgramGroupComponents = this.mutation(
+    removeAuthorizationParam(updateProgramGroupComponentsServiceV1ProgramGroupsProgramGroupIdComponentsPut),
+  )
   /**
    * Deletes a program group.
    */
   deleteProgramGroup = this.mutation(removeAuthorizationParam(deleteProgramGroupServiceV1ProgramGroupsProgramGroupIdDelete))
-
   /**
    * Gets list of tags.
    */
   tags = this.query(removeAuthorizationParam(listTagsServiceV1TagsGet))
-
+  /**
+   * Validates a SCM URL.
+   */
+  validateSCMUrl = this.mutation(removeAuthorizationParam(validateScmUrlServiceV1ReposValidateScmUrlPost))
+  /**
+   * Get Branches for a Repository
+   */
+  getBranches = this.query(removeAuthorizationParam(listBranchesServiceV1ReposBranchesGet))
 }
 
 export const codeShiftClient = new CodeShift()

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,
+};