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

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

@@ -0,0 +1,19 @@
+import { UseMutationOptions } from '@tanstack/react-query';
+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 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'> {
+    body: PostV1DbopsDbSnapshotMetadataRequestBody;
+}
+export declare function postV1DbopsDbSnapshotMetadata(props: PostV1DbopsDbSnapshotMetadataProps): Promise<PostV1DbopsDbSnapshotMetadataOkResponse>;
+/**
+ * Sending DB snapshot metadata from plugin to capture current state
+ */
+export declare function usePostV1DbopsDbSnapshotMetadataMutation(options?: Omit<UseMutationOptions<PostV1DbopsDbSnapshotMetadataOkResponse, PostV1DbopsDbSnapshotMetadataErrorResponse, PostV1DbopsDbSnapshotMetadataProps>, 'mutationKey' | 'mutationFn'>): import("@tanstack/react-query").UseMutationResult<PostV1DbopsDbSnapshotMetadataOkResponse, import("..").Error, PostV1DbopsDbSnapshotMetadataProps, unknown>;

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

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

@@ -26,6 +26,7 @@ export interface V1ListProjDbSchemaQueryQueryParams {
      * @default "DESC"
      */
     order?: 'ASC' | 'DESC';
+    migrationType?: 'Flyway' | 'Liquibase';
 }
 export interface V1ListProjDbSchemaQueryHeaderParams {
     'Harness-Account'?: string;

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

@@ -11,6 +11,8 @@ export type { GetV1CustomOperationsErrorResponse, GetV1CustomOperationsOkRespons
 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 { postV1DbopsDbSnapshotMetadata, usePostV1DbopsDbSnapshotMetadataMutation, } from './hooks/usePostV1DbopsDbSnapshotMetadataMutation';
 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';
@@ -79,6 +81,7 @@ export type { DbInstanceUpdateRequestRequestBody } from './requestBodies/DbInsta
 export type { DbSchemaCreateRequestRequestBody } from './requestBodies/DbSchemaCreateRequestRequestBody';
 export type { DbSchemaFilterRequestRequestBody } from './requestBodies/DbSchemaFilterRequestRequestBody';
 export type { DbSchemaUpdateRequestRequestBody } from './requestBodies/DbSchemaUpdateRequestRequestBody';
+export type { DbSnapshotMetadataCreateRequestRequestBody } from './requestBodies/DbSnapshotMetadataCreateRequestRequestBody';
 export type { ExecutionConfigUpdateRequestRequestBody } from './requestBodies/ExecutionConfigUpdateRequestRequestBody';
 export type { FailureInterruptRequestRequestBody } from './requestBodies/FailureInterruptRequestRequestBody';
 export type { FetchSqlStatementRequestRequestBody } from './requestBodies/FetchSqlStatementRequestRequestBody';
@@ -122,6 +125,7 @@ export type { DbSchemaFilterIn } from './schemas/DbSchemaFilterIn';
 export type { DbSchemaIn } from './schemas/DbSchemaIn';
 export type { DbSchemaOut } from './schemas/DbSchemaOut';
 export type { DbSchemaType } from './schemas/DbSchemaType';
+export type { DbSnapshotMetadataIn } from './schemas/DbSnapshotMetadataIn';
 export type { DbStepType } from './schemas/DbStepType';
 export type { DeployedChangeSets } from './schemas/DeployedChangeSets';
 export type { DeployedChangesetSqlOutput } from './schemas/DeployedChangesetSqlOutput';

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

@@ -4,6 +4,7 @@ export { consumeV1StepPluginResponse, useConsumeV1StepPluginResponseMutation, }
 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 { useV1ChangesetYamlProjDbInstanceQuery, v1ChangesetYamlProjDbInstance, } from './hooks/useV1ChangesetYamlProjDbInstanceQuery';
 export { useV1ChangesetmetadataProjDbInstanceQuery, v1ChangesetmetadataProjDbInstance, } from './hooks/useV1ChangesetmetadataProjDbInstanceQuery';
 export { useV1CreateProjDbSchemaInstanceMutation, v1CreateProjDbSchemaInstance, } from './hooks/useV1CreateProjDbSchemaInstanceMutation';

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

@@ -11,17 +11,17 @@ export interface DbInstanceUpdateRequestRequestBody {
      * Liquibase context
      */
     context?: string;
-    /**
-     * properties to substitute in liquibase changelog
-     */
-    liquibaseSubstituteProperties?: {
-        [key: string]: string;
-    };
     /**
      * name of the database instance
      *
      */
     name?: string;
+    /**
+     * Placeholder replacement in migration scripts.
+     */
+    substituteProperties?: {
+        [key: string]: string;
+    };
     /**
      * Database instance tags
      */

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

@@ -0,0 +1,2 @@
+import type { DbSnapshotMetadataIn } from '../schemas/DbSnapshotMetadataIn';
+export type DbSnapshotMetadataCreateRequestRequestBody = DbSnapshotMetadataIn[];

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

@@ -0,0 +1 @@
+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' | 'DBOPSRollbackCountSQL' | 'DBOPSRollbackSQL' | 'DBOPSUpdateSQL' | 'History' | 'MarkNextChangesetRan' | 'ParentWrapper' | 'Rollback' | 'RollbackCount' | 'RollbackCountSQL' | 'RollbackSQL' | 'Status' | 'Tag' | 'Update' | 'UpdateSQL' | 'Validate';
+export type Command = 'Clone' | 'Custom' | 'DBOPSRollbackCountSQL' | 'DBOPSRollbackSQL' | 'DBOPSUpdateSQL' | 'History' | 'MarkNextChangesetRan' | 'ParentWrapper' | 'Rollback' | 'RollbackCount' | 'RollbackCountSQL' | 'RollbackSQL' | 'Snapshot' | 'Status' | 'Tag' | 'Update' | 'UpdateSQL' | 'Validate';

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

@@ -21,16 +21,16 @@ export interface DbInstanceIn {
      * identifier of the database instance
      */
     identifier: string;
-    /**
-     * properties to substitute in liquibase changelog
-     */
-    liquibaseSubstituteProperties?: {
-        [key: string]: string;
-    };
     /**
      * name of the database instance
      */
     name?: string;
+    /**
+     * Placeholder replacement in migration scripts.
+     */
+    substituteProperties?: {
+        [key: string]: string;
+    };
     /**
      * tags attached to the database instance
      */

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

@@ -31,18 +31,18 @@ export interface DbInstanceOut {
      * Tag on last deployed changeSet
      */
     lastDeployedChangeSetTag: string;
-    /**
-     * properties to substitute in liquibase changelog
-     */
-    liquibaseSubstituteProperties?: {
-        [key: string]: string;
-    };
     /**
      * name of the database instance
      */
     name: string;
     schemaId?: string;
     schemaIdentifier?: string;
+    /**
+     * Placeholder replacement in migration scripts.
+     */
+    substituteProperties?: {
+        [key: string]: string;
+    };
     /**
      * tags attached to the database instance
      */

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

@@ -0,0 +1,25 @@
+import type { Command } from '../schemas/Command';
+export interface DbSnapshotMetadataIn {
+    command: string;
+    harnessCommand: Command;
+    instanceIdentifier: string;
+    /**
+     * Name for the object, example - Customers for table objectType
+     */
+    objectName: string;
+    /**
+     * type for the object for the metadata, example- Table
+     */
+    objectType: string;
+    /**
+     * 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

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

package/package.json

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