[#323] fixed and deprecated isAdmin/isAuthRecord store getters

Author: ganigeorgiev

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.22.1
+
+- Fixed old `pb.authStore.isAdmin`/`pb.authStore..isAuthRecord` and marked them as depricated in favour of `pb.authStore.isSuperuser` ([#323](https://github.com/pocketbase/js-sdk/issues/323)).
+    _Note that with PocketBase v0.23.0 superusers are converted to a system auth collection so you can always simply check the value of `pb.authStore.record?.collectionName`._
+
+
 ## 0.22.0
 
 **⚠️ This release introduces some breaking changes and works only with PocketBase v0.23.0+.**

README.md

@@ -238,11 +238,10 @@ BaseAuthStore {
     record:       RecordModel|null // the authenticated auth record
     token:        string  // the authenticated token
     isValid:      boolean // checks if the store has existing and unexpired token
-    isAdmin:      boolean // checks if the store state is for admin
-    isAuthRecord: boolean // checks if the store state is for an auth record
+    isSuperuser:  boolean // checks if the store state is for superuser
 
     // main methods
-    clear()             // "logout" the authenticated record or admin model
+    clear()             // "logout" the authenticated record
     save(token, record) // update the store with the new auth data
     onChange(callback, fireImmediately = false) // register a callback that will be called on store change
 
@@ -252,7 +251,7 @@ BaseAuthStore {
 }
 ```
 
-To _"logout"_ an authenticated record or admin you can call `pb.authStore.clear()`.
+To _"logout"_ the authenticated record you can call `pb.authStore.clear()`.
 
 To _"listen"_ for changes in the auth store, you can register a new listener via `pb.authStore.onChange`, eg:
 ```js

dist/pocketbase.cjs.d.ts

@@ -159,11 +159,17 @@ declare class BaseAuthStore {
      */
     get isValid(): boolean;
     /**
-     * Checks whether the current store state is for admin authentication.
+     * Loosely checks whether the currently loaded store state is for superuser.
+     *
+     * Alternatively you can also compare directly `pb.authStore.record?.collectionName`.
+     */
+    get isSuperuser(): boolean;
+    /**
+     * @deprecated use `isSuperuser` instead or simply check the record.collectionName property.
      */
     get isAdmin(): boolean;
     /**
-     * Checks whether the current store state is for auth record authentication.
+     * @deprecated use `!isSuperuser` instead or simply check the record.collectionName property.
      */
     get isAuthRecord(): boolean;
     /**
@@ -1005,7 +1011,7 @@ declare class FileService extends BaseService {
         [key: string]: any;
     }, filename: string, queryParams?: FileOptions): string;
     /**
-     * Requests a new private file access token for the current auth model (admin or record).
+     * Requests a new private file access token for the current auth model.
      *
      * @throws {ClientResponseError}
      */

dist/pocketbase.cjs.js

@@ -181,11 +181,17 @@ declare class BaseAuthStore {
      */
     get isValid(): boolean;
     /**
-     * Checks whether the current store state is for admin authentication.
+     * Loosely checks whether the currently loaded store state is for superuser.
+     *
+     * Alternatively you can also compare directly `pb.authStore.record?.collectionName`.
+     */
+    get isSuperuser(): boolean;
+    /**
+     * @deprecated use `isSuperuser` instead or simply check the record.collectionName property.
      */
     get isAdmin(): boolean;
     /**
-     * Checks whether the current store state is for auth record authentication.
+     * @deprecated use `!isSuperuser` instead or simply check the record.collectionName property.
      */
     get isAuthRecord(): boolean;
     /**
@@ -1048,7 +1054,7 @@ declare class FileService extends BaseService {
         [key: string]: any;
     }, filename: string, queryParams?: FileOptions): string;
     /**
-     * Requests a new private file access token for the current auth model (admin or record).
+     * Requests a new private file access token for the current auth model.
      *
      * @throws {ClientResponseError}
      */

dist/pocketbase.cjs.js.map

@@ -181,11 +181,17 @@ declare class BaseAuthStore {
      */
     get isValid(): boolean;
     /**
-     * Checks whether the current store state is for admin authentication.
+     * Loosely checks whether the currently loaded store state is for superuser.
+     *
+     * Alternatively you can also compare directly `pb.authStore.record?.collectionName`.
+     */
+    get isSuperuser(): boolean;
+    /**
+     * @deprecated use `isSuperuser` instead or simply check the record.collectionName property.
      */
     get isAdmin(): boolean;
     /**
-     * Checks whether the current store state is for auth record authentication.
+     * @deprecated use `!isSuperuser` instead or simply check the record.collectionName property.
      */
     get isAuthRecord(): boolean;
     /**
@@ -1048,7 +1054,7 @@ declare class FileService extends BaseService {
         [key: string]: any;
     }, filename: string, queryParams?: FileOptions): string;
     /**
-     * Requests a new private file access token for the current auth model (admin or record).
+     * Requests a new private file access token for the current auth model.
      *
      * @throws {ClientResponseError}
      */