Files
grimoire/src/lib/req-parser.ts
Alejandro Gómez 3346a2077d feat(req): add --view flag for list/compact display mode
- Add -v, --view <list|compact> flag to req command
- Remove UI toggle controls from ReqViewer header
- View mode is now set via command flag instead of runtime toggle
- Update man page with new flag documentation and example

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-21 20:29:32 +01:00

618 lines
18 KiB
TypeScript

import { nip19 } from "nostr-tools";
import type { NostrFilter } from "@/types/nostr";
import { isNip05 } from "./nip05";
import {
isValidHexPubkey,
isValidHexEventId,
normalizeHex,
} from "./nostr-validation";
import { normalizeRelayURL } from "./relay-url";
export type ViewMode = "list" | "compact";
export interface ParsedReqCommand {
filter: NostrFilter;
relays?: string[];
closeOnEose?: boolean;
view?: ViewMode; // Display mode for results
nip05Authors?: string[]; // NIP-05 identifiers that need async resolution
nip05PTags?: string[]; // NIP-05 identifiers for #p tags that need async resolution
nip05PTagsUppercase?: string[]; // NIP-05 identifiers for #P tags that need async resolution
needsAccount?: boolean; // True if filter contains $me or $contacts aliases
}
/**
* Parse comma-separated values and apply a parser function to each
* Returns true if at least one value was successfully parsed
*/
function parseCommaSeparated<T>(
value: string,
parser: (v: string) => T | null,
target: Set<T>,
): boolean {
const values = value.split(",").map((v) => v.trim());
let addedAny = false;
for (const val of values) {
if (!val) continue;
const parsed = parser(val);
if (parsed !== null) {
target.add(parsed);
addedAny = true;
}
}
return addedAny;
}
/**
* Parse REQ command arguments into a Nostr filter
* Supports:
* - Filters: -k (kinds), -a (authors: hex/npub/nprofile/NIP-05), -l (limit), -e (note/nevent/naddr/hex), -p (#p: hex/npub/nprofile/NIP-05), -P (#P: hex/npub/nprofile/NIP-05), -t (#t), -d (#d), --tag/-T (any #tag)
* - Time: --since, --until
* - Search: --search
* - Relays: wss://relay.com or relay.com (auto-adds wss://), relay hints from nprofile/nevent/naddr are automatically extracted
* - Options: --close-on-eose (close stream after EOSE, default: stream stays open)
*/
export function parseReqCommand(args: string[]): ParsedReqCommand {
const filter: NostrFilter = {};
const relays: string[] = [];
const nip05Authors = new Set<string>();
const nip05PTags = new Set<string>();
const nip05PTagsUppercase = new Set<string>();
// Use sets for deduplication during accumulation
const kinds = new Set<number>();
const authors = new Set<string>();
const ids = new Set<string>(); // For filter.ids (direct event lookup)
const eventIds = new Set<string>(); // For filter["#e"] (tag-based event lookup)
const aTags = new Set<string>(); // For filter["#a"] (coordinate-based lookup)
const pTags = new Set<string>();
const pTagsUppercase = new Set<string>();
const tTags = new Set<string>();
const dTags = new Set<string>();
// Map for arbitrary single-letter tags: letter -> Set<value>
const genericTags = new Map<string, Set<string>>();
let closeOnEose = false;
let view: ViewMode | undefined;
let i = 0;
while (i < args.length) {
const arg = args[i];
// Relay URLs (starts with wss://, ws://, or looks like a domain)
if (arg.startsWith("wss://") || arg.startsWith("ws://")) {
relays.push(normalizeRelayURL(arg));
i++;
continue;
}
// Shorthand relay (domain-like string without protocol)
if (isRelayDomain(arg)) {
relays.push(normalizeRelayURL(arg));
i++;
continue;
}
// Flags
if (arg.startsWith("-")) {
const flag = arg;
const nextArg = args[i + 1];
switch (flag) {
case "-k":
case "--kind": {
// Support comma-separated kinds: -k 1,3,7
if (!nextArg) {
i++;
break;
}
const addedAny = parseCommaSeparated(
nextArg,
(v) => {
const kind = parseInt(v, 10);
return isNaN(kind) ? null : kind;
},
kinds,
);
i += addedAny ? 2 : 1;
break;
}
case "-a":
case "--author": {
// Support comma-separated authors: -a npub1...,npub2...,user@domain.com,$me,$contacts
if (!nextArg) {
i++;
break;
}
let addedAny = false;
const values = nextArg.split(",").map((a) => a.trim());
for (const authorStr of values) {
if (!authorStr) continue;
// Check for $me and $contacts aliases (case-insensitive)
const normalized = authorStr.toLowerCase();
if (normalized === "$me" || normalized === "$contacts") {
authors.add(normalized);
addedAny = true;
} else if (isNip05(authorStr)) {
// Check if it's a NIP-05 identifier
nip05Authors.add(authorStr);
addedAny = true;
} else {
const result = parseNpubOrHex(authorStr);
if (result.pubkey) {
authors.add(result.pubkey);
addedAny = true;
// Add relay hints from nprofile (normalized)
if (result.relays) {
relays.push(...result.relays.map(normalizeRelayURL));
}
}
}
}
i += addedAny ? 2 : 1;
break;
}
case "-l":
case "--limit": {
const limit = parseInt(nextArg, 10);
if (!isNaN(limit)) {
filter.limit = limit;
i += 2;
} else {
i++;
}
break;
}
case "-e": {
// Support comma-separated event identifiers: -e note1...,nevent1...,naddr1...,hex
if (!nextArg) {
i++;
break;
}
let addedAny = false;
const values = nextArg.split(",").map((v) => v.trim());
for (const val of values) {
if (!val) continue;
const parsed = parseEventIdentifier(val);
if (parsed) {
// Route to appropriate filter field based on type
if (parsed.type === "direct-event") {
ids.add(parsed.value);
} else if (parsed.type === "direct-address") {
aTags.add(parsed.value);
} else if (parsed.type === "tag-event") {
eventIds.add(parsed.value);
}
// Collect relay hints
if (parsed.relays) {
relays.push(...parsed.relays);
}
addedAny = true;
}
}
i += addedAny ? 2 : 1;
break;
}
case "-p": {
// Support comma-separated pubkeys: -p npub1...,npub2...,user@domain.com,$me,$contacts
if (!nextArg) {
i++;
break;
}
let addedAny = false;
const values = nextArg.split(",").map((p) => p.trim());
for (const pubkeyStr of values) {
if (!pubkeyStr) continue;
// Check for $me and $contacts aliases (case-insensitive)
const normalized = pubkeyStr.toLowerCase();
if (normalized === "$me" || normalized === "$contacts") {
pTags.add(normalized);
addedAny = true;
} else if (isNip05(pubkeyStr)) {
// Check if it's a NIP-05 identifier
nip05PTags.add(pubkeyStr);
addedAny = true;
} else {
const result = parseNpubOrHex(pubkeyStr);
if (result.pubkey) {
pTags.add(result.pubkey);
addedAny = true;
// Add relay hints from nprofile (normalized)
if (result.relays) {
relays.push(...result.relays.map(normalizeRelayURL));
}
}
}
}
i += addedAny ? 2 : 1;
break;
}
case "-P": {
// Uppercase P tag (e.g., zap sender in kind 9735)
// Support comma-separated pubkeys: -P npub1...,npub2...,$me,$contacts
if (!nextArg) {
i++;
break;
}
let addedAny = false;
const values = nextArg.split(",").map((p) => p.trim());
for (const pubkeyStr of values) {
if (!pubkeyStr) continue;
// Check for $me and $contacts aliases (case-insensitive)
const normalized = pubkeyStr.toLowerCase();
if (normalized === "$me" || normalized === "$contacts") {
pTagsUppercase.add(normalized);
addedAny = true;
} else if (isNip05(pubkeyStr)) {
// Check if it's a NIP-05 identifier
nip05PTagsUppercase.add(pubkeyStr);
addedAny = true;
} else {
const result = parseNpubOrHex(pubkeyStr);
if (result.pubkey) {
pTagsUppercase.add(result.pubkey);
addedAny = true;
// Add relay hints from nprofile (normalized)
if (result.relays) {
relays.push(...result.relays.map(normalizeRelayURL));
}
}
}
}
i += addedAny ? 2 : 1;
break;
}
case "-t": {
// Support comma-separated hashtags: -t nostr,bitcoin,lightning
if (nextArg) {
const addedAny = parseCommaSeparated(
nextArg,
(v) => v, // hashtags are already strings
tTags,
);
i += addedAny ? 2 : 1;
} else {
i++;
}
break;
}
case "-d": {
// Support comma-separated d-tags: -d article1,article2,article3
if (nextArg) {
const addedAny = parseCommaSeparated(
nextArg,
(v) => v, // d-tags are already strings
dTags,
);
i += addedAny ? 2 : 1;
} else {
i++;
}
break;
}
case "--since": {
const timestamp = parseTimestamp(nextArg);
if (timestamp) {
filter.since = timestamp;
i += 2;
} else {
i++;
}
break;
}
case "--until": {
const timestamp = parseTimestamp(nextArg);
if (timestamp) {
filter.until = timestamp;
i += 2;
} else {
i++;
}
break;
}
case "--search": {
if (nextArg) {
filter.search = nextArg;
i += 2;
} else {
i++;
}
break;
}
case "--close-on-eose": {
closeOnEose = true;
i++;
break;
}
case "--view":
case "-v": {
if (nextArg === "list" || nextArg === "compact") {
view = nextArg;
i += 2;
} else {
i++;
}
break;
}
case "-T":
case "--tag": {
// Generic tag filter: --tag <letter> <value>
// Supports comma-separated values: --tag a val1,val2
if (!nextArg) {
i++;
break;
}
// Next arg should be the single letter
const letter = nextArg;
const valueArg = args[i + 2];
// Validate: must be single letter
if (letter.length !== 1 || !valueArg) {
i++;
break;
}
// Get or create Set for this tag letter
let tagSet = genericTags.get(letter);
if (!tagSet) {
tagSet = new Set<string>();
genericTags.set(letter, tagSet);
}
// Parse comma-separated values
const addedAny = parseCommaSeparated(
valueArg,
(v) => v, // tag values are already strings
tagSet,
);
i += addedAny ? 3 : 1;
break;
}
default:
i++;
break;
}
} else {
i++;
}
}
// Convert accumulated sets to filter arrays (with deduplication)
if (kinds.size > 0) filter.kinds = Array.from(kinds);
if (authors.size > 0) filter.authors = Array.from(authors);
if (ids.size > 0) filter.ids = Array.from(ids);
if (eventIds.size > 0) filter["#e"] = Array.from(eventIds);
if (aTags.size > 0) filter["#a"] = Array.from(aTags);
if (pTags.size > 0) filter["#p"] = Array.from(pTags);
if (pTagsUppercase.size > 0) filter["#P"] = Array.from(pTagsUppercase);
if (tTags.size > 0) filter["#t"] = Array.from(tTags);
if (dTags.size > 0) filter["#d"] = Array.from(dTags);
// Convert generic tags to filter
for (const [letter, tagSet] of genericTags.entries()) {
if (tagSet.size > 0) {
(filter as any)[`#${letter}`] = Array.from(tagSet);
}
}
// Check if filter contains $me or $contacts aliases
const needsAccount =
filter.authors?.some((a) => a === "$me" || a === "$contacts") ||
filter["#p"]?.some((p) => p === "$me" || p === "$contacts") ||
filter["#P"]?.some((p) => p === "$me" || p === "$contacts") ||
false;
return {
filter,
relays: relays.length > 0 ? relays : undefined,
closeOnEose,
view,
nip05Authors: nip05Authors.size > 0 ? Array.from(nip05Authors) : undefined,
nip05PTags: nip05PTags.size > 0 ? Array.from(nip05PTags) : undefined,
nip05PTagsUppercase:
nip05PTagsUppercase.size > 0
? Array.from(nip05PTagsUppercase)
: undefined,
needsAccount,
};
}
/**
* Check if a string looks like a relay domain
* Must contain a dot and not be a flag
*/
function isRelayDomain(value: string): boolean {
if (!value || value.startsWith("-")) return false;
// Must contain at least one dot and look like a domain
return /^[a-zA-Z0-9][\w.-]+\.[a-zA-Z]{2,}(:\d+)?(\/.*)?$/.test(value);
}
/**
* Parse timestamp - supports unix timestamp, relative time (1s, 30m, 2h, 7d, 2w, 3mo, 1y), or "now"
*/
function parseTimestamp(value: string): number | null {
if (!value) return null;
// Special keyword: "now" - current timestamp
if (value.toLowerCase() === "now") {
return Math.floor(Date.now() / 1000);
}
// Unix timestamp (10 digits)
if (/^\d{10}$/.test(value)) {
return parseInt(value, 10);
}
// Relative time: 30s, 1m, 2h, 7d, 2w, 3mo, 1y
// Note: Using alternation to support multi-character units like "mo"
const relativeMatch = value.match(/^(\d+)(s|m|h|d|w|mo|y)$/);
if (relativeMatch) {
const amount = parseInt(relativeMatch[1], 10);
const unit = relativeMatch[2];
const now = Math.floor(Date.now() / 1000);
const multipliers: Record<string, number> = {
s: 1,
m: 60,
h: 3600,
d: 86400,
w: 604800,
mo: 2592000, // 30 days (approximate month)
y: 31536000, // 365 days (approximate year)
};
return now - amount * multipliers[unit];
}
return null;
}
/**
* Parse npub, nprofile, or hex pubkey
* Returns pubkey and optional relay hints from nprofile
*/
function parseNpubOrHex(value: string): {
pubkey: string | null;
relays?: string[];
} {
if (!value) return { pubkey: null };
// Try to decode npub or nprofile
if (value.startsWith("npub") || value.startsWith("nprofile")) {
try {
const decoded = nip19.decode(value);
if (decoded.type === "npub") {
return { pubkey: decoded.data };
}
if (decoded.type === "nprofile") {
return {
pubkey: decoded.data.pubkey,
relays: decoded.data.relays,
};
}
} catch {
// Not valid npub/nprofile, continue
}
}
// Check if it's hex pubkey
if (isValidHexPubkey(value)) {
return { pubkey: normalizeHex(value) };
}
return { pubkey: null };
}
interface ParsedEventIdentifier {
type: "direct-event" | "direct-address" | "tag-event";
value: string;
relays?: string[];
}
/**
* Parse event identifier - supports note, nevent, naddr, and hex event ID
*/
function parseEventIdentifier(value: string): ParsedEventIdentifier | null {
if (!value) return null;
// nevent: direct event lookup with relay hints
if (value.startsWith("nevent")) {
try {
const decoded = nip19.decode(value);
if (decoded.type === "nevent") {
return {
type: "direct-event",
value: decoded.data.id,
relays: decoded.data.relays
?.map((url) => {
try {
return normalizeRelayURL(url);
} catch {
return null;
}
})
.filter((url): url is string => url !== null),
};
}
} catch {
// Not valid nevent, continue
}
}
// naddr: coordinate-based lookup with relay hints
if (value.startsWith("naddr")) {
try {
const decoded = nip19.decode(value);
if (decoded.type === "naddr") {
const coordinate = `${decoded.data.kind}:${decoded.data.pubkey}:${decoded.data.identifier}`;
return {
type: "direct-address",
value: coordinate,
relays: decoded.data.relays
?.map((url) => {
try {
return normalizeRelayURL(url);
} catch {
return null;
}
})
.filter((url): url is string => url !== null),
};
}
} catch {
// Not valid naddr, continue
}
}
// note1: tag-based filtering (existing behavior)
if (value.startsWith("note")) {
try {
const decoded = nip19.decode(value);
if (decoded.type === "note") {
return {
type: "tag-event",
value: decoded.data,
};
}
} catch {
// Not valid note, continue
}
}
// Hex: tag-based filtering (existing behavior)
if (isValidHexEventId(value)) {
return {
type: "tag-event",
value: normalizeHex(value),
};
}
return null;
}