@lavitre/apps 1.57.0 → 1.58.0
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.
- package/README.md +12 -1
- package/dist/Common/Common.Model.d.ts +20 -1
- package/dist/Common/Common.Model.js.map +1 -1
- package/dist/Common/SettingsDefaults.d.ts +97 -0
- package/dist/Common/SettingsDefaults.js +222 -0
- package/dist/Common/SettingsDefaults.js.map +1 -0
- package/dist/Common/index.d.ts +1 -0
- package/dist/Common/index.js +1 -0
- package/dist/Common/index.js.map +1 -1
- package/dist/Connector/Connector.d.ts +17 -1
- package/dist/Connector/Connector.js +44 -5
- package/dist/Connector/Connector.js.map +1 -1
- package/dist/Frame/Frame.d.ts +17 -1
- package/dist/Frame/Frame.js +44 -5
- package/dist/Frame/Frame.js.map +1 -1
- package/dist/Version.d.ts +1 -1
- package/dist/Version.js +1 -1
- package/dist/Version.js.map +1 -1
- package/package.json +1 -1
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"SettingsDefaults.js","sourceRoot":"","sources":["../../Common/SettingsDefaults.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,4EAA4E;AAC5E,MAAM,CAAC,MAAM,kBAAkB,GAAG,uBAAuB,CAAA;AAczD,MAAM,aAAa,GAAG,CAAC,KAAc,EAAuB,EAAE,CAC5D,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;AAEtE;;;;GAIG;AACH,SAAS,iBAAiB,CAAC,QAAiB;IAC1C,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC;QAAE,OAAO,SAAS,CAAA;IAC9C,MAAM,GAAG,GAAG,QAAQ,CAAC,OAAO,CAAA;IAC5B,MAAM,MAAM,GAAG,aAAa,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IACzG,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO,GAAG,CAAA;IACpC,IAAI,GAAG,KAAK,SAAS;QAAE,OAAO,MAAM,CAAA;IACpC,OAAO,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAA;AAC9D,CAAC;AAED,4FAA4F;AAC5F,MAAM,UAAU,oBAAoB,CAAC,UAAmB;IACtD,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC;QAAE,OAAO,SAAS,CAAA;IAChD,MAAM,QAAQ,GAAe,EAAE,CAAA;IAC/B,KAAK,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;QACzD,MAAM,KAAK,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAA;QACzC,IAAI,KAAK,KAAK,SAAS;YAAE,QAAQ,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;IAChD,CAAC;IACD,OAAO,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAA;AAChE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,QAAiB;IACjD,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC;QAAE,OAAO,EAAE,CAAA;IACvC,MAAM,MAAM,GAAyB,EAAE,CAAA;IACvC,IAAI,OAAO,QAAQ,CAAC,OAAO,KAAK,QAAQ,IAAI,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QAC/E,MAAM,CAAC,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAA;IACnC,CAAC;IACD,KAAK,MAAM,KAAK,IAAI,CAAC,MAAM,EAAE,OAAO,CAAU,EAAE,CAAC;QAC/C,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAA;QAC5B,MAAM,QAAQ,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;QACpF,IAAI,QAAQ;YAAE,MAAM,CAAC,KAAK,CAAC,GAAG,QAAQ,CAAA;IACxC,CAAC;IACD,OAAO,MAAM,CAAA;AACf,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,QAAgC,EAAE,MAAkB;IAChF,IAAI,CAAC,QAAQ;QAAE,OAAO,MAAM,CAAA;IAC5B,MAAM,MAAM,GAAe,EAAE,GAAG,QAAQ,EAAE,CAAA;IAC1C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAClD,MAAM,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAA;QAC9B,MAAM,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC,KAAK,CAAC,IAAI,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAA;IACxG,CAAC;IACD,OAAO,MAAM,CAAA;AACf,CAAC;AAED,SAAS,SAAS,CAAC,CAAU,EAAE,CAAU;IACvC,IAAI,CAAC,KAAK,CAAC;QAAE,OAAO,IAAI,CAAA;IACxB,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;QACzC,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IAC7E,CAAC;IACD,IAAI,aAAa,CAAC,CAAC,CAAC,IAAI,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC;QACzC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAC3B,OAAO,IAAI,CAAC,MAAM,KAAK,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;IAC5G,CAAC;IACD,OAAO,KAAK,CAAA;AACd,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,eAAe,CAC7B,KAAiB,EACjB,MAA8B,EAC9B,QAAgC;IAEhC,IAAI,CAAC,QAAQ;QAAE,OAAO,KAAK,CAAA;IAC3B,MAAM,IAAI,GAAe,EAAE,CAAA;IAC3B,KAAK,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAChD,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC,GAAG,CAAC,CAAA;QAChC,MAAM,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAA;QAC9B,IAAI,UAAU,KAAK,SAAS,IAAI,QAAQ,KAAK,SAAS,IAAI,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC;YAAE,SAAQ;QAC7F,IAAI,aAAa,CAAC,IAAI,CAAC,IAAI,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,KAAK,SAAS,IAAI,aAAa,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC;YAC9G,MAAM,MAAM,GAAG,eAAe,CAAC,IAAI,EAAE,UAAoC,EAAE,QAAQ,CAAC,CAAA;YACpF,+EAA+E;YAC/E,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC,IAAI,UAAU,KAAK,SAAS;gBAAE,SAAQ;YAC1E,IAAI,CAAC,GAAG,CAAC,GAAG,MAAM,CAAA;YAClB,SAAQ;QACV,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAA;IAClB,CAAC;IACD,OAAO,IAAI,CAAA;AACb,CAAC;AAKD;;;;;;GAMG;AACH,MAAM,OAAO,wBAAwB;IAOnC,YACE,OAA4B,EAC5B,YAA2C,OAAO,KAAK,KAAK,UAAU;QACpE,CAAC,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC;QAC5C,CAAC,CAAC,SAAS;QAVP;;;;;WAA+C;QACtC;;;;mBAAa,IAAI,GAAG,EAAgC;WAAA;QAEpD;;;;;WAA4B;QAC5B;;;;;WAAwC;QAQvD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;IAC5B,CAAC;IAED,yFAAyF;IACzF,IAAI;QACF,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YACf,IAAI,CAAC,IAAI,GAAG,CAAC,KAAK,IAAI,EAAE;gBACtB,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,EAAE,CAAA;gBAC1B,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS;oBAAE,OAAO,EAAE,CAAA;gBACtC,IAAI,CAAC;oBACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAA;oBAC1C,OAAO,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,iBAAiB,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;gBACpE,CAAC;gBAAC,MAAM,CAAC;oBACP,OAAO,EAAE,CAAA;gBACX,CAAC;YACH,CAAC,CAAC,EAAE,CAAA;QACN,CAAC;QACD,OAAO,IAAI,CAAC,IAAI,CAAA;IAClB,CAAC;IAEO,KAAK,CAAC,UAAU,CAAC,KAAuB;QAC9C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,CAAA;QAC9B,OAAO;YACL,QAAQ,EAAE,KAAK,KAAK,MAAM,IAAI,KAAK,KAAK,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS;YACzE,aAAa,EAAE,IAAI,CAAC,OAAO;SAC5B,CAAA;IACH,CAAC;IAED,2FAA2F;IAC3F,KAAK,CAAC,MAAM,CAAC,KAAuB,EAAE,MAAkB,EAAE,OAAe;QACvE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;QAClC,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;QAChE,OAAO;YACL,KAAK;YACL,KAAK,EAAE,aAAa,CAAC,QAAQ,EAAE,MAAM,CAAC;YACtC,MAAM;YACN,OAAO;YACP,GAAG,CAAC,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAC1D,CAAA;IACH,CAAC;IAED,6EAA6E;IAC7E,KAAK,CAAC,QAAQ,CAAC,KAAuB,EAAE,KAAiB;QACvD,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;QAChE,OAAO,EAAE,KAAK,EAAE,eAAe,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,EAAE,aAAa,EAAE,CAAA;IAC/F,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,UAAU,sBAAsB;IACpC,IAAI,CAAC;QACH,OAAO,OAAO,QAAQ,KAAK,WAAW,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,kBAAkB,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAA;IACpG,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAA;IACb,CAAC;AACH,CAAC","sourcesContent":["import type { AppSettingsLevel } from './Common.Model.js'\n\n/**\n * SDK 1.58 — the defaults of the team- and space-level settings forms.\n *\n * An app declares what an administrator configures for a team or a space in a\n * static `lavitre.settings.json` at the root of its version, next to\n * `connector.html`:\n *\n * ```json\n * { \"version\": 1,\n * \"team\": { \"schema\": { \"city\": { \"type\": \"string\", \"default\": \"Paris\" } } },\n * \"space\": { \"schema\": { \"layout\": { \"type\": \"string\", \"default\": \"grid\" } } } }\n * ```\n *\n * The server never stores a default: what it keeps is only what someone chose.\n * The effective value is the schema `default`s overlaid with what is stored, and\n * only the running version knows which defaults apply (two spaces of one team\n * can run two versions of the app, and share the team level). So the SDK reads\n * the file the app ships, from the app's own origin, and merges it here.\n */\n\n/** File name, resolved against the app document (see `settingsFileUrl`). */\nexport const SETTINGS_FILE_NAME = 'lavitre.settings.json'\n\n/** The levels a `lavitre.settings.json` declares a form for. */\nexport type SettingsFormLevel = Extract<AppSettingsLevel, 'team' | 'space'>\n\n/** What the SDK keeps of `lavitre.settings.json`: its version and each level's defaults. */\nexport type SettingsFileDefaults = {\n version?: number\n team?: Record<string, unknown>\n space?: Record<string, unknown>\n}\n\ntype JsonObject = Record<string, unknown>\n\nconst isPlainObject = (value: unknown): value is JsonObject =>\n typeof value === 'object' && value !== null && !Array.isArray(value)\n\n/**\n * The defaults one property of a properties map contributes: its own `default`\n * and, for an object setting, the defaults of its nested `properties` underneath.\n * `undefined` when it declares none.\n */\nfunction defaultOfProperty(property: unknown): unknown {\n if (!isPlainObject(property)) return undefined\n const own = property.default\n const nested = isPlainObject(property.properties) ? defaultsOfProperties(property.properties) : undefined\n if (nested === undefined) return own\n if (own === undefined) return nested\n return isPlainObject(own) ? mergeDefaults(nested, own) : own\n}\n\n/** The defaults of a properties map (the `schema` of one level). `undefined` when empty. */\nexport function defaultsOfProperties(properties: unknown): JsonObject | undefined {\n if (!isPlainObject(properties)) return undefined\n const defaults: JsonObject = {}\n for (const [key, property] of Object.entries(properties)) {\n const value = defaultOfProperty(property)\n if (value !== undefined) defaults[key] = value\n }\n return Object.keys(defaults).length > 0 ? defaults : undefined\n}\n\n/**\n * Reads a parsed `lavitre.settings.json`. Tolerant on purpose: the server already\n * refused a malformed file at deploy time, and a file it never saw (a version\n * hosted elsewhere) must not break `getSettings` — anything unexpected is no\n * defaults.\n */\nexport function parseSettingsFile(document: unknown): SettingsFileDefaults {\n if (!isPlainObject(document)) return {}\n const parsed: SettingsFileDefaults = {}\n if (typeof document.version === 'number' && Number.isInteger(document.version)) {\n parsed.version = document.version\n }\n for (const level of ['team', 'space'] as const) {\n const form = document[level]\n const defaults = isPlainObject(form) ? defaultsOfProperties(form.schema) : undefined\n if (defaults) parsed[level] = defaults\n }\n return parsed\n}\n\n/**\n * `defaults` overlaid with `stored`: objects merge key by key, recursively; an\n * array or a scalar that is stored replaces the default whole. Neither input is\n * mutated.\n */\nexport function mergeDefaults(defaults: JsonObject | undefined, stored: JsonObject): JsonObject {\n if (!defaults) return stored\n const merged: JsonObject = { ...defaults }\n for (const [key, value] of Object.entries(stored)) {\n const fallback = defaults[key]\n merged[key] = isPlainObject(value) && isPlainObject(fallback) ? mergeDefaults(fallback, value) : value\n }\n return merged\n}\n\nfunction deepEqual(a: unknown, b: unknown): boolean {\n if (a === b) return true\n if (Array.isArray(a) && Array.isArray(b)) {\n return a.length === b.length && a.every((item, i) => deepEqual(item, b[i]))\n }\n if (isPlainObject(a) && isPlainObject(b)) {\n const keys = Object.keys(a)\n return keys.length === Object.keys(b).length && keys.every((key) => key in b && deepEqual(a[key], b[key]))\n }\n return false\n}\n\n/**\n * Undoes `mergeDefaults` before a write: drops the keys that are absent from\n * what was stored and still equal their default. An app that writes back the\n * merged value it read (`{ ...value, layout: 'grid' }`) would otherwise freeze\n * today's defaults into the store, and a later version's new default would\n * never reach that team. A key the app or an administrator did store is kept,\n * even when it equals the default: that was a choice.\n */\nexport function withoutDefaults(\n value: JsonObject,\n stored: JsonObject | undefined,\n defaults: JsonObject | undefined,\n): JsonObject {\n if (!defaults) return value\n const kept: JsonObject = {}\n for (const [key, item] of Object.entries(value)) {\n const storedItem = stored?.[key]\n const fallback = defaults[key]\n if (storedItem === undefined && fallback !== undefined && deepEqual(item, fallback)) continue\n if (isPlainObject(item) && isPlainObject(fallback) && (storedItem === undefined || isPlainObject(storedItem))) {\n const nested = withoutDefaults(item, storedItem as JsonObject | undefined, fallback)\n // An object that held only defaults goes away with them, unless it was stored.\n if (Object.keys(nested).length === 0 && storedItem === undefined) continue\n kept[key] = nested\n continue\n }\n kept[key] = item\n }\n return kept\n}\n\n/** `fetch` as the resolver uses it — injectable for the tests. */\nexport type SettingsFileFetch = (url: string) => Promise<{ ok: boolean; json(): Promise<unknown> }>\n\n/**\n * Loads `lavitre.settings.json` once per app document and answers the merge for\n * `getSettings` / `onSettingsChanged`, and the reverse for `setSettings`.\n *\n * It also remembers the last STORED value per level, which is what\n * `withoutDefaults` compares a write with.\n */\nexport class SettingsDefaultsResolver {\n private file: Promise<SettingsFileDefaults> | undefined\n private readonly lastStored = new Map<AppSettingsLevel, JsonObject>()\n\n private readonly fileUrl: () => string | null\n private readonly fetchFile: SettingsFileFetch | undefined\n\n constructor(\n fileUrl: () => string | null,\n fetchFile: SettingsFileFetch | undefined = typeof fetch === 'function'\n ? (url) => fetch(url, { cache: 'no-cache' })\n : undefined,\n ) {\n this.fileUrl = fileUrl\n this.fetchFile = fetchFile\n }\n\n /** The file, fetched on first use. A 404, a network error or bad JSON is no defaults. */\n load(): Promise<SettingsFileDefaults> {\n if (!this.file) {\n this.file = (async () => {\n const url = this.fileUrl()\n if (!url || !this.fetchFile) return {}\n try {\n const response = await this.fetchFile(url)\n return response.ok ? parseSettingsFile(await response.json()) : {}\n } catch {\n return {}\n }\n })()\n }\n return this.file\n }\n\n private async defaultsOf(level: AppSettingsLevel) {\n const file = await this.load()\n return {\n defaults: level === 'team' || level === 'space' ? file[level] : undefined,\n schemaVersion: file.version,\n }\n }\n\n /** What `getSettings` / `onSettingsChanged` hand the app, from the host's stored value. */\n async merged(level: AppSettingsLevel, stored: JsonObject, version: number) {\n this.lastStored.set(level, stored)\n const { defaults, schemaVersion } = await this.defaultsOf(level)\n return {\n level,\n value: mergeDefaults(defaults, stored),\n stored,\n version,\n ...(schemaVersion !== undefined ? { schemaVersion } : {}),\n }\n }\n\n /** The value `setSettings` sends, and the file version that goes with it. */\n async forWrite(level: AppSettingsLevel, value: JsonObject) {\n const { defaults, schemaVersion } = await this.defaultsOf(level)\n return { value: withoutDefaults(value, this.lastStored.get(level), defaults), schemaVersion }\n }\n}\n\n/**\n * Where an app document finds its `lavitre.settings.json`: next to the document,\n * which is the version root for `connector.html` and the frames beside it. A\n * frame in a sub-folder sets `settingsFileUrl` itself.\n */\nexport function defaultSettingsFileUrl(): string | null {\n try {\n return typeof document !== 'undefined' ? new URL(SETTINGS_FILE_NAME, document.baseURI).href : null\n } catch {\n return null\n }\n}\n"]}
|
package/dist/Common/index.d.ts
CHANGED
|
@@ -3,6 +3,7 @@ export { compareVersions, isMinVersion } from './Version.js';
|
|
|
3
3
|
export { CrdtChannel, MIN_CRDT_HOST_VERSION, type CrdtAttachment, type CrdtInboundMessage, type CrdtOutboundMessage, type CrdtPostMessage, } from './CrdtChannel.js';
|
|
4
4
|
export { BlobStore } from './BlobStore.js';
|
|
5
5
|
export { AppSettingsError, APP_SETTINGS_TIMEOUT_MS, type AppSettingsErrorCode, } from './AppSettings.js';
|
|
6
|
+
export { SETTINGS_FILE_NAME, SettingsDefaultsResolver, defaultsOfProperties, mergeDefaults, parseSettingsFile, withoutDefaults, type SettingsFileDefaults, type SettingsFormLevel, } from './SettingsDefaults.js';
|
|
6
7
|
export { PublicStorageError, PUBLIC_STORAGE_TIMEOUT_MS, PUBLIC_STORAGE_PUT_TIMEOUT_MS, MAX_PUBLIC_FILE_SIZE_BYTES, MIN_PUBLIC_FILE_EXPIRES_IN_SECONDS, validateExpiresIn, putPublicFileExpiryField, withDownloadUrlFallback, type PublicStorageErrorCode, type PublicStorageApi, type PublicStoragePutOptions, } from './PublicStorage.js';
|
|
7
8
|
export { PrivateStorageError, PRIVATE_STORAGE_TIMEOUT_MS, PRIVATE_STORAGE_PUT_TIMEOUT_MS, PRIVATE_STORAGE_GET_TIMEOUT_MS, MAX_PRIVATE_FILE_SIZE_BYTES, MIN_PRIVATE_FILE_EXPIRES_IN_SECONDS, MAX_PRIVATE_LINK_EXPIRES_IN_SECONDS, DEFAULT_PRIVATE_LINK_EXPIRES_IN_SECONDS, MAX_PRIVATE_PATH_LENGTH, MAX_PRIVATE_PATH_SEGMENTS, validatePrivatePath, validatePrivateExpiresIn, validateLinkExpiresIn, privateFileExpiryField, type PrivateStorageErrorCode, type PrivateStorageApi, type PrivateStorageReadApi, type PrivateStoragePutOptions, type PrivateStorageGetLinkOptions, } from './PrivateStorage.js';
|
|
8
9
|
export { AiChannel, MIN_AI_HOST_VERSION, type AiTool, type AiToolHandler, type AiInboundMessage, type AiOutboundMessage, type AiPostMessage, } from './AiChannel.js';
|
package/dist/Common/index.js
CHANGED
|
@@ -3,6 +3,7 @@ export { compareVersions, isMinVersion } from './Version.js';
|
|
|
3
3
|
export { CrdtChannel, MIN_CRDT_HOST_VERSION, } from './CrdtChannel.js';
|
|
4
4
|
export { BlobStore } from './BlobStore.js';
|
|
5
5
|
export { AppSettingsError, APP_SETTINGS_TIMEOUT_MS, } from './AppSettings.js';
|
|
6
|
+
export { SETTINGS_FILE_NAME, SettingsDefaultsResolver, defaultsOfProperties, mergeDefaults, parseSettingsFile, withoutDefaults, } from './SettingsDefaults.js';
|
|
6
7
|
export { PublicStorageError, PUBLIC_STORAGE_TIMEOUT_MS, PUBLIC_STORAGE_PUT_TIMEOUT_MS, MAX_PUBLIC_FILE_SIZE_BYTES, MIN_PUBLIC_FILE_EXPIRES_IN_SECONDS, validateExpiresIn, putPublicFileExpiryField, withDownloadUrlFallback, } from './PublicStorage.js';
|
|
7
8
|
export { PrivateStorageError, PRIVATE_STORAGE_TIMEOUT_MS, PRIVATE_STORAGE_PUT_TIMEOUT_MS, PRIVATE_STORAGE_GET_TIMEOUT_MS, MAX_PRIVATE_FILE_SIZE_BYTES, MIN_PRIVATE_FILE_EXPIRES_IN_SECONDS, MAX_PRIVATE_LINK_EXPIRES_IN_SECONDS, DEFAULT_PRIVATE_LINK_EXPIRES_IN_SECONDS, MAX_PRIVATE_PATH_LENGTH, MAX_PRIVATE_PATH_SEGMENTS, validatePrivatePath, validatePrivateExpiresIn, validateLinkExpiresIn, privateFileExpiryField, } from './PrivateStorage.js';
|
|
8
9
|
export { AiChannel, MIN_AI_HOST_VERSION, } from './AiChannel.js';
|
package/dist/Common/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../Common/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAA;AACjC,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAC5D,OAAO,EACL,WAAW,EACX,qBAAqB,GAKtB,MAAM,kBAAkB,CAAA;AACzB,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EACL,gBAAgB,EAChB,uBAAuB,GAExB,MAAM,kBAAkB,CAAA;AACzB,OAAO,EACL,kBAAkB,EAClB,yBAAyB,EACzB,6BAA6B,EAC7B,0BAA0B,EAC1B,kCAAkC,EAClC,iBAAiB,EACjB,wBAAwB,EACxB,uBAAuB,GAIxB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EACL,mBAAmB,EACnB,0BAA0B,EAC1B,8BAA8B,EAC9B,8BAA8B,EAC9B,2BAA2B,EAC3B,mCAAmC,EACnC,mCAAmC,EACnC,uCAAuC,EACvC,uBAAuB,EACvB,yBAAyB,EACzB,mBAAmB,EACnB,wBAAwB,EACxB,qBAAqB,EACrB,sBAAsB,GAMvB,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EACL,SAAS,EACT,mBAAmB,GAMpB,MAAM,gBAAgB,CAAA;AAEvB,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAChC,KAAwB,EACxB,YAAe,EACf,EAAE;IACF,MAAM,WAAW,GAAG,CAAC,KAAU,EAAE,YAAiB,EAAE,EAAE;QACpD,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;YAC/B,OAAO,KAAK,CAAA;QACd,CAAC;QAED,IAAI,OAAO,KAAK,KAAK,OAAO,YAAY,EAAE,CAAC;YACzC,OAAO,YAAY,CAAA;QACrB,CAAC;QAED,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE,CAAC;YACrC,IAAI,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;gBAChC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC1B,OAAO,YAAY,CAAA;gBACrB,CAAC;qBAAM,CAAC;oBACN,OAAO,KAAK,CAAA;gBACd,CAAC;YACH,CAAC;YAED,KAAK,GAAG,KAAK,KAAK,SAAS,IAAI,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAA;YACzD,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;gBACxC,KAAK,CAAC,GAAG,CAAC,GAAG,kBAAkB,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,YAAY,CAAC,GAAG,CAAC,CAAC,CAAA;YAChE,CAAC,CAAC,CAAA;QACJ,CAAC;QAED,OAAO,KAAK,CAAA;IACd,CAAC,CAAA;IAED,OAAO,WAAW,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,EAAE,YAAY,CAAM,CAAA;AACzE,CAAC,CAAA;AACD,cAAc,qBAAqB,CAAA","sourcesContent":["export * from './Common.Model.js'\nexport { compareVersions, isMinVersion } from './Version.js'\nexport {\n CrdtChannel,\n MIN_CRDT_HOST_VERSION,\n type CrdtAttachment,\n type CrdtInboundMessage,\n type CrdtOutboundMessage,\n type CrdtPostMessage,\n} from './CrdtChannel.js'\nexport { BlobStore } from './BlobStore.js'\nexport {\n AppSettingsError,\n APP_SETTINGS_TIMEOUT_MS,\n type AppSettingsErrorCode,\n} from './AppSettings.js'\nexport {\n PublicStorageError,\n PUBLIC_STORAGE_TIMEOUT_MS,\n PUBLIC_STORAGE_PUT_TIMEOUT_MS,\n MAX_PUBLIC_FILE_SIZE_BYTES,\n MIN_PUBLIC_FILE_EXPIRES_IN_SECONDS,\n validateExpiresIn,\n putPublicFileExpiryField,\n withDownloadUrlFallback,\n type PublicStorageErrorCode,\n type PublicStorageApi,\n type PublicStoragePutOptions,\n} from './PublicStorage.js'\nexport {\n PrivateStorageError,\n PRIVATE_STORAGE_TIMEOUT_MS,\n PRIVATE_STORAGE_PUT_TIMEOUT_MS,\n PRIVATE_STORAGE_GET_TIMEOUT_MS,\n MAX_PRIVATE_FILE_SIZE_BYTES,\n MIN_PRIVATE_FILE_EXPIRES_IN_SECONDS,\n MAX_PRIVATE_LINK_EXPIRES_IN_SECONDS,\n DEFAULT_PRIVATE_LINK_EXPIRES_IN_SECONDS,\n MAX_PRIVATE_PATH_LENGTH,\n MAX_PRIVATE_PATH_SEGMENTS,\n validatePrivatePath,\n validatePrivateExpiresIn,\n validateLinkExpiresIn,\n privateFileExpiryField,\n type PrivateStorageErrorCode,\n type PrivateStorageApi,\n type PrivateStorageReadApi,\n type PrivateStoragePutOptions,\n type PrivateStorageGetLinkOptions,\n} from './PrivateStorage.js'\nexport {\n AiChannel,\n MIN_AI_HOST_VERSION,\n type AiTool,\n type AiToolHandler,\n type AiInboundMessage,\n type AiOutboundMessage,\n type AiPostMessage,\n} from './AiChannel.js'\n\nexport const ensureDefaultValue = <T>(\n value: Partial<T> | null,\n defaultValue: T,\n) => {\n const ensureValue = (value: any, defaultValue: any) => {\n if (defaultValue === undefined) {\n return value\n }\n\n if (typeof value !== typeof defaultValue) {\n return defaultValue\n }\n\n if (typeof defaultValue === 'object') {\n if (Array.isArray(defaultValue)) {\n if (!Array.isArray(value)) {\n return defaultValue\n } else {\n return value\n }\n }\n\n value = value === undefined || value == null ? {} : value\n Object.keys(defaultValue).forEach((key) => {\n value[key] = ensureDefaultValue(value[key], defaultValue[key])\n })\n }\n\n return value\n }\n\n return ensureValue(value === undefined ? {} : value, defaultValue) as T\n}\nexport * from './PreviewScaling.js'\n"]}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../Common/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAA;AACjC,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAC5D,OAAO,EACL,WAAW,EACX,qBAAqB,GAKtB,MAAM,kBAAkB,CAAA;AACzB,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EACL,gBAAgB,EAChB,uBAAuB,GAExB,MAAM,kBAAkB,CAAA;AACzB,OAAO,EACL,kBAAkB,EAClB,wBAAwB,EACxB,oBAAoB,EACpB,aAAa,EACb,iBAAiB,EACjB,eAAe,GAGhB,MAAM,uBAAuB,CAAA;AAC9B,OAAO,EACL,kBAAkB,EAClB,yBAAyB,EACzB,6BAA6B,EAC7B,0BAA0B,EAC1B,kCAAkC,EAClC,iBAAiB,EACjB,wBAAwB,EACxB,uBAAuB,GAIxB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EACL,mBAAmB,EACnB,0BAA0B,EAC1B,8BAA8B,EAC9B,8BAA8B,EAC9B,2BAA2B,EAC3B,mCAAmC,EACnC,mCAAmC,EACnC,uCAAuC,EACvC,uBAAuB,EACvB,yBAAyB,EACzB,mBAAmB,EACnB,wBAAwB,EACxB,qBAAqB,EACrB,sBAAsB,GAMvB,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EACL,SAAS,EACT,mBAAmB,GAMpB,MAAM,gBAAgB,CAAA;AAEvB,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAChC,KAAwB,EACxB,YAAe,EACf,EAAE;IACF,MAAM,WAAW,GAAG,CAAC,KAAU,EAAE,YAAiB,EAAE,EAAE;QACpD,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;YAC/B,OAAO,KAAK,CAAA;QACd,CAAC;QAED,IAAI,OAAO,KAAK,KAAK,OAAO,YAAY,EAAE,CAAC;YACzC,OAAO,YAAY,CAAA;QACrB,CAAC;QAED,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE,CAAC;YACrC,IAAI,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;gBAChC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC1B,OAAO,YAAY,CAAA;gBACrB,CAAC;qBAAM,CAAC;oBACN,OAAO,KAAK,CAAA;gBACd,CAAC;YACH,CAAC;YAED,KAAK,GAAG,KAAK,KAAK,SAAS,IAAI,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAA;YACzD,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;gBACxC,KAAK,CAAC,GAAG,CAAC,GAAG,kBAAkB,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,YAAY,CAAC,GAAG,CAAC,CAAC,CAAA;YAChE,CAAC,CAAC,CAAA;QACJ,CAAC;QAED,OAAO,KAAK,CAAA;IACd,CAAC,CAAA;IAED,OAAO,WAAW,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,EAAE,YAAY,CAAM,CAAA;AACzE,CAAC,CAAA;AACD,cAAc,qBAAqB,CAAA","sourcesContent":["export * from './Common.Model.js'\nexport { compareVersions, isMinVersion } from './Version.js'\nexport {\n CrdtChannel,\n MIN_CRDT_HOST_VERSION,\n type CrdtAttachment,\n type CrdtInboundMessage,\n type CrdtOutboundMessage,\n type CrdtPostMessage,\n} from './CrdtChannel.js'\nexport { BlobStore } from './BlobStore.js'\nexport {\n AppSettingsError,\n APP_SETTINGS_TIMEOUT_MS,\n type AppSettingsErrorCode,\n} from './AppSettings.js'\nexport {\n SETTINGS_FILE_NAME,\n SettingsDefaultsResolver,\n defaultsOfProperties,\n mergeDefaults,\n parseSettingsFile,\n withoutDefaults,\n type SettingsFileDefaults,\n type SettingsFormLevel,\n} from './SettingsDefaults.js'\nexport {\n PublicStorageError,\n PUBLIC_STORAGE_TIMEOUT_MS,\n PUBLIC_STORAGE_PUT_TIMEOUT_MS,\n MAX_PUBLIC_FILE_SIZE_BYTES,\n MIN_PUBLIC_FILE_EXPIRES_IN_SECONDS,\n validateExpiresIn,\n putPublicFileExpiryField,\n withDownloadUrlFallback,\n type PublicStorageErrorCode,\n type PublicStorageApi,\n type PublicStoragePutOptions,\n} from './PublicStorage.js'\nexport {\n PrivateStorageError,\n PRIVATE_STORAGE_TIMEOUT_MS,\n PRIVATE_STORAGE_PUT_TIMEOUT_MS,\n PRIVATE_STORAGE_GET_TIMEOUT_MS,\n MAX_PRIVATE_FILE_SIZE_BYTES,\n MIN_PRIVATE_FILE_EXPIRES_IN_SECONDS,\n MAX_PRIVATE_LINK_EXPIRES_IN_SECONDS,\n DEFAULT_PRIVATE_LINK_EXPIRES_IN_SECONDS,\n MAX_PRIVATE_PATH_LENGTH,\n MAX_PRIVATE_PATH_SEGMENTS,\n validatePrivatePath,\n validatePrivateExpiresIn,\n validateLinkExpiresIn,\n privateFileExpiryField,\n type PrivateStorageErrorCode,\n type PrivateStorageApi,\n type PrivateStorageReadApi,\n type PrivateStoragePutOptions,\n type PrivateStorageGetLinkOptions,\n} from './PrivateStorage.js'\nexport {\n AiChannel,\n MIN_AI_HOST_VERSION,\n type AiTool,\n type AiToolHandler,\n type AiInboundMessage,\n type AiOutboundMessage,\n type AiPostMessage,\n} from './AiChannel.js'\n\nexport const ensureDefaultValue = <T>(\n value: Partial<T> | null,\n defaultValue: T,\n) => {\n const ensureValue = (value: any, defaultValue: any) => {\n if (defaultValue === undefined) {\n return value\n }\n\n if (typeof value !== typeof defaultValue) {\n return defaultValue\n }\n\n if (typeof defaultValue === 'object') {\n if (Array.isArray(defaultValue)) {\n if (!Array.isArray(value)) {\n return defaultValue\n } else {\n return value\n }\n }\n\n value = value === undefined || value == null ? {} : value\n Object.keys(defaultValue).forEach((key) => {\n value[key] = ensureDefaultValue(value[key], defaultValue[key])\n })\n }\n\n return value\n }\n\n return ensureValue(value === undefined ? {} : value, defaultValue) as T\n}\nexport * from './PreviewScaling.js'\n"]}
|
|
@@ -34,9 +34,19 @@ export declare class Connector {
|
|
|
34
34
|
* Pushed whenever the AppSettings value at a given level changes — see
|
|
35
35
|
* {@link getSettings} / {@link setSettings}. Fires for changes made by
|
|
36
36
|
* this app itself as well as by another vitre/app instance sharing the
|
|
37
|
-
* same team/space. Added 1.52.
|
|
37
|
+
* same team/space. Added 1.52. Since 1.58 `value` carries the defaults of
|
|
38
|
+
* `lavitre.settings.json` for `team` and `space`, like {@link getSettings}.
|
|
38
39
|
*/
|
|
39
40
|
onSettingsChanged?: (change: AppSettingsValue) => void;
|
|
41
|
+
/**
|
|
42
|
+
* Since 1.58: where {@link getSettings} reads the defaults of the team and
|
|
43
|
+
* space forms — `lavitre.settings.json` next to this document by default
|
|
44
|
+
* (the version root, for `connector.html` and the frames beside it). A
|
|
45
|
+
* document in a sub-folder points it at the root; `null` turns the merge
|
|
46
|
+
* off. Read once, on the first settings call.
|
|
47
|
+
*/
|
|
48
|
+
settingsFileUrl: string | null;
|
|
49
|
+
private readonly settingsDefaults;
|
|
40
50
|
onVitreSettingsUpdated?: (settings: VitreSettings) => void;
|
|
41
51
|
onConnectionCodeUpdated?: (companionCode?: string) => void;
|
|
42
52
|
onNotificationDismissed?: (notificationId: string) => void;
|
|
@@ -220,6 +230,12 @@ export declare class Connector {
|
|
|
220
230
|
* Rejects with an {@link AppSettingsError} of code `'unsupported'` if the
|
|
221
231
|
* host doesn't answer within 10s — a vitre host older than this feature
|
|
222
232
|
* never responds to `getAppSettings`.
|
|
233
|
+
*
|
|
234
|
+
* Since 1.58, for `team` and `space`, `value` is the defaults of the app's
|
|
235
|
+
* `lavitre.settings.json` (see {@link settingsFileUrl}) overlaid with what is
|
|
236
|
+
* stored, and `stored` is the stored value alone. {@link setSettings} drops
|
|
237
|
+
* the defaults again before writing, so writing back `{ ...value, key }` does
|
|
238
|
+
* not freeze today's defaults into the store.
|
|
223
239
|
*/
|
|
224
240
|
getSettings(level: AppSettingsLevel): Promise<AppSettingsValue>;
|
|
225
241
|
/**
|
|
@@ -4,6 +4,7 @@ import { CrdtChannel, MIN_CRDT_HOST_VERSION } from '../Common/CrdtChannel.js';
|
|
|
4
4
|
import { BlobStore } from '../Common/BlobStore.js';
|
|
5
5
|
import { isMinVersion } from '../Common/index.js';
|
|
6
6
|
import { AppSettingsError, APP_SETTINGS_TIMEOUT_MS } from '../Common/AppSettings.js';
|
|
7
|
+
import { SettingsDefaultsResolver, defaultSettingsFileUrl } from '../Common/SettingsDefaults.js';
|
|
7
8
|
import { PublicStorageError, PUBLIC_STORAGE_TIMEOUT_MS, PUBLIC_STORAGE_PUT_TIMEOUT_MS, MAX_PUBLIC_FILE_SIZE_BYTES, validateExpiresIn, putPublicFileExpiryField, withDownloadUrlFallback, } from '../Common/PublicStorage.js';
|
|
8
9
|
import { PrivateStorageError, PRIVATE_STORAGE_TIMEOUT_MS, PRIVATE_STORAGE_PUT_TIMEOUT_MS, PRIVATE_STORAGE_GET_TIMEOUT_MS, MAX_PRIVATE_FILE_SIZE_BYTES, validatePrivatePath, validatePrivateExpiresIn, validateLinkExpiresIn, privateFileExpiryField, } from '../Common/PrivateStorage.js';
|
|
9
10
|
import { apiVersion } from '../Version.js';
|
|
@@ -152,7 +153,8 @@ export class Connector {
|
|
|
152
153
|
* Pushed whenever the AppSettings value at a given level changes — see
|
|
153
154
|
* {@link getSettings} / {@link setSettings}. Fires for changes made by
|
|
154
155
|
* this app itself as well as by another vitre/app instance sharing the
|
|
155
|
-
* same team/space. Added 1.52.
|
|
156
|
+
* same team/space. Added 1.52. Since 1.58 `value` carries the defaults of
|
|
157
|
+
* `lavitre.settings.json` for `team` and `space`, like {@link getSettings}.
|
|
156
158
|
*/
|
|
157
159
|
Object.defineProperty(this, "onSettingsChanged", {
|
|
158
160
|
enumerable: true,
|
|
@@ -160,6 +162,25 @@ export class Connector {
|
|
|
160
162
|
writable: true,
|
|
161
163
|
value: void 0
|
|
162
164
|
});
|
|
165
|
+
/**
|
|
166
|
+
* Since 1.58: where {@link getSettings} reads the defaults of the team and
|
|
167
|
+
* space forms — `lavitre.settings.json` next to this document by default
|
|
168
|
+
* (the version root, for `connector.html` and the frames beside it). A
|
|
169
|
+
* document in a sub-folder points it at the root; `null` turns the merge
|
|
170
|
+
* off. Read once, on the first settings call.
|
|
171
|
+
*/
|
|
172
|
+
Object.defineProperty(this, "settingsFileUrl", {
|
|
173
|
+
enumerable: true,
|
|
174
|
+
configurable: true,
|
|
175
|
+
writable: true,
|
|
176
|
+
value: defaultSettingsFileUrl()
|
|
177
|
+
});
|
|
178
|
+
Object.defineProperty(this, "settingsDefaults", {
|
|
179
|
+
enumerable: true,
|
|
180
|
+
configurable: true,
|
|
181
|
+
writable: true,
|
|
182
|
+
value: new SettingsDefaultsResolver(() => this.settingsFileUrl)
|
|
183
|
+
});
|
|
163
184
|
Object.defineProperty(this, "onVitreSettingsUpdated", {
|
|
164
185
|
enumerable: true,
|
|
165
186
|
configurable: true,
|
|
@@ -691,7 +712,9 @@ export class Connector {
|
|
|
691
712
|
// Handled by requestResolvers (postRequest pattern)
|
|
692
713
|
break;
|
|
693
714
|
case 'appSettingsChanged':
|
|
694
|
-
this.
|
|
715
|
+
void this.settingsDefaults
|
|
716
|
+
.merged(msg.level, msg.value ?? {}, msg.version)
|
|
717
|
+
.then((change) => this.onSettingsChanged?.(change));
|
|
695
718
|
break;
|
|
696
719
|
case 'publicStorageResponse':
|
|
697
720
|
// Handled by requestResolvers (postRequest pattern)
|
|
@@ -1330,10 +1353,16 @@ export class Connector {
|
|
|
1330
1353
|
* Rejects with an {@link AppSettingsError} of code `'unsupported'` if the
|
|
1331
1354
|
* host doesn't answer within 10s — a vitre host older than this feature
|
|
1332
1355
|
* never responds to `getAppSettings`.
|
|
1356
|
+
*
|
|
1357
|
+
* Since 1.58, for `team` and `space`, `value` is the defaults of the app's
|
|
1358
|
+
* `lavitre.settings.json` (see {@link settingsFileUrl}) overlaid with what is
|
|
1359
|
+
* stored, and `stored` is the stored value alone. {@link setSettings} drops
|
|
1360
|
+
* the defaults again before writing, so writing back `{ ...value, key }` does
|
|
1361
|
+
* not freeze today's defaults into the store.
|
|
1333
1362
|
*/
|
|
1334
1363
|
async getSettings(level) {
|
|
1335
1364
|
const requestId = randomUuid();
|
|
1336
|
-
|
|
1365
|
+
const read = await this.postRequest({ type: 'getAppSettings', requestId, level }, (msg, resolve, reject) => {
|
|
1337
1366
|
if (msg.type === 'appSettingsResponse' && msg.requestId === requestId) {
|
|
1338
1367
|
if (msg.ok) {
|
|
1339
1368
|
resolve({ level: msg.level, value: msg.value ?? {}, version: msg.version ?? 0 });
|
|
@@ -1343,6 +1372,7 @@ export class Connector {
|
|
|
1343
1372
|
}
|
|
1344
1373
|
}
|
|
1345
1374
|
}, undefined, { ms: APP_SETTINGS_TIMEOUT_MS, onTimeout: () => new AppSettingsError('unsupported', level) });
|
|
1375
|
+
return await this.settingsDefaults.merged(read.level, read.value, read.version);
|
|
1346
1376
|
}
|
|
1347
1377
|
/**
|
|
1348
1378
|
* Write the app's settings at `level`, with optimistic concurrency:
|
|
@@ -1357,12 +1387,20 @@ export class Connector {
|
|
|
1357
1387
|
*/
|
|
1358
1388
|
async setSettings(level, value, expectedVersion) {
|
|
1359
1389
|
const requestId = randomUuid();
|
|
1360
|
-
|
|
1390
|
+
const write = await this.settingsDefaults.forWrite(level, value);
|
|
1391
|
+
const written = await this.postRequest({
|
|
1392
|
+
type: 'setAppSettings',
|
|
1393
|
+
requestId,
|
|
1394
|
+
level,
|
|
1395
|
+
value: write.value,
|
|
1396
|
+
expectedVersion,
|
|
1397
|
+
...(write.schemaVersion !== undefined ? { schemaVersion: write.schemaVersion } : {}),
|
|
1398
|
+
}, (msg, resolve, reject) => {
|
|
1361
1399
|
if (msg.type === 'appSettingsResponse' && msg.requestId === requestId) {
|
|
1362
1400
|
if (msg.ok) {
|
|
1363
1401
|
resolve({
|
|
1364
1402
|
level: msg.level,
|
|
1365
|
-
value: msg.value ?? value,
|
|
1403
|
+
value: msg.value ?? write.value,
|
|
1366
1404
|
version: msg.version ?? expectedVersion,
|
|
1367
1405
|
});
|
|
1368
1406
|
}
|
|
@@ -1371,6 +1409,7 @@ export class Connector {
|
|
|
1371
1409
|
}
|
|
1372
1410
|
}
|
|
1373
1411
|
}, undefined, { ms: APP_SETTINGS_TIMEOUT_MS, onTimeout: () => new AppSettingsError('unsupported', level) });
|
|
1412
|
+
return await this.settingsDefaults.merged(written.level, written.value, written.version);
|
|
1374
1413
|
}
|
|
1375
1414
|
changeTeamSpace(space) {
|
|
1376
1415
|
this.postMessage({
|