@aaif/goose-sdk 0.16.0

package/README.md

@@ -0,0 +1,131 @@
+# @aaif/goose-sdk
+
+TypeScript client library for the Goose Agent Client Protocol (ACP).
+
+This package provides:
+- TypeScript types and Zod validators for Goose ACP extension methods
+- A client for communicating with the Goose ACP server
+
+## Installation
+
+```bash
+npm install @aaif/goose-sdk
+```
+
+The native `goose` binaries are distributed as optional dependencies
+and will be automatically installed for your platform.
+
+## Development
+
+### Prerequisites
+
+- Node.js 18+
+- Rust toolchain
+- (Optional) Cross-compilation toolchains for building all platforms
+
+### Building
+
+```bash
+# Build everything (schema + TypeScript)
+npm run build
+
+# Build just the schema (requires Rust)
+npm run build:schema
+
+# Build just the TypeScript
+npm run build:ts
+
+# Build native binary for current platform
+npm run build:native
+
+# Build native binaries for all platforms
+npm run build:native:all
+```
+
+### Local Development with npm link
+
+To use this package locally in another project (e.g., `@aaif/goose`):
+
+```bash
+# In ui/sdk
+npm run build
+npm link
+
+# In ui/text (or another project)
+npm link @aaif/goose-sdk
+```
+
+### Schema Generation
+
+The TypeScript types are generated from Rust schemas defined in `crates/goose-acp`.
+The build process:
+
+1. Builds the `generate-acp-schema` Rust binary
+2. Runs it to generate `acp-schema.json` and `acp-meta.json`
+3. Uses `@hey-api/openapi-ts` to generate TypeScript types and Zod validators
+4. Generates a typed client in `src/generated/client.gen.ts`
+
+To regenerate schemas after changing Rust types:
+
+```bash
+npm run build:schema
+```
+
+## Native Binary Packages
+
+Platform-specific npm packages for the `goose` binary are located in
+`ui/goose-binary/`:
+
+| Package | Platform |
+|---------|----------|
+| `@aaif/goose-binary-darwin-arm64` | macOS Apple Silicon |
+| `@aaif/goose-binary-darwin-x64` | macOS Intel |
+| `@aaif/goose-binary-linux-arm64` | Linux ARM64 |
+| `@aaif/goose-binary-linux-x64` | Linux x64 |
+| `@aaif/goose-binary-win32-x64` | Windows x64 |
+
+These are published separately from `@aaif/goose-sdk`.
+
+### Building Native Binaries
+
+```bash
+# Build for current platform
+npm run build:native
+
+# Build for all platforms (requires cross-compilation toolchains)
+npm run build:native:all
+
+# Build for specific platform(s)
+npx tsx scripts/build-native.ts darwin-arm64 linux-x64
+```
+
+## Publishing
+
+Publishing is handled by GitHub Actions. See `.github/workflows/publish-npm.yml`.
+
+For manual publishing:
+
+```bash
+# From repository root
+./ui/scripts/publish.sh --real
+```
+
+This will:
+1. Build and publish `@aaif/goose-sdk`
+2. Publish all native binary packages
+3. Publish `@aaif/goose` (which depends on the above)
+
+## Usage
+
+```typescript
+import { GooseClient } from "@aaif/goose-sdk";
+
+const client = new GooseClient({
+  // ... configuration
+});
+
+// Use the client
+const result = await client.someMethod({ ... });
+```
+
+See the [main documentation](../../README.md) for more details.

package/dist/generated/client.gen.d.ts

@@ -0,0 +1,30 @@
+export interface ExtMethodProvider {
+    extMethod(method: string, params: Record<string, unknown>): Promise<Record<string, unknown>>;
+}
+import type { AddExtensionRequest, ArchiveSessionRequest, CheckSecretRequest, CheckSecretResponse, DeleteSessionRequest, ExportSessionRequest, ExportSessionResponse, GetExtensionsRequest, GetExtensionsResponse, GetProviderDetailsRequest, GetProviderDetailsResponse, GetProviderModelsRequest, GetProviderModelsResponse, GetToolsRequest, GetToolsResponse, ImportSessionRequest, ImportSessionResponse, ListProvidersRequest, ListProvidersResponse, ReadConfigRequest, ReadConfigResponse, ReadResourceRequest, ReadResourceResponse, RemoveConfigRequest, RemoveExtensionRequest, RemoveSecretRequest, UnarchiveSessionRequest, UpdateProviderRequest, UpdateProviderResponse, UpdateWorkingDirRequest, UpsertConfigRequest, UpsertSecretRequest } from './types.gen.js';
+export declare class GooseExtClient {
+    private conn;
+    constructor(conn: ExtMethodProvider);
+    GooseExtensionsAdd(params: AddExtensionRequest): Promise<void>;
+    GooseExtensionsRemove(params: RemoveExtensionRequest): Promise<void>;
+    GooseTools(params: GetToolsRequest): Promise<GetToolsResponse>;
+    GooseResourceRead(params: ReadResourceRequest): Promise<ReadResourceResponse>;
+    GooseWorkingDirUpdate(params: UpdateWorkingDirRequest): Promise<void>;
+    sessionDelete(params: DeleteSessionRequest): Promise<void>;
+    GooseConfigExtensions(params: GetExtensionsRequest): Promise<GetExtensionsResponse>;
+    GooseSessionProviderUpdate(params: UpdateProviderRequest): Promise<UpdateProviderResponse>;
+    GooseProvidersList(params: ListProvidersRequest): Promise<ListProvidersResponse>;
+    GooseProvidersDetails(params: GetProviderDetailsRequest): Promise<GetProviderDetailsResponse>;
+    GooseProvidersModels(params: GetProviderModelsRequest): Promise<GetProviderModelsResponse>;
+    GooseConfigRead(params: ReadConfigRequest): Promise<ReadConfigResponse>;
+    GooseConfigUpsert(params: UpsertConfigRequest): Promise<void>;
+    GooseConfigRemove(params: RemoveConfigRequest): Promise<void>;
+    GooseSecretCheck(params: CheckSecretRequest): Promise<CheckSecretResponse>;
+    GooseSecretUpsert(params: UpsertSecretRequest): Promise<void>;
+    GooseSecretRemove(params: RemoveSecretRequest): Promise<void>;
+    GooseSessionExport(params: ExportSessionRequest): Promise<ExportSessionResponse>;
+    GooseSessionImport(params: ImportSessionRequest): Promise<ImportSessionResponse>;
+    GooseSessionArchive(params: ArchiveSessionRequest): Promise<void>;
+    GooseSessionUnarchive(params: UnarchiveSessionRequest): Promise<void>;
+}
+//# sourceMappingURL=client.gen.d.ts.map

package/dist/generated/client.gen.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.gen.d.ts","sourceRoot":"","sources":["../../src/generated/client.gen.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,iBAAiB;IAChC,SAAS,CACP,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CACrC;AAED,OAAO,KAAK,EACV,mBAAmB,EACnB,qBAAqB,EACrB,kBAAkB,EAClB,mBAAmB,EACnB,oBAAoB,EACpB,oBAAoB,EACpB,qBAAqB,EACrB,oBAAoB,EACpB,qBAAqB,EACrB,yBAAyB,EACzB,0BAA0B,EAC1B,wBAAwB,EACxB,yBAAyB,EACzB,eAAe,EACf,gBAAgB,EAChB,oBAAoB,EACpB,qBAAqB,EACrB,oBAAoB,EACpB,qBAAqB,EACrB,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACnB,oBAAoB,EACpB,mBAAmB,EACnB,sBAAsB,EACtB,mBAAmB,EACnB,uBAAuB,EACvB,qBAAqB,EACrB,sBAAsB,EACtB,uBAAuB,EACvB,mBAAmB,EACnB,mBAAmB,EACpB,MAAM,gBAAgB,CAAC;AAexB,qBAAa,cAAc;IACb,OAAO,CAAC,IAAI;gBAAJ,IAAI,EAAE,iBAAiB;IAErC,kBAAkB,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAI9D,qBAAqB,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAIpE,UAAU,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAK9D,iBAAiB,CACrB,MAAM,EAAE,mBAAmB,GAC1B,OAAO,CAAC,oBAAoB,CAAC;IAK1B,qBAAqB,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC;IAIrE,aAAa,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;IAI1D,qBAAqB,CACzB,MAAM,EAAE,oBAAoB,GAC3B,OAAO,CAAC,qBAAqB,CAAC;IAK3B,0BAA0B,CAC9B,MAAM,EAAE,qBAAqB,GAC5B,OAAO,CAAC,sBAAsB,CAAC;IAQ5B,kBAAkB,CACtB,MAAM,EAAE,oBAAoB,GAC3B,OAAO,CAAC,qBAAqB,CAAC;IAK3B,qBAAqB,CACzB,MAAM,EAAE,yBAAyB,GAChC,OAAO,CAAC,0BAA0B,CAAC;IAKhC,oBAAoB,CACxB,MAAM,EAAE,wBAAwB,GAC/B,OAAO,CAAC,yBAAyB,CAAC;IAK/B,eAAe,CACnB,MAAM,EAAE,iBAAiB,GACxB,OAAO,CAAC,kBAAkB,CAAC;IAKxB,iBAAiB,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAI7D,iBAAiB,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAI7D,gBAAgB,CACpB,MAAM,EAAE,kBAAkB,GACzB,OAAO,CAAC,mBAAmB,CAAC;IAKzB,iBAAiB,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAI7D,iBAAiB,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAI7D,kBAAkB,CACtB,MAAM,EAAE,oBAAoB,GAC3B,OAAO,CAAC,qBAAqB,CAAC;IAK3B,kBAAkB,CACtB,MAAM,EAAE,oBAAoB,GAC3B,OAAO,CAAC,qBAAqB,CAAC;IAK3B,mBAAmB,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;IAIjE,qBAAqB,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC;CAG5E"}

package/dist/generated/client.gen.js

@@ -0,0 +1,82 @@
+// This file is auto-generated — do not edit manually.
+import { zCheckSecretResponse, zExportSessionResponse, zGetExtensionsResponse, zGetProviderDetailsResponse, zGetProviderModelsResponse, zGetToolsResponse, zImportSessionResponse, zListProvidersResponse, zReadConfigResponse, zReadResourceResponse, zUpdateProviderResponse, } from './zod.gen.js';
+export class GooseExtClient {
+    conn;
+    constructor(conn) {
+        this.conn = conn;
+    }
+    async GooseExtensionsAdd(params) {
+        await this.conn.extMethod("_goose/extensions/add", params);
+    }
+    async GooseExtensionsRemove(params) {
+        await this.conn.extMethod("_goose/extensions/remove", params);
+    }
+    async GooseTools(params) {
+        const raw = await this.conn.extMethod("_goose/tools", params);
+        return zGetToolsResponse.parse(raw);
+    }
+    async GooseResourceRead(params) {
+        const raw = await this.conn.extMethod("_goose/resource/read", params);
+        return zReadResourceResponse.parse(raw);
+    }
+    async GooseWorkingDirUpdate(params) {
+        await this.conn.extMethod("_goose/working_dir/update", params);
+    }
+    async sessionDelete(params) {
+        await this.conn.extMethod("session/delete", params);
+    }
+    async GooseConfigExtensions(params) {
+        const raw = await this.conn.extMethod("_goose/config/extensions", params);
+        return zGetExtensionsResponse.parse(raw);
+    }
+    async GooseSessionProviderUpdate(params) {
+        const raw = await this.conn.extMethod("_goose/session/provider/update", params);
+        return zUpdateProviderResponse.parse(raw);
+    }
+    async GooseProvidersList(params) {
+        const raw = await this.conn.extMethod("_goose/providers/list", params);
+        return zListProvidersResponse.parse(raw);
+    }
+    async GooseProvidersDetails(params) {
+        const raw = await this.conn.extMethod("_goose/providers/details", params);
+        return zGetProviderDetailsResponse.parse(raw);
+    }
+    async GooseProvidersModels(params) {
+        const raw = await this.conn.extMethod("_goose/providers/models", params);
+        return zGetProviderModelsResponse.parse(raw);
+    }
+    async GooseConfigRead(params) {
+        const raw = await this.conn.extMethod("_goose/config/read", params);
+        return zReadConfigResponse.parse(raw);
+    }
+    async GooseConfigUpsert(params) {
+        await this.conn.extMethod("_goose/config/upsert", params);
+    }
+    async GooseConfigRemove(params) {
+        await this.conn.extMethod("_goose/config/remove", params);
+    }
+    async GooseSecretCheck(params) {
+        const raw = await this.conn.extMethod("_goose/secret/check", params);
+        return zCheckSecretResponse.parse(raw);
+    }
+    async GooseSecretUpsert(params) {
+        await this.conn.extMethod("_goose/secret/upsert", params);
+    }
+    async GooseSecretRemove(params) {
+        await this.conn.extMethod("_goose/secret/remove", params);
+    }
+    async GooseSessionExport(params) {
+        const raw = await this.conn.extMethod("_goose/session/export", params);
+        return zExportSessionResponse.parse(raw);
+    }
+    async GooseSessionImport(params) {
+        const raw = await this.conn.extMethod("_goose/session/import", params);
+        return zImportSessionResponse.parse(raw);
+    }
+    async GooseSessionArchive(params) {
+        await this.conn.extMethod("_goose/session/archive", params);
+    }
+    async GooseSessionUnarchive(params) {
+        await this.conn.extMethod("_goose/session/unarchive", params);
+    }
+}

package/dist/generated/index.d.ts

@@ -0,0 +1,88 @@
+export type { AddExtensionRequest, ArchiveSessionRequest, CheckSecretRequest, CheckSecretResponse, DeleteSessionRequest, EmptyResponse, ExportSessionRequest, ExportSessionResponse, ExtRequest, ExtResponse, GetExtensionsRequest, GetExtensionsResponse, GetProviderDetailsRequest, GetProviderDetailsResponse, GetProviderModelsRequest, GetProviderModelsResponse, GetToolsRequest, GetToolsResponse, ImportSessionRequest, ImportSessionResponse, ListProvidersRequest, ListProvidersResponse, ModelEntry, ProviderConfigKey, ProviderDetailEntry, ProviderListEntry, ReadConfigRequest, ReadConfigResponse, ReadResourceRequest, ReadResourceResponse, RemoveConfigRequest, RemoveExtensionRequest, RemoveSecretRequest, UnarchiveSessionRequest, UpdateProviderRequest, UpdateProviderResponse, UpdateWorkingDirRequest, UpsertConfigRequest, UpsertSecretRequest } from './types.gen.js';
+export declare const GOOSE_EXT_METHODS: readonly [{
+    readonly method: "_goose/extensions/add";
+    readonly requestType: "AddExtensionRequest";
+    readonly responseType: "EmptyResponse";
+}, {
+    readonly method: "_goose/extensions/remove";
+    readonly requestType: "RemoveExtensionRequest";
+    readonly responseType: "EmptyResponse";
+}, {
+    readonly method: "_goose/tools";
+    readonly requestType: "GetToolsRequest";
+    readonly responseType: "GetToolsResponse";
+}, {
+    readonly method: "_goose/resource/read";
+    readonly requestType: "ReadResourceRequest";
+    readonly responseType: "ReadResourceResponse";
+}, {
+    readonly method: "_goose/working_dir/update";
+    readonly requestType: "UpdateWorkingDirRequest";
+    readonly responseType: "EmptyResponse";
+}, {
+    readonly method: "session/delete";
+    readonly requestType: "DeleteSessionRequest";
+    readonly responseType: "EmptyResponse";
+}, {
+    readonly method: "_goose/config/extensions";
+    readonly requestType: "GetExtensionsRequest";
+    readonly responseType: "GetExtensionsResponse";
+}, {
+    readonly method: "_goose/session/provider/update";
+    readonly requestType: "UpdateProviderRequest";
+    readonly responseType: "UpdateProviderResponse";
+}, {
+    readonly method: "_goose/providers/list";
+    readonly requestType: "ListProvidersRequest";
+    readonly responseType: "ListProvidersResponse";
+}, {
+    readonly method: "_goose/providers/details";
+    readonly requestType: "GetProviderDetailsRequest";
+    readonly responseType: "GetProviderDetailsResponse";
+}, {
+    readonly method: "_goose/providers/models";
+    readonly requestType: "GetProviderModelsRequest";
+    readonly responseType: "GetProviderModelsResponse";
+}, {
+    readonly method: "_goose/config/read";
+    readonly requestType: "ReadConfigRequest";
+    readonly responseType: "ReadConfigResponse";
+}, {
+    readonly method: "_goose/config/upsert";
+    readonly requestType: "UpsertConfigRequest";
+    readonly responseType: "EmptyResponse";
+}, {
+    readonly method: "_goose/config/remove";
+    readonly requestType: "RemoveConfigRequest";
+    readonly responseType: "EmptyResponse";
+}, {
+    readonly method: "_goose/secret/check";
+    readonly requestType: "CheckSecretRequest";
+    readonly responseType: "CheckSecretResponse";
+}, {
+    readonly method: "_goose/secret/upsert";
+    readonly requestType: "UpsertSecretRequest";
+    readonly responseType: "EmptyResponse";
+}, {
+    readonly method: "_goose/secret/remove";
+    readonly requestType: "RemoveSecretRequest";
+    readonly responseType: "EmptyResponse";
+}, {
+    readonly method: "_goose/session/export";
+    readonly requestType: "ExportSessionRequest";
+    readonly responseType: "ExportSessionResponse";
+}, {
+    readonly method: "_goose/session/import";
+    readonly requestType: "ImportSessionRequest";
+    readonly responseType: "ImportSessionResponse";
+}, {
+    readonly method: "_goose/session/archive";
+    readonly requestType: "ArchiveSessionRequest";
+    readonly responseType: "EmptyResponse";
+}, {
+    readonly method: "_goose/session/unarchive";
+    readonly requestType: "UnarchiveSessionRequest";
+    readonly responseType: "EmptyResponse";
+}];
+export type GooseExtMethod = (typeof GOOSE_EXT_METHODS)[number];
+//# sourceMappingURL=index.d.ts.map

package/dist/generated/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/generated/index.ts"],"names":[],"mappings":"AAEA,YAAY,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,aAAa,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,UAAU,EAAE,WAAW,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,yBAAyB,EAAE,0BAA0B,EAAE,wBAAwB,EAAE,yBAAyB,EAAE,eAAe,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,UAAU,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,mBAAmB,EAAE,uBAAuB,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,uBAAuB,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAEj2B,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA0GpB,CAAC;AAEX,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,CAAC,CAAC"}

package/dist/generated/index.js

@@ -0,0 +1,108 @@
+// This file is auto-generated by @hey-api/openapi-ts
+export const GOOSE_EXT_METHODS = [
+    {
+        method: "_goose/extensions/add",
+        requestType: "AddExtensionRequest",
+        responseType: "EmptyResponse",
+    },
+    {
+        method: "_goose/extensions/remove",
+        requestType: "RemoveExtensionRequest",
+        responseType: "EmptyResponse",
+    },
+    {
+        method: "_goose/tools",
+        requestType: "GetToolsRequest",
+        responseType: "GetToolsResponse",
+    },
+    {
+        method: "_goose/resource/read",
+        requestType: "ReadResourceRequest",
+        responseType: "ReadResourceResponse",
+    },
+    {
+        method: "_goose/working_dir/update",
+        requestType: "UpdateWorkingDirRequest",
+        responseType: "EmptyResponse",
+    },
+    {
+        method: "session/delete",
+        requestType: "DeleteSessionRequest",
+        responseType: "EmptyResponse",
+    },
+    {
+        method: "_goose/config/extensions",
+        requestType: "GetExtensionsRequest",
+        responseType: "GetExtensionsResponse",
+    },
+    {
+        method: "_goose/session/provider/update",
+        requestType: "UpdateProviderRequest",
+        responseType: "UpdateProviderResponse",
+    },
+    {
+        method: "_goose/providers/list",
+        requestType: "ListProvidersRequest",
+        responseType: "ListProvidersResponse",
+    },
+    {
+        method: "_goose/providers/details",
+        requestType: "GetProviderDetailsRequest",
+        responseType: "GetProviderDetailsResponse",
+    },
+    {
+        method: "_goose/providers/models",
+        requestType: "GetProviderModelsRequest",
+        responseType: "GetProviderModelsResponse",
+    },
+    {
+        method: "_goose/config/read",
+        requestType: "ReadConfigRequest",
+        responseType: "ReadConfigResponse",
+    },
+    {
+        method: "_goose/config/upsert",
+        requestType: "UpsertConfigRequest",
+        responseType: "EmptyResponse",
+    },
+    {
+        method: "_goose/config/remove",
+        requestType: "RemoveConfigRequest",
+        responseType: "EmptyResponse",
+    },
+    {
+        method: "_goose/secret/check",
+        requestType: "CheckSecretRequest",
+        responseType: "CheckSecretResponse",
+    },
+    {
+        method: "_goose/secret/upsert",
+        requestType: "UpsertSecretRequest",
+        responseType: "EmptyResponse",
+    },
+    {
+        method: "_goose/secret/remove",
+        requestType: "RemoveSecretRequest",
+        responseType: "EmptyResponse",
+    },
+    {
+        method: "_goose/session/export",
+        requestType: "ExportSessionRequest",
+        responseType: "ExportSessionResponse",
+    },
+    {
+        method: "_goose/session/import",
+        requestType: "ImportSessionRequest",
+        responseType: "ImportSessionResponse",
+    },
+    {
+        method: "_goose/session/archive",
+        requestType: "ArchiveSessionRequest",
+        responseType: "EmptyResponse",
+    },
+    {
+        method: "_goose/session/unarchive",
+        requestType: "UnarchiveSessionRequest",
+        responseType: "EmptyResponse",
+    },
+];