@cratis/scene.model 3.7.0 → 4.1.0

package/dist/esm/screens/ScreenTemplate.js

@@ -7,7 +7,8 @@ const ScreenTemplatePropertyNames = [
     'arrangement',
     'content',
     'displayName',
-    'description'
+    'description',
+    'behaviors'
 ];
 
 export { ScreenTemplatePropertyNames };

package/dist/esm/screens/ScreenTemplate.js.map

@@ -1 +1 @@
-{"version":3,"file":"ScreenTemplate.js","sources":["../../../screens/ScreenTemplate.ts"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\nimport { SceneElement } from '../elements';\nimport { Arrangement, Slot } from '../layouts';\n\n/**\n * A reusable screen structure that fills a named slot on whatever contains it, and offers slots of its\n * own for what it contains in turn.\n *\n * A {@link Layout} and a screen template are deliberately different things. A layout is the application's\n * base navigational look — the shell with its top bar, navigation and content region — and an application\n * has one. A screen template is what goes *inside* that shell, and an application has many: one per\n * module, feature or slice that needs a shape of its own.\n *\n * `fitsSlot` is what makes them compose. A module's screen template fits the application layout's content\n * slot; a feature's screen template fits a slot the module's template declares; a slice's fits one the\n * feature's declares. The same rule at every level, so nesting is arbitrarily deep without a second\n * mechanism — and a template always states where it belongs rather than being told by whatever happens to\n * host it.\n */\nexport interface ScreenTemplate {\n    /**\n     * The template's name, which a {@link Screen} refers to.\n     */\n    name: string;\n\n    /**\n     * The name of the slot on the containing {@link Layout} or screen template this one fills, or\n     * undefined for a template that is placed explicitly rather than by declaration.\n     */\n    fitsSlot?: string;\n\n    /**\n     * The slots this template offers to whatever it contains, in declaration order.\n     */\n    slots: Slot[];\n\n    /**\n     * How this template's own `slots` position relative to each other — the same shape a {@link Layout}\n     * uses, evaluated by the same engine. Absent for declaration order with no further positioning.\n     */\n    arrangement?: Arrangement;\n\n    /**\n     * Content the template itself provides, keyed by slot name — the chrome a template brings with it, as\n     * opposed to what a {@link Screen} based on it fills in.\n     */\n    content?: Record<string, SceneElement[]>;\n\n    /**\n     * A human-readable name for a template picker, falling back to `name`.\n     */\n    displayName?: string;\n\n    /**\n     * A one-line description for a template picker.\n     */\n    description?: string;\n}\n\nexport const ScreenTemplatePropertyNames: (keyof ScreenTemplate)[] = [\n    'name',\n    'fitsSlot',\n    'slots',\n    'arrangement',\n    'content',\n    'displayName',\n    'description',\n];\n"],"names":["ScreenTemplatePropertyNames"],"mappings":"AAAA;AACA;MA4DaA,2BAAAA,GAAwD;AACjE,IAAA,MAAA;AACA,IAAA,UAAA;AACA,IAAA,OAAA;AACA,IAAA,aAAA;AACA,IAAA,SAAA;AACA,IAAA,aAAA;AACA,IAAA;;;"}
+{"version":3,"file":"ScreenTemplate.js","sources":["../../../screens/ScreenTemplate.ts"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\nimport { SceneElement } from '../elements';\nimport { Arrangement, Slot } from '../layouts';\nimport { Behavior } from '../interactions';\n\n/**\n * A reusable screen structure that fills a named slot on whatever contains it, and offers slots of its\n * own for what it contains in turn.\n *\n * A {@link Layout} and a screen template are deliberately different things. A layout is the application's\n * base navigational look — the shell with its top bar, navigation and content region — and an application\n * has one. A screen template is what goes *inside* that shell, and an application has many: one per\n * module, feature or slice that needs a shape of its own.\n *\n * `fitsSlot` is what makes them compose. A module's screen template fits the application layout's content\n * slot; a feature's screen template fits a slot the module's template declares; a slice's fits one the\n * feature's declares. The same rule at every level, so nesting is arbitrarily deep without a second\n * mechanism — and a template always states where it belongs rather than being told by whatever happens to\n * host it.\n */\nexport interface ScreenTemplate {\n    /**\n     * The template's name, which a {@link Screen} refers to.\n     */\n    name: string;\n\n    /**\n     * The name of the slot on the containing {@link Layout} or screen template this one fills, or\n     * undefined for a template that is placed explicitly rather than by declaration.\n     */\n    fitsSlot?: string;\n\n    /**\n     * The slots this template offers to whatever it contains, in declaration order.\n     */\n    slots: Slot[];\n\n    /**\n     * How this template's own `slots` position relative to each other — the same shape a {@link Layout}\n     * uses, evaluated by the same engine. Absent for declaration order with no further positioning.\n     */\n    arrangement?: Arrangement;\n\n    /**\n     * Content the template itself provides, keyed by slot name — the chrome a template brings with it, as\n     * opposed to what a {@link Screen} based on it fills in.\n     */\n    content?: Record<string, SceneElement[]>;\n\n    /**\n     * A human-readable name for a template picker, falling back to `name`.\n     */\n    displayName?: string;\n\n    /**\n     * A one-line description for a template picker.\n     */\n    description?: string;\n    /**\n     * The behaviors attached here - what happens when someone interacts with it. Additive with whatever is\n     * attached further out or further in.\n     */\n    behaviors?: Behavior[];\n}\n\nexport const ScreenTemplatePropertyNames: (keyof ScreenTemplate)[] = [\n    'name',\n    'fitsSlot',\n    'slots',\n    'arrangement',\n    'content',\n    'displayName',\n    'description',\n    'behaviors',\n];\n"],"names":["ScreenTemplatePropertyNames"],"mappings":"AAAA;AACA;MAkEaA,2BAAAA,GAAwD;AACjE,IAAA,MAAA;AACA,IAAA,UAAA;AACA,IAAA,OAAA;AACA,IAAA,aAAA;AACA,IAAA,SAAA;AACA,IAAA,aAAA;AACA,IAAA,aAAA;AACA,IAAA;;;"}

package/dist/esm/sizeClasses/TargetSizeClass.d.ts

@@ -0,0 +1,6 @@
+export declare enum TargetSizeClass {
+    Compact = "Compact",
+    Regular = "Regular",
+    Expanded = "Expanded"
+}
+//# sourceMappingURL=TargetSizeClass.d.ts.map

package/dist/esm/sizeClasses/TargetSizeClass.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TargetSizeClass.d.ts","sourceRoot":"","sources":["../../../sizeClasses/TargetSizeClass.ts"],"names":[],"mappings":"AAWA,oBAAY,eAAe;IACvB,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,QAAQ,aAAa;CACxB"}

package/dist/esm/sizeClasses/TargetSizeClass.js

@@ -0,0 +1,18 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/**
+ * Defines the size a deployment target assumes by default.
+ *
+ * Deliberately a different vocabulary from {@link WidthSizeClass} and {@link HeightSizeClass}. Those two form
+ * the matrix an arrangement resolves against, where the only distinction that matters is whether an axis is
+ * cramped. What a target assumes is a coarser, one-dimensional statement about the device - a desktop is not
+ * merely 'regular' - and it carries a third value because of it.
+ */ var TargetSizeClass = /*#__PURE__*/ function(TargetSizeClass) {
+    TargetSizeClass["Compact"] = "Compact";
+    TargetSizeClass["Regular"] = "Regular";
+    TargetSizeClass["Expanded"] = "Expanded";
+    return TargetSizeClass;
+}({});
+
+export { TargetSizeClass };
+//# sourceMappingURL=TargetSizeClass.js.map

package/dist/esm/sizeClasses/TargetSizeClass.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TargetSizeClass.js","sources":["../../../sizeClasses/TargetSizeClass.ts"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\n/**\n * Defines the size a deployment target assumes by default.\n *\n * Deliberately a different vocabulary from {@link WidthSizeClass} and {@link HeightSizeClass}. Those two form\n * the matrix an arrangement resolves against, where the only distinction that matters is whether an axis is\n * cramped. What a target assumes is a coarser, one-dimensional statement about the device - a desktop is not\n * merely 'regular' - and it carries a third value because of it.\n */\nexport enum TargetSizeClass {\n    Compact = 'Compact',\n    Regular = 'Regular',\n    Expanded = 'Expanded'\n}\n"],"names":["TargetSizeClass"],"mappings":"AAAA;AACA;AAEA;;;;;;;IAQO,IAAKA,eAAAA,iBAAAA,SAAAA,eAAAA,EAAAA;;;;AAAAA,IAAAA,OAAAA,eAAAA;AAIX,CAAA,CAAA,EAAA;;"}

package/dist/esm/sizeClasses/index.d.ts

@@ -1,4 +1,5 @@
 export * from './WidthSizeClass';
 export * from './HeightSizeClass';
 export * from './SizeClass';
+export * from './TargetSizeClass';
 //# sourceMappingURL=index.d.ts.map

package/dist/esm/sizeClasses/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../sizeClasses/index.ts"],"names":[],"mappings":"AAGA,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../sizeClasses/index.ts"],"names":[],"mappings":"AAGA,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC;AAC5B,cAAc,mBAAmB,CAAC"}

package/dist/esm/sizeClasses/index.js

@@ -1,4 +1,5 @@
 export * from './WidthSizeClass';
 export * from './HeightSizeClass';
 export * from './SizeClass';
+export * from './TargetSizeClass';
 //# sourceMappingURL=index.js.map

package/dist/esm/sizeClasses/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../sizeClasses/index.ts"],"names":[],"mappings":"AAGA,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../sizeClasses/index.ts"],"names":[],"mappings":"AAGA,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC;AAC5B,cAAc,mBAAmB,CAAC"}