@harnessio/react-dbops-service-client 0.15.0 → 0.17.0

package/dist/dbops-service/src/services/hooks/useV1ChangesetYamlProjDbInstanceMutation.d.ts

@@ -0,0 +1,38 @@
+import { UseMutationOptions } from '@tanstack/react-query';
+import type { ChangeSetDeploymentYamlResponseResponse } from '../responses/ChangeSetDeploymentYamlResponseResponse';
+import type { ErrorResponseResponse } from '../responses/ErrorResponseResponse';
+import type { ChangeSetDeploymentYamlGetRequestRequestBody } from '../requestBodies/ChangeSetDeploymentYamlGetRequestRequestBody';
+import type { ResponseWithPagination } from '../helpers';
+import { FetcherOptions } from '../../../../fetcher/index.js';
+export interface V1ChangesetYamlProjDbInstanceMutationPathParams {
+    org: string;
+    project: string;
+    dbschema: string;
+    dbinstance: string;
+}
+export interface V1ChangesetYamlProjDbInstanceMutationQueryParams {
+    /**
+     * @format int64
+     * @default 0
+     */
+    page?: number;
+    /**
+     * @default 10
+     */
+    limit?: number;
+}
+export interface V1ChangesetYamlProjDbInstanceMutationHeaderParams {
+    'Harness-Account'?: string;
+}
+export type V1ChangesetYamlProjDbInstanceRequestBody = ChangeSetDeploymentYamlGetRequestRequestBody;
+export type V1ChangesetYamlProjDbInstanceOkResponse = ResponseWithPagination<ChangeSetDeploymentYamlResponseResponse>;
+export type V1ChangesetYamlProjDbInstanceErrorResponse = ErrorResponseResponse;
+export interface V1ChangesetYamlProjDbInstanceProps extends V1ChangesetYamlProjDbInstanceMutationPathParams, Omit<FetcherOptions<V1ChangesetYamlProjDbInstanceMutationQueryParams, V1ChangesetYamlProjDbInstanceRequestBody, V1ChangesetYamlProjDbInstanceMutationHeaderParams>, 'url'> {
+    queryParams: V1ChangesetYamlProjDbInstanceMutationQueryParams;
+    body: V1ChangesetYamlProjDbInstanceRequestBody;
+}
+export declare function v1ChangesetYamlProjDbInstance(props: V1ChangesetYamlProjDbInstanceProps): Promise<V1ChangesetYamlProjDbInstanceOkResponse>;
+/**
+ * ChangeSet deployment yaml for an instance
+ */
+export declare function useV1ChangesetYamlProjDbInstanceMutation(options?: Omit<UseMutationOptions<V1ChangesetYamlProjDbInstanceOkResponse, V1ChangesetYamlProjDbInstanceErrorResponse, V1ChangesetYamlProjDbInstanceProps>, 'mutationKey' | 'mutationFn'>): import("@tanstack/react-query").UseMutationResult<V1ChangesetYamlProjDbInstanceOkResponse, import("..").Error, V1ChangesetYamlProjDbInstanceProps, unknown>;

package/dist/dbops-service/src/services/hooks/useV1ChangesetYamlProjDbInstanceMutation.js

@@ -0,0 +1,14 @@
+/* eslint-disable */
+// This code is autogenerated using @harnessio/oats-cli.
+// Please do not modify this code directly.
+import { useMutation } from '@tanstack/react-query';
+import { fetcher } from '../../../../fetcher/index.js';
+export function v1ChangesetYamlProjDbInstance(props) {
+    return fetcher(Object.assign({ url: `/v1/orgs/${props.org}/projects/${props.project}/dbschema/${props.dbschema}/dbinstance/${props.dbinstance}/changeset/yaml`, method: 'POST' }, props));
+}
+/**
+ * ChangeSet deployment yaml for an instance
+ */
+export function useV1ChangesetYamlProjDbInstanceMutation(options) {
+    return useMutation((mutateProps) => v1ChangesetYamlProjDbInstance(mutateProps), options);
+}

package/dist/dbops-service/src/services/index.d.ts

@@ -3,6 +3,8 @@ export type { ConsumeV1StepPluginResponseErrorResponse, ConsumeV1StepPluginRespo
 export { consumeV1StepPluginResponse, useConsumeV1StepPluginResponseMutation, } from './hooks/useConsumeV1StepPluginResponseMutation';
 export type { CreateV1StepPluginInputsErrorResponse, CreateV1StepPluginInputsOkResponse, CreateV1StepPluginInputsProps, CreateV1StepPluginInputsRequestBody, } from './hooks/useCreateV1StepPluginInputsMutation';
 export { createV1StepPluginInputs, useCreateV1StepPluginInputsMutation, } from './hooks/useCreateV1StepPluginInputsMutation';
+export type { V1ChangesetYamlProjDbInstanceErrorResponse, V1ChangesetYamlProjDbInstanceMutationPathParams, V1ChangesetYamlProjDbInstanceMutationQueryParams, V1ChangesetYamlProjDbInstanceOkResponse, V1ChangesetYamlProjDbInstanceProps, V1ChangesetYamlProjDbInstanceRequestBody, } from './hooks/useV1ChangesetYamlProjDbInstanceMutation';
+export { useV1ChangesetYamlProjDbInstanceMutation, v1ChangesetYamlProjDbInstance, } from './hooks/useV1ChangesetYamlProjDbInstanceMutation';
 export type { V1CreateProjDbSchemaInstanceErrorResponse, V1CreateProjDbSchemaInstanceMutationPathParams, V1CreateProjDbSchemaInstanceOkResponse, V1CreateProjDbSchemaInstanceProps, V1CreateProjDbSchemaInstanceRequestBody, } from './hooks/useV1CreateProjDbSchemaInstanceMutation';
 export { useV1CreateProjDbSchemaInstanceMutation, v1CreateProjDbSchemaInstance, } from './hooks/useV1CreateProjDbSchemaInstanceMutation';
 export type { V1CreateProjDbSchemaErrorResponse, V1CreateProjDbSchemaMutationPathParams, V1CreateProjDbSchemaOkResponse, V1CreateProjDbSchemaProps, V1CreateProjDbSchemaRequestBody, } from './hooks/useV1CreateProjDbSchemaMutation';
@@ -49,6 +51,7 @@ export type { V2ListProjDbInstancesErrorResponse, V2ListProjDbInstancesMutationP
 export { useV2ListProjDbInstancesMutation, v2ListProjDbInstances, } from './hooks/useV2ListProjDbInstancesMutation';
 export type { V2ListProjDbSchemaErrorResponse, V2ListProjDbSchemaMutationPathParams, V2ListProjDbSchemaMutationQueryParams, V2ListProjDbSchemaOkResponse, V2ListProjDbSchemaProps, V2ListProjDbSchemaRequestBody, } from './hooks/useV2ListProjDbSchemaMutation';
 export { useV2ListProjDbSchemaMutation, v2ListProjDbSchema, } from './hooks/useV2ListProjDbSchemaMutation';
+export type { ChangeSetDeploymentYamlGetRequestRequestBody } from './requestBodies/ChangeSetDeploymentYamlGetRequestRequestBody';
 export type { ConsumePluginRespRequestRequestBody } from './requestBodies/ConsumePluginRespRequestRequestBody';
 export type { DbInstanceCreateRequestRequestBody } from './requestBodies/DbInstanceCreateRequestRequestBody';
 export type { DbInstanceFilterRequestRequestBody } from './requestBodies/DbInstanceFilterRequestRequestBody';
@@ -61,6 +64,7 @@ export type { ExecutionConfigUpdateRequestRequestBody } from './requestBodies/Ex
 export type { LogIngestRequestRequestBody } from './requestBodies/LogIngestRequestRequestBody';
 export type { MigrationStateGetRequestRequestBody } from './requestBodies/MigrationStateGetRequestRequestBody';
 export type { PluginStepInputsRequestRequestBody } from './requestBodies/PluginStepInputsRequestRequestBody';
+export type { ChangeSetDeploymentYamlResponseResponse } from './responses/ChangeSetDeploymentYamlResponseResponse';
 export type { DbInstanceListResponseResponse } from './responses/DbInstanceListResponseResponse';
 export type { DbInstanceResponseResponse } from './responses/DbInstanceResponseResponse';
 export type { DbSchemaListResponseResponse } from './responses/DbSchemaListResponseResponse';
@@ -75,6 +79,8 @@ export type { ParsedLogResponseResponse } from './responses/ParsedLogResponseRes
 export type { PluginInputsResponseResponse } from './responses/PluginInputsResponseResponse';
 export type { ChangeLogScript } from './schemas/ChangeLogScript';
 export type { ChangeSetDeploymentStatus } from './schemas/ChangeSetDeploymentStatus';
+export type { ChangeSetDeploymentYamlInput } from './schemas/ChangeSetDeploymentYamlInput';
+export type { ChangeSetDeploymentYamlOutput } from './schemas/ChangeSetDeploymentYamlOutput';
 export type { Changelog } from './schemas/Changelog';
 export type { Command } from './schemas/Command';
 export type { CommandExecutionStatus } from './schemas/CommandExecutionStatus';

package/dist/dbops-service/src/services/index.js

@@ -1,5 +1,6 @@
 export { consumeV1StepPluginResponse, useConsumeV1StepPluginResponseMutation, } from './hooks/useConsumeV1StepPluginResponseMutation';
 export { createV1StepPluginInputs, useCreateV1StepPluginInputsMutation, } from './hooks/useCreateV1StepPluginInputsMutation';
+export { useV1ChangesetYamlProjDbInstanceMutation, v1ChangesetYamlProjDbInstance, } from './hooks/useV1ChangesetYamlProjDbInstanceMutation';
 export { useV1CreateProjDbSchemaInstanceMutation, v1CreateProjDbSchemaInstance, } from './hooks/useV1CreateProjDbSchemaInstanceMutation';
 export { useV1CreateProjDbSchemaMutation, v1CreateProjDbSchema, } from './hooks/useV1CreateProjDbSchemaMutation';
 export { useV1DeleteExecutionConfigMutation, v1DeleteExecutionConfig, } from './hooks/useV1DeleteExecutionConfigMutation';

package/dist/dbops-service/src/services/requestBodies/ChangeSetDeploymentYamlGetRequestRequestBody.d.ts

@@ -0,0 +1,2 @@
+import type { ChangeSetDeploymentYamlInput } from '../schemas/ChangeSetDeploymentYamlInput';
+export type ChangeSetDeploymentYamlGetRequestRequestBody = ChangeSetDeploymentYamlInput;

package/dist/dbops-service/src/services/requestBodies/ChangeSetDeploymentYamlGetRequestRequestBody.js

@@ -0,0 +1 @@
+export {};

package/dist/dbops-service/src/services/requestBodies/ConsumePluginRespRequestRequestBody.d.ts

@@ -2,6 +2,10 @@ import type { Command } from '../schemas/Command';
 import type { CommandExecutionStatus } from '../schemas/CommandExecutionStatus';
 export interface ConsumePluginRespRequestRequestBody {
     command: Command;
+    /**
+     * compressed step output
+     */
+    compressedStepOutput?: string;
     /**
      * Data associated with command execution
      */

package/dist/dbops-service/src/services/responses/ChangeSetDeploymentYamlResponseResponse.d.ts

@@ -0,0 +1,2 @@
+import type { ChangeSetDeploymentYamlOutput } from '../schemas/ChangeSetDeploymentYamlOutput';
+export type ChangeSetDeploymentYamlResponseResponse = ChangeSetDeploymentYamlOutput;

package/dist/dbops-service/src/services/responses/ChangeSetDeploymentYamlResponseResponse.js

@@ -0,0 +1 @@
+export {};

package/dist/dbops-service/src/services/schemas/ChangeSetDeploymentYamlInput.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Get changeSet deployment yaml request input
+ */
+export interface ChangeSetDeploymentYamlInput {
+    /**
+     * fqn of changeSet deployed
+     */
+    changeSetFQN: string;
+    /**
+     * identifier of the db instance
+     */
+    instanceIdentifier: string;
+    /**
+     * identifer of the db schema
+     */
+    schemaIdentifier: string;
+}

package/dist/dbops-service/src/services/schemas/ChangeSetDeploymentYamlInput.js

@@ -0,0 +1,4 @@
+/* eslint-disable */
+// This code is autogenerated using @harnessio/oats-cli.
+// Please do not modify this code directly.
+export {};

package/dist/dbops-service/src/services/schemas/ChangeSetDeploymentYamlOutput.d.ts

@@ -0,0 +1,6 @@
+/**
+ * ChangeSet deployment yaml info for an instance
+ */
+export interface ChangeSetDeploymentYamlOutput {
+    yaml?: string;
+}

package/dist/dbops-service/src/services/schemas/ChangeSetDeploymentYamlOutput.js

@@ -0,0 +1,4 @@
+/* eslint-disable */
+// This code is autogenerated using @harnessio/oats-cli.
+// Please do not modify this code directly.
+export {};

package/dist/dbops-service/src/services/schemas/Command.d.ts

@@ -1,4 +1,4 @@
 /**
  * Type of the plugin command to run
  */
-export type Command = 'Clone' | 'Custom' | 'History' | 'ParentWrapper' | 'Rollback' | 'RollbackSQL' | 'Tag' | 'Update' | 'UpdateSQL' | 'Validate';
+export type Command = 'Clone' | 'Custom' | 'History' | 'ParentWrapper' | 'Rollback' | 'RollbackSQL' | 'Status' | 'Tag' | 'Update' | 'UpdateSQL' | 'Validate';

package/dist/dbops-service/src/services/schemas/DeployedStateOutput.d.ts

@@ -8,6 +8,10 @@ export interface DeployedStateOutput {
     author: string;
     changeSetId: string;
     command: Command;
+    /**
+     * comment in changeset definition
+     */
+    comment?: string;
     /**
      * @format int64
      */
@@ -17,6 +21,10 @@ export interface DeployedStateOutput {
      */
     deployedInCurrentExecution: boolean;
     fileName: string;
+    /**
+     * label in changeset definition
+     */
+    label?: string;
     metadata: ExecutionMetadata;
     status: CommandExecutionStatus;
     tag?: string;

package/dist/dbops-service/src/services/schemas/InstanceMigrationStateChangeSet.d.ts

@@ -21,6 +21,9 @@ export interface InstanceMigrationStateChangeSet {
      * label defined in changeSet
      */
     label?: string;
+    pipeline: string;
+    planExecutionId: string;
+    stageExecutionId: string;
     status: ChangeSetDeploymentStatus;
     tag?: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@harnessio/react-dbops-service-client",
-  "version": "0.15.0",
+  "version": "0.17.0",
   "description": "Harness React DB Devops service client - DB Devops APIs integrated with react hooks",
   "author": "Harness Inc",
   "license": "MIT",