@tidegate/sdk 0.1.0

package/LICENSE

@@ -0,0 +1,204 @@
+Copyright 2026 Emanuele Puccetti
+
+
+                                 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,142 @@
+# Tidegate SDK
+
+Minimal TypeScript SDK for connecting a trusted server to Tidegate.
+
+Server/API-key helpers live under `@tidegate/sdk/server` so they are not
+pulled into browser bundles from the root package entrypoint.
+
+## Action bridge
+
+Use the action bridge to expose your backend capabilities to Tidegate. Tidegate can call
+only registered actions that are also allowlisted by the invoking interaction,
+with input validation, declared-output validation, and server-derived auth.
+
+```txt
+TIDEGATE_ACTION_BRIDGE_SECRET=shared_secret_from_eve
+```
+
+```ts
+import { z } from "zod";
+import {
+  createTidegateActionCatalogManifest,
+  createTidegateActionHandler,
+  defineTidegateActions,
+  tidegateAction,
+} from "@tidegate/sdk/server";
+
+const BookingCancelInput = z.object({
+  appointmentId: z.string().min(1),
+  reason: z.string().optional(),
+});
+
+const BookingCancelOutput = z.object({
+  ok: z.boolean(),
+  appointmentId: z.string(),
+});
+
+const actions = defineTidegateActions({
+  booking: {
+    cancel: tidegateAction({
+      input: BookingCancelInput,
+      returns: BookingCancelOutput,
+      effects: "write",
+      requiredPermissions: ["booking:write"],
+      tenantScope: { fromAuth: "tenantId" },
+
+      async execute(input, ctx) {
+        return cancelAppointment({
+          appointmentId: input.appointmentId,
+          reason: input.reason,
+          tenantId: ctx.auth.tenantId!,
+        });
+      },
+    }),
+  },
+});
+
+export const POST = createTidegateActionHandler(actions);
+
+export const manifest = createTidegateActionCatalogManifest(actions, {
+  catalogId: "salone-ai",
+  version: "2026-06-24T00:00:00.000Z",
+});
+```
+
+`returns` is optional, like Convex return validators. If you omit it, TypeScript
+still infers the return type of `execute` without a `Promise<...>` annotation,
+and Tidegate emits a permissive output contract until static return-type codegen is
+enabled:
+
+```ts
+const actions = defineTidegateActions({
+  booking: {
+    cancel: tidegateAction({
+      input: BookingCancelInput,
+      effects: "write",
+
+      async execute(input, ctx) {
+        return {
+          ok: true,
+          appointmentId: input.appointmentId,
+          tenantId: ctx.auth.tenantId,
+        };
+      },
+    }),
+  },
+});
+```
+
+The request body is limited to `actionId`, `input`, and optional `invocationId`.
+Do not accept `tenantId`, roles, permissions, or user ids from the body. The
+handler derives auth and the interaction action allowlist from the verified Tidegate
+request.
+
+The manifest is not executable code. Tidegate uses it to generate a sandbox
+TypeScript client such as `ctx.capabilities.booking.cancel(...)`; the real
+backend action still executes only through `createTidegateActionHandler(...)`.
+The SDK normalizes the namespaced action tree above to the stable wire action id
+`booking.cancel` for manifests, audit logs, allowlists, and bridge calls.
+
+## Server invoke
+
+Use `interactions.invoke` when your backend, job, or UI server action wants to
+execute a public Tidegate interaction. This is separate from exposing backend actions
+to Tidegate.
+
+Set the API key in the server environment:
+
+```txt
+TIDEGATE_API_KEY=evk_live_...
+```
+
+Then call a public interaction id:
+
+```ts
+import { createTidegateServerClient } from "@tidegate/sdk/server";
+
+const tidegate = createTidegateServerClient();
+
+const result = await tidegate.interactions.invoke("ix.booking.cancelAppointment", {
+  interactionVersion: "1",
+  input: {
+    appointmentId: "apt_123",
+    reason: "Client requested cancellation",
+  },
+  surfaceId: "booking-page",
+  sessionId: "sess_123",
+  messageId: "msg_123",
+  idempotencyKey: "ix.booking.cancelAppointment:sess_123:apt_123",
+});
+```
+
+The SDK validates both the request envelope and Tidegate's response with
+`@tidegate/contracts`.
+
+For local development, staging, or self-hosting, pass explicit overrides:
+
+```ts
+const tidegate = createTidegateServerClient({
+  apiKey: process.env.CUSTOM_TIDEGATE_API_KEY,
+  baseUrl: "http://localhost:3000/api/tidegate/v1",
+});
+```

package/dist/action-bridge.d.ts

@@ -0,0 +1,106 @@
+import { z } from "zod";
+import { TIDEGATE_ACTION_ALLOWED_ACTIONS_HEADER, TIDEGATE_ACTION_AUTH_CONTEXT_HEADER, TIDEGATE_ACTION_INTERACTION_ID_HEADER, TIDEGATE_ACTION_BRIDGE_SECRET_HEADER, TidegateActionErrorCodeSchema, TidegateActionInvokeRequestSchema, TidegateActionInvokeResponseSchema, type TidegateAuthContext, type TidegateActionAuditPolicy, type TidegateActionCatalogManifestV1, type TidegateActionEffect, type TidegateActionErrorCode, type TidegateActionInvokeRequest, type TidegateActionInvokeResponse, type TidegateActionTenantScope } from "@tidegate/contracts";
+export { TIDEGATE_ACTION_ALLOWED_ACTIONS_HEADER, TIDEGATE_ACTION_AUTH_CONTEXT_HEADER, TIDEGATE_ACTION_INTERACTION_ID_HEADER, TIDEGATE_ACTION_BRIDGE_SECRET_HEADER, TidegateActionErrorCodeSchema, TidegateActionInvokeRequestSchema, TidegateActionInvokeResponseSchema, };
+export type { TidegateActionEffect, TidegateActionErrorCode, TidegateActionInvokeRequest, TidegateActionInvokeResponse, };
+export type TidegateActionExecuteArgs<TInput> = {
+    input: TInput;
+    auth: TidegateAuthContext;
+    request: Request;
+    signal: AbortSignal;
+    /**
+     * The runtime invocation id from the invoke request, when present. Use it
+     * to correlate downstream calls with the Tidegate execution trace.
+     */
+    invocationId?: string;
+};
+export type TidegateActionExecuteContext = Omit<TidegateActionExecuteArgs<unknown>, "input">;
+type MaybePromise<T> = Promise<T> | T;
+type TidegateActionMetadata = {
+    description?: string;
+    effects: TidegateActionEffect;
+    requiredPermissions?: string[];
+    tenantScope?: TidegateActionTenantScope;
+    audit?: Partial<TidegateActionAuditPolicy>;
+};
+export type TidegateActionDefinition<TInputSchema extends z.ZodType = z.ZodType, TReturnsSchema extends z.ZodType | undefined = z.ZodType | undefined, TOutput = TReturnsSchema extends z.ZodType ? z.infer<TReturnsSchema> : unknown> = TidegateActionMetadata & {
+    input: TInputSchema;
+    returns?: TReturnsSchema;
+    /**
+     * @deprecated Use `returns` for new actions. `output` remains supported for
+     * existing flat action definitions.
+     */
+    output?: TReturnsSchema;
+    execute: (args: TidegateActionExecuteArgs<z.infer<TInputSchema>>) => MaybePromise<TOutput>;
+};
+export type AnyTidegateActionDefinition = TidegateActionDefinition<any, any>;
+export type TidegateActionNormalizedDefinition<TInputSchema extends z.ZodType = z.ZodType, TOutputSchema extends z.ZodType = z.ZodType> = TidegateActionMetadata & {
+    input: TInputSchema;
+    output: TOutputSchema;
+    returns?: TOutputSchema;
+    execute: (args: TidegateActionExecuteArgs<z.infer<TInputSchema>>) => MaybePromise<z.infer<TOutputSchema>>;
+};
+export type TidegateActionBuilderDefinition<TInputSchema extends z.ZodType = z.ZodType, TOutput = unknown> = TidegateActionMetadata & {
+    input: TInputSchema;
+    returns?: undefined;
+    execute: (input: z.infer<TInputSchema>, ctx: TidegateActionExecuteContext) => MaybePromise<TOutput>;
+};
+export type TidegateActionBuilderWithReturnsDefinition<TInputSchema extends z.ZodType = z.ZodType, TReturnsSchema extends z.ZodType = z.ZodType> = TidegateActionMetadata & {
+    input: TInputSchema;
+    returns: TReturnsSchema;
+    execute: (input: z.infer<TInputSchema>, ctx: TidegateActionExecuteContext) => MaybePromise<z.infer<TReturnsSchema>>;
+};
+export type TidegateActionShorthandWithReturnsDefinition<TInputSchema extends z.ZodType = z.ZodType, TReturnsSchema extends z.ZodType = z.ZodType> = TidegateActionBuilderWithReturnsDefinition<TInputSchema, TReturnsSchema>;
+export type TidegateActionLegacyShorthandDefinition<TInputSchema extends z.ZodType = z.ZodType, TOutputSchema extends z.ZodType = z.ZodType> = TidegateActionMetadata & {
+    /**
+     * @deprecated Use `input`.
+     */
+    inputSchema: TInputSchema;
+    /**
+     * @deprecated Use `returns`.
+     */
+    outputSchema: TOutputSchema;
+    execute: (input: z.infer<TInputSchema>, ctx: TidegateActionExecuteContext) => MaybePromise<z.infer<TOutputSchema>>;
+};
+export type TidegateActionShorthandDefinition<TInputSchema extends z.ZodType = z.ZodType, TOutputSchema extends z.ZodType = z.ZodType> = TidegateActionLegacyShorthandDefinition<TInputSchema, TOutputSchema>;
+export type TidegateActionCatalogNode = AnyTidegateActionDefinition | {
+    readonly [segment: string]: TidegateActionCatalogNode;
+};
+export type TidegateActionCatalog = {
+    readonly [segment: string]: TidegateActionCatalogNode;
+};
+export type CreateTidegateActionCatalogManifestOptions = {
+    catalogId: string;
+    version?: string;
+};
+export type TidegateVerifiedActionRequest = {
+    auth: TidegateAuthContext;
+    allowedActionIds: string[];
+    interactionId?: string;
+};
+export type TidegateActionRequestVerifier = (request: Request) => Promise<TidegateVerifiedActionRequest> | TidegateVerifiedActionRequest;
+export type CreateTidegateActionHandlerOptions = {
+    actionBridgeSecret?: string;
+    verifyRequest?: TidegateActionRequestVerifier;
+};
+export declare class TidegateActionHandlerError extends Error {
+    name: string;
+    readonly code: TidegateActionErrorCode;
+    readonly httpStatus: number;
+    readonly responseStatus: "rejected" | "failed";
+    constructor(code: TidegateActionErrorCode, message: string, httpStatus: number, responseStatus?: "rejected" | "failed");
+}
+export declare class TidegateActionCatalogError extends Error {
+    name: string;
+}
+export declare function tidegateAction<TInputSchema extends z.ZodType, TOutputSchema extends z.ZodType>(definition: TidegateActionNormalizedDefinition<TInputSchema, TOutputSchema>): TidegateActionDefinition<TInputSchema, TOutputSchema, z.infer<TOutputSchema>>;
+export declare function tidegateAction<TInputSchema extends z.ZodType, TOutput>(definition: TidegateActionBuilderDefinition<TInputSchema, TOutput>): TidegateActionDefinition<TInputSchema, undefined, Awaited<TOutput>>;
+export declare function tidegateAction<TInputSchema extends z.ZodType, TReturnsSchema extends z.ZodType>(definition: TidegateActionBuilderWithReturnsDefinition<TInputSchema, TReturnsSchema>): TidegateActionDefinition<TInputSchema, TReturnsSchema, z.infer<TReturnsSchema>>;
+export declare function tidegateAction<TInputSchema extends z.ZodType, TOutputSchema extends z.ZodType>(definition: TidegateActionLegacyShorthandDefinition<TInputSchema, TOutputSchema>): TidegateActionDefinition<TInputSchema, TOutputSchema, z.infer<TOutputSchema>>;
+export declare function defineTidegateActions<TActions extends Record<string, AnyTidegateActionDefinition>>(actions: TActions): TActions;
+export declare function defineTidegateActions<TActions extends TidegateActionCatalog>(actions: TActions): TActions;
+export declare function createTidegateActionCatalogManifest<TActions extends TidegateActionCatalog>(actions: TActions, { catalogId, version, }: CreateTidegateActionCatalogManifestOptions): TidegateActionCatalogManifestV1;
+export declare function createTidegateActionHandler<TActions extends TidegateActionCatalog>(actions: TActions, { actionBridgeSecret, verifyRequest, }?: CreateTidegateActionHandlerOptions): (request: Request) => Promise<Response>;
+export declare function verifyTidegateActionRequest({ actionBridgeSecret, request, }: {
+    actionBridgeSecret?: string;
+    request: Request;
+}): TidegateVerifiedActionRequest;

package/dist/action-bridge.js

@@ -0,0 +1,407 @@
+import { z } from "zod";
+import { TidegateAuthContextSchema, TIDEGATE_ACTION_ALLOWED_ACTIONS_HEADER, TIDEGATE_ACTION_AUTH_CONTEXT_HEADER, TIDEGATE_ACTION_INTERACTION_ID_HEADER, TIDEGATE_ACTION_BRIDGE_SECRET_HEADER, TidegateActionCatalogManifestV1Schema, TidegateActionIdSchema, TidegateActionErrorCodeSchema, TidegateActionInvokeRequestSchema, TidegateActionInvokeResponseSchema, } from "@tidegate/contracts";
+export { TIDEGATE_ACTION_ALLOWED_ACTIONS_HEADER, TIDEGATE_ACTION_AUTH_CONTEXT_HEADER, TIDEGATE_ACTION_INTERACTION_ID_HEADER, TIDEGATE_ACTION_BRIDGE_SECRET_HEADER, TidegateActionErrorCodeSchema, TidegateActionInvokeRequestSchema, TidegateActionInvokeResponseSchema, };
+export class TidegateActionHandlerError extends Error {
+    name = "TidegateActionHandlerError";
+    code;
+    httpStatus;
+    responseStatus;
+    constructor(code, message, httpStatus, responseStatus = "rejected") {
+        super(message);
+        this.code = code;
+        this.httpStatus = httpStatus;
+        this.responseStatus = responseStatus;
+    }
+}
+export class TidegateActionCatalogError extends Error {
+    name = "TidegateActionCatalogError";
+}
+const TIDEGATE_ACTION_DEFINITION_BRAND = Symbol.for("@tidegate/sdk/tidegate-action-definition");
+export function tidegateAction(definition) {
+    if (isLegacyShorthandActionDefinition(definition)) {
+        const { inputSchema, outputSchema, execute, ...metadata } = definition;
+        return brandTidegateActionDefinition({
+            ...metadata,
+            input: inputSchema,
+            returns: outputSchema,
+            output: outputSchema,
+            execute: ({ input, auth, request, signal, invocationId }) => execute(input, { auth, request, signal, invocationId }),
+        });
+    }
+    if (isBuilderActionDefinition(definition)) {
+        const { input, returns, execute, ...metadata } = definition;
+        return brandTidegateActionDefinition({
+            ...metadata,
+            input,
+            returns,
+            execute: ({ input, auth, request, signal, invocationId }) => execute(input, { auth, request, signal, invocationId }),
+        });
+    }
+    return brandTidegateActionDefinition(definition);
+}
+export function defineTidegateActions(actions) {
+    flattenTidegateActions(actions);
+    return actions;
+}
+export function createTidegateActionCatalogManifest(actions, { catalogId, version = "1", }) {
+    return TidegateActionCatalogManifestV1Schema.parse({
+        schemaVersion: "tidegate.actionCatalog.v1",
+        catalogId,
+        version,
+        actions: Object.fromEntries(flattenTidegateActions(actions).map(([actionId, action]) => {
+            const returnsSchema = actionReturnsSchema(action);
+            return [
+                actionId,
+                {
+                    description: action.description ?? actionId,
+                    input: toJsonSchema(action.input),
+                    output: returnsSchema ? toJsonSchema(returnsSchema) : {},
+                    effects: action.effects,
+                    requiredPermissions: action.requiredPermissions ?? [],
+                    tenantScope: action.tenantScope,
+                    audit: {
+                        required: action.audit?.required ?? action.effects !== "read",
+                        redactPaths: action.audit?.redactPaths ?? [],
+                    },
+                },
+            ];
+        })),
+    });
+}
+export function createTidegateActionHandler(actions, { actionBridgeSecret = process.env.TIDEGATE_ACTION_BRIDGE_SECRET, verifyRequest, } = {}) {
+    const actionMap = new Map(flattenTidegateActions(actions));
+    const verifier = verifyRequest ??
+        ((request) => verifyTidegateActionRequest({ request, actionBridgeSecret }));
+    return async function POST(request) {
+        let verified;
+        try {
+            verified = await verifier(request);
+        }
+        catch (error) {
+            return responseFromError(normalizeActionHandlerError(error, "Tidegate action request verification failed."));
+        }
+        let body;
+        try {
+            body = await request.json();
+        }
+        catch {
+            return actionErrorResponse({
+                code: "invalid_request",
+                message: "Request body must be valid JSON.",
+                status: "rejected",
+                httpStatus: 400,
+            });
+        }
+        const requestResult = TidegateActionInvokeRequestSchema.safeParse(body);
+        if (!requestResult.success) {
+            return actionErrorResponse({
+                code: "invalid_request",
+                message: "Request body must include actionId and input only.",
+                status: "rejected",
+                httpStatus: 400,
+            });
+        }
+        const invokeRequest = requestResult.data;
+        if (!verified.allowedActionIds.includes(invokeRequest.actionId)) {
+            return actionErrorResponse({
+                code: "action_not_allowed",
+                message: "The requested Tidegate action is not allowed by this interaction.",
+                status: "rejected",
+                httpStatus: 403,
+                invocationId: invokeRequest.invocationId,
+            });
+        }
+        const action = actionMap.get(invokeRequest.actionId);
+        if (!action) {
+            return actionErrorResponse({
+                code: "action_not_found",
+                message: "The requested Tidegate action is not registered.",
+                status: "rejected",
+                httpStatus: 404,
+                invocationId: invokeRequest.invocationId,
+            });
+        }
+        if (!hasRequiredPermissions(verified.auth, action.requiredPermissions ?? [])) {
+            return actionErrorResponse({
+                code: "permission_denied",
+                message: "The Tidegate action request is missing required permissions.",
+                status: "rejected",
+                httpStatus: 403,
+                invocationId: invokeRequest.invocationId,
+            });
+        }
+        const inputResult = action.input.safeParse(invokeRequest.input);
+        if (!inputResult.success) {
+            return actionErrorResponse({
+                code: "action_input_invalid",
+                message: "The Tidegate action input does not match the registered schema.",
+                status: "rejected",
+                httpStatus: 400,
+                invocationId: invokeRequest.invocationId,
+            });
+        }
+        let output;
+        try {
+            output = await action.execute({
+                input: inputResult.data,
+                auth: verified.auth,
+                request,
+                signal: request.signal,
+                invocationId: invokeRequest.invocationId,
+            });
+        }
+        catch (error) {
+            // A structured TidegateActionHandlerError thrown by the action keeps
+            // its code/status: this is how a backend surfaces auth_required,
+            // permission_denied, action_input_invalid... from downstream systems.
+            const handlerError = normalizeActionHandlerError(error, "The Tidegate action failed while executing.");
+            return actionErrorResponse({
+                code: handlerError.code,
+                message: handlerError.message,
+                status: handlerError.responseStatus,
+                httpStatus: handlerError.httpStatus,
+                invocationId: invokeRequest.invocationId,
+            });
+        }
+        const returnsSchema = actionReturnsSchema(action);
+        let responseOutput = output;
+        if (returnsSchema) {
+            const outputResult = returnsSchema.safeParse(output);
+            if (!outputResult.success) {
+                return actionErrorResponse({
+                    code: "action_output_invalid",
+                    message: "The Tidegate action output does not match the registered schema.",
+                    status: "failed",
+                    httpStatus: 500,
+                    invocationId: invokeRequest.invocationId,
+                });
+            }
+            responseOutput = outputResult.data;
+        }
+        else if (responseOutput === undefined) {
+            responseOutput = null;
+        }
+        return Response.json(TidegateActionInvokeResponseSchema.parse({
+            status: "ok",
+            invocationId: invokeRequest.invocationId,
+            output: responseOutput,
+        }));
+    };
+}
+export function verifyTidegateActionRequest({ actionBridgeSecret = process.env.TIDEGATE_ACTION_BRIDGE_SECRET, request, }) {
+    if (!actionBridgeSecret) {
+        throw new TidegateActionHandlerError("auth_required", "TIDEGATE_ACTION_BRIDGE_SECRET is not configured.", 500, "failed");
+    }
+    const headerSecret = request.headers.get(TIDEGATE_ACTION_BRIDGE_SECRET_HEADER);
+    if (!headerSecret || !constantTimeEqual(headerSecret, actionBridgeSecret)) {
+        throw new TidegateActionHandlerError("auth_required", "The Tidegate action request is missing a valid credential.", 401);
+    }
+    const authHeader = request.headers.get(TIDEGATE_ACTION_AUTH_CONTEXT_HEADER);
+    const allowedActionsHeader = request.headers.get(TIDEGATE_ACTION_ALLOWED_ACTIONS_HEADER);
+    if (!authHeader) {
+        throw new TidegateActionHandlerError("invalid_request", "The Tidegate action request is missing server-derived auth context.", 400);
+    }
+    if (!allowedActionsHeader) {
+        throw new TidegateActionHandlerError("invalid_request", "The Tidegate action request is missing its interaction action allowlist.", 400);
+    }
+    let parsedAuth;
+    let parsedAllowedActions;
+    try {
+        parsedAuth = JSON.parse(authHeader);
+    }
+    catch {
+        throw new TidegateActionHandlerError("invalid_request", "The Tidegate action auth context must be valid JSON.", 400);
+    }
+    try {
+        parsedAllowedActions = JSON.parse(allowedActionsHeader);
+    }
+    catch {
+        throw new TidegateActionHandlerError("invalid_request", "The Tidegate action allowlist must be valid JSON.", 400);
+    }
+    const authResult = TidegateAuthContextSchema.safeParse(parsedAuth);
+    const allowedActionsResult = z.array(z.string().min(1)).safeParse(parsedAllowedActions);
+    if (!authResult.success) {
+        throw new TidegateActionHandlerError("invalid_request", "The Tidegate action auth context is invalid.", 400);
+    }
+    if (!allowedActionsResult.success) {
+        throw new TidegateActionHandlerError("invalid_request", "The Tidegate action allowlist is invalid.", 400);
+    }
+    return {
+        auth: authResult.data,
+        allowedActionIds: allowedActionsResult.data,
+        interactionId: request.headers.get(TIDEGATE_ACTION_INTERACTION_ID_HEADER) ?? undefined,
+    };
+}
+function responseFromError(error) {
+    return actionErrorResponse({
+        code: error.code,
+        message: error.message,
+        status: error.responseStatus,
+        httpStatus: error.httpStatus,
+    });
+}
+function normalizeActionHandlerError(error, fallbackMessage) {
+    if (error instanceof TidegateActionHandlerError) {
+        return error;
+    }
+    return new TidegateActionHandlerError("action_failed", fallbackMessage, 500, "failed");
+}
+function actionErrorResponse({ code, httpStatus, invocationId, message, status, }) {
+    return Response.json(TidegateActionInvokeResponseSchema.parse({
+        status,
+        invocationId,
+        error: {
+            code,
+            // The bridge response contract requires a non-empty message; a
+            // downstream system may legitimately produce an empty one.
+            message: message.trim().length > 0
+                ? message
+                : `The Tidegate action failed with error code ${code} and no message.`,
+        },
+    }), { status: httpStatus });
+}
+function hasRequiredPermissions(auth, requiredPermissions) {
+    if (requiredPermissions.length === 0) {
+        return true;
+    }
+    const permissions = new Set([
+        ...(auth.permissions ?? []),
+        ...(auth.authorization?.permissions ?? []),
+    ]);
+    return requiredPermissions.every((permission) => permissions.has(permission));
+}
+function constantTimeEqual(left, right) {
+    if (left.length !== right.length) {
+        return false;
+    }
+    let diff = 0;
+    for (let index = 0; index < left.length; index += 1) {
+        diff |= left.charCodeAt(index) ^ right.charCodeAt(index);
+    }
+    return diff === 0;
+}
+function toJsonSchema(schema) {
+    return z.toJSONSchema(schema);
+}
+function flattenTidegateActions(actions) {
+    assertPlainNamespace(actions, "Tidegate action catalog");
+    assertStringKeysOnly(actions, "Tidegate action catalog");
+    const entries = new Map();
+    for (const [segment, node] of Object.entries(actions)) {
+        collectTidegateActionEntries({
+            entries,
+            path: [segment],
+            node,
+        });
+    }
+    assertNoNamespaceCollisions([...entries.keys()]);
+    return [...entries.entries()];
+}
+function collectTidegateActionEntries({ entries, path, node, }) {
+    if (isTidegateActionDefinition(node)) {
+        if (path.length > 1 && !isBrandedTidegateActionDefinition(node)) {
+            throw new TidegateActionCatalogError(`Invalid Tidegate action "${path.join(".")}". Wrap input/returns shorthand definitions with tidegateAction(...).`);
+        }
+        const actionId = path.join(".");
+        const actionIdResult = TidegateActionIdSchema.safeParse(actionId);
+        if (!actionIdResult.success) {
+            throw new TidegateActionCatalogError(`Invalid Tidegate action id "${actionId}": ${actionIdResult.error.issues
+                .map((issue) => issue.message)
+                .join(" ")}`);
+        }
+        if (entries.has(actionId)) {
+            throw new TidegateActionCatalogError(`Duplicate Tidegate action id "${actionId}". Use only one definition for each action path.`);
+        }
+        entries.set(actionId, node);
+        return;
+    }
+    if (isShorthandActionDefinition(node)) {
+        throw new TidegateActionCatalogError(`Invalid Tidegate action "${path.join(".")}". Wrap input/returns shorthand definitions with tidegateAction(...).`);
+    }
+    if (!isRecord(node)) {
+        throw new TidegateActionCatalogError(`Invalid Tidegate action namespace "${path.join(".")}". Expected an action definition or nested namespace.`);
+    }
+    const namespace = path.join(".");
+    assertPlainNamespace(node, `Tidegate action namespace "${namespace}"`);
+    assertStringKeysOnly(node, `Tidegate action namespace "${namespace}"`);
+    const childEntries = Object.entries(node);
+    if (childEntries.length === 0) {
+        throw new TidegateActionCatalogError(`Invalid Tidegate action namespace "${namespace}". Namespaces must contain at least one action.`);
+    }
+    for (const [segment, child] of childEntries) {
+        collectTidegateActionEntries({
+            entries,
+            path: [...path, segment],
+            node: child,
+        });
+    }
+}
+function assertNoNamespaceCollisions(actionIds) {
+    const knownActionIds = new Set(actionIds);
+    for (const actionId of actionIds) {
+        const segments = actionId.split(".");
+        let prefix = "";
+        for (const segment of segments.slice(0, -1)) {
+            prefix = prefix.length === 0 ? segment : `${prefix}.${segment}`;
+            if (knownActionIds.has(prefix)) {
+                throw new TidegateActionCatalogError(`Tidegate action id "${actionId}" conflicts with "${prefix}". Use either a leaf action or a namespace at each path.`);
+            }
+        }
+    }
+}
+function isTidegateActionDefinition(value) {
+    return (isRecord(value) &&
+        "input" in value &&
+        "effects" in value &&
+        "execute" in value &&
+        typeof value.execute === "function");
+}
+function isShorthandActionDefinition(value) {
+    return (isBuilderActionDefinition(value) ||
+        isLegacyShorthandActionDefinition(value));
+}
+function isBuilderActionDefinition(value) {
+    return (isRecord(value) &&
+        "input" in value &&
+        !("output" in value) &&
+        "effects" in value &&
+        "execute" in value &&
+        typeof value.execute === "function");
+}
+function isLegacyShorthandActionDefinition(value) {
+    return (isRecord(value) &&
+        "inputSchema" in value &&
+        "outputSchema" in value &&
+        "effects" in value &&
+        "execute" in value &&
+        typeof value.execute === "function");
+}
+function brandTidegateActionDefinition(action) {
+    Object.defineProperty(action, TIDEGATE_ACTION_DEFINITION_BRAND, {
+        configurable: false,
+        enumerable: false,
+        value: true,
+    });
+    return action;
+}
+function isBrandedTidegateActionDefinition(action) {
+    return (action[TIDEGATE_ACTION_DEFINITION_BRAND] ===
+        true);
+}
+function actionReturnsSchema(action) {
+    return action.returns ?? action.output;
+}
+function isRecord(value) {
+    return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function assertPlainNamespace(value, label) {
+    const prototype = Object.getPrototypeOf(value);
+    if (prototype !== Object.prototype && prototype !== null) {
+        throw new TidegateActionCatalogError(`${label} must be a plain object with string action ids or namespace keys.`);
+    }
+}
+function assertStringKeysOnly(value, label) {
+    if (Reflect.ownKeys(value).some((key) => typeof key === "symbol")) {
+        throw new TidegateActionCatalogError(`${label} must use string keys only; symbol keys cannot become stable Tidegate action ids.`);
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1 @@
+export type { InvokeInteractionRequest, InvokeInteractionResponse, } from "@tidegate/contracts";

package/dist/server.d.ts

@@ -0,0 +1,21 @@
+import { type InvokeInteractionRequest, type InvokeInteractionResponse } from "@tidegate/contracts";
+export { TIDEGATE_ACTION_ALLOWED_ACTIONS_HEADER, TIDEGATE_ACTION_AUTH_CONTEXT_HEADER, TIDEGATE_ACTION_INTERACTION_ID_HEADER, TIDEGATE_ACTION_BRIDGE_SECRET_HEADER, TidegateActionCatalogError, TidegateActionErrorCodeSchema, TidegateActionHandlerError, TidegateActionInvokeRequestSchema, TidegateActionInvokeResponseSchema, createTidegateActionCatalogManifest, createTidegateActionHandler, defineTidegateActions, tidegateAction, verifyTidegateActionRequest, type AnyTidegateActionDefinition, type CreateTidegateActionCatalogManifestOptions, type CreateTidegateActionHandlerOptions, type TidegateActionCatalog, type TidegateActionCatalogNode, type TidegateActionBuilderDefinition, type TidegateActionBuilderWithReturnsDefinition, type TidegateActionDefinition, type TidegateActionEffect, type TidegateActionErrorCode, type TidegateActionExecuteContext, type TidegateActionExecuteArgs, type TidegateActionLegacyShorthandDefinition, type TidegateActionNormalizedDefinition, type TidegateActionShorthandDefinition, type TidegateActionShorthandWithReturnsDefinition, type TidegateActionInvokeRequest, type TidegateActionInvokeResponse, type TidegateActionRequestVerifier, type TidegateVerifiedActionRequest, } from "./action-bridge.js";
+export declare const DEFAULT_TIDEGATE_API_BASE_URL = "https://api.tidegate.ai/v1";
+export type TidegateFetch = (input: Parameters<typeof fetch>[0], init?: Parameters<typeof fetch>[1]) => Promise<Response>;
+export type TidegateServerClientOptions = {
+    apiKey?: string;
+    baseUrl?: string;
+    fetchImpl?: TidegateFetch;
+};
+export type TidegateInteractionsClient = {
+    invoke: (interactionId: string, request: InvokeInteractionRequest) => Promise<InvokeInteractionResponse>;
+};
+export type TidegateServerClient = {
+    interactions: TidegateInteractionsClient;
+};
+export declare class TidegateSdkError extends Error {
+    name: string;
+    readonly details?: unknown;
+    constructor(message: string, details?: unknown);
+}
+export declare function createTidegateServerClient({ apiKey, baseUrl, fetchImpl, }?: TidegateServerClientOptions): TidegateServerClient;

package/dist/server.js

@@ -0,0 +1,57 @@
+import { interactionPublicRoutePaths, InvokeInteractionRequestSchema, InvokeInteractionResponseSchema, } from "@tidegate/contracts";
+export { TIDEGATE_ACTION_ALLOWED_ACTIONS_HEADER, TIDEGATE_ACTION_AUTH_CONTEXT_HEADER, TIDEGATE_ACTION_INTERACTION_ID_HEADER, TIDEGATE_ACTION_BRIDGE_SECRET_HEADER, TidegateActionCatalogError, TidegateActionErrorCodeSchema, TidegateActionHandlerError, TidegateActionInvokeRequestSchema, TidegateActionInvokeResponseSchema, createTidegateActionCatalogManifest, createTidegateActionHandler, defineTidegateActions, tidegateAction, verifyTidegateActionRequest, } from "./action-bridge.js";
+export const DEFAULT_TIDEGATE_API_BASE_URL = "https://api.tidegate.ai/v1";
+export class TidegateSdkError extends Error {
+    name = "TidegateSdkError";
+    details;
+    constructor(message, details) {
+        super(message);
+        this.details = details;
+    }
+}
+export function createTidegateServerClient({ apiKey = process.env.TIDEGATE_API_KEY, baseUrl = DEFAULT_TIDEGATE_API_BASE_URL, fetchImpl = globalThis.fetch, } = {}) {
+    if (!apiKey) {
+        throw new TidegateSdkError("Missing TIDEGATE_API_KEY. Create an API key in the Tidegate dashboard and add it to your server environment.");
+    }
+    const normalizedBaseUrl = normalizeBaseUrl(baseUrl);
+    return {
+        interactions: {
+            async invoke(interactionId, request) {
+                const invokeRequest = InvokeInteractionRequestSchema.parse(request);
+                const response = await fetchImpl(urlForInteractionInvoke(normalizedBaseUrl, interactionId), {
+                    method: "POST",
+                    headers: {
+                        accept: "application/json",
+                        authorization: `Bearer ${apiKey}`,
+                        "content-type": "application/json",
+                    },
+                    body: JSON.stringify(invokeRequest),
+                });
+                let body;
+                try {
+                    body = await response.json();
+                }
+                catch (error) {
+                    throw new TidegateSdkError(`Tidegate returned HTTP ${response.status} without a valid JSON body.`, error);
+                }
+                const parsed = InvokeInteractionResponseSchema.safeParse(body);
+                if (!parsed.success) {
+                    throw new TidegateSdkError(`Tidegate returned HTTP ${response.status} with an invalid interaction response.`, parsed.error);
+                }
+                return parsed.data;
+            },
+        },
+    };
+}
+function normalizeBaseUrl(baseUrl) {
+    const normalized = baseUrl.trim().replace(/\/+$/, "");
+    if (normalized.length === 0) {
+        throw new TidegateSdkError("Tidegate baseUrl cannot be empty.");
+    }
+    return normalized;
+}
+function urlForInteractionInvoke(baseUrl, interactionId) {
+    return `${baseUrl}/${interactionPublicRoutePaths.invokeInteraction({
+        interactionId,
+    })}`;
+}

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@tidegate/sdk",
+  "version": "0.1.0",
+  "description": "Tidegate SDK: connect a trusted server to Tidegate (action bridge, public interaction invoke helpers).",
+  "type": "module",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/puccez/tidegate.git",
+    "directory": "packages/tidegate-sdk"
+  },
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./server": {
+      "types": "./dist/server.d.ts",
+      "default": "./dist/server.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@tidegate/contracts": "0.1.0",
+    "zod": "4.4.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}