Hub

Wippy Hub モジュールカタログへの読み取り専用アクセス。モジュールの一覧取得、検索、メタデータ・バージョン・依存関係・README の取得を行います。

読み込み

local hub = require("hub")

呼び出しごとのオプション

すべての呼び出しはオプションテーブルを受け取れます。すべての呼び出しに共通するキー：

キー	型	説明
`registry`	string	レジストリ URL の上書き
`token`	string	API トークンの上書き
`timeout`	duration/number	リクエストのタイムアウト（例: `"3m"` または秒数）

ページネーション対応の呼び出しでは page と page_size も指定できます。

モジュール

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 }

関数	説明
`hub.modules.list(opts?)`	フィルタでモジュールを一覧表示
`hub.modules.search(query, opts?)`	クエリ文字列で検索
`hub.modules.get(module, opts?)`	`org/name` またはモジュール id でモジュールを取得
`hub.modules.readme(module, opts?)`	README を取得。`{content, filename, version}` を返す

List/Search オプション

オプション	値
`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)	文字列の配列
`license` (search)	string
`include_deprecated` (search)	boolean

README

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

version オプションにはバージョン文字列、または {id, version, label} のようなテーブルを渡せます。

バージョン

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")

関数	説明
`hub.versions.list(module, opts?)`	モジュールのバージョン一覧
`hub.versions.get(module, version, opts?)`	特定のバージョンを取得
`hub.versions.inspect(module, version, opts?)`	バージョンのアーティファクトを検査（バンドルをダウンロードして読み取る）
`hub.versions.open(module, version, opts?)`	バージョンのアーティファクトをパッケージハンドルとして開く

パッケージハンドル

hub.versions.open はアーティファクトをダウンロードし、version、digest、packed フィールドを持つハンドルを返します：

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()

メソッド	説明
`pkg:metadata()`	パックのメタデータマップ
`pkg:entries(opts?)`	アーティファクト内のレジストリエントリ。`opts.kind` でフィルタ、`opts.include_data`（デフォルト true）で `data` フィールドを制御
`pkg:resources()`	埋め込みリソースの一覧
`pkg:fs(resource)`	埋め込みリソースのファイルシステムハンドル
`pkg:close()`	ハンドルを解放

エントリの data は生のまま返されます — ${env:...} 参照は解決されません。

依存関係

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

関数	説明
`hub.dependencies.get(module, version?, opts?)`	モジュールバージョンの依存関係
`hub.dependents.get(module, opts?)`	このモジュールに依存するモジュール

ファイル

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

関数	説明
`hub.files.list(module, version, opts?)`	バージョンのファイル一覧（`version` は必須）。`{items, total, page, page_size}` を返す

認証

実行中のプロセスにレジストリトークンをプッシュします — すべてのハブ利用側が次回の呼び出しから、再起動なしでそのトークンを使用します：

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()

関数	説明
`hub.auth.authenticate(token, registry?)`	トークンをレジストリに対して検証し、成功時にランタイムのオーバーライドとしてインストール
`hub.auth.status(registry?)`	現在の認証情報をライブ検証
`hub.auth.logout(registry?)`	ランタイムのトークンオーバーライドをクリア

status には authenticated、registry、orgs が含まれます。アイデンティティフィールド（username、user_id、scope、expires_at、expired）は認証済みの場合にのみ存在します。検証に失敗したトークンは保存されず、authenticate は authenticated = false を返します。このオーバーライドは WIPPY_TOKEN および保存済みの認証情報より優先されます。

権限: hub.auth.authenticate、hub.auth.status、hub.auth.logout

Hub