@stack-spot/portal-network 0.1.0

package/src/api/workspaceSearchEngine.ts

@@ -0,0 +1,153 @@
+/**
+ * Search Engine API
+ * v1.0.0
+ * DO NOT MODIFY - This file has been generated using oazapfts.
+ * See https://www.npmjs.com/package/oazapfts
+ */
+import * as Oazapfts from "@oazapfts/runtime";
+import * as QS from "@oazapfts/runtime/query";
+export const defaults: Oazapfts.Defaults<Oazapfts.CustomHeaders> = {
+    headers: {},
+    baseUrl: "https://workspace-search-engine-api.dev.stackspot.com",
+};
+const oazapfts = Oazapfts.runtime(defaults);
+export const servers = {
+    generatedServerUrl: "https://workspace-search-engine-api.dev.stackspot.com"
+};
+export type ExtraDataResponse = {
+    key: string;
+    value: string;
+};
+export type SearchDataItemResponse = {
+    /** The resource identifier. */
+    identifier?: string;
+    /** The resource slug. */
+    identifierSlug?: string;
+    /** The resource description. */
+    description?: string;
+    /** The resource display name. */
+    name?: string;
+    /** The resource extra data correlated to itself (ie: the workspace ID of an application) */
+    extraData?: ExtraDataResponse[];
+};
+export type SearchDataResponse = {
+    /** The resource type category of the items */
+    category?: string;
+    /** The total result count for the searched text */
+    totalCount?: number;
+    /** List of the resources found */
+    items?: SearchDataItemResponse[];
+};
+export type Pagination = {
+    /** Total pages */
+    totalPages?: number;
+    /** Total pageable elements */
+    totalElements?: number;
+    /** Current page number starting from 0 */
+    pageNumber?: number;
+    /** Current page size. Fixed 50 items. */
+    pageSize?: number;
+    /** Has more results to return. */
+    hasNext?: boolean;
+};
+export type SearchResponse = {
+    content: SearchDataResponse[];
+    pagination?: Pagination;
+};
+export type ValidationDetails = {
+    code: string;
+    field?: string;
+    details?: string;
+    values?: string[];
+};
+export type ErrorResponse = {
+    code: string;
+    status: number;
+    details: string;
+    validationDetails?: ValidationDetails[];
+};
+export type HistoryItemResponse = {
+    id: string;
+    searchText: string;
+};
+export type SearchHistoryResponse = {
+    items: HistoryItemResponse[];
+};
+/**
+ * Search all Stackspot resources using semantic search.
+ */
+export function search({ q, category, page }: {
+    q: string;
+    category?: string;
+    page?: number;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: SearchResponse;
+    } | {
+        status: 400;
+        data: ErrorResponse;
+    } | {
+        status: 500;
+        data: ErrorResponse;
+    }>(`/v1/search${QS.query(QS.explode({
+        q,
+        category,
+        page
+    }))}`, {
+        ...opts
+    }));
+}
+/**
+ * Get the logged-in user search history list.
+ */
+export function getUserHistory(opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: SearchHistoryResponse;
+    } | {
+        status: 403;
+        data: ErrorResponse;
+    } | {
+        status: 500;
+        data: ErrorResponse;
+    }>("/v1/search/history", {
+        ...opts
+    }));
+}
+/**
+ * Clear the logged-in user search history.
+ */
+export function clearUserHistory(opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 204;
+    } | {
+        status: 403;
+        data: ErrorResponse;
+    } | {
+        status: 500;
+        data: ErrorResponse;
+    }>("/v1/search/history", {
+        ...opts,
+        method: "DELETE"
+    }));
+}
+/**
+ * Delete the logged-in user specific search history item.
+ */
+export function deleteUserHistoryItem({ itemId }: {
+    itemId: string;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 204;
+    } | {
+        status: 403;
+        data: ErrorResponse;
+    } | {
+        status: 500;
+        data: ErrorResponse;
+    }>(`/v1/search/history/${encodeURIComponent(itemId)}`, {
+        ...opts,
+        method: "DELETE"
+    }));
+}

package/src/apis.json

@@ -0,0 +1,129 @@
+{
+  "ai": {
+    "url": {
+      "dev": "https://code-buddy-api.dev.stackspot.com",
+      "stg": "https://code-buddy-api.stg.stackspot.com",
+      "prd": "https://genai-code-buddy-api.stackspot.com"
+    },
+    "docs": "/openapi.json"
+  },
+  "workspace": {
+    "url": {
+      "dev": "https://workspace-workspace-api.dev.stackspot.com",
+      "stg": "https://workspace-workspace-api.stg.stackspot.com",
+      "prd": "https://workspace.v1.stackspot.com"
+    },
+    "docs": "/v3/api-docs"
+  },
+  "account": {
+    "url": {
+      "dev": "https://account-account-api.dev.stackspot.com",
+      "stg": "https://account-account-api.stg.stackspot.com",
+      "prd": "https://account.v1.stackspot.com"
+    },
+    "docs": "/v3/api-docs"
+  },
+  "content": {
+    "url": {
+      "dev": "https://content-content-api.dev.stackspot.com",
+      "stg": "https://content-content-api.stg.stackspot.com",
+      "prd": "https://content-api.v1.stackspot.com"
+    },
+    "docs": "/v3/api-docs"
+  },
+  "serviceCatalog": {
+    "url": {
+      "dev": "https://catalog-tech-products-catalog-api.dev.stackspot.com",
+      "stg": "https://catalog-tech-products-catalog-api.stg.stackspot.com",
+      "prd": "https://catalog-api.v1.stackspot.com"
+    },
+    "docs": "/v3/api-docs"
+  },
+  "apiRuntime": {
+    "url": {
+      "dev": "https://runtime-manager.dev.stackspot.com",
+      "stg": "https://runtime-manager.stg.stackspot.com",
+      "prd": "https://runtime-engine.v1.stackspot.com"
+    },
+    "docs": "/v3/api-docs"
+  },
+  "cloudServices": {
+    "url": {
+      "dev": "https://cloud-services-cloud-services-api.dev.stackspot.com",
+      "stg": "https://cloud-services-cloud-services-api.stg.stackspot.com",
+      "prd": "https://cloud-services-api.stackspot.com"
+    },
+    "docs": "/v3/api-docs"
+  },
+  "cloudAccount": {
+    "url": {
+      "dev": "https://account-account-external-connections-api.dev.stackspot.com",
+      "stg": "https://account-account-external-connections-api.stg.stackspot.com",
+      "prd": "https://account-external-connections-api.stackspot.com"
+    },
+    "docs": "/v3/api-docs"
+  },
+  "dataPlatform": {
+    "url": {
+      "dev": "https://data-platform-metabase.dev.stackspot.com",
+      "stg": "https://data-platform-metabase.stg.stackspot.com",
+      "prd": "https://data-platform-stackspot-public.stackspot.com"
+    },
+    "docs": "/v3/api-docs"
+  },
+  "insights": {
+    "url": {
+      "dev": "https://insights-insights-api.dev.stackspot.com",
+      "stg": "https://insights-insights-api.stg.stackspot.com",
+      "prd": "https://insights-api.stackspot.com"
+    },
+    "docs": "/v3/api-docs"
+  },
+  "plugin": {
+    "url": {
+      "dev": "https://content-plugin-api.dev.stackspot.com",
+      "stg": "https://content-plugin-api.stg.stackspot.com",
+      "prd": "https://plugin-api.v1.stackspot.com"
+    },
+    "docs": "/openapi.json"
+  },
+  "workflows": {
+    "url": {
+      "dev": "https://workflow-workflow-api.dev.stackspot.com",
+      "stg": "https://workflow-workflow-api.stg.stackspot.com",
+      "prd": "https://workflow-api.v1.stackspot.com"
+    },
+    "docs": "/openapi.json"
+  },
+  "workspaceManager": {
+    "url": {
+      "dev": "https://workspace-workspace-manager.dev.stackspot.com",
+      "stg": "https://workspace-workspace-manager.stg.stackspot.com",
+      "prd": "https://workspace-manager.v1.stackspot.com"
+    },
+    "docs": "/v3/api-docs"
+  },
+  "workspaceSearchEngine": {
+    "url": {
+      "dev": "https://workspace-search-engine-api.dev.stackspot.com",
+      "stg": "https://workspace-search-engine-api.stg.stackspot.com",
+      "prd": "https://workspace-search-engine-api.stackspot.com"
+    },
+    "docs": "/v3/api-docs"
+  },
+  "permissionValidation": {
+    "url": {
+      "dev": "https://portal-portal-opa-server.dev.stackspot.com/v1/validate",
+      "stg": "https://portal-portal-opa-server.stg.stackspot.com/v1/validate",
+      "prd": "https://portal-opa-server.stackspot.com/v1/validate"
+    }
+  },
+  "apiManagement": {
+    "url": {
+      "dev": "https://api-management-apigw.dev.stackspot.com/api-management",
+      "stg": "https://api-management-apigw.stg.stackspot.com/api-management",
+      "prd": "https://api-management-apigw.stackspot.com/api-management"
+    },
+    "docs": "/v3/api-docs"
+  }
+}

package/src/client/account.ts

@@ -0,0 +1,52 @@
+import { HttpError } from '@oazapfts/runtime'
+import {
+  accountDataIsAvailable, create, createPartner,
+  defaults,
+  deletePartner, getFeatures, getPartnerAccount, getPartnersSharingAllowed,
+  getPersonalClientCredentials, updatePartnerAccountAdminData, updatePartnerAccountData, validateNewPartnerData,
+  validatePartnerAssociationLimit,
+} from '../api/account'
+import apis from '../apis.json'
+import { DefaultAPIError } from '../error/DefaultAPIError'
+import { accountDictionary } from '../error/dictionary/account'
+import { StackspotAPIError } from '../error/StackspotAPIError'
+import { ReactQueryNetworkClient } from '../network/ReactQueryNetworkClient'
+
+class AccountClient extends ReactQueryNetworkClient {
+  constructor() {
+    super(apis.account.url, defaults)
+  }
+
+  protected buildStackSpotError(error: HttpError): StackspotAPIError {
+    return new DefaultAPIError(error.data, error.status, accountDictionary, error.headers)
+  }
+
+  generatePersonalClientCredentials = this.mutation(getPersonalClientCredentials)
+  create = this.mutation(create)
+  isAvailable = this.query(accountDataIsAvailable)
+  featureFlags = this.query(getFeatures)
+  partners = this.query(getPartnersSharingAllowed)
+  partner = this.query(getPartnerAccount)
+  createPartner = this.mutation(createPartner)
+  updatePartner = this.mutation(updatePartnerAccountData)
+  updatePartnerAdmin = this.mutation(updatePartnerAccountAdminData)
+  deactivatePartner = this.mutation(deletePartner)
+  validateNewPartnerData = this.mutation(validateNewPartnerData)
+  validatePartnerAssociationLimit = this.query({
+    name: 'validatePartnerAssociationLimit',
+    request: async (signal) => {
+      try {
+        await validatePartnerAssociationLimit({ signal })
+        return { isValid: true, message: '' }
+      } catch (error) {
+        if (error instanceof HttpError) {
+          const stkError = this.buildStackSpotError(error)
+          if (stkError.status === 422 || stkError.code === 'BAD_USER_INPUT') return { isValid: false, message: stkError.translate() }
+        }
+        throw error
+      }
+    },
+  })
+}
+
+export const accountClient = new AccountClient()

package/src/error/CanceledError.ts

@@ -0,0 +1,7 @@
+import { StackspotAPIError } from './StackspotAPIError'
+
+export class CanceledError extends StackspotAPIError {
+  constructor() {
+    super({ status: 0, message: lang => lang === 'en' ? 'Canceled by the user' : 'Cancelado pelo usuário' })
+  }
+}

package/src/error/DefaultAPIError.ts

@@ -0,0 +1,51 @@
+import { Dictionary, Language } from '@stack-spot/portal-translate'
+import { every, isEmpty, isString } from 'lodash'
+import { ErrorResponse } from '../api/account'
+import { StackspotAPIError } from './StackspotAPIError'
+import { baseDictionary } from './dictionary/base'
+import { cntFields } from './dictionary/cnt-fields'
+import { workspaceFields } from './dictionary/workspace-fields'
+
+// 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,
+}
+
+function getTitle(raw: ErrorResponse, dictionary: Dictionary, language: Language) {
+  if (dictionary[language][raw.code]) return dictionary[language][raw.code]
+  if (!ignoredDescriptions.includes(raw.details)) return raw.details
+  return (baseDictionary as Dictionary)[language][raw.status] || baseDictionary[language].defaultTitle
+}
+
+function createMessage(raw: ErrorResponse, dictionary: Dictionary, language: Language) {
+  const title = getTitle(raw, dictionary, language)
+  if (isEmpty(raw.validationDetails)) return title
+  const api = raw.code?.split(/[-_]/)[0]
+  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]) || ''
+    return name ? `${name}${detail.values && every(detail.values, isString) ? `\n${detail.values.join('\n')}` : ''}` : undefined
+  })?.filter(d => !!d)
+  return `${title}\n${details?.join('\n')}`
+}
+
+export class DefaultAPIError extends StackspotAPIError {
+  data?: ErrorResponse
+  raw?: any
+
+  constructor(rawResponse: any, status: number, dictionary: Dictionary, headers?: Headers) {
+    super({
+      status: status,
+      code: rawResponse.code,
+      message: language => createMessage(rawResponse, dictionary, language),
+      headers,
+    })
+    this.raw = rawResponse
+    if (this.raw?.code !== undefined && this.raw?.status !== undefined && this.raw?.details !== undefined) this.data = rawResponse
+  }
+}

package/src/error/StackspotAPIError.ts

@@ -0,0 +1,31 @@
+import { Language, getLanguage } from '@stack-spot/portal-translate'
+
+type InternationalizedMessage = (language: Language) => string
+
+interface ErrorProperties {
+  status: number,
+  headers?: Headers,
+  code?: string,
+  message?: InternationalizedMessage | string,
+  stack?: string,
+}
+
+export class StackspotAPIError extends Error {
+  status: number
+  headers: Headers | undefined
+  code: string | undefined
+  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'}`)
+    this.status = status
+    this.code = code
+    this.headers = headers
+    this.stack = stack
+    this.intl = typeof message === 'string' ? () => message : message
+  }
+
+  translate(language: Language = getLanguage()) {
+    return this.intl?.(language) ?? this.message
+  }
+}

package/src/error/dictionary/account.ts

@@ -0,0 +1,56 @@
+import { Dictionary } from '@stack-spot/portal-translate'
+
+export const accountDictionary = {
+  en: {
+    ACC_BAD_REQUEST_ERROR: 'The provided data is invalid or inconsistent.',
+    ACC_ATTR_INVALID_EVALUATED_FROM_VALIDATIONS_LENGTH: 'The field {1} must have between {2} and {3} characters long.',
+    ACC_STUDIO_ALREADY_EXISTS_FOR_ACCOUNT: 'A Studio with this name already exists. Please choose a new name.',
+    ACC_UNABLE_DELETE_TEAM_CONSTRAINT_VIOLATION_ERROR: 'The Team cannot be deleted because it is linked to other resources in the account.',
+    ACC_CREDENTIAL_ALREADY_EXISTS_FOR_USER: 'Please configure the SCM to continue.',
+    ACC_CREDENTIAL_NOT_FOUND_ERROR: 'SCM Credentials not found.',
+    ACC_FIELDS_EXTERNALNAME_IS_INVALID: 'The internal identifier contains characters or words that are not allowed.',
+    ACC_MALFORMED_FIELDS_IN_PAYLOAD: 'Check the fields, some entries are invalid.',
+    ACC_TEAM_ALREADY_EXISTS_FOR_ACCOUNT_AND_EXTERNAL_NAME: 'This information has already been used to register a Team. Please use a different one.',
+    ACC_ACCOUNT_DATA_UNAVAILABLE_TO_REGISTER_ACCOUNT_FREEMIUM: 'This name is already in use. Please choose a new one.',
+    ACC_USER_NOT_FOUND_TO_REGISTER_ACCOUNT_FREEMIUM: 'User not found. Please log in with GitHub to register for a Personal acccount.',
+    ACC_ALREADY_EXISTS_ACCOUNT_FREEMIUM_TO_USER: 'You already have a Personal account. Please log in to use your StackSpot Account.',
+    ACC_USER_NOT_ALLOWED_TO_REGISTER_ACCOUNT_FREEMIUM: "Your current domain doesn't allow Personal account registration. Please try registering with a different domain.",
+    ACC_IMPORT_ACCOUNT_MEMBERS_ALREADY_EXISTS_FOR_ACCOUNT: 'An import is currently in progress. Please wait for it to complete or contact StackSpot support for more information.',
+    ACC_SERVICE_CREDENTIAL_PERMISSIONS_INCONSISTENT_TO_ASSOCIATION: 'The permissions provided are inconsistent with this Service Credential.',
+    ACC_SERVICE_CREDENTIAL_TEAMS_INCONSISTENT_TO_ASSOCIATION: 'Some teams are not authorized to use this Service Credential.',
+    ACC_SERVICE_CREDENTIAL_TEAMS_INCONSISTENT_TO_DISASSOCIATION: 'There is an inconsistency in disassociating the Team with this Service Credential.',
+    ACC_SERVICE_CREDENTIAL_ALREADY_EXISTS_FOR_ACCOUNT: 'A Service Credential with this name already exists.',
+    ACC_SERVICE_CREDENTIAL_NOT_FOUND: 'Credencial de Serviço não encontrada.',
+    ACC_ACCOUNT_CREATION_DATA_ERROR: 'This partner is already registered.',
+    ACC_PARTNER_ACCOUNT_ADMIN_UPDATE_NAME_ERROR: 'It is impossible to change only the name or surname of the partner Account Administrator.',
+    ACC_ACCOUNT_PARTNER_CANT_BE_INACTIVATED: 'This partner cannot be deactivated due to associated APIs or products.',
+    ACC_ACCOUNT_CREATION_PARTNER_ASSOCIATION_LIMIT: 'Your account has reached the limit of associations with partner accounts.',
+    ACC_INVALID_PASSWORD: "Invalid password. Please make sure it meets the requirements and hasn't been used before.",
+  },
+  pt: {
+    ACC_BAD_REQUEST_ERROR: 'Os dados informados estão inválidos ou inconsistentes.',
+    ACC_ATTR_INVALID_EVALUATED_FROM_VALIDATIONS_LENGTH: 'O campo {1} deve ter um tamanho entre {2} e {3}.',
+    ACC_STUDIO_ALREADY_EXISTS_FOR_ACCOUNT: 'Já existe um Estúdio com esse nome. Por favor, escolha outro.',
+    ACC_UNABLE_DELETE_TEAM_CONSTRAINT_VIOLATION_ERROR: 'Não é possível excluir a Equipe porque ela está vinculada a outros recursos da conta.',
+    ACC_CREDENTIAL_ALREADY_EXISTS_FOR_USER: 'Para continuar, configure o SCM.',
+    ACC_CREDENTIAL_NOT_FOUND_ERROR: 'Credenciais de SCM não encontradas.',
+    ACC_FIELDS_EXTERNALNAME_IS_INVALID: 'O identificador interno contém caracteres ou palavras não permitidos.',
+    ACC_MALFORMED_FIELDS_IN_PAYLOAD: 'Verifique os campos, alguns estão inválidos.',
+    ACC_TEAM_ALREADY_EXISTS_FOR_ACCOUNT_AND_EXTERNAL_NAME: 'Essas informações já foram usadas para registrar uma Equipe. Por favor, utilize outras informações.',
+    ACC_ACCOUNT_DATA_UNAVAILABLE_TO_REGISTER_ACCOUNT_FREEMIUM: 'Este nome já está em uso. Por favor, escolha um novo.',
+    ACC_USER_NOT_FOUND_TO_REGISTER_ACCOUNT_FREEMIUM: 'User não encontrado. Faça login com Github para registrar uma conta Personal.',
+    ACC_ALREADY_EXISTS_ACCOUNT_FREEMIUM_TO_USER: 'Você já tem uma Conta Personal. Faça login para usar a sua conta StackSpot.',
+    ACC_USER_NOT_ALLOWED_TO_REGISTER_ACCOUNT_FREEMIUM: 'Seu domínio atual não permite o registro de uma Conta Personal. Por favor, use um domínio diferente.',
+    ACC_IMPORT_ACCOUNT_MEMBERS_ALREADY_EXISTS_FOR_ACCOUNT: 'Existe uma importação em andamento. Aguarde a conclusão ou contate o suporte da StackSpot para mais informações.',
+    ACC_SERVICE_CREDENTIAL_PERMISSIONS_INCONSISTENT_TO_ASSOCIATION: 'As permissões fornecidas são inconsistentes para essa Credencial de Serviço.',
+    ACC_SERVICE_CREDENTIAL_TEAMS_INCONSISTENT_TO_ASSOCIATION: 'Algumas Equipes não estão alinhadas para associar a essa Credencial de Serviço.',
+    ACC_SERVICE_CREDENTIAL_TEAMS_INCONSISTENT_TO_DISASSOCIATION: 'Há uma inconsistência na desassociação da Equipe com essa Credencial de Serviço.',
+    ACC_SERVICE_CREDENTIAL_ALREADY_EXISTS_FOR_ACCOUNT: 'Já existe uma Credencial de Serviço com esse nome.',
+    ACC_SERVICE_CREDENTIAL_NOT_FOUND: 'Service Credential not found.',
+    ACC_ACCOUNT_CREATION_DATA_ERROR: 'Esse Parceiro já está registrado.',
+    ACC_PARTNER_ACCOUNT_ADMIN_UPDATE_NAME_ERROR: 'Não é possível alterar apenas o nome ou sobrenome da pessoa que administra a Conta Parceiro.',
+    ACC_ACCOUNT_PARTNER_CANT_BE_INACTIVATED: 'Este Parceiro não pode ser inativado devido a APIs ou produtos associados.',
+    ACC_ACCOUNT_CREATION_PARTNER_ASSOCIATION_LIMIT: 'Sua conta atingiu o limite de associações com Contas de Parceiros.',
+    ACC_INVALID_PASSWORD: 'Senha inválida. Verifique se ela atende aos requisitos e não foi usada anteriormente.',
+  },
+} satisfies Dictionary