Skip to content

rei-k/agid-elixir

Repository files navigation

agid-elixir

Elixir SDK package scaffold for AGID.

This package is generated from agid-spec/agid-spec.json so every language binding follows the same coordinate model, ID format, and public API.

SDK Target Matrix

Field Value
Language Elixir
Package agid
Ecosystem server
Package manager mix/Hex
Runtime Elixir >=1.15
Primary use Concurrent services and realtime systems
Test command mix test

The machine-readable target manifest is agid-sdk.json. The complete language matrix is published by agid-spec/sdk-targets.json.

API

  • encode(latitude, longitude)
  • decode(agid)
  • cellBounds(agid)
  • cellPolygon(agid)
  • normalizeAgid(agid)
  • isValidAgid(agid)
  • validateAgid(agid)

Security Boundary

AGID is a public location/address/building-map-feature identifier. SDKs must keep recipient names, phone numbers, room or unit numbers, private delivery instructions, owner keys, device keys, AOID private payloads, and encrypted AOID payloads outside the public AGID contract. Validation helpers are generated so clients can reject malformed or unsafe public AGID strings before decode, QR, NFC, POS, registry, or resolver use.

Status

This scaffold is ready for implementation work, but it is not ready for formal distribution until the generated encode/decode/cellBounds parity tests pass for this language. The canonical implementation is the existing TypeScript/Rust core in this repository; language implementations should use the shared spec and vectors in agid-spec.

Release Gate

Before publishing this SDK, run mix test and confirm every parity vector in agid-parity-vectors.json matches the canonical agid-spec/test-vectors.json.

About

AGID split repository for agid-elixir, generated from the AGID monorepo SDK/spec source.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages