@eventcatalog/linter
Version:
A linter for EventCatalog to validate frontmatter and resource references
381 lines • 11.9 kB
TypeScript
import { z } from 'zod';
export declare const domainSchema: z.ZodObject<{
services: z.ZodOptional<z.ZodArray<z.ZodObject<{
id: z.ZodString;
version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
}, "strip", z.ZodTypeAny, {
id: string;
version: string;
}, {
id: string;
version?: string | undefined;
}>, "many">>;
domains: z.ZodOptional<z.ZodArray<z.ZodObject<{
id: z.ZodString;
version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
}, "strip", z.ZodTypeAny, {
id: string;
version: string;
}, {
id: string;
version?: string | undefined;
}>, "many">>;
entities: z.ZodOptional<z.ZodArray<z.ZodObject<{
id: z.ZodString;
version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
}, "strip", z.ZodTypeAny, {
id: string;
version: string;
}, {
id: string;
version?: string | undefined;
}>, "many">>;
} & {
id: z.ZodString;
name: z.ZodString;
summary: z.ZodOptional<z.ZodString>;
version: z.ZodEffects<z.ZodString, string, string>;
draft: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodObject<{
title: z.ZodOptional<z.ZodString>;
message: z.ZodString;
}, "strip", z.ZodTypeAny, {
message: string;
title?: string | undefined;
}, {
message: string;
title?: string | undefined;
}>]>>;
badges: z.ZodOptional<z.ZodArray<z.ZodObject<{
content: z.ZodString;
backgroundColor: z.ZodString;
textColor: z.ZodString;
icon: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
content: string;
backgroundColor: string;
textColor: string;
icon?: string | undefined;
}, {
content: string;
backgroundColor: string;
textColor: string;
icon?: string | undefined;
}>, "many">>;
owners: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodObject<{
id: z.ZodString;
collection: z.ZodEnum<["users", "teams"]>;
}, "strip", z.ZodTypeAny, {
id: string;
collection: "users" | "teams";
}, {
id: string;
collection: "users" | "teams";
}>]>, {
id: string;
}, string | {
id: string;
collection: "users" | "teams";
}>, "many">>;
schemaPath: z.ZodOptional<z.ZodString>;
sidebar: z.ZodOptional<z.ZodObject<{
label: z.ZodOptional<z.ZodString>;
badge: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
label?: string | undefined;
badge?: string | undefined;
}, {
label?: string | undefined;
badge?: string | undefined;
}>>;
repository: z.ZodOptional<z.ZodObject<{
language: z.ZodOptional<z.ZodString>;
url: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
language?: string | undefined;
url?: string | undefined;
}, {
language?: string | undefined;
url?: string | undefined;
}>>;
specifications: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
openapiPath: z.ZodOptional<z.ZodString>;
asyncapiPath: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
openapiPath?: string | undefined;
asyncapiPath?: string | undefined;
}, {
openapiPath?: string | undefined;
asyncapiPath?: string | undefined;
}>, z.ZodArray<z.ZodObject<{
type: z.ZodEnum<["openapi", "asyncapi"]>;
path: z.ZodString;
name: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
path: string;
type: "asyncapi" | "openapi";
name?: string | undefined;
}, {
path: string;
type: "asyncapi" | "openapi";
name?: string | undefined;
}>, "many">]>>;
hidden: z.ZodOptional<z.ZodBoolean>;
resourceGroups: z.ZodOptional<z.ZodArray<z.ZodObject<{
id: z.ZodOptional<z.ZodString>;
title: z.ZodOptional<z.ZodString>;
items: z.ZodArray<z.ZodObject<{
id: z.ZodString;
version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
type: z.ZodEnum<["service", "event", "command", "query", "flow", "channel", "domain", "user", "team"]>;
}, "strip", z.ZodTypeAny, {
type: "service" | "event" | "command" | "query" | "flow" | "channel" | "domain" | "user" | "team";
id: string;
version: string;
}, {
type: "service" | "event" | "command" | "query" | "flow" | "channel" | "domain" | "user" | "team";
id: string;
version?: string | undefined;
}>, "many">;
limit: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
sidebar: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
}, "strip", z.ZodTypeAny, {
items: {
type: "service" | "event" | "command" | "query" | "flow" | "channel" | "domain" | "user" | "team";
id: string;
version: string;
}[];
limit: number;
sidebar: boolean;
id?: string | undefined;
title?: string | undefined;
}, {
items: {
type: "service" | "event" | "command" | "query" | "flow" | "channel" | "domain" | "user" | "team";
id: string;
version?: string | undefined;
}[];
id?: string | undefined;
title?: string | undefined;
limit?: number | undefined;
sidebar?: boolean | undefined;
}>, "many">>;
styles: z.ZodOptional<z.ZodObject<{
icon: z.ZodOptional<z.ZodString>;
node: z.ZodOptional<z.ZodObject<{
color: z.ZodOptional<z.ZodString>;
label: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
label?: string | undefined;
color?: string | undefined;
}, {
label?: string | undefined;
color?: string | undefined;
}>>;
}, "strip", z.ZodTypeAny, {
icon?: string | undefined;
node?: {
label?: string | undefined;
color?: string | undefined;
} | undefined;
}, {
icon?: string | undefined;
node?: {
label?: string | undefined;
color?: string | undefined;
} | undefined;
}>>;
deprecated: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
message: z.ZodOptional<z.ZodString>;
date: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodDate]>>;
}, "strip", z.ZodTypeAny, {
message?: string | undefined;
date?: string | Date | undefined;
}, {
message?: string | undefined;
date?: string | Date | undefined;
}>, z.ZodOptional<z.ZodBoolean>]>>;
visualiser: z.ZodOptional<z.ZodBoolean>;
versions: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
latestVersion: z.ZodOptional<z.ZodString>;
catalog: z.ZodOptional<z.ZodObject<{
path: z.ZodString;
filePath: z.ZodString;
astroContentFilePath: z.ZodString;
publicPath: z.ZodString;
type: z.ZodString;
}, "strip", z.ZodTypeAny, {
path: string;
type: string;
filePath: string;
astroContentFilePath: string;
publicPath: string;
}, {
path: string;
type: string;
filePath: string;
astroContentFilePath: string;
publicPath: string;
}>>;
}, "strip", z.ZodTypeAny, {
id: string;
name: string;
version: string;
sidebar?: {
label?: string | undefined;
badge?: string | undefined;
} | undefined;
summary?: string | undefined;
draft?: boolean | {
message: string;
title?: string | undefined;
} | undefined;
badges?: {
content: string;
backgroundColor: string;
textColor: string;
icon?: string | undefined;
}[] | undefined;
owners?: {
id: string;
}[] | undefined;
schemaPath?: string | undefined;
repository?: {
language?: string | undefined;
url?: string | undefined;
} | undefined;
specifications?: {
openapiPath?: string | undefined;
asyncapiPath?: string | undefined;
} | {
path: string;
type: "asyncapi" | "openapi";
name?: string | undefined;
}[] | undefined;
hidden?: boolean | undefined;
resourceGroups?: {
items: {
type: "service" | "event" | "command" | "query" | "flow" | "channel" | "domain" | "user" | "team";
id: string;
version: string;
}[];
limit: number;
sidebar: boolean;
id?: string | undefined;
title?: string | undefined;
}[] | undefined;
styles?: {
icon?: string | undefined;
node?: {
label?: string | undefined;
color?: string | undefined;
} | undefined;
} | undefined;
deprecated?: boolean | {
message?: string | undefined;
date?: string | Date | undefined;
} | undefined;
visualiser?: boolean | undefined;
versions?: string[] | undefined;
latestVersion?: string | undefined;
catalog?: {
path: string;
type: string;
filePath: string;
astroContentFilePath: string;
publicPath: string;
} | undefined;
services?: {
id: string;
version: string;
}[] | undefined;
domains?: {
id: string;
version: string;
}[] | undefined;
entities?: {
id: string;
version: string;
}[] | undefined;
}, {
id: string;
name: string;
version: string;
sidebar?: {
label?: string | undefined;
badge?: string | undefined;
} | undefined;
summary?: string | undefined;
draft?: boolean | {
message: string;
title?: string | undefined;
} | undefined;
badges?: {
content: string;
backgroundColor: string;
textColor: string;
icon?: string | undefined;
}[] | undefined;
owners?: (string | {
id: string;
collection: "users" | "teams";
})[] | undefined;
schemaPath?: string | undefined;
repository?: {
language?: string | undefined;
url?: string | undefined;
} | undefined;
specifications?: {
openapiPath?: string | undefined;
asyncapiPath?: string | undefined;
} | {
path: string;
type: "asyncapi" | "openapi";
name?: string | undefined;
}[] | undefined;
hidden?: boolean | undefined;
resourceGroups?: {
items: {
type: "service" | "event" | "command" | "query" | "flow" | "channel" | "domain" | "user" | "team";
id: string;
version?: string | undefined;
}[];
id?: string | undefined;
title?: string | undefined;
limit?: number | undefined;
sidebar?: boolean | undefined;
}[] | undefined;
styles?: {
icon?: string | undefined;
node?: {
label?: string | undefined;
color?: string | undefined;
} | undefined;
} | undefined;
deprecated?: boolean | {
message?: string | undefined;
date?: string | Date | undefined;
} | undefined;
visualiser?: boolean | undefined;
versions?: string[] | undefined;
latestVersion?: string | undefined;
catalog?: {
path: string;
type: string;
filePath: string;
astroContentFilePath: string;
publicPath: string;
} | undefined;
services?: {
id: string;
version?: string | undefined;
}[] | undefined;
domains?: {
id: string;
version?: string | undefined;
}[] | undefined;
entities?: {
id: string;
version?: string | undefined;
}[] | undefined;
}>;
//# sourceMappingURL=domain.d.ts.map