@greensecurity/javascript-sdk 0.47.0-beta.8 → 0.47.0-beta.9

package/dist/esm/lib/config.d.ts

@@ -35,8 +35,8 @@ export declare function serverURLFromOptions(options: SDKOptions): URL | null;
 export declare const SDK_METADATA: {
     readonly language: "typescript";
     readonly openapiDocVersion: "0.46.0";
-    readonly sdkVersion: "0.47.0-beta.8";
+    readonly sdkVersion: "0.47.0-beta.9";
     readonly genVersion: "2.948.4";
-    readonly userAgent: "speakeasy-sdk/typescript 0.47.0-beta.8 2.948.4 0.46.0 @greensecurity/javascript-sdk";
+    readonly userAgent: "speakeasy-sdk/typescript 0.47.0-beta.9 2.948.4 0.46.0 @greensecurity/javascript-sdk";
 };
 //# sourceMappingURL=config.d.ts.map

package/dist/esm/lib/config.js

@@ -39,8 +39,8 @@ export function serverURLFromOptions(options) {
 export const SDK_METADATA = {
     language: "typescript",
     openapiDocVersion: "0.46.0",
-    sdkVersion: "0.47.0-beta.8",
+    sdkVersion: "0.47.0-beta.9",
     genVersion: "2.948.4",
-    userAgent: "speakeasy-sdk/typescript 0.47.0-beta.8 2.948.4 0.46.0 @greensecurity/javascript-sdk",
+    userAgent: "speakeasy-sdk/typescript 0.47.0-beta.9 2.948.4 0.46.0 @greensecurity/javascript-sdk",
 };
 //# sourceMappingURL=config.js.map

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "@greensecurity/javascript-sdk",
-  "version": "0.47.0-beta.8",
+  "version": "0.47.0-beta.9",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",    

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@greensecurity/javascript-sdk",
-  "version": "0.47.0-beta.8",
+  "version": "0.47.0-beta.9",
   "author": "Green Security LLC",
   "type": "module",
   "tshy": {

package/src/__tests__/doAdmin.test.ts

@@ -2,6 +2,7 @@ import { afterEach, beforeEach, expect, test, vi } from "vitest";
 import type { HookContext } from "../hooks/types.js";
 import type { RetryConfig } from "../lib/retries.js";
 import {
+  $doDelete,
   $doPut,
   buildDoOptions,
   matchesInternalApiErrorStatusCode,
@@ -120,3 +121,37 @@ test("$doPut reports a network failure as a request-error", async () => {
   expect(result.ok).toBe(false);
   expect(call.status).toBe("request-error");
 });
+
+test("$doDelete sends a DELETE with no body and returns the parsed success payload", async () => {
+  const fetchMock = vi.fn(async (request: Request) => {
+    expect(request.method).toBe("DELETE");
+    expect(request.url).toBe("https://internal.test/zone-devices/42");
+    expect(await request.text()).toBe("");
+    return new Response(JSON.stringify({ success: true }), {
+      status: 200,
+      headers: { "Content-Type": "application/json" },
+    });
+  });
+  globalThis.fetch = fetchMock as unknown as typeof fetch;
+
+  const [result, call] = await $doDelete("/zone-devices/42");
+
+  expect(fetchMock).toHaveBeenCalledTimes(1);
+  expect(result.ok).toBe(true);
+  expect(result.ok && result.value).toEqual({ success: true });
+  expect(call.status).toBe("complete");
+});
+
+test("$doDelete maps an API error response to an error result", async () => {
+  globalThis.fetch = vi.fn(async () =>
+    new Response(JSON.stringify({ success: false, error: "Invalid zone device ID" }), {
+      status: 404,
+      headers: { "Content-Type": "application/json" },
+    })
+  ) as unknown as typeof fetch;
+
+  const [result] = await $doDelete("/zone-devices/42");
+
+  expect(result.ok).toBe(false);
+  expect(!result.ok && result.error).toBeInstanceOf(ApiErrorResponse);
+});

package/src/__tests__/vendors.test.ts

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

package/src/__tests__/webhooks.test.ts

@@ -62,11 +62,10 @@ test("Webhooks Updates The Webhook Endpoint With The Given Id", async () => {
       id: 220782,
       webhookEndpointUpdate: {
         webhookUrl: "https://example.com/webhook/incoming",
-        subscriptions: {
-          model: "Vendor",
-          action: "updated",
-          expands: "vendor.company,vendor.user",
-        },
+        subscriptions: [
+          "Vendor.updated",
+          "Vendor.created",
+        ],
         consumers: {
           systemId: 1,
           facilityId: 1,

package/src/__tests__/zoneDevicesCreate.test.ts

@@ -1,7 +1,8 @@
 import { beforeEach, describe, expect, it, vi } from "vitest";
 
 // Typed parameters so mock.calls is the argument tuple; see smartBadgeGetPsks.test.ts.
-const { doPostMock, doGetSingleMock, doPutMock } = vi.hoisted(() => ({
+const { doPostMock, doGetSingleMock, doPutMock, doDeleteMock } = vi.hoisted(() => ({
+  doDeleteMock: vi.fn((_route: string) => Promise.resolve([{ ok: true }, { status: "complete" }])),
   doPutMock: vi.fn((_route: string, _body: unknown) => Promise.resolve([{ ok: true }, { status: "complete" }])),
   doPostMock: vi.fn((_route: string, _body: unknown) => Promise.resolve([{ ok: true }, { status: "complete" }])),
   doGetSingleMock: vi.fn((_route: string, _query: unknown) =>
@@ -13,6 +14,7 @@ vi.mock("../admin-funcs/doAdmin.js", () => ({
   $doPost: doPostMock,
   $doGetSingle: doGetSingleMock,
   $doPut: doPutMock,
+  $doDelete: doDeleteMock,
 }));
 
 import { __internal } from "../index.extras.js";
@@ -22,6 +24,7 @@ describe("__internal.zoneDevices", () => {
     doPostMock.mockClear();
     doGetSingleMock.mockClear();
     doPutMock.mockClear();
+    doDeleteMock.mockClear();
   });
 
   it("puts only the changed fields to /zone-devices/:id", () => {
@@ -30,6 +33,18 @@ describe("__internal.zoneDevices", () => {
     expect(doPutMock).toHaveBeenCalledWith("/zone-devices/42", { zone_id: 7, connection_type: "wifi" });
   });
 
+  it("deletes /zone-devices/:id", () => {
+    __internal.zoneDevices.delete(42);
+
+    expect(doDeleteMock).toHaveBeenCalledWith("/zone-devices/42");
+  });
+
+  it("posts to /zone-devices/:id/provisioning", () => {
+    __internal.zoneDevices.provisioning(42);
+
+    expect(doPostMock).toHaveBeenCalledWith("/zone-devices/42/provisioning", {});
+  });
+
   it("posts the gateway body verbatim to /zone-devices", () => {
     const body = {
       zone_id: 7,

package/src/__tests__/zoneDevicesList.test.ts

@@ -28,10 +28,24 @@ describe("zoneDevicesList", () => {
     expect(doGetSingleMock).toHaveBeenCalledWith("/zone-devices", { zone_id: 7, items_per_page: 1 });
   });
 
+  it("sends the network filter as network_id", () => {
+    zoneDevicesList({ networkId: 3 });
+
+    expect(doGetSingleMock).toHaveBeenCalledWith("/zone-devices", { network_id: 3 });
+  });
+
   // Gatekeeper's Networks and Devices tabs call these; dropping them from `__internal` once
   // broke both without failing a build here.
   it("keeps the gatekeeper funcs on __internal", () => {
-    expect(__internal.zoneDevices).toEqual({ list: zoneDevicesList, get: zoneDevicesGet });
+    expect(__internal.zoneDevices).toEqual({
+      list: zoneDevicesList,
+      get: zoneDevicesGet,
+      create: expect.any(Function),
+      update: expect.any(Function),
+      macAvailability: expect.any(Function),
+      provisioning: expect.any(Function),
+      delete: expect.any(Function),
+    });
     expect(__internal.networks).toEqual({ list: networksList, get: networksGet, create: networksCreate });
   });
 });

package/src/__tests__/zones.test.ts

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

package/src/admin-funcs/doAdmin.ts

@@ -341,10 +341,27 @@ export async function $doPostForm(
   return $doPostBody(route, form, {}, options);
 }
 
-export async function $doPut<T extends object>(
+export function $doPut<T extends object>(
   route: string,
   putData: T,
   options?: RequestOptions,
+): ReturnType<typeof $doJsonRequest> {
+  return $doJsonRequest("PUT", route, putData, options);
+}
+
+export function $doDelete(
+  route: string,
+  options?: RequestOptions,
+): ReturnType<typeof $doJsonRequest> {
+  return $doJsonRequest("DELETE", route, undefined, options);
+}
+
+// PUT and DELETE share everything but the method; a DELETE sends no body.
+async function $doJsonRequest(
+  method: "PUT" | "DELETE",
+  route: string,
+  data: object | undefined,
+  options?: RequestOptions,
 ): Promise<
   [
     Result<
@@ -367,7 +384,7 @@ export async function $doPut<T extends object>(
     throw new Error("GreenSecurityCore client is not initialized.");
   }
 
-  const body = encodeJSON("body", putData, { explode: true });
+  const body = data === undefined ? undefined : encodeJSON("body", data, { explode: true });
 
   // Extract the path parameters from the request object
   const pathParams = {}; //extractRouteParameters(route, request);
@@ -399,7 +416,7 @@ export async function $doPut<T extends object>(
 
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
-    method: "PUT",
+    method,
     baseURL: options?.serverURL,
     path: path,
     headers: headers,

package/src/admin-funcs/zoneDevicesDelete.ts

@@ -0,0 +1,8 @@
+import { APIPromise } from "../types/async.js";
+import { $doDelete, internalApiResult } from "./doAdmin.js";
+
+// Removes a gateway from the Gatekeeper device details screen and revokes its AWS IoT thing.
+// Internal for the same reason as zoneDevicesCreate. 404 covers a gateway outside the caller's scope.
+export function zoneDevicesDelete(zoneDeviceId: number): internalApiResult {
+  return new APIPromise($doDelete(`/zone-devices/${zoneDeviceId}`));
+}

package/src/admin-funcs/zoneDevicesList.ts

@@ -6,6 +6,7 @@ export type zoneDevicesListSortField = "id" | "name";
 export type zoneDevicesListRequest = {
   facilityId?: number;
   zoneId?: number;
+  networkId?: number;
   page?: number;
   itemsPerPage?: number;
   sort?: zoneDevicesListSortField;
@@ -36,6 +37,9 @@ export function zoneDevicesList(
   if (request.zoneId !== undefined) {
     query["zone_id"] = request.zoneId;
   }
+  if (request.networkId !== undefined) {
+    query["network_id"] = request.networkId;
+  }
   if (request.page !== undefined) {
     query["page"] = request.page;
   }

package/src/admin-funcs/zoneDevicesProvisioning.ts

@@ -0,0 +1,12 @@
+import { APIPromise } from "../types/async.js";
+import { $doPost, internalApiResult } from "./doAdmin.js";
+
+// Everything the Gatekeeper app writes to a gateway when it provisions it over the gateway's own
+// Wi-Fi: the admin password, the AWS IoT certificate and broker, and the settings and
+// secrets of the network it joins. The first call mints the password and certificate, hence POST.
+//
+// Internal for the same reason as zoneDevicesCreate. The response carries secrets: callers keep it
+// in memory for the provisioning run and never persist or log it.
+export function zoneDevicesProvisioning(zoneDeviceId: number): internalApiResult {
+  return new APIPromise($doPost(`/zone-devices/${zoneDeviceId}/provisioning`, {}));
+}

package/src/admin-funcs/zoneDevicesUpdate.ts

@@ -11,8 +11,8 @@ export type zoneDevicesUpdateRequest = {
   name?: string;
 };
 
-// Edits a gateway from the Gatekeeper device details screen (GSSD-7059). Pushing a new network to
-// the hardware is GSSD-7061; this only updates the record.
+// Edits a gateway from the Gatekeeper device details screen. This only updates the record; the
+// app pushes the new network to the hardware using zoneDevicesProvisioning.
 //
 // Internal for the same reason as zoneDevicesCreate. 404 covers a gateway, zone or network outside
 // the caller's scope, and a network not linked to the zone's facility.

package/src/index.extras.ts

@@ -67,6 +67,8 @@ import { zoneDevicesGet } from "./admin-funcs/zoneDevicesGet.js";
 import { zoneDevicesCreate } from "./admin-funcs/zoneDevicesCreate.js";
 import { zoneDevicesMacAvailability } from "./admin-funcs/zoneDevicesMacAvailability.js";
 import { zoneDevicesUpdate } from "./admin-funcs/zoneDevicesUpdate.js";
+import { zoneDevicesProvisioning } from "./admin-funcs/zoneDevicesProvisioning.js";
+import { zoneDevicesDelete } from "./admin-funcs/zoneDevicesDelete.js";
 import { lookupsAddressValidation } from "./admin-funcs/lookupsAddressValidation.js";
 import { lookupsAddressAutocomplete } from "./admin-funcs/lookupsAddressAutocomplete.js";
 import { lookupsAddressPlace } from "./admin-funcs/lookupsAddressPlace.js";
@@ -192,6 +194,8 @@ export const __internal = {
     get: zoneDevicesGet,
     create: zoneDevicesCreate,
     update: zoneDevicesUpdate,
+    provisioning: zoneDevicesProvisioning,
+    delete: zoneDevicesDelete,
     macAvailability: zoneDevicesMacAvailability
   }
 };

package/src/lib/config.ts

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