@twin.org/standards-foaf 0.0.3-next.9 → 0.9.0

package/docs/reference/interfaces/IFoafAgent.md

@@ -16,15 +16,11 @@ http://xmlns.com/foaf/0.1/
 - [`IFoafOrganization`](IFoafOrganization.md)
 - [`IFoafPerson`](IFoafPerson.md)
 
-## Indexable
-
-\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
-
 ## Properties
 
-### @context?
+### @context? {#context}
 
-> `optional` **@context**: [`FoafContextType`](../type-aliases/FoafContextType.md)
+> `optional` **@context?**: [`FoafContextType`](../type-aliases/FoafContextType.md)
 
 The LD Context.
 
@@ -34,21 +30,17 @@ The LD Context.
 
 ***
 
-### @type
+### @type {#type}
 
 > **@type**: `string`
 
 Type.
 
-#### Overrides
-
-`IFoafBaseObject.@type`
-
 ***
 
-### age?
+### age? {#age}
 
-> `optional` **age**: `number`
+> `optional` **age?**: `number`
 
 The age in years of some agent.
 
@@ -58,9 +50,9 @@ http://xmlns.com/foaf/spec/#term_age
 
 ***
 
-### made?
+### made? {#made}
 
-> `optional` **made**: `ObjectOrArray`\<`IJsonLdNodeObject`\>
+> `optional` **made?**: `ObjectOrArray`\<`IJsonLdNodeObject`\>
 
 Something that was made by this agent.
 
@@ -70,9 +62,9 @@ http://xmlns.com/foaf/spec/#term_made
 
 ***
 
-### weblog?
+### weblog? {#weblog}
 
-> `optional` **weblog**: [`IFoafDocument`](IFoafDocument.md)
+> `optional` **weblog?**: [`IFoafDocument`](IFoafDocument.md)
 
 A weblog of some thing (whether person, group, company etc.).
 
@@ -82,9 +74,9 @@ http://xmlns.com/foaf/spec/#term_weblog
 
 ***
 
-### openid?
+### openid? {#openid}
 
-> `optional` **openid**: [`IFoafDocument`](IFoafDocument.md)
+> `optional` **openid?**: [`IFoafDocument`](IFoafDocument.md)
 
 An OpenID for an agent.
 
@@ -94,9 +86,9 @@ http://xmlns.com/foaf/spec/#term_openid
 
 ***
 
-### interest?
+### interest? {#interest}
 
-> `optional` **interest**: [`IFoafDocument`](IFoafDocument.md)
+> `optional` **interest?**: [`IFoafDocument`](IFoafDocument.md)
 
 A page about a topic of interest to this person.
 
@@ -106,9 +98,9 @@ http://xmlns.com/foaf/spec/#term_interest
 
 ***
 
-### topic\_interest?
+### topic\_interest? {#topic_interest}
 
-> `optional` **topic\_interest**: `IJsonLdNodeObject`
+> `optional` **topic\_interest?**: `IJsonLdNodeObject`
 
 A thing of interest to this person.
 
@@ -118,9 +110,21 @@ http://xmlns.com/foaf/spec/#term_topic_interest
 
 ***
 
-### name?
+### @id? {#id}
+
+> `optional` **@id?**: `string`
+
+The unique identifier for the FOAF object.
+
+#### Inherited from
+
+[`IFoafBaseObject`](IFoafBaseObject.md).[`@id`](IFoafBaseObject.md#id)
+
+***
+
+### name? {#name}
 
-> `optional` **name**: `string`
+> `optional` **name?**: `string`
 
 A name for some thing.
 
@@ -134,9 +138,9 @@ http://xmlns.com/foaf/spec/#term_name
 
 ***
 
-### title?
+### title? {#title}
 
-> `optional` **title**: `string`
+> `optional` **title?**: `string`
 
 Title (Mr, Mrs, Ms, Dr. etc)
 
@@ -150,9 +154,9 @@ http://xmlns.com/foaf/spec/#term_title
 
 ***
 
-### mbox?
+### mbox? {#mbox}
 
-> `optional` **mbox**: `string`
+> `optional` **mbox?**: `string`
 
 A personal mailbox, ie. an Internet mailbox associated with exactly one owner, the first owner of this mailbox
 
@@ -166,9 +170,9 @@ http://xmlns.com/foaf/spec/#term_mbox
 
 ***
 
-### homepage?
+### homepage? {#homepage}
 
-> `optional` **homepage**: `string`
+> `optional` **homepage?**: `string`
 
 A homepage for some thing.
 
@@ -182,9 +186,9 @@ http://xmlns.com/foaf/spec/#term_homepage
 
 ***
 
-### depiction?
+### depiction? {#depiction}
 
-> `optional` **depiction**: [`IFoafImage`](IFoafImage.md)
+> `optional` **depiction?**: [`IFoafImage`](IFoafImage.md)
 
 A depiction of some thing.
 

package/docs/reference/interfaces/IFoafBaseObject.md

@@ -6,36 +6,32 @@ Core FOAF Properties
 
 http://xmlns.com/foaf/0.1/
 
-## Extends
-
-- `IJsonLdNodeObject`
-
 ## Extended by
 
 - [`IFoafAgent`](IFoafAgent.md)
 - [`IFoafDocument`](IFoafDocument.md)
 
-## Indexable
-
-\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
-
 ## Properties
 
-### @context?
+### @context? {#context}
 
-> `optional` **@context**: [`FoafContextType`](../type-aliases/FoafContextType.md)
+> `optional` **@context?**: [`FoafContextType`](../type-aliases/FoafContextType.md)
 
 The LD Context.
 
-#### Overrides
+***
+
+### @id? {#id}
+
+> `optional` **@id?**: `string`
 
-`IJsonLdNodeObject.@context`
+The unique identifier for the FOAF object.
 
 ***
 
-### name?
+### name? {#name}
 
-> `optional` **name**: `string`
+> `optional` **name?**: `string`
 
 A name for some thing.
 
@@ -45,9 +41,9 @@ http://xmlns.com/foaf/spec/#term_name
 
 ***
 
-### title?
+### title? {#title}
 
-> `optional` **title**: `string`
+> `optional` **title?**: `string`
 
 Title (Mr, Mrs, Ms, Dr. etc)
 
@@ -57,9 +53,9 @@ http://xmlns.com/foaf/spec/#term_title
 
 ***
 
-### mbox?
+### mbox? {#mbox}
 
-> `optional` **mbox**: `string`
+> `optional` **mbox?**: `string`
 
 A personal mailbox, ie. an Internet mailbox associated with exactly one owner, the first owner of this mailbox
 
@@ -69,9 +65,9 @@ http://xmlns.com/foaf/spec/#term_mbox
 
 ***
 
-### homepage?
+### homepage? {#homepage}
 
-> `optional` **homepage**: `string`
+> `optional` **homepage?**: `string`
 
 A homepage for some thing.
 
@@ -81,9 +77,9 @@ http://xmlns.com/foaf/spec/#term_homepage
 
 ***
 
-### depiction?
+### depiction? {#depiction}
 
-> `optional` **depiction**: [`IFoafImage`](IFoafImage.md)
+> `optional` **depiction?**: [`IFoafImage`](IFoafImage.md)
 
 A depiction of some thing.
 

package/docs/reference/interfaces/IFoafDocument.md

@@ -14,15 +14,23 @@ http://xmlns.com/foaf/0.1/
 
 - [`IFoafImage`](IFoafImage.md)
 
-## Indexable
+## Properties
 
-\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
+### @id? {#id}
 
-## Properties
+> `optional` **@id?**: `string`
+
+The unique identifier for the FOAF object.
 
-### name?
+#### Inherited from
+
+[`IFoafBaseObject`](IFoafBaseObject.md).[`@id`](IFoafBaseObject.md#id)
 
-> `optional` **name**: `string`
+***
+
+### name? {#name}
+
+> `optional` **name?**: `string`
 
 A name for some thing.
 
@@ -36,9 +44,9 @@ http://xmlns.com/foaf/spec/#term_name
 
 ***
 
-### title?
+### title? {#title}
 
-> `optional` **title**: `string`
+> `optional` **title?**: `string`
 
 Title (Mr, Mrs, Ms, Dr. etc)
 
@@ -52,9 +60,9 @@ http://xmlns.com/foaf/spec/#term_title
 
 ***
 
-### mbox?
+### mbox? {#mbox}
 
-> `optional` **mbox**: `string`
+> `optional` **mbox?**: `string`
 
 A personal mailbox, ie. an Internet mailbox associated with exactly one owner, the first owner of this mailbox
 
@@ -68,9 +76,9 @@ http://xmlns.com/foaf/spec/#term_mbox
 
 ***
 
-### homepage?
+### homepage? {#homepage}
 
-> `optional` **homepage**: `string`
+> `optional` **homepage?**: `string`
 
 A homepage for some thing.
 
@@ -84,9 +92,9 @@ http://xmlns.com/foaf/spec/#term_homepage
 
 ***
 
-### depiction?
+### depiction? {#depiction}
 
-> `optional` **depiction**: [`IFoafImage`](IFoafImage.md)
+> `optional` **depiction?**: [`IFoafImage`](IFoafImage.md)
 
 A depiction of some thing.
 
@@ -100,9 +108,9 @@ http://xmlns.com/foaf/spec/#term_depiction
 
 ***
 
-### @context?
+### @context? {#context}
 
-> `optional` **@context**: [`FoafContextType`](../type-aliases/FoafContextType.md)
+> `optional` **@context?**: [`FoafContextType`](../type-aliases/FoafContextType.md)
 
 The LD Context.
 
@@ -112,21 +120,17 @@ The LD Context.
 
 ***
 
-### @type
+### @type {#type}
 
 > **@type**: `"Document"` \| `"Image"`
 
 Type.
 
-#### Overrides
-
-`IFoafBaseObject.@type`
-
 ***
 
-### topic?
+### topic? {#topic}
 
-> `optional` **topic**: `string`
+> `optional` **topic?**: `string`
 
 A topic of some page or document.
 
@@ -136,9 +140,9 @@ http://xmlns.com/foaf/spec/#term_topic
 
 ***
 
-### primaryTopic?
+### primaryTopic? {#primarytopic}
 
-> `optional` **primaryTopic**: `ObjectOrArray`\<`IJsonLdNodeObject`\>
+> `optional` **primaryTopic?**: `ObjectOrArray`\<`IJsonLdNodeObject`\>
 
 The primary topic of some page or document.
 
@@ -148,9 +152,9 @@ http://xmlns.com/foaf/spec/#term_primaryTopic
 
 ***
 
-### sha1?
+### sha1? {#sha1}
 
-> `optional` **sha1**: `string`
+> `optional` **sha1?**: `string`
 
 A sha1sum hash, in hex.
 

package/docs/reference/interfaces/IFoafGroup.md

@@ -10,15 +10,11 @@ http://xmlns.com/foaf/0.1/
 
 - [`IFoafAgent`](IFoafAgent.md)
 
-## Indexable
-
-\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
-
 ## Properties
 
-### age?
+### age? {#age}
 
-> `optional` **age**: `number`
+> `optional` **age?**: `number`
 
 The age in years of some agent.
 
@@ -32,9 +28,9 @@ http://xmlns.com/foaf/spec/#term_age
 
 ***
 
-### made?
+### made? {#made}
 
-> `optional` **made**: `ObjectOrArray`\<`IJsonLdNodeObject`\>
+> `optional` **made?**: `ObjectOrArray`\<`IJsonLdNodeObject`\>
 
 Something that was made by this agent.
 
@@ -48,9 +44,9 @@ http://xmlns.com/foaf/spec/#term_made
 
 ***
 
-### weblog?
+### weblog? {#weblog}
 
-> `optional` **weblog**: [`IFoafDocument`](IFoafDocument.md)
+> `optional` **weblog?**: [`IFoafDocument`](IFoafDocument.md)
 
 A weblog of some thing (whether person, group, company etc.).
 
@@ -64,9 +60,9 @@ http://xmlns.com/foaf/spec/#term_weblog
 
 ***
 
-### openid?
+### openid? {#openid}
 
-> `optional` **openid**: [`IFoafDocument`](IFoafDocument.md)
+> `optional` **openid?**: [`IFoafDocument`](IFoafDocument.md)
 
 An OpenID for an agent.
 
@@ -80,9 +76,9 @@ http://xmlns.com/foaf/spec/#term_openid
 
 ***
 
-### interest?
+### interest? {#interest}
 
-> `optional` **interest**: [`IFoafDocument`](IFoafDocument.md)
+> `optional` **interest?**: [`IFoafDocument`](IFoafDocument.md)
 
 A page about a topic of interest to this person.
 
@@ -96,9 +92,9 @@ http://xmlns.com/foaf/spec/#term_interest
 
 ***
 
-### topic\_interest?
+### topic\_interest? {#topic_interest}
 
-> `optional` **topic\_interest**: `IJsonLdNodeObject`
+> `optional` **topic\_interest?**: `IJsonLdNodeObject`
 
 A thing of interest to this person.
 
@@ -112,9 +108,21 @@ http://xmlns.com/foaf/spec/#term_topic_interest
 
 ***
 
-### name?
+### @id? {#id}
+
+> `optional` **@id?**: `string`
+
+The unique identifier for the FOAF object.
+
+#### Inherited from
+
+[`IFoafAgent`](IFoafAgent.md).[`@id`](IFoafAgent.md#id)
+
+***
+
+### name? {#name}
 
-> `optional` **name**: `string`
+> `optional` **name?**: `string`
 
 A name for some thing.
 
@@ -128,9 +136,9 @@ http://xmlns.com/foaf/spec/#term_name
 
 ***
 
-### title?
+### title? {#title}
 
-> `optional` **title**: `string`
+> `optional` **title?**: `string`
 
 Title (Mr, Mrs, Ms, Dr. etc)
 
@@ -144,9 +152,9 @@ http://xmlns.com/foaf/spec/#term_title
 
 ***
 
-### mbox?
+### mbox? {#mbox}
 
-> `optional` **mbox**: `string`
+> `optional` **mbox?**: `string`
 
 A personal mailbox, ie. an Internet mailbox associated with exactly one owner, the first owner of this mailbox
 
@@ -160,9 +168,9 @@ http://xmlns.com/foaf/spec/#term_mbox
 
 ***
 
-### homepage?
+### homepage? {#homepage}
 
-> `optional` **homepage**: `string`
+> `optional` **homepage?**: `string`
 
 A homepage for some thing.
 
@@ -176,9 +184,9 @@ http://xmlns.com/foaf/spec/#term_homepage
 
 ***
 
-### depiction?
+### depiction? {#depiction}
 
-> `optional` **depiction**: [`IFoafImage`](IFoafImage.md)
+> `optional` **depiction?**: [`IFoafImage`](IFoafImage.md)
 
 A depiction of some thing.
 
@@ -192,9 +200,9 @@ http://xmlns.com/foaf/spec/#term_depiction
 
 ***
 
-### @context?
+### @context? {#context}
 
-> `optional` **@context**: [`FoafContextType`](../type-aliases/FoafContextType.md)
+> `optional` **@context?**: [`FoafContextType`](../type-aliases/FoafContextType.md)
 
 The LD Context.
 
@@ -204,7 +212,7 @@ The LD Context.
 
 ***
 
-### @type
+### @type {#type}
 
 > **@type**: `"Group"`
 
@@ -216,9 +224,9 @@ Type.
 
 ***
 
-### member?
+### member? {#member}
 
-> `optional` **member**: `ObjectOrArray`\<[`IFoafAgent`](IFoafAgent.md)\>
+> `optional` **member?**: `ObjectOrArray`\<[`IFoafAgent`](IFoafAgent.md)\>
 
 Indicates a member of a Group