Skip to content

Preserve required and optional GAMEPAD migration declarations #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dskvr wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Preserve required and optional GAMEPAD migration declarations #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/migration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,7 @@ The migration targets [PR #7](https://github.com/dskvr/nips/pull/7) at pinned re
**Automatic migration limits:** ambiguous identifiers, malformed structural metadata, and multi-file manifests block migration. Rebundle multi-file artifacts first. Invalid optional icons are removed with a review note. The artifact itself is never fetched, changed, executed, or uploaded; its hash comes from the original signed `/index.html` path.

Signatures, authorship, and exact signer output are verified before publication. Success requires at least one positive relay acknowledgement; partial failures are listed. Retrying a failed publication reuses the signed event. Discovery depends on the configured relays’ available history, and immutable legacy snapshots may remain discoverable after migration.

## Controller declarations

This non-normative guidance defers to the living [NAP-GAMEPAD proposal](https://github.com/napplet/naps/pull/108) and [NIP-5D](https://github.com/nostr-protocol/nips/pull/2303). Migration preserves the bare `gamepad` domain and the author's required/optional choice; it does not add controller capabilities automatically. Choose optional controller support when keyboard or pointer controls fulfill the core task. A migrated manifest does not upgrade app code or make the target runtime GAMEPAD-capable. Native controller access and focus isolation remain the runtime's responsibility.
10 changes: 10 additions & 0 deletions src/lib/migration.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,16 @@ describe('standalone manifest migration', () => {
).toBe(false)
expect(JSON.stringify(old)).toBe(before)
})
it('preserves GAMEPAD as a bare required or optional domain chosen by the author', () => {
const draft = createDraft(event([['requires', 'gamepad']]))
expect(buildMigration(draft).tags).toContainEqual(['R', 'gamepad'])
draft.capabilities.find((capability) => capability.name === 'gamepad')!.optional = true
const next = buildMigration(draft)
expect(next.tags).toContainEqual(['O', 'gamepad'])
expect(next.tags).not.toContainEqual(['R', 'gamepad'])
const current = createDraft(event([['O', 'gamepad']]))
expect(buildMigration(current).tags).toContainEqual(['O', 'gamepad'])
})
it('allows overriding theme and required API defaults', () => {
const d = createDraft(event())
d.capabilities.forEach((c) => (c.optional = !c.optional))
Expand Down
Loading