Merge branch 'typescript-fixes'

package.json

@@ -171,6 +171,7 @@
             "rust/src/types.rs",
             "rust/Cargo.toml",
             "rust/Cargo.lock",
+            "ts/types.ts",
             ".vscode/settings.json"
           ]
         }

python/stencila/schema/types.py

@@ -3,6 +3,7 @@
 # in the `schema` directory and run `npm run build:python` to regenerate it.
 """Python classes for schema types."""
 
+# List is imported as Array to avoid conflict with the schema's List type
 from typing import Any, Dict, List as Array, Optional, Union
 from enum import Enum
 
@@ -236,7 +237,7 @@ class CodeChunk(CodeBlock):
     label: Optional[str] = None
     """A short label for the CodeChunk."""
 
-    outputs: Optional[Array["Node"]] = None
+    outputs: Optional[Array["Any"]] = None
     """Outputs from executing the chunk."""
 
     reads: Optional[Array[str]] = None
@@ -262,7 +263,7 @@ def __init__(
         imports: Optional[Array[Union["SoftwareSourceCode", "SoftwareApplication", str]]] = None,
         label: Optional[str] = None,
         meta: Optional[Dict[str, Any]] = None,
-        outputs: Optional[Array["Node"]] = None,
+        outputs: Optional[Array["Any"]] = None,
         programmingLanguage: Optional[str] = None,
         reads: Optional[Array[str]] = None,
         uses: Optional[Array[Union["Variable", str]]] = None
@@ -327,7 +328,7 @@ class CodeExpression(CodeFragment):
     errors: Optional[Array["CodeError"]] = None
     """Errors when compiling or executing the chunk."""
 
-    output: Optional["Node"] = None
+    output: Optional["Any"] = None
     """The value of the expression when it was last evaluated."""
 
 
@@ -338,7 +339,7 @@ def __init__(
         format: Optional[str] = None,
         id: Optional[str] = None,
         meta: Optional[Dict[str, Any]] = None,
-        output: Optional["Node"] = None,
+        output: Optional["Any"] = None,
         programmingLanguage: Optional[str] = None
     ) -> None:
         super().__init__(
@@ -1432,7 +1433,7 @@ class DatatableColumn(Thing):
     name: str # type: ignore
     """The name of the item."""
 
-    values: Array[Any]
+    values: Array["Any"]
     """The data values of the column."""
 
     validator: Optional["ArrayValidator"] = None
@@ -1442,7 +1443,7 @@ class DatatableColumn(Thing):
     def __init__(
         self,
         name: str,
-        values: Array[Any],
+        values: Array["Any"],
         alternateNames: Optional[Array[str]] = None,
         description: Optional[Union[Array["BlockContent"], Array["InlineContent"], str]] = None,
         id: Optional[str] = None,
@@ -1586,15 +1587,15 @@ def __init__(
 class ConstantValidator(Validator):
     """A validator specifying a constant value that a node must have."""
 
-    value: Optional["Node"] = None
+    value: Optional["Any"] = None
     """The value that the node must have."""
 
 
     def __init__(
         self,
         id: Optional[str] = None,
         meta: Optional[Dict[str, Any]] = None,
-        value: Optional["Node"] = None
+        value: Optional["Any"] = None
     ) -> None:
         super().__init__(
             id=id,
@@ -1607,15 +1608,15 @@ def __init__(
 class EnumValidator(Validator):
     """A schema specifying that a node must be one of several values."""
 
-    values: Optional[Array["Node"]] = None
+    values: Optional[Array["Any"]] = None
     """A node is valid if it is equal to any of these values."""
 
 
     def __init__(
         self,
         id: Optional[str] = None,
         meta: Optional[Dict[str, Any]] = None,
-        values: Optional[Array["Node"]] = None
+        values: Optional[Array["Any"]] = None
     ) -> None:
         super().__init__(
             id=id,
@@ -2085,7 +2086,7 @@ class ListItem(Thing):
     isChecked: Optional[bool] = None
     """A flag to indicate if this list item is checked."""
 
-    item: Optional["Node"] = None
+    item: Optional["Any"] = None
     """The item represented by this list item."""
 
     position: Optional[int] = None
@@ -2101,7 +2102,7 @@ def __init__(
         identifiers: Optional[Array[Union["PropertyValue", str]]] = None,
         images: Optional[Array[Union["ImageObject", str]]] = None,
         isChecked: Optional[bool] = None,
-        item: Optional["Node"] = None,
+        item: Optional["Any"] = None,
         meta: Optional[Dict[str, Any]] = None,
         name: Optional[str] = None,
         position: Optional[int] = None,
@@ -2467,7 +2468,7 @@ class Variable(Entity):
     validator: Optional["ValidatorTypes"] = None
     """The validator that the value is validated against."""
 
-    value: Optional["Node"] = None
+    value: Optional["Any"] = None
     """The value of the variable."""
 
 
@@ -2478,7 +2479,7 @@ def __init__(
         isReadonly: Optional[bool] = None,
         meta: Optional[Dict[str, Any]] = None,
         validator: Optional["ValidatorTypes"] = None,
-        value: Optional["Node"] = None
+        value: Optional["Any"] = None
     ) -> None:
         super().__init__(
             id=id,
@@ -2497,7 +2498,7 @@ def __init__(
 class Parameter(Variable):
     """A parameter that can be set and used in evaluated code."""
 
-    default: Optional["Node"] = None
+    default: Optional["Any"] = None
     """The default value of the parameter."""
 
     isExtensible: Optional[bool] = None
@@ -2513,15 +2514,15 @@ class Parameter(Variable):
     def __init__(
         self,
         name: str,
-        default: Optional["Node"] = None,
+        default: Optional["Any"] = None,
         id: Optional[str] = None,
         isExtensible: Optional[bool] = None,
         isReadonly: Optional[bool] = None,
         isRequired: Optional[bool] = None,
         isVariadic: Optional[bool] = None,
         meta: Optional[Dict[str, Any]] = None,
         validator: Optional["ValidatorTypes"] = None,
-        value: Optional["Node"] = None
+        value: Optional["Any"] = None
     ) -> None:
         super().__init__(
             name=name,
@@ -4390,7 +4391,7 @@ class CitationIntentEnumeration(Enum):
 """
 Union type for valid inline content.
 """
-InlineContent = Union["AudioObject", "Cite", "CiteGroup", "CodeExpression", "CodeFragment", "Delete", "Emphasis", "ImageObject", "Link", "MathFragment", "NontextualAnnotation", "Note", "Quote", "Strong", "Subscript", "Superscript", "VideoObject", None, bool, int, float, Array[Any], Dict[str, Any], str]
+InlineContent = Union["AudioObject", "Cite", "CiteGroup", "CodeExpression", "CodeFragment", "Delete", "Emphasis", "ImageObject", "Link", "MathFragment", "NontextualAnnotation", "Note", "Quote", "Strong", "Subscript", "Superscript", "VideoObject", None, bool, int, float, str]
 
 
 """
@@ -4414,7 +4415,7 @@ class CitationIntentEnumeration(Enum):
 """
 Union type for all schema nodes, including primitives and entities
 """
-Node = Union["ArrayValidator", "Article", "AudioObject", "BooleanValidator", "Brand", "CitationIntentEnumeration", "Cite", "CiteGroup", "Claim", "Code", "CodeBlock", "CodeChunk", "CodeError", "CodeExpression", "CodeFragment", "Collection", "Comment", "ConstantValidator", "ContactPoint", "CreativeWork", "Datatable", "DatatableColumn", "Date", "DefinedTerm", "Delete", "Emphasis", "EnumValidator", "Enumeration", "Figure", "Function", "Grant", "Heading", "ImageObject", "Include", "IntegerValidator", "Link", "List", "ListItem", "Mark", "Math", "MathBlock", "MathFragment", "MediaObject", "MonetaryGrant", "NontextualAnnotation", "Note", "NumberValidator", "Organization", "Paragraph", "Parameter", "Periodical", "Person", "PostalAddress", "Product", "PropertyValue", "PublicationIssue", "PublicationVolume", "Quote", "QuoteBlock", "Review", "SoftwareApplication", "SoftwareEnvironment", "SoftwareSession", "SoftwareSourceCode", "StringValidator", "Strong", "Subscript", "Superscript", "Table", "TableCell", "TableRow", "ThematicBreak", "Thing", "TupleValidator", "Validator", "Variable", "VideoObject", "VolumeMount", None, bool, int, float, str, Dict[str, Any], Array[Any]]
+Node = Union["Entity", "ArrayValidator", "Article", "AudioObject", "BooleanValidator", "Brand", "CitationIntentEnumeration", "Cite", "CiteGroup", "Claim", "Code", "CodeBlock", "CodeChunk", "CodeError", "CodeExpression", "CodeFragment", "Collection", "Comment", "ConstantValidator", "ContactPoint", "CreativeWork", "Datatable", "DatatableColumn", "Date", "DefinedTerm", "Delete", "Emphasis", "EnumValidator", "Enumeration", "Figure", "Function", "Grant", "Heading", "ImageObject", "Include", "IntegerValidator", "Link", "List", "ListItem", "Mark", "Math", "MathBlock", "MathFragment", "MediaObject", "MonetaryGrant", "NontextualAnnotation", "Note", "NumberValidator", "Organization", "Paragraph", "Parameter", "Periodical", "Person", "PostalAddress", "Product", "PropertyValue", "PublicationIssue", "PublicationVolume", "Quote", "QuoteBlock", "Review", "SoftwareApplication", "SoftwareEnvironment", "SoftwareSession", "SoftwareSourceCode", "StringValidator", "Strong", "Subscript", "Superscript", "Table", "TableCell", "TableRow", "ThematicBreak", "Thing", "TupleValidator", "Validator", "Variable", "VideoObject", "VolumeMount", None, bool, int, float, str, Dict[str, Any], Array["Any"]]
 
 
 """

r/R/types.R

@@ -1568,7 +1568,7 @@ DatatableColumn <- function(
   )
   self$type <- as_scalar("DatatableColumn")
   self[["name"]] <- check_property("DatatableColumn", "name", TRUE, missing(name), "character", name)
-  self[["values"]] <- check_property("DatatableColumn", "values", TRUE, missing(values), Array(Any()), values)
+  self[["values"]] <- check_property("DatatableColumn", "values", TRUE, missing(values), Array(Node), values)
   self[["validator"]] <- check_property("DatatableColumn", "validator", FALSE, missing(validator), ArrayValidator, validator)
   class(self) <- c(class(self), "DatatableColumn")
   self
@@ -4484,7 +4484,7 @@ GrantTypes <- Union(Grant, MonetaryGrant)
 #'
 #' @return A `list` of class `Union` describing valid subtypes of this type
 #' @export
-InlineContent <- Union(AudioObject, Cite, CiteGroup, CodeExpression, CodeFragment, Delete, Emphasis, ImageObject, Link, MathFragment, NontextualAnnotation, Note, Quote, Strong, Subscript, Superscript, VideoObject, "NULL", "logical", "numeric", Array(Any()), "list", "character")
+InlineContent <- Union(AudioObject, Cite, CiteGroup, CodeExpression, CodeFragment, Delete, Emphasis, ImageObject, Link, MathFragment, NontextualAnnotation, Note, Quote, Strong, Subscript, Superscript, VideoObject, "NULL", "logical", "numeric", "character")
 
 
 #' All type schemas that are derived from Mark
@@ -4512,7 +4512,7 @@ MediaObjectTypes <- Union(MediaObject, AudioObject, ImageObject, VideoObject)
 #'
 #' @return A `list` of class `Union` describing valid subtypes of this type
 #' @export
-Node <- Union(ArrayValidator, Article, AudioObject, BooleanValidator, Brand, CitationIntentEnumeration, Cite, CiteGroup, Claim, Code, CodeBlock, CodeChunk, CodeError, CodeExpression, CodeFragment, Collection, Comment, ConstantValidator, ContactPoint, CreativeWork, Datatable, DatatableColumn, Date, DefinedTerm, Delete, Emphasis, EnumValidator, Enumeration, Figure, Function, Grant, Heading, ImageObject, Include, IntegerValidator, Link, List, ListItem, Mark, Math, MathBlock, MathFragment, MediaObject, MonetaryGrant, NontextualAnnotation, Note, NumberValidator, Organization, Paragraph, Parameter, Periodical, Person, PostalAddress, Product, PropertyValue, PublicationIssue, PublicationVolume, Quote, QuoteBlock, Review, SoftwareApplication, SoftwareEnvironment, SoftwareSession, SoftwareSourceCode, StringValidator, Strong, Subscript, Superscript, Table, TableCell, TableRow, ThematicBreak, Thing, TupleValidator, Validator, Variable, VideoObject, VolumeMount, "NULL", "logical", "numeric", "character", "list", Array(Any()))
+Node <- Union(Entity, ArrayValidator, Article, AudioObject, BooleanValidator, Brand, CitationIntentEnumeration, Cite, CiteGroup, Claim, Code, CodeBlock, CodeChunk, CodeError, CodeExpression, CodeFragment, Collection, Comment, ConstantValidator, ContactPoint, CreativeWork, Datatable, DatatableColumn, Date, DefinedTerm, Delete, Emphasis, EnumValidator, Enumeration, Figure, Function, Grant, Heading, ImageObject, Include, IntegerValidator, Link, List, ListItem, Mark, Math, MathBlock, MathFragment, MediaObject, MonetaryGrant, NontextualAnnotation, Note, NumberValidator, Organization, Paragraph, Parameter, Periodical, Person, PostalAddress, Product, PropertyValue, PublicationIssue, PublicationVolume, Quote, QuoteBlock, Review, SoftwareApplication, SoftwareEnvironment, SoftwareSession, SoftwareSourceCode, StringValidator, Strong, Subscript, Superscript, Table, TableCell, TableRow, ThematicBreak, Thing, TupleValidator, Validator, Variable, VideoObject, VolumeMount, "NULL", "logical", "numeric", "character", "list", Array(Node))
 
 
 #' All type schemas that are derived from Thing

rust/src/types.rs

@@ -1588,7 +1588,7 @@ pub struct DatatableColumn {
     pub name: String,
 
     /// The data values of the column.
-    pub values: Array,
+    pub values: Vec<Node>,
 
     /// Alternate names (aliases) for the item.
     pub alternate_names: Option<Vec<String>>,
@@ -5364,8 +5364,6 @@ pub enum InlineContent {
     Boolean(Boolean),
     Integer(Integer),
     Number(Number),
-    Array(Array),
-    Object(Object),
     String(String),
 }
 
@@ -5409,6 +5407,7 @@ pub enum MediaObjectTypes {
 #[derive(Clone, Debug, Serialize, Deserialize)]
 #[serde(untagged)]
 pub enum Node {
+    Entity(Entity),
     ArrayValidator(ArrayValidator),
     Article(Article),
     AudioObject(AudioObject),
@@ -5493,7 +5492,7 @@ pub enum Node {
     Number(Number),
     String(String),
     Object(Object),
-    Array(Array),
+    Array(Vec<Node>),
 }
 
 /// All type schemas that are derived from Thing

schema/Array.schema.yaml

@@ -4,3 +4,5 @@ category: data
 status: stable
 description: A value comprised of several other values.
 type: array
+items:
+  $ref: Node

schema/DatatableColumn.schema.yaml

@@ -15,6 +15,8 @@ properties:
     '@id': stencila:values
     description: The data values of the column.
     type: array
+    items:
+      $ref: Node
 required:
   - name
   - values

schema/InlineContent.schema.yaml

@@ -30,6 +30,4 @@ anyOf:
   - type: boolean
   - type: integer
   - type: number
-  - type: array
-  - type: object
   - type: string

schema/Node.schema.yaml

@@ -16,3 +16,5 @@ anyOf:
   - type: string
   - type: object
   - type: array
+    items:
+      $ref: Node

ts/.gitignore

@@ -1,3 +1 @@
 docs
-types.ts
-util/type-maps.ts

ts/bindings/python.ts

@@ -57,6 +57,7 @@ async function build(): Promise<void> {
   )}
 """Python classes for schema types."""
 
+# List is imported as Array to avoid conflict with the schema's List type
 from typing import Any, Dict, List as Array, Optional, Union
 from enum import Enum
 
@@ -212,12 +213,19 @@ export function unionGenerator(schema: JsonSchema): string {
 }
 
 /**
- * Convert a schema definition to a Python type
+ * Convert a schema definition to a Python type.
+ *
+ * To avoid cyclic type definitions in MyPy, the type `Node` is converted
+ * to a Python `Any`. See https://github.com/python/mypy/issues/731
  */
 function schemaToType(schema: JsonSchema): string {
   const { type, anyOf, allOf, $ref } = schema
 
-  if ($ref !== undefined) return `"${$ref.replace('.schema.json', '')}"`
+  if ($ref !== undefined) {
+    const title = $ref.replace('.schema.json', '')
+    return `"${title === 'Node' ? 'Any' : title}"`
+  }
+
   if (anyOf !== undefined) return anyOfToType(anyOf)
   if (allOf !== undefined) return allOfToType(allOf)
   if (schema.enum !== undefined) return enumToType(schema['@id'], schema.enum)

ts/bindings/rust.ts

@@ -326,15 +326,16 @@ export function unionSchemaToEnum(
 
   const variants = anyOf
     ?.map((schema) => {
-      const name = schemaToType(schema, context)
-      if (name === 'Null') return `    Null,\n`
+      const type = schemaToType(schema, context)
+      if (type === 'Null') return `    Null,\n`
       if (
         (title === 'InlineContent' || title === 'BlockContent') &&
-        isCreativeWorkContent(name)
+        isCreativeWorkContent(type)
       ) {
-        return `    ${name}(${name}Simple),\n`
+        return `    ${type}(${type}Simple),\n`
       }
-      return `    ${name}(${name}),\n`
+      const name = type === 'Vec<Node>' ? 'Array' : type
+      return `    ${name}(${type}),\n`
     })
     .join('')
 
@@ -432,6 +433,6 @@ function arrayToType(schema: JsonSchema, context: Context): string {
     ? anyOfToEnum(schema.items, context)
     : schema.items !== undefined
     ? schemaToType(schema.items, context)
-    : 'ANY'
-  return items === 'ANY' ? 'Array' : `Vec<${items}>`
+    : '?'
+  return `Vec<${items}>`
 }