@script-it/json-views-core 0.1.0-beta.1

package/dist/metadata.d.ts

@@ -0,0 +1,137 @@
+import { type ValuePath } from './json-path.js';
+import { type JsonViewOptionColor, type JsonViewTypeRegistry } from './type-registry.js';
+import { type InferredJsonViewMetadata } from './inference.js';
+import { type JsonViewDiagnosticHelp } from './annotation-capabilities.js';
+export type JsonViewPathRoot = '$';
+export type JsonViewPathSegment = {
+    kind: 'property';
+    key: string;
+} | {
+    kind: 'index';
+    index: number;
+} | {
+    kind: 'wildcard';
+};
+export interface JsonViewPath {
+    source: string;
+    root: JsonViewPathRoot;
+    segments: JsonViewPathSegment[];
+}
+export interface JsonViewSchemaDescriptor {
+    type: string;
+    title?: string;
+    description?: string;
+    required?: boolean;
+    minimum?: number | string | null;
+    maximum?: number | string | null;
+    defaultIncludeTime?: boolean;
+    pattern?: string;
+    options?: string[];
+    optionColors?: Record<string, JsonViewOptionColor>;
+    placeholder?: string;
+    multiline?: boolean;
+    step?: number;
+    [key: string]: unknown;
+}
+export interface CompiledJsonViewSchema {
+    declaration: string;
+    path: JsonViewPath;
+    descriptor: JsonViewSchemaDescriptor;
+    declarationIndex: number;
+    specificity: readonly [concreteSegments: number, totalSegments: number];
+    metadataPath: ValuePath;
+}
+export interface CompiledJsonViewColumn {
+    label: string;
+    path: JsonViewPath;
+    metadataPath: ValuePath;
+}
+export type JsonViewFilterOperator = 'eq' | 'neq' | 'in' | 'notIn' | 'gt' | 'gte' | 'lt' | 'lte' | 'contains' | 'notContains' | 'isEmpty' | 'isNotEmpty' | (string & {});
+export interface CompiledJsonViewFilterRule {
+    /** Present only when this operand comes from the embedded source metadata. */
+    sourceValuePath?: ValuePath;
+    path: JsonViewPath;
+    operator: JsonViewFilterOperator;
+    value?: unknown;
+    metadataPath: ValuePath;
+}
+export interface CompiledJsonViewFilter {
+    match: 'all' | 'any';
+    rules: CompiledJsonViewFilterRule[];
+}
+export interface CompiledJsonViewSort {
+    path: JsonViewPath;
+    direction: 'asc' | 'desc';
+    metadataPath: ValuePath;
+}
+export type JsonViewGroupValue = string | number | boolean | null;
+export interface CompiledJsonViewView {
+    id: string;
+    name: string;
+    path: JsonViewPath;
+    sourcePath: ValuePath;
+    value: unknown;
+    display: 'adaptive' | 'kanban' | 'html';
+    html?: string;
+    css?: string;
+    groupBy?: JsonViewPath;
+    groupOrder?: JsonViewGroupValue[];
+    orderPath?: JsonViewPath;
+    columns?: CompiledJsonViewColumn[];
+    filter?: CompiledJsonViewFilter;
+    sort: CompiledJsonViewSort[];
+    declarationIndex: number;
+    metadataPath: ValuePath;
+}
+export type JsonViewDiagnosticScope = 'metadata' | 'schema' | 'view' | 'value';
+export interface JsonViewMetadataDiagnostic {
+    scope: JsonViewDiagnosticScope;
+    code: string;
+    message: string;
+    metadataPath: ValuePath;
+    sourcePath?: ValuePath;
+    severity?: 'warning' | 'error';
+    viewId?: string;
+    declaration?: string;
+    metadataSource?: 'embedded' | 'external' | 'inferred';
+    help?: JsonViewDiagnosticHelp;
+}
+export interface CompiledJsonViewMetadata {
+    status: 'none' | 'ready' | 'invalid' | 'unsupported-version';
+    metadata?: unknown;
+    metadataSource?: 'embedded' | 'external' | 'inferred';
+    root: unknown;
+    recognized: boolean;
+    active: boolean;
+    schema: CompiledJsonViewSchema[];
+    views: CompiledJsonViewView[];
+    diagnostics: JsonViewMetadataDiagnostic[];
+    inference?: InferredJsonViewMetadata;
+}
+export declare const JSON_VIEW_PATH_MISSING: unique symbol;
+export interface ResolvedJsonViewPath {
+    value: unknown | typeof JSON_VIEW_PATH_MISSING;
+    sourcePath: ValuePath;
+}
+export interface JsonViewViewRow {
+    key: string | number;
+    value: Record<string, unknown>;
+    sourcePath: ValuePath;
+}
+export declare function parseJsonViewPath(source: string, options?: {
+    root?: JsonViewPathRoot;
+    allowWildcard?: boolean;
+}): JsonViewPath;
+export declare function resolveJsonViewPath(root: unknown, path: JsonViewPath): ResolvedJsonViewPath;
+/** Without a root, reads the compiled snapshot; supplying a root resolves the plan against it. */
+export declare function getJsonViewViewRows(view: CompiledJsonViewView, root?: unknown): JsonViewViewRow[];
+export declare function resolveJsonViewRowPath(root: unknown, row: Pick<JsonViewViewRow, 'value' | 'sourcePath'>, path: JsonViewPath): ResolvedJsonViewPath;
+export declare function matchesJsonViewPath(path: JsonViewPath, sourcePath: ValuePath): boolean;
+export declare function schemaForJsonViewPath(schema: readonly CompiledJsonViewSchema[], sourcePath: ValuePath): CompiledJsonViewSchema | undefined;
+export interface CompileJsonViewMetadataOptions {
+    /** Explicit annotations take precedence over embedded annotations and inference. */
+    metadata?: unknown;
+    /** Temporarily hides required-value diagnostics below paths for unfinished record drafts. */
+    suppressRequiredPaths?: readonly ValuePath[];
+}
+export declare function compileJsonViewMetadata(root: unknown, typeRegistry?: JsonViewTypeRegistry, options?: CompileJsonViewMetadataOptions): CompiledJsonViewMetadata;