Use key-value-pairs instead of positional arguments

Author: flobernd

compiler/src/model/metamodel.ts

@@ -213,7 +213,7 @@ export class Container extends VariantBase {
 export class Inherits {
   type: TypeName
   generics?: ValueOf[]
-  meta?: string[]
+  meta?: { [p: string]: string }
 }
 
 /**

compiler/src/model/utils.ts

@@ -418,17 +418,25 @@ export function modelBehaviors (node: ExpressionWithTypeArguments, jsDocs: JSDoc
   const behaviorName = node.getExpression().getText()
   const generics = node.getTypeArguments().map(node => modelType(node))
 
-  let meta: string[] | undefined
+  let meta: Map<string, string> | undefined
   const tags = parseJsDocTagsAllowDuplicates(jsDocs)
   if (tags.behavior_meta !== undefined) {
-    // Splits a string by comma, but preserves comma in quoted strings
-    const re = /(?<=")[^"]+?(?="(?:\s*?,|\s*?$))|(?<=(?:^|,)\s*?)(?:[^,"\s][^,"]*[^,"\s])|(?:[^,"\s])(?![^"]*?"(?:\s*?,|\s*?$))(?=\s*?(?:,|$))/g
+    // Extracts whitespace/comma-separated key-value-pairs with a "=" delimiter and handles double-quotes
+    const re = /(?<key>[^=\s,]+)=(?<value>"([^"]*)"|([^\s,]+))/g
+
     for (const tag of tags.behavior_meta) {
       const id = tag.split(' ')
       if (id[0].trim() !== behaviorName) {
         continue
       }
-      meta = id.slice(1).join(' ').match(re) as string[]
+      const matches = [...id.slice(1).join(' ').matchAll(re)]
+      meta = new Map<string, string>()
+      for (const match of matches) {
+        if (match.groups == null) {
+          continue
+        }
+        meta.set(match.groups.key, match.groups.value.replace(/^"(.+(?="$))"$/, '$1'))
+      }
       break
     }
   }
@@ -439,7 +447,7 @@ export function modelBehaviors (node: ExpressionWithTypeArguments, jsDocs: JSDoc
       namespace: getNameSpace(node)
     },
     ...(generics.length > 0 && { generics }),
-    meta
+    meta: (meta === undefined) ? undefined : Object.fromEntries(meta)
   }
 }
 

compiler/src/steps/validate-model.ts

@@ -653,10 +653,10 @@ export default async function validateModel (apiModel: model.Model, restSpec: Ma
       for (const parent of typeDef.behaviors) {
         validateTypeRef(parent.type, parent.generics, openGenerics)
 
-        if (parent.type.name === 'AdditionalProperty' && (parent.meta == null || parent.meta.length < 2 || parent.meta.length > 3)) {
+        if (parent.type.name === 'AdditionalProperty' && (parent.meta == null || parent.meta.name == null || parent.meta.value == null)) {
           modelError(`AdditionalProperty behavior for type '${fqn(typeDef.name)}' requires a 'behavior_meta' decorator with at least 2 arguments (name of name, name of value, description)`)
         }
-        if (parent.type.name === 'AdditionalProperties' && (parent.meta == null || parent.meta.length !== 2)) {
+        if (parent.type.name === 'AdditionalProperties' && (parent.meta == null || parent.meta.name == null || parent.meta.description == null)) {
           modelError(`AdditionalProperties behavior for type '${fqn(typeDef.name)}' requires a 'behavior_meta' decorator with exactly 2 arguments (name, description)`)
         }
       }

docs/behaviors.md

@@ -16,7 +16,7 @@ We therefore document the requirement to behave like a dictionary for unknown pr
 
 ```ts
 /**
- * @behavior_meta AdditionalProperties sub_aggregations
+ * @behavior_meta AdditionalProperties name=sub_aggregations
  */
 class IpRangeBucket implements AdditionalProperties<AggregateName, Aggregate> {}
 ```
@@ -25,7 +25,7 @@ There are also many places where we expect only one runtime-defined property, su
 
 ```ts
 /**
- * @behavior_meta AdditionalProperty field, bounding_box
+ * @behavior_meta AdditionalProperty name=field value=bounding_box
  */
 class GeoBoundingBoxQuery extends QueryBase
   implements AdditionalProperty<Field, BoundingBox>