loosen the getUrl() type checks

pocketbase · Aug 28, 2023 · fa26b1c · fa26b1c
1 parent 78bf16c
commit fa26b1c
Show file tree

Hide file tree

Showing 17 changed files with 31 additions and 22 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,8 @@
+## 0.17.3-WIP
+
+- Loosen the type check when calling `pb.files.getUrl(user, filename)` to allow passing the `pb.authStore.model` without type assertion.
+
+
 ## 0.17.2
 
 - Fixed mulitple File/Blob array values not transformed properly to their FormData equivalent when an object syntax is used.

diff --git a/dist/pocketbase.cjs.d.ts b/dist/pocketbase.cjs.d.ts
@@ -841,9 +841,9 @@ declare class FileService extends BaseService {
     /**
      * Builds and returns an absolute record file url for the provided filename.
      */
-    getUrl(record: Pick<{
+    getUrl(record: {
         [key: string]: any;
-    }, "id" | "collectionId" | "collectionName">, filename: string, queryParams?: FileOptions): string;
+    }, filename: string, queryParams?: FileOptions): string;
     /**
      * Requests a new private file access token for the current auth model (admin or record).
      */

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
@@ -862,9 +862,9 @@ declare class FileService extends BaseService {
     /**
      * Builds and returns an absolute record file url for the provided filename.
      */
-    getUrl(record: Pick<{
+    getUrl(record: {
         [key: string]: any;
-    }, "id" | "collectionId" | "collectionName">, filename: string, queryParams?: FileOptions): string;
+    }, filename: string, queryParams?: FileOptions): string;
     /**
      * Requests a new private file access token for the current auth model (admin or record).
      */

diff --git a/dist/pocketbase.es.d.ts b/dist/pocketbase.es.d.ts
@@ -862,9 +862,9 @@ declare class FileService extends BaseService {
     /**
      * Builds and returns an absolute record file url for the provided filename.
      */
-    getUrl(record: Pick<{
+    getUrl(record: {
         [key: string]: any;
-    }, "id" | "collectionId" | "collectionName">, filename: string, queryParams?: FileOptions): string;
+    }, filename: string, queryParams?: FileOptions): string;
     /**
      * Requests a new private file access token for the current auth model (admin or record).
      */

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
@@ -841,9 +841,9 @@ declare class FileService extends BaseService {
     /**
      * Builds and returns an absolute record file url for the provided filename.
      */
-    getUrl(record: Pick<{
+    getUrl(record: {
         [key: string]: any;
-    }, "id" | "collectionId" | "collectionName">, filename: string, queryParams?: FileOptions): string;
+    }, filename: string, queryParams?: FileOptions): string;
     /**
      * Requests a new private file access token for the current auth model (admin or record).
      */

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
@@ -841,9 +841,9 @@ declare class FileService extends BaseService {
     /**
      * Builds and returns an absolute record file url for the provided filename.
      */
-    getUrl(record: Pick<{
+    getUrl(record: {
         [key: string]: any;
-    }, "id" | "collectionId" | "collectionName">, filename: string, queryParams?: FileOptions): string;
+    }, filename: string, queryParams?: FileOptions): string;
     /**
      * Requests a new private file access token for the current auth model (admin or record).
      */

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/src/services/FileService.ts b/src/services/FileService.ts
@@ -6,11 +6,15 @@ export class FileService extends BaseService {
      * Builds and returns an absolute record file url for the provided filename.
      */
     getUrl(
-        record: Pick<{[key:string]:any}, 'id' | 'collectionId' | 'collectionName'>,
+        record: {[key:string]:any},
         filename: string,
         queryParams: FileOptions = {}
     ): string {
-        if (!filename || !record?.id) {
+        if (
+            !filename ||
+            !record?.id ||
+            !(record?.collectionId || record?.collectionName)
+        ) {
             return '';
         }