@axintai/compiler 0.2.1 → 0.3.0

package/dist/core/index.d.ts

@@ -1,3 +1,5 @@
+export { EntityDefinition, EntityDisplay, IntentDefinition, ParamConfig, defineEntity, defineIntent, param } from '../sdk/index.js';
+
 /**
  * Axint Core Types
  *
@@ -20,6 +22,14 @@ type IRType = {
     kind: "entity";
     entityName: string;
     properties: IRParameter[];
+} | {
+    kind: "entityQuery";
+    entityName: string;
+    queryType: "all" | "id" | "string" | "property";
+} | {
+    kind: "dynamicOptions";
+    valueType: IRType;
+    providerName: string;
 } | {
     kind: "enum";
     name: string;
@@ -34,6 +44,25 @@ interface IRParameter {
     isOptional: boolean;
     defaultValue?: unknown;
 }
+/**
+ * Display representation configuration for an entity.
+ * Maps which properties to show in Siri and Shortcuts UI.
+ */
+interface DisplayRepresentation {
+    title: string;
+    subtitle?: string;
+    image?: string;
+}
+/**
+ * An App Entity definition for complex, domain-specific data types.
+ * Entities can be queried and used as parameter types in intents.
+ */
+interface IREntity {
+    name: string;
+    displayRepresentation: DisplayRepresentation;
+    properties: IRParameter[];
+    queryType: "all" | "id" | "string" | "property";
+}
 /** The main IR node representing a compiled intent */
 interface IRIntent {
     name: string;
@@ -50,6 +79,12 @@ interface IRIntent {
     infoPlistKeys?: Record<string, string>;
     /** Whether the intent should be exposed to Spotlight indexing */
     isDiscoverable?: boolean;
+    /** App Entities used by this intent */
+    entities?: IREntity[];
+    /** Whether to donate this intent to Spotlight/Siri when performed */
+    donateOnPerform?: boolean;
+    /** Custom result type (SwiftUI view or custom struct) to return */
+    customResultType?: string;
 }
 interface CompilerOptions {
     /** Output directory for generated Swift files */
@@ -133,6 +168,25 @@ declare function compileFile(filePath: string, options?: Partial<CompilerOptions
  * Useful for MCP server and testing.
  */
 declare function compileSource(source: string, fileName?: string, options?: Partial<CompilerOptions>): CompileResult;
+/**
+ * Compile from a pre-built IR (skips parsing). This is the bridge
+ * that allows any frontend language (Python, Rust, Go) to emit an
+ * IRIntent JSON and feed it directly into the Swift generator.
+ *
+ * Used by:
+ *   - `compileSource()` after its own parse step
+ *   - `axint compile --from-ir <file.json>` for cross-language pipelines
+ *   - The Python SDK's `axintai compile` command
+ */
+declare function compileFromIR(ir: IRIntent, options?: Partial<CompilerOptions>): CompileResult;
+/**
+ * Parse a raw JSON object into a typed IRIntent. Accepts the flat
+ * format that the Python SDK's `IntentIR.to_dict()` produces, where
+ * parameter types are plain strings rather than `{ kind, value }` objects.
+ *
+ * This is the key function that bridges the Python → TypeScript gap.
+ */
+declare function irFromJSON(data: Record<string, unknown>): IRIntent;
 
 /**
  * Axint Parser
@@ -150,8 +204,8 @@ declare function compileSource(source: string, fileName?: string, options?: Part
  */
 
 /**
- * Parse a TypeScript source file containing a defineIntent() call
- * and return the IR representation.
+ * Parse a TypeScript source file containing defineIntent() and/or
+ * defineEntity() calls and return the IR representation.
  */
 declare function parseIntentSource(source: string, filePath?: string): IRIntent;
 declare class ParserError extends Error {
@@ -191,8 +245,17 @@ declare function escapeSwiftString(s: string): string;
 declare function escapeXml(s: string): string;
 /**
  * Generate a Swift App Intent source file from an IR intent.
+ * If entities are present, they are generated first, followed by the intent.
  */
 declare function generateSwift(intent: IRIntent): string;
+/**
+ * Generate an AppEntity struct from an IREntity definition.
+ */
+declare function generateEntity(entity: IREntity): string;
+/**
+ * Generate an EntityQuery conformance struct based on the entity's query type.
+ */
+declare function generateEntityQuery(entity: IREntity): string;
 /**
  * Generate an Info.plist XML fragment from the intent's declared keys.
  * Returns `undefined` if the intent declares no Info.plist keys.
@@ -225,9 +288,68 @@ declare function generateEntitlementsFragment(intent: IRIntent): string | undefi
  * Validate an IR intent for App Intents framework compliance.
  */
 declare function validateIntent(intent: IRIntent): Diagnostic[];
+/**
+ * Validate an IREntity for App Intents framework compliance.
+ */
+declare function validateEntity(entity: IREntity, sourceFile: string): Diagnostic[];
 /**
  * Validate generated Swift source code for basic correctness.
  */
 declare function validateSwiftSource(swift: string): Diagnostic[];
 
-export { type CompilerOptions, type CompilerOutput, type Diagnostic, type DiagnosticSeverity, type IRIntent, type IRParameter, type IRPrimitiveType, type IRType, LEGACY_PARAM_ALIASES, PARAM_TYPES, ParserError, SWIFT_TYPE_MAP, compileFile, compileSource, escapeSwiftString, escapeXml, generateEntitlementsFragment, generateInfoPlistFragment, generateSwift, irTypeToSwift, parseIntentSource, validateIntent, validateSwiftSource };
+/**
+ * Axint Eject Module
+ *
+ * Generates standalone Swift code that has no dependency on Axint.
+ * This is useful for teams that want to verify there's no vendor lock-in
+ * or for distributing intents without the compilation layer.
+ *
+ * The eject process:
+ * 1. Compiles the TypeScript intent using the standard pipeline
+ * 2. Transforms the output to remove Axint markers
+ * 3. Optionally generates XCTest stubs
+ * 4. Emits all files (Swift, plist, entitlements, test)
+ */
+interface EjectOptions {
+    /** Output directory for ejected files (defaults to ".") */
+    outDir?: string;
+    /** Generate a basic XCTest file for the intent */
+    includeTests?: boolean;
+    /** Format output with swift-format (requires swift-format on PATH) */
+    format?: boolean;
+}
+interface EjectResult {
+    /** The primary Swift file */
+    swiftFile: {
+        path: string;
+        content: string;
+    };
+    /** Optional Info.plist fragment */
+    infoPlist?: {
+        path: string;
+        content: string;
+    };
+    /** Optional entitlements fragment */
+    entitlements?: {
+        path: string;
+        content: string;
+    };
+    /** Optional XCTest file */
+    testFile?: {
+        path: string;
+        content: string;
+    };
+}
+/**
+ * Eject an intent from Axint, producing standalone Swift code with no
+ * vendor lock-in. The resulting Swift code is production-ready and can
+ * be committed directly to version control.
+ *
+ * @param source The TypeScript intent source
+ * @param fileName Display name for diagnostics (e.g., "intent.ts")
+ * @param options Eject options (outDir, includeTests, format)
+ * @returns Ejected files
+ */
+declare function ejectIntent(source: string, fileName: string, options?: EjectOptions): EjectResult;
+
+export { type CompilerOptions, type CompilerOutput, type Diagnostic, type DiagnosticSeverity, type DisplayRepresentation, type EjectOptions, type EjectResult, type IREntity, type IRIntent, type IRParameter, type IRPrimitiveType, type IRType, LEGACY_PARAM_ALIASES, PARAM_TYPES, ParserError, SWIFT_TYPE_MAP, compileFile, compileFromIR, compileSource, ejectIntent, escapeSwiftString, escapeXml, generateEntitlementsFragment, generateEntity, generateEntityQuery, generateInfoPlistFragment, generateSwift, irFromJSON, irTypeToSwift, parseIntentSource, validateEntity, validateIntent, validateSwiftSource };