@cedarjs/auth 8.0.0-canary.3518 → 8.0.0-canary.3522

package/dist/AuthContext.d.ts

@@ -2,16 +2,21 @@ import React from 'react';
 /**
  * The user returned by your app's `getCurrentUser` function on the api side,
  * when someone is logged in. Cedar generates the fields from your
- * `getCurrentUser` function
+ * `getCurrentUser` function.
+ *
+ * This is a declaration-merging target: Cedar's generated
+ * `.cedar/types/includes/all-currentUser.d.ts` augments it with the app's
+ * `getCurrentUser` return type. It has no fields of its own, so
+ * `LoggedInUser` has exactly the fields `getCurrentUser` returns, and is `{}`
+ * in apps where `getCurrentUser` doesn't return a user.
  */
 export interface LoggedInUser {
-    [key: string]: unknown;
 }
 /**
  * What `getCurrentUser` returns: the logged-in user, or `null` when nobody is
  * logged in
  */
-export type CurrentUser = LoggedInUser | null;
+export type CurrentUser = (LoggedInUser & object) | null;
 export interface AuthContextInterface<TUser, TLogInOptions, TLogIn, TLogOutOptions, TLogOut, TSignUpOptions, TSignUp, TForgotPassword, TResetPasswordOptions, TResetPassword, TValidateResetToken, TClient, TChangePasswordOptions = unknown, TChangePassword = unknown> {
     /** Determining your current authentication state */
     loading: boolean;

package/dist/AuthContext.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AuthContext.d.ts","sourceRoot":"","sources":["../src/AuthContext.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACvB;AAED;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,YAAY,GAAG,IAAI,CAAA;AAE7C,MAAM,WAAW,oBAAoB,CACnC,KAAK,EACL,aAAa,EACb,MAAM,EACN,cAAc,EACd,OAAO,EACP,cAAc,EACd,OAAO,EACP,eAAe,EACf,qBAAqB,EACrB,cAAc,EACd,mBAAmB,EACnB,OAAO,EACP,sBAAsB,GAAG,OAAO,EAChC,eAAe,GAAG,OAAO;IAEzB,oDAAoD;IACpD,OAAO,EAAE,OAAO,CAAA;IAChB,eAAe,EAAE,OAAO,CAAA;IACxB,iFAAiF;IACjF,WAAW,EAAE,WAAW,CAAA;IACxB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,YAAY,EAAE,IAAI,GAAG,KAAK,CAAA;IAC1B,KAAK,CAAC,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IAC/C,MAAM,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAClD,MAAM,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAClD;;;OAGG;IACH,QAAQ,IAAI,OAAO,CAAC,IAAI,GAAG,MAAM,CAAC,CAAA;IAClC;;;OAGG;IACH,cAAc,IAAI,OAAO,CAAC,WAAW,CAAC,CAAA;IACtC;;;;;QAKI;IACJ,OAAO,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,OAAO,CAAA;IACjD;;OAEG;IACH,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAC/B,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAA;IAC1D,aAAa,CAAC,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,cAAc,CAAC,CAAA;IACvE,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAA;IAC3E;;;;OAIG;IACH,cAAc,CAAC,OAAO,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,eAAe,CAAC,CAAA;IAC1E;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,OAAO,CAAA;IACjB,KAAK,CAAC,EAAE,KAAK,CAAA;CACd;AAED,wBAAgB,iBAAiB,CAC/B,KAAK,EACL,aAAa,EACb,MAAM,EACN,cAAc,EACd,OAAO,EACP,cAAc,EACd,OAAO,EACP,eAAe,EACf,qBAAqB,EACrB,cAAc,EACd,mBAAmB,EACnB,OAAO,EACP,sBAAsB,GAAG,OAAO,EAChC,eAAe,GAAG,OAAO,oQAqB1B"}
+{"version":3,"file":"AuthContext.d.ts","sourceRoot":"","sources":["../src/AuthContext.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB;;;;;;;;;;GAUG;AAEH,MAAM,WAAW,YAAY;CAAG;AAEhC;;;GAGG;AAGH,MAAM,MAAM,WAAW,GAAG,CAAC,YAAY,GAAG,MAAM,CAAC,GAAG,IAAI,CAAA;AAExD,MAAM,WAAW,oBAAoB,CACnC,KAAK,EACL,aAAa,EACb,MAAM,EACN,cAAc,EACd,OAAO,EACP,cAAc,EACd,OAAO,EACP,eAAe,EACf,qBAAqB,EACrB,cAAc,EACd,mBAAmB,EACnB,OAAO,EACP,sBAAsB,GAAG,OAAO,EAChC,eAAe,GAAG,OAAO;IAEzB,oDAAoD;IACpD,OAAO,EAAE,OAAO,CAAA;IAChB,eAAe,EAAE,OAAO,CAAA;IACxB,iFAAiF;IACjF,WAAW,EAAE,WAAW,CAAA;IACxB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,YAAY,EAAE,IAAI,GAAG,KAAK,CAAA;IAC1B,KAAK,CAAC,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IAC/C,MAAM,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAClD,MAAM,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAClD;;;OAGG;IACH,QAAQ,IAAI,OAAO,CAAC,IAAI,GAAG,MAAM,CAAC,CAAA;IAClC;;;OAGG;IACH,cAAc,IAAI,OAAO,CAAC,WAAW,CAAC,CAAA;IACtC;;;;;QAKI;IACJ,OAAO,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,OAAO,CAAA;IACjD;;OAEG;IACH,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAC/B,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAA;IAC1D,aAAa,CAAC,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,cAAc,CAAC,CAAA;IACvE,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAA;IAC3E;;;;OAIG;IACH,cAAc,CAAC,OAAO,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,eAAe,CAAC,CAAA;IAC1E;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,OAAO,CAAA;IACjB,KAAK,CAAC,EAAE,KAAK,CAAA;CACd;AAED,wBAAgB,iBAAiB,CAC/B,KAAK,EACL,aAAa,EACb,MAAM,EACN,cAAc,EACd,OAAO,EACP,cAAc,EACd,OAAO,EACP,eAAe,EACf,qBAAqB,EACrB,cAAc,EACd,mBAAmB,EACnB,OAAO,EACP,sBAAsB,GAAG,OAAO,EAChC,eAAe,GAAG,OAAO,oQAqB1B"}

package/dist/AuthProvider/useHasRole.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useHasRole.d.ts","sourceRoot":"","sources":["../../src/AuthProvider/useHasRole.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAEpD,eAAO,MAAM,UAAU,GAAI,aAAa,WAAW,oBAehC,MAAM,GAAG,MAAM,EAAE,KAAG,OAiCtC,CAAA"}
+{"version":3,"file":"useHasRole.d.ts","sourceRoot":"","sources":["../../src/AuthProvider/useHasRole.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAGpD,eAAO,MAAM,UAAU,GAAI,aAAa,WAAW,oBAehC,MAAM,GAAG,MAAM,EAAE,KAAG,OAItC,CAAA"}

package/dist/AuthProvider/useHasRole.js

@@ -1,31 +1,8 @@
 import { useCallback } from "react";
+import { currentUserHasRole } from "../currentUserHasRole.js";
 const useHasRole = (currentUser) => {
   return useCallback(
-    (rolesToCheck) => {
-      if (currentUser?.roles) {
-        if (typeof rolesToCheck === "string") {
-          if (typeof currentUser.roles === "string") {
-            return currentUser.roles === rolesToCheck;
-          } else if (Array.isArray(currentUser.roles)) {
-            return currentUser.roles?.some(
-              (allowedRole) => rolesToCheck === allowedRole
-            );
-          }
-        }
-        if (Array.isArray(rolesToCheck)) {
-          if (Array.isArray(currentUser.roles)) {
-            return currentUser.roles?.some(
-              (allowedRole) => rolesToCheck.includes(allowedRole)
-            );
-          } else if (typeof currentUser.roles === "string") {
-            return rolesToCheck.some(
-              (allowedRole) => currentUser?.roles === allowedRole
-            );
-          }
-        }
-      }
-      return false;
-    },
+    (rolesToCheck) => currentUserHasRole(currentUser, rolesToCheck),
     [currentUser]
   );
 };

package/dist/currentUserHasRole.d.ts

@@ -0,0 +1,16 @@
+import type { CurrentUser } from './AuthContext.js';
+/**
+ * @example
+ * ```js
+ *  currentUserHasRole(currentUser, "editor")
+ *  currentUserHasRole(currentUser, ["editor"])
+ *  currentUserHasRole(currentUser, ["editor", "author"])
+ * ```
+ *
+ * Checks if the "currentUser" from the api side
+ * is assigned a role or one of a list of roles.
+ * If the user is assigned any of the provided list of roles,
+ * the hasRole is considered to be true.
+ */
+export declare function currentUserHasRole(currentUser: CurrentUser, rolesToCheck: string | string[]): boolean;
+//# sourceMappingURL=currentUserHasRole.d.ts.map

package/dist/currentUserHasRole.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"currentUserHasRole.d.ts","sourceRoot":"","sources":["../src/currentUserHasRole.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAEnD;;;;;;;;;;;;GAYG;AACH,wBAAgB,kBAAkB,CAChC,WAAW,EAAE,WAAW,EACxB,YAAY,EAAE,MAAM,GAAG,MAAM,EAAE,GAC9B,OAAO,CA4BT"}

package/dist/currentUserHasRole.js

@@ -0,0 +1,23 @@
+function currentUserHasRole(currentUser, rolesToCheck) {
+  const roles = currentUser && "roles" in currentUser ? currentUser.roles : void 0;
+  if (roles) {
+    if (typeof rolesToCheck === "string") {
+      if (typeof roles === "string") {
+        return roles === rolesToCheck;
+      } else if (Array.isArray(roles)) {
+        return roles.some((allowedRole) => rolesToCheck === allowedRole);
+      }
+    }
+    if (Array.isArray(rolesToCheck)) {
+      if (Array.isArray(roles)) {
+        return roles.some((allowedRole) => rolesToCheck.includes(allowedRole));
+      } else if (typeof roles === "string") {
+        return rolesToCheck.some((allowedRole) => roles === allowedRole);
+      }
+    }
+  }
+  return false;
+}
+export {
+  currentUserHasRole
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cedarjs/auth",
-  "version": "8.0.0-canary.3518",
+  "version": "8.0.0-canary.3522",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/cedarjs/cedar.git",
@@ -32,6 +32,10 @@
     "./dist/AuthProvider/ServerAuthProvider.js": {
       "types": "./dist/AuthProvider/ServerAuthProvider.d.ts",
       "default": "./dist/AuthProvider/ServerAuthProvider.js"
+    },
+    "./currentUserHasRole": {
+      "types": "./dist/currentUserHasRole.d.ts",
+      "default": "./dist/currentUserHasRole.js"
     }
   },
   "types": "./dist/index.d.ts",
@@ -51,7 +55,7 @@
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "0.18.5",
-    "@cedarjs/framework-tools": "8.0.0-canary.3518",
+    "@cedarjs/framework-tools": "8.0.0-canary.3522",
     "@testing-library/dom": "10.4.2",
     "@testing-library/jest-dom": "6.9.1",
     "@testing-library/react": "16.3.3",