@narrative.io/data-collaboration-sdk-ts 4.6.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/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@narrative.io/data-collaboration-sdk-ts",
-	"version": "4.6.0",
+	"version": "4.7.0",
 	"main": "build/index.js",
 	"repository": "github:narrative-io/data-collaboration-sdk-ts",
 	"source": "src/index.ts",