@serverkgg/bridge 0.0.7 → 0.0.9

package/src/wire/panel.ts

@@ -0,0 +1,295 @@
+import {
+	BRIDGE_ID_PATTERN,
+	BRIDGE_MODULE_ID_PATTERN,
+	BridgeAccess,
+	BridgeConfirm,
+	BridgeControl,
+	BridgeFormTarget,
+	BridgeIcon,
+	BridgeKind,
+	BridgeLayout,
+	type BridgeManifest,
+	type BridgePanel,
+	type BridgeSection,
+	BridgeStream,
+	type BridgeTerminalArg,
+	type BridgeTerminalCommand,
+	BridgeTerminalLevel,
+	type BridgeTerminalManifest,
+	type BridgeTerminalRuleManifest,
+	BridgeUploadMode,
+} from "@serverkgg/bridge/protocol";
+import { z } from "zod";
+import { zEnvKey } from "./zEnvKey";
+
+const PANEL_TEXT_LENGTH_LIMIT = 512;
+
+const ACTION_FIELDS_LIMIT = 5;
+
+const SECTION_ACTIONS_LIMIT = 10;
+
+const FORM_CLEARS_LIMIT = 8;
+
+const zKey = z
+	.string()
+	.min(1)
+	.max(64)
+	.regex(/^[A-Za-z][A-Za-z0-9_-]*$/);
+
+const zBridgeId = z.string().min(1).max(32).regex(BRIDGE_ID_PATTERN);
+
+export const zBridgeModuleId = z.string().min(1).max(32).regex(BRIDGE_MODULE_ID_PATTERN);
+
+export const bridgeValueSchema = z.union([
+	z.boolean(),
+	z.number(),
+	z.string().max(8192),
+	z.null(),
+]);
+
+export type BridgeValueInput = z.infer<typeof bridgeValueSchema>;
+
+export const bridgeValuesSchema = z.record(zKey, bridgeValueSchema);
+
+export type BridgeValuesInput = z.infer<typeof bridgeValuesSchema>;
+
+export const panelTextSchema = z.object({
+	ar: z.string().min(1).max(PANEL_TEXT_LENGTH_LIMIT),
+	en: z.string().min(1).max(PANEL_TEXT_LENGTH_LIMIT),
+});
+
+export const bridgeOptionSchema = z.object({
+	value: z.string().min(1).max(128),
+	label: panelTextSchema,
+	help: panelTextSchema.optional(),
+	latest: z.boolean().optional(),
+});
+
+export const bridgeVisibleWhenSchema = z
+	.object({
+		variable: zKey,
+		values: z.array(z.string().max(128)).min(1).max(16).optional(),
+		empty: z.boolean().optional(),
+	})
+	.refine((rule) => rule.empty !== undefined || rule.values !== undefined);
+
+export const bridgeOptionsRefSchema = z.object({
+	module: zBridgeModuleId,
+});
+
+export const bridgePreviewRefSchema = z.object({
+	module: zBridgeModuleId,
+});
+
+export const bridgeFieldSchema = z.object({
+	key: zKey,
+	control: z.enum(BridgeControl),
+	label: panelTextSchema,
+	help: panelTextSchema.optional(),
+	warning: panelTextSchema.optional(),
+	placeholder: z.string().max(256).optional(),
+	min: z.number().optional(),
+	max: z.number().optional(),
+	step: z.number().optional(),
+	maxLength: z.int().positive().optional(),
+	options: z
+		.union([
+			z.array(bridgeOptionSchema).max(64),
+			bridgeOptionsRefSchema,
+		])
+		.optional(),
+	visibleWhen: bridgeVisibleWhenSchema.optional(),
+});
+
+export const bridgeSectionActionSchema = z.object({
+	id: zKey,
+	label: panelTextSchema,
+	confirm: z.enum(BridgeConfirm).optional(),
+	confirmText: panelTextSchema.optional(),
+	download: z.boolean().optional(),
+	fields: z.array(bridgeFieldSchema).max(ACTION_FIELDS_LIMIT).optional(),
+});
+
+export const bridgeTabRefSchema = z.object({
+	tab: zBridgeId,
+	label: panelTextSchema,
+});
+
+export const bridgeFormClearSchema = z.object({
+	variable: zEnvKey,
+	warning: panelTextSchema,
+});
+
+export const bridgeSectionAddSchema = z.object({
+	label: panelTextSchema,
+	placeholder: z.string().max(256).optional(),
+});
+
+export const bridgeSectionUploadSchema = z.object({
+	label: panelTextSchema,
+	extensions: z.array(z.string().min(1).max(16)).min(1).max(8),
+	staging: z.string().min(1).max(128),
+	mode: z.enum(BridgeUploadMode).optional(),
+});
+
+export const bridgeActionsSectionSchema = z.object({
+	layout: z.literal(BridgeLayout.Actions),
+	id: zBridgeId,
+	title: panelTextSchema.optional(),
+	help: panelTextSchema.optional(),
+	module: zBridgeModuleId,
+	actions: z.array(bridgeSectionActionSchema).min(1).max(SECTION_ACTIONS_LIMIT),
+	visibleWhen: bridgeVisibleWhenSchema.optional(),
+	access: z.enum(BridgeAccess).optional(),
+});
+
+export const bridgeFormSectionSchema = z.object({
+	layout: z.literal(BridgeLayout.Form),
+	id: zBridgeId,
+	title: panelTextSchema.optional(),
+	target: z.enum(BridgeFormTarget),
+	module: zBridgeModuleId.optional(),
+	preview: bridgePreviewRefSchema.optional(),
+	reinstall: z.boolean().optional(),
+	restartHint: z.boolean().optional(),
+	confirm: z.enum(BridgeConfirm).optional(),
+	confirmText: panelTextSchema.optional(),
+	fields: z.array(bridgeFieldSchema).min(1).max(32),
+	clears: z.array(bridgeFormClearSchema).max(FORM_CLEARS_LIMIT).optional(),
+	visibleWhen: bridgeVisibleWhenSchema.optional(),
+	access: z.enum(BridgeAccess).optional(),
+});
+
+export const bridgeDetailSectionSchema = z.object({
+	layout: z.literal(BridgeLayout.Detail),
+	id: zBridgeId,
+	title: panelTextSchema.optional(),
+	module: zBridgeModuleId,
+	actions: z.array(bridgeSectionActionSchema).max(SECTION_ACTIONS_LIMIT).optional(),
+	reinstall: z.boolean().optional(),
+	variable: zEnvKey.optional(),
+	confirm: z.enum(BridgeConfirm).optional(),
+	confirmText: panelTextSchema.optional(),
+	related: bridgeTabRefSchema.optional(),
+	empty: panelTextSchema.optional(),
+	visibleWhen: bridgeVisibleWhenSchema.optional(),
+	access: z.enum(BridgeAccess).optional(),
+});
+
+export const bridgeColumnSchema = z.object({
+	key: zKey,
+	label: panelTextSchema,
+});
+
+export const bridgeTableSectionSchema = z.object({
+	layout: z.literal(BridgeLayout.Table),
+	id: zBridgeId,
+	title: panelTextSchema.optional(),
+	module: zBridgeModuleId,
+	restartHint: z.boolean().optional(),
+	columns: z.array(bridgeColumnSchema).min(1).max(8),
+	add: bridgeSectionAddSchema.optional(),
+	upload: bridgeSectionUploadSchema.optional(),
+	actions: z.array(bridgeSectionActionSchema).max(8).optional(),
+	empty: panelTextSchema.optional(),
+	visibleWhen: bridgeVisibleWhenSchema.optional(),
+	access: z.enum(BridgeAccess).optional(),
+});
+
+export const bridgeCardsSectionSchema = z.object({
+	layout: z.literal(BridgeLayout.Cards),
+	id: zBridgeId,
+	title: panelTextSchema.optional(),
+	module: zBridgeModuleId,
+	titleKey: zKey,
+	subtitleKey: zKey.optional(),
+	actions: z.array(bridgeSectionActionSchema).max(8).optional(),
+	empty: panelTextSchema.optional(),
+	visibleWhen: bridgeVisibleWhenSchema.optional(),
+	access: z.enum(BridgeAccess).optional(),
+});
+
+export const bridgeCatalogSectionSchema = z.object({
+	layout: z.literal(BridgeLayout.Catalog),
+	id: zBridgeId,
+	title: panelTextSchema.optional(),
+	module: zBridgeModuleId,
+	restartHint: z.boolean().optional(),
+	reinstall: z.boolean().optional(),
+	variable: zEnvKey.optional(),
+	confirm: z.enum(BridgeConfirm).optional(),
+	confirmText: panelTextSchema.optional(),
+	empty: panelTextSchema.optional(),
+	visibleWhen: bridgeVisibleWhenSchema.optional(),
+	access: z.enum(BridgeAccess).optional(),
+});
+
+export const bridgeSectionSchema: z.ZodType<BridgeSection> = z.discriminatedUnion("layout", [
+	bridgeActionsSectionSchema,
+	bridgeCardsSectionSchema,
+	bridgeCatalogSectionSchema,
+	bridgeDetailSectionSchema,
+	bridgeFormSectionSchema,
+	bridgeTableSectionSchema,
+]);
+
+export const bridgeTabSchema = z.object({
+	id: zBridgeId,
+	title: panelTextSchema,
+	icon: z.enum(BridgeIcon).optional(),
+	sections: z.array(bridgeSectionSchema).min(1).max(8),
+	access: z.enum(BridgeAccess).optional(),
+});
+
+export const bridgePanelSchema: z.ZodType<BridgePanel> = z.object({
+	tabs: z.array(bridgeTabSchema).min(1).max(8),
+});
+
+export const bridgeTerminalArgSchema: z.ZodType<BridgeTerminalArg> = z.object({
+	key: zKey,
+	label: panelTextSchema.optional(),
+	required: z.boolean().optional(),
+	variadic: z.boolean().optional(),
+	values: z.array(z.string().min(1).max(64)).max(64).optional(),
+	module: zBridgeModuleId.optional(),
+	column: zKey.optional(),
+});
+
+export const bridgeTerminalCommandSchema: z.ZodType<BridgeTerminalCommand> = z.object({
+	name: z.string().min(1).max(64),
+	summary: panelTextSchema,
+	syntax: z.string().max(160).optional(),
+	args: z.array(bridgeTerminalArgSchema).max(8).optional(),
+	danger: z.boolean().optional(),
+	requiresRunning: z.boolean().optional(),
+});
+
+export const bridgeTerminalRuleSchema: z.ZodType<BridgeTerminalRuleManifest> = z.object({
+	match: z.string().min(1).max(512),
+	flags: z.string().max(8),
+	level: z.enum(BridgeTerminalLevel),
+	stream: z.enum(BridgeStream).optional(),
+});
+
+export const bridgeTerminalManifestSchema: z.ZodType<BridgeTerminalManifest> = z.object({
+	commands: z.array(bridgeTerminalCommandSchema).max(128),
+	rules: z.array(bridgeTerminalRuleSchema).max(64),
+});
+
+export const bridgeModuleManifestSchema = z.object({
+	id: zBridgeModuleId,
+	kind: z.enum(BridgeKind),
+	requiresRunning: z.boolean(),
+	refreshSeconds: z.int().positive().nullable(),
+	pageSize: z.int().positive().nullable().default(null),
+	dependsOn: z.array(zKey).max(8),
+	actions: z.array(z.string().min(1).max(64)).max(16),
+});
+
+export const bridgeManifestSchema: z.ZodType<BridgeManifest> = z.object({
+	version: z.string(),
+	panel: bridgePanelSchema.nullable(),
+	terminal: bridgeTerminalManifestSchema.nullable().default(null),
+	modules: z.array(bridgeModuleManifestSchema).max(32),
+	events: z.array(z.string().min(1).max(64)).max(32),
+});

package/src/wire/zEnvKey.ts

@@ -0,0 +1,7 @@
+import { z } from "zod";
+
+export const zEnvKey = z
+	.string()
+	.min(2)
+	.max(32)
+	.regex(/^[A-Z][A-Z0-9_]*$/);