Merge pull request #120 from rudrankriyam/stack/110-foundationlabcore

Create FoundationLabCore and define the first shared boundary

Author: rudrankriyam

FoundationLab.xcodeproj/project.pbxproj

@@ -10,6 +10,7 @@
 		0A21D7F12E518858004E8806 /* LiquidGlasKit in Frameworks */ = {isa = PBXBuildFile; productRef = 0A21D7F02E518858004E8806 /* LiquidGlasKit */; };
 		0A5454AB2E1148A8002C2152 /* Foundation Lab.icon in Resources */ = {isa = PBXBuildFile; fileRef = 0A5454A72E1148A8002C2152 /* Foundation Lab.icon */; };
 		0A979E842E1E5921008CFA37 /* FoundationModelsTools in Frameworks */ = {isa = PBXBuildFile; productRef = 0A979E832E1E5921008CFA37 /* FoundationModelsTools */; };
+		0B0A11132ECB100100000001 /* FoundationLabCore in Frameworks */ = {isa = PBXBuildFile; productRef = 0B0A11122ECB100100000001 /* FoundationLabCore */; };
 		F1B8C56E2E5B5A1C00XYZ123 /* LumoKit in Frameworks */ = {isa = PBXBuildFile; productRef = F1B8C56D2E5B5A1C00XYZ123 /* LumoKit */; };
 		FA43F9412E13A16E00F24BCC /* HighlightSwift in Frameworks */ = {isa = PBXBuildFile; productRef = FA43F9402E13A16E00F24BCC /* HighlightSwift */; };
 /* End PBXBuildFile section */
@@ -55,6 +56,7 @@
 				FA43F9412E13A16E00F24BCC /* HighlightSwift in Frameworks */,
 				0A979E842E1E5921008CFA37 /* FoundationModelsTools in Frameworks */,
 				0A21D7F12E518858004E8806 /* LiquidGlasKit in Frameworks */,
+				0B0A11132ECB100100000001 /* FoundationLabCore in Frameworks */,
 				F1B8C56E2E5B5A1C00XYZ123 /* LumoKit in Frameworks */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
@@ -119,6 +121,7 @@
 				FA43F9402E13A16E00F24BCC /* HighlightSwift */,
 				0A979E832E1E5921008CFA37 /* FoundationModelsTools */,
 				0A21D7F02E518858004E8806 /* LiquidGlasKit */,
+				0B0A11122ECB100100000001 /* FoundationLabCore */,
 				F1B8C56D2E5B5A1C00XYZ123 /* LumoKit */,
 			);
 			productName = FoundationLab;
@@ -153,6 +156,7 @@
 				0AC6037E2E1D5288002106F9 /* XCRemoteSwiftPackageReference "HighlightSwift" */,
 				0A979E822E1E5921008CFA37 /* XCRemoteSwiftPackageReference "FoundationModelsTools" */,
 				0A21D7EF2E518858004E8806 /* XCRemoteSwiftPackageReference "LiquidGlasKit" */,
+				0B0A11112ECB100100000001 /* XCLocalSwiftPackageReference "FoundationLabCore" */,
 				F1B8C56C2E5B5A1C00XYZ123 /* XCRemoteSwiftPackageReference "LumoKit" */,
 			);
 			preferredProjectObjectVersion = 77;
@@ -501,6 +505,13 @@
 		};
 /* End XCConfigurationList section */
 
+/* Begin XCLocalSwiftPackageReference section */
+		0B0A11112ECB100100000001 /* XCLocalSwiftPackageReference "FoundationLabCore" */ = {
+			isa = XCLocalSwiftPackageReference;
+			relativePath = FoundationLabCore;
+		};
+/* End XCLocalSwiftPackageReference section */
+
 /* Begin XCRemoteSwiftPackageReference section */
 		0A21D7EF2E518858004E8806 /* XCRemoteSwiftPackageReference "LiquidGlasKit" */ = {
 			isa = XCRemoteSwiftPackageReference;
@@ -555,6 +566,11 @@
 			package = 0A979E822E1E5921008CFA37 /* XCRemoteSwiftPackageReference "FoundationModelsTools" */;
 			productName = FoundationModelsTools;
 		};
+		0B0A11122ECB100100000001 /* FoundationLabCore */ = {
+			isa = XCSwiftPackageProductDependency;
+			package = 0B0A11112ECB100100000001 /* XCLocalSwiftPackageReference "FoundationLabCore" */;
+			productName = FoundationLabCore;
+		};
 		F1B8C56D2E5B5A1C00XYZ123 /* LumoKit */ = {
 			isa = XCSwiftPackageProductDependency;
 			package = F1B8C56C2E5B5A1C00XYZ123 /* XCRemoteSwiftPackageReference "LumoKit" */;

FoundationLabCore/Package.swift

@@ -0,0 +1,27 @@
+// swift-tools-version: 6.2
+
+import PackageDescription
+
+let package = Package(
+    name: "FoundationLabCore",
+    platforms: [
+        .iOS(.v26),
+        .macOS(.v26),
+        .visionOS(.v26)
+    ],
+    products: [
+        .library(
+            name: "FoundationLabCore",
+            targets: ["FoundationLabCore"]
+        )
+    ],
+    targets: [
+        .target(
+            name: "FoundationLabCore"
+        ),
+        .testTarget(
+            name: "FoundationLabCoreTests",
+            dependencies: ["FoundationLabCore"]
+        )
+    ]
+)

FoundationLabCore/README.md

@@ -0,0 +1,29 @@
+# FoundationLabCore
+
+`FoundationLabCore` is the first shared package for Foundation Lab.
+
+Its job is narrow:
+
+- define task-oriented capability boundaries
+- own shared request and result models
+- own domain-level errors
+- define provider protocols for concrete adapters
+
+Its job is not to own delivery layers or UI concerns.
+
+## Dependency rules
+
+- `FoundationLabCore` must not import `SwiftUI`, `AppIntents`, or `ArgumentParser`.
+- `FoundationLabCore` must not own navigation, tabs, routes, or screen-local state.
+- App targets, App Intents adapters, and CLI adapters may depend on `FoundationLabCore`.
+- Concrete integrations with Apple frameworks or third-party SDKs belong in adapter packages, not here.
+
+## Initial conventions
+
+- `Capabilities/` contains task-oriented use case protocols and descriptors.
+- `Requests/` contains shared request models for core flows.
+- `Results/` contains shared result models and execution metadata.
+- `Errors/` contains domain-level errors surfaced by capabilities and providers.
+- `Providers/` contains abstraction seams that later packages implement.
+
+This package is intentionally small. It creates the seam for later extraction work without moving major user-facing features yet.

FoundationLabCore/Sources/FoundationLabCore/Capabilities/Capability.swift

@@ -0,0 +1,27 @@
+import Foundation
+
+public protocol CapabilityRequest: Sendable {}
+
+public protocol CapabilityResult: Sendable {}
+
+public struct CapabilityDescriptor: Sendable, Hashable {
+    public let id: String
+    public let displayName: String
+    public let summary: String
+
+    public init(id: String, displayName: String, summary: String) {
+        self.id = id
+        self.displayName = displayName
+        self.summary = summary
+    }
+}
+
+/// A task-oriented use case that can be shared by the app, App Intents, and CLI adapters.
+public protocol CapabilityUseCase: Sendable {
+    associatedtype Request: CapabilityRequest
+    associatedtype Result: CapabilityResult
+
+    static var descriptor: CapabilityDescriptor { get }
+
+    func execute(_ request: Request) async throws -> Result
+}

FoundationLabCore/Sources/FoundationLabCore/Errors/FoundationLabCoreError.swift

@@ -0,0 +1,21 @@
+import Foundation
+
+public enum FoundationLabCoreError: LocalizedError, Sendable, Equatable {
+    case invalidRequest(String)
+    case unavailableCapability(String)
+    case providerFailure(String)
+    case unsupportedEnvironment(String)
+
+    public var errorDescription: String? {
+        switch self {
+        case .invalidRequest(let message):
+            return "Invalid request: \(message)"
+        case .unavailableCapability(let message):
+            return "Unavailable capability: \(message)"
+        case .providerFailure(let message):
+            return "Provider failure: \(message)"
+        case .unsupportedEnvironment(let message):
+            return "Unsupported environment: \(message)"
+        }
+    }
+}

FoundationLabCore/Sources/FoundationLabCore/Providers/StructuredGenerationProviding.swift

@@ -0,0 +1,8 @@
+import Foundation
+
+public protocol StructuredGenerationProviding: Sendable {
+    func generate<Output: Decodable & Sendable>(
+        _ type: Output.Type,
+        for request: StructuredGenerationRequest<Output>
+    ) async throws -> StructuredGenerationResult<Output>
+}

FoundationLabCore/Sources/FoundationLabCore/Providers/TextGenerationProviding.swift

@@ -0,0 +1,5 @@
+import Foundation
+
+public protocol TextGenerationProviding: Sendable {
+    func generateText(for request: TextGenerationRequest) async throws -> TextGenerationResult
+}

FoundationLabCore/Sources/FoundationLabCore/Requests/CapabilityInvocationContext.swift

@@ -0,0 +1,25 @@
+import Foundation
+
+public enum InvocationSource: String, Sendable, Hashable, Codable {
+    case app
+    case appIntent
+    case cli
+    case automation
+    case unknown
+}
+
+public struct CapabilityInvocationContext: Sendable, Hashable, Codable {
+    public let source: InvocationSource
+    public let localeIdentifier: String?
+    public let correlationID: UUID
+
+    public init(
+        source: InvocationSource,
+        localeIdentifier: String? = nil,
+        correlationID: UUID = UUID()
+    ) {
+        self.source = source
+        self.localeIdentifier = localeIdentifier
+        self.correlationID = correlationID
+    }
+}

FoundationLabCore/Sources/FoundationLabCore/Requests/StructuredGenerationRequest.swift

@@ -0,0 +1,17 @@
+import Foundation
+
+public struct StructuredGenerationRequest<Output: Decodable & Sendable>: CapabilityRequest, Sendable {
+    public let prompt: String
+    public let systemPrompt: String?
+    public let context: CapabilityInvocationContext
+
+    public init(
+        prompt: String,
+        systemPrompt: String? = nil,
+        context: CapabilityInvocationContext
+    ) {
+        self.prompt = prompt
+        self.systemPrompt = systemPrompt
+        self.context = context
+    }
+}

FoundationLabCore/Sources/FoundationLabCore/Requests/TextGenerationRequest.swift

@@ -0,0 +1,17 @@
+import Foundation
+
+public struct TextGenerationRequest: CapabilityRequest, Sendable, Hashable {
+    public let prompt: String
+    public let systemPrompt: String?
+    public let context: CapabilityInvocationContext
+
+    public init(
+        prompt: String,
+        systemPrompt: String? = nil,
+        context: CapabilityInvocationContext
+    ) {
+        self.prompt = prompt
+        self.systemPrompt = systemPrompt
+        self.context = context
+    }
+}