contentful-orm/src/decorators/index.ts

A TypeScript-first ORM for Contentful CMS that enables a code-first approach to content modeling

import 'reflect-metadata';
import { ContentTypeOptions, FieldOptions, ContentfulFieldType, MediaFieldOptions, LinkFieldOptions, ArrayFieldOptions, BaseFieldOptions } from '../types/index.js';

// Decorator metadata keys
const CONTENT_TYPE_KEY = 'contentful:content-type';
const FIELD_KEY = 'contentful:field';

export function ContentType(options: ContentTypeOptions) {
  return function (target: any) {
    Reflect.defineMetadata(CONTENT_TYPE_KEY, options, target);
    return target;
  };
}

export function Field(options: FieldOptions) {
  return function (target: any, propertyKey: string | symbol) {
    const fields = Reflect.getMetadata(FIELD_KEY, target.constructor) || new Map<string, FieldOptions>();
    fields.set(propertyKey.toString(), options);
    Reflect.defineMetadata(FIELD_KEY, fields, target.constructor);
  };
}

export function MediaField(options: Omit<MediaFieldOptions, 'type' | 'linkType'>) {
  return Field({
    ...options,
    type: ContentfulFieldType.Media,
    linkType: 'Asset'
  });
}

export function ReferenceField(options: Omit<LinkFieldOptions, 'type'>) {
  return Field({
    ...options,
    type: ContentfulFieldType.Reference,
    linkType: options.linkType || 'Entry'
  });
}

export function ArrayField(options: Omit<ArrayFieldOptions, 'type'>) {
  return Field({
    ...options,
    type: ContentfulFieldType.Array
  });
}

export function SymbolField(options: Omit<BaseFieldOptions, 'type'> = {}) {
  return Field({ ...options, type: ContentfulFieldType.Symbol });
}

export function IntegerField(options: Omit<BaseFieldOptions, 'type'> = {}) {
  return Field({ ...options, type: ContentfulFieldType.Integer });
}

export function ObjectField(options: Omit<BaseFieldOptions, 'type'> = {}) {
  return Field({ ...options, type: ContentfulFieldType.Object });
}

export function getContentTypeMetadata(target: any): ContentTypeOptions | undefined {
  return Reflect.getMetadata(CONTENT_TYPE_KEY, target);
}

export function getFieldsMetadata(target: any): Map<string, FieldOptions> {
  return Reflect.getMetadata(FIELD_KEY, target) || new Map<string, FieldOptions>();
}