@synopackageland/cli 0.7.1 → 0.7.3

package/dist/standalone/manifest.js

@@ -4,7 +4,7 @@ import { existsSync, readFileSync } from "node:fs";
 import { isAbsolute, join, relative, resolve } from "node:path";
 import { parse } from "yaml";
 import { isNativeArchFamily } from "../build-spk/dsm-arch.js";
-import { checkGlossary, isLocale, loadCatalogs } from "./i18n.js";
+import { checkGlossary, loadCatalogs, readInfoTranslations } from "./i18n.js";
 import { loadRootOps, ROOT_OPS_DIR } from "./root-ops.js";
 import { readDaemon } from "./daemon.js";
 import { readBackground } from "./background.js";
@@ -12,6 +12,7 @@ import { DEFAULT_MIN_DSM, isDsmAtLeast, PORTAL_MIN_DSM, portalMinDsmMessage } fr
 import { readSharedFolder } from "./shared-folder.js";
 import { floorAtAdministrators, permitsOrdinaryUsers, readApiPermissions } from "./api-permissions.js";
 import { readPortalDeclaration } from "../portal/alias.js";
+import { renderPackageIcons } from "../build-spk/dsm-icons.js";
 /**
  * `dsm-package.yaml`: a Standalone Package, i.e. an unsigned native SPK that
  * runs as its own DSM package account with a CGI backend and a DSM window UI.
@@ -19,10 +20,9 @@ import { readPortalDeclaration } from "../portal/alias.js";
 export const STANDALONE_MANIFEST = "dsm-package.yaml";
 export const KNOWN_FIELDS = new Set([
     "schema", "package", "version", "build", "displayname", "description",
-    "metadata", "maintainer", "os_min_ver", "arches", "backend", "ui", "capabilities", "i18n", "daemon", "install", "entry", "portal",
+    "metadata", "maintainer", "os_min_ver", "arches", "backend", "ui", "capabilities", "i18n", "daemon", "install", "entry", "portal", "icon",
 ]);
 const I18N_FIELDS = new Set(["messages", "glossary", "info"]);
-const INFO_TEXT_FIELDS = new Set(["displayname", "description"]);
 const PACKAGE_ID = /^[A-Za-z][A-Za-z0-9]{1,63}$/;
 const VERSION = /^\d+(\.\d+){0,3}$/;
 const OS_MIN_VER = /^\d+\.\d+(\.\d+)?-\d+$/;
@@ -154,6 +154,7 @@ function readManifest(raw, c) {
     if (capabilities.delegate?.scope === "install-selected" && ui && !ui.build)
         c.fail("CAPABILITY_COMBINATION_INVALID", "delegate scope install-selected 只能在 Vue 面板確認；plain UI 不支援，請改用 vue UI（init --ui vue）。");
     const i18n = raw.i18n === undefined ? undefined : readI18n(raw.i18n, c);
+    const icon = raw.icon === undefined ? undefined : readIcon(raw.icon, c);
     const portal = raw.portal === undefined || !packageId ? undefined : readPortalDeclaration(raw.portal, packageId)
         ?? c.fail("STANDALONE_PORTAL_INVALID", "portal 必須是 {} 或 { alias: <小寫英數與 -，1–64 字，不可為 DSM 保留路徑> }。");
     if (portal && osMinVer && !isDsmAtLeast(osMinVer, PORTAL_MIN_DSM)) {
@@ -185,8 +186,21 @@ function readManifest(raw, c) {
         ...(sharedFolder ? { sharedFolder } : {}),
         ...(entry ? { entry } : {}),
         ...(portal ? { portal } : {}),
+        ...(icon ? { icon } : {}),
     };
 }
+function readIcon(value, c) {
+    const path = c.path(value, "icon");
+    if (!path)
+        return undefined;
+    try {
+        renderPackageIcons(path);
+        return path;
+    }
+    catch (error) {
+        return c.fail("STANDALONE_ICON_INVALID", `icon：${error.message}`);
+    }
+}
 /**
  * The CGI enforces the entry mode only when the project's backend carries the
  * SDK gate and main wires it; `-X main.entry` on an older main would be
@@ -282,7 +296,10 @@ function readI18n(value, c) {
     if (!isRecord(value) || Object.keys(value).some((key) => !I18N_FIELDS.has(key))) {
         return invalid("只接受 messages（訊息目錄）、glossary（用語表）與 info（各語言 INFO 文字）。");
     }
-    const info = readInfoText(value.info, c);
+    const info = readInfoTranslations(value.info, {
+        invalid: (why) => c.fail("STANDALONE_I18N_INVALID", `i18n.info ${why}`),
+        text: (text, field) => c.text(text, field),
+    });
     if (value.messages === undefined) {
         return value.glossary === undefined ? info && { info } : invalid("glossary 需要搭配 messages。");
     }
@@ -300,36 +317,6 @@ function readI18n(value, c) {
     drift.forEach((e) => c.fail(e.code, e.message));
     return info && drift.length === 0 ? { catalogs: loaded.catalogs, info } : undefined;
 }
-function readInfoText(value, c) {
-    if (value === undefined) {
-        return {};
-    }
-    const invalid = (why) => c.fail("STANDALONE_I18N_INVALID", `i18n.info ${why}`);
-    if (!isRecord(value)) {
-        return invalid("必須以語言為 key，例如 zh-TW: { displayname, description }。");
-    }
-    const info = {};
-    for (const [locale, text] of Object.entries(value)) {
-        if (!isLocale(locale) || locale === "en") {
-            return invalid(`的「${locale}」不是支援的翻譯語言；英文寫在頂層 displayname / description。`);
-        }
-        if (!isRecord(text) || Object.keys(text).some((key) => !INFO_TEXT_FIELDS.has(key))) {
-            return invalid(`.${locale} 只接受 displayname 與 description。`);
-        }
-        const entry = {};
-        for (const field of INFO_TEXT_FIELDS) {
-            if (text[field] !== undefined) {
-                const checked = c.text(text[field], `i18n.info.${locale}.${field}`);
-                if (!checked) {
-                    return undefined;
-                }
-                entry[field] = checked;
-            }
-        }
-        info[locale] = entry;
-    }
-    return info;
-}
 /**
  * The nearest directory at or above `start` that holds dsm-package.yaml,
  * unless a Managed Profile project (synology-app.yaml) is found first.

package/dist/standalone/native-layout.d.ts

@@ -37,6 +37,8 @@ export interface NativeLayout {
     backend: {
         kind: 'native';
     };
+    /** Project-relative package icon; the CLI then owns PACKAGE_ICON*.PNG, the payload keeps its own window icons. */
+    icon?: string;
     layout: {
         payload: string;
         metadata: string;

package/dist/standalone/native-layout.js

@@ -8,6 +8,7 @@ import { parse } from 'yaml';
 import { createReproducibleTar } from '../build-spk/reproducible-archive.js';
 import { runCommand } from './build.js';
 import { resolveMinDsm } from '../build-spk/dsm-version.js';
+import { renderPackageIcons, writePackageCenterIcons } from '../build-spk/dsm-icons.js';
 export const LAYOUT_ARCHES = { x86_64: [2, 62], aarch64: [2, 183], armv8: [2, 183], armv7: [1, 40] };
 function fail(message) { throw Object.assign(new Error(`NATIVE_LAYOUT_INVALID: ${message}`), { code: 'NATIVE_LAYOUT_INVALID' }); }
 const digest = (bytes) => createHash('sha256').update(bytes).digest('hex');
@@ -61,6 +62,18 @@ function hook(value) {
             fail('invalid hook environment');
     return { command: h.command, cwd: pathText(h.cwd ?? '.'), env };
 }
+function icon(root, value) {
+    const path = pathText(value);
+    if (existsSync(resolve(root, path)))
+        inside(root, path);
+    try {
+        renderPackageIcons(resolve(root, path));
+    }
+    catch (error) {
+        fail(`icon: ${error.message}`);
+    }
+    return path;
+}
 export function isNativeLayout(root) {
     try {
         return (() => { const raw = parse(readFileSync(join(root, 'dsm-package.yaml'), 'utf8')); return raw?.layout !== undefined || raw?.backend?.kind === 'native'; })();
@@ -71,7 +84,7 @@ export function isNativeLayout(root) {
 }
 export function loadNativeLayout(root) {
     try {
-        const m = object(parse(readFileSync(join(root, 'dsm-package.yaml'), 'utf8')), ['schema', 'backend', 'package', 'version', 'build', 'displayname', 'description', 'maintainer', 'metadata', 'os_min_ver', 'privilege', 'arches', 'layout', 'native']);
+        const m = object(parse(readFileSync(join(root, 'dsm-package.yaml'), 'utf8')), ['schema', 'backend', 'package', 'version', 'build', 'displayname', 'description', 'maintainer', 'metadata', 'os_min_ver', 'privilege', 'arches', 'layout', 'native', 'icon']);
         if (m.schema !== 2)
             fail('schema 2 required; migrate schema: 1 to schema: 2 and add backend: {kind: native}');
         const backend = object(m.backend, ['kind']);
@@ -90,6 +103,8 @@ export function loadNativeLayout(root) {
             text(m[k]);
         if (!Array.isArray(m.arches) || !m.arches.length || new Set(m.arches).size !== m.arches.length || m.arches.some((a) => !Object.hasOwn(LAYOUT_ARCHES, a)))
             fail('invalid architecture list');
+        if (m.icon !== undefined)
+            m.icon = icon(root, m.icon);
         const layout = object(m.layout, ['payload', 'metadata', 'binaries', 'anchors']);
         layout.payload = pathText(layout.payload);
         layout.metadata = pathText(layout.metadata);
@@ -291,6 +306,7 @@ export async function buildNativeLayout(options) {
     const arches = options.arches ?? m.arches;
     if (!arches.length || new Set(arches).size !== arches.length || arches.some(a => !m.arches.includes(a)))
         fail('architecture not declared');
+    const icons = m.icon === undefined ? undefined : renderPackageIcons(inside(m.root, m.icon));
     const run = options.run ?? runCommand;
     const version = `${m.version}-${String(m.build).padStart(4, '0')}`;
     const env = { SYNOPKGLAND_PACKAGE: m.package, SYNOPKGLAND_VERSION: m.version, SYNOPKGLAND_BUILD: String(m.build), SYNOPKGLAND_SPK_VERSION: version, SYNOPKGLAND_PROJECT_DIR: m.root };
@@ -313,6 +329,11 @@ export async function buildNativeLayout(options) {
             for (const b of binaries)
                 checkLayoutBinary(payload, b, arch);
             copyTree(metadata, stage);
+            if (icons) {
+                if (['PACKAGE_ICON.PNG', 'PACKAGE_ICON_256.PNG'].some(name => existsSync(join(metadata, name))))
+                    fail('icon and PACKAGE_ICON files in the layout metadata are mutually exclusive; keep one');
+                writePackageCenterIcons(stage, icons);
+            }
             const target = join(stage, 'payload');
             mkdirSync(target);
             const files = copyTree(payload, target);

package/dist/standalone/spk.js

@@ -4,7 +4,7 @@ import { chmodSync, copyFileSync, existsSync, lstatSync, mkdirSync, mkdtempSync,
 import { tmpdir } from "node:os";
 import { dirname, join } from "node:path";
 import { infoArchValue } from "../build-spk/dsm-arch.js";
-import { writeDsmWindowIcons, writePackageCenterIcons } from "../build-spk/dsm-icons.js";
+import { packageIcons, writeDsmWindowIcons, writePackageCenterIcons } from "../build-spk/dsm-icons.js";
 import { renderNativePrivilege } from "../build-spk/native-lifecycle.js";
 import { renderUninstallWizardFiles } from "../build-spk/uninstall-wizard.js";
 import { renderInstallWizardFiles, renderNativeInstallWizard } from "../build-spk/install-wizard.js";
@@ -13,7 +13,8 @@ import { renderDelegateScopeSteps } from '../build-spk/delegate-scope.js';
 import { createReproducibleTar } from "../build-spk/reproducible-archive.js";
 import { renderStandaloneScript } from "./lifecycle.js";
 import { DSM_LANGS, LOCALES } from "./i18n.js";
-import { CGI_PAYLOAD_PATH, renderUiConfig, renderWindowScript, windowScriptName } from "./dsm-window.js";
+import { appTitle, CGI_PAYLOAD_PATH, renderUiConfig, renderWindowScript, windowScriptName } from "./dsm-window.js";
+import { writeUiTexts } from "../build-spk/ui-texts.js";
 import { copyStandaloneNotices } from "../build-spk/notices.js";
 import { hostScriptName, renderHostAdapterScript } from "./host-adapter.js";
 import { copyDaemonPayload } from "./daemon.js";
@@ -54,6 +55,7 @@ export async function assembleStandaloneSpk(options) {
     try {
         if ((manifest.capabilities.rootOps || manifest.capabilities.delegate) && !options.executor)
             throw new StandaloneBuildError("EXECUTOR_PIN_REQUIRED", "Executor artifact required.");
+        const icons = packageIcons(manifest.icon);
         const uiRoot = join(staging, "package", "ui");
         const appDir = join(uiRoot, "app");
         copyUiTree(manifest.ui.dir, appDir);
@@ -61,7 +63,8 @@ export async function assembleStandaloneSpk(options) {
         writeFile(join(uiRoot, "config"), renderUiConfig(manifest));
         writeFile(join(uiRoot, windowScriptName(manifest)), renderWindowScript(manifest, assetVersion));
         writeFile(join(uiRoot, hostScriptName(manifest.build)), renderHostAdapterScript(manifest.package));
-        writeDsmWindowIcons(uiRoot);
+        writeDsmWindowIcons(uiRoot, icons);
+        writeUiTexts(uiRoot, appTitle(manifest));
         const cgiTarget = join(staging, "package", CGI_PAYLOAD_PATH);
         mkdirSync(dirname(cgiTarget), { recursive: true });
         copyFileSync(options.cgiPath, cgiTarget);
@@ -129,7 +132,7 @@ export async function assembleStandaloneSpk(options) {
             ...(folder ? renderSharedFolderUpgradeWizardFiles(manifest.package, folder) : {}),
             ...renderUninstallWizardFiles(manifest.package, "native", { executor: Boolean(options.executor) }),
         });
-        writePackageCenterIcons(staging);
+        writePackageCenterIcons(staging, icons);
         mkdirSync(dirname(options.outputPath), { recursive: true });
         await createReproducibleTar(staging, options.outputPath);
     }

package/dist/templates/binary/dsm-package.yaml

@@ -5,6 +5,9 @@ version: 0.1.0
 build: 1
 displayname: __DISPLAY_NAME__
 description: A DSM package with a prebuilt binary CGI and DSM window UI.
+# Package Center and DSM window icon: a square PNG of at least 256x256, or a
+# folder of icon_<size>.png. Omit to use the SDK default icon.
+# icon: assets/icon.png
 maintainer: Your Name
 # Optional INFO/website metadata. Omit fields you do not need.
 # metadata:

package/dist/templates/compose/synology-app.yaml

@@ -3,6 +3,9 @@ package: com.synology.hello.files
 version: 0.1.0
 displayname: Hello Files
 description: A minimal headless app with a Shared Folder mount.
+# Package Center and DSM window icon: a square PNG of at least 256x256, or a
+# folder of icon_<size>.png. Omit to use the SDK default icon.
+# icon: assets/icon.png
 maintainer: Syno Package Land
 os_min_ver: "7.2.1-69057"
 

package/dist/templates/native-go/dsm-package.yaml

@@ -10,6 +10,9 @@ version: 0.1.0
 build: 1
 displayname: __DISPLAY_NAME__
 description: A native DSM package with a Go backend and a DSM window UI.
+# Package Center and DSM window icon: a square PNG of at least 256x256, or a
+# folder of icon_<size>.png. Omit to use the SDK default icon.
+# icon: assets/icon.png
 maintainer: Your Name
 # Optional INFO/website metadata. Omit fields you do not need.
 # metadata:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@synopackageland/cli",
-  "version": "0.7.1",
+  "version": "0.7.3",
   "description": "Syno Package Land Developer Kit CLI",
   "type": "module",
   "bin": {
@@ -11,6 +11,7 @@
   },
   "files": [
     "dist",
+    "assets",
     "CHANGELOG.md",
     "templates",
     "schema",

package/schema/synology-app.schema.json

@@ -43,6 +43,28 @@
       "type": "string",
       "minLength": 1
     },
+    "icon": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Package icon inside the project: a square PNG of at least 256x256, or a directory of icon_<size>.png (16, 24, 32, 48, 64, 72, 256; icon_256.png required). Omit to use the SDK default icon."
+    },
+    "i18n": {
+      "type": "object",
+      "description": "Translations; only info is allowed.",
+      "properties": {
+        "info": {
+          "type": "object",
+          "description": "Package Center INFO and DSM main menu and window title per locale (zh-TW, zh-CN, ja, ko, de, fr, es, it); English stays top level.",
+          "additionalProperties": {
+            "type": "object",
+            "properties": {
+              "displayname": { "type": "string", "minLength": 1 },
+              "description": { "type": "string", "minLength": 1 }
+            }
+          }
+        }
+      }
+    },
     "adminprotocol": {
       "type": "string"
     },

package/templates/binary/dsm-package.yaml

@@ -5,6 +5,9 @@ version: 0.1.0
 build: 1
 displayname: __DISPLAY_NAME__
 description: A DSM package with a prebuilt binary CGI and DSM window UI.
+# Package Center and DSM window icon: a square PNG of at least 256x256, or a
+# folder of icon_<size>.png. Omit to use the SDK default icon.
+# icon: assets/icon.png
 maintainer: Your Name
 # Optional INFO/website metadata. Omit fields you do not need.
 # metadata:

package/templates/compose/synology-app.yaml

@@ -3,6 +3,9 @@ package: com.synology.hello.files
 version: 0.1.0
 displayname: Hello Files
 description: A minimal headless app with a Shared Folder mount.
+# Package Center and DSM window icon: a square PNG of at least 256x256, or a
+# folder of icon_<size>.png. Omit to use the SDK default icon.
+# icon: assets/icon.png
 maintainer: Syno Package Land
 os_min_ver: "7.2.1-69057"
 

package/templates/native-go/dsm-package.yaml

@@ -10,6 +10,9 @@ version: 0.1.0
 build: 1
 displayname: __DISPLAY_NAME__
 description: A native DSM package with a Go backend and a DSM window UI.
+# Package Center and DSM window icon: a square PNG of at least 256x256, or a
+# folder of icon_<size>.png. Omit to use the SDK default icon.
+# icon: assets/icon.png
 maintainer: Your Name
 # Optional INFO/website metadata. Omit fields you do not need.
 # metadata: