@aiao/rxdb 0.0.1 → 0.0.3

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@aiao/rxdb",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "type": "module",
   "main": "./index.js",
   "dependencies": {
     "uuid": "^11.1.0",
     "type-fest": "^4.41.0",
-    "@aiao/utils": "0.0.1",
+    "@aiao/utils": "0.0.3",
     "rxjs": "~7.8.0"
   },
   ".": {

package/repository/query.interface.d.ts

@@ -1,5 +1,4 @@
 import { SetNonNullable } from 'type-fest';
-import { UUID } from '../entity/entity.interface';
 /**
  * 判断相等
  */
@@ -60,10 +59,6 @@ export type BooleanRules<T, K extends keyof T = keyof T, VT = T[K]> = RuleEqualN
  * 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>;
 /**
  * 查询规则
  */

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

@@ -0,0 +1,62 @@
+import { SetNonNullable } from 'type-fest';
+/**
+ * 判断相等
+ */
+interface RuleEqualNullable<K, VT> {
+    field: K;
+    operator: '=' | '!=';
+    value: VT;
+}
+/**
+ * 字符串比较
+ */
+interface RuleStringNonNullable<K, VT> {
+    field: K;
+    operator: '<' | '>' | '<=' | '>=' | 'contains' | 'notContain' | 'beginWith' | 'notBeginWith' | 'endWith' | 'notEndWith';
+    value: SetNonNullable<VT>;
+}
+/**
+ * 数值比较
+ */
+interface RuleNumberNonNullable<K, VT> {
+    field: K;
+    operator: '<' | '>' | '<=' | '>=';
+    value: SetNonNullable<VT>;
+}
+/**
+ * in
+ */
+interface RuleIn<K, VT> {
+    field: K;
+    operator: 'in' | 'notIn';
+    value: SetNonNullable<VT>[];
+}
+/**
+ * between
+ */
+interface RuleBetween<K, VT> {
+    field: K;
+    operator: 'between' | 'notBetween';
+    value: [SetNonNullable<VT>, SetNonNullable<VT>];
+}
+/**
+ * UUID
+ */
+export type RelationUUIDRules<K, VT> = RuleEqualNullable<K, VT> | RuleIn<K, VT>;
+/**
+ * string
+ */
+export type RelationStringRules<K, VT> = RuleEqualNullable<K, VT> | RuleStringNonNullable<K, VT> | RuleIn<K, VT> | RuleBetween<K, VT>;
+/**
+ * number
+ */
+export type RelationNumberRules<K, VT> = RuleEqualNullable<K, VT> | RuleNumberNonNullable<K, VT> | RuleIn<K, VT> | RuleBetween<K, VT>;
+/**
+ * Boolean
+ */
+export type RelationBooleanRules<K, VT> = RuleEqualNullable<K, VT>;
+/**
+ * Date
+ */
+export type RelationDateRules<K, VT> = RuleEqualNullable<K, VT> | RuleNumberNonNullable<K, VT> | RuleIn<K, VT> | RuleBetween<K, VT>;
+export {};

package/rxdb-utils.d.ts

@@ -15,6 +15,6 @@ export declare const getEntityStatus: <T extends EntityType>(target: InstanceTyp
  */
 export declare const __decorateClass: (decorators: any, target: any, key: any, kind: number) => any;
 /**
- * 生成 uuid
+ * 生成 uuid v7
  */
 export declare const uuid: () => UUID;

package/rxdb.interface.d.ts

@@ -1,7 +1,7 @@
 import { SyncOptions } from './entity/entity-metadata-options.interface';
 import { EntityType } from './entity/entity.interface';
 /**
- * 升级脚步
+ * 升级脚本
  */
 export interface MigrationType {
     up(): Promise<void>;
@@ -11,6 +11,9 @@ export interface MigrationType {
  * RxDB 环境上下文
  */
 export interface RxDBContext {
+    /**
+     * 用户 ID
+     */
     userId?: string;
 }
 /**

package/rxdb.private.d.ts

@@ -23,9 +23,21 @@ 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;
 /**
@@ -44,7 +56,20 @@ export declare const isDatabaseEvent: (event: RxDBEvent) => boolean;
  * 实体管理内部方法
  */
 export type EntityManagerPrivate = {
+    /**
+     * 设置实体代理创建函数
+     * 用于创建新的实体代理对象，并初始化其状态
+     *
+     * @param entity - 要代理的实体
+     * @returns 代理后的实体实例
+     */
     [ɵProxy]: (entity: any) => any;
+    /**
+     * 设置实体删除检查函数
+     * 用于处理数据库适配器的删除事件，更新实体状态
+     *
+     * @param event - 删除事件
+     */
     [ɵEntityDeleteCheck]: (event: RxDBEvent) => void;
 } & EntityManager;
 /**