@aiao/rxdb-plugin-sync 0.0.0-stage → 0.0.26

package/dist/sync-repository.d.ts

@@ -0,0 +1,63 @@
+import { SyncProgress } from '@aiao/rxdb';
+import { SyncManager } from './SyncManager.js';
+import { PullRepositoryOptions, PullRepositoryResult } from './pull-repository.js';
+import { PushRepositoryOptions, PushRepositoryResult } from './push-repository.js';
+/**
+ * @fileoverview 仓库级别的同步操作
+ *
+ * 将仓库的拉取（pull）和推送（push）操作组合在一起，保证正确的执行顺序。
+ */
+/**
+ * 仓库同步选项
+ */
+export interface SyncRepositoryOptions {
+    /**
+     * 同步方向
+     * @default 'sync'
+     */
+    direction?: 'pull' | 'push' | 'sync';
+    /**
+     * 拉取（pull）选项
+     */
+    pull?: PullRepositoryOptions;
+    /**
+     * 推送（push）选项
+     */
+    push?: PushRepositoryOptions;
+}
+/**
+ * 仓库同步结果
+ */
+export interface SyncRepositoryResult extends SyncProgress {
+    /**
+     * 拉取结果
+     */
+    pullResult: PullRepositoryResult;
+    /**
+     * 推送结果
+     */
+    pushResult: PushRepositoryResult;
+}
+/**
+ * 同步一个仓库（先拉取再推送）
+ *
+ * @param sm - SyncManager 实例
+ * @param namespace - 实体命名空间
+ * @param entity - 实体名称
+ * @param options - 同步选项
+ * @returns 同步结果
+ *
+ * @example
+ * ```ts
+ * // 同步 Todo 仓库（pull + push）
+ * const result = await syncRepository(sm, 'public', 'Todo');
+ *
+ * // 使用自定义选项同步
+ * const result = await syncRepository(sm, 'public', 'Todo', {
+ *   pull: { limit: 500, fetchAll: true },
+ *   push: { batchSize: 100 }
+ * });
+ * ```
+ */
+export declare function syncRepository(sm: SyncManager, namespace: string, entity: string, options?: SyncRepositoryOptions): Promise<SyncRepositoryResult>;
+//# sourceMappingURL=sync-repository.d.ts.map

package/dist/sync-repository.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sync-repository.d.ts","sourceRoot":"","sources":["../src/sync-repository.ts"],"names":[],"mappings":"AAAA,OAAO,EASL,KAAK,YAAY,EAClB,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,EAGL,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EAC1B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAGL,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EAC1B,MAAM,sBAAsB,CAAC;AAC9B;;;;GAIG;AAEH;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAErC;;OAEG;IACH,IAAI,CAAC,EAAE,qBAAqB,CAAC;IAE7B;;OAEG;IACH,IAAI,CAAC,EAAE,qBAAqB,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,YAAY;IACxD;;OAEG;IACH,UAAU,EAAE,oBAAoB,CAAC;IAEjC;;OAEG;IACH,UAAU,EAAE,oBAAoB,CAAC;CAClC;AAkGD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAsB,cAAc,CAClC,EAAE,EAAE,WAAW,EACf,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,qBAAqB,GAC9B,OAAO,CAAC,oBAAoB,CAAC,CA+B/B"}

package/dist/topological-sort.d.ts

@@ -0,0 +1,126 @@
+import { DependencyGraph, RepositoryIdentifier } from './dependency-graph.js';
+/**
+ * 排序方向
+ */
+export type SortDirection = 'pull' | 'push';
+/**
+ * 依赖图上的一条边。
+ *
+ * - `dependsOn`：本仓库**依赖**的仓库（父，外键指过去的那一端）
+ * - `requiredBy`：**依赖本仓库**的仓库（子，外键指过来的那一端）
+ */
+export type DependencyEdge = 'dependsOn' | 'requiredBy';
+/**
+ * 排序方向沿依赖图上的哪条边展开。
+ *
+ * 这条对应关系是整个级联调度的枢纽，所以只在这里写一次：拓扑序沿哪条边建立，
+ * 「谁排在我前面」就是哪条边，级联的依赖闸门也必须看同一条边。
+ * 从前它以 `direction === 'pull' ? dep.dependsOn : dep.requiredBy` 的形式散在
+ * {@link topologicalSort} 里，闸门那一侧则各写各的，于是 DELETE 相位的闸门看错了边。
+ */
+export declare function dependencyEdgeOf(direction: SortDirection): DependencyEdge;
+/**
+ * 本相位的依赖闸门该看哪条边 —— 也就是「本相位里谁排在我前面」。
+ *
+ * DELETE 相位子先父后，父被子阻断，看 `requiredBy`；
+ * INSERT/UPDATE 相位父先子后，子被父阻断，看 `dependsOn`。
+ *
+ * 与 {@link topologicalSortForAction} 共用 {@link sortDirectionForAction}，
+ * 保证「执行顺序」和「阻断关系」不可能各说各话。
+ *
+ * @param action - 本相位提交的变更类型
+ * @returns 该相位下判定阻断所依据的依赖边
+ */
+export declare function dependencyEdgeForAction(action: SortActionKind): DependencyEdge;
+/**
+ * 拓扑排序
+ *
+ * @param graph - 依赖图
+ * @param direction - 排序方向
+ *   - 'pull': 父实体在前（User -> Todo -> Comment）
+ *   - 'push': 子实体在前（Comment -> Todo -> User）
+ * @returns 排序后的 repository 列表
+ *
+ * @example
+ * ```ts
+ * // Pull 顺序（父在前）
+ * const pullOrder = topologicalSort(graph, 'pull');
+ * // 返回: [User, Todo, Comment]
+ *
+ * // Push 顺序（子在前）
+ * const pushOrder = topologicalSort(graph, 'push');
+ * // 返回: [Comment, Todo, User]
+ * ```
+ */
+export declare function topologicalSort(graph: DependencyGraph, direction: SortDirection): RepositoryIdentifier[];
+/**
+ * 拓扑排序（Pull 方向）
+ *
+ * 确保父实体在前，适用于 Pull 同步
+ *
+ * @param graph - 依赖图
+ * @returns 排序后的 repository 列表
+ */
+export declare function topologicalSortForPull(graph: DependencyGraph): RepositoryIdentifier[];
+/**
+ * 拓扑排序（Push 方向）
+ *
+ * 确保子实体在前，适用于 Push 同步
+ *
+ * @param graph - 依赖图
+ * @returns 排序后的 repository 列表
+ */
+export declare function topologicalSortForPush(graph: DependencyGraph): RepositoryIdentifier[];
+/**
+ * 变更类型：决定安全的提交顺序
+ */
+export type SortActionKind = 'INSERT' | 'UPDATE' | 'DELETE';
+/**
+ * 按变更类型选排序方向
+ *
+ * 同一张依赖图，INSERT 和 DELETE 需要的顺序**正好相反**，「push 就是子→父」这个说法
+ * 只对 DELETE 成立：
+ *
+ * - `INSERT` / `UPDATE` → **父先**。子行的外键指向父行，父行不先落库就是悬空引用，FK 失败。
+ * - `DELETE` → **子先**。父行还被子行引用着，先删父同样 FK 失败。
+ *
+ * 所以一次级联推送不可能靠单一顺序扫完，必须分相位：DELETE 走一遍子→父，
+ * INSERT/UPDATE 再走一遍父→子。
+ *
+ * @param graph - 依赖图
+ * @param action - 本相位要提交的变更类型
+ * @returns 该类型下安全的提交顺序
+ *
+ * @example
+ * ```ts
+ * topologicalSortForAction(graph, 'INSERT'); // [User, Todo, Comment]
+ * topologicalSortForAction(graph, 'DELETE'); // [Comment, Todo, User]
+ * ```
+ */
+export declare function topologicalSortForAction(graph: DependencyGraph, action: SortActionKind): RepositoryIdentifier[];
+/**
+ * 过滤并排序指定的 repository 列表
+ *
+ * 从依赖图中只选择指定的 repositories，并按拓扑顺序排序
+ *
+ * @param graph - 完整依赖图
+ * @param repositories - 要排序的 repository 列表
+ * @param direction - 排序方向
+ * @returns 排序后的 repository 列表
+ *
+ * @example
+ * ```ts
+ * // 只同步 Todo 和 Comment
+ * const filtered = filterAndSort(
+ *   graph,
+ *   [
+ *     { namespace: 'public', entity: 'Todo' },
+ *     { namespace: 'public', entity: 'Comment' }
+ *   ],
+ *   'pull'
+ * );
+ * // 返回: [Todo, Comment]（按依赖顺序）
+ * ```
+ */
+export declare function filterAndSort(graph: DependencyGraph, repositories: RepositoryIdentifier[], direction: SortDirection): RepositoryIdentifier[];
+//# sourceMappingURL=topological-sort.d.ts.map

package/dist/topological-sort.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"topological-sort.d.ts","sourceRoot":"","sources":["../src/topological-sort.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,KAAK,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAEnF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,MAAM,CAAC;AAE5C;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG,WAAW,GAAG,YAAY,CAAC;AAExD;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,aAAa,GAAG,cAAc,CAEzE;AAWD;;;;;;;;;;;GAWG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,cAAc,GAAG,cAAc,CAE9E;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,aAAa,GAAG,oBAAoB,EAAE,CAiDxG;AAED;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,eAAe,GAAG,oBAAoB,EAAE,CAErF;AAED;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,eAAe,GAAG,oBAAoB,EAAE,CAErF;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAE5D;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,eAAe,EAAE,MAAM,EAAE,cAAc,GAAG,oBAAoB,EAAE,CAE/G;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,aAAa,CAC3B,KAAK,EAAE,eAAe,EACtB,YAAY,EAAE,oBAAoB,EAAE,EACpC,SAAS,EAAE,aAAa,GACvB,oBAAoB,EAAE,CA8BxB"}

package/dist/version.utils.d.ts

@@ -0,0 +1,3 @@
+import { RemoteChange, RxDBChange } from '@aiao/rxdb';
+export declare const remote_change_to_local: (remoteChange: RemoteChange[], base: Partial<RxDBChange>) => Omit<RxDBChange, "id" | "branch$">[];
+//# sourceMappingURL=version.utils.d.ts.map

package/dist/version.utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.utils.d.ts","sourceRoot":"","sources":["../src/version.utils.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,YAAY,EAAE,UAAU,EAAQ,MAAM,YAAY,CAAC;AAC5D,eAAO,MAAM,sBAAsB,GACjC,cAAc,YAAY,EAAE,EAC5B,MAAM,OAAO,CAAC,UAAU,CAAC,KACxB,IAAI,CAAC,UAAU,EAAE,IAAI,GAAG,SAAS,CAAC,EAUjC,CAAC"}

package/package.json

@@ -1,6 +1,61 @@
 {
   "name": "@aiao/rxdb-plugin-sync",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.0.26",
+  "description": "Push/pull synchronization, conflict resolution and offline outbox for Aiao RxDB.",
+  "homepage": "https://rxdb.netlify.app/docs/plugins",
+  "bugs": {
+    "url": "https://github.com/aiao-io/rxdb/issues"
+  },
+  "keywords": [
+    "aiao",
+    "rxdb",
+    "sync",
+    "push",
+    "pull",
+    "conflict",
+    "offline-first",
+    "typescript"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/aiao-io/rxdb.git",
+    "directory": "packages/rxdb-plugin-sync"
+  },
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src",
+    "!src/**/*.spec.*",
+    "!src/**/*.test.*",
+    "!src/**/__tests__/**",
+    "!**/*.tsbuildinfo"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "nx": {
+    "name": "rxdb-plugin-sync",
+    "tags": [
+      "js-lib"
+    ]
+  },
+  "dependencies": {
+    "rxjs": "^7.8.2",
+    "@aiao/rxdb": "0.0.26",
+    "@aiao/utils": "0.0.26",
+    "@aiao/rxdb-plugin-history": "0.0.26"
+  }
 }