@declaro/data 2.0.0-beta.9 → 2.0.0-beta.91

package/src/databaseConnection.ts

@@ -1,137 +0,0 @@
-import type { IDatastoreProvider, BaseModel, BaseModelClass } from '@declaro/core'
-import type { EntityManager, FilterQuery, Reference } from "@mikro-orm/core";
-import type { EntityRepository } from '@mikro-orm/postgresql'
-import { Hydrator } from "./hydrateEntity";
-import type { RemoveReturnType, UpsertReturnType } from "./datastoreAbstract";
-
-export type DatabaseConnectionOptions = {
-    populate?: string[];
-    immutableFields?: string[];
-};
-
-
-export class DatabaseConnection<T extends BaseModel<any>> implements IDatastoreProvider<T> {
-
-    private repository : EntityRepository<any>
-
-    public static inject = ['EntityManager', 'Reference'] as const;
-
-    public readonly em: EntityManager;
-    private hydrator: Hydrator;
-    private populate;
-    private immutableFields = [];
-
-    constructor(em : EntityManager, reference: typeof Reference) {
-        this.em = em;
-        this.hydrator = new Hydrator(this.em, reference);
-    }
-
-    setup(model: BaseModelClass<T>, options: DatabaseConnectionOptions) {
-        this.repository = this.em.getRepository(model);
-        this.populate = options?.populate;
-        if (options?.immutableFields) {
-            this.immutableFields = options.immutableFields;
-        }
-    }
-
-    getAll() {
-        return this.repository.findAll({populate: this.populate}).catch(e => {
-            console.log(e);
-        })
-    }
-
-    getWhere(filter?: FilterQuery<any>) {
-        return this.repository.find(filter, {populate: this.populate}).catch(e => {
-            console.log(e);
-        })
-    }
-
-    get(id: string | number) {
-        return this.repository.findOne(id, {populate: this.populate}).catch(e => {
-            console.log(e);
-        })
-    }
-
-    async upsert<T extends BaseModel<any> | BaseModel<any>[]>(data: T): Promise<UpsertReturnType<T>> {
-        if (Array.isArray(data)) {
-            const entities: BaseModel<any>[] = [];
-
-            for (const singleData of data) {
-                const entity = await this.singleUpsert(singleData);
-                entities.push(entity);
-            }
-
-            return entities as UpsertReturnType<T>;
-        } else {
-            return await this.singleUpsert(data) as UpsertReturnType<T>;
-        }
-    }
-
-    private async singleUpsert<T extends BaseModel<any>>(data: T) {
-        let entity: T;
-
-        // Get entity metadata
-        const meta = this.em.getMetadata().get(data.constructor.name);
-
-        // Create a shallow copy of data, excluding m:n fields, these are ignored for the
-        // shallow clone because those aren't stored in the row itself but rather a linking table
-        const shallowData: Partial<T> = {};
-        Object.keys(data).forEach((key) => {
-            const property = meta.properties[key];
-            if (property && property.reference !== 'm:n') {
-                shallowData[key] = data[key];
-            }
-        });
-
-        if (!data.id) {
-            // Create new entity with shallow data
-            entity = this.em.create(data.constructor.name, shallowData as any);
-            await this.em.persist(entity).flush();
-        } else {
-            // Fetch and merge for existing entity
-            entity = await this.em.findOneOrFail(data.constructor.name, data.id);
-        }
-        // NOTE: this is a current hacky workaround to prevent the em.assign call trying to reset the entity's id
-        // to undefined on an insert. This should probably actually reference the schema metadata to determine the PK
-        delete data.id;
-
-        this.immutableFields.forEach(f => {
-            if (f in data) {
-                data[f] = entity[f];
-            }
-        });
-        // Use em.assign to properly handle m:n relationships for both new and existing entities
-        this.em.assign(entity, data);
-        await this.em.persist(entity).flush();
-
-        return entity;
-    }
-
-    async remove(data: T[] | T): Promise<RemoveReturnType> {
-        if (Array.isArray(data)) {
-            const removedIds: (number|string)[] = [];
-            for (const singleData of data) {
-                if(await this.singleRemove(singleData)) {
-                    removedIds.push(singleData.id);
-                }
-            }
-            return removedIds;
-        } else {
-            return await this.singleRemove(data) ? data.id : null;
-        }
-    }
-
-    private async singleRemove<T extends BaseModel<any>>(data: T): Promise<boolean> {
-        try {
-            const entity = await this.em.findOneOrFail(data.constructor.name, data.id);
-            await this.em.remove(entity).flush();
-            return true;
-        } catch (e) {
-            if (e.constructor.name === 'NotFoundError') {
-                return false;
-            } else {
-                throw e;
-            }
-        }
-    }
-}

package/src/datastoreAbstract.ts

@@ -1,190 +0,0 @@
-import type { IDatastoreProvider, IDatastoreProviderWithFetch, BaseModel, BaseModelClass, IStore } from "@declaro/core";
-import type { FetchFunc } from '@declaro/core';
-import { TrackedStatusStore } from "./trackedStatus";
-import type { FilterQuery } from "@mikro-orm/core";
-
-export type TrackedPayload<T> = {
-    model: T,
-    requestId: string,
-    optimistic?: boolean
-}
-
-export type UpsertReturnType<T> = T extends (infer U)[] ? U[] : T;
-export type RemoveReturnType = (number|string)[] | number | string | null;
-
-export abstract class AbstractStore<T extends BaseModel<any>> implements IStore{
-    protected value: T[] = [];
-    private subscribers: Array<(value: T[]) => void> = [];
-
-    private hydrated = false;
-
-    public trackedStatus = new TrackedStatusStore();
-
-    protected constructor(
-      protected connection: IDatastoreProvider<T>,
-      protected model: BaseModelClass<T>,
-      protected options?: any)
-    {
-        this.connection.setup(this.model, options);
-    }
-
-    subscribe(subscription: (value: T[]) => void): (() => void) {
-        // Add the new subscriber to the subscribers array
-        this.subscribers.push(subscription);
-
-        // Immediately call the subscription with the current value
-        subscription(this.value);
-
-        // Return an unsubscribe function
-        return () => {
-            // Remove the subscriber from the subscribers array
-            this.subscribers = this.subscribers.filter(sub => sub !== subscription);
-        };
-    }
-
-    setFetch(fetch: FetchFunc) {
-        const connectionWithFetch = this.connection as IDatastoreProviderWithFetch<T>;
-
-        if (connectionWithFetch.setFetch) {
-            connectionWithFetch.setFetch(fetch);
-        }
-    }
-
-    set(value: T[]) {
-        // Update the current value
-        this.value = value;
-
-        // Notify all subscribers of the new value
-        this.subscribers.forEach(sub => sub(value));
-    }
-
-    async get(value: string | number) {
-        await this.hydrate(value)
-
-        if (typeof this.value == 'undefined') {
-            return null;
-        }
-
-        const matches = this.value.filter((i: T) => {
-            return i.id == value;
-        });
-        return matches[0];
-    }
-
-    async getWhere(filter?: FilterQuery<any>) {
-        await this.hydrate(null, filter);
-        return this.value;
-    }
-
-    async getAll() {
-        await this.hydrate();
-        return this.value;
-    }
-
-    async hydrate(id?: string | number, filter?: FilterQuery<any>): Promise<void> {
-        if (this.hydrated && !filter) {
-            return;
-        }
-        if (filter) {
-            const v = await this.connection.getWhere(filter);
-            if (v) {
-                this.set(v);
-            }
-        } else if (!id) {
-            const v = await this.connection.getAll();
-            if (v) {
-                this.set(v);
-            }
-        } else if (!filter) {
-            const v = await this.connection.get(id);
-            if (v) {
-                this.set([v]);
-            }
-        }
-        this.hydrated = true;
-    }
-
-    async upsert(model: T | T[], optimistic: boolean = false): Promise<UpsertReturnType<T>> {
-        if (Array.isArray(model)) {
-            const objArray = model.map(m => Object.assign(new this.model(), m));
-            if (optimistic) {
-                objArray.forEach(obj => this.insertIntoStore(obj));
-            }
-
-            const updatedArray: T[] = await this.connection.upsert(objArray);
-            updatedArray.forEach(obj => this.insertIntoStore(obj));
-
-            return updatedArray as UpsertReturnType<T>;
-        } else {
-            const obj = Object.assign(new this.model(), model);
-            if (optimistic) {
-                this.insertIntoStore(obj);
-            }
-
-            const updated: T = await this.connection.upsert(obj);
-            this.insertIntoStore(updated);
-
-            return updated as UpsertReturnType<T>;
-        }
-    }
-
-    async remove(model: T | T[], optimistic: boolean = false): Promise<RemoveReturnType> {
-        if (Array.isArray(model)) {
-            const objArray = model.map(m => Object.assign(new this.model(), m));
-            if (optimistic) {
-                objArray.forEach(obj => this.removeFromStore(obj));
-            }
-
-            const result: RemoveReturnType = await this.connection.remove(objArray);
-            objArray.forEach(obj => this.removeFromStore(obj));
-            return result;
-        } else {
-            const obj = Object.assign(new this.model(), model);
-            if (optimistic) {
-                this.removeFromStore(obj);
-            }
-
-            const result: RemoveReturnType = await this.connection.remove(obj);
-            this.removeFromStore(obj);
-            return result;
-        }
-    }
-
-    async trackedUpsert(payload: TrackedPayload<T | T[]>): Promise<UpsertReturnType<T>> {
-        try {
-            const ret = await this.upsert(payload.model);
-            this.trackedStatus.push({ requestId: payload.requestId, error: false, message: 'Upserted successfully' });
-            return ret;
-        } catch (e) {
-            this.trackedStatus.push({ requestId: payload.requestId, error: true, message: e.message });
-        }
-    }
-
-    async trackedRemove(payload: TrackedPayload<T | T[]>): Promise<RemoveReturnType> {
-        try {
-            const ret = await this.remove(payload.model);
-            this.trackedStatus.push({ requestId: payload.requestId, error: false, message: 'Removed successfully' });
-            return ret;
-        } catch (e) {
-            this.trackedStatus.push({ requestId: payload.requestId, error: true, message: e.message });
-        }
-    }
-
-    insertIntoStore(obj: T) {
-        const exists = this.value.some((i: T) => i.id === obj.id);
-        if (exists) {
-            this.set(this.value.map((i: T) => i.id === obj.id ? obj : i));
-        } else {
-            this.set([...this.value, obj]);
-        }
-    }
-
-    removeFromStore(obj: T) {
-        this.set(this.value.filter((i: T) => i.id !== obj.id));
-    }
-}
-
-// this is useful for dynamic references to methods on concrete extensions of this class
-export type ActionableStore = AbstractStore<BaseModel<any>> & {
-    [key: string]: (...args: any[]) => any;
-};

package/src/hydrateEntity.ts

@@ -1,36 +0,0 @@
-import type { EntityManager, Reference, EntityProperty } from "@mikro-orm/core";
-import type { BaseModel } from "@declaro/core";
-import type { EntitySchema } from "@mikro-orm/core";
-
-export class Hydrator {
-  constructor(
-    private readonly em: EntityManager,
-    private readonly reference: typeof Reference,
-  ) {}
-
-  hydrateEntity<T extends BaseModel<any>>(
-    entity: T
-  ): BaseModel<T> {
-    const metadata = this.em.getMetadata().get(entity.constructor.name);
-
-    for (const prop in entity) {
-      const property: EntityProperty = metadata.properties[prop];
-
-      // Check if this property is a relation (ManyToOne, OneToOne, etc.)
-      if (
-        entity[prop] !== undefined
-        && entity[prop] !== null
-        && property && ['m:1', '1:1'].includes(property.reference)
-      ) {
-        // in EntitySchema mode Mikro allows the entity to be another schema instead of an EntityName
-        const entitySchema = property.entity() as EntitySchema;
-
-        // this is force to an 'any' here because Mikro can understand a 'Reference' on an instance of our entity
-        // even when it's our native entity instead of a Mikro entity (User vs Entity<User>)
-        entity[prop] = this.reference.createFromPK(entitySchema.meta.class, entity[prop]) as any;
-      }
-    }
-
-    return entity;
-  }
-}

package/src/placeholder.test.ts

@@ -1,7 +0,0 @@
-import { describe, it, expect } from 'vitest'
-
-describe('Placeholder', () => {
-    it('should pass', () => {
-        expect(true).toBe(true)
-    })
-})

package/src/serverConnection.ts

@@ -1,74 +0,0 @@
-import type { IDatastoreProviderWithFetch, BaseModel, BaseModelClass } from '@declaro/core'
-import type { FetchFunc } from '@declaro/core'
-import type { FilterQuery } from "@mikro-orm/core";
-
-export class ServerConnection<T extends BaseModel<any>> implements IDatastoreProviderWithFetch<T> {
-
-    private fetch: FetchFunc;
-    private model: BaseModelClass<T>;
-
-    setup(model: BaseModelClass<T>) {
-        this.model = model;
-    }
-
-    setFetch(fetch: FetchFunc) {
-        this.fetch = fetch;
-    }
-
-    getAll(): Promise<any> {
-        return this.fetch(`/store/${this.model.name}/getAll`).then(r => {
-            return r.json().then((objs: any[]) => {
-                // turn results back into objects of the correct type
-                return objs.map(o => Object.assign(new this.model(), o));
-            });
-        });
-    }
-
-    getWhere(filter?: FilterQuery<any>) {
-        return this.fetch(`/store/${this.model.name}/getWhere/${JSON.stringify(filter)}`).then(r => {
-            return r.json().then((objs: any[]) => {
-                // turn results back into objects of the correct type
-                return objs.map(o => Object.assign(new this.model(), o));
-            });
-        });
-    }
-
-    get(id: string | number): Promise<any> {
-        return this.fetch(`/store/${this.model.name}/get/${id}`).then(r => {
-            return r.json();
-        })
-    }
-
-    upsert(model: T | T[]): Promise<any> {
-        return this._callStoreMethod('upsert', 'POST', model);
-    }
-
-    remove(model: T | T[]): Promise<any> {
-        return this._callStoreMethod('remove', 'POST', model);
-    }
-
-    _callStoreMethod(method: string, httpMethod: string, payload: any = null): Promise<any> {
-        let headers = {};
-
-        if (payload) {
-            headers['Content-Type'] = 'application/json;'
-            headers['Accept'] = 'application/json;'
-        }
-
-        return this.fetch(
-            `/store/${this.model.name}/${method}`,
-            {
-                method: httpMethod,
-                body: payload ? JSON.stringify(payload) : null,
-                headers
-            }
-        ).then(async r => {
-            const data = await r.json();
-            if (!r.ok) {
-                throw Error(data.message);
-            } else {
-                return data;
-            }
-        });
-    }
-}

package/src/trackedStatus.ts

@@ -1,35 +0,0 @@
-import type { IStore } from "@declaro/core";
-
-export type RequestStatus = { requestId: string, error: boolean, message: string }
-
-export class TrackedStatusStore implements IStore {
-  private value: { [key: string]: RequestStatus } = {};
-  private subscribers: Array<(value: { [key: string]: RequestStatus }) => void> = [];
-
-  subscribe(subscription: (value: { [key: string]: RequestStatus }) => void): (() => void) {
-    // Add the new subscriber to the subscribers array
-    this.subscribers.push(subscription);
-
-    // Immediately call the subscription with the current value
-    subscription(this.value);
-
-    // Return an unsubscribe function
-    return () => {
-      // Remove the subscriber from the subscribers array
-      this.subscribers = this.subscribers.filter(sub => sub !== subscription);
-    };
-  }
-
-  public push(status: RequestStatus) {
-    this.value = { ...this.value, [status.requestId]: status };
-
-    this.subscribers.forEach(sub => sub(this.value));
-  }
-
-  public remove(requestId: string) {
-    const { [requestId]: removedError, ...rest } = this.value;
-    this.value = rest;
-
-    this.subscribers.forEach(sub => sub(this.value));
-  }
-}

package/tsconfig.json

@@ -1,10 +0,0 @@
-{
-    "extends": ["../../tsconfig.json"],
-    "compilerOptions": {
-        "sourceMap": true
-    },
-    "include": ["src/*.ts", "src/**/*.ts", "src/**/*.d.ts"],
-    "buildOptions": {
-        "outDir": "dist"
-    }
-}

package/vite.config.ts

@@ -1,23 +0,0 @@
-import { resolve } from 'path'
-import { defineConfig } from 'vitest/config'
-import dts from 'vite-plugin-dts'
-
-const extensions = {
-    es: 'mjs',
-    cjs: 'cjs',
-}
-
-export default defineConfig({
-    build: {
-        lib: {
-            entry: resolve(__dirname, 'src/index.ts'),
-            name: 'DeclaroData',
-            formats: ['es', 'cjs'],
-            fileName: (format) => `declaro-data.${extensions[format]}`,
-        },
-    },
-    plugins: [dts()],
-    optimizeDeps: {
-        include: ['src/**/*'],
-    },
-})