cddl 0.1.2 → 0.2.2

package/README.md

@@ -5,6 +5,9 @@ CDDL ![Test](https://github.com/christian-bromann/cddl/workflows/Test/badge.svg?
 
 CDDL expresses Concise Binary Object Representation (CBOR) data structures ([RFC 7049](https://tools.ietf.org/html/rfc7049)). Its main goal is to provide an easy and unambiguous way to express structures for protocol messages and data formats that use CBOR or JSON.
 
+There are also CDDL parser for other languages:
+- Rust: [anweiss/cddl](https://github.com/anweiss/cddl)
+
 __Note:__ this is __work in progress__, feel free to have a look at the code or contribute but don't use this for anything yet!
 
 ## Install
@@ -17,21 +20,35 @@ $ npm install cddl
 
 ## Using this package
 
-Currently you can use this package to parse a CDDL file into an [abstract syntax tree](https://en.wikipedia.org/wiki/Abstract_syntax_tree) (AST). For example you can run the following script:
-
-```js
-const fs = require('fs')
-const path = require('path')
+Currently you can use this package to parse a CDDL file into an [abstract syntax tree](https://en.wikipedia.org/wiki/Abstract_syntax_tree) (AST). For example, given the following CDDL file:
 
-const { Parser, Lexer } = require('cddl')
+```cddl
+person = {
+    identity,       ; an identity
+    employer: tstr, ; some employer
+}
+```
 
-const input = fs.readFileSync('./spec.cddl')
+You can use this package to parse the file into an abstract syntax tree (AST):
 
-const l = new Lexer(input)
-const parser = new Parser(l)
-console.log(JSON.stringify(parser.parse(), null, 4))
+```js
+const CDDL = require('cddl').default
+
+const ast = CDDL.parse('./spec.cddl')
+console.log(ast)
+/**
+ * outputs:
+ * [
+ *   {
+ *     Type: 'group',
+ *     Name: 'person',
+ *     Properties: [ [Object], [Object] ],
+ *     IsChoiceAddition: false
+ *   }
+ * ]
+ */
 ```
 
 ---
 
-If you are interested in this project, please feel free to contribute ideas or code patches. Have a look into our [contributing guidelines](https://github.com/christian-bromann/cddl/blob/master/LICENSE) to get started.
+If you are interested in this project, please feel free to contribute ideas or code patches. Have a look into our [contributing guidelines](https://github.com/christian-bromann/cddl/blob/master/LICENSE) to get started.

package/build/ast.d.ts

@@ -11,7 +11,8 @@
 export declare type Group = {
     Type: 'group';
     Name: string;
-    Properties: Property[];
+    IsChoiceAddition: boolean;
+    Properties: (Property | Property[])[];
 };
 /**
  * an array definition
@@ -24,7 +25,7 @@ export declare type Group = {
 export declare type Array = {
     Type: 'array';
     Name: string;
-    Values: Property[];
+    Values: (Property | Property[])[];
 };
 /**
  * a tag definition
@@ -45,6 +46,7 @@ export declare type Tag = {
 export declare type Variable = {
     Type: 'variable';
     Name: string;
+    IsChoiceAddition: boolean;
     PropertyType: PropertyType | PropertyType[];
 };
 /**
@@ -116,7 +118,7 @@ export declare type Range = {
 export declare type PropertyReferenceType = 'literal' | 'group' | 'group_array' | 'range' | 'tag';
 export declare type PropertyReference = {
     Type: PropertyReferenceType;
-    Value: string | number | Group | Array | Range | Tag;
+    Value: string | number | boolean | Group | Array | Range | Tag;
     Unwrapped: boolean;
 };
 export declare type Assignment = Group | Array | Variable | Comment;

package/build/ast.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ast.d.ts","sourceRoot":"","sources":["../src/ast.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,oBAAY,KAAK,GAAG;IAChB,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,QAAQ,EAAE,CAAC;CAC1B,CAAA;AAED;;;;;;;GAOG;AACH,oBAAY,KAAK,GAAG;IAChB,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,QAAQ,EAAE,CAAC;CACtB,CAAA;AAED;;;;;GAKG;AACH,oBAAY,GAAG,GAAG;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;CACpB,CAAA;AAED;;;;;GAKG;AACH,oBAAY,QAAQ,GAAG;IACnB,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,YAAY,GAAG,YAAY,EAAE,CAAC;CAC/C,CAAA;AAED;;;;;GAKG;AACH,oBAAY,OAAO,GAAG;IAClB,IAAI,EAAE,SAAS,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACnB,CAAA;AAED,oBAAY,UAAU,GAAG;IACrB,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;CACb,CAAA;AAED,oBAAY,QAAQ,GAAG;IACnB,MAAM,EAAE,OAAO,CAAC;IAChB,UAAU,EAAE,UAAU,CAAC;IACvB,IAAI,EAAE,YAAY,CAAC;IACnB,IAAI,EAAE,YAAY,GAAG,YAAY,EAAE,CAAC;IACpC,OAAO,EAAE,MAAM,CAAC;CACnB,CAAA;AAED,oBAAY,IAAI;IACZ;;OAEG;IAEH,IAAI,SAAS;IAEb;;OAEG;IAEH,GAAG,QAAQ;IAEX,IAAI,SAAS;IAEb,IAAI,SAAS;IAEb,KAAK,UAAU;IAEf,OAAO,YAAY;IAEnB,OAAO,YAAY;IAEnB,OAAO,YAAY;IAEnB;;OAEG;IAEH,IAAI,SAAS;IAEb,KAAK,UAAU;IAEf,IAAI,SAAS;IAEb,IAAI,SAAS;CAChB;AAED;;;;;;;;;;;;;;;GAeG;AACH,oBAAY,sBAAsB,GAAG,MAAM,GAAG,MAAM,CAAA;AAEpD,oBAAY,KAAK,GAAG;IAChB,GAAG,EAAE,sBAAsB,CAAC;IAC5B,GAAG,EAAE,sBAAsB,CAAC;IAC5B,SAAS,EAAE,OAAO,CAAA;CACrB,CAAA;AAED,oBAAY,qBAAqB,GAAG,SAAS,GAAG,OAAO,GAAG,aAAa,GAAG,OAAO,GAAG,KAAK,CAAA;AACzF,oBAAY,iBAAiB,GAAG;IAC5B,IAAI,EAAE,qBAAqB,CAAC;IAC5B,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,GAAG,CAAC;IACrD,SAAS,EAAE,OAAO,CAAC;CACtB,CAAA;AAED,oBAAY,UAAU,GAAG,KAAK,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,CAAC;AAC5D,oBAAY,YAAY,GAAG,UAAU,GAAG,KAAK,GAAG,iBAAiB,GAAG,MAAM,CAAA;AAC1E,oBAAY,YAAY,GAAG,MAAM,CAAA"}
+{"version":3,"file":"ast.d.ts","sourceRoot":"","sources":["../src/ast.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,oBAAY,KAAK,GAAG;IAChB,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,gBAAgB,EAAE,OAAO,CAAC;IAC1B,UAAU,EAAE,CAAC,QAAQ,GAAC,QAAQ,EAAE,CAAC,EAAE,CAAC;CACvC,CAAA;AAED;;;;;;;GAOG;AACH,oBAAY,KAAK,GAAG;IAChB,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,CAAC,QAAQ,GAAC,QAAQ,EAAE,CAAC,EAAE,CAAC;CACnC,CAAA;AAED;;;;;GAKG;AACH,oBAAY,GAAG,GAAG;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;CACpB,CAAA;AAED;;;;;GAKG;AACH,oBAAY,QAAQ,GAAG;IACnB,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,gBAAgB,EAAE,OAAO,CAAC;IAC1B,YAAY,EAAE,YAAY,GAAG,YAAY,EAAE,CAAC;CAC/C,CAAA;AAED;;;;;GAKG;AACH,oBAAY,OAAO,GAAG;IAClB,IAAI,EAAE,SAAS,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACnB,CAAA;AAED,oBAAY,UAAU,GAAG;IACrB,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;CACb,CAAA;AAED,oBAAY,QAAQ,GAAG;IACnB,MAAM,EAAE,OAAO,CAAC;IAChB,UAAU,EAAE,UAAU,CAAC;IACvB,IAAI,EAAE,YAAY,CAAC;IACnB,IAAI,EAAE,YAAY,GAAG,YAAY,EAAE,CAAC;IACpC,OAAO,EAAE,MAAM,CAAC;CACnB,CAAA;AAED,oBAAY,IAAI;IACZ;;OAEG;IAEH,IAAI,SAAS;IAEb;;OAEG;IAEH,GAAG,QAAQ;IAEX,IAAI,SAAS;IAEb,IAAI,SAAS;IAEb,KAAK,UAAU;IAEf,OAAO,YAAY;IAEnB,OAAO,YAAY;IAEnB,OAAO,YAAY;IAEnB;;OAEG;IAEH,IAAI,SAAS;IAEb,KAAK,UAAU;IAEf,IAAI,SAAS;IAEb,IAAI,SAAS;CAChB;AAED;;;;;;;;;;;;;;;GAeG;AACH,oBAAY,sBAAsB,GAAG,MAAM,GAAG,MAAM,CAAA;AAEpD,oBAAY,KAAK,GAAG;IAChB,GAAG,EAAE,sBAAsB,CAAC;IAC5B,GAAG,EAAE,sBAAsB,CAAC;IAC5B,SAAS,EAAE,OAAO,CAAA;CACrB,CAAA;AAED,oBAAY,qBAAqB,GAAG,SAAS,GAAG,OAAO,GAAG,aAAa,GAAG,OAAO,GAAG,KAAK,CAAA;AACzF,oBAAY,iBAAiB,GAAG;IAC5B,IAAI,EAAE,qBAAqB,CAAC;IAC5B,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,GAAG,CAAC;IAC/D,SAAS,EAAE,OAAO,CAAC;CACtB,CAAA;AAED,oBAAY,UAAU,GAAG,KAAK,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,CAAC;AAC5D,oBAAY,YAAY,GAAG,UAAU,GAAG,KAAK,GAAG,iBAAiB,GAAG,MAAM,CAAA;AAC1E,oBAAY,YAAY,GAAG,MAAM,CAAA"}

package/build/constants.d.ts

@@ -1,4 +1,5 @@
 export declare const WHITESPACE_CHARACTERS: string[];
+export declare const BOOLEAN_LITERALS: string[];
 /**
  * as defined in Appendix D
  * https://tools.ietf.org/html/draft-ietf-cbor-cddl-08#appendix-D

package/build/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,qBAAqB,UAA0B,CAAA;AAE5D;;;GAGG;AACH,eAAO,MAAM,qBAAqB,UAQjC,CAAA"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,qBAAqB,UAA0B,CAAA;AAC5D,eAAO,MAAM,gBAAgB,UAAoB,CAAA;AAEjD;;;GAGG;AACH,eAAO,MAAM,qBAAqB,UAQjC,CAAA"}

package/build/constants.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PREDEFINED_IDENTIFIER = exports.WHITESPACE_CHARACTERS = void 0;
+exports.PREDEFINED_IDENTIFIER = exports.BOOLEAN_LITERALS = exports.WHITESPACE_CHARACTERS = void 0;
 exports.WHITESPACE_CHARACTERS = [' ', '\t', '\n', '\r'];
+exports.BOOLEAN_LITERALS = ['true', 'false'];
 /**
  * as defined in Appendix D
  * https://tools.ietf.org/html/draft-ietf-cbor-cddl-08#appendix-D

package/build/parser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parser.d.ts","sourceRoot":"","sources":["../src/parser.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,SAAS,CAAA;AAC3B,OAAO,EAAE,KAAK,EAAU,MAAM,UAAU,CAAC;AAGzC,OAAO,EAE2C,UAAU,EAE3D,MAAM,OAAO,CAAA;AAKd,MAAM,CAAC,OAAO,OAAO,MAAM;IACvB,CAAC,EAAE,KAAK,CAAC;IAET,QAAQ,EAAE,KAAK,CAAa;IAC5B,SAAS,EAAE,KAAK,CAAa;gBAEhB,CAAC,EAAE,KAAK;IAOrB,OAAO,CAAC,SAAS;IAMjB,OAAO,CAAC,gBAAgB;IAYxB,OAAO,CAAC,oBAAoB;IAgL5B,OAAO,CAAC,wBAAwB;IAahC;;;;OAIG;IACH,OAAO,CAAC,WAAW;IAoBnB,OAAO,CAAC,iBAAiB;IAazB,OAAO,CAAC,iBAAiB;IAwGzB,OAAO,CAAC,kBAAkB;IAuB1B,OAAO,CAAC,gBAAgB;IA4DxB;;OAEG;IACH,OAAO,CAAC,YAAY;IAUpB,KAAK;CAsBR"}
+{"version":3,"file":"parser.d.ts","sourceRoot":"","sources":["../src/parser.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,SAAS,CAAA;AAE3B,OAAO,EAAE,KAAK,EAAU,MAAM,UAAU,CAAC;AAGzC,OAAO,EAE2C,UAAU,EAE3D,MAAM,OAAO,CAAA;AAKd,MAAM,CAAC,OAAO,OAAO,MAAM;IACvB,CAAC,EAAE,KAAK,CAAC;IAET,QAAQ,EAAE,KAAK,CAAa;IAC5B,SAAS,EAAE,KAAK,CAAa;gBAEhB,CAAC,EAAE,KAAK;IAOrB,OAAO,CAAC,SAAS;IAMjB,OAAO,CAAC,gBAAgB;IA8BxB,OAAO,CAAC,oBAAoB;IA4O5B,OAAO,CAAC,wBAAwB;IAahC;;;;OAIG;IACH,OAAO,CAAC,WAAW;IAoBnB,OAAO,CAAC,iBAAiB;IAazB,OAAO,CAAC,iBAAiB;IA8GzB,OAAO,CAAC,kBAAkB;IAwC1B,OAAO,CAAC,gBAAgB;IA4DxB;;OAEG;IACH,OAAO,CAAC,YAAY;IAUpB,KAAK;CAsBR"}

package/build/parser.js

@@ -20,16 +20,32 @@ class Parser {
         return true;
     }
     parseAssignments() {
-        if (this.curToken.Type !== tokens_1.Tokens.IDENT && this.peekToken.Type !== tokens_1.Tokens.ASSIGN) {
+        /**
+         * expect group identifier, e.g.
+         * groupName =
+         * groupName /=
+         * groupName //=
+         */
+        if (this.curToken.Type !== tokens_1.Tokens.IDENT || !(this.peekToken.Type === tokens_1.Tokens.ASSIGN || this.peekToken.Type === tokens_1.Tokens.SLASH)) {
             throw new Error(`group identifier expected, received "${JSON.stringify(this.curToken)}"`);
         }
+        let isChoiceAddition = false;
         const groupName = this.curToken.Literal;
         this.nextToken(); // eat group identifier
+        // @ts-ignore
+        if (this.curToken.Type === tokens_1.Tokens.SLASH) {
+            isChoiceAddition = true;
+            this.nextToken(); // eat `/`
+        }
+        // @ts-ignore
+        if (this.curToken.Type === tokens_1.Tokens.SLASH) {
+            this.nextToken(); // eat `/`
+        }
         this.nextToken(); // eat `=`
-        return this.parseAssignmentValue(groupName);
+        return this.parseAssignmentValue(groupName, isChoiceAddition);
     }
-    parseAssignmentValue(groupName) {
-        let assignment;
+    parseAssignmentValue(groupName, isChoiceAddition = false) {
+        let isChoice = false;
         const valuesOrProperties = [];
         const closingTokens = this.openSegment();
         /**
@@ -41,11 +57,12 @@ class Parser {
                 const variable = {
                     Type: 'variable',
                     Name: groupName,
+                    IsChoiceAddition: isChoiceAddition,
                     PropertyType: this.parsePropertyTypes()
                 };
                 return variable;
             }
-            return this.parsePropertyType();
+            return this.parsePropertyTypes();
         }
         while (!closingTokens.includes(this.curToken.Type)) {
             const propertyType = [];
@@ -114,49 +131,105 @@ class Parser {
                     this.nextToken(); // eat ^
                 }
             }
+            /**
+             * check if we have a choice instead of an assignment
+             */
+            if (this.curToken.Type === tokens_1.Tokens.SLASH && this.peekToken.Type === tokens_1.Tokens.SLASH) {
+                const prop = {
+                    HasCut: hasCut,
+                    Occurrence: occurrence,
+                    Name: '',
+                    Type: {
+                        Type: "group",
+                        Value: propertyName,
+                        Unwrapped: isUnwrapped
+                    },
+                    Comment: comment
+                };
+                if (isChoice) {
+                    /**
+                     * if we already in a choice just push into it
+                     */
+                    valuesOrProperties[valuesOrProperties.length - 1].push(prop);
+                }
+                else {
+                    /**
+                     * otherwise create a new one
+                     */
+                    isChoice = true;
+                    valuesOrProperties.push([prop]);
+                }
+                this.nextToken(); // eat /
+                this.nextToken(); // eat /
+                continue;
+            }
             /**
              * else if no colon was found, throw
              */
             if (!this.isPropertyValueSeparator()) {
-                throw new Error('Expected ":" or "=>');
+                throw new Error('Expected ":" or "=>"');
             }
-            this.nextToken();
+            this.nextToken(); // eat :
             /**
              * parse property value
              */
-            propertyType.push(this.parseAssignmentValue());
-            this.nextToken();
-            /**
-             * continue parse possible other types (e.g. `float / tstr / int`)
-             */
-            propertyType.push(...this.parsePropertyTypes(true));
+            const props = this.parseAssignmentValue();
+            if (Array.isArray(props)) {
+                /**
+                 * property has multiple types (e.g. `float / tstr / int`)
+                 */
+                propertyType.push(...props);
+            }
+            else {
+                propertyType.push(props);
+            }
             /**
              * advance comma
              */
-            // @ts-ignore
+            let flipIsChoice = false;
             if (this.curToken.Type === tokens_1.Tokens.COMMA) {
-                this.nextToken();
+                /**
+                 * if we are in a choice, we leave it here
+                 */
+                flipIsChoice = true;
+                this.nextToken(); // eat ,
             }
             comment = this.parseComment();
-            valuesOrProperties.push({
+            const prop = {
                 HasCut: hasCut,
                 Occurrence: occurrence,
                 Name: propertyName,
                 Type: propertyType,
                 Comment: comment
-            });
+            };
+            if (isChoice) {
+                valuesOrProperties[valuesOrProperties.length - 1].push(prop);
+            }
+            else {
+                valuesOrProperties.push(prop);
+            }
+            if (flipIsChoice) {
+                isChoice = false;
+            }
             /**
              * if `}` is found we are at the end of the group
              */
-            // @ts-ignore
             if (closingTokens.includes(this.curToken.Type)) {
                 break;
             }
+            /**
+             * eat // if we are in a choice
+             */
+            if (isChoice) {
+                this.nextToken(); // eat /
+                this.nextToken(); // eat /
+                continue;
+            }
         }
         /**
          * close segment
          */
-        while (this.curToken.Type === [...closingTokens].shift()) {
+        if (this.curToken.Type === [...closingTokens].shift()) {
             this.nextToken();
         }
         /**
@@ -175,7 +248,8 @@ class Parser {
         return {
             Type: 'group',
             Name: groupName || '',
-            Properties: valuesOrProperties
+            Properties: valuesOrProperties,
+            IsChoiceAddition: isChoiceAddition
         };
     }
     isPropertyValueSeparator() {
@@ -249,7 +323,14 @@ class Parser {
                 type = this.curToken.Literal;
                 break;
             default: {
-                if (this.curToken.Type === tokens_1.Tokens.IDENT) {
+                if (constants_1.BOOLEAN_LITERALS.includes(this.curToken.Literal)) {
+                    type = {
+                        Type: 'literal',
+                        Value: this.curToken.Literal === 'true',
+                        Unwrapped: isUnwrapped
+                    };
+                }
+                else if (this.curToken.Type === tokens_1.Tokens.IDENT) {
                     type = {
                         Type: 'group',
                         Value: this.curToken.Literal,
@@ -322,14 +403,19 @@ class Parser {
         }
         return type;
     }
-    parsePropertyTypes(parseFromWithin) {
+    parsePropertyTypes() {
         const propertyTypes = [];
+        propertyTypes.push(this.parsePropertyType());
+        this.nextToken(); // eat `/`
         /**
-         * if the first part of the property was parsed skip this step
+         * ensure we don't go into the next choice, e.g.:
+         * ```
+         * delivery = (
+         *   city // lala: tstr / bool // per-pickup: true,
+         * )
          */
-        if (!parseFromWithin) {
-            propertyTypes.push(this.parsePropertyType());
-            this.nextToken(); // eat `/`
+        if (this.curToken.Type === tokens_1.Tokens.SLASH && this.peekToken.Type === tokens_1.Tokens.SLASH) {
+            return propertyTypes;
         }
         /**
          * capture more if available (e.g. `tstr / float / boolean`)
@@ -338,6 +424,16 @@ class Parser {
             this.nextToken(); // eat `/`
             propertyTypes.push(this.parsePropertyType());
             this.nextToken();
+            /**
+             * ensure we don't go into the next choice, e.g.:
+             * ```
+             * delivery = (
+             *   city // lala: tstr / bool // per-pickup: true,
+             * )
+             */
+            if (this.curToken.Type === tokens_1.Tokens.SLASH && this.peekToken.Type === tokens_1.Tokens.SLASH) {
+                break;
+            }
         }
         return propertyTypes;
     }

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "cddl",
-  "version": "0.1.2",
+  "version": "0.2.2",
   "description": "Concise data definition language (RFC 8610) implementation and JSON validator in Node.js",
-  "main": "index.js",
+  "main": "build/index.js",
   "bin": {
     "cddl": "./bin/cddl.js"
   },