設定

プロジェクトルートの murasaki.config.ts(または .js / .mjs)は、アプリの識別情 報、ウィンドウ、ビルド設定を記述します:

import { defineConfig } from 'murasaki'

export default defineConfig({
  appId: 'app.murasaki.example',
  productName: 'Murasaki App',
  version: '0.1.0',
  icon: 'assets/icon.png',
  window: {
    title: 'Murasaki App',
    width: 1000,
    height: 700,
  },
  capabilities: ['dialog:openFile', 'clipboard:writeText'],
})

defineConfig は型推論用に同じobjectを返し、宣言windowのlabel / routeを同期的に 検証します。awaitは不要です。

トップレベルのフィールド

window

windows

window は予約label main を持つprimaryです。secondaryは windows に宣言し、 primary専用の console を除く同じshapeでroute、初期表示、command allowlistを 個別設定します。

window: {
  route: '/',
  capabilities: ['window:open', 'window:list', 'window:manage'],
},
windows: {
  settings: {
    route: '/settings',
    width: 720,
    height: 560,
    capabilities: [],
  },
},

labelは安全な1〜64文字で、mainは予約済みです。secondaryは非表示で作成され、 top-level permissionを継承しません。console はWindows backend console全体を制御する ため、secondaryに書くと拒否されます。lifecycle / renderer APIは ウィンドウと権限を参照してください。

capabilities

レンダラー向けネイティブAPIはデフォルトですべて拒否されます。アプリが実際に使う コマンドだけを追加してください。未知のpermissionは何も許可しません。

capabilities: [
  'app:quit',
  'dialog:openFile',
  'clipboard:readText',
  'clipboard:writeText',
  'notification:show',
  'shell:openExternal',
  'window:setTitle',
]

完全な型付き一覧は NativeCapability です。primaryは window.capabilities ?? capabilities ?? []、secondaryは自身のlistまたは[]を使い、 call元rendererごとに評価します。別originのページはnative bridgeを利用できません。 window管理では window:getLabel、window:open、window:list、window:manage を使います。 applicationのprogrammatic shutdownには app:quit が必要です。built-in updaterを有効に すると、検証済みrestart handshake用としてprimary windowへ自動付与されます。

systemPermissions

これは信頼するrenderer commandではなく、host OSの同意を宣言するconfigです。packaged macOS appではcamera / microphoneの用途説明をInfo.plistへ書き込み、選択した権限を起動時 に要求できます。

systemPermissions: {
  macOS: {
    camera: {
      usageDescription: 'ビデオ通話でカメラを使用します。',
      requestOnLaunch: true,
    },
    microphone: {
      usageDescription: '音声通話でマイクを使用します。',
    },
    screenRecording: { requestOnLaunch: false },
    accessibility: { requestOnLaunch: false },
  },
},

機能の必要性をuserが理解できる場合は、起動時promptより文脈に沿った systemPermission.request()を優先してください。runtime callにはrenderer capabilityの systemPermission:status / systemPermission:requestも必要です。Windows unpackaged desktopの同意は利用時に発生するため、汎用的な起動時promptはありません。macOS TCCの 実動作はmurasaki devのterminal / Node identityではなくpackaged appで確認してください。

main

src/main.ts が存在すると Murasaki が読み込みます。別 entry、graceful cleanup deadline、 Main discovery の無効化を設定できます。

main: {
  entry: 'src/backend/main.ts',
  shutdownTimeoutMs: 15_000,
}
// main: false

lifecycle hook と 'use main' は Node Mainを参照してください。

protocols

custom URL scheme を登録し、一致する URL を Node Main の openRequested() hook で 受け取ります。

protocols: [
  { scheme: 'violet', name: 'Violet Link' },
]

重複または不正な scheme は build error になります。macOS は packaged .app の Info.plist に登録情報を書き込みます。Windows は NSIS / MSI installer が OS へ登録し、 portable Windows archive は登録しません。Linux registration は未実装です。

fileAssociations

1つ以上の extension を document type として登録します。

fileAssociations: [
  {
    extensions: ['vnote', 'violet-note'],
    name: 'Violet Note',
    description: 'Violet で作成したノート',
    role: 'editor',
    mimeType: 'application/x-violet-note',
  },
]

extension は全 entry 間で一意である必要があり、不正な extension / MIME type は build error になります。一致した file は Node Main の openRequested() hook に届きます。 artifact の制約は protocols と同じです。packaged macOS .app と install 済み Windows NSIS / MSI をサポートし、portable Windows archive、Linux、murasaki dev は association を install しません。

delivery semantics、testing、untrusted-input requirement は Deep Link と File Associationを参照してください。

bundle

server / Main code は本番向けに compile されます。static bare npm import は自動検出・ stage されます。runtime behavior を静的検出できない dependency / asset に次を使います。

bundle: {
  external: ['computed-plugin'],
  noExternal: ['small-js-only-package'],
  resources: [
    'prisma/schema.prisma',
    { from: 'prisma/migrations', to: 'database/migrations' },
  ],
}

resources に secret を置かないでください。app bundle 内は user が読めます。native addon は全 target architecture でテストしてください。

build

build: {
  before: 'pnpm --filter @acme/database build && pnpm prisma generate',
  envPrefix: ['VITE_', 'NEXT_PUBLIC_'],
}

prefix付き変数はclient公開用ですが、secretを置かないでください。Viteが値を配布JavaScriptへ 埋め込みます。packaged Node Mainはlauncherの環境を継承し、Murasakiは.envをappへ コピーしません。end-user runtime設定はcontext.paths.dataかdeployment環境を使います。

security

Murasakiはframework shellとuser-owned index.htmlの両方へ、環境別のContent Security Policyを1つ注入します。完全な置き換え、または明示的なopt-outを設定できます。

security: {
  csp: "default-src 'self'; script-src 'self'; style-src 'self' 'unsafe-inline'; connect-src 'self' https: wss:; object-src 'none'; base-uri 'none'; frame-src 'none'",
},

// 別layerがpolicyを管理する場合のescape hatch:
// security: { csp: false },

index.htmlにCSPの<meta http-equiv>がすでにあれば、そのuser-owned policyを維持しつつ script / resourceより先に適用されるよう<head>先頭へ移動します。policyは必ず1か所で 管理してください。既存tagとsecurity.csp stringの併用はbuild errorです。設定値は空でない 1行のstringに限り、control character、double quote、 <、>は使えません。既定値、migration、meta配信CSPの制約は セキュリティを参照してください。

updater

true は、通常の OSS アプリにとって完全に動作する設定です — GitHub リポジトリは package.json の repository フィールドから、公開鍵は .murasaki/update-key.pub から推論され、チャンネルはデフォルトで 'stable'、起動時に一度だけチェックします。 オブジェクト形式では、これらのデフォルトに合わない部分だけを上書きすればよいです:

type UpdaterConfig =
  | boolean
  | {
      repo?: string                    // "owner/repo" — デフォルトは package.json#repository
      endpoint?: string                // セルフホストのマニフェスト URL — repo とは排他
      channel?: string                 // リリースチャンネル、デフォルト 'stable'
      checkOnStart?: boolean           // 起動時に一度チェック、デフォルト true
      checkInterval?: string | false   // 例 '6h' — タイマーで再チェック、デフォルト '6h'
      publicKey?: string               // base64 の Ed25519 公開鍵 — デフォルトは .murasaki/update-key.pub
    }

意図的に provider フィールドはありません — GitHub かセルフホストかは、repo と endpoint のどちらが設定されているかから推論されるため、設定の他の部分とずれることが ありません。また、署名検証を無効化する方法もありません。

checkOnStart と checkInterval は更新エンジン自身が処理するため、UI 側で check() を呼ばなくても機能します。useUpdate().check() を手動で呼ぶこともできます — チェックが実行中のときに二重に走ることはありません。

useUpdate() と <UpdateButton />(いずれも murasaki から)から利用されます — マニフェストの形式、署名、リリースの公開については、完全な 自動更新ガイドを参照してください。

installer

macOS DMG styling と Windows NSIS / MSI installer option です。省略時は Murasaki の 既定値を使います。

installer.windows

sign

Murasaki はあなた自身の証明書または signing provider で署名し、独自の証明書は 一切同梱しません。公証の認証情報と PFX password はこの設定ではなく、常に環境変数から 読み取ります — 詳しくは Distribution → Signingを参照 してください。

macOS fields

sign.windows

murasaki bundle --sign --target win32-x64 は portable ZIP 作成前に app executable を 署名します。murasaki installer --sign --target win32-x64 は生成した NSIS setup と MSI も署名し、すべてを Authenticode policy で検証します。Windows と SignTool が必要です。

CI 用の環境変数 override は Windows installer と signingを参照してください。

次へ