removed the AuthStore type

pocketbase · Aug 26, 2022 · 0aa9a3b · 0aa9a3b
1 parent 0f4d5f9
commit 0aa9a3b
Show file tree

Hide file tree

Showing 8 changed files with 22 additions and 239 deletions.
diff --git a/dist/pocketbase.cjs.d.ts b/dist/pocketbase.cjs.d.ts
@@ -131,47 +131,6 @@ declare abstract class BaseAuthStore {
     onChange(callback: () => void): () => void;
     protected triggerChange(): void;
 }
-/**
- * The minimal AuthStore interface.
- *
- * @deprecated
- * This interface predates the abstract BaseAuthStore class
- * and it is kept mainly for backward compatibility.
- *
- * New AuthStore implementations should extend directly the
- * BaseAuthStore abstract class.
- */
-type AuthStore = {
-    /**
-     * Retrieves the stored token (if any).
-     */
-    readonly token: string;
-    /**
-     * Retrieves the stored model data (if any).
-     */
-    readonly model: User | Admin | null;
-    /**
-     * Checks if the store has valid (aka. existing and unexpired) token.
-     */
-    readonly isValid: boolean;
-    /**
-     * Saves new token and model data in the auth store.
-     */
-    save(token: string, model: User | Admin | null): void;
-    /**
-     * Removes the stored token and model data form the auth store.
-     */
-    clear(): void;
-    /**
-     * Parses the provided cookie string and updates the store state
-     * with the cookie's token and model data.
-     */
-    loadFromCookie(cookie: string, key?: string): void;
-    /**
-     * Exports the current store state as cookie string.
-     */
-    exportToCookie(options?: SerializeOptions, key?: string): string;
-};
 /**
  * BaseService class that should be inherited from all API services.
  */
@@ -639,9 +598,9 @@ declare class Client {
      */
     lang: string;
     /**
-     * A replaceable instance of the local `AuthStore` service.
+     * A replaceable instance of the local auth store service.
      */
-    authStore: AuthStore | BaseAuthStore;
+    authStore: BaseAuthStore;
     /**
      * An instance of the service that handles the **Settings APIs**.
      */
@@ -671,11 +630,11 @@ declare class Client {
      */
     readonly realtime: Realtime;
     private cancelControllers;
-    constructor(baseUrl?: string, lang?: string, authStore?: AuthStore | BaseAuthStore | null);
+    constructor(baseUrl?: string, lang?: string, authStore?: BaseAuthStore | null);
     /**
      * @deprecated Legacy alias for `this.authStore`.
      */
-    get AuthStore(): AuthStore;
+    get AuthStore(): BaseAuthStore;
     /**
      * @deprecated Legacy alias for `this.settings`.
      */

diff --git a/dist/pocketbase.es.d.mts b/dist/pocketbase.es.d.mts
@@ -131,47 +131,6 @@ declare abstract class BaseAuthStore {
     onChange(callback: () => void): () => void;
     protected triggerChange(): void;
 }
-/**
- * The minimal AuthStore interface.
- *
- * @deprecated
- * This interface predates the abstract BaseAuthStore class
- * and it is kept mainly for backward compatibility.
- *
- * New AuthStore implementations should extend directly the
- * BaseAuthStore abstract class.
- */
-type AuthStore = {
-    /**
-     * Retrieves the stored token (if any).
-     */
-    readonly token: string;
-    /**
-     * Retrieves the stored model data (if any).
-     */
-    readonly model: User | Admin | null;
-    /**
-     * Checks if the store has valid (aka. existing and unexpired) token.
-     */
-    readonly isValid: boolean;
-    /**
-     * Saves new token and model data in the auth store.
-     */
-    save(token: string, model: User | Admin | null): void;
-    /**
-     * Removes the stored token and model data form the auth store.
-     */
-    clear(): void;
-    /**
-     * Parses the provided cookie string and updates the store state
-     * with the cookie's token and model data.
-     */
-    loadFromCookie(cookie: string, key?: string): void;
-    /**
-     * Exports the current store state as cookie string.
-     */
-    exportToCookie(options?: SerializeOptions, key?: string): string;
-};
 /**
  * BaseService class that should be inherited from all API services.
  */
@@ -639,9 +598,9 @@ declare class Client {
      */
     lang: string;
     /**
-     * A replaceable instance of the local `AuthStore` service.
+     * A replaceable instance of the local auth store service.
      */
-    authStore: AuthStore | BaseAuthStore;
+    authStore: BaseAuthStore;
     /**
      * An instance of the service that handles the **Settings APIs**.
      */
@@ -671,11 +630,11 @@ declare class Client {
      */
     readonly realtime: Realtime;
     private cancelControllers;
-    constructor(baseUrl?: string, lang?: string, authStore?: AuthStore | BaseAuthStore | null);
+    constructor(baseUrl?: string, lang?: string, authStore?: BaseAuthStore | null);
     /**
      * @deprecated Legacy alias for `this.authStore`.
      */
-    get AuthStore(): AuthStore;
+    get AuthStore(): BaseAuthStore;
     /**
      * @deprecated Legacy alias for `this.settings`.
      */

diff --git a/dist/pocketbase.es.mjs.map b/dist/pocketbase.es.mjs.map
diff --git a/dist/pocketbase.iife.d.ts b/dist/pocketbase.iife.d.ts
@@ -131,47 +131,6 @@ declare abstract class BaseAuthStore {
     onChange(callback: () => void): () => void;
     protected triggerChange(): void;
 }
-/**
- * The minimal AuthStore interface.
- *
- * @deprecated
- * This interface predates the abstract BaseAuthStore class
- * and it is kept mainly for backward compatibility.
- *
- * New AuthStore implementations should extend directly the
- * BaseAuthStore abstract class.
- */
-type AuthStore = {
-    /**
-     * Retrieves the stored token (if any).
-     */
-    readonly token: string;
-    /**
-     * Retrieves the stored model data (if any).
-     */
-    readonly model: User | Admin | null;
-    /**
-     * Checks if the store has valid (aka. existing and unexpired) token.
-     */
-    readonly isValid: boolean;
-    /**
-     * Saves new token and model data in the auth store.
-     */
-    save(token: string, model: User | Admin | null): void;
-    /**
-     * Removes the stored token and model data form the auth store.
-     */
-    clear(): void;
-    /**
-     * Parses the provided cookie string and updates the store state
-     * with the cookie's token and model data.
-     */
-    loadFromCookie(cookie: string, key?: string): void;
-    /**
-     * Exports the current store state as cookie string.
-     */
-    exportToCookie(options?: SerializeOptions, key?: string): string;
-};
 /**
  * BaseService class that should be inherited from all API services.
  */
@@ -639,9 +598,9 @@ declare class Client {
      */
     lang: string;
     /**
-     * A replaceable instance of the local `AuthStore` service.
+     * A replaceable instance of the local auth store service.
      */
-    authStore: AuthStore | BaseAuthStore;
+    authStore: BaseAuthStore;
     /**
      * An instance of the service that handles the **Settings APIs**.
      */
@@ -671,11 +630,11 @@ declare class Client {
      */
     readonly realtime: Realtime;
     private cancelControllers;
-    constructor(baseUrl?: string, lang?: string, authStore?: AuthStore | BaseAuthStore | null);
+    constructor(baseUrl?: string, lang?: string, authStore?: BaseAuthStore | null);
     /**
      * @deprecated Legacy alias for `this.authStore`.
      */
-    get AuthStore(): AuthStore;
+    get AuthStore(): BaseAuthStore;
     /**
      * @deprecated Legacy alias for `this.settings`.
      */

diff --git a/dist/pocketbase.umd.d.ts b/dist/pocketbase.umd.d.ts
@@ -131,47 +131,6 @@ declare abstract class BaseAuthStore {
     onChange(callback: () => void): () => void;
     protected triggerChange(): void;
 }
-/**
- * The minimal AuthStore interface.
- *
- * @deprecated
- * This interface predates the abstract BaseAuthStore class
- * and it is kept mainly for backward compatibility.
- *
- * New AuthStore implementations should extend directly the
- * BaseAuthStore abstract class.
- */
-type AuthStore = {
-    /**
-     * Retrieves the stored token (if any).
-     */
-    readonly token: string;
-    /**
-     * Retrieves the stored model data (if any).
-     */
-    readonly model: User | Admin | null;
-    /**
-     * Checks if the store has valid (aka. existing and unexpired) token.
-     */
-    readonly isValid: boolean;
-    /**
-     * Saves new token and model data in the auth store.
-     */
-    save(token: string, model: User | Admin | null): void;
-    /**
-     * Removes the stored token and model data form the auth store.
-     */
-    clear(): void;
-    /**
-     * Parses the provided cookie string and updates the store state
-     * with the cookie's token and model data.
-     */
-    loadFromCookie(cookie: string, key?: string): void;
-    /**
-     * Exports the current store state as cookie string.
-     */
-    exportToCookie(options?: SerializeOptions, key?: string): string;
-};
 /**
  * BaseService class that should be inherited from all API services.
  */
@@ -639,9 +598,9 @@ declare class Client {
      */
     lang: string;
     /**
-     * A replaceable instance of the local `AuthStore` service.
+     * A replaceable instance of the local auth store service.
      */
-    authStore: AuthStore | BaseAuthStore;
+    authStore: BaseAuthStore;
     /**
      * An instance of the service that handles the **Settings APIs**.
      */
@@ -671,11 +630,11 @@ declare class Client {
      */
     readonly realtime: Realtime;
     private cancelControllers;
-    constructor(baseUrl?: string, lang?: string, authStore?: AuthStore | BaseAuthStore | null);
+    constructor(baseUrl?: string, lang?: string, authStore?: BaseAuthStore | null);
     /**
      * @deprecated Legacy alias for `this.authStore`.
      */
-    get AuthStore(): AuthStore;
+    get AuthStore(): BaseAuthStore;
     /**
      * @deprecated Legacy alias for `this.settings`.
      */

diff --git a/package.json b/package.json
@@ -1,5 +1,5 @@
 {
-    "version": "0.6.0",
+    "version": "0.6.1",
     "name": "pocketbase",
     "description": "PocketBase JavaScript SDK",
     "author": "Gani Georgiev",

diff --git a/src/Client.ts b/src/Client.ts
@@ -1,6 +1,5 @@
 import ClientResponseError from '@/ClientResponseError';
 import BaseAuthStore       from '@/stores/BaseAuthStore';
-import { AuthStore }       from '@/stores/utils/AuthStore';
 import LocalAuthStore      from '@/stores/LocalAuthStore';
 import Settings            from '@/services/Settings';
 import Admins              from '@/services/Admins';
@@ -70,9 +69,9 @@ export default class Client {
     lang: string;
 
     /**
-     * A replaceable instance of the local `AuthStore` service.
+     * A replaceable instance of the local auth store service.
      */
-    authStore: AuthStore | BaseAuthStore;
+    authStore: BaseAuthStore;
 
     /**
      * An instance of the service that handles the **Settings APIs**.
@@ -114,7 +113,7 @@ export default class Client {
     constructor(
         baseUrl = '/',
         lang = 'en-US',
-        authStore?: AuthStore | BaseAuthStore | null,
+        authStore?: BaseAuthStore | null,
     ) {
         this.baseUrl   = baseUrl;
         this.lang      = lang;
@@ -133,7 +132,7 @@ export default class Client {
     /**
      * @deprecated Legacy alias for `this.authStore`.
      */
-    get AuthStore(): AuthStore {
+    get AuthStore(): BaseAuthStore {
         return this.authStore;
     };
 

diff --git a/src/stores/utils/AuthStore.ts b/src/stores/utils/AuthStore.ts