@synopackageland/cli 0.3.9 → 0.4.0

package/dist/host/dsm-client.js

@@ -1,15 +1,11 @@
 import { spawnSync } from "node:child_process";
-import { mkdtempSync, writeFileSync, rmSync } from "node:fs";
-import { tmpdir } from "node:os";
-import { join } from "node:path";
-import { IDENTITY_CGI_PATH } from "./broker-paths.js";
-import { packageSourceOrigin } from "../deploy/catalog-publish.js";
 import { listShareNamesWithSynoagentcli, lookupSharePathWithSynoagentcli } from "./share-lookup.js";
 import { createSynoagentcliApiCall, fetchSharePermissions, fetchUserGroups, } from "./share-permission-lookup.js";
+import { fetchPortInfo } from "./port-info-lookup.js";
 import { dsmFetch } from "./dsm-http.js";
-import { installPackageFromCatalog, installPackageFromLocalSpk, uninstallPackageFromDsm, fetchInstalledPackageState, packageStateFromRecord, } from "./catalog-install.js";
+import { fetchDsmPortProfileInventory } from "./dsm-port-profile.js";
+import { installPackageFromLocalSpk, fetchInstalledPackageState, packageStateFromRecord, } from "./catalog-install.js";
 import { resolveHostCredentials } from "./credentials.js";
-const OIDC_COMPAT_PATH = "/api/v1/inner-loop/oidc-compat";
 export function createNasHost(options = {}) {
     const credentials = options.credentials ?? resolveHostCredentials(options.host);
     if (!credentials) {
@@ -59,9 +55,7 @@ export function homesPathFromDsmUserHomeRead(result) {
 }
 function createDsmNasHost(credentials, profileName) {
     const dsmOrigin = credentials.dsmOrigin.replace(/\/$/, "");
-    const brokerBaseUrl = `${dsmOrigin}${IDENTITY_CGI_PATH}`;
     let cookieHeader = credentials.cookieHeader;
-    const projectEnvCache = new Map();
     const ensureLogin = async () => {
         if (cookieHeader) {
             return;
@@ -75,7 +69,10 @@ function createDsmNasHost(credentials, profileName) {
             session: "FileStation",
             format: "cookie",
         });
-        const response = await dsmFetch(`${dsmOrigin}/webapi/entry.cgi?${query.toString()}`);
+        const response = await dsmFetch(`${dsmOrigin}/webapi/entry.cgi`, { method: "POST", headers: { "content-type": "application/x-www-form-urlencoded" }, body: query });
+        const login = await response.json();
+        if (!response.ok || login.success !== true)
+            throw new Error("DSM login failed");
         const setCookie = typeof response.headers.getSetCookie === "function"
             ? response.headers.getSetCookie()
             : response.headers.get("set-cookie")
@@ -85,140 +82,18 @@ function createDsmNasHost(credentials, profileName) {
             .map((line) => line.split(";")[0]?.trim())
             .filter((pair) => Boolean(pair));
         cookieHeader = pairs.join("; ");
-    };
-    const ensureInnerLoopApi = async () => {
-        await ensureLogin();
-        const response = await dsmFetch(`${brokerBaseUrl}/api/v1/inner-loop/diagnostics?package=probe`, { headers: { cookie: cookieHeader ?? "" } });
-        const text = await response.text();
-        if (response.status === 404 || text.trimStart().startsWith("<")) {
-            const error = new Error("Broker inner-loop API 不可用（收到 HTML 404）。請將 SynoPkgLandService 升級到 >=0.1.0-0016。");
-            error.code = "INNER_LOOP_API_MISSING";
-            throw error;
-        }
-        try {
-            JSON.parse(text);
-        }
-        catch {
-            const error = new Error("Broker inner-loop API 回傳非 JSON 內容。");
-            error.code = "INNER_LOOP_API_MISSING";
-            throw error;
-        }
-    };
-    const ensurePackageSourceFeed = (origin) => {
-        const feed = origin.replace(/\/$/, "") + "/";
-        const list = synoagentcli(["dsm", "package-center", "source", "list"], profileName);
-        if (list.status !== 0) {
-            return;
-        }
-        const parsed = JSON.parse(list.stdout);
-        const items = parsed.data?.items ?? [];
-        const normalizedFeed = feed.replace(/\/$/, "");
-        const existing = items.find((item) => item.feed?.replace(/\/$/, "") === normalizedFeed);
-        if (existing) {
-            return;
-        }
-        const stale = items.find((item) => item.name === "package-land-throwaway");
-        const payload = { name: "package-land-throwaway", feed };
-        const staging = mkdtempSync(join(tmpdir(), "syno-package-source-feed-"));
-        const jsonPath = join(staging, "source.json");
-        writeFileSync(jsonPath, JSON.stringify(payload));
-        try {
-            if (stale?.feed) {
-                synoagentcli(["dsm", "package-center", "source", "update", stale.feed, "--json-file", jsonPath], profileName);
-                return;
-            }
-            synoagentcli(["dsm", "package-center", "source", "add", "--json-file", jsonPath], profileName);
-        }
-        finally {
-            rmSync(staging, { recursive: true, force: true });
-        }
+        if (!cookieHeader)
+            throw new Error("DSM login returned no session cookie");
     };
     return {
         dsmOrigin,
-        installationId: "live-nas",
-        async requestAttestation(input) {
-            await ensureInnerLoopApi();
+        async installFromLocalSpk(input) {
             await ensureLogin();
-            const response = await dsmFetch(`${brokerBaseUrl}/api/v1/inner-loop/attest`, {
-                method: "POST",
-                headers: {
-                    cookie: cookieHeader ?? "",
-                    "content-type": "application/json",
-                },
-                body: JSON.stringify(input),
+            await installPackageFromLocalSpk({
+                dsmOrigin, cookieHeader: cookieHeader ?? "",
+                packageId: input.packageId, spkPath: input.spkPath,
+                version: input.version, profileName, extraValues: input.extraValues,
             });
-            const text = await response.text();
-            let body;
-            try {
-                body = JSON.parse(text);
-            }
-            catch {
-                const error = new Error("Broker inner-loop attest 回傳非 JSON 內容。");
-                error.code = "INNER_LOOP_API_MISSING";
-                throw error;
-            }
-            if (!response.ok) {
-                const error = new Error(body.error?.message ?? `Attestation failed (${response.status})`);
-                error.code = body.error?.code;
-                throw error;
-            }
-            const token = typeof body.token === "string" && body.token.length > 0 ? body.token : undefined;
-            return {
-                kind: "local",
-                attestationDigest: body.attestationDigest ?? "",
-                ...(token !== undefined ? { token } : {}),
-            };
-        },
-        async ensurePackageSource(origin) {
-            ensurePackageSourceFeed(origin);
-        },
-        async installFromCatalog(input) {
-            try {
-                ensurePackageSourceFeed(packageSourceOrigin());
-                await ensureLogin();
-                await installPackageFromCatalog({
-                    dsmOrigin,
-                    cookieHeader: cookieHeader ?? "",
-                    packageId: input.packageId,
-                    profileName,
-                    expectedVersion: input.version,
-                    packageSourceOrigin: packageSourceOrigin(),
-                    extraValues: input.extraValues,
-                });
-            }
-            finally {
-                projectEnvCache.delete(input.packageId);
-            }
-        },
-        async installFromLocalSpk(input) {
-            try {
-                await ensureLogin();
-                await installPackageFromLocalSpk({
-                    dsmOrigin,
-                    cookieHeader: cookieHeader ?? "",
-                    packageId: input.packageId,
-                    spkPath: input.spkPath,
-                    version: input.version,
-                    profileName,
-                    extraValues: input.extraValues,
-                });
-            }
-            finally {
-                projectEnvCache.delete(input.packageId);
-            }
-        },
-        async uninstallPackage(packageIdentity) {
-            try {
-                await ensureLogin();
-                await uninstallPackageFromDsm({
-                    dsmOrigin,
-                    cookieHeader: cookieHeader ?? "",
-                    packageId: packageIdentity,
-                });
-            }
-            finally {
-                projectEnvCache.delete(packageIdentity);
-            }
         },
         async getArchFamily() {
             await ensureLogin();
@@ -241,51 +116,22 @@ function createDsmNasHost(credentials, profileName) {
         async listUserGroups(userName) {
             return fetchUserGroups(userName, createSynoagentcliApiCall(profileName));
         },
-        async resolveHomesPath() {
+        async listPortInfo() {
             try {
-                const result = synoagentcli(["dsm", "control-panel", "user-group", "advanced", "get", "--section", "home"], profileName);
-                return homesPathFromDsmUserHomeRead(result);
+                await ensureLogin();
+                return fetchPortInfo(dsmOrigin, cookieHeader ?? "");
             }
             catch {
                 return undefined;
             }
         },
-        async getInstalledProjectEnv(packageIdentity) {
-            const cached = projectEnvCache.get(packageIdentity);
-            if (cached) {
-                return cached;
-            }
-            const lookup = (async () => {
-                await ensureLogin();
-                const response = await dsmFetch(`${brokerBaseUrl}/api/v1/inner-loop/project-env/${encodeURIComponent(packageIdentity)}`, { headers: { cookie: cookieHeader ?? "" } });
-                if (response.ok) {
-                    const payload = (await response.json());
-                    if (!payload.env || typeof payload.env !== "object" || Array.isArray(payload.env)) {
-                        return undefined;
-                    }
-                    return Object.fromEntries(Object.entries(payload.env).filter((entry) => typeof entry[1] === "string"));
-                }
-                return undefined;
-            })();
-            projectEnvCache.set(packageIdentity, lookup);
-            return lookup;
-        },
-        async getAttestationInfo(packageIdentity) {
-            await ensureLogin();
-            const response = await dsmFetch(`${brokerBaseUrl}/api/v1/inner-loop/info/${encodeURIComponent(packageIdentity)}`, { headers: { cookie: cookieHeader ?? "" } });
-            const text = await response.text();
-            if (response.status === 404 || text.trimStart().startsWith("<")) {
-                const error = new Error("Broker inner-loop info 不可用（HTML 404）。");
-                error.code = "INNER_LOOP_API_MISSING";
-                throw error;
-            }
+        async resolveHomesPath() {
             try {
-                return JSON.parse(text);
+                const result = synoagentcli(["dsm", "control-panel", "user-group", "advanced", "get", "--section", "home"], profileName);
+                return homesPathFromDsmUserHomeRead(result);
             }
             catch {
-                const error = new Error("Broker inner-loop info 回傳非 JSON 內容。");
-                error.code = "INNER_LOOP_API_MISSING";
-                throw error;
+                return undefined;
             }
         },
         async getInstalledPackageState(packageIdentity) {
@@ -344,101 +190,15 @@ function createDsmNasHost(credentials, profileName) {
                 .filter(Boolean)
                 .map((line) => `[status] ${line}`);
         },
-        async getDsmDiagnostics(packageIdentity) {
-            try {
-                await ensureLogin();
-                const pkg = packageIdentity ?? "probe";
-                const response = await dsmFetch(`${brokerBaseUrl}/api/v1/inner-loop/diagnostics?package=${encodeURIComponent(pkg)}`, { headers: { cookie: cookieHeader ?? "" } });
-                if (!response.ok) {
-                    return undefined;
-                }
-                const text = await response.text();
-                return JSON.parse(text);
-            }
-            catch {
-                return undefined;
-            }
-        },
-        async getOidcCompatSettings() {
+        async getDsmPortProfileInventory() {
             try {
                 await ensureLogin();
-                const response = await dsmFetch(`${brokerBaseUrl}${OIDC_COMPAT_PATH}`, {
-                    headers: { cookie: cookieHeader ?? "" },
-                });
-                const text = await response.text();
-                if (response.status === 404 || text.trimStart().startsWith("<")) {
-                    return undefined;
-                }
-                if (!response.ok) {
-                    return undefined;
-                }
-                const payload = JSON.parse(text);
-                const settings = payload.settings;
-                if (!settings || typeof settings !== "object" || Array.isArray(settings)) {
-                    return undefined;
-                }
-                const record = settings;
-                const origin = record.origin;
-                if (!origin || typeof origin !== "object" || Array.isArray(origin)) {
-                    return undefined;
-                }
-                const originRecord = origin;
-                if (typeof record.enabled !== "boolean" ||
-                    typeof originRecord.ready !== "boolean" ||
-                    typeof originRecord.kind !== "string" ||
-                    typeof originRecord.setupHint !== "string") {
-                    return undefined;
-                }
-                return {
-                    enabled: record.enabled,
-                    origin: {
-                        ready: originRecord.ready,
-                        kind: originRecord.kind,
-                        hostname: typeof originRecord.hostname === "string" ? originRecord.hostname : undefined,
-                        issuerUrl: typeof originRecord.issuerUrl === "string" ? originRecord.issuerUrl : undefined,
-                        setupHint: originRecord.setupHint,
-                    },
-                };
+                return await fetchDsmPortProfileInventory(dsmOrigin, cookieHeader ?? "");
             }
             catch {
                 return undefined;
             }
         },
-        async smokeRequireLogin(input) {
-            await ensureLogin();
-            const info = await this.getAttestationInfo(input.packageIdentity);
-            let openUrl = info.openUrl;
-            if (!openUrl) {
-                const pkg = synoagentcli(["dsm", "package-center", "get", input.packageIdentity], profileName);
-                if (pkg.status === 0) {
-                    try {
-                        const parsed = JSON.parse(pkg.stdout);
-                        openUrl = parsed.data?.url?.[0];
-                    }
-                    catch {
-                        // ignore parse errors
-                    }
-                }
-            }
-            if (!openUrl) {
-                return { ok: false };
-            }
-            const origin = new URL(openUrl).origin;
-            const response = await dsmFetch(`${brokerBaseUrl}/api/v1/auth/login`, {
-                method: "POST",
-                headers: {
-                    cookie: cookieHeader ?? input.cookieHeader,
-                    origin,
-                    "content-type": "application/json",
-                },
-                body: JSON.stringify({ packageId: input.packageIdentity }),
-            });
-            if (!response.ok) {
-                return { ok: false };
-            }
-            const body = (await response.json());
-            return { ok: Boolean(body.user?.username), username: body.user?.username };
-        },
     };
 }
 /**

package/dist/host/dsm-port-profile.d.ts

@@ -0,0 +1,47 @@
+/** The precision caveat for the administrator-only fallback. */
+export declare const DSM_PORT_PROFILE_PRECISION_WARNING = "API \u7248\u672A\u8B80\u53D6 conf/resource\uFF1B\u82E5\u6709 App \u81EA\u8A02 Compose project \u540D\u53EF\u80FD\u8AA4\u5831";
+export interface DsmPortRange {
+    start: number;
+    end: number;
+}
+export interface DsmPortProfile {
+    portId: string;
+    containerName: string;
+    projectName: string;
+    /** Kept for diagnostics only; the API orphan test must use projectName. */
+    presumedPackageIdentity: string;
+    dstPorts: DsmPortRange[];
+}
+export interface DsmPortProfileInventory {
+    profiles: DsmPortProfile[];
+    orphaned: DsmPortProfile[];
+}
+/**
+ * parsePortProfileFilename(). In particular, projectName is everything before
+ * the final two dash-separated container segments.
+ */
+export declare function parsePortProfileFilename(filename: string): {
+    containerName: string;
+    projectName: string;
+    presumedPackageIdentity: string;
+} | undefined;
+/** Parse one DSM dst_port value, including the documented range form. */
+export declare function parseDsmPortRange(value: string): DsmPortRange | undefined;
+/** Parse a successful SYNO.Core.Service.PortInfo/load response. */
+export declare function parseDsmPortInfoPayload(payload: unknown): DsmPortProfile[] | undefined;
+/** Parse the installed identity set from a successful DSM package list. */
+export declare function installedPackageIdentitiesFromPayload(payload: unknown): string[] | undefined;
+/**
+ * Build the API-only inventory from the two independent DSM responses.
+ *
+ * The package list is a forward mapping: package identity -> project name.
+ * Do not use presumedPackageIdentity here; replacing dashes with dots is
+ * lossy for identities such as com.example.hello-web.
+ */
+export declare function dsmPortProfileInventoryFromPayloads(portInfoPayload: unknown, packageListPayload: unknown): DsmPortProfileInventory | undefined;
+/**
+ * Read PortInfo.load and the administrator-visible installed package list.
+ * Any transport, HTTP, JSON, or DSM API failure becomes undefined so callers
+ * can skip without inventing residue.
+ */
+export declare function fetchDsmPortProfileInventory(dsmOrigin: string, cookieHeader: string): Promise<DsmPortProfileInventory | undefined>;

package/dist/host/dsm-port-profile.js

@@ -0,0 +1,206 @@
+import { basename } from "node:path";
+import { composeProjectName } from "../build-spk/resource-worker.js";
+import { dsmFetch } from "./dsm-http.js";
+/** The precision caveat for the administrator-only fallback. */
+export const DSM_PORT_PROFILE_PRECISION_WARNING = "API 版未讀取 conf/resource；若有 App 自訂 Compose project 名可能誤報";
+/**
+ * parsePortProfileFilename(). In particular, projectName is everything before
+ * the final two dash-separated container segments.
+ */
+export function parsePortProfileFilename(filename) {
+    const base = basename(filename);
+    if (!base.startsWith("docker_") || !base.endsWith(".sc")) {
+        return undefined;
+    }
+    const containerName = base.slice("docker_".length, base.length - ".sc".length);
+    if (!containerName) {
+        return undefined;
+    }
+    // remove the final -<service>-<replica> pair, not an identity-specific guess.
+    const lastDash = containerName.lastIndexOf("-");
+    if (lastDash <= 0) {
+        return undefined;
+    }
+    const secondLastDash = containerName.lastIndexOf("-", lastDash - 1);
+    if (secondLastDash <= 0) {
+        return undefined;
+    }
+    const projectName = containerName.slice(0, secondLastDash);
+    const presumedPackageIdentity = projectName.replace(/-/g, ".");
+    return {
+        containerName,
+        projectName,
+        presumedPackageIdentity,
+    };
+}
+/** Parse one DSM dst_port value, including the documented range form. */
+export function parseDsmPortRange(value) {
+    const match = /^([0-9]{1,5})(?:-([0-9]{1,5}))?$/.exec(value.trim());
+    if (!match) {
+        return undefined;
+    }
+    const start = Number(match[1]);
+    const end = Number(match[2] ?? match[1]);
+    if (!Number.isInteger(start) ||
+        !Number.isInteger(end) ||
+        start < 1 ||
+        end > 65535 ||
+        start > end) {
+        return undefined;
+    }
+    return { start, end };
+}
+function parseDsmPortRanges(value) {
+    if (!Array.isArray(value) || value.length === 0) {
+        return undefined;
+    }
+    const ranges = [];
+    for (const entry of value) {
+        if (typeof entry !== "string") {
+            return undefined;
+        }
+        const range = parseDsmPortRange(entry);
+        if (!range) {
+            return undefined;
+        }
+        ranges.push(range);
+    }
+    return ranges;
+}
+function record(value) {
+    return value && typeof value === "object" && !Array.isArray(value)
+        ? value
+        : undefined;
+}
+function nonEmptyString(value) {
+    return typeof value === "string" && value.length > 0 ? value : undefined;
+}
+function parseDockerPortInfo(value) {
+    const entry = record(value);
+    if (!entry) {
+        return undefined;
+    }
+    // PortInfo also contains ordinary DSM service rows. Only the documented
+    // Docker(TCP) rows correspond to docker_<container>.sc profiles.
+    if (entry.protocol !== "tcp" || entry.name !== "Docker(TCP)") {
+        return undefined;
+    }
+    const portId = nonEmptyString(entry.port_id);
+    if (!portId?.endsWith("_tcp")) {
+        return undefined;
+    }
+    const containerName = portId.slice(0, -"_tcp".length);
+    if (!containerName || entry.desc !== `Docker ${containerName}`) {
+        return undefined;
+    }
+    const parsed = parsePortProfileFilename(`docker_${containerName}.sc`);
+    const dstPorts = parseDsmPortRanges(entry.dst_port);
+    if (!parsed || !dstPorts) {
+        return undefined;
+    }
+    return {
+        portId,
+        containerName: parsed.containerName,
+        projectName: parsed.projectName,
+        presumedPackageIdentity: parsed.presumedPackageIdentity,
+        dstPorts,
+    };
+}
+/** Parse a successful SYNO.Core.Service.PortInfo/load response. */
+export function parseDsmPortInfoPayload(payload) {
+    const root = record(payload);
+    const data = record(root?.data);
+    if (root?.success !== true || !data || !Array.isArray(data.port_info)) {
+        return undefined;
+    }
+    return data.port_info.flatMap((entry) => {
+        const profile = parseDockerPortInfo(entry);
+        return profile ? [profile] : [];
+    });
+}
+/** Parse the installed identity set from a successful DSM package list. */
+export function installedPackageIdentitiesFromPayload(payload) {
+    const root = record(payload);
+    const data = record(root?.data);
+    if (root?.success !== true || !data || !Array.isArray(data.packages)) {
+        return undefined;
+    }
+    return [
+        ...new Set(data.packages
+            .map((entry) => record(entry)?.id)
+            .filter((id) => typeof id === "string" && id.length > 0)),
+    ];
+}
+/**
+ * Build the API-only inventory from the two independent DSM responses.
+ *
+ * The package list is a forward mapping: package identity -> project name.
+ * Do not use presumedPackageIdentity here; replacing dashes with dots is
+ * lossy for identities such as com.example.hello-web.
+ */
+export function dsmPortProfileInventoryFromPayloads(portInfoPayload, packageListPayload) {
+    const profiles = parseDsmPortInfoPayload(portInfoPayload);
+    if (!profiles) {
+        return undefined;
+    }
+    // An empty PortInfo list is a safe, successful "nothing to report" result;
+    // there is no reason to turn an unavailable package list into an orphan.
+    if (profiles.length === 0) {
+        return { profiles, orphaned: [] };
+    }
+    const installedPackages = installedPackageIdentitiesFromPayload(packageListPayload);
+    // An empty or unavailable package list cannot prove that any profile is an
+    // orphan. Fail closed instead of classifying every visible Docker row.
+    if (!installedPackages || installedPackages.length === 0) {
+        return undefined;
+    }
+    const declaredProjectNames = new Set(installedPackages.map(composeProjectName));
+    const orphaned = profiles.filter((profile) => !declaredProjectNames.has(profile.projectName));
+    return { profiles, orphaned };
+}
+async function fetchJson(dsmOrigin, cookieHeader, params) {
+    const query = new URLSearchParams(params);
+    const response = await dsmFetch(`${dsmOrigin}/webapi/entry.cgi?${query.toString()}`, {
+        headers: { cookie: cookieHeader },
+    });
+    if (!response.ok) {
+        return undefined;
+    }
+    try {
+        return await response.json();
+    }
+    catch {
+        return undefined;
+    }
+}
+/**
+ * Read PortInfo.load and the administrator-visible installed package list.
+ * Any transport, HTTP, JSON, or DSM API failure becomes undefined so callers
+ * can skip without inventing residue.
+ */
+export async function fetchDsmPortProfileInventory(dsmOrigin, cookieHeader) {
+    try {
+        const portInfoPayload = await fetchJson(dsmOrigin, cookieHeader, {
+            api: "SYNO.Core.Service.PortInfo",
+            version: "1",
+            method: "load",
+        });
+        const profiles = parseDsmPortInfoPayload(portInfoPayload);
+        if (!profiles) {
+            return undefined;
+        }
+        if (profiles.length === 0) {
+            return { profiles, orphaned: [] };
+        }
+        const packageListPayload = await fetchJson(dsmOrigin, cookieHeader, {
+            api: "SYNO.Core.Package",
+            version: "2",
+            method: "list",
+            additional: JSON.stringify(["status"]),
+        });
+        return dsmPortProfileInventoryFromPayloads(portInfoPayload, packageListPayload);
+    }
+    catch {
+        return undefined;
+    }
+}

package/dist/host/port-info-lookup.d.ts

@@ -0,0 +1,9 @@
+import type { PortInfoEntry } from "./port-info.js";
+export type PortInfoHttpRequest = (url: string, init?: RequestInit) => Promise<Response>;
+/**
+ * Parses the native DSM response, not a synoagentcli operation envelope.
+ * `undefined` means "cannot tell" and deliberately allows deployment to
+ * continue. An empty `port_info` list has the same fail-open meaning.
+ */
+export declare function parsePortInfo(payload: unknown): PortInfoEntry[] | undefined;
+export declare function fetchPortInfo(dsmOrigin: string, cookieHeader: string, request?: PortInfoHttpRequest): Promise<PortInfoEntry[] | undefined>;