k1nq/TREK
1
0
Fork 0
mirror of https://github.com/mauriceboe/TREK.git synced 2026-10-22 06:56:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix(plugin-sdk): validate checks apiVersion and the manifest rules exactly as an install does

Browse Source 
The SDK accepted any number as apiVersion while the host refuses anything
but a positive integer no newer than its plugin API, a false green for an
author. The manifest patterns, sets and caps now live in the host's
protocol/manifest-rules.ts, and gen-plugin-facts writes them and
PLUGIN_API_VERSION into the SDK, so check:plugin-facts covers them. One
manifest corpus is judged by both validators in a server test (the SDK may
only be stricter, case by case), and a typecheck test holds the SDK's plugin
API types to the host child's copy, which gains rawBodyBase64.
This commit is contained in:
Maurice
2026-10-10 15:20:42 +02:00
parent 15db688586
commit 81ec7dd28d
18 changed files with 949 additions and 146 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugin-sdk/src/generated/host-facts.ts
+85
View File
@@ -1,5 +1,6 @@
// GENERATED — do not edit by hand.
// Source: server/src/nest/plugins/protocol/envelope.ts + server/src/plugin-event-sink.ts
// + server/src/nest/plugins/protocol/manifest-rules.ts
// + server/src/nest/plugins/protocol/output-contract.ts + server/src/addons.ts
// + shared/src/plugins/plugin-poi-facts.ts
// Regenerate: node --import tsx server/scripts/gen-plugin-facts.ts
@@ -1029,3 +1030,87 @@ export const PLUGIN_METHOD_RESULT: Readonly<Record<string, string>> = {
'events.emit': 'host',
'settings.get': 'host',
};
/**
* The plugin-API version this TREK implements. A manifest's `apiVersion` must be a
* positive integer no greater than this, or the install refuses it.
*/
export const PLUGIN_API_VERSION = 1 as const;
/**
* The manifest format rules TREK's install loader enforces
* (server/src/nest/plugins/protocol/manifest-rules.ts), so `trek-plugin validate`
* refuses exactly what an install refuses.
*/
export const MANIFEST_ID_RE = /^[a-z][a-z0-9-]{2,39}$/;
export const MANIFEST_RESERVED_IDS: readonly string[] = [
'registry',
'install',
'rescan',
];
export const MANIFEST_SEMVER_RE = /^\d+\.\d+\.\d+(?:-[0-9A-Za-z.-]+)?$/;
export const MANIFEST_TYPES: readonly string[] = [
'integration',
'page',
'widget',
'trip-page',
];
export const MANIFEST_ADDON_ID_RE = /^[a-z][a-z0-9_]{1,39}$/;
export const MANIFEST_HOST_RE = /^(\*\.[a-z0-9-]+(\.[a-z0-9-]+)+|[a-z0-9-]+(\.[a-z0-9-]+)*)$/i;
export const MANIFEST_WIDGET_SLOTS: readonly string[] = [
'sidebar',
'hero',
'place-detail',
'day-detail',
'reservation-detail',
];
export const MANIFEST_REPLACEABLE_TABS: readonly string[] = [
'transports',
'buchungen',
'listen',
'finanzplan',
'dateien',
'collab',
];
export const MANIFEST_TRIP_PAGE_POSITION_MAX = 50;
export const MANIFEST_ROUTE_PROFILES_MAX = 3;
export const MANIFEST_ROUTE_PROFILE_ID_RE = /^[a-z][a-z0-9-]{0,23}$/;
export const MANIFEST_CAPABILITY_NAME_RE = /^[a-zA-Z][a-zA-Z0-9._-]{0,63}$/;
export const MANIFEST_MCP_TOOLS_MAX = 8;
export const MANIFEST_TOOL_NAME_RE = /^[a-z0-9_]{1,48}$/;
export const MANIFEST_SETTING_KEY_RE = /^[a-zA-Z][a-zA-Z0-9_.-]{0,63}$/;
export const MANIFEST_RESERVED_SETTING_KEYS: readonly string[] = [
'constructor',
'prototype',
'__proto__',
];
export const MANIFEST_ACTIONS_MAX = 8;
/** Every attribute a settings-field object may carry; the host silently drops anything else. */
export const SETTING_FIELD_KEYS = [
'key',
'label',
'input_type',
'placeholder',
'hint',
'required',
'secret',
'scope',
'options',
'oauth',
'default',
] as const;
/** Events a plugin notification channel may carry. Admin-scoped and in-app-only events are excluded. */
export const CHANNEL_EVENTS: string[] = [
'trip_invite',
'booking_change',
'trip_reminder',
'todo_due',
'vacay_invite',
'collection_invite',
'photos_shared',
'collab_message',
'packing_tagged',
'plugin_notification',
];