@greensecurity/javascript-sdk 0.48.0-beta.10 → 0.48.0-beta.11

package/src/__tests__/subscriptionPlanSelection.test.ts

@@ -0,0 +1,53 @@
+import { describe, expect, it, vi } from "vitest";
+
+const { doPostMock } = vi.hoisted(() => ({
+  doPostMock: vi.fn(() => Promise.resolve([{ ok: true }, { status: "complete" }])),
+}));
+
+vi.mock("../admin-funcs/doAdmin.js", () => ({
+  $doPost: doPostMock,
+}));
+
+import { subscriptionFinishScreeningQuestions } from "../admin-funcs/subscriptionFinishScreeningQuestions.js";
+import { subscriptionPlanSelectionResponse$inboundSchema } from "../admin-funcs/subscriptionPlanSelection.js";
+import { subscriptionUpdateVendorType } from "../admin-funcs/subscriptionUpdateVendorType.js";
+
+// GSSD-7289: both steps answer whether the vendor has a plan to choose, and the SDK holds the
+// server to it.
+describe("subscription plan selection responses", () => {
+  it("validates finishing the screening questions against the plan selection schema", () => {
+    subscriptionFinishScreeningQuestions({ vendor_id: 7 });
+
+    expect(doPostMock).toHaveBeenCalledWith(
+      "/subscription/screening-questions",
+      { vendor_id: 7 },
+      undefined,
+      subscriptionPlanSelectionResponse$inboundSchema,
+    );
+  });
+
+  it("validates choosing a vendor type against the plan selection schema", () => {
+    subscriptionUpdateVendorType({ vendor_id: 7, vendor_type_id: [10] });
+
+    expect(doPostMock).toHaveBeenCalledWith(
+      "/subscription/vendor-type",
+      { vendor_id: 7, vendor_type_id: [10] },
+      undefined,
+      subscriptionPlanSelectionResponse$inboundSchema,
+    );
+  });
+
+  it("accepts a response that says whether a plan must be chosen, keeping other fields", () => {
+    const parsed = subscriptionPlanSelectionResponse$inboundSchema.parse({
+      success: true,
+      plan_selection_required: false,
+      extra: 1,
+    });
+
+    expect(parsed).toEqual({ success: true, plan_selection_required: false, extra: 1 });
+  });
+
+  it("rejects a response without plan_selection_required", () => {
+    expect(subscriptionPlanSelectionResponse$inboundSchema.safeParse({ success: true }).success).toBe(false);
+  });
+});

package/src/__tests__/vendors.test.ts

@@ -121,7 +121,7 @@ test("Vendors List Vendor Credits", async () => {
       page: 1,
       useUrlParams: false,
     },
-    creditBalance: 2457.03,
+    creditBalance: 8833.6,
   });
 });
 

package/src/__tests__/zones.test.ts

@@ -35,37 +35,40 @@ test("Zones List Or Search Security Zones", async () => {
       useUrlParams: false,
     },
     items: [
-      {
-        facility: {},
-      },
       {
         facility: {
           contacts: {
-            contact: null,
+            contact: {
+              status: "Active",
+              department: 123,
+            },
             adminContact: {
-              status: "Inactive",
+              status: "Active",
               department: 123,
             },
             techContact: {
-              status: "Active",
+              status: "Inactive",
               department: 123,
             },
             greenSecurityCsm: {
-              status: "Active",
+              status: "Deleted",
               department: 123,
             },
             accountManager: {
-              status: "Deleted",
+              status: "Active",
               department: 123,
             },
           },
           vendorGuestPolicy: {
             enabled: false,
             vendorGuestLimitAndOr: "and",
-            vendorGuestRequireEmail: false,
+            vendorGuestRequireEmail: true,
           },
         },
       },
+      {
+        facility: {},
+      },
     ],
   });
 });
@@ -83,7 +86,7 @@ test("Zones Security Zone Checkin", async () => {
 
   const result = await greenSecurity.zones.securityZoneCheckin({
     qrCode: "<value>",
-    zoneId: 416448,
+    zoneId: 450895,
   });
   expect(result).toBeDefined();
   expect(result).toEqual({});

package/src/admin-funcs/doAdmin.ts

@@ -20,9 +20,11 @@ import { Result } from "../types/fp.js";
 import { getInternalCore } from "./initializeCore.js";
 import { encodeJSON } from "../lib/encodings.js";
 
-export type internalApiResult = APIPromise<
+// An internal call whose response is validated against a schema for `T` (see $doPost's
+// responseSchema). internalApiResult is the untyped default.
+export type internalApiResultOf<T> = APIPromise<
   Result<
-    Json,
+    T,
     | errors.ApiErrorResponse
     | GreenSecurityError
     | SDKValidationError
@@ -34,6 +36,8 @@ export type internalApiResult = APIPromise<
   >
 >;
 
+export type internalApiResult = internalApiResultOf<Json>;
+
 // This creates a generic JSON schema that can be used to validate any JSON object
 const literalSchema = z.union([z.string(), z.number(), z.boolean(), z.null()]);
 type Literal = z.infer<typeof literalSchema>;
@@ -201,10 +205,10 @@ export async function $doGetSingle<T extends object>(
   return [result, { status: "complete", request: req, response }];
 }
 
-type BodyResult = Promise<
+type BodyResult<T = Json> = Promise<
   [
     Result<
-      Json,
+      T,
       | errors.ApiErrorResponse
       | GreenSecurityError
       | ResponseValidationError
@@ -222,13 +226,18 @@ type BodyResult = Promise<
 // Shared by the JSON and multipart requests below: everything except the method, how the body
 // is built and whether we name a Content-Type. A multipart body must NOT carry one, because only
 // fetch can append the boundary it generates.
-async function $doBodyRequest(
+async function $doBodyRequest<R = Json>(
   method: "POST" | "PUT",
   route: string,
   body: BodyInit | undefined,
   contentTypeHeader: Record<string, string>,
   options?: RequestOptions,
-): BodyResult {
+  responseSchema?: z.ZodType<R>,
+): BodyResult<R> {
+  // Without a schema the body is only checked to be JSON, which is every caller before typed
+  // responses existed.
+  const schema = (responseSchema ?? jsonSchema) as z.ZodType<R>;
+
   const client = getInternalCore();
   if (!client) {
     throw new Error("GreenSecurityCore client is not initialized.");
@@ -290,7 +299,7 @@ async function $doBodyRequest(
   };
 
   const [result] = await M.match<
-    Json,
+    R,
     | errors.ApiErrorResponse
     | GreenSecurityError
     | ResponseValidationError
@@ -301,10 +310,10 @@ async function $doBodyRequest(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.json(200, jsonSchema),
+    M.json(200, schema),
     // A REST create answers 201, which matches none of the cases below — an unmatched status is
     // an error, so the caller saw a failure for a request the server had accepted.
-    M.json(201, jsonSchema),
+    M.json(201, schema),
     // 422 is a real answer here, not a surprise: the create returns it for a refused certificate
     // and for a model validation failure. Left out, it fell through to M.fail("4XX"), which
     // yields a generic APIError and hides the server's message from the form.
@@ -319,17 +328,21 @@ async function $doBodyRequest(
   return [result, { status: "complete", request: req, response }];
 }
 
-export async function $doPost<T extends object>(
+// Pass responseSchema to validate and type the 200/201 body; a body that does not match it comes
+// back as a ResponseValidationError instead of being handed to the caller.
+export async function $doPost<T extends object, R = Json>(
   route: string,
   postData: T,
   options?: RequestOptions,
-): BodyResult {
+  responseSchema?: z.ZodType<R>,
+): BodyResult<R> {
   return $doBodyRequest(
     "POST",
     route,
     encodeJSON("body", postData, { explode: true }),
     { "Content-Type": "application/json" },
     options,
+    responseSchema,
   );
 }
 

package/src/admin-funcs/subscriptionFinishScreeningQuestions.ts

@@ -1,13 +1,21 @@
 import { APIPromise } from "../types/async.js";
-import { $doPost, internalApiResult } from "./doAdmin.js";
+import { $doPost, internalApiResultOf } from "./doAdmin.js";
+import {
+  subscriptionPlanSelectionResponse,
+  subscriptionPlanSelectionResponse$inboundSchema,
+} from "./subscriptionPlanSelection.js";
 
 export type subscriptionFinishScreeningQuestionsRequest = {
   vendor_id: number;
 };
 
-export function subscriptionFinishScreeningQuestions(request: subscriptionFinishScreeningQuestionsRequest): internalApiResult  {
+export function subscriptionFinishScreeningQuestions(
+  request: subscriptionFinishScreeningQuestionsRequest,
+): internalApiResultOf<subscriptionPlanSelectionResponse> {
   return new APIPromise($doPost(
     "/subscription/screening-questions",
-    request
+    request,
+    undefined,
+    subscriptionPlanSelectionResponse$inboundSchema,
   ));
 }

package/src/admin-funcs/subscriptionPlanSelection.ts

@@ -0,0 +1,17 @@
+import * as z from "zod/v3";
+
+// What finishing the screening questions or choosing a vendor type answers. GSSD-7289.
+export type subscriptionPlanSelectionResponse = {
+  success: boolean;
+  // false when Standard is the vendor's only plan (e.g. Level 1, which cannot buy Emerald): the
+  // server has already selected it, so the plan step is skipped and the next step is the invoice.
+  plan_selection_required: boolean;
+};
+
+// Unknown fields pass through, so the server can add to the response without breaking callers.
+export const subscriptionPlanSelectionResponse$inboundSchema: z.ZodType<subscriptionPlanSelectionResponse> = z
+  .object({
+    success: z.boolean(),
+    plan_selection_required: z.boolean(),
+  })
+  .passthrough();

package/src/admin-funcs/subscriptionUpdateVendorType.ts

@@ -1,14 +1,22 @@
 import { APIPromise } from "../types/async.js";
-import { $doPost, internalApiResult } from "./doAdmin.js";
+import { $doPost, internalApiResultOf } from "./doAdmin.js";
+import {
+  subscriptionPlanSelectionResponse,
+  subscriptionPlanSelectionResponse$inboundSchema,
+} from "./subscriptionPlanSelection.js";
 
 export type subscriptionUpdateVendorTypeRequest = {
   vendor_id: number;
   vendor_type_id: number[];
 };
 
-export function subscriptionUpdateVendorType(request: subscriptionUpdateVendorTypeRequest): internalApiResult  {
+export function subscriptionUpdateVendorType(
+  request: subscriptionUpdateVendorTypeRequest,
+): internalApiResultOf<subscriptionPlanSelectionResponse> {
   return new APIPromise($doPost(
     "/subscription/vendor-type",
-    request
+    request,
+    undefined,
+    subscriptionPlanSelectionResponse$inboundSchema,
   ));
 }

package/src/lib/config.ts

@@ -80,8 +80,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.47.0",
-  sdkVersion: "0.48.0-beta.10",
+  sdkVersion: "0.48.0-beta.11",
   genVersion: "2.950.13",
   userAgent:
-    "speakeasy-sdk/typescript 0.48.0-beta.10 2.950.13 0.47.0 @greensecurity/javascript-sdk",
+    "speakeasy-sdk/typescript 0.48.0-beta.11 2.950.13 0.47.0 @greensecurity/javascript-sdk",
 } as const;