reset-framework-cli 1.2.1 → 1.2.4

package/src/lib/output.js

@@ -1,268 +1,283 @@
-import path from "node:path"
-import { cp, mkdir, readdir, rm, writeFile } from "node:fs/promises"
-import { existsSync } from "node:fs"
-
-import { logger } from "./logger.js"
-import { runCommand } from "./process.js"
-import {
-  resolveFrameworkRuntimeBinary,
-  resolveFrameworkRuntimeOutputDir
-} from "./project.js"
-
-function escapePlistString(value) {
-  return value
-    .replaceAll("&", "&")
-    .replaceAll("<", "&lt;")
-    .replaceAll(">", "&gt;")
-}
-
-function serializePlistValue(value, indentLevel = 1) {
-  const indent = "  ".repeat(indentLevel)
-
-  if (Array.isArray(value)) {
-    if (value.length === 0) {
-      return `${indent}<array/>\n`
-    }
-
-    return (
-      `${indent}<array>\n` +
-      value.map((entry) => serializePlistValue(entry, indentLevel + 1)).join("") +
-      `${indent}</array>\n`
-    )
-  }
-
-  if (typeof value === "object" && value !== null) {
-    const entries = Object.entries(value)
-    if (entries.length === 0) {
-      return `${indent}<dict/>\n`
-    }
-
-    return (
-      `${indent}<dict>\n` +
-      entries
-        .map(
-          ([key, entryValue]) =>
-            `${"  ".repeat(indentLevel + 1)}<key>${escapePlistString(key)}</key>\n${serializePlistValue(entryValue, indentLevel + 1)}`
-        )
-        .join("") +
-      `${indent}</dict>\n`
-    )
-  }
-
-  if (typeof value === "boolean") {
-    return `${indent}<${value ? "true" : "false"}/>\n`
-  }
-
-  if (typeof value === "number") {
-    return `${indent}<integer>${value}</integer>\n`
-  }
-
-  return `${indent}<string>${escapePlistString(String(value))}</string>\n`
-}
-
-function buildMacOSInfoPlist(config) {
-  const urlTypes = Array.isArray(config.protocols?.schemes)
-    ? config.protocols.schemes.map((schemeConfig) => ({
-        CFBundleTypeRole: schemeConfig.role ?? "Viewer",
-        CFBundleURLName:
-          typeof schemeConfig.name === "string" && schemeConfig.name.trim() !== ""
-            ? schemeConfig.name
-            : `${config.appId}.${schemeConfig.scheme}`,
-        CFBundleURLSchemes: [schemeConfig.scheme]
-      }))
-    : []
-
-  const plist = {
-    CFBundleDevelopmentRegion: "English",
-    CFBundleDisplayName: config.productName,
-    CFBundleExecutable: "reset-framework",
-    CFBundleIdentifier: config.appId,
-    CFBundleInfoDictionaryVersion: "6.0",
-    CFBundleName: config.productName,
-    CFBundlePackageType: "APPL",
-    CFBundleShortVersionString: config.version,
-    CFBundleVersion: config.version,
-    CSResourcesFileMapped: true
-  }
-
-  if (urlTypes.length > 0) {
-    plist.CFBundleURLTypes = urlTypes
-  }
-
-  return (
-    `<?xml version="1.0" encoding="UTF-8"?>\n` +
-    `<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">\n` +
-    `<plist version="1.0">\n` +
-    serializePlistValue(plist, 0) +
-    `</plist>\n`
-  )
-}
-
-function shouldCopyWindowsRuntimeArtifact(entryName) {
-  const extension = path.extname(entryName).toLowerCase()
-
-  return [
-    ".bin",
-    ".dat",
-    ".dll",
-    ".exe",
-    ".json",
-    ".manifest",
-    ".pak",
-    ".pri"
-  ].includes(extension)
-}
-
-function escapePowerShellLiteral(value) {
-  return String(value).replaceAll("'", "''")
-}
-
-export async function stageMacOSAppBundle(frameworkPaths, frameworkBuildPaths, config, options = {}) {
-  const { dryRun = false, outputPaths, configPath, preferSource = false } = options
-  const runtimeSourceBundle = resolveFrameworkRuntimeOutputDir(frameworkPaths, frameworkBuildPaths, "release", {
-    mustExist: !dryRun,
-    preferSource
-  })
-
-  if (!outputPaths) {
-    throw new Error("stageMacOSAppBundle requires resolved output paths")
-  }
-
-  if (!existsSync(outputPaths.frontendEntryFile) && !dryRun) {
-    throw new Error(
-      `Missing frontend build output at ${outputPaths.frontendEntryFile}. Run the frontend build first.`
-    )
-  }
-
-  logger.info(`Staging app bundle into ${outputPaths.appBundlePath}`)
-
-  if (dryRun) {
-    logger.info(`- copy ${runtimeSourceBundle} -> ${outputPaths.appBundlePath}`)
-    logger.info(`- copy ${configPath} -> ${outputPaths.bundledConfigPath}`)
-    logger.info(`- copy ${outputPaths.frontendDistDir} -> ${outputPaths.bundledFrontendDir}`)
-    return outputPaths
-  }
-
-  await mkdir(outputPaths.macosDir, { recursive: true })
-  await rm(outputPaths.appBundlePath, { recursive: true, force: true })
-  await cp(runtimeSourceBundle, outputPaths.appBundlePath, { recursive: true })
-
-  await mkdir(outputPaths.resourcesDir, { recursive: true })
-  await cp(configPath, outputPaths.bundledConfigPath, { force: true })
-  await rm(outputPaths.bundledFrontendDir, { recursive: true, force: true })
-  await cp(outputPaths.frontendDistDir, outputPaths.bundledFrontendDir, { recursive: true })
-  await writeFile(
-    path.join(outputPaths.appBundlePath, "Contents", "Info.plist"),
-    buildMacOSInfoPlist(config),
-    "utf8"
-  )
-
-  return outputPaths
-}
-
-export async function stageWindowsAppBundle(frameworkPaths, frameworkBuildPaths, config, options = {}) {
-  const { dryRun = false, outputPaths, configPath, preferSource = false } = options
-  const runtimeSourceBinary = resolveFrameworkRuntimeBinary(frameworkPaths, frameworkBuildPaths, "release", {
-    mustExist: !dryRun,
-    preferSource
-  })
-  const runtimeSourceDir = resolveFrameworkRuntimeOutputDir(frameworkPaths, frameworkBuildPaths, "release", {
-    mustExist: !dryRun,
-    preferSource
-  })
-
-  if (!outputPaths) {
-    throw new Error("stageWindowsAppBundle requires resolved output paths")
-  }
-
-  if (!existsSync(outputPaths.frontendEntryFile) && !dryRun) {
-    throw new Error(
-      `Missing frontend build output at ${outputPaths.frontendEntryFile}. Run the frontend build first.`
-    )
-  }
-
-  logger.info(`Staging Windows app into ${outputPaths.appBundlePath}`)
-
-  if (dryRun) {
-    logger.info(`- copy ${runtimeSourceDir} -> ${outputPaths.appBundlePath}`)
-    logger.info(`- rename ${runtimeSourceBinary} -> ${outputPaths.appExecutablePath}`)
-    logger.info(`- copy ${configPath} -> ${outputPaths.bundledConfigPath}`)
-    logger.info(`- copy ${outputPaths.frontendDistDir} -> ${outputPaths.bundledFrontendDir}`)
-    return outputPaths
-  }
-
-  await mkdir(outputPaths.windowsDir, { recursive: true })
-  await rm(outputPaths.appBundlePath, { recursive: true, force: true })
-  await mkdir(outputPaths.appBundlePath, { recursive: true })
-  const runtimeEntries = await readdir(runtimeSourceDir, { withFileTypes: true })
-  const runtimeBinaryName = path.basename(runtimeSourceBinary)
-
-  for (const entry of runtimeEntries) {
-    if (!entry.isDirectory() && !shouldCopyWindowsRuntimeArtifact(entry.name)) {
-      continue
-    }
-
-    const sourcePath = path.join(runtimeSourceDir, entry.name)
-    const targetPath =
-      entry.name.toLowerCase() === runtimeBinaryName.toLowerCase()
-        ? outputPaths.appExecutablePath
-        : path.join(outputPaths.appBundlePath, entry.name)
-
-    await cp(sourcePath, targetPath, { recursive: true, force: true })
-  }
-
-  await mkdir(outputPaths.resourcesDir, { recursive: true })
-  await cp(configPath, outputPaths.bundledConfigPath, { force: true })
-  await rm(outputPaths.bundledFrontendDir, { recursive: true, force: true })
-  await cp(outputPaths.frontendDistDir, outputPaths.bundledFrontendDir, { recursive: true })
-
-  return outputPaths
-}
-
-export async function createMacOSZipArchive(outputPaths, options = {}) {
-  const { dryRun = false } = options
-
-  logger.info(`Packaging ${outputPaths.appBundlePath} -> ${outputPaths.zipPath}`)
-
-  if (process.platform !== "darwin") {
-    throw new Error("Packaging is only implemented for macOS right now")
-  }
-
-  if (!dryRun) {
-    await mkdir(outputPaths.packagesDir, { recursive: true })
-  }
-
-  await runCommand(
-    "ditto",
-    ["-c", "-k", "--sequesterRsrc", "--keepParent", outputPaths.appBundlePath, outputPaths.zipPath],
-    { dryRun }
-  )
-}
-
-export async function createWindowsZipArchive(outputPaths, options = {}) {
-  const { dryRun = false } = options
-
-  logger.info(`Packaging ${outputPaths.appBundlePath} -> ${outputPaths.zipPath}`)
-
-  if (process.platform !== "win32") {
-    throw new Error("Packaging is only implemented for Windows and macOS right now")
-  }
-
-  if (!dryRun) {
-    await mkdir(outputPaths.packagesDir, { recursive: true })
-    await rm(outputPaths.zipPath, { force: true })
-  }
-
-  const literalSourcePath = escapePowerShellLiteral(outputPaths.appBundlePath)
-  const literalDestinationPath = escapePowerShellLiteral(outputPaths.zipPath)
-  const archiveCommand = [
-    "$ErrorActionPreference = 'Stop'",
-    `Compress-Archive -LiteralPath '${literalSourcePath}' -DestinationPath '${literalDestinationPath}' -CompressionLevel Optimal`
-  ].join("; ")
-
-  await runCommand(
-    "powershell.exe",
-    ["-NoLogo", "-NoProfile", "-NonInteractive", "-Command", archiveCommand],
-    { dryRun }
-  )
-}
+import path from "node:path"
+import { cp, mkdir, readdir, rm, writeFile } from "node:fs/promises"
+import { existsSync } from "node:fs"
+
+import { stageAppBackend } from "./backend.js"
+import { logger } from "./logger.js"
+import { runCommand } from "./process.js"
+import {
+  resolveFrameworkRuntimeBinary,
+  resolveFrameworkRuntimeOutputDir
+} from "./project.js"
+
+function escapePlistString(value) {
+  return value
+    .replaceAll("&", "&amp;")
+    .replaceAll("<", "&lt;")
+    .replaceAll(">", "&gt;")
+}
+
+function serializePlistValue(value, indentLevel = 1) {
+  const indent = "  ".repeat(indentLevel)
+
+  if (Array.isArray(value)) {
+    if (value.length === 0) {
+      return `${indent}<array/>\n`
+    }
+
+    return (
+      `${indent}<array>\n` +
+      value.map((entry) => serializePlistValue(entry, indentLevel + 1)).join("") +
+      `${indent}</array>\n`
+    )
+  }
+
+  if (typeof value === "object" && value !== null) {
+    const entries = Object.entries(value)
+    if (entries.length === 0) {
+      return `${indent}<dict/>\n`
+    }
+
+    return (
+      `${indent}<dict>\n` +
+      entries
+        .map(
+          ([key, entryValue]) =>
+            `${"  ".repeat(indentLevel + 1)}<key>${escapePlistString(key)}</key>\n${serializePlistValue(entryValue, indentLevel + 1)}`
+        )
+        .join("") +
+      `${indent}</dict>\n`
+    )
+  }
+
+  if (typeof value === "boolean") {
+    return `${indent}<${value ? "true" : "false"}/>\n`
+  }
+
+  if (typeof value === "number") {
+    return `${indent}<integer>${value}</integer>\n`
+  }
+
+  return `${indent}<string>${escapePlistString(String(value))}</string>\n`
+}
+
+function buildMacOSInfoPlist(config) {
+  const urlTypes = Array.isArray(config.protocols?.schemes)
+    ? config.protocols.schemes.map((schemeConfig) => ({
+        CFBundleTypeRole: schemeConfig.role ?? "Viewer",
+        CFBundleURLName:
+          typeof schemeConfig.name === "string" && schemeConfig.name.trim() !== ""
+            ? schemeConfig.name
+            : `${config.appId}.${schemeConfig.scheme}`,
+        CFBundleURLSchemes: [schemeConfig.scheme]
+      }))
+    : []
+
+  const plist = {
+    CFBundleDevelopmentRegion: "English",
+    CFBundleDisplayName: config.productName,
+    CFBundleExecutable: "reset-framework",
+    CFBundleIdentifier: config.appId,
+    CFBundleInfoDictionaryVersion: "6.0",
+    CFBundleName: config.productName,
+    CFBundlePackageType: "APPL",
+    CFBundleShortVersionString: config.version,
+    CFBundleVersion: config.version,
+    CSResourcesFileMapped: true
+  }
+
+  if (urlTypes.length > 0) {
+    plist.CFBundleURLTypes = urlTypes
+  }
+
+  return (
+    `<?xml version="1.0" encoding="UTF-8"?>\n` +
+    `<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">\n` +
+    `<plist version="1.0">\n` +
+    serializePlistValue(plist, 0) +
+    `</plist>\n`
+  )
+}
+
+function shouldCopyWindowsRuntimeArtifact(entryName) {
+  const extension = path.extname(entryName).toLowerCase()
+
+  return [
+    ".bin",
+    ".dat",
+    ".dll",
+    ".exe",
+    ".json",
+    ".manifest",
+    ".pak",
+    ".pri"
+  ].includes(extension)
+}
+
+function escapePowerShellLiteral(value) {
+  return String(value).replaceAll("'", "''")
+}
+
+export async function stageMacOSAppBundle(frameworkPaths, frameworkBuildPaths, config, options = {}) {
+  const { dryRun = false, outputPaths, configPath, preferSource = false, backendArtifact = null } = options
+  const runtimeSourceBundle = resolveFrameworkRuntimeOutputDir(frameworkPaths, frameworkBuildPaths, "release", {
+    mustExist: !dryRun,
+    preferSource
+  })
+
+  if (!outputPaths) {
+    throw new Error("stageMacOSAppBundle requires resolved output paths")
+  }
+
+  if (!existsSync(outputPaths.frontendEntryFile) && !dryRun) {
+    throw new Error(
+      `Missing frontend build output at ${outputPaths.frontendEntryFile}. Run the frontend build first.`
+    )
+  }
+
+  logger.info(`Staging app bundle into ${outputPaths.appBundlePath}`)
+
+  if (dryRun) {
+    logger.info(`- copy ${runtimeSourceBundle} -> ${outputPaths.appBundlePath}`)
+    logger.info(`- copy ${configPath} -> ${outputPaths.bundledConfigPath}`)
+    logger.info(`- copy ${outputPaths.frontendDistDir} -> ${outputPaths.bundledFrontendDir}`)
+    if (backendArtifact) {
+      logger.info(`- copy ${backendArtifact.bundleEntryPath} -> ${outputPaths.bundledBackendEntryPath}`)
+      logger.info(`- copy ${backendArtifact.runnerPath} -> ${outputPaths.bundledBackendRunnerPath}`)
+      logger.info(`- copy ${backendArtifact.supportModulePath} -> ${outputPaths.bundledBackendSupportModulePath}`)
+      logger.info(`- copy ${backendArtifact.runtimeExecutablePath} -> ${outputPaths.bundledBackendRuntimePath}`)
+    }
+    return outputPaths
+  }
+
+  await mkdir(outputPaths.macosDir, { recursive: true })
+  await rm(outputPaths.appBundlePath, { recursive: true, force: true })
+  await cp(runtimeSourceBundle, outputPaths.appBundlePath, { recursive: true })
+
+  await mkdir(outputPaths.resourcesDir, { recursive: true })
+  await cp(configPath, outputPaths.bundledConfigPath, { force: true })
+  await rm(outputPaths.bundledFrontendDir, { recursive: true, force: true })
+  await cp(outputPaths.frontendDistDir, outputPaths.bundledFrontendDir, { recursive: true })
+  await stageAppBackend(backendArtifact, outputPaths)
+  await writeFile(
+    path.join(outputPaths.appBundlePath, "Contents", "Info.plist"),
+    buildMacOSInfoPlist(config),
+    "utf8"
+  )
+
+  return outputPaths
+}
+
+export async function stageWindowsAppBundle(frameworkPaths, frameworkBuildPaths, config, options = {}) {
+  const { dryRun = false, outputPaths, configPath, preferSource = false, backendArtifact = null } = options
+  const runtimeSourceBinary = resolveFrameworkRuntimeBinary(frameworkPaths, frameworkBuildPaths, "release", {
+    mustExist: !dryRun,
+    preferSource
+  })
+  const runtimeSourceDir = resolveFrameworkRuntimeOutputDir(frameworkPaths, frameworkBuildPaths, "release", {
+    mustExist: !dryRun,
+    preferSource
+  })
+
+  if (!outputPaths) {
+    throw new Error("stageWindowsAppBundle requires resolved output paths")
+  }
+
+  if (!existsSync(outputPaths.frontendEntryFile) && !dryRun) {
+    throw new Error(
+      `Missing frontend build output at ${outputPaths.frontendEntryFile}. Run the frontend build first.`
+    )
+  }
+
+  logger.info(`Staging Windows app into ${outputPaths.appBundlePath}`)
+
+  if (dryRun) {
+    logger.info(`- copy ${runtimeSourceDir} -> ${outputPaths.appBundlePath}`)
+    logger.info(`- rename ${runtimeSourceBinary} -> ${outputPaths.appExecutablePath}`)
+    logger.info(`- copy ${configPath} -> ${outputPaths.bundledConfigPath}`)
+    logger.info(`- copy ${outputPaths.frontendDistDir} -> ${outputPaths.bundledFrontendDir}`)
+    if (backendArtifact) {
+      logger.info(`- copy ${backendArtifact.bundleEntryPath} -> ${outputPaths.bundledBackendEntryPath}`)
+      logger.info(`- copy ${backendArtifact.runnerPath} -> ${outputPaths.bundledBackendRunnerPath}`)
+      logger.info(`- copy ${backendArtifact.supportModulePath} -> ${outputPaths.bundledBackendSupportModulePath}`)
+      logger.info(`- copy ${backendArtifact.runtimeExecutablePath} -> ${outputPaths.bundledBackendRuntimePath}`)
+    }
+    return outputPaths
+  }
+
+  await mkdir(outputPaths.windowsDir, { recursive: true })
+  await rm(outputPaths.appBundlePath, { recursive: true, force: true })
+  await mkdir(outputPaths.appBundlePath, { recursive: true })
+  const runtimeEntries = await readdir(runtimeSourceDir, { withFileTypes: true })
+  const runtimeBinaryName = path.basename(runtimeSourceBinary)
+
+  for (const entry of runtimeEntries) {
+    if (!entry.isDirectory() && !shouldCopyWindowsRuntimeArtifact(entry.name)) {
+      continue
+    }
+
+    const sourcePath = path.join(runtimeSourceDir, entry.name)
+    const targetPath =
+      entry.name.toLowerCase() === runtimeBinaryName.toLowerCase()
+        ? outputPaths.appExecutablePath
+        : path.join(outputPaths.appBundlePath, entry.name)
+
+    await cp(sourcePath, targetPath, { recursive: true, force: true })
+  }
+
+  await mkdir(outputPaths.resourcesDir, { recursive: true })
+  await cp(configPath, outputPaths.bundledConfigPath, { force: true })
+  await rm(outputPaths.bundledFrontendDir, { recursive: true, force: true })
+  await cp(outputPaths.frontendDistDir, outputPaths.bundledFrontendDir, { recursive: true })
+  await stageAppBackend(backendArtifact, outputPaths)
+
+  return outputPaths
+}
+
+export async function createMacOSZipArchive(outputPaths, options = {}) {
+  const { dryRun = false } = options
+
+  logger.info(`Packaging ${outputPaths.appBundlePath} -> ${outputPaths.zipPath}`)
+
+  if (process.platform !== "darwin") {
+    throw new Error("Packaging is only implemented for macOS right now")
+  }
+
+  if (!dryRun) {
+    await mkdir(outputPaths.packagesDir, { recursive: true })
+  }
+
+  await runCommand(
+    "ditto",
+    ["-c", "-k", "--sequesterRsrc", "--keepParent", outputPaths.appBundlePath, outputPaths.zipPath],
+    { dryRun }
+  )
+}
+
+export async function createWindowsZipArchive(outputPaths, options = {}) {
+  const { dryRun = false } = options
+
+  logger.info(`Packaging ${outputPaths.appBundlePath} -> ${outputPaths.zipPath}`)
+
+  if (process.platform !== "win32") {
+    throw new Error("Packaging is only implemented for Windows and macOS right now")
+  }
+
+  if (!dryRun) {
+    await mkdir(outputPaths.packagesDir, { recursive: true })
+    await rm(outputPaths.zipPath, { force: true })
+  }
+
+  const literalSourcePath = escapePowerShellLiteral(outputPaths.appBundlePath)
+  const literalDestinationPath = escapePowerShellLiteral(outputPaths.zipPath)
+  const archiveCommand = [
+    "$ErrorActionPreference = 'Stop'",
+    `Compress-Archive -LiteralPath '${literalSourcePath}' -DestinationPath '${literalDestinationPath}' -CompressionLevel Optimal`
+  ].join("; ")
+
+  await runCommand(
+    "powershell.exe",
+    ["-NoLogo", "-NoProfile", "-NonInteractive", "-Command", archiveCommand],
+    { dryRun }
+  )
+}