@aiao/rxdb 0.0.1

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@aiao/rxdb",
+  "version": "0.0.1",
+  "type": "module",
+  "main": "./index.js",
+  "dependencies": {
+    "uuid": "^11.1.0",
+    "type-fest": "^4.41.0",
+    "@aiao/utils": "0.0.1",
+    "rxjs": "~7.8.0"
+  },
+  ".": {
+    "import": "./index.js",
+    "types": "./index.d.ts"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/repository/Repository.d.ts

@@ -0,0 +1,108 @@
+import { BehaviorSubject, Observable } from 'rxjs';
+import { SyncOptions } from '../entity/entity-metadata-options.interface';
+import { EntityType } from '../entity/entity.interface';
+import { RxDB } from '../RxDB';
+import { IRxDBAdapter, RxDBAdapterLocalBase, RxDBAdapterRemoteBase } from '../rxdb-adapter';
+import { CountOptions, FindAllOptions, FindByCursorOptions, FindOneOptions, FindOneOrFailOptions, FindOptions, GetOptions } from './query-options.interface';
+import { RuleGroup } from './query.interface';
+import { IRepository } from './repository.interface';
+/**
+ * 实体仓库
+ * 根据配置决策实体的具体操作
+ */
+export declare class Repository<T extends EntityType, RT extends IRepository<T> = IRepository<T>> implements IRepository<T> {
+    protected rxdb: RxDB;
+    protected EntityType: EntityType;
+    /**
+     * 本地适配器
+     */
+    protected localAdapterSub: BehaviorSubject<string>;
+    protected localAdapter$: Observable<IRxDBAdapter & RxDBAdapterLocalBase>;
+    /**
+     * 本地仓库
+     */
+    protected local$: Observable<RT>;
+    /**
+     * 远程适配器
+     */
+    protected remoteAdapterSub: BehaviorSubject<string>;
+    protected remoteAdapter$: Observable<IRxDBAdapter & RxDBAdapterRemoteBase>;
+    /**
+     * 远程仓库
+     */
+    protected remote$: Observable<IRepository<EntityType>>;
+    /**
+     * 同步配置
+     * TODO: 待实现同步功能
+     */
+    sync: SyncOptions;
+    constructor(rxdb: RxDB, EntityType: EntityType);
+    /**
+     * 根据 id 获取实体
+     * @param id
+     * @param options
+     */
+    get(id: string, options?: GetOptions): Observable<InstanceType<T>>;
+    /**
+     * 查找一个实体
+     * @param where
+     * @param options
+     */
+    findOne(where: RuleGroup<InstanceType<T>>, options?: FindOneOptions): Observable<InstanceType<T> | undefined>;
+    /**
+     * 查找一个实体，查不到就抛出错误
+     * @param where
+     * @param options
+     */
+    findOneOrFail(where: RuleGroup<InstanceType<T>>, options?: FindOneOrFailOptions): Observable<InstanceType<T>>;
+    /**
+     * 查询多个实体
+     * @param where
+     * @param options
+     */
+    find(where: RuleGroup<InstanceType<T>>, options?: FindOptions): Observable<InstanceType<T>[]>;
+    /**
+     * 查询所有实体
+     * @param where
+     * @param options
+     */
+    findAll(where: RuleGroup<InstanceType<T>>, options?: FindAllOptions): Observable<InstanceType<T>[]>;
+    /**
+     * 通过指针查询实体
+     * @param where
+     * @param options
+     */
+    findByCursor(where: RuleGroup<InstanceType<T>>, options?: FindByCursorOptions): Observable<InstanceType<T>[]>;
+    /**
+     * 查询实体数量
+     * @param where
+     * @param options
+     */
+    count(where: RuleGroup<InstanceType<T>>, options?: CountOptions): Observable<number>;
+    /**
+     * 事务保存
+     * @param entities 需要保存的实体
+     */
+    transactionSave(entities: InstanceType<T>[]): Promise<any>;
+    /**
+     * 创建实体
+     * @param entity
+     */
+    create(entity: InstanceType<T>): Promise<InstanceType<T>>;
+    /**
+     * 更新实体
+     * @param entity
+     * @param patch
+     */
+    update(entity: InstanceType<T>, patch: Partial<InstanceType<T>>): Promise<InstanceType<T>>;
+    /**
+     * 删除实体
+     * @param entity
+     */
+    remove(entity: InstanceType<T>): Promise<InstanceType<T>>;
+    /**
+     * 设置状态 local
+     */
+    protected _setLocalEntityStatus: (entity: InstanceType<T>) => boolean;
+    protected _setLocalEntitiesStatus: (entities: InstanceType<T>[]) => void;
+}

package/repository/RepositoryBase.d.ts

@@ -0,0 +1,32 @@
+import { EntityType, UUID } from '../entity/entity.interface';
+import { RxDB } from '../RxDB';
+/**
+ * 数据仓库
+ * 用来协调数据存取
+ */
+export declare abstract class RepositoryBase<T extends EntityType> {
+    protected readonly rxdb: RxDB;
+    protected readonly EntityClass: T;
+    constructor(rxdb: RxDB, EntityClass: T);
+    /**
+     * 获取实体实例
+     * @param data 实体数据
+     */
+    createEntityRef(data: Partial<InstanceType<T>> & {
+        id: UUID;
+    }): any;
+    /**
+     * 获取实体实例
+     * @param id 实体的 ID
+     */
+    getEntityRef(id: UUID): InstanceType<T> | undefined;
+    /**
+     * 获取实体实例
+     * @param id 实体的 ID
+     */
+    hasEntityRef(id: UUID): boolean;
+    /**
+     * 更新实体
+     */
+    updateEntity(entity: InstanceType<T>, newValue: Partial<InstanceType<T>>): void;
+}

package/repository/TreeRepository.d.ts

@@ -0,0 +1,28 @@
+import { Observable } from 'rxjs';
+import { EntityType } from '../entity/entity.interface';
+import { RuleGroup } from './query.interface';
+import { Repository } from './Repository';
+import { FindTreeOptions } from './tree-query-options.interface';
+import { ITreeRepository } from './tree-repository.interface';
+/**
+ * 树结构实体仓库
+ * 根据配置决策实体的具体操作
+ */
+export declare class TreeRepository<T extends EntityType, RepositoryType extends ITreeRepository<T> = ITreeRepository<T>> extends Repository<T, RepositoryType> implements ITreeRepository<T> {
+    /**
+     * 查询子孙
+     */
+    findDescendants(entity: InstanceType<T>, where: RuleGroup<InstanceType<T>>, options: FindTreeOptions): Observable<InstanceType<T>[]>;
+    /**
+     * 查询子孙数量
+     */
+    countDescendants(entity: InstanceType<T>, where: RuleGroup<InstanceType<T>>, options: FindTreeOptions): Observable<number>;
+    /**
+     * 查询祖先
+     */
+    findAncestors(entity: InstanceType<T>, where: RuleGroup<InstanceType<T>>, options: FindTreeOptions): Observable<InstanceType<T>[]>;
+    /**
+     * 查询祖先数量
+     */
+    countAncestors(entity: InstanceType<T>, where: RuleGroup<InstanceType<T>>, options: FindTreeOptions): Observable<number>;
+}

package/repository/query-options.interface.d.ts

@@ -0,0 +1,53 @@
+/**
+ * 排序
+ */
+export interface OrderBy<FieldType extends string = string> {
+    field: FieldType;
+    order: 'asc' | 'desc';
+}
+/**
+ * Get 查询选项
+ */
+export type GetOptions = object;
+/**
+ * FindOne 查询选项
+ */
+export interface FindOneOptions<OrderByFieldType extends string = string> {
+    orderBy?: OrderBy<OrderByFieldType>[];
+}
+/**
+ * FindOneOrFail 查询选项
+ */
+export interface FindOneOrFailOptions<OrderByFieldType extends string = string> {
+    orderBy?: OrderBy<OrderByFieldType>[];
+}
+/**
+ * Find 查询选项
+ */
+export interface FindOptions<OrderByFieldType extends string = string> {
+    orderBy?: OrderBy<OrderByFieldType>[];
+    limit?: number;
+    offset?: number;
+}
+/**
+ * FindAll 查询选项
+ */
+export interface FindAllOptions<OrderByFieldType extends string = string> {
+    orderBy?: OrderBy<OrderByFieldType>[];
+}
+/**
+ * FindByCursor 查询选项
+ */
+export interface FindByCursorOptions<OrderByFieldType extends string = string> {
+    orderBy?: OrderBy<OrderByFieldType>[];
+    before?: string;
+    after?: string;
+    first?: number;
+    last?: number;
+}
+/**
+ * Count 查询选项
+ */
+export interface CountOptions {
+    groupBy?: string[];
+}

package/repository/query.interface.d.ts

@@ -0,0 +1,92 @@
+import { SetNonNullable } from 'type-fest';
+import { UUID } from '../entity/entity.interface';
+/**
+ * 判断相等
+ */
+interface RuleEqualNullable<T, K extends keyof T = keyof T, VT = T[K]> {
+    field: K;
+    operator: '=' | '!=';
+    value: VT;
+}
+/**
+ * 字符串比较
+ */
+interface RuleStringNonNullable<T, K extends keyof T = keyof T, VT = T[K]> {
+    field: K;
+    operator: '<' | '>' | '<=' | '>=' | 'contains' | 'notContain' | 'beginWith' | 'notBeginWith' | 'endWith' | 'notEndWith';
+    value: SetNonNullable<VT>;
+}
+/**
+ * 数值比较
+ */
+interface RuleNumberNonNullable<T, K extends keyof T = keyof T, VT = T[K]> {
+    field: K;
+    operator: '<' | '>' | '<=' | '>=';
+    value: SetNonNullable<VT>;
+}
+/**
+ * in
+ */
+interface RuleIn<T, K extends keyof T = keyof T, VT = T[K]> {
+    field: K;
+    operator: 'in' | 'notIn';
+    value: SetNonNullable<VT>[];
+}
+/**
+ * between
+ */
+interface RuleBetween<T, K extends keyof T = keyof T, VT = T[K]> {
+    field: K;
+    operator: 'between' | 'notBetween';
+    value: [SetNonNullable<VT>, SetNonNullable<VT>];
+}
+/**
+ * UUID
+ */
+export type UUIDRules<T, K extends keyof T = keyof T, VT = T[K]> = RuleEqualNullable<T, K> | RuleIn<T, K, VT>;
+/**
+ * string
+ */
+export type StringRules<T, K extends keyof T = keyof T, VT = T[K]> = RuleEqualNullable<T, K, VT> | RuleStringNonNullable<T, K, VT> | RuleIn<T, K, VT> | RuleBetween<T, K, VT>;
+/**
+ * number
+ */
+export type NumberRules<T, K extends keyof T = keyof T, VT = T[K]> = RuleEqualNullable<T, K, VT> | RuleNumberNonNullable<T, K, VT> | RuleIn<T, K, VT> | RuleBetween<T, K, VT>;
+/**
+ * Boolean
+ */
+export type BooleanRules<T, K extends keyof T = keyof T, VT = T[K]> = RuleEqualNullable<T, K, VT>;
+/**
+ * Date
+ */
+export type DateRules<T, K extends keyof T = keyof T, VT = T[K]> = RuleEqualNullable<T, K, VT> | RuleNumberNonNullable<T, K, VT> | RuleIn<T, K, VT> | RuleBetween<T, K, VT>;
+export type OneToOneRules<T, K extends keyof T = keyof T> = RuleEqualNullable<T, K, UUID> | RuleIn<T, K, UUID>;
+export type ManyToOneRules<T, K extends keyof T = keyof T> = RuleEqualNullable<T, K, UUID> | RuleIn<T, K, UUID>;
+export type OneToManyRules<T, K extends keyof T = keyof T> = RuleIn<T, K, UUID>;
+export type ManyToManyRules<T, K extends keyof T = keyof T> = RuleIn<T, K, UUID>;
+/**
+ * 查询规则
+ */
+export type Rule<T = any, K extends keyof T = keyof T, VT = T[K]> = RuleEqualNullable<T, K, VT> | RuleStringNonNullable<T, K, VT> | RuleIn<T, K, VT> | RuleBetween<T, K, VT>;
+/**
+ * 查询规则组
+ */
+export interface RuleGroup<T = any, K extends keyof T = keyof T, RT = Rule<T, K, T[K]>> {
+    combinator: 'and' | 'or';
+    rules: Array<RuleGroup<T, K, RT> | RT>;
+}
+/**
+ * 所有操作符
+ */
+export type OperatorName = '=' | '!=' | '<' | '>' | '<=' | '>=' | 'contains' | 'notContain' | 'beginWith' | 'notBeginWith' | 'endWith' | 'notEndWith' | 'null' | 'notNull' | 'in' | 'notIn' | 'between' | 'notBetween';
+/**
+ * 操作类型
+ */
+export type MutationType = 'create' | 'update' | 'remove';
+/**
+ * 查询上下文
+ */
+export interface IQueryContext {
+    userId?: string;
+}
+export {};

package/repository/query.utils.d.ts

@@ -0,0 +1,19 @@
+import { EntityType } from '../entity/entity.interface';
+import { OrderBy } from './query-options.interface';
+import { RuleGroup } from './query.interface';
+/**
+ * 判断是否是 RuleGroup
+ */
+export declare const isRuleGroup: (value: unknown) => value is RuleGroup<any>;
+/**
+ * 判断实体是否匹配规则组
+ */
+export declare const isEntityMatchRuleGroup: <T extends EntityType>(entity: T, ruleGroup: RuleGroup<T>) => boolean;
+/**
+ * 判断 entity 是否在排序后的结果中
+ * @param entities 排序后的结果
+ * @param entity 需要判断的实体
+ * @param orderByArray 排序数组
+ * @returns
+ */
+export declare const isEntityEffectOrderBy: <T extends EntityType>(entities: T[], entity: T, orderByArray: OrderBy<string>[]) => boolean | undefined;

package/repository/repository.interface.d.ts

@@ -0,0 +1,84 @@
+import { Observable } from 'rxjs';
+import { EntityType } from '../entity/entity.interface';
+import { CountOptions, FindAllOptions, FindByCursorOptions, FindOneOptions, FindOneOrFailOptions, FindOptions, GetOptions } from './query-options.interface';
+import { RuleGroup } from './query.interface';
+/**
+ * 数据仓库管理接口
+ */
+export interface IRepository<T extends EntityType> {
+    /**
+     * 根据 id 获取实体
+     * @param id
+     * @param options
+     */
+    get(id: string, options?: GetOptions): Observable<InstanceType<T>>;
+    /**
+     * 查找一个实体
+     * @param where
+     * @param options
+     */
+    findOne(where: RuleGroup<InstanceType<T>>, options?: FindOneOptions): Observable<InstanceType<T> | undefined>;
+    /**
+     * 查找一个实体，查不到就抛出错误
+     * @param where
+     * @param options
+     */
+    findOneOrFail(where: RuleGroup<InstanceType<T>>, options?: FindOneOrFailOptions): Observable<InstanceType<T>>;
+    /**
+     * 查询多个实体
+     * @param where
+     * @param options
+     */
+    find(where: RuleGroup<InstanceType<T>>, options?: FindOptions): Observable<InstanceType<T>[]>;
+    /**
+     * 查询所有实体
+     * @param where
+     * @param options
+     */
+    findAll(where: RuleGroup<InstanceType<T>>, options?: FindAllOptions): Observable<InstanceType<T>[]>;
+    /**
+     * 通过指针查询实体
+     * @param where
+     * @param options
+     */
+    findByCursor(where: RuleGroup<InstanceType<T>>, options?: FindByCursorOptions): Observable<InstanceType<T>[]>;
+    /**
+     * 查询实体数量
+     * @param where
+     * @param options
+     */
+    count(where: RuleGroup<InstanceType<T>>, options?: CountOptions): Observable<number>;
+    /**
+     * 创建实体
+     * @param entity
+     */
+    create(entity: InstanceType<T>): Promise<InstanceType<T>>;
+    /**
+     * 更新实体
+     * @param entity
+     * @param patch
+     */
+    update(entity: InstanceType<T>, patch: Partial<InstanceType<T>>): Promise<InstanceType<T>>;
+    /**
+     * 删除实体
+     * @param entity
+     */
+    remove(entity: InstanceType<T>): Promise<InstanceType<T>>;
+}
+/**
+ * 同步状态
+ */
+export declare enum SyncStatus {
+    /**
+     * 已同步
+     */
+    Synced = "Synced",
+    /**
+     * 同步中
+     */
+    Syncing = "Syncing",
+    /**
+     * 从未同步
+     */
+    Never = "Never"
+}

package/repository/tree-query-options.interface.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 树结构查询配置
+ */
+export interface FindTreeOptions {
+    /**
+     * 查询级别
+     */
+    level?: number;
+}

package/repository/tree-repository.interface.d.ts

@@ -0,0 +1,26 @@
+import { Observable } from 'rxjs';
+import { EntityType } from '../entity/entity.interface';
+import { RuleGroup } from './query.interface';
+import { IRepository } from './repository.interface';
+import { FindTreeOptions } from './tree-query-options.interface';
+/**
+ * 树结构仓库接口
+ */
+export interface ITreeRepository<T extends EntityType> extends IRepository<T> {
+    /**
+     * 查询子孙实体
+     */
+    findDescendants(entity: InstanceType<T>, where: RuleGroup<InstanceType<T>>, options?: FindTreeOptions): Observable<InstanceType<T>[]>;
+    /**
+     * 查询子孙实体数量
+     */
+    countDescendants(entity: InstanceType<T>, where: RuleGroup<InstanceType<T>>, options?: FindTreeOptions): Observable<number>;
+    /**
+     * 查询祖先节点
+     */
+    findAncestors(entity: InstanceType<T>, where: RuleGroup<InstanceType<T>>, options?: FindTreeOptions): Observable<InstanceType<T>[]>;
+    /**
+     * 查询祖先节点数量
+     */
+    countAncestors(entity: InstanceType<T>, where: RuleGroup<InstanceType<T>>, options?: FindTreeOptions): Observable<number>;
+}

package/rxdb-adapter.d.ts

@@ -0,0 +1,73 @@
+import { Observable } from 'rxjs';
+import { EntityType } from './entity/entity.interface';
+import { IRepository } from './repository/repository.interface';
+import { RxDB } from './RxDB';
+/**
+ * 事务回调函数
+ */
+export type TransactionFun = () => Promise<any>;
+/**
+ * RxDB 数据库适配器接口
+ */
+export interface IRxDBAdapter {
+    readonly name: string;
+    /**
+     * 连接数据库
+     */
+    connect(): Observable<IRxDBAdapter>;
+    /**
+     * 取消连接
+     */
+    disconnect(): Promise<void>;
+    /**
+     * 获取数据库版本
+     */
+    version(): Promise<string>;
+    /**
+     * 获取仓库
+     */
+    getRepository<T extends EntityType, RT extends IRepository<T>>(EntityType: EntityType): RT;
+    /**
+     * 创建 table
+     */
+    createTable(EntityType: EntityType): Promise<boolean>;
+    /**
+     * 判断 table 是否存在
+     */
+    isTableExisted(EntityType: EntityType): Promise<boolean>;
+}
+/**
+ * 数据库适配器基类
+ */
+export declare abstract class RxDBAdapterBase {
+    readonly rxdb: RxDB;
+    constructor(rxdb: RxDB);
+}
+/**
+ * 数据库适配器基类
+ */
+export declare abstract class RxDBAdapterLocalBase extends RxDBAdapterBase {
+    /**
+     * 执行事务
+     */
+    abstract transaction(fun: TransactionFun): Promise<any>;
+}
+/**
+ * 数据库适配器基类
+ */
+export declare abstract class RxDBAdapterRemoteBase extends RxDBAdapterBase {
+}
+/**
+ * 适配器基础配置
+ */
+export type IRxDBAdapterOptions = Record<string, any>;
+/**
+ * RxDB 插件
+ */
+export type AdapterFactory = (rxDB: RxDB) => Promise<IRxDBAdapter> | IRxDBAdapter;
+/**
+ * RxDB 适配器
+ */
+export interface RxDBAdapters {
+    [name: string]: IRxDBAdapter;
+}