Hub

Schreibgeschützter Zugriff auf den Wippy Hub-Modulkatalog: Module auflisten, suchen, Metadaten, Versionen, Abhängigkeiten und READMEs abrufen.

Laden

local hub = require("hub")

Optionen pro Aufruf

Jeder Aufruf akzeptiert eine optionale Optionstabelle. Schlüssel, die für alle Aufrufe gelten:

Schlüssel	Typ	Beschreibung
`registry`	string	Überschreibt die Registry-URL
`token`	string	Überschreibt das API-Token
`timeout`	duration/number	Anfrage-Timeout (z. B. `"3m"` oder Sekunden)

Aufrufe mit Paginierungsunterstützung akzeptieren zusätzlich page und page_size.

Module

local result, err = hub.modules.list({
    org = "wippy",
    visibility = "public",
    type = "library",
    sort_order = "downloads_desc",
    page = 1,
    page_size = 20,
})
-- result = { items, total, page, page_size }

Funktion	Beschreibung
`hub.modules.list(opts?)`	Module mit Filtern auflisten
`hub.modules.search(query, opts?)`	Nach Suchbegriff suchen
`hub.modules.get(module, opts?)`	Modul nach `org/name` oder Modul-ID abrufen
`hub.modules.readme(module, opts?)`	README abrufen; gibt `{content, filename, version}` zurück

Optionen für List/Search

Option	Werte
`organization_id` / `org`	string
`visibility`	`public`, `private`, `internal`
`type`	`library`, `application`, `agent`, `plugin`
`sort_order`	`name_asc`, `name_desc`, `created_desc`, `updated_desc`, `downloads_desc`
`keywords` (search)	Array von Strings
`license` (search)	string
`include_deprecated` (search)	boolean

README

local readme, err = hub.modules.readme("wippy/terminal", {
    version = "1.2.3"
})
print(readme.content)

Die Option version akzeptiert entweder einen Versionsstring oder eine Tabelle wie {id, version, label}.

Versionen

local versions, err = hub.versions.list("wippy/terminal", {
    include_yanked = false,
    page_size = 50,
})

local v, err = hub.versions.get("wippy/terminal", "1.0.0")

Funktion	Beschreibung
`hub.versions.list(module, opts?)`	Versionen eines Moduls auflisten
`hub.versions.get(module, version, opts?)`	Eine bestimmte Version abrufen
`hub.versions.inspect(module, version, opts?)`	Das Artefakt einer Version inspizieren (lädt das Bundle herunter und liest es)
`hub.versions.open(module, version, opts?)`	Das Artefakt einer Version als Package-Handle öffnen

Package-Handle

hub.versions.open lädt das Artefakt herunter und gibt ein Handle mit den Feldern version, digest, packed zurück:

local pkg, err = hub.versions.open("wippy/terminal", "1.2.3")

local entries, err = pkg:entries({
    kind = "function.lua",       -- string or string[], omit for all kinds
    include_data = false,        -- default true
})
-- each entry: { id = "ns:name", kind = "...", meta = {...}, data = <any> }

pkg:close()

Methode	Beschreibung
`pkg:metadata()`	Pack-Metadaten-Map
`pkg:entries(opts?)`	Registry-Einträge im Artefakt; `opts.kind` filtert, `opts.include_data` (Standard true) steuert das `data`-Feld
`pkg:resources()`	Liste eingebetteter Ressourcen
`pkg:fs(resource)`	Dateisystem-Handle für eine eingebettete Ressource
`pkg:close()`	Handle freigeben

Entry-data wird roh zurückgegeben — ${env:...}-Referenzen werden nicht aufgelöst.

Abhängigkeiten

local deps, err = hub.dependencies.get("wippy/terminal", "1.0.0")
local users, err = hub.dependents.get("wippy/terminal")

Funktion	Beschreibung
`hub.dependencies.get(module, version?, opts?)`	Abhängigkeiten einer Modulversion
`hub.dependents.get(module, opts?)`	Module, die von diesem abhängen

Dateien

local files, err = hub.files.list("wippy/terminal", "1.0.0")

Funktion	Beschreibung
`hub.files.list(module, version, opts?)`	Dateien einer Version auflisten (`version` erforderlich); gibt `{items, total, page, page_size}` zurück

Authentifizierung

Ein Registry-Token in den laufenden Prozess einspeisen — jeder Hub-Konsument übernimmt es beim nächsten Aufruf, ohne Neustart:

local status, err = hub.auth.authenticate("wpy_xxx")          -- default registry
local status, err = hub.auth.authenticate("wpy_xxx", "https://hub.example.com")

local status, err = hub.auth.status()
local ok, err = hub.auth.logout()

Funktion	Beschreibung
`hub.auth.authenticate(token, registry?)`	Das Token gegen die Registry validieren und bei Erfolg als Runtime-Override installieren
`hub.auth.status(registry?)`	Die aktuelle Zugangsberechtigung live validieren
`hub.auth.logout(registry?)`	Das Runtime-Token-Override löschen

status enthält authenticated, registry und orgs; Identitätsfelder (username, user_id, scope, expires_at, expired) sind nur vorhanden, wenn authentifiziert. Ein Token, das die Validierung nicht besteht, wird nicht gespeichert — authenticate gibt authenticated = false zurück. Das Override hat Vorrang vor WIPPY_TOKEN und gespeicherten Zugangsdaten.

Berechtigungen: hub.auth.authenticate, hub.auth.status, hub.auth.logout

Siehe auch

CLI Reference — wippy readme, wippy search, wippy publish
Publishing Guide