Change in circular type definition results in TypeScript warning

[jashaj]

Description

After the change in #370, TypeScript sees the key as string | number. This breaks code that expects the key to be a string.

DefinitionList.vue:

<template>
  <div>
    <h2>Record type</h2>
    <dl>
      <definition-item v-for="(value, key) in recordType" :key="key" :term="key" :description="value" />
    </dl>
    <h2>Object type</h2>
    <dl>
      <!-- Error:
           Vue: Type string | number is not assignable to type string
           Type number is not assignable to type string -->
      <definition-item v-for="(value, key) in objectType" :key="key" :term="key" :description="value" />
    </dl>
  </div>
</template>

<script setup lang="ts">
import DefinitionItem from '@/components/DefinitionItem.vue';

const recordType: Record<string, string> = {
  title: 'Text',
  foo: 'bar',
};

const objectType: { [key: string]: string } = {
  title: 'Text',
  foo: 'bar',
};
</script>

DefinitionItem.vue:

<template>
  <div>
    <dt>{{ term }}</dt>
    <dd>{{ description }}</dd>
  </div>
</template>

<script setup lang="ts">
interface Props {
  term: string;
  description: string;
}

defineProps<Props>();
</script>

OpenAPI specification (optional)

No response

Configuration

No response

System information (optional)

No response

[jordanshatford]

@jashaj I have tested this locally in my setup:

Record<string, string> 

# and

{ [key: string]: string }

would act the same (both allowing setting numeric keys x[1] = 'some string'. Are you able to provide a setup for reproduction. They should act the same.

[jordanshatford]

@jashaj also using Object.keys, it thinks both have string keys. Not sure why with Vue it differs

[mrlubos]

At a quick glance, this seems to be a Vue issue? vuejs/core#8819

[mrlubos]

@jordanshatford remind me why was that type changed?

[jordanshatford]

@mrlubos #370

[mrlubos]

Should we try to detect circular imports and apply that type only then? Would that minimise the chance of this kind of issues?

[jordanshatford]

@mrlubos im not sure. In my above comment Record<string, string> DOES allow settings x[1] = 'some string'