@greensecurity/javascript-sdk 0.46.0-beta.7 → 0.46.0-beta.9

package/dist/esm/sdk/zones.d.ts

@@ -10,6 +10,8 @@ export declare class Zones extends ClientSDK {
      * Lists or searches security zones
      *
      * **Permissions.** Requires the `zones.view` permission.
+     *
+     * The `expand` parameter accepts only `zone.device_counts`, which also requires `zone_devices.view`. The server ignores other values.
      */
     listOrSearchSecurityZones(request: operations.ListOrSearchSecurityZonesRequest, options?: RequestOptions): Promise<PageIterator<operations.ListOrSearchSecurityZonesResponse, {
         page: number;
@@ -27,6 +29,7 @@ export declare class Zones extends ClientSDK {
      * - `zone.facility`
      * - `zone.department`
      * - `zone.rules`
+     * - `zone.device_counts` (also requires `zone_devices.view`)
      *
      * The server ignores unrecognized values.
      */

package/dist/esm/sdk/zones.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"zones.d.ts","sourceRoot":"","sources":["../../../src/sdk/zones.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAE5D,OAAO,EAAE,YAAY,EAAwB,MAAM,wBAAwB,CAAC;AAE5E,qBAAa,KAAM,SAAQ,SAAS;IAClC;;;;;;;OAOG;IACG,yBAAyB,CAC7B,OAAO,EAAE,UAAU,CAAC,gCAAgC,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,YAAY,CAAC,UAAU,CAAC,iCAAiC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAC7E;IAQD;;;;;;;;;;;;;;;OAeG;IACG,eAAe,CACnB,OAAO,EAAE,UAAU,CAAC,sBAAsB,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC;IAQ3B;;;;;;;OAOG;IACG,mBAAmB,CACvB,OAAO,EAAE,UAAU,CAAC,8BAA8B,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,wCAAwC,CAAC;CAOhE"}
+{"version":3,"file":"zones.d.ts","sourceRoot":"","sources":["../../../src/sdk/zones.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAE5D,OAAO,EAAE,YAAY,EAAwB,MAAM,wBAAwB,CAAC;AAE5E,qBAAa,KAAM,SAAQ,SAAS;IAClC;;;;;;;;;OASG;IACG,yBAAyB,CAC7B,OAAO,EAAE,UAAU,CAAC,gCAAgC,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,YAAY,CAAC,UAAU,CAAC,iCAAiC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAC7E;IAQD;;;;;;;;;;;;;;;;OAgBG;IACG,eAAe,CACnB,OAAO,EAAE,UAAU,CAAC,sBAAsB,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC;IAQ3B;;;;;;;OAOG;IACG,mBAAmB,CACvB,OAAO,EAAE,UAAU,CAAC,8BAA8B,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,wCAAwC,CAAC;CAOhE"}

package/dist/esm/sdk/zones.js

@@ -15,6 +15,8 @@ export class Zones extends ClientSDK {
      * Lists or searches security zones
      *
      * **Permissions.** Requires the `zones.view` permission.
+     *
+     * The `expand` parameter accepts only `zone.device_counts`, which also requires `zone_devices.view`. The server ignores other values.
      */
     async listOrSearchSecurityZones(request, options) {
         return unwrapResultIterator(zonesListOrSearchSecurityZones(this, request, options));
@@ -32,6 +34,7 @@ export class Zones extends ClientSDK {
      * - `zone.facility`
      * - `zone.department`
      * - `zone.rules`
+     * - `zone.device_counts` (also requires `zone_devices.view`)
      *
      * The server ignores unrecognized values.
      */

package/dist/esm/sdk/zones.js.map

@@ -1 +1 @@
-{"version":3,"file":"zones.js","sourceRoot":"","sources":["../../../src/sdk/zones.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,EAAE,8BAA8B,EAAE,MAAM,4CAA4C,CAAC;AAC5F,OAAO,EAAE,wBAAwB,EAAE,MAAM,sCAAsC,CAAC;AAChF,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAgB,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE5E,MAAM,OAAO,KAAM,SAAQ,SAAS;IAClC;;;;;;;OAOG;IACH,KAAK,CAAC,yBAAyB,CAC7B,OAAoD,EACpD,OAAwB;QAIxB,OAAO,oBAAoB,CAAC,8BAA8B,CACxD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,eAAe,CACnB,OAA0C,EAC1C,OAAwB;QAExB,OAAO,WAAW,CAAC,oBAAoB,CACrC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,mBAAmB,CACvB,OAAkD,EAClD,OAAwB;QAExB,OAAO,WAAW,CAAC,wBAAwB,CACzC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"zones.js","sourceRoot":"","sources":["../../../src/sdk/zones.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,EAAE,8BAA8B,EAAE,MAAM,4CAA4C,CAAC;AAC5F,OAAO,EAAE,wBAAwB,EAAE,MAAM,sCAAsC,CAAC;AAChF,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAgB,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE5E,MAAM,OAAO,KAAM,SAAQ,SAAS;IAClC;;;;;;;;;OASG;IACH,KAAK,CAAC,yBAAyB,CAC7B,OAAoD,EACpD,OAAwB;QAIxB,OAAO,oBAAoB,CAAC,8BAA8B,CACxD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,eAAe,CACnB,OAA0C,EAC1C,OAAwB;QAExB,OAAO,WAAW,CAAC,oBAAoB,CACrC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,mBAAmB,CACvB,OAAkD,EAClD,OAAwB;QAExB,OAAO,WAAW,CAAC,wBAAwB,CACzC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}

package/examples/apps/hello-green/src/apiKey.ts

@@ -0,0 +1,27 @@
+import type { ExtensionContext } from "@greensecurity/javascript-sdk/apps/context";
+import { secrets } from "@greensecurity/javascript-sdk/apps/secrets";
+
+/** The name the settings view stores the Acme API key under, scoped to this installation. */
+export const API_KEY_SECRET = "acme_api_key";
+
+/** Whether this installation has an Acme API key stored, as the Secret Store reports it. */
+export type ApiKeyStatus = "saved" | "not set" | "unavailable";
+
+/**
+ * Looks the API key up without reading its value (`expandPayload: false`): the views only need
+ * to know whether one is stored, so the key never reaches the app's UI. A 404 means none is
+ * stored; any other failure, a missing `app_secrets.write` grant included, means the store
+ * could not answer.
+ */
+export async function findApiKeyStatus(ctx: ExtensionContext): Promise<ApiKeyStatus> {
+  try {
+    await secrets.find(ctx, { name: API_KEY_SECRET, scope: { type: "installation" }, expandPayload: false });
+    return "saved";
+  } catch (error) {
+    return isNotFound(error) ? "not set" : "unavailable";
+  }
+}
+
+function isNotFound(error: unknown): boolean {
+  return error instanceof Error && "statusCode" in error && error.statusCode === 404;
+}

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "@greensecurity/javascript-sdk",
-  "version": "0.46.0-beta.7",
+  "version": "0.46.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.46.0-beta.7",
+  "version": "0.46.0-beta.9",
   "author": "Green Security LLC",
   "type": "module",
   "tshy": {

package/src/__tests__/alerts.test.ts

@@ -33,6 +33,7 @@ test("Alerts List Alerts", async () => {
       itemsPerPage: 562526,
       page: 1,
       useUrlParams: true,
+      scope: null,
     },
     items: [],
   });

package/src/__tests__/apps/kit/example.test.ts

@@ -27,19 +27,25 @@ const MANIFEST = JSON.parse(readFileSync(join(EXAMPLE_DIR, "green-app.json"), "u
 const MANIFEST_PERMISSIONS = MANIFEST.permissions.map((p) => p.permission);
 
 describe("hello-green AppSettings", () => {
-  async function renderSettings(fetchStatus: number, showToast: () => Promise<void>, errorMessage = "Forbidden") {
+  // One status per request, in order (the save, then the lookup that confirms it); the last
+  // one repeats.
+  async function renderSettings(fetchStatus: number | number[], showToast: () => Promise<void>, errorMessage = "Forbidden") {
+    const statuses = Array.isArray(fetchStatus) ? [...fetchStatus] : [fetchStatus];
+    const nextStatus = () => (statuses.length > 1 ? statuses.shift() : statuses[0]) ?? 500;
     // Through a variable, so the SDK's own tsc/tshy programs do not compile the example (it has
     // its own tsconfig and is outside `rootDir`); vitest still transforms and loads it.
     const exampleModule = "../../../../examples/apps/hello-green/src/AppSettings.js";
     const { AppSettings } = (await import(/* @vite-ignore */ exampleModule)) as { AppSettings: ComponentType };
     const originalFetch = globalThis.fetch;
-    globalThis.fetch = (async () =>
-      new Response(
-        JSON.stringify(fetchStatus === 200
+    globalThis.fetch = (async () => {
+      const status = nextStatus();
+      return new Response(
+        JSON.stringify(status === 200
           ? { id: 1, object: "app.secret", name: "acme_api_key", scope: { type: "installation" }, created: 1758499200, expires_at: null }
-          : { error: errorMessage, success: false, code: fetchStatus }),
-        { status: fetchStatus, headers: { "content-type": "application/json" } },
-      )) as typeof fetch;
+          : { error: errorMessage, success: false, code: status }),
+        { status, headers: { "content-type": "application/json" } },
+      );
+    }) as typeof fetch;
     try {
       const view = await renderForTest(h(AppSettings), { host: { showToast }, context: { app: { permissions: MANIFEST_PERMISSIONS } } });
       await view.root.trigger("onSave", { api_key: "k" });
@@ -55,6 +61,12 @@ describe("hello-green AppSettings", () => {
     expect(view.host.callsTo("showToast")).toHaveLength(1);
   });
 
+  test("a save the secret store does not confirm is not reported as saved", async () => {
+    const view = await renderSettings([200, 404], async () => undefined, "Not found");
+    expect(view.root.props["statusMessage"]).toBe("The API key was sent, but the secret store did not confirm it. Try again.");
+    expect(view.host.callsTo("showToast")).toHaveLength(0);
+  });
+
   test("a failed save asks to retry and shows no success toast", async () => {
     const view = await renderSettings(403, async () => undefined);
     expect(view.root.props["statusMessage"]).toBe("Could not save the API key. Try again.");