@cratis/scene.model 2.0.0 → 3.1.0

package/elements/index.ts

@@ -9,3 +9,4 @@ export * from './Panel';
 export * from './ItemsControl';
 export * from './ContentControl';
 export * from './ExternalComponent';
+export * from './panels';

package/elements/panels/ColumnDefinition.ts

@@ -0,0 +1,15 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { GridLength } from '../../common';
+
+/**
+ * One column of a {@link Grid}.
+ */
+export interface ColumnDefinition {
+    width: GridLength;
+    minimumWidth: number;
+    maximumWidth: number;
+}
+
+export const ColumnDefinitionPropertyNames: (keyof ColumnDefinition)[] = ['width', 'minimumWidth', 'maximumWidth'];

package/elements/panels/DockPanel.ts

@@ -0,0 +1,14 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { Panel } from '../Panel';
+
+/**
+ * Lays its children out against its edges, each child stating which edge through the `Dock` key
+ * of its `properties`.
+ */
+export interface DockPanel extends Panel {
+    lastChildFill: boolean;
+}
+
+export const DockPanelPropertyNames: (keyof DockPanel)[] = ['lastChildFill'];

package/elements/panels/Grid.ts

@@ -0,0 +1,17 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { Panel } from '../Panel';
+import { RowDefinition } from './RowDefinition';
+import { ColumnDefinition } from './ColumnDefinition';
+
+/**
+ * Lays its children out in rows and columns. A child states which cell it occupies through the
+ * `Grid.Row`, `Grid.Column`, `Grid.RowSpan` and `Grid.ColumnSpan` keys of its `properties`.
+ */
+export interface Grid extends Panel {
+    rows: RowDefinition[];
+    columns: ColumnDefinition[];
+}
+
+export const GridPropertyNames: (keyof Grid)[] = ['rows', 'columns'];

package/elements/panels/RowDefinition.ts

@@ -0,0 +1,15 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { GridLength } from '../../common';
+
+/**
+ * One row of a {@link Grid}.
+ */
+export interface RowDefinition {
+    height: GridLength;
+    minimumHeight: number;
+    maximumHeight: number;
+}
+
+export const RowDefinitionPropertyNames: (keyof RowDefinition)[] = ['height', 'minimumHeight', 'maximumHeight'];

package/elements/panels/StackPanel.ts

@@ -0,0 +1,15 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { Panel } from '../Panel';
+import { Orientation } from '../../common';
+
+/**
+ * Lays its children out in a single line.
+ */
+export interface StackPanel extends Panel {
+    orientation: Orientation;
+    spacing: number;
+}
+
+export const StackPanelPropertyNames: (keyof StackPanel)[] = ['orientation', 'spacing'];

package/elements/panels/WrapPanel.ts

@@ -0,0 +1,16 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { Panel } from '../Panel';
+import { Orientation } from '../../common';
+
+/**
+ * Lays its children out in a line and starts a new one whenever the current line runs out of room.
+ */
+export interface WrapPanel extends Panel {
+    orientation: Orientation;
+    itemWidth?: number;
+    itemHeight?: number;
+}
+
+export const WrapPanelPropertyNames: (keyof WrapPanel)[] = ['orientation', 'itemWidth', 'itemHeight'];

package/elements/panels/index.ts

@@ -0,0 +1,9 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+export * from './StackPanel';
+export * from './DockPanel';
+export * from './WrapPanel';
+export * from './RowDefinition';
+export * from './ColumnDefinition';
+export * from './Grid';

package/package.json

@@ -1,7 +1,17 @@
 {
     "name": "@cratis/scene.model",
-    "version": "2.0.0",
+    "version": "3.1.0",
     "description": "The TypeScript mirror of Cratis.Scene.Model — the platform-agnostic Screen object model.",
+    "keywords": [
+        "cratis",
+        "scene",
+        "ui",
+        "ui-model",
+        "event-modeling",
+        "event-sourcing",
+        "cqrs",
+        "low-code"
+    ],
     "author": "Cratis",
     "license": "MIT",
     "repository": {

package/packages/ScenePackage.ts

@@ -72,6 +72,20 @@ export interface ScenePackage {
      * tooling needs it to know what to import; the model itself never loads anything.
      */
     module?: string;
+
+    /**
+     * The license the package is available under, as a short human-readable name (`MIT`,
+     * `PrimeUI Community`). A package picker shows it, because "what am I taking on by selecting this"
+     * is a question an author needs answered before they select it, not after.
+     */
+    license?: string;
+
+    /**
+     * Where the license terms actually live, so a reader can go and check rather than take `license` on
+     * trust. Required in practice for anything that is not a permissive standard license — a name alone
+     * tells an author nothing about eligibility or obligations.
+     */
+    licenseUrl?: string;
 }
 
 export const ScenePackagePropertyNames: (keyof ScenePackage)[] = [
@@ -87,4 +101,6 @@ export const ScenePackagePropertyNames: (keyof ScenePackage)[] = [
     'displayName',
     'description',
     'module',
+    'license',
+    'licenseUrl',
 ];

package/profiles/Theme.ts

@@ -50,6 +50,11 @@ export interface Theme {
      * A one-line description for a theme picker.
      */
     description?: string;
+
+    /**
+     * Where those license terms live, so a reader can check them rather than take `license` on trust.
+     */
+    licenseUrl?: string;
 }
 
 export const ThemePropertyNames: (keyof Theme)[] = [
@@ -61,4 +66,5 @@ export const ThemePropertyNames: (keyof Theme)[] = [
     'authorUrl',
     'license',
     'description',
+    'licenseUrl',
 ];