The manifest covers components, pages, vendors and menu — config.yml is a more accurate name. Updated build.sh (both project and template), router.js comment, and README. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Signed-off-by: GnomeZworc <nicolas.boufidjeline@g3e.fr>
333 lines
14 KiB
Bash
Executable file
333 lines
14 KiB
Bash
Executable file
#!/usr/bin/env bash
|
|
# Build the web UI component set from config.yml.
|
|
#
|
|
# ./build.sh build (download remote components + generate components.json)
|
|
# ./build.sh --check validate manifest and entry files without downloading
|
|
#
|
|
# Reads config.yml, downloads each remote component into components/<name>/
|
|
# at the requested ref, then generates components.json (runtime load list) and
|
|
# components.lock.json (resolved commit pins).
|
|
#
|
|
# Dependencies: yq (mikefarah/yq v4), jq, curl
|
|
# Optional env:
|
|
# GIT_TOKEN forge token for private repos (sent as "Authorization: token …")
|
|
|
|
set -euo pipefail
|
|
|
|
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
|
|
WEB_DIR="${SCRIPT_DIR}/sources"
|
|
MANIFEST="${SCRIPT_DIR}/config.yml"
|
|
COMPONENTS_DIR="${WEB_DIR}/components"
|
|
OUTPUT="${WEB_DIR}/components.json"
|
|
LOCKFILE="${WEB_DIR}/components.lock.json"
|
|
GIT_TOKEN="${GIT_TOKEN:-}"
|
|
|
|
RED='\033[0;31m'; GREEN='\033[0;32m'; YELLOW='\033[1;33m'; BLUE='\033[0;34m'; NC='\033[0m'
|
|
log() { echo -e "${GREEN}[+]${NC} $*"; }
|
|
warn() { echo -e "${YELLOW}[!]${NC} $*"; }
|
|
info() { echo -e "${BLUE}[i]${NC} $*"; }
|
|
die() { echo -e "${RED}[-]${NC} $*" >&2; exit 1; }
|
|
|
|
CHECK_ONLY=false
|
|
[[ "${1:-}" == "--check" ]] && CHECK_ONLY=true
|
|
|
|
# ── Dependency + manifest guards ────────────────────────────────────────────────
|
|
|
|
command -v yq &>/dev/null || die "yq is required (mikefarah/yq v4)"
|
|
command -v jq &>/dev/null || die "jq is required"
|
|
command -v curl &>/dev/null || die "curl is required"
|
|
[[ -f "$MANIFEST" ]] || die "manifest not found: $MANIFEST"
|
|
|
|
# ── Forge API helpers ───────────────────────────────────────────────────────────
|
|
|
|
api_get() {
|
|
local url="$1"
|
|
local args=(-sf -H "Accept: application/json")
|
|
[[ -n "$GIT_TOKEN" ]] && args+=(-H "Authorization: token ${GIT_TOKEN}")
|
|
curl "${args[@]}" "$url" || die "API request failed: $url"
|
|
}
|
|
|
|
raw_dl() {
|
|
local url="$1" out="$2"
|
|
local args=(-sfL)
|
|
[[ -n "$GIT_TOKEN" ]] && args+=(-H "Authorization: token ${GIT_TOKEN}")
|
|
curl "${args[@]}" "$url" -o "$out" || die "download failed: $url"
|
|
}
|
|
|
|
# Split a repo URL into "server owner repo".
|
|
# https://git.g3e.fr/team-reseau/vpc-panel → https://git.g3e.fr team-reseau vpc-panel
|
|
parse_repo_url() {
|
|
local url="$1"
|
|
url="${url%.git}"; url="${url%/}"
|
|
local proto="${url%%://*}"
|
|
local rest="${url#*://}"
|
|
local host="${rest%%/*}"
|
|
local path="${rest#*/}"
|
|
[[ "$path" == "$rest" || -z "$path" ]] && die "invalid repo URL (need owner/repo): $1"
|
|
local owner="${path%/*}" repo="${path##*/}"
|
|
[[ -z "$owner" || -z "$repo" ]] && die "invalid repo URL (need owner/repo): $1"
|
|
echo "${proto}://${host}" "$owner" "$repo"
|
|
}
|
|
|
|
# Build the commits API URL — handles GitHub (api.github.com) vs Gitea (/api/v1).
|
|
forge_commits_url() {
|
|
local server="$1" owner="$2" repo="$3" ref="$4"
|
|
if [[ "$server" == "https://github.com" ]]; then
|
|
echo "https://api.github.com/repos/${owner}/${repo}/commits?sha=${ref}&per_page=1"
|
|
else
|
|
echo "${server}/api/v1/repos/${owner}/${repo}/commits?sha=${ref}&limit=1"
|
|
fi
|
|
}
|
|
|
|
# Build the contents API URL for a given path (empty = repo root).
|
|
forge_contents_url() {
|
|
local server="$1" owner="$2" repo="$3" ref="$4" path="$5"
|
|
if [[ "$server" == "https://github.com" ]]; then
|
|
if [[ -z "$path" ]]; then
|
|
echo "https://api.github.com/repos/${owner}/${repo}/contents?ref=${ref}"
|
|
else
|
|
echo "https://api.github.com/repos/${owner}/${repo}/contents/${path}?ref=${ref}"
|
|
fi
|
|
else
|
|
if [[ -z "$path" ]]; then
|
|
echo "${server}/api/v1/repos/${owner}/${repo}/contents?ref=${ref}"
|
|
else
|
|
echo "${server}/api/v1/repos/${owner}/${repo}/contents/${path}?ref=${ref}"
|
|
fi
|
|
fi
|
|
}
|
|
|
|
resolve_commit() {
|
|
local server="$1" owner="$2" repo="$3" ref="$4"
|
|
api_get "$(forge_commits_url "$server" "$owner" "$repo" "$ref")" \
|
|
| jq -r '.[0].sha // empty'
|
|
}
|
|
|
|
# Recursively download a repo path (relative to repo root) into dest dir.
|
|
download_path() {
|
|
local server="$1" owner="$2" repo="$3" ref="$4" rpath="$5" dest="$6"
|
|
|
|
local api
|
|
api="$(forge_contents_url "$server" "$owner" "$repo" "$ref" "$rpath")"
|
|
|
|
local listing
|
|
listing="$(api_get "$api")"
|
|
|
|
mkdir -p "$dest"
|
|
while IFS= read -r entry; do
|
|
local type name dl path
|
|
type="$(jq -r '.type' <<<"$entry")"
|
|
name="$(jq -r '.name' <<<"$entry")"
|
|
dl="$( jq -r '.download_url // ""' <<<"$entry")"
|
|
path="$(jq -r '.path' <<<"$entry")"
|
|
|
|
if [[ "$type" == "dir" ]]; then
|
|
download_path "$server" "$owner" "$repo" "$ref" "$path" "${dest}/${name}"
|
|
else
|
|
[[ -z "$dl" ]] && die "no download_url for ${path} in ${owner}/${repo}@${ref}"
|
|
raw_dl "$dl" "${dest}/${name}"
|
|
fi
|
|
done < <(echo "$listing" | jq -c 'if type=="array" then .[] else . end')
|
|
}
|
|
|
|
# ── Read manifest ────────────────────────────────────────────────────────────────
|
|
|
|
PAGES_DIR="${WEB_DIR}/pages"
|
|
|
|
mapfile -t LOCALS < <(yq '(.local_components // [])[]' "$MANIFEST")
|
|
mapfile -t REMOTES < <(yq '(.components // [])[] | [.name, .repo, (.ref // "main")] | join("|")' "$MANIFEST")
|
|
mapfile -t LOCAL_PAGES < <(yq '(.local_pages // [])[]' "$MANIFEST")
|
|
mapfile -t REMOTE_PAGES < <(yq '(.remote_pages // [])[] | [.name, .repo, (.ref // "main")] | join("|")' "$MANIFEST")
|
|
mapfile -t VENDORS < <(yq '(.vendors // [])[] | [.name, .repo, (.ref // "main"), (.path // ""), (.dest // "")] | join("|")' "$MANIFEST")
|
|
|
|
# ── Download vendors ────────────────────────────────────────────────────────────
|
|
# Vendors are third-party libraries downloaded into web/vendor/ at build time.
|
|
# They are gitignored and never loaded by components.json — components import
|
|
# them directly via relative paths (e.g. ../../vendor/novnc/core/rfb.js).
|
|
|
|
for spec in "${VENDORS[@]}"; do
|
|
[[ -z "$spec" ]] && continue
|
|
IFS='|' read -r name repo ref vpath dest <<<"$spec"
|
|
[[ -z "$name" || -z "$repo" ]] && die "vendor entry missing name or repo: '$spec'"
|
|
|
|
read -r server owner gitrepo <<<"$(parse_repo_url "$repo")"
|
|
[[ -z "$dest" ]] && dest="vendor/${name}"
|
|
local_dest="${WEB_DIR}/${dest}"
|
|
|
|
if [[ "$CHECK_ONLY" == true ]]; then
|
|
info "would fetch vendor ${name} from ${repo}@${ref} path=${vpath:-/}"
|
|
continue
|
|
fi
|
|
|
|
log "fetching vendor ${name} ← ${owner}/${gitrepo}@${ref}${vpath:+ path=}${vpath}"
|
|
commit="$(resolve_commit "$server" "$owner" "$gitrepo" "$ref")"
|
|
[[ -z "$commit" ]] && die "cannot resolve ref '${ref}' in ${owner}/${gitrepo}"
|
|
|
|
rm -rf "$local_dest"
|
|
download_path "$server" "$owner" "$gitrepo" "$ref" "$vpath" "$local_dest"
|
|
info " vendor '${name}' → ${dest} (${commit:0:12})"
|
|
done
|
|
|
|
# Ordered list of load paths for components.json
|
|
declare -a LOAD_PATHS=()
|
|
|
|
# ── Validate locals ──────────────────────────────────────────────────────────────
|
|
|
|
for name in "${LOCALS[@]}"; do
|
|
[[ -z "$name" ]] && continue
|
|
entry="${COMPONENTS_DIR}/${name}/${name}.js"
|
|
if [[ ! -f "$entry" ]]; then
|
|
die "local component '${name}' missing entry file: components/${name}/${name}.js"
|
|
fi
|
|
LOAD_PATHS+=("components/${name}/${name}.js")
|
|
done
|
|
|
|
# ── Download remotes ─────────────────────────────────────────────────────────────
|
|
|
|
LOCK_ENTRIES="[]"
|
|
|
|
for spec in "${REMOTES[@]}"; do
|
|
[[ -z "$spec" ]] && continue
|
|
IFS='|' read -r name repo ref <<<"$spec"
|
|
[[ -z "$name" || -z "$repo" ]] && die "manifest entry missing name or repo: '$spec'"
|
|
|
|
read -r server owner gitrepo <<<"$(parse_repo_url "$repo")"
|
|
dest="${COMPONENTS_DIR}/${name}"
|
|
|
|
if [[ "$CHECK_ONLY" == true ]]; then
|
|
info "would fetch ${name} from ${repo}@${ref}"
|
|
commit="$(resolve_commit "$server" "$owner" "$gitrepo" "$ref" || true)"
|
|
[[ -z "$commit" ]] && warn " could not resolve ref '${ref}' in ${owner}/${gitrepo}"
|
|
LOAD_PATHS+=("components/${name}/${name}.js")
|
|
continue
|
|
fi
|
|
|
|
log "fetching ${name} ← ${owner}/${gitrepo}@${ref}"
|
|
commit="$(resolve_commit "$server" "$owner" "$gitrepo" "$ref")"
|
|
[[ -z "$commit" ]] && die "cannot resolve ref '${ref}' in ${owner}/${gitrepo}"
|
|
|
|
rm -rf "$dest"
|
|
download_path "$server" "$owner" "$gitrepo" "$ref" "" "$dest"
|
|
|
|
entry="${dest}/${name}.js"
|
|
[[ -f "$entry" ]] || die "component '${name}' has no ${name}.js at repo root"
|
|
|
|
LOAD_PATHS+=("components/${name}/${name}.js")
|
|
LOCK_ENTRIES="$(jq \
|
|
--arg name "$name" --arg repo "$repo" --arg ref "$ref" --arg commit "$commit" \
|
|
'. + [{name:$name, repo:$repo, ref:$ref, commit:$commit}]' <<<"$LOCK_ENTRIES")"
|
|
info " pinned ${commit:0:12}"
|
|
done
|
|
|
|
# ── Generate components.json ─────────────────────────────────────────────────────
|
|
|
|
if [[ "$CHECK_ONLY" == true ]]; then
|
|
log "check passed: ${#LOAD_PATHS[@]} components, manifest valid"
|
|
exit 0
|
|
fi
|
|
|
|
printf '%s\n' "${LOAD_PATHS[@]}" | jq -R . | jq -s . > "$OUTPUT"
|
|
echo "$LOCK_ENTRIES" | jq '.' > "$LOCKFILE"
|
|
|
|
log "wrote ${OUTPUT} (${#LOAD_PATHS[@]} components)"
|
|
log "wrote ${LOCKFILE} ($(jq 'length' <<<"$LOCK_ENTRIES") remote pins)"
|
|
|
|
# ── Process pages ────────────────────────────────────────────────────────────────
|
|
|
|
PAGE_ENTRIES="[]"
|
|
|
|
# Collect page metadata from a directory into PAGE_ENTRIES.
|
|
# Detects css/js presence automatically — both are optional.
|
|
add_page_entry() {
|
|
local name="$1" dir="$2"
|
|
local manifest="${dir}/manifest.json"
|
|
local html="${dir}/index.html"
|
|
|
|
[[ -f "$manifest" ]] || die "page '${name}' missing manifest.json in ${dir}"
|
|
[[ -f "$html" ]] || die "page '${name}' missing index.html in ${dir}"
|
|
|
|
local route label icon css_arg js_arg
|
|
route=$(jq -r '.route' "$manifest")
|
|
label=$(jq -r '.label' "$manifest")
|
|
icon=$(jq -r '.icon' "$manifest")
|
|
css_arg="null"; js_arg="null"
|
|
[[ -f "${dir}/${name}.css" ]] && css_arg="\"pages/${name}/${name}.css\""
|
|
[[ -f "${dir}/${name}.js" ]] && js_arg="\"pages/${name}/${name}.js\""
|
|
|
|
PAGE_ENTRIES="$(jq \
|
|
--arg route "$route" --arg label "$label" --arg icon "$icon" \
|
|
--arg html "pages/${name}/index.html" \
|
|
--argjson css "$css_arg" --argjson js "$js_arg" \
|
|
'. + [{route:$route, label:$label, icon:$icon, html:$html, css:$css, js:$js}]' \
|
|
<<<"$PAGE_ENTRIES")"
|
|
info " page '${name}' → /#/${route}$([ "$css_arg" != "null" ] && echo " +css")$([ "$js_arg" != "null" ] && echo " +js")"
|
|
}
|
|
|
|
# Local pages
|
|
for name in "${LOCAL_PAGES[@]}"; do
|
|
[[ -z "$name" ]] && continue
|
|
add_page_entry "$name" "${PAGES_DIR}/${name}"
|
|
done
|
|
|
|
# Remote pages — download then register
|
|
for spec in "${REMOTE_PAGES[@]}"; do
|
|
[[ -z "$spec" ]] && continue
|
|
IFS='|' read -r name repo ref <<<"$spec"
|
|
[[ -z "$name" || -z "$repo" ]] && die "remote_pages entry missing name or repo"
|
|
|
|
read -r server owner gitrepo <<<"$(parse_repo_url "$repo")"
|
|
dest="${PAGES_DIR}/${name}"
|
|
|
|
if [[ "$CHECK_ONLY" == true ]]; then
|
|
info "would fetch page ${name} from ${repo}@${ref}"
|
|
continue
|
|
fi
|
|
|
|
log "fetching page ${name} ← ${owner}/${gitrepo}@${ref}"
|
|
commit="$(resolve_commit "$server" "$owner" "$gitrepo" "$ref")"
|
|
[[ -z "$commit" ]] && die "cannot resolve ref '${ref}' in ${owner}/${gitrepo}"
|
|
|
|
rm -rf "$dest"
|
|
download_path "$server" "$owner" "$gitrepo" "$ref" "" "$dest"
|
|
add_page_entry "$name" "$dest"
|
|
info " pinned ${commit:0:12}"
|
|
done
|
|
|
|
if [[ "$CHECK_ONLY" == false ]]; then
|
|
# Build navigation.json from menu: section.
|
|
# Convert full manifest to JSON once (single yq call) then jq handles all logic.
|
|
# Menu items: string → page lookup, object → pass-through (separator/section).
|
|
manifest_json=$(yq -o json '.' "$MANIFEST")
|
|
menu_json=$(echo "$manifest_json" | jq -c '.menu // []')
|
|
menu_len=$(echo "$menu_json" | jq 'length')
|
|
|
|
if [[ "$menu_len" -gt 0 ]]; then
|
|
NAV_ENTRIES=$(jq -n \
|
|
--argjson menu "$menu_json" \
|
|
--argjson pages "$PAGE_ENTRIES" \
|
|
'def resolve($pages):
|
|
. as $r | $pages[] | select(.route == $r) | { label, href: ("#/" + .route), icon };
|
|
[ $menu[] |
|
|
if type == "string"
|
|
then resolve($pages)
|
|
elif .type == "group"
|
|
then { type: "group", label: .label, icon: (.icon // ""),
|
|
children: [ .children[]? |
|
|
if type == "string" then resolve($pages) else . end ] }
|
|
else .
|
|
end
|
|
]')
|
|
else
|
|
# No menu defined — use all pages in discovery order
|
|
NAV_ENTRIES=$(echo "$PAGE_ENTRIES" | \
|
|
jq '[.[] | { label, href: ("#/" + .route), icon }]')
|
|
fi
|
|
|
|
# pages.json — full list (all pages, original discovery order)
|
|
echo "$PAGE_ENTRIES" | jq '.' > "${WEB_DIR}/pages.json"
|
|
|
|
# navigation.json — write NAV_ENTRIES as-is (already correctly shaped)
|
|
echo "$NAV_ENTRIES" | jq '.' > "${WEB_DIR}/navigation.json"
|
|
|
|
log "wrote pages.json ($(echo "$PAGE_ENTRIES" | jq 'length') pages) + navigation.json ($(echo "$NAV_ENTRIES" | jq 'length') in menu)"
|
|
fi
|