@tiangong-ai/cli 0.0.22 → 0.0.24

package/dist/research/workspace/external-skills.d.ts

@@ -0,0 +1,477 @@
+import type { CapabilityDeclarations, CapabilitySourceDeclaration } from "./types.js";
+export declare const EXTERNAL_SKILLS_CLI_VERSION = "1.5.22";
+export declare const EXTERNAL_SKILL_PROFILE = "internet-research";
+export declare const EXTERNAL_SKILL_CONTEXT_PROFILE = "internet-research-with-context";
+export declare const EXTERNAL_SKILL_MEDIA_PROFILE = "internet-research-with-media";
+export declare function inspectExternalSkillCatalog(input: {
+    selectedPath: string;
+    workspace?: string | null;
+    skillRoot?: string | null;
+}): Promise<{
+    schemaVersion: 1;
+    catalog: string;
+    policy: {
+        implementations: string;
+        runtimeInstall: boolean;
+        projectLocalCopyRecommended: boolean;
+    };
+    installer: {
+        package: string;
+        version: string;
+        source: {
+            locator: "https://github.com/brave/brave-search-skills.git";
+            immutableRef: "3e088af66eb61f1c207c22b2be0278ca8744d1d1";
+        };
+        projectPlan: {
+            shell: string;
+            workingDirectory: string;
+            checkoutDirectory: string;
+            precondition: string;
+            automaticAtRuntime: boolean;
+            commands: string[];
+            verification: {
+                repository: "brave/brave-search-skills";
+                immutableRef: "3e088af66eb61f1c207c22b2be0278ca8744d1d1";
+                expectedTrees: {
+                    skillName: string;
+                    sha256: string;
+                }[];
+            };
+        };
+        globalPlan: {
+            shell: string;
+            workingDirectory: string;
+            checkoutDirectory: string;
+            precondition: string;
+            automaticAtRuntime: boolean;
+            commands: string[];
+            verification: {
+                repository: "brave/brave-search-skills";
+                immutableRef: "3e088af66eb61f1c207c22b2be0278ca8744d1d1";
+                expectedTrees: {
+                    skillName: string;
+                    sha256: string;
+                }[];
+            };
+        };
+        allRecommendedProjectPlan: {
+            shell: string;
+            workingDirectory: string;
+            checkoutDirectory: string;
+            precondition: string;
+            automaticAtRuntime: boolean;
+            commands: string[];
+            verification: {
+                repository: "brave/brave-search-skills";
+                immutableRef: "3e088af66eb61f1c207c22b2be0278ca8744d1d1";
+                expectedTrees: {
+                    skillName: string;
+                    sha256: string;
+                }[];
+            };
+        };
+        allRecommendedGlobalPlan: {
+            shell: string;
+            workingDirectory: string;
+            checkoutDirectory: string;
+            precondition: string;
+            automaticAtRuntime: boolean;
+            commands: string[];
+            verification: {
+                repository: "brave/brave-search-skills";
+                immutableRef: "3e088af66eb61f1c207c22b2be0278ca8744d1d1";
+                expectedTrees: {
+                    skillName: string;
+                    sha256: string;
+                }[];
+            };
+        };
+    };
+    profiles: {
+        id: string;
+        description: string;
+        skillIds: string[];
+    }[];
+    conditionalSkillIds: string[];
+    enhancedSkillIds: string[];
+    entries: {
+        id: string;
+        capabilityId: string;
+        skillName: string;
+        tier: "required" | "enhanced" | "conditional";
+        purpose: string;
+        source: {
+            repository: "brave/brave-search-skills";
+            locator: "https://github.com/brave/brave-search-skills.git";
+            immutableRef: "3e088af66eb61f1c207c22b2be0278ca8744d1d1";
+            license: "MIT";
+            expectedTreeSha256: string;
+        };
+        install: {
+            projectPlan: {
+                shell: string;
+                workingDirectory: string;
+                checkoutDirectory: string;
+                precondition: string;
+                automaticAtRuntime: boolean;
+                commands: string[];
+                verification: {
+                    repository: "brave/brave-search-skills";
+                    immutableRef: "3e088af66eb61f1c207c22b2be0278ca8744d1d1";
+                    expectedTrees: {
+                        skillName: string;
+                        sha256: string;
+                    }[];
+                };
+            };
+            globalPlan: {
+                shell: string;
+                workingDirectory: string;
+                checkoutDirectory: string;
+                precondition: string;
+                automaticAtRuntime: boolean;
+                commands: string[];
+                verification: {
+                    repository: "brave/brave-search-skills";
+                    immutableRef: "3e088af66eb61f1c207c22b2be0278ca8744d1d1";
+                    expectedTrees: {
+                        skillName: string;
+                        sha256: string;
+                    }[];
+                };
+            };
+            automaticAtRuntime: boolean;
+        };
+        configuration: {
+            allowedHosts: string[];
+            credentialIds: string[];
+            discoveryScopes: string[];
+            requiredForDiscovery: boolean;
+            providerPlan: string;
+        };
+        installation: {
+            status: "missing" | "installed" | "drifted" | "ambiguous";
+            paths: string[];
+            observedTreeSha256: string[];
+            errors: string[];
+        };
+        status: {
+            configured: boolean;
+            locked: boolean;
+            credential: string;
+        };
+    }[];
+    evaluatedAlternatives: {
+        skillName: string;
+        recommended: false;
+        disposition: "custom-admission" | "not-evidence-source" | "unsupported-execution";
+        reason: string;
+        source: {
+            repository: "brave/brave-search-skills";
+            locator: "https://github.com/brave/brave-search-skills.git";
+            immutableRef: "3e088af66eb61f1c207c22b2be0278ca8744d1d1";
+            license: "MIT";
+            expectedTreeSha256: string;
+        };
+        install: {
+            projectPlan: {
+                shell: string;
+                workingDirectory: string;
+                checkoutDirectory: string;
+                precondition: string;
+                automaticAtRuntime: boolean;
+                commands: string[];
+                verification: {
+                    repository: "brave/brave-search-skills";
+                    immutableRef: "3e088af66eb61f1c207c22b2be0278ca8744d1d1";
+                    expectedTrees: {
+                        skillName: string;
+                        sha256: string;
+                    }[];
+                };
+            };
+            globalPlan: {
+                shell: string;
+                workingDirectory: string;
+                checkoutDirectory: string;
+                precondition: string;
+                automaticAtRuntime: boolean;
+                commands: string[];
+                verification: {
+                    repository: "brave/brave-search-skills";
+                    immutableRef: "3e088af66eb61f1c207c22b2be0278ca8744d1d1";
+                    expectedTrees: {
+                        skillName: string;
+                        sha256: string;
+                    }[];
+                };
+            };
+            automaticAtRuntime: boolean;
+        };
+        installation: {
+            status: "missing" | "installed" | "drifted" | "ambiguous";
+            paths: string[];
+            observedTreeSha256: string[];
+            errors: string[];
+        };
+        configuration: {
+            status: "requires-explicit-import";
+            command: string;
+        } | {
+            status: "not-supported";
+            command: null;
+        };
+    }[];
+    credentials: {
+        id: string;
+        provider: string;
+        requiredBy: string[];
+        obtainAt: string;
+        workspaceEnvironmentKey: string;
+        exampleAssignment: string;
+        configureCommand: string;
+        minimumUtf8Bytes: number;
+        outputPolicy: string;
+    }[];
+    customExternalCapabilities: {
+        supported: boolean;
+        purpose: string;
+        supportedKinds: {
+            kind: string;
+            execution: string;
+            permissions: string[];
+        }[];
+        runtimeInstall: boolean;
+        sourceRequirements: string[];
+        networkRequirements: string[];
+        commands: string[];
+        brokeredEvidenceDefinitionTemplate: {
+            id: string;
+            skillPath: string;
+            source: {
+                type: string;
+                locator: string;
+                immutableRef: string;
+                expectedTreeSha256: string;
+                license: string;
+                catalogId: null;
+            };
+            requiredForDiscovery: boolean;
+            permissions: string[];
+            allowedHosts: string[];
+            http: {
+                accept: string;
+                allowedContentTypes: string[];
+                maxResponseBytes: number;
+                maxItems: number;
+            };
+            coverage: {
+                dimensions: string[];
+                sourceTypes: string[];
+                discoveryScopes: string[];
+                fullText: boolean;
+                publicationDates: boolean;
+            };
+            credentials: {
+                id: string;
+                allowedHosts: string[];
+                headerName: string;
+                prefix: string;
+            }[];
+            healthCheck: {
+                url: string;
+                credentialId: string;
+                expectedContentTypes: string[];
+            };
+        };
+    };
+    workspaceCapabilities: {
+        id: string;
+        skillName: string;
+        catalogId: string | null;
+        externalSource: boolean;
+        source: {
+            type: "git" | "registry" | "local";
+            locatorSha256: string;
+            immutableRef: string;
+            expectedTreeSha256: string;
+            license: string;
+        } | null;
+        requiredForDiscovery: boolean;
+        discoveryScopes: string[];
+        allowedHosts: string[];
+        credentialIds: string[];
+        status: {
+            locked: boolean;
+            credential: string;
+            errors: string[];
+        };
+    }[];
+    summary: {
+        recommended: number;
+        evaluated: number;
+        notSelected: number;
+        required: number;
+        enhanced: number;
+        conditional: number;
+        installed: number;
+        configured: number;
+        credentialsReady: number;
+        workspaceCapabilities: number;
+    };
+    workspace: string | null;
+    skillRoots: string[];
+    capabilityVerification: {
+        status: "verified" | "drifted";
+        checked: number;
+        errors: string[];
+    } | null;
+    credentialEnvironment: {
+        status: "ready" | "blocked";
+        detail: string;
+        missingIds: string[];
+    } | null;
+}>;
+export declare function configureExternalSkillProfile(input: {
+    workspace: string;
+    profile: string;
+    skillRoot?: string | null;
+}): Promise<{
+    schemaVersion: 1;
+    workspace: string;
+    profile: string;
+    configured: {
+        id: string;
+        skillName: string;
+        treeSha256: string | undefined;
+        credentialIds: string[];
+        requiredForDiscovery: boolean;
+    }[];
+    lockStatus: "written";
+    next: string[];
+}>;
+export declare function configureTiangongSciCapability(input: {
+    workspace: string;
+    skillPath: string;
+    source: CapabilitySourceDeclaration;
+    endpoint: string;
+    region?: string | null;
+}): Promise<{
+    schemaVersion: 1;
+    workspace: string;
+    configured: {
+        id: string;
+        skillName: string;
+        treeSha256: string;
+        credentialIds: string[];
+        requiredForDiscovery: boolean;
+        discoveryScopes: string[];
+    };
+    lockStatus: "written";
+}>;
+export declare function importExternalCapability(input: {
+    workspace: string;
+    definitionPath: string;
+}): Promise<{
+    schemaVersion: 1;
+    workspace: string;
+    imported: {
+        id: string;
+        skillName: string;
+        sourceType: "git" | "registry" | "local";
+        sourceLocatorSha256: string;
+        immutableRef: string;
+        expectedTreeSha256: string;
+        license: string;
+        requiredForDiscovery: boolean;
+        discoveryScopes: string[];
+    };
+    lockStatus: "written";
+}>;
+export declare function doctorExternalCapabilities(workspace: string, options?: {
+    live?: boolean;
+    fetcher?: typeof fetch;
+    sleeper?: (milliseconds: number) => Promise<unknown>;
+}): Promise<{
+    schemaVersion: 1;
+    workspace: string;
+    mode: "live" | "static";
+    status: "ready" | "blocked";
+    capabilityVerification: {
+        status: "verified" | "drifted";
+        checked: number;
+        errors: string[];
+    };
+    credentialEnvironment: {
+        status: "ready" | "blocked";
+        detail: string;
+        missingIds: string[];
+    };
+    capabilities: {
+        id: string;
+        skillName: string;
+        catalogId: string | null;
+        sourceType: "git" | "registry" | "local" | null;
+        externalSource: boolean;
+        installed: boolean;
+        locked: boolean;
+        requiredForDiscovery: boolean;
+        discoveryScopes: string[];
+        credentialIds: string[];
+        missingCredentialIds: string[];
+        staticStatus: string;
+        staticErrors: string[];
+        health: {
+            status: "fail";
+            code: string;
+            host: string;
+            targetSha256: string;
+            httpStatus: number;
+            retryAfterSeconds: number | null;
+            detail: string;
+        } | {
+            status: "pass";
+            code: string;
+            host: string;
+            targetSha256: string;
+            httpStatus: number;
+            retryAfterSeconds: number | null;
+            detail: string;
+        } | {
+            status: "fail";
+            code: string;
+            host: string;
+            targetSha256: string;
+            httpStatus: null;
+            retryAfterSeconds: null;
+            detail: string;
+        } | {
+            status: "blocked";
+            code: string;
+            host: string | null;
+            targetSha256: string | null;
+            httpStatus: null;
+            retryAfterSeconds: null;
+            detail: string;
+        } | {
+            status: "not-applicable";
+            code: string;
+            host: null;
+            targetSha256: null;
+            httpStatus: null;
+            retryAfterSeconds: null;
+            detail: string;
+        } | {
+            status: "not-run";
+            code: string;
+            host: string | null;
+            targetSha256: string | null;
+            httpStatus: null;
+            retryAfterSeconds: null;
+            detail: string;
+        };
+    }[];
+    failures: string[];
+}>;
+export declare function hasPublicInternetCapability(declarations: CapabilityDeclarations): boolean;
+export declare function requiredDiscoveryCapabilityIds(declarations: CapabilityDeclarations): string[];