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

package/docs/reference/interfaces/IPerson.md

@@ -0,0 +1,275 @@
+# Interface: IPerson
+
+A FOAF Person.
+
+## See
+
+http://xmlns.com/foaf/0.1/
+
+## Extends
+
+- [`IAgent`](IAgent.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?
+
+> `optional` **age**: `number`
+
+The age in years of some agent.
+
+#### See
+
+http://xmlns.com/foaf/spec/#term_age
+
+#### Inherited from
+
+[`IAgent`](IAgent.md).[`age`](IAgent.md#age)
+
+***
+
+### made?
+
+> `optional` **made**: `ObjectOrArray`\<`IJsonLdNodeObject`\>
+
+Something that was made by this agent.
+
+#### See
+
+http://xmlns.com/foaf/spec/#term_made
+
+#### Inherited from
+
+[`IAgent`](IAgent.md).[`made`](IAgent.md#made)
+
+***
+
+### weblog?
+
+> `optional` **weblog**: [`IDocument`](IDocument.md)
+
+A weblog of some thing (whether person, group, company etc.).
+
+#### See
+
+http://xmlns.com/foaf/spec/#term_weblog
+
+#### Inherited from
+
+[`IAgent`](IAgent.md).[`weblog`](IAgent.md#weblog)
+
+***
+
+### openid?
+
+> `optional` **openid**: [`IDocument`](IDocument.md)
+
+An OpenID for an agent.
+
+#### See
+
+http://xmlns.com/foaf/spec/#term_openid
+
+#### Inherited from
+
+[`IAgent`](IAgent.md).[`openid`](IAgent.md#openid)
+
+***
+
+### interest?
+
+> `optional` **interest**: [`IDocument`](IDocument.md)
+
+A page about a topic of interest to this person.
+
+#### See
+
+http://xmlns.com/foaf/spec/#term_interest
+
+#### Inherited from
+
+[`IAgent`](IAgent.md).[`interest`](IAgent.md#interest)
+
+***
+
+### topic\_interest?
+
+> `optional` **topic\_interest**: `IJsonLdNodeObject`
+
+A thing of interest to this person.
+
+#### See
+
+http://xmlns.com/foaf/spec/#term_topic_interest
+
+#### Inherited from
+
+[`IAgent`](IAgent.md).[`topic_interest`](IAgent.md#topic_interest)
+
+***
+
+### name?
+
+> `optional` **name**: `string`
+
+A name for some thing.
+
+#### See
+
+http://xmlns.com/foaf/spec/#term_name
+
+#### Inherited from
+
+[`IAgent`](IAgent.md).[`name`](IAgent.md#name)
+
+***
+
+### title?
+
+> `optional` **title**: `string`
+
+Title (Mr, Mrs, Ms, Dr. etc)
+
+#### See
+
+http://xmlns.com/foaf/spec/#term_title
+
+#### Inherited from
+
+[`IAgent`](IAgent.md).[`title`](IAgent.md#title)
+
+***
+
+### mbox?
+
+> `optional` **mbox**: `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
+
+#### Inherited from
+
+[`IAgent`](IAgent.md).[`mbox`](IAgent.md#mbox)
+
+***
+
+### homepage?
+
+> `optional` **homepage**: `string`
+
+A homepage for some thing.
+
+#### See
+
+http://xmlns.com/foaf/spec/#term_homepage
+
+#### Inherited from
+
+[`IAgent`](IAgent.md).[`homepage`](IAgent.md#homepage)
+
+***
+
+### depiction?
+
+> `optional` **depiction**: [`IImage`](IImage.md)
+
+A depiction of some thing.
+
+#### See
+
+http://xmlns.com/foaf/spec/#term_depiction
+
+#### Inherited from
+
+[`IAgent`](IAgent.md).[`depiction`](IAgent.md#depiction)
+
+***
+
+### @context?
+
+> `optional` **@context**: [`FoafContextType`](../type-aliases/FoafContextType.md)
+
+The LD Context.
+
+#### Overrides
+
+[`IAgent`](IAgent.md).[`@context`](IAgent.md#context)
+
+***
+
+### @type
+
+> **@type**: `"Person"`
+
+Type.
+
+#### Overrides
+
+[`IAgent`](IAgent.md).[`@type`](IAgent.md#type)
+
+***
+
+### familyName?
+
+> `optional` **familyName**: `string`
+
+The family name of some person.
+
+#### See
+
+http://xmlns.com/foaf/spec/#term_familyName
+
+***
+
+### givenName?
+
+> `optional` **givenName**: `string`
+
+The given name of some person.
+
+#### See
+
+http://xmlns.com/foaf/spec/#term_givenName
+
+***
+
+### knows?
+
+> `optional` **knows**: `ObjectOrArray`\<[`IAgent`](IAgent.md)\>
+
+A person known by this person (indicating some level of reciprocated interaction between the parties).
+
+#### See
+
+http://xmlns.com/foaf/spec/#term_knows
+
+***
+
+### img?
+
+> `optional` **img**: [`IImage`](IImage.md)
+
+An image that can be used to represent some thing.
+
+#### See
+
+http://xmlns.com/foaf/spec/#term_img
+
+***
+
+### nick?
+
+> `optional` **nick**: `string`
+
+A short informal nickname characterizing an agent (includes login identifiers, IRC and other chat nicknames).
+
+#### See
+
+http://xmlns.com/foaf/spec/#term_nick

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

@@ -0,0 +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)\]
+
+The FOAF JSON-LD context type.

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

@@ -0,0 +1,5 @@
+# Type Alias: FoafContexts
+
+> **FoafContexts** = *typeof* [`FoafContexts`](../variables/FoafContexts.md)\[keyof *typeof* [`FoafContexts`](../variables/FoafContexts.md)\]
+
+The LD Contexts concerning FOAF.

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

@@ -0,0 +1,9 @@
+# Type Alias: FoafTypes
+
+> **FoafTypes** = *typeof* [`FoafTypes`](../variables/FoafTypes.md)\[keyof *typeof* [`FoafTypes`](../variables/FoafTypes.md)\]
+
+The types for FOAF.
+
+## See
+
+http://xmlns.com/foaf/0.1/

package/docs/reference/variables/FoafContexts.md

@@ -0,0 +1,25 @@
+# Variable: FoafContexts
+
+> `const` **FoafContexts**: `object`
+
+The LD Contexts concerning FOAF.
+
+## Type Declaration
+
+### ContextRoot
+
+> `readonly` **ContextRoot**: `"https://xmlns.com/foaf/0.1/"` = `"https://xmlns.com/foaf/0.1/"`
+
+The FOAF LD Context.
+
+### TwinContext
+
+> `readonly` **TwinContext**: `"https://schema.twindev.org/foaf/"` = `"https://schema.twindev.org/foaf/"`
+
+The TWIN context for FOAF.
+
+### ContextRedirect
+
+> `readonly` **ContextRedirect**: `"https://schema.twindev.org/foaf/types.jsonld"` = `"https://schema.twindev.org/foaf/types.jsonld"`
+
+The TWIN context redirect for JSON-LD.

package/docs/reference/variables/FoafTypes.md

@@ -0,0 +1,47 @@
+# Variable: FoafTypes
+
+> `const` **FoafTypes**: `object`
+
+The types for FOAF.
+
+## Type Declaration
+
+### Document
+
+> `readonly` **Document**: `"Document"` = `"Document"`
+
+Document.
+
+### Image
+
+> `readonly` **Image**: `"Image"` = `"Image"`
+
+Image.
+
+### Agent
+
+> `readonly` **Agent**: `"Agent"` = `"Agent"`
+
+Agent.
+
+### Person
+
+> `readonly` **Person**: `"Person"` = `"Person"`
+
+Person.
+
+### Organization
+
+> `readonly` **Organization**: `"Organization"` = `"Organization"`
+
+Organization.
+
+### Group
+
+> `readonly` **Group**: `"Group"` = `"Group"`
+
+Group.
+
+## See
+
+http://xmlns.com/foaf/0.1/

package/locales/en.json

@@ -0,0 +1 @@
+{}

package/package.json

@@ -0,0 +1,52 @@
+{
+	"name": "@twin.org/standards-foaf",
+	"version": "0.0.3-next.3",
+	"description": "Models which define the structure of FOAF",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/standards.git",
+		"directory": "packages/standards-foaf"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"dependencies": {
+		"@twin.org/core": "next",
+		"@twin.org/data-core": "next",
+		"@twin.org/data-json-ld": "next"
+	},
+	"main": "./dist/es/index.js",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/types/index.d.ts",
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
+		},
+		"./locales/*.json": "./locales/*.json"
+	},
+	"files": [
+		"dist/es",
+		"dist/types",
+		"locales",
+		"docs"
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"standards",
+		"schema",
+		"specification",
+		"foaf"
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/standards/issues"
+	},
+	"homepage": "https://twindev.org"
+}