@stack-spot/portal-network 0.27.2 → 0.28.0-beta

package/src/apis.json

@@ -11,7 +11,7 @@
     "url": {
       "dev": "https://workspace-workspace-api.dev.stackspot.com",
       "stg": "https://workspace-workspace-api.stg.stackspot.com",
-      "prd": "https://workspace.v1.stackspot.com"
+      "prd": "https://workspace.stackspot.com"
     },
     "docs": "/v3/api-docs"
   },
@@ -19,7 +19,7 @@
     "url": {
       "dev": "https://account-account-api.dev.stackspot.com",
       "stg": "https://account-account-api.stg.stackspot.com",
-      "prd": "https://account.v1.stackspot.com"
+      "prd": "https://account.stackspot.com"
     },
     "docs": "/v3/api-docs"
   },
@@ -27,7 +27,7 @@
     "url": {
       "dev": "https://content-content-api.dev.stackspot.com",
       "stg": "https://content-content-api.stg.stackspot.com",
-      "prd": "https://content-api.v1.stackspot.com"
+      "prd": "https://content-api.stackspot.com"
     },
     "docs": "/v3/api-docs"
   },
@@ -43,7 +43,7 @@
     "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"
+      "prd": "https://catalog-api.stackspot.com"
     },
     "docs": "/v3/api-docs"
   },
@@ -51,7 +51,7 @@
     "url": {
       "dev": "https://runtime-manager.dev.stackspot.com",
       "stg": "https://runtime-manager.stg.stackspot.com",
-      "prd": "https://runtime-manager.v1.stackspot.com"
+      "prd": "https://runtime-manager.stackspot.com"
     },
     "docs": "/v3/api-docs"
   },
@@ -91,7 +91,7 @@
     "url": {
       "dev": "https://workflow-workflow-api.dev.stackspot.com",
       "stg": "https://workflow-workflow-api.stg.stackspot.com",
-      "prd": "https://workflow-api.v1.stackspot.com"
+      "prd": "https://workflow-api.stackspot.com"
     },
     "docs": "/openapi.json"
   },
@@ -99,7 +99,7 @@
     "url": {
       "dev": "https://workspace-workspace-manager.dev.stackspot.com",
       "stg": "https://workspace-workspace-manager.stg.stackspot.com",
-      "prd": "https://workspace-manager.v1.stackspot.com"
+      "prd": "https://workspace-manager.stackspot.com"
     },
     "docs": "/v3/api-docs"
   },
@@ -130,7 +130,7 @@
     "url": {
       "dev": "https://workspace-workspace-secrets-api.dev.stackspot.com",
       "stg": "https://workspace-workspace-secrets-api.stg.stackspot.com",
-      "prd": "https://secrets-api.v1.stackspot.com"
+      "prd": "https://secrets-api.stackspot.com"
     },
     "docs": "/v3/api-docs"
   },

package/src/client/content.ts

@@ -1,11 +1,23 @@
 import { HttpError } from '@oazapfts/runtime'
-import { addLink, addWorkspace, changeVisibility, createStudio, defaults, deleteLink, deletePluginVersion, deleteStudio, deleteV1StacksVersionsByStackVersionId, delWorkspace, deprecatePluginVersion, deprecateStackVersionBy, getApplicationDetailsView, getApplicationsUsesPlugin, getDependentPluginsVersions, getGetPluginView, getInfrastructureEnvironmentsUsesPlugin, getPluginInfrastructureView, getPluginModalView, getPluginVersions, getPluginVersionsNotInUse, getPluginVersionUsageSummary, getStackUsesPlugin, getStackVersionListByIds, getStackWorkspaceDetailView, getStackWorkspaces, getStarterStackVersionsAndPluginsVersions, getStarterUsesPlugin, getStudioByIdOrSlug, getStudios1, getStudiosToCreateButton, getStudioTabs, getUnusedStackVersions, listLinksByStackVersion, listReasons, listWorkspaces, patchStarterV2, stackModalViewSummary, stackVersionUsageSummary, updateStudio, updateStudioTabs } from '../api/content'
+import {
+  addLink, addWorkspace, changeVisibility, createStudio, defaults, deleteLink, deleteStudio, delWorkspace,
+  getStackVersionListByIds, getStudioByIdOrSlug, getStudios1, getStudiosToCreateButton, getStudioTabs,
+  listConnectionInterfaceTypes, listLinksByStackVersion, listPluginVersionByIdsController, listReasons, 
+  listWorkspaces, stackModalViewSummary, getListOfInputs, updateStudio, updateStudioTabs, deleteV1StacksVersionsByStackVersionId, 
+  getStackWorkspaces, getStackWorkspaceDetailView, getUnusedStackVersions, getPluginModalView, getStackUsesPlugin, 
+  getGetPluginView, getPluginInfrastructureView, getApplicationsUsesPlugin, getStarterUsesPlugin, getPluginVersionsNotInUse, 
+  getPluginVersions, getDependentPluginsVersions, getStarterStackVersionsAndPluginsVersions, getInfrastructureEnvironmentsUsesPlugin, 
+  getApplicationDetailsView, stackVersionUsageSummary, deprecateStackVersionBy, getPluginVersionUsageSummary, deprecatePluginVersion,
+  deletePluginVersion, patchStarterV2, listPlugins,
+  getActionsVersions, listStarters, listStacksByFilters,
+} from '../api/content'
 import apis from '../apis.json'
 import { DefaultAPIError } from '../error/DefaultAPIError'
 import { cntDictionary } from '../error/dictionary/cnt'
 import { StackspotAPIError } from '../error/StackspotAPIError'
 import { ReactQueryNetworkClient } from '../network/ReactQueryNetworkClient'
 import { removeAuthorizationParam } from '../utils/remove-authorization-param'
+import { OperationObject } from '../network/types'
 
 class ContentClient extends ReactQueryNetworkClient {
   constructor() {
@@ -83,7 +95,10 @@ class ContentClient extends ReactQueryNetworkClient {
    * Gets content deprecation reasons
    */
   deprecationReasons = this.query(listReasons)
-
+  /**
+   * Gets stacks from a given studio
+   */
+  stacksFromStudios = this.query(listStacksByFilters)
   /**
    * Get usage summary of stack
    */
@@ -176,6 +191,31 @@ class ContentClient extends ReactQueryNetworkClient {
    * Update starter
    */
   updateStarter = this.mutation(patchStarterV2)
+  /**
+   * Gets connection interface types
+   */
+  connectionInterfaceTypes = this.query(listConnectionInterfaceTypes)
+  /**
+   * Gets a list of plugin versions from list of ids.
+   */
+  pluginVersionsByIds = this.query(listPluginVersionByIdsController)
+  /**
+   * Gets plugins from a stack version
+   */
+  listPluginsFromStack = this.query(listPlugins)
+  /**
+   * Gets the inputs of a specific Action. This fn is only used for permission purposes.
+   */
+  actionInputs = this.query(getListOfInputs) as 
+    OperationObject<Parameters<typeof getListOfInputs>[0]>
+  /**
+   * Gets action versions by ids
+   */
+  actionsVersions = this.query(getActionsVersions)
+  /**
+   * Gets all starters from a stack version id
+   */
+  startersInStackVersion = this.query(listStarters)
 }
 
 export const contentClient = new ContentClient()

package/src/client/types.ts

@@ -2,6 +2,7 @@ import { RequestOpts } from '@oazapfts/runtime'
 import { AccountScmInfoSaveRequest, AccountScmInfoUpdateRequest, AccountScmStatusResponse } from '../api/account'
 import { ConnectAccountRequestV2, ManagedAccountProvisionRequest } from '../api/cloudAccount'
 import { AllocationCostRequest, AllocationCostResponse, ChargePeriod, getAllocationCostFilters, ManagedService, ServiceResource } from '../api/cloudServices'
+import { FullInputContextResponse, InputConditionResponse, InputValuesContextResponse, PluginForAppCreationV2Response, PluginInputValuesInConsolidatedContextResponse, ValueByEnvResponse } from '../api/workspaceManager'
 
 interface BaseSMCStatus {
   /**
@@ -116,6 +117,43 @@ export interface FixedManagedAccountProvisionRequest extends Omit<ManagedAccount
   workspaceId: string,
 }
 
+export interface FixedPluginForAppCreationV2Response extends Omit<PluginForAppCreationV2Response, 'inputs'> {
+  inputs: FixedPluginInputValuesInConsolidatedContextResponse[],
+}
+
+export type InputType = 'BOOL' | 'INT' | 'MULTISELECT' | 'OBJECT' | 'LIST' | 'REQUIRED-CONNECTION' | 'PASSWORD' | 'SELECT' | 'TEXT'
+
+export interface FixedInputConditionResponse extends Omit<InputConditionResponse, 'value'> {
+  value?: any,
+}
+
+export interface FixedValueByEnvResponse extends Omit<ValueByEnvResponse, 'value'> {
+  value: any,
+}
+
+export interface FixedInputValuesContextResponse extends Omit<InputValuesContextResponse, 
+'inputs' | 'input' | 'type' | 'default' | 'condition' | 'valuesByEnv'> {
+  inputs: Omit<FixedInputValuesContextResponse, 'valuesByEnv'>[],
+  input?: Omit<FixedInputValuesContextResponse, 'valuesByEnv'>,
+  type: InputType,
+  default?: any,
+  condition?: FixedInputConditionResponse,
+  valuesByEnv: FixedValueByEnvResponse[],
+}
+
+export interface FixedFullInputContextResponse extends Omit<FullInputContextResponse, 'inputs'> {
+  inputs: FixedInputValuesContextResponse[],
+}
+
+export interface FixedPluginInputValuesInConsolidatedContextResponse extends 
+Omit<PluginInputValuesInConsolidatedContextResponse, 'inputs' | 'input' | 'type' | 'default' | 'condition'> {
+  inputs: FixedInputValuesContextResponse[],
+  input?: FixedInputValuesContextResponse,
+  type: InputType,
+  default?: any,
+  condition?: FixedInputConditionResponse,
+}
+
 export type OazapftsFunction<Variables = any, Result = any> = (variables: Variables, opts?: RequestOpts) => Promise<Result>
 
 type Unpromisify<T> = T extends Promise<infer R> ? Unpromisify<R> : T

package/src/client/workspace-manager.ts

@@ -0,0 +1,171 @@
+/* eslint-disable max-len */
+import { HttpError } from '@oazapfts/runtime'
+import {
+  defaults,
+  getAccountPluginInputs,
+  getApplicationAppliedPlugins,
+  getConsolidatedPluginInputs,
+  getSharedInfraAppliedPlugins,
+  listStacks1,
+  getStackActionInputsInWorkspaceContext,
+  getStackActionInputsInAccountContext,
+  upsertWorkspaceActionsInputContext,
+  upsertAccountActionsInputContext,
+  upsertPluginWorkspaceContext,
+  upsertPluginAccountContext,
+  getConsolidatedPluginInputsWithConnectionInterfaces,
+  listWorkflowByStackIdAndWorkflowType,
+} from '../api/workspaceManager'
+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 { contentClient } from './content'
+import { FixedFullInputContextResponse, FixedPluginForAppCreationV2Response, ReplaceResult } from './types'
+import { workspaceClient } from './workspace'
+
+class WorkspaceManagerClient extends ReactQueryNetworkClient {
+  constructor() {
+    super(apis.workspaceManager.url, defaults)
+  }
+
+  protected buildStackSpotError(error: HttpError): StackspotAPIError {
+    return new DefaultAPIError(error.data, error.status, workspaceDictionary, error.headers)
+  }
+
+  /**
+   * Gets all stacks in a workspace
+   */
+  stacksInWorkspace = this.query({
+    name: 'stacksInWorkspace',
+    request: async (signal, variables: Parameters<typeof listStacks1>[0]) => listStacks1(variables, { signal }),
+    permission: async (variables: Parameters<typeof listStacks1>[0]) => {
+      const contentStacksPermission = await contentClient.allStackVersionByIds.isAllowed()
+      const workspaceStacksPermission = await workspaceClient.stacks.isAllowed(variables)
+      return workspaceStacksPermission && contentStacksPermission
+    },
+  })
+  /**
+   * Gets inputs from a plugin in a workspace stack
+   */
+  pluginInputsInWorkspace = this.query({
+    name: 'pluginInputsInWorkspace',
+    request: async (signal, variables: Parameters<typeof getConsolidatedPluginInputs>[0]) => {
+      const data = await getConsolidatedPluginInputs(variables, { signal })
+      return data as FixedFullInputContextResponse
+    },
+    permission: async ({ workspaceId, stackVersionId }: Parameters<typeof getConsolidatedPluginInputs>[0]) => {
+      const canViewContext = await workspaceClient.listConsolidatedWorkspaceContext.isAllowed({ $type: 'plugin', workspaceId, stackVersionId })
+      const canGetConnectionInterfaceTypes = await contentClient.connectionInterfaceTypes.isAllowed()
+      const canGetPluginVersions = await contentClient.pluginVersionsByIds.isAllowed({})
+      return canViewContext && canGetConnectionInterfaceTypes && canGetPluginVersions
+    },
+  })
+  /**
+   * Gets inputs from a plugin in account context
+   */
+  pluginInputsAccount = this.query({
+    name: 'pluginInputsAccount',
+    request: async (signal, variables: Parameters<typeof getAccountPluginInputs>[0]) => {
+      const data = await getAccountPluginInputs(variables, { signal })
+      return data as FixedFullInputContextResponse
+    },
+    permission: async ({ stackVersionId }: Parameters<typeof getAccountPluginInputs>[0]) => {
+      const canViewContext = await workspaceClient.listConsolidatedContext.isAllowed({ $type: 'plugin', stackVersionId })
+      const canGetConnectionInterfaceTypes = await contentClient.connectionInterfaceTypes.isAllowed()
+      const canGetPluginVersions = await contentClient.pluginVersionsByIds.isAllowed({})
+      return canViewContext && canGetConnectionInterfaceTypes && canGetPluginVersions
+    },
+  })
+  /**
+  * Update context inputs from an action in workspace
+  */
+  updateInputContextPluginWorkspace = this.mutation({
+    name: 'updateInputContextPluginWorkspace',
+    request: async (signal, variables: Parameters<typeof upsertPluginWorkspaceContext>[0]) =>
+      upsertPluginWorkspaceContext(variables, { signal }),
+    permission: async ({ stackVersionId, workspaceId, pluginVersionId }: Parameters<typeof upsertPluginWorkspaceContext>[0]) =>
+      workspaceClient.saveContextInWorkspace.isAllowed({ $type: 'plugin', workspaceId, stackVersionId, externalId: pluginVersionId }),
+  })
+  /**
+   * Update context inputs from an action in account
+   */
+  updateInputContextPluginAccount = this.mutation({
+    name: 'updateInputContextPluginAccount',
+    request: async (signal, variables: Parameters<typeof upsertPluginAccountContext>[0]) =>
+      upsertPluginAccountContext(variables, { signal }),
+    permission: async ({ stackVersionId, pluginVersionId }: Parameters<typeof upsertPluginAccountContext>[0]) =>
+      workspaceClient.saveContextInAccount.isAllowed({ $type: 'plugin', stackVersionId, externalId: pluginVersionId }),
+  })
+
+  /**
+   * Gets applied plugins in shared infra
+   */
+  appliedPluginsSharedInfra = this.query(getSharedInfraAppliedPlugins)
+  /**
+   * Gets applied plugins in application
+   */
+  appliedPluginsApplication = this.query(getApplicationAppliedPlugins)
+  /**
+   * Gets plugin inputs and connection interface from a plugin in a stack version in workspace
+   */
+  pluginInputsWithConnectionInterfaces = this.query(getConsolidatedPluginInputsWithConnectionInterfaces as unknown as ReplaceResult<typeof getConsolidatedPluginInputsWithConnectionInterfaces, FixedPluginForAppCreationV2Response>)
+  /**
+   * Gets workflows from a given stack and workflow type 
+   */
+  workflowsByStackIdAndWorkflowType = this.query(listWorkflowByStackIdAndWorkflowType)
+  
+  /**
+  * Gets inputs from an action in a workspace
+  */
+  actionInputsInWorkspace = this.query({
+    name: 'actionInputsInWorkspace',
+    request: async (signal, variables: Parameters<typeof getStackActionInputsInWorkspaceContext>[0]) => {
+      const data = await getStackActionInputsInWorkspaceContext(variables, { signal })
+      return data as FixedFullInputContextResponse
+    },
+    permission: async ({ workspaceId, stackVersionId, actionsVersionId }: Parameters<typeof getStackActionInputsInWorkspaceContext>[0]) => {
+      const canViewContext = await workspaceClient.listConsolidatedWorkspaceContext.isAllowed({ $type: 'action', workspaceId, stackVersionId })
+      const canGetActionInput = await contentClient.actionInputs.isAllowed({ actionVersionId: actionsVersionId })
+      return canViewContext && canGetActionInput
+    },
+  })
+  /**
+   * Gets inputs from an action in account context
+   */
+  actionInputsAccount = this.query({
+    name: 'actionInputsFromStack',
+    request: async (signal, variables: Parameters<typeof getStackActionInputsInAccountContext>[0]) => {
+      const data = await getStackActionInputsInAccountContext(variables, { signal })
+      return data as FixedFullInputContextResponse
+    },
+    permission: async ({ stackVersionId, actionsVersionId }: Parameters<typeof getStackActionInputsInAccountContext>[0]) => {
+      const canViewContext = await workspaceClient.listConsolidatedContext.isAllowed({ $type: 'action', stackVersionId })
+      const canGetActionInput = await contentClient.actionInputs.isAllowed({ actionVersionId: actionsVersionId })
+      return canViewContext && canGetActionInput
+    },
+  })
+  /**
+   * Update context inputs from an action in workspace
+   */
+  updateInputContextActionWorkspace = this.mutation({
+    name: 'updateInputContextActionWorkspace',
+    request: async (signal, variables: Parameters<typeof upsertWorkspaceActionsInputContext>[0]) =>
+      upsertWorkspaceActionsInputContext(variables, { signal }),
+    permission: async ({ stackVersionId, workspaceId, actionVersionId }: Parameters<typeof upsertWorkspaceActionsInputContext>[0]) =>
+      workspaceClient.saveContextInWorkspace.isAllowed({ $type: 'action', workspaceId, stackVersionId, externalId: actionVersionId }),
+  })
+  /**
+   * Update context inputs from an action in account
+   */
+  updateInputContextActionAccount = this.mutation({
+    name: 'updateInputContextActionAccount',
+    request: async (signal, variables: Parameters<typeof upsertAccountActionsInputContext>[0]) =>
+      upsertAccountActionsInputContext(variables, { signal }),
+    permission: async ({ stackVersionId, actionVersionId }: Parameters<typeof upsertAccountActionsInputContext>[0]) =>
+      workspaceClient.saveContextInAccount.isAllowed({ $type: 'action', stackVersionId, externalId: actionVersionId }),
+  })
+}
+
+export const workspaceManagerClient = new WorkspaceManagerClient()