@fabricorg/databricks-testkit 0.4.0 → 0.5.0

package/dist/index.d.cts

@@ -604,7 +604,106 @@ declare function jobsCertificationCheck(): LiveCheck;
 
 declare function createLakeflowJobsTargetPack(): TargetPack;
 
+type JsonObject = Record<string, unknown>;
+interface PipelineResource extends JsonObject {
+    pipeline_id?: string;
+    name?: string;
+    state?: string;
+    spec?: JsonObject;
+}
+interface DashboardResource extends JsonObject {
+    dashboard_id?: string;
+    display_name?: string;
+    lifecycle_state?: string;
+}
+interface GenieSpaceResource extends JsonObject {
+    space_id?: string;
+    title?: string;
+}
+interface RegisteredModelResource extends JsonObject {
+    full_name?: string;
+    name?: string;
+}
+interface ServingEndpointResource extends JsonObject {
+    name?: string;
+    state?: {
+        ready?: string;
+        config_update?: string;
+    };
+    config?: JsonObject;
+    ai_gateway?: JsonObject;
+}
+interface VectorSearchEndpointResource extends JsonObject {
+    name?: string;
+    endpoint_status?: {
+        state?: string;
+        message?: string;
+    };
+}
+interface VectorSearchIndexResource extends JsonObject {
+    name?: string;
+    status?: {
+        ready?: boolean;
+        message?: string;
+        indexed_row_count?: number;
+    };
+}
+/**
+ * Typed, injectable adapter for Databricks workload surfaces that are not part
+ * of SQL Statement Execution. It deliberately mirrors the public REST APIs so
+ * target packs can be unit tested without a workspace.
+ */
+declare class DatabricksAdvancedWorkloadsAdapter {
+    private readonly client;
+    constructor(client: WorkspaceClientLike);
+    pipeline(id: string): Promise<PipelineResource>;
+    table(fullName: string): Promise<JsonObject>;
+    dashboard(id: string): Promise<DashboardResource>;
+    genieSpace(id: string): Promise<GenieSpaceResource>;
+    startGenieConversation(spaceId: string, question: string): Promise<JsonObject>;
+    experiment(id: string): Promise<JsonObject>;
+    registeredModel(fullName: string): Promise<RegisteredModelResource>;
+    modelVersion(fullName: string, version: string): Promise<JsonObject>;
+    onlineTable(fullName: string): Promise<JsonObject>;
+    servingEndpoint(name: string): Promise<ServingEndpointResource>;
+    invokeServingEndpoint(name: string, request: unknown): Promise<JsonObject>;
+    vectorSearchEndpoint(name: string): Promise<VectorSearchEndpointResource>;
+    vectorSearchIndex(name: string): Promise<VectorSearchIndexResource>;
+    queryVectorSearchIndex(name: string, request: unknown): Promise<JsonObject>;
+    connection(name: string): Promise<JsonObject>;
+    share(name: string): Promise<JsonObject>;
+    cleanRoom(name: string): Promise<JsonObject>;
+    ipAccessList(id: string): Promise<JsonObject>;
+    clusterPolicy(id: string): Promise<JsonObject>;
+    warehouse(id: string): Promise<JsonObject>;
+}
+declare function advancedStreamingCdcCheck(): LiveCheck;
+declare function lakeflowConnectCheck(): LiveCheck;
+declare function aiBiDashboardCheck(): LiveCheck;
+declare function genieCheck(): LiveCheck;
+declare function mlflowLifecycleCheck(): LiveCheck;
+declare function featureEngineeringServingCheck(): LiveCheck;
+declare function modelServingCheck(): LiveCheck;
+declare function vectorSearchCheck(): LiveCheck;
+declare function ragAgentCheck(): LiveCheck;
+declare function federationSharingCleanRoomsCheck(): LiveCheck;
+declare function securityPostureCostCheck(): LiveCheck;
+interface RegionalDrCheckOptions {
+    clientFactory?: (env: Record<string, string | undefined>) => WorkspaceClientLike;
+}
+declare function regionalDrCheck(options?: RegionalDrCheckOptions): LiveCheck;
+
+declare function createAdvancedStreamingTargetPack(): TargetPack;
+declare function createAiBiGenieTargetPack(): TargetPack;
+declare function createMlflowLifecycleTargetPack(): TargetPack;
+declare function createFeatureEngineeringTargetPack(): TargetPack;
+declare function createModelServingTargetPack(): TargetPack;
+declare function createVectorRagAgentsTargetPack(): TargetPack;
+declare function createFederationSharingTargetPack(): TargetPack;
+declare function createSecurityCostDrTargetPack(): TargetPack;
+declare function createAdvancedTargetPacks(): readonly TargetPack[];
+
 declare function createBuiltinTargetPacks(): readonly TargetPack[];
 declare const builtinTargetPacks: readonly TargetPack[];
 
-export { type AppHealthCheckOptions, type AutoLoaderCheckOptions, type ConditionJobTask, type CreateContextOptions, type DatabricksJobTask, DatabricksJobsAdapter, type DbtJobTask, type DefinedLiveSuite, type DefinedTargetPackRun, type DeltaColumnContract, type DuckDbConnectionLike, type DuckDbContextOptions, type EphemeralLakebaseBranch, type ExecutionContext, type ForEachJobTask, type JobOrchestrationLiveSpec, type JobOrchestrationRun, type JobRepairOptions, type JobRepairRunState, type JobTaskBase, type JobTaskDependency, type JobTaskRunState, type JobWaitOptions, type JobsSubmitRequest, type LakebaseBranchOptions, type LakebaseCheckOptions, type LakebaseControlClient, type LiveCheck, type LiveCheckContext, type LiveCheckResult, type LiveCheckStatus, type LiveEvidence, type LiveSuiteRuntime, type LiveSuiteSpec, type MockDatabricksClient, type NotebookJobTask, type PipelineJobTask, type PollOptions, type PythonWheelJobTask, type RecordedCall, type RunJobTask, type RunTargetPackOptions, type SecretRotationCheckOptions, type SparkJarJobTask, type SparkPythonJobTask, type SparkSubmitJobTask, type SqlJobTask, TableFixture, type TargetPack, type TargetPackDoctorCheck, type TargetPackDoctorRequirement, type TargetPackDoctorResult, type TargetPackEvidenceMetadata, type TargetPackMaturity, type TargetPackRequirement, type TargetPackSpec, type TestProfile, type VolumeIOCheckOptions, type WorkspaceClientLike, type WorkspaceContextOptions, appHealthCheck, assertDeltaContract, autoLoaderIngestionCheck, backupRestoreCheck, builtinTargetPacks, classicComputeCheck, compareToGolden, createAppsOperationalFoundationPack, createBuiltinTargetPacks, createClientFromEnv, createDuckDbContext, createEphemeralLakebaseBranch, createExecutionContext, createFoundationTargetPacks, createJobsCodeFoundationPack, createLakebaseTestProvider, createLakeflowFoundationPack, createLakeflowJobsTargetPack, createMockDatabricksClient, createSqlDeltaFoundationPack, createTargetPackRegistry, createUnityStorageFoundationPack, createWorkspaceContext, customLiveCheck, dbtBuildCheck, defineLiveSuite, defineTargetPack, defineTargetPackRun, deleteEphemeralLakebaseBranch, deleteVolumeFile, deltaContractCheck, doctorTargetPack, ensureVolumeDirectory, expectQueryToMatchGolden, expectTable, failureRecoveryCheck, foundationTargetPacks, jobRunCheck, jobsCertificationCheck, jobsOrchestrationCheck, lakebaseCredentialCheck, lakebaseRoundTripCheck, normalizeJobRun, normalizeRow, normalizeVolumeRoot, notebookSubmitCheck, parseJobOrchestrationLiveSpec, parseStatementRows, performanceBudgetCheck, pipelineRefreshCheck, renderJUnit, resolveLakebaseProject, resolveProfile, resolveTokenProvider, restrictedPrincipalCheck, rollbackCheck, runLiveSuite, runTargetPack, secretRotationCheck, secretScopeCheck, serverlessComputeCheck, sqlRoundTripCheck, toLakebaseBranchId, toNamedParameters, unityCatalogAccessCheck, uploadVolumeFile, validateJobGraph, volumeIOCheck, waitForPipelineUpdate };
+export { type AppHealthCheckOptions, type AutoLoaderCheckOptions, type ConditionJobTask, type CreateContextOptions, type DashboardResource, DatabricksAdvancedWorkloadsAdapter, type DatabricksJobTask, DatabricksJobsAdapter, type DbtJobTask, type DefinedLiveSuite, type DefinedTargetPackRun, type DeltaColumnContract, type DuckDbConnectionLike, type DuckDbContextOptions, type EphemeralLakebaseBranch, type ExecutionContext, type ForEachJobTask, type GenieSpaceResource, type JobOrchestrationLiveSpec, type JobOrchestrationRun, type JobRepairOptions, type JobRepairRunState, type JobTaskBase, type JobTaskDependency, type JobTaskRunState, type JobWaitOptions, type JobsSubmitRequest, type LakebaseBranchOptions, type LakebaseCheckOptions, type LakebaseControlClient, type LiveCheck, type LiveCheckContext, type LiveCheckResult, type LiveCheckStatus, type LiveEvidence, type LiveSuiteRuntime, type LiveSuiteSpec, type MockDatabricksClient, type NotebookJobTask, type PipelineJobTask, type PipelineResource, type PollOptions, type PythonWheelJobTask, type RecordedCall, type RegionalDrCheckOptions, type RegisteredModelResource, type RunJobTask, type RunTargetPackOptions, type SecretRotationCheckOptions, type ServingEndpointResource, type SparkJarJobTask, type SparkPythonJobTask, type SparkSubmitJobTask, type SqlJobTask, TableFixture, type TargetPack, type TargetPackDoctorCheck, type TargetPackDoctorRequirement, type TargetPackDoctorResult, type TargetPackEvidenceMetadata, type TargetPackMaturity, type TargetPackRequirement, type TargetPackSpec, type TestProfile, type VectorSearchEndpointResource, type VectorSearchIndexResource, type VolumeIOCheckOptions, type WorkspaceClientLike, type WorkspaceContextOptions, advancedStreamingCdcCheck, aiBiDashboardCheck, appHealthCheck, assertDeltaContract, autoLoaderIngestionCheck, backupRestoreCheck, builtinTargetPacks, classicComputeCheck, compareToGolden, createAdvancedStreamingTargetPack, createAdvancedTargetPacks, createAiBiGenieTargetPack, createAppsOperationalFoundationPack, createBuiltinTargetPacks, createClientFromEnv, createDuckDbContext, createEphemeralLakebaseBranch, createExecutionContext, createFeatureEngineeringTargetPack, createFederationSharingTargetPack, createFoundationTargetPacks, createJobsCodeFoundationPack, createLakebaseTestProvider, createLakeflowFoundationPack, createLakeflowJobsTargetPack, createMlflowLifecycleTargetPack, createMockDatabricksClient, createModelServingTargetPack, createSecurityCostDrTargetPack, createSqlDeltaFoundationPack, createTargetPackRegistry, createUnityStorageFoundationPack, createVectorRagAgentsTargetPack, createWorkspaceContext, customLiveCheck, dbtBuildCheck, defineLiveSuite, defineTargetPack, defineTargetPackRun, deleteEphemeralLakebaseBranch, deleteVolumeFile, deltaContractCheck, doctorTargetPack, ensureVolumeDirectory, expectQueryToMatchGolden, expectTable, failureRecoveryCheck, featureEngineeringServingCheck, federationSharingCleanRoomsCheck, foundationTargetPacks, genieCheck, jobRunCheck, jobsCertificationCheck, jobsOrchestrationCheck, lakebaseCredentialCheck, lakebaseRoundTripCheck, lakeflowConnectCheck, mlflowLifecycleCheck, modelServingCheck, normalizeJobRun, normalizeRow, normalizeVolumeRoot, notebookSubmitCheck, parseJobOrchestrationLiveSpec, parseStatementRows, performanceBudgetCheck, pipelineRefreshCheck, ragAgentCheck, regionalDrCheck, renderJUnit, resolveLakebaseProject, resolveProfile, resolveTokenProvider, restrictedPrincipalCheck, rollbackCheck, runLiveSuite, runTargetPack, secretRotationCheck, secretScopeCheck, securityPostureCostCheck, serverlessComputeCheck, sqlRoundTripCheck, toLakebaseBranchId, toNamedParameters, unityCatalogAccessCheck, uploadVolumeFile, validateJobGraph, vectorSearchCheck, volumeIOCheck, waitForPipelineUpdate };

package/dist/index.d.ts

@@ -604,7 +604,106 @@ declare function jobsCertificationCheck(): LiveCheck;
 
 declare function createLakeflowJobsTargetPack(): TargetPack;
 
+type JsonObject = Record<string, unknown>;
+interface PipelineResource extends JsonObject {
+    pipeline_id?: string;
+    name?: string;
+    state?: string;
+    spec?: JsonObject;
+}
+interface DashboardResource extends JsonObject {
+    dashboard_id?: string;
+    display_name?: string;
+    lifecycle_state?: string;
+}
+interface GenieSpaceResource extends JsonObject {
+    space_id?: string;
+    title?: string;
+}
+interface RegisteredModelResource extends JsonObject {
+    full_name?: string;
+    name?: string;
+}
+interface ServingEndpointResource extends JsonObject {
+    name?: string;
+    state?: {
+        ready?: string;
+        config_update?: string;
+    };
+    config?: JsonObject;
+    ai_gateway?: JsonObject;
+}
+interface VectorSearchEndpointResource extends JsonObject {
+    name?: string;
+    endpoint_status?: {
+        state?: string;
+        message?: string;
+    };
+}
+interface VectorSearchIndexResource extends JsonObject {
+    name?: string;
+    status?: {
+        ready?: boolean;
+        message?: string;
+        indexed_row_count?: number;
+    };
+}
+/**
+ * Typed, injectable adapter for Databricks workload surfaces that are not part
+ * of SQL Statement Execution. It deliberately mirrors the public REST APIs so
+ * target packs can be unit tested without a workspace.
+ */
+declare class DatabricksAdvancedWorkloadsAdapter {
+    private readonly client;
+    constructor(client: WorkspaceClientLike);
+    pipeline(id: string): Promise<PipelineResource>;
+    table(fullName: string): Promise<JsonObject>;
+    dashboard(id: string): Promise<DashboardResource>;
+    genieSpace(id: string): Promise<GenieSpaceResource>;
+    startGenieConversation(spaceId: string, question: string): Promise<JsonObject>;
+    experiment(id: string): Promise<JsonObject>;
+    registeredModel(fullName: string): Promise<RegisteredModelResource>;
+    modelVersion(fullName: string, version: string): Promise<JsonObject>;
+    onlineTable(fullName: string): Promise<JsonObject>;
+    servingEndpoint(name: string): Promise<ServingEndpointResource>;
+    invokeServingEndpoint(name: string, request: unknown): Promise<JsonObject>;
+    vectorSearchEndpoint(name: string): Promise<VectorSearchEndpointResource>;
+    vectorSearchIndex(name: string): Promise<VectorSearchIndexResource>;
+    queryVectorSearchIndex(name: string, request: unknown): Promise<JsonObject>;
+    connection(name: string): Promise<JsonObject>;
+    share(name: string): Promise<JsonObject>;
+    cleanRoom(name: string): Promise<JsonObject>;
+    ipAccessList(id: string): Promise<JsonObject>;
+    clusterPolicy(id: string): Promise<JsonObject>;
+    warehouse(id: string): Promise<JsonObject>;
+}
+declare function advancedStreamingCdcCheck(): LiveCheck;
+declare function lakeflowConnectCheck(): LiveCheck;
+declare function aiBiDashboardCheck(): LiveCheck;
+declare function genieCheck(): LiveCheck;
+declare function mlflowLifecycleCheck(): LiveCheck;
+declare function featureEngineeringServingCheck(): LiveCheck;
+declare function modelServingCheck(): LiveCheck;
+declare function vectorSearchCheck(): LiveCheck;
+declare function ragAgentCheck(): LiveCheck;
+declare function federationSharingCleanRoomsCheck(): LiveCheck;
+declare function securityPostureCostCheck(): LiveCheck;
+interface RegionalDrCheckOptions {
+    clientFactory?: (env: Record<string, string | undefined>) => WorkspaceClientLike;
+}
+declare function regionalDrCheck(options?: RegionalDrCheckOptions): LiveCheck;
+
+declare function createAdvancedStreamingTargetPack(): TargetPack;
+declare function createAiBiGenieTargetPack(): TargetPack;
+declare function createMlflowLifecycleTargetPack(): TargetPack;
+declare function createFeatureEngineeringTargetPack(): TargetPack;
+declare function createModelServingTargetPack(): TargetPack;
+declare function createVectorRagAgentsTargetPack(): TargetPack;
+declare function createFederationSharingTargetPack(): TargetPack;
+declare function createSecurityCostDrTargetPack(): TargetPack;
+declare function createAdvancedTargetPacks(): readonly TargetPack[];
+
 declare function createBuiltinTargetPacks(): readonly TargetPack[];
 declare const builtinTargetPacks: readonly TargetPack[];
 
-export { type AppHealthCheckOptions, type AutoLoaderCheckOptions, type ConditionJobTask, type CreateContextOptions, type DatabricksJobTask, DatabricksJobsAdapter, type DbtJobTask, type DefinedLiveSuite, type DefinedTargetPackRun, type DeltaColumnContract, type DuckDbConnectionLike, type DuckDbContextOptions, type EphemeralLakebaseBranch, type ExecutionContext, type ForEachJobTask, type JobOrchestrationLiveSpec, type JobOrchestrationRun, type JobRepairOptions, type JobRepairRunState, type JobTaskBase, type JobTaskDependency, type JobTaskRunState, type JobWaitOptions, type JobsSubmitRequest, type LakebaseBranchOptions, type LakebaseCheckOptions, type LakebaseControlClient, type LiveCheck, type LiveCheckContext, type LiveCheckResult, type LiveCheckStatus, type LiveEvidence, type LiveSuiteRuntime, type LiveSuiteSpec, type MockDatabricksClient, type NotebookJobTask, type PipelineJobTask, type PollOptions, type PythonWheelJobTask, type RecordedCall, type RunJobTask, type RunTargetPackOptions, type SecretRotationCheckOptions, type SparkJarJobTask, type SparkPythonJobTask, type SparkSubmitJobTask, type SqlJobTask, TableFixture, type TargetPack, type TargetPackDoctorCheck, type TargetPackDoctorRequirement, type TargetPackDoctorResult, type TargetPackEvidenceMetadata, type TargetPackMaturity, type TargetPackRequirement, type TargetPackSpec, type TestProfile, type VolumeIOCheckOptions, type WorkspaceClientLike, type WorkspaceContextOptions, appHealthCheck, assertDeltaContract, autoLoaderIngestionCheck, backupRestoreCheck, builtinTargetPacks, classicComputeCheck, compareToGolden, createAppsOperationalFoundationPack, createBuiltinTargetPacks, createClientFromEnv, createDuckDbContext, createEphemeralLakebaseBranch, createExecutionContext, createFoundationTargetPacks, createJobsCodeFoundationPack, createLakebaseTestProvider, createLakeflowFoundationPack, createLakeflowJobsTargetPack, createMockDatabricksClient, createSqlDeltaFoundationPack, createTargetPackRegistry, createUnityStorageFoundationPack, createWorkspaceContext, customLiveCheck, dbtBuildCheck, defineLiveSuite, defineTargetPack, defineTargetPackRun, deleteEphemeralLakebaseBranch, deleteVolumeFile, deltaContractCheck, doctorTargetPack, ensureVolumeDirectory, expectQueryToMatchGolden, expectTable, failureRecoveryCheck, foundationTargetPacks, jobRunCheck, jobsCertificationCheck, jobsOrchestrationCheck, lakebaseCredentialCheck, lakebaseRoundTripCheck, normalizeJobRun, normalizeRow, normalizeVolumeRoot, notebookSubmitCheck, parseJobOrchestrationLiveSpec, parseStatementRows, performanceBudgetCheck, pipelineRefreshCheck, renderJUnit, resolveLakebaseProject, resolveProfile, resolveTokenProvider, restrictedPrincipalCheck, rollbackCheck, runLiveSuite, runTargetPack, secretRotationCheck, secretScopeCheck, serverlessComputeCheck, sqlRoundTripCheck, toLakebaseBranchId, toNamedParameters, unityCatalogAccessCheck, uploadVolumeFile, validateJobGraph, volumeIOCheck, waitForPipelineUpdate };
+export { type AppHealthCheckOptions, type AutoLoaderCheckOptions, type ConditionJobTask, type CreateContextOptions, type DashboardResource, DatabricksAdvancedWorkloadsAdapter, type DatabricksJobTask, DatabricksJobsAdapter, type DbtJobTask, type DefinedLiveSuite, type DefinedTargetPackRun, type DeltaColumnContract, type DuckDbConnectionLike, type DuckDbContextOptions, type EphemeralLakebaseBranch, type ExecutionContext, type ForEachJobTask, type GenieSpaceResource, type JobOrchestrationLiveSpec, type JobOrchestrationRun, type JobRepairOptions, type JobRepairRunState, type JobTaskBase, type JobTaskDependency, type JobTaskRunState, type JobWaitOptions, type JobsSubmitRequest, type LakebaseBranchOptions, type LakebaseCheckOptions, type LakebaseControlClient, type LiveCheck, type LiveCheckContext, type LiveCheckResult, type LiveCheckStatus, type LiveEvidence, type LiveSuiteRuntime, type LiveSuiteSpec, type MockDatabricksClient, type NotebookJobTask, type PipelineJobTask, type PipelineResource, type PollOptions, type PythonWheelJobTask, type RecordedCall, type RegionalDrCheckOptions, type RegisteredModelResource, type RunJobTask, type RunTargetPackOptions, type SecretRotationCheckOptions, type ServingEndpointResource, type SparkJarJobTask, type SparkPythonJobTask, type SparkSubmitJobTask, type SqlJobTask, TableFixture, type TargetPack, type TargetPackDoctorCheck, type TargetPackDoctorRequirement, type TargetPackDoctorResult, type TargetPackEvidenceMetadata, type TargetPackMaturity, type TargetPackRequirement, type TargetPackSpec, type TestProfile, type VectorSearchEndpointResource, type VectorSearchIndexResource, type VolumeIOCheckOptions, type WorkspaceClientLike, type WorkspaceContextOptions, advancedStreamingCdcCheck, aiBiDashboardCheck, appHealthCheck, assertDeltaContract, autoLoaderIngestionCheck, backupRestoreCheck, builtinTargetPacks, classicComputeCheck, compareToGolden, createAdvancedStreamingTargetPack, createAdvancedTargetPacks, createAiBiGenieTargetPack, createAppsOperationalFoundationPack, createBuiltinTargetPacks, createClientFromEnv, createDuckDbContext, createEphemeralLakebaseBranch, createExecutionContext, createFeatureEngineeringTargetPack, createFederationSharingTargetPack, createFoundationTargetPacks, createJobsCodeFoundationPack, createLakebaseTestProvider, createLakeflowFoundationPack, createLakeflowJobsTargetPack, createMlflowLifecycleTargetPack, createMockDatabricksClient, createModelServingTargetPack, createSecurityCostDrTargetPack, createSqlDeltaFoundationPack, createTargetPackRegistry, createUnityStorageFoundationPack, createVectorRagAgentsTargetPack, createWorkspaceContext, customLiveCheck, dbtBuildCheck, defineLiveSuite, defineTargetPack, defineTargetPackRun, deleteEphemeralLakebaseBranch, deleteVolumeFile, deltaContractCheck, doctorTargetPack, ensureVolumeDirectory, expectQueryToMatchGolden, expectTable, failureRecoveryCheck, featureEngineeringServingCheck, federationSharingCleanRoomsCheck, foundationTargetPacks, genieCheck, jobRunCheck, jobsCertificationCheck, jobsOrchestrationCheck, lakebaseCredentialCheck, lakebaseRoundTripCheck, lakeflowConnectCheck, mlflowLifecycleCheck, modelServingCheck, normalizeJobRun, normalizeRow, normalizeVolumeRoot, notebookSubmitCheck, parseJobOrchestrationLiveSpec, parseStatementRows, performanceBudgetCheck, pipelineRefreshCheck, ragAgentCheck, regionalDrCheck, renderJUnit, resolveLakebaseProject, resolveProfile, resolveTokenProvider, restrictedPrincipalCheck, rollbackCheck, runLiveSuite, runTargetPack, secretRotationCheck, secretScopeCheck, securityPostureCostCheck, serverlessComputeCheck, sqlRoundTripCheck, toLakebaseBranchId, toNamedParameters, unityCatalogAccessCheck, uploadVolumeFile, validateJobGraph, vectorSearchCheck, volumeIOCheck, waitForPipelineUpdate };