@civic/auth 0.0.1-beta.29 → 0.0.1-beta.3

package/dist/types-DOfl9w7j.d.ts

@@ -1,23 +0,0 @@
-declare enum OAuthTokens {
-    ID_TOKEN = "id_token",
-    ACCESS_TOKEN = "access_token",
-    REFRESH_TOKEN = "refresh_token"
-}
-declare enum CodeVerifier {
-    COOKIE_NAME = "code_verifier",
-    APP_URL = "app_url"
-}
-declare enum UserStorage {
-    USER = "user"
-}
-interface CookieConfig {
-    secure?: boolean;
-    sameSite?: "strict" | "lax" | "none";
-    domain?: string;
-    path?: string;
-    maxAge?: number;
-    httpOnly?: boolean;
-}
-type TokensCookieConfig = Record<OAuthTokens | CodeVerifier, CookieConfig>;
-
-export { CodeVerifier as C, OAuthTokens as O, type TokensCookieConfig as T, UserStorage as U, type CookieConfig as a };

package/dist/types-HdCjGldB.d.mts

@@ -1,58 +0,0 @@
-import { TokenResponseBody } from 'oslo/oauth2';
-
-type UnknownObject = Record<string, unknown>;
-type EmptyObject = Record<string, never>;
-type DisplayMode = "iframe" | "redirect" | "new_tab" | "custom_tab";
-type Endpoints = {
-    jwks: string;
-    auth: string;
-    token: string;
-    userinfo: string;
-    challenge?: string;
-};
-type Config = {
-    oauthServer: string;
-    endpoints?: Endpoints;
-};
-type SessionData = {
-    authenticated: boolean;
-    state?: string;
-    accessToken?: string;
-    refreshToken?: string;
-    idToken?: string;
-    timestamp?: number;
-    expiresIn?: number;
-    codeVerifier?: string;
-    displayMode?: DisplayMode;
-    openerUrl?: string;
-};
-type OIDCTokenResponseBody = TokenResponseBody & {
-    id_token: string;
-};
-type ForwardedTokens = Record<string, {
-    idToken?: string;
-    accessToken?: string;
-    refreshToken?: string;
-}>;
-type Tokens = {
-    idToken: string;
-    accessToken: string;
-    refreshToken: string;
-    forwardedTokens: ForwardedTokens;
-};
-type BaseUser = {
-    id: string;
-    email?: string;
-    name?: string;
-    given_name?: string;
-    family_name?: string;
-    picture?: string;
-    updated_at?: Date;
-};
-type User<T extends UnknownObject = EmptyObject> = BaseUser & Partial<Tokens> & T;
-interface AuthStorage {
-    get(key: string): string | null;
-    set(key: string, value: string): void;
-}
-
-export type { AuthStorage as A, Config as C, DisplayMode as D, Endpoints as E, ForwardedTokens as F, OIDCTokenResponseBody as O, SessionData as S, Tokens as T, User as U, UnknownObject as a, EmptyObject as b };

package/dist/types-HdCjGldB.d.ts

@@ -1,58 +0,0 @@
-import { TokenResponseBody } from 'oslo/oauth2';
-
-type UnknownObject = Record<string, unknown>;
-type EmptyObject = Record<string, never>;
-type DisplayMode = "iframe" | "redirect" | "new_tab" | "custom_tab";
-type Endpoints = {
-    jwks: string;
-    auth: string;
-    token: string;
-    userinfo: string;
-    challenge?: string;
-};
-type Config = {
-    oauthServer: string;
-    endpoints?: Endpoints;
-};
-type SessionData = {
-    authenticated: boolean;
-    state?: string;
-    accessToken?: string;
-    refreshToken?: string;
-    idToken?: string;
-    timestamp?: number;
-    expiresIn?: number;
-    codeVerifier?: string;
-    displayMode?: DisplayMode;
-    openerUrl?: string;
-};
-type OIDCTokenResponseBody = TokenResponseBody & {
-    id_token: string;
-};
-type ForwardedTokens = Record<string, {
-    idToken?: string;
-    accessToken?: string;
-    refreshToken?: string;
-}>;
-type Tokens = {
-    idToken: string;
-    accessToken: string;
-    refreshToken: string;
-    forwardedTokens: ForwardedTokens;
-};
-type BaseUser = {
-    id: string;
-    email?: string;
-    name?: string;
-    given_name?: string;
-    family_name?: string;
-    picture?: string;
-    updated_at?: Date;
-};
-type User<T extends UnknownObject = EmptyObject> = BaseUser & Partial<Tokens> & T;
-interface AuthStorage {
-    get(key: string): string | null;
-    set(key: string, value: string): void;
-}
-
-export type { AuthStorage as A, Config as C, DisplayMode as D, Endpoints as E, ForwardedTokens as F, OIDCTokenResponseBody as O, SessionData as S, Tokens as T, User as U, UnknownObject as a, EmptyObject as b };

package/dist/vitest.config.d.ts

@@ -1,3 +0,0 @@
-declare const _default: import("vite").UserConfig;
-export default _default;
-//# sourceMappingURL=vitest.config.d.ts.map

package/dist/vitest.config.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"vitest.config.d.ts","sourceRoot":"","sources":["../vitest.config.ts"],"names":[],"mappings":";AAIA,wBAoCG"}

package/dist/vitest.config.js

@@ -1,40 +0,0 @@
-/// <reference types='vitest' />
-import { defineConfig } from "vite";
-import path from "path";
-export default defineConfig({
-    resolve: {
-        alias: {
-            "@": path.resolve(__dirname, "./src"),
-        },
-    },
-    test: {
-        globals: true,
-        environment: "jsdom",
-        include: ["test/**/*.{test,spec}.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"],
-        env: {
-            NODE_ENV: "development",
-        },
-        reporters: ["default"],
-        coverage: {
-            exclude: [
-                "**/node_modules/**",
-                "**/dist/**",
-                "**/build/**",
-                "postcss.config.cjs",
-                "tailwind.config.js",
-                ".eslintrc.js",
-                "tsup.config.ts",
-                "vitest.config.ts",
-            ],
-            reportsDirectory: "../../coverage/apps/civic-auth-client",
-            provider: "v8",
-            thresholds: {
-                lines: 80,
-                functions: 70,
-                branches: 85,
-                statements: 80,
-            },
-        },
-    },
-});
-//# sourceMappingURL=vitest.config.js.map

package/dist/vitest.config.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"vitest.config.js","sourceRoot":"","sources":["../vitest.config.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AACpC,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB,eAAe,YAAY,CAAC;IAC1B,OAAO,EAAE;QACP,KAAK,EAAE;YACL,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC;SACtC;KACF;IAED,IAAI,EAAE;QACJ,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,OAAO;QACpB,OAAO,EAAE,CAAC,uDAAuD,CAAC;QAClE,GAAG,EAAE;YACH,QAAQ,EAAE,aAAa;SACxB;QACD,SAAS,EAAE,CAAC,SAAS,CAAC;QACtB,QAAQ,EAAE;YACR,OAAO,EAAE;gBACP,oBAAoB;gBACpB,YAAY;gBACZ,aAAa;gBACb,oBAAoB;gBACpB,oBAAoB;gBACpB,cAAc;gBACd,gBAAgB;gBAChB,kBAAkB;aACnB;YACD,gBAAgB,EAAE,uCAAuC;YACzD,QAAQ,EAAE,IAAI;YACd,UAAU,EAAE;gBACV,KAAK,EAAE,EAAE;gBACT,SAAS,EAAE,EAAE;gBACb,QAAQ,EAAE,EAAE;gBACZ,UAAU,EAAE,EAAE;aACf;SACF;KACF;CACF,CAAC,CAAC","sourcesContent":["/// <reference types='vitest' />\nimport { defineConfig } from \"vite\";\nimport path from \"path\";\n\nexport default defineConfig({\n  resolve: {\n    alias: {\n      \"@\": path.resolve(__dirname, \"./src\"),\n    },\n  },\n\n  test: {\n    globals: true,\n    environment: \"jsdom\",\n    include: [\"test/**/*.{test,spec}.{js,mjs,cjs,ts,mts,cts,jsx,tsx}\"],\n    env: {\n      NODE_ENV: \"development\",\n    },\n    reporters: [\"default\"],\n    coverage: {\n      exclude: [\n        \"**/node_modules/**\",\n        \"**/dist/**\",\n        \"**/build/**\",\n        \"postcss.config.cjs\",\n        \"tailwind.config.js\",\n        \".eslintrc.js\",\n        \"tsup.config.ts\",\n        \"vitest.config.ts\",\n      ],\n      reportsDirectory: \"../../coverage/apps/civic-auth-client\",\n      provider: \"v8\",\n      thresholds: {\n        lines: 80,\n        functions: 70,\n        branches: 85,\n        statements: 80,\n      },\n    },\n  },\n});\n"]}

package/src/browser/storage.ts

@@ -1,11 +0,0 @@
-import type { AuthStorage } from "@/types.js";
-
-export class LocalStorageAdapter implements AuthStorage {
-  async get(key: string): Promise<string> {
-    return Promise.resolve(localStorage.getItem(key) || "");
-  }
-
-  async set(key: string, value: string): Promise<void> {
-    localStorage.setItem(key, value);
-  }
-}

package/src/config.ts

@@ -1,6 +0,0 @@
-import type { Config } from "@/types.js";
-import { DEFAULT_AUTH_SERVER } from "./constants.js";
-
-export const authConfig: Config = {
-  oauthServer: DEFAULT_AUTH_SERVER,
-};

package/src/constants.ts

@@ -1,29 +0,0 @@
-const DEFAULT_SCOPES = [
-  "openid",
-  "profile",
-  "email",
-  "forwardedTokens",
-  "offline_access",
-];
-const IFRAME_ID = "civic-auth-iframe";
-
-const DEFAULT_AUTH_SERVER = "https://auth.civic.com/oauth";
-
-const DEFAULT_OAUTH_GET_PARAMS = ["code", "state", "iss"];
-
-// The server's callback handler renders this text if it needs the front-end to make an additional token exchange call,
-// for the iframe case where cookies are not sent along with the initial redirect.
-const TOKEN_EXCHANGE_TRIGGER_TEXT = "sameDomainCodeExchangeRequired";
-
-const TOKEN_EXCHANGE_SUCCESS_TEXT = "serverSideTokenExchangeSuccess";
-
-const DEFAULT_DISPLAY_MODE = "iframe";
-export {
-  DEFAULT_SCOPES,
-  DEFAULT_OAUTH_GET_PARAMS,
-  DEFAULT_DISPLAY_MODE,
-  IFRAME_ID,
-  DEFAULT_AUTH_SERVER,
-  TOKEN_EXCHANGE_TRIGGER_TEXT,
-  TOKEN_EXCHANGE_SUCCESS_TEXT,
-};

package/src/index.ts

@@ -1,16 +0,0 @@
-// These are the default exports of the project.
-// They are limited by design to ensure that the public API does not expose any internal implementation details.
-// Do not change this without thinking carefully about the impact on the client-facing public API.
-export type {
-  Tokens,
-  Endpoints,
-  Config,
-  User,
-  DisplayMode,
-  ForwardedTokens,
-  AuthStorage,
-} from "@/types.js";
-
-export type * from "@/shared/lib/types.js";
-
-export type { UserContextType } from "@/shared/providers/UserProvider.js";

package/src/lib/cookies.ts

@@ -1,28 +0,0 @@
-const getWindowCookieValue = ({
-  key,
-  window,
-  parseJson = false,
-}: {
-  key: string;
-  window: Window;
-  parseJson?: boolean;
-}) => {
-  const cookie = window.document.cookie;
-  if (!cookie) return null;
-  const cookies = cookie.split(";");
-  for (const c of cookies) {
-    const [name, value] = c.trim().split("=");
-    if (value && name === key) {
-      try {
-        const decodeURIComponentValue = decodeURIComponent(value);
-        return parseJson
-          ? JSON.parse(decodeURIComponentValue)
-          : decodeURIComponentValue;
-      } catch {
-        return value;
-      }
-    }
-  }
-  return null;
-};
-export { getWindowCookieValue };

package/src/lib/jwt.ts

@@ -1,15 +0,0 @@
-import type { ForwardedTokens, ForwardedTokensJWT } from "@/types.js";
-
-export const convertForwardedTokenFormat = (
-  inputTokens: ForwardedTokensJWT,
-): ForwardedTokens =>
-  Object.fromEntries(
-    Object.entries(inputTokens).map(([source, tokens]) => [
-      source,
-      {
-        idToken: tokens?.id_token,
-        accessToken: tokens?.access_token,
-        refreshToken: tokens?.refresh_token,
-      },
-    ]),
-  );

package/src/lib/logger.ts

@@ -1,72 +0,0 @@
-import debug from "debug";
-
-const PACKAGE_NAME = "@civic/auth";
-
-export interface Logger {
-  debug(message: string, ...args: unknown[]): void;
-  info(message: string, ...args: unknown[]): void;
-  warn(message: string, ...args: unknown[]): void;
-  error(message: string, ...args: unknown[]): void;
-}
-
-class DebugLogger implements Logger {
-  private debugLogger: debug.Debugger;
-  private infoLogger: debug.Debugger;
-  private warnLogger: debug.Debugger;
-  private errorLogger: debug.Debugger;
-
-  constructor(namespace: string) {
-    // Format: @org/package:library:component:level
-    this.debugLogger = debug(`${PACKAGE_NAME}:${namespace}:debug`);
-    this.infoLogger = debug(`${PACKAGE_NAME}:${namespace}:info`);
-    this.warnLogger = debug(`${PACKAGE_NAME}:${namespace}:warn`);
-    this.errorLogger = debug(`${PACKAGE_NAME}:${namespace}:error`);
-
-    this.debugLogger.color = "4";
-    this.infoLogger.color = "2";
-    this.warnLogger.color = "3";
-    this.errorLogger.color = "1";
-  }
-
-  debug(message: string, ...args: unknown[]): void {
-    this.debugLogger(message, ...args);
-  }
-
-  info(message: string, ...args: unknown[]): void {
-    this.infoLogger(message, ...args);
-  }
-
-  warn(message: string, ...args: unknown[]): void {
-    this.warnLogger(message, ...args);
-  }
-
-  error(message: string, ...args: unknown[]): void {
-    this.errorLogger(message, ...args);
-  }
-}
-
-export const createLogger = (namespace: string): Logger =>
-  new DebugLogger(namespace);
-
-// Pre-configured loggers for different parts of your package
-export const loggers = {
-  // Next.js specific loggers
-  nextjs: {
-    routes: createLogger("api:routes"),
-    middleware: createLogger("api:middleware"),
-    handlers: {
-      auth: createLogger("api:handlers:auth"),
-    },
-  },
-  // React specific loggers
-  react: {
-    components: createLogger("react:components"),
-    hooks: createLogger("react:hooks"),
-    context: createLogger("react:context"),
-  },
-  // Shared utilities loggers
-  services: {
-    validation: createLogger("utils:validation"),
-    network: createLogger("utils:network"),
-  },
-} as const;

package/src/lib/oauth.ts

@@ -1,83 +0,0 @@
-import type { DisplayMode, Endpoints, OpenIdConfiguration } from "@/types.js";
-import { v4 as uuid } from "uuid";
-
-const getIssuerVariations = (issuer: string): string[] => {
-  const issuerWithoutSlash = issuer.endsWith("/")
-    ? issuer.slice(0, issuer.length - 1)
-    : issuer;
-
-  const issuerWithSlash = `${issuerWithoutSlash}/`;
-
-  return [issuerWithoutSlash, issuerWithSlash];
-};
-
-const addSlashIfNeeded = (url: string): string =>
-  url.endsWith("/") ? url : `${url}/`;
-
-const getOauthEndpoints = async (oauthServer: string): Promise<Endpoints> => {
-  const openIdConfigResponse = await fetch(
-    `${addSlashIfNeeded(oauthServer)}.well-known/openid-configuration`,
-  );
-  const openIdConfig =
-    (await openIdConfigResponse.json()) as OpenIdConfiguration;
-  return {
-    jwks: openIdConfig.jwks_uri,
-    auth: openIdConfig.authorization_endpoint,
-    token: openIdConfig.token_endpoint,
-    userinfo: openIdConfig.userinfo_endpoint,
-  };
-};
-
-/**
- * creates a state string for the OAuth2 flow, encoding the display mode too for future use
- * @param {DisplayMode} displayMode
- * @returns {string}
- */
-const generateState = (
-  displayMode: DisplayMode,
-  serverTokenExchange?: boolean,
-): string => {
-  const jsonString = JSON.stringify({
-    uuid: uuid(),
-    displayMode,
-    ...(serverTokenExchange ? { serverTokenExchange } : {}),
-  });
-  return btoa(jsonString);
-};
-
-/**
- * parses the state string from the OAuth2 flow, decoding the display mode too
- * @param state
- * @param sessionDisplayMode
- * @returns { uuid: string, displayMode: DisplayMode }
- */
-const displayModeFromState = (
-  state: string,
-  sessionDisplayMode: DisplayMode | undefined,
-): DisplayMode | undefined => {
-  try {
-    const jsonString = atob(state);
-    return JSON.parse(jsonString).displayMode;
-  } catch (e) {
-    console.error("Failed to parse displayMode from state:", state, e);
-    return sessionDisplayMode;
-  }
-};
-
-const serverTokenExchangeFromState = (state: string): boolean | undefined => {
-  try {
-    const jsonString = atob(state);
-    return JSON.parse(jsonString).serverTokenExchange;
-  } catch {
-    console.error("Failed to parse serverTokenExchange from state:", state);
-    return undefined;
-  }
-};
-
-export {
-  serverTokenExchangeFromState,
-  getIssuerVariations,
-  getOauthEndpoints,
-  displayModeFromState,
-  generateState,
-};

package/src/lib/postMessage.ts

@@ -1,22 +0,0 @@
-import type { LoginPostMessage } from "@/types.js";
-
-const validateLoginAppPostMessage = (
-  event: LoginPostMessage,
-  clientId: string,
-): boolean => {
-  const caseEvent = event as LoginPostMessage;
-  console.log("caseEvent", caseEvent);
-  if (
-    !caseEvent.clientId ||
-    !caseEvent.data.url ||
-    !caseEvent.source ||
-    !caseEvent.type ||
-    caseEvent.clientId !== clientId ||
-    caseEvent.source !== "civicloginApp"
-  ) {
-    return false;
-  }
-  return true;
-};
-
-export { validateLoginAppPostMessage };

package/src/lib/windowUtil.ts

@@ -1,29 +0,0 @@
-const isWindowInIframe = (window: Window): boolean => {
-  if (typeof window !== "undefined") {
-    // use the window width to determine if we're in an iframe or not
-    try {
-      if (window?.frameElement?.id === "civic-auth-iframe") {
-        return true;
-      }
-      // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    } catch (_e) {
-      // If we get an error, we're not in an iframe
-      return false;
-    }
-  }
-  return false;
-};
-
-const removeParamsWithoutReload = (paramsToRemove: string[]) => {
-  const url = new URL(window.location.href);
-  paramsToRemove.forEach((param: string) => {
-    url.searchParams.delete(param);
-  });
-  try {
-    window.history.replaceState({}, "", url);
-  } catch (error) {
-    console.warn("window.history.replaceState failed", error);
-  }
-};
-
-export { isWindowInIframe, removeParamsWithoutReload };

package/src/nextjs/GetUser.ts

@@ -1,22 +0,0 @@
-/**
- * Used on the server-side to get the user object from the cookie
- */
-import type { User } from "@/types.js";
-import { GenericUserSession } from "@/shared/lib/UserSession.js";
-import { NextjsClientStorage } from "@/nextjs/cookies.js";
-import { retrieveTokens } from "@/shared/lib/util.js";
-
-export const getUser = async (): Promise<User | null> => {
-  const clientStorage = new NextjsClientStorage();
-  const userSession = new GenericUserSession(clientStorage);
-  const tokens = await retrieveTokens(clientStorage);
-  const user = await userSession.get();
-  if (!user || !tokens) return null;
-
-  return {
-    ...user!,
-    idToken: tokens.id_token,
-    accessToken: tokens.access_token,
-    refreshToken: tokens.refresh_token ?? "",
-  } as User;
-};