shopify_draft_proxy - v0.1.0

shopify_draft_proxy/graphql/ast

Mirrors the operation-document subset of graphql-js language/ast.ts.

The proxy only parses GraphQL executable documents (queries, mutations, subscriptions, fragments) sent by clients. Schema-definition nodes (ScalarTypeDefinition, ObjectTypeDefinition, type extensions, directive definitions, etc.) are intentionally not represented here — the Gleam port does not parse schema text.

Field naming differs from graphql-js where JS keywords or stylistic preferences require it: type becomes type_ref / inner / type_condition, camelCase becomes snake_case throughout. Location only carries the start/end character offsets used by error reporting; graphql-js additionally stores start/end token references, which the parser does not need.

Types

Argument

name: value. Used inside arguments lists on fields and directives.

pub type Argument {
  Argument(
    name: Name,
    value: Value,
    loc: option.Option(Location),
  )
}

Constructors

Definition

Top-level executable definitions. Mirrors ExecutableDefinitionNode.

pub type Definition {
  OperationDefinition(
    operation: OperationType,
    name: option.Option(Name),
    variable_definitions: List(VariableDefinition),
    directives: List(Directive),
    selection_set: SelectionSet,
    loc: option.Option(Location),
  )
  FragmentDefinition(
    name: Name,
    type_condition: TypeRef,
    directives: List(Directive),
    selection_set: SelectionSet,
    loc: option.Option(Location),
  )
}

Constructors

Directive

@name(arg: …) decorating a field, fragment, definition, etc.

pub type Directive {
  Directive(
    name: Name,
    arguments: List(Argument),
    loc: option.Option(Location),
  )
}

Constructors

Document

A complete GraphQL document. Mirrors DocumentNode.

pub type Document {
  Document(
    definitions: List(Definition),
    loc: option.Option(Location),
  )
}

Constructors

Location

Source range a node was parsed from. 0-indexed code-point offsets into the originating Source.body. Mirrors graphql-js’s Location.start and .end; the startToken/endToken and source fields are omitted because the proxy does not consume them.

pub type Location {
  Location(start: Int, end: Int)
}

Constructors 

  • Location(start: Int, end: Int)

Name

A Name — an identifier in the source. Mirrors NameNode.

pub type Name {
  Name(value: String, loc: option.Option(Location))
}

Constructors

ObjectField

A single key/value pair inside an ObjectValue.

pub type ObjectField {
  ObjectField(
    name: Name,
    value: Value,
    loc: option.Option(Location),
  )
}

Constructors

OperationType

query, mutation, or subscription.

pub type OperationType {
  Query
  Mutation
  Subscription
}

Constructors 

  • Query
  • Mutation
  • Subscription

Selection

One element of a selection set. Mirrors SelectionNode.

pub type Selection {
  Field(
    alias: option.Option(Name),
    name: Name,
    arguments: List(Argument),
    directives: List(Directive),
    selection_set: option.Option(SelectionSet),
    loc: option.Option(Location),
  )
  FragmentSpread(
    name: Name,
    directives: List(Directive),
    loc: option.Option(Location),
  )
  InlineFragment(
    type_condition: option.Option(TypeRef),
    directives: List(Directive),
    selection_set: SelectionSet,
    loc: option.Option(Location),
  )
}

Constructors

SelectionSet

{ … }. Wraps the list of selections so it can carry its own location.

pub type SelectionSet {
  SelectionSet(
    selections: List(Selection),
    loc: option.Option(Location),
  )
}

Constructors

TypeRef

Type references in variable definitions. Mirrors TypeNode. The name TypeRef is used (not Type) to avoid colliding with the built-in Gleam concept of “type”.

pub type TypeRef {
  NamedType(name: Name, loc: option.Option(Location))
  ListType(inner: TypeRef, loc: option.Option(Location))
  NonNullType(inner: TypeRef, loc: option.Option(Location))
}

Constructors

Value

GraphQL value literal. Mirrors ValueNode. The block flag on StringValue distinguishes single-quoted from triple-quoted strings, matching graphql-js.

pub type Value {
  IntValue(value: String, loc: option.Option(Location))
  FloatValue(value: String, loc: option.Option(Location))
  StringValue(
    value: String,
    block: Bool,
    loc: option.Option(Location),
  )
  BooleanValue(value: Bool, loc: option.Option(Location))
  NullValue(loc: option.Option(Location))
  EnumValue(value: String, loc: option.Option(Location))
  ListValue(values: List(Value), loc: option.Option(Location))
  ObjectValue(
    fields: List(ObjectField),
    loc: option.Option(Location),
  )
  VariableValue(variable: Variable)
}

Constructors

Variable

$variable. Used both standalone (in VariableDefinition.variable) and nested inside a Value via VariableValue. graphql-js represents this as a single VariableNode; Gleam needs a wrapper variant on Value to fit the VariableNode | … union into a sum type.

pub type Variable {
  Variable(name: Name, loc: option.Option(Location))
}

Constructors

VariableDefinition

$var: Type = default @directive. Used inside operation definitions.

pub type VariableDefinition {
  VariableDefinition(
    variable: Variable,
    type_ref: TypeRef,
    default_value: option.Option(Value),
    directives: List(Directive),
    loc: option.Option(Location),
  )
}

Constructors

✨ Search Document