@authhero/adapter-interfaces 0.1.0 → 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 authhero
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+# @authhero/adapter-interfaces
+
+This package provides a set of interfaces used for creating adapters for AuthHero. Adapters are used to connect AuthHero to various services, such as databases, email services, and more.

package/package.json

@@ -5,11 +5,11 @@
     "type": "git",
     "url": "https://github.com/markusahlstrand/authhero"
   },
-  "version": "0.1.0",
+  "version": "0.1.1",
+  "files": [
+    "dist"
+  ],
   "main": "dist/adapter-interfaces.js",
-  "scripts": {
-    "build": "tsc && vite build"
-  },
   "devDependencies": {
     "@rollup/plugin-commonjs": "^26.0.1",
     "@rollup/plugin-node-resolve": "^15.2.3",
@@ -19,5 +19,8 @@
   },
   "dependencies": {
     "@hono/zod-openapi": "^0.14.5"
+  },
+  "scripts": {
+    "build": "tsc && vite build"
   }
-}
+}

package/CHANGELOG.md

@@ -1,7 +0,0 @@
-# @authhero/adapter-interfaces
-
-## 0.1.0
-
-### Minor Changes
-
-- Added package for apapter interfaces

package/src/adapters/Applications.ts

@@ -1,31 +0,0 @@
-import { Application, Totals } from "../types";
-import { ListParams } from "./ListParams";
-
-export interface CreateApplicationParams {
-  name: string;
-  allowed_web_origins: string;
-  allowed_callback_urls: string;
-  allowed_logout_urls: string;
-  email_validation: "enabled" | "disabled" | "enforced";
-  client_secret: string;
-  id: string;
-  disable_sign_ups: boolean;
-}
-
-export interface ApplicationsAdapter {
-  create(
-    tenant_id: string,
-    params: CreateApplicationParams,
-  ): Promise<Application>;
-  get(tenant_id: string, id: string): Promise<Application | null>;
-  remove(tenant_id: string, id: string): Promise<boolean>;
-  list(
-    tenant_id: string,
-    params: ListParams,
-  ): Promise<{ applications: Application[]; totals?: Totals }>;
-  update(
-    tenant_id: string,
-    id: string,
-    application: Partial<Application>,
-  ): Promise<boolean>;
-}

package/src/adapters/AuthenticationCodes.ts

@@ -1,6 +0,0 @@
-import { AuthenticationCode } from "../types";
-
-export interface AuthenticationCodesAdapter {
-  create: (tenant_id: string, authCode: AuthenticationCode) => Promise<void>;
-  get: (tenant_id: string, code: string) => Promise<AuthenticationCode>;
-}

package/src/adapters/Branding.ts

@@ -1,6 +0,0 @@
-import { Branding } from "../types";
-
-export interface BrandingAdapter {
-  set: (tenant_id: string, authCode: Branding) => Promise<void>;
-  get: (tenant_id: string) => Promise<Branding | null>;
-}

package/src/adapters/Codes.ts

@@ -1,6 +0,0 @@
-import { Code } from "../types";
-
-export interface CodesAdapter {
-  create: (tenant_id: string, authCode: Code) => Promise<void>;
-  list: (tenant_id: string, user_id: string) => Promise<Code[]>;
-}

package/src/adapters/Connections.ts

@@ -1,18 +0,0 @@
-import { Connection, ConnectionInsert, Totals } from "../types";
-import { ListParams } from "./ListParams";
-
-export interface ListConnectionsResponse extends Totals {
-  connections: Connection[];
-}
-
-export interface ConnectionsAdapter {
-  create(tenant_id: string, params: ConnectionInsert): Promise<Connection>;
-  remove(tenant_id: string, connection_id: string): Promise<boolean>;
-  get(tenant_id: string, connection_id: string): Promise<Connection | null>;
-  update(
-    tenant_id: string,
-    connection_id: string,
-    params: Partial<ConnectionInsert>,
-  ): Promise<boolean>;
-  list(tenant_id: string, params: ListParams): Promise<ListConnectionsResponse>;
-}

package/src/adapters/Domains.ts

@@ -1,11 +0,0 @@
-import { Totals, Domain } from "../types";
-import { ListParams } from "./ListParams";
-
-interface ListDomainsResponse extends Totals {
-  domains: Domain[];
-}
-
-export interface DomainsAdapter {
-  create(tenant_id: string, params: Domain): Promise<Domain>;
-  list(tenant_id: string, params: ListParams): Promise<ListDomainsResponse>;
-}

package/src/adapters/Hooks.ts

@@ -1,18 +0,0 @@
-import { Hook, HookInsert, Totals } from "../types";
-import { ListParams } from "./ListParams";
-
-export interface ListHooksResponse extends Totals {
-  hooks: Hook[];
-}
-
-export interface HooksAdapter {
-  create: (tenant_id: string, hook: HookInsert) => Promise<Hook>;
-  remove: (tenant_id: string, hook_id: string) => Promise<boolean>;
-  get: (tenant_id: string, hook_id: string) => Promise<Hook | null>;
-  update: (
-    tenant_id: string,
-    hook_id: string,
-    hook: Partial<HookInsert>,
-  ) => Promise<boolean>;
-  list: (tenant_id: string, params: ListParams) => Promise<ListHooksResponse>;
-}

package/src/adapters/Keys.ts

@@ -1,7 +0,0 @@
-import { Certificate } from "../types";
-
-export interface KeysAdapter {
-  create: (key: Certificate) => Promise<void>;
-  list: () => Promise<Certificate[]>;
-  revoke: (kid: string, revoke_at: Date) => Promise<boolean>;
-}

package/src/adapters/ListParams.ts

@@ -1,10 +0,0 @@
-export interface ListParams {
-  page: number;
-  per_page: number;
-  include_totals: boolean;
-  q?: string;
-  sort?: {
-    sort_by: string;
-    sort_order: "asc" | "desc";
-  };
-}

package/src/adapters/Logs.ts

@@ -1,12 +0,0 @@
-import { LogsResponse, Log, Totals } from "../types";
-import { ListParams } from "./ListParams";
-
-interface ListLogsResponse extends Totals {
-  logs: LogsResponse[];
-}
-
-export interface LogsDataAdapter {
-  create(tenantId: string, params: Log): Promise<Log>;
-  list(tenantId: string, params: ListParams): Promise<ListLogsResponse>;
-  get(tenantId: string, logId: string): Promise<LogsResponse | null>;
-}

package/src/adapters/OTP.ts

@@ -1,7 +0,0 @@
-import { OTP } from "../types";
-
-export interface OTPAdapter {
-  create: (authCode: OTP) => Promise<void>;
-  list: (tenant_id: string, email: string) => Promise<OTP[]>;
-  remove: (tenant_id: string, id: string) => Promise<void>;
-}

package/src/adapters/Passwords.ts

@@ -1,10 +0,0 @@
-import { PasswordParams, PasswordResponse } from "../types";
-
-export interface PasswordsAdapter {
-  create: (tenant_id: string, params: PasswordParams) => Promise<void>;
-  update: (tenant_id: string, params: PasswordParams) => Promise<boolean>;
-  validate: (
-    tenant_id: string,
-    params: PasswordParams,
-  ) => Promise<PasswordResponse>;
-}

package/src/adapters/Sessions.ts

@@ -1,12 +0,0 @@
-import { Session } from "../types";
-
-export interface SessionsAdapter {
-  create: (session: Session) => Promise<void>;
-  get: (tenant_id: string, id: string) => Promise<Session | null>;
-  update: (
-    tenant_id: string,
-    id: string,
-    session: { used_at: string },
-  ) => Promise<boolean>;
-  remove: (tenant_id: string, id: string) => Promise<boolean>;
-}

package/src/adapters/Tenants.ts

@@ -1,18 +0,0 @@
-import { Tenant, Totals } from "../types";
-import { ListParams } from "./ListParams";
-
-export interface CreateTenantParams {
-  name: string;
-  audience: string;
-  sender_name: string;
-  sender_email: string;
-  id?: string;
-}
-
-export interface TenantsDataAdapter {
-  create(params: CreateTenantParams): Promise<Tenant>;
-  get(id: string): Promise<Tenant | null>;
-  list(params: ListParams): Promise<{ tenants: Tenant[]; totals?: Totals }>;
-  update(id: string, tenant: Partial<Tenant>): Promise<void>;
-  remove(tenantId: string): Promise<boolean>;
-}

package/src/adapters/Tickets.ts

@@ -1,7 +0,0 @@
-import { Ticket } from "../types";
-
-export interface TicketsAdapter {
-  create: (ticket: Ticket) => Promise<void>;
-  get: (tenant_id: string, id: string) => Promise<Ticket | null>;
-  remove: (tenant_id: string, id: string) => Promise<void>;
-}

package/src/adapters/UniversalLoginSession.ts

@@ -1,17 +0,0 @@
-import { AuthParams } from "../types";
-
-export interface UniversalLoginSession {
-  id: string;
-  tenant_id: string;
-  created_at: string;
-  updated_at: string;
-  expires_at: string;
-  authParams: AuthParams;
-  auth0Client?: string;
-}
-
-export interface UniversalLoginSessionsAdapter {
-  create: (session: UniversalLoginSession) => Promise<void>;
-  update: (id: string, session: UniversalLoginSession) => Promise<boolean>;
-  get: (id: string) => Promise<UniversalLoginSession | null>;
-}

package/src/adapters/Users.ts

@@ -1,20 +0,0 @@
-import { User, Totals } from "../types";
-import { ListParams } from "./ListParams";
-
-export interface ListUsersResponse extends Totals {
-  users: User[];
-}
-
-export interface UserDataAdapter {
-  get(tenant_id: string, id: string): Promise<User | null>;
-  create(tenantId: string, user: User): Promise<User>;
-  remove(tenantId: string, id: string): Promise<boolean>;
-  list(tenantId: string, params: ListParams): Promise<ListUsersResponse>;
-  update(tenantId: string, id: string, user: Partial<User>): Promise<boolean>;
-  unlink(
-    tenantId: string,
-    id: string,
-    provider: string,
-    linked_user_id: string,
-  ): Promise<boolean>;
-}

package/src/adapters/index.ts

@@ -1,35 +0,0 @@
-import { CodesAdapter } from "./Codes";
-import { OTPAdapter } from "./OTP";
-import { PasswordsAdapter } from "./Passwords";
-import { SessionsAdapter } from "./Sessions";
-import { TenantsDataAdapter } from "./Tenants";
-import { TicketsAdapter } from "./Tickets";
-import { UserDataAdapter } from "./Users";
-import { LogsDataAdapter } from "./Logs";
-import { ApplicationsAdapter } from "./Applications";
-import { UniversalLoginSessionsAdapter } from "./UniversalLoginSession";
-import { ConnectionsAdapter } from "./Connections";
-import { DomainsAdapter } from "./Domains";
-import { KeysAdapter } from "./Keys";
-import { BrandingAdapter } from "./Branding";
-import { AuthenticationCodesAdapter } from "./AuthenticationCodes";
-import { HooksAdapter } from "./Hooks";
-
-export interface DataAdapters {
-  applications: ApplicationsAdapter;
-  branding: BrandingAdapter;
-  codes: CodesAdapter;
-  OTP: OTPAdapter;
-  passwords: PasswordsAdapter;
-  sessions: SessionsAdapter;
-  tenants: TenantsDataAdapter;
-  tickets: TicketsAdapter;
-  universalLoginSessions: UniversalLoginSessionsAdapter;
-  users: UserDataAdapter;
-  logs: LogsDataAdapter;
-  connections: ConnectionsAdapter;
-  domains: DomainsAdapter;
-  keys: KeysAdapter;
-  hooks: HooksAdapter;
-  authenticationCodes: AuthenticationCodesAdapter;
-}

package/src/index.ts

@@ -1,2 +0,0 @@
-export * from "./types";
-export * from "./adapters";

package/src/types/Application.ts

@@ -1,33 +0,0 @@
-import { z } from "@hono/zod-openapi";
-
-export const applicationInsertSchema = z.object({
-  id: z.string(),
-  name: z.string(),
-  allowed_web_origins: z
-    .string()
-    .transform((val) => (val === null ? "" : val))
-    .default(""),
-  allowed_callback_urls: z
-    .string()
-    .transform((val) => (val === null ? "" : val))
-    .default(""),
-  allowed_logout_urls: z
-    .string()
-    .transform((val) => (val === null ? "" : val))
-    .default(""),
-  email_validation: z
-    .enum(["enabled", "disabled", "enforced"])
-    .default("enforced"),
-  client_secret: z.string().default(""),
-  disable_sign_ups: z.boolean().default(false),
-});
-export type ApplicationInsert = z.infer<typeof applicationInsertSchema>;
-
-export const applicationSchema = z
-  .object({
-    created_at: z.string().transform((val) => (val === null ? "" : val)),
-    updated_at: z.string().transform((val) => (val === null ? "" : val)),
-  })
-  .extend(applicationInsertSchema.shape);
-
-export type Application = z.infer<typeof applicationSchema>;

package/src/types/AuthParams.ts

@@ -1,36 +0,0 @@
-import { z } from "@hono/zod-openapi";
-
-export enum AuthorizationResponseType {
-  TOKEN = "token",
-  TOKEN_ID_TOKEN = "token id_token",
-  CODE = "code",
-}
-
-export enum AuthorizationResponseMode {
-  QUERY = "query",
-  FRAGMENT = "fragment",
-  FORM_POST = "form_post",
-  WEB_MESSAGE = "web_message",
-}
-
-export enum CodeChallengeMethod {
-  S265 = "S256",
-  plain = "plain",
-}
-
-export const authParamsSchema = z.object({
-  client_id: z.string(),
-  vendor_id: z.string().optional(),
-  response_type: z.nativeEnum(AuthorizationResponseType).optional(),
-  response_mode: z.nativeEnum(AuthorizationResponseMode).optional(),
-  redirect_uri: z.string().optional(),
-  audience: z.string().optional(),
-  state: z.string().optional(),
-  nonce: z.string().optional(),
-  scope: z.string().optional(),
-  code_challenge_method: z.nativeEnum(CodeChallengeMethod).optional(),
-  code_challenge: z.string().optional(),
-  username: z.string().optional(),
-});
-
-export type AuthParams = z.infer<typeof authParamsSchema>;

package/src/types/AuthenticationCode.ts

@@ -1,14 +0,0 @@
-import { z } from "@hono/zod-openapi";
-import { authParamsSchema } from "./AuthParams";
-
-export const authenticationCodeSchema = z.object({
-  authParams: authParamsSchema,
-  nonce: z.string().optional(),
-  code: z.string(),
-  user_id: z.string(),
-  created_at: z.string(),
-  expires_at: z.string(),
-  used_at: z.string().optional(),
-});
-
-export type AuthenticationCode = z.infer<typeof authenticationCodeSchema>;

package/src/types/BaseEntity.ts

@@ -1,6 +0,0 @@
-import { z } from "@hono/zod-openapi";
-
-export const baseEntitySchema = z.object({
-  created_at: z.string(),
-  updated_at: z.string(),
-});

package/src/types/Branding.ts

@@ -1,26 +0,0 @@
-import { z } from "@hono/zod-openapi";
-
-export const brandingSchema = z.object({
-  colors: z
-    .object({
-      primary: z.string(),
-      page_background: z
-        .object({
-          type: z.string().optional(),
-          start: z.string().optional(),
-          end: z.string().optional(),
-          angle_deg: z.number().optional(),
-        })
-        .optional(),
-    })
-    .optional(),
-  logo_url: z.string().optional(),
-  favicon_url: z.string().optional(),
-  font: z
-    .object({
-      url: z.string(),
-    })
-    .optional(),
-});
-
-export type Branding = z.infer<typeof brandingSchema>;

package/src/types/Client.ts

@@ -1,51 +0,0 @@
-import { z } from "@hono/zod-openapi";
-import { connectionSchema } from "./Connection";
-
-const ClientDomainSchema = z.object({
-  domain: z.string(),
-  dkim_private_key: z.string().optional(),
-  dkim_public_key: z.string().optional(),
-  email_api_key: z.string().optional(),
-  email_service: z
-    .union([z.literal("mailgun"), z.literal("mailchannels")])
-    .optional(),
-});
-
-const BaseClientSchema = z.object({
-  id: z.string(),
-  name: z.string(),
-  domains: z.array(ClientDomainSchema),
-  allowed_callback_urls: z.array(z.string()),
-  allowed_logout_urls: z.array(z.string()),
-  allowed_web_origins: z.array(z.string()),
-  email_validation: z.union([
-    z.literal("enabled"),
-    z.literal("disabled"),
-    z.literal("enforced"),
-  ]),
-  tenant_id: z.string(),
-  client_secret: z.string(),
-  disable_sign_ups: z.boolean(),
-  tenant: z.object({
-    name: z.string(),
-    audience: z.string().optional(),
-    logo: z.string().optional(),
-    primary_color: z.string().optional(),
-    secondary_color: z.string().optional(),
-    sender_email: z.string(),
-    sender_name: z.string(),
-    support_url: z.string().optional(),
-    language: z.string().length(2).optional(),
-  }),
-});
-
-export const ClientSchema = BaseClientSchema.extend({
-  connections: z.array(connectionSchema),
-});
-
-export const PartialClientSchema = BaseClientSchema.extend({
-  connections: z.array(connectionSchema.partial()),
-});
-
-export type Client = z.infer<typeof ClientSchema>;
-export type PartialClient = z.infer<typeof PartialClientSchema>;

package/src/types/Code.ts

@@ -1,9 +0,0 @@
-export interface Code {
-  id: string;
-  code: string;
-  type: "password_reset" | "validation";
-  created_at: string;
-  expires_at: string;
-  used_at?: string;
-  user_id: string;
-}

package/src/types/Connection.ts

@@ -1,33 +0,0 @@
-import { z } from "@hono/zod-openapi";
-import {
-  AuthorizationResponseMode,
-  AuthorizationResponseType,
-} from "./AuthParams";
-
-export const connectionInsertSchema = z.object({
-  id: z.string().optional(),
-  name: z.string(),
-  client_id: z.string().optional(),
-  client_secret: z.string().optional(),
-  authorization_endpoint: z.string().optional(),
-  response_type: z.custom<AuthorizationResponseType>().optional(),
-  response_mode: z.custom<AuthorizationResponseMode>().optional(),
-  private_key: z.string().optional(),
-  kid: z.string().optional(),
-  team_id: z.string().optional(),
-  token_endpoint: z.string().optional(),
-  token_exchange_basic_auth: z.boolean().optional(),
-  userinfo_endpoint: z.string().optional(),
-  scope: z.string().optional(),
-});
-export type ConnectionInsert = z.infer<typeof connectionInsertSchema>;
-
-export const connectionSchema = z
-  .object({
-    id: z.string(),
-    created_at: z.string().transform((val) => (val === null ? "" : val)),
-    updated_at: z.string().transform((val) => (val === null ? "" : val)),
-  })
-  .extend(connectionInsertSchema.shape);
-
-export type Connection = z.infer<typeof connectionSchema>;

package/src/types/Domain.ts

@@ -1,17 +0,0 @@
-import { z } from "@hono/zod-openapi";
-import { baseEntitySchema } from "./BaseEntity";
-
-export const domainInsertSchema = z.object({
-  domain: z.string(),
-  dkim_private_key: z.string().optional(),
-  dkim_public_key: z.string().optional(),
-  email_api_key: z.string().optional(),
-  email_service: z.enum(["mailgun", "mailchannels"]),
-});
-export type DomainInsert = z.infer<typeof domainInsertSchema>;
-
-export const domainSchema = baseEntitySchema.extend({
-  ...domainInsertSchema.shape,
-  id: z.string(),
-});
-export type Domain = z.infer<typeof domainSchema>;

package/src/types/Hook.ts

@@ -1,17 +0,0 @@
-import { z } from "@hono/zod-openapi";
-import { baseEntitySchema } from "./BaseEntity";
-
-export const hookInsertSchema = z.object({
-  trigger_id: z.enum(["post-user-registration", "post-user-login"]),
-  enabled: z.boolean().default(false),
-  url: z.string(),
-  hook_id: z.string().optional(),
-});
-export type HookInsert = z.infer<typeof hookInsertSchema>;
-
-export const hookSchema = hookInsertSchema.extend({
-  ...baseEntitySchema.shape,
-  hook_id: z.string(),
-});
-
-export type Hook = z.infer<typeof hookSchema>;

package/src/types/JWKS.ts

@@ -1,37 +0,0 @@
-import { z } from "@hono/zod-openapi";
-
-export const jwksSchema = z.object({
-  alg: z.string(),
-  e: z.string(),
-  kid: z.string(),
-  kty: z.string(),
-  n: z.string(),
-  use: z.string().optional(),
-});
-
-export const jwksKeySchema = z.object({
-  keys: z.array(jwksSchema),
-});
-
-export const openIDConfigurationSchema = z.object({
-  issuer: z.string(),
-  authorization_endpoint: z.string(),
-  token_endpoint: z.string(),
-  device_authorization_endpoint: z.string(),
-  userinfo_endpoint: z.string(),
-  mfa_challenge_endpoint: z.string(),
-  jwks_uri: z.string(),
-  registration_endpoint: z.string(),
-  revocation_endpoint: z.string(),
-  scopes_supported: z.array(z.string()),
-  response_types_supported: z.array(z.string()),
-  code_challenge_methods_supported: z.array(z.string()),
-  response_modes_supported: z.array(z.string()),
-  subject_types_supported: z.array(z.string()),
-  id_token_signing_alg_values_supported: z.array(z.string()),
-  token_endpoint_auth_methods_supported: z.array(z.string()),
-  claims_supported: z.array(z.string()),
-  request_uri_parameter_supported: z.boolean(),
-  request_parameter_supported: z.boolean(),
-  token_endpoint_auth_signing_alg_values_supported: z.array(z.string()),
-});

package/src/types/LoginState.ts

@@ -1,8 +0,0 @@
-import { AuthParams } from "./AuthParams";
-
-export interface LoginState {
-  connection?: string;
-  authParams: AuthParams;
-  state: string;
-  errorMessage?: string;
-}