@narrative.io/data-collaboration-sdk-ts 4.5.0 → 4.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  import { BaseApi } from "../base-api";
2
2
  import type { ApiRecordsV2, OffsetPagination } from "../types";
3
- import type { CalculateAffectedRowsInput, CalculateAffectedRowsJob, CollectAccessRulesBillingDataInput, CollectAccessRulesBillingDataJob, CollectAccessRulesBillingDataResult, ColumnDetails, ColumnStatDataType, CostsInput, CostsJob, CreateTableInput, DatasetsCalculateColumnStatsJob, DatasetsCreateTableJob, DatasetsDeleteTableJob, DatasetsDeliverDataJob, DatasetsEnforceRowTtlRetentionPolicyJob, DatasetsEnforceTableTtlRetentionPolicyJob, DatasetsExecuteDmlJob, DatasetsExecuteSelectJob, DatasetsSampleJob, DatasetsSuggestMappingsJob, DatasetsTruncateTableJob, DeleteInput, DeliverInput, EnabledColumnStatFlags, EnforceRowTtlRetentionPolicyInput, EnforceTableTtlRetentionPolicyInput, ExecuteDmlInput, ExecuteDmlResult, ExecuteSelectInput, ExecuteSelectResult, ExplainInput, ExplainJob, ExplainOutput, ForecastInput, ForecastInternalJob, ForecastJob, HealthCheckJob, Job, JobExecutionCluster, JobRequestSource, JobRequestSourceApiUser, JobRequestSourceProcess, JobType, KnownJob, MaterializedViewInput, MaterializedViewJob, MaterializedViewOutput, MaterializedViewRowStats, ModelInferenceRunInput, ModelInferenceRunJob, ModelInferenceRunJobResult, ModelsDeliverModelInput, ModelsDeliverModelJob, ModelsTrainClassifierJob, ModelTrainingRunInput, ModelTrainingRunJob, RefreshMaterializedViewResult, SampleInput, StatsInput, StatsInputV2, SuggestMappingsInput, SuggestMappingsResult, TruncateTableInput } from "./types";
3
+ import type { BaseJob, CalculateAffectedRowsInput, CalculateAffectedRowsJob, CollectAccessRulesBillingDataInput, CollectAccessRulesBillingDataJob, CollectAccessRulesBillingDataResult, ColumnDetails, ColumnStatDataType, CostsInput, CostsJob, CreateTableInput, DatasetsCalculateColumnStatsJob, DatasetsCreateTableJob, DatasetsDeleteTableJob, DatasetsDeliverDataJob, DatasetsEnforceRowTtlRetentionPolicyJob, DatasetsEnforceTableTtlRetentionPolicyJob, DatasetsExecuteDmlJob, DatasetsExecuteSelectJob, DatasetsSampleJob, DatasetsSuggestMappingsJob, DatasetsTruncateTableJob, DeleteInput, DeliverInput, EnabledColumnStatFlags, EnforceRowTtlRetentionPolicyInput, EnforceTableTtlRetentionPolicyInput, ExecuteDmlInput, ExecuteDmlResult, ExecuteSelectInput, ExecuteSelectResult, ExplainInput, ExplainJob, ExplainOutput, ForecastInput, ForecastInternalJob, ForecastJob, HealthCheckJob, Job, JobExecutionCluster, JobRequestSource, JobRequestSourceApiUser, JobRequestSourceProcess, JobType, KnownJob, MaterializedViewInput, MaterializedViewJob, MaterializedViewOutput, MaterializedViewRowStats, ModelInferenceRunInput, ModelInferenceRunJob, ModelInferenceRunJobResult, ModelsDeliverModelInput, ModelsDeliverModelJob, ModelsTrainClassifierJob, ModelTrainingRunInput, ModelTrainingRunJob, RefreshMaterializedViewResult, SampleInput, StatsInput, StatsInputV2, SuggestMappingsInput, SuggestMappingsResult, TruncateTableInput, UnknownJob } from "./types";
4
4
  import { isKnownJob, KNOWN_JOB_TYPES } from "./types";
5
5
  type JobStateFilter = "cancelled" | "completed" | "failed" | "pending" | "pending_cancellation" | "running" | "scheduled";
6
6
  interface GetJobsParameters extends OffsetPagination {
@@ -36,4 +36,4 @@ declare class JobsApi extends BaseApi {
36
36
  */
37
37
  cancelJob(jobId: string): Promise<Job>;
38
38
  }
39
- export { type CalculateAffectedRowsInput, type CalculateAffectedRowsJob, type CollectAccessRulesBillingDataInput, type CollectAccessRulesBillingDataJob, type CollectAccessRulesBillingDataResult, type ColumnDetails, type ColumnStatDataType, type CostsInput, type CostsJob, type CreateTableInput, type DatasetsCalculateColumnStatsJob, type DatasetsCreateTableJob, type DatasetsDeleteTableJob, type DatasetsDeliverDataJob, type DatasetsEnforceRowTtlRetentionPolicyJob, type DatasetsEnforceTableTtlRetentionPolicyJob, type DatasetsExecuteDmlJob, type DatasetsExecuteSelectJob, type DatasetsSampleJob, type DatasetsSuggestMappingsJob, type DatasetsTruncateTableJob, type DeleteInput, type DeliverInput, type EnabledColumnStatFlags, type EnforceRowTtlRetentionPolicyInput, type EnforceTableTtlRetentionPolicyInput, type ExecuteDmlInput, type ExecuteDmlResult, type ExecuteSelectInput, type ExecuteSelectResult, type ExplainInput, type ExplainJob, type ExplainOutput, type ForecastInput, type ForecastInternalJob, type ForecastJob, type GetJobsParameters, type HealthCheckJob, isKnownJob, type Job, type JobExecutionCluster, type JobRequestSource, type JobRequestSourceApiUser, type JobRequestSourceProcess, type JobStateFilter, JobsApi, type JobType, KNOWN_JOB_TYPES, type KnownJob, type MaterializedViewInput, type MaterializedViewJob, type MaterializedViewOutput, type MaterializedViewRowStats, type ModelInferenceRunInput, type ModelInferenceRunJob, type ModelInferenceRunJobResult, type ModelsDeliverModelInput, type ModelsDeliverModelJob, type ModelsTrainClassifierJob, type ModelTrainingRunInput, type ModelTrainingRunJob, type RefreshMaterializedViewResult, type SampleInput, type StatsInput, type StatsInputV2, type SuggestMappingsInput, type SuggestMappingsResult, type TruncateTableInput, };
39
+ export { type BaseJob, type CalculateAffectedRowsInput, type CalculateAffectedRowsJob, type CollectAccessRulesBillingDataInput, type CollectAccessRulesBillingDataJob, type CollectAccessRulesBillingDataResult, type ColumnDetails, type ColumnStatDataType, type CostsInput, type CostsJob, type CreateTableInput, type DatasetsCalculateColumnStatsJob, type DatasetsCreateTableJob, type DatasetsDeleteTableJob, type DatasetsDeliverDataJob, type DatasetsEnforceRowTtlRetentionPolicyJob, type DatasetsEnforceTableTtlRetentionPolicyJob, type DatasetsExecuteDmlJob, type DatasetsExecuteSelectJob, type DatasetsSampleJob, type DatasetsSuggestMappingsJob, type DatasetsTruncateTableJob, type DeleteInput, type DeliverInput, type EnabledColumnStatFlags, type EnforceRowTtlRetentionPolicyInput, type EnforceTableTtlRetentionPolicyInput, type ExecuteDmlInput, type ExecuteDmlResult, type ExecuteSelectInput, type ExecuteSelectResult, type ExplainInput, type ExplainJob, type ExplainOutput, type ForecastInput, type ForecastInternalJob, type ForecastJob, type GetJobsParameters, type HealthCheckJob, isKnownJob, type Job, type JobExecutionCluster, type JobRequestSource, type JobRequestSourceApiUser, type JobRequestSourceProcess, type JobStateFilter, JobsApi, type JobType, KNOWN_JOB_TYPES, type KnownJob, type MaterializedViewInput, type MaterializedViewJob, type MaterializedViewOutput, type MaterializedViewRowStats, type ModelInferenceRunInput, type ModelInferenceRunJob, type ModelInferenceRunJobResult, type ModelsDeliverModelInput, type ModelsDeliverModelJob, type ModelsTrainClassifierJob, type ModelTrainingRunInput, type ModelTrainingRunJob, type RefreshMaterializedViewResult, type SampleInput, type StatsInput, type StatsInputV2, type SuggestMappingsInput, type SuggestMappingsResult, type TruncateTableInput, type UnknownJob, };
@@ -48,7 +48,7 @@ type WithResult<J, R> = Omit<J, "result"> & {
48
48
  * run as `datasets_execute_select`. Where no operator of its own exists, it
49
49
  * equals `type`.
50
50
  */
51
- type BaseJob = WithRequestSource<components["schemas"]["JobBase"]>;
51
+ export type BaseJob = WithRequestSource<components["schemas"]["JobBase"]>;
52
52
  export type ExplainInput = components["schemas"]["NqlForecastJobInput"];
53
53
  /**
54
54
  * The forecast, or the reason it could not be produced. Exactly one of
@@ -1,4 +1,5 @@
1
1
  import type { components } from "../generated/api-types";
2
+ import type { BaseJob, CalculateAffectedRowsJob, CollectAccessRulesBillingDataJob, DatasetsCalculateColumnStatsJob, DatasetsCreateTableJob, DatasetsDeleteTableJob, DatasetsDeliverDataJob, DatasetsEnforceRowTtlRetentionPolicyJob, DatasetsEnforceTableTtlRetentionPolicyJob, DatasetsExecuteDmlJob, DatasetsSampleJob, DatasetsTruncateTableJob, ExplainJob, HealthCheckJob, Job, MaterializedViewJob, ModelInferenceRunJob, ModelsDeliverModelJob, ModelsTrainClassifierJob, ModelTrainingRunJob, UnknownJob } from "../jobs/types";
2
3
  /** A data plane as the API returns it, owned or shared. */
3
4
  export type DataPlaneResponse = components["schemas"]["DataPlaneResponse"];
4
5
  /**
@@ -30,36 +31,36 @@ export type DataPlanePlatform = components["schemas"]["Platform"];
30
31
  */
31
32
  export type DataPlaneSharedPlatform = components["schemas"]["PlatformSharedResponse"];
32
33
  /** A job as the API returns it, including the one a health check enqueues. */
33
- export type JobResponse = components["schemas"]["JobResponse"];
34
+ export type JobResponse = Job;
34
35
  /**
35
36
  * The fields every job carries, whatever its type. Exported so a test can build
36
37
  * a job type the fixtures do not cover without restating the envelope.
37
38
  */
38
- export type JobEnvelope = components["schemas"]["JobBase"];
39
- export type MaterializeViewJobResponse = components["schemas"]["MaterializeViewJobResponse"];
40
- export type NqlForecastJobResponse = components["schemas"]["NqlForecastJobResponse"];
41
- export type DatasetsSampleJobResponse = components["schemas"]["DatasetsSampleJobResponse"];
42
- export type DatasetsCalculateColumnStatsJobResponse = components["schemas"]["DatasetsCalculateColumnStatsJobResponse"];
43
- export type CollectAccessRulesBillingDataJobResponse = components["schemas"]["CollectAccessRulesBillingDataJobResponse"];
44
- export type DatasetsDeliverDataJobResponse = components["schemas"]["DatasetsDeliverDataJobResponse"];
45
- export type ModelInferenceRunJobResponse = components["schemas"]["ModelInferenceRunJobResponse"];
46
- export type DatasetsDeleteTableJobResponse = components["schemas"]["DatasetsDeleteTableJobResponse"];
47
- export type DatasetsExecuteDmlJobResponse = components["schemas"]["DatasetsExecuteDmlJobResponse"];
48
- export type DatasetsCreateTableJobResponse = components["schemas"]["DatasetsCreateTableJobResponse"];
49
- export type DatasetsTruncateTableJobResponse = components["schemas"]["DatasetsTruncateTableJobResponse"];
50
- export type DatasetsEnforceTableTtlRetentionPolicyJobResponse = components["schemas"]["DatasetsEnforceTableTtlRetentionPolicyJobResponse"];
51
- export type DatasetsEnforceRowTtlRetentionPolicyJobResponse = components["schemas"]["DatasetsEnforceRowTtlRetentionPolicyJobResponse"];
52
- export type DatasetsCalculateAffectedRowsJobResponse = components["schemas"]["DatasetsCalculateAffectedRowsJobResponse"];
53
- export type ModelTrainingRunJobResponse = components["schemas"]["ModelTrainingRunJobResponse"];
54
- export type ModelsDeliverModelJobResponse = components["schemas"]["ModelsDeliverModelJobResponse"];
55
- export type ModelsTrainClassifierJobResponse = components["schemas"]["ModelsTrainClassifierJobResponse"];
56
- export type HealthCheckJobResponse = components["schemas"]["HealthCheckJobResponse"];
39
+ export type JobEnvelope = BaseJob;
40
+ export type MaterializeViewJobResponse = MaterializedViewJob;
41
+ export type NqlForecastJobResponse = ExplainJob;
42
+ export type DatasetsSampleJobResponse = DatasetsSampleJob;
43
+ export type DatasetsCalculateColumnStatsJobResponse = DatasetsCalculateColumnStatsJob;
44
+ export type CollectAccessRulesBillingDataJobResponse = CollectAccessRulesBillingDataJob;
45
+ export type DatasetsDeliverDataJobResponse = DatasetsDeliverDataJob;
46
+ export type ModelInferenceRunJobResponse = ModelInferenceRunJob;
47
+ export type DatasetsDeleteTableJobResponse = DatasetsDeleteTableJob;
48
+ export type DatasetsExecuteDmlJobResponse = DatasetsExecuteDmlJob;
49
+ export type DatasetsCreateTableJobResponse = DatasetsCreateTableJob;
50
+ export type DatasetsTruncateTableJobResponse = DatasetsTruncateTableJob;
51
+ export type DatasetsEnforceTableTtlRetentionPolicyJobResponse = DatasetsEnforceTableTtlRetentionPolicyJob;
52
+ export type DatasetsEnforceRowTtlRetentionPolicyJobResponse = DatasetsEnforceRowTtlRetentionPolicyJob;
53
+ export type DatasetsCalculateAffectedRowsJobResponse = CalculateAffectedRowsJob;
54
+ export type ModelTrainingRunJobResponse = ModelTrainingRunJob;
55
+ export type ModelsDeliverModelJobResponse = ModelsDeliverModelJob;
56
+ export type ModelsTrainClassifierJobResponse = ModelsTrainClassifierJob;
57
+ export type HealthCheckJobResponse = HealthCheckJob;
57
58
  /**
58
59
  * A job whose type the spec does not describe a branch for. Job types are free
59
60
  * strings on the server, so this is what a type added after the spec was
60
61
  * generated decodes as, with `input` and `result` left free-form.
61
62
  */
62
- export type OtherJobResponse = components["schemas"]["OtherJobResponse"];
63
+ export type OtherJobResponse = UnknownJob;
63
64
  /**
64
65
  * A derivation rule as the API returns it. `warnings` is populated on create
65
66
  * and update responses and empty on reads.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@narrative.io/data-collaboration-sdk-ts",
3
- "version": "4.5.0",
3
+ "version": "4.6.0",
4
4
  "main": "build/index.js",
5
5
  "repository": "github:narrative-io/data-collaboration-sdk-ts",
6
6
  "source": "src/index.ts",
@@ -86,7 +86,7 @@
86
86
  "@babel/core": "8.0.1",
87
87
  "@babel/preset-env": "8.0.2",
88
88
  "@babel/preset-typescript": "8.0.1",
89
- "@biomejs/biome": "2.5.5",
89
+ "@biomejs/biome": "2.5.6",
90
90
  "@commitlint/cli": "21.2.1",
91
91
  "@commitlint/config-conventional": "21.2.0",
92
92
  "@types/jest": "30.0.0",