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

package/docs/reference/interfaces/IFoafImage.md

@@ -10,15 +10,23 @@ http://xmlns.com/foaf/0.1/
 
 - [`IFoafDocument`](IFoafDocument.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.
+
+#### Inherited from
+
+[`IFoafDocument`](IFoafDocument.md).[`@id`](IFoafDocument.md#id)
+
+***
 
-### name?
+### name? {#name}
 
-> `optional` **name**: `string`
+> `optional` **name?**: `string`
 
 A name for some thing.
 
@@ -32,9 +40,9 @@ http://xmlns.com/foaf/spec/#term_name
 
 ***
 
-### title?
+### title? {#title}
 
-> `optional` **title**: `string`
+> `optional` **title?**: `string`
 
 Title (Mr, Mrs, Ms, Dr. etc)
 
@@ -48,9 +56,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
 
@@ -64,9 +72,9 @@ http://xmlns.com/foaf/spec/#term_mbox
 
 ***
 
-### homepage?
+### homepage? {#homepage}
 
-> `optional` **homepage**: `string`
+> `optional` **homepage?**: `string`
 
 A homepage for some thing.
 
@@ -80,9 +88,9 @@ http://xmlns.com/foaf/spec/#term_homepage
 
 ***
 
-### depiction?
+### depiction? {#depiction}
 
-> `optional` **depiction**: `IFoafImage`
+> `optional` **depiction?**: `IFoafImage`
 
 A depiction of some thing.
 
@@ -96,9 +104,9 @@ http://xmlns.com/foaf/spec/#term_depiction
 
 ***
 
-### topic?
+### topic? {#topic}
 
-> `optional` **topic**: `string`
+> `optional` **topic?**: `string`
 
 A topic of some page or document.
 
@@ -112,9 +120,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.
 
@@ -128,9 +136,9 @@ http://xmlns.com/foaf/spec/#term_primaryTopic
 
 ***
 
-### sha1?
+### sha1? {#sha1}
 
-> `optional` **sha1**: `string`
+> `optional` **sha1?**: `string`
 
 A sha1sum hash, in hex.
 
@@ -144,9 +152,9 @@ http://xmlns.com/foaf/spec/#term_sha1sum
 
 ***
 
-### @context?
+### @context? {#context}
 
-> `optional` **@context**: [`FoafContextType`](../type-aliases/FoafContextType.md)
+> `optional` **@context?**: [`FoafContextType`](../type-aliases/FoafContextType.md)
 
 The LD Context.
 
@@ -156,7 +164,7 @@ The LD Context.
 
 ***
 
-### @type
+### @type {#type}
 
 > **@type**: `"Image"`
 
@@ -168,9 +176,9 @@ Type.
 
 ***
 
-### depicts?
+### depicts? {#depicts}
 
-> `optional` **depicts**: `IJsonLdNodeObject`
+> `optional` **depicts?**: `IJsonLdNodeObject`
 
 A thing depicted in this representation.
 
@@ -180,9 +188,9 @@ http://xmlns.com/foaf/spec/#term_depicts
 
 ***
 
-### thumbnail?
+### thumbnail? {#thumbnail}
 
-> `optional` **thumbnail**: `IFoafImage`
+> `optional` **thumbnail?**: `IFoafImage`
 
 A derived thumbnail image.
 

package/docs/reference/interfaces/IFoafOrganization.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**: `"Organization"`
 

package/docs/reference/interfaces/IFoafPerson.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**: `"Person"`
 
@@ -216,9 +224,9 @@ Type.
 
 ***
 
-### familyName?
+### familyName? {#familyname}
 
-> `optional` **familyName**: `string`
+> `optional` **familyName?**: `string`
 
 The family name of some person.
 
@@ -228,9 +236,9 @@ http://xmlns.com/foaf/spec/#term_familyName
 
 ***
 
-### givenName?
+### givenName? {#givenname}
 
-> `optional` **givenName**: `string`
+> `optional` **givenName?**: `string`
 
 The given name of some person.
 
@@ -240,9 +248,9 @@ http://xmlns.com/foaf/spec/#term_givenName
 
 ***
 
-### knows?
+### knows? {#knows}
 
-> `optional` **knows**: `ObjectOrArray`\<[`IFoafAgent`](IFoafAgent.md)\>
+> `optional` **knows?**: `ObjectOrArray`\<[`IFoafAgent`](IFoafAgent.md)\>
 
 A person known by this person (indicating some level of reciprocated interaction between the parties).
 
@@ -252,9 +260,9 @@ http://xmlns.com/foaf/spec/#term_knows
 
 ***
 
-### img?
+### img? {#img}
 
-> `optional` **img**: [`IFoafImage`](IFoafImage.md)
+> `optional` **img?**: [`IFoafImage`](IFoafImage.md)
 
 An image that can be used to represent some thing.
 
@@ -264,9 +272,9 @@ http://xmlns.com/foaf/spec/#term_img
 
 ***
 
-### nick?
+### nick? {#nick}
 
-> `optional` **nick**: `string`
+> `optional` **nick?**: `string`
 
 A short informal nickname characterizing an agent (includes login identifiers, IRC and other chat nicknames).
 

package/docs/reference/type-aliases/FoafContextType.md

@@ -1,5 +1,5 @@
 # Type Alias: FoafContextType
 
-> **FoafContextType** = *typeof* [`ContextRoot`](../variables/FoafContexts.md#contextroot) \| \[*typeof* [`ContextRoot`](../variables/FoafContexts.md#contextroot)\] \| \[`...IJsonLdContextDefinitionElement[]`, *typeof* [`ContextRoot`](../variables/FoafContexts.md#contextroot)\]
+> **FoafContextType** = *typeof* [`Context`](../variables/FoafContexts.md#context) \| `SingleOccurrenceArray`\<`IJsonLdContextDefinitionElement`, *typeof* [`Context`](../variables/FoafContexts.md#context)\>
 
 The FOAF JSON-LD context type.

package/docs/reference/variables/FoafContexts.md

@@ -6,20 +6,28 @@ The LD Contexts concerning FOAF.
 
 ## Type Declaration
 
-### ContextRoot
+### Namespace {#namespace}
 
-> `readonly` **ContextRoot**: `"https://xmlns.com/foaf/0.1/"` = `"https://xmlns.com/foaf/0.1/"`
+> `readonly` **Namespace**: `"https://xmlns.com/foaf/0.1/"` = `"https://xmlns.com/foaf/0.1/"`
 
-The FOAF LD Context.
+The canonical RDF namespace URI.
 
-### TwinContext
+### Context {#context}
 
-> `readonly` **TwinContext**: `"https://schema.twindev.org/foaf/"` = `"https://schema.twindev.org/foaf/"`
+> `readonly` **Context**: `"https://xmlns.com/foaf/0.1/"` = `"https://xmlns.com/foaf/0.1/"`
 
-The TWIN context for FOAF.
+The value to use in @context.
+Note: Context matches Namespace (both include trailing slash) as per FOAF specification.
+The FOAF JSON-LD context URL format includes a trailing slash.
 
-### ContextRedirect
+### JsonLdContext {#jsonldcontext}
 
-> `readonly` **ContextRedirect**: `"https://schema.twindev.org/foaf/types.jsonld"` = `"https://schema.twindev.org/foaf/types.jsonld"`
+> `readonly` **JsonLdContext**: `"https://schema.twindev.org/foaf/types.jsonld"` = `"https://schema.twindev.org/foaf/types.jsonld"`
 
-The TWIN context redirect for JSON-LD.
+The JSON-LD Context URL.
+
+### JsonSchemaNamespace {#jsonschemanamespace}
+
+> `readonly` **JsonSchemaNamespace**: `"https://schema.twindev.org/foaf/"` = `"https://schema.twindev.org/foaf/"`
+
+The namespace location of the hosted version of the JSON Schema.

package/docs/reference/variables/FoafTypes.md

@@ -6,37 +6,37 @@ The types for FOAF.
 
 ## Type Declaration
 
-### Document
+### Document {#document}
 
 > `readonly` **Document**: `"Document"` = `"Document"`
 
 Document.
 
-### Image
+### Image {#image}
 
 > `readonly` **Image**: `"Image"` = `"Image"`
 
 Image.
 
-### Agent
+### Agent {#agent}
 
 > `readonly` **Agent**: `"Agent"` = `"Agent"`
 
 Agent.
 
-### Person
+### Person {#person}
 
 > `readonly` **Person**: `"Person"` = `"Person"`
 
 Person.
 
-### Organization
+### Organization {#organization}
 
 > `readonly` **Organization**: `"Organization"` = `"Organization"`
 
 Organization.
 
-### Group
+### Group {#group}
 
 > `readonly` **Group**: `"Group"` = `"Group"`
 

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/standards-foaf",
-	"version": "0.0.3-next.9",
-	"description": "Models which define the structure of FOAF",
+	"version": "0.9.0",
+	"description": "Data models for the FOAF vocabulary.",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/twinfoundation/standards.git",
+		"url": "git+https://github.com/iotaledger/twin-standards.git",
 		"directory": "packages/standards-foaf"
 	},
 	"author": "martyn.janes@iota.org",
@@ -14,9 +14,9 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/core": "next",
-		"@twin.org/data-core": "next",
-		"@twin.org/data-json-ld": "next"
+		"@twin.org/core": "^0.9.0",
+		"@twin.org/data-core": "^0.9.0",
+		"@twin.org/data-json-ld": "^0.9.0"
 	},
 	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
@@ -46,7 +46,7 @@
 		"foaf"
 	],
 	"bugs": {
-		"url": "git+https://github.com/twinfoundation/standards/issues"
+		"url": "git+https://github.com/iotaledger/twin-standards/issues"
 	},
 	"homepage": "https://twindev.org"
 }