Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEATURE]: On Dart with Freezed, be able to prevent conflicts with nested types on JSON Schema #2660

Open
polvallverdu opened this issue Oct 25, 2024 · 0 comments

Comments

@polvallverdu
Copy link

Context (Input, Language)

Input Format: Json Schema
Output Language: Dart Freezed

Description

Currently generating Freezed classes for Dart defines nested objects with their literal name, which may cause conflicts if multiple objects are needed. Some stuff is being done if it conflicts with it's own schema, but not for other schemas.

Current Behaviour / Output

bunx quicktype --lang dart --src-lang schema -t Fasfasfsa --just-types --use-freezed
{
  "type": "object",
  "properties": {
    "hello": {
      "type": "string"
    },
    "works": {
      "type": "object",
      "properties": {
        "yes": {
          "type": "boolean"
        },
        "no": {
          "type": "boolean"
        }
      },
      "required": ["yes", "no"],
      "additionalProperties": false
    }
  },
  "required": ["hello", "works"],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}
@freezed
class Fasfasfsa with _$Fasfasfsa {
    const factory Fasfasfsa({
        required String hello,
        required Works works,
    }) = _Fasfasfsa;
}

@freezed
class Works with _$Works {
    const factory Works({
        required bool no,
        required bool yes,
    }) = _Works;
}

Proposed Behaviour / Output

bunx quicktype --lang dart --src-lang schema -t Fasfasfsa --just-types --use-freezed
{
  "type": "object",
  "properties": {
    "hello": {
      "type": "string"
    },
    "works": {
      "type": "object",
      "properties": {
        "yes": {
          "type": "boolean"
        },
        "no": {
          "type": "boolean"
        }
      },
      "required": ["yes", "no"],
      "additionalProperties": false
    }
  },
  "required": ["hello", "works"],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}
@freezed
class Fasfasfsa with _$Fasfasfsa {
    const factory Fasfasfsa({
        required String hello,
        required Fasfasfsa_Works works,
    }) = _Fasfasfsa;
}

@freezed
class Fasfasfsa_Works with _$Fasfasfsa_Works {
    const factory Fasfasfsa_Works({
        required bool no,
        required bool yes,
    }) = _Fasfasfsa_Works;
}

Solution

Somehow relate nested objects with their parents, to prevent conflicts.

Alternatives

Having the ability to control those names somehow, without needing interactivity. (kinda impossible)

@polvallverdu polvallverdu changed the title [FEATURE]: feature description here [FEATURE]: On Dart with Freezed, be able to prevent conflicts with nested types on JSON Schema Oct 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant