@aiao/rxdb 0.0.1

package/entity/entity_proxy_helper.d.ts

@@ -0,0 +1,48 @@
+import { UpdatedBy } from '../rxdb.private';
+import { EntityType } from './entity.interface';
+/**
+ * 实体变化接口
+ * 描述实体属性的单次变更信息
+ *
+ * @interface EntityChange
+ * @template T 实体类型
+ * @template K 属性键类型，默认为实体的所有属性键
+ * @template V 属性值类型，默认为对应属性的值类型
+ */
+export interface EntityChange<T extends EntityType, K extends keyof T = keyof T, V = T[K]> {
+    /**
+     * 操作者
+     * - `UPDATED_BY_USER`: 用户操作
+     * - `UPDATED_BY_SYSTEM`: 系统操作
+     * - uuid: 具体某个用户（待实现）
+     */
+    updatedBy: UpdatedBy;
+    /**
+     * 变化的属性
+     */
+    prop: K;
+    /**
+     * 变化前的值
+     */
+    oldValue: V;
+    /**
+     * 变化后的值
+     */
+    value: V;
+}
+/**
+ * 创建实体代理对象
+ *
+ * 该函数通过JavaScript的Proxy机制创建实体的代理对象，用于：
+ * 1. 跟踪实体属性的变更
+ * 2. 记录变更的来源（用户或系统）
+ * 3. 计算变更的差异并更新实体状态
+ * 4. 批量处理连续的变更操作
+ *
+ * 代理对象会拦截属性设置操作，当属性值发生变化时：
+ * - 记录变更信息（属性名、旧值、新值、变更来源）
+ * - 标记实体状态为已修改
+ * - 在下一个事件循环中计算差异并更新状态
+ */
+declare const _default: <T extends EntityType>(entity: InstanceType<T>) => T;
+export default _default;

package/entity/entity_relation_helper.d.ts

@@ -0,0 +1,15 @@
+import { EntityManager } from './EntityManager';
+import { EntityRelationMetadata } from './entity-metadata-options.interface';
+import { EntityType } from './entity.interface';
+/**
+ * 帮助 EntityManager 处理实体关系
+ * 为实体类型添加关系属性，根据关系类型创建不同的可观察对象
+ *
+ * 该函数会：
+ * 1. 获取关联实体类型
+ * 2. 根据关系类型（一对一、一对多、多对一、多对多）创建相应的可观察对象
+ * 3. 为可观察对象添加操作方法（set、remove、add等）
+ * 4. 将关系属性添加到实体类型的原型上
+ */
+declare const _default: (relation: EntityRelationMetadata, EntityType: EntityType, em: EntityManager) => void;
+export default _default;

package/entity/generate_many_to_many_entity.d.ts

@@ -0,0 +1,35 @@
+import { EntityMetadataOptions, EntityRelationManyToManyMetadata } from './entity-metadata-options.interface';
+import { EntityMetadata } from './entity-metadata.interface';
+/**
+ * 多对多关系描述接口
+ * 包含实体元数据和关系元数据
+ */
+export interface ManyToManyRelation {
+    /**
+     * 实体元数据
+     */
+    metadata: EntityMetadata;
+    /**
+     * 多对多关系元数据
+     */
+    relation: EntityRelationManyToManyMetadata;
+}
+/**
+ * 根据多对多关系生成中间表实体元数据
+ *
+ * 中间表实体用于连接两个实体之间的多对多关系，它包含两个外键，分别指向关系的两端
+ * 中间表的命名规则是将两个实体名称按字母顺序排序后用下划线连接
+ * 命名空间同样按字母顺序排序后用下划线连接
+ *
+ * @example
+ * // 如果有 User 和 Role 两个实体，生成的中间表名称为 Role_User
+ * // 如果两个实体分别在 auth 和 system 命名空间，生成的命名空间为 auth_system
+ */
+/**
+ * 根据多对多关系生成中间表实体元数据
+ *
+ * @param options - 包含两个多对多关系的数组，每个关系包含实体元数据和关系元数据
+ * @returns 生成的中间表实体元数据选项
+ */
+declare const _default: (options: [ManyToManyRelation, ManyToManyRelation]) => EntityMetadataOptions;
+export default _default;

package/entity/transition-metadata.d.ts

@@ -0,0 +1,17 @@
+import { EntityMetadataOptions } from './entity-metadata-options.interface';
+import { EntityMetadata } from './entity-metadata.interface';
+import { AbstractEntityType, EntityType } from './entity.interface';
+/**
+ * 将元数据选项(metadataOptions)转换为实体元数据(metadata)
+ *
+ * 该函数执行以下操作：
+ * 1. 收集实体原型链上的所有元数据选项
+ * 2. 创建属性映射、关系映射和索引映射
+ * 3. 处理实体继承关系
+ * 4. 设置显示名称、默认值属性、外键关系和外键名称
+ * 5. 添加辅助方法如isForeignKey
+ *
+ * @param metadataOptions - 实体元数据选项，包含实体的基本配置
+ * @param [EntityType] - 可选的目标类，用于获取原型链上的元数据
+ */
+export declare const transitionMetadata: (metadataOptions: EntityMetadataOptions, EntityType?: EntityType | AbstractEntityType) => EntityMetadata;

package/index.d.ts

@@ -0,0 +1,26 @@
+export * from './entity/@Entity';
+export * from './entity/@TreeEntity';
+export * from './entity/entity-metadata-options.interface';
+export * from './entity/entity-metadata.interface';
+export * from './entity/entity.interface';
+export * from './entity/entity.utils';
+export { isEntityInternalName } from './entity/entity.utils';
+export * from './entity/EntityBase';
+export { transitionMetadata } from './entity/transition-metadata';
+export * from './entity/TreeEntityBase';
+export * from './repository/query-options.interface';
+export * from './repository/query.interface';
+export * from './repository/query.utils';
+export * from './repository/repository.interface';
+export * from './repository/RepositoryBase';
+export * from './repository/tree-query-options.interface';
+export * from './repository/tree-repository.interface';
+export * from './RxDB';
+export * from './rxdb-adapter';
+export * from './rxdb-events';
+export * from './rxdb-plugin';
+export * from './rxdb-utils';
+export * from './rxdb.interface';
+export * from './RxDBError';
+export * from './system/change';
+export * from './system/migration';