@harnessio/react-dbops-service-client 0.6.0 → 0.8.0

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

@@ -0,0 +1,38 @@
+import { UseMutationOptions } from '@tanstack/react-query';
+import type { DeployedStateOutput } from '../schemas/DeployedStateOutput';
+import type { ErrorResponseResponse } from '../responses/ErrorResponseResponse';
+import type { DeployedStateInput } from '../schemas/DeployedStateInput';
+import type { ResponseWithPagination } from '../helpers';
+import { FetcherOptions } from '../../../../fetcher/index.js';
+export interface V1GetDeployedStateMutationPathParams {
+    org: string;
+    project: string;
+    dbschema: string;
+    dbinstance: string;
+}
+export interface V1GetDeployedStateMutationQueryParams {
+    /**
+     * @format int64
+     * @default 0
+     */
+    page?: number;
+    /**
+     * @default 10
+     */
+    limit?: number;
+}
+export interface V1GetDeployedStateMutationHeaderParams {
+    'Harness-Account'?: string;
+}
+export type V1GetDeployedStateRequestBody = DeployedStateInput;
+export type V1GetDeployedStateOkResponse = ResponseWithPagination<DeployedStateOutput[]>;
+export type V1GetDeployedStateErrorResponse = ErrorResponseResponse;
+export interface V1GetDeployedStateProps extends V1GetDeployedStateMutationPathParams, Omit<FetcherOptions<V1GetDeployedStateMutationQueryParams, V1GetDeployedStateRequestBody, V1GetDeployedStateMutationHeaderParams>, 'url'> {
+    queryParams: V1GetDeployedStateMutationQueryParams;
+    body: V1GetDeployedStateRequestBody;
+}
+export declare function v1GetDeployedState(props: V1GetDeployedStateProps): Promise<V1GetDeployedStateOkResponse>;
+/**
+ * Status of changeset deployment as part of execution with comparison to earlier state.
+ */
+export declare function useV1GetDeployedStateMutation(options?: Omit<UseMutationOptions<V1GetDeployedStateOkResponse, V1GetDeployedStateErrorResponse, V1GetDeployedStateProps>, 'mutationKey' | 'mutationFn'>): import("@tanstack/react-query").UseMutationResult<V1GetDeployedStateOkResponse, import("..").Error, V1GetDeployedStateProps, unknown>;

package/dist/dbops-service/src/services/hooks/useV1GetDeployedStateMutation.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 v1GetDeployedState(props) {
+    return fetcher(Object.assign({ url: `/v1/orgs/${props.org}/projects/${props.project}/dbschema/${props.dbschema}/instance/${props.dbinstance}/deployedState`, method: 'POST' }, props));
+}
+/**
+ * Status of changeset deployment as part of execution with comparison to earlier state.
+ */
+export function useV1GetDeployedStateMutation(options) {
+    return useMutation((mutateProps) => v1GetDeployedState(mutateProps), options);
+}

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

@@ -20,7 +20,13 @@ export interface V1ListProjDbSchemaInstanceMutationQueryParams {
      */
     limit?: number;
     search_term?: string;
+    /**
+     * @default "created"
+     */
     sort?: 'created' | 'name' | 'updated';
+    /**
+     * @default "DESC"
+     */
     order?: 'ASC' | 'DESC';
 }
 export interface V1ListProjDbSchemaInstanceMutationHeaderParams {

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

@@ -18,7 +18,13 @@ export interface V1ListProjDbSchemaQueryQueryParams {
      */
     limit?: number;
     search_term?: string;
+    /**
+     * @default "created"
+     */
     sort?: 'created' | 'name' | 'updated';
+    /**
+     * @default "DESC"
+     */
     order?: 'ASC' | 'DESC';
 }
 export interface V1ListProjDbSchemaQueryHeaderParams {

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

@@ -15,6 +15,8 @@ export type { V1GetDbOverviewErrorResponse, V1GetDbOverviewOkResponse, V1GetDbOv
 export { useV1GetDbOverviewQuery, v1GetDbOverview } from './hooks/useV1GetDbOverviewQuery';
 export type { V1GetDbinstanceLogErrorResponse, V1GetDbinstanceLogOkResponse, V1GetDbinstanceLogProps, V1GetDbinstanceLogQueryPathParams, } from './hooks/useV1GetDbinstanceLogQuery';
 export { useV1GetDbinstanceLogQuery, v1GetDbinstanceLog } from './hooks/useV1GetDbinstanceLogQuery';
+export type { V1GetDeployedStateErrorResponse, V1GetDeployedStateMutationPathParams, V1GetDeployedStateMutationQueryParams, V1GetDeployedStateOkResponse, V1GetDeployedStateProps, V1GetDeployedStateRequestBody, } from './hooks/useV1GetDeployedStateMutation';
+export { useV1GetDeployedStateMutation, v1GetDeployedState, } from './hooks/useV1GetDeployedStateMutation';
 export type { V1GetProjDbSchemaInstanceErrorResponse, V1GetProjDbSchemaInstanceOkResponse, V1GetProjDbSchemaInstanceProps, V1GetProjDbSchemaInstanceQueryPathParams, } from './hooks/useV1GetProjDbSchemaInstanceQuery';
 export { useV1GetProjDbSchemaInstanceQuery, v1GetProjDbSchemaInstance, } from './hooks/useV1GetProjDbSchemaInstanceQuery';
 export type { V1GetProjDbSchemaErrorResponse, V1GetProjDbSchemaOkResponse, V1GetProjDbSchemaProps, V1GetProjDbSchemaQueryPathParams, } from './hooks/useV1GetProjDbSchemaQuery';
@@ -58,7 +60,11 @@ export type { DbInstanceIn } from './schemas/DbInstanceIn';
 export type { DbInstanceOut } from './schemas/DbInstanceOut';
 export type { DbSchemaIn } from './schemas/DbSchemaIn';
 export type { DbSchemaOut } from './schemas/DbSchemaOut';
+export type { DbStepType } from './schemas/DbStepType';
+export type { DeployedStateInput } from './schemas/DeployedStateInput';
+export type { DeployedStateOutput } from './schemas/DeployedStateOutput';
 export type { Error } from './schemas/Error';
+export type { ExecutionMetadata } from './schemas/ExecutionMetadata';
 export type { InstanceDetail } from './schemas/InstanceDetail';
 export type { MigrationStateChangeSet } from './schemas/MigrationStateChangeSet';
 export type { MigrationStateIn } from './schemas/MigrationStateIn';

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

@@ -6,6 +6,7 @@ export { useV1DeleteProjDbSchemaInstanceMutation, v1DeleteProjDbSchemaInstance,
 export { useV1DeleteProjDbSchemaMutation, v1DeleteProjDbSchema, } from './hooks/useV1DeleteProjDbSchemaMutation';
 export { useV1GetDbOverviewQuery, v1GetDbOverview } from './hooks/useV1GetDbOverviewQuery';
 export { useV1GetDbinstanceLogQuery, v1GetDbinstanceLog } from './hooks/useV1GetDbinstanceLogQuery';
+export { useV1GetDeployedStateMutation, v1GetDeployedState, } from './hooks/useV1GetDeployedStateMutation';
 export { useV1GetProjDbSchemaInstanceQuery, v1GetProjDbSchemaInstance, } from './hooks/useV1GetProjDbSchemaInstanceQuery';
 export { useV1GetProjDbSchemaQuery, v1GetProjDbSchema } from './hooks/useV1GetProjDbSchemaQuery';
 export { useV1IngestLogsMutation, v1IngestLogs } from './hooks/useV1IngestLogsMutation';

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

@@ -15,17 +15,22 @@ export interface ConsumePluginRespRequestRequestBody {
      * Organization identifier
      */
     org: string;
+    parentStepType?: string;
     /**
      * Identifier of the pipeline
      */
-    pipeline?: string;
+    pipeline: string;
     /**
      * ExecutionId of the pipeline executed
      */
-    planExecutionId?: string;
+    planExecutionId: string;
     /**
      * Project identifier
      */
     project: string;
+    /**
+     * ExecutionId of the stage executed
+     */
+    stageExecutionId: string;
     status: CommandExecutionStatus;
 }

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

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

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

@@ -27,6 +27,10 @@ export interface DbInstanceOut {
      * Most recent tag applied to the database
      */
     lastAppliedTag?: string;
+    /**
+     * Tag on last deployed changeSet
+     */
+    lastDeployedChangeSetTag: string;
     /**
      * name of the database instance
      */

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

@@ -0,0 +1 @@
+export type DbStepType = 'DBSchemaApply';

package/dist/dbops-service/src/services/schemas/DbStepType.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/DeployedStateInput.d.ts

@@ -0,0 +1,19 @@
+import type { DbStepType } from '../schemas/DbStepType';
+/**
+ * Input for getting execution deployed states
+ */
+export interface DeployedStateInput {
+    /**
+     * identifier of the pipeline
+     */
+    pipeline: string;
+    planExecutionId: string;
+    stageExecutionId: string;
+    /**
+     * start time of step execution
+     * @format int64
+     * @default 0
+     */
+    startTime?: number;
+    stepType: DbStepType;
+}

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

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

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

@@ -0,0 +1,23 @@
+import type { Command } from '../schemas/Command';
+import type { ExecutionMetadata } from '../schemas/ExecutionMetadata';
+import type { CommandExecutionStatus } from '../schemas/CommandExecutionStatus';
+/**
+ * The status of changeset deployment
+ */
+export interface DeployedStateOutput {
+    author: string;
+    changeSetId: string;
+    command: Command;
+    /**
+     * @format int64
+     */
+    deployedAt?: number;
+    /**
+     * if changeset run as part of current step execution
+     */
+    deployedInCurrentExecution: boolean;
+    fileName: string;
+    metadata: ExecutionMetadata;
+    status: CommandExecutionStatus;
+    tag?: string;
+}

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

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

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

@@ -0,0 +1,8 @@
+/**
+ * Properties related to pipeline execution
+ */
+export interface ExecutionMetadata {
+    pipeline: string;
+    planExecutionId: string;
+    stageExecutionId: string;
+}

package/dist/dbops-service/src/services/schemas/ExecutionMetadata.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.6.0",
+  "version": "0.8.0",
   "description": "Harness React DB Devops service client - DB Devops APIs integrated with react hooks",
   "author": "Harness Inc",
   "license": "MIT",