@synopackageland/cli 0.4.0 → 0.5.0

package/dist/build-spk/notices.js

@@ -0,0 +1,60 @@
+import { copyFileSync, existsSync, lstatSync, mkdirSync, readFileSync, readdirSync } from 'node:fs';
+import { dirname, join } from 'node:path';
+/** Copy legal text only; never follow a project-supplied symlink. */
+export function copyNoticeTree(source, target) {
+    const stat = lstatSync(source);
+    if (stat.isSymbolicLink())
+        throw new Error(`[NOTICE_UNSAFE] Symlink in notice tree: ${source}`);
+    if (stat.isDirectory()) {
+        mkdirSync(target, { recursive: true });
+        for (const name of readdirSync(source).sort())
+            copyNoticeTree(join(source, name), join(target, name));
+    }
+    else if (stat.isFile() && stat.size <= 8 * 1024 * 1024) {
+        mkdirSync(dirname(target), { recursive: true });
+        copyFileSync(source, target);
+    }
+    else
+        throw new Error(`[NOTICE_UNSAFE] Notice must be a bounded regular file: ${source}`);
+}
+/** Fixed payload location, independent of app code/binary paths. */
+export function copyProjectNotices(root, payload) {
+    const dest = join(payload, 'LICENSES');
+    if (existsSync(join(root, 'LICENSES')))
+        copyNoticeTree(join(root, 'LICENSES'), dest);
+    if (existsSync(join(root, 'LICENSE')))
+        copyNoticeTree(join(root, 'LICENSE'), join(dest, 'APP.txt'));
+}
+export function copyStandaloneNotices(root, uiDir, payload, go, helper, identity, goDir = join(root, 'backend')) {
+    copyProjectNotices(root, payload);
+    const dest = join(payload, 'LICENSES');
+    const shared = new URL('../../templates/_shared/', import.meta.url);
+    if (go || helper) {
+        mkdirSync(dest, { recursive: true });
+        for (const name of ['GO-LICENSE', 'GO-PATENTS'])
+            copyFileSync(new URL(name, shared), join(dest, name));
+        if (existsSync(join(goDir, 'THIRD_PARTY_NOTICES.txt')))
+            copyNoticeTree(join(goDir, 'THIRD_PARTY_NOTICES.txt'), join(dest, 'GO-THIRD_PARTY_NOTICES.txt'));
+    }
+    if (helper)
+        copyFileSync(new URL('../../templates/native-go/backend/THIRD_PARTY_NOTICES.txt', import.meta.url), join(dest, 'HELPER-THIRD_PARTY_NOTICES.txt'));
+    const frontend = join(root, 'frontend/package.json');
+    const usesUi = existsSync(frontend) && Boolean(JSON.parse(readFileSync(frontend, 'utf8')).dependencies?.['@synopackageland/ui']);
+    if (usesUi) {
+        for (const name of ['UI-LICENSE', 'UI-THIRD_PARTY.md', 'THIRD_PARTY_NOTICES.txt', 'inventory.json']) {
+            const source = join(uiDir, 'LICENSES', name);
+            if (!existsSync(source))
+                throw new Error(`[NOTICE_MISSING] UI notice missing: ${source}; rebuild frontend`);
+        }
+    }
+    if (existsSync(join(uiDir, 'LICENSES')))
+        copyNoticeTree(join(uiDir, 'LICENSES'), join(dest, 'ui'));
+    if (identity) {
+        const source = join(root, 'node/dist/LICENSES');
+        for (const name of ['THIRD_PARTY_NOTICES.txt', 'inventory.json']) {
+            if (!existsSync(join(source, name)))
+                throw new Error(`[NOTICE_MISSING] Better Auth notice missing: ${name}; rebuild node bundle`);
+        }
+        copyNoticeTree(source, join(dest, 'better-auth'));
+    }
+}

package/dist/build-spk/resource-worker.d.ts

@@ -1,10 +1,15 @@
-import type { AppContract } from "../types.js";
-import type { ResourceWorkerEligibility } from "../compose/analyze.js";
+import type { AppContract, ComposeDocument } from "../types.js";
+import { type ResourceWorkerEligibility } from "../compose/analyze.js";
 export { classifyComposeRoute, resourceWorkerEligibility, type ComposeRoute, type ComposeRouteClassification, type ResourceWorkerEligibility, type ResourceWorkerIneligibleReason, } from "../compose/analyze.js";
 export declare function composeProjectName(packageId: string): string;
-export declare function renderDockerProjectResource(packageId: string, projectPath?: string): Record<string, unknown>;
+/**
+ * `forcePull` re-resolves every image tag on install, which can move an image
+ * shared with other containers. Digest-pinned images cannot move, so it is only
+ * needed (and kept, to preserve upgrade behaviour) while a tag is unpinned.
+ */
+export declare function renderDockerProjectResource(packageId: string, projectPath?: string, forcePull?: boolean): Record<string, unknown>;
 export declare function renderWebserviceResource(contract: AppContract, adminport: number): Record<string, unknown>;
-export declare function renderResourceConfig(contract: AppContract, eligibility: ResourceWorkerEligibility): string;
+export declare function renderResourceConfig(contract: AppContract, eligibility: ResourceWorkerEligibility, compose: ComposeDocument): string;
 /**
  * Renders the lifecycle control script for the Docker Project resource-worker
  * route. ContainerManager owns the actual project start/stop operation through

package/dist/build-spk/resource-worker.js

@@ -1,4 +1,5 @@
-import { cookieStripHeaders, resolvedWebLaunch, webStationAlias, webStationServiceName, } from "../contract/web-launch.js";
+import { collectUnpinnedImages } from "../compose/analyze.js";
+import { cookieStripHeaders, resolvedWebLaunch, usesAuthGateway, webStationAlias, webStationServiceName, } from "../contract/web-launch.js";
 export { classifyComposeRoute, resourceWorkerEligibility, } from "../compose/analyze.js";
 export function composeProjectName(packageId) {
     const slug = packageId
@@ -7,7 +8,12 @@ export function composeProjectName(packageId) {
         .replace(/^[-_]+|[-_]+$/g, "");
     return slug.length > 0 ? slug : "app";
 }
-export function renderDockerProjectResource(packageId, projectPath = "compose") {
+/**
+ * `forcePull` re-resolves every image tag on install, which can move an image
+ * shared with other containers. Digest-pinned images cannot move, so it is only
+ * needed (and kept, to preserve upgrade behaviour) while a tag is unpinned.
+ */
+export function renderDockerProjectResource(packageId, projectPath = "compose", forcePull = true) {
     const projectName = composeProjectName(packageId);
     return {
         "docker-project": {
@@ -16,7 +22,7 @@ export function renderDockerProjectResource(packageId, projectPath = "compose")
                     name: projectName,
                     path: projectPath,
                     build_params: {
-                        force_pull: true,
+                        force_pull: forcePull,
                         force_recreate: true,
                         build: false,
                     },
@@ -58,11 +64,14 @@ export function renderWebserviceResource(contract, adminport) {
         },
     };
 }
-export function renderResourceConfig(contract, eligibility) {
+export function renderResourceConfig(contract, eligibility, compose) {
     const packageId = String(contract.package);
-    const dockerResource = renderDockerProjectResource(packageId, "compose");
+    const forcePull = collectUnpinnedImages(compose).length > 0;
+    const dockerResource = renderDockerProjectResource(packageId, "compose", forcePull);
     let combined = { ...dockerResource };
-    if (eligibility.adminport !== undefined) {
+    // A gateway package is reached through its DSM-authenticated CGI only; a Web
+    // Station portal in front of the container would be an anonymous second door.
+    if (eligibility.adminport !== undefined && !usesAuthGateway(contract)) {
         const webResource = renderWebserviceResource(contract, eligibility.adminport);
         combined = {
             ...combined,

package/dist/build-spk/share-combobox.d.ts

@@ -0,0 +1,3 @@
+import type { Translate } from "./wizard-i18n.js";
+/** A wizard combobox listing the NAS's Shared Folders (`SYNO.Core.Share list`) into the variable `key`. */
+export declare function sharedFolderCombobox(t: Translate, key: string): Record<string, unknown>;

package/dist/build-spk/share-combobox.js

@@ -0,0 +1,27 @@
+/** A wizard combobox listing the NAS's Shared Folders (`SYNO.Core.Share list`) into the variable `key`. */
+export function sharedFolderCombobox(t, key) {
+    return {
+        type: "combobox",
+        desc: t("param.sharedFolder", { name: key }),
+        subitems: [{
+                key,
+                desc: key,
+                displayField: "name",
+                valueField: "name",
+                editable: false,
+                forceSelection: true,
+                autoSelect: false,
+                mode: "remote",
+                api_store: {
+                    api: "SYNO.Core.Share",
+                    method: "list",
+                    version: 1,
+                    baseParams: { limit: -1, offset: 0 },
+                    root: "shares",
+                    idProperty: "name",
+                    fields: ["name"],
+                },
+                validator: { allowBlank: false },
+            }],
+    };
+}

package/dist/build-spk/uninstall-wizard.d.ts

@@ -0,0 +1,14 @@
+/** The key Synology's own packages use for their "also remove my data" box. */
+export declare const REMOVE_ADDITIONAL_KEY = "pkgwizard_remove_additional";
+export type UninstallWizardKind = "native" | "container";
+/** Options that add a warning without changing the data box. */
+export interface UninstallWizardOptions {
+    /**
+     * True when the package ships a root integration (helper). Its kill switch
+     * runs inside the App, so the administrator must disable it before DSM is
+     * allowed to uninstall; the warning says so.
+     */
+    integration?: boolean;
+}
+/** `uninstall_uifile` (English) plus one `uninstall_uifile_<dsm language>` per locale. */
+export declare function renderUninstallWizardFiles(packageName: string, kind: UninstallWizardKind, options?: UninstallWizardOptions): Record<string, string>;

package/dist/build-spk/uninstall-wizard.js

@@ -0,0 +1,33 @@
+import { renderWizardFiles } from "./wizard-i18n.js";
+/** The key Synology's own packages use for their "also remove my data" box. */
+export const REMOVE_ADDITIONAL_KEY = "pkgwizard_remove_additional";
+function list(items) {
+    return `<ul class="synopkg-ul-list">${items.map((item) => `<li>${item}</li>`).join("")}</ul>`;
+}
+function renderUninstallWizard(t, packageName, kind, options) {
+    const vars = { package: packageName };
+    return [{
+            step_title: t("uninstall.step"),
+            items: [
+                ...(options.integration ? [{ desc: t("uninstall.integration") }] : []),
+                { desc: t("uninstall.intro") },
+                { desc: t("uninstall.deleteHeading") },
+                {
+                    desc: list([
+                        t("uninstall.item.appdata", vars),
+                        t(kind === "container" ? "uninstall.item.apphomeSecrets" : "uninstall.item.apphome", vars),
+                    ]),
+                },
+                { desc: t(kind === "container" ? "uninstall.keep.container" : "uninstall.keep.native") },
+                { desc: t("uninstall.backup") },
+                {
+                    type: "multiselect",
+                    subitems: [{ key: REMOVE_ADDITIONAL_KEY, desc: t("uninstall.checkbox"), defaultValue: false }],
+                },
+            ],
+        }];
+}
+/** `uninstall_uifile` (English) plus one `uninstall_uifile_<dsm language>` per locale. */
+export function renderUninstallWizardFiles(packageName, kind, options = {}) {
+    return renderWizardFiles("uninstall_uifile", (t) => renderUninstallWizard(t, packageName, kind, options));
+}

package/dist/build-spk/wizard-i18n.d.ts

@@ -0,0 +1,18 @@
+import { type Locale } from "../standalone/i18n.js";
+import { WIZARD_MESSAGES, type WizardMessageId } from "./wizard-messages.js";
+export { WIZARD_MESSAGES, type WizardMessageId };
+export type Translate = (id: WizardMessageId, vars?: Record<string, string>) => string;
+/** Fills `{name}` placeholders; a placeholder without a value is a generator bug, not user input. */
+export declare function translator(locale: Locale): Translate;
+/**
+ * One DSM wizard file per locale: the default file (`<base>`) is English and
+ * every other locale is `<base>_<dsm language>`, which DSM prefers when the
+ * administrator's language matches.
+ */
+export declare function renderWizardFiles(base: string, render: (t: Translate) => unknown): Record<string, string>;
+/**
+ * Writes `WIZARD_UIFILES/<name>` for every rendered file under an SPK staging
+ * directory. A dynamic wizard (`<name>.sh`) is executable: DSM runs it to
+ * generate the wizard; a static JSON file is not.
+ */
+export declare function writeWizardUiFiles(staging: string, files: Record<string, string>): void;

package/dist/build-spk/wizard-i18n.js

@@ -0,0 +1,38 @@
+import { chmodSync, mkdirSync, writeFileSync } from "node:fs";
+import { join } from "node:path";
+import { DSM_LANGS, LOCALES } from "../standalone/i18n.js";
+import { WIZARD_MESSAGES } from "./wizard-messages.js";
+export { WIZARD_MESSAGES };
+/** Fills `{name}` placeholders; a placeholder without a value is a generator bug, not user input. */
+export function translator(locale) {
+    return (id, vars = {}) => WIZARD_MESSAGES[id][locale].replace(/\{(\w+)\}/g, (_, name) => {
+        const value = vars[name];
+        if (value === undefined)
+            throw new Error(`wizard message ${id} needs {${name}}`);
+        return value;
+    });
+}
+/**
+ * One DSM wizard file per locale: the default file (`<base>`) is English and
+ * every other locale is `<base>_<dsm language>`, which DSM prefers when the
+ * administrator's language matches.
+ */
+export function renderWizardFiles(base, render) {
+    return Object.fromEntries(LOCALES.map((locale) => [
+        locale === "en" ? base : `${base}_${DSM_LANGS[locale]}`,
+        JSON.stringify(render(translator(locale)), null, 2),
+    ]));
+}
+/**
+ * Writes `WIZARD_UIFILES/<name>` for every rendered file under an SPK staging
+ * directory. A dynamic wizard (`<name>.sh`) is executable: DSM runs it to
+ * generate the wizard; a static JSON file is not.
+ */
+export function writeWizardUiFiles(staging, files) {
+    const dir = join(staging, "WIZARD_UIFILES");
+    mkdirSync(dir, { recursive: true });
+    for (const [name, text] of Object.entries(files)) {
+        writeFileSync(join(dir, name), text, "utf8");
+        chmodSync(join(dir, name), name.endsWith(".sh") ? 0o755 : 0o644);
+    }
+}

package/dist/build-spk/wizard-messages.d.ts

@@ -0,0 +1,388 @@
+export declare const WIZARD_MESSAGES: {
+    "install.step": {
+        en: string;
+        "zh-TW": string;
+        "zh-CN": string;
+        ja: string;
+        ko: string;
+        de: string;
+        fr: string;
+        es: string;
+        it: string;
+    };
+    "install.reuseData": {
+        en: string;
+        "zh-TW": string;
+        "zh-CN": string;
+        ja: string;
+        ko: string;
+        de: string;
+        fr: string;
+        es: string;
+        it: string;
+    };
+    "upgrade.step": {
+        en: string;
+        "zh-TW": string;
+        "zh-CN": string;
+        ja: string;
+        ko: string;
+        de: string;
+        fr: string;
+        es: string;
+        it: string;
+    };
+    "uninstall.step": {
+        en: string;
+        "zh-TW": string;
+        "zh-CN": string;
+        ja: string;
+        ko: string;
+        de: string;
+        fr: string;
+        es: string;
+        it: string;
+    };
+    "label.sharedFolder": {
+        en: string;
+        "zh-TW": string;
+        "zh-CN": string;
+        ja: string;
+        ko: string;
+        de: string;
+        fr: string;
+        es: string;
+        it: string;
+    };
+    "label.runAs": {
+        en: string;
+        "zh-TW": string;
+        "zh-CN": string;
+        ja: string;
+        ko: string;
+        de: string;
+        fr: string;
+        es: string;
+        it: string;
+    };
+    "param.install": {
+        en: string;
+        "zh-TW": string;
+        "zh-CN": string;
+        ja: string;
+        ko: string;
+        de: string;
+        fr: string;
+        es: string;
+        it: string;
+    };
+    "param.sharedFolder": {
+        en: string;
+        "zh-TW": string;
+        "zh-CN": string;
+        ja: string;
+        ko: string;
+        de: string;
+        fr: string;
+        es: string;
+        it: string;
+    };
+    "param.runAs": {
+        en: string;
+        "zh-TW": string;
+        "zh-CN": string;
+        ja: string;
+        ko: string;
+        de: string;
+        fr: string;
+        es: string;
+        it: string;
+    };
+    "consent.sharedFolder": {
+        en: string;
+        "zh-TW": string;
+        "zh-CN": string;
+        ja: string;
+        ko: string;
+        de: string;
+        fr: string;
+        es: string;
+        it: string;
+    };
+    "consent.homes": {
+        en: string;
+        "zh-TW": string;
+        "zh-CN": string;
+        ja: string;
+        ko: string;
+        de: string;
+        fr: string;
+        es: string;
+        it: string;
+    };
+    "consent.dsmUser": {
+        en: string;
+        "zh-TW": string;
+        "zh-CN": string;
+        ja: string;
+        ko: string;
+        de: string;
+        fr: string;
+        es: string;
+        it: string;
+    };
+    "consent.appOwnSpace": {
+        en: string;
+        "zh-TW": string;
+        "zh-CN": string;
+        ja: string;
+        ko: string;
+        de: string;
+        fr: string;
+        es: string;
+        it: string;
+    };
+    "consent.posixAllShares": {
+        en: string;
+        "zh-TW": string;
+        "zh-CN": string;
+        ja: string;
+        ko: string;
+        de: string;
+        fr: string;
+        es: string;
+        it: string;
+    };
+    "consent.privilege": {
+        en: string;
+        "zh-TW": string;
+        "zh-CN": string;
+        ja: string;
+        ko: string;
+        de: string;
+        fr: string;
+        es: string;
+        it: string;
+    };
+    "upgrade.posixNotice": {
+        en: string;
+        "zh-TW": string;
+        "zh-CN": string;
+        ja: string;
+        ko: string;
+        de: string;
+        fr: string;
+        es: string;
+        it: string;
+    };
+    "upgrade.sharedFolderRw": {
+        en: string;
+        "zh-TW": string;
+        "zh-CN": string;
+        ja: string;
+        ko: string;
+        de: string;
+        fr: string;
+        es: string;
+        it: string;
+    };
+    "upgrade.dsmUser": {
+        en: string;
+        "zh-TW": string;
+        "zh-CN": string;
+        ja: string;
+        ko: string;
+        de: string;
+        fr: string;
+        es: string;
+        it: string;
+    };
+    "upgrade.reuseDesc": {
+        en: string;
+        "zh-TW": string;
+        "zh-CN": string;
+        ja: string;
+        ko: string;
+        de: string;
+        fr: string;
+        es: string;
+        it: string;
+    };
+    "upgrade.changeDesc": {
+        en: string;
+        "zh-TW": string;
+        "zh-CN": string;
+        ja: string;
+        ko: string;
+        de: string;
+        fr: string;
+        es: string;
+        it: string;
+    };
+    "upgrade.changeSub": {
+        en: string;
+        "zh-TW": string;
+        "zh-CN": string;
+        ja: string;
+        ko: string;
+        de: string;
+        fr: string;
+        es: string;
+        it: string;
+    };
+    "uninstall.integration": {
+        en: string;
+        "zh-TW": string;
+        "zh-CN": string;
+        ja: string;
+        ko: string;
+        de: string;
+        fr: string;
+        es: string;
+        it: string;
+    };
+    "uninstall.intro": {
+        en: string;
+        "zh-TW": string;
+        "zh-CN": string;
+        ja: string;
+        ko: string;
+        de: string;
+        fr: string;
+        es: string;
+        it: string;
+    };
+    "uninstall.deleteHeading": {
+        en: string;
+        "zh-TW": string;
+        "zh-CN": string;
+        ja: string;
+        ko: string;
+        de: string;
+        fr: string;
+        es: string;
+        it: string;
+    };
+    "uninstall.item.appdata": {
+        en: string;
+        "zh-TW": string;
+        "zh-CN": string;
+        ja: string;
+        ko: string;
+        de: string;
+        fr: string;
+        es: string;
+        it: string;
+    };
+    "uninstall.item.apphome": {
+        en: string;
+        "zh-TW": string;
+        "zh-CN": string;
+        ja: string;
+        ko: string;
+        de: string;
+        fr: string;
+        es: string;
+        it: string;
+    };
+    "uninstall.item.apphomeSecrets": {
+        en: string;
+        "zh-TW": string;
+        "zh-CN": string;
+        ja: string;
+        ko: string;
+        de: string;
+        fr: string;
+        es: string;
+        it: string;
+    };
+    "uninstall.keep.native": {
+        en: string;
+        "zh-TW": string;
+        "zh-CN": string;
+        ja: string;
+        ko: string;
+        de: string;
+        fr: string;
+        es: string;
+        it: string;
+    };
+    "uninstall.keep.container": {
+        en: string;
+        "zh-TW": string;
+        "zh-CN": string;
+        ja: string;
+        ko: string;
+        de: string;
+        fr: string;
+        es: string;
+        it: string;
+    };
+    "uninstall.backup": {
+        en: string;
+        "zh-TW": string;
+        "zh-CN": string;
+        ja: string;
+        ko: string;
+        de: string;
+        fr: string;
+        es: string;
+        it: string;
+    };
+    "uninstall.checkbox": {
+        en: string;
+        "zh-TW": string;
+        "zh-CN": string;
+        ja: string;
+        ko: string;
+        de: string;
+        fr: string;
+        es: string;
+        it: string;
+    };
+    "nativeShare.selectIntro": {
+        en: string;
+        "zh-TW": string;
+        "zh-CN": string;
+        ja: string;
+        ko: string;
+        de: string;
+        fr: string;
+        es: string;
+        it: string;
+    };
+    "nativeShare.createIntro": {
+        en: string;
+        "zh-TW": string;
+        "zh-CN": string;
+        ja: string;
+        ko: string;
+        de: string;
+        fr: string;
+        es: string;
+        it: string;
+    };
+    "nativeShare.permission.ro": {
+        en: string;
+        "zh-TW": string;
+        "zh-CN": string;
+        ja: string;
+        ko: string;
+        de: string;
+        fr: string;
+        es: string;
+        it: string;
+    };
+    "nativeShare.permission.rw": {
+        en: string;
+        "zh-TW": string;
+        "zh-CN": string;
+        ja: string;
+        ko: string;
+        de: string;
+        fr: string;
+        es: string;
+        it: string;
+    };
+};
+export type WizardMessageId = keyof typeof WIZARD_MESSAGES;