Spaces:
Runtime error
Runtime error
File size: 6,967 Bytes
cd8bd0a | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 | /**
* Plugin manifest validator β Zod schema for plugin.json files.
*
* @module plugins/manifest
*/
import { z } from "zod";
// ββ Permission enum ββ
export const PermissionSchema = z.enum(["network", "file-read", "file-write", "env", "exec"]);
export type Permission = z.infer<typeof PermissionSchema>;
// ββ Skill definition in manifest ββ
export const ManifestSkillSchema = z.object({
name: z.string().min(1).max(100),
description: z.string().max(500).optional(),
input: z.record(z.string(), z.unknown()).optional(),
output: z.record(z.string(), z.unknown()).optional(),
});
export type ManifestSkill = z.infer<typeof ManifestSkillSchema>;
// ββ Config schema field ββ
export const ConfigFieldSchema = z.object({
type: z.enum(["string", "number", "boolean", "select"]),
default: z.unknown().optional(),
min: z.number().optional(),
max: z.number().optional(),
enum: z.array(z.string()).optional(),
description: z.string().optional(),
});
export type ConfigField = z.infer<typeof ConfigFieldSchema>;
// ββ Hooks ββ
export const HooksSchema = z.object({
onRequest: z.boolean().optional(),
onResponse: z.boolean().optional(),
onError: z.boolean().optional(),
onInstall: z.boolean().optional(),
onActivate: z.boolean().optional(),
onDeactivate: z.boolean().optional(),
onUninstall: z.boolean().optional(),
});
// ββ Requires ββ
export const RequiresSchema = z.object({
omniroute: z.string().optional(),
permissions: z.array(PermissionSchema).optional(),
});
// ββ Full manifest ββ
export const PluginManifestSchema = z.object({
name: z
.string()
.min(1)
.max(100)
.regex(/^[a-z0-9-]+$/, "Name must be kebab-case (lowercase, hyphens only)"),
version: z.string().regex(/^\d+\.\d+\.\d+$/, "Version must be semver (e.g. 1.0.0)"),
description: z.string().max(500).optional(),
author: z.string().max(200).optional(),
license: z.string().optional(),
main: z.string().optional(),
source: z.enum(["local", "marketplace"]).optional(),
tags: z.array(z.string()).optional(),
requires: RequiresSchema.optional(),
hooks: HooksSchema.optional(),
skills: z.array(ManifestSkillSchema).optional(),
enabledByDefault: z.boolean().optional(),
configSchema: z.record(z.string(), ConfigFieldSchema).optional(),
/**
* OPT-IN tamper-detection: `sha256-<base64>` of the plugin's entry file.
*
* NOT a security boundary β loopback-only routing and exec opt-in are the real
* boundaries. Local-operator plugins without `integrity` are fully allowed (trust
* is implicit for locally installed code). When this field IS present, the loader
* verifies the entry file hash at load time and refuses to activate on mismatch.
*
* Format: `sha256-<base64url>` (same as SRI / W3C Subresource Integrity).
* Generate with: `node -e "const {createHash}=require('crypto'),{readFileSync}=require('fs');
* console.log('sha256-'+createHash('sha256').update(readFileSync('index.js')).digest('base64'))"`
*/
integrity: z.string().optional(),
});
export type PluginManifest = z.infer<typeof PluginManifestSchema>;
// ββ Defaults applied after parsing ββ
export interface PluginManifestWithDefaults extends PluginManifest {
license: string;
main: string;
source: "local" | "marketplace";
tags: string[];
requires: { omniroute?: string; permissions: Permission[] };
hooks: {
onRequest: boolean;
onResponse: boolean;
onError: boolean;
onInstall: boolean;
onActivate: boolean;
onDeactivate: boolean;
onUninstall: boolean;
};
skills: ManifestSkill[];
enabledByDefault: boolean;
configSchema: Record<string, ConfigField>;
}
export function applyDefaults(manifest: PluginManifest): PluginManifestWithDefaults {
return {
...manifest,
license: manifest.license ?? "MIT",
main: manifest.main ?? "index.js",
source: manifest.source ?? "local",
tags: manifest.tags ?? [],
requires: {
omniroute: manifest.requires?.omniroute,
permissions: manifest.requires?.permissions ?? [],
},
hooks: {
onRequest: manifest.hooks?.onRequest ?? false,
onResponse: manifest.hooks?.onResponse ?? false,
onError: manifest.hooks?.onError ?? false,
onInstall: manifest.hooks?.onInstall ?? false,
onActivate: manifest.hooks?.onActivate ?? false,
onDeactivate: manifest.hooks?.onDeactivate ?? false,
onUninstall: manifest.hooks?.onUninstall ?? false,
},
skills: manifest.skills ?? [],
enabledByDefault: manifest.enabledByDefault ?? false,
configSchema: manifest.configSchema ?? {},
};
}
// ββ Validation ββ
export function validateManifest(raw: unknown): PluginManifestWithDefaults {
const parsed = PluginManifestSchema.parse(raw);
return applyDefaults(parsed);
}
export function safeValidateManifest(
raw: unknown
): { success: true; data: PluginManifestWithDefaults } | { success: false; errors: string[] } {
const result = PluginManifestSchema.safeParse(raw);
if (result.success) {
return { success: true, data: applyDefaults(result.data) };
}
return {
success: false,
errors: result.error.issues.map((i) => `${i.path.join(".")}: ${i.message}`),
};
}
// ββ Config validation ββ
export type ValidatePluginConfigResult =
| { valid: true }
| { valid: false; errors: string[] };
/**
* Validate a config object against a ConfigField schema map.
* Only provided keys are validated β missing keys are fine (use defaults).
*/
export function validatePluginConfig(
config: Record<string, unknown>,
schema: Record<string, ConfigField>
): ValidatePluginConfigResult {
const errors: string[] = [];
// If schema is empty, allow anything
const hasSchema = Object.keys(schema).length > 0;
if (!hasSchema) return { valid: true };
for (const [key, value] of Object.entries(config)) {
const field = schema[key];
if (!field) {
errors.push(`Unknown config key: ${key}`);
continue;
}
switch (field.type) {
case "string":
if (typeof value !== "string") errors.push(`${key} must be a string`);
break;
case "number":
if (typeof value !== "number") {
errors.push(`${key} must be a number`);
} else {
if (field.min !== undefined && value < field.min)
errors.push(`${key} must be >= ${field.min}`);
if (field.max !== undefined && value > field.max)
errors.push(`${key} must be <= ${field.max}`);
}
break;
case "boolean":
if (typeof value !== "boolean") errors.push(`${key} must be a boolean`);
break;
case "select":
if (!field.enum || !field.enum.includes(value as string))
errors.push(`${key} must be one of: ${(field.enum ?? []).join(", ")}`);
break;
}
}
if (errors.length > 0) return { valid: false, errors };
return { valid: true };
}
|