@stack-spot/portal-network 0.158.0 → 0.159.0-beta.2

package/src/api/notification.ts

@@ -332,3 +332,5 @@ export function delete1({ notificationIntentId }: {
         method: "DELETE"
     }));
 }
+
+

package/src/api-addresses.ts

@@ -7,14 +7,26 @@ type ApiConfig = {
   docs?: string,
 }
 
+type PartialApiConfig = {
+  url: Partial<Record<Env, string>>,
+  docs?: string
+}
+
 interface Apis {
   [api: string]: ApiConfig,
 }
 
+interface PartialApis {
+  [api: string]: PartialApiConfig
+}
+
 type ApiAddress = {
   [api: string]: string,
 }
 
+let defaultApis: Apis = apisJson;
+let overrideApis: PartialApis = {};
+
 function transformApisToApiAddress(apis: Apis, env: Env): ApiAddress {
   const apiAddress: ApiAddress = {}
 
@@ -25,6 +37,65 @@ function transformApisToApiAddress(apis: Apis, env: Env): ApiAddress {
   return apiAddress
 }
 
+/**
+ * Searchs the default APIs configuration for the API object that matches the given baseURL.
+ * @param baseUrl the base URL to search.
+ * @param candidate the URL of the desired API to find.
+ * @returns {boolean} true if the URL is found, otherwise false.
+ */
+function matchesBaseUrl(baseUrl: Record<Env, string>, candidate: Record<Env, string>): boolean {
+  const envs: Env[] = ['dev', 'stg', 'prd'];
+
+  return envs.every(e => {
+    if (candidate[e]) {
+      return baseUrl[e] === candidate[e];
+    }
+    return true;
+  });
+}
+
+/**
+ * Checks if there is override for the given base URL and target environment.
+ * @param baseURL the default API base URL to check for overrides.
+ * @param targetEnv the target environment
+ * @returns {string} the overriden base URL if found, otherwise the original API baseURL.
+ */
+export const getBaseUrlWithOverride = (baseUrl: Record<Env, string>, targetEnv: Env = 'prd'): string => {
+  let matchesApiName: string | null = null;
+
+  for (const [apiName, config] of Object.entries(defaultApis)) {
+    if (matchesBaseUrl(baseUrl, config.url)) {
+      matchesApiName = apiName;
+      break;
+    }
+  }
+
+  if (matchesApiName) {
+    const overrideUrl = overrideApis[matchesApiName]?.url?.[targetEnv];
+
+    if (overrideUrl) {
+      return overrideUrl;
+    }
+  }
+  return baseUrl[targetEnv];
+}
+
+/**
+ * Sets the APIs addresses for override.
+ * @param customApis a JSON object containing APIs address to override.
+ */
+export const setApisOverride = (customApis: PartialApis) => {
+  overrideApis = customApis;
+}
+
+/**
+ * Sets the default APIs addresses for each environments.
+ * @returns {Apis} an object containing APIs URLs grouped by api name and enviroments.
+ */
+export const getApiAddresses = (): Apis => {
+  return defaultApis;
+}
+
 export const apiAddresses = () => {
   const env = NetworkClient.getEnv()
   return transformApisToApiAddress(apisJson, env)

package/src/client/account.ts

@@ -8,7 +8,12 @@ import {
   bindGroupMembers,
   bindRoleGroups,
   bindRoles,
-  bindToGroups, bindToRoles, create, create1, createAccountRole, createExtension, createExtensionLink, createExtensionVersion, createGroupMapping,
+  bindToGroups, 
+  bindToRoles, 
+  create, 
+  create1, 
+  createAccountRole, createExtension, createExtensionLink, 
+  createExtensionVersion, createFidoMagicLink, createGroupMapping,
   createPartner,
   createPersonalAccessToken,
   createSecret,
@@ -130,16 +135,16 @@ import {
   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'
 import { CreateSCMRequest, SCMStatus, UpdateSCMRequest } from './types'
+import { getApiAddresses } from '../api-addresses'
 
 class AccountClient extends ReactQueryNetworkClient {
   constructor() {
-    super(apis.account.url, defaults)
+    super(getApiAddresses().account.url, defaults)
   }
 
   protected buildStackSpotError(error: HttpError): StackspotAPIError {
@@ -872,6 +877,10 @@ class AccountClient extends ReactQueryNetworkClient {
    * Updates the sales representatives
    */
   updateSalesRepresentatives = this.mutation(updateSalesRepresentatives)
+  /**
+   * Create FIDO magic link
+   */
+  createFidoMagicLink = this.mutation(createFidoMagicLink)
 }
 
 export const accountClient = new AccountClient()

package/src/client/agent-tools.ts

@@ -1,16 +1,18 @@
 import { HttpError } from '@oazapfts/runtime'
-import { createToolkitToolsV1ToolkitsToolkitIdToolsPost, createToolkitV1ToolkitsPost, defaults, deleteToolkitToolsV1ToolkitsToolkitIdToolsDelete, deleteToolkitV1ToolkitsToolkitIdDelete, editToolkitToolV1ToolkitsToolkitIdToolsToolIdPut, forkToolkitV1ToolkitsToolkitIdForkPost, getPublicToolKitsV1BuiltinToolkitGet, getToolkitToolV1ToolkitsToolkitIdToolsToolIdGet, getToolkitV1ToolkitsToolkitIdGet, HttpValidationError, listAgentsUsingToolsV1ToolkitsToolkitIdToolsAgentsPost, listToolkitsV1ToolkitsGet, updateToolkitV1ToolkitsToolkitIdPatch } from '../api/agent-tools'
-import apis from '../apis.json'
+import { getApiAddresses } from '../api-addresses'
+import { addFavoriteV1AgentsAgentIdFavoritePost, AgentVisibilityLevelEnum, createAgentV1AgentsPost, createToolkitToolsV1ToolkitsToolkitIdToolsPost, createToolkitV1ToolkitsPost, defaults, deleteAgentV1AgentsAgentIdDelete, deleteToolkitToolsV1ToolkitsToolkitIdToolsDelete, deleteToolkitV1ToolkitsToolkitIdDelete, editToolkitToolV1ToolkitsToolkitIdToolsToolIdPut, forkToolkitV1ToolkitsToolkitIdForkPost, getAgentV1AgentsAgentIdGet, getPublicToolKitsV1BuiltinToolkitGet, getToolkitToolV1ToolkitsToolkitIdToolsToolIdGet, getToolkitV1ToolkitsToolkitIdGet, HttpValidationError, listAgentsUsingToolsV1ToolkitsToolkitIdToolsAgentsPost, listAgentsV1AgentsGet, listToolkitsV1ToolkitsGet, publishAgentV1AgentsAgentIdPublishPost, searchAgentsV1AgentsSearchPost, updateAgentV1AgentsAgentIdPut, updateToolkitV1ToolkitsToolkitIdPatch, VisibilityLevelEnum } from '../api/agent-tools'
 import { StackspotAPIError } from '../error/StackspotAPIError'
 import { ReactQueryNetworkClient } from '../network/ReactQueryNetworkClient'
 import { FetchEventStream } from '../network/types'
 import { removeAuthorizationParam } from '../utils/remove-authorization-param'
 import { StreamedArray } from '../utils/StreamedArray'
-import { AgentToolsOpenAPIPreview } from './types'
+import { AgentResponseWithBuiltIn, AgentToolsOpenAPIPreview, AgentVisibilityLevel } from './types'
+import { workspaceAiClient } from './workspace-ai'
+const AGENT_DEFAULT_SLUG = 'stk_code_buddy'
 
 class AgentToolsClient extends ReactQueryNetworkClient {
   constructor() {
-    super(apis['agent-tools'].url, defaults)
+    super(getApiAddresses()['agent-tools'].url, defaults)
   }
 
   protected buildStackSpotError(error: HttpError): StackspotAPIError {
@@ -26,8 +28,104 @@ class AgentToolsClient extends ReactQueryNetworkClient {
   tools = this.query(removeAuthorizationParam(getPublicToolKitsV1BuiltinToolkitGet))
 
   /**
-   * Get list of Toolkits
+   * Create agent
    */
+  createAgent = this.mutation(removeAuthorizationParam(createAgentV1AgentsPost))
+
+  /**
+   * Delete agent
+   */
+  deleteAgent = this.mutation(deleteAgentV1AgentsAgentIdDelete)
+
+  /**
+   * Updates an agent
+   */
+  updateAgent = this.mutation(updateAgentV1AgentsAgentIdPut)
+
+  /**
+  * Favorite an agent
+  */
+  favoriteAgent = this.mutation(addFavoriteV1AgentsAgentIdFavoritePost)
+
+  /**
+  * Publish an agent
+  */
+  publishAgent = this.mutation(publishAgentV1AgentsAgentIdPublishPost)
+
+  /** 
+   * List agents
+   */
+  agents = this.infiniteQuery(removeAuthorizationParam(listAgentsV1AgentsGet))
+
+  /** 
+   * Gets agent by id
+   */
+  agent = this.query(removeAuthorizationParam(getAgentV1AgentsAgentIdGet))
+
+  /** 
+   * Gets agents by ids
+   */
+  agentsByIds = this.query(removeAuthorizationParam(searchAgentsV1AgentsSearchPost))
+
+  /** 
+   * Gets the default agent slug
+   */
+  agentDefaultSlug = AGENT_DEFAULT_SLUG
+
+  /** 
+   * Gets the default agent
+   */
+  agentDefault = this.query({
+    name: 'agentDefault',
+    request: async (signal) => {
+      const agentDefault = await listAgentsV1AgentsGet(
+        { visibility: 'built_in', slug: this.agentDefaultSlug, authorization: '' }, { signal },
+      )
+
+      const agentId = agentDefault.at(0)?.id
+      const agent = agentId ? await this.agent.query({ agentId }) : undefined
+      return agent
+    },
+  })
+
+  /** 
+   * List agents filtered by visibility.
+   */
+  allAgents = this.query({
+    name: 'allAgents',
+    request: async (signal, variables: { visibilities: (AgentVisibilityLevel | 'all')[] }) => {
+      const allVisibilities = ['account', 'built_in', 'favorite', 'personal', 'shared', 'workspace'] as const
+      const visibilities = variables.visibilities.includes('all')
+        ? allVisibilities
+        : variables.visibilities as Array<AgentVisibilityLevelEnum | VisibilityLevelEnum>
+
+      const shouldFetchWorkspaceAgents = visibilities.includes('workspace')
+
+      const workspaceAgentsPromise = shouldFetchWorkspaceAgents
+        ? workspaceAiClient.workspacesContentsByType.query({ contentType: 'agent' })
+        : Promise.resolve([])
+
+      const [workspaceAgents, ...agentsByVisibility] = await Promise.all([
+        workspaceAgentsPromise,
+        ...visibilities.map((visibility) => listAgentsV1AgentsGet({ visibility, authorization: '' }, { signal })),
+      ])
+
+      const workspaceAgentsWithSpaceName = workspaceAgents.flatMap(({ agents, space_name }) =>
+        agents?.map((agent) => ({ ...agent, spaceName: space_name, builtIn: false }))) as AgentResponseWithBuiltIn[]
+
+      const allAgents: AgentResponseWithBuiltIn[] = workspaceAgentsWithSpaceName ?? []
+
+      agentsByVisibility.forEach(agents => allAgents.push(...agents.map(agent => ({
+        ...agent,
+        builtIn: agent?.visibility_level === 'built_in',
+      }))))
+
+      return allAgents
+    },
+  })
+
+  /* Get list of Toolkits
+  */
   toolkits = this.query(removeAuthorizationParam(listToolkitsV1ToolkitsGet))
   /**
    * Get a toolkit by Id

package/src/client/agent.ts

@@ -1,14 +1,11 @@
 import { HttpError } from '@oazapfts/runtime'
+import { getApiAddresses } from '../api-addresses'
 import {
   defaults, deleteV1AgentByAgentIdFavorite, getV1AgentByAgentId, getV1Agents, getV1PublicAgentByAgentId, getV1PublicAgents,
   postV1AgentByAgentIdFavorite, putV1AgentByAgentId,
-  VisibilityLevel,
 } from '../api/agent'
-import apis from '../apis.json'
 import { StackspotAPIError } from '../error/StackspotAPIError'
 import { ReactQueryNetworkClient } from '../network/ReactQueryNetworkClient'
-import { AgentResponseWithBuiltIn, AgentVisibilityLevel } from './types'
-import { workspaceAiClient } from './workspace-ai'
 
 export const isAgentDefault = (agentSlug?: string) => agentSlug === 'stk_code_buddy'
 
@@ -20,7 +17,7 @@ interface AgentError {
 
 class AgentClient extends ReactQueryNetworkClient {
   constructor() {
-    super(apis.agent.url, defaults)
+    super(getApiAddresses().agent.url, defaults)
   }
 
   protected buildStackSpotError(error: HttpError): StackspotAPIError {
@@ -36,57 +33,6 @@ class AgentClient extends ReactQueryNetworkClient {
     })
   }
 
-  /** 
-   * List agents filtered by visibility.
-   */
-  allAgents = this.query({
-    name: 'allAgents',
-    request: async (signal, variables: { visibilities: AgentVisibilityLevel[] }) => {
-      const visibilities: VisibilityLevel[] = variables.visibilities.includes('ALL')
-        ? ['PERSONAL', 'SHARED', 'WORKSPACE', 'ACCOUNT', 'FAVORITE']
-        : variables.visibilities.filter((visibility) => visibility !== 'BUILT-IN' && visibility !== 'ALL') as VisibilityLevel[]
-
-      const shouldIncludeBuiltInAgent = variables.visibilities.includes('ALL') || variables.visibilities.includes('BUILT-IN')
-      const shouldFetchBuiltInAgent = shouldIncludeBuiltInAgent || variables.visibilities.includes('FAVORITE')
-      const shouldFetchWorkspaceAgents = variables.visibilities.includes('ALL') || variables.visibilities.includes('WORKSPACE')
-
-      const publicAgentsPromise = shouldFetchBuiltInAgent ? getV1PublicAgents({}, { signal }) : Promise.resolve([])
-      const workspaceAgentsPromise = shouldFetchWorkspaceAgents
-        ? workspaceAiClient.workspacesContentsByType.query({ contentType: 'agent' })
-        : Promise.resolve([])
-
-      const [publicAgents, workspaceAgents, ...agentsByVisibility] = await Promise.all([
-        publicAgentsPromise,
-        workspaceAgentsPromise,
-        ...visibilities.map((visibility) => getV1Agents({ visibility }, { signal })),
-      ])
-
-      const workspaceAgentsWithSpaceName = workspaceAgents?.flatMap(({ agents, space_name }) =>
-        agents?.map((agent) => ({
-          ...agent,
-          spaceName: space_name,
-          builtIn: publicAgents?.some(publicAgent => publicAgent.id === agent.id),
-        }))) as AgentResponseWithBuiltIn[]
-
-      const allAgents: AgentResponseWithBuiltIn[] = workspaceAgentsWithSpaceName || []
-
-      if (shouldIncludeBuiltInAgent) {
-        const builtInsAgents = publicAgents?.map((agent) => ({ ...agent, builtIn: true, visibility_level: 'BUILT-IN' }))
-        // @ts-ignore fixme: above, BUILT-IN is not a valid value for the enum VisibilityLevel.
-        allAgents.push(...builtInsAgents)
-      }
-
-      agentsByVisibility.forEach(agents => {
-        allAgents.push(...agents.map(agent => ({
-          ...agent,
-          builtIn: publicAgents?.some(publicAgent => publicAgent.id === agent.id),
-        })))
-      })
-
-      return allAgents
-    },
-  })
-
   /** 
    * Gets an agent by id
    */
@@ -97,18 +43,6 @@ class AgentClient extends ReactQueryNetworkClient {
       : getV1AgentByAgentId({ ...variables }, { signal }),
   })
 
-  /** 
-   * Gets the default agent
-   */
-  agentDefault = this.query({
-    name: 'agentDefault',
-    request: async (signal) => {
-      const publicAgents = await getV1PublicAgents({}, { signal })
-      const agentDefault = publicAgents.find((agent) => isAgentDefault(agent.slug))
-      return agentDefault ? { ...agentDefault, builtIn: true } : undefined
-    },
-  })
-
   /** 
    * List commons agents
    */

package/src/client/ai.ts

@@ -34,11 +34,11 @@ import {
   quickCommandsRunV2V2QuickCommandsSlugStepsStepSlugRunPost,
   resetKnowledgeObjectsV1KnowledgeSourcesSlugObjectsDelete,
   runFetchStepV1QuickCommandsSlugStepsStepSlugFetchRunPost,
+  searchKnowledgeSourcesV1KnowledgeSourcesSearchPost,
   updateQuickCommandV1QuickCommandsSlugPatch,
   updateTitleV1ConversationsConversationIdPatch,
   vectorizeCustomKnowledgeSourceV1KnowledgeSourcesSlugCustomPost,
 } from '../api/ai'
-import apis from '../apis.json'
 import { StackspotAPIError } from '../error/StackspotAPIError'
 import { ReactQueryNetworkClient } from '../network/ReactQueryNetworkClient'
 import { removeAuthorizationParam } from '../utils/remove-authorization-param'
@@ -55,10 +55,11 @@ import {
   ReplaceResult,
   StepChatStep,
 } from './types'
+import { getApiAddresses } from '../api-addresses'
 
 class AIClient extends ReactQueryNetworkClient {
   constructor() {
-    super(apis.ai.url, defaults)
+    super(getApiAddresses().ai.url, defaults)
   }
 
   protected buildStackSpotError(error: HttpError): StackspotAPIError {
@@ -135,6 +136,10 @@ class AIClient extends ReactQueryNetworkClient {
    * Gets a knowledge source document by the slug of the parent knowledge source and the document id.
    */
   knowledgeSourceDocument = this.query(removeAuthorizationParam(findKnowledgeObjectByCustomIdV1KnowledgeSourcesSlugObjectsCustomIdGet))
+  /**
+   * Lists knowledge sources matching the provided IDs.
+   */
+  searchKnowledgeSources = this.query(removeAuthorizationParam(searchKnowledgeSourcesV1KnowledgeSourcesSearchPost))
   /**
    * Gets the chat history. This is a paginated resource.
    */
@@ -376,3 +381,4 @@ class AIClient extends ReactQueryNetworkClient {
 }
 
 export const aiClient = new AIClient()
+

package/src/client/api-management.ts

@@ -1,14 +1,14 @@
 import { HttpError } from '@oazapfts/runtime'
 import { defaults, getEntries, getEntryById, getSubEntries } from '../api/apiManagement'
-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 { getApiAddresses } from '../api-addresses'
 
 class ApiManagementClient extends ReactQueryNetworkClient {
   constructor() {
-    super(apis.apiManagement.url, defaults)
+    super(getApiAddresses().apiManagement.url, defaults)
   } 
 
   protected buildStackSpotError(error: HttpError): StackspotAPIError {

package/src/client/cloud-account.ts

@@ -1,17 +1,17 @@
 import { HttpError } from '@oazapfts/runtime'
 import { createCloudAccount, defaults, deleteCloudAccountFromEnvironment, deleteManagedAccountsFromWorkspace, getCloudAccountByWorkspace, getManagedCloudRegion, getManagedCloudTemplate, getProvisionWorkflowInWorkspace, listCloudAccounts, provisionManagedAccountsForWorkspace } from '../api/cloudAccount'
-import apis from '../apis.json'
 import { DefaultAPIError } from '../error/DefaultAPIError'
 import { StackspotAPIError } from '../error/StackspotAPIError'
 import { ReactQueryNetworkClient } from '../network/ReactQueryNetworkClient'
 import { removeAuthorizationParam } from '../utils/remove-authorization-param'
 import { FixedConnectAccountRequestV2, FixedManagedAccountProvisionRequest, FixVariables } from './types'
+import { getApiAddresses } from '../api-addresses'
 
 const listAccounts = removeAuthorizationParam(listCloudAccounts)
 
 class CloudAccountClient extends ReactQueryNetworkClient {
   constructor() {
-    super(apis.cloudAccount.url, defaults)
+    super(getApiAddresses().cloudAccount.url, defaults)
   } 
 
   protected buildStackSpotError(error: HttpError): StackspotAPIError {

package/src/client/cloud-platform-horizon.ts

@@ -1,16 +1,16 @@
 import { HttpError } from '@oazapfts/runtime'
 
-import apis from '../apis.json'
 import { DefaultAPIError } from '../error/DefaultAPIError'
 import { StackspotAPIError } from '../error/StackspotAPIError'
 import { ReactQueryNetworkClient } from '../network/ReactQueryNetworkClient'
 import { removeAuthorizationParam } from '../utils/remove-authorization-param'
 import { createAddon, createDeployTemplate, createOrganization, createRuntime1, createTenant1, defaults, deploy, findApplicationDeploymentById, getApplicationDeploymentHealth, getApplicationDeploymentLogs, getOrganizationById, getOrganizations, getRuntime1, getTenant1, listAddon, listApplicationDeployments, listDeployTemplate, listRuntimes, listRuntimes1, listTenants, listTenants1 } from '../api/cloudPlatformHorizon'
 import { baseDictionary } from '../error/dictionary/base'
+import { getApiAddresses } from '../api-addresses'
 
 class CloudPlatformHorizonClient extends ReactQueryNetworkClient {
   constructor() {
-    super(apis.cloudPlatformHorizon.url, defaults)
+    super(getApiAddresses().cloudPlatformHorizon.url, defaults)
   }
 
   protected buildStackSpotError(error: HttpError): StackspotAPIError {

package/src/client/cloud-platform.ts

@@ -31,16 +31,16 @@ import
   listVpns,
   providers,
 } from '../api/cloudPlatform'
-import apis from '../apis.json'
 import { DefaultAPIError } from '../error/DefaultAPIError'
 import { StackspotAPIError } from '../error/StackspotAPIError'
 import { ReactQueryNetworkClient } from '../network/ReactQueryNetworkClient'
 import { removeAuthorizationParam } from '../utils/remove-authorization-param'
 import { scfDictionary } from '../error/dictionary/cloud-platform'
+import { getApiAddresses } from '../api-addresses'
 
 class CloudPlatformClient extends ReactQueryNetworkClient {
   constructor() {
-    super(apis.cloudPlatform.url, defaults)
+    super(getApiAddresses().cloudPlatform.url, defaults)
   }
 
   protected buildStackSpotError(error: HttpError): StackspotAPIError {

package/src/client/cloud-runtimes.ts

@@ -24,16 +24,16 @@ import
   startApplication,
   stopApplication,
 } from '../api/cloudRuntimes'
-import apis from '../apis.json'
 import { DefaultAPIError } from '../error/DefaultAPIError'
 import { StackspotAPIError } from '../error/StackspotAPIError'
 import { ReactQueryNetworkClient } from '../network/ReactQueryNetworkClient'
 import { removeAuthorizationParam } from '../utils/remove-authorization-param'
 import { baseDictionary } from '../error/dictionary/base'
+import { getApiAddresses } from '../api-addresses'
 
 class CloudRuntimesClient extends ReactQueryNetworkClient {
   constructor() {
-    super(apis.cloudRuntimes.url, defaults)
+    super(getApiAddresses().cloudRuntimes.url, defaults)
   }
 
   protected buildStackSpotError(error: HttpError): StackspotAPIError {

package/src/client/cloud-services.ts

@@ -5,15 +5,15 @@ import {
   getCostOverview, getGuardrails, getInstanceDetails, listBillingAccounts, listInstances, listServices,
   processAllocationCostRequest,
 } from '../api/cloudServices'
-import apis from '../apis.json'
 import { DefaultAPIError } from '../error/DefaultAPIError'
 import { StackspotAPIError } from '../error/StackspotAPIError'
 import { ReactQueryNetworkClient } from '../network/ReactQueryNetworkClient'
 import { CostAllocationResult, CostAllocationVariables, FixedManagedService, FixVariables, OazapftsFunction, ReplaceResult } from './types'
+import { getApiAddresses } from '../api-addresses'
 
 class CloudServicesClient extends ReactQueryNetworkClient {
   constructor() {
-    super(apis.cloudServices.url, defaults)
+    super(getApiAddresses().cloudServices.url, defaults)
   }
 
   protected buildStackSpotError(error: HttpError): StackspotAPIError {