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

package/build/compute-pools/index.d.ts

@@ -7,6 +7,13 @@ import type { ComputePoolResponse, CreateComputePoolRequest, ListComputePoolsPar
  */
 export declare class ComputePoolsApi extends BaseApi {
     private computePoolsResourcePath;
+    /**
+     * The company-level default lives under `/company`, not under the data
+     * plane, because the backend groups it with the company's other settings
+     * (`CompanyComputePoolRoutes`). It is a compute-pool setting to a caller,
+     * which is why the two methods that use it live on this class.
+     */
+    private companyDefaultResourcePath;
     /**
      * List compute pools for a data plane.
      *
@@ -40,4 +47,30 @@ export declare class ComputePoolsApi extends BaseApi {
      * @see {@link https://docs.narrative.io/api-reference/compute-pools/archive-a-compute-pool}
      */
     archiveComputePool(dataPlaneId: string, computePoolId: string): Promise<void>;
+    /**
+     * Set the calling company's own default compute pool on one data plane.
+     *
+     * Level 3 of the pool resolution chain: what the company's jobs run on when
+     * neither the job (level 1) nor the dataset (level 2) pins a pool, taking
+     * precedence over the plane owner's default (level 4,
+     * {@link DataPlaneApi.setDefaultComputePool}). Unlike that one, this works on
+     * any plane the company can reach, not only planes it owns.
+     *
+     * `companyId` must be the authenticated company — the route answers 404 for
+     * any other. The pool must be active, live on `dataPlaneId`, and be one the
+     * company may use (owned, or shared with it through `use` collaborators),
+     * which is exactly the set `listComputePools` returns.
+     *
+     * Replaces any existing default for that plane; other planes' entries are
+     * untouched. Answers 204 and returns nothing — the new value shows up as
+     * `default_source` on the next {@link ComputePoolsApi.listComputePools}.
+     */
+    setCompanyDefaultComputePool(companyId: number, dataPlaneId: string, computePoolId: string): Promise<void>;
+    /**
+     * Clear the calling company's own default compute pool on one data plane,
+     * letting its jobs fall through to the plane owner's default.
+     *
+     * Idempotent: clearing when nothing is set is a no-op and still answers 204.
+     */
+    clearCompanyDefaultComputePool(companyId: number, dataPlaneId: string): Promise<void>;
 }

package/build/compute-pools/index.js

@@ -8,6 +8,15 @@ export class ComputePoolsApi extends BaseApi {
     computePoolsResourcePath(dataPlaneId) {
         return `data-planes/${dataPlaneId}/compute-pools`;
     }
+    /**
+     * The company-level default lives under `/company`, not under the data
+     * plane, because the backend groups it with the company's other settings
+     * (`CompanyComputePoolRoutes`). It is a compute-pool setting to a caller,
+     * which is why the two methods that use it live on this class.
+     */
+    companyDefaultResourcePath(companyId, dataPlaneId) {
+        return `company/${companyId}/data-planes/${dataPlaneId}/default-compute-pool`;
+    }
     /**
      * List compute pools for a data plane.
      *
@@ -51,4 +60,34 @@ export class ComputePoolsApi extends BaseApi {
     async archiveComputePool(dataPlaneId, computePoolId) {
         await this.delete(`${this.computePoolsResourcePath(dataPlaneId)}/${computePoolId}`);
     }
+    /**
+     * Set the calling company's own default compute pool on one data plane.
+     *
+     * Level 3 of the pool resolution chain: what the company's jobs run on when
+     * neither the job (level 1) nor the dataset (level 2) pins a pool, taking
+     * precedence over the plane owner's default (level 4,
+     * {@link DataPlaneApi.setDefaultComputePool}). Unlike that one, this works on
+     * any plane the company can reach, not only planes it owns.
+     *
+     * `companyId` must be the authenticated company — the route answers 404 for
+     * any other. The pool must be active, live on `dataPlaneId`, and be one the
+     * company may use (owned, or shared with it through `use` collaborators),
+     * which is exactly the set `listComputePools` returns.
+     *
+     * Replaces any existing default for that plane; other planes' entries are
+     * untouched. Answers 204 and returns nothing — the new value shows up as
+     * `default_source` on the next {@link ComputePoolsApi.listComputePools}.
+     */
+    async setCompanyDefaultComputePool(companyId, dataPlaneId, computePoolId) {
+        await this.put(`${this.companyDefaultResourcePath(companyId, dataPlaneId)}/${computePoolId}`, undefined);
+    }
+    /**
+     * Clear the calling company's own default compute pool on one data plane,
+     * letting its jobs fall through to the plane owner's default.
+     *
+     * Idempotent: clearing when nothing is set is a no-op and still answers 204.
+     */
+    async clearCompanyDefaultComputePool(companyId, dataPlaneId) {
+        await this.delete(this.companyDefaultResourcePath(companyId, dataPlaneId));
+    }
 }

package/build/compute-pools/types.d.ts

@@ -1,5 +1,16 @@
 export type ComputePoolType = "owned" | "shared";
 export type ComputePoolStatus = "active" | "archived";
+/**
+ * Which level made a pool the *authenticated company's* default on its data
+ * plane.
+ *
+ * `company` is the company's own setting for that plane
+ * ({@link ComputePoolsApi.setCompanyDefaultComputePool}) and takes precedence;
+ * `data_plane` is the default the plane's owner set
+ * ({@link DataPlaneApi.setDefaultComputePool}), which every collaborating
+ * company falls through to when it has no default of its own.
+ */
+export type ComputePoolDefaultSource = "company" | "data_plane";
 export type ComputePoolSize = "x_small" | "small" | "medium" | "large" | "x_large" | "2x_large" | "3x_large" | "4x_large" | "5x_large" | "6x_large";
 export type SnowflakeWarehouseSize = ComputePoolSize;
 /**
@@ -89,6 +100,18 @@ export interface ComputePoolOwnedResponse {
     tags: string[];
     provider: ComputePoolProvider;
     collaborators: ComputePoolCollaborators;
+    /**
+     * Set when this pool is the one the authenticated company's jobs run on when
+     * they don't name one themselves, and says which level made it the default.
+     * `null` on every other pool, and at most one active pool per data plane
+     * carries a non-null value.
+     *
+     * Only the pool the resolution actually landed on is marked. A company that
+     * has set its own default therefore leaves the *plane's* default pool
+     * reporting `null` here — read {@link DataPlane.default_compute_pool_id} for
+     * that one.
+     */
+    default_source: ComputePoolDefaultSource | null;
 }
 export interface ComputePoolSharedResponse {
     type: "shared";
@@ -104,6 +127,8 @@ export interface ComputePoolSharedResponse {
     updated_at?: string;
     tags: string[];
     provider: ComputePoolProvider;
+    /** Behaves exactly as it does on {@link ComputePoolOwnedResponse}. */
+    default_source: ComputePoolDefaultSource | null;
 }
 export type ComputePoolResponse = ComputePoolOwnedResponse | ComputePoolSharedResponse;
 export interface CreateComputePoolRequestCommon {

package/build/compute-pools/types.test-d.d.ts

@@ -58,6 +58,30 @@ export type AwsResponse = AssertTrue<IsAssignable<{
             type: "none";
         };
     };
+    default_source: null;
+}, ComputePoolResponse>>;
+/**
+ * `default_source` is required, not optional. The API sends it on every pool —
+ * `null` on the ones that aren't the default — so a response missing it
+ * entirely is one the server does not produce.
+ */
+export type ResponseWithoutDefaultSource = AssertFalse<IsAssignable<{
+    type: "owned";
+    id: string;
+    company_id: number;
+    data_plane_id: string;
+    external_id: AwsEmrExternalId;
+    name: string;
+    display_name: string;
+    status: "active";
+    created_at: string;
+    tags: string[];
+    provider: AwsEmrProvider;
+    collaborators: {
+        use: {
+            type: "none";
+        };
+    };
 }, ComputePoolResponse>>;
 export type SnowflakeResponse = AssertTrue<IsAssignable<{
     type: "shared";
@@ -71,5 +95,6 @@ export type SnowflakeResponse = AssertTrue<IsAssignable<{
     created_at: string;
     tags: string[];
     provider: SnowflakeWarehouseProvider;
+    default_source: "data_plane";
 }, ComputePoolResponse>>;
 export {};

package/build/jobs/index.d.ts

@@ -1,6 +1,6 @@
 import { BaseApi } from "../base-api";
 import type { ApiRecordsV2, OffsetPagination } from "../types";
-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";
+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";
 import { isKnownJob, KNOWN_JOB_TYPES } from "./types";
 type JobStateFilter = "cancelled" | "completed" | "failed" | "pending" | "pending_cancellation" | "running" | "scheduled";
 interface GetJobsParameters extends OffsetPagination {
@@ -36,4 +36,4 @@ declare class JobsApi extends BaseApi {
      */
     cancelJob(jobId: string): Promise<Job>;
 }
-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, };
+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, };

package/build/jobs/types.d.ts

@@ -48,7 +48,7 @@ type WithResult<J, R> = Omit<J, "result"> & {
  * run as `datasets_execute_select`. Where no operator of its own exists, it
  * equals `type`.
  */
-type BaseJob = WithRequestSource<components["schemas"]["JobBase"]>;
+export type BaseJob = WithRequestSource<components["schemas"]["JobBase"]>;
 export type ExplainInput = components["schemas"]["NqlForecastJobInput"];
 /**
  * The forecast, or the reason it could not be produced. Exactly one of

package/build/testing/types.d.ts

@@ -1,4 +1,5 @@
 import type { components } from "../generated/api-types";
+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";
 /** A data plane as the API returns it, owned or shared. */
 export type DataPlaneResponse = components["schemas"]["DataPlaneResponse"];
 /**
@@ -30,36 +31,36 @@ export type DataPlanePlatform = components["schemas"]["Platform"];
  */
 export type DataPlaneSharedPlatform = components["schemas"]["PlatformSharedResponse"];
 /** A job as the API returns it, including the one a health check enqueues. */
-export type JobResponse = components["schemas"]["JobResponse"];
+export type JobResponse = Job;
 /**
  * The fields every job carries, whatever its type. Exported so a test can build
  * a job type the fixtures do not cover without restating the envelope.
  */
-export type JobEnvelope = components["schemas"]["JobBase"];
-export type MaterializeViewJobResponse = components["schemas"]["MaterializeViewJobResponse"];
-export type NqlForecastJobResponse = components["schemas"]["NqlForecastJobResponse"];
-export type DatasetsSampleJobResponse = components["schemas"]["DatasetsSampleJobResponse"];
-export type DatasetsCalculateColumnStatsJobResponse = components["schemas"]["DatasetsCalculateColumnStatsJobResponse"];
-export type CollectAccessRulesBillingDataJobResponse = components["schemas"]["CollectAccessRulesBillingDataJobResponse"];
-export type DatasetsDeliverDataJobResponse = components["schemas"]["DatasetsDeliverDataJobResponse"];
-export type ModelInferenceRunJobResponse = components["schemas"]["ModelInferenceRunJobResponse"];
-export type DatasetsDeleteTableJobResponse = components["schemas"]["DatasetsDeleteTableJobResponse"];
-export type DatasetsExecuteDmlJobResponse = components["schemas"]["DatasetsExecuteDmlJobResponse"];
-export type DatasetsCreateTableJobResponse = components["schemas"]["DatasetsCreateTableJobResponse"];
-export type DatasetsTruncateTableJobResponse = components["schemas"]["DatasetsTruncateTableJobResponse"];
-export type DatasetsEnforceTableTtlRetentionPolicyJobResponse = components["schemas"]["DatasetsEnforceTableTtlRetentionPolicyJobResponse"];
-export type DatasetsEnforceRowTtlRetentionPolicyJobResponse = components["schemas"]["DatasetsEnforceRowTtlRetentionPolicyJobResponse"];
-export type DatasetsCalculateAffectedRowsJobResponse = components["schemas"]["DatasetsCalculateAffectedRowsJobResponse"];
-export type ModelTrainingRunJobResponse = components["schemas"]["ModelTrainingRunJobResponse"];
-export type ModelsDeliverModelJobResponse = components["schemas"]["ModelsDeliverModelJobResponse"];
-export type ModelsTrainClassifierJobResponse = components["schemas"]["ModelsTrainClassifierJobResponse"];
-export type HealthCheckJobResponse = components["schemas"]["HealthCheckJobResponse"];
+export type JobEnvelope = BaseJob;
+export type MaterializeViewJobResponse = MaterializedViewJob;
+export type NqlForecastJobResponse = ExplainJob;
+export type DatasetsSampleJobResponse = DatasetsSampleJob;
+export type DatasetsCalculateColumnStatsJobResponse = DatasetsCalculateColumnStatsJob;
+export type CollectAccessRulesBillingDataJobResponse = CollectAccessRulesBillingDataJob;
+export type DatasetsDeliverDataJobResponse = DatasetsDeliverDataJob;
+export type ModelInferenceRunJobResponse = ModelInferenceRunJob;
+export type DatasetsDeleteTableJobResponse = DatasetsDeleteTableJob;
+export type DatasetsExecuteDmlJobResponse = DatasetsExecuteDmlJob;
+export type DatasetsCreateTableJobResponse = DatasetsCreateTableJob;
+export type DatasetsTruncateTableJobResponse = DatasetsTruncateTableJob;
+export type DatasetsEnforceTableTtlRetentionPolicyJobResponse = DatasetsEnforceTableTtlRetentionPolicyJob;
+export type DatasetsEnforceRowTtlRetentionPolicyJobResponse = DatasetsEnforceRowTtlRetentionPolicyJob;
+export type DatasetsCalculateAffectedRowsJobResponse = CalculateAffectedRowsJob;
+export type ModelTrainingRunJobResponse = ModelTrainingRunJob;
+export type ModelsDeliverModelJobResponse = ModelsDeliverModelJob;
+export type ModelsTrainClassifierJobResponse = ModelsTrainClassifierJob;
+export type HealthCheckJobResponse = HealthCheckJob;
 /**
  * A job whose type the spec does not describe a branch for. Job types are free
  * strings on the server, so this is what a type added after the spec was
  * generated decodes as, with `input` and `result` left free-form.
  */
-export type OtherJobResponse = components["schemas"]["OtherJobResponse"];
+export type OtherJobResponse = UnknownJob;
 /**
  * A derivation rule as the API returns it. `warnings` is populated on create
  * and update responses and empty on reads.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@narrative.io/data-collaboration-sdk-ts",
-	"version": "4.5.0",
+	"version": "4.7.0",
 	"main": "build/index.js",
 	"repository": "github:narrative-io/data-collaboration-sdk-ts",
 	"source": "src/index.ts",
@@ -86,7 +86,7 @@
 		"@babel/core": "8.0.1",
 		"@babel/preset-env": "8.0.2",
 		"@babel/preset-typescript": "8.0.1",
-		"@biomejs/biome": "2.5.5",
+		"@biomejs/biome": "2.5.6",
 		"@commitlint/cli": "21.2.1",
 		"@commitlint/config-conventional": "21.2.0",
 		"@types/jest": "30.0.0",