@harnessio/react-dbops-service-client 0.5.0 → 0.7.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/{useV1GetCommandStatusMutation.js → useV1GetDeployedStateMutation.js}

@@ -3,12 +3,12 @@
 // Please do not modify this code directly.
 import { useMutation } from '@tanstack/react-query';
 import { fetcher } from '../../../../fetcher/index.js';
-export function v1GetCommandStatus(props) {
-    return fetcher(Object.assign({ url: `/v1/orgs/${props.org}/projects/${props.project}/pipeline/${props.pipeline}/dbschema/${props.dbschema}/instance/${props.dbinstance}/deployedState`, method: 'POST' }, props));
+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 useV1GetCommandStatusMutation(options) {
-    return useMutation((mutateProps) => v1GetCommandStatus(mutateProps), options);
+export function useV1GetDeployedStateMutation(options) {
+    return useMutation((mutateProps) => v1GetDeployedState(mutateProps), options);
 }

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

@@ -0,0 +1,40 @@
+import { UseMutationOptions } from '@tanstack/react-query';
+import type { DbInstanceListResponseResponse } from '../responses/DbInstanceListResponseResponse';
+import type { ErrorResponseResponse } from '../responses/ErrorResponseResponse';
+import type { DbInstanceFilterRequestRequestBody } from '../requestBodies/DbInstanceFilterRequestRequestBody';
+import type { ResponseWithPagination } from '../helpers';
+import { FetcherOptions } from '../../../../fetcher/index.js';
+export interface V1ListProjDbSchemaInstanceMutationPathParams {
+    org: string;
+    project: string;
+    dbschema: string;
+}
+export interface V1ListProjDbSchemaInstanceMutationQueryParams {
+    /**
+     * @format int64
+     * @default 0
+     */
+    page?: number;
+    /**
+     * @default 10
+     */
+    limit?: number;
+    search_term?: string;
+    sort?: 'created' | 'name' | 'updated';
+    order?: 'ASC' | 'DESC';
+}
+export interface V1ListProjDbSchemaInstanceMutationHeaderParams {
+    'Harness-Account'?: string;
+}
+export type V1ListProjDbSchemaInstanceRequestBody = DbInstanceFilterRequestRequestBody;
+export type V1ListProjDbSchemaInstanceOkResponse = ResponseWithPagination<DbInstanceListResponseResponse>;
+export type V1ListProjDbSchemaInstanceErrorResponse = ErrorResponseResponse;
+export interface V1ListProjDbSchemaInstanceProps extends V1ListProjDbSchemaInstanceMutationPathParams, Omit<FetcherOptions<V1ListProjDbSchemaInstanceMutationQueryParams, V1ListProjDbSchemaInstanceRequestBody, V1ListProjDbSchemaInstanceMutationHeaderParams>, 'url'> {
+    queryParams: V1ListProjDbSchemaInstanceMutationQueryParams;
+    body: V1ListProjDbSchemaInstanceRequestBody;
+}
+export declare function v1ListProjDbSchemaInstance(props: V1ListProjDbSchemaInstanceProps): Promise<V1ListProjDbSchemaInstanceOkResponse>;
+/**
+ * Retrieves the specified database instances of the database schema
+ */
+export declare function useV1ListProjDbSchemaInstanceMutation(options?: Omit<UseMutationOptions<V1ListProjDbSchemaInstanceOkResponse, V1ListProjDbSchemaInstanceErrorResponse, V1ListProjDbSchemaInstanceProps>, 'mutationKey' | 'mutationFn'>): import("@tanstack/react-query").UseMutationResult<V1ListProjDbSchemaInstanceOkResponse, import("..").Error, V1ListProjDbSchemaInstanceProps, unknown>;

package/dist/dbops-service/src/services/hooks/useV1ListProjDbSchemaInstanceMutation.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 v1ListProjDbSchemaInstance(props) {
+    return fetcher(Object.assign({ url: `/v1/orgs/${props.org}/projects/${props.project}/dbschema/${props.dbschema}/instancelist`, method: 'POST' }, props));
+}
+/**
+ * Retrieves the specified database instances of the database schema
+ */
+export function useV1ListProjDbSchemaInstanceMutation(options) {
+    return useMutation((mutateProps) => v1ListProjDbSchemaInstance(mutateProps), options);
+}

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

@@ -11,20 +11,20 @@ export type { V1DeleteProjDbSchemaInstanceErrorResponse, V1DeleteProjDbSchemaIns
 export { useV1DeleteProjDbSchemaInstanceMutation, v1DeleteProjDbSchemaInstance, } from './hooks/useV1DeleteProjDbSchemaInstanceMutation';
 export type { V1DeleteProjDbSchemaErrorResponse, V1DeleteProjDbSchemaMutationPathParams, V1DeleteProjDbSchemaOkResponse, V1DeleteProjDbSchemaProps, } from './hooks/useV1DeleteProjDbSchemaMutation';
 export { useV1DeleteProjDbSchemaMutation, v1DeleteProjDbSchema, } from './hooks/useV1DeleteProjDbSchemaMutation';
-export type { V1GetCommandStatusErrorResponse, V1GetCommandStatusMutationPathParams, V1GetCommandStatusOkResponse, V1GetCommandStatusProps, V1GetCommandStatusRequestBody, } from './hooks/useV1GetCommandStatusMutation';
-export { useV1GetCommandStatusMutation, v1GetCommandStatus, } from './hooks/useV1GetCommandStatusMutation';
 export type { V1GetDbOverviewErrorResponse, V1GetDbOverviewOkResponse, V1GetDbOverviewProps, V1GetDbOverviewQueryPathParams, } from './hooks/useV1GetDbOverviewQuery';
 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';
 export { useV1GetProjDbSchemaQuery, v1GetProjDbSchema } from './hooks/useV1GetProjDbSchemaQuery';
 export type { V1IngestLogsErrorResponse, V1IngestLogsMutationPathParams, V1IngestLogsOkResponse, V1IngestLogsProps, V1IngestLogsRequestBody, } from './hooks/useV1IngestLogsMutation';
 export { useV1IngestLogsMutation, v1IngestLogs } from './hooks/useV1IngestLogsMutation';
-export type { V1ListProjDbSchemaInstanceErrorResponse, V1ListProjDbSchemaInstanceOkResponse, V1ListProjDbSchemaInstanceProps, V1ListProjDbSchemaInstanceQueryPathParams, V1ListProjDbSchemaInstanceQueryQueryParams, } from './hooks/useV1ListProjDbSchemaInstanceQuery';
-export { useV1ListProjDbSchemaInstanceQuery, v1ListProjDbSchemaInstance, } from './hooks/useV1ListProjDbSchemaInstanceQuery';
+export type { V1ListProjDbSchemaInstanceErrorResponse, V1ListProjDbSchemaInstanceMutationPathParams, V1ListProjDbSchemaInstanceMutationQueryParams, V1ListProjDbSchemaInstanceOkResponse, V1ListProjDbSchemaInstanceProps, V1ListProjDbSchemaInstanceRequestBody, } from './hooks/useV1ListProjDbSchemaInstanceMutation';
+export { useV1ListProjDbSchemaInstanceMutation, v1ListProjDbSchemaInstance, } from './hooks/useV1ListProjDbSchemaInstanceMutation';
 export type { V1ListProjDbSchemaErrorResponse, V1ListProjDbSchemaOkResponse, V1ListProjDbSchemaProps, V1ListProjDbSchemaQueryPathParams, V1ListProjDbSchemaQueryQueryParams, } from './hooks/useV1ListProjDbSchemaQuery';
 export { useV1ListProjDbSchemaQuery, v1ListProjDbSchema } from './hooks/useV1ListProjDbSchemaQuery';
 export type { V1MigrationStateProjDbSchemaErrorResponse, V1MigrationStateProjDbSchemaMutationPathParams, V1MigrationStateProjDbSchemaMutationQueryParams, V1MigrationStateProjDbSchemaOkResponse, V1MigrationStateProjDbSchemaProps, V1MigrationStateProjDbSchemaRequestBody, } from './hooks/useV1MigrationStateProjDbSchemaMutation';
@@ -55,15 +55,16 @@ export type { ChangeSetDeploymentStatus } from './schemas/ChangeSetDeploymentSta
 export type { Changelog } from './schemas/Changelog';
 export type { Command } from './schemas/Command';
 export type { CommandExecutionStatus } from './schemas/CommandExecutionStatus';
-export type { CommandStatusIn } from './schemas/CommandStatusIn';
-export type { CommandStatusOut } from './schemas/CommandStatusOut';
 export type { DbInstanceFilterIn } from './schemas/DbInstanceFilterIn';
 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

@@ -4,13 +4,13 @@ export { useV1CreateProjDbSchemaInstanceMutation, v1CreateProjDbSchemaInstance,
 export { useV1CreateProjDbSchemaMutation, v1CreateProjDbSchema, } from './hooks/useV1CreateProjDbSchemaMutation';
 export { useV1DeleteProjDbSchemaInstanceMutation, v1DeleteProjDbSchemaInstance, } from './hooks/useV1DeleteProjDbSchemaInstanceMutation';
 export { useV1DeleteProjDbSchemaMutation, v1DeleteProjDbSchema, } from './hooks/useV1DeleteProjDbSchemaMutation';
-export { useV1GetCommandStatusMutation, v1GetCommandStatus, } from './hooks/useV1GetCommandStatusMutation';
 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';
-export { useV1ListProjDbSchemaInstanceQuery, v1ListProjDbSchemaInstance, } from './hooks/useV1ListProjDbSchemaInstanceQuery';
+export { useV1ListProjDbSchemaInstanceMutation, v1ListProjDbSchemaInstance, } from './hooks/useV1ListProjDbSchemaInstanceMutation';
 export { useV1ListProjDbSchemaQuery, v1ListProjDbSchema } from './hooks/useV1ListProjDbSchemaQuery';
 export { useV1MigrationStateProjDbSchemaMutation, v1MigrationStateProjDbSchema, } from './hooks/useV1MigrationStateProjDbSchemaMutation';
 export { useV1UpdateProjDbSchemaInstanceMutation, v1UpdateProjDbSchemaInstance, } from './hooks/useV1UpdateProjDbSchemaInstanceMutation';

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

@@ -0,0 +1,13 @@
+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;
+    stepType: DbStepType;
+}

package/dist/dbops-service/src/services/schemas/{CommandStatusOut.d.ts → DeployedStateOutput.d.ts}

@@ -1,9 +1,10 @@
 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 CommandStatusOut {
+export interface DeployedStateOutput {
     author: string;
     changeSetId: string;
     command: Command;
@@ -11,11 +12,12 @@ export interface CommandStatusOut {
      * @format int64
      */
     deployedAt?: number;
-    fileName: string;
     /**
-     * if changeset run as part of current execution or belong to previous state
+     * if changeset run as part of current step execution
      */
-    fromCurrentExecution: boolean;
+    deployedInCurrentExecution: boolean;
+    fileName: string;
+    metadata: ExecutionMetadata;
     status: CommandExecutionStatus;
     tag?: string;
 }

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.5.0",
+  "version": "0.7.0",
   "description": "Harness React DB Devops service client - DB Devops APIs integrated with react hooks",
   "author": "Harness Inc",
   "license": "MIT",

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

@@ -1,27 +0,0 @@
-import { UseMutationOptions } from '@tanstack/react-query';
-import type { CommandStatusOut } from '../schemas/CommandStatusOut';
-import type { ErrorResponseResponse } from '../responses/ErrorResponseResponse';
-import type { CommandStatusIn } from '../schemas/CommandStatusIn';
-import type { ResponseWithPagination } from '../helpers';
-import { FetcherOptions } from '../../../../fetcher/index.js';
-export interface V1GetCommandStatusMutationPathParams {
-    org: string;
-    project: string;
-    pipeline: string;
-    dbschema: string;
-    dbinstance: string;
-}
-export interface V1GetCommandStatusMutationHeaderParams {
-    'Harness-Account'?: string;
-}
-export type V1GetCommandStatusRequestBody = CommandStatusIn;
-export type V1GetCommandStatusOkResponse = ResponseWithPagination<CommandStatusOut[]>;
-export type V1GetCommandStatusErrorResponse = ErrorResponseResponse;
-export interface V1GetCommandStatusProps extends V1GetCommandStatusMutationPathParams, Omit<FetcherOptions<unknown, V1GetCommandStatusRequestBody, V1GetCommandStatusMutationHeaderParams>, 'url'> {
-    body: V1GetCommandStatusRequestBody;
-}
-export declare function v1GetCommandStatus(props: V1GetCommandStatusProps): Promise<V1GetCommandStatusOkResponse>;
-/**
- * Status of changeset deployment as part of execution with comparison to earlier state.
- */
-export declare function useV1GetCommandStatusMutation(options?: Omit<UseMutationOptions<V1GetCommandStatusOkResponse, V1GetCommandStatusErrorResponse, V1GetCommandStatusProps>, 'mutationKey' | 'mutationFn'>): import("@tanstack/react-query").UseMutationResult<V1GetCommandStatusOkResponse, import("..").Error, V1GetCommandStatusProps, unknown>;

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

@@ -1,37 +0,0 @@
-import { UseQueryOptions } from '@tanstack/react-query';
-import type { DbInstanceListResponseResponse } from '../responses/DbInstanceListResponseResponse';
-import type { ErrorResponseResponse } from '../responses/ErrorResponseResponse';
-import type { ResponseWithPagination } from '../helpers';
-import { FetcherOptions } from '../../../../fetcher/index.js';
-export interface V1ListProjDbSchemaInstanceQueryPathParams {
-    org: string;
-    project: string;
-    dbschema: string;
-}
-export interface V1ListProjDbSchemaInstanceQueryQueryParams {
-    /**
-     * @format int64
-     * @default 0
-     */
-    page?: number;
-    /**
-     * @default 10
-     */
-    limit?: number;
-    search_term?: string;
-    sort?: 'created' | 'name' | 'updated';
-    order?: 'ASC' | 'DESC';
-}
-export interface V1ListProjDbSchemaInstanceQueryHeaderParams {
-    'Harness-Account'?: string;
-}
-export type V1ListProjDbSchemaInstanceOkResponse = ResponseWithPagination<DbInstanceListResponseResponse>;
-export type V1ListProjDbSchemaInstanceErrorResponse = ErrorResponseResponse;
-export interface V1ListProjDbSchemaInstanceProps extends V1ListProjDbSchemaInstanceQueryPathParams, Omit<FetcherOptions<V1ListProjDbSchemaInstanceQueryQueryParams, unknown, V1ListProjDbSchemaInstanceQueryHeaderParams>, 'url'> {
-    queryParams: V1ListProjDbSchemaInstanceQueryQueryParams;
-}
-export declare function v1ListProjDbSchemaInstance(props: V1ListProjDbSchemaInstanceProps): Promise<V1ListProjDbSchemaInstanceOkResponse>;
-/**
- * Retrieves the specified database instances of the database schema
- */
-export declare function useV1ListProjDbSchemaInstanceQuery(props: V1ListProjDbSchemaInstanceProps, options?: Omit<UseQueryOptions<V1ListProjDbSchemaInstanceOkResponse, V1ListProjDbSchemaInstanceErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<V1ListProjDbSchemaInstanceOkResponse, import("..").Error>;

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

@@ -1,20 +0,0 @@
-/* eslint-disable */
-// This code is autogenerated using @harnessio/oats-cli.
-// Please do not modify this code directly.
-import { useQuery } from '@tanstack/react-query';
-import { fetcher } from '../../../../fetcher/index.js';
-export function v1ListProjDbSchemaInstance(props) {
-    return fetcher(Object.assign({ url: `/v1/orgs/${props.org}/projects/${props.project}/dbschema/${props.dbschema}/instance`, method: 'GET' }, props));
-}
-/**
- * Retrieves the specified database instances of the database schema
- */
-export function useV1ListProjDbSchemaInstanceQuery(props, options) {
-    return useQuery([
-        'v1-list-proj-db-schema-instance',
-        props.org,
-        props.project,
-        props.dbschema,
-        props.queryParams,
-    ], ({ signal }) => v1ListProjDbSchemaInstance(Object.assign(Object.assign({}, props), { signal })), options);
-}

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

@@ -1,9 +0,0 @@
-import type { DbStepType } from '../schemas/DbStepType';
-/**
- * Input for getting command execution status
- */
-export interface CommandStatusIn {
-    planExecutionId: string;
-    stageExecutionId: string;
-    stepType: DbStepType;
-}