@data-weave/datamanager 0.3.8

package/CHANGELOG.md

@@ -0,0 +1,50 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## [0.3.8](https://github.com/data-weave/datamanager/compare/v0.3.7...v0.3.8) (2025-09-28)
+
+**Note:** Version bump only for package @data-weave/datamanager
+
+## [0.3.7](https://github.com/data-weave/datamanager/compare/v0.3.6...v0.3.7) (2025-09-28)
+
+**Note:** Version bump only for package @data-weave/datamanager
+
+## [0.3.6](https://github.com/data-weave/datamanager/compare/v0.3.5...v0.3.6) (2025-09-28)
+
+**Note:** Version bump only for package @data-weave/datamanager
+
+## [0.3.5](https://github.com/data-weave/datamanager/compare/v0.3.4...v0.3.5) (2025-09-28)
+
+**Note:** Version bump only for package @data-weave/datamanager
+
+## [0.3.4](https://github.com/data-weave/datamanager/compare/v0.3.3...v0.3.4) (2025-09-28)
+
+**Note:** Version bump only for package @data-weave/datamanager
+
+## [0.3.2](https://github.com/data-weave/datamanager/compare/v0.3.1...v0.3.2) (2025-09-28)
+
+**Note:** Version bump only for package @data-weave/datamanager
+
+## [0.3.1](https://github.com/data-weave/datamanager/compare/v0.3.0...v0.3.1) (2025-09-28)
+
+**Note:** Version bump only for package @data-weave/datamanager
+
+## 0.3.0 (2025-09-28)
+
+### Features
+
+- add code quality workflow and circular dep check ([9c7b7e3](https://github.com/data-weave/datamanager/commit/9c7b7e34501dfc95ddc2bcff686f55db06d9b1b8))
+- project re-organization ([4a00af3](https://github.com/data-weave/datamanager/commit/4a00af36c4c2f6e49287542e0d5ad85acaa50cda))
+
+### Bug Fixes
+
+- adjust config and lib versions ([9c7e2c9](https://github.com/data-weave/datamanager/commit/9c7e2c9072ea34b1e54326c2612b43c92ec2da4e))
+- implement Cache prop & clean up some of anys ([955b11a](https://github.com/data-weave/datamanager/commit/955b11a6ab05224f843db834ad28796602679fac))
+
+### Code Refactoring
+
+- abstract out firestoreReference into LiveReference ([7848a87](https://github.com/data-weave/datamanager/commit/7848a872155593e5acab56696d4d9f27f0e6abb2))
+- abstract out LiveList function from FirestorList ([bb4278e](https://github.com/data-weave/datamanager/commit/bb4278e960d0080d1fb18d847036acb189782ec9))
+- adjustments for LiveList & ListReference ([49cd540](https://github.com/data-weave/datamanager/commit/49cd540295693e40bbb9eb75b5101b45c6932921))

package/lib/Cache.ts

@@ -0,0 +1,41 @@
+export interface Cache<K = any, V = any> {
+    get(key: K): V | undefined
+    set(key: K, value: V): void
+    has(key: K): boolean
+}
+
+export class MapCache<K, V> implements Cache<K, V> {
+    private cache = new Map<K, V>()
+    private maxSize?: number
+
+    constructor(maxSize?: number) {
+        this.maxSize = maxSize
+    }
+
+    get(key: K): V | undefined {
+        return this.cache.get(key)
+    }
+
+    set(key: K, value: V): void {
+        if (this.maxSize && this.cache.size >= this.maxSize && !this.cache.has(key)) {
+            // Remove the first entry (oldest) when cache is full
+            const firstKey = this.cache.keys().next().value
+            if (firstKey) {
+                this.cache.delete(firstKey)
+            }
+        }
+        this.cache.set(key, value)
+    }
+
+    has(key: K): boolean {
+        return this.cache.has(key)
+    }
+
+    delete(key: K): boolean {
+        return this.cache.delete(key)
+    }
+
+    clear(): void {
+        this.cache.clear()
+    }
+}

package/lib/DataManager.ts

@@ -0,0 +1,49 @@
+import { List } from './List'
+import { IdentifiableReference, WithoutId } from './Reference'
+
+export interface ReadOptions {
+    readonly transaction?: unknown
+}
+
+export interface WriteOptions {
+    readonly transaction?: unknown
+    readonly batcher?: unknown
+}
+
+export interface CreateOptions extends WriteOptions {
+    id?: string
+    merge?: boolean
+}
+
+export type OrderByOption = 'asc' | 'desc'
+
+export interface GetListOptions {
+    readonly filterBy?: unknown
+    readonly orderBy?: unknown
+    readonly limit?: number
+}
+
+export interface Metadata {
+    readonly id: string
+    readonly createdAt: Date
+    readonly updatedAt: Date
+    readonly deleted: boolean
+}
+
+// Copy of Firestore DocumentData definition
+type DocumentData = {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    [field: string]: any
+}
+
+export type WithMetadata<T extends DocumentData> = T & Metadata
+export abstract class DataManager<T extends DocumentData> {
+    public abstract read(id: string): Promise<T | undefined>
+    public abstract create(data: WithoutId<T>, options?: CreateOptions): Promise<IdentifiableReference<WithMetadata<T>>>
+    public abstract delete(id: string): Promise<void>
+    public abstract update(id: string, data: Partial<WithoutId<T>>): Promise<void>
+    public abstract upsert(id: string, data: WithoutId<T>): Promise<void>
+
+    public abstract getRef(id: string): IdentifiableReference<WithMetadata<T>>
+    public abstract getList(params?: GetListOptions): List<WithMetadata<T>>
+}

package/lib/List.ts

@@ -0,0 +1,24 @@
+import { Resolvable } from './Reference'
+
+export interface ListPaginationParams {
+    readonly pageSize?: number
+    readonly append?: boolean
+    readonly loadFirstPageManually?: boolean
+}
+
+export interface List<T> extends Resolvable<readonly T[]> {
+    readonly values: readonly T[]
+}
+
+export function createInitializedList<T>(values: ReadonlyArray<T>): List<T> {
+    return {
+        values,
+        resolved: true,
+        hasError: false,
+        resolve: async () => values,
+    }
+}
+
+export function createEmptyList<T>(): List<T> {
+    return createInitializedList([])
+}

package/lib/LiveList.ts

@@ -0,0 +1,70 @@
+import { List } from './List'
+
+export interface LiveListOptions<T> {
+    onUpdate?: (newValues: T[]) => void
+    onError?: (error: unknown) => void
+}
+
+export class LiveList<T> implements List<T> {
+    private _values: T[] = []
+    private _resolved: boolean = false
+    private _hasError: boolean = false
+    private _options: LiveListOptions<T>
+
+    constructor(options: LiveListOptions<T>) {
+        this._options = options
+    }
+
+    resolve(): Promise<readonly T[]> {
+        throw new Error('Method not implemented.')
+    }
+
+    public get values() {
+        return this._values
+    }
+
+    public get hasError() {
+        return this._hasError
+    }
+
+    public get resolved() {
+        return this._resolved
+    }
+
+    protected setStale() {
+        this._resolved = false
+    }
+
+    protected onValuesChange(): void {}
+
+    protected onUpdate(): void {
+        this._resolved = true
+        this.onValuesChange()
+        this._options.onUpdate?.(this._values)
+    }
+
+    protected onUpdateAll(values: T[]): void {
+        this._values = values
+        this.onUpdate()
+    }
+
+    protected onUpdateAtIndex(index: number, value: T): void {
+        this._values[index] = value
+    }
+
+    protected onAddAtIndex(index: number, value: T): void {
+        this._values.splice(index, 0, value)
+    }
+
+    protected onRemoveAtIndex(index: number): void {
+        this._values.splice(index, 1)
+    }
+
+    protected onError(error: unknown): void {
+        this._hasError = true
+        this._values = []
+        this._resolved = true
+        this._options.onError?.(error)
+        this.onValuesChange()
+    }
+}

package/lib/LiveReference.ts

@@ -0,0 +1,57 @@
+import { Reference } from './Reference'
+
+export interface LiveReferenceOptions<T> {
+    onUpdate?: (newValue: T | undefined) => void
+    onError?: (error: unknown) => void
+}
+
+export class LiveReference<T> implements Reference<T> {
+    private _value: T | undefined
+    private _resolved: boolean = false
+    private _hasError: boolean = false
+    private _options: LiveReferenceOptions<T>
+
+    resolve(): Promise<T | undefined> {
+        throw new Error('Method not implemented.')
+    }
+
+    constructor(readonly options: LiveReferenceOptions<T>) {
+        this._value = undefined
+        this._resolved = false
+        this._hasError = false
+        this._options = options
+    }
+
+    public get value(): T | undefined {
+        return this._value
+    }
+
+    public get resolved() {
+        return this._resolved
+    }
+
+    public get hasError() {
+        return this._hasError
+    }
+
+    protected setStale() {
+        this._resolved = false
+    }
+
+    protected onUpdate(data: T | undefined): void {
+        this._value = data
+        this._resolved = true
+        this.onValueChange()
+        this._options.onUpdate?.(this._value)
+    }
+
+    protected onError(error: unknown) {
+        this._hasError = true
+        this._value = undefined
+        this._resolved = true
+        this.onValueChange()
+        this._options.onError?.(error)
+    }
+
+    protected onValueChange(): void {}
+}

package/lib/Reference.ts

@@ -0,0 +1,34 @@
+export interface Identifiable {
+    readonly id: string
+}
+
+export type WithoutId<T> = Omit<T, 'id'>
+
+export interface Resolvable<T> {
+    readonly resolved: boolean
+    readonly hasError: boolean
+    resolve(): Promise<T>
+}
+
+export interface Reference<T> extends Resolvable<T | undefined> {
+    readonly value: T | undefined
+}
+
+export type IdentifiableReference<T> = Reference<T> & Identifiable
+
+export function createInitializedIdentifiableReference<T>(
+    value: T | undefined,
+    id: string
+): Reference<T> & Identifiable {
+    return {
+        id,
+        value,
+        resolved: true,
+        hasError: false,
+        resolve: async () => value,
+    }
+}
+
+export function createEmptyIdentifiableReference<T>(id: string): Reference<T> {
+    return createInitializedIdentifiableReference<T>(undefined, id)
+}

package/lib/index.ts

@@ -0,0 +1,6 @@
+export * from './Cache'
+export * from './DataManager'
+export * from './List'
+export * from './LiveList'
+export * from './LiveReference'
+export * from './Reference'

package/lib/version.js

@@ -0,0 +1,2 @@
+// Generated by genversion.
+module.exports = '0.3.8';

package/package.json

@@ -0,0 +1,21 @@
+{
+    "name": "@data-weave/datamanager",
+    "version": "0.3.8",
+    "author": "",
+    "main": "lib/index.js",
+    "types": "lib/index.d.ts",
+    "scripts": {
+        "build": "genversion --semi lib/version.js",
+        "build:clean": "rimraf android/build && rimraf ios/build",
+        "prepare": "npm run build"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/data-weave/datamanager/tree/master/packages/datamanager"
+    },
+    "publishConfig": {
+        "access": "public",
+        "registry": "https://registry.npmjs.org/"
+    },
+    "gitHead": "15240bc24e96bab7e184edd81f18fbf64b52d8c9"
+}