@greensecurity/javascript-sdk 0.46.0 → 0.47.0-beta.1

package/src/__tests__/companies.test.ts

@@ -103,6 +103,7 @@ test("Companies List Company Managers", async () => {
       itemsPerPage: 598575,
       page: 1,
       useUrlParams: true,
+      scope: null,
     },
     items: [],
   });
@@ -159,6 +160,7 @@ test("Companies Lookup Companies", async () => {
       itemsPerPage: 371915,
       page: 1,
       useUrlParams: true,
+      scope: null,
     },
     items: [],
   });
@@ -194,6 +196,7 @@ test("Companies List Company Credits", async () => {
       itemsPerPage: 223549,
       page: 1,
       useUrlParams: true,
+      scope: null,
     },
     items: [
       {},
@@ -230,6 +233,7 @@ test("Companies List Company Credentials", async () => {
       itemsPerPage: 695175,
       page: 1,
       useUrlParams: true,
+      scope: null,
     },
   });
 });

package/src/__tests__/events.test.ts

@@ -36,6 +36,7 @@ test("Events List Or Search Vendor Invitees", async () => {
       itemsPerPage: 801598,
       page: 1,
       useUrlParams: true,
+      scope: null,
     },
     items: [],
   });
@@ -179,6 +180,7 @@ test("Events List Locations", async () => {
       itemsPerPage: 192898,
       page: 1,
       useUrlParams: true,
+      scope: null,
     },
   });
 });
@@ -210,6 +212,7 @@ test("Events List Pending Invitations", async () => {
       itemsPerPage: 165687,
       page: 1,
       useUrlParams: true,
+      scope: null,
     },
     items: [
       {},
@@ -244,6 +247,7 @@ test("Events List Feed", async () => {
       itemsPerPage: 428684,
       page: 1,
       useUrlParams: true,
+      scope: null,
     },
     items: [],
   });
@@ -276,6 +280,7 @@ test("Events List Standing Appointments", async () => {
       itemsPerPage: 850564,
       page: 1,
       useUrlParams: true,
+      scope: null,
     },
     items: [
       {},

package/src/__tests__/fhirconfigs.test.ts

@@ -33,6 +33,7 @@ test("Fhir Configs List Of Fhir Configurations", async () => {
       itemsPerPage: 19984,
       page: 1,
       useUrlParams: true,
+      scope: null,
     },
     items: [
       {

package/src/__tests__/invoices.test.ts

@@ -97,6 +97,7 @@ test("Invoices List Invoices", async () => {
       itemsPerPage: 80477,
       page: 1,
       useUrlParams: true,
+      scope: null,
     },
   });
 });

package/src/__tests__/medicalproducts.test.ts

@@ -31,6 +31,7 @@ test("Medical Products List All Medical Products", async () => {
       itemsPerPage: 237587,
       page: 1,
       useUrlParams: true,
+      scope: null,
     },
     items: [],
   });
@@ -378,6 +379,7 @@ test("Medical Products List All Medical Product Families", async () => {
       itemsPerPage: 14932,
       page: 1,
       useUrlParams: true,
+      scope: null,
     },
     items: [],
   });
@@ -527,6 +529,7 @@ test("Medical Products List All Medical Product Categories", async () => {
       itemsPerPage: 758419,
       page: 1,
       useUrlParams: true,
+      scope: null,
     },
     items: [],
   });
@@ -675,6 +678,7 @@ test("Medical Products List All Manufacturers", async () => {
       itemsPerPage: 347097,
       page: 1,
       useUrlParams: true,
+      scope: null,
     },
     items: [
       {
@@ -861,6 +865,7 @@ test("Medical Products List All Distributors", async () => {
       itemsPerPage: 570797,
       page: 1,
       useUrlParams: true,
+      scope: null,
     },
     items: [
       {

package/src/__tests__/oauth.test.ts

@@ -0,0 +1,108 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { expect, test } from "vitest";
+import { GreenSecurity } from "../index.js";
+import { createTestHTTPClient } from "./testclient.js";
+
+test("Oauth Create Token", async () => {
+  const testHttpClient = createTestHTTPClient("createToken");
+
+  const greenSecurity = new GreenSecurity({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "https://localhost:3000/api",
+    httpClient: testHttpClient,
+    security: {
+      token: process.env["GREEN_SECURITY_TOKEN"] ?? "value",
+    },
+  });
+
+  const result = await greenSecurity.oauth.createToken({
+    grantType: "refresh_token",
+    refreshToken: "gsdr_Qm9vZ2xlLWlzLW5vdC1hLXJlYWwtdG9rZW4tZXhhbXBsZQ",
+    clientId: "greensecurity-apps-cli",
+    scope: "vendors.view",
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    accessToken: "gsu_3kq9Xw7V0bY2mT8cLr5nPzQ1aB4dE6fG8hJ0kL2mN4pR6s",
+    tokenType: "Bearer",
+    expiresIn: 900,
+    scope: "vendors.view vendor_credentials.view",
+    activationId: 1087,
+    refreshToken: "gsdr_Qm9vZ2xlLWlzLW5vdC1hLXJlYWwtdG9rZW4tZXhhbXBsZQ",
+    refreshTokenExpiresIn: 2592000,
+  });
+});
+
+test("Oauth Create Device Authorization", async () => {
+  const testHttpClient = createTestHTTPClient("createDeviceAuthorization");
+
+  const greenSecurity = new GreenSecurity({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "https://localhost:3000/api",
+    httpClient: testHttpClient,
+  });
+
+  const result = await greenSecurity.oauth.createDeviceAuthorization({
+    clientId: "greensecurity-apps-cli",
+    scope: "apps:develop",
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    deviceCode: "<value>",
+    userCode: "WDJB-MJHT",
+    verificationUri: "https://www.greensecurityllc.com/v3/apps/device",
+    verificationUriComplete:
+      "https://www.greensecurityllc.com/v3/apps/device?user_code=WDJB-MJHT",
+    expiresIn: 600,
+    interval: 5,
+  });
+});
+
+test("Oauth Introspect Token", async () => {
+  const testHttpClient = createTestHTTPClient("introspectToken");
+
+  const greenSecurity = new GreenSecurity({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "https://localhost:3000/api",
+    httpClient: testHttpClient,
+    security: {
+      token: process.env["GREEN_SECURITY_TOKEN"] ?? "value",
+    },
+  });
+
+  const result = await greenSecurity.oauth.introspectToken({
+    token: "<value>",
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    active: true,
+    sub: "5123",
+    appId: 42,
+    activationId: 1087,
+    scope: "vendors.view vendor_credentials.view",
+    exp: 1790000000,
+    iat: 1789999100,
+    tokenType: "Bearer",
+    act: {
+      sub: "5123",
+    },
+  });
+});
+
+test("Oauth Revoke Token", async () => {
+  const testHttpClient = createTestHTTPClient("revokeToken");
+
+  const greenSecurity = new GreenSecurity({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "https://localhost:3000/api",
+    httpClient: testHttpClient,
+    security: {
+      token: process.env["GREEN_SECURITY_TOKEN"] ?? "value",
+    },
+  });
+
+  const result = await greenSecurity.oauth.revokeToken({
+    token: "<value>",
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({});
+});

package/src/__tests__/organizations.test.ts

@@ -34,6 +34,7 @@ test("Organizations List Or Search Departments", async () => {
       itemsPerPage: 357325,
       page: 1,
       useUrlParams: true,
+      scope: null,
     },
     items: [],
   });
@@ -71,6 +72,7 @@ test("Organizations List Or Search Department Contacts", async () => {
       itemsPerPage: 834563,
       page: 1,
       useUrlParams: true,
+      scope: null,
     },
     items: [
       {
@@ -114,6 +116,7 @@ test("Organizations List Company Target Facilities", async () => {
       itemsPerPage: 112555,
       page: 1,
       useUrlParams: true,
+      scope: null,
     },
     items: [],
   });
@@ -266,6 +269,7 @@ test("Organizations List Facility Vendors", async () => {
       itemsPerPage: 557,
       page: 1,
       useUrlParams: true,
+      scope: null,
     },
     items: [],
   });

package/src/__tests__/systems.test.ts

@@ -36,6 +36,7 @@ test("Systems List Systems", async () => {
       itemsPerPage: 286465,
       page: 1,
       useUrlParams: true,
+      scope: null,
     },
     items: [
       {

package/src/__tests__/vendors.test.ts

@@ -121,7 +121,7 @@ test("Vendors List Vendor Credits", async () => {
       page: 1,
       useUrlParams: false,
     },
-    creditBalance: 473.87,
+    creditBalance: 8505.64,
   });
 });
 
@@ -908,6 +908,7 @@ test("Vendors List Vendor Types", async () => {
       itemsPerPage: 224781,
       page: 1,
       useUrlParams: true,
+      scope: null,
     },
     items: [
       {},
@@ -1133,6 +1134,7 @@ test("Vendors List Vendors", async () => {
       itemsPerPage: 999117,
       page: 1,
       useUrlParams: true,
+      scope: null,
     },
     items: [],
   });
@@ -1195,6 +1197,7 @@ test("Vendors Get Vendor Upload History", async () => {
       itemsPerPage: 183457,
       page: 1,
       useUrlParams: true,
+      scope: null,
     },
     items: [
       {
@@ -1335,6 +1338,7 @@ test("Vendors Get Vendor Target Facilities", async () => {
       itemsPerPage: 570346,
       page: 1,
       useUrlParams: true,
+      scope: null,
     },
     items: [],
   });
@@ -1365,6 +1369,7 @@ test("Vendors Get Vendor Screening Questions", async () => {
       itemsPerPage: 860787,
       page: 1,
       useUrlParams: true,
+      scope: null,
     },
     items: [],
     facilityName: "<value>",

package/src/__tests__/vendorscans.test.ts

@@ -100,6 +100,7 @@ test("Vendor Scans List Vendor Scans", async () => {
       itemsPerPage: 411928,
       page: 1,
       useUrlParams: true,
+      scope: null,
     },
     items: [
       {},

package/src/__tests__/webhooks.test.ts

@@ -20,7 +20,7 @@ test("Webhooks List All Webhook Endpoints", async () => {
   const testWebhookListForVendorUserResult = await greenSecurity.webhooks
     .listAllWebhookEndpoints({
       itemsPerPage: 25,
-      desc: 0,
+      desc: true,
       sort: "",
     });
   expect(testWebhookListForVendorUserResult).toBeDefined();

package/src/__tests__/zoneDevicesCreate.test.ts

@@ -0,0 +1,56 @@
+import { beforeEach, describe, expect, it, vi } from "vitest";
+
+// Typed parameters so mock.calls is the argument tuple; see smartBadgeGetPsks.test.ts.
+const { doPostMock, doGetSingleMock } = vi.hoisted(() => ({
+  doPostMock: vi.fn((_route: string, _body: unknown) => Promise.resolve([{ ok: true }, { status: "complete" }])),
+  doGetSingleMock: vi.fn((_route: string, _query: unknown) =>
+    Promise.resolve([{ ok: true }, { status: "complete" }])
+  ),
+}));
+
+vi.mock("../admin-funcs/doAdmin.js", () => ({
+  $doPost: doPostMock,
+  $doGetSingle: doGetSingleMock,
+}));
+
+import { __internal } from "../index.extras.js";
+
+describe("__internal.zoneDevices", () => {
+  beforeEach(() => {
+    doPostMock.mockClear();
+    doGetSingleMock.mockClear();
+  });
+
+  it("posts the gateway body verbatim to /zone-devices", () => {
+    const body = {
+      zone_id: 7,
+      network_id: 3,
+      connection_type: "ethernet" as const,
+      mac_address: "AA:BB:CC:DD:EE:FF",
+      name: "Lobby gateway",
+    };
+
+    __internal.zoneDevices.create(body);
+
+    expect(doPostMock).toHaveBeenCalledWith("/zone-devices", body);
+  });
+
+  it("sends the MAC as a query parameter to the availability check", () => {
+    __internal.zoneDevices.macAvailability("AA:BB:CC:DD:EE:FF");
+
+    expect(doGetSingleMock).toHaveBeenCalledWith("/zone-devices/mac-availability", {
+      mac_address: "AA:BB:CC:DD:EE:FF",
+    });
+  });
+
+  // a5d10295d4 once dropped these from __internal while gatekeeper-client still called them.
+  it("keeps the gatekeeper networks and zone device calls exported", () => {
+    expect(__internal.networks).toEqual({
+      list: expect.any(Function),
+      get: expect.any(Function),
+      create: expect.any(Function),
+    });
+    expect(__internal.zoneDevices.list).toEqual(expect.any(Function));
+    expect(__internal.zoneDevices.get).toEqual(expect.any(Function));
+  });
+});

package/src/__tests__/zoneDevicesList.test.ts

@@ -0,0 +1,37 @@
+import { beforeEach, describe, expect, it, vi } from "vitest";
+
+const { doGetSingleMock } = vi.hoisted(() => ({
+  doGetSingleMock: vi.fn((_route: string, _query?: unknown) =>
+    Promise.resolve([{ ok: true }, { status: "complete" }])
+  ),
+}));
+
+vi.mock("../admin-funcs/doAdmin.js", () => ({
+  $doGetSingle: doGetSingleMock,
+}));
+
+import { networksCreate } from "../admin-funcs/networksCreate.js";
+import { networksGet } from "../admin-funcs/networksGet.js";
+import { networksList } from "../admin-funcs/networksList.js";
+import { zoneDevicesGet } from "../admin-funcs/zoneDevicesGet.js";
+import { zoneDevicesList } from "../admin-funcs/zoneDevicesList.js";
+import { __internal } from "../index.extras.js";
+
+describe("zoneDevicesList", () => {
+  beforeEach(() => {
+    doGetSingleMock.mockClear();
+  });
+
+  it("sends the zone filter as zone_id", () => {
+    zoneDevicesList({ zoneId: 7, itemsPerPage: 1 });
+
+    expect(doGetSingleMock).toHaveBeenCalledWith("/zone-devices", { zone_id: 7, items_per_page: 1 });
+  });
+
+  // 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.networks).toEqual({ list: networksList, get: networksGet, create: networksCreate });
+  });
+});

package/src/__tests__/zones.test.ts

@@ -39,32 +39,7 @@ test("Zones List Or Search Security Zones", async () => {
         facility: {},
       },
       {
-        facility: {
-          contacts: {
-            contact: {
-              status: "Deleted",
-              department: null,
-            },
-            adminContact: null,
-            techContact: {
-              status: "Deleted",
-              department: 123,
-            },
-            greenSecurityCsm: {
-              status: "Inactive",
-              department: null,
-            },
-            accountManager: {
-              status: "Inactive",
-              department: 123,
-            },
-          },
-          vendorGuestPolicy: {
-            enabled: false,
-            vendorGuestLimitAndOr: "and",
-            vendorGuestRequireEmail: false,
-          },
-        },
+        facility: {},
       },
     ],
   });
@@ -82,9 +57,8 @@ test("Zones Security Zone Checkin", async () => {
   });
 
   const result = await greenSecurity.zones.securityZoneCheckin({
-    longitude: 1088.53,
-    latitude: 6020.88,
-    zoneId: 654096,
+    qrCode: "<value>",
+    zoneId: 544883,
   });
   expect(result).toBeDefined();
   expect(result).toEqual({});

package/src/admin-funcs/zoneDevicesCreate.ts

@@ -0,0 +1,22 @@
+import { APIPromise } from "../types/async.js";
+import { $doPost, internalApiResult } from "./doAdmin.js";
+
+export type zoneDeviceConnectionType = "ethernet" | "wifi";
+
+// Wire names, posted verbatim like networksCreateRequest.
+export type zoneDevicesCreateRequest = {
+  zone_id: number;
+  network_id: number;
+  connection_type: zoneDeviceConnectionType;
+  mac_address: string;
+  name: string;
+};
+
+// Saves an MG6 gateway from the Gatekeeper create-gateway flow (GSSD-7286). Provisioning is a
+// separate call.
+//
+// Internal for the same reason as zoneDevicesList. 409 means the MAC is already a gateway
+// somewhere; the server never says where.
+export function zoneDevicesCreate(request: zoneDevicesCreateRequest): internalApiResult {
+  return new APIPromise($doPost("/zone-devices", request));
+}

package/src/admin-funcs/zoneDevicesList.ts

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

package/src/admin-funcs/zoneDevicesMacAvailability.ts

@@ -0,0 +1,8 @@
+import { APIPromise } from "../types/async.js";
+import { $doGetSingle, internalApiResult } from "./doAdmin.js";
+
+// Whether a scanned MAC is free to become a gateway: `{ mac_address, available }`, with the MAC
+// normalized. A query parameter rather than a path segment, so no separator needs escaping.
+export function zoneDevicesMacAvailability(macAddress: string): internalApiResult {
+  return new APIPromise($doGetSingle("/zone-devices/mac-availability", { mac_address: macAddress }));
+}