@cratis/scene.engine 4.2.0 → 4.3.0

package/dist/esm/for_runActions/when_running_against_the_shared_fixture_corpus.js

@@ -1,61 +0,0 @@
-import { readFileSync } from 'node:fs';
-import { join } from 'node:path';
-import { InteractionActionKind, InteractionTriggerKind, NotificationLevel } from '@cratis/scene.model';
-import { resolveBehaviors } from '../resolveBehaviors';
-import { InteractionStop, runActions } from '../runActions';
-import { pathEchoingContext, RecordingDispatcher } from './given/a_recording_dispatcher';
-const manifestPath = join(import.meta.dirname, '..', '..', '..', '..', 'interaction-fixtures.json');
-const corpus = JSON.parse(readFileSync(manifestPath, 'utf-8'));
-function attachment(fixture) {
-    return {
-        level: fixture.level,
-        depth: fixture.depth,
-        behaviors: fixture.behaviors.map(behavior => ({
-            name: behavior.name ?? undefined,
-            order: behavior.order,
-            bindings: [
-                {
-                    trigger: { kind: InteractionTriggerKind[behavior.trigger] },
-                    actions: [],
-                },
-            ],
-        })),
-    };
-}
-function action(fixture) {
-    return {
-        kind: InteractionActionKind[fixture.kind] ?? fixture.kind,
-        command: fixture.command,
-        query: fixture.query,
-        screen: fixture.screen,
-        dialogTemplate: fixture.dialogTemplate,
-        level: fixture.level === undefined ? undefined : NotificationLevel[fixture.level],
-        message: fixture.text === undefined ? undefined : { text: fixture.text },
-        onSuccess: (fixture.onSuccess ?? []).map(action),
-        onFailure: (fixture.onFailure ?? []).map(action),
-        onResult: (fixture.onResult ?? []).map(action),
-    };
-}
-function callsWithoutArguments(calls) {
-    return calls.map(call => call.replace(/:\{.*\}$/, ''));
-}
-describe('when running against the shared fixture corpus', () => {
-    for (const fixture of corpus.resolutionCases) {
-        it(`should resolve the case where ${fixture.name}`, () => {
-            const resolved = resolveBehaviors(fixture.attachments.map(attachment), InteractionTriggerKind[fixture.trigger]);
-            resolved.map(candidate => candidate.behaviorName ?? null).should.eql(fixture.expected);
-        });
-    }
-    for (const fixture of corpus.sequencingCases) {
-        it(`should sequence the case where ${fixture.name}`, async () => {
-            const dispatcher = new RecordingDispatcher();
-            dispatcher.commandSucceeds = fixture.commandSucceeds;
-            dispatcher.confirmAnswer = fixture.confirmAnswer;
-            const run = await runActions(fixture.actions.map(action), dispatcher, pathEchoingContext);
-            callsWithoutArguments(dispatcher.calls).should.eql(fixture.expectedCalls);
-            run.stop.should.equal(InteractionStop[fixture.expectedStop]);
-            run.findings.map(finding => finding.kind).should.eql(fixture.expectedFindings ?? []);
-        });
-    }
-});
-//# sourceMappingURL=when_running_against_the_shared_fixture_corpus.js.map

package/dist/esm/for_runActions/when_running_against_the_shared_fixture_corpus.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"when_running_against_the_shared_fixture_corpus.js","sourceRoot":"","sources":["../../../for_runActions/when_running_against_the_shared_fixture_corpus.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAqB,qBAAqB,EAAE,sBAAsB,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC1H,OAAO,EAAsB,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAC3E,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AAiDzF,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,2BAA2B,CAAC,CAAC;AACpG,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,YAAY,EAAE,OAAO,CAAC,CAAkB,CAAC;AAEhF,SAAS,UAAU,CAAC,OAA0B;IAC1C,OAAO;QACH,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YAC1C,IAAI,EAAE,QAAQ,CAAC,IAAI,IAAI,SAAS;YAChC,KAAK,EAAE,QAAQ,CAAC,KAAK;YACrB,QAAQ,EAAE;gBACN;oBACI,OAAO,EAAE,EAAE,IAAI,EAAE,sBAAsB,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAW;oBACpE,OAAO,EAAE,EAAE;iBACd;aACJ;SACJ,CAAC,CAAC;KACN,CAAC;AACN,CAAC;AAED,SAAS,MAAM,CAAC,OAAsB;IAClC,OAAO;QACH,IAAI,EAAE,qBAAqB,CAAC,OAAO,CAAC,IAA0C,CAAC,IAAI,OAAO,CAAC,IAAI;QAC/F,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,cAAc,EAAE,OAAO,CAAC,cAAc;QACtC,KAAK,EAAE,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,iBAAiB,CAAC,OAAO,CAAC,KAAK,CAAC;QACjF,OAAO,EAAE,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE;QACxE,SAAS,EAAE,CAAC,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC;QAChD,SAAS,EAAE,CAAC,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC;QAChD,QAAQ,EAAE,CAAC,OAAO,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC;KAC5B,CAAC;AAC3B,CAAC;AAID,SAAS,qBAAqB,CAAC,KAAe;IAC1C,OAAO,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,CAAC;AAC3D,CAAC;AAED,QAAQ,CAAC,gDAAgD,EAAE,GAAG,EAAE;IAC5D,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,eAAe,EAAE,CAAC;QAC3C,EAAE,CAAC,iCAAiC,OAAO,CAAC,IAAI,EAAE,EAAE,GAAG,EAAE;YACrD,MAAM,QAAQ,GAAG,gBAAgB,CAC7B,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,EACnC,sBAAsB,CAAC,OAAO,CAAC,OAAO,CAAC,CAC1C,CAAC;YAEF,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC,SAAS,CAAC,YAAY,IAAI,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC3F,CAAC,CAAC,CAAC;IACP,CAAC;IAED,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,eAAe,EAAE,CAAC;QAC3C,EAAE,CAAC,kCAAkC,OAAO,CAAC,IAAI,EAAE,EAAE,KAAK,IAAI,EAAE;YAC5D,MAAM,UAAU,GAAG,IAAI,mBAAmB,EAAE,CAAC;YAC7C,UAAU,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;YACrD,UAAU,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;YAEjD,MAAM,GAAG,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,kBAAkB,CAAC,CAAC;YAE1F,qBAAqB,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;YAC1E,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC;YAC7D,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,gBAAgB,IAAI,EAAE,CAAC,CAAC;QACzF,CAAC,CAAC,CAAC;IACP,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/esm/for_themeCompatibility/when_checking_against_the_shared_fixture_corpus.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=when_checking_against_the_shared_fixture_corpus.d.ts.map

package/dist/esm/for_themeCompatibility/when_checking_against_the_shared_fixture_corpus.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"when_checking_against_the_shared_fixture_corpus.d.ts","sourceRoot":"","sources":["../../../for_themeCompatibility/when_checking_against_the_shared_fixture_corpus.ts"],"names":[],"mappings":""}

package/dist/esm/for_themeCompatibility/when_checking_against_the_shared_fixture_corpus.js

@@ -1,18 +0,0 @@
-import { readFileSync } from 'node:fs';
-import { join } from 'node:path';
-import { applicableThemePackages, incompatiblePackages } from '../index';
-const manifestPath = join(import.meta.dirname, '..', '..', '..', '..', 'theme-compatibility-fixtures.json');
-const corpus = JSON.parse(readFileSync(manifestPath, 'utf-8'));
-describe('when checking against the shared fixture corpus', () => {
-    for (const fixtureCase of corpus.cases) {
-        const theme = { name: 'test-theme', compatibleWith: fixtureCase.theme.compatibleWith };
-        const profile = { name: 'test-profile', targetPlatform: 'web', packages: fixtureCase.profile.packages };
-        it(`should match the expected incompatible packages for "${fixtureCase.name}"`, () => {
-            incompatiblePackages(theme, profile).should.deep.equal(fixtureCase.expectedIncompatible);
-        });
-        it(`should match the expected applicable packages for "${fixtureCase.name}"`, () => {
-            applicableThemePackages(theme, profile).should.deep.equal(fixtureCase.expectedApplicable);
-        });
-    }
-});
-//# sourceMappingURL=when_checking_against_the_shared_fixture_corpus.js.map

package/dist/esm/for_themeCompatibility/when_checking_against_the_shared_fixture_corpus.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"when_checking_against_the_shared_fixture_corpus.js","sourceRoot":"","sources":["../../../for_themeCompatibility/when_checking_against_the_shared_fixture_corpus.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC,OAAO,EAAE,uBAAuB,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAczE,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,mCAAmC,CAAC,CAAC;AAC5G,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,YAAY,EAAE,OAAO,CAAC,CAAkB,CAAC;AAEhF,QAAQ,CAAC,iDAAiD,EAAE,GAAG,EAAE;IAC7D,KAAK,MAAM,WAAW,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACrC,MAAM,KAAK,GAAU,EAAE,IAAI,EAAE,YAAY,EAAE,cAAc,EAAE,WAAW,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC;QAC9F,MAAM,OAAO,GAAc,EAAE,IAAI,EAAE,cAAc,EAAE,cAAc,EAAE,KAAK,EAAE,QAAQ,EAAE,WAAW,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;QAEnH,EAAE,CAAC,wDAAwD,WAAW,CAAC,IAAI,GAAG,EAAE,GAAG,EAAE;YACjF,oBAAoB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,oBAAoB,CAAC,CAAC;QAC7F,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sDAAsD,WAAW,CAAC,IAAI,GAAG,EAAE,GAAG,EAAE;YAC/E,uBAAuB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAAC;QAC9F,CAAC,CAAC,CAAC;IACP,CAAC;AACL,CAAC,CAAC,CAAC"}

package/for_aggregateContributions/when_aggregating_by_contribution_point.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 { Contribution } from '@cratis/scene.model';
-import { aggregateContributions } from '../index';
-
-function contribution(contributionPointName: string, id: string, order?: number): Contribution {
-    return { contributionPointName, content: { id, properties: {} }, order };
-}
-
-describe('when aggregating by contribution point', () => {
-    it('should exclude contributions targeting a different contribution point', () => {
-        const result = aggregateContributions([contribution('Navigation', 'a'), contribution('Toolbar', 'b')], 'Navigation');
-        result.map(item => item.content.id).should.deep.equal(['a']);
-    });
-
-    it('should sort ordered contributions ascending by order', () => {
-        const result = aggregateContributions([contribution('Navigation', 'second', 20), contribution('Navigation', 'first', 10)], 'Navigation');
-        result.map(item => item.content.id).should.deep.equal(['first', 'second']);
-    });
-
-    it('should sort unordered contributions after every ordered one', () => {
-        const result = aggregateContributions([contribution('Navigation', 'unordered'), contribution('Navigation', 'ordered', 10)], 'Navigation');
-        result.map(item => item.content.id).should.deep.equal(['ordered', 'unordered']);
-    });
-
-    it('should preserve original relative order among unordered contributions', () => {
-        const result = aggregateContributions([contribution('Navigation', 'first'), contribution('Navigation', 'second')], 'Navigation');
-        result.map(item => item.content.id).should.deep.equal(['first', 'second']);
-    });
-});

package/for_buildStarterProfile/when_checking_against_the_shared_fixture_corpus.ts

@@ -1,32 +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 { readFileSync } from 'node:fs';
-import { join } from 'node:path';
-import { UiStarter } from '@cratis/scene.model';
-import { buildStarterProfile } from '../index';
-
-interface FixtureCase {
-    name: string;
-    starter: UiStarter;
-    targetPlatform: string;
-    expectedProfile: { name: string; targetPlatform: string; packages: string[] };
-}
-
-interface FixtureCorpus {
-    profileCases: FixtureCase[];
-}
-
-const manifestPath = join(import.meta.dirname, '..', '..', '..', '..', 'ui-starter-fixtures.json');
-const corpus = JSON.parse(readFileSync(manifestPath, 'utf-8')) as FixtureCorpus;
-
-describe('when checking against the shared fixture corpus', () => {
-    for (const fixtureCase of corpus.profileCases) {
-        it(`should build the expected profile for "${fixtureCase.name}"`, () => {
-            const profile = buildStarterProfile(fixtureCase.starter, fixtureCase.targetPlatform);
-            profile.name.should.equal(fixtureCase.expectedProfile.name);
-            profile.targetPlatform.should.equal(fixtureCase.expectedProfile.targetPlatform);
-            profile.packages.should.deep.equal(fixtureCase.expectedProfile.packages);
-        });
-    }
-});

package/for_computeSizeClass/when_computing_the_size_class.ts

@@ -1,23 +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 { HeightSizeClass, WidthSizeClass } from '@cratis/scene.model';
-import { computeSizeClass, defaultHeightBreakpoint, defaultWidthBreakpoint } from '../index';
-
-describe('when computing the size class', () => {
-    it('should be compact by compact below both breakpoints', () => {
-        computeSizeClass(320, 480).should.deep.equal({ width: WidthSizeClass.Compact, height: HeightSizeClass.Compact });
-    });
-
-    it('should be regular width below height breakpoint only', () => {
-        computeSizeClass(1024, 480).should.deep.equal({ width: WidthSizeClass.Regular, height: HeightSizeClass.Compact });
-    });
-
-    it('should be regular by regular at exactly both breakpoints', () => {
-        computeSizeClass(defaultWidthBreakpoint, defaultHeightBreakpoint).should.deep.equal({ width: WidthSizeClass.Regular, height: HeightSizeClass.Regular });
-    });
-
-    it('should honor a custom breakpoint', () => {
-        computeSizeClass(500, 500, 400).width.should.equal(WidthSizeClass.Regular);
-    });
-});

package/for_evaluateFlowArrangement/when_evaluating_against_the_shared_fixture_corpus.ts

@@ -1,67 +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 { readFileSync } from 'node:fs';
-import { join } from 'node:path';
-import { ExternalComponent, FlowArrangement, FlowLeaf, FlowOverride, HeightSizeClass, HorizontalAlignment, SizeClass, VerticalAlignment, Visibility, WidthSizeClass } from '@cratis/scene.model';
-import { evaluateFlowArrangement } from '../index';
-
-interface FixtureOverride {
-    width: WidthSizeClass | null;
-    height: HeightSizeClass | null;
-    tag: string;
-}
-
-interface FixtureCase {
-    name: string;
-    rootTag: string;
-    overrides: FixtureOverride[];
-    sizeClass: SizeClass;
-    expectedTag: string;
-}
-
-interface FixtureCorpus {
-    flowCases: FixtureCase[];
-}
-
-const manifestPath = join(import.meta.dirname, '..', '..', '..', '..', 'layout-evaluation-fixtures.json');
-const corpus = JSON.parse(readFileSync(manifestPath, 'utf-8')) as FixtureCorpus;
-
-function leaf(tag: string): FlowLeaf {
-    const content: ExternalComponent = {
-        id: tag,
-        name: tag,
-        properties: {},
-        visibility: Visibility.Visible,
-        isEnabled: true,
-        opacity: 1,
-        size: {},
-        zIndex: 0,
-        minimumSize: {},
-        maximumSize: {},
-        margin: { left: 0, top: 0, right: 0, bottom: 0 },
-        horizontalAlignment: HorizontalAlignment.Stretch,
-        verticalAlignment: VerticalAlignment.Stretch,
-        componentName: 'core:text',
-        slots: {},
-    };
-    return { content };
-}
-
-describe('when evaluating against the shared fixture corpus', () => {
-    for (const fixtureCase of corpus.flowCases) {
-        it(`should match the expected tag for "${fixtureCase.name}"`, () => {
-            const arrangement: FlowArrangement = {
-                root: leaf(fixtureCase.rootTag),
-                overrides: fixtureCase.overrides.map((override): FlowOverride => ({
-                    width: override.width ?? undefined,
-                    height: override.height ?? undefined,
-                    root: leaf(override.tag),
-                })),
-            };
-
-            const result = evaluateFlowArrangement(arrangement, fixtureCase.sizeClass) as FlowLeaf;
-            (result.content as ExternalComponent).id.should.equal(fixtureCase.expectedTag);
-        });
-    }
-});

package/for_evaluateFreeformArrangement/when_evaluating_against_the_shared_fixture_corpus.ts

@@ -1,68 +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 { readFileSync } from 'node:fs';
-import { join } from 'node:path';
-import { ElementPlacement, ExternalComponent, FreeformArrangement, HeightSizeClass, HorizontalAlignment, SizeClass, VerticalAlignment, Visibility, WidthSizeClass } from '@cratis/scene.model';
-import { evaluateFreeformArrangement } from '../index';
-
-interface FixtureVariant {
-    width: WidthSizeClass;
-    height: HeightSizeClass;
-    tag: string;
-}
-
-interface FixtureCase {
-    name: string;
-    variants: FixtureVariant[];
-    sizeClass: SizeClass;
-    expectedTag: string | null;
-}
-
-interface FixtureCorpus {
-    freeformCases: FixtureCase[];
-}
-
-const manifestPath = join(import.meta.dirname, '..', '..', '..', '..', 'layout-evaluation-fixtures.json');
-const corpus = JSON.parse(readFileSync(manifestPath, 'utf-8')) as FixtureCorpus;
-
-function placement(tag: string): ElementPlacement {
-    const element: ExternalComponent = {
-        id: tag,
-        name: tag,
-        properties: {},
-        visibility: Visibility.Visible,
-        isEnabled: true,
-        opacity: 1,
-        size: {},
-        zIndex: 0,
-        minimumSize: {},
-        maximumSize: {},
-        margin: { left: 0, top: 0, right: 0, bottom: 0 },
-        horizontalAlignment: HorizontalAlignment.Stretch,
-        verticalAlignment: VerticalAlignment.Stretch,
-        componentName: 'core:text',
-        slots: {},
-    };
-    return { element, x: 0, y: 0, width: 0, height: 0 };
-}
-
-describe('when evaluating against the shared fixture corpus', () => {
-    for (const fixtureCase of corpus.freeformCases) {
-        it(`should match the expected tag for "${fixtureCase.name}"`, () => {
-            const arrangement: FreeformArrangement = {
-                variants: fixtureCase.variants.map(variant => ({
-                    sizeClass: { width: variant.width, height: variant.height },
-                    placements: [placement(variant.tag)],
-                })),
-            };
-
-            const result = evaluateFreeformArrangement(arrangement, fixtureCase.sizeClass);
-            if (fixtureCase.expectedTag === null) {
-                (result === undefined).should.be.true;
-            } else {
-                (result!.placements[0].element as ExternalComponent).id.should.equal(fixtureCase.expectedTag);
-            }
-        });
-    }
-});

package/for_evaluateFreeformSlotArrangement/when_evaluating_against_the_shared_fixture_corpus.ts

@@ -1,47 +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 { readFileSync } from 'node:fs';
-import { join } from 'node:path';
-import { FreeformSlotArrangement, HeightSizeClass, SizeClass, WidthSizeClass } from '@cratis/scene.model';
-import { evaluateFreeformSlotArrangement } from '../index';
-
-interface FixtureVariant {
-    width: WidthSizeClass;
-    height: HeightSizeClass;
-    tag: string;
-}
-
-interface FixtureCase {
-    name: string;
-    variants: FixtureVariant[];
-    sizeClass: SizeClass;
-    expectedTag: string | null;
-}
-
-interface FixtureCorpus {
-    freeformCases: FixtureCase[];
-}
-
-const manifestPath = join(import.meta.dirname, '..', '..', '..', '..', 'layout-evaluation-fixtures.json');
-const corpus = JSON.parse(readFileSync(manifestPath, 'utf-8')) as FixtureCorpus;
-
-describe('when evaluating against the shared fixture corpus', () => {
-    for (const fixtureCase of corpus.freeformCases) {
-        it(`should match the expected tag for "${fixtureCase.name}"`, () => {
-            const arrangement: FreeformSlotArrangement = {
-                variants: fixtureCase.variants.map(variant => ({
-                    sizeClass: { width: variant.width, height: variant.height },
-                    placements: [{ slotName: variant.tag, x: 0, y: 0, width: 0, height: 0 }],
-                })),
-            };
-
-            const result = evaluateFreeformSlotArrangement(arrangement, fixtureCase.sizeClass);
-            if (fixtureCase.expectedTag === null) {
-                (result === undefined).should.be.true;
-            } else {
-                result!.placements[0].slotName.should.equal(fixtureCase.expectedTag);
-            }
-        });
-    }
-});

package/for_incompatibleStarterThemes/when_checking_against_the_shared_fixture_corpus.ts

@@ -1,34 +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 { readFileSync } from 'node:fs';
-import { join } from 'node:path';
-import { Theme, UiStarter } from '@cratis/scene.model';
-import { incompatibleStarterThemes } from '../index';
-
-interface FixtureCase {
-    name: string;
-    starter: UiStarter;
-    themes: Record<string, Theme>;
-    expectedIncompatible: string[];
-}
-
-interface FixtureCorpus {
-    themeCases: FixtureCase[];
-}
-
-const manifestPath = join(import.meta.dirname, '..', '..', '..', '..', 'ui-starter-fixtures.json');
-const corpus = JSON.parse(readFileSync(manifestPath, 'utf-8')) as FixtureCorpus;
-
-describe('when checking against the shared fixture corpus', () => {
-    for (const fixtureCase of corpus.themeCases) {
-        const themes: Record<string, Theme> = {};
-        for (const [themeName, theme] of Object.entries(fixtureCase.themes)) {
-            themes[themeName] = { name: themeName, compatibleWith: theme.compatibleWith };
-        }
-
-        it(`should match the expected incompatible themes for "${fixtureCase.name}"`, () => {
-            incompatibleStarterThemes(fixtureCase.starter, themes).should.deep.equal(fixtureCase.expectedIncompatible);
-        });
-    }
-});

package/for_packageCatalog/when_querying_against_the_shared_fixture_corpus.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 { availablePackagesFor, baseComponentLibraries, componentsForPackages } from '../index';
-import { CatalogFixtureCase, corpus } from '../for_packageDependencies/fixtures';
-
-function run(fixtureCase: CatalogFixtureCase): string[] {
-    switch (fixtureCase.query) {
-        case 'baseComponentLibraries':
-            return baseComponentLibraries(corpus.catalog).map((scenePackage) => scenePackage.name);
-        case 'availableFor':
-            return availablePackagesFor(corpus.catalog, fixtureCase.selected ?? []).map((scenePackage) => scenePackage.name);
-        case 'componentsFor':
-            return componentsForPackages(corpus.catalog, fixtureCase.selected ?? []);
-        default:
-            throw new Error(`The fixture corpus asks for an unknown query '${fixtureCase.query}'`);
-    }
-}
-
-describe('when querying against the shared fixture corpus', () => {
-    for (const fixtureCase of corpus.catalogCases) {
-        it(`should match the expected result for "${fixtureCase.name}"`, () => {
-            run(fixtureCase).should.deep.equal(fixtureCase.expected);
-        });
-    }
-});

package/for_packageDependencies/fixtures.ts

@@ -1,44 +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 { readFileSync } from 'node:fs';
-import { join } from 'node:path';
-import { ScenePackage } from '@cratis/scene.model';
-
-export interface ResolutionFixtureCase {
-    name: string;
-    selected: string[];
-    expectedPackages: string[];
-    expectedAdded: string[];
-    expectedMissing: { package: string; dependsOn: string }[];
-    expectedVersionConflicts: { package: string; dependsOn: string; requiredRange: string; actualVersion: string }[];
-    expectedCycles: string[][];
-}
-
-export interface VersionRangeFixtureCase {
-    version: string;
-    range: string | null;
-    expected: boolean;
-}
-
-export interface CatalogFixtureCase {
-    name: string;
-    query: string;
-    selected?: string[];
-    expected: string[];
-}
-
-interface FixtureCorpus {
-    catalog: ScenePackage[];
-    resolutionCases: ResolutionFixtureCase[];
-    versionRangeCases: VersionRangeFixtureCase[];
-    catalogCases: CatalogFixtureCase[];
-}
-
-const fixturePath = join(import.meta.dirname, '..', '..', '..', '..', 'package-dependency-fixtures.json');
-
-/**
- * The same corpus the C# specs read, so both languages resolve against an identical catalog rather than
- * two hand-written ones that can quietly diverge.
- */
-export const corpus = JSON.parse(readFileSync(fixturePath, 'utf-8')) as FixtureCorpus;

package/for_packageDependencies/when_resolving_against_the_shared_fixture_corpus.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 { isPackageSelectionValid, resolvePackageDependencies } from '../index';
-import { corpus } from './fixtures';
-
-describe('when resolving against the shared fixture corpus', () => {
-    for (const fixtureCase of corpus.resolutionCases) {
-        const selection = resolvePackageDependencies(fixtureCase.selected, corpus.catalog);
-
-        it(`should order the packages as expected for "${fixtureCase.name}"`, () => {
-            selection.packages.should.deep.equal(fixtureCase.expectedPackages);
-        });
-
-        it(`should report the expected transitively added packages for "${fixtureCase.name}"`, () => {
-            selection.added.should.deep.equal(fixtureCase.expectedAdded);
-        });
-
-        it(`should report the expected missing dependencies for "${fixtureCase.name}"`, () => {
-            selection.missing.should.deep.equal(fixtureCase.expectedMissing);
-        });
-
-        it(`should report the expected version conflicts for "${fixtureCase.name}"`, () => {
-            selection.versionConflicts.should.deep.equal(fixtureCase.expectedVersionConflicts);
-        });
-
-        it(`should report the expected cycles for "${fixtureCase.name}"`, () => {
-            selection.cycles.should.deep.equal(fixtureCase.expectedCycles);
-        });
-
-        it(`should consider "${fixtureCase.name}" valid only when nothing is wrong`, () => {
-            const expectedValid =
-                fixtureCase.expectedMissing.length === 0 &&
-                fixtureCase.expectedVersionConflicts.length === 0 &&
-                fixtureCase.expectedCycles.length === 0;
-            isPackageSelectionValid(selection).should.equal(expectedValid);
-        });
-    }
-});

package/for_packageVersionRange/when_checking_against_the_shared_fixture_corpus.ts

@@ -1,13 +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 { isVersionSatisfiedBy } from '../index';
-import { corpus } from '../for_packageDependencies/fixtures';
-
-describe('when checking against the shared fixture corpus', () => {
-    for (const fixtureCase of corpus.versionRangeCases) {
-        it(`should decide ${fixtureCase.version} against '${fixtureCase.range ?? '<null>'}' the same way the corpus does`, () => {
-            isVersionSatisfiedBy(fixtureCase.version, fixtureCase.range ?? undefined).should.equal(fixtureCase.expected);
-        });
-    }
-});

package/for_panelKind/when_telling_the_panels_apart.ts

@@ -1,47 +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 { Canvas, DockPanel, Grid, HorizontalAlignment, Orientation, Panel, StackPanel, VerticalAlignment, Visibility, WrapPanel } from '@cratis/scene.model';
-import { isCanvas, isDockPanel, isGrid, isStackPanel, isWrapPanel } from '../index';
-
-const base = {
-    id: 'panel',
-    properties: {},
-    visibility: Visibility.Visible,
-    isEnabled: true,
-    opacity: 1,
-    zIndex: 0,
-    size: {},
-    name: 'panel',
-    minimumSize: {},
-    maximumSize: {},
-    margin: { left: 0, top: 0, right: 0, bottom: 0 },
-    horizontalAlignment: HorizontalAlignment.Stretch,
-    verticalAlignment: VerticalAlignment.Stretch,
-    children: [],
-};
-
-const canvas: Canvas = { ...base, extent: { width: 1280, height: 800 } };
-const grid: Grid = { ...base, rows: [], columns: [] };
-const dock: DockPanel = { ...base, lastChildFill: true };
-const stack: StackPanel = { ...base, orientation: Orientation.Vertical, spacing: 0 };
-const wrap: WrapPanel = { ...base, orientation: Orientation.Horizontal };
-const plain: Panel = { ...base };
-
-describe('when telling the panels apart', () => {
-    it('should recognize a canvas by its extent', () => isCanvas(canvas).should.be.true);
-    it('should recognize a grid by its tracks', () => isGrid(grid).should.be.true);
-    it('should recognize a dock panel by its fill flag', () => isDockPanel(dock).should.be.true);
-    it('should recognize a stack panel by its spacing', () => isStackPanel(stack).should.be.true);
-    it('should recognize a wrap panel by an orientation with no spacing', () => isWrapPanel(wrap).should.be.true);
-
-    it('should not mistake a stack panel for a wrap panel', () => isWrapPanel(stack).should.be.false);
-    it('should not mistake a wrap panel for a stack panel', () => isStackPanel(wrap).should.be.false);
-    it('should not mistake a grid for a dock panel', () => isDockPanel(grid).should.be.false);
-    it('should not mistake a canvas for a grouping panel', () => isCanvas(plain).should.be.false);
-    it('should leave a canvas unclaimed by the arranging guards', () =>
-        [isGrid(canvas), isDockPanel(canvas), isStackPanel(canvas), isWrapPanel(canvas)].should.have.members([false, false, false, false]));
-
-    it('should leave a plain panel unclaimed by every guard', () =>
-        [isCanvas(plain), isGrid(plain), isDockPanel(plain), isStackPanel(plain), isWrapPanel(plain)].should.have.members([false, false, false, false, false]));
-});

package/for_renderElement/when_rendering_a_mixed_tree.ts

@@ -1,58 +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 { ContentControl, Control, ExternalComponent, HorizontalAlignment, ItemsControl, Panel, VerticalAlignment, Visibility } from '@cratis/scene.model';
-import { Renderer, renderElement } from '../index';
-
-function control(id: string): Control {
-    return {
-        id,
-        name: id,
-        properties: {},
-        visibility: Visibility.Visible,
-        isEnabled: true,
-        opacity: 1,
-        size: {},
-        zIndex: 0,
-        minimumSize: {},
-        maximumSize: {},
-        margin: { left: 0, top: 0, right: 0, bottom: 0 },
-        horizontalAlignment: HorizontalAlignment.Stretch,
-        verticalAlignment: VerticalAlignment.Stretch,
-        borderThickness: { left: 0, top: 0, right: 0, bottom: 0 },
-        padding: { left: 0, top: 0, right: 0, bottom: 0 },
-        tabIndex: 0,
-    };
-}
-
-class StringRenderer implements Renderer<string> {
-    renderContentControl(element: ContentControl, content: string): string {
-        return `ContentControl(${element.id})[${content}]`;
-    }
-
-    renderItemsControl(element: ItemsControl, items: string[]): string {
-        return `ItemsControl(${element.id})[${items.join(',')}]`;
-    }
-
-    renderExternalComponent(element: ExternalComponent, slots: Record<string, string[]>): string {
-        const slotsText = Object.entries(slots).map(([name, children]) => `${name}=${children.join(',')}`).join(';');
-        return `ExternalComponent(${element.componentName})[${slotsText}]`;
-    }
-
-    renderPanel(element: Panel, children: string[]): string {
-        return `Panel(${element.id})[${children.join(',')}]`;
-    }
-}
-
-describe('when rendering a mixed tree', () => {
-    const badge: ExternalComponent = { ...control('badge'), componentName: 'core:badge', slots: {} };
-    const itemTemplate: ContentControl = { ...control('row'), content: badge };
-    const items: ItemsControl = { ...control('items'), itemsSource: { path: 'rows' }, itemTemplate };
-    const root: Panel = { ...control('root'), children: [items] };
-
-    const output = renderElement(root, new StringRenderer(), binding => (binding.path === 'rows' ? [{}, {}] : []));
-
-    it('should render the panel wrapping the items control', () => output.should.equal(
-        'Panel(root)[ItemsControl(items)[ContentControl(row)[ExternalComponent(core:badge)[]],ContentControl(row)[ExternalComponent(core:badge)[]]]]',
-    ));
-});