@authhero/adapter-interfaces 0.1.0 → 0.1.1

package/src/types/OTP.ts

@@ -1,26 +0,0 @@
-import {
-  AuthorizationResponseMode,
-  AuthorizationResponseType,
-} from "./AuthParams";
-
-export interface OTP {
-  id: string;
-  tenant_id: string;
-  client_id: string;
-  email: string;
-  code: string;
-  ip?: string;
-  send: "link" | "code";
-  authParams: {
-    nonce?: string;
-    state?: string;
-    scope?: string;
-    response_type?: AuthorizationResponseType;
-    response_mode?: AuthorizationResponseMode;
-    redirect_uri?: string;
-  };
-  created_at: Date;
-  expires_at: Date;
-  used_at?: string;
-  user_id?: string;
-}

package/src/types/Password.ts

@@ -1,9 +0,0 @@
-export interface PasswordResponse {
-  valid: boolean;
-  message: string;
-}
-
-export interface PasswordParams {
-  user_id: string;
-  password: string;
-}

package/src/types/Session.ts

@@ -1,10 +0,0 @@
-export interface Session {
-  id: string;
-  tenant_id: string;
-  client_id: string;
-  created_at: Date;
-  expires_at: Date;
-  used_at: Date;
-  deleted_at?: Date;
-  user_id: string;
-}

package/src/types/SigningKey.ts

@@ -1,55 +0,0 @@
-import { z } from "@hono/zod-openapi";
-
-export const certificateSchema = z.object({
-  private_key: z.string(),
-  public_key: z.string(),
-  kid: z.string(),
-  created_at: z.string(),
-  revoked_at: z.string().optional(),
-});
-
-export interface Certificate {
-  private_key: string;
-  public_key: string;
-  kid: string;
-  created_at: string;
-  revoked_at?: string;
-}
-
-export const signingKeySchema = z.object({
-  kid: z.string().openapi({ description: "The key id of the signing key" }),
-  cert: z
-    .string()
-    .openapi({ description: "The public certificate of the signing key" }),
-  fingerprint: z.string().openapi({ description: "The cert fingerprint" }),
-  thumbprint: z.string().openapi({ description: "The cert thumbprint" }),
-  pkcs7: z.string().optional().openapi({
-    description: "The public certificate of the signing key in pkcs7 format",
-  }),
-  current: z
-    .boolean()
-    .optional()
-    .openapi({ description: "True if the key is the current key" }),
-  next: z
-    .boolean()
-    .optional()
-    .openapi({ description: "True if the key is the next key" }),
-  previous: z
-    .boolean()
-    .optional()
-    .openapi({ description: "True if the key is the previous key" }),
-  current_since: z.string().optional().openapi({
-    description: "The date and time when the key became the current key",
-  }),
-  current_until: z.string().optional().openapi({
-    description: "The date and time when the current key was rotated",
-  }),
-  revoked: z
-    .boolean()
-    .optional()
-    .openapi({ description: "True if the key is revoked" }),
-  revoked_at: z
-    .string()
-    .optional()
-    .openapi({ description: "The date and time when the key was revoked" }),
-});

package/src/types/Tenant.ts

@@ -1,54 +0,0 @@
-import { z } from "@hono/zod-openapi";
-
-export const tenantInsertSchema = z.object({
-  name: z.string(),
-  audience: z.string(),
-  sender_email: z.string().email(),
-  sender_name: z.string(),
-  support_url: z.string().url().optional(),
-  logo: z.string().url().optional(),
-  primary_color: z.string().optional(),
-  secondary_color: z.string().optional(),
-  language: z.string().optional(),
-});
-
-export const tenantSchema = tenantInsertSchema.extend({
-  created_at: z.string().transform((val) => (val === null ? "" : val)),
-  updated_at: z.string().transform((val) => (val === null ? "" : val)),
-});
-
-export interface Tenant {
-  id: string;
-  name: string;
-  audience: string;
-  sender_email: string;
-  sender_name: string;
-  support_url?: string;
-  logo?: string;
-  primary_color?: string;
-  secondary_color?: string;
-  language?: string;
-  created_at: string;
-  updated_at: string;
-}
-
-export const vendorSettingsSchema = z.object({
-  logoUrl: z.string(),
-  loginBackgroundImage: z.string().nullish(),
-  style: z.object({
-    primaryColor: z.string(),
-    buttonTextColor: z.string(),
-    primaryHoverColor: z.string(),
-  }),
-  supportEmail: z.string().nullable(),
-  supportUrl: z.string().nullable(),
-  name: z.string(),
-  showGreyishBackground: z.boolean().optional(),
-  termsAndConditionsUrl: z.string().nullable(),
-  companyName: z.string().optional(),
-  checkoutHideSocial: z.boolean().optional(),
-  siteUrl: z.string().nullable(),
-  manageSubscriptionsUrl: z.string().optional(),
-});
-
-export type VendorSettings = z.infer<typeof vendorSettingsSchema>;

package/src/types/Ticket.ts

@@ -1,22 +0,0 @@
-import {
-  AuthorizationResponseMode,
-  AuthorizationResponseType,
-} from "./AuthParams";
-
-export interface Ticket {
-  id: string;
-  tenant_id: string;
-  client_id: string;
-  email: string;
-  authParams?: {
-    nonce?: string;
-    state?: string;
-    scope?: string;
-    response_type?: AuthorizationResponseType;
-    response_mode?: AuthorizationResponseMode;
-    redirect_uri?: string;
-  };
-  created_at: Date;
-  expires_at: Date;
-  used_at?: Date;
-}

package/src/types/Token.ts

@@ -1,75 +0,0 @@
-import { z } from "@hono/zod-openapi";
-
-export enum GrantType {
-  RefreshToken = "refresh_token",
-  AuthorizationCode = "authorization_code",
-  ClientCredential = "client_credentials",
-  Passwordless = "passwordless",
-  Password = "password",
-}
-
-const grantTypeSchema = z.nativeEnum(GrantType);
-
-const authorizationCodeGrantTypeParamsSchema = z.object({
-  grant_type: grantTypeSchema.refine(
-    (val) => val === GrantType.AuthorizationCode,
-  ),
-  code: z.string(),
-  client_secret: z.string(),
-  client_id: z.string(),
-});
-
-export type AuthorizationCodeGrantTypeParams = z.infer<
-  typeof authorizationCodeGrantTypeParamsSchema
->;
-
-const pkceAuthorizationCodeGrantTypeParamsSchema = z.object({
-  grant_type: grantTypeSchema.refine(
-    (val) => val === GrantType.AuthorizationCode,
-  ),
-  code: z.string(),
-  code_verifier: z.string(),
-  client_id: z.string().optional(),
-  redirect_uri: z.string(),
-});
-
-export type PKCEAuthorizationCodeGrantTypeParams = z.infer<
-  typeof pkceAuthorizationCodeGrantTypeParamsSchema
->;
-
-const clientCredentialGrantTypeParamsSchema = z.object({
-  grant_type: grantTypeSchema.refine(
-    (val) => val === GrantType.ClientCredential,
-  ),
-  scope: z.string().optional(),
-  client_secret: z.string(),
-  client_id: z.string(),
-  audience: z.string().optional(),
-});
-
-export type ClientCredentialsGrantTypeParams = z.infer<
-  typeof clientCredentialGrantTypeParamsSchema
->;
-
-const tokenResponseSchema = z.object({
-  access_token: z.string(),
-  id_token: z.string().optional(),
-  scope: z.string().optional(),
-  state: z.string().optional(),
-  refresh_token: z.string().optional(),
-  token_type: z.string(),
-  expires_in: z.number(),
-});
-export type TokenResponse = z.infer<typeof tokenResponseSchema>;
-
-const codeResponseSchema = z.object({
-  code: z.string(),
-  state: z.string().optional(),
-});
-export type CodeResponse = z.infer<typeof codeResponseSchema>;
-
-export {
-  authorizationCodeGrantTypeParamsSchema,
-  pkceAuthorizationCodeGrantTypeParamsSchema,
-  clientCredentialGrantTypeParamsSchema,
-};

package/src/types/User.ts

@@ -1,45 +0,0 @@
-import { z } from "@hono/zod-openapi";
-import { baseEntitySchema } from "./BaseEntity";
-import { identitySchema } from "./auth0/Identity";
-
-export const baseUserSchema = z.object({
-  email: z.string().optional(),
-  username: z.string().optional(),
-  given_name: z.string().optional(),
-  family_name: z.string().optional(),
-  nickname: z.string().optional(),
-  name: z.string().optional(),
-  picture: z.string().optional(),
-  locale: z.string().optional(),
-  linked_to: z.string().optional(),
-  profileData: z.string().optional(),
-  user_id: z.string().optional(),
-});
-
-export type BaseUser = z.infer<typeof baseUserSchema>;
-
-export const userInsertSchema = baseUserSchema.extend({
-  email_verified: z.boolean().default(false),
-  verify_email: z.boolean().optional(),
-  last_ip: z.string().optional(),
-  last_login: z.string().optional(),
-  user_id: z.string().optional(),
-  provider: z.string().default("email"),
-  connection: z.string().default("email"),
-});
-
-export const userSchema = userInsertSchema
-  .extend(baseEntitySchema.shape)
-  .extend({
-    user_id: z.string(),
-    // TODO: this not might be correct if you use the username
-    email: z.string(),
-    is_social: z.boolean(),
-    login_count: z.number(),
-    identities: z.array(identitySchema).optional(),
-  });
-
-export type User = z.infer<typeof userSchema>;
-
-// TODO: Add the login_count and other properties
-export const auth0UserResponseSchema = userSchema;

package/src/types/auth0/Identity.ts

@@ -1,27 +0,0 @@
-import { z } from "@hono/zod-openapi";
-
-export const profileDataSchema = z
-  .object({
-    email: z.string().optional(),
-    email_verified: z.boolean().optional(),
-    name: z.string().optional(),
-    username: z.string().optional(),
-    given_name: z.string().optional(),
-    phone_number: z.string().optional(),
-    phone_verified: z.boolean().optional(),
-    family_name: z.string().optional(),
-  })
-  .catchall(z.any());
-
-export const identitySchema = z.object({
-  connection: z.string(),
-  user_id: z.string(),
-  provider: z.string(),
-  isSocial: z.boolean(),
-  access_token: z.string().optional(),
-  access_token_secret: z.string().optional(),
-  refresh_token: z.string().optional(),
-  profileData: profileDataSchema.optional(),
-});
-
-export type Identity = z.infer<typeof identitySchema>;

package/src/types/auth0/LogsResponse.ts

@@ -1,90 +0,0 @@
-import { z } from "@hono/zod-openapi";
-
-export enum LogTypes {
-  SUCCESS_API_OPERATION = "sapi",
-  //
-  SUCCESS_SILENT_AUTH = "ssa",
-  FAILED_SILENT_AUTH = "fsa",
-  //
-  SUCCESS_SIGNUP = "ss",
-  FAILED_SIGNUP = "fs",
-  //
-  SUCCESS_LOGIN = "s",
-  FAILED_LOGIN = "f",
-  FAILED_LOGIN_INCORRECT_PASSWORD = "fp",
-  // we don't have this in the logs yet
-  // FAILED_LOGIN_INVALID_EMAIL_USERNAME = "fu",
-  //
-  SUCCESS_LOGOUT = "slo",
-  SUCCESS_CROSS_ORIGIN_AUTHENTICATION = "scoa",
-  FAILED_CROSS_ORIGIN_AUTHENTICATION = "fcoa",
-  SUCCESS_EXCHANGE_AUTHORIZATION_CODE_FOR_ACCESS_TOKEN = "seacft",
-  SUCCESS_EXCHANGE_REFRESH_TOKEN_FOR_ACCESS_TOKEN = "serft",
-  CODE_LINK_SENT = "cls",
-  // TODO - not implemented - just for completion as we do get this in our latest auth0 logs
-  NOT_IMPLEMENTED_1 = "seccft",
-}
-
-// Enum for LogTypes
-const LogType = z.enum([
-  "sapi", // SUCCESS_API_OPERATION
-  "ssa", // SUCCESS_SILENT_AUTH - omitted for brevity and since it's clear from context
-  "fsa", // FAILED_SILENT_AUTH
-  "ss", // SUCCESS_SIGNUP
-  "ssa", /// SUCCESS_SILENT_AUTH
-  "fs",
-  "s", // SUCCESS_LOGIN
-  "f", // FAILED_LOGIN
-  "fp", // FAILED_LOGIN_INCORRECT_PASSWORD
-  // FAILED_LOGIN_INVALID_EMAIL_USERNAME = "fu", - we don't have this in the logs yet
-  "slo", // SUCCESS_LOGOUT
-  "scoa", // SUCCESS_CROSS_ORIGIN_AUTHENTICATION
-  "fcoa", // FAILED_CROSS_ORIGIN_AUTHENTICATION
-  "seccft", // NOT_IMPLEMENTED_1 - not implemented - just for completion as we do get this in our latest auth0 logs
-  "cls", // NOT_IMPLEMENTED_2
-  "seacft", // SUCCESS_EXCHANGE_AUTHORIZATION_CODE_FOR_ACCESS_TOKEN
-  "serft",
-]);
-
-export type LogType = z.infer<typeof LogType>;
-
-export const Auth0Client = z.object({
-  name: z.string(),
-  version: z.string(),
-  env: z
-    .object({
-      node: z.string().optional(),
-    })
-    .optional(),
-});
-
-export const logSchema = z.object({
-  type: LogType,
-  date: z.string(),
-  description: z.string().optional(),
-  log_id: z.string().optional(),
-  _id: z.string().optional(),
-  ip: z.string(),
-  user_agent: z.string(),
-  details: z.any().optional(), // Using z.any() as a placeholder for "details" type
-  isMobile: z.boolean(),
-  user_id: z.string().optional(),
-  user_name: z.string().optional(),
-  connection: z.string().optional(),
-  connection_id: z.string().optional(),
-  client_id: z.string().optional(),
-  client_name: z.string().optional(),
-  audience: z.string().optional(),
-  scope: z.array(z.string()).optional(),
-  strategy: z.string().optional(),
-  strategy_type: z.string().optional(),
-  hostname: z.string().optional(),
-  auth0_client: Auth0Client.optional(),
-});
-
-export type Log = z.infer<typeof logSchema>;
-
-export type LogsResponse = Log & {
-  log_id: string;
-  _id: string;
-};

package/src/types/auth0/Query.ts

@@ -1,42 +0,0 @@
-import { z } from "@hono/zod-openapi";
-
-export const auth0QuerySchema = z.object({
-  page: z
-    .string()
-    .min(0)
-    .optional()
-    .default("0")
-    .transform((p) => parseInt(p, 10))
-    .openapi({
-      description: "The page number where 0 is the first page",
-    }),
-  per_page: z
-    .string()
-    .min(1)
-    .optional()
-    .default("10")
-    .transform((p) => parseInt(p, 10))
-    .openapi({
-      description: "The number of items per page",
-    }),
-  include_totals: z
-    .string()
-    .optional()
-    .default("false")
-    .transform((it) => it === "true")
-    .openapi({
-      description:
-        "If the total number of items should be included in the response",
-    }),
-  sort: z
-    .string()
-    .regex(/^.+:(-1|1)$/)
-    .optional()
-    .openapi({
-      description:
-        "A property that should have the format 'string:-1' or 'string:1'",
-    }),
-  q: z.string().optional().openapi({
-    description: "A lucene query string used to filter the results",
-  }),
-});

package/src/types/auth0/Totals.ts

@@ -1,13 +0,0 @@
-import { z } from "@hono/zod-openapi";
-
-export const totalsSchema = z.object({
-  start: z.number(),
-  limit: z.number(),
-  length: z.number(),
-});
-
-export interface Totals {
-  start: number;
-  limit: number;
-  length: number;
-}

package/src/types/auth0/UserResponse.ts

@@ -1,24 +0,0 @@
-import { z } from "@hono/zod-openapi";
-import { BaseUser, baseUserSchema } from "../User";
-
-export interface PostUsersBody extends BaseUser {
-  password?: string;
-  // Whether this user will receive a verification email after creation (true) or no email (false). Overrides behavior of email_verified parameter.
-  verify_email?: boolean;
-  username?: string;
-  connection?: string;
-  email_verified?: boolean;
-}
-
-export const userResponseSchema = baseUserSchema
-  .extend({
-    email: z.string(),
-    login_count: z.number(),
-    multifactor: z.array(z.string()).optional(),
-    last_ip: z.string().optional(),
-    last_login: z.string().optional(),
-    user_id: z.string(),
-  })
-  .catchall(z.any());
-
-export type UserResponse = z.infer<typeof userResponseSchema>;

package/src/types/auth0/index.ts

@@ -1,3 +0,0 @@
-export * from "./Totals";
-export * from "./UserResponse";
-export * from "./LogsResponse";

package/src/types/index.ts

@@ -1,20 +0,0 @@
-export * from "./Application";
-export * from "./AuthenticationCode";
-export * from "./AuthParams";
-export * from "./Token";
-export * from "./LoginState";
-export * from "./Client";
-export * from "./Token";
-export * from "./SigningKey";
-export * from "./Session";
-export * from "./OTP";
-export * from "./Ticket";
-export * from "./Code";
-export * from "./Password";
-export * from "./User";
-export * from "./auth0";
-export * from "./Branding";
-export * from "./Domain";
-export * from "./Hook";
-export * from "./Tenant";
-export * from "./Connection";

package/tsconfig.json

@@ -1,9 +0,0 @@
-{
-  "extends": "../../tsconfig.json",
-  "compilerOptions": {
-    // "noEmit": true,
-    "baseUrl": "."
-  },
-  "include": ["src"],
-  "references": [{ "path": "./tsconfig.node.json" }]
-}

package/tsconfig.node.json

@@ -1,4 +0,0 @@
-{
-  "extends": "../../tsconfig.node.json",
-  "include": ["vite.config.ts"]
-}