@twin.org/data-json-ld 0.0.2-next.4 → 0.0.3-next.2

package/dist/es/models/jsonLdTypes.js

@@ -0,0 +1,113 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types of JSON-LD data.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const JsonLdTypes = {
+    /**
+     * Represents JSON-LD Document.
+     */
+    Document: "JsonLdDocument",
+    /**
+     * Represents JSON-LD Object.
+     */
+    Object: "JsonLdObject",
+    /**
+     * Represents JSON-LD Node Object.
+     */
+    NodeObject: "JsonLdNodeObject",
+    /**
+     * Represents JSON-LD Node Primitive.
+     */
+    NodePrimitive: "JsonLdNodePrimitive",
+    /**
+     * Represents JSON-LD Graph Object.
+     */
+    GraphObject: "JsonLdGraphObject",
+    /**
+     * Represents JSON-LD Value Object.
+     */
+    ValueObject: "JsonLdValueObject",
+    /**
+     * Represents JSON-LD List Object.
+     */
+    ListObject: "JsonLdListObject",
+    /**
+     * Represents JSON-LD Set Object.
+     */
+    SetObject: "JsonLdSetObject",
+    /**
+     * Represents JSON-LD Language Map.
+     */
+    LanguageMap: "JsonLdLanguageMap",
+    /**
+     * Represents JSON-LD Index Map.
+     */
+    IndexMap: "JsonLdIndexMap",
+    /**
+     * Represents JSON-LD Index Map Item.
+     */
+    IndexMapItem: "JsonLdIndexMapItem",
+    /**
+     * Represents JSON-LD Id Map.
+     */
+    IdMap: "JsonLdIdMap",
+    /**
+     * Represents JSON-LD Type Map.
+     */
+    TypeMap: "JsonLdTypeMap",
+    /**
+     * Represents JSON-LD Included block.
+     */
+    IncludedBlock: "JsonLdIncludedBlock",
+    /**
+     * Represents JSON-LD Context Definition.
+     */
+    ContextDefinition: "JsonLdContextDefinition",
+    /**
+     * Represents JSON-LD Context Definition Element.
+     */
+    ContextDefinitionElement: "JsonLdContextDefinitionElement",
+    /**
+     * Represents JSON-LD Context Definition Root.
+     */
+    ContextDefinitionRoot: "JsonLdContextDefinitionRoot",
+    /**
+     * Represents JSON-LD Expanded Term Definition.
+     */
+    ExpandedTermDefinition: "JsonLdExpandedTermDefinition",
+    /**
+     * Represents JSON-LD Keyword.
+     */
+    Keyword: "JsonLdKeyword",
+    /**
+     * Represents JSON-LD List or Set Item.
+     */
+    ListOrSetItem: "JsonLdListOrSetItem",
+    /**
+     * Represents JSON-LD Container Type.
+     */
+    ContainerType: "JsonLdContainerType",
+    /**
+     * Represents JSON-LD Container Type Array.
+     */
+    ContainerTypeArray: "JsonLdContainerTypeArray",
+    /**
+     * Represents JSON-LD JSON Primitive.
+     */
+    JsonPrimitive: "JsonLdJsonPrimitive",
+    /**
+     * Represents JSON-LD JSON Array.
+     */
+    JsonArray: "JsonLdJsonArray",
+    /**
+     * Represents JSON-LD JSON Object.
+     */
+    JsonObject: "JsonLdJsonObject",
+    /**
+     * Represents JSON-LD JSON Value.
+     */
+    JsonValue: "JsonLdJsonValue"
+};
+//# sourceMappingURL=jsonLdTypes.js.map

package/dist/es/models/jsonLdTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsonLdTypes.js","sourceRoot":"","sources":["../../../src/models/jsonLdTypes.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,WAAW,GAAG;IAC1B;;OAEG;IACH,QAAQ,EAAE,gBAAgB;IAE1B;;OAEG;IACH,MAAM,EAAE,cAAc;IAEtB;;OAEG;IACH,UAAU,EAAE,kBAAkB;IAE9B;;OAEG;IACH,aAAa,EAAE,qBAAqB;IAEpC;;OAEG;IACH,WAAW,EAAE,mBAAmB;IAEhC;;OAEG;IACH,WAAW,EAAE,mBAAmB;IAEhC;;OAEG;IACH,UAAU,EAAE,kBAAkB;IAE9B;;OAEG;IACH,SAAS,EAAE,iBAAiB;IAE5B;;OAEG;IACH,WAAW,EAAE,mBAAmB;IAEhC;;OAEG;IACH,QAAQ,EAAE,gBAAgB;IAE1B;;OAEG;IACH,YAAY,EAAE,oBAAoB;IAElC;;OAEG;IACH,KAAK,EAAE,aAAa;IAEpB;;OAEG;IACH,OAAO,EAAE,eAAe;IAExB;;OAEG;IACH,aAAa,EAAE,qBAAqB;IAEpC;;OAEG;IACH,iBAAiB,EAAE,yBAAyB;IAE5C;;OAEG;IACH,wBAAwB,EAAE,gCAAgC;IAE1D;;OAEG;IACH,qBAAqB,EAAE,6BAA6B;IAEpD;;OAEG;IACH,sBAAsB,EAAE,8BAA8B;IAEtD;;OAEG;IACH,OAAO,EAAE,eAAe;IAExB;;OAEG;IACH,aAAa,EAAE,qBAAqB;IAEpC;;OAEG;IACH,aAAa,EAAE,qBAAqB;IAEpC;;OAEG;IACH,kBAAkB,EAAE,0BAA0B;IAE9C;;OAEG;IACH,aAAa,EAAE,qBAAqB;IAEpC;;OAEG;IACH,SAAS,EAAE,iBAAiB;IAE5B;;OAEG;IACH,UAAU,EAAE,kBAAkB;IAE9B;;OAEG;IACH,SAAS,EAAE,iBAAiB;CACnB,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The types of JSON-LD data.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const JsonLdTypes = {\n\t/**\n\t * Represents JSON-LD Document.\n\t */\n\tDocument: \"JsonLdDocument\",\n\n\t/**\n\t * Represents JSON-LD Object.\n\t */\n\tObject: \"JsonLdObject\",\n\n\t/**\n\t * Represents JSON-LD Node Object.\n\t */\n\tNodeObject: \"JsonLdNodeObject\",\n\n\t/**\n\t * Represents JSON-LD Node Primitive.\n\t */\n\tNodePrimitive: \"JsonLdNodePrimitive\",\n\n\t/**\n\t * Represents JSON-LD Graph Object.\n\t */\n\tGraphObject: \"JsonLdGraphObject\",\n\n\t/**\n\t * Represents JSON-LD Value Object.\n\t */\n\tValueObject: \"JsonLdValueObject\",\n\n\t/**\n\t * Represents JSON-LD List Object.\n\t */\n\tListObject: \"JsonLdListObject\",\n\n\t/**\n\t * Represents JSON-LD Set Object.\n\t */\n\tSetObject: \"JsonLdSetObject\",\n\n\t/**\n\t * Represents JSON-LD Language Map.\n\t */\n\tLanguageMap: \"JsonLdLanguageMap\",\n\n\t/**\n\t * Represents JSON-LD Index Map.\n\t */\n\tIndexMap: \"JsonLdIndexMap\",\n\n\t/**\n\t * Represents JSON-LD Index Map Item.\n\t */\n\tIndexMapItem: \"JsonLdIndexMapItem\",\n\n\t/**\n\t * Represents JSON-LD Id Map.\n\t */\n\tIdMap: \"JsonLdIdMap\",\n\n\t/**\n\t * Represents JSON-LD Type Map.\n\t */\n\tTypeMap: \"JsonLdTypeMap\",\n\n\t/**\n\t * Represents JSON-LD Included block.\n\t */\n\tIncludedBlock: \"JsonLdIncludedBlock\",\n\n\t/**\n\t * Represents JSON-LD Context Definition.\n\t */\n\tContextDefinition: \"JsonLdContextDefinition\",\n\n\t/**\n\t * Represents JSON-LD Context Definition Element.\n\t */\n\tContextDefinitionElement: \"JsonLdContextDefinitionElement\",\n\n\t/**\n\t * Represents JSON-LD Context Definition Root.\n\t */\n\tContextDefinitionRoot: \"JsonLdContextDefinitionRoot\",\n\n\t/**\n\t * Represents JSON-LD Expanded Term Definition.\n\t */\n\tExpandedTermDefinition: \"JsonLdExpandedTermDefinition\",\n\n\t/**\n\t * Represents JSON-LD Keyword.\n\t */\n\tKeyword: \"JsonLdKeyword\",\n\n\t/**\n\t * Represents JSON-LD List or Set Item.\n\t */\n\tListOrSetItem: \"JsonLdListOrSetItem\",\n\n\t/**\n\t * Represents JSON-LD Container Type.\n\t */\n\tContainerType: \"JsonLdContainerType\",\n\n\t/**\n\t * Represents JSON-LD Container Type Array.\n\t */\n\tContainerTypeArray: \"JsonLdContainerTypeArray\",\n\n\t/**\n\t * Represents JSON-LD JSON Primitive.\n\t */\n\tJsonPrimitive: \"JsonLdJsonPrimitive\",\n\n\t/**\n\t * Represents JSON-LD JSON Array.\n\t */\n\tJsonArray: \"JsonLdJsonArray\",\n\n\t/**\n\t * Represents JSON-LD JSON Object.\n\t */\n\tJsonObject: \"JsonLdJsonObject\",\n\n\t/**\n\t * Represents JSON-LD JSON Value.\n\t */\n\tJsonValue: \"JsonLdJsonValue\"\n} as const;\n\n/**\n * The types of JSON-LD data.\n */\nexport type JsonLdTypes = (typeof JsonLdTypes)[keyof typeof JsonLdTypes];\n"]}

package/dist/es/schemas/JsonLdContainerType.json

@@ -0,0 +1,13 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/json-ld/JsonLdContainerType",
+    "description": "JSON-LD container types.",
+    "type": "string",
+    "enum": [
+        "@language",
+        "@index",
+        "@id",
+        "@graph",
+        "@type"
+    ]
+}

package/dist/es/schemas/JsonLdContainerTypeArray.json

@@ -0,0 +1,179 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/json-ld/JsonLdContainerTypeArray",
+    "description": "JSON-LD container type array.",
+    "anyOf": [
+        {
+            "type": "array",
+            "items": {
+                "allOf": [
+                    {
+                        "type": "string",
+                        "const": "@graph"
+                    },
+                    {
+                        "type": "string",
+                        "const": "@id"
+                    }
+                ]
+            }
+        },
+        {
+            "type": "array",
+            "items": {
+                "allOf": [
+                    {
+                        "type": "string",
+                        "const": "@id"
+                    },
+                    {
+                        "type": "string",
+                        "const": "@graph"
+                    }
+                ]
+            }
+        },
+        {
+            "type": "array",
+            "items": {
+                "allOf": [
+                    {
+                        "type": "string",
+                        "const": "@set"
+                    },
+                    {
+                        "type": "string",
+                        "const": "@graph"
+                    },
+                    {
+                        "type": "string",
+                        "const": "@id"
+                    }
+                ]
+            }
+        },
+        {
+            "type": "array",
+            "items": {
+                "allOf": [
+                    {
+                        "type": "string",
+                        "const": "@set"
+                    },
+                    {
+                        "type": "string",
+                        "const": "@id"
+                    },
+                    {
+                        "type": "string",
+                        "const": "@graph"
+                    }
+                ]
+            }
+        },
+        {
+            "type": "array",
+            "items": {
+                "allOf": [
+                    {
+                        "type": "string",
+                        "const": "@graph"
+                    },
+                    {
+                        "type": "string",
+                        "const": "@set"
+                    },
+                    {
+                        "type": "string",
+                        "const": "@id"
+                    }
+                ]
+            }
+        },
+        {
+            "type": "array",
+            "items": {
+                "allOf": [
+                    {
+                        "type": "string",
+                        "const": "@id"
+                    },
+                    {
+                        "type": "string",
+                        "const": "@set"
+                    },
+                    {
+                        "type": "string",
+                        "const": "@graph"
+                    }
+                ]
+            }
+        },
+        {
+            "type": "array",
+            "items": {
+                "allOf": [
+                    {
+                        "type": "string",
+                        "const": "@graph"
+                    },
+                    {
+                        "type": "string",
+                        "const": "@id"
+                    },
+                    {
+                        "type": "string",
+                        "const": "@set"
+                    }
+                ]
+            }
+        },
+        {
+            "type": "array",
+            "items": {
+                "allOf": [
+                    {
+                        "type": "string",
+                        "const": "@id"
+                    },
+                    {
+                        "type": "string",
+                        "const": "@graph"
+                    },
+                    {
+                        "type": "string",
+                        "const": "@set"
+                    }
+                ]
+            }
+        },
+        {
+            "type": "array",
+            "items": {
+                "allOf": [
+                    {
+                        "type": "string",
+                        "const": "@set"
+                    },
+                    {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContainerType"
+                    }
+                ]
+            }
+        },
+        {
+            "type": "array",
+            "items": {
+                "allOf": [
+                    {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContainerType"
+                    },
+                    {
+                        "type": "string",
+                        "const": "@set"
+                    }
+                ]
+            }
+        }
+    ]
+}

package/dist/es/schemas/JsonLdContextDefinition.json

@@ -0,0 +1,76 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/json-ld/JsonLdContextDefinition",
+    "description": "A context definition defines a local context in a node object.",
+    "type": "object",
+    "properties": {
+        "@base": {
+            "type": [
+                "string",
+                "null"
+            ]
+        },
+        "@direction": {
+            "type": [
+                "string",
+                "null"
+            ],
+            "enum": [
+                "ltr",
+                "rtl",
+                null
+            ]
+        },
+        "@import": {
+            "type": "string"
+        },
+        "@language": {
+            "type": "string"
+        },
+        "@propagate": {
+            "type": "boolean"
+        },
+        "@protected": {
+            "type": "boolean"
+        },
+        "@type": {
+            "type": "object",
+            "properties": {
+                "@container": {
+                    "type": "string",
+                    "const": "@set"
+                },
+                "@protected": {
+                    "type": "boolean"
+                }
+            },
+            "required": [
+                "@container"
+            ],
+            "additionalProperties": false
+        },
+        "@version": {
+            "type": "string",
+            "const": "1.1"
+        },
+        "@vocab": {
+            "type": [
+                "string",
+                "null"
+            ]
+        }
+    },
+    "additionalProperties": {
+        "anyOf": [
+            {
+                "type": "null"
+            },
+            {
+                "type": "string"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdExpandedTermDefinition"
+            }
+        ]
+    }
+}

package/dist/es/schemas/JsonLdContextDefinitionElement.json

@@ -0,0 +1,16 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement",
+    "description": "A context definition element is used to define the types of a context definition.",
+    "anyOf": [
+        {
+            "type": "null"
+        },
+        {
+            "type": "string"
+        },
+        {
+            "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinition"
+        }
+    ]
+}

package/dist/es/schemas/JsonLdContextDefinitionRoot.json

@@ -0,0 +1,16 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionRoot",
+    "description": "A context definition root is used to define the root of a context definition.",
+    "anyOf": [
+        {
+            "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+        },
+        {
+            "type": "array",
+            "items": {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+            }
+        }
+    ]
+}

package/dist/es/schemas/JsonLdDocument.json

@@ -0,0 +1,48 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/json-ld/JsonLdDocument",
+    "description": "A JSON-LD document MUST be valid JSON text as described in [RFC8259], or some format that can be represented in the JSON-LD internal representation that is equivalent to valid JSON text.",
+    "anyOf": [
+        {
+            "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+        },
+        {
+            "type": "array",
+            "items": {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+            }
+        },
+        {
+            "type": "object",
+            "properties": {
+                "@context": {
+                    "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionRoot"
+                },
+                "@graph": {
+                    "anyOf": [
+                        {
+                            "$ref": "https://schema.twindev.org/json-ld/JsonLdValueObject"
+                        },
+                        {
+                            "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "anyOf": [
+                                    {
+                                        "$ref": "https://schema.twindev.org/json-ld/JsonLdValueObject"
+                                    },
+                                    {
+                                        "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+                                    }
+                                ]
+                            }
+                        }
+                    ]
+                }
+            },
+            "additionalProperties": false
+        }
+    ]
+}

package/dist/es/schemas/JsonLdExpandedTermDefinition.json

@@ -0,0 +1,136 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/json-ld/JsonLdExpandedTermDefinition",
+    "description": "An expanded term definition is used to describe the mapping between a term and its expanded identifier, as well as other properties of the value associated with the term when it is used as key in a node object.",
+    "anyOf": [
+        {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "@id": {
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        },
+                        {
+                            "type": "null"
+                        }
+                    ]
+                },
+                "@nest": {
+                    "type": "string"
+                },
+                "@container": {
+                    "anyOf": [
+                        {
+                            "type": "string",
+                            "const": "@list"
+                        },
+                        {
+                            "type": "string",
+                            "const": "@set"
+                        },
+                        {
+                            "$ref": "https://schema.twindev.org/json-ld/JsonLdContainerType"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "anyOf": [
+                                    {
+                                        "type": "string",
+                                        "const": "@list"
+                                    },
+                                    {
+                                        "type": "string",
+                                        "const": "@set"
+                                    },
+                                    {
+                                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContainerType"
+                                    }
+                                ]
+                            }
+                        },
+                        {
+                            "$ref": "https://schema.twindev.org/json-ld/JsonLdContainerTypeArray"
+                        },
+                        {
+                            "type": "null"
+                        }
+                    ]
+                },
+                "@type": {
+                    "type": "string"
+                },
+                "@language": {
+                    "type": "string"
+                },
+                "@index": {
+                    "type": "string"
+                },
+                "@context": {
+                    "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinition"
+                },
+                "@prefix": {
+                    "type": "boolean"
+                },
+                "@propagate": {
+                    "type": "boolean"
+                },
+                "@protected": {
+                    "type": "boolean"
+                }
+            }
+        },
+        {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "@reverse": {
+                    "type": "string"
+                },
+                "@container": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "enum": [
+                        "@set",
+                        "@index",
+                        null
+                    ]
+                },
+                "@type": {
+                    "type": "string"
+                },
+                "@language": {
+                    "type": "string"
+                },
+                "@index": {
+                    "type": "string"
+                },
+                "@context": {
+                    "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinition"
+                },
+                "@prefix": {
+                    "type": "boolean"
+                },
+                "@propagate": {
+                    "type": "boolean"
+                },
+                "@protected": {
+                    "type": "boolean"
+                }
+            },
+            "required": [
+                "@reverse"
+            ]
+        }
+    ]
+}

package/dist/es/schemas/JsonLdGraphObject.json

@@ -0,0 +1,44 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/json-ld/JsonLdGraphObject",
+    "description": "A graph object represents a named graph, which MAY include an explicit graph name.",
+    "type": "object",
+    "properties": {
+        "@graph": {
+            "anyOf": [
+                {
+                    "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+                    }
+                }
+            ]
+        },
+        "@index": {
+            "type": "string"
+        },
+        "@id": {
+            "anyOf": [
+                {
+                    "type": "string"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                }
+            ]
+        },
+        "@context": {
+            "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionRoot"
+        }
+    },
+    "required": [
+        "@graph"
+    ],
+    "additionalProperties": false
+}

package/dist/es/schemas/JsonLdIdMap.json

@@ -0,0 +1,9 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/json-ld/JsonLdIdMap",
+    "description": "An id map is used to associate an IRI with a value that allows easy programmatic access.",
+    "type": "object",
+    "additionalProperties": {
+        "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+    }
+}

package/dist/es/schemas/JsonLdIncludedBlock.json

@@ -0,0 +1,16 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock",
+    "description": "An included block is used to provide a set of node objects.",
+    "anyOf": [
+        {
+            "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+        },
+        {
+            "type": "array",
+            "items": {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+            }
+        }
+    ]
+}