domain-objects/dist/manipulation/WithMetadata.type.d.ts

A simple, convenient way to represent domain objects, leverage domain knowledge, and add runtime validation in your code base.

import type { HasMetadata } from 'type-fns';
/**
 * extracts the metadata keys from a DomainObject class, if explicitly declared
 *
 * returns the literal tuple element union if metadata is declared with `as const`,
 * otherwise returns `never` to signal that defaults should be used
 */
type ExplicitMetadataKeysOf<TDobj> = TDobj extends {
    metadata: infer M;
} ? M extends readonly string[] ? string extends M[number] ? never : M[number] : never : never;
/**
 * applies metadata key requirements on top of an instance type
 *
 * - if metadata is explicitly declared on the class (as const), requires those keys
 * - otherwise, uses the default metadata keys from HasMetadata (id, uuid, createdAt, updatedAt, effectiveAt)
 */
export type WithMetadata<TDobj, TInstance extends Record<string, any>> = [
    ExplicitMetadataKeysOf<TDobj>
] extends [never] ? HasMetadata<TInstance> : HasMetadata<TInstance, ExplicitMetadataKeysOf<TDobj> & string>;
export {};