@aiao/rxdb 0.0.1

package/rxdb-events.d.ts

@@ -0,0 +1,186 @@
+import { EntityType, UUID } from './entity/entity.interface';
+import { UnixMilliseconds } from './rxdb.interface';
+import { UpdatedBy } from './rxdb.private';
+/**
+ * RxDB 实体事件抽象类
+ */
+declare abstract class AbstractRxDBEntityEvent {
+    readonly entity: InstanceType<EntityType>;
+    abstract type: string;
+    constructor(entity: InstanceType<EntityType>);
+}
+/**
+ * RxDB 实体错误事件抽象类
+ */
+declare abstract class AbstractRxDBEntityErrorEvent extends AbstractRxDBEntityEvent {
+    readonly error: any;
+    constructor(entity: InstanceType<EntityType>, error: any);
+}
+export declare const ENTITY_NEW_EVENT = "ENTITY_NEW";
+/**
+ * 实体 被 new 出来
+ */
+export declare class EntityNewEvent extends AbstractRxDBEntityEvent {
+    type: string;
+}
+export declare const ENTITY_CREATE_EVENT = "ENTITY_CREATE";
+export declare const ENTITY_CREATE_SUCCESS_EVENT = "ENTITY_CREATE_SUCCESS";
+export declare const ENTITY_CREATE_ERROR_EVENT = "ENTITY_CREATE_ERROR";
+/**
+ * 实体 正在被创建
+ */
+export declare class EntityCreateEvent extends AbstractRxDBEntityEvent {
+    type: string;
+}
+/**
+ * 实体 创建成功
+ */
+export declare class EntityCreateSuccessEvent extends AbstractRxDBEntityEvent {
+    type: string;
+}
+/**
+ * 实体 创建错误
+ */
+export declare class EntityCreateErrorEvent extends AbstractRxDBEntityErrorEvent {
+    type: string;
+}
+export declare const ENTITY_UPDATE_EVENT = "ENTITY_UPDATE";
+export declare const ENTITY_UPDATE_SUCCESS_EVENT = "ENTITY_UPDATE_SUCCESS";
+export declare const ENTITY_UPDATE_ERROR_EVENT = "ENTITY_UPDATE_ERROR";
+/**
+ * 实体 准备更新
+ */
+export declare class EntityUpdateEvent extends AbstractRxDBEntityEvent {
+    type: string;
+}
+/**
+ * 实体 更新成功
+ */
+export declare class EntityUpdateSuccessEvent extends AbstractRxDBEntityEvent {
+    type: string;
+}
+/**
+ * 实体 更新失败
+ */
+export declare class EntityUpdateErrorEvent extends AbstractRxDBEntityErrorEvent {
+    type: string;
+}
+export declare const ENTITY_REMOVE_EVENT = "ENTITY_REMOVE";
+export declare const ENTITY_REMOVE_SUCCESS_EVENT = "ENTITY_REMOVE_SUCCESS";
+export declare const ENTITY_REMOVE_ERROR_EVENT = "ENTITY_REMOVE_ERROR";
+/**
+ * 实体 准备删除
+ */
+export declare class EntityRemoveEvent extends AbstractRxDBEntityEvent {
+    type: string;
+}
+/**
+ * 实体 删除成功
+ */
+export declare class EntityRemoveSuccessEvent extends AbstractRxDBEntityEvent {
+    type: string;
+}
+/**
+ * 实体 删除失败
+ */
+export declare class EntityRemoveErrorEvent extends AbstractRxDBEntityErrorEvent {
+    type: string;
+}
+export declare const ENTITY_PATCH_EVENT = "ENTITY_PATCH";
+/**
+ * 实体 部分更新
+ */
+export declare class EntityPatchEvent extends AbstractRxDBEntityEvent {
+    readonly patch: Record<string, any>;
+    readonly inversePatch: Record<string, any>;
+    readonly recordAt: UnixMilliseconds;
+    readonly timeStamp: DOMHighResTimeStamp;
+    readonly updatedBy: UpdatedBy;
+    type: string;
+    constructor(entity: InstanceType<EntityType>, patch: Record<string, any>, inversePatch: Record<string, any>, recordAt: UnixMilliseconds, timeStamp: DOMHighResTimeStamp, updatedBy: UpdatedBy);
+}
+/**
+ * 实体 所有事件
+ */
+export interface RxDBEntityEventMap {
+    [ENTITY_NEW_EVENT]: EntityNewEvent;
+    [ENTITY_CREATE_EVENT]: EntityCreateEvent;
+    [ENTITY_CREATE_SUCCESS_EVENT]: EntityCreateSuccessEvent;
+    [ENTITY_CREATE_ERROR_EVENT]: EntityCreateErrorEvent;
+    [ENTITY_PATCH_EVENT]: EntityPatchEvent;
+    [ENTITY_UPDATE_EVENT]: EntityUpdateEvent;
+    [ENTITY_UPDATE_SUCCESS_EVENT]: EntityUpdateSuccessEvent;
+    [ENTITY_UPDATE_ERROR_EVENT]: EntityUpdateErrorEvent;
+    [ENTITY_REMOVE_EVENT]: EntityRemoveEvent;
+    [ENTITY_REMOVE_SUCCESS_EVENT]: EntityRemoveSuccessEvent;
+    [ENTITY_REMOVE_ERROR_EVENT]: EntityRemoveErrorEvent;
+}
+export declare const TRANSACTION_BEGIN = "TRANSACTION_BEGIN";
+export declare const TRANSACTION_COMMIT = "TRANSACTION_COMMIT";
+export declare const TRANSACTION_ROLLBACK = "TRANSACTION_ROLLBACK";
+/**
+ * 事务 开始
+ */
+export declare class TransactionBeginEvent {
+    type: string;
+}
+/**
+ * 事务 提交
+ */
+export declare class TransactionCommitEvent {
+    type: string;
+}
+/**
+ * 事务 回滚
+ */
+export declare class TransactionRollbackEvent {
+    type: string;
+}
+export declare const DATABASE_DELETE = "DATABASE_DELETE";
+export declare const DATABASE_INSERT = "DATABASE_INSERT";
+export declare const DATABASE_UPDATE = "DATABASE_UPDATE";
+/**
+ * 数据变化
+ */
+export interface IRxDBAdapterDataChange {
+    id?: UUID;
+    rowId?: any;
+    data?: any;
+    recordAt: UnixMilliseconds;
+    timeStamp: DOMHighResTimeStamp;
+}
+declare abstract class AbstractRxDBAdapterDataChangeEvent {
+    readonly EntityType: EntityType;
+    readonly data: IRxDBAdapterDataChange;
+    abstract type: string;
+    constructor(EntityType: EntityType, data: IRxDBAdapterDataChange);
+}
+export declare class RxDBAdapterDeleteChangeEvent extends AbstractRxDBAdapterDataChangeEvent {
+    type: string;
+}
+export declare class RxDBAdapterInsertChangeEvent extends AbstractRxDBAdapterDataChangeEvent {
+    type: string;
+}
+export declare class RxDBAdapterUpdateChangeEvent extends AbstractRxDBAdapterDataChangeEvent {
+    type: string;
+}
+/**
+ * Rxdb 事件
+ */
+export interface RxDBEventMap extends RxDBEntityEventMap {
+    [TRANSACTION_BEGIN]: TransactionBeginEvent;
+    [TRANSACTION_COMMIT]: TransactionCommitEvent;
+    [TRANSACTION_ROLLBACK]: TransactionRollbackEvent;
+    [DATABASE_DELETE]: RxDBAdapterDeleteChangeEvent;
+    [DATABASE_INSERT]: RxDBAdapterInsertChangeEvent;
+    [DATABASE_UPDATE]: RxDBAdapterUpdateChangeEvent;
+}
+/**
+ * RxDB 实体事件
+ */
+export type RxDBEntityEvent = RxDBEntityEventMap[keyof RxDBEntityEventMap];
+/**
+ * RxDB 事件
+ */
+export type RxDBEvent = RxDBEventMap[keyof RxDBEventMap];
+export {};

package/rxdb-plugin.d.ts

@@ -0,0 +1,20 @@
+import { RxDB } from './RxDB';
+/**
+ * RxDB 插件接口
+ */
+export interface IRxDBPlugin {
+    name: Uncapitalize<string>;
+    install(): Promise<void>;
+    destroy(): Promise<void>;
+}
+/**
+ * RxDB 插件基类
+ */
+export declare abstract class RxDBPluginBase {
+    protected readonly rxdb: RxDB;
+    constructor(rxdb: RxDB);
+}
+/**
+ * RxDB 插件
+ */
+export type Plugin<Options = any> = (rxDB: RxDB, options?: Options) => IRxDBPlugin;

package/rxdb-utils.d.ts

@@ -0,0 +1,20 @@
+import { EntityMetadata } from './entity/entity-metadata.interface';
+import { EntityType, UUID } from './entity/entity.interface';
+import { EntityStatus } from './entity/EntityStatus';
+/**
+ * 获取实体元数据
+ */
+export declare const getEntityMetadata: <T extends EntityType>(target: T | InstanceType<T>) => EntityMetadata;
+/**
+ * 获取实体状态
+ */
+export declare const getEntityStatus: <T extends EntityType>(target: InstanceType<T>) => EntityStatus<T>;
+/**
+ * class 的装饰器
+ * 代码生成时会重复创建这个方法，所以统一引用 rxdb 里的减少代码量
+ */
+export declare const __decorateClass: (decorators: any, target: any, key: any, kind: number) => any;
+/**
+ * 生成 uuid
+ */
+export declare const uuid: () => UUID;

package/rxdb.interface.d.ts

@@ -0,0 +1,56 @@
+import { SyncOptions } from './entity/entity-metadata-options.interface';
+import { EntityType } from './entity/entity.interface';
+/**
+ * 升级脚步
+ */
+export interface MigrationType {
+    up(): Promise<void>;
+    down(): Promise<void>;
+}
+/**
+ * RxDB 环境上下文
+ */
+export interface RxDBContext {
+    userId?: string;
+}
+/**
+ * RxDB 配置
+ */
+export interface RxDBOptions {
+    /**
+     * 数据库名称
+     */
+    dbName: string;
+    /**
+     * 所有实体
+     */
+    entities: EntityType[];
+    /**
+     * 升级脚本
+     */
+    migrations?: MigrationType[];
+    /**
+     * 默认的同步配置
+     */
+    sync: SyncOptions;
+    /**
+     * 环境上下文
+     */
+    context?: RxDBContext;
+    /**
+     * 关系查询深度
+     * 最小为 1
+     * @default 2
+     * @example 1 允许查询自己的基本属性 + 自己的关系的基本属性
+     * @example 2 允许查询自己的基本属性 + 自己的关系的基本属性 + 自己关系的关系的基本属性
+     */
+    relationQueryDeep?: number;
+}
+/**
+ * unix(毫秒)时间
+ */
+export type UnixMilliseconds = number;
+/**
+ * unix(秒)时间
+ */
+export type UnixSeconds = number;

package/rxdb.private.d.ts

@@ -0,0 +1,55 @@
+import { EntityManager } from './entity/EntityManager';
+import { UUID } from './entity/entity.interface';
+import { RxDBAdapters } from './rxdb-adapter';
+import { RxDBEvent } from './rxdb-events';
+import { RxDBOptions } from './rxdb.interface';
+/**
+ * 实体代理
+ */
+export declare const ɵProxy: unique symbol;
+/**
+ * 实体元数据
+ */
+export declare const METADATA: unique symbol;
+/**
+ * 实体状态
+ */
+export declare const STATUS: unique symbol;
+/**
+ * 实体状态正在变化
+ */
+export declare const STATUS_CHECK: unique symbol;
+/**
+ * 实体管理器
+ */
+export declare const ENTITY_MANAGER: unique symbol;
+export declare const ɵEntityDeleteCheck: unique symbol;
+export declare const UPDATED_BY: unique symbol;
+export declare const UPDATED_BY_SYSTEM: string;
+export declare const UPDATED_BY_USER: string;
+export type UpdatedBy = typeof UPDATED_BY_SYSTEM | typeof UPDATED_BY_USER | UUID | null;
+/**
+ * 是否是本地数据库适配器
+ */
+export declare const isLocalAdapter: <K extends keyof RxDBAdapters>(adapterName: K, options: RxDBOptions) => boolean;
+/**
+ * 是否是事务事件
+ */
+export declare const isTransactionEvent: (event: RxDBEvent) => boolean;
+/**
+ * 是否是数据库事件
+ */
+export declare const isDatabaseEvent: (event: RxDBEvent) => boolean;
+/**
+ * 实体管理内部方法
+ */
+export type EntityManagerPrivate = {
+    [ɵProxy]: (entity: any) => any;
+    [ɵEntityDeleteCheck]: (event: RxDBEvent) => void;
+} & EntityManager;
+/**
+ * Entity 私有属性
+ */
+export type EntityPrivate = {
+    [UPDATED_BY]: UpdatedBy;
+};

package/schema/SchemaManager.d.ts

@@ -0,0 +1,57 @@
+import { EntityPropertyMetadata, EntityRelationMetadata } from '../entity/entity-metadata-options.interface';
+import { EntityMetadata } from '../entity/entity-metadata.interface';
+import { EntityType } from '../entity/entity.interface';
+import { RxDB } from '../RxDB';
+type FindMappedRelationResult<T> = {
+    metadata: EntityMetadata;
+    relation: T;
+} | undefined;
+/**
+ * SchemaManager
+ */
+export declare class SchemaManager {
+    #private;
+    protected readonly rxdb: RxDB;
+    constructor(rxdb: RxDB);
+    /**
+     * 查找当前关系属性的映射关系
+     * @param relation 当前关系属性
+     */
+    findMappedRelation(meta: EntityMetadata, relation: EntityRelationMetadata): FindMappedRelationResult<EntityRelationMetadata>;
+    /**
+     * 通过查询条件的字段找出关系数组
+     * @param field 查询条件的字段
+     */
+    getFieldRelations(metadata: EntityMetadata, field: string): GetFieldRelationsResult;
+    /**
+     * 获取实体元数据
+     */
+    getEntityMetadata(name: string, namespace: string): EntityMetadata | undefined;
+    /**
+     * 获取实体元数据
+     */
+    getEntityType(name: string, namespace: string): EntityType | undefined;
+}
+interface GetFieldRelationsResult {
+    /**
+     * 关系组
+     */
+    relations: {
+        metadata: EntityMetadata;
+        relation: EntityRelationMetadata;
+    }[];
+    /**
+     * 要查询的属性
+     */
+    property: EntityPropertyMetadata;
+    /**
+     * 查询的属性名字
+     * 当 isForeignKey = true 的时候 propertyName = xxxId
+     */
+    propertyName: string;
+    /**
+     * 要查询的属性是否是当前查询 Entity 外键
+     */
+    isForeignKey: boolean;
+}
+export {};

package/system/change.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 记录所有实体更改变化
+ */
+export declare class RxDBChange {
+    id: number;
+    namespace?: string;
+    entity: string;
+    entityId: string;
+    type: string;
+    inversePatch?: Record<string, any>;
+    patch?: Record<string, any>;
+    changedAt: Date;
+}

package/system/migration.d.ts

@@ -0,0 +1,9 @@
+import { UUID } from '../entity/entity.interface';
+/**
+ * 数据库变更合并记录
+ */
+export declare class RxDBMigration {
+    readonly id: UUID;
+    readonly name: string;
+    readonly executedAt?: Date | null;
+}