@narrative.io/data-collaboration-sdk-ts 4.3.1 → 4.4.0

package/build/testing/fixtures/data-planes.d.ts

@@ -1,10 +1,25 @@
-import type { DataPlaneOwnedResponse, JobResponse } from "../types";
+import type { DataPlaneOwnedResponse, DataPlaneSharedResponse, JobResponse } from "../types";
 /**
  * An owned, active data plane. Every field the spec requires is filled in, so a
  * caller only overrides what its assertion is about. The optional fields are
  * present and `null`, which is what the API sends for an absent value — a mock
  * that omitted them would let a consumer assert `undefined` and still pass.
  */
-export declare function createDataPlane(overrides?: Partial<DataPlaneOwnedResponse>): DataPlaneOwnedResponse;
+export declare function createOwnedDataPlane(overrides?: Partial<DataPlaneOwnedResponse>): DataPlaneOwnedResponse;
+/**
+ * A data plane shared with the calling company, active, on AWS. Shared planes
+ * belong to someone else, so this one carries a different `company_id` and id
+ * than {@link createOwnedDataPlane} — seeding both gives you two records.
+ *
+ * Optional fields are present and `null` for the same reason as on the owned
+ * factory. For the other platform the API serves, override it:
+ *
+ * ```ts
+ * createSharedDataPlane({
+ *   platform: { type: "platform_shared_snowflake", region: null },
+ * });
+ * ```
+ */
+export declare function createSharedDataPlane(overrides?: Partial<DataPlaneSharedResponse>): DataPlaneSharedResponse;
 /** The job a health check enqueues, pending and not yet attempted. */
 export declare function createHealthCheckJob(overrides?: Partial<JobResponse>): JobResponse;

package/build/testing/fixtures/data-planes.js

@@ -5,7 +5,7 @@ const TIMESTAMP = "2026-01-01T00:00:00Z";
  * present and `null`, which is what the API sends for an absent value — a mock
  * that omitted them would let a consumer assert `undefined` and still pass.
  */
-export function createDataPlane(overrides = {}) {
+export function createOwnedDataPlane(overrides = {}) {
     return {
         type: "owned",
         id: "5f9d1a4e-0000-4000-8000-000000000001",
@@ -32,6 +32,41 @@ export function createDataPlane(overrides = {}) {
         ...overrides,
     };
 }
+/**
+ * A data plane shared with the calling company, active, on AWS. Shared planes
+ * belong to someone else, so this one carries a different `company_id` and id
+ * than {@link createOwnedDataPlane} — seeding both gives you two records.
+ *
+ * Optional fields are present and `null` for the same reason as on the owned
+ * factory. For the other platform the API serves, override it:
+ *
+ * ```ts
+ * createSharedDataPlane({
+ *   platform: { type: "platform_shared_snowflake", region: null },
+ * });
+ * ```
+ */
+export function createSharedDataPlane(overrides = {}) {
+    return {
+        type: "shared",
+        id: "5f9d1a4e-0000-4000-8000-000000000002",
+        company_id: 2,
+        created_at: TIMESTAMP,
+        display_name: "Test Shared Data Plane",
+        platform: {
+            type: "platform_shared_aws",
+            region: { type: "region_aws", id: "us-east-1" },
+        },
+        status: "active",
+        updated_at: TIMESTAMP,
+        compute_pools: [],
+        description: null,
+        tags: null,
+        last_heartbeat_at: null,
+        default_compute_pool_id: null,
+        ...overrides,
+    };
+}
 /** The job a health check enqueues, pending and not yet attempted. */
 export function createHealthCheckJob(overrides = {}) {
     return {

package/build/testing/fixtures/index.d.ts

@@ -1 +1 @@
-export { createDataPlane, createHealthCheckJob } from "./data-planes";
+export { createHealthCheckJob, createOwnedDataPlane, createSharedDataPlane, } from "./data-planes";

package/build/testing/fixtures/index.js

@@ -1 +1 @@
-export { createDataPlane, createHealthCheckJob } from "./data-planes";
+export { createHealthCheckJob, createOwnedDataPlane, createSharedDataPlane, } from "./data-planes";

package/build/testing/handlers/data-planes.js

@@ -1,5 +1,5 @@
 import { rejectUnauthenticated } from "../auth";
-import { createDataPlane, createHealthCheckJob } from "../fixtures/data-planes";
+import { createHealthCheckJob, createOwnedDataPlane, } from "../fixtures/data-planes";
 /**
  * Records live for the lifetime of one `createHandlers()` call, so each test
  * suite gets its own copy and writes from one test can't leak into another.
@@ -16,7 +16,7 @@ function findOwned(store, id) {
     const record = store.find(id);
     return record?.type === "owned" ? record : undefined;
 }
-export function createDataPlaneHandlers(http, auth, seed = [createDataPlane()]) {
+export function createDataPlaneHandlers(http, auth, seed = [createOwnedDataPlane()]) {
     const store = createStore(seed);
     return [
         http.get("/data-planes", ({ request, cookies, response }) => {
@@ -49,7 +49,9 @@ export function createDataPlaneHandlers(http, auth, seed = [createDataPlane()])
             const record = findOwned(store, params.data_plane_id);
             if (!record)
                 return response(404).empty();
-            record.default_compute_pool_id = undefined;
+            // null, not undefined: the encoder emits the key with an explicit
+            // null, and JSON.stringify would drop an undefined one entirely.
+            record.default_compute_pool_id = null;
             return response(200).json(record);
         }),
         http.post("/data-planes/{data_plane_id}/health-check", async ({ params, request, cookies, response }) => {

package/build/testing/index.d.ts

@@ -7,12 +7,20 @@
  *
  * ```ts
  * import { setupServer } from "msw/node";
- * import { createHandlers, createDataPlane } from "@narrative.io/data-collaboration-sdk-ts/testing";
+ * import {
+ * 	createHandlers,
+ * 	createOwnedDataPlane,
+ * 	createSharedDataPlane,
+ * } from "@narrative.io/data-collaboration-sdk-ts/testing";
  *
- * const server = setupServer(...createHandlers({ dataPlanes: [createDataPlane()] }));
+ * const server = setupServer(
+ * 	...createHandlers({
+ * 		dataPlanes: [createOwnedDataPlane(), createSharedDataPlane()],
+ * 	}),
+ * );
  * ```
  */
-export { createDataPlane, createHealthCheckJob } from "./fixtures";
+export { createHealthCheckJob, createOwnedDataPlane, createSharedDataPlane, } from "./fixtures";
 export { createHandlers } from "./handlers";
 export { createDataPlaneHandlers } from "./handlers/data-planes";
-export type { AuthGuard, AuthGuardContext, CreateHandlersOptions, DataPlaneOwnedResponse, DataPlaneResponse, JobResponse, } from "./types";
+export type { AuthGuard, AuthGuardContext, CreateHandlersOptions, DataPlaneOwnedResponse, DataPlanePlatform, DataPlaneResponse, DataPlaneSharedPlatform, DataPlaneSharedResponse, JobResponse, } from "./types";

package/build/testing/index.js

@@ -7,11 +7,19 @@
  *
  * ```ts
  * import { setupServer } from "msw/node";
- * import { createHandlers, createDataPlane } from "@narrative.io/data-collaboration-sdk-ts/testing";
+ * import {
+ * 	createHandlers,
+ * 	createOwnedDataPlane,
+ * 	createSharedDataPlane,
+ * } from "@narrative.io/data-collaboration-sdk-ts/testing";
  *
- * const server = setupServer(...createHandlers({ dataPlanes: [createDataPlane()] }));
+ * const server = setupServer(
+ * 	...createHandlers({
+ * 		dataPlanes: [createOwnedDataPlane(), createSharedDataPlane()],
+ * 	}),
+ * );
  * ```
  */
-export { createDataPlane, createHealthCheckJob } from "./fixtures";
+export { createHealthCheckJob, createOwnedDataPlane, createSharedDataPlane, } from "./fixtures";
 export { createHandlers } from "./handlers";
 export { createDataPlaneHandlers } from "./handlers/data-planes";

package/build/testing/types.d.ts

@@ -1,8 +1,34 @@
 import type { components } from "../generated/api-types";
 /** A data plane as the API returns it, owned or shared. */
 export type DataPlaneResponse = components["schemas"]["DataPlaneResponse"];
-/** A data plane this company owns. Only owned planes have a default compute pool. */
+/**
+ * A data plane this company owns. Only owned planes carry an external id and
+ * collaborators, and only they accept the default-compute-pool endpoints.
+ */
 export type DataPlaneOwnedResponse = components["schemas"]["DataPlaneOwnedResponse"];
+/**
+ * A data plane shared with this company. Same shape as the owned variant minus
+ * `external_id` and `collaborators`, and its platform is one of the
+ * `platform_shared_*` types rather than the owned ones.
+ */
+export type DataPlaneSharedResponse = components["schemas"]["DataPlaneSharedResponse"];
+/**
+ * The platform an owned data plane runs on — AWS or Snowflake.
+ *
+ * Both factories default to AWS, so a test that needs another variant passes
+ * this as a `platform` override. Named after the root entry point's
+ * `DataPlanePlatform` rather than the generated schema's bare `Platform`, so
+ * the two entry points read the same way — the two are assignable in both
+ * directions.
+ */
+export type DataPlanePlatform = components["schemas"]["Platform"];
+/**
+ * The platform a shared data plane runs on. Distinct from
+ * {@link DataPlanePlatform}: the discriminators are the `platform_shared_*`
+ * ones, and `region` is required on the AWS variant but optional and nullable
+ * on the Snowflake one.
+ */
+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 interface AuthGuardContext {

package/package.json

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