@player-ui/types 0.4.0 → 0.4.1-next.0

package/dist/xlr/View.json

@@ -0,0 +1,185 @@
+{
+    "source": "core/types/src/index.ts",
+    "name": "View",
+    "type": "conditional",
+    "check": {
+        "left": {
+            "type": "unknown"
+        },
+        "right": {
+            "type": "ref",
+            "ref": "Asset",
+            "property": "validation"
+        }
+    },
+    "value": {
+        "true": {
+            "type": "and",
+            "and": [
+                {
+                    "type": "ref",
+                    "ref": "T"
+                },
+                {
+                    "type": "object",
+                    "properties": {
+                        "validation": {
+                            "required": false,
+                            "node": {
+                                "type": "array",
+                                "elementType": {
+                                    "name": "CrossfieldReference",
+                                    "type": "object",
+                                    "properties": {
+                                        "type": {
+                                            "required": true,
+                                            "node": {
+                                                "type": "string",
+                                                "title": "Reference.type",
+                                                "description": "The name of the referenced validation type\nThis will be used to lookup the proper handler"
+                                            }
+                                        },
+                                        "message": {
+                                            "required": false,
+                                            "node": {
+                                                "type": "string",
+                                                "title": "Reference.message",
+                                                "description": "An optional means of overriding the default message if the validation is triggered"
+                                            }
+                                        },
+                                        "severity": {
+                                            "required": false,
+                                            "node": {
+                                                "name": "Severity",
+                                                "type": "or",
+                                                "or": [
+                                                    {
+                                                        "type": "string",
+                                                        "const": "error"
+                                                    },
+                                                    {
+                                                        "type": "string",
+                                                        "const": "warning"
+                                                    }
+                                                ],
+                                                "title": "Reference.severity",
+                                                "description": "An optional means of overriding the default severity of the validation if triggered"
+                                            }
+                                        },
+                                        "trigger": {
+                                            "required": false,
+                                            "node": {
+                                                "name": "Trigger",
+                                                "type": "or",
+                                                "or": [
+                                                    {
+                                                        "type": "string",
+                                                        "const": "navigation"
+                                                    },
+                                                    {
+                                                        "type": "string",
+                                                        "const": "change"
+                                                    },
+                                                    {
+                                                        "type": "string",
+                                                        "const": "load"
+                                                    }
+                                                ],
+                                                "title": "Reference.trigger",
+                                                "description": "When to run this particular validation"
+                                            }
+                                        },
+                                        "dataTarget": {
+                                            "required": false,
+                                            "node": {
+                                                "type": "never",
+                                                "title": "CrossfieldReference.dataTarget",
+                                                "description": "Cross-field references and validation must run against the default (deformatted) value"
+                                            }
+                                        },
+                                        "displayTarget": {
+                                            "required": false,
+                                            "node": {
+                                                "name": "DisplayTarget",
+                                                "type": "or",
+                                                "or": [
+                                                    {
+                                                        "type": "string",
+                                                        "const": "page"
+                                                    },
+                                                    {
+                                                        "type": "string",
+                                                        "const": "section"
+                                                    },
+                                                    {
+                                                        "type": "string",
+                                                        "const": "field"
+                                                    }
+                                                ],
+                                                "title": "Reference.displayTarget",
+                                                "description": "Where the error should be displayed"
+                                            }
+                                        },
+                                        "blocking": {
+                                            "required": false,
+                                            "node": {
+                                                "type": "or",
+                                                "or": [
+                                                    {
+                                                        "type": "boolean",
+                                                        "title": "Reference.blocking"
+                                                    },
+                                                    {
+                                                        "type": "string",
+                                                        "const": "once"
+                                                    }
+                                                ],
+                                                "title": "Reference.blocking",
+                                                "description": "If the validation blocks navigation\ntrue/false - always/never block navigation\nonce - only block navigation if the validation has not been triggered before",
+                                                "default": "- true for errors, 'once' for warnings"
+                                            }
+                                        },
+                                        "ref": {
+                                            "required": false,
+                                            "node": {
+                                                "type": "ref",
+                                                "ref": "Binding",
+                                                "title": "CrossfieldReference.ref",
+                                                "description": "The binding to associate this validation with"
+                                            }
+                                        }
+                                    },
+                                    "additionalProperties": {
+                                        "type": "unknown"
+                                    },
+                                    "title": "CrossfieldReference"
+                                },
+                                "title": "validation",
+                                "description": "Each view can optionally supply a list of validations to run against a particular view"
+                            }
+                        }
+                    },
+                    "additionalProperties": false
+                }
+            ]
+        },
+        "false": {
+            "type": "ref",
+            "ref": "T"
+        }
+    },
+    "title": "View",
+    "genericTokens": [
+        {
+            "symbol": "T",
+            "constraints": {
+                "type": "ref",
+                "ref": "Asset"
+            },
+            "default": {
+                "type": "ref",
+                "ref": "Asset"
+            }
+        }
+    ]
+}

package/dist/xlr/manifest.js

@@ -0,0 +1,41 @@
+const Asset = require('./Asset.json')
+const AssetBinding = require('./AssetBinding.json')
+const SwitchCase = require('./SwitchCase.json')
+const Switch = require('./Switch.json')
+const AssetWrapper = require('./AssetWrapper.json')
+const AssetWrapperOrSwitch = require('./AssetWrapperOrSwitch.json')
+const AssetSwitch = require('./AssetSwitch.json')
+const StaticSwitch = require('./StaticSwitch.json')
+const DynamicSwitch = require('./DynamicSwitch.json')
+const Expression = require('./Expression.json')
+const ExpressionRef = require('./ExpressionRef.json')
+const Binding = require('./Binding.json')
+const BindingRef = require('./BindingRef.json')
+const DataModel = require('./DataModel.json')
+const Navigation = require('./Navigation.json')
+const ExpressionObject = require('./ExpressionObject.json')
+const NavigationFlow = require('./NavigationFlow.json')
+const NavigationFlowTransition = require('./NavigationFlowTransition.json')
+const NavigationBaseState = require('./NavigationBaseState.json')
+const NavigationFlowTransitionableState = require('./NavigationFlowTransitionableState.json')
+const NavigationFlowViewState = require('./NavigationFlowViewState.json')
+const NavigationFlowEndState = require('./NavigationFlowEndState.json')
+const NavigationFlowActionState = require('./NavigationFlowActionState.json')
+const NavigationFlowExternalState = require('./NavigationFlowExternalState.json')
+const NavigationFlowFlowState = require('./NavigationFlowFlowState.json')
+const NavigationFlowState = require('./NavigationFlowState.json')
+const FlowResult = require('./FlowResult.json')
+const Templatable = require('./Templatable.json')
+const Template = require('./Template.json')
+const View = require('./View.json')
+const Flow = require('./Flow.json')
+
+    module.exports = {
+      "pluginName": "Types",
+      "capabilities": {
+        "Types":[Asset,AssetBinding,SwitchCase,Switch,AssetWrapper,AssetWrapperOrSwitch,AssetSwitch,StaticSwitch,DynamicSwitch,Expression,ExpressionRef,Binding,BindingRef,DataModel,Navigation,ExpressionObject,NavigationFlow,NavigationFlowTransition,NavigationBaseState,NavigationFlowTransitionableState,NavigationFlowViewState,NavigationFlowEndState,NavigationFlowActionState,NavigationFlowExternalState,NavigationFlowFlowState,NavigationFlowState,FlowResult,Templatable,Template,View,Flow],
+      },
+      "customPrimitives": [
+        'Expression','Asset','Binding','AssetWrapper','Schema.DataType','ExpressionHandler'
+      ]
+    }

package/dist/xlr/manifest.json

@@ -0,0 +1,46 @@
+{
+    "pluginName": "Types",
+    "capabilities": {
+        "Types": [
+            "Asset",
+            "AssetBinding",
+            "SwitchCase",
+            "Switch",
+            "AssetWrapper",
+            "AssetWrapperOrSwitch",
+            "AssetSwitch",
+            "StaticSwitch",
+            "DynamicSwitch",
+            "Expression",
+            "ExpressionRef",
+            "Binding",
+            "BindingRef",
+            "DataModel",
+            "Navigation",
+            "ExpressionObject",
+            "NavigationFlow",
+            "NavigationFlowTransition",
+            "NavigationBaseState",
+            "NavigationFlowTransitionableState",
+            "NavigationFlowViewState",
+            "NavigationFlowEndState",
+            "NavigationFlowActionState",
+            "NavigationFlowExternalState",
+            "NavigationFlowFlowState",
+            "NavigationFlowState",
+            "FlowResult",
+            "Templatable",
+            "Template",
+            "View",
+            "Flow"
+        ]
+    },
+    "customPrimitives": [
+        "Expression",
+        "Asset",
+        "Binding",
+        "AssetWrapper",
+        "Schema.DataType",
+        "ExpressionHandler"
+    ]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@player-ui/types",
-  "version": "0.4.0",
+  "version": "0.4.1-next.0",
   "private": false,
   "publishConfig": {
     "registry": "https://registry.npmjs.org"
@@ -50,6 +50,14 @@
     {
       "name": "Kelly Harrop",
       "url": "https://github.com/kharrop"
+    },
+    {
+      "name": "Alejandro Fimbres",
+      "url": "https://github.com/lexfm"
+    },
+    {
+      "name": "Rafael Campos",
+      "url": "https://github.com/rafbcampos"
     }
   ]
 }

package/src/index.ts

@@ -272,17 +272,16 @@ export declare namespace Schema {
   /** A Node describes a specific object in the tree */
   export interface Node {
     /** Each property describes a property of the object */
-    [key: string]: DataType;
+    [key: string]: DataTypes;
   }
 
+  export type DataTypes = DataType | RecordType | ArrayType;
+
   /** Each prop in the object can have a specific DataType */
   export interface DataType<T = unknown> {
     /** The reference of the base type to use */
     type: string;
 
-    /** The referenced object represents an array rather than an object */
-    isArray?: boolean;
-
     /**
      * Any additional validations that are associated with this property
      * These will add to any base validations associated with the "type"
@@ -304,6 +303,23 @@ export declare namespace Schema {
     /** Any additional options */
     [key: string]: unknown;
   }
+  /** Determines if the Datatype is a record object */
+  export interface RecordType extends DataType {
+    /** boolean to define if its a record */
+    isRecord: boolean;
+
+    /** This property is mutually exclusive with RecordType and can not be used with ArrayType */
+    isArray?: never;
+  }
+
+  /** Determines if the DataType is an Array Object */
+  export interface ArrayType extends DataType {
+    /** boolean to define if its an array */
+    isArray: boolean;
+
+    /** This property is mutually exclusive with ArrayType and can not be used with RecordType */
+    isRecord?: never;
+  }
 }
 
 /** Namespace to wrap up core functionality to be used by the Language Service */
@@ -382,6 +398,15 @@ export declare namespace Validation {
     /** Where the error should be displayed */
     displayTarget?: DisplayTarget;
 
+    /**
+     * If the validation blocks navigation
+     * true/false - always/never block navigation
+     * once - only block navigation if the validation has not been triggered before
+     *
+     * @default - true for errors, 'once' for warnings
+     */
+    blocking?: boolean | 'once';
+
     /** Additional props to send down to a Validator */
     [key: string]: unknown;
   }