updated changelog and OAuth2UrlCallback type

pocketbase · Apr 17, 2023 · cf5d381 · cf5d381
1 parent 08ccf66
commit cf5d381
Show file tree

Hide file tree

Showing 19 changed files with 44 additions and 59 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,14 +1,4 @@
-## 0.14.0-rc
-
-- Added new `pb.files` service:
-    ```js
-    // Builds and returns an absolute record file url for the provided filename.
-    🔓 pb.files.getUrl(record, filename, queryParams = {});
-
-    // Requests a new private file access token for the current auth model (admin or record).
-    🔐 pb.files.getToken(queryParams = {});
-    ```
-    _`pb.getFileUrl()` is soft-deprecated and acts as alias calling `pb.files.getUrl()` under the hood._
+## 0.14.0
 
 - Added simplified `authWithOAuth2()` version without having to implement custom redirect, deeplink or even page reload:
     ```js
@@ -17,6 +7,8 @@
     })
     ```
 
+    Works with PocketBase v0.15.0+.
+
     This method initializes a one-off realtime subscription and will
     open a popup window with the OAuth2 vendor page to authenticate.
     Once the external OAuth2 sign-in/sign-up flow is completed, the popup
@@ -28,8 +20,21 @@
     as redirect URL.
 
     _The "manual" code exchange flow is still supported as `authWithOAuth2Code(provider, code, codeVerifier, redirectUrl)`._
+
     _For backward compatibility it is also available as soft-deprecated function overload of `authWithOAuth2(provider, code, codeVerifier, redirectUrl)`._
 
+- Added new `pb.files` service:
+    ```js
+    // Builds and returns an absolute record file url for the provided filename.
+    🔓 pb.files.getUrl(record, filename, queryParams = {});
+
+    // Requests a new private file access token for the current auth model (admin or record).
+    🔐 pb.files.getToken(queryParams = {});
+    ```
+    _`pb.getFileUrl()` is soft-deprecated and acts as alias calling `pb.files.getUrl()` under the hood._
+
+    Works with PocketBase v0.15.0+.
+
 
 ## 0.13.1
 

diff --git a/README.md b/README.md
@@ -681,12 +681,12 @@ const pb = new PocketBase(baseUrl = '/', authStore = LocalAuthStore);
 // Authenticates a record with their username/email and password.
 🔓 pb.collection(collectionIdOrName).authWithPassword(usernameOrEmail, password, bodyParams = {}, queryParams = {});
 
-// Authenticates a record with OAuth2 code.
-🔓 pb.collection(collectionIdOrName).authWithOAuth2Code(provider, code, codeVerifier, redirectUrl, createData = {}, bodyParams = {}, queryParams = {});
-
 // Authenticates a record with OAuth2 provider without custom redirects, deeplinks or even page reload.
 🔓 pb.collection(collectionIdOrName).authWithOAuth2(authConfig);
 
+// Authenticates a record with OAuth2 code.
+🔓 pb.collection(collectionIdOrName).authWithOAuth2Code(provider, code, codeVerifier, redirectUrl, createData = {}, bodyParams = {}, queryParams = {});
+
 // Refreshes the current authenticated record model and auth token.
 🔐 pb.collection(collectionIdOrName).authRefresh(bodyParams = {}, queryParams = {});
 

diff --git a/dist/pocketbase.cjs.d.ts b/dist/pocketbase.cjs.d.ts
@@ -509,10 +509,7 @@ interface RecordSubscription<T = Record> {
     action: string; // eg. create, update, delete
     record: T;
 }
-type OAuth2UrlCallback = (data: OAuth2UrlCallbackData) => void;
-interface OAuth2UrlCallbackData {
-    url: string;
-}
+type OAuth2UrlCallback = (url: string) => void | Promise<void>;
 interface OAuth2AuthConfig {
     // the name of the OAuth2 provider (eg. "google")
     provider: string;
@@ -683,7 +680,7 @@ declare class RecordService extends CrudService<Record> {
      * Example:
      *
      * ```js
-     * const authData = await pb.collection('users').authWithOAuth2({
+     * const authData = await pb.collection("users").authWithOAuth2({
      *     provider: "google",
      * })
      * ```

diff --git a/dist/pocketbase.cjs.js b/dist/pocketbase.cjs.js
diff --git a/dist/pocketbase.cjs.js.map b/dist/pocketbase.cjs.js.map
diff --git a/dist/pocketbase.es.d.mts b/dist/pocketbase.es.d.mts
@@ -509,10 +509,7 @@ interface RecordSubscription<T = Record> {
     action: string; // eg. create, update, delete
     record: T;
 }
-type OAuth2UrlCallback = (data: OAuth2UrlCallbackData) => void;
-interface OAuth2UrlCallbackData {
-    url: string;
-}
+type OAuth2UrlCallback = (url: string) => void | Promise<void>;
 interface OAuth2AuthConfig {
     // the name of the OAuth2 provider (eg. "google")
     provider: string;
@@ -683,7 +680,7 @@ declare class RecordService extends CrudService<Record> {
      * Example:
      *
      * ```js
-     * const authData = await pb.collection('users').authWithOAuth2({
+     * const authData = await pb.collection("users").authWithOAuth2({
      *     provider: "google",
      * })
      * ```
@@ -1097,4 +1094,4 @@ declare function getTokenPayload(token: string): {
  * @param [expirationThreshold] Time in seconds that will be subtracted from the token `exp` property.
  */
 declare function isTokenExpired(token: string, expirationThreshold?: number): boolean;
-export { Client as default, ClientResponseError, BaseAuthStore, LocalAuthStore, getTokenPayload, isTokenExpired, ExternalAuth, Admin, Collection, Record, LogRequest, BaseModel, ListResult, SchemaField, CrudService, AdminService, CollectionService, LogService, RealtimeService, RecordService, SettingsService, SendOptions, BeforeSendResult, RecordAuthResponse, AuthProviderInfo, AuthMethodsList, RecordSubscription, OAuth2UrlCallback, OAuth2UrlCallbackData, OAuth2AuthConfig, OnStoreChangeFunc, UnsubscribeFunc, BaseQueryParams, ListQueryParams, RecordQueryParams, RecordListQueryParams, LogStatsQueryParams, FileQueryParams, FullListQueryParams, RecordFullListQueryParams };
+export { Client as default, ClientResponseError, BaseAuthStore, LocalAuthStore, getTokenPayload, isTokenExpired, ExternalAuth, Admin, Collection, Record, LogRequest, BaseModel, ListResult, SchemaField, CrudService, AdminService, CollectionService, LogService, RealtimeService, RecordService, SettingsService, SendOptions, BeforeSendResult, RecordAuthResponse, AuthProviderInfo, AuthMethodsList, RecordSubscription, OAuth2UrlCallback, OAuth2AuthConfig, OnStoreChangeFunc, UnsubscribeFunc, BaseQueryParams, ListQueryParams, RecordQueryParams, RecordListQueryParams, LogStatsQueryParams, FileQueryParams, FullListQueryParams, RecordFullListQueryParams };
diff --git a/dist/pocketbase.es.js b/dist/pocketbase.es.js
diff --git a/dist/pocketbase.es.js.map b/dist/pocketbase.es.js.map
diff --git a/dist/pocketbase.es.mjs b/dist/pocketbase.es.mjs
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
@@ -509,10 +509,7 @@ interface RecordSubscription<T = Record> {
     action: string; // eg. create, update, delete
     record: T;
 }
-type OAuth2UrlCallback = (data: OAuth2UrlCallbackData) => void;
-interface OAuth2UrlCallbackData {
-    url: string;
-}
+type OAuth2UrlCallback = (url: string) => void | Promise<void>;
 interface OAuth2AuthConfig {
     // the name of the OAuth2 provider (eg. "google")
     provider: string;
@@ -683,7 +680,7 @@ declare class RecordService extends CrudService<Record> {
      * Example:
      *
      * ```js
-     * const authData = await pb.collection('users').authWithOAuth2({
+     * const authData = await pb.collection("users").authWithOAuth2({
      *     provider: "google",
      * })
      * ```

diff --git a/dist/pocketbase.iife.js b/dist/pocketbase.iife.js
diff --git a/dist/pocketbase.iife.js.map b/dist/pocketbase.iife.js.map
diff --git a/dist/pocketbase.umd.d.ts b/dist/pocketbase.umd.d.ts
@@ -509,10 +509,7 @@ interface RecordSubscription<T = Record> {
     action: string; // eg. create, update, delete
     record: T;
 }
-type OAuth2UrlCallback = (data: OAuth2UrlCallbackData) => void;
-interface OAuth2UrlCallbackData {
-    url: string;
-}
+type OAuth2UrlCallback = (url: string) => void | Promise<void>;
 interface OAuth2AuthConfig {
     // the name of the OAuth2 provider (eg. "google")
     provider: string;
@@ -683,7 +680,7 @@ declare class RecordService extends CrudService<Record> {
      * Example:
      *
      * ```js
-     * const authData = await pb.collection('users').authWithOAuth2({
+     * const authData = await pb.collection("users").authWithOAuth2({
      *     provider: "google",
      * })
      * ```

diff --git a/dist/pocketbase.umd.js b/dist/pocketbase.umd.js
diff --git a/dist/pocketbase.umd.js.map b/dist/pocketbase.umd.js.map
diff --git a/package.json b/package.json
@@ -1,5 +1,5 @@
 {
-    "version": "0.14.0-rc2",
+    "version": "0.14.0",
     "name": "pocketbase",
     "description": "PocketBase JavaScript SDK",
     "author": "Gani Georgiev",

diff --git a/src/index.ts b/src/index.ts
@@ -32,7 +32,6 @@ import {
     AuthMethodsList,
     RecordSubscription,
     OAuth2UrlCallback,
-    OAuth2UrlCallbackData,
     OAuth2AuthConfig,
 } from '@/services/RecordService';
 import { UnsubscribeFunc } from '@/services/RealtimeService';
@@ -79,7 +78,6 @@ export {
     AuthMethodsList,
     RecordSubscription,
     OAuth2UrlCallback,
-    OAuth2UrlCallbackData,
     OAuth2AuthConfig,
     OnStoreChangeFunc,
     UnsubscribeFunc,

diff --git a/src/services/RecordService.ts b/src/services/RecordService.ts
@@ -38,11 +38,7 @@ export interface RecordSubscription<T = Record> {
     record: T;
 }
 
-export type OAuth2UrlCallback = (data: OAuth2UrlCallbackData) => void;
-
-export interface OAuth2UrlCallbackData {
-    url: string;
-}
+export type OAuth2UrlCallback = (url: string) => void|Promise<void>;
 
 export interface OAuth2AuthConfig {
     // the name of the OAuth2 provider (eg. "google")
@@ -405,7 +401,7 @@ export default class RecordService extends CrudService<Record> {
      * Example:
      *
      * ```js
-     * const authData = await pb.collection('users').authWithOAuth2({
+     * const authData = await pb.collection("users").authWithOAuth2({
      *     provider: "google",
      * })
      * ```
@@ -475,9 +471,7 @@ export default class RecordService extends CrudService<Record> {
                     url.searchParams.set("scope", config.scopes.join(" "));
                 }
 
-                const callbackData = { url: url.toString() };
-
-                config.urlCallback ? config.urlCallback(callbackData) : this._defaultUrlCallback(callbackData);
+                await (config.urlCallback ? config.urlCallback(url.toString()) : this._defaultUrlCallback(url.toString()));
             } catch (err) {
                 reject(new ClientResponseError(err));
             }
@@ -657,7 +651,7 @@ export default class RecordService extends CrudService<Record> {
 
     // ---------------------------------------------------------------
 
-    private _defaultUrlCallback(data: OAuth2UrlCallbackData) {
+    private _defaultUrlCallback(url: string) {
         if (typeof window === "undefined" || !window?.open) {
             throw new ClientResponseError(new Error(`Not in a browser context - please pass a custom urlCallback function.`));
         }
@@ -676,7 +670,7 @@ export default class RecordService extends CrudService<Record> {
         let top  = (windowHeight / 2) - (height / 2);
 
         window.open(
-            data.url,
+            url,
             "oauth2-popup",
             'width='+width+',height='+height+',top='+top+',left='+left+',resizable,menubar=no'
         );