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

package/CHANGELOG.md

@@ -0,0 +1,30 @@
+# @react-protected/core
+
+## 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.
+
+## 0.2.0-beta.2
+
+### Minor Changes
+
+- 05cda4d: Update roadmap and docs
+
+## 0.1.1-beta.1
+
+### Patch Changes
+
+- 4b835f6: Docs added
+
+## 0.1.1-beta.0
+
+### Patch Changes
+
+- 11a6537: Configure Changesets-based release automation and public package publish metadata.

package/dist/createGuard.d.ts

@@ -1,2 +1,11 @@
 import { Guard, GuardOptions } from './types';
+/**
+ * Creates a guard that evaluates access against the current user.
+ *
+ * @typeParam TUser - User shape returned by `getUser`.
+ * @param options - Access callbacks and user accessors used by the guard.
+ * @returns A reusable guard with resolved defaults for authentication, role, and permission checks.
+ * @remarks When `roles` or `permissions` are provided without `access`, the guard treats the config
+ * as authenticated-only.
+ */
 export declare function createGuard<TUser = unknown>(options: GuardOptions<TUser>): Guard<TUser>;

package/dist/types.d.ts

@@ -1,10 +1,32 @@
+/**
+ * Access level handled by the framework-agnostic guard.
+ */
 export type AccessLevel = 'public' | 'authenticated';
+/**
+ * Access requirements consumed by `guard.check()` and adapter components.
+ */
 export type AccessConfig = {
+    /**
+     * Declares whether access is public or requires an authenticated user.
+     * Defaults to `'public'` when omitted.
+     */
     access?: AccessLevel;
+    /**
+     * Roles that must be satisfied by your `hasRole` callback.
+     */
     roles?: Array<string>;
+    /**
+     * Permissions that must be satisfied by your `hasPermission` callback.
+     */
     permissions?: Array<string>;
+    /**
+     * Optional metadata for application-specific access logic.
+     */
     meta?: Record<string, unknown>;
 };
+/**
+ * Result returned by `guard.check()`.
+ */
 export type AccessResult = {
     allowed: true;
 } | {
@@ -14,13 +36,37 @@ export type AccessResult = {
     allowed: false;
     reason: 'forbidden';
 };
+/**
+ * Callbacks and accessors used to create a guard instance.
+ */
 export type GuardOptions<TUser = unknown> = {
+    /**
+     * Returns the current user or `null` when no user is available.
+     */
     getUser: () => TUser | null;
+    /**
+     * Overrides the default authenticated check of `user !== null`.
+     */
     isAuthenticated?: (user: TUser | null) => boolean;
+    /**
+     * Determines whether the current user satisfies the requested roles.
+     */
     hasRole?: (user: TUser, roles: Array<string>) => boolean;
+    /**
+     * Determines whether the current user satisfies the requested permissions.
+     */
     hasPermission?: (user: TUser, permissions: Array<string>) => boolean;
 };
+/**
+ * Guard instance returned by `createGuard()`.
+ */
 export type Guard<TUser = unknown> = {
+    /**
+     * Evaluates whether the current user satisfies the provided access config.
+     */
     check: (config: AccessConfig) => AccessResult;
+    /**
+     * Resolved guard callbacks with built-in defaults applied.
+     */
     options: Required<GuardOptions<TUser>>;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-protected/core",
-  "version": "0.2.0-beta.2",
+  "version": "0.2.0",
   "license": "MIT",
   "description": "Framework-agnostic route protection logic",
   "main": "./dist/index.cjs",
@@ -22,7 +22,8 @@
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "CHANGELOG.md"
   ],
   "devDependencies": {
     "vite": "^5.0.0",