@usesoftwareau/jwt-state 1.0.0

package/src/hooks.ts

@@ -0,0 +1,98 @@
+import { usePrevious } from "@usesoftwareau/react-utils";
+import { _useJWTState } from "./common";
+import { JWTReducerState } from "./reducer";
+
+/**
+ * Type representing the authentication readiness state obtained from the JWT reducer state.
+ */
+type AuthReadyFromContext = JWTReducerState<any>["authReady"];
+
+/**
+ * Hook to access the authentication readiness state.
+ * @returns Authentication readiness state from the JWT reducer state.
+ */
+export function _useAuthReady(): AuthReadyFromContext {
+  return _useJWTState()[0].authReady;
+}
+
+/**
+ * Type representing the claims obtained from the JWT reducer state.
+ */
+type ClaimsFromContext<CustomClaims extends Record<string, any>> = JWTReducerState<CustomClaims>["claims"];
+
+/**
+ * Hook to access the claims from the JWT reducer state.
+ * @param assert - Optional parameter to assert if claims are present.
+ * @returns Claims from the JWT reducer state.
+ * @example
+ * ```tsx
+ * // Custom claims used throughout the app
+ * declare global {
+ *  interface CustomClaims {
+ *    created: string;
+ *    dbid: string;
+ *    email: string;
+ *    email_verified: boolean;
+ *    mobile: string;
+ *    admin?: boolean | string;
+ *    banned?: string;
+ *  }
+ * }
+ * // Local, app specific useClaims hook with the custom claims applied
+ * export const useClaims = <Assert extends boolean>(assert?: Assert) => _useClaims<Assert, CustomClaims>(assert);
+ * 
+ * // Access the user's claims object in a screen
+ * const claims = useClaims();
+ * ```
+ */
+export function _useClaims<T extends boolean, CustomClaims extends Record<string, any> = Record<string, any>>(assert?: T) {
+  const claims = _useJWTState<CustomClaims>()[0].claims;
+
+  const prevClaims = usePrevious(claims);
+  const selectedClaims = claims ?? prevClaims;
+  if (assert && !selectedClaims) {
+    throw new Error("(useJWTState) Claims were not present during assertion.");
+  }
+  return selectedClaims as T extends true ? NonNullable<ClaimsFromContext<CustomClaims>> : ClaimsFromContext<CustomClaims>;
+}
+
+/**
+ * Type representing the token obtained from the JWT reducer state.
+ */
+type TokenFromContext = JWTReducerState<any>["token"];
+
+/**
+ * Hook to access the token from the JWT reducer state.
+ * @param assert - Optional parameter to assert if token is present.
+ * @returns Token from the JWT reducer state.
+ * @example
+ * ```tsx
+ * // Custom claims used throughout the app
+ * declare global {
+ *  interface CustomClaims {
+ *    created: string;
+ *    dbid: string;
+ *    email: string;
+ *    email_verified: boolean;
+ *    mobile: string;
+ *    admin?: boolean | string;
+ *    banned?: string;
+ *  }
+ * }
+ * // Local, app specific useClaims hook with the custom claims applied
+ * export const useToken = <Assert extends boolean>(assert?: Assert) => _useToken<Assert, CustomClaims>(assert);
+ * 
+ * // Access the user's token in a screen
+ * const token = useToken();
+ * ```
+ */
+export function _useToken<T extends boolean, CustomClaims extends Record<string, any> = Record<string, any>>(assert?: T) {
+  const token = _useJWTState<CustomClaims>()[0].token;
+
+  const prevToken = usePrevious(token);
+  const selectedToken = token ?? prevToken;
+  if (assert && typeof selectedToken !== "string") {
+    throw new Error("(useJWTState) Token was not present during assertion.");
+  }
+  return selectedToken as T extends true ? NonNullable<TokenFromContext> : TokenFromContext;
+}

package/src/index.tsx

@@ -0,0 +1,4 @@
+
+export * from "./common"
+
+export * from "./hooks";

package/src/reducer.ts

@@ -0,0 +1,98 @@
+import { ActionsWithBatching } from "@usesoftwareau/react-utils";
+
+/**
+ * Interface representing the standard claims type.
+ */
+export interface _ClaimsType {
+  aud: string;
+  exp: number;
+  iat: number;
+  iss: string;
+  sub: string;
+}
+ 
+/**
+ * Interface representing the state of the JWT reducer.
+ */
+export interface JWTReducerState<CustomClaims extends Record<string, any> = Record<string, any>> {
+  authReady: boolean;
+  claims: (_ClaimsType & CustomClaims) | null;
+  token: string | null;
+}
+
+/**
+ * Action interface to set the authentication readiness value.
+ */
+interface SetAuthReadyValueAction {
+  type: "SET_AUTH_READY_VALUE";
+  payload: JWTReducerState["authReady"];
+}
+
+/**
+ * Action interface to set the token value.
+ */
+interface SetTokenValueAction {
+  type: "SET_TOKEN_VALUE";
+  payload: JWTReducerState["token"];
+}
+
+/**
+ * Action interface to set the claims value.
+ */
+interface SetClaimsValueAction<CustomClaims extends Record<string, any> = Record<string, any>> {
+  type: "SET_CLAIMS_VALUE";
+  payload: JWTReducerState<CustomClaims>["claims"];
+}
+
+/**
+ * Base action types for the JWT reducer.
+ */
+type ReducerBaseActions<CustomClaims extends Record<string, any> = Record<string, any>> =
+  | SetAuthReadyValueAction
+  | SetClaimsValueAction<CustomClaims>
+  | SetTokenValueAction;
+
+/**
+ * All possible action types for the JWT reducer.
+ */
+type ReducerAllActions<CustomClaims extends Record<string, any>> = ActionsWithBatching<ReducerBaseActions<CustomClaims>>;
+
+/**
+ * Type representing all actions for the JWT reducer.
+ */
+export type JWTReducerActions<CustomClaims extends Record<string, any> = Record<string, any>> = ReducerAllActions<CustomClaims>;
+
+/**
+ * Reducer function to handle JWT reducer actions.
+ */
+export function reducerHandler<CustomClaims extends Record<string, any>>(prev: JWTReducerState<CustomClaims>, action: JWTReducerActions<CustomClaims>, originalPrev?: JWTReducerState<CustomClaims>): JWTReducerState<CustomClaims> {
+  const isSubAction = !!originalPrev;
+  const newState = isSubAction ? prev : { ...prev };
+  switch(action.type) {
+    case "MULTIPLE":
+      for(const subAction of action.payload) {
+        reducerHandler(newState, subAction, prev);
+      }
+      break;
+    case "SET_AUTH_READY_VALUE":
+      newState.authReady = action.payload;
+      break;
+    case "SET_TOKEN_VALUE": {
+      newState.token = action.payload ?? null;
+      break;
+    }
+    case "SET_CLAIMS_VALUE":
+      newState.claims = action.payload;
+      break;
+  }
+  return newState;
+}
+
+/**
+ * Initial state for the JWT reducer.
+ */
+export const initialJWTReducerState: JWTReducerState<any> = {
+  authReady: false,
+  claims: null,
+  token: null
+};

package/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "extends": "@tsconfig/react-native/tsconfig.json",
+  "compilerOptions": {
+    "module": "esnext",
+    "moduleResolution": "bundler",
+    "outDir": "./build",
+    "rootDir": "./src",
+    "noEmit": false,
+    "declaration": true
+  },
+  "exclude": ["./build", "./docs"]
+}

package/typedoc.json

@@ -0,0 +1,6 @@
+{
+  "out": "docs",
+  "entryPoints": ["src/**/*.tsx"],
+  // Excluding .web files explicity here incse the entry points get updated in the future.
+  "exclude": ["**/*.test.ts", "**/*.spec.ts", "**/*.web.tsx"]
+}