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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (62) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +21 -0
  3. package/dist/es/dataTypes/foafDataTypes.js +65 -0
  4. package/dist/es/dataTypes/foafDataTypes.js.map +1 -0
  5. package/dist/es/index.js +14 -0
  6. package/dist/es/index.js.map +1 -0
  7. package/dist/es/models/IAgent.js +2 -0
  8. package/dist/es/models/IAgent.js.map +1 -0
  9. package/dist/es/models/IBaseObject.js +2 -0
  10. package/dist/es/models/IBaseObject.js.map +1 -0
  11. package/dist/es/models/IDocument.js +2 -0
  12. package/dist/es/models/IDocument.js.map +1 -0
  13. package/dist/es/models/IGroup.js +2 -0
  14. package/dist/es/models/IGroup.js.map +1 -0
  15. package/dist/es/models/IImage.js +2 -0
  16. package/dist/es/models/IImage.js.map +1 -0
  17. package/dist/es/models/IOrganization.js +2 -0
  18. package/dist/es/models/IOrganization.js.map +1 -0
  19. package/dist/es/models/IPerson.js +2 -0
  20. package/dist/es/models/IPerson.js.map +1 -0
  21. package/dist/es/models/foafContextType.js +2 -0
  22. package/dist/es/models/foafContextType.js.map +1 -0
  23. package/dist/es/models/foafContexts.js +21 -0
  24. package/dist/es/models/foafContexts.js.map +1 -0
  25. package/dist/es/models/foafTypes.js +34 -0
  26. package/dist/es/models/foafTypes.js.map +1 -0
  27. package/dist/es/schemas/Agent.json +176 -0
  28. package/dist/es/schemas/Document.json +168 -0
  29. package/dist/es/schemas/Group.json +191 -0
  30. package/dist/es/schemas/Image.json +173 -0
  31. package/dist/es/schemas/Organization.json +177 -0
  32. package/dist/es/schemas/Person.json +207 -0
  33. package/dist/types/dataTypes/foafDataTypes.d.ts +13 -0
  34. package/dist/types/index.d.ts +11 -0
  35. package/dist/types/models/IAgent.d.ts +50 -0
  36. package/dist/types/models/IBaseObject.d.ts +38 -0
  37. package/dist/types/models/IDocument.d.ts +34 -0
  38. package/dist/types/models/IGroup.d.ts +23 -0
  39. package/dist/types/models/IImage.d.ts +29 -0
  40. package/dist/types/models/IOrganization.d.ts +17 -0
  41. package/dist/types/models/IPerson.d.ts +44 -0
  42. package/dist/types/models/foafContextType.d.ts +6 -0
  43. package/dist/types/models/foafContexts.d.ts +21 -0
  44. package/dist/types/models/foafTypes.d.ts +35 -0
  45. package/docs/changelog.md +10 -0
  46. package/docs/examples.md +1 -0
  47. package/docs/reference/classes/FoafDataTypes.md +37 -0
  48. package/docs/reference/index.md +26 -0
  49. package/docs/reference/interfaces/IAgent.md +197 -0
  50. package/docs/reference/interfaces/IBaseObject.md +92 -0
  51. package/docs/reference/interfaces/IDocument.md +159 -0
  52. package/docs/reference/interfaces/IGroup.md +227 -0
  53. package/docs/reference/interfaces/IImage.md +191 -0
  54. package/docs/reference/interfaces/IOrganization.md +215 -0
  55. package/docs/reference/interfaces/IPerson.md +275 -0
  56. package/docs/reference/type-aliases/FoafContextType.md +5 -0
  57. package/docs/reference/type-aliases/FoafContexts.md +5 -0
  58. package/docs/reference/type-aliases/FoafTypes.md +9 -0
  59. package/docs/reference/variables/FoafContexts.md +25 -0
  60. package/docs/reference/variables/FoafTypes.md +47 -0
  61. package/locales/en.json +1 -0
  62. package/package.json +52 -0
@@ -0,0 +1,35 @@
1
+ /**
2
+ * The types for FOAF.
3
+ * @see http://xmlns.com/foaf/0.1/
4
+ */
5
+ export declare const FoafTypes: {
6
+ /**
7
+ * Document.
8
+ */
9
+ readonly Document: "Document";
10
+ /**
11
+ * Image.
12
+ */
13
+ readonly Image: "Image";
14
+ /**
15
+ * Agent.
16
+ */
17
+ readonly Agent: "Agent";
18
+ /**
19
+ * Person.
20
+ */
21
+ readonly Person: "Person";
22
+ /**
23
+ * Organization.
24
+ */
25
+ readonly Organization: "Organization";
26
+ /**
27
+ * Group.
28
+ */
29
+ readonly Group: "Group";
30
+ };
31
+ /**
32
+ * The types for FOAF.
33
+ * @see http://xmlns.com/foaf/0.1/
34
+ */
35
+ export type FoafTypes = (typeof FoafTypes)[keyof typeof FoafTypes];
@@ -0,0 +1,10 @@
1
+ # Changelog
2
+
3
+ ## [0.0.3-next.3](https://github.com/twinfoundation/standards/compare/standards-foaf-v0.0.3-next.2...standards-foaf-v0.0.3-next.3) (2025-11-18)
4
+
5
+
6
+ ### Features
7
+
8
+ * add w3c dcat standards package ([#68](https://github.com/twinfoundation/standards/issues/68)) ([85746c6](https://github.com/twinfoundation/standards/commit/85746c673464498a52e9c30ce498fd88b81a7434))
9
+
10
+ ## Changelog
@@ -0,0 +1 @@
1
+ # @twin.org/standards-foaf Examples
@@ -0,0 +1,37 @@
1
+ # Abstract Class: FoafDataTypes
2
+
3
+ Data Type registration for FOAF
4
+
5
+ ## Constructors
6
+
7
+ ### Constructor
8
+
9
+ > **new FoafDataTypes**(): `FoafDataTypes`
10
+
11
+ #### Returns
12
+
13
+ `FoafDataTypes`
14
+
15
+ ## Methods
16
+
17
+ ### registerRedirects()
18
+
19
+ > `static` **registerRedirects**(): `void`
20
+
21
+ Register redirects for FOAF namespace to enable offline JSON-LD processing.
22
+
23
+ #### Returns
24
+
25
+ `void`
26
+
27
+ ***
28
+
29
+ ### registerTypes()
30
+
31
+ > `static` **registerTypes**(): `void`
32
+
33
+ Register all the data types.
34
+
35
+ #### Returns
36
+
37
+ `void`
@@ -0,0 +1,26 @@
1
+ # @twin.org/standards-foaf
2
+
3
+ ## Classes
4
+
5
+ - [FoafDataTypes](classes/FoafDataTypes.md)
6
+
7
+ ## Interfaces
8
+
9
+ - [IAgent](interfaces/IAgent.md)
10
+ - [IBaseObject](interfaces/IBaseObject.md)
11
+ - [IDocument](interfaces/IDocument.md)
12
+ - [IGroup](interfaces/IGroup.md)
13
+ - [IImage](interfaces/IImage.md)
14
+ - [IOrganization](interfaces/IOrganization.md)
15
+ - [IPerson](interfaces/IPerson.md)
16
+
17
+ ## Type Aliases
18
+
19
+ - [FoafContextType](type-aliases/FoafContextType.md)
20
+ - [FoafContexts](type-aliases/FoafContexts.md)
21
+ - [FoafTypes](type-aliases/FoafTypes.md)
22
+
23
+ ## Variables
24
+
25
+ - [FoafContexts](variables/FoafContexts.md)
26
+ - [FoafTypes](variables/FoafTypes.md)
@@ -0,0 +1,197 @@
1
+ # Interface: IAgent
2
+
3
+ A FOAF Agent.
4
+
5
+ ## See
6
+
7
+ http://xmlns.com/foaf/0.1/
8
+
9
+ ## Extends
10
+
11
+ - [`IBaseObject`](IBaseObject.md)
12
+
13
+ ## Extended by
14
+
15
+ - [`IGroup`](IGroup.md)
16
+ - [`IOrganization`](IOrganization.md)
17
+ - [`IPerson`](IPerson.md)
18
+
19
+ ## Indexable
20
+
21
+ \[`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`
22
+
23
+ ## Properties
24
+
25
+ ### @context?
26
+
27
+ > `optional` **@context**: [`FoafContextType`](../type-aliases/FoafContextType.md)
28
+
29
+ The LD Context.
30
+
31
+ #### Overrides
32
+
33
+ [`IBaseObject`](IBaseObject.md).[`@context`](IBaseObject.md#context)
34
+
35
+ ***
36
+
37
+ ### @type
38
+
39
+ > **@type**: `string`
40
+
41
+ Type.
42
+
43
+ #### Overrides
44
+
45
+ `IBaseObject.@type`
46
+
47
+ ***
48
+
49
+ ### age?
50
+
51
+ > `optional` **age**: `number`
52
+
53
+ The age in years of some agent.
54
+
55
+ #### See
56
+
57
+ http://xmlns.com/foaf/spec/#term_age
58
+
59
+ ***
60
+
61
+ ### made?
62
+
63
+ > `optional` **made**: `ObjectOrArray`\<`IJsonLdNodeObject`\>
64
+
65
+ Something that was made by this agent.
66
+
67
+ #### See
68
+
69
+ http://xmlns.com/foaf/spec/#term_made
70
+
71
+ ***
72
+
73
+ ### weblog?
74
+
75
+ > `optional` **weblog**: [`IDocument`](IDocument.md)
76
+
77
+ A weblog of some thing (whether person, group, company etc.).
78
+
79
+ #### See
80
+
81
+ http://xmlns.com/foaf/spec/#term_weblog
82
+
83
+ ***
84
+
85
+ ### openid?
86
+
87
+ > `optional` **openid**: [`IDocument`](IDocument.md)
88
+
89
+ An OpenID for an agent.
90
+
91
+ #### See
92
+
93
+ http://xmlns.com/foaf/spec/#term_openid
94
+
95
+ ***
96
+
97
+ ### interest?
98
+
99
+ > `optional` **interest**: [`IDocument`](IDocument.md)
100
+
101
+ A page about a topic of interest to this person.
102
+
103
+ #### See
104
+
105
+ http://xmlns.com/foaf/spec/#term_interest
106
+
107
+ ***
108
+
109
+ ### topic\_interest?
110
+
111
+ > `optional` **topic\_interest**: `IJsonLdNodeObject`
112
+
113
+ A thing of interest to this person.
114
+
115
+ #### See
116
+
117
+ http://xmlns.com/foaf/spec/#term_topic_interest
118
+
119
+ ***
120
+
121
+ ### name?
122
+
123
+ > `optional` **name**: `string`
124
+
125
+ A name for some thing.
126
+
127
+ #### See
128
+
129
+ http://xmlns.com/foaf/spec/#term_name
130
+
131
+ #### Inherited from
132
+
133
+ [`IBaseObject`](IBaseObject.md).[`name`](IBaseObject.md#name)
134
+
135
+ ***
136
+
137
+ ### title?
138
+
139
+ > `optional` **title**: `string`
140
+
141
+ Title (Mr, Mrs, Ms, Dr. etc)
142
+
143
+ #### See
144
+
145
+ http://xmlns.com/foaf/spec/#term_title
146
+
147
+ #### Inherited from
148
+
149
+ [`IBaseObject`](IBaseObject.md).[`title`](IBaseObject.md#title)
150
+
151
+ ***
152
+
153
+ ### mbox?
154
+
155
+ > `optional` **mbox**: `string`
156
+
157
+ A personal mailbox, ie. an Internet mailbox associated with exactly one owner, the first owner of this mailbox
158
+
159
+ #### See
160
+
161
+ http://xmlns.com/foaf/spec/#term_mbox
162
+
163
+ #### Inherited from
164
+
165
+ [`IBaseObject`](IBaseObject.md).[`mbox`](IBaseObject.md#mbox)
166
+
167
+ ***
168
+
169
+ ### homepage?
170
+
171
+ > `optional` **homepage**: `string`
172
+
173
+ A homepage for some thing.
174
+
175
+ #### See
176
+
177
+ http://xmlns.com/foaf/spec/#term_homepage
178
+
179
+ #### Inherited from
180
+
181
+ [`IBaseObject`](IBaseObject.md).[`homepage`](IBaseObject.md#homepage)
182
+
183
+ ***
184
+
185
+ ### depiction?
186
+
187
+ > `optional` **depiction**: [`IImage`](IImage.md)
188
+
189
+ A depiction of some thing.
190
+
191
+ #### See
192
+
193
+ http://xmlns.com/foaf/spec/#term_depiction
194
+
195
+ #### Inherited from
196
+
197
+ [`IBaseObject`](IBaseObject.md).[`depiction`](IBaseObject.md#depiction)
@@ -0,0 +1,92 @@
1
+ # Interface: IBaseObject
2
+
3
+ Core FOAF Properties
4
+
5
+ ## See
6
+
7
+ http://xmlns.com/foaf/0.1/
8
+
9
+ ## Extends
10
+
11
+ - `IJsonLdNodeObject`
12
+
13
+ ## Extended by
14
+
15
+ - [`IAgent`](IAgent.md)
16
+ - [`IDocument`](IDocument.md)
17
+
18
+ ## Indexable
19
+
20
+ \[`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`
21
+
22
+ ## Properties
23
+
24
+ ### @context?
25
+
26
+ > `optional` **@context**: [`FoafContextType`](../type-aliases/FoafContextType.md)
27
+
28
+ The LD Context.
29
+
30
+ #### Overrides
31
+
32
+ `IJsonLdNodeObject.@context`
33
+
34
+ ***
35
+
36
+ ### name?
37
+
38
+ > `optional` **name**: `string`
39
+
40
+ A name for some thing.
41
+
42
+ #### See
43
+
44
+ http://xmlns.com/foaf/spec/#term_name
45
+
46
+ ***
47
+
48
+ ### title?
49
+
50
+ > `optional` **title**: `string`
51
+
52
+ Title (Mr, Mrs, Ms, Dr. etc)
53
+
54
+ #### See
55
+
56
+ http://xmlns.com/foaf/spec/#term_title
57
+
58
+ ***
59
+
60
+ ### mbox?
61
+
62
+ > `optional` **mbox**: `string`
63
+
64
+ A personal mailbox, ie. an Internet mailbox associated with exactly one owner, the first owner of this mailbox
65
+
66
+ #### See
67
+
68
+ http://xmlns.com/foaf/spec/#term_mbox
69
+
70
+ ***
71
+
72
+ ### homepage?
73
+
74
+ > `optional` **homepage**: `string`
75
+
76
+ A homepage for some thing.
77
+
78
+ #### See
79
+
80
+ http://xmlns.com/foaf/spec/#term_homepage
81
+
82
+ ***
83
+
84
+ ### depiction?
85
+
86
+ > `optional` **depiction**: [`IImage`](IImage.md)
87
+
88
+ A depiction of some thing.
89
+
90
+ #### See
91
+
92
+ http://xmlns.com/foaf/spec/#term_depiction
@@ -0,0 +1,159 @@
1
+ # Interface: IDocument
2
+
3
+ A FOAF Document
4
+
5
+ ## See
6
+
7
+ http://xmlns.com/foaf/0.1/
8
+
9
+ ## Extends
10
+
11
+ - [`IBaseObject`](IBaseObject.md)
12
+
13
+ ## Extended by
14
+
15
+ - [`IImage`](IImage.md)
16
+
17
+ ## Indexable
18
+
19
+ \[`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`
20
+
21
+ ## Properties
22
+
23
+ ### name?
24
+
25
+ > `optional` **name**: `string`
26
+
27
+ A name for some thing.
28
+
29
+ #### See
30
+
31
+ http://xmlns.com/foaf/spec/#term_name
32
+
33
+ #### Inherited from
34
+
35
+ [`IBaseObject`](IBaseObject.md).[`name`](IBaseObject.md#name)
36
+
37
+ ***
38
+
39
+ ### title?
40
+
41
+ > `optional` **title**: `string`
42
+
43
+ Title (Mr, Mrs, Ms, Dr. etc)
44
+
45
+ #### See
46
+
47
+ http://xmlns.com/foaf/spec/#term_title
48
+
49
+ #### Inherited from
50
+
51
+ [`IBaseObject`](IBaseObject.md).[`title`](IBaseObject.md#title)
52
+
53
+ ***
54
+
55
+ ### mbox?
56
+
57
+ > `optional` **mbox**: `string`
58
+
59
+ A personal mailbox, ie. an Internet mailbox associated with exactly one owner, the first owner of this mailbox
60
+
61
+ #### See
62
+
63
+ http://xmlns.com/foaf/spec/#term_mbox
64
+
65
+ #### Inherited from
66
+
67
+ [`IBaseObject`](IBaseObject.md).[`mbox`](IBaseObject.md#mbox)
68
+
69
+ ***
70
+
71
+ ### homepage?
72
+
73
+ > `optional` **homepage**: `string`
74
+
75
+ A homepage for some thing.
76
+
77
+ #### See
78
+
79
+ http://xmlns.com/foaf/spec/#term_homepage
80
+
81
+ #### Inherited from
82
+
83
+ [`IBaseObject`](IBaseObject.md).[`homepage`](IBaseObject.md#homepage)
84
+
85
+ ***
86
+
87
+ ### depiction?
88
+
89
+ > `optional` **depiction**: [`IImage`](IImage.md)
90
+
91
+ A depiction of some thing.
92
+
93
+ #### See
94
+
95
+ http://xmlns.com/foaf/spec/#term_depiction
96
+
97
+ #### Inherited from
98
+
99
+ [`IBaseObject`](IBaseObject.md).[`depiction`](IBaseObject.md#depiction)
100
+
101
+ ***
102
+
103
+ ### @context?
104
+
105
+ > `optional` **@context**: [`FoafContextType`](../type-aliases/FoafContextType.md)
106
+
107
+ The LD Context.
108
+
109
+ #### Overrides
110
+
111
+ [`IBaseObject`](IBaseObject.md).[`@context`](IBaseObject.md#context)
112
+
113
+ ***
114
+
115
+ ### @type
116
+
117
+ > **@type**: `"Document"` \| `"Image"`
118
+
119
+ Type.
120
+
121
+ #### Overrides
122
+
123
+ `IBaseObject.@type`
124
+
125
+ ***
126
+
127
+ ### topic?
128
+
129
+ > `optional` **topic**: `string`
130
+
131
+ A topic of some page or document.
132
+
133
+ #### See
134
+
135
+ http://xmlns.com/foaf/spec/#term_topic
136
+
137
+ ***
138
+
139
+ ### primaryTopic?
140
+
141
+ > `optional` **primaryTopic**: `ObjectOrArray`\<`IJsonLdNodeObject`\>
142
+
143
+ The primary topic of some page or document.
144
+
145
+ #### See
146
+
147
+ http://xmlns.com/foaf/spec/#term_primaryTopic
148
+
149
+ ***
150
+
151
+ ### sha1?
152
+
153
+ > `optional` **sha1**: `string`
154
+
155
+ A sha1sum hash, in hex.
156
+
157
+ #### See
158
+
159
+ http://xmlns.com/foaf/spec/#term_sha1sum