@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,227 @@
1
+ # Interface: IGroup
2
+
3
+ A FOAF Group.
4
+
5
+ ## See
6
+
7
+ http://xmlns.com/foaf/0.1/
8
+
9
+ ## Extends
10
+
11
+ - [`IAgent`](IAgent.md)
12
+
13
+ ## Indexable
14
+
15
+ \[`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`
16
+
17
+ ## Properties
18
+
19
+ ### age?
20
+
21
+ > `optional` **age**: `number`
22
+
23
+ The age in years of some agent.
24
+
25
+ #### See
26
+
27
+ http://xmlns.com/foaf/spec/#term_age
28
+
29
+ #### Inherited from
30
+
31
+ [`IAgent`](IAgent.md).[`age`](IAgent.md#age)
32
+
33
+ ***
34
+
35
+ ### made?
36
+
37
+ > `optional` **made**: `ObjectOrArray`\<`IJsonLdNodeObject`\>
38
+
39
+ Something that was made by this agent.
40
+
41
+ #### See
42
+
43
+ http://xmlns.com/foaf/spec/#term_made
44
+
45
+ #### Inherited from
46
+
47
+ [`IAgent`](IAgent.md).[`made`](IAgent.md#made)
48
+
49
+ ***
50
+
51
+ ### weblog?
52
+
53
+ > `optional` **weblog**: [`IDocument`](IDocument.md)
54
+
55
+ A weblog of some thing (whether person, group, company etc.).
56
+
57
+ #### See
58
+
59
+ http://xmlns.com/foaf/spec/#term_weblog
60
+
61
+ #### Inherited from
62
+
63
+ [`IAgent`](IAgent.md).[`weblog`](IAgent.md#weblog)
64
+
65
+ ***
66
+
67
+ ### openid?
68
+
69
+ > `optional` **openid**: [`IDocument`](IDocument.md)
70
+
71
+ An OpenID for an agent.
72
+
73
+ #### See
74
+
75
+ http://xmlns.com/foaf/spec/#term_openid
76
+
77
+ #### Inherited from
78
+
79
+ [`IAgent`](IAgent.md).[`openid`](IAgent.md#openid)
80
+
81
+ ***
82
+
83
+ ### interest?
84
+
85
+ > `optional` **interest**: [`IDocument`](IDocument.md)
86
+
87
+ A page about a topic of interest to this person.
88
+
89
+ #### See
90
+
91
+ http://xmlns.com/foaf/spec/#term_interest
92
+
93
+ #### Inherited from
94
+
95
+ [`IAgent`](IAgent.md).[`interest`](IAgent.md#interest)
96
+
97
+ ***
98
+
99
+ ### topic\_interest?
100
+
101
+ > `optional` **topic\_interest**: `IJsonLdNodeObject`
102
+
103
+ A thing of interest to this person.
104
+
105
+ #### See
106
+
107
+ http://xmlns.com/foaf/spec/#term_topic_interest
108
+
109
+ #### Inherited from
110
+
111
+ [`IAgent`](IAgent.md).[`topic_interest`](IAgent.md#topic_interest)
112
+
113
+ ***
114
+
115
+ ### name?
116
+
117
+ > `optional` **name**: `string`
118
+
119
+ A name for some thing.
120
+
121
+ #### See
122
+
123
+ http://xmlns.com/foaf/spec/#term_name
124
+
125
+ #### Inherited from
126
+
127
+ [`IAgent`](IAgent.md).[`name`](IAgent.md#name)
128
+
129
+ ***
130
+
131
+ ### title?
132
+
133
+ > `optional` **title**: `string`
134
+
135
+ Title (Mr, Mrs, Ms, Dr. etc)
136
+
137
+ #### See
138
+
139
+ http://xmlns.com/foaf/spec/#term_title
140
+
141
+ #### Inherited from
142
+
143
+ [`IAgent`](IAgent.md).[`title`](IAgent.md#title)
144
+
145
+ ***
146
+
147
+ ### mbox?
148
+
149
+ > `optional` **mbox**: `string`
150
+
151
+ A personal mailbox, ie. an Internet mailbox associated with exactly one owner, the first owner of this mailbox
152
+
153
+ #### See
154
+
155
+ http://xmlns.com/foaf/spec/#term_mbox
156
+
157
+ #### Inherited from
158
+
159
+ [`IAgent`](IAgent.md).[`mbox`](IAgent.md#mbox)
160
+
161
+ ***
162
+
163
+ ### homepage?
164
+
165
+ > `optional` **homepage**: `string`
166
+
167
+ A homepage for some thing.
168
+
169
+ #### See
170
+
171
+ http://xmlns.com/foaf/spec/#term_homepage
172
+
173
+ #### Inherited from
174
+
175
+ [`IAgent`](IAgent.md).[`homepage`](IAgent.md#homepage)
176
+
177
+ ***
178
+
179
+ ### depiction?
180
+
181
+ > `optional` **depiction**: [`IImage`](IImage.md)
182
+
183
+ A depiction of some thing.
184
+
185
+ #### See
186
+
187
+ http://xmlns.com/foaf/spec/#term_depiction
188
+
189
+ #### Inherited from
190
+
191
+ [`IAgent`](IAgent.md).[`depiction`](IAgent.md#depiction)
192
+
193
+ ***
194
+
195
+ ### @context?
196
+
197
+ > `optional` **@context**: [`FoafContextType`](../type-aliases/FoafContextType.md)
198
+
199
+ The LD Context.
200
+
201
+ #### Overrides
202
+
203
+ [`IAgent`](IAgent.md).[`@context`](IAgent.md#context)
204
+
205
+ ***
206
+
207
+ ### @type
208
+
209
+ > **@type**: `"Group"`
210
+
211
+ Type.
212
+
213
+ #### Overrides
214
+
215
+ [`IAgent`](IAgent.md).[`@type`](IAgent.md#type)
216
+
217
+ ***
218
+
219
+ ### member?
220
+
221
+ > `optional` **member**: `ObjectOrArray`\<[`IAgent`](IAgent.md)\>
222
+
223
+ Indicates a member of a Group
224
+
225
+ #### See
226
+
227
+ http://xmlns.com/foaf/spec/#term_member
@@ -0,0 +1,191 @@
1
+ # Interface: IImage
2
+
3
+ A FOAF image.
4
+
5
+ ## See
6
+
7
+ http://xmlns.com/foaf/0.1/
8
+
9
+ ## Extends
10
+
11
+ - [`IDocument`](IDocument.md)
12
+
13
+ ## Indexable
14
+
15
+ \[`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`
16
+
17
+ ## Properties
18
+
19
+ ### name?
20
+
21
+ > `optional` **name**: `string`
22
+
23
+ A name for some thing.
24
+
25
+ #### See
26
+
27
+ http://xmlns.com/foaf/spec/#term_name
28
+
29
+ #### Inherited from
30
+
31
+ [`IDocument`](IDocument.md).[`name`](IDocument.md#name)
32
+
33
+ ***
34
+
35
+ ### title?
36
+
37
+ > `optional` **title**: `string`
38
+
39
+ Title (Mr, Mrs, Ms, Dr. etc)
40
+
41
+ #### See
42
+
43
+ http://xmlns.com/foaf/spec/#term_title
44
+
45
+ #### Inherited from
46
+
47
+ [`IDocument`](IDocument.md).[`title`](IDocument.md#title)
48
+
49
+ ***
50
+
51
+ ### mbox?
52
+
53
+ > `optional` **mbox**: `string`
54
+
55
+ A personal mailbox, ie. an Internet mailbox associated with exactly one owner, the first owner of this mailbox
56
+
57
+ #### See
58
+
59
+ http://xmlns.com/foaf/spec/#term_mbox
60
+
61
+ #### Inherited from
62
+
63
+ [`IDocument`](IDocument.md).[`mbox`](IDocument.md#mbox)
64
+
65
+ ***
66
+
67
+ ### homepage?
68
+
69
+ > `optional` **homepage**: `string`
70
+
71
+ A homepage for some thing.
72
+
73
+ #### See
74
+
75
+ http://xmlns.com/foaf/spec/#term_homepage
76
+
77
+ #### Inherited from
78
+
79
+ [`IDocument`](IDocument.md).[`homepage`](IDocument.md#homepage)
80
+
81
+ ***
82
+
83
+ ### depiction?
84
+
85
+ > `optional` **depiction**: `IImage`
86
+
87
+ A depiction of some thing.
88
+
89
+ #### See
90
+
91
+ http://xmlns.com/foaf/spec/#term_depiction
92
+
93
+ #### Inherited from
94
+
95
+ [`IDocument`](IDocument.md).[`depiction`](IDocument.md#depiction)
96
+
97
+ ***
98
+
99
+ ### topic?
100
+
101
+ > `optional` **topic**: `string`
102
+
103
+ A topic of some page or document.
104
+
105
+ #### See
106
+
107
+ http://xmlns.com/foaf/spec/#term_topic
108
+
109
+ #### Inherited from
110
+
111
+ [`IDocument`](IDocument.md).[`topic`](IDocument.md#topic)
112
+
113
+ ***
114
+
115
+ ### primaryTopic?
116
+
117
+ > `optional` **primaryTopic**: `ObjectOrArray`\<`IJsonLdNodeObject`\>
118
+
119
+ The primary topic of some page or document.
120
+
121
+ #### See
122
+
123
+ http://xmlns.com/foaf/spec/#term_primaryTopic
124
+
125
+ #### Inherited from
126
+
127
+ [`IDocument`](IDocument.md).[`primaryTopic`](IDocument.md#primarytopic)
128
+
129
+ ***
130
+
131
+ ### sha1?
132
+
133
+ > `optional` **sha1**: `string`
134
+
135
+ A sha1sum hash, in hex.
136
+
137
+ #### See
138
+
139
+ http://xmlns.com/foaf/spec/#term_sha1sum
140
+
141
+ #### Inherited from
142
+
143
+ [`IDocument`](IDocument.md).[`sha1`](IDocument.md#sha1)
144
+
145
+ ***
146
+
147
+ ### @context?
148
+
149
+ > `optional` **@context**: [`FoafContextType`](../type-aliases/FoafContextType.md)
150
+
151
+ The LD Context.
152
+
153
+ #### Overrides
154
+
155
+ [`IDocument`](IDocument.md).[`@context`](IDocument.md#context)
156
+
157
+ ***
158
+
159
+ ### @type
160
+
161
+ > **@type**: `"Image"`
162
+
163
+ Type.
164
+
165
+ #### Overrides
166
+
167
+ [`IDocument`](IDocument.md).[`@type`](IDocument.md#type)
168
+
169
+ ***
170
+
171
+ ### depicts?
172
+
173
+ > `optional` **depicts**: `IJsonLdNodeObject`
174
+
175
+ A thing depicted in this representation.
176
+
177
+ #### See
178
+
179
+ http://xmlns.com/foaf/spec/#term_depicts
180
+
181
+ ***
182
+
183
+ ### thumbnail?
184
+
185
+ > `optional` **thumbnail**: `IImage`
186
+
187
+ A derived thumbnail image.
188
+
189
+ #### See
190
+
191
+ http://xmlns.com/foaf/spec/#term_thumbnail
@@ -0,0 +1,215 @@
1
+ # Interface: IOrganization
2
+
3
+ A FOAF Organization.
4
+
5
+ ## See
6
+
7
+ http://xmlns.com/foaf/0.1/
8
+
9
+ ## Extends
10
+
11
+ - [`IAgent`](IAgent.md)
12
+
13
+ ## Indexable
14
+
15
+ \[`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`
16
+
17
+ ## Properties
18
+
19
+ ### age?
20
+
21
+ > `optional` **age**: `number`
22
+
23
+ The age in years of some agent.
24
+
25
+ #### See
26
+
27
+ http://xmlns.com/foaf/spec/#term_age
28
+
29
+ #### Inherited from
30
+
31
+ [`IAgent`](IAgent.md).[`age`](IAgent.md#age)
32
+
33
+ ***
34
+
35
+ ### made?
36
+
37
+ > `optional` **made**: `ObjectOrArray`\<`IJsonLdNodeObject`\>
38
+
39
+ Something that was made by this agent.
40
+
41
+ #### See
42
+
43
+ http://xmlns.com/foaf/spec/#term_made
44
+
45
+ #### Inherited from
46
+
47
+ [`IAgent`](IAgent.md).[`made`](IAgent.md#made)
48
+
49
+ ***
50
+
51
+ ### weblog?
52
+
53
+ > `optional` **weblog**: [`IDocument`](IDocument.md)
54
+
55
+ A weblog of some thing (whether person, group, company etc.).
56
+
57
+ #### See
58
+
59
+ http://xmlns.com/foaf/spec/#term_weblog
60
+
61
+ #### Inherited from
62
+
63
+ [`IAgent`](IAgent.md).[`weblog`](IAgent.md#weblog)
64
+
65
+ ***
66
+
67
+ ### openid?
68
+
69
+ > `optional` **openid**: [`IDocument`](IDocument.md)
70
+
71
+ An OpenID for an agent.
72
+
73
+ #### See
74
+
75
+ http://xmlns.com/foaf/spec/#term_openid
76
+
77
+ #### Inherited from
78
+
79
+ [`IAgent`](IAgent.md).[`openid`](IAgent.md#openid)
80
+
81
+ ***
82
+
83
+ ### interest?
84
+
85
+ > `optional` **interest**: [`IDocument`](IDocument.md)
86
+
87
+ A page about a topic of interest to this person.
88
+
89
+ #### See
90
+
91
+ http://xmlns.com/foaf/spec/#term_interest
92
+
93
+ #### Inherited from
94
+
95
+ [`IAgent`](IAgent.md).[`interest`](IAgent.md#interest)
96
+
97
+ ***
98
+
99
+ ### topic\_interest?
100
+
101
+ > `optional` **topic\_interest**: `IJsonLdNodeObject`
102
+
103
+ A thing of interest to this person.
104
+
105
+ #### See
106
+
107
+ http://xmlns.com/foaf/spec/#term_topic_interest
108
+
109
+ #### Inherited from
110
+
111
+ [`IAgent`](IAgent.md).[`topic_interest`](IAgent.md#topic_interest)
112
+
113
+ ***
114
+
115
+ ### name?
116
+
117
+ > `optional` **name**: `string`
118
+
119
+ A name for some thing.
120
+
121
+ #### See
122
+
123
+ http://xmlns.com/foaf/spec/#term_name
124
+
125
+ #### Inherited from
126
+
127
+ [`IAgent`](IAgent.md).[`name`](IAgent.md#name)
128
+
129
+ ***
130
+
131
+ ### title?
132
+
133
+ > `optional` **title**: `string`
134
+
135
+ Title (Mr, Mrs, Ms, Dr. etc)
136
+
137
+ #### See
138
+
139
+ http://xmlns.com/foaf/spec/#term_title
140
+
141
+ #### Inherited from
142
+
143
+ [`IAgent`](IAgent.md).[`title`](IAgent.md#title)
144
+
145
+ ***
146
+
147
+ ### mbox?
148
+
149
+ > `optional` **mbox**: `string`
150
+
151
+ A personal mailbox, ie. an Internet mailbox associated with exactly one owner, the first owner of this mailbox
152
+
153
+ #### See
154
+
155
+ http://xmlns.com/foaf/spec/#term_mbox
156
+
157
+ #### Inherited from
158
+
159
+ [`IAgent`](IAgent.md).[`mbox`](IAgent.md#mbox)
160
+
161
+ ***
162
+
163
+ ### homepage?
164
+
165
+ > `optional` **homepage**: `string`
166
+
167
+ A homepage for some thing.
168
+
169
+ #### See
170
+
171
+ http://xmlns.com/foaf/spec/#term_homepage
172
+
173
+ #### Inherited from
174
+
175
+ [`IAgent`](IAgent.md).[`homepage`](IAgent.md#homepage)
176
+
177
+ ***
178
+
179
+ ### depiction?
180
+
181
+ > `optional` **depiction**: [`IImage`](IImage.md)
182
+
183
+ A depiction of some thing.
184
+
185
+ #### See
186
+
187
+ http://xmlns.com/foaf/spec/#term_depiction
188
+
189
+ #### Inherited from
190
+
191
+ [`IAgent`](IAgent.md).[`depiction`](IAgent.md#depiction)
192
+
193
+ ***
194
+
195
+ ### @context?
196
+
197
+ > `optional` **@context**: [`FoafContextType`](../type-aliases/FoafContextType.md)
198
+
199
+ The LD Context.
200
+
201
+ #### Overrides
202
+
203
+ [`IAgent`](IAgent.md).[`@context`](IAgent.md#context)
204
+
205
+ ***
206
+
207
+ ### @type
208
+
209
+ > **@type**: `"Organization"`
210
+
211
+ Type.
212
+
213
+ #### Overrides
214
+
215
+ [`IAgent`](IAgent.md).[`@type`](IAgent.md#type)