shel-neos-schema 1.1.1 → 1.2.0

package/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Sebastian Helzle
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/NodeTypes.Schema.json

@@ -22,6 +22,9 @@
             "properties": {
                 "message": {
                     "type": "string"
+                },
+                "thumbnail": {
+                    "type": "string"
                 }
             }
         },
@@ -1548,6 +1551,35 @@
                     "$ref": "#/definitions/defaultValueValidation"
                 }
             },
+            "references": {
+                "description": "References to other nodes. Since Neos 9.0, this is the recommended way to define reference properties. The old way using `properties` with type `reference` or `references` is still supported for backwards compatibility, but it is recommended to switch to this new syntax.",
+                "type": [
+                    "object",
+                    "null"
+                ],
+                "additionalProperties": {
+                    "type": "object",
+                    "additionalProperties": false,
+                    "properties": {
+                        "options": {
+                            "type": "object",
+                            "additionalProperties": true,
+                            "properties": {
+                                "preset": {
+                                    "type": "string"
+                                }
+                            }
+                        },
+                        "ui": {
+                            "$ref": "#/definitions/propertyUIOptions"
+                        },
+                        "validation": {
+                            "$ref": "#/definitions/validation"
+                        }
+                    },
+                    "$ref": "#/definitions/defaultValueValidation"
+                }
+            },
             "ui": {
                 "type": "object",
                 "additionalProperties": false,

package/Readme.md

@@ -202,3 +202,16 @@ If you know how to use the schema in other editors, please provide a PR with the
 
 If you have ideas on how to improve the schema, please provide an issue with an example, and a
 PR that would resolve the issue if you can.
+
+## Release
+
+Run
+
+```console
+npm version <major|minor|patch>
+npm publish
+```
+
+## License
+
+See [LICENSE](LICENSE.txt) file.

package/examples/NodeTypes.Simple.yaml

@@ -14,6 +14,9 @@ My.Vendor:Content.Text:
       options:
         someCustomOption: true
       ui:
+        help:
+          message: 'Explanation about this text property'
+          thumbnail: 'resource://My.Site/Private/Images/helpThumbnail.png'
         inlineEditable: true
         inspector:
           editor: Neos.Neos/Inspector/Editors/TextFieldEditor

package/examples/NodeTypes.WithChildren.yaml

@@ -1,4 +1,4 @@
-My.Vendor:Document.Simple:
+My.Vendor:Document.WithChildren:
   superTypes:
     Neos.Neos:Document: true
   childNodes:

package/examples/NodeTypes.WithReferences.yaml

@@ -0,0 +1,12 @@
+My.Vendor:Document.WithReferences:
+  superTypes:
+    Neos.Neos:Document: true
+  references:
+    myReference:
+      ui:
+        label: 'My reference'
+        inspector:
+          group: default
+          editorOptions:
+            nodeTypes:
+              - Neos.Neos:Document

package/examples/NodeTypes.WithTemplate.yaml

@@ -1,5 +1,5 @@
 # Example taken from https://github.com/Flowpack/Flowpack.NodeTemplates
-Neos.NodeTypes:Page:
+Neos.NodeTypes:Document.WithTemplate:
   ui:
     creationDialog:
       elements:

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "shel-neos-schema",
     "description": "A tool to validate Neos YAML schema files like nodetypes and other configuration",
-    "version": "1.1.1",
+    "version": "1.2.0",
     "main": "bin/validate.js",
     "author": "Sebastian Helzle <sebastian@helzle.it>",
     "license": "MIT",
@@ -24,9 +24,9 @@
         "validate": "bin/validate.js"
     },
     "dependencies": {
-        "ajv": "^8.0.5",
-        "js-yaml": "^4.0.0",
-        "yargs": "^17.7.2"
+        "ajv": "^8.17.1",
+        "js-yaml": "^4.1.1",
+        "yargs": "^18.0.0"
     },
     "packageManager": "yarn@4.6.0"
 }