Something went wrong. Try again.
A lexicon-driven AppView for ATProto.
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207export interface HoverEntry { signature: string; description: string; module?: string;}
export const HOVER_DOCS = new Map<string, HoverEntry>([ // ── Lua keywords ────────────────────────────────────────────────────── ["and", { signature: "and", description: "Logical AND operator — returns first falsy operand or last operand" }], ["break", { signature: "break", description: "Exit the innermost loop" }], ["do", { signature: "do ... end", description: "Block delimiter — creates a new scope" }], ["else", { signature: "else", description: "Alternative branch in an if statement" }], ["elseif", { signature: "elseif condition then", description: "Additional condition branch in an if statement" }], ["end", { signature: "end", description: "Closes a block (function, if, for, while, do)" }], ["false", { signature: "false", description: "Boolean false value" }], ["for", { signature: "for var = start, stop [, step] do ... end", description: "Numeric or generic loop" }], ["function", { signature: "function name(...) ... end", description: "Define a function" }], ["goto", { signature: "goto label", description: "Jump to a label within the same block" }], ["if", { signature: "if condition then ... end", description: "Conditional branch" }], ["in", { signature: "in", description: "Iterator separator in generic for loops" }], ["local", { signature: "local name [= value]", description: "Declare a local variable" }], ["nil", { signature: "nil", description: "The nil value — represents absence of a value" }], ["not", { signature: "not", description: "Logical NOT operator" }], ["or", { signature: "or", description: "Logical OR operator — returns first truthy operand or last operand" }], ["repeat", { signature: "repeat ... until condition", description: "Loop that runs at least once" }], ["return", { signature: "return [values]", description: "Return values from a function" }], ["then", { signature: "then", description: "Begins the body of an if/elseif branch" }], ["true", { signature: "true", description: "Boolean true value" }], ["until", { signature: "until condition", description: "End condition of a repeat loop" }], ["while", { signature: "while condition do ... end", description: "Loop while condition is true" }],
// ── Global builtins ─────────────────────────────────────────────────── ["print", { signature: "print(···)", description: "Print values to stdout (separated by tabs)" }], ["tostring", { signature: "tostring(v)", description: "Convert any value to a string" }], ["tonumber", { signature: "tonumber(e [, base])", description: "Convert a value to a number, or nil if not convertible" }], ["type", { signature: "type(v)", description: "Returns the type of a value as a string" }], ["pairs", { signature: "pairs(t)", description: "Returns an iterator over all key-value pairs in a table" }], ["ipairs", { signature: "ipairs(t)", description: "Returns an iterator over integer-keyed elements (1, 2, ...)" }], ["next", { signature: "next(table [, index])", description: "Returns the next key-value pair after the given key" }], ["select", { signature: "select(index, ···)", description: "Returns arguments after the given index, or count with '#'" }], ["unpack", { signature: "unpack(list [, i [, j]])", description: "Returns elements from a table (alias for table.unpack)" }], ["error", { signature: "error(message [, level])", description: "Raise an error with a message" }], ["pcall", { signature: "pcall(f [, arg1, ···])", description: "Call a function in protected mode — returns ok, result" }], ["xpcall", { signature: "xpcall(f, msgh [, arg1, ···])", description: "Like pcall but with a custom error handler" }], ["assert", { signature: "assert(v [, message])", description: "Raise an error if v is falsy" }], ["setmetatable", { signature: "setmetatable(table, metatable)", description: "Set the metatable for a table" }], ["getmetatable", { signature: "getmetatable(object)", description: "Returns the metatable of an object, or nil" }], ["rawget", { signature: "rawget(table, index)", description: "Get a value without invoking __index metamethod" }], ["rawset", { signature: "rawset(table, index, value)", description: "Set a value without invoking __newindex metamethod" }], ["rawequal", { signature: "rawequal(v1, v2)", description: "Check equality without invoking __eq metamethod" }],
// ── HappyView sandbox globals ───────────────────────────────────────── ["input", { signature: "input", description: "Procedure input table (from request body)" }], ["params", { signature: "params", description: "Query parameters table (from URL query string)" }], ["caller_did", { signature: "caller_did", description: "DID of the authenticated caller (nil for unauthenticated queries)" }], ["collection", { signature: "collection", description: "Target collection NSID for this lexicon" }], ["method", { signature: "method", description: "XRPC method name being called" }], ["env", { signature: "env", description: "Script variables table (configured per-lexicon in the dashboard)" }], ["now", { signature: "now()", description: "Current UTC timestamp as ISO 8601 string" }], ["log", { signature: "log(···)", description: "Log values to server console" }], ["TID", { signature: "TID()", description: "Generate a new TID (timestamp identifier)" }], ["toarray", { signature: "toarray(table)", description: "Mark a table as a JSON array for serialization (ensures empty tables serialize as [] not {})" }],
// ── Hook-specific globals ──────────────────────────────────────────── ["action", { signature: "action", description: "Hook action type — \"create\", \"update\", or \"delete\"" }], ["uri", { signature: "uri", description: "AT URI of the record being processed" }], ["did", { signature: "did", description: "DID of the repo owner" }], ["rkey", { signature: "rkey", description: "Record key of the record being processed" }], ["record", { signature: "record", description: "Record data table (nil on delete actions)" }],
// ── string module ───────────────────────────────────────────────────── ["string.byte", { signature: "string.byte(s [, i [, j]])", description: "Returns internal numeric codes of characters", module: "string" }], ["string.char", { signature: "string.char(···)", description: "Returns a string from character codes", module: "string" }], ["string.find", { signature: "string.find(s, pattern [, init [, plain]])", description: "Find first match of pattern in string", module: "string" }], ["string.format", { signature: "string.format(formatstring, ···)", description: "Format a string (like sprintf)", module: "string" }], ["string.gmatch", { signature: "string.gmatch(s, pattern)", description: "Returns an iterator for all pattern matches", module: "string" }], ["string.gsub", { signature: "string.gsub(s, pattern, repl [, n])", description: "Global substitution — replace pattern matches", module: "string" }], ["string.len", { signature: "string.len(s)", description: "Returns the byte length of a string", module: "string" }], ["string.lower", { signature: "string.lower(s)", description: "Returns lowercase copy of a string", module: "string" }], ["string.match", { signature: "string.match(s, pattern [, init])", description: "Find first match and return captures", module: "string" }], ["string.rep", { signature: "string.rep(s, n [, sep])", description: "Returns a repeated copy of a string", module: "string" }], ["string.reverse", { signature: "string.reverse(s)", description: "Returns reversed string", module: "string" }], ["string.sub", { signature: "string.sub(s, i [, j])", description: "Returns a substring", module: "string" }], ["string.upper", { signature: "string.upper(s)", description: "Returns uppercase copy of a string", module: "string" }],
// ── table module ────────────────────────────────────────────────────── ["table.concat", { signature: "table.concat(list [, sep [, i [, j]]])", description: "Concatenate table elements into a string", module: "table" }], ["table.insert", { signature: "table.insert(list, [pos,] value)", description: "Insert an element into a table", module: "table" }], ["table.move", { signature: "table.move(a1, f, e, t [, a2])", description: "Move elements between tables", module: "table" }], ["table.pack", { signature: "table.pack(···)", description: "Pack arguments into a table with n field", module: "table" }], ["table.remove", { signature: "table.remove(list [, pos])", description: "Remove an element from a table", module: "table" }], ["table.sort", { signature: "table.sort(list [, comp])", description: "Sort a table in-place", module: "table" }], ["table.unpack", { signature: "table.unpack(list [, i [, j]])", description: "Unpack table elements as multiple return values", module: "table" }],
// ── math module ─────────────────────────────────────────────────────── ["math.abs", { signature: "math.abs(x)", description: "Absolute value", module: "math" }], ["math.acos", { signature: "math.acos(x)", description: "Arc cosine (in radians)", module: "math" }], ["math.asin", { signature: "math.asin(x)", description: "Arc sine (in radians)", module: "math" }], ["math.atan", { signature: "math.atan(y [, x])", description: "Arc tangent of y/x (in radians)", module: "math" }], ["math.ceil", { signature: "math.ceil(x)", description: "Round up to nearest integer", module: "math" }], ["math.cos", { signature: "math.cos(x)", description: "Cosine (x in radians)", module: "math" }], ["math.deg", { signature: "math.deg(x)", description: "Convert radians to degrees", module: "math" }], ["math.exp", { signature: "math.exp(x)", description: "Returns e^x", module: "math" }], ["math.floor", { signature: "math.floor(x)", description: "Round down to nearest integer", module: "math" }], ["math.fmod", { signature: "math.fmod(x, y)", description: "Remainder of x / y", module: "math" }], ["math.huge", { signature: "math.huge", description: "Infinity value (HUGE_VAL)", module: "math" }], ["math.log", { signature: "math.log(x [, base])", description: "Logarithm of x in the given base (default: e)", module: "math" }], ["math.max", { signature: "math.max(x, ···)", description: "Returns the maximum value among arguments", module: "math" }], ["math.maxinteger", { signature: "math.maxinteger", description: "Maximum integer value (2^63 - 1)", module: "math" }], ["math.min", { signature: "math.min(x, ···)", description: "Returns the minimum value among arguments", module: "math" }], ["math.mininteger", { signature: "math.mininteger", description: "Minimum integer value (-2^63)", module: "math" }], ["math.modf", { signature: "math.modf(x)", description: "Returns integer and fractional parts of x", module: "math" }], ["math.pi", { signature: "math.pi", description: "Pi constant (3.14159...)", module: "math" }], ["math.rad", { signature: "math.rad(x)", description: "Convert degrees to radians", module: "math" }], ["math.random", { signature: "math.random([m [, n]])", description: "Generate a pseudo-random number", module: "math" }], ["math.randomseed", { signature: "math.randomseed([x [, y]])", description: "Set the random seed", module: "math" }], ["math.sin", { signature: "math.sin(x)", description: "Sine (x in radians)", module: "math" }], ["math.sqrt", { signature: "math.sqrt(x)", description: "Square root of x", module: "math" }], ["math.tan", { signature: "math.tan(x)", description: "Tangent (x in radians)", module: "math" }], ["math.tointeger", { signature: "math.tointeger(x)", description: "Convert to integer if possible, otherwise nil", module: "math" }], ["math.type", { signature: "math.type(x)", description: "Returns \"integer\", \"float\", or false", module: "math" }], ["math.ult", { signature: "math.ult(m, n)", description: "Unsigned integer less-than comparison", module: "math" }],
// ── coroutine module ────────────────────────────────────────────────── ["coroutine.create", { signature: "coroutine.create(f)", description: "Create a new coroutine from function f", module: "coroutine" }], ["coroutine.resume", { signature: "coroutine.resume(co [, val1, ···])", description: "Resume a suspended coroutine", module: "coroutine" }], ["coroutine.yield", { signature: "coroutine.yield(···)", description: "Suspend the running coroutine", module: "coroutine" }], ["coroutine.status", { signature: "coroutine.status(co)", description: "Returns coroutine status: \"running\", \"suspended\", \"normal\", or \"dead\"", module: "coroutine" }], ["coroutine.wrap", { signature: "coroutine.wrap(f)", description: "Create an iterator function from a coroutine", module: "coroutine" }], ["coroutine.isyieldable", { signature: "coroutine.isyieldable()", description: "Returns true if the running coroutine can yield", module: "coroutine" }], ["coroutine.running", { signature: "coroutine.running()", description: "Returns the running coroutine and a boolean (true if main)", module: "coroutine" }], ["coroutine.close", { signature: "coroutine.close(co)", description: "Close a coroutine and release its resources", module: "coroutine" }],
// ── utf8 module ─────────────────────────────────────────────────────── ["utf8.char", { signature: "utf8.char(···)", description: "Returns a UTF-8 string from codepoint values", module: "utf8" }], ["utf8.charpattern", { signature: "utf8.charpattern", description: "Pattern that matches exactly one UTF-8 character", module: "utf8" }], ["utf8.codepoint", { signature: "utf8.codepoint(s [, i [, j [, lax]]])", description: "Returns codepoint values of characters in a string", module: "utf8" }], ["utf8.codes", { signature: "utf8.codes(s [, lax])", description: "Returns an iterator over UTF-8 codepoints", module: "utf8" }], ["utf8.len", { signature: "utf8.len(s [, i [, j [, lax]]])", description: "Returns the number of UTF-8 characters in a string", module: "utf8" }], ["utf8.offset", { signature: "utf8.offset(s, n [, i])", description: "Returns the byte position of the nth UTF-8 character", module: "utf8" }],
// ── HappyView Record API ────────────────────────────────────────────── ["Record", { signature: "Record(collection)", description: "Create a new record for the given collection NSID" }], ["Record.load", { signature: "Record.load(uri)", description: "Load a record from the database by AT URI" }], ["Record.load_all", { signature: "Record.load_all({uri1, uri2, ...})", description: "Load multiple records from the database" }], ["Record.save_all", { signature: "Record.save_all({r1, r2, ...})", description: "Save multiple records in parallel" }], ["Record:save", { signature: "record:save()", description: "Save this record (creates or updates on PDS and database)" }], ["Record:delete", { signature: "record:delete()", description: "Delete this record from PDS and database" }], ["Record:set_key_type", { signature: "record:set_key_type(type)", description: "Set the record key type (tid, any, nsid, literal:*)" }], ["Record:set_rkey", { signature: "record:set_rkey(key)", description: "Set a specific rkey for this record" }], ["Record:set_repo", { signature: "record:set_repo(did)", description: "Override the repo DID (write to a different user's repo instead of caller_did)" }], ["Record:generate_rkey", { signature: "record:generate_rkey()", description: "Generate an rkey based on the record's _key_type" }],
// ── HappyView db API ────────────────────────────────────────────────── ["db.query", { signature: "db.query({collection, did?, limit?, offset?, cursor?, sort?, sortDirection?})", description: "Query records — returns {records, cursor?}", module: "db" }], ["db.get", { signature: "db.get(uri)", description: "Get a single record by AT URI — returns record or nil", module: "db" }], ["db.count", { signature: "db.count(collection [, did])", description: "Count records in a collection", module: "db" }], ["db.search", { signature: "db.search({collection, field, query, limit?})", description: "Search records by field value — returns {records}", module: "db" }], ["db.backlinks", { signature: "db.backlinks({collection, uri, did?, limit?, cursor?})", description: "Find records that reference a URI via record_refs — returns {records, cursor?}", module: "db" }], ["db.raw", { signature: "db.raw(sql [, params])", description: "Execute a raw SQL query — returns array of row tables. Can reach your own tables plus the record index and space data; HappyView's sensitive internal tables (secrets, auth, config) are blocked.", module: "db" }], ["db.backend", { signature: "db.backend()", description: "Returns the database backend — \"sqlite\" or \"postgres\"", module: "db" }],
// ── HappyView HTTP API ─────────────────────────────────────────────── ["http.get", { signature: "http.get(url [, options])", description: "HTTP GET request — returns {status, body, headers}", module: "http" }], ["http.post", { signature: "http.post(url [, options])", description: "HTTP POST request — returns {status, body, headers}", module: "http" }], ["http.put", { signature: "http.put(url [, options])", description: "HTTP PUT request — returns {status, body, headers}", module: "http" }], ["http.patch", { signature: "http.patch(url [, options])", description: "HTTP PATCH request — returns {status, body, headers}", module: "http" }], ["http.delete", { signature: "http.delete(url [, options])", description: "HTTP DELETE request — returns {status, body, headers}", module: "http" }], ["http.head", { signature: "http.head(url [, options])", description: "HTTP HEAD request — returns {status, headers}", module: "http" }],
// ── HappyView XRPC API ────────────────────────────────────────────── ["xrpc.query", { signature: "xrpc.query(method [, params])", description: "Make an XRPC query to a PDS — returns {status, body} where body is JSON string", module: "xrpc" }], ["xrpc.procedure", { signature: "xrpc.procedure(method, input [, params])", description: "Make an XRPC procedure call (requires caller_did) — returns {status, body}", module: "xrpc" }],
// ── HappyView AT Protocol API ──────────────────────────────────────── ["atproto.resolve_service_endpoint", { signature: "atproto.resolve_service_endpoint(did)", description: "Resolve a DID to its PDS endpoint URL — returns string or nil", module: "atproto" }], ["atproto.get_labels", { signature: "atproto.get_labels(uri)", description: "Get labels for a URI — returns array of {src, uri, val, cts}", module: "atproto" }], ["atproto.get_labels_batch", { signature: "atproto.get_labels_batch({uri1, uri2, ...})", description: "Get labels for multiple URIs — returns table keyed by URI", module: "atproto" }], ["atproto.sign", { signature: "atproto.sign(record)", description: "Sign a record (requires attestation signer, procedure scripts only) — returns signature object", module: "atproto" }], ["atproto.verify_signature", { signature: "atproto.verify_signature(record, sig, repo_did)", description: "Verify a record signature — returns boolean", module: "atproto" }],
// ── HappyView Spaces API ──────────────────────────────────────────── // Note: hover lookup keys on the immediate `<prefix>.<word>` pair, not the // full dotted path — so these are keyed as `spaces.*`, matching how a // hover on `is_member` in `atproto.spaces.is_member` is resolved. ["atproto.spaces", { signature: "atproto.spaces", description: "Permissioned Spaces sub-table", module: "atproto" }], ["spaces.is_member", { signature: "atproto.spaces.is_member(space_uri, did)", description: "Whether did is a member of the space — returns boolean", module: "atproto" }], ["spaces.get_access", { signature: "atproto.spaces.get_access(space_uri, did)", description: "Member's access level — returns 'read' | 'write' | nil", module: "atproto" }], ["spaces.list_members", { signature: "atproto.spaces.list_members(space_uri)", description: "List resolved members — returns array of {did, access}", module: "atproto" }], ["spaces.query", { signature: "atproto.spaces.query({space_uri, collection?, limit?, cursor?})", description: "List records in a space — returns {records, cursor}", module: "atproto" }], ["spaces.get", { signature: "atproto.spaces.get(space_uri)", description: "Look up a space — returns a Space handle or nil (requires caller_did to write)", module: "atproto" }], ["spaces.create", { signature: "atproto.spaces.create({type, skey, display_name?, ...})", description: "Create a space (requires caller_did) — returns a Space handle", module: "atproto" }], ["spaces.accept_invite", { signature: "atproto.spaces.accept_invite({token})", description: "Redeem an invite token and join a space (requires caller_did) — returns a Space handle", module: "atproto" }], ["Space:write_record", { signature: "space:write_record({collection, record})", description: "Create a record with an auto-generated rkey — returns {uri, cid}" }], ["Space:put_record", { signature: "space:put_record({collection, rkey, record, swap_cid?})", description: "Create or overwrite a record at a specific rkey — returns {uri, cid}" }], ["Space:delete_record", { signature: "space:delete_record({collection, rkey, swap_cid?})", description: "Delete a record (author-ownership-only) — returns true" }], ["Space:add_member", { signature: "space:add_member({did, access?, is_delegation?})", description: "Add a member (space-admin only) — returns {did, access}" }], ["Space:remove_member", { signature: "space:remove_member({did})", description: "Remove a member (space-admin only) — returns true" }], ["Space:members", { signature: "space:members()", description: "List resolved members — returns array of {did, access}" }], ["Space:is_member", { signature: "space:is_member(did)", description: "Whether did is a member — returns boolean" }], ["Space:access", { signature: "space:access(did)", description: "Member's access level — returns 'read' | 'write' | nil" }], ["Space:update", { signature: "space:update({display_name?, description?, mint_policy?, app_access?, managing_app_did?, config?})", description: "Update space metadata (space-admin only) — returns true" }], ["Space:delete", { signature: "space:delete()", description: "Delete the space (space-admin only) — returns true" }], ["Space:query", { signature: "space:query({collection?, limit?, cursor?})", description: "List records in the space — returns {records, cursor}" }], ["Space:create_invite", { signature: "space:create_invite({access?, max_uses?, expires_at?})", description: "Create an invite token (space-admin only) — returns {invite_id, token, access, max_uses, expires_at}" }],]);