1
0
silverbullet/plugos/types.ts
2023-08-20 07:24:17 +02:00

57 lines
2.0 KiB
TypeScript

import { System } from "./system.ts";
import { AssetJson } from "./asset_bundle/bundle.ts";
/** The generic top level of a plug manifest file.
* Defines plug metadata and functions.
*/
export interface Manifest<HookT> {
/** The plug's name. Typically this is the name of the manifest file, without the file extension. */
name: string;
/** A list of syscall permissions required for this plug to function.
*
* Possible values:
* - `fetch`: enables `fetch` function. (see: plug-api/plugos-syscall/fetch.ts, and plug-api/lib/fetch.ts)
* - `shell`: enables the `shell.run` syscall. (see: plug-api/plugos-syscall/shell.ts)
*/
requiredPermissions?: string[];
/** A list of files or glob patterns that should be bundled with the plug.
*
* These files will be accessible through the `asset.readAsset` function.
*
* see: plug-api/plugos-syscall/asset.ts#readAsset
*/
assets?: string[] | AssetJson;
/** A map of function names to definitions. Declared functions are public, and may be associated with various hooks
*
* see: common/manifest.ts#SilverBulletHooks
*/
functions: {
[key: string]: FunctionDef<HookT>;
};
}
/** Associates hooks with a function. This is the generic base structure, that identifies the function. Hooks are defined by the type parameter. */
export type FunctionDef<HookT> = {
/** A function path, in the form `${relativeFilename}:${functionName}`.
*
* During compilation (see `../build_plugs.ts`) the function is read from the file and inlined into the plug bundle.
*
* This field and `FunctionDef.redirect` are mutually exclusive.
*/
path?: string;
/** A function from another plug, in the form `${plugName}.${functionName}` that will be attached to the given hooks. */
redirect?: string;
/** Environments where this plug is allowed to run, current may be one of "cli", "server", or "client". */
env?: string;
} & HookT;
export interface Hook<HookT> {
validateManifest(manifest: Manifest<HookT>): string[];
apply(system: System<HookT>): void;
}