@stack-spot/portal-network 0.14.1 → 0.15.0

package/src/client/cloud-services.ts

@@ -0,0 +1,84 @@
+import { HttpError } from '@oazapfts/runtime'
+import {
+  BillingAccountSummaryResponse,
+  defaults, downloadCsvFiles, enableGuardrail, getAlerts, getAllocationCostCsv, getAllocationCostFilters, getAllTags,
+  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, OazapftsFunction, ReplaceResult } from './types'
+
+class CloudServicesClient extends ReactQueryNetworkClient {
+  constructor() {
+    super(apis.cloudServices.url, defaults)
+  }
+
+  protected buildStackSpotError(error: HttpError): StackspotAPIError {
+    return new DefaultAPIError(error.data, error.status, { en: {}, pt: {} }, error.headers)
+  }
+
+  /**
+   * Gets overview of costs over the current month, last month and last 3 months.
+   */
+  costOverview = this.query(getCostOverview)
+  /**
+   * Gets a CSV file with the data of `costOverview`.
+   */
+  downloadCostOverviewCSV = this.mutation(downloadCsvFiles)
+  /**
+   * Gets the alerts in a workspace and environment (paginated).
+   */
+  alerts = this.infiniteQuery(getAlerts, {
+    accumulator: 'data',
+    defaultVariables: { pageSize: 40 },
+    initialPageParam: 1,
+    getNextPageParam: ({ lastPage }) => lastPage.nextPage,
+  })
+  /**
+   * Lists instances of a particular service resource running in a workspace.
+   */
+  allInstancesOfResource = this.query(listInstances)
+  /**
+   * Lists all managed services.
+   */
+  allServices = this.query(listServices as unknown as ReplaceResult<typeof listServices, FixedManagedService[]>)
+  /**
+   * Gets the description of an instance.
+   */
+  instance = this.query(getInstanceDetails as unknown as ReplaceResult<typeof getInstanceDetails, string>)
+  /**
+   * Gets all Guard Rails.
+   */
+  guardRails = this.query(getGuardrails)
+  /**
+   * Enables a Guard Rail in any level
+   */
+  enableGuardRail = this.mutation(enableGuardrail)
+  /**
+   * Retrieves cost and usage metrics for the current account.
+   */
+  costAllocation = this.query(
+    processAllocationCostRequest as unknown as OazapftsFunction<CostAllocationVariables, CostAllocationResult>,
+  )
+  /**
+   * Lists the filters related to the given type.
+   */
+  costAllocationFilters = this.query(getAllocationCostFilters)
+  /**
+   * Gets a CSV file with the data of `costAllocation`.
+   */
+  downloadCostAllocationCSV = this.query(getAllocationCostCsv)
+  /**
+   * Lists all tags.
+   */
+  allTags = this.query(getAllTags)
+  /**
+   * Retrieves a summary for each billing account of the account with the id passed as parameter.
+   */
+  billingAccounts = this.query(listBillingAccounts as unknown as ReplaceResult<typeof listBillingAccounts, BillingAccountSummaryResponse[]>)
+}
+
+export const cloudServicesClient = new CloudServicesClient()

package/src/client/types.ts

@@ -1,4 +1,7 @@
-import { AccountScmInfoSaveRequest, AccountScmInfoUpdateRequest, AccountScmStatusResponse } from '../api/account'
+import { RequestOpts } from '@oazapfts/runtime'
+import { AccountScmInfoSaveRequest, AccountScmInfoUpdateRequest, AccountScmStatusResponse, IdResponse } from '../api/account'
+import { AllocationCostRequest, AllocationCostResponse, ChargePeriod, getAllocationCostFilters, ManagedService, ServiceResource } from '../api/cloudServices'
+import { EnvironmentReadResponse, WorkspaceReadResponse } from '../api/workspace'
 
 interface BaseSMCStatus {
   /**
@@ -42,3 +45,84 @@ export interface UpdateSCMRequest {
     value?: SCMAuthGitValue | SCMAuthPATValue,
   },
 }
+
+export type AllocationCostType = Parameters<typeof getAllocationCostFilters>[0]['$type']
+
+export interface CostAllocationVariables {
+  allocationCostRequest: Omit<AllocationCostRequest, 'stackSpotAccountId' | 'billingAccountId'> & {
+    stackSpotAccountId: string,
+    billingAccountId: string[],
+  },
+}
+
+interface ServiceNameResponse {
+  type: 'ServiceNameResponse',
+  chargePeriod?: ChargePeriod,
+  /** Represents an offering that can be purchased from a cloud provider. */
+  serviceName?: string,
+  /** Effective cost post discounts and amortizations. */
+  effectiveCost?: number,
+}
+
+interface TagResponse {
+  type: 'TagResponse',
+  chargePeriod?: ChargePeriod,
+  /** Tag key: Identifies a grouping attribute or category for resources or constructs. */
+  tagKey?: string,
+  /** Tag value: Specifies the group or category detail that the resource or construct belongs to. */
+  tagValue?: string,
+  /** Effective cost post discounts and amortizations. */
+  effectiveCost?: number,
+}
+
+interface UsageUnitResponse {
+  type: 'UsageUnitResponse',
+  chargePeriod?: ChargePeriod,
+  /** Represents an offering that can be purchased from a cloud provider. */
+  serviceName?: string,
+  /** Represents the volume of a given resource or service used or purchased based on the Usage Unit. */
+  usageQuantity?: number,
+  /** Defines the unit of measurement for the resource or service. */
+  usageUnit?: string,
+  /** Effective cost post discounts and amortizations. */
+  effectiveCost?: number,
+}
+
+export type CostAllocationData = ServiceNameResponse | TagResponse | UsageUnitResponse
+
+export interface CostAllocationResult extends Omit<AllocationCostResponse, 'data'> {
+  data: CostAllocationData[],
+}
+
+interface FixedServiceResource extends Omit<ServiceResource, 'id'> {
+  id: string,
+}
+
+export interface FixedManagedService extends Omit<ManagedService, 'resources'> {
+  resources: FixedServiceResource[],
+}
+
+export type OazapftsFunction<Variables = any, Result = any> = (variables: Variables, opts?: RequestOpts) => Promise<Result>
+
+export type FixVariables<
+  T extends OazapftsFunction,
+  Fix extends Record<string, any>,
+> = OazapftsFunction<Omit<Parameters<T>[0], keyof Fix> & { [K in keyof Fix as Fix[K] extends never ? never : K]: Fix[K] }, ReturnType<T>>
+
+export type ReplaceResult<T extends (...args: any[]) => Promise<any>, Fix> = (...args: Parameters<T>) => Promise<Fix>
+
+
+export interface FixedWorkspaceReadResponse extends Omit<WorkspaceReadResponse, 'id' | 'name'> {
+  id: string,
+  name: string,
+}
+
+export interface FixedEnvironmentReadResponse extends Omit<EnvironmentReadResponse, 'id' | 'name'> {
+  id: string,
+  name: string,
+}
+
+export interface FixedIdResponse extends Omit<IdResponse, 'id'> {
+  id: string,
+}
+

package/src/client/workspace.ts

@@ -34,6 +34,7 @@ import { DefaultAPIError } from '../error/DefaultAPIError'
 import { workspaceDictionary } from '../error/dictionary/workspace'
 import { StackspotAPIError } from '../error/StackspotAPIError'
 import { ReactQueryNetworkClient } from '../network/ReactQueryNetworkClient'
+import { FixedEnvironmentReadResponse, FixedIdResponse, FixedWorkspaceReadResponse, ReplaceResult } from './types'
 
 class WorkspaceClient extends ReactQueryNetworkClient {
   constructor() {
@@ -77,12 +78,12 @@ class WorkspaceClient extends ReactQueryNetworkClient {
   /**
    * Gets all environments
    */
-  environments = this.query(getEnvironments)
+  environments = this.query(getEnvironments as unknown as ReplaceResult<typeof getEnvironments, FixedEnvironmentReadResponse[]>)
 
   /**
    * Gets environment by Id
    */
-  environment = this.query(getEnvironment)
+  environment = this.query(getEnvironment as unknown as ReplaceResult<typeof getEnvironment, FixedEnvironmentReadResponse>)
 
   /**
    * Creates an environment
@@ -157,17 +158,17 @@ class WorkspaceClient extends ReactQueryNetworkClient {
   /**
    * Gets all workspaces
    */
-  workspaces = this.query(getWorkspaces)
+  workspaces = this.query(getWorkspaces as unknown as ReplaceResult<typeof getWorkspaces, FixedWorkspaceReadResponse[]>)
 
   /**
    * Gets a workspace
    */
-  workspace = this.query(getWorkspaceForId)
+  workspace = this.query(getWorkspaceForId as unknown as ReplaceResult<typeof getWorkspaceForId, FixedWorkspaceReadResponse>)
 
   /**
    * Creates a workspace
    */
-  createWorkspace = this.mutation(save)  
+  createWorkspace = this.mutation(save  as unknown as ReplaceResult<typeof save, FixedIdResponse>)
 
   /**
    * Updates a workspace

package/src/index.ts

@@ -1,4 +1,5 @@
 export { accountClient } from './client/account'
+export { cloudServicesClient } from './client/cloud-services'
 export { secretsClient } from './client/secrets'
 export { workspaceClient } from './client/workspace'
 export { runtimeManagerClient } from './client/runtime-manager'
@@ -6,8 +7,11 @@ export { workspaceSearchClient } from './client/workspace-search'
 export { workflowClient } from './client/workflow'
 export { eventBusClient } from './client/event-bus'
 export * from './client/types'
+export { UseQueryObjectOptions } from './network/types'
 export { DefaultAPIError } from './error/DefaultAPIError'
 export { StackspotAPIError } from './error/StackspotAPIError'
 export { NetworkClient } from './network/NetworkClient'
 export { queryClient } from './network/react-query-client'
+export { OperationResult, OperationVariables } from './network/types'
 export { useExtendedList } from './utils/use-extended-list'
+

package/src/network/AutoInfiniteQuery.ts

@@ -50,7 +50,11 @@ export class AutoInfiniteQuery<Variables, Result, PageParamName extends keyof Va
     ).flat() as Accumulator extends keyof Result ? Result[Accumulator] : Result
   }
 
-  private useInfiniteQueryResult(suspense: boolean, variables = {} as Variables, options?: UseInfiniteQueryObjectOptions) {
+  private useInfiniteQueryResult(
+    suspense: boolean,
+    variables = {} as Variables,
+    options?: UseInfiniteQueryObjectOptions<Result>,
+  ) {
     variables = { ...variables, ...this.options.defaultVariables }
     const use = suspense ? useSuspenseInfiniteQuery : useInfiniteQuery
     return use<any, any, any, any, any>({
@@ -65,7 +69,7 @@ export class AutoInfiniteQuery<Variables, Result, PageParamName extends keyof Va
 
   useInfiniteQuery(
     variables?: Variables,
-    options?: UseInfiniteQueryObjectOptions,
+    options?: UseInfiniteQueryObjectOptions<Result>,
   ): [
     Accumulator extends keyof Result ? Result[Accumulator] : Result,
     UseInfiniteQueryResult<InfiniteData<Result>, StackspotAPIError>,
@@ -79,7 +83,7 @@ export class AutoInfiniteQuery<Variables, Result, PageParamName extends keyof Va
 
   useStatefulInfiniteQuery(
     variables?: Variables,
-    options?: UseInfiniteQueryObjectOptions,
+    options?: UseInfiniteQueryObjectOptions<Result>,
   ): [
     Accumulator extends keyof Result ? Result[Accumulator] : Result,
     boolean,

package/src/network/AutoQuery.ts

@@ -1,10 +1,10 @@
 /* eslint-disable react-hooks/rules-of-hooks */
 
-import { DefinedUseQueryResult, UseQueryOptions, UseSuspenseQueryResult, useQuery, useSuspenseQuery } from '@tanstack/react-query'
+import { DefinedUseQueryResult, UseSuspenseQueryResult, useQuery, useSuspenseQuery } from '@tanstack/react-query'
 import { StackspotAPIError } from '../error/StackspotAPIError'
 import { AutoOperation } from './AutoOperation'
 import { queryClient } from './react-query-client'
-import { AutoQueryObjectParams, QueryObject } from './types'
+import { AutoQueryObjectParams, QueryObject, UseQueryObjectOptions } from './types'
 
 export class AutoQuery<Variables, Result> extends AutoOperation<Variables> implements QueryObject<Variables, Result> {
   /**
@@ -35,16 +35,16 @@ export class AutoQuery<Variables, Result> extends AutoOperation<Variables> imple
   #useQueryResult<T extends boolean>(
     suspense: T,
     ...args: Variables extends void
-      ? [options?: Omit<UseQueryOptions, 'queryFn' | 'queryKey'>]
-      : [variables: Variables, options?: Omit<UseQueryOptions, 'queryFn' | 'queryKey'>]
+      ? [options?: UseQueryObjectOptions<Result>]
+      : [variables: Variables, options?: UseQueryObjectOptions<Result>]
   ) {
     /* `this.fn` is a oazapfts function, i.e. it has arity 1 or 2. If it accepts variables, its arity is 2: the 1st parameter is the
     variables and the 2nd is the RequestOpts. If it doesn't accept variables, its arity is one: it accepts only the RequestOpts.
     We can use this information to determine what the type of `args` actually is at runtime. If variables are accepted, than the 1st
     argument is the variables and the 2nd is the query options, otherwise, it has a single argument, which is the query options. */
     const [variables, options] = this.fn.length > 1
-      ? args as [Variables, Omit<UseQueryOptions, 'queryFn' | 'queryKey'> | undefined]
-      : [undefined, args[0] as Omit<UseQueryOptions, 'queryFn' | 'queryKey'> | undefined]
+      ? args as [Variables, UseQueryObjectOptions<Result> | undefined]
+      : [undefined, args[0] as UseQueryObjectOptions<Result> | undefined]
     const use = suspense ? useSuspenseQuery : useQuery
     return use({
       ...options,
@@ -55,8 +55,8 @@ export class AutoQuery<Variables, Result> extends AutoOperation<Variables> imple
 
   useQuery(
     ...args: Variables extends void
-      ? [options?: Omit<UseQueryOptions, 'queryFn' | 'queryKey'>]
-      : [variables: Variables, options?: Omit<UseQueryOptions, 'queryFn' | 'queryKey'>]
+      ? [options?: UseQueryObjectOptions<Result>]
+      : [variables: Variables, options?: UseQueryObjectOptions<Result>]
   ) {
     const result = this.#useQueryResult(true, ...args)
     return result.data
@@ -64,8 +64,8 @@ export class AutoQuery<Variables, Result> extends AutoOperation<Variables> imple
 
   useStatefulQuery(
     ...args: Variables extends void
-      ? [options?: Omit<UseQueryOptions, 'queryFn' | 'queryKey'>]
-      : [variables: Variables, options?: Omit<UseQueryOptions, 'queryFn' | 'queryKey'>]
+      ? [options?: UseQueryObjectOptions<Result>]
+      : [variables: Variables, options?: UseQueryObjectOptions<Result>]
   ) {
     const result = this.#useQueryResult(false, ...args)
     return [result.data, result.isPending, result.error as StackspotAPIError | undefined, result] as const

package/src/network/ManualInfiniteQuery.ts

@@ -44,7 +44,7 @@ export class ManualInfiniteQuery<
     ).flat() as Accumulator extends keyof Result ? Result[Accumulator] : Result
   }
 
-  private useInfiniteQueryResult(suspense: boolean, variables = {} as Variables, options?: UseInfiniteQueryObjectOptions) {
+  private useInfiniteQueryResult(suspense: boolean, variables = {} as Variables, options?: UseInfiniteQueryObjectOptions<Result>) {
     variables = { ...variables, ...this.getConfig().defaultVariables }
     const use = suspense ? useSuspenseInfiniteQuery : useInfiniteQuery
     return use<any, any, any, any, any>({
@@ -59,7 +59,7 @@ export class ManualInfiniteQuery<
 
   useInfiniteQuery(
     variables?: Variables,
-    options?: UseInfiniteQueryObjectOptions,
+    options?: UseInfiniteQueryObjectOptions<Result>,
   ): [
     Accumulator extends keyof Result ? Result[Accumulator] : Result,
     UseInfiniteQueryResult<InfiniteData<Result>, StackspotAPIError>,
@@ -73,7 +73,7 @@ export class ManualInfiniteQuery<
 
   useStatefulInfiniteQuery(
     variables?: Variables,
-    options?: UseInfiniteQueryObjectOptions,
+    options?: UseInfiniteQueryObjectOptions<Result>,
   ): [
     Accumulator extends keyof Result ? Result[Accumulator] : Result,
     boolean,

package/src/network/ManualQuery.ts

@@ -1,10 +1,10 @@
 /* eslint-disable react-hooks/rules-of-hooks */
 
-import { DefinedUseQueryResult, UseQueryOptions, UseSuspenseQueryResult, useQuery, useSuspenseQuery } from '@tanstack/react-query'
+import { DefinedUseQueryResult, UseSuspenseQueryResult, useQuery, useSuspenseQuery } from '@tanstack/react-query'
 import { StackspotAPIError } from '../error/StackspotAPIError'
 import { ManualOperation } from './ManualOperation'
 import { queryClient } from './react-query-client'
-import { FullOperationConfig, QueryObject } from './types'
+import { FullOperationConfig, QueryObject, UseQueryObjectOptions } from './types'
 
 export class ManualQuery<
   Variables extends Record<string, any> | void,
@@ -51,8 +51,8 @@ export class ManualQuery<
   #useQueryResult<T extends boolean>(
     suspense: T,
     ...args: Variables extends void
-      ? [options?: Omit<UseQueryOptions, 'queryFn' | 'queryKey'>]
-      : [variables: Variables, options?: Omit<UseQueryOptions, 'queryFn' | 'queryKey'>]
+      ? [options?: UseQueryObjectOptions<Result>]
+      : [variables: Variables, options?: UseQueryObjectOptions<Result>]
   ) {
     /* `this.config.request` is a function with arity 1 or 2. If it accepts variables, its arity is 2: the 1st parameter is the
     AbortSignal and the 2nd is the variables. If it doesn't accept variables, its arity is one: it accepts only the AbortSignal.
@@ -69,8 +69,8 @@ export class ManualQuery<
 
   useQuery(
     ...args: Variables extends void
-      ? [options?: Omit<UseQueryOptions, 'queryFn' | 'queryKey'>]
-      : [variables: Variables, options?: Omit<UseQueryOptions, 'queryFn' | 'queryKey'>]
+      ? [options?: UseQueryObjectOptions<Result>]
+      : [variables: Variables, options?: UseQueryObjectOptions<Result>]
   ) {
     const result = this.#useQueryResult(false, ...args)
     return result.data
@@ -78,8 +78,8 @@ export class ManualQuery<
 
   useStatefulQuery(
     ...args: Variables extends void
-      ? [options?: Omit<UseQueryOptions, 'queryFn' | 'queryKey'>]
-      : [variables: Variables, options?: Omit<UseQueryOptions, 'queryFn' | 'queryKey'>]
+      ? [options?: UseQueryObjectOptions<Result>]
+      : [variables: Variables, options?: UseQueryObjectOptions<Result>]
   ) {
     const result = this.#useQueryResult(false, ...args)
     return [result.data, result.isPending, result.error as StackspotAPIError | undefined, result] as const

package/src/network/types.ts

@@ -144,6 +144,8 @@ export interface OperationObject<Variables> {
   cancel: (variables?: Partial<Variables>) => boolean,
 }
 
+export type UseQueryObjectOptions<Result> = Omit<UseQueryOptions<Result, StackspotAPIError>, 'queryFn' | 'queryKey'>
+
 export interface QueryObject<Variables, Result> extends OperationObject<Variables> {
   /**
    * Runs the query operation.
@@ -165,8 +167,8 @@ export interface QueryObject<Variables, Result> extends OperationObject<Variable
    */
   useQuery: (
     ...args: Variables extends void
-      ? [options?: Omit<UseQueryOptions, 'queryFn' | 'queryKey'>]
-      : [variables: Variables, options?: Omit<UseQueryOptions, 'queryFn' | 'queryKey'>]
+      ? [options?: UseQueryObjectOptions<Result>]
+      : [variables: Variables, options?: UseQueryObjectOptions<Result>]
   ) => Result | undefined,
   /**
    * Same as `query`, but a React Hook instead.
@@ -180,8 +182,8 @@ export interface QueryObject<Variables, Result> extends OperationObject<Variable
    */
   useStatefulQuery: (
     ...args: Variables extends void
-      ? [options?: Omit<UseQueryOptions, 'queryFn' | 'queryKey'>]
-      : [variables: Variables, options?: Omit<UseQueryOptions, 'queryFn' | 'queryKey'>]
+      ? [options?: UseQueryObjectOptions<Result>]
+      : [variables: Variables, options?: UseQueryObjectOptions<Result>]
   ) => Readonly<[Result | undefined, boolean, StackspotAPIError | null | undefined, UseQueryResult<Result, StackspotAPIError>]>,
   /**
    * Invalidates the cache for this query. A specific query can be invalidated by passing an argument (variables).
@@ -197,7 +199,10 @@ export interface QueryObject<Variables, Result> extends OperationObject<Variable
   getKey: (...args: Variables extends void ? [] : [variables?: Partial<Variables>]) => any[],
 }
 
-export type UseInfiniteQueryObjectOptions = Omit<UseInfiniteQueryOptions, 'queryFn' | 'queryKey' | 'getNextPageParam' | 'initialPageParam'>
+export type UseInfiniteQueryObjectOptions<Result> = Omit<
+  UseInfiniteQueryOptions<Result, StackspotAPIError>,
+  'queryFn' | 'queryKey' | 'getNextPageParam' | 'initialPageParam'
+>
 
 export interface InfiniteQueryObject<Variables, Result, Accumulator extends keyof Result | ''> extends QueryObject<Variables, Result> {
   /**
@@ -212,8 +217,8 @@ export interface InfiniteQueryObject<Variables, Result, Accumulator extends keyo
    */
   useInfiniteQuery: (
     ...args: Partial<Variables> extends Variables
-      ? [variables?: Variables, options?: UseInfiniteQueryObjectOptions]
-      : [variables: Variables, options?: UseInfiniteQueryObjectOptions]
+      ? [variables?: Variables, options?: UseInfiniteQueryObjectOptions<Result>]
+      : [variables: Variables, options?: UseInfiniteQueryObjectOptions<Result>]
   ) => Readonly<[
     (Accumulator extends keyof Result ? Result[Accumulator] : Result) | undefined,
     UseInfiniteQueryResult<InfiniteData<Result>, StackspotAPIError>,
@@ -232,8 +237,8 @@ export interface InfiniteQueryObject<Variables, Result, Accumulator extends keyo
    */
   useStatefulInfiniteQuery: (
     ...args: Partial<Variables> extends Variables
-      ? [variables?: Variables, options?: Omit<UseInfiniteQueryOptions, 'queryFn' | 'queryKey' | 'getNextPageParam' | 'initialPageParam'>]
-      : [variables: Variables, options?: Omit<UseInfiniteQueryOptions, 'queryFn' | 'queryKey' | 'getNextPageParam' | 'initialPageParam'>]
+      ? [variables?: Variables, options?: UseInfiniteQueryObjectOptions<Result>]
+      : [variables: Variables, options?: UseInfiniteQueryObjectOptions<Result>]
   ) => Readonly<[
     (Accumulator extends keyof Result ? Result[Accumulator] : Result) | undefined,
     boolean,
@@ -277,3 +282,11 @@ export interface MutationObject<Variables, Result> extends OperationObject<Varia
       UseMutationResult<Result, StackspotAPIError, Variables>,
     ]>,
 }
+
+export type OperationVariables<T extends Pick<OperationObject<any>, 'cancel'>> = T extends Pick<OperationObject<infer R>, 'cancel'>
+  ? R
+  : never
+export type OperationResult<T extends { query: (variables?: any) => Promise<any> } | { mutate: (variables?: any) => Promise<any> }> = 
+  T extends { query: (variables?: any) => Promise<infer R> } ? R : (
+    T extends { mutate: (variables?: any) => Promise<infer R> } ? R : never
+  )