@cratis/scene.engine 3.1.0 → 3.3.0

package/for_panelKind/when_telling_the_panels_apart.ts

@@ -1,8 +1,8 @@
 // Copyright (c) Cratis. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
-import { DockPanel, Grid, HorizontalAlignment, Orientation, Panel, StackPanel, VerticalAlignment, Visibility, WrapPanel } from '@cratis/scene.model';
-import { isDockPanel, isGrid, isStackPanel, isWrapPanel } from '../index';
+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',
@@ -21,6 +21,7 @@ const base = {
     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 };
@@ -28,6 +29,7 @@ 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);
@@ -36,7 +38,10 @@ describe('when telling the panels apart', () => {
     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', () =>
-        [isGrid(plain), isDockPanel(plain), isStackPanel(plain), isWrapPanel(plain)].should.have.members([false, false, false, false]));
+        [isCanvas(plain), isGrid(plain), isDockPanel(plain), isStackPanel(plain), isWrapPanel(plain)].should.have.members([false, false, false, false, false]));
 });

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cratis/scene.engine",
-    "version": "3.1.0",
+    "version": "3.3.0",
     "description": "The Scene runtime: walks a Scene element tree and drives whichever renderer is plugged in. Does not know React, or any other rendering platform, exists.",
     "keywords": [
         "cratis",
@@ -47,9 +47,9 @@
         "up": "yarn g:up"
     },
     "dependencies": {
-        "@cratis/scene.model": "3.1.0"
+        "@cratis/scene.model": "3.3.0"
     },
     "devDependencies": {
-        "@cratis/scene.model": "3.1.0"
+        "@cratis/scene.model": "3.3.0"
     }
 }

package/panelKind.ts

@@ -1,7 +1,7 @@
 // Copyright (c) Cratis. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
-import { DockPanel, Grid, Panel, StackPanel, WrapPanel } from '@cratis/scene.model';
+import { Canvas, DockPanel, Grid, Panel, StackPanel, WrapPanel } from '@cratis/scene.model';
 
 /**
  * Type guards telling the concrete panels apart, by the property each one alone declares - the same way
@@ -13,6 +13,10 @@ import { DockPanel, Grid, Panel, StackPanel, WrapPanel } from '@cratis/scene.mod
  * whatever way its platform considers neutral.
  */
 
+export function isCanvas(panel: Panel): panel is Canvas {
+    return 'extent' in panel;
+}
+
 export function isGrid(panel: Panel): panel is Grid {
     return 'rows' in panel && 'columns' in panel;
 }