@stack-spot/portal-network 0.13.0 → 0.14.0

package/src/api/workspace.ts

@@ -4,15 +4,15 @@
  * 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"
+import * as Oazapfts from "@oazapfts/runtime";
+import * as QS from "@oazapfts/runtime/query";
 export const defaults: Oazapfts.Defaults<Oazapfts.CustomHeaders> = {
     headers: {},
-    baseUrl: "https://workspace-workspace-api.dev.stackspot.com",
+    baseUrl: "https://workspace.v1.stackspot.com",
 };
 const oazapfts = Oazapfts.runtime(defaults);
 export const servers = {
-    generatedServerUrl: "https://workspace-workspace-api.dev.stackspot.com"
+    generatedServerUrl: "https://workspace.v1.stackspot.com"
 };
 export type ContextAttributeDto = {
     key: string;
@@ -301,38 +301,6 @@ export type StackWorkflowCreateRequest = {
     actionsBefore: WorkflowActionContextRequest[];
     actionsAfter: WorkflowActionContextRequest[];
 };
-export type EnvironmentSimpleResponse = {
-    /** Environment id. */
-    id?: string;
-    /** Environment name. */
-    name?: string;
-};
-export type TargetByPluginUsageResponse = {
-    /** Plugin Version ID. */
-    pluginVersionId?: string;
-    environment?: EnvironmentSimpleResponse;
-};
-export type WorkspaceResponse = {
-    /** Workspace id. */
-    id?: string;
-    /** Workspace name */
-    name?: string;
-    /** Workspace description */
-    description?: string;
-    /** Workspace image */
-    imageUrl?: string;
-};
-export type PluginUsageByTargetResponse = {
-    /** Application id. */
-    id?: string;
-    /** Application name. */
-    name?: string;
-    /** Application description. */
-    description?: string;
-    /** Amount of linked versions. */
-    totalLinkedVersions?: number;
-    workspace?: WorkspaceResponse;
-};
 export type WorkspaceReadResponse = {
     /** Workspace id. */
     id?: string;
@@ -346,6 +314,8 @@ export type WorkspaceReadResponse = {
     manageRuntime?: boolean;
     /** Workspace accountId. */
     accountId?: string;
+    /** Workspace teams. - deprecated field */
+    teams?: string[];
     /** Workspace creator. */
     createdBy?: string;
     /** Workspace creation date. */
@@ -397,15 +367,6 @@ export type StackWithWorkspaceContextResponse = {
     /** Account id. */
     accountId?: string;
 };
-export type WorkspaceByStackUsageResponse = {
-    /** Stack Version ID. */
-    stackVersionId?: string;
-    /** Amount of linked applications. */
-    totalLinkedApps?: number;
-    /** Amount of linked shared infrastructure. */
-    totalLinkedInfra?: number;
-    environment?: EnvironmentSimpleResponse;
-};
 export type SharedInfraDetailsResponse = {
     /** Shared infrastructure id. */
     id?: string;
@@ -640,9 +601,9 @@ export type CreateApplicationRequest = {
     /** Application repository base branch. */
     repoBaseBranch: string;
     /** Stack used to generate this application. */
-    stackVersionId?: string;
+    stackVersionId: string;
     /** Starter used to generate this application. */
-    starterId?: string;
+    starterId: string;
 };
 export type RecreateApplicationRequest = {
     /** Application name. */
@@ -789,23 +750,6 @@ export type ApplicationDeploySnapshotRequest = {
     /** Input attributes for applied app plugin. */
     plugins?: PluginElementSnapshot[];
 };
-export type StackUsageByWorkspaceResponse = {
-    /** Workspace id. */
-    id?: string;
-    /** Workspace name */
-    name?: string;
-    /** Workspace description */
-    description?: string;
-    /** Workspace image */
-    imageUrl?: string;
-    /** Amount of linked versions. */
-    totalLinkedVersions?: number;
-};
-export type PluginUsageAmountResponse = {
-    pluginVersionId: string;
-    totalUsedInInfras: number;
-    totalUsedInApps: number;
-};
 export type EnvironmentReadResponse = {
     /** Environment id. */
     id?: string;
@@ -953,6 +897,8 @@ export type AppliedPluginV2Response = {
     links?: Link[];
 };
 export type ConnectionInterfaceSummaryV2Response = {
+    /** Connection interface api id. */
+    apiId?: string;
     /** Connection interface id type generate by client. */
     typeId?: string;
     /** Connection interface id generated by client. */
@@ -1041,6 +987,30 @@ export type ActivityResponse = {
         [key: string]: object;
     };
 };
+export type PaginatedActivityResponse = {
+    items: ActivityResponse[];
+    currentPage: number;
+    totalItems: number;
+    totalPages: number;
+    pageSize: number;
+    hasNextPage: boolean;
+};
+export type AppDependencyConnInterfaceResponse = {
+    name: string;
+    "type": string;
+};
+export type Dependencies = {
+    environmentName: string;
+    hasSelfHostedInfra: boolean;
+    hasApplication: boolean;
+    connectionInterfaces: AppDependencyConnInterfaceResponse[];
+};
+export type AppAndInfraDependencyResponse = {
+    canDelete: boolean;
+    hasSelfHostedInfra: boolean;
+    hasApplication: boolean;
+    dependencies: Dependencies[];
+};
 export type ConnectionInterfaceDetailsResponse = {
     /** Connection interface id. */
     id?: string;
@@ -1122,14 +1092,6 @@ export type ApplicationDeployInfoResponse = {
     appDeploy?: AppDeployResponse;
     infraDeploy?: InfraDeployResponse;
 };
-export type AppDependencyConnInterfaceResponse = {
-    name: string;
-    "type": string;
-};
-export type ApplicationDependencyResponse = {
-    environment: string;
-    connectionInterfaces: AppDependencyConnInterfaceResponse[];
-};
 export type EnvironmentsRequest = {
     environmentId: string;
     environmentName?: string;
@@ -1171,6 +1133,12 @@ export type CheckConnectionSlugAvailabilityResponse = {
     /** Whether connection slug is available or not. */
     available?: boolean;
 };
+export type WorkspaceResponse = {
+    /** Workspace id. */
+    id?: string;
+    /** Workspace name. */
+    name?: string;
+};
 export type ApplicationRepoUrlReadResponse = {
     /** Application id. */
     id?: string;
@@ -2088,53 +2056,6 @@ export function saveStackWorkflowContext({ stackId, workflowId, stackWorkflowCre
         body: stackWorkflowCreateRequest
     })));
 }
-/**
- * List specific shared infra or application usage by plugin list.
- */
-export function listPluginUsageByTargetId({ accountId, targetType, targetId, body }: {
-    accountId: string;
-    targetType: "applications" | "shared_infra";
-    targetId: string;
-    body: string[];
-}, opts?: Oazapfts.RequestOpts) {
-    return oazapfts.ok(oazapfts.fetchJson<{
-        status: 200;
-        data: TargetByPluginUsageResponse[];
-    } | {
-        status: 403;
-        data: ErrorResponse;
-    }>(`/v1/${encodeURIComponent(targetType)}/${encodeURIComponent(targetId)}/plugins/usage`, oazapfts.json({
-        ...opts,
-        method: "POST",
-        body,
-        headers: oazapfts.mergeHeaders(opts?.headers, {
-            accountId
-        })
-    })));
-}
-/**
- * List all shared infras or applications usage by plugin list.
- */
-export function listAllPluginUsage({ accountId, targetType, body }: {
-    accountId: string;
-    targetType: "applications" | "shared_infra";
-    body: string[];
-}, opts?: Oazapfts.RequestOpts) {
-    return oazapfts.ok(oazapfts.fetchJson<{
-        status: 200;
-        data: PluginUsageByTargetResponse[];
-    } | {
-        status: 403;
-        data: ErrorResponse;
-    }>(`/v1/${encodeURIComponent(targetType)}/plugins/usage`, oazapfts.json({
-        ...opts,
-        method: "POST",
-        body,
-        headers: oazapfts.mergeHeaders(opts?.headers, {
-            accountId
-        })
-    })));
-}
 /**
  * Get all workspaces
  */
@@ -2322,29 +2243,6 @@ export function getStacksWithContext({ workspaceId, body }: {
         body
     })));
 }
-/**
- * List specific workspace usage by stack version list.
- */
-export function listStackUsageByWorkspaceId({ accountId, workspaceId, body }: {
-    accountId: string;
-    workspaceId: string;
-    body: string[];
-}, opts?: Oazapfts.RequestOpts) {
-    return oazapfts.ok(oazapfts.fetchJson<{
-        status: 200;
-        data: WorkspaceByStackUsageResponse[];
-    } | {
-        status: 403;
-        data: ErrorResponse;
-    }>(`/v1/workspaces/${encodeURIComponent(workspaceId)}/stacks/usage`, oazapfts.json({
-        ...opts,
-        method: "POST",
-        body,
-        headers: oazapfts.mergeHeaders(opts?.headers, {
-            accountId
-        })
-    })));
-}
 /**
  * Get all shared infrastructure of a workspace.
  */
@@ -3291,56 +3189,6 @@ export function processDeploySnapshot1({ workspaceId, applicationId, application
         body: applicationDeploySnapshotRequest
     })));
 }
-/**
- * List all workspaces usage by stack version list.
- */
-export function listAllStackUsage({ accountId, body }: {
-    accountId: string;
-    body: string[];
-}, opts?: Oazapfts.RequestOpts) {
-    return oazapfts.ok(oazapfts.fetchJson<{
-        status: 200;
-        data: StackUsageByWorkspaceResponse[];
-    } | {
-        status: 403;
-        data: ErrorResponse;
-    }>("/v1/workspaces/stacks/usage", oazapfts.json({
-        ...opts,
-        method: "POST",
-        body,
-        headers: oazapfts.mergeHeaders(opts?.headers, {
-            accountId
-        })
-    })));
-}
-/**
- * Retrieve the amount of apps and shared infras that use the given plugin version id list
- */
-export function findPluginUsageAmount({ accountId, body }: {
-    accountId: string;
-    body: string[];
-}, opts?: Oazapfts.RequestOpts) {
-    return oazapfts.ok(oazapfts.fetchJson<{
-        status: 200;
-        data: PluginUsageAmountResponse[];
-    } | {
-        status: 400;
-        data: ErrorResponse;
-    } | {
-        status: 403;
-        data: ErrorResponse;
-    } | {
-        status: 500;
-        data: ErrorResponse;
-    }>("/v1/plugin-usage", oazapfts.json({
-        ...opts,
-        method: "POST",
-        body,
-        headers: oazapfts.mergeHeaders(opts?.headers, {
-            accountId
-        })
-    })));
-}
 /**
  * Get environments
  */
@@ -4428,15 +4276,17 @@ export function getAppliedPlugins2({ workspaceId, sharedInfraId, environmentId,
 /**
  * List shared infrastructure's activities.
  */
-export function listActivities({ workspaceId, sharedInfraId, environmentId, $type }: {
+export function listActivities({ workspaceId, sharedInfraId, environmentId, $type, page, size }: {
     workspaceId: string;
     sharedInfraId: string;
     environmentId: string;
     $type?: "DEPLOY" | "ACTION" | "WORKFLOW" | "DRIFT" | "DESTROY" | "ROLLBACK" | "IAC" | "DEPLOY_SELF_HOSTED" | "DESTROY_SELF_HOSTED" | "ROLLBACK_SELF_HOSTED" | "IAC_SELF_HOSTED" | "CUSTOMER_WORKFLOW";
+    page: number;
+    size: number;
 }, opts?: Oazapfts.RequestOpts) {
     return oazapfts.ok(oazapfts.fetchJson<{
         status: 200;
-        data: ActivityResponse[];
+        data: PaginatedActivityResponse;
     } | {
         status: 400;
         data: ErrorResponse;
@@ -4450,11 +4300,39 @@ export function listActivities({ workspaceId, sharedInfraId, environmentId, $typ
         status: 500;
         data: ErrorResponse;
     }>(`/v1/workspaces/${encodeURIComponent(workspaceId)}/shared-infra/${encodeURIComponent(sharedInfraId)}/environments/${encodeURIComponent(environmentId)}/activities${QS.query(QS.explode({
-        "type": $type
+        "type": $type,
+        page,
+        size
     }))}`, {
         ...opts
     }));
 }
+/**
+ * Get all in use connection interface dependencies from the shared infra.
+ */
+export function getDependencyTree({ workspaceId, sharedInfraId }: {
+    workspaceId: string;
+    sharedInfraId: string;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: AppAndInfraDependencyResponse;
+    } | {
+        status: 400;
+        data: ErrorResponse;
+    } | {
+        status: 403;
+        data: ErrorResponse;
+    } | {
+        status: 404;
+        data: ErrorResponse;
+    } | {
+        status: 500;
+        data: ErrorResponse;
+    }>(`/v1/workspaces/${encodeURIComponent(workspaceId)}/shared-infra/${encodeURIComponent(sharedInfraId)}/dependencies`, {
+        ...opts
+    }));
+}
 /**
  * Get a connection interface by connection interface id.
  */
@@ -4651,15 +4529,17 @@ export function getAppDeployInfo({ workspaceId, applicationId, environmentId, ac
 /**
  * List application's activities.
  */
-export function listActivities1({ workspaceId, applicationId, environmentId, $type }: {
+export function listActivities1({ workspaceId, applicationId, environmentId, $type, page, size }: {
     workspaceId: string;
     applicationId: string;
     environmentId: string;
     $type?: "DEPLOY" | "ACTION" | "WORKFLOW" | "DRIFT" | "DESTROY" | "ROLLBACK" | "IAC" | "DEPLOY_SELF_HOSTED" | "DESTROY_SELF_HOSTED" | "ROLLBACK_SELF_HOSTED" | "IAC_SELF_HOSTED" | "CUSTOMER_WORKFLOW";
+    page: number;
+    size: number;
 }, opts?: Oazapfts.RequestOpts) {
     return oazapfts.ok(oazapfts.fetchJson<{
         status: 200;
-        data: ActivityResponse[];
+        data: PaginatedActivityResponse;
     } | {
         status: 400;
         data: ErrorResponse;
@@ -4673,7 +4553,9 @@ export function listActivities1({ workspaceId, applicationId, environmentId, $ty
         status: 500;
         data: ErrorResponse;
     }>(`/v1/workspaces/${encodeURIComponent(workspaceId)}/applications/${encodeURIComponent(applicationId)}/environments/${encodeURIComponent(environmentId)}/activities${QS.query(QS.explode({
-        "type": $type
+        "type": $type,
+        page,
+        size
     }))}`, {
         ...opts
     }));
@@ -4681,13 +4563,13 @@ export function listActivities1({ workspaceId, applicationId, environmentId, $ty
 /**
  * Get all in use connection interface dependencies from the application.
  */
-export function getDependencyTree({ workspaceId, applicationId }: {
+export function getDependencyTree1({ workspaceId, applicationId }: {
     workspaceId: string;
     applicationId: string;
 }, opts?: Oazapfts.RequestOpts) {
     return oazapfts.ok(oazapfts.fetchJson<{
         status: 200;
-        data: ApplicationDependencyResponse[];
+        data: AppAndInfraDependencyResponse;
     } | {
         status: 400;
         data: ErrorResponse;

package/src/apis.json

@@ -31,6 +31,14 @@
     },
     "docs": "/v3/api-docs"
   },
+  "eventBus": {
+    "url": {
+      "dev": "https://idp-event-bus-api.dev.stackspot.com",
+      "stg": "https://idp-event-bus-api.stg.stackspot.com",
+      "prd": "https://event-bus-api.stackspot.com"
+    },
+    "docs": "/v3/api-docs"
+  },
   "serviceCatalog": {
     "url": {
       "dev": "https://catalog-tech-products-catalog-api.dev.stackspot.com",
@@ -43,7 +51,7 @@
     "url": {
       "dev": "https://runtime-manager.dev.stackspot.com",
       "stg": "https://runtime-manager.stg.stackspot.com",
-      "prd": "https://runtime-engine.v1.stackspot.com"
+      "prd": "https://runtime-manager.v1.stackspot.com"
     },
     "docs": "/v3/api-docs"
   },

package/src/client/event-bus.ts

@@ -0,0 +1,82 @@
+import { HttpError } from '@oazapfts/runtime'
+import { CompletablePromise } from '@stack-spot/opa'
+import { cloneDeep } from 'lodash'
+import { defaults, EventProcessingResponse, Event as EventType, sendEvents } from '../api/eventBus'
+import apis from '../apis.json'
+import { DefaultAPIError } from '../error/DefaultAPIError'
+import { baseDictionary } from '../error/dictionary/base'
+import { StackspotAPIError } from '../error/StackspotAPIError'
+import { NetworkClient } from '../network/NetworkClient'
+
+export const EVENTS_STORAGE_IDENTIFIER = 'eventsError'
+const DEFER_MS = 5000
+class EventBusClient extends NetworkClient {
+  private queue: EventType[] = []
+  private deferred = new CompletablePromise<EventProcessingResponse>()
+  private timeout: number | undefined
+  private lock = false
+
+  constructor() {
+    super(apis.eventBus.url)
+    defaults.baseUrl = ''
+    defaults.fetch = (...args) => this.fetch(...args)
+  }
+
+  protected buildStackSpotError(error: HttpError): StackspotAPIError {
+    return new DefaultAPIError(error.data, error.status, baseDictionary, error.headers)
+  }
+  
+  private async consume() {
+    if (this.queue.length === 0) return
+    if (this.lock) return this.timeout = window.setTimeout(() => this.consume(), DEFER_MS)
+
+    this.lock = true
+    const deferred = this.deferred
+    this.deferred = new CompletablePromise()
+    const sendingQueue = cloneDeep(this.queue)
+    this.queue = []
+
+    const storageEvents = JSON.parse(localStorage.getItem(EVENTS_STORAGE_IDENTIFIER) || '[]')
+
+    const bodyData = {
+      events: sendingQueue.concat(storageEvents),
+    }
+
+    try {
+      const allResults: EventProcessingResponse = await sendEvents({ sendEventsRequest: bodyData })
+
+      if (allResults.errorCount === 0) {
+        localStorage.removeItem(EVENTS_STORAGE_IDENTIFIER)
+      }
+      deferred.resolve(allResults)
+
+    } catch (error: any) {
+      if (error instanceof HttpError) {
+        deferred.reject(new Error(`Error while sending events. Network error ${error.status}.\n}`))
+      }
+      throw error
+    }
+  }
+
+  private async add(event: EventType) {
+    if (this.timeout) window.clearTimeout(this.timeout)
+    const index = this.queue.length
+    this.queue.push(event)
+    this.timeout = window.setTimeout(() => this.consume(), DEFER_MS)
+    const response = await this.deferred.promise
+    const result = response.results[index]
+    if ('errorCode' in result) {
+      throw result
+    }
+    return result
+  }
+
+  /**
+   * Sends an event
+   */
+  sendEvent = async (event: EventType) => {
+    await this.add(event)
+  }
+}
+
+export const eventBusClient = new EventBusClient()

package/src/client/workspace.ts

@@ -6,11 +6,21 @@ import {
   deleteConnectionInterfaceAttributesFromEnvironment, deleteConnectionInterfaceFromAllEnvironments,
   delete4 as deleteEmbeddedLink,
   getEmbeddedLinks1 as getAllApplicationEmbeddedLinks,
+  getApplication,
   getEmbeddedLink1 as getApplicationEmbeddedLinks,
   getConnectionInterface, getConnectionInterfaces,
+  getDependencyTree,
+  getDependencyTree1,
   getEmbeddedLink, getEmbeddedLinks, getEnvironment, getEnvironments,
+  getSharedInfrastructure,
+  getWorkspaceForId,
+  getWorkspaces,
+  save,
   save8 as saveApplicationEmbeddedLinks,
   save9 as saveEnvironment,
+  update1,
+  update2,
+  update6,
   upsertBatch2 as updateAllApplicationEmbeddedLinks,
   upsertBatch1 as updateAllEmbeddedLink,
   update8 as updateApplicationEmbeddedLinks,
@@ -144,6 +154,57 @@ class WorkspaceClient extends ReactQueryNetworkClient {
    */
   updateAllEmbeddedLinksInApplication = this.mutation(updateAllApplicationEmbeddedLinks)
   
+  /**
+   * Gets all workspaces
+   */
+  workspaces = this.query(getWorkspaces)
+
+  /**
+   * Gets a workspace
+   */
+  workspace = this.query(getWorkspaceForId)
+
+  /**
+   * Creates a workspace
+   */
+  createWorkspace = this.mutation(save)  
+
+  /**
+   * Updates a workspace
+   */
+  updateWorkspace = this.mutation(update1)  
+  
+  /**
+   * Gets an application
+   */
+  application = this.query(getApplication)
+
+  /**
+   * Gets the dependencies of an application
+   */
+  applicationDependencies = this.query(getDependencyTree1)
+  
+  /**
+   * Gets a shared infra
+   */
+  sharedInfra = this.query(getSharedInfrastructure)
+
+  /**
+   * Gets the dependencies of a shared infra
+   */
+  sharedInfraDependencies = this.query(getDependencyTree)
+  
+  /**
+   * Updates an application
+   */
+  updateApplication = this.mutation(update6)
+
+  /**
+   * Updates a shared infra
+   */
+  updateInfra = this.mutation(update2)
+
+  
 }
 
 export const workspaceClient = new WorkspaceClient()

package/src/index.ts

@@ -4,6 +4,7 @@ export { workspaceClient } from './client/workspace'
 export { runtimeManagerClient } from './client/runtime-manager'
 export { workspaceSearchClient } from './client/workspace-search'
 export { workflowClient } from './client/workflow'
+export { eventBusClient } from './client/event-bus'
 export * from './client/types'
 export { DefaultAPIError } from './error/DefaultAPIError'
 export { StackspotAPIError } from './error/StackspotAPIError'