cddl2ts 0.7.1 → 0.7.2

package/build/index.js

@@ -57,6 +57,21 @@ export function transform(assignments, options) {
     }
     return print(ast).code;
 }
+function getAssignmentComments(assignment) {
+    return assignment.Comments.map((c) => b.commentLine(` ${c.Content}`, true));
+}
+function exportWithComments(declaration) {
+    const expr = b.exportDeclaration(false, declaration);
+    expr.comments = declaration.comments;
+    declaration.comments = [];
+    return expr;
+}
+function isExtensibleRecordProperty(prop) {
+    return !isUnNamedProperty(prop) &&
+        prop.Occurrence.m === Infinity &&
+        !prop.HasCut &&
+        RECORD_KEY_TYPES.has(prop.Name);
+}
 function parseAssignment(assignment) {
     if (isVariable(assignment)) {
         const propType = Array.isArray(assignment.PropertyType)
@@ -72,8 +87,8 @@ function parseAssignment(assignment) {
             typeParameters = b.tsUnionType(propType.map(parseUnionType));
         }
         const expr = b.tsTypeAliasDeclaration(id, typeParameters);
-        expr.comments = assignment.Comments.map((c) => b.commentLine(` ${c.Content}`, true));
-        return b.exportDeclaration(false, expr);
+        expr.comments = getAssignmentComments(assignment);
+        return exportWithComments(expr);
     }
     if (isGroup(assignment)) {
         const id = b.identifier(pascalCase(assignment.Name));
@@ -154,8 +169,8 @@ function parseAssignment(assignment) {
                 value = b.tsIntersectionType(intersections);
             }
             const expr = b.tsTypeAliasDeclaration(id, value);
-            expr.comments = assignment.Comments.map((c) => b.commentLine(` ${c.Content}`, true));
-            return b.exportDeclaration(false, expr);
+            expr.comments = getAssignmentComments(assignment);
+            return exportWithComments(expr);
         }
         const props = properties;
         /**
@@ -167,8 +182,8 @@ function parseAssignment(assignment) {
             if (propType.length === 1 && RECORD_KEY_TYPES.has(prop.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);
+                expr.comments = getAssignmentComments(assignment);
+                return exportWithComments(expr);
             }
         }
         // Check if extended interfaces are likely unions or conflicting types
@@ -385,14 +400,14 @@ function parseAssignment(assignment) {
                 value = b.tsIntersectionType(intersections);
             }
             const expr = b.tsTypeAliasDeclaration(id, value);
-            expr.comments = assignment.Comments.map((c) => b.commentLine(` ${c.Content}`, true));
-            return b.exportDeclaration(false, expr);
+            expr.comments = getAssignmentComments(assignment);
+            return exportWithComments(expr);
         }
         // Fallback to interface if no mixins (pure object)
         const objectType = parseObjectType(props);
         const expr = b.tsInterfaceDeclaration(id, b.tsInterfaceBody(objectType));
-        expr.comments = assignment.Comments.map((c) => b.commentLine(` ${c.Content}`, true));
-        return b.exportDeclaration(false, expr);
+        expr.comments = getAssignmentComments(assignment);
+        return exportWithComments(expr);
     }
     if (isCDDLArray(assignment)) {
         const id = b.identifier(pascalCase(assignment.Name));
@@ -408,8 +423,8 @@ function parseAssignment(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 b.exportDeclaration(false, expr);
+            expr.comments = getAssignmentComments(assignment);
+            return exportWithComments(expr);
         }
         // Standard array
         const firstType = assignmentValues.Type;
@@ -422,8 +437,8 @@ function parseAssignment(assignment) {
             ? obj[0]
             : b.tsParenthesizedType(b.tsUnionType(obj)));
         const expr = b.tsTypeAliasDeclaration(id, value);
-        expr.comments = assignment.Comments.map((c) => b.commentLine(` ${c.Content}`, true));
-        return b.exportDeclaration(false, expr);
+        expr.comments = getAssignmentComments(assignment);
+        return exportWithComments(expr);
     }
     throw new Error(`Unknown assignment type "${assignment.Type}"`);
 }
@@ -444,9 +459,22 @@ function parseObjectType(props) {
         if (isUnNamedProperty(prop)) {
             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 (isExtensibleRecordProperty(prop)) {
+            const keyIdentifier = b.identifier('key');
+            keyIdentifier.typeAnnotation = b.tsTypeAnnotation(NATIVE_TYPES[prop.Name]);
+            const indexSignature = b.tsIndexSignature([keyIdentifier], b.tsTypeAnnotation(b.tsUnionType([
+                ...cddlType.map((t) => parseUnionType(t)),
+                b.tsUndefinedKeyword()
+            ])));
+            indexSignature.comments = comments.length
+                ? [b.commentBlock(`*\n *${comments.join('\n *')}\n `)]
+                : [];
+            propItems.push(indexSignature);
+            continue;
+        }
+        const id = b.identifier(camelcase(prop.Name));
         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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cddl2ts",
-  "version": "0.7.1",
+  "version": "0.7.2",
   "description": "A Node.js package that can generate a TypeScript definition based on a CDDL file",
   "author": "Christian Bromann <mail@bromann.dev>",
   "license": "MIT",
@@ -32,7 +32,7 @@
     "camelcase": "^9.0.0",
     "recast": "^0.23.11",
     "yargs": "^18.0.0",
-    "cddl": "0.19.1"
+    "cddl": "0.19.2"
   },
   "scripts": {
     "release": "release-it --config .release-it.ts --VV",

package/src/index.ts

@@ -90,6 +90,27 @@ export function transform (assignments: Assignment[], options?: TransformOptions
     return print(ast).code
 }
 
+function getAssignmentComments (assignment: Assignment) {
+    return assignment.Comments.map((c) => b.commentLine(` ${c.Content}`, true))
+}
+
+function exportWithComments (
+    declaration: types.namedTypes.TSTypeAliasDeclaration
+        | types.namedTypes.TSInterfaceDeclaration
+) {
+    const expr = b.exportDeclaration(false, declaration)
+    expr.comments = declaration.comments
+    declaration.comments = []
+    return expr
+}
+
+function isExtensibleRecordProperty (prop: Property) {
+    return !isUnNamedProperty(prop) &&
+        prop.Occurrence.m === Infinity &&
+        !prop.HasCut &&
+        RECORD_KEY_TYPES.has(prop.Name)
+}
+
 function parseAssignment (assignment: Assignment) {
     if (isVariable(assignment)) {
         const propType = Array.isArray(assignment.PropertyType)
@@ -107,8 +128,8 @@ function parseAssignment (assignment: Assignment) {
         }
 
         const expr = b.tsTypeAliasDeclaration(id, typeParameters)
-        expr.comments = assignment.Comments.map((c) => b.commentLine(` ${c.Content}`, true))
-        return b.exportDeclaration(false, expr)
+        expr.comments = getAssignmentComments(assignment)
+        return exportWithComments(expr)
     }
 
     if (isGroup(assignment)) {
@@ -201,8 +222,8 @@ function parseAssignment (assignment: Assignment) {
             }
 
             const expr = b.tsTypeAliasDeclaration(id, value)
-            expr.comments = assignment.Comments.map((c) => b.commentLine(` ${c.Content}`, true))
-            return b.exportDeclaration(false, expr)
+            expr.comments = getAssignmentComments(assignment)
+            return exportWithComments(expr)
         }
 
         const props = properties as Property[]
@@ -216,8 +237,8 @@ function parseAssignment (assignment: Assignment) {
             if (propType.length === 1 && RECORD_KEY_TYPES.has(prop.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)
+                expr.comments = getAssignmentComments(assignment)
+                return exportWithComments(expr)
             }
         }
 
@@ -431,16 +452,16 @@ function parseAssignment (assignment: Assignment) {
             }
 
             const expr = b.tsTypeAliasDeclaration(id, value)
-            expr.comments = assignment.Comments.map((c) => b.commentLine(` ${c.Content}`, true))
-            return b.exportDeclaration(false, expr)
+            expr.comments = getAssignmentComments(assignment)
+            return exportWithComments(expr)
         }
 
         // Fallback to interface if no mixins (pure object)
         const objectType = parseObjectType(props)
 
         const expr = b.tsInterfaceDeclaration(id, b.tsInterfaceBody(objectType))
-        expr.comments = assignment.Comments.map((c) => b.commentLine(` ${c.Content}`, true))
-        return b.exportDeclaration(false, expr)
+        expr.comments = getAssignmentComments(assignment)
+        return exportWithComments(expr)
     }
 
     if (isCDDLArray(assignment)) {
@@ -459,8 +480,8 @@ function parseAssignment (assignment: 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 b.exportDeclaration(false, expr)
+            expr.comments = getAssignmentComments(assignment)
+            return exportWithComments(expr)
         }
 
         // Standard array
@@ -477,8 +498,8 @@ function parseAssignment (assignment: Assignment) {
                 : b.tsParenthesizedType(b.tsUnionType(obj))
         )
         const expr = b.tsTypeAliasDeclaration(id, value)
-        expr.comments = assignment.Comments.map((c) => b.commentLine(` ${c.Content}`, true))
-        return b.exportDeclaration(false, expr)
+        expr.comments = getAssignmentComments(assignment)
+        return exportWithComments(expr)
     }
 
     throw new Error(`Unknown assignment type "${(assignment as any).Type}"`)
@@ -502,10 +523,31 @@ function parseObjectType (props: Property[]): ObjectBody {
             continue
         }
 
-        const id = b.identifier(camelcase(prop.Name))
         const cddlType: PropertyType[] = Array.isArray(prop.Type) ? prop.Type : [prop.Type]
         const comments: string[] = prop.Comments.map((c) => ` ${c.Content}`)
 
+        if (isExtensibleRecordProperty(prop)) {
+            const keyIdentifier = b.identifier('key')
+            keyIdentifier.typeAnnotation = b.tsTypeAnnotation(NATIVE_TYPES[prop.Name])
+
+            const indexSignature = b.tsIndexSignature(
+                [keyIdentifier],
+                b.tsTypeAnnotation(
+                    b.tsUnionType([
+                        ...cddlType.map((t) => parseUnionType(t)),
+                        b.tsUndefinedKeyword()
+                    ])
+                )
+            )
+            indexSignature.comments = comments.length
+                ? [b.commentBlock(`*\n *${comments.join('\n *')}\n `)]
+                : []
+            propItems.push(indexSignature)
+            continue
+        }
+
+        const id = b.identifier(camelcase(prop.Name))
+
         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

package/tests/__snapshots__/extensible_metadata.test.ts.snap

@@ -0,0 +1,16 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`extensible metadata > should render extensible metadata as an interface with an index signature 1`] = `
+"export type MetadataScalar = null | boolean | number | number | string;
+
+export interface MessageMetadata {
+  provider?: string;
+  model?: string;
+  modelType?: string;
+  runId?: string;
+  threadId?: string;
+  systemFingerprint?: string;
+  serviceTier?: string;
+  [key: string]: MetadataScalar | undefined;
+}"
+`;

package/tests/__snapshots__/group_choice.test.ts.snap

@@ -12,52 +12,52 @@ export type DirectProxyConfiguration = Extensible & {
   proxyType: "direct";
 };
 
-export // 1. Simple Group Choice
-type ManualProxyConfiguration = Extensible & {
+// 1. Simple Group Choice
+export type ManualProxyConfiguration = Extensible & {
   proxyType: "manual";
 };
 
-export // 2. Nested Group Choice
-type SimpleGroupChoice = Int | string;
+// 2. Nested Group Choice
+export type SimpleGroupChoice = Int | string;
 
-export // 3. Group Choice with Multiple Items (Sequence) - interpreted as tuple
-type NestedGroupChoice = (Int | Tstr);
+// 3. Group Choice with Multiple Items (Sequence) - interpreted as tuple
+export type NestedGroupChoice = (Int | Tstr);
 
-export // 4. Map Group Choice - interpreted as map (interface) union
-type SequenceGroupChoice = [number, string] | number;
+// 4. Map Group Choice - interpreted as map (interface) union
+export type SequenceGroupChoice = [number, string] | number;
 
-export // 5. Type Choice inside Group - should be value union
-type MapGroupChoice = {
+// 5. Type Choice inside Group - should be value union
+export type MapGroupChoice = {
   a: 1;
 } | {
   b: 2;
 };
 
-export // 6. Array with Group Choice - should be array of union?
-type TypeChoiceInsideGroup = number | string;
+// 6. Array with Group Choice - should be array of union?
+export type TypeChoiceInsideGroup = number | string;
 
-export // 7. Map with nested group (bare and parens) - should be object like
-type ArrayGroupChoice = Int | string[];
+// 7. Map with nested group (bare and parens) - should be object like
+export type ArrayGroupChoice = Int | string[];
 
 export type MapWithBareGroup = number;
 
-export // 8. Group wrapped in map with multiple properties
-type MapWithParensGroup = number;
+// 8. Group wrapped in map with multiple properties
+export type MapWithParensGroup = number;
 
-export // 9. Property type choice without operators
-type MapGroupWrap = ;
+// 9. Property type choice without operators
+export type MapGroupWrap = ;
 
-export // 10. Nested choice with group reference
-interface PropChoiceNoOp {
+// 10. Nested choice with group reference
+export interface PropChoiceNoOp {
   a: number | number;
   b: string;
 }
 
-export // 11. Complex type (group) followed by property without comma
-type NestedChoiceRef = number | string;
+// 11. Complex type (group) followed by property without comma
+export type NestedChoiceRef = number | string;
 
-export // 12. Multi-item group choice (verifies isChoice persistence)
-interface MapNoComma {
+// 12. Multi-item group choice (verifies isChoice persistence)
+export interface MapNoComma {
   a: number;
   b: string;
 }

package/tests/__snapshots__/mod.test.ts.snap

@@ -95,8 +95,8 @@ export interface SomeGroup {
 export type ScriptListLocalValue = ScriptLocalValue[];
 export type ScriptMappingLocalValue = (ScriptLocalValue | ScriptLocalValue)[];
 
-export // some comments here
-type Extensible = Record<string, any>;",
+// some comments here
+export type Extensible = Record<string, any>;",
   ],
 ]
 `;

package/tests/__snapshots__/webdriver_remote.test.ts.snap

@@ -388,9 +388,9 @@ export interface BrowsingContextPrintParameters {
   shrinkToFit?: boolean;
 }
 
-export // Minimum size is 1pt x 1pt. Conversion follows from
+// Minimum size is 1pt x 1pt. Conversion follows from
 // https://www.w3.org/TR/css3-values/#absolute-lengths
-interface BrowsingContextPrintMarginParameters {
+export interface BrowsingContextPrintMarginParameters {
   /**
    * @default 1
    */

package/tests/extensible_metadata.test.ts

@@ -0,0 +1,49 @@
+import url from 'node:url'
+import path from 'node:path'
+import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest'
+
+import cli from '../src/cli.js'
+
+const __dirname = url.fileURLToPath(new URL('.', import.meta.url))
+const cddlFile = path.join(__dirname, '..', '..', '..', 'examples', 'commons', 'extensible_metadata.cddl')
+
+vi.mock('../src/constants', () => ({
+    pkg: {
+        name: 'cddl2ts',
+        version: '0.0.0'
+    }
+}))
+
+describe('extensible metadata', () => {
+    let exitOrig = process.exit
+    let logOrig = console.log
+    let errorOrig = console.error
+
+    beforeEach(() => {
+        process.exit = vi.fn() as any
+        console.log = vi.fn()
+        console.error = vi.fn()
+    })
+
+    afterEach(() => {
+        process.exit = exitOrig
+        console.log = logOrig
+        console.error = errorOrig
+    })
+
+    it('should render extensible metadata as an interface with an index signature', async () => {
+        await cli([cddlFile])
+
+        expect(process.exit).not.toHaveBeenCalledWith(1)
+        expect(console.error).not.toHaveBeenCalled()
+
+        const output = vi.mocked(console.log).mock.calls.flat().join('\n')
+
+        expect(output).toContain('export interface MessageMetadata {')
+        expect(output).toContain('provider?: string;')
+        expect(output).toContain('modelType?: string;')
+        expect(output).toContain('[key: string]: MetadataScalar | undefined;')
+        expect(output).not.toContain('text?: MetadataScalar;')
+        expect(output).toMatchSnapshot()
+    })
+})

package/tests/named_group_choice.test.ts

@@ -39,8 +39,8 @@ describe('named group choice', () => {
 
         const output = vi.mocked(console.log).mock.calls.flat().join('\n')
 
-        // The export keyword is separated from the type definition by comments
-        expect(output).toMatch(/export\s+(\/\/.*\n)+\s*type Choice = OptionA \| OptionB/)
+        // Leading comments should render before the exported declaration.
+        expect(output).toMatch(/(\/\/.*\n)+export type Choice = OptionA \| OptionB/)
         expect(output).toContain('export interface OptionA {')
         expect(output).toContain('export interface OptionB {')
     })

package/tests/transform_edge_cases.test.ts

@@ -14,11 +14,11 @@ import { transform } from '../src/index.js'
 
 const COMMENTS: Comment[] = []
 
-function comment (content: string): Comment {
+function comment (content: string, leading = false): Comment {
     return {
         Type: 'comment',
         Content: content,
-        Leading: false
+        Leading: leading
     }
 }
 
@@ -240,6 +240,40 @@ describe('transform edge cases', () => {
         expect(output).toContain('enabled?: boolean')
     })
 
+    it('should place leading comments before exported declarations', () => {
+        const output = transform([
+            variable('metadata-scalar', ['null', 'bool', 'int', 'float', 'text'], [
+                comment('Flat scalar value used by concise metadata bags.', true)
+            ])
+        ])
+
+        expect(output).toContain(`// Flat scalar value used by concise metadata bags.\nexport type MetadataScalar = null | boolean | number | number | string;`)
+        expect(output).not.toContain('export // Flat scalar value used by concise metadata bags.')
+    })
+
+    it('should emit extensible object properties as index signatures', () => {
+        const output = transform([
+            variable('metadata-scalar', ['null', 'bool', 'int', 'float', 'text']),
+            group('message-metadata', [
+                property('provider', 'text', {
+                    Occurrence: { n: 0, m: 1 }
+                }),
+                property('model', 'text', {
+                    Occurrence: { n: 0, m: 1 }
+                }),
+                property('text', groupRef('metadata-scalar'), {
+                    Occurrence: { n: 0, m: Infinity }
+                })
+            ])
+        ])
+
+        expect(output).toContain('export interface MessageMetadata {')
+        expect(output).toContain('provider?: string;')
+        expect(output).toContain('model?: string;')
+        expect(output).toContain('[key: string]: MetadataScalar | undefined;')
+        expect(output).not.toContain('text?: MetadataScalar;')
+    })
+
     it('should throw clear errors for unsupported inputs', () => {
         expect(() => transform([
             variable('unknown-native', 'nope')