lemon-devkit/dist/fields/common-fields.d.ts

Lemon Serverless Micro-Service Platform for local development

/**
 * `fields/common-fields.ts`
 * - shared common model field canon and drift checks.
 *
 * @author      Claire <claire@lemoncloud.io>
 * @date        2026-04-27 added common field helpers.
 * @copyright (C) lemoncloud.io 2026 - All Rights Reserved.
 */
export declare const DEFAULT_COMMON_MODEL_FIELDS: readonly string[];
export interface FormatCommonFieldsOptions {
    exclude?: readonly string[];
}
export interface CheckCommonFieldsOptions extends FormatCommonFieldsOptions {
    canon?: readonly string[];
    entryName?: string;
    runHint?: string;
}
export interface CommonFieldsCheckResult {
    ok: boolean;
    expected: string[];
    actual: string[];
    missing: string[];
    extra: string[];
}
export declare const sortCommonFields: (xs: readonly string[]) => string[];
export declare const formatCommonFields: (xs?: readonly string[], options?: FormatCommonFieldsOptions) => string;
export declare const checkCommonFields: (actual: readonly string[], options?: CheckCommonFieldsOptions) => CommonFieldsCheckResult;
export declare const assertCommonFields: (actual: readonly string[], options?: CheckCommonFieldsOptions) => void;