diff --git a/src/render/contract/contract.test.mjs b/src/render/contract/contract.test.mjs index 1cc15946f..a5d623b9b 100644 --- a/src/render/contract/contract.test.mjs +++ b/src/render/contract/contract.test.mjs @@ -131,6 +131,9 @@ test('PORTS lists every member of every port, required exactly when the type req test('every member of every port has one role, and each role names real members', () => { const ids = ROLES.map((r) => r.id); assert.equal(new Set(ids).size, ids.length); + // No entry is claimed by two roles, so the most specific entry is never a tie. + const entries = ROLES.flatMap((r) => r.members); + assert.equal(new Set(entries).size, entries.length, 'an entry in two roles'); for (const [port, members] of Object.entries(PORTS)) for (const member of Object.keys(members)) assert.ok( @@ -156,6 +159,9 @@ test('every member of every port has one role, and each role names real members' assert.equal(roleOf('globe', 'sky.set'), 'look'); assert.equal(roleOf('globe', 'setSurfaceShading'), 'look'); assert.equal(roleOf('nowhere', 'x'), undefined); + assert.equal(roleOf('globe', 'bogus'), undefined); + assert.equal(roleOf('globe'), 'surface'); + assert.equal(roleOf('imageryLayer', 'lit'), 'look'); }); test('the capability and frame-step lists are the types’ own', () => { diff --git a/src/render/contract/index.d.ts b/src/render/contract/index.d.ts index 0613ca6c9..2f1bcb691 100644 --- a/src/render/contract/index.d.ts +++ b/src/render/contract/index.d.ts @@ -40,10 +40,13 @@ export interface ContractRole { /** What a renderer does, by role: every member of {@link PORTS} in one. */ export declare const ROLES: readonly ContractRole[]; -/** The role of `port`'s `member` (dotted), or undefined. */ +/** + * The role of `port`'s `member` (dotted), or of the port itself without one; + * undefined for a member the port does not have. + */ export declare function roleOf( port: string, - member: string, + member?: string, ): ContractRole['id'] | undefined; /** Every quality setting a renderer may support. */ diff --git a/src/render/contract/index.js b/src/render/contract/index.js index 4fcae119e..754f9ca55 100644 --- a/src/render/contract/index.js +++ b/src/render/contract/index.js @@ -350,7 +350,12 @@ export const ROLES = deepFreeze([ title: 'Look', summary: 'How the world is lit and finished: sky and atmosphere, surface shading, styles and screen effects.', - members: ['effects', 'globe.sky', 'globe.setSurfaceShading'], + members: [ + 'effects', + 'globe.sky', + 'globe.setSurfaceShading', + 'imageryLayer.lit', + ], }, { id: 'host', @@ -366,11 +371,12 @@ export const ROLES = deepFreeze([ * The role a member belongs to: the most specific {@link ROLES} entry naming * its port or one of its dotted prefixes. * @param {string} port - * @param {string} member dotted, as in {@link PORTS} - * @returns {string|undefined} the role's id + * @param {string} [member] dotted, as in {@link PORTS}; empty for the port's own role + * @returns {string|undefined} the role's id; undefined for a member the port does not have */ -export function roleOf(port, member) { - const parts = member.split('.'); +export function roleOf(port, member = '') { + if (member && !(PORTS[port] && member in PORTS[port])) return undefined; + const parts = member ? member.split('.') : []; for (let n = parts.length; n >= 0; n--) { const key = [port, ...parts.slice(0, n)].join('.'); const role = ROLES.find((r) => r.members.includes(key));