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

package/CHANGELOG.md

@@ -0,0 +1,36 @@
+# @react-protected/core
+
+## 0.3.0
+
+### Minor Changes
+
+- cb262d3: loader, action and middleware support
+
+## 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/README.md

@@ -1,22 +1,6 @@
 # @react-protected/core
 
-Framework-agnostic access-control logic. No dependency on React, a router, or a store.
-
----
-
-## Installation
-
-```bash
-npm install @react-protected/core
-```
-
-```bash
-yarn add @react-protected/core
-```
-
-```bash
-pnpm add @react-protected/core
-```
+Framework-agnostic access-control logic. No dependency on React, a router, or redirect policy.
 
 ## Usage
 
@@ -27,36 +11,20 @@ const guard = createGuard({
   getUser: () => store.getState().user,
   hasRole: (user, roles) => roles.some((role) => user.roles.includes(role)),
   hasPermission: (user, permissions) =>
-    permissions.every((p) => user.permissions.includes(p)),
+    permissions.every((permission) => user.permissions.includes(permission)),
 })
 
 const result = guard.check({ access: 'authenticated', roles: ['admin'] })
 
-if (result.allowed) {
-  // permit access
-} else {
-  // result.reason: 'unauthenticated' | 'forbidden'
+if (!result.allowed) {
+  // result.reason: 'unauthenticated' | 'authenticated' | 'forbidden'
 }
 ```
 
-### Implicit auth requirement
-
-When `roles` or `permissions` are set without an explicit `access` field, the route is treated as `'authenticated'` automatically:
-
-```ts
-guard.check({ roles: ['admin'] })
-// equivalent to: guard.check({ access: 'authenticated', roles: ['admin'] })
-```
-
-## Packages
-
-| Package | Description |
-| --- | --- |
-| `@react-protected/core` | This package — pure access-control logic |
-| `@react-protected/react` | React context, hooks, and `HasAccess` component |
-| `@react-protected/react-router` | Adapter for React Router |
+Supported access levels:
 
-## Documentation
+- `'public'`
+- `'authenticated'`
+- `'unauthenticated'`
 
-- [Core API](https://github.com/astakhovaskold/react-protected/blob/main/docs/en/api/core.md)
-- [Examples](https://github.com/astakhovaskold/react-protected/blob/main/docs/en/README.md)
+When `roles` or `permissions` are set without `access`, the guard treats the config as authenticated-only.

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/index.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});function u(r){const s={getUser:r.getUser,isAuthenticated:r.isAuthenticated??(e=>e!==null),hasRole:r.hasRole??(()=>!1),hasPermission:r.hasPermission??(()=>!1)};return{check:e=>{var a,l,n,i;const t=s.getUser(),o=s.isAuthenticated(t);return((e.access??"public")==="authenticated"||!!((a=e.roles)!=null&&a.length)||!!((l=e.permissions)!=null&&l.length))&&!o?{allowed:!1,reason:"unauthenticated"}:(n=e.roles)!=null&&n.length&&t&&!s.hasRole(t,e.roles)?{allowed:!1,reason:"forbidden"}:(i=e.permissions)!=null&&i.length&&t&&!s.hasPermission(t,e.permissions)?{allowed:!1,reason:"forbidden"}:{allowed:!0}},options:s}}exports.createGuard=u;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});function c(a){const s={getUser:a.getUser,isAuthenticated:a.isAuthenticated??(e=>e!==null),hasRole:a.hasRole??(()=>!1),hasPermission:a.hasPermission??(()=>!1)};return{check:e=>{var n,o,i,u;const t=s.getUser(),r=s.isAuthenticated(t),l=e.access??"public",d=l==="authenticated"||!!((n=e.roles)!=null&&n.length)||!!((o=e.permissions)!=null&&o.length);return l==="unauthenticated"?r?{allowed:!1,reason:"authenticated"}:{allowed:!0}:d&&!r?{allowed:!1,reason:"unauthenticated"}:(i=e.roles)!=null&&i.length&&t&&!s.hasRole(t,e.roles)?{allowed:!1,reason:"forbidden"}:(u=e.permissions)!=null&&u.length&&t&&!s.hasPermission(t,e.permissions)?{allowed:!1,reason:"forbidden"}:{allowed:!0}},options:s}}exports.createGuard=c;

package/dist/index.js

@@ -1,16 +1,16 @@
-function d(r) {
+function c(a) {
   const s = {
-    getUser: r.getUser,
-    isAuthenticated: r.isAuthenticated ?? ((e) => e !== null),
-    hasRole: r.hasRole ?? (() => !1),
-    hasPermission: r.hasPermission ?? (() => !1)
+    getUser: a.getUser,
+    isAuthenticated: a.isAuthenticated ?? ((e) => e !== null),
+    hasRole: a.hasRole ?? (() => !1),
+    hasPermission: a.hasPermission ?? (() => !1)
   };
   return { check: (e) => {
-    var a, n, l, i;
-    const t = s.getUser(), o = s.isAuthenticated(t);
-    return ((e.access ?? "public") === "authenticated" || !!((a = e.roles) != null && a.length) || !!((n = e.permissions) != null && n.length)) && !o ? { allowed: !1, reason: "unauthenticated" } : (l = e.roles) != null && l.length && t && !s.hasRole(t, e.roles) ? { allowed: !1, reason: "forbidden" } : (i = e.permissions) != null && i.length && t && !s.hasPermission(t, e.permissions) ? { allowed: !1, reason: "forbidden" } : { allowed: !0 };
+    var l, o, i, u;
+    const t = s.getUser(), r = s.isAuthenticated(t), n = e.access ?? "public", h = n === "authenticated" || !!((l = e.roles) != null && l.length) || !!((o = e.permissions) != null && o.length);
+    return n === "unauthenticated" ? r ? { allowed: !1, reason: "authenticated" } : { allowed: !0 } : h && !r ? { allowed: !1, reason: "unauthenticated" } : (i = e.roles) != null && i.length && t && !s.hasRole(t, e.roles) ? { allowed: !1, reason: "forbidden" } : (u = e.permissions) != null && u.length && t && !s.hasPermission(t, e.permissions) ? { allowed: !1, reason: "forbidden" } : { allowed: !0 };
   }, options: s };
 }
 export {
-  d as createGuard
+  c as createGuard
 };

package/dist/types.d.ts

@@ -1,26 +1,76 @@
-export type AccessLevel = 'public' | 'authenticated';
+/**
+ * Access level handled by the framework-agnostic guard.
+ */
+export type AccessLevel = 'public' | 'authenticated' | 'unauthenticated';
+/**
+ * Access requirements consumed by `guard.check()` and adapter components.
+ */
 export type AccessConfig = {
+    /**
+     * Declares whether access is public, requires an authenticated user, or requires
+     * an unauthenticated 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;
 } | {
     allowed: false;
     reason: 'unauthenticated';
+} | {
+    allowed: false;
+    reason: 'authenticated';
 } | {
     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.3.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",