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

package/build/data-planes/types.d.ts

@@ -38,10 +38,11 @@ export interface SnowflakePlatform {
     account_name: string;
     organization_name: string;
     /**
-     * Optional: the platform can fail to parse a region when provisioning the
-     * Snowflake Native App. Informational only.
+     * The platform can fail to parse a region when provisioning the Snowflake
+     * Native App, so this is informational only. Responses always carry the key,
+     * with an explicit `null` when there is no region.
      */
-    region?: DataPlaneRegion;
+    region?: DataPlaneRegion | null;
 }
 /** Platform details returned for a data plane the calling company owns. */
 export type DataPlanePlatform = AwsPlatform | SnowflakePlatform;
@@ -51,7 +52,8 @@ export interface AwsSharedPlatform {
 }
 export interface SnowflakeSharedPlatform {
     type: "platform_shared_snowflake";
-    region?: DataPlaneRegion;
+    /** Nullable for the same reason as {@link SnowflakePlatform.region}. */
+    region?: DataPlaneRegion | null;
 }
 /**
  * Platform details returned for a data plane shared with you. Account
@@ -84,11 +86,21 @@ export interface DataPlaneOwnedResponse {
     status: DataPlaneStatus;
     updated_at: string;
     collaborators: DataPlaneCollaborators;
+    /**
+     * Always present, empty when the plane has no pools: the backend field is a
+     * plain `List`, never an `Option`.
+     */
     compute_pools: ComputePoolResponse[];
-    description?: string;
-    tags?: string[];
-    last_heartbeat_at?: string;
-    default_compute_pool_id?: string;
+    /**
+     * The response encoder does not drop nulls, so each of these four arrives as
+     * an explicit `null` when absent rather than being left out. `tags` is `null`
+     * for a plane with no tags too — `DataPlaneResponse.apply` maps an empty list
+     * to `None` — though a directly constructed response can still send `[]`.
+     */
+    description?: string | null;
+    tags?: string[] | null;
+    last_heartbeat_at?: string | null;
+    default_compute_pool_id?: string | null;
 }
 /**
  * A data plane shared with the calling company. Omits details like the external
@@ -104,11 +116,13 @@ export interface DataPlaneSharedResponse {
     platform: DataPlaneSharedPlatform;
     status: DataPlaneStatus;
     updated_at: string;
+    /** Required for the same reason as {@link DataPlaneOwnedResponse.compute_pools}. */
     compute_pools: ComputePoolResponse[];
-    description?: string;
-    tags?: string[];
-    last_heartbeat_at?: string;
-    default_compute_pool_id?: string;
+    /** Nullable for the same reason as on {@link DataPlaneOwnedResponse}. */
+    description?: string | null;
+    tags?: string[] | null;
+    last_heartbeat_at?: string | null;
+    default_compute_pool_id?: string | null;
 }
 /** Discriminated union of the owned/shared data plane response shapes. */
 export type DataPlane = DataPlaneOwnedResponse | DataPlaneSharedResponse;

package/build/generated/api-types.d.ts

@@ -2,7 +2,7 @@
  * GENERATED FILE — DO NOT EDIT.
  *
  * Source: https://docs-cdn.narrative.io/api-reference/main/openapi.json
- * Spec etag: W/"2579229b75ddefef951659560f71d465"
+ * Spec etag: W/"1b05b0fe6188a5d59c67bbde3678af08"
  *
  * Regenerate with: bun run generate:api-types
  */
@@ -24249,15 +24249,54 @@ export interface components {
             provider?: components["schemas"]["Provider"];
             collaborators?: components["schemas"]["ComputePoolCollaborators"];
         };
+        AwsRegion: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: "region_aws";
+            /** @description AWS region identifier, e.g. `us-east-1`. */
+            id: string;
+        };
         AwsPlatform: {
-            /** @enum {string} */
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
             type: "platform_aws";
-            region: string;
+            /** @description The 12-digit AWS account ID of the account hosting the data plane. */
+            account_id: string;
+            region: components["schemas"]["AwsRegion"];
         };
+        AzureRegion: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: "region_azure";
+            /** @description Azure region identifier, e.g. `uaenorth`. */
+            id: string;
+        };
+        GcpRegion: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: "region_gcp";
+            /** @description GCP region identifier, e.g. `us-east4`. */
+            id: string;
+        };
+        Region: components["schemas"]["AwsRegion"] | components["schemas"]["AzureRegion"] | components["schemas"]["GcpRegion"];
         SnowflakePlatform: {
-            /** @enum {string} */
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
             type: "platform_snowflake";
-            region?: string;
+            account_locator: string;
+            account_name: string;
+            organization_name: string;
+            region?: components["schemas"]["Region"] | null;
         };
         Platform: components["schemas"]["AwsPlatform"] | components["schemas"]["SnowflakePlatform"];
         "data-plane-collaborators_ParticipantsAll": {
@@ -24274,7 +24313,7 @@ export interface components {
              */
             type: "none";
         };
-        "data-plane-collaborators_CompanyId": string;
+        "data-plane-collaborators_CompanyId": number;
         "data-plane-collaborators_ParticipantsInclusion": {
             /**
              * @description discriminator enum property added by openapi-typescript
@@ -24297,60 +24336,73 @@ export interface components {
             manage_compute_pools: components["schemas"]["DataPlaneParticipants"];
         };
         DataPlaneOwnedResponse: {
-            /** @enum {string} */
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
             type: "owned";
             /** Format: uuid */
             id: string;
             company_id: number;
             /** Format: date-time */
             created_at: string;
-            description?: string;
+            description?: string | null;
             display_name: string;
             external_id: string;
             platform: components["schemas"]["Platform"];
             /** @enum {string} */
             status: "active" | "archived";
             /** Format: date-time */
-            last_heartbeat_at?: string;
-            tags?: string[];
+            last_heartbeat_at?: string | null;
+            tags?: string[] | null;
             /** Format: date-time */
             updated_at: string;
             collaborators: components["schemas"]["DataPlaneCollaborators"];
             /** Format: uuid */
-            default_compute_pool_id?: string;
-            compute_pools?: components["schemas"]["ComputePoolResponse"][];
+            default_compute_pool_id?: string | null;
+            compute_pools: components["schemas"]["ComputePoolResponse"][];
         };
         AwsSharedResponse: {
-            /** @enum {string} */
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
             type: "platform_shared_aws";
-            region: string;
+            region: components["schemas"]["AwsRegion"];
         };
         SnowflakeSharedResponse: {
-            /** @enum {string} */
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
             type: "platform_shared_snowflake";
-            region?: string;
+            region?: components["schemas"]["Region"] | null;
         };
         PlatformSharedResponse: components["schemas"]["AwsSharedResponse"] | components["schemas"]["SnowflakeSharedResponse"];
         DataPlaneSharedResponse: {
-            /** @enum {string} */
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
             type: "shared";
+            /** Format: uuid */
             id: string;
-            company_id: string;
+            company_id: number;
             /** Format: date-time */
             created_at: string;
-            description?: string;
+            description?: string | null;
             display_name: string;
             platform: components["schemas"]["PlatformSharedResponse"];
             /** @enum {string} */
             status: "active" | "archived";
             /** Format: date-time */
-            last_heartbeat_at?: string;
-            tags?: string[];
+            last_heartbeat_at?: string | null;
+            tags?: string[] | null;
             /** Format: date-time */
             updated_at: string;
             /** Format: uuid */
-            default_compute_pool_id?: string;
-            compute_pools?: components["schemas"]["ComputePoolResponse"][];
+            default_compute_pool_id?: string | null;
+            compute_pools: components["schemas"]["ComputePoolResponse"][];
         };
         DataPlaneResponse: components["schemas"]["DataPlaneOwnedResponse"] | components["schemas"]["DataPlaneSharedResponse"];
         GetDataPlanesResponse: {

package/build/generated/api-types.js

@@ -2,7 +2,7 @@
  * GENERATED FILE — DO NOT EDIT.
  *
  * Source: https://docs-cdn.narrative.io/api-reference/main/openapi.json
- * Spec etag: W/"2579229b75ddefef951659560f71d465"
+ * Spec etag: W/"1b05b0fe6188a5d59c67bbde3678af08"
  *
  * Regenerate with: bun run generate:api-types
  */

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

@@ -1,7 +1,9 @@
 import type { DataPlaneOwnedResponse, 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.
+ * 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;
 /** The job a health check enqueues, pending and not yet attempted. */

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

@@ -1,7 +1,9 @@
 const TIMESTAMP = "2026-01-01T00:00:00Z";
 /**
  * An owned, active data plane. Every field the spec requires is filled in, so a
- * caller only overrides what its assertion is about.
+ * 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 function createDataPlane(overrides = {}) {
     return {
@@ -11,13 +13,22 @@ export function createDataPlane(overrides = {}) {
         created_at: TIMESTAMP,
         display_name: "Test Data Plane",
         external_id: "test-data-plane",
-        platform: { type: "platform_aws", region: "us-east-1" },
+        platform: {
+            type: "platform_aws",
+            account_id: "123456789000",
+            region: { type: "region_aws", id: "us-east-1" },
+        },
         status: "active",
         updated_at: TIMESTAMP,
         collaborators: {
             participants: { type: "none" },
             manage_compute_pools: { type: "none" },
         },
+        compute_pools: [],
+        description: null,
+        tags: null,
+        last_heartbeat_at: null,
+        default_compute_pool_id: null,
         ...overrides,
     };
 }

package/package.json

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