@signetai/connector-base 0.140.1

package/dist/index.d.ts

@@ -0,0 +1,159 @@
+/**
+ * @signetai/connector-base
+ *
+ * Base class for Signet harness connectors. Provides shared functionality
+ * that all connectors need (Signet block handling, skills symlinking),
+ * allowing concrete connectors to focus on harness-specific logic.
+ *
+ * @example
+ * ```typescript
+ * import { BaseConnector, InstallResult } from '@signetai/connector-base';
+ *
+ * class MyConnector extends BaseConnector {
+ *   readonly name = "my-harness";
+ *   readonly harnessId = "myharness";
+ *
+ *   async install(basePath: string): Promise<InstallResult> {
+ *     // harness-specific setup
+ *   }
+ *
+ *   async uninstall(): Promise<void> {
+ *     // harness-specific cleanup
+ *   }
+ *
+ *   isInstalled(): boolean {
+ *     // check if already set up
+ *   }
+ *
+ *   getConfigPath(): string {
+ *     // return harness config file path
+ *   }
+ * }
+ * ```
+ */
+import { type SymlinkOptions, type SymlinkResult } from "@signetai/core";
+export interface InstallResult {
+    success: boolean;
+    message: string;
+    filesWritten: string[];
+    configsPatched?: string[];
+    warnings?: string[];
+}
+export interface UninstallResult {
+    filesRemoved: string[];
+    configsPatched?: string[];
+}
+/**
+ * Abstract base class for Signet harness connectors.
+ *
+ * Provides:
+ * - stripSignetBlock() - remove existing Signet blocks before re-injection
+ * - stripLegacySignetBlock() - migrate old SIGNET block out of AGENTS.md
+ * - symlinkSkills() - symlink skills directory to harness-specific location
+ *
+ * Subclasses must implement:
+ * - name - human-readable harness name
+ * - harnessId - machine identifier for the harness
+ * - install() - harness-specific setup
+ * - uninstall() - harness-specific cleanup
+ * - isInstalled() - check if integration exists
+ * - getConfigPath() - return path to harness config
+ */
+export declare abstract class BaseConnector {
+    /**
+     * Human-readable name for the harness (e.g., "Claude Code")
+     */
+    abstract readonly name: string;
+    /**
+     * Machine identifier (e.g., "claude-code")
+     */
+    abstract readonly harnessId: string;
+    /**
+     * Strip existing Signet blocks from content.
+     *
+     * Call this before re-injecting the block to prevent duplication
+     * when re-running install or sync operations.
+     */
+    protected stripSignetBlock(content: string): string;
+    /**
+     * Strip legacy SIGNET block markers from AGENTS.md in place.
+     *
+     * Returns the path when a write occurred, otherwise null.
+     */
+    protected stripLegacySignetBlock(basePath: string): string | null;
+    /**
+     * Symlink skills from source to target directory.
+     *
+     * Each subdirectory in sourceDir becomes a symlink in targetDir.
+     * Existing symlinks are replaced; real directories are skipped.
+     */
+    protected symlinkSkills(sourceDir: string, targetDir: string, options?: SymlinkOptions): SymlinkResult;
+    /**
+     * Generate the auto-generated file header.
+     *
+     * @param sourcePath - Path to the source file being generated from
+     * @param targetName - Name of the target harness
+     */
+    protected generateHeader(sourcePath: string, targetName?: string): string;
+    /**
+     * Read and compose additional identity files (SOUL.md, IDENTITY.md,
+     * USER.md, MEMORY.md) into a single string with section headers.
+     *
+     * @param basePath - Path to the Signet workspace or equivalent identity directory
+     */
+    protected composeIdentityExtras(basePath: string): string;
+    /**
+     * Install the connector for this harness.
+     *
+     * Should:
+     * - Configure hooks in the harness config
+     * - Generate any necessary files (CLAUDE.md, AGENTS.md, etc.)
+     * - Set up skills symlinks
+     *
+     * Must be idempotent - safe to run multiple times.
+     */
+    abstract install(basePath: string): Promise<InstallResult>;
+    /**
+     * Remove the connector integration.
+     *
+     * Should:
+     * - Remove hooks from harness config
+     * - Remove generated files (but not user data)
+     * - Optionally remove skills symlinks
+     */
+    abstract uninstall(): Promise<UninstallResult>;
+    /**
+     * Check if the connector is already installed.
+     */
+    abstract isInstalled(): boolean;
+    /**
+     * Get the path to the harness's main config file.
+     */
+    abstract getConfigPath(): string;
+}
+export declare function atomicWriteJson(path: string, data: unknown, indent?: number | string): void;
+export declare const MANAGED_DAEMON_URL_DEFAULT = "http://127.0.0.1:3850";
+export declare const MANAGED_AGENT_ID_DEFAULT = "default";
+export declare function readManagedTrimmedEnv(name: string): string | undefined;
+export declare function resolveSignetWorkspacePath(home?: string): string;
+export declare function resolveSignetDaemonUrl(): string;
+export declare function resolveSignetAgentId(): string;
+export declare function resolveSignetApiKey(): string | undefined;
+export declare function buildManagedExtensionEnvBootstrap(env: {
+    readonly signetPath: string;
+    readonly daemonUrl: string;
+    readonly agentId: string;
+    readonly apiKey?: string;
+}): string;
+export declare function managedExtensionFilePath(agentDir: string, filename: string): string;
+export declare function isManagedExtensionFile(filePath: string, marker: string): boolean;
+export declare function removeManagedExtensionFile(filePath: string, marker: string): boolean;
+export interface ConnectorInstallerOptions {
+    readonly commandName?: string;
+    readonly packageName?: string;
+    readonly label?: string;
+}
+type ConnectorConstructor = new () => BaseConnector;
+export declare function runConnectorInstaller(harness: string, ConnectorClass: ConnectorConstructor, options?: ConnectorInstallerOptions): void;
+export type { SymlinkOptions, SymlinkResult };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AAMH,OAAO,EACN,KAAK,cAAc,EACnB,KAAK,aAAa,EAKlB,MAAM,cAAc,CAAC;AAMtB,MAAM,WAAW,aAAa;IAC7B,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,eAAe;IAC/B,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;CAC1B;AAMD;;;;;;;;;;;;;;;GAeG;AACH,8BAAsB,aAAa;IAClC;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAMpC;;;;;OAKG;IACH,SAAS,CAAC,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAInD;;;;OAIG;IACH,SAAS,CAAC,sBAAsB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAmBjE;;;;;OAKG;IACH,SAAS,CAAC,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,aAAa;IAItG;;;;;OAKG;IACH,SAAS,CAAC,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM;IAczE;;;;;OAKG;IACH,SAAS,CAAC,qBAAqB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAwBzD;;;;;;;;;OASG;IACH,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAE1D;;;;;;;OAOG;IACH,QAAQ,CAAC,SAAS,IAAI,OAAO,CAAC,eAAe,CAAC;IAE9C;;OAEG;IACH,QAAQ,CAAC,WAAW,IAAI,OAAO;IAE/B;;OAEG;IACH,QAAQ,CAAC,aAAa,IAAI,MAAM;CAChC;AAQD,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,GAAE,MAAM,GAAG,MAAU,GAAG,IAAI,CAY9F;AAMD,eAAO,MAAM,0BAA0B,0BAA0B,CAAC;AAClE,eAAO,MAAM,wBAAwB,YAAY,CAAC;AAElD,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAKtE;AAED,wBAAgB,0BAA0B,CAAC,IAAI,SAAY,GAAG,MAAM,CAgBnE;AAED,wBAAgB,sBAAsB,IAAI,MAAM,CAE/C;AAED,wBAAgB,oBAAoB,IAAI,MAAM,CAE7C;AAED,wBAAgB,mBAAmB,IAAI,MAAM,GAAG,SAAS,CAExD;AAED,wBAAgB,iCAAiC,CAAC,GAAG,EAAE;IACtD,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;CACzB,GAAG,MAAM,CA6BT;AAED,wBAAgB,wBAAwB,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAEnF;AAED,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAGhF;AAUD,wBAAgB,0BAA0B,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAKpF;AAMD,MAAM,WAAW,yBAAyB;IACzC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,KAAK,oBAAoB,GAAG,UAAU,aAAa,CAAC;AAmFpD,wBAAgB,qBAAqB,CACpC,OAAO,EAAE,MAAM,EACf,cAAc,EAAE,oBAAoB,EACpC,OAAO,GAAE,yBAA8B,GACrC,IAAI,CAsCN;AAMD,YAAY,EAAE,cAAc,EAAE,aAAa,EAAE,CAAC"}