@opengeni/tool-gateway 0.1.0-canary.0

package/LICENSE

@@ -0,0 +1,190 @@
+                                 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
+
+   Copyright 2026 Cloudgeni-ai
+
+   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,69 @@
+# `@opengeni/tool-gateway`
+
+Protocol-neutral catalog validation, authorization, and execution for OpenGeni
+tools. Runtime composition supplies already-admitted first-party and integration
+definitions; this package gives model MCP, Codemode, HTTP/SDK, external MCP, and
+Site adapters one canonical identity and execution path.
+
+The package owns:
+
+- deterministic catalog digests that exclude non-authoritative timestamps;
+- exact `{ serverId, toolName }` identities, normalized exact-name
+  disambiguation, and catalog-time rejection of namespace/tool prefix
+  collisions;
+- bounded catalog, JSON Schema input/output validation, and generated SDK
+  declarations;
+- caller-aware authorization and approval classification; and
+- result-shape preservation around the supplied executor closures.
+
+It does not discover providers, resolve credentials, persist attempt lifecycle,
+or mint authority. Those responsibilities remain in runtime and transport
+adapters. A catalog digest or friendly name never grants access by itself.
+
+```ts
+import { createWorkspaceToolGateway } from "@opengeni/tool-gateway";
+
+const { catalog, gateway } = createWorkspaceToolGateway({
+  accountId,
+  workspaceId,
+  generation,
+  definitions,
+  authorize,
+  requireApproval,
+});
+
+const result = await gateway.call({
+  operationId: crypto.randomUUID(),
+  catalogDigest: catalog.digest,
+  identity: { serverId: "docs", toolName: "search" },
+  arguments: { query: "roadmap" },
+  caller: { kind: "http", subjectId },
+});
+```
+
+Approval evidence is transport-owned. Current-human HTTP calls classified for
+human approval use a server-issued, hash-only, single-use capability. The
+capability binds the public catalog identity and arguments plus a private
+provider-authority digest, so changing an Integration instance, revision, or
+connection invalidates an older approval without changing the public catalog.
+Connection-backed approval issuance first resolves credentials in a preflight
+mode that neither refreshes tokens nor records provider usage; a provider adapter
+without that side-effect-free preflight is omitted from the current-human
+catalog. Agent attempts keep their existing durable approval and operation
+lifecycle. A model call to an `approval: human` entry is rejected by the gateway
+unless the attempt host confirms the exact model name and subject from its
+approved SDK invocation context; model-supplied arguments or transport metadata
+cannot grant that authority. A Site version's requested identities are only a
+host-filtered maximum allowlist. Publishing grants no tool authority; the API
+revalidates the active version and the viewer's live authority before using the
+ordinary gateway approval and execution path. The
+external/current-human MCP adapter has no
+server-verifiable one-shot approval exchange, so it projects only entries whose
+classification is not `human`; a direct call to a hidden projected name is
+rejected instead of advertising a tool that can never execute.
+
+`prepareCall` performs catalog, identity, approval, input-schema, and
+authorization checks without invoking the supplied executor. Attempt transports
+use that seam before crossing their durable side-effect marker, then invoke the
+returned execution closure. Ordinary `call` remains the compatible
+combined preflight-plus-execution API.

package/dist/catalog.d.ts

@@ -0,0 +1,7 @@
+import { type ToolGatewayCatalog as ToolGatewayCatalogValue } from "@opengeni/contracts";
+export declare function digestToolGatewayCatalog(catalog: Omit<ToolGatewayCatalogValue, "digest">): string;
+export declare function parseVerifiedToolGatewayCatalog(input: unknown): ToolGatewayCatalogValue;
+export declare function digestCanonicalJson(value: unknown): string;
+/** Compare canonical JSON keys by JavaScript UTF-16 code units, independent of host locale. */
+export declare function compareCanonicalStrings(left: string, right: string): number;
+export declare function assertToolGatewayCatalogSize(catalog: ToolGatewayCatalogValue): void;

package/dist/declarations.d.ts

@@ -0,0 +1,21 @@
+import type { ToolGatewayCatalogEntry } from "@opengeni/contracts";
+import { parseVerifiedToolGatewayCatalog } from "./catalog.js";
+export type GenerateToolGatewayDeclarationsOptions = {
+    moduleSpecifier?: string;
+    interfaceName?: string;
+};
+/** Generate declaration merging for one exact digest-pinned workspace catalog. */
+export declare function generateToolGatewayDeclarations(catalog: Parameters<typeof parseVerifiedToolGatewayCatalog>[0], options?: GenerateToolGatewayDeclarationsOptions): string;
+export declare function generateToolDeclarations(catalog: {
+    digest: string;
+    entries: readonly ToolGatewayCatalogEntry[];
+}, options: {
+    moduleSpecifier: string;
+    interfaceName: string;
+    callOptionsType: string;
+    fallbackResultType: string;
+    generatedBy: string;
+    catalogDigestLabel?: string;
+}): string;
+/** Honest bounded JSON-Schema-to-TypeScript projection for generated declarations. */
+export declare function jsonSchemaToTypeScript(schema: unknown): string;

package/dist/errors.d.ts

@@ -0,0 +1,32 @@
+export declare class ToolGatewayCatalogStaleError extends Error {
+    readonly code = "catalog_stale";
+    constructor();
+}
+export declare class ToolGatewayToolNotFoundError extends Error {
+    readonly code = "tool_not_found";
+    constructor();
+}
+export declare class ToolGatewayApprovalRequiredError extends Error {
+    readonly code = "approval_required";
+    constructor();
+}
+export declare class ToolGatewayCatalogIntegrityError extends Error {
+    readonly code = "catalog_integrity_failed";
+    constructor();
+}
+export declare class ToolGatewayCatalogTooLargeError extends Error {
+    readonly code = "catalog_too_large";
+    constructor();
+}
+export declare class ToolGatewayPathCollisionError extends Error {
+    readonly code = "tool_path_collision";
+    constructor(path: readonly string[], kind: "collision" | "extends_leaf");
+}
+export declare class ToolGatewayInputValidationError extends Error {
+    readonly code = "invalid_tool_arguments";
+    constructor();
+}
+export declare class ToolGatewayOutputValidationError extends Error {
+    readonly code = "invalid_tool_result";
+    constructor();
+}

package/dist/index.d.ts

@@ -0,0 +1,136 @@
+import { type ValidateFunction } from "ajv";
+import { type ToolGatewayCaller, type ToolGatewayCatalog as ToolGatewayCatalogValue, type ToolGatewayCatalogEntry as ToolGatewayCatalogEntryValue, type ToolGatewayIdentity, type ToolGatewayResult as ToolGatewayResultValue } from "@opengeni/contracts";
+export type ToolGatewayExecutionContext = {
+    operationId: string;
+    caller: ToolGatewayCaller;
+    /** In-process transport metadata; never part of catalog identity or digest. */
+    transportMeta?: Record<string, unknown> | null;
+    signal?: AbortSignal;
+};
+export type ToolGatewayCallContext = Pick<ToolGatewayExecutionContext, "transportMeta" | "signal">;
+export type ToolGatewayDefinition = Omit<ToolGatewayCatalogEntryValue, "codemodePath"> & {
+    /** Optional human-readable path. Unsafe/colliding segments are normalized. */
+    codemodePath?: readonly string[];
+    /** Internal authority revision bound into human approval capabilities. */
+    approvalAuthorityDigest?: string;
+    /** Connection-backed calls must have a side-effect-free provider preflight before approval. */
+    requiresProviderPreflight?: boolean;
+    /** In-process provider preflight; never enters the public catalog or its digest. */
+    preflightCall?: (input: {
+        call: ToolGatewayCall;
+        entry: ToolGatewayCatalogEntryValue;
+        context: ToolGatewayCallContext;
+    }) => Promise<void> | void;
+    /** In-process execution lifecycle; never enters the public catalog or its digest. */
+    lifecycle?: ToolGatewayCallLifecycle;
+    execute: (args: Record<string, unknown>, context: ToolGatewayExecutionContext) => Promise<ToolGatewayResultValue> | ToolGatewayResultValue;
+};
+export type ToolGatewayAuthorization = (input: {
+    call: ToolGatewayCall;
+    entry: ToolGatewayCatalogEntryValue;
+}) => Promise<void> | void;
+export type ToolGatewayCall = {
+    operationId: string;
+    catalogDigest: string;
+    identity: ToolGatewayIdentity;
+    arguments: Record<string, unknown>;
+    caller: ToolGatewayCaller;
+};
+export type ToolGatewayCallSettlement = {
+    outcome: "completed";
+    result: ToolGatewayResultValue;
+} | {
+    outcome: "failed";
+    error: unknown;
+};
+export type PreparedToolGatewayCallLifecycle = {
+    /** Cross the side-effect boundary immediately before the executor closure. */
+    begin?: () => Promise<void> | void;
+    /** Settle the side-effect lifecycle after a returned result or thrown failure. */
+    complete?: (settlement: ToolGatewayCallSettlement) => Promise<void> | void;
+};
+export type ToolGatewayCallLifecycle = {
+    /** Argument-sensitive preflight. Throwing here guarantees the executor never runs. */
+    prepare: (input: {
+        call: ToolGatewayCall;
+        entry: ToolGatewayCatalogEntryValue;
+        context: ToolGatewayCallContext;
+    }) => Promise<PreparedToolGatewayCallLifecycle | void> | PreparedToolGatewayCallLifecycle | void;
+};
+export type ModelToolGatewayCall = {
+    operationId?: string;
+    modelName: string;
+    arguments: Record<string, unknown>;
+    subjectId: string;
+    transportMeta?: Record<string, unknown> | null;
+    signal?: AbortSignal;
+};
+type CompiledDefinition = {
+    entry: ToolGatewayCatalogEntryValue;
+    execute: ToolGatewayDefinition["execute"];
+    approvalAuthorityDigest: string | undefined;
+    preflightCall: ToolGatewayDefinition["preflightCall"];
+    lifecycle: ToolGatewayCallLifecycle | undefined;
+    validateInput: ValidateFunction<unknown>;
+    validateOutput: ValidateFunction<unknown> | null;
+};
+export type PreparedToolGatewayCall = {
+    readonly call: ToolGatewayCall;
+    readonly entry: ToolGatewayCatalogEntryValue;
+    readonly approvalAuthorityDigest: string;
+    execute: () => Promise<ToolGatewayResultValue>;
+};
+export declare class PreparedToolGatewayDefinitions {
+    private readonly definitions;
+    readonly entries: readonly ToolGatewayCatalogEntryValue[];
+    constructor(definitions: readonly CompiledDefinition[]);
+    create(input: {
+        catalogDigest: string;
+        authorize?: ToolGatewayAuthorization;
+        requireApproval?: (entry: ToolGatewayCatalogEntryValue, caller: ToolGatewayCaller, context: {
+            transportMeta?: Record<string, unknown> | null;
+        }) => boolean;
+        confirmModelApproval?: (input: {
+            entry: ToolGatewayCatalogEntryValue;
+            modelName: string;
+            subjectId: string;
+        }) => boolean;
+    }): ToolGateway;
+}
+export declare class ToolGateway {
+    readonly catalogDigest: string;
+    private readonly authorize;
+    private readonly requireApproval;
+    private readonly confirmModelApproval;
+    private readonly byIdentity;
+    private readonly byModelName;
+    constructor(catalogDigest: string, definitions: readonly CompiledDefinition[], authorize: ToolGatewayAuthorization | undefined, requireApproval: ((entry: ToolGatewayCatalogEntryValue, caller: ToolGatewayCaller, context: {
+        transportMeta?: Record<string, unknown> | null;
+    }) => boolean) | undefined, confirmModelApproval: ((input: {
+        entry: ToolGatewayCatalogEntryValue;
+        modelName: string;
+        subjectId: string;
+    }) => boolean) | undefined);
+    call(input: ToolGatewayCall, context?: ToolGatewayCallContext): Promise<ToolGatewayResultValue>;
+    prepareCall(input: ToolGatewayCall, context?: ToolGatewayCallContext): Promise<PreparedToolGatewayCall>;
+    private prepareCallWithModelApproval;
+    callModel(input: ModelToolGatewayCall): Promise<ToolGatewayResultValue>;
+}
+export declare function prepareToolGatewayDefinitions(definitions: readonly ToolGatewayDefinition[]): PreparedToolGatewayDefinitions;
+export declare function createWorkspaceToolGateway(input: {
+    accountId: string;
+    workspaceId: string;
+    generation: number;
+    definitions: readonly ToolGatewayDefinition[];
+    createdAt?: Date;
+    authorize?: ToolGatewayAuthorization;
+    requireApproval?: (entry: ToolGatewayCatalogEntryValue, caller: ToolGatewayCaller, context: {
+        transportMeta?: Record<string, unknown> | null;
+    }) => boolean;
+}): {
+    catalog: ToolGatewayCatalogValue;
+    gateway: ToolGateway;
+};
+export * from "./catalog.js";
+export * from "./declarations.js";
+export * from "./errors.js";