authhero 5.8.0 → 5.9.0

package/dist/types/email-services/resend.d.ts

@@ -0,0 +1,14 @@
+import { z } from "@hono/zod-openapi";
+import type { EmailServiceAdapter, EmailServiceSendParams } from "@authhero/adapter-interfaces";
+export declare const resendCredentialsSchema: z.ZodObject<{
+    api_key: z.ZodString;
+}, z.core.$strip>;
+export type ResendCredentials = z.infer<typeof resendCredentialsSchema>;
+export interface ResendEmailServiceOptions {
+    fetchImpl?: typeof fetch;
+}
+export declare class ResendEmailService implements EmailServiceAdapter {
+    private readonly options;
+    constructor(options?: ResendEmailServiceOptions);
+    send(params: EmailServiceSendParams): Promise<void>;
+}

package/dist/types/emails/defaults/Layout.d.ts

@@ -0,0 +1,12 @@
+import { ReactNode } from "react";
+interface LayoutProps {
+    preview?: string;
+    children: ReactNode;
+}
+/**
+ * Shared frame for all built-in email defaults. Liquid placeholders
+ * (`{{ branding.logo }}`, `{{ tenant.support_url }}`, etc.) are emitted as
+ * raw strings; the runtime Liquid pass interpolates them per-send.
+ */
+export declare function Layout({ preview, children }: LayoutProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/types/emails/defaults/PrimaryButton.d.ts

@@ -0,0 +1,11 @@
+import { ReactNode } from "react";
+interface PrimaryButtonProps {
+    href: string;
+    children: ReactNode;
+}
+/**
+ * Liquid-friendly button. The background color is a Liquid placeholder so the
+ * runtime pass can substitute the tenant's `branding.primary_color`.
+ */
+export declare function PrimaryButton({ href, children }: PrimaryButtonProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/types/emails/defaults/ResetEmail.d.ts

@@ -0,0 +1 @@
+export declare function ResetEmail(): import("react/jsx-runtime").JSX.Element;

package/dist/types/emails/defaults/ResetEmailByCode.d.ts

@@ -0,0 +1 @@
+export declare function ResetEmailByCode(): import("react/jsx-runtime").JSX.Element;

package/dist/types/emails/defaults/UserInvitation.d.ts

@@ -0,0 +1 @@
+export declare function UserInvitation(): import("react/jsx-runtime").JSX.Element;

package/dist/types/emails/defaults/VerifyEmail.d.ts

@@ -0,0 +1 @@
+export declare function VerifyEmail(): import("react/jsx-runtime").JSX.Element;

package/dist/types/emails/defaults/VerifyEmailByCode.d.ts

@@ -0,0 +1 @@
+export declare function VerifyEmailByCode(): import("react/jsx-runtime").JSX.Element;

package/dist/types/emails/defaults/WelcomeEmail.d.ts

@@ -0,0 +1 @@
+export declare function WelcomeEmail(): import("react/jsx-runtime").JSX.Element;

package/dist/types/emails/defaults/compiled.d.ts

@@ -0,0 +1,2 @@
+import type { EmailTemplateName } from "@authhero/adapter-interfaces";
+export declare const defaultBodies: Partial<Record<EmailTemplateName, string>>;

package/dist/types/emails/defaults/index.d.ts

@@ -0,0 +1,6 @@
+import type { EmailTemplateName } from "@authhero/adapter-interfaces";
+export interface DefaultTemplate {
+    subject: string;
+    body: string;
+}
+export declare function getDefaultTemplate(name: EmailTemplateName): DefaultTemplate | null;

package/dist/types/emails/defaults/subjects.d.ts

@@ -0,0 +1,2 @@
+import type { EmailTemplateName } from "@authhero/adapter-interfaces";
+export declare const defaultSubjects: Partial<Record<EmailTemplateName, string>>;

package/dist/types/emails/index.d.ts

@@ -0,0 +1,70 @@
+import { Context } from "hono";
+import { Bindings, Variables } from "../types";
+import { AuthParams, User } from "@authhero/adapter-interfaces";
+export type SendEmailParams = {
+    to: string;
+    subject: string;
+    html?: string;
+    text?: string;
+    template: string;
+    data: Record<string, string>;
+    from?: string;
+};
+export declare function sendEmail(ctx: Context<{
+    Bindings: Bindings;
+    Variables: Variables;
+}>, params: SendEmailParams): Promise<void>;
+export type SendSmsParams = {
+    to: string;
+    from?: string;
+    text: string;
+    code: string;
+};
+export declare function sendSms(ctx: Context<{
+    Bindings: Bindings;
+    Variables: Variables;
+}>, params: SendSmsParams): Promise<void>;
+export declare function sendResetPassword(ctx: Context<{
+    Bindings: Bindings;
+    Variables: Variables;
+}>, to: string, code: string, state?: string, language?: string): Promise<void>;
+export declare function sendResetPasswordCode(ctx: Context<{
+    Bindings: Bindings;
+    Variables: Variables;
+}>, to: string, code: string, language?: string): Promise<void>;
+export interface SendCodeParams {
+    to: string;
+    code: string;
+    language?: string;
+}
+export interface SendLinkParams extends SendCodeParams {
+    authParams: AuthParams;
+}
+export declare function sendCode(ctx: Context<{
+    Bindings: Bindings;
+    Variables: Variables;
+}>, { to, code, language }: SendCodeParams): Promise<void>;
+export declare function sendLink(ctx: Context<{
+    Bindings: Bindings;
+    Variables: Variables;
+}>, { to, code, authParams, language }: SendLinkParams): Promise<void>;
+export declare function sendValidateEmailAddress(ctx: Context<{
+    Bindings: Bindings;
+    Variables: Variables;
+}>, user: User, language?: string): Promise<void>;
+export declare function sendSignupValidateEmailAddress(ctx: Context<{
+    Bindings: Bindings;
+    Variables: Variables;
+}>, to: string, code: string, state: string, language?: string): Promise<void>;
+export interface SendInvitationParams {
+    to: string;
+    invitationUrl: string;
+    inviterName?: string;
+    organizationName: string;
+    ttlSec: number;
+    language?: string;
+}
+export declare function sendInvitation(ctx: Context<{
+    Bindings: Bindings;
+    Variables: Variables;
+}>, { to, invitationUrl, inviterName, organizationName, ttlSec, language, }: SendInvitationParams): Promise<void>;

package/dist/types/emails/render.d.ts

@@ -0,0 +1,41 @@
+import { Context } from "hono";
+import { EmailTemplateName } from "@authhero/adapter-interfaces";
+import { Bindings, Variables } from "../types";
+export interface RenderedEmail {
+    subject: string;
+    html: string;
+    from: string;
+}
+export type RenderResult = {
+    kind: "rendered";
+    email: RenderedEmail;
+}
+/** Override exists and tenant explicitly disabled this template. */
+ | {
+    kind: "disabled";
+}
+/** No override and no bundled default — caller should use legacy inline HTML. */
+ | {
+    kind: "none";
+};
+/**
+ * Resolve and render an email template for the current tenant.
+ *
+ * Lookup order:
+ *   1. Tenant override stored in `email_templates` (Auth0-compatible).
+ *      If `enabled === false`, returns `{ kind: "disabled" }`.
+ *   2. Bundled default (compiled from MJML at build time).
+ *   3. `{ kind: "none" }` if neither exists.
+ */
+export declare function renderEmailTemplate(ctx: Context<{
+    Bindings: Bindings;
+    Variables: Variables;
+}>, templateName: EmailTemplateName, vars: Record<string, unknown>, fallbackFrom: string): Promise<RenderResult>;
+/**
+ * Render the bundled default template directly, without consulting the
+ * adapter. Exposed for tests and tooling.
+ */
+export declare function renderDefaultTemplate(templateName: EmailTemplateName, vars: Record<string, unknown>): Promise<{
+    subject: string;
+    html: string;
+} | null>;

package/dist/types/errors/is-unique-constraint-error.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Check whether an error is a unique-constraint violation (HTTP 409).
+ *
+ * Uses a duck-typed status check rather than `instanceof HTTPException`
+ * because HTTPException instances may not share a class identity across
+ * bundled adapter packages (minification can rename the class).
+ */
+export declare function isUniqueConstraintError(err: unknown): boolean;

package/dist/types/errors/json-http-exception.d.ts

@@ -0,0 +1,5 @@
+import { HTTPException } from "hono/http-exception";
+import { ContentfulStatusCode } from "hono/utils/http-status";
+export declare class JSONHTTPException extends HTTPException {
+    constructor(status: ContentfulStatusCode, body: object);
+}

package/dist/types/errors/redirect-exception.d.ts

@@ -0,0 +1,6 @@
+import { RedirectStatusCode } from "hono/utils/http-status";
+export declare class RedirectException extends Error {
+    readonly location: string;
+    readonly status: RedirectStatusCode;
+    constructor(location: string, status?: RedirectStatusCode);
+}