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

package/dist/es/schemas/Organization.json

@@ -0,0 +1,177 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/foaf/Organization",
+    "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/Image",
+            "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/Document",
+            "description": "A weblog of some thing (whether person, group, company etc.)."
+        },
+        "openid": {
+            "$ref": "https://schema.twindev.org/foaf/Document",
+            "description": "An OpenID for an agent."
+        },
+        "interest": {
+            "$ref": "https://schema.twindev.org/foaf/Document",
+            "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/Person.json

@@ -0,0 +1,207 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/foaf/Person",
+    "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/Image",
+            "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/Document",
+            "description": "A weblog of some thing (whether person, group, company etc.)."
+        },
+        "openid": {
+            "$ref": "https://schema.twindev.org/foaf/Document",
+            "description": "An OpenID for an agent."
+        },
+        "interest": {
+            "$ref": "https://schema.twindev.org/foaf/Document",
+            "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/Agent"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "$ref": "https://schema.twindev.org/foaf/Agent"
+                    }
+                }
+            ]
+        },
+        "img": {
+            "$ref": "https://schema.twindev.org/foaf/Image",
+            "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/IAgent.js";
+export * from "./models/IBaseObject.js";
+export * from "./models/IDocument.js";
+export * from "./models/IGroup.js";
+export * from "./models/IImage.js";
+export * from "./models/IOrganization.js";
+export * from "./models/IPerson.js";
+export * from "./models/foafContexts.js";
+export * from "./models/foafContextType.js";
+export * from "./models/foafTypes.js";

package/dist/types/models/IAgent.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 { IBaseObject } from "./IBaseObject.js";
+import type { IDocument } from "./IDocument.js";
+/**
+ * A FOAF Agent.
+ * @see http://xmlns.com/foaf/0.1/
+ */
+export interface IAgent extends IBaseObject {
+    /**
+     * 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?: IDocument;
+    /**
+     * An OpenID for an agent.
+     * @see http://xmlns.com/foaf/spec/#term_openid
+     */
+    openid?: IDocument;
+    /**
+     * A page about a topic of interest to this person.
+     * @see http://xmlns.com/foaf/spec/#term_interest
+     */
+    interest?: IDocument;
+    /**
+     * A thing of interest to this person.
+     * @see http://xmlns.com/foaf/spec/#term_topic_interest
+     */
+    topic_interest?: IJsonLdNodeObject;
+}

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

@@ -0,0 +1,38 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { FoafContextType } from "./foafContextType.js";
+import type { IImage } from "./IImage.js";
+/**
+ * Core FOAF Properties
+ * @see http://xmlns.com/foaf/0.1/
+ */
+export interface IBaseObject 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?: IImage;
+}

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

@@ -0,0 +1,34 @@
+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 { IBaseObject } from "./IBaseObject.js";
+/**
+ * A FOAF Document
+ * @see http://xmlns.com/foaf/0.1/
+ */
+export interface IDocument extends IBaseObject {
+    /**
+     * The LD Context.
+     */
+    "@context"?: FoafContextType;
+    /**
+     * Type.
+     */
+    "@type": typeof FoafTypes.Document | typeof FoafTypes.Image;
+    /**
+     * A topic of some page or document.
+     * @see http://xmlns.com/foaf/spec/#term_topic
+     */
+    topic?: string;
+    /**
+     * The primary topic of some page or document.
+     * @see http://xmlns.com/foaf/spec/#term_primaryTopic
+     */
+    primaryTopic?: ObjectOrArray<IJsonLdNodeObject>;
+    /**
+     * A sha1sum hash, in hex.
+     * @see http://xmlns.com/foaf/spec/#term_sha1sum
+     */
+    sha1?: string;
+}

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

@@ -0,0 +1,23 @@
+import type { ObjectOrArray } from "@twin.org/core";
+import type { FoafContextType } from "./foafContextType.js";
+import type { FoafTypes } from "./foafTypes.js";
+import type { IAgent } from "./IAgent.js";
+/**
+ * A FOAF Group.
+ * @see http://xmlns.com/foaf/0.1/
+ */
+export interface IGroup extends IAgent {
+    /**
+     * The LD Context.
+     */
+    "@context"?: FoafContextType;
+    /**
+     * Type.
+     */
+    "@type": typeof FoafTypes.Group;
+    /**
+     * Indicates a member of a Group
+     * @see http://xmlns.com/foaf/spec/#term_member
+     */
+    member?: ObjectOrArray<IAgent>;
+}

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

@@ -0,0 +1,29 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { FoafContextType } from "./foafContextType.js";
+import type { FoafTypes } from "./foafTypes.js";
+import type { IDocument } from "./IDocument.js";
+/**
+ * A FOAF image.
+ * @see http://xmlns.com/foaf/0.1/
+ */
+export interface IImage extends IDocument {
+    /**
+     * The LD Context.
+     *
+     */
+    "@context"?: FoafContextType;
+    /**
+     * Type.
+     */
+    "@type": typeof FoafTypes.Image;
+    /**
+     * A thing depicted in this representation.
+     * @see http://xmlns.com/foaf/spec/#term_depicts
+     */
+    depicts?: IJsonLdNodeObject;
+    /**
+     * A derived thumbnail image.
+     * @see http://xmlns.com/foaf/spec/#term_thumbnail
+     */
+    thumbnail?: IImage;
+}

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

@@ -0,0 +1,17 @@
+import type { FoafContextType } from "./foafContextType.js";
+import type { FoafTypes } from "./foafTypes.js";
+import type { IAgent } from "./IAgent.js";
+/**
+ * A FOAF Organization.
+ * @see http://xmlns.com/foaf/0.1/
+ */
+export interface IOrganization extends IAgent {
+    /**
+     * The LD Context.
+     */
+    "@context"?: FoafContextType;
+    /**
+     * Type.
+     */
+    "@type": typeof FoafTypes.Organization;
+}

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

@@ -0,0 +1,44 @@
+import type { ObjectOrArray } from "@twin.org/core";
+import type { FoafContextType } from "./foafContextType.js";
+import type { FoafTypes } from "./foafTypes.js";
+import type { IAgent } from "./IAgent.js";
+import type { IImage } from "./IImage.js";
+/**
+ * A FOAF Person.
+ * @see http://xmlns.com/foaf/0.1/
+ */
+export interface IPerson extends IAgent {
+    /**
+     * The LD Context.
+     */
+    "@context"?: FoafContextType;
+    /**
+     * Type.
+     */
+    "@type": typeof FoafTypes.Person;
+    /**
+     * The family name of some person.
+     * @see http://xmlns.com/foaf/spec/#term_familyName
+     */
+    familyName?: string;
+    /**
+     * The given name of some person.
+     * @see http://xmlns.com/foaf/spec/#term_givenName
+     */
+    givenName?: string;
+    /**
+     * A person known by this person (indicating some level of reciprocated interaction between the parties).
+     * @see http://xmlns.com/foaf/spec/#term_knows
+     */
+    knows?: ObjectOrArray<IAgent>;
+    /**
+     * An image that can be used to represent some thing.
+     * @see http://xmlns.com/foaf/spec/#term_img
+     */
+    img?: IImage;
+    /**
+     * A short informal nickname characterizing an agent (includes login identifiers, IRC and other chat nicknames).
+     * @see http://xmlns.com/foaf/spec/#term_nick
+     */
+    nick?: string;
+}

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

@@ -0,0 +1,6 @@
+import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
+import type { FoafContexts } from "./foafContexts.js";
+/**
+ * The FOAF JSON-LD context type.
+ */
+export type FoafContextType = typeof FoafContexts.ContextRoot | [typeof FoafContexts.ContextRoot] | [...IJsonLdContextDefinitionElement[], typeof FoafContexts.ContextRoot];

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

@@ -0,0 +1,21 @@
+/**
+ * The LD Contexts concerning FOAF.
+ */
+export declare const FoafContexts: {
+    /**
+     * The FOAF LD Context.
+     */
+    readonly ContextRoot: "https://xmlns.com/foaf/0.1/";
+    /**
+     * The TWIN context for FOAF.
+     */
+    readonly TwinContext: "https://schema.twindev.org/foaf/";
+    /**
+     * The TWIN context redirect for JSON-LD.
+     */
+    readonly ContextRedirect: "https://schema.twindev.org/foaf/types.jsonld";
+};
+/**
+ * The LD Contexts concerning FOAF.
+ */
+export type FoafContexts = (typeof FoafContexts)[keyof typeof FoafContexts];