@aiao/rxdb-angular 0.0.7 → 0.0.8

package/types/aiao-rxdb-angular.d.ts

@@ -0,0 +1,222 @@
+import { EntityType, EntityStaticType, TreeEntityType, RxDB, FindByCursorOptions } from '@aiao/rxdb';
+import { GraphEntityType } from '@aiao/rxdb-plugin-graph';
+import * as _angular_core from '@angular/core';
+import { Signal, CreateSignalOptions, WritableSignal } from '@angular/core';
+
+type UseOptions<T> = T | (() => T);
+interface RxDBResource<T> {
+    /**
+     * 资源的值
+     */
+    readonly value: Signal<T>;
+    /**
+     * 资源的错误
+     */
+    readonly error: Signal<Error | undefined>;
+    /**
+     * 资源的加载状态
+     */
+    readonly isLoading: Signal<boolean>;
+    /**
+     * 资源是否为空
+     */
+    readonly isEmpty: Signal<boolean | undefined>;
+    /**
+     * 资源是否有值
+     */
+    readonly hasValue: Signal<boolean>;
+}
+declare const useRepositoryQuery: <T extends EntityType, RT>(EntityType: T, method: string, defaultValue: any, options: UseOptions<any>) => RxDBResource<RT>;
+/**
+ * 通过 ID 获取单个实体
+ *
+ * @param EntityType 实体类
+ * @param options 实体 ID 或查询参数对象
+ * @returns 返回包含实体的资源 signal
+ *
+ * @example
+ * ```typescript
+ * const user = useGet(User, 'user-1');
+ * ```
+ */
+declare const useGet: <T extends EntityType>(EntityType: T, options: UseOptions<EntityStaticType<T, "getOptions">>) => RxDBResource<InstanceType<T>>;
+/**
+ * 查找第一个匹配条件的实体
+ *
+ * @param EntityType 实体类
+ * @param options 查询参数（where、排序等）
+ * @returns 返回包含实体的资源 signal
+ */
+declare const useFindOne: <T extends EntityType>(EntityType: T, options: UseOptions<EntityStaticType<T, "findOneOptions">>) => RxDBResource<InstanceType<T> | undefined>;
+/**
+ * 查找匹配的实体，未找到则抛出错误
+ *
+ * @param EntityType 实体类
+ * @param options 查询参数
+ * @returns 返回包含实体的资源 signal
+ */
+declare const useFindOneOrFail: <T extends EntityType>(EntityType: T, options: UseOptions<EntityStaticType<T, "findOneOrFailOptions">>) => RxDBResource<InstanceType<T>>;
+/**
+ * 查找符合条件的多个实体
+ *
+ * @param EntityType 实体类
+ * @param options 查询参数
+ * @returns 返回包含实体数组的资源 signal
+ */
+declare const useFind: <T extends EntityType>(EntityType: T, options: UseOptions<EntityStaticType<T, "findOptions">>) => RxDBResource<InstanceType<T>[]>;
+/**
+ * 使用游标分页查找实体
+ *
+ * @param EntityType 实体类
+ * @param options 游标参数
+ * @returns 返回包含实体数组的资源 signal
+ */
+declare const useFindByCursor: <T extends EntityType>(EntityType: T, options: UseOptions<EntityStaticType<T, "findByCursorOptions">>) => RxDBResource<InstanceType<T>[]>;
+/**
+ * 查找全部实体
+ *
+ * @param EntityType 实体类
+ * @param options 查询参数
+ * @returns 返回包含全部实体的资源 signal
+ */
+declare const useFindAll: <T extends EntityType>(EntityType: T, options: UseOptions<EntityStaticType<T, "findAllOptions">>) => RxDBResource<InstanceType<T>[]>;
+/**
+ * 统计满足条件的实体数量
+ *
+ * @param EntityType 实体类
+ * @param options 查询参数
+ * @returns 返回包含数量的资源 signal
+ */
+declare const useCount: <T extends EntityType>(EntityType: T, options: UseOptions<EntityStaticType<T, "countOptions">>) => RxDBResource<number>;
+/**
+ * 查找树结构中的所有子孙实体
+ *
+ * @param EntityType 实体类
+ * @param options 树查询参数（entityId、深度等）
+ * @returns 返回包含子孙实体的资源 signal
+ */
+declare const useFindDescendants: <T extends TreeEntityType>(EntityType: T, options: UseOptions<EntityStaticType<T, "findTreeOptions">>) => RxDBResource<InstanceType<T>[]>;
+/**
+ * 统计树结构中的子孙数量
+ *
+ * @param EntityType 实体类
+ * @param options 树查询参数
+ * @returns 返回包含数量的资源 signal
+ */
+declare const useCountDescendants: <T extends TreeEntityType>(EntityType: T, options: UseOptions<EntityStaticType<T, "findTreeOptions">>) => RxDBResource<number>;
+/**
+ * 查找树结构中的所有祖先实体
+ *
+ * @param EntityType 实体类
+ * @param options 树查询参数
+ * @returns 返回包含祖先实体的资源 signal
+ */
+declare const useFindAncestors: <T extends TreeEntityType>(EntityType: T, options: UseOptions<EntityStaticType<T, "findTreeOptions">>) => RxDBResource<InstanceType<T>[]>;
+/**
+ * 统计树结构中的祖先数量
+ *
+ * @param EntityType 实体类
+ * @param options 树查询参数
+ * @returns 返回包含数量的资源 signal
+ */
+declare const useCountAncestors: <T extends TreeEntityType>(EntityType: T, options: UseOptions<EntityStaticType<T, "findTreeOptions">>) => RxDBResource<number>;
+/**
+ * 查找图结构中的邻接实体
+ *
+ * @param EntityType 实体类
+ * @param options 图查询参数（entityId、方向、层级等）
+ * @returns 返回包含邻居实体的资源 signal
+ *
+ * @example
+ * ```typescript
+ * const friends = useGraphNeighbors(User, {
+ *   entityId: 'user-1',
+ *   direction: 'out',
+ *   level: 1
+ * });
+ * ```
+ */
+declare const useGraphNeighbors: <T extends GraphEntityType>(EntityType: T, options: UseOptions<EntityStaticType<T, "findNeighborsOptions">>) => RxDBResource<InstanceType<T>[]>;
+/**
+ * 统计图结构中的邻接数量
+ *
+ * @param EntityType 实体类
+ * @param options 图查询参数
+ * @returns 返回包含数量的资源 signal
+ */
+declare const useCountNeighbors: <T extends GraphEntityType>(EntityType: T, options: UseOptions<EntityStaticType<T, "findNeighborsOptions">>) => RxDBResource<number>;
+/**
+ * 查找图结构中两个实体之间的路径
+ *
+ * @param EntityType 实体类
+ * @param options 路径查询参数（fromId、toId、最大深度等）
+ * @returns 返回包含路径的资源 signal
+ *
+ * @example
+ * ```typescript
+ * const paths = useGraphPaths(User, {
+ *   fromId: 'user-1',
+ *   toId: 'user-2',
+ *   maxDepth: 5
+ * });
+ * ```
+ */
+declare const useGraphPaths: <T extends GraphEntityType>(EntityType: T, options: UseOptions<EntityStaticType<T, "findPathsOptions">>) => RxDBResource<any[]>;
+
+type OptionsInput<T extends EntityType> = FindByCursorOptions<T> | Signal<FindByCursorOptions<T>>;
+/**
+ * 无限滚动的列表
+ */
+declare class InfiniteScrollingList<T extends EntityType> {
+    #private;
+    private readonly rxdb;
+    private readonly EntityType;
+    private readonly options;
+    readonly error: _angular_core.WritableSignal<Error | undefined>;
+    readonly isLoading: _angular_core.WritableSignal<boolean>;
+    readonly hasMore: _angular_core.WritableSignal<boolean>;
+    readonly value: Signal<InstanceType<T>[]>;
+    readonly hasValue: Signal<boolean>;
+    readonly isEmpty: Signal<boolean>;
+    constructor(rxdb: RxDB, EntityType: T, options: OptionsInput<T>);
+    loadMore(): void;
+    /**
+     * 刷新列表数据
+     */
+    refresh(): void;
+}
+
+/**
+ * RxDB 实体变化指令
+ * 如果你使用了 `changeDetection: ChangeDetectionStrategy.OnPush`
+ * 那么正在输入的变化不会触发 angular 渲染机制，使用这个指令可以实现实时渲染
+ *
+ * @example
+ * 当修改实体时，需要在多个地方预览修改变化时，可以使用这个指令
+ */
+declare class RxDBEntityChangeDirective {
+    #private;
+    readonly rxdbChangeDetector: _angular_core.InputSignal<any>;
+    readonly debounceTime: _angular_core.InputSignal<number>;
+    readonly auditTime: _angular_core.InputSignal<number>;
+    constructor();
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<RxDBEntityChangeDirective, never>;
+    static ɵdir: _angular_core.ɵɵDirectiveDeclaration<RxDBEntityChangeDirective, "[rxdbChangeDetector]", never, { "rxdbChangeDetector": { "alias": "rxdbChangeDetector"; "required": false; "isSignal": true; }; "debounceTime": { "alias": "debounceTime"; "required": false; "isSignal": true; }; "auditTime": { "alias": "auditTime"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+
+/**
+ * RxDB 配置
+ */
+declare const provideRxDB: (useFactory?: () => RxDB) => _angular_core.EnvironmentProviders;
+
+declare const useAction: <Options = any, RT = any>(promiseFn: (options?: Options) => Promise<RT>) => {
+    isPending: _angular_core.WritableSignal<boolean>;
+    execute: (options?: Options | undefined) => Promise<RT>;
+};
+
+declare const useState: (namespace: string) => (name: string) => {
+    signal: <T>(initialValue: T, options?: CreateSignalOptions<T>) => WritableSignal<T>;
+};
+
+export { InfiniteScrollingList, RxDBEntityChangeDirective, provideRxDB, useAction, useCount, useCountAncestors, useCountDescendants, useCountNeighbors, useFind, useFindAll, useFindAncestors, useFindByCursor, useFindDescendants, useFindOne, useFindOneOrFail, useGet, useGraphNeighbors, useGraphPaths, useRepositoryQuery, useState };
+export type { RxDBResource };

package/eslint.config.mjs

@@ -1,58 +0,0 @@
-import nx from '@nx/eslint-plugin';
-import jsoncParser from 'jsonc-eslint-parser';
-import baseConfig from '../../eslint.config.mjs';
-
-export default [
-  ...baseConfig,
-  {
-    files: ['**/*.json'],
-    rules: {
-      '@nx/dependency-checks': [
-        'error',
-        {
-          ignoredFiles: ['{projectRoot}/eslint.config.{js,cjs,mjs,ts,cts,mts}'],
-          ignoredDependencies: [
-            '@analogjs/vite-plugin-angular',
-            '@codecov/vite-plugin',
-            '@angular/common',
-            '@angular/core',
-            '@angular/forms',
-            '@nx/vite',
-            'vite'
-          ]
-        }
-      ]
-    },
-    languageOptions: {
-      parser: jsoncParser
-    }
-  },
-  ...nx.configs['flat/angular'],
-  ...nx.configs['flat/angular-template'],
-  {
-    files: ['**/*.ts'],
-    rules: {
-      '@angular-eslint/directive-selector': [
-        'error',
-        {
-          type: 'attribute',
-          prefix: 'rxdb',
-          style: 'camelCase'
-        }
-      ],
-      '@angular-eslint/component-selector': [
-        'error',
-        {
-          type: 'element',
-          prefix: 'rxdb',
-          style: 'kebab-case'
-        }
-      ]
-    }
-  },
-  {
-    files: ['**/*.html'],
-    // Override or add rules here
-    rules: {}
-  }
-];

package/ng-package.json

@@ -1,7 +0,0 @@
-{
-  "$schema": "../../node_modules/ng-packagr/ng-package.schema.json",
-  "dest": "../../dist/packages/rxdb-angular",
-  "lib": {
-    "entryFile": "src/index.ts"
-  }
-}

package/project.json

@@ -1,48 +0,0 @@
-{
-  "$schema": "../../node_modules/nx/schemas/project-schema.json",
-  "implicitDependencies": ["code-editor-angular"],
-  "name": "rxdb-angular",
-  "prefix": "rxdb",
-  "projectType": "library",
-  "release": {
-    "version": {
-      "manifestRootsToUpdate": ["dist/{projectRoot}"],
-      "currentVersionResolver": "git-tag",
-      "fallbackCurrentVersionResolver": "disk"
-    }
-  },
-  "sourceRoot": "packages/rxdb-angular/src",
-  "tags": ["angular-lib"],
-  "targets": {
-    "build": {
-      "executor": "@nx/angular:package",
-      "outputs": ["{workspaceRoot}/dist/{projectRoot}"],
-      "options": {
-        "project": "packages/rxdb-angular/ng-package.json",
-        "tsConfig": "packages/rxdb-angular/tsconfig.lib.json"
-      },
-      "configurations": {
-        "production": {
-          "tsConfig": "packages/rxdb-angular/tsconfig.lib.prod.json"
-        },
-        "development": {}
-      },
-      "defaultConfiguration": "production"
-    },
-    "nx-release-publish": {
-      "options": {
-        "packageRoot": "dist/{projectRoot}"
-      }
-    },
-    "lint": {
-      "executor": "@nx/eslint:lint"
-    },
-    "test": {
-      "executor": "@nx/vitest:test",
-      "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
-      "options": {
-        "config": "packages/rxdb-angular/vite.config.mts"
-      }
-    }
-  }
-}

package/src/InfiniteScrollingList.ts

@@ -1,123 +0,0 @@
-import { EntityType, FindByCursorOptions, RxDB } from '@aiao/rxdb';
-import { isFunction, nextMicroTask } from '@aiao/utils';
-import { computed, DestroyRef, effect, EffectRef, inject, Signal, signal, untracked } from '@angular/core';
-import { takeUntilDestroyed } from '@angular/core/rxjs-interop';
-
-type OptionsInput<T extends EntityType> = FindByCursorOptions<T> | Signal<FindByCursorOptions<T>>;
-
-/**
- * 无限滚动的列表
- */
-export class InfiniteScrollingList<T extends EntityType> {
-  readonly #values = signal<InstanceType<T>[][]>([]);
-  readonly #destroy_ref = inject(DestroyRef);
-  readonly #options_eff: EffectRef;
-
-  #is_initialized = false;
-
-  readonly error = signal<Error | undefined>(undefined);
-  readonly isLoading = signal<boolean>(false);
-  readonly hasMore = signal<boolean>(true);
-  readonly value = computed<InstanceType<T>[]>(() => this.#values().flat());
-  readonly hasValue = computed<boolean>(() => this.value().length > 0);
-  readonly isEmpty = computed<boolean>(() => !this.isLoading() && !this.hasValue() && this.#is_initialized);
-
-  constructor(
-    private readonly rxdb: RxDB,
-    private readonly EntityType: T,
-    private readonly options: OptionsInput<T>
-  ) {
-    this.#options_eff = effect(() => {
-      if (isFunction(this.options)) {
-        this.options();
-      }
-      if (!this.#is_initialized) {
-        this.#is_initialized = true;
-        nextMicroTask(() => this.loadMore());
-        return;
-      }
-      untracked(() => this.#reset());
-    });
-
-    this.#destroy_ref.onDestroy(() => {
-      this.#options_eff.destroy();
-    });
-  }
-
-  loadMore(): void {
-    if (this.isLoading() || !this.hasMore()) {
-      return;
-    }
-
-    this.isLoading.set(true);
-    this.error.set(undefined);
-
-    const last_entity = this.#get_last_entity();
-    const opt = isFunction(this.options) ? this.options() : this.options;
-    const options = structuredClone(opt);
-
-    if (last_entity) {
-      options.after = last_entity;
-    }
-
-    const current_index = this.#values().length;
-
-    this.rxdb.entityManager
-      .getRepository(this.EntityType)
-      .findByCursor(options)
-      .pipe(takeUntilDestroyed(this.#destroy_ref))
-      .subscribe({
-        next: result => {
-          this.isLoading.set(false);
-          this.#values.update(values => {
-            const updated = [...values];
-            updated[current_index] = result;
-            return updated;
-          });
-
-          if (result.length < (options.limit || 100)) {
-            this.hasMore.set(false);
-          }
-        },
-        error: error => {
-          this.isLoading.set(false);
-          this.error.set(error);
-        },
-        complete: () => {
-          this.hasMore.set(false);
-          this.isLoading.set(false);
-        }
-      });
-  }
-
-  /**
-   * 刷新列表数据
-   */
-  refresh(): void {
-    // 强制重置状态，即使正在加载中
-    this.#values.set([]);
-    this.error.set(undefined);
-    this.isLoading.set(false); // 强制设置为 false，允许新的 loadMore
-    this.hasMore.set(true);
-
-    // 立即开始加载
-    this.loadMore();
-  }
-  #reset(): void {
-    this.#values.set([]);
-    this.error.set(undefined);
-    this.isLoading.set(false);
-    this.hasMore.set(true);
-    nextMicroTask(() => this.loadMore());
-  }
-
-  #get_last_entity(): InstanceType<T> | undefined {
-    const values = this.#values();
-    if (values.length === 0) return undefined;
-
-    const last_page = values[values.length - 1];
-    if (last_page.length === 0) return undefined;
-
-    return last_page[last_page.length - 1];
-  }
-}

package/src/devtools/devtools.html

@@ -1,99 +0,0 @@
-@let tabs = $tabs();
-@let current_tab = $current_tab();
-
-<div class="touch" (mousedown)="mousedown($event)"></div>
-
-<!-- header -->
-<div class="bg-base-300 z-1 flex min-h-0 flex-row p-0 shadow-sm">
-  <div class="flex-1">
-    <div class="tabs tabs-border tabs-xs" role="tablist">
-      @for (tab of tabs; track $index) {
-        <a
-          class="tab"
-          [class.tab-active]="current_tab === tab.id"
-          (click)="$current_tab.set(tab.id)"
-          aria-hidden="true"
-          role="tab"
-        >
-          {{ tab.name }}
-        </a>
-      }
-    </div>
-  </div>
-  <div>
-    <button class="btn btn-xs btn-ghost" (click)="toggle_settings()" aria-hidden="true">
-      <lucide-icon [img]="Settings" size="16"></lucide-icon>
-    </button>
-    <button class="btn btn-xs btn-ghost" (click)="close_rxdb_devtools()" aria-hidden="true">
-      <lucide-icon [img]="X" size="16"></lucide-icon>
-    </button>
-  </div>
-</div>
-
-<!-- Pages -->
-<div class="bg-base-100 flex h-full flex-1 flex-row overflow-hidden">
-  @switch (current_tab) {
-    @case ('tables') {
-      @defer (on viewport) {
-        <rxdb-entity-table-tools [theme]="theme()"></rxdb-entity-table-tools>
-      } @placeholder {
-        <div>entity table loading...</div>
-      }
-    }
-
-    @case ('events') {
-      @defer (on viewport) {
-        <rxdb-event-tools></rxdb-event-tools>
-      } @placeholder {
-        <div>entity table loading...</div>
-      }
-    }
-
-    @case ('settings') {
-      @defer (on viewport) {
-        <rxdb-settings (sideChange)="$side.set($event)"></rxdb-settings>
-      } @placeholder {
-        <div>entity table loading...</div>
-      }
-    }
-  }
-</div>
-<!-- footer -->
-@let branchName = $branchName();
-@let switch_branching = $switch_branching();
-
-<div class="bg-base-300 relative z-1 flex min-h-0 flex-row p-0 shadow-sm">
-  <div class="relative flex w-30 items-center justify-center">
-    @if (switch_branching) {
-      <span class="loading loading-spinner loading-xs absolute"></span>
-    }
-    <select
-      class="select select-ghost select-xs outline-none"
-      [disabled]="switch_branching"
-      (change)="switch_branch($event)"
-      name="branch"
-    >
-      @for (branch of branches.value(); track $index) {
-        <option [selected]="branch.activated" [value]="branch.id">
-          {{ branch.id }}
-        </option>
-      }
-    </select>
-  </div>
-  <input
-    class="input input-xs w-24 outline-none"
-    [(ngModel)]="$branchName"
-    [disabled]="switch_branching"
-    (keyup.enter)="create_branch(branchName)"
-    placeholder="branch name"
-    type="text"
-  />
-  <button
-    class="btn btn-xs btn-ghost"
-    [class.btn-disabled]="!branchName"
-    [disabled]="switch_branching"
-    (click)="create_branch(branchName)"
-  >
-    Create Branch
-  </button>
-</div>

package/src/devtools/devtools.interface.ts

@@ -1,3 +0,0 @@
-export interface RxDBDevToolsOptions {
-  theme?: 'light' | 'dark';
-}

package/src/devtools/devtools.scss

@@ -1,49 +0,0 @@
-:host {
-  position: fixed;
-  display: flex;
-  flex-direction: column;
-  z-index: 100;
-  border: 1px solid #ccc;
-}
-
-.touch {
-  position: absolute;
-  height: 100%;
-  width: 4px;
-  z-index: 1000;
-  cursor: ew-resize;
-  transition: background 0.1s 0.3s;
-  &:hover {
-    background-color: rgba($color: blue, $alpha: 0.2);
-  }
-}
-
-:host(.right) {
-  top: 0;
-  right: 0;
-  .touch {
-    left: 0;
-    transform: translateX(-2px);
-  }
-}
-
-:host(.left) {
-  top: 0;
-  left: 0;
-  .touch {
-    right: 0;
-    transform: translateX(2px);
-  }
-}
-
-:host(.bottom) {
-  bottom: 0;
-  left: 0;
-  .touch {
-    top: 0;
-    width: 100%;
-    height: 4px;
-    transform: translateY(-2px);
-    cursor: ns-resize;
-  }
-}

package/src/devtools/devtools.spec.ts

@@ -1,30 +0,0 @@
-import { provideZonelessChangeDetection } from '@angular/core';
-import { ComponentFixture, TestBed } from '@angular/core/testing';
-import { BrowserModule } from '@angular/platform-browser';
-import { beforeEach, describe, expect, it } from 'vitest';
-import { provideRxDB } from '../rxdb.provider';
-import { RxDBDevtools } from './devtools';
-
-const setup_rxdb = () => {
-  return null as any;
-};
-
-describe('RxDBDevtools', () => {
-  let component: RxDBDevtools;
-  let fixture: ComponentFixture<RxDBDevtools>;
-
-  beforeEach(async () => {
-    await TestBed.configureTestingModule({
-      imports: [RxDBDevtools, BrowserModule],
-      providers: [provideZonelessChangeDetection(), provideRxDB(setup_rxdb)]
-    }).compileComponents();
-
-    fixture = TestBed.createComponent(RxDBDevtools);
-    component = fixture.componentInstance;
-    fixture.detectChanges();
-  });
-
-  it('should create', () => {
-    expect(component).toBeTruthy();
-  });
-});