@harnessio/react-dbops-service-client 0.28.0 → 0.29.0

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

@@ -0,0 +1,20 @@
+import { UseMutationOptions } from '@tanstack/react-query';
+import type { FlywayPluginInputsResponseResponse } from '../responses/FlywayPluginInputsResponseResponse';
+import type { ErrorResponseResponse } from '../responses/ErrorResponseResponse';
+import type { FlywayPluginInputsRequestRequestBody } from '../requestBodies/FlywayPluginInputsRequestRequestBody';
+import type { ResponseWithPagination } from '../helpers';
+import { FetcherOptions } from '../../../../fetcher/index.js';
+export interface CreateV1FlywayPluginInputsMutationHeaderParams {
+    'Harness-Account'?: string;
+}
+export type CreateV1FlywayPluginInputsRequestBody = FlywayPluginInputsRequestRequestBody;
+export type CreateV1FlywayPluginInputsOkResponse = ResponseWithPagination<FlywayPluginInputsResponseResponse>;
+export type CreateV1FlywayPluginInputsErrorResponse = ErrorResponseResponse;
+export interface CreateV1FlywayPluginInputsProps extends Omit<FetcherOptions<unknown, CreateV1FlywayPluginInputsRequestBody, CreateV1FlywayPluginInputsMutationHeaderParams>, 'url'> {
+    body: CreateV1FlywayPluginInputsRequestBody;
+}
+export declare function createV1FlywayPluginInputs(props: CreateV1FlywayPluginInputsProps): Promise<CreateV1FlywayPluginInputsOkResponse>;
+/**
+ * Create Flyway Plugin Inputs using Step Inputs
+ */
+export declare function useCreateV1FlywayPluginInputsMutation(options?: Omit<UseMutationOptions<CreateV1FlywayPluginInputsOkResponse, CreateV1FlywayPluginInputsErrorResponse, CreateV1FlywayPluginInputsProps>, 'mutationKey' | 'mutationFn'>): import("@tanstack/react-query").UseMutationResult<CreateV1FlywayPluginInputsOkResponse, import("..").Error, CreateV1FlywayPluginInputsProps, unknown>;

package/dist/dbops-service/src/services/hooks/useCreateV1FlywayPluginInputsMutation.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 createV1FlywayPluginInputs(props) {
+    return fetcher(Object.assign({ url: `/v1/step/flyway/plugin-inputs`, method: 'POST' }, props));
+}
+/**
+ * Create Flyway Plugin Inputs using Step Inputs
+ */
+export function useCreateV1FlywayPluginInputsMutation(options) {
+    return useMutation((mutateProps) => createV1FlywayPluginInputs(mutateProps), options);
+}

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

@@ -3,13 +3,29 @@ import type { ErrorResponseResponse } from '../responses/ErrorResponseResponse';
 import type { DbSnapshotMetadataCreateRequestRequestBody } from '../requestBodies/DbSnapshotMetadataCreateRequestRequestBody';
 import type { ResponseWithPagination } from '../helpers';
 import { FetcherOptions } from '../../../../fetcher/index.js';
+export interface PostV1DbopsDbSnapshotMetadataMutationPathParams {
+    snapshotId: string;
+}
+export interface PostV1DbopsDbSnapshotMetadataMutationQueryParams {
+    /**
+     * @example "Update"
+     */
+    harnessCommand: 'DBOPSRollbackCountSQL' | 'DBOPSRollbackSQL' | 'DBOPSSnapshot' | 'DBOPSUpdateSQL' | 'Rollback' | 'Update';
+    pipelineExecutionId: string;
+    stageExecutionId: string;
+    pipelineIdentifier: string;
+    dbInstance: string;
+    dbSchema: string;
+    parentId: string;
+}
 export interface PostV1DbopsDbSnapshotMetadataMutationHeaderParams {
     'Harness-Account'?: string;
 }
 export type PostV1DbopsDbSnapshotMetadataRequestBody = DbSnapshotMetadataCreateRequestRequestBody;
 export type PostV1DbopsDbSnapshotMetadataOkResponse = ResponseWithPagination<unknown>;
 export type PostV1DbopsDbSnapshotMetadataErrorResponse = ErrorResponseResponse;
-export interface PostV1DbopsDbSnapshotMetadataProps extends Omit<FetcherOptions<unknown, PostV1DbopsDbSnapshotMetadataRequestBody, PostV1DbopsDbSnapshotMetadataMutationHeaderParams>, 'url'> {
+export interface PostV1DbopsDbSnapshotMetadataProps extends PostV1DbopsDbSnapshotMetadataMutationPathParams, Omit<FetcherOptions<PostV1DbopsDbSnapshotMetadataMutationQueryParams, PostV1DbopsDbSnapshotMetadataRequestBody, PostV1DbopsDbSnapshotMetadataMutationHeaderParams>, 'url'> {
+    queryParams: PostV1DbopsDbSnapshotMetadataMutationQueryParams;
     body: PostV1DbopsDbSnapshotMetadataRequestBody;
 }
 export declare function postV1DbopsDbSnapshotMetadata(props: PostV1DbopsDbSnapshotMetadataProps): Promise<PostV1DbopsDbSnapshotMetadataOkResponse>;

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

@@ -4,7 +4,7 @@
 import { useMutation } from '@tanstack/react-query';
 import { fetcher } from '../../../../fetcher/index.js';
 export function postV1DbopsDbSnapshotMetadata(props) {
-    return fetcher(Object.assign({ url: `/v1/dbops/db-metadata`, method: 'POST' }, props));
+    return fetcher(Object.assign({ url: `/v1/dbops/db-metadata/${props.snapshotId}`, method: 'POST' }, props));
 }
 /**
  * Sending DB snapshot metadata from plugin to capture current state

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

@@ -0,0 +1,35 @@
+import { UseMutationOptions } from '@tanstack/react-query';
+import type { ErrorResponseResponse } from '../responses/ErrorResponseResponse';
+import type { ResponseWithPagination } from '../helpers';
+import { FetcherOptions } from '../../../../fetcher/index.js';
+export interface PostV1DbopsMetadataSnapshotMutationPathParams {
+    snapshotId: string;
+}
+export interface PostV1DbopsMetadataSnapshotMutationQueryParams {
+    /**
+     * @example "Update"
+     */
+    harnessCommand: 'DBOPSRollbackCountSQL' | 'DBOPSRollbackSQL' | 'DBOPSSnapshot' | 'DBOPSUpdateSQL' | 'Rollback' | 'Update';
+    pipelineExecutionId: string;
+    stageExecutionId: string;
+    pipelineIdentifier: string;
+    dbInstance: string;
+    dbSchema: string;
+    parentId: string;
+}
+export interface PostV1DbopsMetadataSnapshotMutationHeaderParams {
+    'Harness-Account'?: string;
+    'X-Checksum-Sha256'?: string;
+}
+export type PostV1DbopsMetadataSnapshotRequestBody = string;
+export type PostV1DbopsMetadataSnapshotOkResponse = ResponseWithPagination<unknown>;
+export type PostV1DbopsMetadataSnapshotErrorResponse = ErrorResponseResponse;
+export interface PostV1DbopsMetadataSnapshotProps extends PostV1DbopsMetadataSnapshotMutationPathParams, Omit<FetcherOptions<PostV1DbopsMetadataSnapshotMutationQueryParams, PostV1DbopsMetadataSnapshotRequestBody, PostV1DbopsMetadataSnapshotMutationHeaderParams>, 'url'> {
+    queryParams: PostV1DbopsMetadataSnapshotMutationQueryParams;
+    body: PostV1DbopsMetadataSnapshotRequestBody;
+}
+export declare function postV1DbopsMetadataSnapshot(props: PostV1DbopsMetadataSnapshotProps): Promise<PostV1DbopsMetadataSnapshotOkResponse>;
+/**
+ * Sending DB snapshot file from plugin to harness for capturing current state
+ */
+export declare function usePostV1DbopsMetadataSnapshotMutation(options?: Omit<UseMutationOptions<PostV1DbopsMetadataSnapshotOkResponse, PostV1DbopsMetadataSnapshotErrorResponse, PostV1DbopsMetadataSnapshotProps>, 'mutationKey' | 'mutationFn'>): import("@tanstack/react-query").UseMutationResult<PostV1DbopsMetadataSnapshotOkResponse, import("..").Error, PostV1DbopsMetadataSnapshotProps, unknown>;

package/dist/dbops-service/src/services/hooks/usePostV1DbopsMetadataSnapshotMutation.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 postV1DbopsMetadataSnapshot(props) {
+    return fetcher(Object.assign({ url: `/v1/dbops/metadata-snapshot/${props.snapshotId}`, method: 'POST' }, props));
+}
+/**
+ * Sending DB snapshot file from plugin to harness for capturing current state
+ */
+export function usePostV1DbopsMetadataSnapshotMutation(options) {
+    return useMutation((mutateProps) => postV1DbopsMetadataSnapshot(mutateProps), options);
+}

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

@@ -13,7 +13,7 @@ export interface V1ChangesetmetadataProjDbInstanceQueryQueryParams {
     /**
      * @example "Update"
      */
-    harnessCommand: 'DBOPSRollbackCountSQL' | 'DBOPSRollbackSQL' | 'DBOPSUpdateSQL' | 'Rollback' | 'Update';
+    harnessCommand: 'DBOPSRollbackCountSQL' | 'DBOPSRollbackSQL' | 'DBOPSSnapshot' | 'DBOPSUpdateSQL' | 'Rollback' | 'Update';
     pipelineExecutionId: string;
     stageExecutionId: string;
     /**

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

@@ -5,14 +5,18 @@ export type { ConsumeV1StepPluginOutputResponseErrorResponse, ConsumeV1StepPlugi
 export { consumeV1StepPluginOutputResponse, useConsumeV1StepPluginOutputResponseMutation, } from './hooks/useConsumeV1StepPluginOutputResponseMutation';
 export type { ConsumeV1StepPluginResponseErrorResponse, ConsumeV1StepPluginResponseOkResponse, ConsumeV1StepPluginResponseProps, ConsumeV1StepPluginResponseRequestBody, } from './hooks/useConsumeV1StepPluginResponseMutation';
 export { consumeV1StepPluginResponse, useConsumeV1StepPluginResponseMutation, } from './hooks/useConsumeV1StepPluginResponseMutation';
+export type { CreateV1FlywayPluginInputsErrorResponse, CreateV1FlywayPluginInputsOkResponse, CreateV1FlywayPluginInputsProps, CreateV1FlywayPluginInputsRequestBody, } from './hooks/useCreateV1FlywayPluginInputsMutation';
+export { createV1FlywayPluginInputs, useCreateV1FlywayPluginInputsMutation, } from './hooks/useCreateV1FlywayPluginInputsMutation';
 export type { CreateV1StepPluginInputsErrorResponse, CreateV1StepPluginInputsOkResponse, CreateV1StepPluginInputsProps, CreateV1StepPluginInputsRequestBody, } from './hooks/useCreateV1StepPluginInputsMutation';
 export { createV1StepPluginInputs, useCreateV1StepPluginInputsMutation, } from './hooks/useCreateV1StepPluginInputsMutation';
 export type { GetV1CustomOperationsErrorResponse, GetV1CustomOperationsOkResponse, GetV1CustomOperationsProps, GetV1CustomOperationsRequestBody, } from './hooks/useGetV1CustomOperationsMutation';
 export { getV1CustomOperations, useGetV1CustomOperationsMutation, } from './hooks/useGetV1CustomOperationsMutation';
 export type { GetV1SchemaInstanceMetadataErrorResponse, GetV1SchemaInstanceMetadataOkResponse, GetV1SchemaInstanceMetadataProps, GetV1SchemaInstanceMetadataRequestBody, } from './hooks/useGetV1SchemaInstanceMetadataMutation';
 export { getV1SchemaInstanceMetadata, useGetV1SchemaInstanceMetadataMutation, } from './hooks/useGetV1SchemaInstanceMetadataMutation';
-export type { PostV1DbopsDbSnapshotMetadataErrorResponse, PostV1DbopsDbSnapshotMetadataOkResponse, PostV1DbopsDbSnapshotMetadataProps, PostV1DbopsDbSnapshotMetadataRequestBody, } from './hooks/usePostV1DbopsDbSnapshotMetadataMutation';
+export type { PostV1DbopsDbSnapshotMetadataErrorResponse, PostV1DbopsDbSnapshotMetadataMutationPathParams, PostV1DbopsDbSnapshotMetadataMutationQueryParams, PostV1DbopsDbSnapshotMetadataOkResponse, PostV1DbopsDbSnapshotMetadataProps, PostV1DbopsDbSnapshotMetadataRequestBody, } from './hooks/usePostV1DbopsDbSnapshotMetadataMutation';
 export { postV1DbopsDbSnapshotMetadata, usePostV1DbopsDbSnapshotMetadataMutation, } from './hooks/usePostV1DbopsDbSnapshotMetadataMutation';
+export type { PostV1DbopsMetadataSnapshotErrorResponse, PostV1DbopsMetadataSnapshotMutationPathParams, PostV1DbopsMetadataSnapshotMutationQueryParams, PostV1DbopsMetadataSnapshotOkResponse, PostV1DbopsMetadataSnapshotProps, PostV1DbopsMetadataSnapshotRequestBody, } from './hooks/usePostV1DbopsMetadataSnapshotMutation';
+export { postV1DbopsMetadataSnapshot, usePostV1DbopsMetadataSnapshotMutation, } from './hooks/usePostV1DbopsMetadataSnapshotMutation';
 export type { V1ChangesetYamlProjDbInstanceErrorResponse, V1ChangesetYamlProjDbInstanceOkResponse, V1ChangesetYamlProjDbInstanceProps, V1ChangesetYamlProjDbInstanceQueryPathParams, V1ChangesetYamlProjDbInstanceQueryQueryParams, } from './hooks/useV1ChangesetYamlProjDbInstanceQuery';
 export { useV1ChangesetYamlProjDbInstanceQuery, v1ChangesetYamlProjDbInstance, } from './hooks/useV1ChangesetYamlProjDbInstanceQuery';
 export type { V1ChangesetmetadataProjDbInstanceErrorResponse, V1ChangesetmetadataProjDbInstanceOkResponse, V1ChangesetmetadataProjDbInstanceProps, V1ChangesetmetadataProjDbInstanceQueryPathParams, V1ChangesetmetadataProjDbInstanceQueryQueryParams, } from './hooks/useV1ChangesetmetadataProjDbInstanceQuery';
@@ -85,6 +89,7 @@ export type { DbSnapshotMetadataCreateRequestRequestBody } from './requestBodies
 export type { ExecutionConfigUpdateRequestRequestBody } from './requestBodies/ExecutionConfigUpdateRequestRequestBody';
 export type { FailureInterruptRequestRequestBody } from './requestBodies/FailureInterruptRequestRequestBody';
 export type { FetchSqlStatementRequestRequestBody } from './requestBodies/FetchSqlStatementRequestRequestBody';
+export type { FlywayPluginInputsRequestRequestBody } from './requestBodies/FlywayPluginInputsRequestRequestBody';
 export type { LogIngestRequestRequestBody } from './requestBodies/LogIngestRequestRequestBody';
 export type { MigrationStateGetRequestRequestBody } from './requestBodies/MigrationStateGetRequestRequestBody';
 export type { PluginStepInputsRequestRequestBody } from './requestBodies/PluginStepInputsRequestRequestBody';
@@ -100,6 +105,7 @@ export type { ErrorResponseResponse } from './responses/ErrorResponseResponse';
 export type { ExecutionConfigSuccessResponseResponse } from './responses/ExecutionConfigSuccessResponseResponse';
 export type { ExecutionConfigTagsResponseResponse } from './responses/ExecutionConfigTagsResponseResponse';
 export type { FetchSqlStatementResponseResponse } from './responses/FetchSqlStatementResponseResponse';
+export type { FlywayPluginInputsResponseResponse } from './responses/FlywayPluginInputsResponseResponse';
 export type { InstanceMigrationStateResponseResponse } from './responses/InstanceMigrationStateResponseResponse';
 export type { MigrationStateResponseResponse } from './responses/MigrationStateResponseResponse';
 export type { OverviewResponseResponse } from './responses/OverviewResponseResponse';
@@ -135,6 +141,7 @@ export type { Error } from './schemas/Error';
 export type { ExecutionConfigOperation } from './schemas/ExecutionConfigOperation';
 export type { ExecutionConfigTags } from './schemas/ExecutionConfigTags';
 export type { ExecutionMetadata } from './schemas/ExecutionMetadata';
+export type { FlywayCommand } from './schemas/FlywayCommand';
 export type { InstanceDetail } from './schemas/InstanceDetail';
 export type { InstanceMigrationStateChangeSet } from './schemas/InstanceMigrationStateChangeSet';
 export type { InstanceMigrationStateOut } from './schemas/InstanceMigrationStateOut';

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

@@ -1,10 +1,12 @@
 export { consumeFailureInterrupt, useConsumeFailureInterruptMutation, } from './hooks/useConsumeFailureInterruptMutation';
 export { consumeV1StepPluginOutputResponse, useConsumeV1StepPluginOutputResponseMutation, } from './hooks/useConsumeV1StepPluginOutputResponseMutation';
 export { consumeV1StepPluginResponse, useConsumeV1StepPluginResponseMutation, } from './hooks/useConsumeV1StepPluginResponseMutation';
+export { createV1FlywayPluginInputs, useCreateV1FlywayPluginInputsMutation, } from './hooks/useCreateV1FlywayPluginInputsMutation';
 export { createV1StepPluginInputs, useCreateV1StepPluginInputsMutation, } from './hooks/useCreateV1StepPluginInputsMutation';
 export { getV1CustomOperations, useGetV1CustomOperationsMutation, } from './hooks/useGetV1CustomOperationsMutation';
 export { getV1SchemaInstanceMetadata, useGetV1SchemaInstanceMetadataMutation, } from './hooks/useGetV1SchemaInstanceMetadataMutation';
 export { postV1DbopsDbSnapshotMetadata, usePostV1DbopsDbSnapshotMetadataMutation, } from './hooks/usePostV1DbopsDbSnapshotMetadataMutation';
+export { postV1DbopsMetadataSnapshot, usePostV1DbopsMetadataSnapshotMutation, } from './hooks/usePostV1DbopsMetadataSnapshotMutation';
 export { useV1ChangesetYamlProjDbInstanceQuery, v1ChangesetYamlProjDbInstance, } from './hooks/useV1ChangesetYamlProjDbInstanceQuery';
 export { useV1ChangesetmetadataProjDbInstanceQuery, v1ChangesetmetadataProjDbInstance, } from './hooks/useV1ChangesetmetadataProjDbInstanceQuery';
 export { useV1CreateProjDbSchemaInstanceMutation, v1CreateProjDbSchemaInstance, } from './hooks/useV1CreateProjDbSchemaInstanceMutation';

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

@@ -0,0 +1,35 @@
+import type { FlywayCommand } from '../schemas/FlywayCommand';
+export interface FlywayPluginInputsRequestRequestBody {
+    command: FlywayCommand;
+    /**
+     * when pluginCommand type is Custom, customCommand is considered which is any string provided by the user
+     */
+    customCommand?: string;
+    /**
+     * db instance identifier
+     * @example "myschema/prod-1-instance"
+     */
+    dbInstance: string;
+    /**
+     * dbSchema reference
+     */
+    dbSchema: string;
+    /**
+     * Controls whether to include JWT authentication token in the plugin settings. If true, a bearer token will be included.
+     */
+    includeJwtAuth?: boolean;
+    /**
+     * parent unique id for the scope
+     */
+    parentId: string;
+    /**
+     * Key value mapping of user input plugin settings
+     */
+    settings?: {
+        [key: string]: string;
+    };
+    /**
+     * The base directory Flyway uses to resolve relative paths for migrations
+     */
+    workingDirectory?: string;
+}

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

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

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

@@ -0,0 +1,30 @@
+import type { DbInstanceOut } from '../schemas/DbInstanceOut';
+import type { DbSchemaOut } from '../schemas/DbSchemaOut';
+export interface FlywayPluginInputsResponseResponse {
+    /**
+     * DB engine images by type/version.
+     */
+    dbImages?: {
+        [key: string]: any;
+    };
+    /**
+     * Built-in default config key-values
+     */
+    defaultConfigs?: {
+        [key: string]: string;
+    };
+    /**
+     * Optional auxiliary images to pull
+     */
+    downloadImages?: {
+        [key: string]: any;
+    };
+    instance?: DbInstanceOut;
+    schema?: DbSchemaOut;
+    /**
+     * Computed plugin step settings/env
+     */
+    settings?: {
+        [key: string]: string;
+    };
+}

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

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

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

@@ -1,8 +1,4 @@
-import type { Command } from '../schemas/Command';
 export interface DbSnapshotMetadataIn {
-    command: string;
-    harnessCommand: Command;
-    instanceIdentifier: string;
     /**
      * Name for the object, example - Customers for table objectType
      */
@@ -15,11 +11,5 @@ export interface DbSnapshotMetadataIn {
      * json value of the object
      */
     objectValue: string;
-    parentId: string;
-    pipelineExecutionId: string;
-    pipelineIdentifier: string;
-    schemaIdentifier: string;
-    snapshotId: string;
     snapshotObjectId?: string;
-    stageExecutionId: string;
 }

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

@@ -1 +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/FlywayCommand.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Type of the plugin command to run
+ */
+export type FlywayCommand = 'Clone' | 'Custom' | 'Info' | 'Migrate' | 'MigrateSQL' | 'ParentWrapper' | 'Repair' | 'Undo' | 'UndoSQL';

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

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

package/package.json

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