@cedarjs/auth 8.0.0-canary.3568 → 8.0.0-canary.3570

package/dist/AuthContext.d.ts

@@ -20,8 +20,9 @@ export type CurrentUser = (LoggedInUser & object) | null;
 /**
  * The app's permission names, as keys. Cedar generates them from the app's
  * permission definitions (`packages/permissions`, set up by
- * `cedar setup tenancy`). Empty when the app has none, and then
- * `hasPermission` takes nothing: it could only ever answer `false`.
+ * `cedar setup permissions` or `cedar setup tenancy`). Empty when the app
+ * has none, and then `hasPermission` takes nothing: it could only ever
+ * answer `false`.
  */
 export interface AvailablePermissions {
 }
@@ -85,10 +86,11 @@ export interface AuthContextInterface<TUser, TLogInOptions, TLogIn, TLogOutOptio
      */
     hasRole(rolesToCheck: string | string[]): boolean;
     /**
-     * Whether the user has `permission` where they are in the app. Always
-     * `false` outside a scope that provides permissions, such as an
-     * organization route with `tenancy` from `@cedarjs/tenancy/web` on the
-     * `Router`.
+     * Whether the user has `permission` where they are in the app: in
+     * `currentUser.permissions`, or in a scope that provides permissions,
+     * such as an organization route with `tenancy` from
+     * `@cedarjs/tenancy/web` on the `Router`. With tenancy, `false` outside
+     * an organization.
      */
     hasPermission(permission: PermissionName): 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;;;;;;;;;;GAUG;AAEH,MAAM,WAAW,YAAY;CAAG;AAEhC;;;GAGG;AAGH,MAAM,MAAM,WAAW,GAAG,CAAC,YAAY,GAAG,MAAM,CAAC,GAAG,IAAI,CAAA;AAExD;;;;;GAKG;AAEH,MAAM,WAAW,oBAAoB;CAAG;AAExC;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,MAAM,oBAAoB,CAAC,SAAS,CAAC,KAAK,CAAC,GACrE,KAAK,GACL,OAAO,CAAC,MAAM,oBAAoB,EAAE,MAAM,CAAC,CAAA;AAE/C;;;;;GAKG;AAEH,MAAM,WAAW,WAAW;CAAG;AAE/B,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;;;;OAIG;IACH,OAAO,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,OAAO,CAAA;IACjD;;;;;OAKG;IACH,aAAa,CAAC,UAAU,EAAE,cAAc,GAAG,OAAO,CAAA;IAClD;;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;;;;;;GAMG;AAEH,MAAM,WAAW,oBAAoB;CAAG;AAExC;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,MAAM,oBAAoB,CAAC,SAAS,CAAC,KAAK,CAAC,GACrE,KAAK,GACL,OAAO,CAAC,MAAM,oBAAoB,EAAE,MAAM,CAAC,CAAA;AAE/C;;;;;GAKG;AAEH,MAAM,WAAW,WAAW;CAAG;AAE/B,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;;;;OAIG;IACH,OAAO,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,OAAO,CAAA;IACjD;;;;;;OAMG;IACH,aAAa,CAAC,UAAU,EAAE,cAAc,GAAG,OAAO,CAAA;IAClD;;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/AuthProvider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AuthProvider.d.ts","sourceRoot":"","sources":["../../src/AuthProvider/AuthProvider.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AACtC,OAAO,KAA0C,MAAM,OAAO,CAAA;AAE9D,OAAO,KAAK,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAC1E,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAA;AAiBlE,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,SAAS,CAAA;CACpB;AAKD,wBAAgB,kBAAkB,CAChC,KAAK,EACL,YAAY,EACZ,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,EAEzB,WAAW,EAAE,KAAK,CAAC,OAAO,CACtB,oBAAoB,CAClB,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,EACtB,eAAe,CAChB,GACD,SAAS,CACZ,EACD,kBAAkB,EAAE,kBAAkB,CACpC,KAAK,EACL,YAAY,EACZ,aAAa,EACb,MAAM,EACN,cAAc,EACd,OAAO,EACP,cAAc,EACd,OAAO,EACP,eAAe,EACf,qBAAqB,EACrB,cAAc,EACd,mBAAmB,EACnB,OAAO,EACP,sBAAsB,EACtB,eAAe,CAChB,EACD,mBAAmB,CAAC,EAAE;IACpB,cAAc,CAAC,EAAE,MAAM,OAAO,CAAC,WAAW,CAAC,CAAA;IAC3C,UAAU,CAAC,EAAE,CACX,WAAW,EAAE,WAAW,KACrB,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,OAAO,CAAA;CAClD,kBAEmC,iBAAiB,uBA+FtD"}
+{"version":3,"file":"AuthProvider.d.ts","sourceRoot":"","sources":["../../src/AuthProvider/AuthProvider.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AACtC,OAAO,KAAuD,MAAM,OAAO,CAAA;AAE3E,OAAO,KAAK,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAC1E,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAA;AAkBlE,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,SAAS,CAAA;CACpB;AAED,wBAAgB,kBAAkB,CAChC,KAAK,EACL,YAAY,EACZ,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,EAEzB,WAAW,EAAE,KAAK,CAAC,OAAO,CACtB,oBAAoB,CAClB,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,EACtB,eAAe,CAChB,GACD,SAAS,CACZ,EACD,kBAAkB,EAAE,kBAAkB,CACpC,KAAK,EACL,YAAY,EACZ,aAAa,EACb,MAAM,EACN,cAAc,EACd,OAAO,EACP,cAAc,EACd,OAAO,EACP,eAAe,EACf,qBAAqB,EACrB,cAAc,EACd,mBAAmB,EACnB,OAAO,EACP,sBAAsB,EACtB,eAAe,CAChB,EACD,mBAAmB,CAAC,EAAE;IACpB,cAAc,CAAC,EAAE,MAAM,OAAO,CAAC,WAAW,CAAC,CAAA;IAC3C,UAAU,CAAC,EAAE,CACX,WAAW,EAAE,WAAW,KACrB,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,OAAO,CAAA;CAClD,kBAEmC,iBAAiB,uBAuGtD"}

package/dist/AuthProvider/AuthProvider.js

@@ -1,4 +1,5 @@
-import React, { useContext, useEffect, useState } from "react";
+import React, { useCallback, useContext, useEffect, useState } from "react";
+import { currentUserHasPermission } from "../currentUserHasPermission.js";
 import { spaDefaultAuthProviderState } from "./AuthProviderState.js";
 import { ServerAuthContext } from "./ServerAuthProvider.js";
 import { useChangePassword } from "./useChangePassword.js";
@@ -12,7 +13,6 @@ import { useResetPassword } from "./useResetPassword.js";
 import { useSignUp } from "./useSignUp.js";
 import { useToken } from "./useToken.js";
 import { useValidateResetToken } from "./useValidateResetToken.js";
-const noPermissions = () => false;
 function createAuthProvider(AuthContext, authImplementation, customProviderHooks) {
   const AuthProvider = ({ children }) => {
     const serverAuthState = useContext(ServerAuthContext);
@@ -31,6 +31,11 @@ function createAuthProvider(AuthContext, authImplementation, customProviderHooks
       // eslint-disable-next-line react-hooks/rules-of-hooks
       useHasRole(authProviderState.currentUser)
     );
+    const { currentUser } = authProviderState;
+    const hasPermission = useCallback(
+      (permission) => currentUserHasPermission(currentUser, permission),
+      [currentUser]
+    );
     const signUp = useSignUp(
       authImplementation,
       setAuthProviderState,
@@ -68,7 +73,7 @@ function createAuthProvider(AuthContext, authImplementation, customProviderHooks
           getToken,
           getCurrentUser,
           hasRole,
-          hasPermission: noPermissions,
+          hasPermission,
           reauthenticate,
           forgotPassword,
           resetPassword,

package/dist/HasPermissionContext.d.ts

@@ -1,12 +1,14 @@
 import React from 'react';
 /**
- * Provides `useAuth().hasPermission` for the components below it. Unset,
- * `hasPermission` is always `false`: permissions belong to a scope, such as
- * an organization, and there is none here.
+ * Provides `useAuth().hasPermission` for the components below it, for a
+ * scope with permissions of its own. Unset, `hasPermission` checks
+ * `currentUser.permissions`, the user's own (`cedar setup permissions`).
  *
  * The organization provider that the `Router` renders for `tenancy` from
  * `@cedarjs/tenancy/web` provides it, so inside an organization route
- * `hasPermission` checks the user's membership there.
+ * `hasPermission` checks the user's membership there. With tenancy,
+ * `currentUser` has no permissions of its own, so outside an organization
+ * `hasPermission` is `false`.
  */
 export declare const HasPermissionContext: React.Context<((permission: string) => boolean) | undefined>;
 //# sourceMappingURL=HasPermissionContext.d.ts.map

package/dist/HasPermissionContext.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"HasPermissionContext.d.ts","sourceRoot":"","sources":["../src/HasPermissionContext.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB;;;;;;;;GAQG;AACH,eAAO,MAAM,oBAAoB,8BACjB,MAAM,KAAK,OAAO,cACtB,CAAA"}
+{"version":3,"file":"HasPermissionContext.d.ts","sourceRoot":"","sources":["../src/HasPermissionContext.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB;;;;;;;;;;GAUG;AACH,eAAO,MAAM,oBAAoB,8BACjB,MAAM,KAAK,OAAO,cACtB,CAAA"}

package/dist/currentUserHasPermission.d.ts

@@ -0,0 +1,10 @@
+import type { CurrentUser } from './AuthContext.js';
+/**
+ * Whether `currentUser.permissions` has `permission`. `getCurrentUser` adds
+ * them with `withPermissions` in an app that has run
+ * `cedar setup permissions`: the permissions of the user's roles. With
+ * tenancy, permissions belong to a membership instead, so `currentUser`
+ * has none of its own.
+ */
+export declare function currentUserHasPermission(currentUser: CurrentUser, permission: string): boolean;
+//# sourceMappingURL=currentUserHasPermission.d.ts.map

package/dist/currentUserHasPermission.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"currentUserHasPermission.d.ts","sourceRoot":"","sources":["../src/currentUserHasPermission.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAEnD;;;;;;GAMG;AACH,wBAAgB,wBAAwB,CACtC,WAAW,EAAE,WAAW,EACxB,UAAU,EAAE,MAAM,GACjB,OAAO,CAQT"}

package/dist/currentUserHasPermission.js

@@ -0,0 +1,7 @@
+function currentUserHasPermission(currentUser, permission) {
+  const permissions = currentUser && "permissions" in currentUser ? currentUser.permissions : void 0;
+  return Array.isArray(permissions) && permissions.includes(permission);
+}
+export {
+  currentUserHasPermission
+};

package/package.json

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