@nest-yalc-2/omnikernel-module 2.2.2 → 2.2.6

package/src/omnikernel.diagnostics.ts

@@ -1,83 +1,83 @@
-import type { DataSource } from 'typeorm';
-
-export interface OmniKernelQueryPlanEvidence {
-  dialect: 'sqlite' | 'postgres';
-  recordGridPlan: readonly string[];
-  relationSourcePlan: readonly string[];
-  usesRecordGridIndex: boolean;
-  usesRelationSourceIndex: boolean;
-}
-
-const recordGridIndex = 'omni_record_scope_kind_status_guid_idx';
-const relationSourceIndex =
-  'omni_relation_scope_source_kind_status_created_guid_idx';
-
-/**
- * Bounded operator evidence for the two high-fanout generated read shapes.
- * This is diagnostic-only: CRUD continues to use the normal TypeORM path.
- */
-export async function collectOmniKernelQueryPlanEvidence(
-  dataSource: DataSource,
-  sample: {
-    scopeId: string;
-    recordKind: string;
-    recordStatus: string;
-    sourceRecordId: string;
-    relationKind: string;
-    relationStatus: string;
-  },
-): Promise<OmniKernelQueryPlanEvidence> {
-  const dialect = dataSource.options.type;
-  if (dialect !== 'sqlite' && dialect !== 'postgres') {
-    throw new TypeError(
-      'OmniKernel diagnostics support sqlite and postgres only.',
-    );
-  }
-
-  const statements =
-    dialect === 'sqlite'
-      ? {
-          record: `EXPLAIN QUERY PLAN SELECT "guid" FROM "omni-record" WHERE "scopeId" = ? AND "kind" = ? AND "status" = ? AND "deletedAt" IS NULL ORDER BY "guid"`,
-          relation: `EXPLAIN QUERY PLAN SELECT "guid" FROM "omni-relation" WHERE "scopeId" = ? AND "sourceRecordId" = ? AND "kind" = ? AND "status" = ? ORDER BY "createdAt", "guid"`,
-        }
-      : {
-          record: `EXPLAIN (FORMAT JSON) SELECT "guid" FROM "omni-record" WHERE "scopeId" = $1 AND "kind" = $2 AND "status" = $3 AND "deletedAt" IS NULL ORDER BY "guid"`,
-          relation: `EXPLAIN (FORMAT JSON) SELECT "guid" FROM "omni-relation" WHERE "scopeId" = $1 AND "sourceRecordId" = $2 AND "kind" = $3 AND "status" = $4 ORDER BY "createdAt", "guid"`,
-        };
-
-  const recordResult = await dataSource.query(statements.record, [
-    sample.scopeId,
-    sample.recordKind,
-    sample.recordStatus,
-  ]);
-  const relationResult = await dataSource.query(statements.relation, [
-    sample.scopeId,
-    sample.sourceRecordId,
-    sample.relationKind,
-    sample.relationStatus,
-  ]);
-  const recordGridPlan = flattenPlan(recordResult);
-  const relationSourcePlan = flattenPlan(relationResult);
-
-  return {
-    dialect,
-    recordGridPlan,
-    relationSourcePlan,
-    usesRecordGridIndex: containsIndex(recordGridPlan, recordGridIndex),
-    usesRelationSourceIndex: containsIndex(
-      relationSourcePlan,
-      relationSourceIndex,
-    ),
-  };
-}
-
-function flattenPlan(result: unknown): string[] {
-  return JSON.stringify(result)
-    .replaceAll('\\n', ' ')
-    .split(/(?<=\}),|\n/)
-    .filter((line) => line.length > 0);
-}
-
-function containsIndex(plan: readonly string[], indexName: string): boolean {
-  return plan.some((line) => line.includes(indexName));
-}
+import type { DataSource } from 'typeorm';
+
+export interface OmniKernelQueryPlanEvidence {
+  dialect: 'sqlite' | 'postgres';
+  recordGridPlan: readonly string[];
+  relationSourcePlan: readonly string[];
+  usesRecordGridIndex: boolean;
+  usesRelationSourceIndex: boolean;
+}
+
+const recordGridIndex = 'omni_record_scope_kind_status_guid_idx';
+const relationSourceIndex =
+  'omni_relation_scope_source_kind_status_created_guid_idx';
+
+/**
+ * Bounded operator evidence for the two high-fanout generated read shapes.
+ * This is diagnostic-only: CRUD continues to use the normal TypeORM path.
+ */
+export async function collectOmniKernelQueryPlanEvidence(
+  dataSource: DataSource,
+  sample: {
+    scopeId: string;
+    recordKind: string;
+    recordStatus: string;
+    sourceRecordId: string;
+    relationKind: string;
+    relationStatus: string;
+  },
+): Promise<OmniKernelQueryPlanEvidence> {
+  const dialect = dataSource.options.type;
+  if (dialect !== 'sqlite' && dialect !== 'postgres') {
+    throw new TypeError(
+      'OmniKernel diagnostics support sqlite and postgres only.',
+    );
+  }
+
+  const statements =
+    dialect === 'sqlite'
+      ? {
+          record: `EXPLAIN QUERY PLAN SELECT "guid" FROM "omni-record" WHERE "scopeId" = ? AND "kind" = ? AND "status" = ? AND "deletedAt" IS NULL ORDER BY "guid"`,
+          relation: `EXPLAIN QUERY PLAN SELECT "guid" FROM "omni-relation" WHERE "scopeId" = ? AND "sourceRecordId" = ? AND "kind" = ? AND "status" = ? ORDER BY "createdAt", "guid"`,
+        }
+      : {
+          record: `EXPLAIN (FORMAT JSON) SELECT "guid" FROM "omni-record" WHERE "scopeId" = $1 AND "kind" = $2 AND "status" = $3 AND "deletedAt" IS NULL ORDER BY "guid"`,
+          relation: `EXPLAIN (FORMAT JSON) SELECT "guid" FROM "omni-relation" WHERE "scopeId" = $1 AND "sourceRecordId" = $2 AND "kind" = $3 AND "status" = $4 ORDER BY "createdAt", "guid"`,
+        };
+
+  const recordResult = await dataSource.query(statements.record, [
+    sample.scopeId,
+    sample.recordKind,
+    sample.recordStatus,
+  ]);
+  const relationResult = await dataSource.query(statements.relation, [
+    sample.scopeId,
+    sample.sourceRecordId,
+    sample.relationKind,
+    sample.relationStatus,
+  ]);
+  const recordGridPlan = flattenPlan(recordResult);
+  const relationSourcePlan = flattenPlan(relationResult);
+
+  return {
+    dialect,
+    recordGridPlan,
+    relationSourcePlan,
+    usesRecordGridIndex: containsIndex(recordGridPlan, recordGridIndex),
+    usesRelationSourceIndex: containsIndex(
+      relationSourcePlan,
+      relationSourceIndex,
+    ),
+  };
+}
+
+function flattenPlan(result: unknown): string[] {
+  return JSON.stringify(result)
+    .replaceAll('\\n', ' ')
+    .split(/(?<=\}),|\n/)
+    .filter((line) => line.length > 0);
+}
+
+function containsIndex(plan: readonly string[], indexName: string): boolean {
+  return plan.some((line) => line.includes(indexName));
+}

package/src/omnikernel.module.ts

@@ -1,97 +1,97 @@
-import { DynamicModule, Module } from '@nestjs/common';
-import { EventEmitter2 } from '@nestjs/event-emitter';
-import { TypeOrmModule } from '@nestjs/typeorm';
-import { OmniExternalRefEntity } from './base/omni-external-ref.entity.js';
-import { OmniNamedEntity } from './base/omni-named.entity.js';
-import { OmniRecordEntity } from './base/omni-record.entity.js';
-import { OmniRelationEntity } from './base/omni-relation.entity.js';
-import { OmniCollectionEntity } from './omni-collection.entity.js';
-import { omniCollectionBackendProvidersFactory } from './omni-collection.backend.js';
-import { OmniDocumentEntity } from './omni-document.entity.js';
-import { omniDocumentBackendProvidersFactory } from './omni-document.backend.js';
-import { omniExternalRefBackendProvidersFactory } from './omni-external-ref.backend.js';
-import { omniNamedBackendProvidersFactory } from './omni-named.backend.js';
-import { omniRecordBackendProvidersFactory } from './omni-record.backend.js';
-import { omniRelationBackendProvidersFactory } from './omni-relation.backend.js';
-import {
-  OmniKernelQueryService,
-  omniKernelQueryServiceProviderFactory,
-} from './omnikernel.query.service.js';
-import {
-  OMNI_KERNEL_OPTIONS,
-  OmniScopeContext,
-  normalizeOmniKernelRegistrationOptions,
-  type OmniKernelRegistrationOptions,
-} from './omni-scope.js';
-
-@Module({})
-export class OmniKernelModule {
-  static register(
-    registration: string | OmniKernelRegistrationOptions,
-  ): DynamicModule {
-    const options = normalizeOmniKernelRegistrationOptions(registration);
-    const { dbConnection } = options;
-    const omniNamedProviders =
-      omniNamedBackendProvidersFactory(dbConnection).providers;
-    const omniRecordProviders = omniRecordBackendProvidersFactory(
-      dbConnection,
-      options.reservedRecordKinds,
-    ).providers;
-    const omniRelationProviders =
-      omniRelationBackendProvidersFactory(dbConnection).providers;
-    const omniCollectionProviders =
-      omniCollectionBackendProvidersFactory(dbConnection).providers;
-    const omniDocumentProviders =
-      omniDocumentBackendProvidersFactory(dbConnection).providers;
-    const omniExternalRefProviders =
-      omniExternalRefBackendProvidersFactory(dbConnection).providers;
-    const omniKernelQueryServiceProvider =
-      omniKernelQueryServiceProviderFactory(dbConnection);
-    const eventEmitter = new EventEmitter2();
-
-    return {
-      module: OmniKernelModule,
-      imports: [
-        TypeOrmModule.forFeature(
-          [
-            OmniNamedEntity,
-            OmniRecordEntity,
-            OmniRelationEntity,
-            OmniCollectionEntity,
-            OmniDocumentEntity,
-            OmniExternalRefEntity,
-          ],
-          dbConnection,
-        ),
-      ],
-      providers: [
-        { provide: OMNI_KERNEL_OPTIONS, useValue: options },
-        OmniScopeContext,
-        {
-          provide: EventEmitter2,
-          useValue: eventEmitter,
-        },
-        ...omniNamedProviders,
-        ...omniRecordProviders,
-        ...omniRelationProviders,
-        ...omniCollectionProviders,
-        ...omniDocumentProviders,
-        ...omniExternalRefProviders,
-        omniKernelQueryServiceProvider,
-      ],
-      exports: [
-        OMNI_KERNEL_OPTIONS,
-        OmniScopeContext,
-        EventEmitter2,
-        ...omniNamedProviders,
-        ...omniRecordProviders,
-        ...omniRelationProviders,
-        ...omniCollectionProviders,
-        ...omniDocumentProviders,
-        ...omniExternalRefProviders,
-        omniKernelQueryServiceProvider,
-        OmniKernelQueryService,
-      ],
-    };
-  }
-}
+import { DynamicModule, Module } from '@nestjs/common';
+import { EventEmitter2 } from '@nestjs/event-emitter';
+import { TypeOrmModule } from '@nestjs/typeorm';
+import { OmniExternalRefEntity } from './base/omni-external-ref.entity.js';
+import { OmniNamedEntity } from './base/omni-named.entity.js';
+import { OmniRecordEntity } from './base/omni-record.entity.js';
+import { OmniRelationEntity } from './base/omni-relation.entity.js';
+import { OmniCollectionEntity } from './omni-collection.entity.js';
+import { omniCollectionBackendProvidersFactory } from './omni-collection.backend.js';
+import { OmniDocumentEntity } from './omni-document.entity.js';
+import { omniDocumentBackendProvidersFactory } from './omni-document.backend.js';
+import { omniExternalRefBackendProvidersFactory } from './omni-external-ref.backend.js';
+import { omniNamedBackendProvidersFactory } from './omni-named.backend.js';
+import { omniRecordBackendProvidersFactory } from './omni-record.backend.js';
+import { omniRelationBackendProvidersFactory } from './omni-relation.backend.js';
+import {
+  OmniKernelQueryService,
+  omniKernelQueryServiceProviderFactory,
+} from './omnikernel.query.service.js';
+import {
+  OMNI_KERNEL_OPTIONS,
+  OmniScopeContext,
+  normalizeOmniKernelRegistrationOptions,
+  type OmniKernelRegistrationOptions,
+} from './omni-scope.js';
+
+@Module({})
+export class OmniKernelModule {
+  static register(
+    registration: string | OmniKernelRegistrationOptions,
+  ): DynamicModule {
+    const options = normalizeOmniKernelRegistrationOptions(registration);
+    const { dbConnection } = options;
+    const omniNamedProviders =
+      omniNamedBackendProvidersFactory(dbConnection).providers;
+    const omniRecordProviders = omniRecordBackendProvidersFactory(
+      dbConnection,
+      options.reservedRecordKinds,
+    ).providers;
+    const omniRelationProviders =
+      omniRelationBackendProvidersFactory(dbConnection).providers;
+    const omniCollectionProviders =
+      omniCollectionBackendProvidersFactory(dbConnection).providers;
+    const omniDocumentProviders =
+      omniDocumentBackendProvidersFactory(dbConnection).providers;
+    const omniExternalRefProviders =
+      omniExternalRefBackendProvidersFactory(dbConnection).providers;
+    const omniKernelQueryServiceProvider =
+      omniKernelQueryServiceProviderFactory(dbConnection);
+    const eventEmitter = new EventEmitter2();
+
+    return {
+      module: OmniKernelModule,
+      imports: [
+        TypeOrmModule.forFeature(
+          [
+            OmniNamedEntity,
+            OmniRecordEntity,
+            OmniRelationEntity,
+            OmniCollectionEntity,
+            OmniDocumentEntity,
+            OmniExternalRefEntity,
+          ],
+          dbConnection,
+        ),
+      ],
+      providers: [
+        { provide: OMNI_KERNEL_OPTIONS, useValue: options },
+        OmniScopeContext,
+        {
+          provide: EventEmitter2,
+          useValue: eventEmitter,
+        },
+        ...omniNamedProviders,
+        ...omniRecordProviders,
+        ...omniRelationProviders,
+        ...omniCollectionProviders,
+        ...omniDocumentProviders,
+        ...omniExternalRefProviders,
+        omniKernelQueryServiceProvider,
+      ],
+      exports: [
+        OMNI_KERNEL_OPTIONS,
+        OmniScopeContext,
+        EventEmitter2,
+        ...omniNamedProviders,
+        ...omniRecordProviders,
+        ...omniRelationProviders,
+        ...omniCollectionProviders,
+        ...omniDocumentProviders,
+        ...omniExternalRefProviders,
+        omniKernelQueryServiceProvider,
+        OmniKernelQueryService,
+      ],
+    };
+  }
+}

package/src/omnikernel.query.service.ts

@@ -1,108 +1,108 @@
-import { FactoryProvider, Scope } from '@nestjs/common';
-import { getRepositoryToken } from '@nestjs/typeorm';
-import { Repository } from 'typeorm';
-import { OmniExternalRefEntity } from './base/omni-external-ref.entity.js';
-import { OmniRecordEntity } from './base/omni-record.entity.js';
-import { OmniRelationEntity } from './base/omni-relation.entity.js';
-import { OmniCollectionEntity } from './omni-collection.entity.js';
-import { OmniExternalRefInternalType } from './omni-external-ref-internal-type.enum.js';
-import { OmniRelationKind } from './omni-relation-kind.enum.js';
-import { OmniRelationStatus } from './omni-relation-status.enum.js';
-import { isOmniCollectionRecordKind } from './omni-relation-semantics.js';
-import { OmniScopeContext, type OmniScope } from './omni-scope.js';
-
-const defaultQueryScope: OmniScope = {
-  scopeId: 'default',
-  cacheKey: (key) => `default:${key}`,
-};
-
-export class OmniKernelQueryService {
-  constructor(
-    protected relationRepository: Repository<OmniRelationEntity>,
-    protected externalRefRepository: Repository<OmniExternalRefEntity>,
-    protected readonly scope: OmniScope = defaultQueryScope,
-  ) {}
-
-  async getCollectionMembers(
-    collectionId: string,
-  ): Promise<OmniRecordEntity[]> {
-    const relations = await this.relationRepository.find({
-      where: {
-        scopeId: this.scope.scopeId,
-        sourceRecordId: collectionId,
-        kind: OmniRelationKind.Contains,
-        status: OmniRelationStatus.Active,
-      },
-      relations: {
-        targetRecord: true,
-      },
-      order: {
-        createdAt: 'ASC',
-      },
-    });
-
-    return relations.map((relation) => relation.targetRecord);
-  }
-
-  async getDocumentCollections(
-    documentId: string,
-  ): Promise<OmniCollectionEntity[]> {
-    const relations = await this.relationRepository.find({
-      where: {
-        scopeId: this.scope.scopeId,
-        targetRecordId: documentId,
-        kind: OmniRelationKind.Contains,
-        status: OmniRelationStatus.Active,
-      },
-      relations: {
-        sourceRecord: true,
-      },
-      order: {
-        createdAt: 'ASC',
-      },
-    });
-
-    return relations
-      .map((relation) => relation.sourceRecord)
-      .filter(
-        (record): record is OmniCollectionEntity =>
-          !!record && isOmniCollectionRecordKind(record.kind),
-      );
-  }
-
-  async getDocumentExternalRefs(documentId: string, provider?: string) {
-    return this.externalRefRepository.find({
-      where: {
-        scopeId: this.scope.scopeId,
-        internalType: OmniExternalRefInternalType.Document,
-        internalId: documentId,
-        ...(provider ? { provider } : {}),
-      },
-      order: {
-        createdAt: 'ASC',
-      },
-    });
-  }
-}
-
-export const omniKernelQueryServiceProviderFactory = (
-  dbConnection: string,
-): FactoryProvider<OmniKernelQueryService> => ({
-  provide: OmniKernelQueryService,
-  scope: Scope.REQUEST,
-  useFactory: (
-    relationRepository: Repository<OmniRelationEntity>,
-    externalRefRepository: Repository<OmniExternalRefEntity>,
-    scope: OmniScope,
-  ) =>
-    new OmniKernelQueryService(
-      relationRepository,
-      externalRefRepository,
-      scope,
-    ),
-  inject: [
-    getRepositoryToken(OmniRelationEntity, dbConnection),
-    getRepositoryToken(OmniExternalRefEntity, dbConnection),
-    OmniScopeContext,
-  ],
-});
+import { FactoryProvider, Scope } from '@nestjs/common';
+import { getRepositoryToken } from '@nestjs/typeorm';
+import { Repository } from 'typeorm';
+import { OmniExternalRefEntity } from './base/omni-external-ref.entity.js';
+import { OmniRecordEntity } from './base/omni-record.entity.js';
+import { OmniRelationEntity } from './base/omni-relation.entity.js';
+import { OmniCollectionEntity } from './omni-collection.entity.js';
+import { OmniExternalRefInternalType } from './omni-external-ref-internal-type.enum.js';
+import { OmniRelationKind } from './omni-relation-kind.enum.js';
+import { OmniRelationStatus } from './omni-relation-status.enum.js';
+import { isOmniCollectionRecordKind } from './omni-relation-semantics.js';
+import { OmniScopeContext, type OmniScope } from './omni-scope.js';
+
+const defaultQueryScope: OmniScope = {
+  scopeId: 'default',
+  cacheKey: (key) => `default:${key}`,
+};
+
+export class OmniKernelQueryService {
+  constructor(
+    protected relationRepository: Repository<OmniRelationEntity>,
+    protected externalRefRepository: Repository<OmniExternalRefEntity>,
+    protected readonly scope: OmniScope = defaultQueryScope,
+  ) {}
+
+  async getCollectionMembers(
+    collectionId: string,
+  ): Promise<OmniRecordEntity[]> {
+    const relations = await this.relationRepository.find({
+      where: {
+        scopeId: this.scope.scopeId,
+        sourceRecordId: collectionId,
+        kind: OmniRelationKind.Contains,
+        status: OmniRelationStatus.Active,
+      },
+      relations: {
+        targetRecord: true,
+      },
+      order: {
+        createdAt: 'ASC',
+      },
+    });
+
+    return relations.map((relation) => relation.targetRecord);
+  }
+
+  async getDocumentCollections(
+    documentId: string,
+  ): Promise<OmniCollectionEntity[]> {
+    const relations = await this.relationRepository.find({
+      where: {
+        scopeId: this.scope.scopeId,
+        targetRecordId: documentId,
+        kind: OmniRelationKind.Contains,
+        status: OmniRelationStatus.Active,
+      },
+      relations: {
+        sourceRecord: true,
+      },
+      order: {
+        createdAt: 'ASC',
+      },
+    });
+
+    return relations
+      .map((relation) => relation.sourceRecord)
+      .filter(
+        (record): record is OmniCollectionEntity =>
+          !!record && isOmniCollectionRecordKind(record.kind),
+      );
+  }
+
+  async getDocumentExternalRefs(documentId: string, provider?: string) {
+    return this.externalRefRepository.find({
+      where: {
+        scopeId: this.scope.scopeId,
+        internalType: OmniExternalRefInternalType.Document,
+        internalId: documentId,
+        ...(provider ? { provider } : {}),
+      },
+      order: {
+        createdAt: 'ASC',
+      },
+    });
+  }
+}
+
+export const omniKernelQueryServiceProviderFactory = (
+  dbConnection: string,
+): FactoryProvider<OmniKernelQueryService> => ({
+  provide: OmniKernelQueryService,
+  scope: Scope.REQUEST,
+  useFactory: (
+    relationRepository: Repository<OmniRelationEntity>,
+    externalRefRepository: Repository<OmniExternalRefEntity>,
+    scope: OmniScope,
+  ) =>
+    new OmniKernelQueryService(
+      relationRepository,
+      externalRefRepository,
+      scope,
+    ),
+  inject: [
+    getRepositoryToken(OmniRelationEntity, dbConnection),
+    getRepositoryToken(OmniExternalRefEntity, dbConnection),
+    OmniScopeContext,
+  ],
+});