@koolbase/core 12.5.0 → 12.6.0

package/dist/cjs/index.d.ts

@@ -12,6 +12,8 @@ export { KoolbaseAuth } from './auth.js';
 export { KoolbaseDatabase } from './database.js';
 export { KoolbaseCollectionController, collectionQueryKey, initialCollectionState, } from './collection-controller.js';
 export type { CollectionQuery, CollectionState, CollectionStatus } from './collection-controller.js';
+export { KoolbaseRecordController, initialRecordState } from './record-controller.js';
+export type { RecordState, RecordStatus } from './record-controller.js';
 export { KoolbaseFlags } from './flags.js';
 export { KoolbaseFunctions } from './functions.js';
 export { KoolbaseRealtime } from './realtime.js';

package/dist/cjs/index.js

@@ -19,7 +19,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.memoryPlatform = exports.getPlatform = exports.setPlatform = exports.RestoreResult = exports.koolbaseSdkVersion = exports.getOrCreateDeviceId = exports.KoolbaseMessaging = exports.isPending = exports.isFiscalized = exports.decodeFiscalResponse = exports.KoolbaseFiscalError = exports.KoolbaseFiscal = exports.disabledAnalytics = exports.KoolbaseAnalytics = exports.KoolbaseStorage = exports.KoolbaseRealtime = exports.KoolbaseFunctions = exports.KoolbaseFlags = exports.initialCollectionState = exports.collectionQueryKey = exports.KoolbaseCollectionController = exports.KoolbaseDatabase = exports.KoolbaseAuth = void 0;
+exports.memoryPlatform = exports.getPlatform = exports.setPlatform = exports.RestoreResult = exports.koolbaseSdkVersion = exports.getOrCreateDeviceId = exports.KoolbaseMessaging = exports.isPending = exports.isFiscalized = exports.decodeFiscalResponse = exports.KoolbaseFiscalError = exports.KoolbaseFiscal = exports.disabledAnalytics = exports.KoolbaseAnalytics = exports.KoolbaseStorage = exports.KoolbaseRealtime = exports.KoolbaseFunctions = exports.KoolbaseFlags = exports.initialRecordState = exports.KoolbaseRecordController = exports.initialCollectionState = exports.collectionQueryKey = exports.KoolbaseCollectionController = exports.KoolbaseDatabase = exports.KoolbaseAuth = void 0;
 __exportStar(require("./types.js"), exports);
 __exportStar(require("./errors.js"), exports);
 __exportStar(require("./network.js"), exports);
@@ -38,6 +38,9 @@ var collection_controller_js_1 = require("./collection-controller.js");
 Object.defineProperty(exports, "KoolbaseCollectionController", { enumerable: true, get: function () { return collection_controller_js_1.KoolbaseCollectionController; } });
 Object.defineProperty(exports, "collectionQueryKey", { enumerable: true, get: function () { return collection_controller_js_1.collectionQueryKey; } });
 Object.defineProperty(exports, "initialCollectionState", { enumerable: true, get: function () { return collection_controller_js_1.initialCollectionState; } });
+var record_controller_js_1 = require("./record-controller.js");
+Object.defineProperty(exports, "KoolbaseRecordController", { enumerable: true, get: function () { return record_controller_js_1.KoolbaseRecordController; } });
+Object.defineProperty(exports, "initialRecordState", { enumerable: true, get: function () { return record_controller_js_1.initialRecordState; } });
 var flags_js_1 = require("./flags.js");
 Object.defineProperty(exports, "KoolbaseFlags", { enumerable: true, get: function () { return flags_js_1.KoolbaseFlags; } });
 var functions_js_1 = require("./functions.js");

package/dist/cjs/record-controller.d.ts

@@ -0,0 +1,36 @@
+import type { KoolbaseDatabase } from './database.js';
+import type { KoolbaseRecord } from './types.js';
+export type RecordStatus = 'loading' | 'loaded' | 'notFound' | 'error';
+export interface RecordState {
+    readonly status: RecordStatus;
+    readonly record: KoolbaseRecord | null;
+    /** Why the first load failed, while status is 'error'. */
+    readonly error: unknown;
+    /** True while refresh() runs. */
+    readonly refreshing: boolean;
+}
+export declare const initialRecordState: RecordState;
+type RecordReader = Pick<KoolbaseDatabase, 'get'>;
+export declare class KoolbaseRecordController {
+    readonly collection: string;
+    readonly id: string;
+    private readonly db;
+    private state;
+    private readonly listeners;
+    private generation;
+    private disposed;
+    constructor(db: RecordReader, collection: string, id: string);
+    getState(): RecordState;
+    /** Called on every change. Returns the unsubscribe. */
+    subscribe(listener: () => void): () => void;
+    /** The first load. Call once; refresh() for later loads. */
+    load(): Promise<void>;
+    /** The record again, from the server. What is shown stays while it runs, and stays if it fails. */
+    refresh(): Promise<void>;
+    /** Stops all updates. A result still in flight is dropped when it lands. */
+    dispose(): void;
+    private fetch;
+    private isStale;
+    private set;
+}
+export {};

package/dist/cjs/record-controller.js

@@ -0,0 +1,110 @@
+"use strict";
+// One record, read by id, framework-free: the detail-screen counterpart of
+// KoolbaseCollectionController. @koolbase/react-native's useRecord wraps it.
+//
+//  - loading, loaded, notFound or error. notFound is its own state because
+//    the API answers a denied read as "not found" too (it does not reveal
+//    whether a record exists): a detail screen says "not available", not
+//    "something went wrong".
+//  - an empty id is notFound with no request: a screen opened without one.
+//  - a record from a different collection is notFound: the API names each
+//    record's collection, and a mistyped or crafted id must not put another
+//    collection's record on this screen.
+//  - refresh() keeps the record shown while it runs, and if it fails.
+//  - every fetch has a generation: a result superseded by a later refresh,
+//    or landing after dispose(), is dropped.
+// Not yet: an offline fallback from the record cache, which keeps data and
+// revision but not createdAt or createdBy.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KoolbaseRecordController = exports.initialRecordState = void 0;
+const database_errors_js_1 = require("./database-errors.js");
+exports.initialRecordState = Object.freeze({
+    status: 'loading',
+    record: null,
+    error: null,
+    refreshing: false,
+});
+class KoolbaseRecordController {
+    constructor(db, collection, id) {
+        this.state = exports.initialRecordState;
+        this.listeners = new Set();
+        this.generation = 0;
+        this.disposed = false;
+        this.db = db;
+        this.collection = collection;
+        this.id = id;
+    }
+    getState() {
+        return this.state;
+    }
+    /** Called on every change. Returns the unsubscribe. */
+    subscribe(listener) {
+        if (this.disposed)
+            return () => { };
+        this.listeners.add(listener);
+        return () => {
+            this.listeners.delete(listener);
+        };
+    }
+    /** The first load. Call once; refresh() for later loads. */
+    async load() {
+        if (this.disposed)
+            return;
+        await this.fetch();
+    }
+    /** The record again, from the server. What is shown stays while it runs, and stays if it fails. */
+    async refresh() {
+        if (this.disposed)
+            return;
+        this.set({ refreshing: true });
+        const gen = await this.fetch();
+        if (!this.isStale(gen))
+            this.set({ refreshing: false });
+    }
+    /** Stops all updates. A result still in flight is dropped when it lands. */
+    dispose() {
+        this.disposed = true;
+        this.listeners.clear();
+    }
+    async fetch() {
+        const gen = ++this.generation;
+        if (!this.id) {
+            this.set({ status: 'notFound', record: null, error: null });
+            return gen;
+        }
+        try {
+            const record = await this.db.get(this.id);
+            if (this.isStale(gen))
+                return gen;
+            if (record.collection !== undefined && record.collection !== this.collection) {
+                this.set({ status: 'notFound', record: null, error: null });
+            }
+            else {
+                this.set({ status: 'loaded', record, error: null });
+            }
+        }
+        catch (error) {
+            if (this.isStale(gen))
+                return gen;
+            if (error instanceof database_errors_js_1.KoolbaseNotFoundError) {
+                this.set({ status: 'notFound', record: null, error: null });
+            }
+            else if (this.state.record === null) {
+                this.set({ status: 'error', error });
+            }
+            // Otherwise keep the record shown: stale beats blank.
+        }
+        return gen;
+    }
+    isStale(gen) {
+        return this.disposed || gen !== this.generation;
+    }
+    set(patch) {
+        if (this.disposed)
+            return;
+        this.state = Object.freeze({ ...this.state, ...patch });
+        for (const listener of [...this.listeners])
+            listener();
+    }
+}
+exports.KoolbaseRecordController = KoolbaseRecordController;

package/dist/esm/index.d.ts

@@ -12,6 +12,8 @@ export { KoolbaseAuth } from './auth.js';
 export { KoolbaseDatabase } from './database.js';
 export { KoolbaseCollectionController, collectionQueryKey, initialCollectionState, } from './collection-controller.js';
 export type { CollectionQuery, CollectionState, CollectionStatus } from './collection-controller.js';
+export { KoolbaseRecordController, initialRecordState } from './record-controller.js';
+export type { RecordState, RecordStatus } from './record-controller.js';
 export { KoolbaseFlags } from './flags.js';
 export { KoolbaseFunctions } from './functions.js';
 export { KoolbaseRealtime } from './realtime.js';

package/dist/esm/index.js

@@ -16,6 +16,7 @@ export * from './storage-errors.js';
 export { KoolbaseAuth } from './auth.js';
 export { KoolbaseDatabase } from './database.js';
 export { KoolbaseCollectionController, collectionQueryKey, initialCollectionState, } from './collection-controller.js';
+export { KoolbaseRecordController, initialRecordState } from './record-controller.js';
 export { KoolbaseFlags } from './flags.js';
 export { KoolbaseFunctions } from './functions.js';
 export { KoolbaseRealtime } from './realtime.js';

package/dist/esm/record-controller.d.ts

@@ -0,0 +1,36 @@
+import type { KoolbaseDatabase } from './database.js';
+import type { KoolbaseRecord } from './types.js';
+export type RecordStatus = 'loading' | 'loaded' | 'notFound' | 'error';
+export interface RecordState {
+    readonly status: RecordStatus;
+    readonly record: KoolbaseRecord | null;
+    /** Why the first load failed, while status is 'error'. */
+    readonly error: unknown;
+    /** True while refresh() runs. */
+    readonly refreshing: boolean;
+}
+export declare const initialRecordState: RecordState;
+type RecordReader = Pick<KoolbaseDatabase, 'get'>;
+export declare class KoolbaseRecordController {
+    readonly collection: string;
+    readonly id: string;
+    private readonly db;
+    private state;
+    private readonly listeners;
+    private generation;
+    private disposed;
+    constructor(db: RecordReader, collection: string, id: string);
+    getState(): RecordState;
+    /** Called on every change. Returns the unsubscribe. */
+    subscribe(listener: () => void): () => void;
+    /** The first load. Call once; refresh() for later loads. */
+    load(): Promise<void>;
+    /** The record again, from the server. What is shown stays while it runs, and stays if it fails. */
+    refresh(): Promise<void>;
+    /** Stops all updates. A result still in flight is dropped when it lands. */
+    dispose(): void;
+    private fetch;
+    private isStale;
+    private set;
+}
+export {};

package/dist/esm/record-controller.js

@@ -0,0 +1,106 @@
+// One record, read by id, framework-free: the detail-screen counterpart of
+// KoolbaseCollectionController. @koolbase/react-native's useRecord wraps it.
+//
+//  - loading, loaded, notFound or error. notFound is its own state because
+//    the API answers a denied read as "not found" too (it does not reveal
+//    whether a record exists): a detail screen says "not available", not
+//    "something went wrong".
+//  - an empty id is notFound with no request: a screen opened without one.
+//  - a record from a different collection is notFound: the API names each
+//    record's collection, and a mistyped or crafted id must not put another
+//    collection's record on this screen.
+//  - refresh() keeps the record shown while it runs, and if it fails.
+//  - every fetch has a generation: a result superseded by a later refresh,
+//    or landing after dispose(), is dropped.
+// Not yet: an offline fallback from the record cache, which keeps data and
+// revision but not createdAt or createdBy.
+import { KoolbaseNotFoundError } from './database-errors.js';
+export const initialRecordState = Object.freeze({
+    status: 'loading',
+    record: null,
+    error: null,
+    refreshing: false,
+});
+export class KoolbaseRecordController {
+    constructor(db, collection, id) {
+        this.state = initialRecordState;
+        this.listeners = new Set();
+        this.generation = 0;
+        this.disposed = false;
+        this.db = db;
+        this.collection = collection;
+        this.id = id;
+    }
+    getState() {
+        return this.state;
+    }
+    /** Called on every change. Returns the unsubscribe. */
+    subscribe(listener) {
+        if (this.disposed)
+            return () => { };
+        this.listeners.add(listener);
+        return () => {
+            this.listeners.delete(listener);
+        };
+    }
+    /** The first load. Call once; refresh() for later loads. */
+    async load() {
+        if (this.disposed)
+            return;
+        await this.fetch();
+    }
+    /** The record again, from the server. What is shown stays while it runs, and stays if it fails. */
+    async refresh() {
+        if (this.disposed)
+            return;
+        this.set({ refreshing: true });
+        const gen = await this.fetch();
+        if (!this.isStale(gen))
+            this.set({ refreshing: false });
+    }
+    /** Stops all updates. A result still in flight is dropped when it lands. */
+    dispose() {
+        this.disposed = true;
+        this.listeners.clear();
+    }
+    async fetch() {
+        const gen = ++this.generation;
+        if (!this.id) {
+            this.set({ status: 'notFound', record: null, error: null });
+            return gen;
+        }
+        try {
+            const record = await this.db.get(this.id);
+            if (this.isStale(gen))
+                return gen;
+            if (record.collection !== undefined && record.collection !== this.collection) {
+                this.set({ status: 'notFound', record: null, error: null });
+            }
+            else {
+                this.set({ status: 'loaded', record, error: null });
+            }
+        }
+        catch (error) {
+            if (this.isStale(gen))
+                return gen;
+            if (error instanceof KoolbaseNotFoundError) {
+                this.set({ status: 'notFound', record: null, error: null });
+            }
+            else if (this.state.record === null) {
+                this.set({ status: 'error', error });
+            }
+            // Otherwise keep the record shown: stale beats blank.
+        }
+        return gen;
+    }
+    isStale(gen) {
+        return this.disposed || gen !== this.generation;
+    }
+    set(patch) {
+        if (this.disposed)
+            return;
+        this.state = Object.freeze({ ...this.state, ...patch });
+        for (const listener of [...this.listeners])
+            listener();
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@koolbase/core",
-  "version": "12.5.0",
+  "version": "12.6.0",
   "description": "Koolbase SDK core \u2014 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",