altair-graphql-core
Version:
Several of the core logic for altair graphql client
100 lines • 3.66 kB
TypeScript
import { z } from 'zod/v4';
/**
* Defines the repository of the plugin.
* Used to know where to get the plugin from.
*/
export declare const pluginSourceSchema: z.ZodEnum<{
readonly NPM: "npm";
readonly GITHUB: "github";
readonly URL: "url";
}>;
/**
* Specifies the type of the plugin.
* Determines how the plugin would interact with Altair.
*/
export declare const pluginTypeSchema: z.ZodEnum<{
readonly HEADER: "header";
readonly SIDEBAR: "sidebar";
readonly ACTION_BUTTON: "action_button";
}>;
/**
* Specifies the capabilities (functionalities) available to the plugin.
* In the future, this would be used to request the necessary permissions from the user.
*/
export declare const pluginCapabilitiesSchema: z.ZodEnum<{
"query:read": "query:read";
"query:write": "query:write";
"header:read": "header:read";
"header:write": "header:write";
"environment:read": "environment:read";
"environment:write": "environment:write";
}>;
export declare const pluginManifestSchema: z.ZodObject<{
manifest_version: z.ZodUnion<[z.ZodLiteral<1>, z.ZodLiteral<2>]>;
name: z.ZodString;
display_name: z.ZodString;
version: z.ZodString;
description: z.ZodString;
author_email: z.ZodOptional<z.ZodString>;
author: z.ZodOptional<z.ZodString>;
type: z.ZodOptional<z.ZodEnum<{
readonly HEADER: "header";
readonly SIDEBAR: "sidebar";
readonly ACTION_BUTTON: "action_button";
}>>;
plugin_class: z.ZodOptional<z.ZodString>;
scripts: z.ZodArray<z.ZodString>;
styles: z.ZodOptional<z.ZodArray<z.ZodString>>;
capabilities: z.ZodOptional<z.ZodArray<z.ZodEnum<{
"query:read": "query:read";
"query:write": "query:write";
"header:read": "header:read";
"header:write": "header:write";
"environment:read": "environment:read";
"environment:write": "environment:write";
}>>>;
}, z.core.$strip>;
export declare const altairV1PluginSchema: z.ZodObject<{
name: z.ZodString;
display_name: z.ZodString;
capabilities: z.ZodArray<z.ZodEnum<{
"query:read": "query:read";
"query:write": "query:write";
"header:read": "header:read";
"header:write": "header:write";
"environment:read": "environment:read";
"environment:write": "environment:write";
}>>;
type: z.ZodOptional<z.ZodEnum<{
readonly HEADER: "header";
readonly SIDEBAR: "sidebar";
readonly ACTION_BUTTON: "action_button";
}>>;
plugin_class: z.ZodOptional<z.ZodString>;
manifest: z.ZodObject<{
manifest_version: z.ZodUnion<[z.ZodLiteral<1>, z.ZodLiteral<2>]>;
name: z.ZodString;
display_name: z.ZodString;
version: z.ZodString;
description: z.ZodString;
author_email: z.ZodOptional<z.ZodString>;
author: z.ZodOptional<z.ZodString>;
type: z.ZodOptional<z.ZodEnum<{
readonly HEADER: "header";
readonly SIDEBAR: "sidebar";
readonly ACTION_BUTTON: "action_button";
}>>;
plugin_class: z.ZodOptional<z.ZodString>;
scripts: z.ZodArray<z.ZodString>;
styles: z.ZodOptional<z.ZodArray<z.ZodString>>;
capabilities: z.ZodOptional<z.ZodArray<z.ZodEnum<{
"query:read": "query:read";
"query:write": "query:write";
"header:read": "header:read";
"header:write": "header:write";
"environment:read": "environment:read";
"environment:write": "environment:write";
}>>>;
}, z.core.$strip>;
}, z.core.$strip>;
//# sourceMappingURL=plugin.schema.d.ts.map