@stack-spot/portal-network 0.6.0 → 0.8.0

package/src/client/secrets.ts

@@ -0,0 +1,56 @@
+import { HttpError } from '@oazapfts/runtime'
+
+import { createKey, defaults, deleteKey, deleteSecretValue, editKey, getAll1, getAvailability, updateSecretValue } from '../api/secrets'
+import apis from '../apis.json'
+import { DefaultAPIError } from '../error/DefaultAPIError'
+import { secretsDictionary } from '../error/dictionary/secrets'
+import { StackspotAPIError } from '../error/StackspotAPIError'
+import { ReactQueryNetworkClient } from '../network/ReactQueryNetworkClient'
+
+class SecretClient extends ReactQueryNetworkClient {
+  constructor() {
+    super(apis.secrets.url, defaults)
+  }
+
+  protected buildStackSpotError(error: HttpError): StackspotAPIError {
+    return new DefaultAPIError(error.data, error.status, secretsDictionary, error.headers)
+  }
+
+  /**
+   * Create a key
+   */
+  createKey = this.mutation(createKey)
+  
+  /**
+   * Get all keys
+   */
+  getAllKeys = this.query(getAll1)
+
+  /**
+   * Delete a key
+   */
+  deleteKey = this.mutation(deleteKey)
+
+  /**
+   * Update a key's description
+   */
+  updateKey = this.mutation(editKey)
+
+  /**
+   * Get which secrets are defined or undefined for a user
+   */
+  getAvailability = this.query(getAvailability)
+    
+  /**
+   * Update a secret's value
+   */
+  updateSecretValue = this.mutation(updateSecretValue)
+
+  /**
+   * Delete a secret's value
+   */
+  deleteSecretValue = this.mutation(deleteSecretValue)
+
+}
+
+export const secretsClient = new SecretClient()

package/src/client/types.ts

@@ -0,0 +1,44 @@
+import { AccountScmInfoSaveRequest, AccountScmInfoUpdateRequest, AccountScmStatusResponse } from '../api/account'
+
+interface BaseSMCStatus {
+  /**
+   * Indicates the current status of the SCM credential.
+   * - 'valid': the SCM credential is valid.
+   * - 'missing-account': the SCM credential is not configured at the account level.
+   * - 'missing-user': the SCM credential is configured at the account level, but the SCM access is not configured for the user.
+   */
+  status: 'missing-account' | 'missing-user' | 'valid',
+}
+
+interface ValidSCMStatus extends BaseSMCStatus, AccountScmStatusResponse {
+  status: 'valid',
+}
+
+interface InvalidSCMStatus extends BaseSMCStatus {
+  status: 'missing-account' | 'missing-user',
+}
+
+export type SCMStatus = InvalidSCMStatus | ValidSCMStatus
+
+interface SCMAuthPATValue {
+  user: string,
+  pass: string,
+}
+
+interface SCMAuthGitValue {
+  appId: string,
+  installationId: string,
+  privateKey: string,
+}
+
+export interface CreateSCMRequest {
+  accountScmInfoSaveRequest: AccountScmInfoSaveRequest & {
+    value: SCMAuthGitValue | SCMAuthPATValue,
+  },
+}
+
+export interface UpdateSCMRequest {
+  accountScmInfoUpdateRequest: AccountScmInfoUpdateRequest & {
+    value?: SCMAuthGitValue | SCMAuthPATValue,
+  },
+}

package/src/error/dictionary/secrets.ts

@@ -0,0 +1,14 @@
+import { Dictionary } from '@stack-spot/portal-translate'
+
+export const secretsDictionary = {
+  en: {
+    WSA_SECRET_KEY_ALREADY_EXISTS: 'Secret Key already exists.',
+    WSA_SECRET_KEY_NOT_FOUND: 'Secret Key not found.',
+    WSA_SECRET_VALUE_NOT_FOUND: 'Secret Value not found.',
+  },
+  pt: {
+    WSA_SECRET_KEY_ALREADY_EXISTS: 'Secret Key já existe.',
+    WSA_SECRET_KEY_NOT_FOUND: 'Secret Key não encontrada.',
+    WSA_SECRET_VALUE_NOT_FOUND: 'Valor da Secret não encontrado.',
+  },
+} satisfies Dictionary

package/src/index.ts

@@ -1,4 +1,6 @@
 export { accountClient } from './client/account'
+export { secretsClient } from './client/secrets'
+export * from './client/types'
 export { workspaceClient } from './client/workspace'
 export { DefaultAPIError } from './error/DefaultAPIError'
 export { StackspotAPIError } from './error/StackspotAPIError'