cddl 0.7.0 → 0.8.1

package/README.md

@@ -33,12 +33,7 @@ npx cddl validate ./path/to/interface.cddl
 
 ### 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).
-- or a [TypeScript](https://www.typescriptlang.org/) definition
-
-For example, given the following CDDL file:
+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 = {
@@ -47,7 +42,7 @@ person = {
 }
 ```
 
-By default the package parses the content into an AST:
+It parses the content into an AST:
 
 ```js
 import { parse } from 'cddl'
@@ -67,34 +62,7 @@ console.log(ast)
  */
 ```
 
-You can apply a target specifier to transform the AST into a different language or format (currently supported: `ts` for TypeScript). Note that this is highly experimental and work in progress.
-
-```js
-import { parse } from 'cddl'
-
-/**
- * spec.cddl:
- *
- * session.CapabilityRequest = {
- *   ?acceptInsecureCerts: bool,
- *   ?browserName: text,
- *   ?browserVersion: text,
- *   ?platformName: text,
- * };
- */
-const ts = parse('./spec.cddl', { target: 'ts' })
-console.log(ts)
-/**
- * outputs:
- *
- * interface SessionCapabilityRequest {
- *   acceptInsecureCerts?: boolean,
- *   browserName?: string,
- *   browserVersion?: string,
- *   platformName?: string,
- * }
- */
-```
+The CDDL AST is defined in [source files](./src/ast.ts). The `parse` method returns `Assignment[]`.
 
 ---
 

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,10 @@
 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 };
+export * from './ast.js';
 //# 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,SAAQ,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;AACxB,cAAc,UAAU,CAAA"}

package/build/index.js

@@ -1,18 +1,9 @@
 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 = { target: ParseTargets.AST }) => {
-        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 };
+export * from './ast.js';

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,8 +1,8 @@
 {
   "name": "cddl",
-  "version": "0.7.0",
+  "version": "0.8.1",
   "description": "Concise data definition language (RFC 8610) implementation and JSON validator in Node.js",
-  "author": "Christian Bromann <christian@saucelabs.com>",
+  "author": "Christian Bromann <mail@bromann.dev>",
   "license": "MIT",
   "homepage": "https://github.com/christian-bromann/cddl#readme",
   "repository": {
@@ -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,EAAmG,MAAM,QAAQ,CAAA;AAmBzI,wBAAgB,SAAS,CAAE,WAAW,EAAE,UAAU,EAAE,UAkBnD"}

package/build/transform/ts.js

@@ -1,185 +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 NATIVE_TYPES = {
-    number: b.tsNumberKeyword(),
-    float: b.tsNumberKeyword(),
-    uint: b.tsNumberKeyword(),
-    bool: b.tsBooleanKeyword(),
-    str: b.tsStringKeyword(),
-    text: b.tsStringKeyword(),
-    tstr: b.tsStringKeyword(),
-    range: b.tsNumberKeyword(),
-    nil: b.tsNullKeyword(),
-    null: b.tsNullKeyword()
-};
-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);
-    }
-    return print(ast).code;
-}
-function parseAssignment(ast, assignment) {
-    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 = assignment.Comments.map((c) => b.commentLine(` ${c.Content}`, true));
-        return expr;
-    }
-    if (assignment.Type === 'group') {
-        const id = b.identifier(camelcase(assignment.Name, { pascalCase: true }));
-        const objectType = parseObjectType(assignment.Properties);
-        const extendInterfaces = assignment.Properties
-            .filter((prop) => prop.Name === '')
-            .map((prop) => b.tsExpressionWithTypeArguments(b.identifier(camelcase(prop.Type[0].Value, { pascalCase: true }))));
-        const expr = b.tsInterfaceDeclaration(id, b.tsInterfaceBody(objectType));
-        expr.extends = extendInterfaces;
-        expr.comments = assignment.Comments.map((c) => b.commentLine(` ${c.Content}`, true));
-        return expr;
-    }
-}
-function parsePropertyType(propType) {
-    if (typeof propType === 'string') {
-        return b.tsStringKeyword();
-    }
-    if (propType.Type === 'group') {
-        return b.tsTypeReference(b.identifier(camelcase(propType.Value.toString(), { pascalCase: true })));
-    }
-    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) {
-        /**
-         * Empty groups like
-         * {
-         *   HasCut: false,
-         *   Occurrence: { n: 1, m: 1 },
-         *   Name: '',
-         *   Type: [ { Type: 'group', Value: 'Extensible', Unwrapped: false } ],
-         *   Comment: ''
-         * }
-         * are ignored and later added as interface extensions
-         */
-        if (prop.Name === '') {
-            continue;
-        }
-        const id = b.identifier(camelcase(prop.Name));
-        const cddlType = Array.isArray(prop.Type) ? prop.Type : [prop.Type];
-        const comments = prop.Comments.map((c) => ` ${c.Content}`);
-        if (prop.Operator && prop.Operator.Type === 'default') {
-            const defaultValue = parseDefaultValue(prop.Operator);
-            defaultValue && comments.length && comments.push(''); // add empty line if we have previous comments
-            defaultValue && comments.push(` @default ${defaultValue}`);
-        }
-        const type = cddlType.map((t) => {
-            const unionType = parseUnionType(t);
-            if (unionType) {
-                const defaultValue = parseDefaultValue(t.Operator);
-                defaultValue && comments.length && comments.push(''); // add empty line if we have previous comments
-                defaultValue && comments.push(` @default ${defaultValue}`);
-                return unionType;
-            }
-            throw new Error(`Couldn't parse property ${JSON.stringify(t)}`);
-        });
-        const typeAnnotation = b.tsTypeAnnotation(b.tsUnionType(type));
-        const isOptional = prop.Occurrence.n === 0;
-        const propSignature = b.tsPropertySignature(id, typeAnnotation, isOptional);
-        propSignature.comments = comments.length ? [b.commentBlock(`*\n *${comments.join('\n *')}\n `)] : [];
-        propItems.push(propSignature);
-    }
-    return propItems;
-}
-function parseUnionType(t) {
-    if (typeof t === 'string') {
-        if (!NATIVE_TYPES[t]) {
-            throw new Error(`Unknown native type: "${t}`);
-        }
-        return NATIVE_TYPES[t];
-    }
-    else if (NATIVE_TYPES[t.Type]) {
-        return NATIVE_TYPES[t.Type];
-    }
-    else if (t.Value === 'null') {
-        return b.tsNullKeyword();
-    }
-    else if (t.Type === 'group') {
-        const value = t.Value;
-        /**
-         * check if we have
-         * ?attributes: {*text => text},
-         */
-        if (!value && t.Properties) {
-            return b.tsTypeLiteral(parseObjectType(t.Properties));
-        }
-        return b.tsTypeReference(b.identifier(camelcase(value.toString(), { pascalCase: true })));
-    }
-    else if (t.Type === 'literal' && typeof t.Value === 'string') {
-        return b.tsLiteralType(b.stringLiteral(t.Value));
-    }
-    else if (t.Type === 'literal' && typeof t.Value === 'number') {
-        return b.tsLiteralType(b.numericLiteral(t.Value));
-    }
-    else if (t.Type === 'array') {
-        const types = t.Values[0].Type;
-        const typedTypes = (Array.isArray(types) ? types : [types]).map((val) => {
-            return typeof val === 'string' && NATIVE_TYPES[val]
-                ? NATIVE_TYPES[val]
-                : b.tsTypeReference(b.identifier(camelcase(val.Value, { pascalCase: true })));
-        });
-        return b.tsArrayType(typedTypes.length > 1
-            ? b.tsParenthesizedType(b.tsUnionType(typedTypes))
-            : b.tsUnionType(typedTypes));
-    }
-    else if (typeof t.Type === 'object' && t.Type.Type === 'range') {
-        return b.tsNumberKeyword();
-    }
-    else if (typeof t.Type === 'object' && t.Type.Type === 'group') {
-        /**
-         * e.g. ?pointerType: input.PointerType .default "mouse"
-         */
-        const referenceValue = camelcase(t.Type.Value, { pascalCase: true });
-        return b.tsTypeReference(b.identifier(referenceValue));
-    }
-}
-function parseDefaultValue(operator) {
-    if (!operator || operator.Type !== 'default') {
-        return;
-    }
-    const operatorValue = operator.Value;
-    if (operator.Value === 'null') {
-        return operator.Value;
-    }
-    if (operatorValue.Type !== 'literal') {
-        throw new Error(`Can't parse operator default value of ${JSON.stringify(operator)}`);
-    }
-    return typeof operatorValue.Value === 'string'
-        ? `'${operatorValue.Value}'`
-        : operatorValue.Value;
-}

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 {};