@knowttl/checkpoint-axi 0.1.1 → 0.1.2

package/README.md

@@ -74,6 +74,14 @@ Use the [command reference](docs/commands.md) for the full catalogue.
 | home | Show local profile context without resolving secrets | Local read | [Guide](docs/configuration.md) |
 | profile | List named file profiles | Local read | [Guide](docs/configuration.md) |
 | task | Inspect asynchronous action status without polling | Read | [Guide](docs/reads.md#event-and-task-reads) |
+
+Email search --filter accepts a JSON array of {saasAttrName, saasAttrOp, saasAttrValue}.
+saasAttrName is a field path, not a closed enum (guide pages 19-20).
+Documented examples: entityPayload.subject, entityPayload.fromEmail, entityPayload.attachmentCount.
+Other documented email payload paths (pages 15-16, 24-25): entityPayload.internetMessageId, entityPayload.received, entityPayload.size, entityPayload.emailLinks, entityPayload.attachments, entityPayload.mode, entityPayload.recipients, entityPayload.fromDomain, entityPayload.fromUser, entityPayload.fromName, entityPayload.to, entityPayload.toUser, entityPayload.cc, entityPayload.ccUser, entityPayload.bcc, entityPayload.bccUser, entityPayload.replyToEmail, entityPayload.replyToNickname, entityPayload.isRead, entityPayload.isDeleted, entityPayload.isIncoming, entityPayload.isInternal, entityPayload.isOutgoing, entityPayload.isQuarantined, entityPayload.isQuarantineNotification, entityPayload.isRestored, entityPayload.isRestoreRequested, entityPayload.isRestoreDeclined, entityPayload.saasSpamVerdict, entityPayload.SpfResult.
+saasAttrOp: is, contains, startsWith, isEmpty, isNot, notContains, isNotEmpty, greaterThan, lessThan.
+The guide defines operators globally, without a per-field compatibility matrix; examples pair fromEmail with is and attachmentCount with greaterThan.
+saasAttrValue is a string.
 <!-- command-registry:end -->
 
 The command catalogue generates this overview and the full references.
@@ -114,8 +122,8 @@ File metadata never mixes with environment-profile fields; SecretRefs may explic
 | `CHECKPOINT_AXI_REGION` | Environment-profile region | Required with client ID/secret |
 | `CHECKPOINT_AXI_CLIENT_ID` | Environment-profile client ID | Required with region/secret |
 | `CHECKPOINT_AXI_CLIENT_SECRET` | Environment secret source | Default SecretRef; required for env profile |
-| `CHECKPOINT_AXI_SAAS` | Environment-profile SaaS | `office365_emails` |
-| `CHECKPOINT_AXI_SCOPE` | Environment-profile download scope | Unset |
+| `CHECKPOINT_AXI_SAAS` | Environment-profile SaaS application name, not a URL; see [SaaS and scope](docs/configuration.md#saas-and-scope) for selection and format | `office365_emails` (Microsoft 365 email) |
+| `CHECKPOINT_AXI_SCOPE` | Environment-profile download scope; see [SaaS and scope](docs/configuration.md#saas-and-scope) for values and [download requirements](docs/downloads.md) for usage and permission limits | Unset |
 | `CHECKPOINT_AXI_READ_ONLY` | Force read-only: `1`/`true`; `0`/`false` releases override | Unset |
 | `CHECKPOINT_AXI_WRITE_LOG` | Write journal path | State directory's `writes.log`; blank uses default |
 | `XDG_CONFIG_HOME` | Absolute config base on Linux/macOS | `~/.config` |

package/axi-credential.schema.json

@@ -6,29 +6,48 @@
   "additionalProperties": false,
   "required": ["region", "clientId"],
   "properties": {
-    "region": { "type": "string", "enum": ["us", "eu", "ca", "au", "uk", "uae", "in"] },
-    "clientId": { "type": "string", "minLength": 1, "pattern": "\\S" },
-    "clientSecret": { "$ref": "#/$defs/secretRef", "x-secret": true, "default": { "env": "CHECKPOINT_AXI_CLIENT_SECRET" } },
-    "saas": { "type": "string", "minLength": 1, "pattern": "\\S", "default": "office365_emails" },
-    "scope": { "type": "string", "minLength": 1, "pattern": "\\S" },
+    "region": {
+      "title": "Region", "description": "Required region code for your tenant's regional gateway: us, eu, ca, au, uk, uae or in. Obtain it from your tenant administrator. There is no default; URLs are not accepted.",
+      "type": "string", "enum": ["us", "eu", "ca", "au", "uk", "uae", "in"]
+    },
+    "clientId": {
+      "title": "Client ID", "description": "Required non-blank API client ID from your tenant's API credentials. There is no default.",
+      "type": "string", "minLength": 1, "pattern": "\\S"
+    },
+    "clientSecret": {
+      "title": "Client secret reference", "description": "Reference the environment variable or absolute private file containing your API client secret, never the secret itself. If omitted, reads CHECKPOINT_AXI_CLIENT_SECRET; a missing or blank secret prevents authentication.",
+      "$ref": "#/$defs/secretRef", "x-secret": true, "default": { "env": "CHECKPOINT_AXI_CLIENT_SECRET" }
+    },
+    "saas": {
+      "title": "SaaS application name",
+      "description": "One non-blank SaaS application name for the tenant, not a gateway, host or authentication URL; slash (/) is not allowed. Obtain the exact API application name from your tenant administrator or Check Point support. If omitted, defaults to office365_emails, selecting Microsoft 365 email; supply the appropriate name for another application. A profile takes one value, while --saas on event list accepts a comma-separated list.",
+      "type": "string", "minLength": 1, "pattern": "\\S", "not": { "pattern": "/" }, "default": "office365_emails"
+    },
+    "scope": {
+      "title": "Download scope",
+      "description": "Download scope value supplied by your tenant administrator or Check Point support for the intended download. Use printable ASCII with no spaces (characters ! through ~); comma-separated values are sent verbatim. There is no default: omitted means unset, so email download fails because it requires the profile scope as its scopes header. Attachment download uses this only as the default scope query; --scope overrides it, and neither supplied means no scope query. Tenant scope authorization and the relationship between these selectors remain unverified; do not guess a value.",
+      "type": "string", "minLength": 1, "pattern": "^[!-~]+$"
+    },
     "downloads": {
+      "title": "Download permission", "description": "Separate file-profile download opt-in. If omitted, downloads are disabled. Environment profiles cannot enable downloads.",
       "type": "object", "additionalProperties": false, "required": ["allow"], "default": { "allow": false },
-      "properties": { "allow": { "type": "boolean" } }
+      "properties": { "allow": { "title": "Allow downloads", "description": "Set true to permit download commands; each command still requires a new private output file.", "type": "boolean" } }
     },
     "writes": {
+      "title": "Write permissions", "description": "File-profile write opt-in and exact operation allow-list. If omitted, writes are disabled with no allowed operations. Forced read-only always wins.",
       "type": "object", "additionalProperties": false, "required": ["allowWrites", "operations"],
       "default": { "allowWrites": false, "operations": [] },
       "properties": {
-        "allowWrites": { "type": "boolean" },
-        "operations": { "type": "array", "items": { "type": "string", "pattern": "^[a-z][A-Za-z0-9_.-]*$" } }
+        "allowWrites": { "title": "Allow writes", "description": "Set true to permit listed operations, subject to preview, exact confirmation and durable redacted intent.", "type": "boolean" },
+        "operations": { "title": "Allowed write operations", "description": "Exact operation names to allow, such as email.quarantine. An empty list permits no writes.", "type": "array", "items": { "type": "string", "pattern": "^[a-z][A-Za-z0-9_.-]*$" } }
       }
     }
   },
   "$defs": {
     "secretRef": {
       "oneOf": [
-        { "type": "object", "additionalProperties": false, "required": ["env"], "properties": { "env": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" } } },
-        { "type": "object", "additionalProperties": false, "required": ["file"], "properties": { "file": { "type": "string", "pattern": "^(?:/|[A-Za-z]:[\\\\/])" } } }
+        { "type": "object", "additionalProperties": false, "required": ["env"], "properties": { "env": { "title": "Secret environment variable", "description": "Name of the environment variable holding the secret, such as CHECKPOINT_AXI_CLIENT_SECRET. Use letters, digits and underscores, starting with a letter or underscore.", "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" } } },
+        { "type": "object", "additionalProperties": false, "required": ["file"], "properties": { "file": { "title": "Secret file path", "description": "Absolute path to a private UTF-8 file holding the secret. Symlinks and insecure permissions are rejected; a leading BOM and trailing whitespace are removed from its content.", "type": "string", "pattern": "^(?:/|[A-Za-z]:[\\\\/])" } } }
       ]
     }
   }

package/dist/src/catalogue.d.ts

@@ -1,5 +1,7 @@
 export declare const DESCRIPTION = "Inspect Check Point Email Security through compact, guarded AXI commands";
 export declare const SETUP_GUIDANCE = "Run checkpoint-axi config path; configure a region, clientId and clientSecret env/file SecretRef";
+export declare const EMAIL_PAYLOAD_ATTRIBUTES: string[];
+export declare const EMAIL_FILTER_GUIDANCE: string;
 export declare const catalogue: {
     readonly "email download": {
         readonly description: "Download an email to a new private file with profile opt-in, a 50 MiB cap and mandatory SHA-256 verification; scopes and email hash availability are unverified (guide pages 131-132)";
@@ -230,7 +232,7 @@ export declare const catalogue: {
     readonly "email search": {
         readonly description: "Search emails with a bounded date window and scroll continuation (API guide pages 18-27)";
         readonly flags: {
-            readonly filter: "JSON array of {saasAttrName, saasAttrOp, saasAttrValue} filters (guide pages 19-20)";
+            readonly filter: `JSON array of {saasAttrName, saasAttrOp, saasAttrValue} filters. ${string}`;
             readonly "start-date": string;
             readonly "end-date": string;
             readonly limit: string;

package/dist/src/catalogue.js

@@ -1,6 +1,11 @@
 import { exceptionFamilies } from "./exceptions.js";
 export const DESCRIPTION = "Inspect Check Point Email Security through compact, guarded AXI commands";
 export const SETUP_GUIDANCE = "Run checkpoint-axi config path; configure a region, clientId and clientSecret env/file SecretRef";
+export const EMAIL_PAYLOAD_ATTRIBUTES = ["subject", "fromEmail", "attachmentCount", "internetMessageId", "received", "size", "emailLinks", "attachments", "mode", "recipients", "fromDomain", "fromUser", "fromName", "to", "toUser", "cc", "ccUser", "bcc", "bccUser", "replyToEmail", "replyToNickname", "isRead", "isDeleted", "isIncoming", "isInternal", "isOutgoing", "isQuarantined", "isQuarantineNotification", "isRestored", "isRestoreRequested", "isRestoreDeclined", "saasSpamVerdict", "SpfResult"].map((name) => `entityPayload.${name}`);
+export const EMAIL_FILTER_GUIDANCE = "saasAttrName is a field path, not a closed enum (guide pages 19-20). Documented examples: "
+    + EMAIL_PAYLOAD_ATTRIBUTES.slice(0, 3).join(", ") + ". Other documented email payload paths (pages 15-16, 24-25): "
+    + EMAIL_PAYLOAD_ATTRIBUTES.slice(3).join(", ")
+    + ". saasAttrOp: is, contains, startsWith, isEmpty, isNot, notContains, isNotEmpty, greaterThan, lessThan. The guide defines operators globally, without a per-field compatibility matrix; examples pair fromEmail with is and attachmentCount with greaterThan. saasAttrValue is a string.";
 const common = {
     config: "Config path; default CHECKPOINT_AXI_CONFIG or platform path",
     profile: "Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile",
@@ -82,7 +87,7 @@ export const catalogue = {
             saas: "SaaS override; default selected profile saas or office365_emails",
             "saas-entity": "Optional SaaS entity type selector",
             ...paging,
-            filter: "JSON array of {saasAttrName, saasAttrOp, saasAttrValue} filters (guide pages 19-20)",
+            filter: `JSON array of {saasAttrName, saasAttrOp, saasAttrValue} filters. ${EMAIL_FILTER_GUIDANCE}`,
         }, examples: ["checkpoint-axi email search", "checkpoint-axi email search --all --saas office365_emails", "checkpoint-axi email search --cursor <cursor>"] },
     "email show": { description: "Show one email with verdicts, actions and available actions (API guide pages 10-18)", flags: common,
         examples: ["checkpoint-axi email show <id>", "checkpoint-axi email show <id> --full"] },

package/dist/src/profiles.js

@@ -8,6 +8,7 @@ import { SecretRedactor } from "./redact.js";
 const profileName = z.string().regex(/^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$/);
 const region = z.enum(Object.keys(REGIONS));
 const nonempty = z.string().trim().min(1);
+const saasName = nonempty.refine((value) => !value.includes("/"));
 function schema(platform) {
     const secretRef = z.union([
         z.strictObject({ env: z.string().regex(/^[A-Za-z_][A-Za-z0-9_]*$/) }),
@@ -17,7 +18,7 @@ function schema(platform) {
         region,
         clientId: nonempty,
         clientSecret: secretRef.default({ env: "CHECKPOINT_AXI_CLIENT_SECRET" }),
-        saas: nonempty.default("office365_emails"),
+        saas: saasName.default("office365_emails"),
         scope: nonempty.optional(),
         downloads: z.strictObject({ allow: z.boolean() }).default({ allow: false }),
         writes: z.strictObject({ allowWrites: z.boolean(), operations: z.array(z.string().regex(/^[a-z][A-Za-z0-9_.-]*$/)) })
@@ -78,7 +79,7 @@ export function credentialStore(options = {}, redactor = new SecretRedactor()) {
         }
         const parsed = schema(platform).safeParse(raw);
         if (!parsed.success)
-            return invalid("Invalid configuration: check profile names, region, defaultProfile, unknown fields and clientSecret SecretRef");
+            return invalid("Invalid configuration: check profile names, region, defaultProfile, unknown fields, clientSecret SecretRef and saas (use a SaaS application name, not a URL)");
         return { path, config: parsed.data };
     }
     function select(config, flag) {
@@ -87,8 +88,11 @@ export function credentialStore(options = {}, redactor = new SecretRedactor()) {
             invalid("Invalid selected profile name");
         const envFields = ["REGION", "CLIENT_ID", "SAAS", "SCOPE"];
         if (selected === undefined && envFields.some((field) => env[`CHECKPOINT_AXI_${field}`] !== undefined)) {
+            if (env.CHECKPOINT_AXI_SAAS !== undefined && !saasName.safeParse(env.CHECKPOINT_AXI_SAAS).success) {
+                return invalid("saas must be a SaaS application name, not a URL");
+            }
             if (!region.safeParse(env.CHECKPOINT_AXI_REGION).success || !env.CHECKPOINT_AXI_CLIENT_ID?.trim() || !env.CHECKPOINT_AXI_CLIENT_SECRET?.trim()
-                || (env.CHECKPOINT_AXI_SAAS !== undefined && !env.CHECKPOINT_AXI_SAAS.trim()) || (env.CHECKPOINT_AXI_SCOPE !== undefined && !env.CHECKPOINT_AXI_SCOPE.trim())) {
+                || (env.CHECKPOINT_AXI_SCOPE !== undefined && !env.CHECKPOINT_AXI_SCOPE.trim())) {
                 return invalid("Incomplete or invalid env profile; set REGION, CLIENT_ID and CLIENT_SECRET together");
             }
             return { region: env.CHECKPOINT_AXI_REGION, clientId: env.CHECKPOINT_AXI_CLIENT_ID.trim(),

package/dist/src/reads.js

@@ -3,6 +3,7 @@ import { createHash } from "node:crypto";
 import { z } from "zod";
 import { REGIONS } from "./regions.js";
 import { gateway, READ_LIMITS } from "./transport.js";
+import { responseInvalid } from "./response-invalid.js";
 const day = 86_400_000;
 const timestamp = z.iso.datetime({ offset: true });
 const filters = z.array(z.strictObject({ saasAttrName: z.string().min(1),
@@ -10,10 +11,12 @@ const filters = z.array(z.strictObject({ saasAttrName: z.string().min(1),
     saasAttrValue: z.string() }));
 const continuation = z.strictObject({ version: z.literal(1), binding: z.string(), start: timestamp, end: timestamp,
     scroll: z.string().optional(), offset: z.number().int().nonnegative(), replayRisk: z.literal(true).optional() });
+// The guide's prose/table (pp.11,14) says security-result array; its JSON examples use an object.
+const securityResults = z.object({ combinedVerdict: z.unknown().optional() }).passthrough();
 // Entity schemas and SaaS-specific payloads: guide pages 11-15 and 21-24.
 const entity = z.object({ entityInfo: z.object({ entityId: z.string().min(1), entityActionState: z.string().optional() }).passthrough(),
     entityPayload: z.object({ subject: z.string().optional() }).passthrough(),
-    entitySecurityResults: z.object({ combinedVerdict: z.unknown().optional() }).passthrough().optional(),
+    entitySecurityResults: z.union([securityResults, z.array(z.object({}).passthrough())]).optional(),
 }).passthrough();
 // Event and task fields: guide pages 31-32, 35-36 and 40-41.
 const event = z.object({ eventId: z.string().min(1), type: z.string(), state: z.string(), severity: z.string() }).passthrough();
@@ -101,15 +104,19 @@ export async function readCommand(name, id, flags, store, transport) {
     if (name.endsWith(" show")) {
         const kind = name.split(" ")[0];
         const page = await api.read({ path: name === "task show" ? `/task/${id}` : isEvent ? `/event/${id}` : `/search/entity/${id}` });
+        const response = { responseData: page.dataIsArray ? page.records : page.records[0] };
+        const recordPath = page.dataIsArray ? ["responseData", 0] : ["responseData"];
         if (page.records.length === 0)
             throw new AxiError(`${kind} was not found`, "NOT_FOUND", []);
         const parsed = (name === "task show" ? task : isEvent ? event : entity).safeParse(page.records[0]);
-        if (page.records.length !== 1 || !parsed.success)
-            throw new AxiError(`Invalid ${kind} detail response`, "RESPONSE_INVALID", []);
+        if (page.records.length !== 1)
+            throw responseInvalid(`Invalid ${kind} detail response`, response, [["responseData"]]);
+        if (!parsed.success)
+            throw responseInvalid(`Invalid ${kind} detail response`, response, parsed.error.issues.map((issue) => [...recordPath, ...issue.path]));
         const record = page.records[0];
         const returnedId = name === "task show" ? String(record.id) : isEvent ? record.eventId : record.entityInfo?.entityId;
         if (returnedId !== id)
-            throw new AxiError(`Invalid ${kind} detail response`, "RESPONSE_INVALID", []);
+            throw responseInvalid(`Invalid ${kind} detail response`, response, [[...recordPath, ...(name === "task show" ? ["id"] : isEvent ? ["eventId"] : ["entityInfo", "entityId"])]]);
         return { [kind]: parsed.data };
     }
     const results = [];
@@ -131,11 +138,14 @@ export async function readCommand(name, id, flags, store, transport) {
             throw error;
         }
         const parsed = z.array(isEvent ? event : entity).safeParse(page.records);
-        if (!parsed.success || offset > page.records.length)
-            throw new AxiError("Invalid search response", "RESPONSE_INVALID", []);
+        const response = { responseData: page.dataIsArray ? page.records : page.records[0] };
+        if (!parsed.success)
+            throw responseInvalid("Invalid search response", response, parsed.error.issues.map((issue) => ["responseData", ...(page.dataIsArray ? issue.path : issue.path.slice(1))]));
+        if (offset > page.records.length)
+            throw responseInvalid("Invalid search response", response, [["responseData"]]);
         // Never wrap an echoed credential in a reversible continuation cursor.
         if (page.scrollId && store.redactor.text(page.scrollId) !== page.scrollId)
-            throw new AxiError("Unsafe API scrollId", "RESPONSE_INVALID", []);
+            throw responseInvalid("Unsafe API scrollId", { responseEnvelope: { scrollId: page.scrollId } }, [["responseEnvelope", "scrollId"]]);
         total = page.total ?? total;
         const rows = parsed.data.slice(offset, offset + limit - results.length);
         results.push(...rows.map((record) => {
@@ -145,7 +155,7 @@ export async function readCommand(name, id, flags, store, transport) {
             }
             const value = entity.parse(record);
             return { id: value.entityInfo.entityId, subject: value.entityPayload.subject ?? "",
-                state: value.entityInfo.entityActionState ?? "", verdict: value.entitySecurityResults?.combinedVerdict ?? null };
+                state: value.entityInfo.entityActionState ?? "", verdict: Array.isArray(value.entitySecurityResults) ? null : value.entitySecurityResults?.combinedVerdict ?? null };
         }));
         offset += rows.length;
         if (offset < page.records.length) {

package/dist/src/response-invalid.d.ts

@@ -0,0 +1,2 @@
+import { AxiError } from "axi-sdk-js";
+export declare function responseInvalid(message: string, value: unknown, paths: readonly (readonly PropertyKey[])[]): AxiError;

package/dist/src/response-invalid.js

@@ -0,0 +1,17 @@
+import { AxiError } from "axi-sdk-js";
+// Never format validator messages or received values: both may contain tenant data.
+export function responseInvalid(message, value, paths) {
+    const failures = paths.map((path) => {
+        let received = value;
+        let location = "$";
+        for (const key of path) {
+            location += typeof key === "number" ? `[${key}]`
+                : `.${typeof key === "string" && /^[A-Za-z_$][A-Za-z0-9_$]*$/.test(key) ? key : "<key>"}`;
+            received = received !== null && typeof received === "object" && Object.hasOwn(received, key)
+                ? received[key] : undefined;
+        }
+        const type = received === undefined ? "missing" : received === null ? "null" : Array.isArray(received) ? "array" : typeof received;
+        return `${location}: ${type}`;
+    });
+    return new AxiError(`${message} (${[...new Set(failures)].join("; ")})`, "RESPONSE_INVALID", []);
+}

package/dist/src/transport.d.ts

@@ -59,6 +59,7 @@ export type ReadRequest = {
 };
 export type Page = {
     records: unknown[];
+    dataIsArray: boolean;
     scrollId?: string;
     total?: number;
 };

package/dist/src/transport.js

@@ -4,6 +4,7 @@ import { request } from "node:https";
 import { setTimeout as delay } from "node:timers/promises";
 import { REGIONS } from "./regions.js";
 import { consumeWriteAuthorization } from "./writes.js";
+import { responseInvalid } from "./response-invalid.js";
 export const READ_LIMITS = { requests: 10, rows: 1_000, milliseconds: 60_000, bytes: 8 * 1024 * 1024 };
 export const DOWNLOAD_LIMIT = 50 * 1024 * 1024;
 const failure = (code, message) => new AxiError(message, code, ["Check the selected region and credentials; run checkpoint-axi doctor"]);
@@ -12,24 +13,26 @@ const object = (value) => value !== null && typeof value === "object" && !Array.
 export function decodePage(value, unverified = false) {
     // These exception families publish no response schema (guide pages 83-123).
     if (unverified && (!object(value) || !Object.hasOwn(value, "responseEnvelope"))) {
-        return { records: Array.isArray(value) ? value : [value] };
+        return { records: Array.isArray(value) ? value : [value], dataIsArray: Array.isArray(value) };
     }
-    if (!object(value) || !object(value.responseEnvelope))
-        throw failure("RESPONSE_INVALID", "Missing API response envelope");
+    if (!object(value))
+        throw responseInvalid("Missing API response envelope", value, [[]]);
+    if (!object(value.responseEnvelope))
+        throw responseInvalid("Missing API response envelope", value, [["responseEnvelope"]]);
     const envelope = value.responseEnvelope;
     if (envelope.responseCode !== 0 && envelope.responseCode !== "0" && envelope.responseCode !== 200 && envelope.responseCode !== "200") {
         throw failure("API_ERROR", "API response envelope did not report success");
     }
     const data = value.responseData;
     if ((!unverified && !Array.isArray(data) && !object(data)) || data === undefined)
-        throw failure("RESPONSE_INVALID", "Expected responseData");
+        throw responseInvalid("Expected responseData", value, [["responseData"]]);
     if (envelope.scrollId !== undefined && envelope.scrollId !== null && typeof envelope.scrollId !== "string") {
-        throw failure("RESPONSE_INVALID", "Invalid API scrollId");
+        throw responseInvalid("Invalid API scrollId", value, [["responseEnvelope", "scrollId"]]);
     }
     if (envelope.totalRecordsNumber !== undefined && (!Number.isSafeInteger(envelope.totalRecordsNumber) || Number(envelope.totalRecordsNumber) < 0)) {
-        throw failure("RESPONSE_INVALID", "Invalid API totalRecordsNumber");
+        throw responseInvalid("Invalid API totalRecordsNumber", value, [["responseEnvelope", "totalRecordsNumber"]]);
     }
-    return { records: Array.isArray(data) ? data : [data], scrollId: typeof envelope.scrollId === "string" && envelope.scrollId ? envelope.scrollId : undefined,
+    return { records: Array.isArray(data) ? data : [data], dataIsArray: Array.isArray(data), scrollId: typeof envelope.scrollId === "string" && envelope.scrollId ? envelope.scrollId : undefined,
         total: envelope.totalRecordsNumber };
 }
 // No field name or lifetime is commissioned yet (guide page 8).
@@ -125,7 +128,7 @@ export function gateway(profile, credentials, redactor, dependencies = {}, mutat
                         resolve({ status, value: JSON.parse(json) });
                     }
                     catch {
-                        reject(failure("RESPONSE_INVALID", "API returned invalid JSON"));
+                        reject(responseInvalid("API returned invalid JSON", json, [[]]));
                     }
                 });
             });

package/docs/agent-guide.md

@@ -36,6 +36,12 @@ checkpoint-axi email show synthetic-email-1 --fields email
 ```
 
 Search flags: --saas (default profile SaaS or office365_emails), --saas-entity, and --filter (JSON array of {saasAttrName, saasAttrOp, saasAttrValue}).
+saasAttrName is a field path, not a closed enum (guide pages 19-20).
+Documented examples: entityPayload.subject, entityPayload.fromEmail, entityPayload.attachmentCount.
+Other documented email payload paths (pages 15-16, 24-25): entityPayload.internetMessageId, entityPayload.received, entityPayload.size, entityPayload.emailLinks, entityPayload.attachments, entityPayload.mode, entityPayload.recipients, entityPayload.fromDomain, entityPayload.fromUser, entityPayload.fromName, entityPayload.to, entityPayload.toUser, entityPayload.cc, entityPayload.ccUser, entityPayload.bcc, entityPayload.bccUser, entityPayload.replyToEmail, entityPayload.replyToNickname, entityPayload.isRead, entityPayload.isDeleted, entityPayload.isIncoming, entityPayload.isInternal, entityPayload.isOutgoing, entityPayload.isQuarantined, entityPayload.isQuarantineNotification, entityPayload.isRestored, entityPayload.isRestoreRequested, entityPayload.isRestoreDeclined, entityPayload.saasSpamVerdict, entityPayload.SpfResult.
+saasAttrOp: is, contains, startsWith, isEmpty, isNot, notContains, isNotEmpty, greaterThan, lessThan.
+The guide defines operators globally, without a per-field compatibility matrix; examples pair fromEmail with is and attachmentCount with greaterThan.
+saasAttrValue is a string.
 Event selectors include --event-types, --event-states, --severities, --event-ids (comma-separated), --confidence-indicator and --description; --saas accepts comma-separated SaaS values here.
 Event detail includes available actions; task detail reads status and per-action results once, without waiting or polling:
 

package/docs/commands.md

@@ -197,7 +197,7 @@ Search emails with a bounded date window and scroll continuation (API guide page
 | `--limit` | Maximum rows; default 50, range 1-1000; cannot combine with --all |
 | `--all` | Read up to 1000 rows / 10 HTTP requests / 60 seconds / 8 MiB; default false |
 | `--cursor` | Opaque continuation bound to profile, region, operation and selectors; repeat original selectors |
-| `--filter` | JSON array of {saasAttrName, saasAttrOp, saasAttrValue} filters (guide pages 19-20) |
+| `--filter` | JSON array of {saasAttrName, saasAttrOp, saasAttrValue} filters. saasAttrName is a field path, not a closed enum (guide pages 19-20). Documented examples: entityPayload.subject, entityPayload.fromEmail, entityPayload.attachmentCount. Other documented email payload paths (pages 15-16, 24-25): entityPayload.internetMessageId, entityPayload.received, entityPayload.size, entityPayload.emailLinks, entityPayload.attachments, entityPayload.mode, entityPayload.recipients, entityPayload.fromDomain, entityPayload.fromUser, entityPayload.fromName, entityPayload.to, entityPayload.toUser, entityPayload.cc, entityPayload.ccUser, entityPayload.bcc, entityPayload.bccUser, entityPayload.replyToEmail, entityPayload.replyToNickname, entityPayload.isRead, entityPayload.isDeleted, entityPayload.isIncoming, entityPayload.isInternal, entityPayload.isOutgoing, entityPayload.isQuarantined, entityPayload.isQuarantineNotification, entityPayload.isRestored, entityPayload.isRestoreRequested, entityPayload.isRestoreDeclined, entityPayload.saasSpamVerdict, entityPayload.SpfResult. saasAttrOp: is, contains, startsWith, isEmpty, isNot, notContains, isNotEmpty, greaterThan, lessThan. The guide defines operators globally, without a per-field compatibility matrix; examples pair fromEmail with is and attachmentCount with greaterThan. saasAttrValue is a string. |
 
 ```sh
 checkpoint-axi email search

package/docs/configuration.md

@@ -35,8 +35,6 @@ Omitting `clientSecret` defaults its reference to `CHECKPOINT_AXI_CLIENT_SECRET`
 It confirms local readiness, not API authentication.
 `profile list` and home never resolve secret files.
 Supported regions are `us`, `eu`, `ca`, `au`, `uk`, `uae` and `in`; there is no origin override.
-Optional `saas` defaults to `office365_emails`; `doctor`, `email search` and `event list` accept `--saas <name>` to override it for that call.
-Optional `scope` supplies the required email download `scopes` header and the default optional attachment `scope` query.
 The host-facing [credential schema](../axi-credential.schema.json) describes one strict profile.
 
 Config precedence is `--config`, then `CHECKPOINT_AXI_CONFIG`, then the platform path.
@@ -52,6 +50,22 @@ POSIX reads reject symlinks, foreign ownership, group/other-writable config and
 Secret file content is UTF-8 with a leading BOM and trailing whitespace removed.
 On Windows, regular files and reparse points are checked without interpreting mode bits; `auth status`, `doctor` and email, event, task and exception API commands also verify a protected DACL for the current user, SYSTEM and Administrators.
 
+## SaaS and scope
+
+`saas` is one non-blank SaaS application name, not a gateway, host or authentication URL.
+Obtain the exact API application name for your tenant from its administrator or Check Point support.
+If omitted, it defaults to `office365_emails`, selecting Microsoft 365 email; choose the appropriate name when targeting another application.
+`office365_emails` is valid; `https://example.test/auth` and `example.test/auth` are invalid because slash (`/`) is not allowed.
+A profile takes one value, not a comma-separated list.
+`doctor` and `email search` accept `--saas <name>` for a single-call override; `event list --saas <names>` accepts a comma-separated list.
+
+`scope` is a download scope value supplied by your tenant administrator or Check Point support for the intended download.
+Use printable ASCII with no spaces (characters `!` through `~`); comma-separated values are sent verbatim.
+For example, `synthetic:scope` has a valid form, while `synthetic scope` does not; the example is not a tenant-authorized value.
+There is no default: omitted means unset.
+Do not guess a tenant-authorized value.
+See [download requirements](downloads.md) for how email and attachment commands use scope, the remaining verification limits, and the separate download opt-in and output checks.
+
 ## Write and download permissions
 
 File profiles are read-only by default.

package/docs/downloads.md

@@ -17,6 +17,8 @@ checkpoint-axi attachment download-all <entity-id> --out /absolute/attachments
 ```
 
 Email downloads require profile `scope`, sent verbatim as the comma-separated `scopes` header required on page 131.
+Without it, email download fails before authentication.
+See [SaaS and scope](configuration.md#saas-and-scope) for the profile value's source and format.
 `--original` selects the unmodified email; default false includes the service's processing headers.
 Attachment commands use optional `--scope` as a query selector, defaulting to profile `scope` when configured; no scope query is sent when both are absent.
 Scope authorization and the relationship between the email `scopes` header and attachment `scope` query require manual verification.

package/docs/reads.md

@@ -30,6 +30,8 @@ Search defaults to the past 24 hours and 50 rows; `--start-date` and `--end-date
 `--saas` overrides the selected profile and `--saas-entity` optionally selects the entity type.
 `--filter` accepts a JSON array of the documented `saasAttrName`, `saasAttrOp` and `saasAttrValue` filters (guide pages 19-20).
 For example, `--filter '[{"saasAttrName":"entityPayload.subject","saasAttrOp":"contains","saasAttrValue":"Synthetic"}]'` selects a subject substring.
+The [generated search reference](commands.md#email-search) lists documented field paths and operators, also available in `email search --help`.
+The guide uses field paths rather than a closed attribute enum and does not specify a per-field operator compatibility matrix.
 Use `--limit <1-1000>` or `--all`, which stops at 1,000 rows, 10 HTTP requests, 60 seconds or 8 MiB, including authentication and retries.
 Incomplete searches return `complete: false`; when an opaque `cursor` is present, repeat with `--cursor <cursor>` and the same original selectors to continue.
 Cursors preserve the original window, bind profile/client identity, regional origin, operation and selectors, and retain an offset when a row limit splits a server page.
@@ -40,6 +42,13 @@ Treat cursors as sensitive search state and do not edit them.
 Cursor strings are never truncated; email text is redacted before 500-character previews, with `--full` for complete text.
 See [downloads](downloads.md) for private file output.
 
+The vendor PDF describes `entitySecurityResults` as an array in its prose/table (pages 11 and 14), while its JSON examples use an object.
+Both documented forms are accepted; detail preserves them, and search reports `verdict: null` for an array because no combined verdict object is documented there.
+Other response constraints remain unchanged.
+`RESPONSE_INVALID` diagnostics for these reads name failing JSON paths and received types, including `missing`, without response values.
+Non-identifier path keys appear as `<key>`.
+These diagnostics support owner commissioning; the actual failing fields behind TD-049's live unfiltered-search and spam-detail failures remain unverified.
+
 ## Event and task reads
 
 `checkpoint-axi event list` returns compact ID, type, state and severity rows (guide pages 37-42).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knowttl/checkpoint-axi",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Inspect Check Point Email Security through compact, guarded AXI commands",
   "license": "MIT",
   "type": "module",

package/skills/checkpoint-axi/SKILL.md

@@ -41,6 +41,12 @@ Both are bounded by 8 MiB of JSON and 60 seconds including auth and read retries
 Email search defaults to 50 compact rows and a 24-hour window; --start-date and --end-date require ISO timestamps with timezones and a positive window of at most 31 days (guide pages 18-27).
 Use --limit <1-1000> or --all, which caps output at 1000 rows within the shared transport budget.
 Use --saas-entity for an entity type or --filter for a JSON array of {saasAttrName, saasAttrOp, saasAttrValue} filters (guide pages 19-20).
+saasAttrName is a field path, not a closed enum (guide pages 19-20).
+Documented examples: entityPayload.subject, entityPayload.fromEmail, entityPayload.attachmentCount.
+Other documented email payload paths (pages 15-16, 24-25): entityPayload.internetMessageId, entityPayload.received, entityPayload.size, entityPayload.emailLinks, entityPayload.attachments, entityPayload.mode, entityPayload.recipients, entityPayload.fromDomain, entityPayload.fromUser, entityPayload.fromName, entityPayload.to, entityPayload.toUser, entityPayload.cc, entityPayload.ccUser, entityPayload.bcc, entityPayload.bccUser, entityPayload.replyToEmail, entityPayload.replyToNickname, entityPayload.isRead, entityPayload.isDeleted, entityPayload.isIncoming, entityPayload.isInternal, entityPayload.isOutgoing, entityPayload.isQuarantined, entityPayload.isQuarantineNotification, entityPayload.isRestored, entityPayload.isRestoreRequested, entityPayload.isRestoreDeclined, entityPayload.saasSpamVerdict, entityPayload.SpfResult.
+saasAttrOp: is, contains, startsWith, isEmpty, isNot, notContains, isNotEmpty, greaterThan, lessThan.
+The guide defines operators globally, without a per-field compatibility matrix; examples pair fromEmail with is and attachmentCount with greaterThan.
+saasAttrValue is a string.
 See [email-read guidance](../../docs/reads.md#email-reads) for continuation, completion status, cursor safety and page replay limitations.
 Email show <id> includes payload, verdicts, actions taken and available actions (guide pages 10-18).
 Use --full for strings truncated at 500 characters and --fields for top-level output projection.