@lavitre/apps 1.56.2 → 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 +29 -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
package/dist/Frame/Frame.js
CHANGED
|
@@ -5,6 +5,7 @@ import { BlobStore } from '../Common/BlobStore.js';
|
|
|
5
5
|
import { AiChannel, MIN_AI_HOST_VERSION } from '../Common/AiChannel.js';
|
|
6
6
|
import { isMinVersion } from '../Common/index.js';
|
|
7
7
|
import { AppSettingsError, APP_SETTINGS_TIMEOUT_MS } from '../Common/AppSettings.js';
|
|
8
|
+
import { SettingsDefaultsResolver, defaultSettingsFileUrl } from '../Common/SettingsDefaults.js';
|
|
8
9
|
import { PublicStorageError, PUBLIC_STORAGE_TIMEOUT_MS, PUBLIC_STORAGE_PUT_TIMEOUT_MS, MAX_PUBLIC_FILE_SIZE_BYTES, validateExpiresIn, putPublicFileExpiryField, withDownloadUrlFallback, } from '../Common/PublicStorage.js';
|
|
9
10
|
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';
|
|
10
11
|
import { apiVersion } from '../Version.js';
|
|
@@ -139,7 +140,8 @@ export class Frame {
|
|
|
139
140
|
* Pushed whenever the AppSettings value at a given level changes — see
|
|
140
141
|
* {@link getSettings} / {@link setSettings}. Fires for changes made by
|
|
141
142
|
* this app itself as well as by another vitre/app instance sharing the
|
|
142
|
-
* same team/space. Added 1.52.
|
|
143
|
+
* same team/space. Added 1.52. Since 1.58 `value` carries the defaults of
|
|
144
|
+
* `lavitre.settings.json` for `team` and `space`, like {@link getSettings}.
|
|
143
145
|
*/
|
|
144
146
|
Object.defineProperty(this, "onSettingsChanged", {
|
|
145
147
|
enumerable: true,
|
|
@@ -147,6 +149,25 @@ export class Frame {
|
|
|
147
149
|
writable: true,
|
|
148
150
|
value: void 0
|
|
149
151
|
});
|
|
152
|
+
/**
|
|
153
|
+
* Since 1.58: where {@link getSettings} reads the defaults of the team and
|
|
154
|
+
* space forms — `lavitre.settings.json` next to this document by default
|
|
155
|
+
* (the version root, for `connector.html` and the frames beside it). A
|
|
156
|
+
* document in a sub-folder points it at the root; `null` turns the merge
|
|
157
|
+
* off. Read once, on the first settings call.
|
|
158
|
+
*/
|
|
159
|
+
Object.defineProperty(this, "settingsFileUrl", {
|
|
160
|
+
enumerable: true,
|
|
161
|
+
configurable: true,
|
|
162
|
+
writable: true,
|
|
163
|
+
value: defaultSettingsFileUrl()
|
|
164
|
+
});
|
|
165
|
+
Object.defineProperty(this, "settingsDefaults", {
|
|
166
|
+
enumerable: true,
|
|
167
|
+
configurable: true,
|
|
168
|
+
writable: true,
|
|
169
|
+
value: new SettingsDefaultsResolver(() => this.settingsFileUrl)
|
|
170
|
+
});
|
|
150
171
|
Object.defineProperty(this, "onVitreSettingsUpdated", {
|
|
151
172
|
enumerable: true,
|
|
152
173
|
configurable: true,
|
|
@@ -879,7 +900,9 @@ export class Frame {
|
|
|
879
900
|
// Handled by requestResolvers (postRequest pattern)
|
|
880
901
|
break;
|
|
881
902
|
case 'appSettingsChanged':
|
|
882
|
-
this.
|
|
903
|
+
void this.settingsDefaults
|
|
904
|
+
.merged(msg.level, msg.value ?? {}, msg.version)
|
|
905
|
+
.then((change) => this.onSettingsChanged?.(change));
|
|
883
906
|
break;
|
|
884
907
|
case 'publicStorageResponse':
|
|
885
908
|
// Handled by requestResolvers (postRequest pattern)
|
|
@@ -1599,10 +1622,16 @@ export class Frame {
|
|
|
1599
1622
|
* Rejects with an {@link AppSettingsError} of code `'unsupported'` if the
|
|
1600
1623
|
* host doesn't answer within 10s — a vitre host older than this feature
|
|
1601
1624
|
* never responds to `getAppSettings`.
|
|
1625
|
+
*
|
|
1626
|
+
* Since 1.58, for `team` and `space`, `value` is the defaults of the app's
|
|
1627
|
+
* `lavitre.settings.json` (see {@link settingsFileUrl}) overlaid with what is
|
|
1628
|
+
* stored, and `stored` is the stored value alone. {@link setSettings} drops
|
|
1629
|
+
* the defaults again before writing, so writing back `{ ...value, key }` does
|
|
1630
|
+
* not freeze today's defaults into the store.
|
|
1602
1631
|
*/
|
|
1603
1632
|
async getSettings(level) {
|
|
1604
1633
|
const requestId = randomUuid();
|
|
1605
|
-
|
|
1634
|
+
const read = await this.postRequest({ type: 'getAppSettings', requestId, level }, (msg, resolve, reject) => {
|
|
1606
1635
|
if (msg.type === 'appSettingsResponse' && msg.requestId === requestId) {
|
|
1607
1636
|
if (msg.ok) {
|
|
1608
1637
|
resolve({ level: msg.level, value: msg.value ?? {}, version: msg.version ?? 0 });
|
|
@@ -1612,6 +1641,7 @@ export class Frame {
|
|
|
1612
1641
|
}
|
|
1613
1642
|
}
|
|
1614
1643
|
}, undefined, { ms: APP_SETTINGS_TIMEOUT_MS, onTimeout: () => new AppSettingsError('unsupported', level) });
|
|
1644
|
+
return await this.settingsDefaults.merged(read.level, read.value, read.version);
|
|
1615
1645
|
}
|
|
1616
1646
|
/**
|
|
1617
1647
|
* Write the app's settings at `level`, with optimistic concurrency:
|
|
@@ -1626,12 +1656,20 @@ export class Frame {
|
|
|
1626
1656
|
*/
|
|
1627
1657
|
async setSettings(level, value, expectedVersion) {
|
|
1628
1658
|
const requestId = randomUuid();
|
|
1629
|
-
|
|
1659
|
+
const write = await this.settingsDefaults.forWrite(level, value);
|
|
1660
|
+
const written = await this.postRequest({
|
|
1661
|
+
type: 'setAppSettings',
|
|
1662
|
+
requestId,
|
|
1663
|
+
level,
|
|
1664
|
+
value: write.value,
|
|
1665
|
+
expectedVersion,
|
|
1666
|
+
...(write.schemaVersion !== undefined ? { schemaVersion: write.schemaVersion } : {}),
|
|
1667
|
+
}, (msg, resolve, reject) => {
|
|
1630
1668
|
if (msg.type === 'appSettingsResponse' && msg.requestId === requestId) {
|
|
1631
1669
|
if (msg.ok) {
|
|
1632
1670
|
resolve({
|
|
1633
1671
|
level: msg.level,
|
|
1634
|
-
value: msg.value ?? value,
|
|
1672
|
+
value: msg.value ?? write.value,
|
|
1635
1673
|
version: msg.version ?? expectedVersion,
|
|
1636
1674
|
});
|
|
1637
1675
|
}
|
|
@@ -1640,6 +1678,7 @@ export class Frame {
|
|
|
1640
1678
|
}
|
|
1641
1679
|
}
|
|
1642
1680
|
}, undefined, { ms: APP_SETTINGS_TIMEOUT_MS, onTimeout: () => new AppSettingsError('unsupported', level) });
|
|
1681
|
+
return await this.settingsDefaults.merged(written.level, written.value, written.version);
|
|
1643
1682
|
}
|
|
1644
1683
|
changeTeamSpace(space) {
|
|
1645
1684
|
this.postMessage({
|