@cratis/scene.primereact 4.1.1 → 4.2.1

package/for_primeReactPackage/when_validating_the_bundle.ts

@@ -1,17 +0,0 @@
-// Copyright (c) Cratis. All rights reserved.
-// Licensed under the MIT license. See LICENSE file in the project root for full license information.
-
-import { validatePackageBundle } from '@cratis/scene.react';
-import { primeReactPackage } from '../primeReactPackage';
-
-describe('when validating the bundle', () => {
-    let problems: string[];
-
-    beforeEach(() => {
-        problems = validatePackageBundle(primeReactPackage);
-    });
-
-    it('should report no problems', () => {
-        problems.should.deep.equal([]);
-    });
-});

package/for_primeReactThemePreset/when_resolving_a_preset.ts

@@ -1,49 +0,0 @@
-// Copyright (c) Cratis. All rights reserved.
-// Licensed under the MIT license. See LICENSE file in the project root for full license information.
-
-import { primeReactThemeNames, primeReactThemePreset } from '../theme';
-
-describe('when resolving a preset', () => {
-    describe('and the theme is one this package ships', () => {
-        it('should resolve a preset for every theme in the catalog', () => {
-            primeReactThemeNames.filter((name) => primeReactThemePreset(name) === undefined).should.deep.equal([]);
-        });
-
-        it('should bind the theme accent onto the preset primary scale', () => {
-            const preset = primeReactThemePreset('lara-light-blue')!;
-            (preset.semantic!.primary as Record<string, string>)['500'].should.equal('#3b82f6');
-        });
-
-        it('should bind a different accent for a differently tinted theme of the same family', () => {
-            const preset = primeReactThemePreset('lara-light-teal')!;
-            (preset.semantic!.primary as Record<string, string>)['500'].should.equal('#14b8a6');
-        });
-
-        /**
-         * `definePreset` deep-merges into a *new* object, but the base presets are module singletons.
-         * A merge that mutated its base would leave whichever theme resolved first tinting every later
-         * one - a bug that only appears once two themes of a family are used in the same session, which
-         * is exactly what a theme picker does.
-         */
-        it('should not tint one theme with another theme of the same family', () => {
-            primeReactThemePreset('lara-light-purple');
-            const blue = primeReactThemePreset('lara-light-blue')!;
-            (blue.semantic!.primary as Record<string, string>)['500'].should.equal('#3b82f6');
-        });
-
-        /**
-         * `PrimeReactProvider` treats a new preset identity as a theme change and re-emits every `--p-*`
-         * custom property, so handing it a freshly built object each render would repaint the page on
-         * every render.
-         */
-        it('should return the same preset instance for the same theme, so a re-render is not a theme change', () => {
-            primeReactThemePreset('aura-dark-indigo')!.should.equal(primeReactThemePreset('aura-dark-indigo')!);
-        });
-    });
-
-    describe('and the theme is unknown', () => {
-        it('should resolve nothing rather than a default that would silently theme a screen wrongly', () => {
-            (primeReactThemePreset('lara-light-chartreuse') === undefined).should.be.true;
-        });
-    });
-});

package/for_primeReactThemes/when_checking_attribution.ts

@@ -1,46 +0,0 @@
-// Copyright (c) Cratis. All rights reserved.
-// Licensed under the MIT license. See LICENSE file in the project root for full license information.
-
-import { primeReactThemeLicense, primeReactThemeLicenseUrl, primeReactThemes } from '../theme';
-
-describe('when checking attribution', () => {
-    it('should credit an author on every theme', () => {
-        primeReactThemes.filter((theme) => theme.author === undefined || theme.author === '').should.deep.equal([]);
-    });
-
-    it('should link to the author on every theme', () => {
-        primeReactThemes.filter((theme) => theme.authorUrl === undefined || theme.authorUrl === '').should.deep.equal([]);
-    });
-
-    it('should state a license on every theme', () => {
-        primeReactThemes.filter((theme) => theme.license === undefined || theme.license === '').should.deep.equal([]);
-    });
-
-    it('should credit PrimeTek, whose presets every one of them is built on', () => {
-        primeReactThemes.filter((theme) => theme.author !== 'PrimeTek').should.deep.equal([]);
-    });
-
-    /**
-     * The assertion this spec exists for. Until PrimeReact 11 these themes really were MIT, and the
-     * previous version of this file pinned exactly that. Relicensing is invisible to a compiler and to
-     * every other spec in this package, so without a spec that names the current license out loud, the
-     * catalog would have gone on advertising MIT indefinitely.
-     */
-    it('should state the commercial license PrimeReact 11 actually ships under, not the MIT of v10', () => {
-        primeReactThemeLicense.should.equal('PrimeUI Community / Commercial');
-        primeReactThemes.filter((theme) => theme.license !== primeReactThemeLicense).should.deep.equal([]);
-    });
-
-    /**
-     * A license name on its own does not tell a reader whether they qualify for the free Community tier
-     * or owe a commercial fee. The link is the part that answers that, so it is pinned too.
-     */
-    it('should link to the terms on every theme, not just name them', () => {
-        primeReactThemeLicenseUrl.should.equal('https://primeui.dev/licenses/community');
-        primeReactThemes.filter((theme) => theme.licenseUrl !== primeReactThemeLicenseUrl).should.deep.equal([]);
-    });
-
-    it('should describe every theme for a picker', () => {
-        primeReactThemes.filter((theme) => theme.description === undefined || theme.description === '').should.deep.equal([]);
-    });
-});

package/for_primeReactThemes/when_checking_compatibility.ts

@@ -1,26 +0,0 @@
-// Copyright (c) Cratis. All rights reserved.
-// Licensed under the MIT license. See LICENSE file in the project root for full license information.
-
-import { incompatiblePackages } from '@cratis/scene.engine';
-import { UiProfile } from '@cratis/scene.model';
-import { primeReactThemes } from '../theme';
-
-describe('when checking compatibility', () => {
-    const profile: UiProfile = { name: 'web', targetPlatform: 'web', packages: ['core', 'PrimeReact', 'Tailwind'] };
-
-    it('should declare every theme compatible with PrimeReact', () => {
-        primeReactThemes.filter((theme) => !theme.compatibleWith.includes('PrimeReact')).should.deep.equal([]);
-    });
-
-    it('should declare every theme compatible with Tailwind', () => {
-        primeReactThemes.filter((theme) => !theme.compatibleWith.includes('Tailwind')).should.deep.equal([]);
-    });
-
-    it('should declare every theme compatible with core, which gets no implicit exemption', () => {
-        primeReactThemes.filter((theme) => !theme.compatibleWith.includes('core')).should.deep.equal([]);
-    });
-
-    it('should report no incompatibility for a profile listing all three', () => {
-        primeReactThemes.flatMap((theme) => incompatiblePackages(theme, profile)).should.deep.equal([]);
-    });
-});

package/for_primeReactThemes/when_checking_the_token_vocabulary.ts

@@ -1,70 +0,0 @@
-// Copyright (c) Cratis. All rights reserved.
-// Licensed under the MIT license. See LICENSE file in the project root for full license information.
-
-import { primeReactThemes } from '../theme';
-
-describe('when checking the token vocabulary', () => {
-    const vocabulary = [
-        'primary.color',
-        'primary.contrastColor',
-        'surface.background',
-        'surface.card',
-        'surface.border',
-        'surface.hover',
-        'surface.overlay',
-        'text.color',
-        'text.mutedColor',
-        'highlight.background',
-        'highlight.color',
-        'content.borderRadius',
-        'focus.ring',
-    ];
-
-    it('should give every theme the whole vocabulary', () => {
-        const incomplete = primeReactThemes
-            .filter((theme) => vocabulary.some((token) => theme.tokens?.[token] === undefined))
-            .map((theme) => theme.name);
-        incomplete.should.deep.equal([]);
-    });
-
-    it('should give every theme nothing but the vocabulary, so packages can agree on it', () => {
-        const extra = primeReactThemes.flatMap((theme) => Object.keys(theme.tokens ?? {}).filter((token) => !vocabulary.includes(token)));
-        extra.should.deep.equal([]);
-    });
-
-    it('should say whether every theme is dark', () => {
-        primeReactThemes.filter((theme) => theme.isDark === undefined).should.deep.equal([]);
-    });
-
-    it('should ship both light and dark themes', () => {
-        primeReactThemes.some((theme) => theme.isDark === true).should.be.true;
-        primeReactThemes.some((theme) => theme.isDark === false).should.be.true;
-    });
-
-    /**
-     * The token values are generated by resolving each preset's `{path}` references and `light-dark()`
-     * pairs, so the risk is not a typo but a resolver that silently gave up - leaving a raw `{emerald.500}`
-     * or an unpicked `light-dark(...)` in the catalog, which reaches CSS as a value the browser drops.
-     */
-    it('should have resolved every token to a literal value rather than leaving a preset reference behind', () => {
-        const unresolved = primeReactThemes.flatMap((theme) =>
-            Object.entries(theme.tokens ?? {})
-                .filter(([, value]) => value.includes('{') || value.includes('light-dark('))
-                .map(([token]) => `${theme.name}: ${token}`)
-        );
-        unresolved.should.deep.equal([]);
-    });
-
-    it('should mirror the accent the preset binds for a light theme', () => {
-        primeReactThemes.find((theme) => theme.name === 'lara-light-blue')!.tokens!['primary.color'].should.equal('#3b82f6');
-    });
-
-    /**
-     * A dark theme takes the lighter step of the accent ramp, not the same value as its light sibling.
-     * Getting this wrong is the classic `light-dark()` resolution bug and produces a dark theme that is
-     * legible everywhere except its own accent.
-     */
-    it('should take the accent from the lighter end of the ramp for a dark theme', () => {
-        primeReactThemes.find((theme) => theme.name === 'lara-dark-blue')!.tokens!['primary.color'].should.equal('#60a5fa');
-    });
-});

package/for_properties/when_reading_a_boolean_property.ts

@@ -1,35 +0,0 @@
-// Copyright (c) Cratis. All rights reserved.
-// Licensed under the MIT license. See LICENSE file in the project root for full license information.
-
-import { SceneElement } from '@cratis/scene.model';
-import { booleanProperty } from '../properties';
-
-describe('when reading a boolean property', () => {
-    const element: SceneElement = { id: 'element', properties: { disabled: true, visible: false, filter: 'yes' } };
-
-    describe('and the property is present and a boolean', () => {
-        it('should return true when it is true', () => {
-            booleanProperty(element, 'disabled', false).should.be.true;
-        });
-
-        it('should return false when it is false rather than falling back', () => {
-            booleanProperty(element, 'visible', true).should.be.false;
-        });
-    });
-
-    describe('and the property is missing', () => {
-        it('should return undefined when no fallback was given', () => {
-            (booleanProperty(element, 'rounded') === undefined).should.be.true;
-        });
-
-        it('should return the fallback when one was given', () => {
-            booleanProperty(element, 'rounded', true).should.be.true;
-        });
-    });
-
-    describe('and the property is present but not a boolean', () => {
-        it('should treat a truthy string like a missing property', () => {
-            booleanProperty(element, 'filter', false).should.be.false;
-        });
-    });
-});

package/for_properties/when_reading_a_number_property.ts

@@ -1,39 +0,0 @@
-// Copyright (c) Cratis. All rights reserved.
-// Licensed under the MIT license. See LICENSE file in the project root for full license information.
-
-import { SceneElement } from '@cratis/scene.model';
-import { numberProperty } from '../properties';
-
-describe('when reading a number property', () => {
-    const element: SceneElement = { id: 'element', properties: { rows: 5, zero: 0, size: '12', broken: Number.NaN } };
-
-    describe('and the property is present and a number', () => {
-        it('should return it', () => {
-            numberProperty(element, 'rows', 1).should.equal(5);
-        });
-
-        it('should return zero rather than falling back', () => {
-            numberProperty(element, 'zero', 10).should.equal(0);
-        });
-    });
-
-    describe('and the property is missing', () => {
-        it('should return undefined when no fallback was given', () => {
-            (numberProperty(element, 'columns') === undefined).should.be.true;
-        });
-
-        it('should return the fallback when one was given', () => {
-            numberProperty(element, 'columns', 2).should.equal(2);
-        });
-    });
-
-    describe('and the property is present but not a usable number', () => {
-        it('should treat a numeric string like a missing property', () => {
-            numberProperty(element, 'size', 16).should.equal(16);
-        });
-
-        it('should treat NaN like a missing property, because it is never a usable size', () => {
-            numberProperty(element, 'broken', 16).should.equal(16);
-        });
-    });
-});

package/for_properties/when_reading_a_string_property.ts

@@ -1,31 +0,0 @@
-// Copyright (c) Cratis. All rights reserved.
-// Licensed under the MIT license. See LICENSE file in the project root for full license information.
-
-import { SceneElement } from '@cratis/scene.model';
-import { stringProperty } from '../properties';
-
-describe('when reading a string property', () => {
-    const element: SceneElement = { id: 'element', properties: { label: 'Save', count: 3 } };
-
-    describe('and the property is present and a string', () => {
-        it('should return it', () => {
-            stringProperty(element, 'label')!.should.equal('Save');
-        });
-    });
-
-    describe('and the property is missing', () => {
-        it('should return undefined when no fallback was given', () => {
-            (stringProperty(element, 'placeholder') === undefined).should.be.true;
-        });
-
-        it('should return the fallback when one was given', () => {
-            stringProperty(element, 'placeholder', 'Type here').should.equal('Type here');
-        });
-    });
-
-    describe('and the property is present but not a string', () => {
-        it('should treat it exactly like a missing one', () => {
-            stringProperty(element, 'count', 'none').should.equal('none');
-        });
-    });
-});

package/for_properties/when_reading_an_array_property.ts

@@ -1,41 +0,0 @@
-// Copyright (c) Cratis. All rights reserved.
-// Licensed under the MIT license. See LICENSE file in the project root for full license information.
-
-import { SceneElement } from '@cratis/scene.model';
-import { arrayProperty, recordArrayProperty, stringArrayProperty } from '../properties';
-
-describe('when reading an array property', () => {
-    const element: SceneElement = {
-        id: 'element',
-        properties: {
-            mixed: ['a', 2, { name: 'c' }, ['d'], undefined],
-            notAnArray: 'a',
-        },
-    };
-
-    describe('and the property is present and an array', () => {
-        it('should return every entry untouched', () => {
-            arrayProperty(element, 'mixed').should.have.lengthOf(5);
-        });
-
-        it('should keep only the strings when strings were asked for', () => {
-            stringArrayProperty(element, 'mixed').should.deep.equal(['a']);
-        });
-
-        it('should keep only the objects when objects were asked for, excluding arrays', () => {
-            recordArrayProperty(element, 'mixed').should.deep.equal([{ name: 'c' }]);
-        });
-    });
-
-    describe('and the property is missing', () => {
-        it('should return an empty array rather than undefined, because every caller maps over it', () => {
-            arrayProperty(element, 'absent').should.deep.equal([]);
-        });
-    });
-
-    describe('and the property is present but not an array', () => {
-        it('should treat it exactly like a missing one', () => {
-            arrayProperty(element, 'notAnArray').should.deep.equal([]);
-        });
-    });
-});

package/for_properties/when_reading_options.ts

@@ -1,50 +0,0 @@
-// Copyright (c) Cratis. All rights reserved.
-// Licensed under the MIT license. See LICENSE file in the project root for full license information.
-
-import { SceneElement } from '@cratis/scene.model';
-import { optionsProperty } from '../properties';
-
-describe('when reading options', () => {
-    describe('and the options are written as bare strings', () => {
-        const element: SceneElement = { id: 'element', properties: { options: ['Draft', 'Published'] } };
-
-        it('should use each string as both label and value', () => {
-            optionsProperty(element, 'options').should.deep.equal([
-                { label: 'Draft', value: 'Draft' },
-                { label: 'Published', value: 'Published' },
-            ]);
-        });
-    });
-
-    describe('and the options are written as records', () => {
-        const element: SceneElement = { id: 'element', properties: { options: [{ label: 'Draft', value: 'draft' }] } };
-
-        it('should keep the label and value apart', () => {
-            optionsProperty(element, 'options').should.deep.equal([{ label: 'Draft', value: 'draft' }]);
-        });
-    });
-
-    describe('and a record carries only a label', () => {
-        const element: SceneElement = { id: 'element', properties: { options: [{ label: 'Draft' }] } };
-
-        it('should use the label as the value, which is what the shorthand means', () => {
-            optionsProperty(element, 'options').should.deep.equal([{ label: 'Draft', value: 'Draft' }]);
-        });
-    });
-
-    describe('and an entry carries no usable label', () => {
-        const element: SceneElement = { id: 'element', properties: { options: [{ value: 'draft' }, 7, { label: 'Draft' }] } };
-
-        it('should skip it rather than render a blank choice', () => {
-            optionsProperty(element, 'options').should.deep.equal([{ label: 'Draft', value: 'Draft' }]);
-        });
-    });
-
-    describe('and the property is missing', () => {
-        const element: SceneElement = { id: 'element', properties: {} };
-
-        it('should return no options', () => {
-            optionsProperty(element, 'options').should.deep.equal([]);
-        });
-    });
-});

package/for_treeNodes/when_converting_entries.ts

@@ -1,43 +0,0 @@
-// Copyright (c) Cratis. All rights reserved.
-// Licensed under the MIT license. See LICENSE file in the project root for full license information.
-
-import { toTreeNodes } from '../treeNodes';
-
-describe('when converting entries', () => {
-    describe('and no entry supplies a key', () => {
-        const nodes = toTreeNodes([{ label: 'Documents', children: [{ label: 'Work' }, { label: 'Work' }] }]);
-
-        it('should derive a key from the path', () => {
-            nodes[0].key!.should.equal('0');
-        });
-
-        it('should keep two identically labeled siblings apart, so expansion and selection track the right row', () => {
-            nodes[0].children![0].key!.should.equal('0-0');
-            nodes[0].children![1].key!.should.equal('0-1');
-        });
-    });
-
-    describe('and an entry supplies its own key', () => {
-        const nodes = toTreeNodes([{ key: 'docs', label: 'Documents', children: [{ label: 'Work' }] }]);
-
-        it('should keep it', () => {
-            nodes[0].key!.should.equal('docs');
-        });
-
-        it('should build child keys from it', () => {
-            nodes[0].children![0].key!.should.equal('docs-0');
-        });
-    });
-
-    describe('and an entry is a bare string', () => {
-        it('should use it as the label', () => {
-            toTreeNodes(['Documents'])[0].label!.should.equal('Documents');
-        });
-    });
-
-    describe('and an entry is neither a string nor a record', () => {
-        it('should drop it', () => {
-            toTreeNodes([7, ['nested'], 'Documents']).should.have.lengthOf(1);
-        });
-    });
-});