@sidecar-ai/compiler 0.1.0-alpha.0

package/dist/index.d.ts

@@ -0,0 +1,175 @@
+import { SourceFile } from 'ts-morph';
+import { JsonSchema, ToolAnnotations, ToolVisibility, ToolWidgetOptions, McpToolDescriptor, ResourceAnnotations, McpResourceDescriptor, McpResourceTemplateDescriptor, PromptArgsDefinition, McpPromptDescriptor } from '@sidecar-ai/core';
+
+/** Diagnostic severity surfaced by the CLI and future editor integrations. */
+type DiagnosticSeverity = "warning" | "error";
+/** Stable diagnostic emitted for a concrete project source location. */
+type SidecarDiagnostic = {
+    severity: DiagnosticSeverity;
+    code: string;
+    message: string;
+    filePath: string;
+    line: number;
+    column: number;
+    hint?: string;
+};
+/** Collects project-level warnings that do not block compilation by default. */
+declare function collectProjectDiagnostics(rootDir: string, input: SidecarToolManifestEntry[] | {
+    tools: SidecarToolManifestEntry[];
+    resources?: SidecarResourceManifestEntry[];
+    prompts?: SidecarPromptManifestEntry[];
+    config?: SidecarCompilerConfig;
+}): Promise<SidecarDiagnostic[]>;
+/** Formats diagnostics in a TypeScript-style shape understood by many editors. */
+declare function formatDiagnostic(diagnostic: SidecarDiagnostic): string;
+
+/** Manifest and option types shared across the Sidecar compiler modules. */
+
+/** Build target profile selected by reserved platform file suffixes. */
+type SidecarTarget = "mcp" | "chatgpt" | "claude";
+/** Platform suffix chosen for a reserved tool or widget file. */
+type SidecarSourceVariant = "shared" | "openai" | "anthropic";
+/** Tool entry emitted into `manifest.sidecar.json`. */
+type SidecarToolManifestEntry = {
+    sourceFile: string;
+    variant: SidecarSourceVariant;
+    target: SidecarTarget;
+    directory: string;
+    id: string;
+    name: string;
+    description: string;
+    inputSchema: JsonSchema;
+    outputSchema?: JsonSchema;
+    annotations?: ToolAnnotations;
+    visibility?: ToolVisibility;
+    widget?: SidecarWidgetManifestEntry;
+    descriptor: McpToolDescriptor;
+};
+/** Widget resource linked to a tool entry. */
+type SidecarWidgetManifestEntry = {
+    sourceFile: string;
+    variant: SidecarSourceVariant;
+    resourceUri: string;
+    resourceMeta?: Record<string, unknown>;
+    outputFile?: string;
+    options?: ToolWidgetOptions;
+};
+/** Static resource entry emitted into `manifest.sidecar.json`. */
+type SidecarResourceManifestEntry = {
+    sourceFile: string;
+    directory: string;
+    uri: string;
+    name: string;
+    title?: string;
+    description?: string;
+    mimeType?: string;
+    size?: number;
+    annotations?: ResourceAnnotations;
+    subscribe?: boolean;
+    descriptor: McpResourceDescriptor;
+};
+/** Static resource template entry emitted into `manifest.sidecar.json`. */
+type SidecarResourceTemplateManifestEntry = {
+    uriTemplate: string;
+    name: string;
+    title?: string;
+    description?: string;
+    mimeType?: string;
+    annotations?: ResourceAnnotations;
+    descriptor: McpResourceTemplateDescriptor;
+};
+/** Static prompt entry emitted into `manifest.sidecar.json`. */
+type SidecarPromptManifestEntry = {
+    sourceFile: string;
+    directory: string;
+    name: string;
+    title: string;
+    description?: string;
+    args?: PromptArgsDefinition;
+    descriptor: McpPromptDescriptor;
+};
+/** Serializable project config subset recorded in build manifests. */
+type SidecarCompilerConfig = {
+    resources: {
+        subscribe: boolean;
+        listChanged: boolean;
+    };
+    prompts: {
+        listChanged: boolean;
+    };
+    tools: {
+        listChanged: boolean;
+    };
+    pagination: {
+        pageSize: number;
+        hasOverride: boolean;
+    };
+};
+/** Build manifest produced for a Sidecar MCP output. */
+type SidecarManifest = {
+    version: 1;
+    target: SidecarTarget;
+    rootDir: string;
+    generatedAt: string;
+    config: SidecarCompilerConfig;
+    tools: SidecarToolManifestEntry[];
+    resources: SidecarResourceManifestEntry[];
+    resourceTemplates: SidecarResourceTemplateManifestEntry[];
+    prompts: SidecarPromptManifestEntry[];
+    diagnostics?: SidecarDiagnostic[];
+};
+/** Options accepted by `buildProject()`. */
+type BuildProjectOptions = {
+    rootDir: string;
+    outDir?: string;
+    plugins?: boolean;
+    strict?: boolean;
+    target?: SidecarTarget;
+};
+/** Project identity used by generated plugin packages. */
+type ProjectIdentity = {
+    name: string;
+    slug: string;
+    version: string;
+    description: string;
+};
+
+type AuthScopeCatalog = Record<string, {
+    id: string;
+    description: string;
+}>;
+/** Finds all Sidecar tool files under `server/` and returns manifest entries. */
+declare function analyzeProjectTools(rootDir: string, options?: {
+    target?: SidecarTarget;
+}): Promise<SidecarToolManifestEntry[]>;
+/** Analyzes one `tool.ts` source file into a compiler manifest entry. */
+declare function analyzeToolFile(sourceFile: SourceFile, rootDir: string, options?: {
+    target?: SidecarTarget;
+    variant?: SidecarSourceVariant;
+    authScopes?: AuthScopeCatalog;
+}): SidecarToolManifestEntry;
+
+/** Builds the MCP output, generated types, and optional plugin packages. */
+declare function buildProject(options: BuildProjectOptions): Promise<SidecarManifest>;
+
+/** Reads the serializable subset of `sidecar.config.ts` without executing app code. */
+declare function analyzeProjectConfig(rootDir: string): SidecarCompilerConfig;
+
+/** Compiler-specific errors include the source file path in their message. */
+
+/** Error thrown when a reserved file violates Sidecar's authoring contract. */
+declare class CompilerError extends Error {
+    constructor(sourceFile: SourceFile, message: string);
+}
+
+/** Finds all Sidecar prompt files under `prompts/`. */
+declare function analyzeProjectPrompts(rootDir: string): Promise<SidecarPromptManifestEntry[]>;
+/** Analyzes one `prompt.ts` source file into a compiler manifest entry. */
+declare function analyzePromptFile(sourceFile: SourceFile, rootDir: string): SidecarPromptManifestEntry;
+
+/** Finds all Sidecar resource files under `resources/`. */
+declare function analyzeProjectResources(rootDir: string): Promise<SidecarResourceManifestEntry[]>;
+/** Analyzes one `resource.ts` source file into a compiler manifest entry. */
+declare function analyzeResourceFile(sourceFile: SourceFile, rootDir: string): SidecarResourceManifestEntry;
+
+export { type BuildProjectOptions, CompilerError, type ProjectIdentity, type SidecarCompilerConfig, type SidecarDiagnostic, type SidecarManifest, type SidecarPromptManifestEntry, type SidecarResourceManifestEntry, type SidecarResourceTemplateManifestEntry, type SidecarSourceVariant, type SidecarTarget, type SidecarToolManifestEntry, type SidecarWidgetManifestEntry, analyzeProjectConfig, analyzeProjectPrompts, analyzeProjectResources, analyzeProjectTools, analyzePromptFile, analyzeResourceFile, analyzeToolFile, buildProject, collectProjectDiagnostics, formatDiagnostic };