@cratis/scene.blueprint.components 4.1.1 → 4.2.1

package/for_componentsScreenTemplates/when_following_the_nesting_chain.ts

@@ -1,83 +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 { isScreenTemplateResolutionValid, resolveScreenTemplates } from '@cratis/scene.engine';
-import { appShellLayout } from '@cratis/scene.blueprint.default';
-import { nestingChainTemplates } from '../templates';
-
-/**
- * The three-level chain, put through the real resolver rather than checked by walking slot lists.
- *
- * "It composes recursively" is the kind of claim that is true in a design document and wrong in the code,
- * and the way it goes wrong is specific: a chain that reuses one slot name at several levels reads
- * perfectly and resolves to nothing, because the resolver refuses to guess which of two containers a
- * template belongs to. Only running it proves the chain is really placeable.
- */
-describe('when following the nesting chain', () => {
-    const resolution = resolveScreenTemplates(appShellLayout, nestingChainTemplates);
-    const placementOf = (name: string) => resolution.placements.find(placement => placement.template === name);
-
-    it('should be a valid resolution', () => {
-        isScreenTemplateResolutionValid(resolution).should.be.true;
-    });
-
-    it('should place all three levels', () => {
-        resolution.placements.should.have.lengthOf(3);
-    });
-
-    it('should leave nothing unplaced', () => {
-        resolution.unplaced.should.be.empty;
-    });
-
-    describe('and it is the module level', () => {
-        const placement = placementOf('DataModulePage')!;
-
-        it('should sit directly inside the application layout', () => {
-            placement.container.should.equal(appShellLayout.name);
-        });
-
-        it('should fill the content slot', () => {
-            placement.slot.should.equal('content');
-        });
-
-        it('should be one level below the layout', () => {
-            placement.depth.should.equal(1);
-        });
-    });
-
-    describe('and it is the feature level', () => {
-        const placement = placementOf('DataFeatureSection')!;
-
-        it('should sit inside the module template', () => {
-            placement.container.should.equal('DataModulePage');
-        });
-
-        it('should fill a slot the module template declares', () => {
-            placement.slot.should.equal('body');
-        });
-
-        it('should be two levels below the layout', () => {
-            placement.depth.should.equal(2);
-        });
-    });
-
-    describe('and it is the slice level', () => {
-        const placement = placementOf('CommandSliceSection')!;
-
-        it('should sit inside the feature template', () => {
-            placement.container.should.equal('DataFeatureSection');
-        });
-
-        it('should fill a slot the feature template declares', () => {
-            placement.slot.should.equal('primary');
-        });
-
-        it('should be three levels below the layout', () => {
-            placement.depth.should.equal(3);
-        });
-    });
-
-    it('should order the placements shallowest first, so a caller can build the tree top down', () => {
-        resolution.placements.map(placement => placement.depth).should.deep.equal([1, 2, 3]);
-    });
-});

package/for_componentsScreenTemplates/when_placing_them_in_the_default_blueprint_layout.ts

@@ -1,51 +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 { resolveScreenTemplates } from '@cratis/scene.engine';
-import { appShellLayout, defaultBlueprint } from '@cratis/scene.blueprint.default';
-import { componentsPageTemplates } from '../templates';
-
-/**
- * The page templates are resolved against the default blueprint's layout *and its templates*, because that
- * is the situation an application is actually in: a profile that activates both blueprints has every one of
- * those templates in scope, and a `fitsSlot` that became ambiguous once they were is a `fitsSlot` that
- * works only in isolation.
- *
- * Only this package's templates are asserted on. The default blueprint's own nesting chain reuses `body` at
- * three levels, so it is reported unplaced in this combined scope - which is `resolveScreenTemplates`
- * behaving correctly, and not this package's result to claim or to fix.
- */
-describe('when placing them in the default blueprint layout', () => {
-    const templates = [...(defaultBlueprint.screenTemplates ?? []), ...componentsPageTemplates];
-    const resolution = resolveScreenTemplates(appShellLayout, templates);
-    const ownNames = new Set(componentsPageTemplates.map(template => template.name));
-    const ownPlacements = resolution.placements.filter(placement => ownNames.has(placement.template));
-
-    it('should have templates to place', () => {
-        componentsPageTemplates.should.not.be.empty;
-    });
-
-    it('should place every one of them', () => {
-        ownPlacements.map(placement => placement.template).sort().should.deep.equal([...ownNames].sort());
-    });
-
-    it('should leave none of them unplaced, even with the other blueprint templates in scope', () => {
-        resolution.unplaced.filter(unplaced => ownNames.has(unplaced.template)).should.be.empty;
-    });
-
-    it('should place every one directly inside the layout rather than inside another template', () => {
-        ownPlacements.filter(placement => placement.container !== appShellLayout.name).should.be.empty;
-    });
-
-    it('should place every one at the first level below the layout', () => {
-        ownPlacements.filter(placement => placement.depth !== 1).should.be.empty;
-    });
-
-    it('should place every one in the content slot, which is the only region a layout offers a screen', () => {
-        ownPlacements.filter(placement => placement.slot !== 'content').should.be.empty;
-    });
-
-    it('should introduce no nesting cycle', () => {
-        resolution.cycles.should.deep.equal([]);
-    });
-});

package/for_componentsScreenTemplates/when_resolving_the_component_names_they_reference.ts

@@ -1,72 +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 { resolveComponentName } from '@cratis/scene.engine';
-import { composeScreenElement, defaultBlueprintName, distinctComponentNames } from '@cratis/scene.blueprint.default';
-import { cratisComponentsPackageManifest } from '@cratis/scene.components';
-import { ComponentName } from '../ComponentName';
-import { CompositeName } from '../CompositeName';
-import { componentsBlueprintCatalog, componentsBlueprintProfile, componentsGalleryScreens } from '../gallery';
-import { componentsBlueprintName } from '../packageName';
-import { componentsDialogTemplates } from '../templates';
-
-/**
- * Every name a template writes has to resolve against the profile, or it renders as a dashed red box in
- * the middle of an otherwise fine page with nothing pointing back at the template that wrote it. The
- * catalog is built from the real manifests of the packages this blueprint depends on, so a name renamed
- * upstream fails here rather than in an application.
- */
-describe('when resolving the component names they reference', () => {
-    const fromScreens = distinctComponentNames(componentsGalleryScreens.map(composeScreenElement));
-    const fromDialogs = distinctComponentNames(componentsDialogTemplates.flatMap(template => Object.values(template.content ?? {}).flat()));
-    const names = [...new Set([...fromScreens, ...fromDialogs])].sort();
-    const resolutions = names.map(name => ({ name, resolution: resolveComponentName(name, componentsBlueprintProfile, componentsBlueprintCatalog) }));
-
-    it('should reference something', () => {
-        names.should.not.be.empty;
-    });
-
-    it('should reference something from the dialog templates too', () => {
-        fromDialogs.should.not.be.empty;
-    });
-
-    it('should resolve every referenced name against the profile', () => {
-        resolutions
-            .filter(entry => entry.resolution === undefined)
-            .map(entry => entry.name)
-            .should.be.empty;
-    });
-
-    it('should resolve its own page header to itself', () => {
-        resolveComponentName(ComponentName.ArcPageHeader, componentsBlueprintProfile, componentsBlueprintCatalog)!.package.should.equal(componentsBlueprintName);
-    });
-
-    it('should reference every component it registers, so nothing is declared and then unused', () => {
-        const referenced = new Set(names);
-        Object.values(ComponentName)
-            .filter(name => !referenced.has(name))
-            .should.be.empty;
-    });
-
-    it('should resolve the shell components to the blueprint it layers on', () => {
-        resolveComponentName('appShell', componentsBlueprintProfile, componentsBlueprintCatalog)!.package.should.equal(defaultBlueprintName);
-    });
-
-    it('should resolve the Arc-bound composites to the component library', () => {
-        resolutions
-            .filter(entry => (Object.values(CompositeName) as string[]).includes(entry.name))
-            .filter(entry => entry.resolution?.package !== cratisComponentsPackageManifest.name)
-            .map(entry => entry.name)
-            .should.be.empty;
-    });
-
-    it('should resolve a name both libraries declare to the Arc-aware one, and record the other as shadowed', () => {
-        const dataTable = resolveComponentName(CompositeName.DataTable, componentsBlueprintProfile, componentsBlueprintCatalog)!;
-        dataTable.package.should.equal(cratisComponentsPackageManifest.name);
-        dataTable.shadows.should.contain('PrimeReact');
-    });
-
-    it('should resolve the borrowed column to PrimeReact, since neither library declares one', () => {
-        resolveComponentName('column', componentsBlueprintProfile, componentsBlueprintCatalog)!.package.should.equal('PrimeReact');
-    });
-});

package/for_deriveArcHeading/when_no_binding_is_named.ts

@@ -1,42 +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 { BindingKind } from '@cratis/scene.components';
-import { deriveArcHeading } from '../header';
-
-/**
- * The third state, and the one that is easiest to conflate with the second. A template that names nothing
- * is not broken - the schema editor page genuinely has no query behind it - so this reads as a statement
- * rather than as a problem to fix.
- */
-describe('when no binding is named', () => {
-    const heading = deriveArcHeading({ title: 'InvoiceRegistered' }, {}, BindingKind.Query);
-
-    it('should use the title the template gave it', () => {
-        heading.title.should.equal('InvoiceRegistered');
-    });
-
-    it('should build a trail of just the title when no section was given', () => {
-        heading.trail.should.deep.equal(['InvoiceRegistered']);
-    });
-
-    it('should report that it is not bound', () => {
-        heading.isBound.should.be.false;
-    });
-
-    it('should state the absence plainly rather than naming a binding nobody asked for', () => {
-        heading.bindingLabel.should.equal('No binding');
-    });
-
-    it('should carry no binding name', () => {
-        (heading.bindingName === undefined).should.be.true;
-    });
-
-    describe('and the template gave no title either', () => {
-        const untitled = deriveArcHeading({}, {}, BindingKind.Query);
-
-        it('should fall back to something readable rather than an empty heading', () => {
-            untitled.title.should.equal('Untitled page');
-        });
-    });
-});

package/for_deriveArcHeading/when_the_binding_is_not_registered.ts

@@ -1,25 +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 { BindingKind } from '@cratis/scene.components';
-import { deriveArcHeading } from '../header';
-
-describe('when the binding is not registered', () => {
-    const heading = deriveArcHeading({ section: 'Billing' }, { name: 'RecordAdjustment' }, BindingKind.Command);
-
-    it('should fall back to the binding name read as a sentence, so the page is legible before anyone writes a title', () => {
-        heading.title.should.equal('Record adjustment');
-    });
-
-    it('should build the trail from the derived title', () => {
-        heading.trail.should.deep.equal(['Billing', 'Record adjustment']);
-    });
-
-    it('should report that it is not bound', () => {
-        heading.isBound.should.be.false;
-    });
-
-    it('should say which name a host has to register, which is the only actionable part', () => {
-        heading.bindingLabel.should.equal('No command registered as RecordAdjustment');
-    });
-});

package/for_deriveArcHeading/when_the_binding_is_registered.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 { BindingKind } from '@cratis/scene.components';
-import { deriveArcHeading } from '../header';
-
-class AllInvoices {}
-
-describe('when the binding is registered', () => {
-    const heading = deriveArcHeading({ title: 'Invoices', subtitle: 'Every invoice', section: 'Billing' }, { name: 'AllInvoices', target: AllInvoices }, BindingKind.Query);
-
-    it('should use the title the template gave it', () => {
-        heading.title.should.equal('Invoices');
-    });
-
-    it('should keep the subtitle', () => {
-        heading.subtitle!.should.equal('Every invoice');
-    });
-
-    it('should build the trail from the section and the title, rather than a second literal', () => {
-        heading.trail.should.deep.equal(['Billing', 'Invoices']);
-    });
-
-    it('should report that it is bound', () => {
-        heading.isBound.should.be.true;
-    });
-
-    it('should say what it is bound to, naming the kind so a query is not mistaken for a command', () => {
-        heading.bindingLabel.should.equal('Bound to query AllInvoices');
-    });
-
-    it('should keep the binding name for anything that wants to report it', () => {
-        heading.bindingName!.should.equal('AllInvoices');
-    });
-});

package/for_humanizeBindingName/when_reading_a_proxy_name.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 { humanizeBindingName } from '../header';
-
-describe('when reading a proxy name', () => {
-    it('should read a two-word query name as a sentence', () => {
-        humanizeBindingName('AllInvoices').should.equal('All invoices');
-    });
-
-    it('should read a command name as a sentence', () => {
-        humanizeBindingName('RecordAdjustment').should.equal('Record adjustment');
-    });
-
-    it('should lower every word after the first', () => {
-        humanizeBindingName('InvoicesInFlight').should.equal('Invoices in flight');
-    });
-
-    it('should leave a single word alone', () => {
-        humanizeBindingName('Invoices').should.equal('Invoices');
-    });
-
-    it('should split a word boundary that follows a digit', () => {
-        humanizeBindingName('Top10Customers').should.equal('Top10 customers');
-    });
-
-    it('should keep a run of capitals together rather than chopping it into initials', () => {
-        humanizeBindingName('AllPIIRecords').should.equal('All PIIRecords');
-    });
-
-    it('should return an empty name unchanged rather than inventing a heading', () => {
-        humanizeBindingName('').should.equal('');
-    });
-});