Type Coercion / Node Conversion

lsimichael commented 4 years ago

(See below)

michaelcpuckett commented 4 years ago

I have an idea for a future version of JSON-LD Framing.

As a web developer, I would like to receive a JSON document from i.e. a simple API, add a @context to it, and perform JSON-LD operations. This light approach has been a big selling point to me for using JSON-LD.

A common response from such an API may include an "id" property as a number (as it is indexed in the source database as an integer), so after applying the @context the document may look like this:

{
  "@context": {
    "@base": "http://starwars.com/",
    "@vocab": "http://starwars.com/",
    "id": "@id",
    "type": "@type"
  },
  "id": 123,
  "type": "Human",
  "firstName": "Luke",
  "lastName": "Skywalker"
}

The expansion step will generate an error:

Invalid JSON-LD syntax; "@id" value must a string.

This makes sense, but my intention in declaring the @base was to form the IRI "http://starwars.com/123". I don't think this kind of type coercion is currently possible with JSON-LD.

The alternative would be a blank node with a custom ID property, which is less useful in certain situations.

I propose a framing solution that generates a new triple with the coerced XSD type and removes the original, so that when flattened, it becomes:

[
  {
    "@id": "http://starwars.com/123",
    "@type": [
      "http://starwars.com/Human"
    ],
    "http://starwars.com/firstName": [
      {
        "@value": "Luke"
      }
    ],
    "http://starwars.com/lastName": [
      {
        "@value": "Skywalker"
      }
    ]
  }
]

As a starting point, I suggest adding a term called @coerce.

gkellogg commented 4 years ago

This would probably be in compaction/expansion rather than framing. It is somewhat similar to the useNativeTypes option for fromRdf.

It’s a common idiom in JSON, so it’s worthy of future consideration.

michaelcpuckett commented 4 years ago

Thanks! I opened a new issue in the other repo.

https://github.com/w3c/json-ld-syntax/issues/335

If that's right, this can be closed.

w3c / json-ld-framing

Type Coercion / Node Conversion #98