Skip to content

Commit eed0345

Browse files
committed
Rename setting event types to kebab-case for Pryv API compatibility
Pryv events.get types filter requires pattern ^[a-z0-9-]+/[a-z0-9-]+$. Renamed: settings/preferredLocales → settings/preferred-locales, settings/dateFormat → settings/date-format, settings/unitSystem → settings/unit-system, contact/displayName → contact/display-name.
1 parent 4bb2925 commit eed0345

6 files changed

Lines changed: 26 additions & 26 deletions

File tree

js/index.d.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,12 +50,12 @@ declare const HDSLib: {
5050
unhook(): void;
5151
};
5252
SETTING_TYPES: {
53-
readonly preferredLocales: "settings/preferredLocales";
53+
readonly preferredLocales: "settings/preferred-locales";
5454
readonly theme: "settings/theme";
5555
readonly timezone: "settings/timezone";
56-
readonly dateFormat: "settings/dateFormat";
57-
readonly unitSystem: "settings/unitSystem";
58-
readonly displayName: "settings/displayName";
56+
readonly dateFormat: "settings/date-format";
57+
readonly unitSystem: "settings/unit-system";
58+
readonly displayName: "contact/display-name";
5959
};
6060
HDSModelConversions: typeof HDSModelConversions;
6161
};

js/settings/HDSSettings.d.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ import type { Application } from '../appTemplates/Application';
44
* Known setting event types — each stored as a separate Pryv event.
55
*/
66
export declare const SETTING_TYPES: {
7-
readonly preferredLocales: "settings/preferredLocales";
7+
readonly preferredLocales: "settings/preferred-locales";
88
readonly theme: "settings/theme";
99
readonly timezone: "settings/timezone";
10-
readonly dateFormat: "settings/dateFormat";
11-
readonly unitSystem: "settings/unitSystem";
12-
readonly displayName: "settings/displayName";
10+
readonly dateFormat: "settings/date-format";
11+
readonly unitSystem: "settings/unit-system";
12+
readonly displayName: "contact/display-name";
1313
};
1414
export type SettingKey = keyof typeof SETTING_TYPES;
1515
export type DateFormat = 'DD.MM.YYYY' | 'DD/MM/YYYY' | 'MM/DD/YYYY' | 'YYYY-MM-DD';

js/settings/HDSSettings.js

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

js/settings/HDSSettings.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

tests/HDSSettings.test.js

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -69,9 +69,9 @@ describe('[HDSS] HDSSettings', function () {
6969
'events.get': (params) => ({
7070
events: [
7171
{ id: 'ev1', type: 'settings/theme', content: 'dark' },
72-
{ id: 'ev2', type: 'settings/preferredLocales', content: ['fr'] },
73-
{ id: 'ev3', type: 'settings/unitSystem', content: 'imperial' },
74-
{ id: 'ev4', type: 'settings/displayName', content: 'Dr. Smith' }
72+
{ id: 'ev2', type: 'settings/preferred-locales', content: ['fr'] },
73+
{ id: 'ev3', type: 'settings/unit-system', content: 'imperial' },
74+
{ id: 'ev4', type: 'contact/display-name', content: 'Dr. Smith' }
7575
]
7676
})
7777
});
@@ -145,7 +145,7 @@ describe('[HDSS] HDSSettings', function () {
145145
assert.strictEqual(HDSSettings.get('displayName'), 'Alice');
146146

147147
const createCall = conn.apiCalls.find(c =>
148-
c.method === 'events.create' && c.params.type === 'settings/displayName'
148+
c.method === 'events.create' && c.params.type === 'contact/display-name'
149149
);
150150
assert.ok(createCall, 'Should have created a settings/displayName event');
151151
assert.strictEqual(createCall.params.content, 'Alice');
@@ -154,7 +154,7 @@ describe('[HDSS] HDSSettings', function () {
154154
it('[HDSS-S5] displayName updates existing event', async () => {
155155
const conn = createMockConnection({
156156
'events.get': (params) => ({
157-
events: [{ id: 'ev-dn', type: 'settings/displayName', content: 'Old Name' }]
157+
events: [{ id: 'ev-dn', type: 'contact/display-name', content: 'Old Name' }]
158158
})
159159
});
160160

@@ -194,11 +194,11 @@ describe('[HDSS] HDSSettings', function () {
194194

195195
describe('[STPS] SETTING_TYPES', () => {
196196
it('[STPS1] has expected keys', () => {
197-
assert.strictEqual(SETTING_TYPES.preferredLocales, 'settings/preferredLocales');
197+
assert.strictEqual(SETTING_TYPES.preferredLocales, 'settings/preferred-locales');
198198
assert.strictEqual(SETTING_TYPES.theme, 'settings/theme');
199199
assert.strictEqual(SETTING_TYPES.timezone, 'settings/timezone');
200-
assert.strictEqual(SETTING_TYPES.dateFormat, 'settings/dateFormat');
201-
assert.strictEqual(SETTING_TYPES.unitSystem, 'settings/unitSystem');
202-
assert.strictEqual(SETTING_TYPES.displayName, 'settings/displayName');
200+
assert.strictEqual(SETTING_TYPES.dateFormat, 'settings/date-format');
201+
assert.strictEqual(SETTING_TYPES.unitSystem, 'settings/unit-system');
202+
assert.strictEqual(SETTING_TYPES.displayName, 'contact/display-name');
203203
});
204204
});

ts/settings/HDSSettings.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ import type { Application } from '../appTemplates/Application';
66
* Known setting event types — each stored as a separate Pryv event.
77
*/
88
export const SETTING_TYPES = {
9-
preferredLocales: 'settings/preferredLocales',
9+
preferredLocales: 'settings/preferred-locales',
1010
theme: 'settings/theme',
1111
timezone: 'settings/timezone',
12-
dateFormat: 'settings/dateFormat',
13-
unitSystem: 'settings/unitSystem',
14-
displayName: 'settings/displayName',
12+
dateFormat: 'settings/date-format',
13+
unitSystem: 'settings/unit-system',
14+
displayName: 'contact/display-name',
1515
} as const;
1616

1717
export type SettingKey = keyof typeof SETTING_TYPES;

0 commit comments

Comments
 (0)