@react-protected/react 0.2.0-beta.2 → 0.2.0

package/CHANGELOG.md

@@ -0,0 +1,43 @@
+# @react-protected/react
+
+## 0.2.0
+
+### Minor Changes
+
+- 05cda4d: Update roadmap and docs
+
+### Patch Changes
+
+- 4b835f6: Docs added
+- 11a6537: Configure Changesets-based release automation and public package publish metadata.
+- Updated dependencies [4b835f6]
+- Updated dependencies [11a6537]
+- Updated dependencies [05cda4d]
+  - @react-protected/core@0.2.0
+
+## 0.2.0-beta.2
+
+### Minor Changes
+
+- 05cda4d: Update roadmap and docs
+
+### Patch Changes
+
+- Updated dependencies [05cda4d]
+  - @react-protected/core@0.2.0-beta.2
+
+## 0.1.1-beta.1
+
+### Patch Changes
+
+- 4b835f6: Docs added
+- Updated dependencies [4b835f6]
+  - @react-protected/core@0.1.1-beta.1
+
+## 0.1.1-beta.0
+
+### Patch Changes
+
+- 11a6537: Configure Changesets-based release automation and public package publish metadata.
+- Updated dependencies [11a6537]
+  - @react-protected/core@0.1.1-beta.0

package/dist/AccessProvider.d.ts

@@ -1,3 +1,17 @@
 import { AccessContextValue, AccessProviderProps } from './types';
+/**
+ * Provides access control configuration to the React subtree.
+ *
+ * @typeParam TUser - User shape returned by `getUser`.
+ * @param props - Guard callbacks, navigation settings, and descendant elements.
+ * @returns A context provider that enables access-aware hooks and components.
+ */
 export declare function AccessProvider<TUser = unknown>({ children, loginPath, forbiddenPath, defaultPath, callbackUrlParam, shouldAddCallbackUrl, getUser, isAuthenticated, hasRole, hasPermission, }: AccessProviderProps<TUser>): import("react/jsx-runtime").JSX.Element;
+/**
+ * Returns the active access context from `AccessProvider`.
+ *
+ * @typeParam TUser - User shape stored in the access context.
+ * @returns The guard instance and navigation settings for the current subtree.
+ * @throws {Error} When called outside an `AccessProvider`.
+ */
 export declare function useAccess<TUser = unknown>(): AccessContextValue<TUser>;

package/dist/HasAccess.d.ts

@@ -3,6 +3,18 @@ import { RouteProtection } from './types';
 type HasAccessProps = RouteProtection & {
     children?: ReactNode;
 };
+/**
+ * Returns `true` when the current user satisfies the provided access config.
+ *
+ * @param config - Access requirements to evaluate with the active guard.
+ * @returns `true` when access is allowed, otherwise `false`.
+ */
 export declare function useHasAccess(config: RouteProtection): boolean;
+/**
+ * Renders its children only when the current user satisfies the access config.
+ *
+ * @param props - Access requirements and the children to render when allowed.
+ * @returns The provided children when access is allowed, otherwise `null`.
+ */
 export declare function HasAccess({ access, roles, permissions, meta, children }: HasAccessProps): string | number | boolean | import('react').ReactElement<any, string | import('react').JSXElementConstructor<any>> | Iterable<ReactNode> | null;
 export {};

package/dist/testing.d.ts

@@ -1,9 +1,30 @@
 import { GuardOptions } from '@react-protected/core';
 import { ReactNode } from 'react';
 import { NavigationConfig } from './types';
+/**
+ * Props accepted by `MockAccessProvider`.
+ */
 export type MockAccessProviderProps<TUser = unknown> = Partial<GuardOptions<TUser>> & NavigationConfig & {
+    /**
+     * User returned by the default `getUser` implementation.
+     */
     user?: TUser | null;
+    /**
+     * Default outcome used by generated access callbacks when explicit callbacks are not provided.
+     */
     allowed?: boolean;
+    /**
+     * React subtree that consumes the mocked access context.
+     */
     children?: ReactNode;
 };
+/**
+ * Test helper that provides a predictable access context.
+ *
+ * @typeParam TUser - User shape returned by the mocked `getUser`.
+ * @param props - Mocked user, optional callback overrides, navigation settings, and children.
+ * @returns An `AccessProvider` configured for deterministic tests.
+ * @remarks When explicit callbacks are omitted, authentication, role, and permission checks all
+ * resolve to the `allowed` flag.
+ */
 export declare function MockAccessProvider<TUser = unknown>({ user, allowed, children, getUser, isAuthenticated, hasRole, hasPermission, loginPath, forbiddenPath, defaultPath, callbackUrlParam, shouldAddCallbackUrl, }: MockAccessProviderProps<TUser>): import("react/jsx-runtime").JSX.Element;

package/dist/types.d.ts

@@ -1,24 +1,78 @@
-import { AccessConfig, Guard, GuardOptions } from '@react-protected/core';
+import { AccessConfig as CoreAccessConfig, Guard, GuardOptions } from '@react-protected/core';
 import { ReactNode } from 'react';
-export type { AccessConfig as RouteProtection } from '@react-protected/core';
+/**
+ * Access requirements consumed by React hooks and components in this package.
+ */
+export type RouteProtection = CoreAccessConfig;
+/**
+ * Navigation paths used when access-aware components need to redirect.
+ */
 export type NavigationConfig = {
+    /**
+     * Redirect target for unauthenticated users.
+     */
     loginPath?: string;
+    /**
+     * Redirect target when the user is authenticated but lacks access.
+     */
     forbiddenPath?: string;
+    /**
+     * Redirect target for authenticated users visiting guest-only screens.
+     */
     defaultPath?: string;
+    /**
+     * Query parameter name used to preserve the current location during login redirects.
+     */
     callbackUrlParam?: string;
+    /**
+     * Decides whether the callback URL should be attached to an unauthenticated redirect.
+     */
     shouldAddCallbackUrl?: () => boolean;
 };
+/**
+ * Access context exposed by `useAccess()`.
+ */
 export type AccessContextValue<TUser = unknown> = {
+    /**
+     * Guard instance used to evaluate access rules.
+     */
     guard: Guard<TUser>;
+    /**
+     * Redirect target for unauthenticated users.
+     */
     loginPath: string;
+    /**
+     * Redirect target when the user is authenticated but forbidden.
+     */
     forbiddenPath: string;
+    /**
+     * Redirect target for authenticated users on guest-only screens.
+     */
     defaultPath: string;
+    /**
+     * Query parameter name used to preserve the current location during login redirects.
+     */
     callbackUrlParam?: string;
+    /**
+     * Decides whether the callback URL should be attached to an unauthenticated redirect.
+     */
     shouldAddCallbackUrl?: () => boolean;
 };
+/**
+ * Props accepted by `AccessProvider`.
+ */
 export type AccessProviderProps<TUser = unknown> = GuardOptions<TUser> & NavigationConfig & {
+    /**
+     * React subtree that consumes the access context.
+     */
     children?: ReactNode;
 };
-export type AccessRouteProps = AccessConfig & {
+/**
+ * Access requirements accepted by `useHasAccess()` and `HasAccess`.
+ */
+export type AccessRouteProps = RouteProtection & {
+    /**
+     * React subtree rendered when the access check passes.
+     */
     children?: ReactNode;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-protected/react",
-  "version": "0.2.0-beta.2",
+  "version": "0.2.0",
   "license": "MIT",
   "description": "React context and hooks for react-protected",
   "main": "./dist/index.cjs",
@@ -27,10 +27,11 @@
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "CHANGELOG.md"
   ],
   "dependencies": {
-    "@react-protected/core": "0.2.0-beta.2"
+    "@react-protected/core": "0.2.0"
   },
   "peerDependencies": {
     "react": ">=18.0.0",