@koolbase/core 12.1.0 → 12.3.0

package/dist/esm/network.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Network failures, made actionable.
+ *
+ * A browser rejects a request it may not make cross-origin with the same bare
+ * TypeError ("Failed to fetch") as a dead network, and deliberately hides which
+ * it was. The SDK cannot tell them apart either, so it names the likely causes,
+ * starting with the one only the app's developer can fix: Trusted Origins.
+ *
+ * It stays a TypeError, so code that tells a network failure from a server
+ * rejection that way (the offline queue) behaves exactly as before.
+ */
+export declare class KoolbaseNetworkError extends TypeError {
+    code: string;
+    readonly url: string;
+    readonly origin?: string;
+    constructor(url: string, cause: unknown);
+}
+/** fetch, with network failures turned into a KoolbaseNetworkError. */
+export declare function koolbaseFetch(input: string, init?: RequestInit): Promise<Response>;

package/dist/esm/network.js

@@ -0,0 +1,47 @@
+/**
+ * Network failures, made actionable.
+ *
+ * A browser rejects a request it may not make cross-origin with the same bare
+ * TypeError ("Failed to fetch") as a dead network, and deliberately hides which
+ * it was. The SDK cannot tell them apart either, so it names the likely causes,
+ * starting with the one only the app's developer can fix: Trusted Origins.
+ *
+ * It stays a TypeError, so code that tells a network failure from a server
+ * rejection that way (the offline queue) behaves exactly as before.
+ */
+export class KoolbaseNetworkError extends TypeError {
+    constructor(url, cause) {
+        const loc = globalThis.location;
+        const origin = loc?.origin && loc.origin !== 'null' ? loc.origin : undefined;
+        const reason = cause instanceof Error ? cause.message : String(cause);
+        let host = url;
+        try {
+            host = new URL(url).origin;
+        }
+        catch {
+            // keep the raw url
+        }
+        let message = `Could not reach Koolbase at ${host} (${reason}).`;
+        message += origin
+            ? ` If you are online, check that this site's address (${origin}) is in the project's Trusted Origins in the Koolbase dashboard.`
+            : ' Check the network connection and the configured base URL.';
+        super(message);
+        this.code = 'network_error';
+        this.name = 'KoolbaseNetworkError';
+        this.url = url;
+        this.origin = origin;
+        Object.setPrototypeOf(this, new.target.prototype);
+    }
+}
+/** fetch, with network failures turned into a KoolbaseNetworkError. */
+export async function koolbaseFetch(input, init) {
+    try {
+        return await fetch(input, init);
+    }
+    catch (e) {
+        // A request the caller cancelled keeps its meaning.
+        if (e?.name === 'AbortError')
+            throw e;
+        throw new KoolbaseNetworkError(input, e);
+    }
+}

package/dist/esm/storage.js

@@ -1,3 +1,4 @@
+import { koolbaseFetch } from './network.js';
 import { KoolbaseUnauthenticatedError } from './errors.js';
 import { KoolbaseStorageError, koolbaseStorageErrorFromResponse, } from './storage-errors.js';
 // --- Cloudflare image-transform URL helpers -------------------------------
@@ -94,7 +95,7 @@ export class KoolbaseStorage {
             ? options.file.type || 'application/octet-stream'
             : options.file.type;
         // ─── Step 1: Get presigned upload URL ───
-        const urlRes = await fetch(`${this.config.baseUrl}/v1/sdk/storage/upload-url`, {
+        const urlRes = await koolbaseFetch(`${this.config.baseUrl}/v1/sdk/storage/upload-url`, {
             method: 'POST',
             headers: {
                 ...(await this.buildHeaders()),
@@ -120,9 +121,9 @@ export class KoolbaseStorage {
         // the two hosts differ here and nowhere else in this method.
         const fileBlob = isBlob
             ? options.file
-            : await (await fetch(options.file.uri)).blob();
+            : await (await koolbaseFetch(options.file.uri)).blob();
         const fileSize = fileBlob.size;
-        const uploadRes = await fetch(upload_url, {
+        const uploadRes = await koolbaseFetch(upload_url, {
             method: 'PUT',
             headers: { 'Content-Type': contentType },
             body: fileBlob,
@@ -149,7 +150,7 @@ export class KoolbaseStorage {
         if (options.metadata !== undefined) {
             confirmBody.metadata = options.metadata;
         }
-        const confirmRes = await fetch(`${this.config.baseUrl}/v1/sdk/storage/confirm`, {
+        const confirmRes = await koolbaseFetch(`${this.config.baseUrl}/v1/sdk/storage/confirm`, {
             method: 'POST',
             headers: {
                 ...(await this.buildHeaders()),
@@ -200,7 +201,7 @@ export class KoolbaseStorage {
      * // -> { category: 'landscape', tag: 'sunset' }
      */
     async updateMetadata(bucket, path, metadata) {
-        const res = await fetch(`${this.config.baseUrl}/v1/sdk/storage/objects/metadata`, {
+        const res = await koolbaseFetch(`${this.config.baseUrl}/v1/sdk/storage/objects/metadata`, {
             method: 'PATCH',
             headers: {
                 ...(await this.buildHeaders()),
@@ -223,7 +224,7 @@ export class KoolbaseStorage {
         if (versionId) {
             url += `&version_id=${encodeURIComponent(versionId)}`;
         }
-        const res = await fetch(url, { headers: await this.buildHeaders() });
+        const res = await koolbaseFetch(url, { headers: await this.buildHeaders() });
         if (!res.ok) {
             throw await this.error(res, 'Failed to get download URL');
         }
@@ -318,7 +319,7 @@ export class KoolbaseStorage {
         const url = forcePurge
             ? `${this.config.baseUrl}/v1/sdk/storage/object?force_purge=true`
             : `${this.config.baseUrl}/v1/sdk/storage/object`;
-        const res = await fetch(url, {
+        const res = await koolbaseFetch(url, {
             method: 'DELETE',
             headers: {
                 ...(await this.buildHeaders()),
@@ -345,7 +346,7 @@ export class KoolbaseStorage {
     async listVersions(bucket, path) {
         const url = `${this.config.baseUrl}/v1/sdk/storage/object-versions` +
             `?bucket=${encodeURIComponent(bucket)}&path=${encodeURIComponent(path)}`;
-        const res = await fetch(url, { headers: await this.buildHeaders() });
+        const res = await koolbaseFetch(url, { headers: await this.buildHeaders() });
         if (!res.ok) {
             throw await this.error(res, 'Failed to list versions');
         }
@@ -361,7 +362,7 @@ export class KoolbaseStorage {
     async getVersion(bucket, path, versionId) {
         const url = `${this.config.baseUrl}/v1/sdk/storage/object-versions/${encodeURIComponent(versionId)}` +
             `?bucket=${encodeURIComponent(bucket)}&path=${encodeURIComponent(path)}`;
-        const res = await fetch(url, { headers: await this.buildHeaders() });
+        const res = await koolbaseFetch(url, { headers: await this.buildHeaders() });
         if (!res.ok) {
             throw await this.error(res, 'Failed to fetch version');
         }
@@ -380,7 +381,7 @@ export class KoolbaseStorage {
     async restoreVersion(bucket, path, versionId) {
         const url = `${this.config.baseUrl}/v1/sdk/storage/object-versions/${encodeURIComponent(versionId)}/restore` +
             `?bucket=${encodeURIComponent(bucket)}&path=${encodeURIComponent(path)}`;
-        const res = await fetch(url, {
+        const res = await koolbaseFetch(url, {
             method: 'POST',
             headers: await this.buildHeaders(),
         });
@@ -398,7 +399,7 @@ export class KoolbaseStorage {
     async purgeVersion(bucket, path, versionId) {
         const url = `${this.config.baseUrl}/v1/sdk/storage/object-versions/${encodeURIComponent(versionId)}` +
             `?bucket=${encodeURIComponent(bucket)}&path=${encodeURIComponent(path)}`;
-        const res = await fetch(url, {
+        const res = await koolbaseFetch(url, {
             method: 'DELETE',
             headers: await this.buildHeaders(),
         });

package/dist/esm/sync-engine.js

@@ -1,3 +1,4 @@
+import { koolbaseFetch } from './network.js';
 import { readOfflineState, mutateOfflineState, migrateLegacyQueue, flushLockName, } from './offline-state.js';
 import { KoolbaseUnauthenticatedError } from './errors.js';
 import { getPlatform } from './platform.js';
@@ -242,7 +243,7 @@ export class SyncEngine {
             : `${this.config.baseUrl}/v1/sdk/db/records/${write.recordId}`;
         let res;
         if (write.operation === 'insert') {
-            res = await fetch(url, {
+            res = await koolbaseFetch(url, {
                 method: 'POST',
                 headers,
                 // The write's own id: generated at enqueue, identical on every retry.
@@ -256,7 +257,7 @@ export class SyncEngine {
             });
         }
         else if (write.operation === 'update') {
-            res = await fetch(url, {
+            res = await koolbaseFetch(url, {
                 method: 'PATCH',
                 headers,
                 // The revision the change was composed against. The server applies it
@@ -275,7 +276,7 @@ export class SyncEngine {
             const q = write.baseRevision !== undefined
                 ? `?expected_revision=${write.baseRevision}`
                 : '';
-            res = await fetch(`${url}${q}`, { method: 'DELETE', headers });
+            res = await koolbaseFetch(`${url}${q}`, { method: 'DELETE', headers });
         }
         if (res.status === 401)
             throw new KoolbaseUnauthenticatedError('unauthorized');

package/dist/esm/types.d.ts

@@ -239,6 +239,13 @@ export interface QueryOptions {
     orderBy?: string;
     orderDesc?: boolean;
     populate?: string[];
+    /**
+     * How to read: 'default' is cache-first, refreshed in the background;
+     * 'network-only' skips the cache and waits for the server (the result still
+     * refreshes the cache). Use 'network-only' after a write this client did not
+     * make, by a Function or another user, when you need the server's state now.
+     */
+    cache?: 'default' | 'network-only';
 }
 export interface QueryResult {
     records: KoolbaseRecord[];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@koolbase/core",
-  "version": "12.1.0",
-  "description": "Koolbase SDK core \u2014 shared behaviour behind @koolbase/react-native and @koolbase/js. Install one of those, not this.",
+  "version": "12.3.0",
+  "description": "Koolbase SDK core — shared behaviour behind @koolbase/react-native and @koolbase/js. Install one of those, not this.",
   "main": "./dist/cjs/index.js",
   "types": "./dist/esm/index.d.ts",
   "files": [