@tryghost/app-sdk 0.1.0-alpha.2 → 0.1.0-alpha.21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1 @@
1
+ {"version":3,"file":"sign-B1y31TLX.js","names":[],"sources":["../../../../contracts/app-contracts/build/manifest/localhost.js","../../../../contracts/app-contracts/build/manifest/ghost-host.js","../../../../contracts/app-contracts/build/manifest/id.js","../../../../contracts/app-contracts/build/manifest/limits.js","../../../../contracts/app-contracts/build/identity/loading.js","../../../../contracts/app-contracts/build/identity/signed-manifest.js","../../src/tooling/git.ts","../../src/tooling/keys.ts","../../../../contracts/app-contracts/build/manifest/icon.js","../../../../contracts/app-contracts/build/manifest/keys.js","../../../../contracts/app-contracts/build/manifest/surfaces.js","../../../../contracts/app-contracts/build/manifest/text.js","../../../../contracts/app-contracts/build/manifest/url.js","../../../../contracts/app-contracts/build/manifest/schema.js","../../../../contracts/app-contracts/build/manifest/parse.js","../../src/tooling/sign.ts"],"sourcesContent":["// `URL` has already normalised the host by the time these run: every spelling of an IPv4\n// address is dotted decimal, and an IPv4-mapped IPv6 address is two hex groups.\nconst LOOPBACK_HOSTS = [\n /^localhost$/,\n /\\.localhost$/,\n /^127\\.\\d+\\.\\d+\\.\\d+$/,\n /^0\\.0\\.0\\.0$/,\n /^\\[::1?\\]$/,\n /^\\[::ffff:7f[0-9a-f]{2}:[0-9a-f]{1,4}\\]$/,\n /^\\[::ffff:0:0\\]$/,\n];\n/**\n * A hostname without its trailing dots, which the URL parser keeps, every one of them:\n * `localhost..` is `localhost`. A loop rather than a regular expression, which would take\n * time quadratic in the number of dots on a hostname with many dots before its end.\n */\nexport function withoutTrailingDots(hostname) {\n let end = hostname.length;\n while (end > 0 && hostname[end - 1] === '.') {\n end -= 1;\n }\n return hostname.slice(0, end);\n}\n/**\n * Whether a host is the machine itself: `localhost`, or a loopback or unspecified address.\n * Pass `URL.hostname`, so the host is already normalised. Trailing dots are dropped, as\n * `isGhostHost` drops them.\n */\nexport function isLocalhost(hostname) {\n const host = withoutTrailingDots(hostname);\n return LOOPBACK_HOSTS.some((pattern) => pattern.test(host));\n}\n//# sourceMappingURL=localhost.js.map","import { withoutTrailingDots } from './localhost.js';\n/**\n * Whether a URL is on a host Ghost itself is served from: the site's, or Admin's, on any\n * port and over either scheme. A page on Ghost's origin would be Ghost, not the app,\n * whatever a frame's sandbox says. On another port it would be the app's, but browsers send\n * a host's cookies to every port on it, so the app's server would be sent the staff user's\n * session. So Ghost refuses a manifest URL on such a host, and Admin asks again where it\n * frames the page, since the site's or Admin's address can change after an app is\n * installed.\n *\n * Hosts are compared as the URL parser reads them, so case and IDN spellings agree, and\n * without a trailing dot. A sibling host, such as another subdomain of the site's, is not\n * Ghost's: the cookies Ghost sets are host-only. Nor is a name under Ghost's, such as\n * `my-app.localhost` next to `localhost`, or another name for the same machine, such as\n * `127.0.0.1`, which browsers treat as other hosts too.\n *\n * Any doubt counts as Ghost's: a URL that isn't http or https, a Ghost URL like that, or no\n * Ghost URLs at all. Either way the URL is refused.\n */\nexport function isGhostHost(url, ghostUrls) {\n const host = hostOf(url);\n if (host === null) {\n return true;\n }\n let known = false;\n for (const ghostUrl of ghostUrls) {\n const ghostHost = hostOf(ghostUrl);\n if (ghostHost === null || ghostHost === host) {\n return true;\n }\n known = true;\n }\n return !known;\n}\n/** An http or https URL's host as `isGhostHost` compares it, or null for any other. */\nexport function hostOf(value) {\n let url;\n // Admin runs this, and `URL.parse` is newer than the browsers Admin supports.\n try {\n url = new URL(value);\n }\n catch {\n return null;\n }\n if (url.protocol !== 'http:' && url.protocol !== 'https:') {\n return null;\n }\n return withoutTrailingDots(url.hostname) || null;\n}\n//# sourceMappingURL=ghost-host.js.map","/** Matches the limit of the index that ties saved cards to an app. */\nexport const APP_ID_MAX_LENGTH = 191;\nconst ID_SEGMENT = /^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$/;\n/**\n * An app ID is reverse-domain style: at least two dot-separated segments of lowercase\n * letters, digits and hyphens, starting with a letter so that an IP address or a version\n * number is not an ID. IDs are compared exactly, so an uppercase ID is invalid rather than\n * lowercased.\n */\nexport function isValidAppId(value) {\n if (typeof value !== 'string' || value.length > APP_ID_MAX_LENGTH) {\n return false;\n }\n const segments = value.split('.');\n return (segments.length >= 2 &&\n /^[a-z]/.test(value) &&\n segments.every((segment) => ID_SEGMENT.test(segment)));\n}\n//# sourceMappingURL=id.js.map","/**\n * The longest URL a manifest may hold, measured once resolved. Ghost stores every one of\n * them, the manifest's own URL included, so its columns are exactly this wide.\n */\nexport const URL_MAX_LENGTH = 2000;\n//# sourceMappingURL=limits.js.map","// How Ghost reads the signed manifest an app serves. Ghost core reads it by these, and the app\n// SDK signs by them, so a manifest it signs is one Ghost reads.\n/** The largest manifest Ghost stores, which it keeps in a TEXT column. */\nexport const MANIFEST_MAX_BYTES = 64 * 1024;\n/**\n * The largest signed manifest Ghost reads: the manifest in base64url is a third larger, and\n * the header and signature are well under a kilobyte, so a manifest of the largest size\n * still fits.\n */\nexport const SIGNED_MANIFEST_MAX_BYTES = Math.ceil((MANIFEST_MAX_BYTES * 4) / 3) + 1024;\n/** JSON text as Ghost reads it: a byte order mark is valid at its start, but JSON.parse refuses it. */\nexport function parseJsonText(text) {\n return JSON.parse(text.charCodeAt(0) === 0xfeff ? text.slice(1) : text);\n}\n//# sourceMappingURL=loading.js.map","import { FlattenedSign, flattenedVerify, importJWK } from 'jose';\nimport { z } from 'zod';\nimport { ALGORITHM, readExactHeader } from './jws.js';\nimport { decodeText } from './keys.js';\n/** The `typ` a signed manifest's protected header carries, so no other signature passes as one. */\nexport const SIGNED_MANIFEST_TYPE = 'ghost-app-manifest';\nconst SignedManifestShape = z.strictObject({\n protected: z.string(),\n payload: z.string(),\n signature: z.string(),\n});\nconst ProtectedHeader = z.strictObject({\n alg: z.literal(ALGORITHM),\n typ: z.literal(SIGNED_MANIFEST_TYPE),\n});\nconst EXPECTED_HEADER = JSON.stringify({ alg: ALGORITHM, typ: SIGNED_MANIFEST_TYPE });\n/**\n * Signs a manifest with an app's identity key. A string is signed as the exact text it is;\n * anything else is signed as its JSON.\n */\nexport async function signManifest(manifest, identityKey) {\n const text = typeof manifest === 'string' ? manifest : JSON.stringify(manifest);\n const signed = await new FlattenedSign(new TextEncoder().encode(text))\n .setProtectedHeader({ alg: ALGORITHM, typ: SIGNED_MANIFEST_TYPE })\n .sign(identityKey);\n return { protected: signed.protected, payload: signed.payload, signature: signed.signature };\n}\n/**\n * Reads the manifest out of a signed manifest, without verifying it. The key to verify it\n * with is named inside the manifest, so the manifest has to be read and checked first;\n * nothing in it may be used until `verifySignedManifest` has passed.\n */\nexport function readSignedManifest(body) {\n const shape = SignedManifestShape.safeParse(body);\n if (!shape.success) {\n return {\n success: false,\n error: 'Expected a signed manifest: flattened JWS JSON with protected, payload and signature',\n };\n }\n const signed = shape.data;\n if (!readExactHeader(signed.protected, ProtectedHeader)) {\n return { success: false, error: `Expected a protected header of ${EXPECTED_HEADER}` };\n }\n const payload = decodeText(signed.payload);\n if (payload === undefined) {\n return { success: false, error: 'Expected a payload of UTF-8 text in base64url' };\n }\n return { success: true, signed, payload };\n}\n/**\n * Checks a signed manifest was signed with the identity key the manifest names, under\n * exactly the protected header `readSignedManifest` accepts.\n */\nexport async function verifySignedManifest(signed, identityKey) {\n let key;\n try {\n key = await importJWK(identityKey, ALGORITHM);\n }\n catch {\n return { success: false, error: 'identity_key is not a usable Ed25519 key' };\n }\n if (!readExactHeader(signed.protected, ProtectedHeader)) {\n return { success: false, error: `Expected a protected header of ${EXPECTED_HEADER}` };\n }\n try {\n await flattenedVerify(signed, key, { algorithms: [ALGORITHM] });\n }\n catch {\n return { success: false, error: 'The signature was not made with identity_key' };\n }\n return { success: true };\n}\n//# sourceMappingURL=signed-manifest.js.map","import { execFile } from 'node:child_process';\nimport { existsSync } from 'node:fs';\nimport { dirname, join, relative, resolve } from 'node:path';\n\nimport { ignoreError } from '../shared/ignore.ts';\n\nexport type IgnoredResult = { ignored: true } | { ignored: false; reason: string };\n\nfunction git(args: string[], cwd: string, input?: string) {\n return new Promise<{ code: number | string | null; stdout: string; stderr: string }>((done) => {\n const child = execFile('git', args, { cwd }, (error, stdout, stderr) => {\n done({ code: error ? ((error as { code?: number | string }).code ?? 1) : 0, stdout, stderr });\n });\n // A git that couldn't start has no stdin to write to; its error arrives above.\n child.stdin?.on('error', ignoreError);\n child.stdin?.end(input);\n });\n}\n\nfunction insideRepository(directory: string): boolean {\n for (let current = resolve(directory); ; current = dirname(current)) {\n if (existsSync(join(current, '.git'))) {\n return true;\n }\n if (dirname(current) === current) {\n return false;\n }\n }\n}\n\n/**\n * The directory itself, or the nearest one above it that exists, to run git in: a project's\n * directory may not exist before its keys are written, and git can't start in one that doesn't.\n */\nfunction existingDirectory(directory: string): string {\n let current = resolve(directory);\n while (!existsSync(current) && dirname(current) !== current) {\n current = dirname(current);\n }\n return current;\n}\n\n/**\n * Whether git ignores every one of `files`, which needn't exist yet, so none can be committed by\n * accident. A file outside any repository counts as ignored.\n */\nexport async function isGitIgnored(\n root: string,\n files: string | readonly string[],\n): Promise<IgnoredResult> {\n // git can't start in a directory that doesn't exist, and a project's may not exist yet.\n const cwd = existingDirectory(root);\n const paths = (typeof files === 'string' ? [files] : files).map((file) => ({\n // As the developer named it, for messages, and as git is asked about it, from `cwd`.\n shown: relative(root, resolve(root, file)),\n asked: relative(cwd, resolve(root, file)),\n }));\n const named = `${paths.map(({ shown }) => shown).join(' and ')} ${paths.length > 1 ? 'are' : 'is'}`;\n\n const repository = await findRepository(cwd, named);\n if (repository !== 'inside') {\n return repository === 'outside' ? { ignored: true } : repository;\n }\n return askWhichAreIgnored(cwd, paths, named);\n}\n\n/** Whether `cwd` is in a repository, or why git can't say when it seems to be. */\nasync function findRepository(\n cwd: string,\n named: string,\n): Promise<'inside' | 'outside' | { ignored: false; reason: string }> {\n // Read from what git exits with, never from what it says, which is in the developer's\n // language. A `.git` that git can't read is still a repository, so it isn't taken as outside.\n const inside = await git(['rev-parse', '--is-inside-work-tree'], cwd);\n if (inside.code === 0) {\n return 'inside';\n }\n if (!insideRepository(cwd)) {\n return 'outside';\n }\n return {\n ignored: false,\n reason:\n inside.code === 'ENOENT'\n ? `git isn't installed, so it can't check ${named} ignored`\n : `git couldn't read the repository: ${inside.stderr.trim()}`,\n };\n}\n\nasync function askWhichAreIgnored(\n cwd: string,\n paths: { shown: string; asked: string }[],\n named: string,\n): Promise<IgnoredResult> {\n // One call for every path. It lists the ones it ignores, and exits with 1 when it ignores none.\n // Paths go in and out separated by NUL, as git would otherwise quote one with any byte outside\n // ASCII. A file git tracks isn't ignored, even if a `.gitignore` names it.\n const { code, stdout, stderr } = await git(\n ['check-ignore', '--stdin', '-z'],\n cwd,\n paths.map(({ asked }) => `${asked}\\0`).join(''),\n );\n if (code !== 0 && code !== 1) {\n return { ignored: false, reason: `git couldn't check ${named} ignored: ${stderr.trim()}` };\n }\n const ignored = new Set(stdout.split('\\0'));\n const notIgnored = paths.find(({ asked }) => !ignored.has(asked));\n return notIgnored\n ? { ignored: false, reason: `git doesn't ignore ${notIgnored.shown}` }\n : { ignored: true };\n}\n","import { generateKeyPairSync, randomUUID } from 'node:crypto';\nimport { existsSync } from 'node:fs';\nimport { chmod, link, mkdir, readFile, rm, stat, writeFile } from 'node:fs/promises';\nimport { basename, dirname, join } from 'node:path';\n\nimport { publicHalfOf } from '../shared/keys.ts';\nimport { isGitIgnored } from './git.ts';\n\n/**\n * Which keys to use. Development and production have separate identity keys, so an app\n * installed from the developer's machine is a different app from the deployed one.\n */\nexport type Mode = 'development' | 'production';\n\n/** Where keys are kept, relative to the project: `.ghost-app/<mode>/<name>.json`. */\nexport const KEYS_DIRECTORY = '.ghost-app';\n\n/**\n * - `identity`: signs the manifest. It says who made the app, so it stays with the developer\n * (or their CI) and never reaches the backend or a bundle.\n * - `backend`: answers Ghost's challenge, so the backend holds it.\n */\nexport type KeyName = 'identity' | 'backend';\n\nexport const KEY_NAMES: readonly KeyName[] = ['identity', 'backend'];\n\n/** A private Ed25519 key as a JWK. */\nexport interface PrivateKeyJwk {\n kty: 'OKP';\n crv: 'Ed25519';\n x: string;\n d: string;\n}\n\n/** A public Ed25519 key as a JWK, as a manifest names it. */\nexport interface PublicKeyJwk {\n kty: 'OKP';\n crv: 'Ed25519';\n x: string;\n}\n\n/** The production identity key, as CI provides it, instead of `.ghost-app/production/identity.json`. */\nexport const IDENTITY_KEY_VARIABLE = 'GHOST_APP_IDENTITY_KEY';\n\n/**\n * The backend key, as the backend reads it, and as CI may provide it to sign a production\n * manifest instead of `.ghost-app/production/backend.json`. Signing only needs its public half.\n */\nexport const BACKEND_KEY_VARIABLE = 'GHOST_APP_BACKEND_KEY';\n\nexport interface KeyOptions {\n /** The project's directory, which holds `.ghost-app/`. */\n root: string;\n mode: Mode;\n}\n\n/** The file a key is kept in, relative to the project. */\nexport function keyFile(mode: Mode, name: KeyName): string {\n return join(KEYS_DIRECTORY, mode, `${name}.json`);\n}\n\n/** A new private Ed25519 key. */\nexport function generateKey(): PrivateKeyJwk {\n const { x, d } = generateKeyPairSync('ed25519').privateKey.export({ format: 'jwk' });\n return { kty: 'OKP', crv: 'Ed25519', x: x!, d: d! };\n}\n\n/** A key's public half, with only `kty`, `crv` and `x`. */\nexport function publicKeyOf(key: PrivateKeyJwk | PublicKeyJwk): PublicKeyJwk {\n return { kty: 'OKP', crv: 'Ed25519', x: key.x };\n}\n\n/**\n * Reads a private key from JSON. `source` names where it came from, for the error: the key\n * itself is never in one.\n */\nexport async function readKey(text: string, source: string): Promise<PrivateKeyJwk> {\n const key = await readAnyKey(text, source);\n if (!('d' in key)) {\n throw new Error(`${source} is a public key; expected the private key, with d`);\n }\n return key;\n}\n\n/** Reads a key from JSON, private or public. */\nasync function readAnyKey(text: string, source: string): Promise<PrivateKeyJwk | PublicKeyJwk> {\n let value: unknown;\n try {\n value = JSON.parse(text);\n } catch {\n throw new Error(`${source} isn't a key: it isn't JSON`);\n }\n if (!isEd25519(value)) {\n throw new Error(`${source} isn't an Ed25519 key as a JWK, with kty \"OKP\", crv \"Ed25519\" and x`);\n }\n const { d } = value as { d?: unknown };\n if (d === undefined) {\n return publicKeyOf(value);\n }\n // A key with a private part that doesn't read isn't a public key either.\n if (typeof d !== 'string') {\n throw new Error(`${source} isn't a usable Ed25519 key: its d isn't a string`);\n }\n // A JWK carries both halves, so a hand-edited or pasted one could pair a private half with\n // someone else's public half, and sign for a key the manifest doesn't name.\n const bytes = Buffer.from(d, 'base64url');\n if (bytes.length !== 32) {\n throw new Error(`${source} isn't a usable Ed25519 key`);\n }\n if ((await publicHalfOf(bytes)) !== value.x) {\n throw new Error(`${source} isn't a usable Ed25519 key: its x doesn't match its d`);\n }\n return { kty: 'OKP', crv: 'Ed25519', x: value.x, d } satisfies PrivateKeyJwk;\n}\n\nfunction isEd25519(value: unknown): value is { kty: 'OKP'; crv: 'Ed25519'; x: string } {\n const { kty, crv, x } = (typeof value === 'object' && value !== null ? value : {}) as Record<\n string,\n unknown\n >;\n return kty === 'OKP' && crv === 'Ed25519' && typeof x === 'string';\n}\n\nasync function readKeyFile(root: string, mode: Mode, name: KeyName): Promise<PrivateKeyJwk> {\n const file = keyFile(mode, name);\n let text: string;\n try {\n text = await readFile(join(root, file), 'utf8');\n } catch (error) {\n if ((error as NodeJS.ErrnoException).code !== 'ENOENT') {\n throw error;\n }\n throw new Error(missingKeyMessage(mode, name, file), { cause: error });\n }\n return readKey(text, file);\n}\n\n/** Says how to create a missing key, as nothing that reads keys creates one. */\nfunction missingKeyMessage(mode: Mode, name: KeyName, file: string): string {\n if (mode === 'development') {\n return `There's no development ${name} key: ${file} doesn't exist. Create one with \\`ghost-app keys\\`.`;\n }\n // In production, CI may provide the key as a variable instead.\n return `There's no production ${name} key: ${file} doesn't exist. Create one with \\`ghost-app keys --production\\`, or set ${variableFor(name)}.`;\n}\n\nconst variableFor = (name: KeyName) =>\n name === 'identity' ? IDENTITY_KEY_VARIABLE : BACKEND_KEY_VARIABLE;\n\nexport interface CreateKeysResult {\n /** The keys this call created. */\n created: KeyName[];\n /** The keys that already existed, which are never replaced. */\n kept: KeyName[];\n}\n\n/**\n * Creates a mode's missing identity and backend keys under `.ghost-app/<mode>/`, as files only\n * their owner can read, and keeps any that exist.\n */\nexport async function createKeys({ root, mode }: KeyOptions): Promise<CreateKeysResult> {\n // Each key is written whole to a temporary file beside it first, then linked to its name.\n const keys = KEY_NAMES.map((name) => {\n const file = keyFile(mode, name);\n const pending = join(dirname(file), `.${basename(file)}.${randomUUID()}.tmp`);\n return { name, file, pending };\n });\n // So a private key can't be committed by accident, git must ignore every file a key is\n // written to, the temporary ones included.\n await refuseUnlessGitIgnores(root, [\n ...keys.map(({ file }) => file),\n ...keys.map(({ pending }) => pending),\n ]);\n await mkdir(join(root, KEYS_DIRECTORY, mode), { recursive: true, mode: 0o700 });\n const result: CreateKeysResult = { created: [], kept: [] };\n for (const { name, file, pending } of keys) {\n // An existing key is kept: a new identity key would make the app a different app on every\n // site that installed it.\n const created = await publishKey(join(root, file), join(root, pending));\n result[created ? 'created' : 'kept'].push(name);\n }\n return result;\n}\n\nasync function refuseUnlessGitIgnores(root: string, files: string[]) {\n const ignored = await isGitIgnored(root, files);\n if (!ignored.ignored) {\n throw new Error(\n `Refusing to write private keys where git could commit them: ${ignored.reason}. Add ${KEYS_DIRECTORY}/ to .gitignore.`,\n );\n }\n}\n\n/** Writes a new key to `file` unless one is there, by way of `pending`, and says whether it did. */\nasync function publishKey(file: string, pending: string): Promise<boolean> {\n try {\n await writeFile(pending, `${JSON.stringify(generateKey(), null, 2)}\\n`, {\n flag: 'wx',\n // Only for its owner on macOS and Linux. Windows ignores the mode, and the key gets the\n // folder's inherited permissions, which the README tells developers to keep private.\n mode: 0o600,\n });\n // A link fails if the name is taken, so a key is never replaced, even by a concurrent run,\n // and an interrupted write never leaves part of a key where a key belongs.\n await link(pending, file);\n return true;\n } catch (error) {\n if ((error as NodeJS.ErrnoException).code !== 'EEXIST') {\n throw error;\n }\n // Kept, but only for its owner, as a key written by hand or copied in may not be.\n if (process.platform !== 'win32' && ((await stat(file)).mode & 0o077) !== 0) {\n await chmod(file, 0o600);\n }\n return false;\n } finally {\n await rm(pending, { force: true });\n }\n}\n\nexport interface SigningKeys {\n identityKey: PrivateKeyJwk;\n /** The backend key's public half: all signing needs. */\n backendKey: PublicKeyJwk;\n}\n\nexport interface ReadKeysOptions extends KeyOptions {\n /** Where to read `GHOST_APP_IDENTITY_KEY` and `GHOST_APP_BACKEND_KEY` from, in production. */\n env?: Record<string, string | undefined>;\n}\n\n/**\n * Where `readSigningKeys` reads a mode's key from: the variable, in production when it's set to\n * anything but blanks, or else the key's file.\n */\nexport function signingKeySource(\n mode: Mode,\n name: KeyName,\n env: Record<string, string | undefined> = process.env,\n): string {\n const variable = variableFor(name);\n return mode === 'production' && env[variable]?.trim() ? variable : keyFile(mode, name);\n}\n\n/**\n * The keys to sign a mode's manifest with, from the key files, or in production from\n * `GHOST_APP_IDENTITY_KEY` and `GHOST_APP_BACKEND_KEY`, so CI can sign without the files.\n */\nexport async function readSigningKeys({\n root,\n mode,\n env = process.env,\n}: ReadKeysOptions): Promise<SigningKeys> {\n const fromVariable = (name: KeyName) =>\n signingKeySource(mode, name, env) === variableFor(name)\n ? env[variableFor(name)]!.trim()\n : undefined;\n\n const identityText = fromVariable('identity');\n const identityKey = identityText\n ? await sameAsFile(root, mode, 'identity', await readKey(identityText, IDENTITY_KEY_VARIABLE))\n : await readKeyFile(root, mode, 'identity');\n\n // CI may provide only the backend key's public half, as signing needs nothing more.\n const backendText = fromVariable('backend');\n const backendKey = publicKeyOf(\n backendText\n ? await sameAsFile(root, mode, 'backend', await readAnyKey(backendText, BACKEND_KEY_VARIABLE))\n : await readKeyFile(root, mode, 'backend'),\n );\n\n if (identityKey.x === backendKey.x) {\n throw new Error('The identity key and the backend key are the same key; they must be two keys');\n }\n return { identityKey, backendKey };\n}\n\n/**\n * A key from a variable, after checking it's the same key as the file, where there's one. A\n * variable left set, such as a development key exported for every shell, would otherwise win over\n * the file unnoticed, and a manifest naming the wrong backend key retires the right one on every\n * site.\n */\nasync function sameAsFile<Key extends PublicKeyJwk>(\n root: string,\n mode: Mode,\n name: KeyName,\n key: Key,\n): Promise<Key> {\n const file = keyFile(mode, name);\n if (existsSync(join(root, file)) && (await readKeyFile(root, mode, name)).x !== key.x) {\n const variable = variableFor(name);\n throw new Error(\n `${variable} and ${file} are different ${name} keys. Unset ${variable} to sign with the file, or remove ${file} to sign with the variable.`,\n );\n }\n return key;\n}\n\n/** A mode's private backend key, from `.ghost-app/<mode>/backend.json`, for the backend to hold. */\nexport function readBackendKey({ root, mode }: KeyOptions): Promise<PrivateKeyJwk> {\n return readKeyFile(root, mode, 'backend');\n}\n","import { z } from 'zod';\nconst ICON_NAME_MAX_LENGTH = 64;\nconst ICON_NAME = /^[a-z0-9]+(?:-[a-z0-9]+)*$/;\nconst EITHER = 'Expected an icon with either a name or a url';\n/**\n * Ghost draws the icon on the app's accent colour: a named Admin icon or an image the app\n * serves. Ghost keeps a copy of the image with each manifest version it stores, and only\n * shows that copy. Unknown names aren't rejected, since they depend on the Admin build;\n * Admin falls back to a default icon.\n */\nexport function iconField(url) {\n return (z\n .strictObject({\n name: z\n .string('Expected an icon name')\n .max(ICON_NAME_MAX_LENGTH, `Expected at most ${ICON_NAME_MAX_LENGTH} characters`)\n .regex(ICON_NAME, 'Expected an icon name such as audio-lines')\n .optional(),\n url: url().optional(),\n }, EITHER)\n .refine(({ name, url: iconUrl }) => (name === undefined) !== (iconUrl === undefined), EITHER)\n // Only the type narrows: the value already is one or the other. A transform would\n // narrow it too, but one-way, and a stored manifest has to encode back through here.\n .pipe(z.custom()));\n}\n//# sourceMappingURL=icon.js.map","import { z } from 'zod';\n// 32 bytes in base64url without padding. The last character carries the final 4 bits and\n// 2 zero bits, so only 16 of the 64 characters can end it, which keeps the spelling of a key\n// unique.\nconst ED25519_X = /^[A-Za-z0-9_-]{42}[AEIMQUYcgkosw048]$/;\nconst EXPECTED = 'Expected a public Ed25519 key as a JWK with kty, crv and x';\nconst PRIVATE = 'Expected a public key, but this includes its private part (d)';\n/**\n * A key a manifest names. A manifest is public, so a key that includes its private part\n * is refused with a message of its own: it has to be replaced, not just removed. Other\n * members are refused by name, as key tools often add some, such as `kid` or `alg`.\n */\nexport const publicKeyField = z.strictObject({\n kty: z.literal('OKP', EXPECTED),\n crv: z.literal('Ed25519', EXPECTED),\n x: z.string(EXPECTED).regex(ED25519_X, 'Expected 32 bytes in base64url, without padding'),\n}, {\n error: (issue) => {\n if (issue.code !== 'unrecognized_keys') {\n return EXPECTED;\n }\n return issue.keys.includes('d')\n ? PRIVATE\n : `Expected only kty, crv and x; remove ${issue.keys.join(', ')}`;\n },\n});\n//# sourceMappingURL=keys.js.map","import { z } from 'zod';\n/**\n * What an app asks for: the places in Ghost it wants to appear. Each surface type is one\n * entry in a union, so a new one is added here and nowhere else.\n */\nexport function surfacesField(url) {\n const adminPage = z.strictObject({\n type: z.literal('admin_page'),\n url: url(),\n });\n const surfaceTypes = [adminPage];\n const surface = z.discriminatedUnion('type', surfaceTypes, {\n error: `Expected a surface with a type of: ${surfaceTypes.map((entry) => entry.shape.type.value).join(', ')}`,\n });\n return z\n .array(surface, 'Expected a list of surfaces')\n .min(1, 'Expected at least one surface')\n .superRefine((surfaces, ctx) => {\n const seen = new Set();\n surfaces.forEach((entry, index) => {\n if (seen.has(entry.type)) {\n ctx.addIssue({\n code: 'custom',\n message: `Expected at most one ${entry.type} surface`,\n path: [index],\n });\n }\n seen.add(entry.type);\n });\n });\n}\n//# sourceMappingURL=surfaces.js.map","import { z } from 'zod';\nimport { isPlainText } from '../plain-text.js';\n// A character that shows something on its own: a letter, digit, punctuation or symbol, but not\n// the blank Braille pattern or one Unicode says to draw as nothing, such as a joiner or a Hangul\n// filler. Whitespace and marks aren't any of those.\nconst VISIBLE_CHARACTER = new RegExp('(?![\\\\u2800\\\\p{Default_Ignorable_Code_Point}])[\\\\p{L}\\\\p{N}\\\\p{P}\\\\p{S}]', 'u');\nconst shows = (text) => VISIBLE_CHARACTER.test(text);\n// Shows nothing, and holds nothing plain text refuses other than whitespace, so trimming never\n// takes off a character, such as one that reorders text, that should get the text refused.\nconst blank = (character) => !shows(character) && isPlainText(character.replace(/\\s/gu, ''));\n// Made on first use, so loading the contract doesn't set one up.\nlet graphemes;\n/**\n * Takes off each end the characters, as a reader sees them, that show nothing: a space with a\n * mark on it goes, an emoji with its variation selector stays, and so does anything invisible\n * that joins onto a visible character. Walks in from each end, so a long run of spaces costs no\n * more than its length.\n */\nfunction trimEdges(value) {\n graphemes ??= new Intl.Segmenter();\n const characters = graphemes.segment(value);\n let start = value.length;\n for (const { segment, index } of characters) {\n if (!blank(segment)) {\n start = index;\n break;\n }\n }\n let end = value.length;\n while (end > start) {\n const { segment, index } = characters.containing(end - 1);\n if (!blank(segment)) {\n break;\n }\n end = index;\n }\n return value.slice(start, end);\n}\n/**\n * One line of plain text, as an app serves it. What shows nothing is taken off both ends, and\n * text with nothing visible left, such as a name of Hangul fillers, is refused.\n */\nexport function plainText(maxLength) {\n return (z\n .string('Expected text')\n // Whitespace first, as a character that joins onto a space, such as a skin tone, would keep it.\n .trim()\n .overwrite(trimEdges)\n .refine(shows, 'Expected text')\n .max(maxLength, `Expected at most ${maxLength} characters`)\n .refine(isPlainText, 'Expected plain text on one line'));\n}\n// Any letter, digit, punctuation or symbol, fillers included: the rule manifests were stored under\n// before blank names were refused.\nconst ANY_CHARACTER = /[\\p{L}\\p{N}\\p{P}\\p{S}]/u;\n/**\n * One line of plain text, as Ghost stored it. Laxer than `plainText`, so a manifest stored before\n * blank names were refused still reads, and the app can still be listed and uninstalled.\n */\nexport function storedText(maxLength) {\n return z\n .string('Expected text')\n .trim()\n .refine((value) => ANY_CHARACTER.test(value), 'Expected text')\n .max(maxLength, `Expected at most ${maxLength} characters`)\n .refine(isPlainText, 'Expected plain text on one line');\n}\n//# sourceMappingURL=text.js.map","import { z } from 'zod';\nimport { isContainedPath } from '../bridge/rules.js';\nimport { URL_MAX_LENGTH } from './limits.js';\nimport { isLocalhost } from './localhost.js';\nexport const FRAGMENT_PROBLEM = 'Expected a URL without a fragment';\n/**\n * Whether an address carries a fragment, even an empty one, which the parsed URL's `hash`\n * hides. A fragment never reaches the server, so a manifest address with one is a mistake or\n * a second spelling of the same address.\n */\nexport const hasFragment = (address) => address.includes('#');\n/**\n * Checks a URL once the URL parser has read it, so the rules apply to the URL Ghost would\n * use. The length is measured on the parsed URL for the same reason, as that is what is\n * stored and checked again later.\n */\nexport function checkResolvedUrl(url, allowLocalhost) {\n if (url.href.length > URL_MAX_LENGTH) {\n return `Expected at most ${URL_MAX_LENGTH} characters`;\n }\n if (url.username || url.password) {\n return 'Expected a URL without a username or password';\n }\n if (isLocalhost(url.hostname)) {\n if (!allowLocalhost) {\n return 'Expected a public address; localhost is only allowed when Ghost runs in development';\n }\n return url.protocol === 'https:' || url.protocol === 'http:'\n ? null\n : 'Expected an http or https URL';\n }\n return url.protocol === 'https:' ? null : 'Expected an https URL';\n}\nconst ROUTE_PROBLEM = 'Expected a URL that resolves to a path starting with a single /, with no \\\\ in its query or fragment';\nconst PATH_PROBLEM = 'Expected a path on the manifest’s own origin, such as /admin';\n// Two, so a reference that names one of them still names a host other than the other's.\nconst PLACEHOLDER_HOSTS = ['manifest-a.invalid', 'manifest-b.invalid'];\n/** Whether a reference names a host, in any of the URL parser's spellings of one. */\nconst namesHost = (value) => PLACEHOLDER_HOSTS.some((host) => URL.parse(value, `https://${host}/`)?.host !== host);\nfunction isManifestItself(url, base) {\n return url.pathname === new URL(base).pathname;\n}\n/**\n * A URL in the manifest. What Ghost loads is written as a path, resolved against the\n * address the manifest was fetched from, so an app is one origin: the one Ghost fetches\n * the manifest from and challenges is the one every surface runs on. The manifest names\n * that address as its signed `manifest_url`, so the resolved URLs are as fixed as if they\n * were written out. `parseManifestUrl` keeps that origin off Ghost's hosts.\n *\n * `linkOnly` marks a URL that is only ever linked to, never loaded, which is absolute and\n * may be anywhere, the publisher's own site included.\n *\n * A loaded URL's path, query and fragment must also make a path `isContainedPath` accepts.\n * Admin opens the app there, as its entry route, and the SDK refuses a route that isn't one.\n * Resolving can still give one that isn't: `/.//admin` resolves to the path `//admin`, which\n * names a host, and a `\\` in the query or fragment is left as it is. Only the page is opened\n * as a route, but every URL Ghost loads is held to the one rule.\n */\nexport function urlField({ allowLocalhost, base }, linkOnly = false) {\n if (linkOnly) {\n return z.string('Expected an absolute URL').transform((value, ctx) => {\n const url = URL.parse(value);\n const problem = url ? checkResolvedUrl(url, allowLocalhost) : 'Expected an absolute URL';\n if (problem) {\n ctx.addIssue({ code: 'custom', message: problem });\n return z.NEVER;\n }\n return url.href;\n });\n }\n const origin = new URL(base).origin;\n return z.string(PATH_PROBLEM).transform((value, ctx) => {\n // A path, or a path-relative reference. A URL with a scheme, or a `//host` one, names\n // its own origin, which the manifest's would then not be, even when it's the same one\n // today. An empty one, or one that's only a query or fragment, would be the manifest\n // itself.\n const url = URL.canParse(value) || namesHost(value) ? null : URL.parse(value, base);\n if (!url || url.origin !== origin || isManifestItself(url, base)) {\n ctx.addIssue({ code: 'custom', message: PATH_PROBLEM });\n return z.NEVER;\n }\n const problem = checkResolvedUrl(url, allowLocalhost);\n if (problem) {\n ctx.addIssue({ code: 'custom', message: problem });\n return z.NEVER;\n }\n if (!isContainedPath(`${url.pathname}${url.search}${url.hash}`)) {\n ctx.addIssue({ code: 'custom', message: ROUTE_PROBLEM });\n return z.NEVER;\n }\n return url.href;\n });\n}\nconst MAILTO_PROBLEM = 'Expected a mailto: link to one email address';\n// No separators, and no control, format or invisible characters, which could hide or reorder what\n// the mail client shows in its To field.\nconst EMAIL_PART = String.raw `[^\\s\\p{Cc}\\p{Cf}\\p{Default_Ignorable_Code_Point}\\u2800@,;:<>()[\\]\\\\\"?#%/]+`;\nconst EMAIL_ADDRESS = new RegExp(String.raw `^${EMAIL_PART}@${EMAIL_PART}\\.${EMAIL_PART}$`, 'u');\n/**\n * Everything after a `mailto:` link's scheme, decoded as a mail client decodes it. That's the\n * whole recipient list, query and fragment included: a mail client doesn't read `//` as an\n * authority, so the URL's `pathname` alone can miss a recipient.\n */\nfunction mailtoRecipients(link) {\n try {\n return decodeURIComponent(link.href.slice('mailto:'.length));\n }\n catch {\n return null;\n }\n}\n/**\n * A link to an app's developer: a URL as `url(true)` holds it, or a `mailto:` link to one email\n * address. Ghost only ever links to it. A `mailto:` link takes no query or fragment, not even an\n * empty one, so it can't prefill a message or add recipients. The address is checked as a mail\n * client decodes it, so an escaped `,` can't add a second one.\n */\nexport function contactField(url) {\n const web = url(true);\n return z.string('Expected an absolute URL').transform((value, ctx) => {\n // Branches on the scheme as the URL parser reads it, which skips leading spaces.\n const link = URL.parse(value);\n if (link?.protocol !== 'mailto:') {\n const result = web.safeParse(value);\n if (!result.success) {\n for (const issue of result.error.issues) {\n ctx.addIssue({ code: 'custom', message: issue.message });\n }\n return z.NEVER;\n }\n return result.data;\n }\n const recipients = mailtoRecipients(link);\n if (!recipients || link.href.length > URL_MAX_LENGTH || !EMAIL_ADDRESS.test(recipients)) {\n ctx.addIssue({ code: 'custom', message: MAILTO_PROBLEM });\n return z.NEVER;\n }\n return link.href;\n });\n}\n/**\n * A URL as a manifest holds it once `parseManifest` has accepted it: absolute, and\n * already checked. Nothing is resolved or checked again, so a manifest accepted before the\n * site's URL changed still reads back.\n */\nexport const absoluteUrl = () => z.url('Expected an absolute URL');\n//# sourceMappingURL=url.js.map","import { z } from 'zod';\nimport { iconField } from './icon.js';\nimport { APP_ID_MAX_LENGTH, isValidAppId } from './id.js';\nimport { publicKeyField } from './keys.js';\nimport { isLocalhost } from './localhost.js';\nimport { surfacesField } from './surfaces.js';\nimport { plainText, storedText } from './text.js';\nimport { absoluteUrl, contactField, FRAGMENT_PROBLEM, hasFragment, urlField, } from './url.js';\nconst NAME_MAX_LENGTH = 50;\nconst DESCRIPTION_MAX_LENGTH = 200;\nconst AUTHOR_NAME_MAX_LENGTH = 50;\nconst HEX_COLOR = /^#[0-9a-f]{6}$/i;\nconst KEY_FIELDS = new Set(['identity_key', 'backend_key']);\nconst URL_FIELDS = new Set([\n 'author',\n 'icon',\n 'surfaces',\n 'manifest_url',\n 'development',\n]);\n/** Passes a refinement only once the fields it reads parsed, and the manifest is an object. */\nconst parsedFields = (fields) => ({ issues }) => issues.every(({ path = [] }) => path.length > 0 && !fields.has(path[0]));\n/**\n * The manifest as a whole. Unknown fields are rejected at every level, so an app cannot\n * claim something Ghost has not designed, and adding a field is always a deliberate change\n * here.\n *\n * Defined once, with the URL and text rules left open. What a valid URL is depends on whether\n * the manifest is being parsed, when where Ghost is served from matters, or read back after it\n * was, when it doesn't. Text is held to today's rules when parsed, and read back under the\n * rules it was stored under. The author's link is held to its own rule when parsed, which\n * allows a mailto: link, and read back as any absolute URL.\n */\nfunction manifestShape(url, text, contact) {\n return (z\n .strictObject({\n id: z.custom(isValidAppId, {\n error: `Expected a lowercase reverse-domain ID such as com.example.app, at most ${APP_ID_MAX_LENGTH} characters`,\n }),\n name: text(NAME_MAX_LENGTH),\n description: text(DESCRIPTION_MAX_LENGTH),\n author: z.strictObject({\n name: text(AUTHOR_NAME_MAX_LENGTH),\n // Where publishers reach the developer: a web page, which may be on the publisher's\n // own site, or a mailto: link. Only ever linked to.\n url: contact(),\n }, 'Expected an author with a name and a url'),\n accent_color: z\n .string('Expected a hex colour such as #ff5500')\n .regex(HEX_COLOR, 'Expected a hex colour such as #ff5500')\n .toLowerCase(),\n icon: iconField(url),\n surfaces: surfacesField(url),\n // Where the signed manifest is served from: the app's one origin, which every path\n // in it resolves against. Ghost fetches it server-side and never loads it as a page.\n manifest_url: url(true).refine((address) => !hasFragment(address), FRAGMENT_PROBLEM),\n identity_key: publicKeyField,\n backend_key: publicKeyField,\n // Lets Admin label a development build. Production sites may run one to test it.\n development: z.boolean('Expected true or false'),\n })\n // A backend holds its key online. If it also signed manifests, whoever took over the\n // backend could publish any manifest as the app.\n .refine((manifest) => manifest.identity_key.x !== manifest.backend_key.x, {\n message: 'Expected a different key from identity_key',\n path: ['backend_key'],\n // Only once both keys are known to be keys. An issue without a path is about the\n // manifest as a whole, which may not be an object at all.\n when: parsedFields(KEY_FIELDS),\n })\n // An app on the developer's machine is always labelled as a development build.\n .refine((manifest) => manifest.development ||\n ![\n manifest.author.url,\n 'url' in manifest.icon ? manifest.icon.url : undefined,\n ...manifest.surfaces.map((surface) => surface.url),\n manifest.manifest_url,\n ].some((address) => address !== undefined && isLocalhost(new URL(address).hostname)), {\n message: 'Expected true, as the app is on localhost',\n path: ['development'],\n when: parsedFields(URL_FIELDS),\n }));\n}\n/** The manifest as an app serves it. Built per parse, as its URL rule depends on the parse. */\nexport function manifestSchema(rules) {\n const url = (linkOnly) => urlField(rules, linkOnly);\n return manifestShape(url, plainText, () => contactField(url));\n}\n/**\n * The manifest as `parseManifest` hands it back: every URL absolute, and nothing left to\n * resolve or check. This is the schema to read a stored manifest with, as it holds\n * whatever the site's URL has become since, and it encodes a manifest back to the same\n * shape, so what is stored is what will be read.\n */\nexport const AppManifestSchema = manifestShape(absoluteUrl, storedText, absoluteUrl);\n//# sourceMappingURL=schema.js.map","import { hostOf, isGhostHost } from './ghost-host.js';\nimport { isLocalhost } from './localhost.js';\nimport { manifestSchema } from './schema.js';\nimport { checkResolvedUrl, FRAGMENT_PROBLEM, hasFragment } from './url.js';\nfunction formatPath(path) {\n return path.reduce((result, part) => {\n if (typeof part === 'number') {\n return `${result}[${part}]`;\n }\n return result ? `${result}.${String(part)}` : String(part);\n }, '');\n}\nconst GHOST_URLS_PROBLEM = 'Expected the URLs Ghost itself is served from';\nconst ON_GHOST_HOST = 'Expected the manifest on a host other than the one Ghost itself is served from, on any port, as browsers send Ghost’s cookies to every port on its host';\nconst ON_GHOST_HOST_LOCALLY = `${ON_GHOST_HOST}. To run the app on this machine too, serve it from a name of its own under .localhost, such as my-app.localhost`;\n/**\n * Why a manifest on one of Ghost's hosts is refused, with a hint for when that's most\n * likely: an app run next to Ghost on the developer's machine. A name under `.localhost`\n * is a host of its own, which browsers send to the machine itself, and so does Ghost in\n * development, whatever the system's resolver knows.\n */\nfunction onGhostHost(url) {\n return isLocalhost(url.hostname) ? ON_GHOST_HOST_LOCALLY : ON_GHOST_HOST;\n}\n/**\n * Reads the address a manifest is to be read from, by the same rules as the URLs inside\n * it, and checks it is on none of Ghost's hosts. Run it before fetching, so the first\n * request never goes to an address Ghost would refuse (plain HTTP, one carrying\n * credentials, or one on Ghost's host). It cannot judge where that address redirects,\n * which is for whatever fetches it to limit.\n *\n * The address it hands back is the one to store, to compare with a later one, and that the\n * manifest must name as its `manifest_url`. The URL parser settles most differences in\n * spelling, but not a trailing dot on the host or the case of a percent-encoding: an address spelled that way reads as a\n * change of manifest URL, which needs the publisher's approval, the safe way to be wrong.\n */\nexport function parseManifestUrl(input, { ghostUrls, allowLocalhost = false }) {\n if (ghostUrls.length === 0 || !ghostUrls.every((ghostUrl) => hostOf(ghostUrl) !== null)) {\n return { success: false, error: GHOST_URLS_PROBLEM };\n }\n const url = URL.parse(input);\n if (!url) {\n return { success: false, error: 'Expected the manifest at a URL' };\n }\n const problem = hasFragment(input) ? FRAGMENT_PROBLEM : checkResolvedUrl(url, allowLocalhost);\n if (problem) {\n return { success: false, error: `${problem} for the manifest itself` };\n }\n if (isGhostHost(url, ghostUrls)) {\n return { success: false, error: onGhostHost(url) };\n }\n return { success: true, manifestUrl: url.href };\n}\n/** A manifest's problems as `path: message`, joined by `separator`, as Ghost reports them. */\nexport function formatManifestErrors(errors, separator) {\n return errors\n .map(({ path, message }) => (path ? `${path}: ${message}` : message))\n .join(separator);\n}\nfunction invalid(errors) {\n return { success: false, reason: 'invalid', errors };\n}\n/**\n * Validates a manifest, and checks it names the address it was fetched from as its\n * `manifest_url`. A copy served from anywhere else is refused, so the signature binds the\n * manifest to its address as well as to every URL in it.\n *\n * Returns either the manifest, or every problem found. It does not fetch anything and it\n * never throws. Without the URLs Ghost is served from it rejects every manifest, since the\n * rule that keeps apps off Ghost's hosts could not be checked.\n */\nexport function parseManifest(input, options) {\n const allowLocalhost = options.allowLocalhost ?? false;\n const address = parseManifestUrl(options.manifestUrl, options);\n if (!address.success) {\n return invalid([{ path: '', message: address.error }]);\n }\n const result = manifestSchema({ allowLocalhost, base: address.manifestUrl }).safeParse(input);\n if (!result.success) {\n return invalid(result.error.issues.map((issue) => ({\n path: formatPath(issue.path),\n message: issue.message,\n })));\n }\n if (result.data.manifest_url !== address.manifestUrl) {\n return {\n success: false,\n reason: 'manifest_url_mismatch',\n errors: [\n {\n path: 'manifest_url',\n message: `Expected ${address.manifestUrl}, the address the manifest was read from`,\n },\n ],\n };\n }\n return { success: true, manifest: result.data };\n}\n//# sourceMappingURL=parse.js.map","import { readFile } from 'node:fs/promises';\nimport { resolve } from 'node:path';\n\nimport type { AppFailureCode } from '@tryghost/app-contracts';\nimport {\n SIGNED_MANIFEST_MAX_BYTES,\n parseJsonText,\n signManifest,\n} from '@tryghost/app-contracts/identity';\nimport {\n formatManifestErrors,\n parseManifest,\n parseManifestUrl,\n} from '@tryghost/app-contracts/manifest';\n\nimport {\n publicKeyOf,\n readKey,\n readSigningKeys,\n type PrivateKeyJwk,\n type PublicKeyJwk,\n type ReadKeysOptions,\n} from './keys.ts';\nimport { UNKNOWN_GHOST_URL } from '../shared/manifest.ts';\nimport type { ManifestError, SignedManifest } from './types.ts';\n\n/** The readable manifest a project keeps, which the tooling signs. */\nexport const MANIFEST_FILE = 'ghost-app.json';\n\n/** The fields the tooling adds, which `ghost-app.json` mustn't set. */\nconst ADDED_FIELDS = ['manifest_url', 'identity_key', 'backend_key', 'development'] as const;\n\nexport interface SignOptions {\n /** The address the signed manifest will be served from, which it names as its own. */\n manifestUrl: string;\n identityKey: PrivateKeyJwk;\n /** Only its public half goes in the manifest. */\n backendKey: PrivateKeyJwk | PublicKeyJwk;\n /** Whether this is a development build, as it must be when any URL is on localhost. */\n development: boolean;\n}\n\nexport type SignResult =\n | {\n success: true;\n signed: SignedManifest;\n /** The manifest as signed, with the fields the tooling added. */\n manifest: Record<string, unknown>;\n }\n | {\n success: false;\n /**\n * As Ghost would refuse it: `APP_MANIFEST_INVALID`, `APP_MANIFEST_URL_INVALID`, or\n * `APP_MANIFEST_TOO_LARGE` for one larger than Ghost fetches.\n */\n code: 'APP_MANIFEST_INVALID' | 'APP_MANIFEST_URL_INVALID' | 'APP_MANIFEST_TOO_LARGE';\n errors: ManifestError[];\n };\n\n// Never if a code here stops being one Ghost answers with, so `refuse` stops compiling.\ntype Refusal = Extract<SignResult, { success: false; code: AppFailureCode }>;\n\nconst refuse = (code: Refusal['code'], message: string, path = ''): Refusal => ({\n success: false,\n code,\n errors: [{ path, message }],\n});\n\n/**\n * Adds the manifest URL, both public keys and the development flag to a manifest, and signs it\n * with the identity key, unless Ghost would refuse it.\n */\nexport async function signAppManifest(source: unknown, options: SignOptions): Promise<SignResult> {\n // A JWK carries both halves, so one passed in, rather than read from a file, could pair a\n // private half with another key's public half. The manifest would name a key that didn't sign\n // it, or one the backend can't answer for, and Ghost would refuse it. That's the caller's\n // mistake, so it throws.\n await readKey(JSON.stringify(options.identityKey), 'identityKey');\n if ('d' in options.backendKey) {\n await readKey(JSON.stringify(options.backendKey), 'backendKey');\n }\n // Ghost's own hosts are the one rule only a site knows, so a name no site has stands in.\n const address = parseManifestUrl(options.manifestUrl, {\n ghostUrls: [UNKNOWN_GHOST_URL],\n allowLocalhost: true,\n });\n if (!address.success) {\n return refuse('APP_MANIFEST_URL_INVALID', address.error);\n }\n if (typeof source !== 'object' || source === null || Array.isArray(source)) {\n return refuse('APP_MANIFEST_INVALID', 'Expected the manifest as a JSON object');\n }\n // The fields signing adds can't come from the file, or the file could name other keys.\n const added = ADDED_FIELDS.filter((field) => field in source);\n if (added.length > 0) {\n return {\n success: false,\n code: 'APP_MANIFEST_INVALID',\n errors: added.map((field) => ({\n path: field,\n message: `Leave ${field} out: it's added when the manifest is signed`,\n })),\n };\n }\n\n const manifest = {\n ...source,\n manifest_url: address.manifestUrl,\n identity_key: publicKeyOf(options.identityKey),\n backend_key: publicKeyOf(options.backendKey),\n development: options.development,\n };\n // Checked by the rules Ghost applies, so a manifest Ghost would refuse is never signed, and\n // the result lists every problem by the path to its field.\n const parsed = parseManifest(manifest, {\n manifestUrl: address.manifestUrl,\n ghostUrls: [UNKNOWN_GHOST_URL],\n allowLocalhost: true,\n });\n if (!parsed.success) {\n // A mismatch can't happen, as the manifest URL was just set; any failure is invalid.\n return { success: false, code: 'APP_MANIFEST_INVALID', errors: parsed.errors };\n }\n\n const signed = await signManifest(JSON.stringify(manifest), options.identityKey);\n // A valid manifest is far smaller than Ghost stores, but the payload keeps whatever the file\n // had, such as text Ghost trims, so it can still be larger than Ghost fetches.\n if (new TextEncoder().encode(serialiseSigned(signed)).byteLength > SIGNED_MANIFEST_MAX_BYTES) {\n return refuse(\n 'APP_MANIFEST_TOO_LARGE',\n `Expected a signed manifest of at most ${Math.floor(SIGNED_MANIFEST_MAX_BYTES / 1024)} KB`,\n );\n }\n return { success: true, signed, manifest };\n}\n\n/** A manifest's problems, one per line, as `path: message`, as Ghost lists them. */\nexport function formatErrors(errors: readonly ManifestError[]): string {\n return formatManifestErrors(errors, '\\n');\n}\n\n/** A signed manifest as the CLI and the Vite plugin write it to a file. */\nexport function serialiseSigned(signed: SignedManifest): string {\n return `${JSON.stringify(signed, null, 2)}\\n`;\n}\n\n/** Reads `ghost-app.json`, or another readable manifest, as JSON. */\nexport async function readManifestSource(file: string): Promise<unknown> {\n const text = await readFile(file, 'utf8');\n try {\n return parseJsonText(text);\n } catch (error) {\n throw new Error(`${file} isn't JSON: ${(error as Error).message}`, { cause: error });\n }\n}\n\nexport interface SignProjectOptions extends ReadKeysOptions {\n manifestUrl: string;\n /** The readable manifest, relative to `root`. `ghost-app.json` by default. */\n manifestFile?: string;\n}\n\n/** Signs a project's `ghost-app.json` for a manifest URL with the mode's keys. */\nexport async function signProject({\n root,\n mode,\n env,\n manifestUrl,\n manifestFile = MANIFEST_FILE,\n}: SignProjectOptions): Promise<SignResult> {\n // Resolved, so an absolute path is taken as it is.\n const source = await readManifestSource(resolve(root, manifestFile));\n // Keys are read, never created: a missing one throws with how to create it.\n const keys = await readSigningKeys({ root, mode, env });\n return signAppManifest(source, { manifestUrl, ...keys, development: mode === 'development' });\n}\n"],"mappings":";;;;;;;;;;AAEA,IAAM,iBAAiB;CACnB;CACA;CACA;CACA;CACA;CACA;CACA;AACJ;;;;;;AAMA,SAAgB,oBAAoB,UAAU;CAC1C,IAAI,MAAM,SAAS;CACnB,OAAO,MAAM,KAAK,SAAS,MAAM,OAAO,KACpC,OAAO;CAEX,OAAO,SAAS,MAAM,GAAG,GAAG;AAChC;;;;;;AAMA,SAAgB,YAAY,UAAU;CAClC,MAAM,OAAO,oBAAoB,QAAQ;CACzC,OAAO,eAAe,MAAM,YAAY,QAAQ,KAAK,IAAI,CAAC;AAC9D;;;;;;;;;;;;;;;;;;;;;ACZA,SAAgB,YAAY,KAAK,WAAW;CACxC,MAAM,OAAO,OAAO,GAAG;CACvB,IAAI,SAAS,MACT,OAAO;CAEX,IAAI,QAAQ;CACZ,KAAK,MAAM,YAAY,WAAW;EAC9B,MAAM,YAAY,OAAO,QAAQ;EACjC,IAAI,cAAc,QAAQ,cAAc,MACpC,OAAO;EAEX,QAAQ;CACZ;CACA,OAAO,CAAC;AACZ;;AAEA,SAAgB,OAAO,OAAO;CAC1B,IAAI;CAEJ,IAAI;EACA,MAAM,IAAI,IAAI,KAAK;CACvB,QACM;EACF,OAAO;CACX;CACA,IAAI,IAAI,aAAa,WAAW,IAAI,aAAa,UAC7C,OAAO;CAEX,OAAO,oBAAoB,IAAI,QAAQ,KAAK;AAChD;AC9CA,IAAM,aAAa;;;;;;;AAOnB,SAAgB,aAAa,OAAO;CAChC,IAAI,OAAO,UAAU,YAAY,MAAM,SAAA,KACnC,OAAO;CAEX,MAAM,WAAW,MAAM,MAAM,GAAG;CAChC,OAAQ,SAAS,UAAU,KACvB,SAAS,KAAK,KAAK,KACnB,SAAS,OAAO,YAAY,WAAW,KAAK,OAAO,CAAC;AAC5D;;;;;;;ACbA,IAAa,iBAAiB;;;;;;ACK9B,IAAa,4BAA4B,KAAK,KANZ,KAAK,OAMkC,IAAK,CAAC,IAAI;;AAEnF,SAAgB,cAAc,MAAM;CAChC,OAAO,KAAK,MAAM,KAAK,WAAW,CAAC,MAAM,QAAS,KAAK,MAAM,CAAC,IAAI,IAAI;AAC1E;;;;ACRA,IAAa,uBAAuB;AACR,EAAE,aAAa;CACvC,WAAW,EAAE,OAAO;CACpB,SAAS,EAAE,OAAO;CAClB,WAAW,EAAE,OAAO;AACxB,CAAC;AACuB,EAAE,aAAa;CACnC,KAAK,EAAE,QAAQ,SAAS;CACxB,KAAK,EAAE,QAAQ,oBAAoB;AACvC,CAAC;AACuB,KAAK,UAAU;CAAE,KAAK;CAAW,KAAK;AAAqB,CAAC;;;;;AAKpF,eAAsB,aAAa,UAAU,aAAa;CACtD,MAAM,OAAO,OAAO,aAAa,WAAW,WAAW,KAAK,UAAU,QAAQ;CAC9E,MAAM,SAAS,MAAM,IAAI,cAAc,IAAI,YAAY,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CACjE,mBAAmB;EAAE,KAAK;EAAW,KAAK;CAAqB,CAAC,CAAC,CACjE,KAAK,WAAW;CACrB,OAAO;EAAE,WAAW,OAAO;EAAW,SAAS,OAAO;EAAS,WAAW,OAAO;CAAU;AAC/F;;;AClBA,SAAS,IAAI,MAAgB,KAAa,OAAgB;CACxD,OAAO,IAAI,SAA2E,SAAS;EAC7F,MAAM,QAAQ,SAAS,OAAO,MAAM,EAAE,IAAI,IAAI,OAAO,QAAQ,WAAW;GACtE,KAAK;IAAE,MAAM,QAAU,MAAqC,QAAQ,IAAK;IAAG;IAAQ;GAAO,CAAC;EAC9F,CAAC;EAED,MAAM,OAAO,GAAG,SAAS,WAAW;EACpC,MAAM,OAAO,IAAI,KAAK;CACxB,CAAC;AACH;AAEA,SAAS,iBAAiB,WAA4B;CACpD,KAAK,IAAI,UAAU,QAAQ,SAAS,IAAK,UAAU,QAAQ,OAAO,GAAG;EACnE,IAAI,WAAW,KAAK,SAAS,MAAM,CAAC,GAClC,OAAO;EAET,IAAI,QAAQ,OAAO,MAAM,SACvB,OAAO;CAEX;AACF;;;;;AAMA,SAAS,kBAAkB,WAA2B;CACpD,IAAI,UAAU,QAAQ,SAAS;CAC/B,OAAO,CAAC,WAAW,OAAO,KAAK,QAAQ,OAAO,MAAM,SAClD,UAAU,QAAQ,OAAO;CAE3B,OAAO;AACT;;;;;AAMA,eAAsB,aACpB,MACA,OACwB;CAExB,MAAM,MAAM,kBAAkB,IAAI;CAClC,MAAM,SAAS,OAAO,UAAU,WAAW,CAAC,KAAK,IAAI,MAAA,CAAO,KAAK,UAAU;EAEzE,OAAO,SAAS,MAAM,QAAQ,MAAM,IAAI,CAAC;EACzC,OAAO,SAAS,KAAK,QAAQ,MAAM,IAAI,CAAC;CAC1C,EAAE;CACF,MAAM,QAAQ,GAAG,MAAM,KAAK,EAAE,YAAY,KAAK,CAAC,CAAC,KAAK,OAAO,EAAE,GAAG,MAAM,SAAS,IAAI,QAAQ;CAE7F,MAAM,aAAa,MAAM,eAAe,KAAK,KAAK;CAClD,IAAI,eAAe,UACjB,OAAO,eAAe,YAAY,EAAE,SAAS,KAAK,IAAI;CAExD,OAAO,mBAAmB,KAAK,OAAO,KAAK;AAC7C;;AAGA,eAAe,eACb,KACA,OACoE;CAGpE,MAAM,SAAS,MAAM,IAAI,CAAC,aAAa,uBAAuB,GAAG,GAAG;CACpE,IAAI,OAAO,SAAS,GAClB,OAAO;CAET,IAAI,CAAC,iBAAiB,GAAG,GACvB,OAAO;CAET,OAAO;EACL,SAAS;EACT,QACE,OAAO,SAAS,WACZ,0CAA0C,MAAM,YAChD,qCAAqC,OAAO,OAAO,KAAK;CAChE;AACF;AAEA,eAAe,mBACb,KACA,OACA,OACwB;CAIxB,MAAM,EAAE,MAAM,QAAQ,WAAW,MAAM,IACrC;EAAC;EAAgB;EAAW;CAAI,GAChC,KACA,MAAM,KAAK,EAAE,YAAY,GAAG,MAAM,GAAG,CAAC,CAAC,KAAK,EAAE,CAChD;CACA,IAAI,SAAS,KAAK,SAAS,GACzB,OAAO;EAAE,SAAS;EAAO,QAAQ,sBAAsB,MAAM,YAAY,OAAO,KAAK;CAAI;CAE3F,MAAM,UAAU,IAAI,IAAI,OAAO,MAAM,IAAI,CAAC;CAC1C,MAAM,aAAa,MAAM,MAAM,EAAE,YAAY,CAAC,QAAQ,IAAI,KAAK,CAAC;CAChE,OAAO,aACH;EAAE,SAAS;EAAO,QAAQ,sBAAsB,WAAW;CAAQ,IACnE,EAAE,SAAS,KAAK;AACtB;;;;AC/FA,IAAa,iBAAiB;AAS9B,IAAa,YAAgC,CAAC,YAAY,SAAS;;AAkBnE,IAAa,wBAAwB;;;;;AAMrC,IAAa,uBAAuB;;AASpC,SAAgB,QAAQ,MAAY,MAAuB;CACzD,OAAO,KAAK,gBAAgB,MAAM,GAAG,KAAK,MAAM;AAClD;;AAGA,SAAgB,cAA6B;CAC3C,MAAM,EAAE,GAAG,MAAM,oBAAoB,SAAS,CAAC,CAAC,WAAW,OAAO,EAAE,QAAQ,MAAM,CAAC;CACnF,OAAO;EAAE,KAAK;EAAO,KAAK;EAAc;EAAO;CAAG;AACpD;;AAGA,SAAgB,YAAY,KAAiD;CAC3E,OAAO;EAAE,KAAK;EAAO,KAAK;EAAW,GAAG,IAAI;CAAE;AAChD;;;;;AAMA,eAAsB,QAAQ,MAAc,QAAwC;CAClF,MAAM,MAAM,MAAM,WAAW,MAAM,MAAM;CACzC,IAAI,EAAE,OAAO,MACX,MAAM,IAAI,MAAM,GAAG,OAAO,mDAAmD;CAE/E,OAAO;AACT;;AAGA,eAAe,WAAW,MAAc,QAAuD;CAC7F,IAAI;CACJ,IAAI;EACF,QAAQ,KAAK,MAAM,IAAI;CACzB,QAAQ;EACN,MAAM,IAAI,MAAM,GAAG,OAAO,4BAA4B;CACxD;CACA,IAAI,CAAC,UAAU,KAAK,GAClB,MAAM,IAAI,MAAM,GAAG,OAAO,oEAAoE;CAEhG,MAAM,EAAE,MAAM;CACd,IAAI,MAAM,KAAA,GACR,OAAO,YAAY,KAAK;CAG1B,IAAI,OAAO,MAAM,UACf,MAAM,IAAI,MAAM,GAAG,OAAO,kDAAkD;CAI9E,MAAM,QAAQ,OAAO,KAAK,GAAG,WAAW;CACxC,IAAI,MAAM,WAAW,IACnB,MAAM,IAAI,MAAM,GAAG,OAAO,4BAA4B;CAExD,IAAK,MAAM,aAAa,KAAK,MAAO,MAAM,GACxC,MAAM,IAAI,MAAM,GAAG,OAAO,uDAAuD;CAEnF,OAAO;EAAE,KAAK;EAAO,KAAK;EAAW,GAAG,MAAM;EAAG;CAAE;AACrD;AAEA,SAAS,UAAU,OAAoE;CACrF,MAAM,EAAE,KAAK,KAAK,MAAO,OAAO,UAAU,YAAY,UAAU,OAAO,QAAQ,CAAC;CAIhF,OAAO,QAAQ,SAAS,QAAQ,aAAa,OAAO,MAAM;AAC5D;AAEA,eAAe,YAAY,MAAc,MAAY,MAAuC;CAC1F,MAAM,OAAO,QAAQ,MAAM,IAAI;CAC/B,IAAI;CACJ,IAAI;EACF,OAAO,MAAM,SAAS,KAAK,MAAM,IAAI,GAAG,MAAM;CAChD,SAAS,OAAO;EACd,IAAK,MAAgC,SAAS,UAC5C,MAAM;EAER,MAAM,IAAI,MAAM,kBAAkB,MAAM,MAAM,IAAI,GAAG,EAAE,OAAO,MAAM,CAAC;CACvE;CACA,OAAO,QAAQ,MAAM,IAAI;AAC3B;;AAGA,SAAS,kBAAkB,MAAY,MAAe,MAAsB;CAC1E,IAAI,SAAS,eACX,OAAO,0BAA0B,KAAK,QAAQ,KAAK;CAGrD,OAAO,yBAAyB,KAAK,QAAQ,KAAK,0EAA0E,YAAY,IAAI,EAAE;AAChJ;AAEA,IAAM,eAAe,SACnB,SAAS,aAAa,wBAAwB;;;;;AAahD,eAAsB,WAAW,EAAE,MAAM,QAA+C;CAEtF,MAAM,OAAO,UAAU,KAAK,SAAS;EACnC,MAAM,OAAO,QAAQ,MAAM,IAAI;EAE/B,OAAO;GAAE;GAAM;GAAM,SADL,KAAK,QAAQ,IAAI,GAAG,IAAI,SAAS,IAAI,EAAE,GAAG,WAAW,EAAE,KAClD;EAAQ;CAC/B,CAAC;CAGD,MAAM,uBAAuB,MAAM,CACjC,GAAG,KAAK,KAAK,EAAE,WAAW,IAAI,GAC9B,GAAG,KAAK,KAAK,EAAE,cAAc,OAAO,CACtC,CAAC;CACD,MAAM,MAAM,KAAK,MAAM,gBAAgB,IAAI,GAAG;EAAE,WAAW;EAAM,MAAM;CAAM,CAAC;CAC9E,MAAM,SAA2B;EAAE,SAAS,CAAC;EAAG,MAAM,CAAC;CAAE;CACzD,KAAK,MAAM,EAAE,MAAM,MAAM,aAAa,MAIpC,OAAO,MADe,WAAW,KAAK,MAAM,IAAI,GAAG,KAAK,MAAM,OAAO,CAAC,IACrD,YAAY,OAAO,CAAC,KAAK,IAAI;CAEhD,OAAO;AACT;AAEA,eAAe,uBAAuB,MAAc,OAAiB;CACnE,MAAM,UAAU,MAAM,aAAa,MAAM,KAAK;CAC9C,IAAI,CAAC,QAAQ,SACX,MAAM,IAAI,MACR,+DAA+D,QAAQ,OAAO,QAAQ,eAAe,iBACvG;AAEJ;;AAGA,eAAe,WAAW,MAAc,SAAmC;CACzE,IAAI;EACF,MAAM,UAAU,SAAS,GAAG,KAAK,UAAU,YAAY,GAAG,MAAM,CAAC,EAAE,KAAK;GACtE,MAAM;GAGN,MAAM;EACR,CAAC;EAGD,MAAM,KAAK,SAAS,IAAI;EACxB,OAAO;CACT,SAAS,OAAO;EACd,IAAK,MAAgC,SAAS,UAC5C,MAAM;EAGR,IAAI,QAAQ,aAAa,aAAa,MAAM,KAAK,IAAI,EAAA,CAAG,OAAO,QAAW,GACxE,MAAM,MAAM,MAAM,GAAK;EAEzB,OAAO;CACT,UAAU;EACR,MAAM,GAAG,SAAS,EAAE,OAAO,KAAK,CAAC;CACnC;AACF;;;;;AAiBA,SAAgB,iBACd,MACA,MACA,MAA0C,QAAQ,KAC1C;CACR,MAAM,WAAW,YAAY,IAAI;CACjC,OAAO,SAAS,gBAAgB,IAAI,SAAS,EAAE,KAAK,IAAI,WAAW,QAAQ,MAAM,IAAI;AACvF;;;;;AAMA,eAAsB,gBAAgB,EACpC,MACA,MACA,MAAM,QAAQ,OAC0B;CACxC,MAAM,gBAAgB,SACpB,iBAAiB,MAAM,MAAM,GAAG,MAAM,YAAY,IAAI,IAClD,IAAI,YAAY,IAAI,EAAE,CAAE,KAAK,IAC7B,KAAA;CAEN,MAAM,eAAe,aAAa,UAAU;CAC5C,MAAM,cAAc,eAChB,MAAM,WAAW,MAAM,MAAM,YAAY,MAAM,QAAQ,cAAc,qBAAqB,CAAC,IAC3F,MAAM,YAAY,MAAM,MAAM,UAAU;CAG5C,MAAM,cAAc,aAAa,SAAS;CAC1C,MAAM,aAAa,YACjB,cACI,MAAM,WAAW,MAAM,MAAM,WAAW,MAAM,WAAW,aAAa,oBAAoB,CAAC,IAC3F,MAAM,YAAY,MAAM,MAAM,SAAS,CAC7C;CAEA,IAAI,YAAY,MAAM,WAAW,GAC/B,MAAM,IAAI,MAAM,8EAA8E;CAEhG,OAAO;EAAE;EAAa;CAAW;AACnC;;;;;;;AAQA,eAAe,WACb,MACA,MACA,MACA,KACc;CACd,MAAM,OAAO,QAAQ,MAAM,IAAI;CAC/B,IAAI,WAAW,KAAK,MAAM,IAAI,CAAC,MAAM,MAAM,YAAY,MAAM,MAAM,IAAI,EAAA,CAAG,MAAM,IAAI,GAAG;EACrF,MAAM,WAAW,YAAY,IAAI;EACjC,MAAM,IAAI,MACR,GAAG,SAAS,OAAO,KAAK,iBAAiB,KAAK,eAAe,SAAS,oCAAoC,KAAK,4BACjH;CACF;CACA,OAAO;AACT;;AAGA,SAAgB,eAAe,EAAE,MAAM,QAA4C;CACjF,OAAO,YAAY,MAAM,MAAM,SAAS;AAC1C;;;AC7SA,IAAM,uBAAuB;AAC7B,IAAM,YAAY;AAClB,IAAM,SAAS;;;;;;;AAOf,SAAgB,UAAU,KAAK;CAC3B,OAAQ,EACH,aAAa;EACd,MAAM,EACD,OAAO,uBAAuB,CAAC,CAC/B,IAAI,sBAAsB,oBAAoB,qBAAqB,YAAY,CAAC,CAChF,MAAM,WAAW,2CAA2C,CAAC,CAC7D,SAAS;EACd,KAAK,IAAI,CAAC,CAAC,SAAS;CACxB,GAAG,MAAM,CAAC,CACL,QAAQ,EAAE,MAAM,KAAK,cAAe,SAAS,KAAA,OAAgB,YAAY,KAAA,IAAY,MAAM,CAAC,CAG5F,KAAK,EAAE,OAAO,CAAC;AACxB;;;ACpBA,IAAM,YAAY;AAClB,IAAM,WAAW;AACjB,IAAM,UAAU;;;;;;AAMhB,IAAa,iBAAiB,EAAE,aAAa;CACzC,KAAK,EAAE,QAAQ,OAAO,QAAQ;CAC9B,KAAK,EAAE,QAAQ,WAAW,QAAQ;CAClC,GAAG,EAAE,OAAO,QAAQ,CAAC,CAAC,MAAM,WAAW,iDAAiD;AAC5F,GAAG,EACC,QAAQ,UAAU;CACd,IAAI,MAAM,SAAS,qBACf,OAAO;CAEX,OAAO,MAAM,KAAK,SAAS,GAAG,IACxB,UACA,wCAAwC,MAAM,KAAK,KAAK,IAAI;AACtE,EACJ,CAAC;;;;;;;ACpBD,SAAgB,cAAc,KAAK;CAK/B,MAAM,eAAe,CAJH,EAAE,aAAa;EAC7B,MAAM,EAAE,QAAQ,YAAY;EAC5B,KAAK,IAAI;CACb,CAC8B,CAAC;CAC/B,MAAM,UAAU,EAAE,mBAAmB,QAAQ,cAAc,EACvD,OAAO,sCAAsC,aAAa,KAAK,UAAU,MAAM,MAAM,KAAK,KAAK,CAAC,CAAC,KAAK,IAAI,IAC9G,CAAC;CACD,OAAO,EACF,MAAM,SAAS,6BAA6B,CAAC,CAC7C,IAAI,GAAG,+BAA+B,CAAC,CACvC,aAAa,UAAU,QAAQ;EAChC,MAAM,uBAAO,IAAI,IAAI;EACrB,SAAS,SAAS,OAAO,UAAU;GAC/B,IAAI,KAAK,IAAI,MAAM,IAAI,GACnB,IAAI,SAAS;IACT,MAAM;IACN,SAAS,wBAAwB,MAAM,KAAK;IAC5C,MAAM,CAAC,KAAK;GAChB,CAAC;GAEL,KAAK,IAAI,MAAM,IAAI;EACvB,CAAC;CACL,CAAC;AACL;;;ACzBA,IAAM,oCAAoB,IAAI,OAAO,4EAA4E,GAAG;AACpH,IAAM,SAAS,SAAS,kBAAkB,KAAK,IAAI;AAGnD,IAAM,SAAS,cAAc,CAAC,MAAM,SAAS,KAAK,YAAY,UAAU,QAAQ,QAAQ,EAAE,CAAC;AAE3F,IAAI;;;;;;;AAOJ,SAAS,UAAU,OAAO;CACtB,cAAc,IAAI,KAAK,UAAU;CACjC,MAAM,aAAa,UAAU,QAAQ,KAAK;CAC1C,IAAI,QAAQ,MAAM;CAClB,KAAK,MAAM,EAAE,SAAS,WAAW,YAC7B,IAAI,CAAC,MAAM,OAAO,GAAG;EACjB,QAAQ;EACR;CACJ;CAEJ,IAAI,MAAM,MAAM;CAChB,OAAO,MAAM,OAAO;EAChB,MAAM,EAAE,SAAS,UAAU,WAAW,WAAW,MAAM,CAAC;EACxD,IAAI,CAAC,MAAM,OAAO,GACd;EAEJ,MAAM;CACV;CACA,OAAO,MAAM,MAAM,OAAO,GAAG;AACjC;;;;;AAKA,SAAgB,UAAU,WAAW;CACjC,OAAQ,EACH,OAAO,eAAe,CAAC,CAEvB,KAAK,CAAC,CACN,UAAU,SAAS,CAAC,CACpB,OAAO,OAAO,eAAe,CAAC,CAC9B,IAAI,WAAW,oBAAoB,UAAU,YAAY,CAAC,CAC1D,OAAO,aAAa,iCAAiC;AAC9D;AAGA,IAAM,gBAAgB;;;;;AAKtB,SAAgB,WAAW,WAAW;CAClC,OAAO,EACF,OAAO,eAAe,CAAC,CACvB,KAAK,CAAC,CACN,QAAQ,UAAU,cAAc,KAAK,KAAK,GAAG,eAAe,CAAC,CAC7D,IAAI,WAAW,oBAAoB,UAAU,YAAY,CAAC,CAC1D,OAAO,aAAa,iCAAiC;AAC9D;;;AC9DA,IAAa,mBAAmB;;;;;;AAMhC,IAAa,eAAe,YAAY,QAAQ,SAAS,GAAG;;;;;;AAM5D,SAAgB,iBAAiB,KAAK,gBAAgB;CAClD,IAAI,IAAI,KAAK,SAAA,KACT,OAAO,oBAAoB,eAAe;CAE9C,IAAI,IAAI,YAAY,IAAI,UACpB,OAAO;CAEX,IAAI,YAAY,IAAI,QAAQ,GAAG;EAC3B,IAAI,CAAC,gBACD,OAAO;EAEX,OAAO,IAAI,aAAa,YAAY,IAAI,aAAa,UAC/C,OACA;CACV;CACA,OAAO,IAAI,aAAa,WAAW,OAAO;AAC9C;AACA,IAAM,gBAAgB;AACtB,IAAM,eAAe;AAErB,IAAM,oBAAoB,CAAC,sBAAsB,oBAAoB;;AAErE,IAAM,aAAa,UAAU,kBAAkB,MAAM,SAAS,IAAI,MAAM,OAAO,WAAW,KAAK,EAAE,CAAC,EAAE,SAAS,IAAI;AACjH,SAAS,iBAAiB,KAAK,MAAM;CACjC,OAAO,IAAI,aAAa,IAAI,IAAI,IAAI,CAAC,CAAC;AAC1C;;;;;;;;;;;;;;;;;AAiBA,SAAgB,SAAS,EAAE,gBAAgB,QAAQ,WAAW,OAAO;CACjE,IAAI,UACA,OAAO,EAAE,OAAO,0BAA0B,CAAC,CAAC,WAAW,OAAO,QAAQ;EAClE,MAAM,MAAM,IAAI,MAAM,KAAK;EAC3B,MAAM,UAAU,MAAM,iBAAiB,KAAK,cAAc,IAAI;EAC9D,IAAI,SAAS;GACT,IAAI,SAAS;IAAE,MAAM;IAAU,SAAS;GAAQ,CAAC;GACjD,OAAO,EAAE;EACb;EACA,OAAO,IAAI;CACf,CAAC;CAEL,MAAM,SAAS,IAAI,IAAI,IAAI,CAAC,CAAC;CAC7B,OAAO,EAAE,OAAO,YAAY,CAAC,CAAC,WAAW,OAAO,QAAQ;EAKpD,MAAM,MAAM,IAAI,SAAS,KAAK,KAAK,UAAU,KAAK,IAAI,OAAO,IAAI,MAAM,OAAO,IAAI;EAClF,IAAI,CAAC,OAAO,IAAI,WAAW,UAAU,iBAAiB,KAAK,IAAI,GAAG;GAC9D,IAAI,SAAS;IAAE,MAAM;IAAU,SAAS;GAAa,CAAC;GACtD,OAAO,EAAE;EACb;EACA,MAAM,UAAU,iBAAiB,KAAK,cAAc;EACpD,IAAI,SAAS;GACT,IAAI,SAAS;IAAE,MAAM;IAAU,SAAS;GAAQ,CAAC;GACjD,OAAO,EAAE;EACb;EACA,IAAI,CAAC,gBAAgB,GAAG,IAAI,WAAW,IAAI,SAAS,IAAI,MAAM,GAAG;GAC7D,IAAI,SAAS;IAAE,MAAM;IAAU,SAAS;GAAc,CAAC;GACvD,OAAO,EAAE;EACb;EACA,OAAO,IAAI;CACf,CAAC;AACL;AACA,IAAM,iBAAiB;AAGvB,IAAM,aAAa,OAAO,GAAI;AAC9B,IAAM,gBAAgB,IAAI,OAAO,OAAO,GAAI,IAAI,WAAW,GAAG,WAAW,IAAI,WAAW,IAAI,GAAG;;;;;;AAM/F,SAAS,iBAAiB,MAAM;CAC5B,IAAI;EACA,OAAO,mBAAmB,KAAK,KAAK,MAAM,CAAgB,CAAC;CAC/D,QACM;EACF,OAAO;CACX;AACJ;;;;;;;AAOA,SAAgB,aAAa,KAAK;CAC9B,MAAM,MAAM,IAAI,IAAI;CACpB,OAAO,EAAE,OAAO,0BAA0B,CAAC,CAAC,WAAW,OAAO,QAAQ;EAElE,MAAM,OAAO,IAAI,MAAM,KAAK;EAC5B,IAAI,MAAM,aAAa,WAAW;GAC9B,MAAM,SAAS,IAAI,UAAU,KAAK;GAClC,IAAI,CAAC,OAAO,SAAS;IACjB,KAAK,MAAM,SAAS,OAAO,MAAM,QAC7B,IAAI,SAAS;KAAE,MAAM;KAAU,SAAS,MAAM;IAAQ,CAAC;IAE3D,OAAO,EAAE;GACb;GACA,OAAO,OAAO;EAClB;EACA,MAAM,aAAa,iBAAiB,IAAI;EACxC,IAAI,CAAC,cAAc,KAAK,KAAK,SAAA,OAA2B,CAAC,cAAc,KAAK,UAAU,GAAG;GACrF,IAAI,SAAS;IAAE,MAAM;IAAU,SAAS;GAAe,CAAC;GACxD,OAAO,EAAE;EACb;EACA,OAAO,KAAK;CAChB,CAAC;AACL;;;;;;AAMA,IAAa,oBAAoB,EAAE,IAAI,0BAA0B;;;ACzIjE,IAAM,kBAAkB;AACxB,IAAM,yBAAyB;AAC/B,IAAM,yBAAyB;AAC/B,IAAM,YAAY;AAClB,IAAM,6BAAa,IAAI,IAAI,CAAC,gBAAgB,aAAa,CAAC;AAC1D,IAAM,6BAAa,IAAI,IAAI;CACvB;CACA;CACA;CACA;CACA;AACJ,CAAC;;AAED,IAAM,gBAAgB,YAAY,EAAE,aAAa,OAAO,OAAO,EAAE,OAAO,CAAC,QAAQ,KAAK,SAAS,KAAK,CAAC,OAAO,IAAI,KAAK,EAAE,CAAC;;;;;;;;;;;;AAYxH,SAAS,cAAc,KAAK,MAAM,SAAS;CACvC,OAAQ,EACH,aAAa;EACd,IAAI,EAAE,OAAO,cAAc,EACvB,OAAO,yFACX,CAAC;EACD,MAAM,KAAK,eAAe;EAC1B,aAAa,KAAK,sBAAsB;EACxC,QAAQ,EAAE,aAAa;GACnB,MAAM,KAAK,sBAAsB;GAGjC,KAAK,QAAQ;EACjB,GAAG,0CAA0C;EAC7C,cAAc,EACT,OAAO,uCAAuC,CAAC,CAC/C,MAAM,WAAW,uCAAuC,CAAC,CACzD,YAAY;EACjB,MAAM,UAAU,GAAG;EACnB,UAAU,cAAc,GAAG;EAG3B,cAAc,IAAI,IAAI,CAAC,CAAC,QAAQ,YAAY,CAAC,YAAY,OAAO,GAAG,gBAAgB;EACnF,cAAc;EACd,aAAa;EAEb,aAAa,EAAE,QAAQ,wBAAwB;CACnD,CAAC,CAAC,CAGG,QAAQ,aAAa,SAAS,aAAa,MAAM,SAAS,YAAY,GAAG;EAC1E,SAAS;EACT,MAAM,CAAC,aAAa;EAGpB,MAAM,aAAa,UAAU;CACjC,CAAC,CAAC,CAEG,QAAQ,aAAa,SAAS,eAC/B,CAAC;EACG,SAAS,OAAO;EAChB,SAAS,SAAS,OAAO,SAAS,KAAK,MAAM,KAAA;EAC7C,GAAG,SAAS,SAAS,KAAK,YAAY,QAAQ,GAAG;EACjD,SAAS;CACb,CAAC,CAAC,MAAM,YAAY,YAAY,KAAA,KAAa,YAAY,IAAI,IAAI,OAAO,CAAC,CAAC,QAAQ,CAAC,GAAG;EACtF,SAAS;EACT,MAAM,CAAC,aAAa;EACpB,MAAM,aAAa,UAAU;CACjC,CAAC;AACL;;AAEA,SAAgB,eAAe,OAAO;CAClC,MAAM,OAAO,aAAa,SAAS,OAAO,QAAQ;CAClD,OAAO,cAAc,KAAK,iBAAiB,aAAa,GAAG,CAAC;AAChE;AAOiC,cAAc,aAAa,YAAY,WAAW;;;AC1FnF,SAAS,WAAW,MAAM;CACtB,OAAO,KAAK,QAAQ,QAAQ,SAAS;EACjC,IAAI,OAAO,SAAS,UAChB,OAAO,GAAG,OAAO,GAAG,KAAK;EAE7B,OAAO,SAAS,GAAG,OAAO,GAAG,OAAO,IAAI,MAAM,OAAO,IAAI;CAC7D,GAAG,EAAE;AACT;AACA,IAAM,qBAAqB;AAC3B,IAAM,gBAAgB;AACtB,IAAM,wBAAwB,GAAG,cAAc;;;;;;;AAO/C,SAAS,YAAY,KAAK;CACtB,OAAO,YAAY,IAAI,QAAQ,IAAI,wBAAwB;AAC/D;;;;;;;;;;;;;AAaA,SAAgB,iBAAiB,OAAO,EAAE,WAAW,iBAAiB,SAAS;CAC3E,IAAI,UAAU,WAAW,KAAK,CAAC,UAAU,OAAO,aAAa,OAAO,QAAQ,MAAM,IAAI,GAClF,OAAO;EAAE,SAAS;EAAO,OAAO;CAAmB;CAEvD,MAAM,MAAM,IAAI,MAAM,KAAK;CAC3B,IAAI,CAAC,KACD,OAAO;EAAE,SAAS;EAAO,OAAO;CAAiC;CAErE,MAAM,UAAU,YAAY,KAAK,IAAI,mBAAmB,iBAAiB,KAAK,cAAc;CAC5F,IAAI,SACA,OAAO;EAAE,SAAS;EAAO,OAAO,GAAG,QAAQ;CAA0B;CAEzE,IAAI,YAAY,KAAK,SAAS,GAC1B,OAAO;EAAE,SAAS;EAAO,OAAO,YAAY,GAAG;CAAE;CAErD,OAAO;EAAE,SAAS;EAAM,aAAa,IAAI;CAAK;AAClD;;AAEA,SAAgB,qBAAqB,QAAQ,WAAW;CACpD,OAAO,OACF,KAAK,EAAE,MAAM,cAAe,OAAO,GAAG,KAAK,IAAI,YAAY,OAAQ,CAAC,CACpE,KAAK,SAAS;AACvB;AACA,SAAS,QAAQ,QAAQ;CACrB,OAAO;EAAE,SAAS;EAAO,QAAQ;EAAW;CAAO;AACvD;;;;;;;;;;AAUA,SAAgB,cAAc,OAAO,SAAS;CAC1C,MAAM,iBAAiB,QAAQ,kBAAkB;CACjD,MAAM,UAAU,iBAAiB,QAAQ,aAAa,OAAO;CAC7D,IAAI,CAAC,QAAQ,SACT,OAAO,QAAQ,CAAC;EAAE,MAAM;EAAI,SAAS,QAAQ;CAAM,CAAC,CAAC;CAEzD,MAAM,SAAS,eAAe;EAAE;EAAgB,MAAM,QAAQ;CAAY,CAAC,CAAC,CAAC,UAAU,KAAK;CAC5F,IAAI,CAAC,OAAO,SACR,OAAO,QAAQ,OAAO,MAAM,OAAO,KAAK,WAAW;EAC/C,MAAM,WAAW,MAAM,IAAI;EAC3B,SAAS,MAAM;CACnB,EAAE,CAAC;CAEP,IAAI,OAAO,KAAK,iBAAiB,QAAQ,aACrC,OAAO;EACH,SAAS;EACT,QAAQ;EACR,QAAQ,CACJ;GACI,MAAM;GACN,SAAS,YAAY,QAAQ,YAAY;EAC7C,CACJ;CACJ;CAEJ,OAAO;EAAE,SAAS;EAAM,UAAU,OAAO;CAAK;AAClD;;;;ACtEA,IAAa,gBAAgB;;AAG7B,IAAM,eAAe;CAAC;CAAgB;CAAgB;CAAe;AAAa;AAgClF,IAAM,UAAU,MAAuB,SAAiB,OAAO,QAAiB;CAC9E,SAAS;CACT;CACA,QAAQ,CAAC;EAAE;EAAM;CAAQ,CAAC;AAC5B;;;;;AAMA,eAAsB,gBAAgB,QAAiB,SAA2C;CAKhG,MAAM,QAAQ,KAAK,UAAU,QAAQ,WAAW,GAAG,aAAa;CAChE,IAAI,OAAO,QAAQ,YACjB,MAAM,QAAQ,KAAK,UAAU,QAAQ,UAAU,GAAG,YAAY;CAGhE,MAAM,UAAU,iBAAiB,QAAQ,aAAa;EACpD,WAAW,CAAC,iBAAiB;EAC7B,gBAAgB;CAClB,CAAC;CACD,IAAI,CAAC,QAAQ,SACX,OAAO,OAAO,4BAA4B,QAAQ,KAAK;CAEzD,IAAI,OAAO,WAAW,YAAY,WAAW,QAAQ,MAAM,QAAQ,MAAM,GACvE,OAAO,OAAO,wBAAwB,wCAAwC;CAGhF,MAAM,QAAQ,aAAa,QAAQ,UAAU,SAAS,MAAM;CAC5D,IAAI,MAAM,SAAS,GACjB,OAAO;EACL,SAAS;EACT,MAAM;EACN,QAAQ,MAAM,KAAK,WAAW;GAC5B,MAAM;GACN,SAAS,SAAS,MAAM;EAC1B,EAAE;CACJ;CAGF,MAAM,WAAW;EACf,GAAG;EACH,cAAc,QAAQ;EACtB,cAAc,YAAY,QAAQ,WAAW;EAC7C,aAAa,YAAY,QAAQ,UAAU;EAC3C,aAAa,QAAQ;CACvB;CAGA,MAAM,SAAS,cAAc,UAAU;EACrC,aAAa,QAAQ;EACrB,WAAW,CAAC,iBAAiB;EAC7B,gBAAgB;CAClB,CAAC;CACD,IAAI,CAAC,OAAO,SAEV,OAAO;EAAE,SAAS;EAAO,MAAM;EAAwB,QAAQ,OAAO;CAAO;CAG/E,MAAM,SAAS,MAAM,aAAa,KAAK,UAAU,QAAQ,GAAG,QAAQ,WAAW;CAG/E,IAAI,IAAI,YAAY,CAAC,CAAC,OAAO,gBAAgB,MAAM,CAAC,CAAC,CAAC,aAAa,2BACjE,OAAO,OACL,0BACA,yCAAyC,KAAK,MAAM,4BAA4B,IAAI,EAAE,IACxF;CAEF,OAAO;EAAE,SAAS;EAAM;EAAQ;CAAS;AAC3C;;AAGA,SAAgB,aAAa,QAA0C;CACrE,OAAO,qBAAqB,QAAQ,IAAI;AAC1C;;AAGA,SAAgB,gBAAgB,QAAgC;CAC9D,OAAO,GAAG,KAAK,UAAU,QAAQ,MAAM,CAAC,EAAE;AAC5C;;AAGA,eAAsB,mBAAmB,MAAgC;CACvE,MAAM,OAAO,MAAM,SAAS,MAAM,MAAM;CACxC,IAAI;EACF,OAAO,cAAc,IAAI;CAC3B,SAAS,OAAO;EACd,MAAM,IAAI,MAAM,GAAG,KAAK,eAAgB,MAAgB,WAAW,EAAE,OAAO,MAAM,CAAC;CACrF;AACF;;AASA,eAAsB,YAAY,EAChC,MACA,MACA,KACA,aACA,eAAe,iBAC2B;CAK1C,OAAO,gBAAgB,MAHF,mBAAmB,QAAQ,MAAM,YAAY,CAAC,GAGpC;EAAE;EAAa,GAAG,MAD9B,gBAAgB;GAAE;GAAM;GAAM;EAAI,CAAC;EACC,aAAa,SAAS;CAAc,CAAC;AAC9F"}
@@ -0,0 +1,9 @@
1
+ //#region ../../contracts/app-contracts/build/identity/signed-manifest.d.ts
2
+ /** A signed manifest as an app serves it: flattened JWS JSON (RFC 7515, section 7.2.2). */
3
+ interface SignedManifest {
4
+ protected: string;
5
+ payload: string;
6
+ signature: string;
7
+ }
8
+ //#endregion
9
+ export { SignedManifest as t };
package/build/index.d.ts CHANGED
@@ -1,9 +1,12 @@
1
- //#region ../app-contracts/build/bridge/rules.d.ts
1
+ //#region ../../contracts/app-contracts/build/bridge/rules.d.ts
2
2
  /** Every code a refusal can carry, in either direction. */
3
3
  declare const BRIDGE_ERROR_CODES: readonly ["session_ended", "invalid_argument", "invalid_path", "blocked", "network_error", "rejected", "invalid_context"];
4
4
  type BridgeErrorCode = (typeof BRIDGE_ERROR_CODES)[number];
5
5
  declare const THEME_MODES: readonly ['light', 'dark'];
6
- /** The theme Admin is showing, so the page can match it. `mode` is resolved, never `system`. */
6
+ /**
7
+ * The theme Admin is showing, so the page can match it. `mode` is `light` or `dark`, never
8
+ * `system`.
9
+ */
7
10
  type Theme = {
8
11
  mode: (typeof THEME_MODES)[number];
9
12
  accent_color: string;
@@ -22,7 +25,7 @@ type StartContext = {
22
25
  /**
23
26
  * Who is using the app, by ID and role only. Name and email are left out on purpose: an
24
27
  * app that needs more about a person reads it from the API, through `/users/?filter=id:…`,
25
- * where app scopes will apply.
28
+ * where the app's permissions will apply.
26
29
  */
27
30
  user: {
28
31
  id: string;
@@ -67,21 +70,24 @@ type Place = {
67
70
  /**
68
71
  * Why an SDK call failed:
69
72
  *
70
- * - `not_framed`: the page is not framed in Admin, so there is nothing to connect to.
71
- * - `not_connected`: Admin did not start the app in time.
72
- * - `duplicate_sdk`: another copy of the SDK in the page has already connected, or tried to.
73
- * - `invalid_context`: Admin started the app with a context this SDK cannot read.
74
- * - `session_ended`: this document has left the app session, or the session has ended.
75
- * - `invalid_argument`: the app passed something that cannot be sent.
76
- * - `invalid_path`: a path that is not an Admin API path, or not a route within the app; or
73
+ * - `not_framed`: The page isn't framed in Admin, so there's nothing to connect to.
74
+ * - `not_connected`: Admin didn't start the app in time.
75
+ * - `duplicate_sdk`: Another copy of the SDK in the page has already connected, or tried to,
76
+ * because the page loads the SDK more than once. Load a single copy for the whole page.
77
+ * - `invalid_context`: Admin started the app with a context this SDK can't read. Updating the
78
+ * SDK usually fixes it.
79
+ * - `session_ended`: This document has left the app session, usually because the page reloaded
80
+ * or navigated away, or the session has ended. Every call fails after that.
81
+ * - `invalid_argument`: The app passed something that can't be sent.
82
+ * - `invalid_path`: A path that isn't an Admin API path or a route within the app, or
77
83
  * one the Admin API only redirects, such as a path without its trailing `/`.
78
- * - `unsupported`: this site's version of Ghost doesn't have the call the app made yet. The
84
+ * - `unsupported`: This site's version of Ghost doesn't have the call the app made yet. The
79
85
  * SDK knows this from the calls Admin listed when it connected.
80
86
  * - `blocked`: Admin refused by policy, such as a request the allowlist doesn't allow.
81
- * - `network_error`: Admin could not reach its own API.
82
- * - `rejected`: Admin refused for any other reason; the message says why.
87
+ * - `network_error`: Admin couldn't reach its own API.
88
+ * - `rejected`: Admin refused for another reason. The message says why.
83
89
  *
84
- * `not_framed`, `not_connected`, `duplicate_sdk` and `unsupported` are the SDK's own codes; the
90
+ * `not_framed`, `not_connected`, `duplicate_sdk` and `unsupported` are the SDK's own codes. The
85
91
  * rest are bridge codes, which cross the channel.
86
92
  */
87
93
  type GhostAppErrorCode = 'not_framed' | 'not_connected' | 'duplicate_sdk' | 'unsupported' | BridgeErrorCode;
@@ -96,7 +102,7 @@ declare class GhostAppError extends Error {
96
102
  type Site = Readonly<StartContext['site']>;
97
103
  /**
98
104
  * Who is using the app, by ID and role. Read anything more, such as their name, through
99
- * `ghost.fetch(`/users/?filter=id:${ghost.user.id}`)`: `/users/:id/` isn't allowed.
105
+ * `` ghost.fetch(`/users/?filter=id:${ghost.user.id}`) ``: `/users/:id/` isn't allowed.
100
106
  */
101
107
  type User = Readonly<StartContext['user']>;
102
108
  /** The session with Admin: the installation's revision when the session started. */
@@ -109,8 +115,12 @@ interface ConnectOptions {
109
115
  type JsonBody = Record<string, unknown> | readonly unknown[];
110
116
  /** Like `RequestInit`, for the requests Admin can make on the app's behalf. */
111
117
  interface GhostFetchInit {
112
- /** Any case; sent in uppercase. Defaults to `GET`. */
118
+ /** Any case, sent in uppercase. Defaults to `GET`. */
113
119
  method?: string;
120
+ /**
121
+ * Anything `Headers` accepts, except the headers only Admin sets. The SDK refuses those,
122
+ * such as `authorization`, `cookie` and `content-type`.
123
+ */
114
124
  headers?: HeadersInit;
115
125
  /** Always JSON: text is sent as it is, and an object or array is sent as JSON. */
116
126
  body?: string | JsonBody | null;
@@ -123,34 +133,39 @@ interface GhostFetchInit {
123
133
  interface GhostPath {
124
134
  /**
125
135
  * The app's route: the path, query and fragment of the page's URL, such as `/episodes/12`, in
126
- * the URL parser's normalised form, as Admin stores it (`/search?q=a%20b`, `..` resolved).
136
+ * the URL parser's normalized form, as Admin stores it (`/search?q=a%20b`, `..` resolved).
127
137
  */
128
138
  readonly current: string;
129
139
  }
130
140
  type Unsubscribe = () => void;
131
141
  /** The connection to Ghost, once Admin has started the app. */
132
142
  interface Ghost {
143
+ /** The site the app is running in: its URL, title, timezone and locale. */
133
144
  readonly site: Site;
145
+ /** The staff user using the app, by ID and role. */
134
146
  readonly user: User;
135
147
  /** The theme Admin shows now. `mode` is always `light` or `dark`. */
136
148
  readonly theme: Readonly<Theme>;
149
+ /** The installation's revision when this session started. */
137
150
  readonly session: Session;
151
+ /** The app's route, kept in step with Admin's URL. */
138
152
  readonly path: GhostPath;
139
- /** False once the session has ended; every call then rejects with `session_ended`. */
153
+ /** False once the session has ended. Every call then rejects with `session_ended`. */
140
154
  readonly connected: boolean;
141
- /** Called when the publisher switches Admin's theme. */
155
+ /** Registers a callback that runs when the person using the app switches Admin's theme. */
142
156
  onThemeChange(callback: (theme: Readonly<Theme>) => void): Unsubscribe;
143
157
  /**
144
- * Called when Admin moves the app to another of its routes: back or forward in Admin's
145
- * history, or one of Admin's own links. The SDK has already put the page's URL there and
146
- * dispatched `popstate`, which a router follows. A multi-page app, with no router to render
147
- * the new address, loads it: `location.replace(path)`. Not called for the app's own moves.
158
+ * Registers a callback that runs when Admin moves the app to another of its routes: Back or
159
+ * forward in Admin's history, or one of Admin's own links. The SDK has already put the
160
+ * page's URL there and dispatched `popstate`, which a router follows. A multi-page app, with
161
+ * no router to render the new address, loads it: `location.replace(path)`. It doesn't run for
162
+ * the app's own moves.
148
163
  */
149
164
  onPathChange(callback: (path: string) => void): Unsubscribe;
150
165
  /**
151
- * Called once when this document leaves the app session, because the page reloads, posts a
152
- * form or follows a link, or when the app session itself ends. Called straight away if that
153
- * has already happened.
166
+ * Registers a callback that runs once when this document leaves the app session, because the
167
+ * page reloads, posts a form or follows a link, or when the app session itself ends. It runs
168
+ * straight away if that has already happened.
154
169
  */
155
170
  onSessionEnd(callback: (error: GhostAppError) => void): Unsubscribe;
156
171
  /**
@@ -159,7 +174,7 @@ interface Ghost {
159
174
  * its status, and rejects only when Admin refuses to make the request.
160
175
  */
161
176
  fetch(path: string, init?: GhostFetchInit): Promise<Response>;
162
- /** Sends the publisher to a place in Admin, such as `{ post: { id } }`. */
177
+ /** Sends the person using the app to a place in Admin, such as `{ post: { id } }`. */
163
178
  open(place: Place): Promise<void>;
164
179
  }
165
180
  //#endregion
@@ -169,7 +184,7 @@ interface Ghost {
169
184
  * app. Safe to call as soon as the page loads.
170
185
  *
171
186
  * Every call shares one connection, and the first call's options apply. Only one copy of the
172
- * SDK in a page can connect; any other copy rejects with `duplicate_sdk`. Admin answers each
187
+ * SDK in a page can connect. Any other copy rejects with `duplicate_sdk`. Admin answers each
173
188
  * document only once, so after it answers, that connection is the page's only one. Once it
174
189
  * fails or its session ends, every call rejects with the error it ended with, and only a new
175
190
  * document (after a reload, for example) can connect again. A failure before Admin answered,