diff --git a/examples/omnikernel-module/README.md b/examples/omnikernel-module/README.md index aa789a61..7ccc5112 100644 --- a/examples/omnikernel-module/README.md +++ b/examples/omnikernel-module/README.md @@ -12,10 +12,18 @@ It follows the same `CrudGenDependencyFactory` pattern used by `examples/task-system-module`, so each entity exposes the usual auto-wired service, dataloader, and GraphQL resolver providers. +## PR 2 additions + +- typed record and relation enums for status and relation semantics +- `OmniDocumentEntity` as the first concrete record family built on + `OmniRecordEntity` + ## Entities - `OmniNamedEntity`: basic named records with `externalId`, `title`, and `slug`. - `OmniRecordEntity`: richer records with `kind`, `status`, and `payload`. +- `OmniDocumentEntity`: concrete document-like records with document subtype, + content, source URL, and publication timestamp. - `OmniRelationEntity`: directional links between two Omni records. - `OmniExternalRefEntity`: provider-specific mappings between internal records and external systems. diff --git a/examples/omnikernel-module/src/__tests__/omni-document.entity.spec.ts b/examples/omnikernel-module/src/__tests__/omni-document.entity.spec.ts new file mode 100644 index 00000000..15eba32f --- /dev/null +++ b/examples/omnikernel-module/src/__tests__/omni-document.entity.spec.ts @@ -0,0 +1,50 @@ +import { describe, expect, it } from '@jest/globals'; +import { getMetadataArgsStorage } from 'typeorm'; + +const { OmniRecordEntity } = await import('../base/omni-record.entity.js'); +const { OmniDocumentEntity } = await import('../omni-document.entity.js'); +const { OmniDocumentKind } = await import('../omni-document-kind.enum.js'); + +describe('OmniDocumentEntity', () => { + it('extends OmniRecordEntity', () => { + expect(new OmniDocumentEntity()).toBeInstanceOf(OmniRecordEntity); + }); + + it('registers document-specific columns', () => { + const metadata = getMetadataArgsStorage(); + const table = metadata.tables.find( + (item) => item.target === OmniDocumentEntity, + ); + const entityColumns = metadata.columns + .filter((item) => item.target === OmniDocumentEntity) + .map((item) => item.propertyName); + + expect(table?.name).toBe('omni-document'); + expect(entityColumns).toEqual( + expect.arrayContaining([ + 'documentKind', + 'content', + 'contentMimeType', + 'sourceUrl', + 'publishedAt', + ]), + ); + }); + + it('defaults the base record kind to document when missing', () => { + const entity = new OmniDocumentEntity(); + + entity.ensureDocumentRecordKind(); + + expect(entity.kind).toBe(OmniDocumentKind.Document); + }); + + it('preserves an explicit base record kind when already set', () => { + const entity = new OmniDocumentEntity(); + entity.kind = OmniDocumentKind.Document; + + entity.ensureDocumentRecordKind(); + + expect(entity.kind).toBe(OmniDocumentKind.Document); + }); +}); diff --git a/examples/omnikernel-module/src/base/omni-record.entity.ts b/examples/omnikernel-module/src/base/omni-record.entity.ts index 56b6ddf6..50404d48 100644 --- a/examples/omnikernel-module/src/base/omni-record.entity.ts +++ b/examples/omnikernel-module/src/base/omni-record.entity.ts @@ -3,6 +3,7 @@ import { Column, Entity, OneToMany } from 'typeorm'; import type { Relation } from 'typeorm'; import { OmniNamedEntity } from './omni-named.entity.js'; import { OmniRelationEntity } from './omni-relation.entity.js'; +import { OmniRecordStatus } from '../omni-record-status.enum.js'; @Entity('omni-record') @ObjectType({ isAbstract: true }) @@ -10,8 +11,12 @@ export class OmniRecordEntity extends OmniNamedEntity { @Column('varchar', { length: 64 }) kind!: string; - @Column('varchar', { default: 'draft', length: 32 }) - status!: string; + @Column('varchar', { + default: OmniRecordStatus.Draft, + enum: Object.values(OmniRecordStatus), + length: 32, + }) + status!: OmniRecordStatus; @Column('simple-json', { nullable: true }) payload?: Record | null; diff --git a/examples/omnikernel-module/src/base/omni-relation.entity.ts b/examples/omnikernel-module/src/base/omni-relation.entity.ts index 99acd846..916d1484 100644 --- a/examples/omnikernel-module/src/base/omni-relation.entity.ts +++ b/examples/omnikernel-module/src/base/omni-relation.entity.ts @@ -3,6 +3,8 @@ import { Column, Entity, JoinColumn, ManyToOne } from 'typeorm'; import type { Relation } from 'typeorm'; import { OmniBaseEntity } from './omni-base.entity.js'; import { OmniRecordEntity } from './omni-record.entity.js'; +import { OmniRelationKind } from '../omni-relation-kind.enum.js'; +import { OmniRelationStatus } from '../omni-relation-status.enum.js'; @Entity('omni-relation') @ObjectType({ isAbstract: true }) @@ -21,11 +23,18 @@ export class OmniRelationEntity extends OmniBaseEntity { @JoinColumn({ name: 'targetRecordId', referencedColumnName: 'guid' }) targetRecord!: Relation; - @Column('varchar', { length: 64 }) - kind!: string; + @Column('varchar', { + enum: Object.values(OmniRelationKind), + length: 64, + }) + kind!: OmniRelationKind; - @Column('varchar', { default: 'active', length: 32 }) - status!: string; + @Column('varchar', { + default: OmniRelationStatus.Active, + enum: Object.values(OmniRelationStatus), + length: 32, + }) + status!: OmniRelationStatus; @Column('simple-json', { nullable: true }) payload?: Record | null; diff --git a/examples/omnikernel-module/src/index.ts b/examples/omnikernel-module/src/index.ts index f4cfee79..1a67a593 100644 --- a/examples/omnikernel-module/src/index.ts +++ b/examples/omnikernel-module/src/index.ts @@ -5,8 +5,15 @@ export * from './base/omni-relation.entity.js'; export * from './base/omni-external-ref.entity.js'; export * from './omni-named.dto.js'; export * from './omni-named.resolver.js'; +export * from './omni-record-status.enum.js'; +export * from './omni-relation-status.enum.js'; +export * from './omni-relation-kind.enum.js'; export * from './omni-record.dto.js'; export * from './omni-record.resolver.js'; +export * from './omni-document-kind.enum.js'; +export * from './omni-document.entity.js'; +export * from './omni-document.dto.js'; +export * from './omni-document.resolver.js'; export * from './omni-relation.dto.js'; export * from './omni-relation.resolver.js'; export * from './omni-external-ref.dto.js'; diff --git a/examples/omnikernel-module/src/omni-document-kind.enum.ts b/examples/omnikernel-module/src/omni-document-kind.enum.ts new file mode 100644 index 00000000..f5cb2063 --- /dev/null +++ b/examples/omnikernel-module/src/omni-document-kind.enum.ts @@ -0,0 +1,6 @@ +export enum OmniDocumentKind { + Document = 'document', + Note = 'note', + Article = 'article', + Page = 'page', +} diff --git a/examples/omnikernel-module/src/omni-document.dto.ts b/examples/omnikernel-module/src/omni-document.dto.ts new file mode 100644 index 00000000..e6809d2b --- /dev/null +++ b/examples/omnikernel-module/src/omni-document.dto.ts @@ -0,0 +1,172 @@ +import { + Field, + InputType, + ObjectType, + OmitType, + PartialType, +} from '@nestjs/graphql'; +import { + ModelField, + ModelObject, +} from '@nestjs-yalc/crud-gen/object.decorator.js'; +import { UUIDScalar } from '@nestjs-yalc/graphql/scalars/uuid.scalar.js'; +import returnValue from '@nestjs-yalc/utils/returnValue.js'; +import { + IsDate, + IsEnum, + IsIn, + IsObject, + IsOptional, + IsString, + IsUrl, + IsUUID, + MaxLength, +} from 'class-validator'; +import { GraphQLJSONObject } from 'graphql-type-json'; +import type { Relation } from 'typeorm'; +import { OmniDocumentEntity } from './omni-document.entity.js'; +import { OmniDocumentKind } from './omni-document-kind.enum.js'; +import { OmniRecordStatus } from './omni-record-status.enum.js'; +import { OmniRelationEntity } from './base/omni-relation.entity.js'; +import { OmniRelationType } from './omni-relation.dto.js'; + +@ObjectType() +@ModelObject() +export class OmniDocumentType extends OmniDocumentEntity { + constructor(data?: Partial) { + super(); + if (data) { + Object.assign(this, data); + } + } + + @ModelField({ gqlType: returnValue(UUIDScalar), isRequired: true }) + @Field(() => UUIDScalar) + @IsUUID() + guid!: string; + + @ModelField({ gqlOptions: { nullable: true } }) + @Field({ nullable: true }) + @IsOptional() + @IsString() + @MaxLength(128) + externalId?: string | null; + + @ModelField({}) + @Field() + @IsString() + @MaxLength(255) + title!: string; + + @ModelField({ gqlOptions: { nullable: true } }) + @Field({ nullable: true }) + @IsOptional() + @IsString() + @MaxLength(255) + slug?: string | null; + + @ModelField({}) + @Field() + @IsString() + @IsIn([OmniDocumentKind.Document]) + kind!: string; + + @ModelField({}) + @Field() + @IsEnum(OmniRecordStatus) + status!: OmniRecordStatus; + + @ModelField({ + gqlType: returnValue(GraphQLJSONObject), + gqlOptions: { nullable: true }, + }) + @Field(() => GraphQLJSONObject, { nullable: true }) + @IsOptional() + @IsObject() + payload?: Record | null; + + @ModelField({ + gqlType: returnValue([OmniRelationType]), + gqlOptions: { nullable: true }, + relation: { + relationType: 'one-to-many', + sourceKey: { dst: 'guid', alias: 'guid' }, + targetKey: { dst: 'sourceRecordId', alias: 'sourceRecordId' }, + type: () => OmniRelationEntity, + }, + }) + @Field(() => [OmniRelationType], { nullable: true }) + outgoingRelations?: Relation; + + @ModelField({ + gqlType: returnValue([OmniRelationType]), + gqlOptions: { nullable: true }, + relation: { + relationType: 'one-to-many', + sourceKey: { dst: 'guid', alias: 'guid' }, + targetKey: { dst: 'targetRecordId', alias: 'targetRecordId' }, + type: () => OmniRelationEntity, + }, + }) + @Field(() => [OmniRelationType], { nullable: true }) + incomingRelations?: Relation; + + @ModelField({}) + @Field() + @IsEnum(OmniDocumentKind) + documentKind!: OmniDocumentKind; + + @ModelField({ gqlOptions: { nullable: true } }) + @Field({ nullable: true }) + @IsOptional() + @IsString() + content?: string | null; + + @ModelField({ gqlOptions: { nullable: true } }) + @Field({ nullable: true }) + @IsOptional() + @IsString() + @MaxLength(128) + contentMimeType?: string | null; + + @ModelField({ gqlOptions: { nullable: true } }) + @Field({ nullable: true }) + @IsOptional() + @IsUrl() + @MaxLength(2048) + sourceUrl?: string | null; + + @ModelField({ gqlOptions: { nullable: true } }) + @Field({ nullable: true }) + @IsOptional() + @IsDate() + publishedAt?: Date | null; +} + +@InputType() +@ModelObject() +export class OmniDocumentCreateInput extends OmitType( + OmniDocumentType, + [ + 'createdAt', + 'updatedAt', + 'kind', + 'outgoingRelations', + 'incomingRelations', + ] as const, + InputType, +) {} + +@InputType() +@ModelObject({ copyFrom: OmniDocumentType }) +export class OmniDocumentCondition extends PartialType( + OmniDocumentCreateInput, + InputType, +) {} + +@InputType() +@ModelObject({ copyFrom: OmniDocumentType }) +export class OmniDocumentUpdateInput extends PartialType( + OmniDocumentCreateInput, + InputType, +) {} diff --git a/examples/omnikernel-module/src/omni-document.entity.ts b/examples/omnikernel-module/src/omni-document.entity.ts new file mode 100644 index 00000000..85ad0e43 --- /dev/null +++ b/examples/omnikernel-module/src/omni-document.entity.ts @@ -0,0 +1,35 @@ +import { ObjectType } from '@nestjs/graphql'; +import { BeforeInsert, BeforeUpdate, Column, Entity } from 'typeorm'; +import { OmniRecordEntity } from './base/omni-record.entity.js'; +import { OmniDocumentKind } from './omni-document-kind.enum.js'; + +@Entity('omni-document') +@ObjectType({ isAbstract: true }) +export class OmniDocumentEntity extends OmniRecordEntity { + @Column('varchar', { + default: OmniDocumentKind.Document, + enum: Object.values(OmniDocumentKind), + length: 32, + }) + documentKind!: OmniDocumentKind; + + @Column('text', { nullable: true }) + content?: string | null; + + @Column('varchar', { nullable: true, length: 128 }) + contentMimeType?: string | null; + + @Column('varchar', { nullable: true, length: 2048 }) + sourceUrl?: string | null; + + @Column('datetime', { nullable: true }) + publishedAt?: Date | null; + + @BeforeInsert() + @BeforeUpdate() + ensureDocumentRecordKind() { + if (!this.kind) { + this.kind = OmniDocumentKind.Document; + } + } +} diff --git a/examples/omnikernel-module/src/omni-document.resolver.ts b/examples/omnikernel-module/src/omni-document.resolver.ts new file mode 100644 index 00000000..62d706d6 --- /dev/null +++ b/examples/omnikernel-module/src/omni-document.resolver.ts @@ -0,0 +1,27 @@ +import { CrudGenDependencyFactory } from '@nestjs-yalc/crud-gen/crud-gen.helpers.js'; +import { + OmniDocumentCondition, + OmniDocumentCreateInput, + OmniDocumentType, + OmniDocumentUpdateInput, +} from './omni-document.dto.js'; +import { OmniDocumentEntity } from './omni-document.entity.js'; + +export const omniDocumentProvidersFactory = (dbConnection: string) => + CrudGenDependencyFactory({ + entityModel: OmniDocumentEntity, + resolver: { + dto: OmniDocumentType, + input: { + create: OmniDocumentCreateInput, + update: OmniDocumentUpdateInput, + conditions: OmniDocumentCondition, + }, + prefix: 'OmniKernel_', + }, + service: { + dbConnection, + entityModel: OmniDocumentEntity, + }, + dataloader: { databaseKey: 'guid' }, + }); diff --git a/examples/omnikernel-module/src/omni-record-status.enum.ts b/examples/omnikernel-module/src/omni-record-status.enum.ts new file mode 100644 index 00000000..9a7672fe --- /dev/null +++ b/examples/omnikernel-module/src/omni-record-status.enum.ts @@ -0,0 +1,5 @@ +export enum OmniRecordStatus { + Draft = 'draft', + Active = 'active', + Archived = 'archived', +} diff --git a/examples/omnikernel-module/src/omni-record.dto.ts b/examples/omnikernel-module/src/omni-record.dto.ts index e80b5dcc..c5fde87d 100644 --- a/examples/omnikernel-module/src/omni-record.dto.ts +++ b/examples/omnikernel-module/src/omni-record.dto.ts @@ -12,7 +12,7 @@ import { import { UUIDScalar } from '@nestjs-yalc/graphql/scalars/uuid.scalar.js'; import returnValue from '@nestjs-yalc/utils/returnValue.js'; import { - IsIn, + IsEnum, IsObject, IsOptional, IsString, @@ -24,6 +24,7 @@ import type { Relation } from 'typeorm'; import { OmniRecordEntity } from './base/omni-record.entity.js'; import { OmniRelationEntity } from './base/omni-relation.entity.js'; import { OmniRelationType } from './omni-relation.dto.js'; +import { OmniRecordStatus } from './omni-record-status.enum.js'; @ObjectType() @ModelObject() @@ -68,9 +69,8 @@ export class OmniRecordType extends OmniRecordEntity { @ModelField({}) @Field() - @IsString() - @IsIn(['draft', 'active', 'archived']) - status!: string; + @IsEnum(OmniRecordStatus) + status!: OmniRecordStatus; @ModelField({ gqlType: returnValue(GraphQLJSONObject), diff --git a/examples/omnikernel-module/src/omni-relation-kind.enum.ts b/examples/omnikernel-module/src/omni-relation-kind.enum.ts new file mode 100644 index 00000000..e1301c1c --- /dev/null +++ b/examples/omnikernel-module/src/omni-relation-kind.enum.ts @@ -0,0 +1,6 @@ +export enum OmniRelationKind { + Contains = 'contains', + References = 'references', + RelatedTo = 'related_to', + DerivedFrom = 'derived_from', +} diff --git a/examples/omnikernel-module/src/omni-relation-status.enum.ts b/examples/omnikernel-module/src/omni-relation-status.enum.ts new file mode 100644 index 00000000..9c1596c0 --- /dev/null +++ b/examples/omnikernel-module/src/omni-relation-status.enum.ts @@ -0,0 +1,5 @@ +export enum OmniRelationStatus { + Active = 'active', + Inactive = 'inactive', + Archived = 'archived', +} diff --git a/examples/omnikernel-module/src/omni-relation.dto.ts b/examples/omnikernel-module/src/omni-relation.dto.ts index 4c753140..afd2dbf6 100644 --- a/examples/omnikernel-module/src/omni-relation.dto.ts +++ b/examples/omnikernel-module/src/omni-relation.dto.ts @@ -12,7 +12,7 @@ import { import { UUIDScalar } from '@nestjs-yalc/graphql/scalars/uuid.scalar.js'; import returnValue from '@nestjs-yalc/utils/returnValue.js'; import { - IsIn, + IsEnum, IsObject, IsOptional, IsString, @@ -24,6 +24,8 @@ import type { Relation } from 'typeorm'; import { OmniRecordEntity } from './base/omni-record.entity.js'; import { OmniRelationEntity } from './base/omni-relation.entity.js'; import { OmniRecordType } from './omni-record.dto.js'; +import { OmniRelationKind } from './omni-relation-kind.enum.js'; +import { OmniRelationStatus } from './omni-relation-status.enum.js'; @ObjectType() @ModelObject() @@ -78,15 +80,13 @@ export class OmniRelationType extends OmniRelationEntity { @ModelField({}) @Field() - @IsString() - @MaxLength(64) - kind!: string; + @IsEnum(OmniRelationKind) + kind!: OmniRelationKind; @ModelField({}) @Field() - @IsString() - @IsIn(['active', 'inactive', 'archived']) - status!: string; + @IsEnum(OmniRelationStatus) + status!: OmniRelationStatus; @ModelField({ gqlType: returnValue(GraphQLJSONObject), diff --git a/examples/omnikernel-module/src/omnikernel.module.ts b/examples/omnikernel-module/src/omnikernel.module.ts index 77ebf007..1c967677 100644 --- a/examples/omnikernel-module/src/omnikernel.module.ts +++ b/examples/omnikernel-module/src/omnikernel.module.ts @@ -5,6 +5,8 @@ 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 { OmniDocumentEntity } from './omni-document.entity.js'; +import { omniDocumentProvidersFactory } from './omni-document.resolver.js'; import { omniExternalRefProvidersFactory } from './omni-external-ref.resolver.js'; import { omniNamedProvidersFactory } from './omni-named.resolver.js'; import { omniRecordProvidersFactory } from './omni-record.resolver.js'; @@ -17,6 +19,7 @@ export class OmniKernelModule { const omniNamedProviders = omniNamedProvidersFactory(dbConnection); const omniRecordProviders = omniRecordProvidersFactory(dbConnection); const omniRelationProviders = omniRelationProvidersFactory(dbConnection); + const omniDocumentProviders = omniDocumentProvidersFactory(dbConnection); const omniExternalRefProviders = omniExternalRefProvidersFactory(dbConnection); @@ -28,6 +31,7 @@ export class OmniKernelModule { OmniNamedEntity, OmniRecordEntity, OmniRelationEntity, + OmniDocumentEntity, OmniExternalRefEntity, ], dbConnection, @@ -41,6 +45,7 @@ export class OmniKernelModule { ...omniNamedProviders.providers, ...omniRecordProviders.providers, ...omniRelationProviders.providers, + ...omniDocumentProviders.providers, ...omniExternalRefProviders.providers, ], exports: [ @@ -48,6 +53,7 @@ export class OmniKernelModule { ...omniNamedProviders.providers, ...omniRecordProviders.providers, ...omniRelationProviders.providers, + ...omniDocumentProviders.providers, ...omniExternalRefProviders.providers, ], };