Skip to content

Document Next.js consumption (transpilePackages, GitHub Packages auth in Docker/CI) #3

Description

@alexanderkreidich

The README covers Vite consumers (resolve.dedupe, file: linking), but the appx canvas template is a Next.js 15 app. Because the package ships TypeScript source (exportssrc/index.ts), a Next consumer needs:

// next.config.ts
transpilePackages: ['@appx-org/agent-client']

and the GitHub Packages scope registry with a readable token at install time:

@appx-org:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}

The token part matters for Docker builds and CI, where no user keyring is available — worth a short README section with the recommended secret-passing pattern (e.g. BuildKit --secret rather than baking the token into a layer).

Also worth verifying/documenting: React dedupe behavior under file: linking in Next (the Vite-specific resolve.dedupe advice doesn't apply), and that 'use client' boundaries work — the components use hooks, so Next consumers must mount them under a client component.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions