cnd-parser

• Latest Release:
• Build-Status:

cnd-parser is copyright 2015 by DracoBlue http://dracoblue.net

What is cnd-parser?

This is a small (nodejs/browserify) library for parsing CND-Strings (defined in jsr-170 and explained at jackrabbit).

This implementation doesn't support the full CND-syntax.

Limitations

• constraints and default values are not supported
• each property and childnode needs to be defined on one row
• shortcuts (like m for multiple) are not supported
• the library does no validation for nodetype, property or childnode options

Example

This example:

1<ns = 'http://namespace.com/ns'>
2[ns:NodeType] > ns:ParentType1, ns:ParentType2
3  orderable mixin
4  - ex:property (string) primary mandatory autocreated protected multiple version
5  + ns:node (ns:reqType1, ns:reqType2) mandatory autocreated protected multiple version
6[nt:resource] > mix:referenceable
7  - jcr:encoding
8  - jcr:mimeType mandatory
9  - jcr:data (binary) mandatory
10  - jcr:lastModified (date) mandatory ignore

can be parsed (in nodejs) like this:

1cnd = cndParser.parseString('/* string here! */');
2console.log(JSON.stringify(cnd.getNodeTypes(), null, 4));

Output:

1[
2    {
3        "options": {
4            "orderable": true,
5            "mixin": true
6        },
7        "properties": [
8            {
9                "options": {
10                    "primary": true,
11                    "mandatory": true,
12                    "autocreated": true,
13                    "protected": true,
14                    "multiple": true,
15                    "version": true
16                },
17                "namespacedName": "ex:property",
18                "localName": "property",
19                "namespace": "ex",
20                "types": [
21                    "string"
22                ]
23            }
24        ],
25        "childNodes": [
26            {
27                "options": {
28                    "mandatory": true,
29                    "autocreated": true,
30                    "protected": true,
31                    "multiple": true,
32                    "version": true
33                },
34                "namespacedName": "ns:node",
35                "localName": "node",
36                "namespace": "ns",
37                "types": [
38                    "ns:reqType1",
39                    "ns:reqType2"
40                ]
41            }
42        ],
43        "namespacedName": "ns:NodeType",
44        "localName": "NodeType",
45        "namespace": "ns",
46        "superTypes": [
47            "ns:ParentType1",
48            "ns:ParentType2"
49        ]
50    },
51    {
52        "options": {},
53        "properties": [
54            {
55                "options": {},
56                "namespacedName": "jcr:encoding",
57                "localName": "encoding",
58                "namespace": "jcr"
59            },
60            {
61                "options": {
62                    "mandatory": true
63                },
64                "namespacedName": "jcr:mimeType",
65                "localName": "mimeType",
66                "namespace": "jcr"
67            },
68            {
69                "options": {
70                    "mandatory": true
71                },
72                "namespacedName": "jcr:data",
73                "localName": "data",
74                "namespace": "jcr",
75                "types": [
76                    "binary"
77                ]
78            },
79            {
80                "options": {
81                    "mandatory": true,
82                    "ignore": true
83                },
84                "namespacedName": "jcr:lastModified",
85                "localName": "lastModified",
86                "namespace": "jcr",
87                "types": [
88                    "date"
89                ]
90            }
91        ],
92        "childNodes": [],
93        "namespacedName": "nt:resource",
94        "localName": "resource",
95        "namespace": "nt",
96        "superTypes": [
97            "mix:referenceable"
98        ]
99    }
100]

License

The cnd-parser project is licensed under the MIT License. See LICENSE for more information.