cddl 0.6.0 → 0.8.0

package/.editorconfig

@@ -0,0 +1,18 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+
+indent_style = space
+indent_size = 4
+
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[{.travis.yml,**/*.json,.github/**/*.yml}]
+indent_size = 2

package/README.md

@@ -20,7 +20,20 @@ $ 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, given the following CDDL file:
+This package exposes a CLI as well as a programmatic interface for parsing and transforming CDDL.
+
+### CLI
+
+The `cddl` CLI offers a `validate` command that helps identify invalid CDDL formats, e.g.:
+
+```sh
+npx cddl validate ./path/to/interface.cddl
+✅ Valid CDDL file!
+```
+
+### Programmatic Interface
+
+You can also 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:
 
 ```cddl
 person = {
@@ -29,7 +42,7 @@ person = {
 }
 ```
 
-You can use this package to parse the file into an abstract syntax tree (AST):
+It parses the content into an AST:
 
 ```js
 import { parse } from 'cddl'
@@ -49,6 +62,8 @@ console.log(ast)
  */
 ```
 
+The CDDL AST is defined in [source files](./src/ast.ts). The `parse` method returns `Assignment[]`.
+
 ---
 
 If you are interested in this project, please feel free to contribute ideas or code patches. Have a look at our [contributing](https://github.com/christian-bromann/cddl/blob/master/LICENSE) guidelines](https://github.com/christian-bromann/cddl/blob/master/LICENSE) to get started.

package/build/ast.d.ts

@@ -13,6 +13,7 @@ export type Group = {
     Name: string;
     IsChoiceAddition: boolean;
     Properties: (Property | Property[])[];
+    Comments: Comment[];
 };
 /**
  * an array definition
@@ -26,6 +27,7 @@ export type Array = {
     Type: 'array';
     Name: string;
     Values: (Property | Property[])[];
+    Comments: Comment[];
 };
 /**
  * a tag definition
@@ -49,6 +51,7 @@ export type Variable = {
     IsChoiceAddition: boolean;
     PropertyType: PropertyType | PropertyType[];
     Operator?: Operator;
+    Comments: Comment[];
 };
 /**
  * a comment statement
@@ -59,6 +62,7 @@ export type Variable = {
 export type Comment = {
     Type: 'comment';
     Content: string;
+    Leading: boolean;
 };
 export type Occurrence = {
     n: number;
@@ -69,7 +73,7 @@ export type Property = {
     Occurrence: Occurrence;
     Name: PropertyName;
     Type: PropertyType | PropertyType[];
-    Comment: string;
+    Comments: Comment[];
     Operator?: Operator;
 };
 export declare enum Type {
@@ -93,7 +97,12 @@ export declare enum Type {
     BSTR = "bstr",
     BYTES = "bytes",
     TSTR = "tstr",
-    TEXT = "text"
+    TEXT = "text",
+    /**
+     * null types
+     */
+    NIL = "nil",
+    NULL = "null"
 }
 /**
  * can be a number, e.g. "foo = 0..10"
@@ -122,7 +131,7 @@ export interface Operator {
     Type: OperatorType;
     Value: PropertyType;
 }
-export type PropertyReferenceType = 'literal' | 'group' | 'group_array' | 'range' | 'tag';
+export type PropertyReferenceType = 'literal' | 'group' | 'group_array' | 'array' | 'range' | 'tag';
 export type PropertyReference = {
     Type: PropertyReferenceType;
     Value: string | number | boolean | Group | Array | Range | Tag;
@@ -130,10 +139,10 @@ export type PropertyReference = {
     Operator?: Operator;
 };
 export interface NativeTypeWithOperator {
-    Type: Type;
+    Type: Type | PropertyReference;
     Operator?: Operator;
 }
-export type Assignment = Group | Array | Variable | Comment;
+export type Assignment = Group | Array | Variable;
 export type PropertyType = Assignment | Array | PropertyReference | string | NativeTypeWithOperator;
 export type PropertyName = string;
 //# sourceMappingURL=ast.d.ts.map

package/build/ast.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ast.d.ts","sourceRoot":"","sources":["../src/ast.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,MAAM,MAAM,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,MAAM,MAAM,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,MAAM,MAAM,GAAG,GAAG;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;CACpB,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,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;IAC5C,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACvB,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,OAAO,GAAG;IAClB,IAAI,EAAE,SAAS,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACnB,CAAA;AAED,MAAM,MAAM,UAAU,GAAG;IACrB,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;CACb,CAAA;AAED,MAAM,MAAM,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;IAChB,QAAQ,CAAC,EAAE,QAAQ,CAAA;CACtB,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,MAAM,MAAM,sBAAsB,GAAG,MAAM,GAAG,MAAM,CAAA;AAEpD,MAAM,MAAM,KAAK,GAAG;IAChB,GAAG,EAAE,sBAAsB,CAAC;IAC5B,GAAG,EAAE,sBAAsB,CAAC;IAC5B,SAAS,EAAE,OAAO,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAA;AAC9H,MAAM,WAAW,QAAQ;IACrB,IAAI,EAAE,YAAY,CAAC;IACnB,KAAK,EAAE,YAAY,CAAA;CACtB;AAED,MAAM,MAAM,qBAAqB,GAAG,SAAS,GAAG,OAAO,GAAG,aAAa,GAAG,OAAO,GAAG,KAAK,CAAA;AACzF,MAAM,MAAM,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;IACnB,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACvB,CAAA;AAED,MAAM,WAAW,sBAAsB;IACnC,IAAI,EAAE,IAAI,CAAA;IACV,QAAQ,CAAC,EAAE,QAAQ,CAAA;CACtB;AAED,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,CAAC;AAC5D,MAAM,MAAM,YAAY,GAAG,UAAU,GAAG,KAAK,GAAG,iBAAiB,GAAG,MAAM,GAAG,sBAAsB,CAAA;AACnG,MAAM,MAAM,YAAY,GAAG,MAAM,CAAA"}
+{"version":3,"file":"ast.d.ts","sourceRoot":"","sources":["../src/ast.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,MAAM,MAAM,KAAK,GAAG;IAChB,IAAI,EAAE,OAAO,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,gBAAgB,EAAE,OAAO,CAAA;IACzB,UAAU,EAAE,CAAC,QAAQ,GAAC,QAAQ,EAAE,CAAC,EAAE,CAAA;IACnC,QAAQ,EAAE,OAAO,EAAE,CAAA;CACtB,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,KAAK,GAAG;IAChB,IAAI,EAAE,OAAO,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,CAAC,QAAQ,GAAC,QAAQ,EAAE,CAAC,EAAE,CAAA;IAC/B,QAAQ,EAAE,OAAO,EAAE,CAAA;CACtB,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,GAAG,GAAG;IACd,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,EAAE,MAAM,CAAA;CACnB,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,GAAG;IACnB,IAAI,EAAE,UAAU,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,gBAAgB,EAAE,OAAO,CAAA;IACzB,YAAY,EAAE,YAAY,GAAG,YAAY,EAAE,CAAA;IAC3C,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,QAAQ,EAAE,OAAO,EAAE,CAAA;CACtB,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,OAAO,GAAG;IAClB,IAAI,EAAE,SAAS,CAAA;IACf,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,OAAO,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,UAAU,GAAG;IACrB,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACnB,MAAM,EAAE,OAAO,CAAA;IACf,UAAU,EAAE,UAAU,CAAA;IACtB,IAAI,EAAE,YAAY,CAAA;IAClB,IAAI,EAAE,YAAY,GAAG,YAAY,EAAE,CAAA;IACnC,QAAQ,EAAE,OAAO,EAAE,CAAA;IACnB,QAAQ,CAAC,EAAE,QAAQ,CAAA;CACtB,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;IAEb;;OAEG;IACH,GAAG,QAAQ;IACX,IAAI,SAAS;CAChB;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,GAAG,MAAM,CAAA;AAEpD,MAAM,MAAM,KAAK,GAAG;IAChB,GAAG,EAAE,sBAAsB,CAAA;IAC3B,GAAG,EAAE,sBAAsB,CAAA;IAC3B,SAAS,EAAE,OAAO,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAA;AAC9H,MAAM,WAAW,QAAQ;IACrB,IAAI,EAAE,YAAY,CAAA;IAClB,KAAK,EAAE,YAAY,CAAA;CACtB;AAED,MAAM,MAAM,qBAAqB,GAAG,SAAS,GAAG,OAAO,GAAG,aAAa,GAAG,OAAO,GAAG,OAAO,GAAG,KAAK,CAAA;AACnG,MAAM,MAAM,iBAAiB,GAAG;IAC5B,IAAI,EAAE,qBAAqB,CAAA;IAC3B,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,GAAG,CAAA;IAC9D,SAAS,EAAE,OAAO,CAAA;IAClB,QAAQ,CAAC,EAAE,QAAQ,CAAA;CACtB,CAAA;AAED,MAAM,WAAW,sBAAsB;IACnC,IAAI,EAAE,IAAI,GAAG,iBAAiB,CAAA;IAC9B,QAAQ,CAAC,EAAE,QAAQ,CAAA;CACtB;AAED,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,KAAK,GAAG,QAAQ,CAAA;AACjD,MAAM,MAAM,YAAY,GAAG,UAAU,GAAG,KAAK,GAAG,iBAAiB,GAAG,MAAM,GAAG,sBAAsB,CAAA;AACnG,MAAM,MAAM,YAAY,GAAG,MAAM,CAAA"}

package/build/ast.js

@@ -33,4 +33,9 @@ export var Type;
     Type["TSTR"] = "tstr";
     // Text string (major type 3)
     Type["TEXT"] = "text";
+    /**
+     * null types
+     */
+    Type["NIL"] = "nil";
+    Type["NULL"] = "null";
 })(Type || (Type = {}));

package/build/cli/commands/validate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../../../src/cli/commands/validate.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAA;AAMrD,UAAU,iBAAiB;IACvB,QAAQ,EAAE,MAAM,CAAA;CACnB;AAED,eAAO,MAAM,OAAO,wBAAwB,CAAA;AAC5C,eAAO,MAAM,IAAI,2BAA2B,CAAA;AAC5C,eAAO,MAAM,OAAO,UAAW,KAAK,EAAE,CAAC,aAItC,CAAA;AAED,eAAO,MAAM,OAAO,SAAU,mBAAmB,iBAAiB,CAAC,cAuBlE,CAAA"}
+{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../../../src/cli/commands/validate.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAA;AAKrD,UAAU,iBAAiB;IACvB,QAAQ,EAAE,MAAM,CAAA;CACnB;AAED,eAAO,MAAM,OAAO,wBAAwB,CAAA;AAC5C,eAAO,MAAM,IAAI,2BAA2B,CAAA;AAC5C,eAAO,MAAM,OAAO,UAAW,KAAK,EAAE,CAAC,aAItC,CAAA;AAED,eAAO,MAAM,OAAO,SAAU,mBAAmB,iBAAiB,CAAC,cAuBlE,CAAA"}

package/build/cli/commands/validate.js

@@ -1,8 +1,7 @@
 import fs from 'node:fs';
 import path from 'node:path';
 import { CLI_EPILOGUE } from '../constants.js';
-import { ParseTargets } from '../../constants.js';
-import CDDL from '../../index.js';
+import { parse } from '../../index.js';
 export const command = 'validate <filePath>';
 export const desc = 'Validate a *.cddl file';
 export const builder = (yargs) => {
@@ -19,7 +18,7 @@ export const handler = (argv) => {
         return process.exit(1);
     }
     try {
-        CDDL.parse(filePath, { target: ParseTargets.AST });
+        parse(filePath);
         /**
          * ToDo check for
          *  - missing group declarations

package/build/constants.d.ts

@@ -5,8 +5,4 @@ export declare const BOOLEAN_LITERALS: string[];
  * https://tools.ietf.org/html/draft-ietf-cbor-cddl-08#appendix-D
  */
 export declare const PREDEFINED_IDENTIFIER: string[];
-export declare enum ParseTargets {
-    AST = "ast",
-    TS = "ts"
-}
 //# sourceMappingURL=constants.d.ts.map

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;AAC5D,eAAO,MAAM,gBAAgB,UAAoB,CAAA;AAEjD;;;GAGG;AACH,eAAO,MAAM,qBAAqB,UAQjC,CAAA;AAED,oBAAY,YAAY;IACpB,GAAG,QAAQ;IACX,EAAE,OAAO;CACZ"}
+{"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

@@ -13,8 +13,3 @@ export const PREDEFINED_IDENTIFIER = [
     'float32', 'float64', 'float16-32', 'float32-64', 'float',
     'false', 'true', 'bool', 'nil', 'null', 'undefined'
 ];
-export var ParseTargets;
-(function (ParseTargets) {
-    ParseTargets["AST"] = "ast";
-    ParseTargets["TS"] = "ts";
-})(ParseTargets || (ParseTargets = {}));

package/build/index.d.ts

@@ -1,10 +1,9 @@
 import Lexer from './lexer.js';
 import Parser from './parser.js';
-import { ParseTargets } from './constants.js';
-import type { ParseOptions } from './types.js';
+export declare function parse(filePath: string): import("./ast.js").Assignment[];
 declare const _default: {
-    parse: (filePath: string, opts: ParseOptions) => string | import("./ast.js").Assignment[];
+    parse: typeof parse;
 };
 export default _default;
-export { Lexer, Parser, ParseTargets };
+export { Lexer, Parser };
 //# sourceMappingURL=index.d.ts.map

package/build/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,YAAY,CAAA;AAC9B,OAAO,MAAM,MAAM,aAAa,CAAA;AAGhC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;;sBAGxB,MAAM,QAAQ,YAAY;;AADhD,wBAcC;AAED,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,YAAY,CAAA;AAC9B,OAAO,MAAM,MAAM,aAAa,CAAA;AAEhC,wBAAgB,KAAK,CAAE,QAAQ,EAAE,MAAM,mCAGtC;;;;AAED,wBAAwB;AACxB,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,CAAA"}

package/build/index.js

@@ -1,18 +1,8 @@
 import Lexer from './lexer.js';
 import Parser from './parser.js';
-import { transform as transformTS } from './transform/ts.js';
-import { ParseTargets } from './constants.js';
-export default {
-    parse: (filePath, opts) => {
-        const parser = new Parser(filePath);
-        const ast = parser.parse();
-        if (opts.target === ParseTargets.AST) {
-            return ast;
-        }
-        if (opts.target === ParseTargets.TS) {
-            return transformTS(ast);
-        }
-        throw new Error(`Unsupported parse target: "${opts.target || 'undefined'}"`);
-    }
-};
-export { Lexer, Parser, ParseTargets };
+export function parse(filePath) {
+    const parser = new Parser(filePath);
+    return parser.parse();
+}
+export default { parse };
+export { Lexer, Parser };

package/build/parser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parser.d.ts","sourceRoot":"","sources":["../src/parser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,MAAM,YAAY,CAAA;AAE9B,OAAO,EAAE,KAAK,EAAU,MAAM,aAAa,CAAC;AAG5C,OAAO,EAE2C,UAAU,EAE3D,MAAM,UAAU,CAAA;AAoBjB,MAAM,CAAC,OAAO,OAAO,MAAM;;IAEvB,CAAC,EAAE,KAAK,CAAC;IAET,QAAQ,EAAE,KAAK,CAAa;IAC5B,SAAS,EAAE,KAAK,CAAa;gBAEhB,QAAQ,EAAE,MAAM;IAQ7B,OAAO,CAAC,SAAS;IAMjB,OAAO,CAAC,gBAAgB;IA8BxB,OAAO,CAAC,oBAAoB;IAyW5B,OAAO,CAAC,wBAAwB;IAahC;;;;OAIG;IACH,OAAO,CAAC,WAAW;IAoBnB,OAAO,CAAC,iBAAiB;IAazB,OAAO,CAAC,iBAAiB;IA2HzB,OAAO,CAAC,aAAa;IAgBrB,OAAO,CAAC,UAAU;IAIlB,OAAO,CAAC,kBAAkB;IAiD1B,OAAO,CAAC,gBAAgB;IA4DxB;;OAEG;IACH,OAAO,CAAC,YAAY;IAUpB,KAAK;IAuBL,OAAO,CAAC,WAAW;CAKtB"}
+{"version":3,"file":"parser.d.ts","sourceRoot":"","sources":["../src/parser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,MAAM,YAAY,CAAA;AAE9B,OAAO,EAAE,KAAK,EAAU,MAAM,aAAa,CAAC;AAG5C,OAAO,EAE2C,UAAU,EAE3D,MAAM,UAAU,CAAA;AAoBjB,MAAM,CAAC,OAAO,OAAO,MAAM;;IAEvB,CAAC,EAAE,KAAK,CAAC;IAET,QAAQ,EAAE,KAAK,CAAa;IAC5B,SAAS,EAAE,KAAK,CAAa;gBAEhB,QAAQ,EAAE,MAAM;IAQ7B,OAAO,CAAC,SAAS;IAMjB,OAAO,CAAC,gBAAgB;IA2CxB,OAAO,CAAC,oBAAoB;IA6Y5B,OAAO,CAAC,wBAAwB;IAahC;;;;OAIG;IACH,OAAO,CAAC,WAAW;IAoBnB,OAAO,CAAC,iBAAiB;IAazB,OAAO,CAAC,iBAAiB;IA6HzB,OAAO,CAAC,aAAa;IAgBrB,OAAO,CAAC,UAAU;IAIlB,OAAO,CAAC,kBAAkB;IAiD1B,OAAO,CAAC,gBAAgB;IA4DxB;;OAEG;IACH,OAAO,CAAC,YAAY;IAcpB,KAAK;IAaL,OAAO,CAAC,WAAW;CAKtB"}

package/build/parser.js

@@ -38,6 +38,10 @@ export default class Parser {
         return true;
     }
     parseAssignments() {
+        const comments = [];
+        while (this.curToken.Type === Tokens.COMMENT) {
+            comments.push(this.parseComment());
+        }
         /**
          * expect group identifier, e.g.
          * groupName =
@@ -60,7 +64,14 @@ export default class Parser {
             this.nextToken(); // eat `/`
         }
         this.nextToken(); // eat `=`
-        return this.parseAssignmentValue(groupName, isChoiceAddition);
+        const assignmentValue = this.parseAssignmentValue(groupName, isChoiceAddition);
+        // @ts-expect-error curToken can be changed by now but TS doesn't understand this
+        while (this.curToken.Type === Tokens.COMMENT) {
+            const comment = this.parseComment();
+            comment && comments.push(comment);
+        }
+        assignmentValue.Comments = comments;
+        return assignmentValue;
     }
     parseAssignmentValue(groupName, isChoiceAddition = false) {
         let isChoice = false;
@@ -79,7 +90,8 @@ export default class Parser {
                     Type: 'variable',
                     Name: groupName,
                     IsChoiceAddition: isChoiceAddition,
-                    PropertyType: this.parsePropertyTypes()
+                    PropertyType: this.parsePropertyTypes(),
+                    Comments: []
                 };
                 return variable;
             }
@@ -116,7 +128,8 @@ export default class Parser {
                     Type: 'variable',
                     Name: groupName,
                     IsChoiceAddition: isChoiceAddition,
-                    PropertyType: propertyType
+                    PropertyType: propertyType,
+                    Comments: []
                 };
                 if (this.isOperator()) {
                     variable.Operator = this.parseOperator();
@@ -140,7 +153,8 @@ export default class Parser {
                     Name: groupName,
                     IsChoiceAddition: isChoiceAddition,
                     PropertyType: prop,
-                    Operator: this.parseOperator()
+                    Operator: this.parseOperator(),
+                    Comments: []
                 };
                 return variable;
             }
@@ -148,10 +162,12 @@ export default class Parser {
         }
         while (!closingTokens.includes(this.curToken.Type)) {
             const propertyType = [];
+            const comments = [];
             let isUnwrapped = false;
             let hasCut = false;
             let propertyName = '';
-            let comment = '';
+            const leadingComment = this.parseComment(true);
+            leadingComment && comments.push(leadingComment);
             const occurrence = this.parseOccurrences();
             /**
              * check if variable name is unwrapped
@@ -184,7 +200,7 @@ export default class Parser {
                     Occurrence: occurrence,
                     Name: '',
                     Type: innerGroup,
-                    Comment: ''
+                    Comments: []
                 });
                 continue;
             }
@@ -202,6 +218,7 @@ export default class Parser {
             if (this.curToken.Type === Tokens.COMMA || closingTokens.includes(this.curToken.Type)) {
                 const tokenType = this.curToken.Type;
                 let parsedComments = false;
+                let comment;
                 /**
                  * check if line has a comment
                  */
@@ -221,7 +238,7 @@ export default class Parser {
                                 Value: propertyName,
                                 Unwrapped: isUnwrapped
                             }],
-                    Comment: comment
+                    Comments: comment ? [comment] : []
                 });
                 if (this.curToken.Literal === Tokens.COMMA || this.curToken.Literal === closingTokens[0]) {
                     if (this.curToken.Literal === Tokens.COMMA) {
@@ -263,11 +280,11 @@ export default class Parser {
                     Occurrence: occurrence,
                     Name: '',
                     Type: {
-                        Type: "group",
+                        Type: 'group',
                         Value: propertyName,
                         Unwrapped: isUnwrapped
                     },
-                    Comment: comment
+                    Comments: comments
                 };
                 if (isChoice) {
                     /**
@@ -318,14 +335,15 @@ export default class Parser {
                 flipIsChoice = true;
                 this.nextToken(); // eat ,
             }
-            comment = this.parseComment();
+            const trailingComment = this.parseComment();
+            trailingComment && comments.push(trailingComment);
             const prop = {
                 HasCut: hasCut,
                 Occurrence: occurrence,
                 Name: propertyName,
                 Type: propertyType,
-                Comment: comment,
-                ...(operator ? operator : {})
+                Comments: comments,
+                ...(operator ? { Operator: operator } : {})
             };
             if (isChoice) {
                 valuesOrProperties[valuesOrProperties.length - 1].push(prop);
@@ -364,9 +382,35 @@ export default class Parser {
             return {
                 Type: 'array',
                 Name: groupName || '',
-                Values: valuesOrProperties
+                Values: valuesOrProperties,
+                Comments: []
             };
         }
+        /**
+         * simplify wrapped types, e.g. from
+         * {
+         *     "Type": "group",
+         *     "Name": "",
+         *     "Properties": [
+         *         {
+         *             "HasCut": false,
+         *             "Occurrence": {
+         *                 "n": 1,
+         *                 "m": 1
+         *             },
+         *             "Name": "",
+         *             "Type": "bool",
+         *             "Comment": ""
+         *         }
+         *     ],
+         *     "IsChoiceAddition": false
+         * }
+         * back to:
+         * bool
+         */
+        if (!groupName && valuesOrProperties.length === 1 && PREDEFINED_IDENTIFIER.includes(valuesOrProperties[0].Type)) {
+            return valuesOrProperties[0].Type;
+        }
         /**
          * otherwise a group
          */
@@ -374,7 +418,8 @@ export default class Parser {
             Type: 'group',
             Name: groupName || '',
             Properties: valuesOrProperties,
-            IsChoiceAddition: isChoiceAddition
+            IsChoiceAddition: isChoiceAddition,
+            Comments: []
         };
     }
     isPropertyValueSeparator() {
@@ -446,6 +491,8 @@ export default class Parser {
             case Type.BYTES:
             case Type.TSTR:
             case Type.TEXT:
+            case Type.NIL:
+            case Type.NULL:
                 type = this.curToken.Literal;
                 break;
             default: {
@@ -656,26 +703,20 @@ export default class Parser {
     /**
      * check if line has a comment
      */
-    parseComment() {
-        let comment = '';
-        if (this.curToken.Type === Tokens.COMMENT) {
-            comment = this.curToken.Literal.slice(2);
-            this.nextToken();
+    parseComment(isLeading) {
+        if (this.curToken.Type !== Tokens.COMMENT) {
+            return;
         }
-        return comment;
+        const comment = this.curToken.Literal.replace(/^;(\s*)/, '');
+        this.nextToken();
+        if (comment.trim().length === 0) {
+            return;
+        }
+        return { Type: 'comment', Content: comment, Leading: Boolean(isLeading) };
     }
     parse() {
         const definition = [];
         while (this.curToken.Type !== Tokens.EOF) {
-            if (this.curToken.Type === Tokens.COMMENT) {
-                const comment = {
-                    Type: 'comment',
-                    Content: this.curToken.Literal.slice(1).trim()
-                };
-                definition.push(comment);
-                this.nextToken();
-                continue;
-            }
             const group = this.parseAssignments();
             if (group) {
                 definition.push(group);

package/examples/webdriver/remote.cddl

@@ -375,14 +375,14 @@ script.RemoteReference = (
 
 script.SharedReference = {
    sharedId: script.SharedId
-   
+
    ?handle: script.Handle,
    Extensible
 }
 
 script.RemoteObjectReference = {
    handle: script.Handle,
-   
+
    ?sharedId: script.SharedId
    Extensible
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cddl",
-  "version": "0.6.0",
+  "version": "0.8.0",
   "description": "Concise data definition language (RFC 8610) implementation and JSON validator in Node.js",
   "author": "Christian Bromann <christian@saucelabs.com>",
   "license": "MIT",
@@ -42,9 +42,6 @@
     "vitest": "^0.29.2"
   },
   "dependencies": {
-    "@babel/parser": "^7.21.4",
-    "camelcase": "^7.0.1",
-    "recast": "^0.22.0",
     "yargs": "^17.7.1"
   }
 }

package/build/transform/ts.d.ts

@@ -1,3 +0,0 @@
-import type { Assignment } from '../ast';
-export declare function transform(assignments: Assignment[]): string;
-//# sourceMappingURL=ts.d.ts.map

package/build/transform/ts.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ts.d.ts","sourceRoot":"","sources":["../../src/transform/ts.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,UAAU,EAA6C,MAAM,QAAQ,CAAA;AAanF,wBAAgB,SAAS,CAAE,WAAW,EAAE,UAAU,EAAE,UAoBnD"}

package/build/transform/ts.js

@@ -1,113 +0,0 @@
-import camelcase from 'camelcase';
-import { parse, print, types } from 'recast';
-import typescriptParser from 'recast/parsers/typescript.js';
-// @ts-ignore
-import pkg from '../../package.json' assert { type: 'json' };
-const b = types.builders;
-const comments = [];
-const NATIVE_TYPES = {
-    number: 'number',
-    uint: 'Uint32Array',
-    bool: 'boolean',
-    str: 'string',
-    text: 'string',
-    tstr: 'string'
-};
-export function transform(assignments) {
-    let ast = parse(`// compiled with https://www.npmjs.com/package/cddl v${pkg.version}`, {
-        parser: typescriptParser,
-        sourceFileName: 'cddl2Ts.ts',
-        sourceRoot: process.cwd()
-    });
-    for (const assignment of assignments) {
-        const statement = parseAssignment(ast, assignment);
-        if (!statement) {
-            continue;
-        }
-        ast.program.body.push(statement);
-    }
-    ast.program.comments = comments.map((c) => b.commentLine(c, false, false));
-    return print(ast).code;
-}
-function parseAssignment(ast, assignment) {
-    if (assignment.Type === 'comment') {
-        comments.push(assignment.Content);
-        return;
-    }
-    if (assignment.Type === 'variable') {
-        const propType = Array.isArray(assignment.PropertyType)
-            ? assignment.PropertyType
-            : [assignment.PropertyType];
-        const id = b.identifier(camelcase(assignment.Name, { pascalCase: true }));
-        let typeParameters;
-        // @ts-expect-error e.g. "js-int = -9007199254740991..9007199254740991"
-        if (propType.length === 1 && propType[0].Type === 'range') {
-            typeParameters = b.tsNumberKeyword();
-        }
-        else {
-            typeParameters = b.tsUnionType(propType.map(parsePropertyType));
-        }
-        const expr = b.tsTypeAliasDeclaration(id, typeParameters);
-        expr.comments = comments.map((c) => b.commentLine(c, true));
-        return expr;
-    }
-    if (assignment.Type === 'group') {
-        const id = b.identifier(camelcase(assignment.Name, { pascalCase: true }));
-        const objectType = parseObjectType(assignment.Properties);
-        const expr = b.interfaceDeclaration(id, objectType, []);
-        return expr;
-    }
-}
-function parsePropertyType(propType) {
-    if (typeof propType === 'string') {
-        return b.tsStringKeyword();
-    }
-    if (propType.Type === 'group') {
-        return b.tsTypeReference(b.identifier(propType.Value.toString()));
-    }
-    if (propType.Type === 'literal') {
-        return b.tsLiteralType(b.stringLiteral(propType.Value.toString()));
-    }
-    throw new Error(`Couldn't parse property type ${JSON.stringify(propType, null, 4)}`);
-}
-function parseObjectType(props) {
-    const propItems = [];
-    for (const prop of props) {
-        /**
-         * ToDo(Christian): support Extensible
-         */
-        if (prop.Name === '') {
-            propItems[propItems.length - 1].comments = [b.commentLine(`Missing: ${JSON.stringify(prop)}`)];
-            continue;
-        }
-        const id = b.identifier(camelcase(prop.Name));
-        const cddlType = Array.isArray(prop.Type) ? prop.Type : [prop.Type];
-        const typeParameters = b.unionTypeAnnotation(cddlType.map((t) => {
-            if (typeof t === 'string') {
-                if (!NATIVE_TYPES[t]) {
-                    throw new Error(`Unknown native type: "${t}`);
-                }
-                return b.typeParameter(NATIVE_TYPES[t]);
-            }
-            else if (t.Value === 'null') {
-                return b.nullTypeAnnotation();
-            }
-            else if (t.Type === 'group') {
-                const value = t.Value;
-                return b.typeParameter(
-                /**
-                 * transform native CDDL types into TypeScript types
-                 */
-                NATIVE_TYPES[value] ? value : camelcase(value.toString(), { pascalCase: true }));
-            }
-            else if (t.Type === 'literal' && typeof t.Value === 'string') {
-                return b.stringLiteralTypeAnnotation(t.Value, t.Value);
-            }
-            throw new Error(`Couldn't parse property ${JSON.stringify(t)}`);
-        }));
-        const isOptional = prop.Occurrence.n === 0;
-        propItems.push(b.objectTypeProperty(id, typeParameters, isOptional));
-    }
-    const obj = b.objectTypeAnnotation(propItems);
-    return obj;
-}

package/build/types.d.ts

@@ -1,5 +0,0 @@
-import { ParseTargets } from './constants.js';
-export interface ParseOptions {
-    target: ParseTargets;
-}
-//# sourceMappingURL=types.d.ts.map

package/build/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAE7C,MAAM,WAAW,YAAY;IACzB,MAAM,EAAE,YAAY,CAAA;CACvB"}

package/build/types.js

@@ -1 +0,0 @@
-export {};