cddl2ts 0.1.0 → 0.2.0

package/README.md

@@ -1,4 +1,4 @@
-CDDL to TypeScript ![Test](https://github.com/christian-bromann/cddl/workflows/Test/badge.svg?branch=master)
+CDDL to TypeScript [![Test](https://github.com/christian-bromann/cddl2ts/actions/workflows/test.yml/badge.svg)](https://github.com/christian-bromann/cddl2ts/actions/workflows/test.yml)
 ==================
 
 > A Node.js package that can generate a TypeScript definition based on a CDDL file

package/bin/cddl2ts.js

@@ -2,8 +2,4 @@
 
 import parse from '../build/cli.js'
 
-if (process.env.NODE_ENV == null) {
-    process.env.NODE_ENV = 'test'
-}
-
 parse()

package/build/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,UAAU,EAAmG,MAAM,MAAM,CAAA;AAqBvI,wBAAgB,SAAS,CAAE,WAAW,EAAE,UAAU,EAAE,UAkBnD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,UAAU,EAAmG,MAAM,MAAM,CAAA;AAsBvI,wBAAgB,SAAS,CAAE,WAAW,EAAE,UAAU,EAAE,UAkBnD"}

package/build/index.js

@@ -4,6 +4,7 @@ import typescriptParser from 'recast/parsers/typescript.js';
 import { pkg } from './constants.js';
 const b = types.builders;
 const NATIVE_TYPES = {
+    any: b.tsAnyKeyword(),
     number: b.tsNumberKeyword(),
     float: b.tsNumberKeyword(),
     uint: b.tsNumberKeyword(),
@@ -46,10 +47,19 @@ function parseAssignment(ast, assignment) {
         }
         const expr = b.tsTypeAliasDeclaration(id, typeParameters);
         expr.comments = assignment.Comments.map((c) => b.commentLine(` ${c.Content}`, true));
-        return expr;
+        return b.exportDeclaration(false, expr);
     }
     if (assignment.Type === 'group') {
         const id = b.identifier(camelcase(assignment.Name, { pascalCase: true }));
+        /**
+         * transform CDDL groups like `Extensible = (*text => any)`
+         */
+        if (assignment.Properties.length === 1 && assignment.Properties[0].Type.length === 1 && Object.keys(NATIVE_TYPES).includes((assignment.Properties[0].Name))) {
+            const value = parseUnionType(assignment);
+            const expr = b.tsTypeAliasDeclaration(id, value);
+            expr.comments = assignment.Comments.map((c) => b.commentLine(` ${c.Content}`, true));
+            return b.exportDeclaration(false, expr);
+        }
         const objectType = parseObjectType(assignment.Properties);
         const extendInterfaces = assignment.Properties
             .filter((prop) => prop.Name === '')
@@ -57,7 +67,7 @@ function parseAssignment(ast, assignment) {
         const expr = b.tsInterfaceDeclaration(id, b.tsInterfaceBody(objectType));
         expr.extends = extendInterfaces;
         expr.comments = assignment.Comments.map((c) => b.commentLine(` ${c.Content}`, true));
-        return expr;
+        return b.exportDeclaration(false, expr);
     }
     if (assignment.Type === 'array') {
         const id = b.identifier(camelcase(assignment.Name, { pascalCase: true }));
@@ -71,7 +81,7 @@ function parseAssignment(ast, assignment) {
         const value = b.tsArrayType(b.tsParenthesizedType(b.tsUnionType(obj)));
         const expr = b.tsTypeAliasDeclaration(id, value);
         expr.comments = assignment.Comments.map((c) => b.commentLine(` ${c.Content}`, true));
-        return expr;
+        return b.exportDeclaration(false, expr);
     }
     throw new Error(`Unknown assignment type "${assignment.Type}"`);
 }
@@ -146,10 +156,22 @@ function parseUnionType(t) {
     else if (t.Type === 'group') {
         const value = t.Value;
         /**
-         * check if we have
-         * ?attributes: {*text => text},
+         * check if we have special groups
          */
         if (!value && t.Properties) {
+            const prop = t.Properties;
+            /**
+             * {*text => text} which will be transformed to `Record<string, string>`
+             */
+            if (prop.length === 1 && Object.keys(NATIVE_TYPES).includes(prop[0].Name)) {
+                return b.tsTypeReference(b.identifier('Record'), b.tsTypeParameterInstantiation([
+                    NATIVE_TYPES[prop[0].Name],
+                    parseUnionType(prop[0].Type[0])
+                ]));
+            }
+            /**
+             * e.g. ?attributes: {*foo => text},
+             */
             return b.tsTypeLiteral(parseObjectType(t.Properties));
         }
         return b.tsTypeReference(b.identifier(camelcase(value.toString(), { pascalCase: true })));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cddl2ts",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "A Node.js package that can generate a TypeScript definition based on a CDDL file",
   "author": "Christian Bromann <mail@bromann.dev>",
   "license": "MIT",
@@ -44,7 +44,7 @@
   "dependencies": {
     "@babel/parser": "^7.21.9",
     "camelcase": "^7.0.1",
-    "cddl": "^0.8.3",
+    "cddl": "^0.8.4",
     "recast": "^0.23.2",
     "yargs": "^17.7.2"
   }