hallpass-client 0.4.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,52 @@
+# hallpass-client
+
+The Node.js and TypeScript client for [hallpass](https://github.com/roee-hersh/hallpass): before
+your AI agent acts for a user, ask the system that owns the resource whether that user may do it.
+
+```sh
+npm install https://github.com/roee-hersh/hallpass/releases/download/v0.4.0/hallpass-client-node.tgz
+```
+
+Every [release](https://github.com/roee-hersh/hallpass/releases) carries the package. Pin a version
+as above rather than using `latest/download`: npm records the tarball's checksum in
+`package-lock.json`, so a URL whose content changes with each release would fail `npm ci` later.
+The package name is `hallpass-client`, so imports read `from "hallpass-client"`.
+
+It needs a running hallpass service. The client has no dependencies; it uses Node's built-in `fetch`
+(Node 18.17 or later). It ships as an ES module with type declarations.
+
+```ts
+import { AsyncLocalStorage } from "node:async_hooks";
+import { Hallpass, guarded } from "hallpass-client";
+
+const hp = new Hallpass(); // HALLPASS_URL and HALLPASS_API_KEY from the environment
+const currentUser = new AsyncLocalStorage<string>();
+
+const deleteIssue = guarded(hp, "jira-main", "DELETE_ISSUES", "issue:{key}", { user: currentUser, fresh: true })(
+  async ({ key }: { key: string }) => {
+    await jira.deleteIssue(key); // the agent's own credential, only after hallpass said allow
+    return `deleted ${key}`;
+  },
+);
+
+// per request or session, from your auth:
+await currentUser.run(req.user.email, () => generateText({ model, tools, prompt }));
+```
+
+- **The model never picks the user.** It comes from `user`: a string, a zero-argument function,
+  or an `AsyncLocalStorage` your application enters. A `user` key in the tool's arguments is ignored.
+- **It fails closed.** `deny`, `unknown` and hallpass being unreachable all reject with
+  `PermissionDenied` before the body runs. Pass `deny` to return a message to the model instead.
+- **One package covers every framework.** The wrapped function takes one object of arguments,
+  which is what the Vercel AI SDK, the MCP SDK and most agent frameworks pass to a tool.
+
+Without a wrapper:
+
+```ts
+const d = await hp.check("dana@example.com", "jira-main", "DELETE_ISSUES", "issue:PAY-123");
+d.decision, d.reason;   // "deny", "denied: ..."
+await hp.require(...);  // rejects with PermissionDenied unless allow
+```
+
+Framework examples: [examples/agent-ts](https://github.com/roee-hersh/hallpass/tree/main/examples/agent-ts).
+The guide: [docs/agents.md](https://github.com/roee-hersh/hallpass/blob/main/docs/agents.md).

package/dist/index.d.ts

@@ -0,0 +1,167 @@
+/**
+ * The hallpass client for agents. Node's built-in fetch, no dependencies.
+ *
+ * The one rule an agent has to follow: perform an action on behalf of a user
+ * only when hallpass answered `allow`. `deny` and `unknown` both mean "do not
+ * act", and so does any failure to reach hallpass at all.
+ *
+ *     const hp = new Hallpass(); // HALLPASS_URL and HALLPASS_API_KEY from the environment
+ *     await hp.require("dana@example.com", "jira-main", "DELETE_ISSUES", "issue:PAY-123");
+ *     await jira.deleteIssue("PAY-123"); // only reached when the answer was allow
+ *
+ * Or, for a tool an agent framework exposes to a model, `guarded`:
+ *
+ *     const currentUser = new AsyncLocalStorage<string>();
+ *
+ *     const deleteIssue = guarded(hp, "jira-main", "DELETE_ISSUES", "issue:{key}", { user: currentUser })(
+ *       async ({ key }: { key: string }) => {
+ *         await jira.deleteIssue(key);
+ *         return `deleted ${key}`;
+ *       },
+ *     );
+ *
+ * The user comes from the application, never from the tool's arguments.
+ *
+ * Install it from a hallpass release (see sdk/node/README.md). This is the TypeScript
+ * counterpart of the Python package (sdk/python) and follows the same
+ * contract; the tests in examples/agent-ts/hallpass_client.test.ts spell it
+ * out.
+ */
+import { AsyncLocalStorage } from "node:async_hooks";
+export declare const ALLOW = "allow";
+export declare const DENY = "deny";
+export declare const UNKNOWN = "unknown";
+export type DecisionValue = typeof ALLOW | typeof DENY | typeof UNKNOWN;
+/**
+ * One answer from `POST /check`.
+ *
+ * `decision` is `allow`, `deny` or `unknown`. `reason` is `"<code>: <text>"`
+ * as hallpass sent it, or `"client_error: ..."` when the request never
+ * produced a usable answer. `status` is the HTTP status, 0 when no response
+ * arrived.
+ */
+export declare class Decision {
+    readonly decision: DecisionValue;
+    readonly reason: string;
+    readonly status: number;
+    constructor(decision: DecisionValue, reason: string, status?: number);
+    /** True only for a positive `allow`. `unknown` is not allowed. */
+    get allowed(): boolean;
+    /** The machine-readable code in front of the colon, e.g. `user_not_found`. */
+    get code(): string;
+}
+/** Thrown by `Hallpass.require` when the answer was not `allow`. */
+export declare class PermissionDenied extends Error {
+    readonly decision: Decision;
+    readonly user: string;
+    readonly connection: string;
+    readonly action: string;
+    readonly resource: string;
+    constructor(decision: Decision, user: string, connection: string, action: string, resource: string);
+}
+export interface HallpassOptions {
+    /** Defaults to `$HALLPASS_URL` or `http://localhost:8080`. */
+    url?: string;
+    /** Defaults to `$HALLPASS_API_KEY`. */
+    apiKey?: string;
+    /** Total budget for one check, connection and body included. Default 10 s. */
+    timeoutMs?: number;
+}
+/**
+ * Client for one hallpass service.
+ *
+ * The URL must be `https://`; plain `http://` is accepted only for
+ * `localhost` or a loopback address, the same rule hallpass applies to its
+ * own upstream URLs, because the API key travels in a header. hallpass
+ * itself waits up to the connection's `timeout` (8 s by default) for the
+ * upstream system, so keep `timeoutMs` a little above that.
+ *
+ * Redirects are not followed. A redirect would re-send the API key to
+ * whatever host the `Location` header names, and its answer would not be
+ * hallpass's, so a 3xx becomes an `unknown` decision like any other
+ * unusable response.
+ */
+export declare class Hallpass {
+    #private;
+    readonly url: string;
+    readonly timeoutMs: number;
+    constructor(options?: HallpassOptions);
+    /**
+     * Ask hallpass. Never rejects on transport: every failure becomes an
+     * `unknown` decision. The fifth argument is the user's groups, or an
+     * options object: `{ groups, fresh }`. Groups left out or null are
+     * omitted from the request.
+     *
+     * `fresh: true` asks for an answer straight from the upstream system,
+     * skipping hallpass's caches. Use it for destructive actions. It narrows
+     * the window between the check and the action to the time between the
+     * two; it does not close it.
+     */
+    check(user: string, connection: string, action: string, resource: string, options?: readonly string[] | null | CheckOptions): Promise<Decision>;
+    /** True only when hallpass said `allow`. */
+    allowed(user: string, connection: string, action: string, resource: string, options?: readonly string[] | null | CheckOptions): Promise<boolean>;
+    /** Resolve to the decision when it is `allow`; reject with `PermissionDenied` otherwise. */
+    require(user: string, connection: string, action: string, resource: string, options?: readonly string[] | null | CheckOptions): Promise<Decision>;
+}
+/** Options of `check`, `allowed` and `require`. */
+export interface CheckOptions {
+    /** The user's groups; left out or null, none are sent. */
+    groups?: readonly string[] | null;
+    /** Skip hallpass's caches and ask the upstream system now. */
+    fresh?: boolean;
+}
+/**
+ * Where the acting user (or their groups) comes from: a fixed value, a
+ * zero-argument function, or an `AsyncLocalStorage` the application enters
+ * for the current session or request. Resolved on every call.
+ */
+export type Source<T> = T | (() => T | undefined) | AsyncLocalStorage<T>;
+export type UserSource = Source<string>;
+export type GroupsSource = Source<readonly string[]>;
+/**
+ * Resolve a user or groups source now.
+ *
+ * An `AsyncLocalStorage` with nothing set for this session throws an error
+ * saying so, rather than handing an `undefined` to a framework.
+ */
+export declare function current<T>(source: Source<T>, what?: string): T;
+export interface GuardedOptions<D = never> {
+    /** Where the acting user comes from. Never the tool's arguments. */
+    user: UserSource;
+    /** The user's groups, from the same kinds of source. Must yield an array. */
+    groups?: GroupsSource;
+    /**
+     * Called with the `PermissionDenied` instead of throwing it; its return
+     * value is returned to the caller. For frameworks that hide a thrown
+     * error's text from the model.
+     */
+    deny?: (e: PermissionDenied) => D | Promise<D>;
+    /**
+     * Make every check skip hallpass's caches and ask the upstream system
+     * now. Use it for delete, merge and scale-type actions.
+     */
+    fresh?: boolean;
+}
+/** The shape every agent framework hands a tool: one object of arguments, then whatever else it passes. */
+export type Args = Record<string, unknown>;
+/**
+ * Wrap a function so it runs only after hallpass allowed it.
+ *
+ * The user the check is for comes from `options.user`: a string, a
+ * zero-argument function, or an `AsyncLocalStorage` the application enters
+ * for the current session. It is never read from the call's arguments, so a
+ * framework's tool definition can take the wrapped function directly and
+ * the model cannot pick who it acts as; a `user` key in the arguments is
+ * ignored, never honoured. `groups` works the same way and must yield an
+ * array.
+ *
+ * `resource` is a template over the call's arguments, e.g. `"issue:{key}"`.
+ * A call whose arguments cannot fill it makes no request and runs nothing.
+ * The wrapped function is called with the same arguments it was given, so
+ * an agent framework's extra parameters (tool call id, abort signal, ...)
+ * pass through.
+ *
+ * Any answer other than `allow` rejects with `PermissionDenied` before the
+ * body runs. With `options.deny` given, its return value is returned instead.
+ */
+export declare function guarded<D = never>(hp: Hallpass, connection: string, action: string, resource: string, options: GuardedOptions<D>): <A extends Args, Rest extends unknown[], R>(fn: (args: A, ...rest: Rest) => R | Promise<R>) => (args: A, ...rest: Rest) => Promise<R | D>;

package/dist/index.js

@@ -0,0 +1,352 @@
+/**
+ * The hallpass client for agents. Node's built-in fetch, no dependencies.
+ *
+ * The one rule an agent has to follow: perform an action on behalf of a user
+ * only when hallpass answered `allow`. `deny` and `unknown` both mean "do not
+ * act", and so does any failure to reach hallpass at all.
+ *
+ *     const hp = new Hallpass(); // HALLPASS_URL and HALLPASS_API_KEY from the environment
+ *     await hp.require("dana@example.com", "jira-main", "DELETE_ISSUES", "issue:PAY-123");
+ *     await jira.deleteIssue("PAY-123"); // only reached when the answer was allow
+ *
+ * Or, for a tool an agent framework exposes to a model, `guarded`:
+ *
+ *     const currentUser = new AsyncLocalStorage<string>();
+ *
+ *     const deleteIssue = guarded(hp, "jira-main", "DELETE_ISSUES", "issue:{key}", { user: currentUser })(
+ *       async ({ key }: { key: string }) => {
+ *         await jira.deleteIssue(key);
+ *         return `deleted ${key}`;
+ *       },
+ *     );
+ *
+ * The user comes from the application, never from the tool's arguments.
+ *
+ * Install it from a hallpass release (see sdk/node/README.md). This is the TypeScript
+ * counterpart of the Python package (sdk/python) and follows the same
+ * contract; the tests in examples/agent-ts/hallpass_client.test.ts spell it
+ * out.
+ */
+import { AsyncLocalStorage } from "node:async_hooks";
+import { isIPv4, isIPv6 } from "node:net";
+export const ALLOW = "allow";
+export const DENY = "deny";
+export const UNKNOWN = "unknown";
+/**
+ * One answer from `POST /check`.
+ *
+ * `decision` is `allow`, `deny` or `unknown`. `reason` is `"<code>: <text>"`
+ * as hallpass sent it, or `"client_error: ..."` when the request never
+ * produced a usable answer. `status` is the HTTP status, 0 when no response
+ * arrived.
+ */
+export class Decision {
+    decision;
+    reason;
+    status;
+    constructor(decision, reason, status = 200) {
+        this.decision = decision;
+        this.reason = reason;
+        this.status = status;
+        Object.freeze(this);
+    }
+    /** True only for a positive `allow`. `unknown` is not allowed. */
+    get allowed() {
+        return this.decision === ALLOW;
+    }
+    /** The machine-readable code in front of the colon, e.g. `user_not_found`. */
+    get code() {
+        return (this.reason.split(":", 1)[0] ?? "").trim();
+    }
+}
+/** Thrown by `Hallpass.require` when the answer was not `allow`. */
+export class PermissionDenied extends Error {
+    decision;
+    user;
+    connection;
+    action;
+    resource;
+    constructor(decision, user, connection, action, resource) {
+        super(`${user} may not ${action} on ${resource} in ${connection}: ${decision.decision} (${decision.reason})`);
+        this.name = "PermissionDenied";
+        this.decision = decision;
+        this.user = user;
+        this.connection = connection;
+        this.action = action;
+        this.resource = resource;
+    }
+}
+/**
+ * Client for one hallpass service.
+ *
+ * The URL must be `https://`; plain `http://` is accepted only for
+ * `localhost` or a loopback address, the same rule hallpass applies to its
+ * own upstream URLs, because the API key travels in a header. hallpass
+ * itself waits up to the connection's `timeout` (8 s by default) for the
+ * upstream system, so keep `timeoutMs` a little above that.
+ *
+ * Redirects are not followed. A redirect would re-send the API key to
+ * whatever host the `Location` header names, and its answer would not be
+ * hallpass's, so a 3xx becomes an `unknown` decision like any other
+ * unusable response.
+ */
+export class Hallpass {
+    url;
+    timeoutMs;
+    #apiKey;
+    constructor(options = {}) {
+        this.url = validateUrl(options.url || process.env.HALLPASS_URL || "http://localhost:8080");
+        this.#apiKey = options.apiKey ?? process.env.HALLPASS_API_KEY ?? "";
+        if (!this.#apiKey) {
+            throw new Error("hallpass API key missing: pass apiKey or set HALLPASS_API_KEY");
+        }
+        this.timeoutMs = options.timeoutMs ?? 10_000;
+    }
+    /**
+     * Ask hallpass. Never rejects on transport: every failure becomes an
+     * `unknown` decision. The fifth argument is the user's groups, or an
+     * options object: `{ groups, fresh }`. Groups left out or null are
+     * omitted from the request.
+     *
+     * `fresh: true` asks for an answer straight from the upstream system,
+     * skipping hallpass's caches. Use it for destructive actions. It narrows
+     * the window between the check and the action to the time between the
+     * two; it does not close it.
+     */
+    async check(user, connection, action, resource, options) {
+        const { groups, fresh } = checkOptions(options);
+        const body = { user, connection, action, resource };
+        if (groups != null) {
+            body.groups = groupList(groups);
+        }
+        if (fresh) {
+            body.fresh = true;
+        }
+        let response;
+        let raw;
+        try {
+            response = await fetch(this.url + "/check", {
+                method: "POST",
+                headers: {
+                    Authorization: "Bearer " + this.#apiKey,
+                    "Content-Type": "application/json",
+                    Accept: "application/json",
+                },
+                body: JSON.stringify(body),
+                redirect: "manual",
+                signal: AbortSignal.timeout(this.timeoutMs),
+            });
+            // 400 and 401 still carry a decision body; anything else is unusable
+            // and parse() says so. A body cut short or a malformed response
+            // rejects here and lands in the catch below.
+            raw = await response.text();
+        }
+        catch (e) {
+            return new Decision(UNKNOWN, `client_error: hallpass unreachable: ${describe(e)}`, 0);
+        }
+        return parse(response.status, raw);
+    }
+    /** True only when hallpass said `allow`. */
+    async allowed(user, connection, action, resource, options) {
+        return (await this.check(user, connection, action, resource, options)).allowed;
+    }
+    /** Resolve to the decision when it is `allow`; reject with `PermissionDenied` otherwise. */
+    async require(user, connection, action, resource, options) {
+        const d = await this.check(user, connection, action, resource, options);
+        if (!d.allowed) {
+            throw new PermissionDenied(d, user, connection, action, resource);
+        }
+        return d;
+    }
+}
+/** The rule hallpass applies to its own upstream URLs (ValidateHTTPSURL). */
+function validateUrl(url) {
+    if (/[\s?#]/.test(url)) {
+        throw new Error(`hallpass url ${JSON.stringify(url)} must not contain whitespace, '?' or '#'`);
+    }
+    let u;
+    try {
+        u = new URL(url);
+    }
+    catch {
+        throw new Error(`hallpass url ${JSON.stringify(url)} must start with https:// (http:// only for localhost)`);
+    }
+    if (u.username || u.password) {
+        throw new Error(`hallpass url ${JSON.stringify(url)} must not contain userinfo`);
+    }
+    if (u.protocol === "https:" && u.hostname) {
+        return url.replace(/\/+$/, "");
+    }
+    if (u.protocol === "http:" && isLoopback(u.hostname)) {
+        return url.replace(/\/+$/, "");
+    }
+    throw new Error(`hallpass url ${JSON.stringify(url)} must start with https:// (http:// only for localhost)`);
+}
+/** localhost, 127.0.0.0/8, ::1, and 127.0.0.0/8 mapped into IPv6, as Go's net.IP.IsLoopback. */
+function isLoopback(hostname) {
+    if (hostname === "localhost") {
+        return true;
+    }
+    const host = hostname.replace(/^\[|\]$/g, ""); // URL keeps the brackets around an IPv6 literal
+    if (isIPv4(host)) {
+        return host.startsWith("127.");
+    }
+    if (!isIPv6(host)) {
+        return false;
+    }
+    if (host === "::1") {
+        return true;
+    }
+    // URL normalizes ::ffff:127.0.0.1 to ::ffff:7f00:1; the first hex group holds the top two octets.
+    const mapped = /^::ffff:([0-9a-f]{1,4}):[0-9a-f]{1,4}$/i.exec(host);
+    return mapped !== null && parseInt(mapped[1], 16) >> 8 === 127;
+}
+function checkOptions(o) {
+    if (o == null) {
+        return { groups: null, fresh: false };
+    }
+    if (Array.isArray(o)) {
+        return { groups: o, fresh: false };
+    }
+    if (typeof o === "boolean") {
+        throw new TypeError("the fifth argument is the groups array or { groups, fresh }; pass { fresh: true } for a fresh check");
+    }
+    if (typeof o !== "object" || Symbol.iterator in o) {
+        // A Set or another iterable of groups is not an array of them.
+        throw new TypeError("groups must be an array of strings");
+    }
+    for (const key of Object.keys(o)) {
+        if (key !== "groups" && key !== "fresh") {
+            throw new TypeError(`unknown check option ${JSON.stringify(key)}; the options are groups and fresh`);
+        }
+    }
+    const opts = o;
+    if (opts.fresh !== undefined && typeof opts.fresh !== "boolean") {
+        throw new TypeError("fresh must be a boolean");
+    }
+    return { groups: opts.groups ?? null, fresh: opts.fresh === true };
+}
+function groupList(groups) {
+    if (typeof groups === "string" || !Array.isArray(groups) || !groups.every((g) => typeof g === "string")) {
+        throw new TypeError("groups must be an array of strings");
+    }
+    return [...groups];
+}
+function describe(e) {
+    if (!(e instanceof Error)) {
+        return String(e);
+    }
+    // fetch reports "fetch failed" and keeps the socket error in cause.
+    const cause = e.cause instanceof Error ? `: ${e.cause.message}` : "";
+    return e.message + cause;
+}
+function parse(status, raw) {
+    let data;
+    try {
+        data = JSON.parse(raw);
+    }
+    catch {
+        return new Decision(UNKNOWN, `client_error: unexpected response (HTTP ${status})`, status);
+    }
+    if (typeof data !== "object" || data === null || !("decision" in data)) {
+        return new Decision(UNKNOWN, `client_error: unexpected response (HTTP ${status})`, status);
+    }
+    const { decision, reason } = data;
+    if (decision !== ALLOW && decision !== DENY && decision !== UNKNOWN) {
+        return new Decision(UNKNOWN, `client_error: unexpected decision ${JSON.stringify(decision)}`, status);
+    }
+    if (decision === ALLOW && status !== 200) {
+        // hallpass never allows with a non-200 status; do not trust a proxy that does.
+        return new Decision(UNKNOWN, `client_error: allow with HTTP ${status}`, status);
+    }
+    return new Decision(decision, reason === undefined ? "" : String(reason), status);
+}
+/**
+ * Resolve a user or groups source now.
+ *
+ * An `AsyncLocalStorage` with nothing set for this session throws an error
+ * saying so, rather than handing an `undefined` to a framework.
+ */
+export function current(source, what = "user") {
+    let value;
+    if (source instanceof AsyncLocalStorage) {
+        value = source.getStore();
+        if (value === undefined) {
+            throw new Error(`no ${what} set for this session: the AsyncLocalStorage has no store here`);
+        }
+        return value;
+    }
+    if (typeof source === "function") {
+        value = source();
+        if (value === undefined) {
+            throw new Error(`no ${what} set for this session: the ${what} function returned undefined`);
+        }
+        return value;
+    }
+    return source;
+}
+/**
+ * Wrap a function so it runs only after hallpass allowed it.
+ *
+ * The user the check is for comes from `options.user`: a string, a
+ * zero-argument function, or an `AsyncLocalStorage` the application enters
+ * for the current session. It is never read from the call's arguments, so a
+ * framework's tool definition can take the wrapped function directly and
+ * the model cannot pick who it acts as; a `user` key in the arguments is
+ * ignored, never honoured. `groups` works the same way and must yield an
+ * array.
+ *
+ * `resource` is a template over the call's arguments, e.g. `"issue:{key}"`.
+ * A call whose arguments cannot fill it makes no request and runs nothing.
+ * The wrapped function is called with the same arguments it was given, so
+ * an agent framework's extra parameters (tool call id, abort signal, ...)
+ * pass through.
+ *
+ * Any answer other than `allow` rejects with `PermissionDenied` before the
+ * body runs. With `options.deny` given, its return value is returned instead.
+ */
+export function guarded(hp, connection, action, resource, options) {
+    const { user, groups, deny, fresh = false } = options;
+    return (fn) => {
+        const name = fn.name || "the guarded function";
+        const inner = async (args, ...rest) => {
+            if (typeof args !== "object" || args === null || Array.isArray(args)) {
+                throw new TypeError(`${name} takes one object of arguments`);
+            }
+            // Everything below happens before any request, so a bad call is an
+            // error to the caller, never a check on one resource and an action on
+            // another.
+            const target = fill(resource, args);
+            const who = current(user, "user");
+            if (typeof who !== "string" || who === "") {
+                throw new Error("guarded: user must be a non-empty string");
+            }
+            const grp = groups === undefined ? undefined : current(groups, "groups");
+            try {
+                await hp.require(who, connection, action, target, { groups: grp, fresh });
+            }
+            catch (e) {
+                if (e instanceof PermissionDenied && deny !== undefined) {
+                    return deny(e);
+                }
+                throw e;
+            }
+            return fn(args, ...rest);
+        };
+        Object.defineProperty(inner, "name", { value: fn.name });
+        return inner;
+    };
+}
+/** `"thing:{thing_id}"` over `{thing_id: "1"}` gives `"thing:1"`. */
+function fill(template, args) {
+    return template.replace(/\{([^{}]*)\}/g, (_, key) => {
+        const v = args[key];
+        if (typeof v === "string") {
+            return v;
+        }
+        if (typeof v === "number" || typeof v === "boolean") {
+            return String(v);
+        }
+        throw new Error(`guarded: resource ${JSON.stringify(template)} needs a string argument ${JSON.stringify(key)}`);
+    });
+}

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "hallpass-client",
+  "version": "0.4.0",
+  "description": "Check with hallpass whether a user may do something before your AI agent does it for them.",
+  "keywords": [
+    "ai-agents",
+    "authorization",
+    "permissions",
+    "llm",
+    "tools",
+    "mcp"
+  ],
+  "homepage": "https://github.com/roee-hersh/hallpass/tree/main/sdk/node",
+  "bugs": "https://github.com/roee-hersh/hallpass/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/roee-hersh/hallpass.git",
+    "directory": "sdk/node"
+  },
+  "license": "Apache-2.0",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "sideEffects": false,
+  "engines": {
+    "node": ">=18.17"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "test": "npm run build && node --test test/package.test.mjs",
+    "prepack": "npm run build"
+  },
+  "devDependencies": {
+    "@types/node": "^22.20.4",
+    "typescript": "^5.9.3"
+  }
+}