@twin.org/standards-foaf 0.0.3-next.10

package/dist/es/schemas/FoafImage.json

@@ -0,0 +1,173 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/foaf/FoafImage",
+    "description": "A FOAF image.",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "description": "The FOAF JSON-LD context type.",
+            "anyOf": [
+                {
+                    "type": "string",
+                    "const": "https://xmlns.com/foaf/0.1/"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "const": "https://xmlns.com/foaf/0.1/"
+                    },
+                    "minItems": 1,
+                    "maxItems": 1
+                },
+                {
+                    "type": "array",
+                    "minItems": 1,
+                    "prefixItems": [
+                        {
+                            "type": "string",
+                            "const": "https://xmlns.com/foaf/0.1/"
+                        }
+                    ],
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                    }
+                }
+            ]
+        },
+        "@id": {
+            "anyOf": [
+                {
+                    "type": "string"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                }
+            ]
+        },
+        "@included": {
+            "$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
+        },
+        "@graph": {
+            "anyOf": [
+                {
+                    "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+                    }
+                }
+            ]
+        },
+        "@nest": {
+            "anyOf": [
+                {
+                    "$ref": "https://schema.twindev.org/json-ld/JsonLdJsonObject"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdJsonObject"
+                    }
+                }
+            ]
+        },
+        "@type": {
+            "type": "string",
+            "const": "Image",
+            "description": "Type."
+        },
+        "@reverse": {
+            "type": "object",
+            "additionalProperties": {
+                "type": "string"
+            }
+        },
+        "@index": {
+            "type": "string"
+        },
+        "name": {
+            "type": "string",
+            "description": "A name for some thing."
+        },
+        "title": {
+            "type": "string",
+            "description": "Title (Mr, Mrs, Ms, Dr. etc)"
+        },
+        "mbox": {
+            "type": "string",
+            "description": "A personal mailbox, ie. an Internet mailbox associated with exactly one owner, the first owner of this mailbox"
+        },
+        "homepage": {
+            "type": "string",
+            "description": "A homepage for some thing."
+        },
+        "depiction": {
+            "$ref": "https://schema.twindev.org/foaf/FoafImage",
+            "description": "A depiction of some thing."
+        },
+        "topic": {
+            "type": "string",
+            "description": "A topic of some page or document."
+        },
+        "primaryTopic": {
+            "description": "Object or array data type",
+            "anyOf": [
+                {
+                    "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+                    }
+                }
+            ]
+        },
+        "sha1": {
+            "type": "string",
+            "description": "A sha1sum hash, in hex."
+        },
+        "depicts": {
+            "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject",
+            "description": "A thing depicted in this representation."
+        },
+        "thumbnail": {
+            "$ref": "https://schema.twindev.org/foaf/FoafImage",
+            "description": "A derived thumbnail image."
+        }
+    },
+    "required": [
+        "@type"
+    ],
+    "additionalProperties": {
+        "anyOf": [
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdNodePrimitive"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdIndexMap"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdIdMap"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdTypeMap"
+            },
+            {
+                "type": "array"
+            }
+        ]
+    }
+}

package/dist/es/schemas/FoafOrganization.json

@@ -0,0 +1,177 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/foaf/FoafOrganization",
+    "description": "A FOAF Organization.",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "description": "The FOAF JSON-LD context type.",
+            "anyOf": [
+                {
+                    "type": "string",
+                    "const": "https://xmlns.com/foaf/0.1/"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "const": "https://xmlns.com/foaf/0.1/"
+                    },
+                    "minItems": 1,
+                    "maxItems": 1
+                },
+                {
+                    "type": "array",
+                    "minItems": 1,
+                    "prefixItems": [
+                        {
+                            "type": "string",
+                            "const": "https://xmlns.com/foaf/0.1/"
+                        }
+                    ],
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                    }
+                }
+            ]
+        },
+        "@id": {
+            "anyOf": [
+                {
+                    "type": "string"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                }
+            ]
+        },
+        "@included": {
+            "$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
+        },
+        "@graph": {
+            "anyOf": [
+                {
+                    "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+                    }
+                }
+            ]
+        },
+        "@nest": {
+            "anyOf": [
+                {
+                    "$ref": "https://schema.twindev.org/json-ld/JsonLdJsonObject"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdJsonObject"
+                    }
+                }
+            ]
+        },
+        "@type": {
+            "type": "string",
+            "const": "Organization",
+            "description": "Type."
+        },
+        "@reverse": {
+            "type": "object",
+            "additionalProperties": {
+                "type": "string"
+            }
+        },
+        "@index": {
+            "type": "string"
+        },
+        "name": {
+            "type": "string",
+            "description": "A name for some thing."
+        },
+        "title": {
+            "type": "string",
+            "description": "Title (Mr, Mrs, Ms, Dr. etc)"
+        },
+        "mbox": {
+            "type": "string",
+            "description": "A personal mailbox, ie. an Internet mailbox associated with exactly one owner, the first owner of this mailbox"
+        },
+        "homepage": {
+            "type": "string",
+            "description": "A homepage for some thing."
+        },
+        "depiction": {
+            "$ref": "https://schema.twindev.org/foaf/FoafImage",
+            "description": "A depiction of some thing."
+        },
+        "age": {
+            "type": "number",
+            "description": "The age in years of some agent."
+        },
+        "made": {
+            "description": "Object or array data type",
+            "anyOf": [
+                {
+                    "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+                    }
+                }
+            ]
+        },
+        "weblog": {
+            "$ref": "https://schema.twindev.org/foaf/FoafDocument",
+            "description": "A weblog of some thing (whether person, group, company etc.)."
+        },
+        "openid": {
+            "$ref": "https://schema.twindev.org/foaf/FoafDocument",
+            "description": "An OpenID for an agent."
+        },
+        "interest": {
+            "$ref": "https://schema.twindev.org/foaf/FoafDocument",
+            "description": "A page about a topic of interest to this person."
+        },
+        "topic_interest": {
+            "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject",
+            "description": "A thing of interest to this person."
+        }
+    },
+    "required": [
+        "@type"
+    ],
+    "additionalProperties": {
+        "anyOf": [
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdNodePrimitive"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdIndexMap"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdIdMap"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdTypeMap"
+            },
+            {
+                "type": "array"
+            }
+        ]
+    }
+}

package/dist/es/schemas/FoafPerson.json

@@ -0,0 +1,207 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/foaf/FoafPerson",
+    "description": "A FOAF Person.",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "description": "The FOAF JSON-LD context type.",
+            "anyOf": [
+                {
+                    "type": "string",
+                    "const": "https://xmlns.com/foaf/0.1/"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "const": "https://xmlns.com/foaf/0.1/"
+                    },
+                    "minItems": 1,
+                    "maxItems": 1
+                },
+                {
+                    "type": "array",
+                    "minItems": 1,
+                    "prefixItems": [
+                        {
+                            "type": "string",
+                            "const": "https://xmlns.com/foaf/0.1/"
+                        }
+                    ],
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                    }
+                }
+            ]
+        },
+        "@id": {
+            "anyOf": [
+                {
+                    "type": "string"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                }
+            ]
+        },
+        "@included": {
+            "$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
+        },
+        "@graph": {
+            "anyOf": [
+                {
+                    "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+                    }
+                }
+            ]
+        },
+        "@nest": {
+            "anyOf": [
+                {
+                    "$ref": "https://schema.twindev.org/json-ld/JsonLdJsonObject"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdJsonObject"
+                    }
+                }
+            ]
+        },
+        "@type": {
+            "type": "string",
+            "const": "Person",
+            "description": "Type."
+        },
+        "@reverse": {
+            "type": "object",
+            "additionalProperties": {
+                "type": "string"
+            }
+        },
+        "@index": {
+            "type": "string"
+        },
+        "name": {
+            "type": "string",
+            "description": "A name for some thing."
+        },
+        "title": {
+            "type": "string",
+            "description": "Title (Mr, Mrs, Ms, Dr. etc)"
+        },
+        "mbox": {
+            "type": "string",
+            "description": "A personal mailbox, ie. an Internet mailbox associated with exactly one owner, the first owner of this mailbox"
+        },
+        "homepage": {
+            "type": "string",
+            "description": "A homepage for some thing."
+        },
+        "depiction": {
+            "$ref": "https://schema.twindev.org/foaf/FoafImage",
+            "description": "A depiction of some thing."
+        },
+        "age": {
+            "type": "number",
+            "description": "The age in years of some agent."
+        },
+        "made": {
+            "description": "Object or array data type",
+            "anyOf": [
+                {
+                    "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+                    }
+                }
+            ]
+        },
+        "weblog": {
+            "$ref": "https://schema.twindev.org/foaf/FoafDocument",
+            "description": "A weblog of some thing (whether person, group, company etc.)."
+        },
+        "openid": {
+            "$ref": "https://schema.twindev.org/foaf/FoafDocument",
+            "description": "An OpenID for an agent."
+        },
+        "interest": {
+            "$ref": "https://schema.twindev.org/foaf/FoafDocument",
+            "description": "A page about a topic of interest to this person."
+        },
+        "topic_interest": {
+            "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject",
+            "description": "A thing of interest to this person."
+        },
+        "familyName": {
+            "type": "string",
+            "description": "The family name of some person."
+        },
+        "givenName": {
+            "type": "string",
+            "description": "The given name of some person."
+        },
+        "knows": {
+            "description": "Object or array data type",
+            "anyOf": [
+                {
+                    "$ref": "https://schema.twindev.org/foaf/FoafAgent"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "$ref": "https://schema.twindev.org/foaf/FoafAgent"
+                    }
+                }
+            ]
+        },
+        "img": {
+            "$ref": "https://schema.twindev.org/foaf/FoafImage",
+            "description": "An image that can be used to represent some thing."
+        },
+        "nick": {
+            "type": "string",
+            "description": "A short informal nickname characterizing an agent (includes login identifiers, IRC and other chat nicknames)."
+        }
+    },
+    "required": [
+        "@type"
+    ],
+    "additionalProperties": {
+        "anyOf": [
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdNodePrimitive"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdIndexMap"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdIdMap"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdTypeMap"
+            },
+            {
+                "type": "array"
+            }
+        ]
+    }
+}

package/dist/types/dataTypes/foafDataTypes.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Data Type registration for FOAF
+ */
+export declare abstract class FoafDataTypes {
+    /**
+     * Register redirects for FOAF namespace to enable offline JSON-LD processing.
+     */
+    static registerRedirects(): void;
+    /**
+     * Register all the data types.
+     */
+    static registerTypes(): void;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,11 @@
+export * from "./dataTypes/foafDataTypes.js";
+export * from "./models/IFoafAgent.js";
+export * from "./models/IFoafBaseObject.js";
+export * from "./models/IFoafDocument.js";
+export * from "./models/IFoafGroup.js";
+export * from "./models/IFoafImage.js";
+export * from "./models/IFoafOrganization.js";
+export * from "./models/IFoafPerson.js";
+export * from "./models/foafContexts.js";
+export * from "./models/foafContextType.js";
+export * from "./models/foafTypes.js";

package/dist/types/models/IFoafAgent.d.ts

@@ -0,0 +1,50 @@
+import type { ObjectOrArray } from "@twin.org/core";
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { FoafContextType } from "./foafContextType.js";
+import type { FoafTypes } from "./foafTypes.js";
+import type { IFoafBaseObject } from "./IFoafBaseObject.js";
+import type { IFoafDocument } from "./IFoafDocument.js";
+/**
+ * A FOAF Agent.
+ * @see http://xmlns.com/foaf/0.1/
+ */
+export interface IFoafAgent extends IFoafBaseObject {
+    /**
+     * The LD Context.
+     */
+    "@context"?: FoafContextType;
+    /**
+     * Type.
+     */
+    "@type": typeof FoafTypes.Agent | typeof FoafTypes.Person | typeof FoafTypes.Organization | typeof FoafTypes.Group | string;
+    /**
+     * The age in years of some agent.
+     * @see http://xmlns.com/foaf/spec/#term_age
+     */
+    age?: number;
+    /**
+     * Something that was made by this agent.
+     * @see http://xmlns.com/foaf/spec/#term_made
+     */
+    made?: ObjectOrArray<IJsonLdNodeObject>;
+    /**
+     * A weblog of some thing (whether person, group, company etc.).
+     * @see http://xmlns.com/foaf/spec/#term_weblog
+     */
+    weblog?: IFoafDocument;
+    /**
+     * An OpenID for an agent.
+     * @see http://xmlns.com/foaf/spec/#term_openid
+     */
+    openid?: IFoafDocument;
+    /**
+     * A page about a topic of interest to this person.
+     * @see http://xmlns.com/foaf/spec/#term_interest
+     */
+    interest?: IFoafDocument;
+    /**
+     * A thing of interest to this person.
+     * @see http://xmlns.com/foaf/spec/#term_topic_interest
+     */
+    topic_interest?: IJsonLdNodeObject;
+}

package/dist/types/models/IFoafBaseObject.d.ts

@@ -0,0 +1,38 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { FoafContextType } from "./foafContextType.js";
+import type { IFoafImage } from "./IFoafImage.js";
+/**
+ * Core FOAF Properties
+ * @see http://xmlns.com/foaf/0.1/
+ */
+export interface IFoafBaseObject extends IJsonLdNodeObject {
+    /**
+     * The LD Context.
+     */
+    "@context"?: FoafContextType;
+    /**
+     * A name for some thing.
+     * @see http://xmlns.com/foaf/spec/#term_name
+     */
+    name?: string;
+    /**
+     * Title (Mr, Mrs, Ms, Dr. etc)
+     * @see http://xmlns.com/foaf/spec/#term_title
+     */
+    title?: string;
+    /**
+     * A personal mailbox, ie. an Internet mailbox associated with exactly one owner, the first owner of this mailbox
+     * @see http://xmlns.com/foaf/spec/#term_mbox
+     */
+    mbox?: string;
+    /**
+     * A homepage for some thing.
+     * @see http://xmlns.com/foaf/spec/#term_homepage
+     */
+    homepage?: string;
+    /**
+     * A depiction of some thing.
+     * @see http://xmlns.com/foaf/spec/#term_depiction
+     */
+    depiction?: IFoafImage;
+}