alknet/tasks/napi/project-setup.md at 47968ee48df2b8e50b9fab4b5ee1329833083fb4

Files

glm-5.1 5c820a41e9 tasks: decompose Phase 0a ADR foundation and mark prior tasks completed

Add 10 new tasks under tasks/architecture/ for Phase 0a (ADR writing):
- 9 ADR tasks (026-034) with dependency-ordered structure
- 1 review checkpoint task before Phase 0b spec writing

ADR dependency graph (3 generations):
  Gen 1 (parallel): 026, 029, 030, 031, 032, 034
  Gen 2 (depends on 029): 027, 028
  Gen 3 (depends on 027+028): 033
  Gen 4: review checkpoint

Also mark all 34 prior implementation tasks as completed — they
were finished but still showing as pending in the taskgraph.

2026-06-07 08:55:33 +00:00

1.9 KiB

Raw Blame History

id, name, status, depends_on, scope, risk, impact, level

name

status

depends_on

scope

risk

impact

level

napi/project-setup

Set up alknet-napi project with napi-rs build tooling and TypeScript types

completed

setup/project-init

moderate

low

component

implementation

Description

Set up the napi-rs project for the @alkdev/alknet Node.js native addon. This includes the napi-rs build configuration, TypeScript type definitions, and the package structure.

Per ADR-015 and ADR-016: napi-rs is the FFI bridge, and the wrapper exposes connect() and serve() functions. The NAPI layer is transport-agnostic — it doesn't know about pubsub's EventEnvelope.

The Cargo.toml skeleton was created in setup/project-init. This task configures the actual napi-rs build pipeline, TypeScript types, and verifies the build works.

Acceptance Criteria

crates/alknet-napi/ has Cargo.toml with crate-type = ["cdylib"], napi and napi-derive dependencies
crates/alknet-napi/src/lib.rs with napi module registration
packages/alknet-napi/ directory (or similar) with package.json named @alkdev/alknet
packages/alknet-napi/tsconfig.json for TypeScript type generation
TypeScript type definitions for AlknetConnectOptions, AlknetServeOptions, AlknetServer, ConnectionInfo matching napi-and-pubsub.md interfaces
napi.config.js or NapiRs.config with correct cargo path, module name
Build command: npm run build builds the native addon
Feature flags: iroh feature optional; base package includes tcp + tls
npm install and initial build succeed

References

docs/architecture/napi-and-pubsub.md — NAPI Wrapper section, TypeScript interfaces
docs/architecture/decisions/015-napi-rs-for-ffi-bridge.md — napi-rs choice
docs/architecture/decisions/016-napi-expose-connect-and-serve.md — both connect() and serve()

Notes

To be filled by implementation agent

Summary

To be filled on completion

1.9 KiB Raw Blame History