How to edit/create a ModelProperty value and set it in the properties of a Model

[irvinesunday]

I have this object:

alias sunoSkill = {
  name_for_human: "Suno";
  description_for_human: "Suno is a tool that can generate songs based on a description. The user provides a description of the song they want to create, and Suno generates the song lyrics. Suno is a fun and creative way to create songs for any occasion.";
  logo_url: "https://th.bing.com/th?id=OSK.935650835684F7E18AC3F31034DE6DF3";
  contact_email: "[email protected]";
  privacy_policy_url: "https://app.suno.ai/privacy";
  legal_info_url: "https://app.suno.ai/legal";
}

I have passed it via a custom decorator, $skill`, and annotated it over the namespace as such...

@skill(sunoSkill)
@test namespace Service {}

I am trying to enrich the OpenApi info object via x-extensions. Since there's no direct way of setting extensions on the info object at the moment, I will pass the values to the available $info decorator. Here's how I've done it:

export function $skill(context: DecoratorContext, target: Namespace, value: Model) 
{
  const newModel = context.program.checker.cloneType(value);

  // Define the lookup dictionary
  const lookupDictionary: { [key: string]: string } = 
  {
    name_for_human: 'title',
    description_for_human: 'x-ai-description',
    logo_url: 'x-logo',
    privacy_policy_url: 'x-privacy-policy-url',
    legal_info_url: 'x-legal-info-url',
    contact_email: 'email',
  };

  for (let prop of properties.values()) 
  {
     if (lookupDictionary[prop.name]) 
    {      
      newModel.properties.rekey(prop.name, lookupDictionary[prop.name]);
    }
    else if (prop.name === 'contact_email')
    {
      /*  
     Here I need to transform the contact_email value --> "[email protected]" from a string literal to the below object: 
     "contact":{
        "email": "[email protected]"
      }
      */
    }
  }
}

Question: How can I modify the ModelProperty value to be of the said contact object above and set it in the newModel properties?

The output should look like this:

{
  "contact":{
    "email": "[email protected]"
  },
  "title": "Suno",
  "x-ai-description": "Suno is a tool that can generate songs based on a description. The user provides a description of the song they want to create, and Suno generates the song lyrics. Suno is a fun and creative way to create songs for any occasion.",
  "x-legal-info-url": "https://app.suno.ai/legal",
  "x-logo": "https://th.bing.com/th?id=OSK.935650835684F7E18AC3F31034DE6DF3",
  "x-privacy-policy-url": "https://app.suno.ai/privacy",      
}

Here's my failing test:

it("set all properties", async () => {
    const { Service } = (await runner.compile(`
    alias sunoSkill = {
      name_for_human: "Suno";
      description_for_human: "Suno is a tool that can generate songs based on a description. The user provides a description of the song they want to create, and Suno generates the song lyrics. Suno is a fun and creative way to create songs for any occasion.";
      logo_url: "https://th.bing.com/th?id=OSK.935650835684F7E18AC3F31034DE6DF3";
      contact_email: "[email protected]";
      privacy_policy_url: "https://app.suno.ai/privacy";
      legal_info_url: "https://app.suno.ai/legal";
    };
      @skill(sunoSkill)
      @test namespace Service {}
    `)) as { Service: Namespace };

    const doc = getInfo(runner.program, Service);    
    deepStrictEqual(doc, {
      "contact":{
        "email": "[email protected]"
      },
      "title": "Suno",
      "x-ai-description": "Suno is a tool that can generate songs based on a description. The user provides a description of the song they want to create, and Suno generates the song lyrics. Suno is a fun and creative way to create songs for any occasion.",
      "x-legal-info-url": "https://app.suno.ai/legal",
      "x-logo": "https://th.bing.com/th?id=OSK.935650835684F7E18AC3F31034DE6DF3",
      "x-privacy-policy-url": "https://app.suno.ai/privacy",      
    });
  });

[timotheeguerin]

You can call program.checker.createAndFinishType to create the type but you'll have to pass all the properties

program.checker.createAndFinishType({
    kind: "Model",
    properties:  createRekeyableMap(),
...
  })

and then do the same for the properties and their values, which is going to be quite verbose

[irvinesunday]

Does this mean I should recreate the entire model sunoSkill and pass in the individual properties or create a new type for the contact property? It is still unclear

[timotheeguerin]

no just the new contact model + the contact property and you do newModel.properties.set("contact", contactProperty)

[irvinesunday]

Kindly point me to where I'm doing it wrong.
Here's my current implementation:

// Create a StringLiteralNode to hold the email value as an object
const valueNode: Expression = {
  kind: SyntaxKind.StringLiteral,
  value: `{email: [email protected]}`,
  flags: 0,
  symbol: {
    flags: 0,
    declarations: [],
    name: "email",
  },
  pos: 0,
  end: 0,
}

// Create a ModelPropertyNode and pass in the valueNode containing the email value
const modelPropertyNode : ModelPropertyNode =  {
  kind: SyntaxKind.ModelProperty,
  id: {
    kind: SyntaxKind.Identifier,
    sv: "email",
    flags: 0,
    symbol: {
      flags: 0,
      declarations: [],
      name: "email",
    },
    pos: 0,
    end: 0,
  },
  decorators: [],
  optional: false,
  flags: 0,
  symbol: {
    flags: 0,
    declarations: [],
    name: "email",
  },
  pos: 0,
  end: 0,
  value: valueNode
}

// Assign the modelPropertyNode to the prop.type.node property
// prop is the current iteration of value.properties.values() --> where value is the model object (sunoSkill)
prop.type.node = modelPropertyNode;

// Create a new ModelProperty object that will contain the email value
const contactProperty = context.program.checker.createAndFinishType({
  kind: "ModelProperty",
  node: modelPropertyNode,
  name: "email",
  type: prop.type,
  optional: false,
  projections: [],
  projectionsByName: () => [],
  isFinished: false,
  decorators: []
});

// Add the contact property to the newModel (retrieved from const newModel = context.program.checker.cloneType(value);)
newModel.properties.set('contact', contactProperty);

The above however still doesn't resolve the contact object as expected:

"contact":{
    "email": "[email protected]"
  }

we still end up with: "contact": "[email protected]"

[timotheeguerin]

Need to create another wrapper, here you are just create a oroperty contact which type is right back the type of the original property

[garethj-msft]

Idea: What about contributing the ability to add extensions to the info object to the core OAS emitter instead, then just using that? In general you should be able to extend anything in OAS, right, so the emitter should support that.

Obviously we'd need to agree a design.

[timotheeguerin]

Yes, I did mention that yersteday, this would be the correct clean solution having a setInfoExtension(key: string, value: string) in openapi library. The code above was a workaround to unblock until this was a thing. Can you file an issue?