@twin.org/standards-w3c-activity-streams 0.0.3-next.9 → 0.9.0

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 (190) hide show
  1. package/README.md +1 -1
  2. package/dist/es/dataTypes/activityStreamsDataTypes.js +275 -16
  3. package/dist/es/dataTypes/activityStreamsDataTypes.js.map +1 -1
  4. package/dist/es/index.js +33 -0
  5. package/dist/es/index.js.map +1 -1
  6. package/dist/es/models/IActivityStreamsActivity.js.map +1 -1
  7. package/dist/es/models/IActivityStreamsActor.js +2 -0
  8. package/dist/es/models/IActivityStreamsActor.js.map +1 -0
  9. package/dist/es/models/IActivityStreamsApplication.js +2 -0
  10. package/dist/es/models/IActivityStreamsApplication.js.map +1 -0
  11. package/dist/es/models/IActivityStreamsArticle.js +2 -0
  12. package/dist/es/models/IActivityStreamsArticle.js.map +1 -0
  13. package/dist/es/models/IActivityStreamsAudio.js +2 -0
  14. package/dist/es/models/IActivityStreamsAudio.js.map +1 -0
  15. package/dist/es/models/IActivityStreamsCollection.js +2 -0
  16. package/dist/es/models/IActivityStreamsCollection.js.map +1 -0
  17. package/dist/es/models/IActivityStreamsCollectionPage.js +2 -0
  18. package/dist/es/models/IActivityStreamsCollectionPage.js.map +1 -0
  19. package/dist/es/models/IActivityStreamsDocument.js +2 -0
  20. package/dist/es/models/IActivityStreamsDocument.js.map +1 -0
  21. package/dist/es/models/IActivityStreamsEvent.js +2 -0
  22. package/dist/es/models/IActivityStreamsEvent.js.map +1 -0
  23. package/dist/es/models/IActivityStreamsGroup.js +2 -0
  24. package/dist/es/models/IActivityStreamsGroup.js.map +1 -0
  25. package/dist/es/models/IActivityStreamsImage.js +2 -0
  26. package/dist/es/models/IActivityStreamsImage.js.map +1 -0
  27. package/dist/es/models/IActivityStreamsIntransitiveActivity.js +2 -0
  28. package/dist/es/models/IActivityStreamsIntransitiveActivity.js.map +1 -0
  29. package/dist/es/models/IActivityStreamsLink.js +2 -0
  30. package/dist/es/models/IActivityStreamsLink.js.map +1 -0
  31. package/dist/es/models/IActivityStreamsMention.js +2 -0
  32. package/dist/es/models/IActivityStreamsMention.js.map +1 -0
  33. package/dist/es/models/IActivityStreamsNote.js +2 -0
  34. package/dist/es/models/IActivityStreamsNote.js.map +1 -0
  35. package/dist/es/models/IActivityStreamsObject.js +2 -0
  36. package/dist/es/models/IActivityStreamsObject.js.map +1 -0
  37. package/dist/es/models/IActivityStreamsOrderedCollection.js +2 -0
  38. package/dist/es/models/IActivityStreamsOrderedCollection.js.map +1 -0
  39. package/dist/es/models/IActivityStreamsOrderedCollectionPage.js +2 -0
  40. package/dist/es/models/IActivityStreamsOrderedCollectionPage.js.map +1 -0
  41. package/dist/es/models/IActivityStreamsOrganization.js +2 -0
  42. package/dist/es/models/IActivityStreamsOrganization.js.map +1 -0
  43. package/dist/es/models/IActivityStreamsPage.js +2 -0
  44. package/dist/es/models/IActivityStreamsPage.js.map +1 -0
  45. package/dist/es/models/IActivityStreamsPerson.js +2 -0
  46. package/dist/es/models/IActivityStreamsPerson.js.map +1 -0
  47. package/dist/es/models/IActivityStreamsPlace.js +2 -0
  48. package/dist/es/models/IActivityStreamsPlace.js.map +1 -0
  49. package/dist/es/models/IActivityStreamsProfile.js +2 -0
  50. package/dist/es/models/IActivityStreamsProfile.js.map +1 -0
  51. package/dist/es/models/IActivityStreamsQuestion.js +2 -0
  52. package/dist/es/models/IActivityStreamsQuestion.js.map +1 -0
  53. package/dist/es/models/IActivityStreamsQuestionAnyOfChoice.js +2 -0
  54. package/dist/es/models/IActivityStreamsQuestionAnyOfChoice.js.map +1 -0
  55. package/dist/es/models/IActivityStreamsQuestionBase.js +2 -0
  56. package/dist/es/models/IActivityStreamsQuestionBase.js.map +1 -0
  57. package/dist/es/models/IActivityStreamsQuestionNeitherChoice.js +4 -0
  58. package/dist/es/models/IActivityStreamsQuestionNeitherChoice.js.map +1 -0
  59. package/dist/es/models/IActivityStreamsQuestionOneOfChoice.js +2 -0
  60. package/dist/es/models/IActivityStreamsQuestionOneOfChoice.js.map +1 -0
  61. package/dist/es/models/IActivityStreamsRelationship.js +2 -0
  62. package/dist/es/models/IActivityStreamsRelationship.js.map +1 -0
  63. package/dist/es/models/IActivityStreamsService.js +2 -0
  64. package/dist/es/models/IActivityStreamsService.js.map +1 -0
  65. package/dist/es/models/IActivityStreamsTombstone.js +2 -0
  66. package/dist/es/models/IActivityStreamsTombstone.js.map +1 -0
  67. package/dist/es/models/IActivityStreamsVideo.js +2 -0
  68. package/dist/es/models/IActivityStreamsVideo.js.map +1 -0
  69. package/dist/es/models/activityStreamsContextType.js.map +1 -1
  70. package/dist/es/models/activityStreamsContexts.js +13 -7
  71. package/dist/es/models/activityStreamsContexts.js.map +1 -1
  72. package/dist/es/models/activityStreamsLinkTypes.js +21 -0
  73. package/dist/es/models/activityStreamsLinkTypes.js.map +1 -0
  74. package/dist/es/models/activityStreamsObjectTypes.js +141 -0
  75. package/dist/es/models/activityStreamsObjectTypes.js.map +1 -0
  76. package/dist/es/models/activityStreamsTypes.js +88 -30
  77. package/dist/es/models/activityStreamsTypes.js.map +1 -1
  78. package/dist/es/schemas/ActivityStreamsActivity.json +116 -127
  79. package/dist/es/schemas/ActivityStreamsActor.json +68 -0
  80. package/dist/es/schemas/ActivityStreamsApplication.json +41 -0
  81. package/dist/es/schemas/ActivityStreamsArticle.json +41 -0
  82. package/dist/es/schemas/ActivityStreamsAudio.json +41 -0
  83. package/dist/es/schemas/ActivityStreamsCollection.json +102 -0
  84. package/dist/es/schemas/ActivityStreamsCollectionPage.json +74 -0
  85. package/dist/es/schemas/ActivityStreamsContextType.json +30 -0
  86. package/dist/es/schemas/ActivityStreamsDocument.json +41 -0
  87. package/dist/es/schemas/ActivityStreamsEvent.json +41 -0
  88. package/dist/es/schemas/ActivityStreamsGroup.json +41 -0
  89. package/dist/es/schemas/ActivityStreamsImage.json +41 -0
  90. package/dist/es/schemas/ActivityStreamsIntransitiveActivity.json +167 -0
  91. package/dist/es/schemas/ActivityStreamsLink.json +112 -0
  92. package/dist/es/schemas/ActivityStreamsMention.json +41 -0
  93. package/dist/es/schemas/ActivityStreamsNote.json +41 -0
  94. package/dist/es/schemas/ActivityStreamsObject.json +507 -0
  95. package/dist/es/schemas/ActivityStreamsObjectTypes.json +112 -0
  96. package/dist/es/schemas/ActivityStreamsOrderedCollection.json +65 -0
  97. package/dist/es/schemas/ActivityStreamsOrderedCollectionPage.json +48 -0
  98. package/dist/es/schemas/ActivityStreamsOrganization.json +41 -0
  99. package/dist/es/schemas/ActivityStreamsPage.json +41 -0
  100. package/dist/es/schemas/ActivityStreamsPerson.json +41 -0
  101. package/dist/es/schemas/ActivityStreamsPlace.json +65 -0
  102. package/dist/es/schemas/ActivityStreamsProfile.json +52 -0
  103. package/dist/es/schemas/ActivityStreamsRelationship.json +67 -0
  104. package/dist/es/schemas/ActivityStreamsService.json +41 -0
  105. package/dist/es/schemas/ActivityStreamsTombstone.json +60 -0
  106. package/dist/es/schemas/ActivityStreamsTypes.json +119 -32
  107. package/dist/es/schemas/ActivityStreamsVideo.json +41 -0
  108. package/dist/types/dataTypes/activityStreamsDataTypes.d.ts +5 -1
  109. package/dist/types/index.d.ts +33 -0
  110. package/dist/types/models/IActivityStreamsActivity.d.ts +17 -13
  111. package/dist/types/models/IActivityStreamsActor.d.ts +16 -0
  112. package/dist/types/models/IActivityStreamsApplication.d.ts +15 -0
  113. package/dist/types/models/IActivityStreamsArticle.d.ts +15 -0
  114. package/dist/types/models/IActivityStreamsAudio.d.ts +15 -0
  115. package/dist/types/models/IActivityStreamsCollection.d.ts +42 -0
  116. package/dist/types/models/IActivityStreamsCollectionPage.d.ts +32 -0
  117. package/dist/types/models/IActivityStreamsDocument.d.ts +15 -0
  118. package/dist/types/models/IActivityStreamsEvent.d.ts +15 -0
  119. package/dist/types/models/IActivityStreamsGroup.d.ts +15 -0
  120. package/dist/types/models/IActivityStreamsImage.d.ts +15 -0
  121. package/dist/types/models/IActivityStreamsIntransitiveActivity.d.ts +42 -0
  122. package/dist/types/models/IActivityStreamsLink.d.ts +62 -0
  123. package/dist/types/models/IActivityStreamsMention.d.ts +16 -0
  124. package/dist/types/models/IActivityStreamsNote.d.ts +15 -0
  125. package/dist/types/models/IActivityStreamsObject.d.ts +187 -0
  126. package/dist/types/models/IActivityStreamsOrderedCollection.d.ts +21 -0
  127. package/dist/types/models/IActivityStreamsOrderedCollectionPage.d.ts +23 -0
  128. package/dist/types/models/IActivityStreamsOrganization.d.ts +15 -0
  129. package/dist/types/models/IActivityStreamsPage.d.ts +15 -0
  130. package/dist/types/models/IActivityStreamsPerson.d.ts +15 -0
  131. package/dist/types/models/IActivityStreamsPlace.d.ts +60 -0
  132. package/dist/types/models/IActivityStreamsProfile.d.ts +23 -0
  133. package/dist/types/models/IActivityStreamsQuestion.d.ts +13 -0
  134. package/dist/types/models/IActivityStreamsQuestionAnyOfChoice.d.ts +17 -0
  135. package/dist/types/models/IActivityStreamsQuestionBase.d.ts +22 -0
  136. package/dist/types/models/IActivityStreamsQuestionNeitherChoice.d.ts +13 -0
  137. package/dist/types/models/IActivityStreamsQuestionOneOfChoice.d.ts +17 -0
  138. package/dist/types/models/IActivityStreamsRelationship.d.ts +35 -0
  139. package/dist/types/models/IActivityStreamsService.d.ts +15 -0
  140. package/dist/types/models/IActivityStreamsTombstone.d.ts +27 -0
  141. package/dist/types/models/IActivityStreamsVideo.d.ts +15 -0
  142. package/dist/types/models/activityStreamsContextType.d.ts +2 -1
  143. package/dist/types/models/activityStreamsContexts.d.ts +12 -6
  144. package/dist/types/models/activityStreamsLinkTypes.d.ts +21 -0
  145. package/dist/types/models/activityStreamsObjectTypes.d.ts +141 -0
  146. package/dist/types/models/activityStreamsTypes.d.ts +87 -29
  147. package/docs/changelog.md +526 -40
  148. package/docs/examples.md +29 -1
  149. package/docs/reference/classes/ActivityStreamsDataTypes.md +14 -2
  150. package/docs/reference/index.md +35 -0
  151. package/docs/reference/interfaces/IActivityStreamsActivity.md +497 -26
  152. package/docs/reference/interfaces/IActivityStreamsActor.md +534 -0
  153. package/docs/reference/interfaces/IActivityStreamsApplication.md +525 -0
  154. package/docs/reference/interfaces/IActivityStreamsArticle.md +525 -0
  155. package/docs/reference/interfaces/IActivityStreamsAudio.md +525 -0
  156. package/docs/reference/interfaces/IActivityStreamsCollection.md +591 -0
  157. package/docs/reference/interfaces/IActivityStreamsCollectionPage.md +646 -0
  158. package/docs/reference/interfaces/IActivityStreamsDocument.md +532 -0
  159. package/docs/reference/interfaces/IActivityStreamsEvent.md +525 -0
  160. package/docs/reference/interfaces/IActivityStreamsGroup.md +525 -0
  161. package/docs/reference/interfaces/IActivityStreamsImage.md +525 -0
  162. package/docs/reference/interfaces/IActivityStreamsIntransitiveActivity.md +589 -0
  163. package/docs/reference/interfaces/IActivityStreamsLink.md +126 -0
  164. package/docs/reference/interfaces/IActivityStreamsMention.md +166 -0
  165. package/docs/reference/interfaces/IActivityStreamsNote.md +525 -0
  166. package/docs/reference/interfaces/IActivityStreamsObject.md +411 -0
  167. package/docs/reference/interfaces/IActivityStreamsOrderedCollection.md +621 -0
  168. package/docs/reference/interfaces/IActivityStreamsOrderedCollectionPage.md +683 -0
  169. package/docs/reference/interfaces/IActivityStreamsOrganization.md +525 -0
  170. package/docs/reference/interfaces/IActivityStreamsPage.md +525 -0
  171. package/docs/reference/interfaces/IActivityStreamsPerson.md +525 -0
  172. package/docs/reference/interfaces/IActivityStreamsPlace.md +612 -0
  173. package/docs/reference/interfaces/IActivityStreamsProfile.md +539 -0
  174. package/docs/reference/interfaces/IActivityStreamsQuestionAnyOfChoice.md +27 -0
  175. package/docs/reference/interfaces/IActivityStreamsQuestionBase.md +619 -0
  176. package/docs/reference/interfaces/IActivityStreamsQuestionNeitherChoice.md +19 -0
  177. package/docs/reference/interfaces/IActivityStreamsQuestionOneOfChoice.md +27 -0
  178. package/docs/reference/interfaces/IActivityStreamsRelationship.md +565 -0
  179. package/docs/reference/interfaces/IActivityStreamsService.md +525 -0
  180. package/docs/reference/interfaces/IActivityStreamsTombstone.md +550 -0
  181. package/docs/reference/interfaces/IActivityStreamsVideo.md +525 -0
  182. package/docs/reference/type-aliases/ActivityStreamsContextType.md +1 -1
  183. package/docs/reference/type-aliases/ActivityStreamsLinkTypes.md +5 -0
  184. package/docs/reference/type-aliases/ActivityStreamsObjectTypes.md +5 -0
  185. package/docs/reference/type-aliases/IActivityStreamsQuestion.md +13 -0
  186. package/docs/reference/variables/ActivityStreamsContexts.md +17 -9
  187. package/docs/reference/variables/ActivityStreamsLinkTypes.md +32 -0
  188. package/docs/reference/variables/ActivityStreamsObjectTypes.md +272 -0
  189. package/docs/reference/variables/ActivityStreamsTypes.md +116 -58
  190. package/package.json +7 -7
@@ -0,0 +1,15 @@
1
+ import type { ObjectOrArray } from "@twin.org/core";
2
+ import type { ActivityStreamsObjectTypes } from "./activityStreamsObjectTypes.js";
3
+ import type { IActivityStreamsObject } from "./IActivityStreamsObject.js";
4
+ /**
5
+ * A W3C Activity Streams Note.
6
+ *
7
+ * A `Note` is a short written work.
8
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-note
9
+ */
10
+ export interface IActivityStreamsNote extends IActivityStreamsObject {
11
+ /**
12
+ * Note type.
13
+ */
14
+ type: ObjectOrArray<typeof ActivityStreamsObjectTypes.Note | string>;
15
+ }
@@ -0,0 +1,187 @@
1
+ import type { ObjectOrArray } from "@twin.org/core";
2
+ import type { IJsonLdLanguageMap, IJsonLdNodeObject } from "@twin.org/data-json-ld";
3
+ import type { ActivityStreamsContextType } from "./activityStreamsContextType.js";
4
+ import type { ActivityStreamsObjectTypes } from "./activityStreamsObjectTypes.js";
5
+ /**
6
+ * A W3C Activity Streams Object.
7
+ *
8
+ * This is the base type for most ActivityStreams entities. It supports natural language
9
+ * values (e.g. `name`, `summary`, `content`) as either plain strings or language maps.
10
+ * @see https://www.w3.org/TR/activitystreams-core/#object
11
+ */
12
+ export interface IActivityStreamsObject {
13
+ /**
14
+ * The LD Context.
15
+ */
16
+ "@context": ActivityStreamsContextType;
17
+ /**
18
+ * Object type.
19
+ *
20
+ * The value can be a single type or an array of types.
21
+ */
22
+ type?: ObjectOrArray<ActivityStreamsObjectTypes | string>;
23
+ /**
24
+ * Global identifier.
25
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-id
26
+ * @json-schema format:uri
27
+ */
28
+ id?: string;
29
+ /**
30
+ * Natural language name.
31
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-name
32
+ */
33
+ name?: string | IJsonLdLanguageMap;
34
+ /**
35
+ * Natural language name map.
36
+ * @see https://www.w3.org/TR/activitystreams-core/#naturalLanguageValues
37
+ */
38
+ nameMap?: IJsonLdLanguageMap;
39
+ /**
40
+ * Natural language summary.
41
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-summary
42
+ */
43
+ summary?: string | IJsonLdLanguageMap;
44
+ /**
45
+ * Natural language summary map.
46
+ * @see https://www.w3.org/TR/activitystreams-core/#naturalLanguageValues
47
+ */
48
+ summaryMap?: IJsonLdLanguageMap;
49
+ /**
50
+ * Natural language content.
51
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-content
52
+ */
53
+ content?: string | IJsonLdLanguageMap;
54
+ /**
55
+ * Natural language content map.
56
+ * @see https://www.w3.org/TR/activitystreams-core/#naturalLanguageValues
57
+ */
58
+ contentMap?: IJsonLdLanguageMap;
59
+ /**
60
+ * A link to the representation of the object.
61
+ *
62
+ * The value can be a URI or an embedded node object.
63
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-url
64
+ */
65
+ url?: ObjectOrArray<string | IJsonLdNodeObject>;
66
+ /**
67
+ * A graphical representation of the object.
68
+ *
69
+ * The value can be a URI or an embedded `Image`/`Link` object.
70
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-image-term
71
+ */
72
+ image?: ObjectOrArray<string | IJsonLdNodeObject>;
73
+ /**
74
+ * An icon for the object.
75
+ *
76
+ * The value can be a URI or an embedded `Image`/`Link` object.
77
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-icon
78
+ */
79
+ icon?: ObjectOrArray<string | IJsonLdNodeObject>;
80
+ /**
81
+ * Published date-time.
82
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-published
83
+ * @json-schema format:date-time
84
+ */
85
+ published?: string;
86
+ /**
87
+ * Updated date-time.
88
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-updated
89
+ * @json-schema format:date-time
90
+ */
91
+ updated?: string;
92
+ /**
93
+ * Start time.
94
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-starttime
95
+ * @json-schema format:date-time
96
+ */
97
+ startTime?: string;
98
+ /**
99
+ * End time.
100
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-endtime
101
+ * @json-schema format:date-time
102
+ */
103
+ endTime?: string;
104
+ /**
105
+ * Duration.
106
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-duration
107
+ * @json-schema format:duration
108
+ */
109
+ duration?: string;
110
+ /**
111
+ * The generator of the object.
112
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-generator
113
+ */
114
+ generator?: ObjectOrArray<string | IJsonLdNodeObject>;
115
+ /**
116
+ * Attachments.
117
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-attachment
118
+ */
119
+ attachment?: ObjectOrArray<string | IJsonLdNodeObject>;
120
+ /**
121
+ * Objects attributed to.
122
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-attributedto
123
+ */
124
+ attributedTo?: ObjectOrArray<string | IJsonLdNodeObject>;
125
+ /**
126
+ * Audience.
127
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-audience
128
+ */
129
+ audience?: ObjectOrArray<string | IJsonLdNodeObject>;
130
+ /**
131
+ * Context.
132
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-context
133
+ */
134
+ context?: ObjectOrArray<string | IJsonLdNodeObject>;
135
+ /**
136
+ * Location.
137
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-location
138
+ */
139
+ location?: ObjectOrArray<string | IJsonLdNodeObject>;
140
+ /**
141
+ * Tag.
142
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-tag
143
+ */
144
+ tag?: ObjectOrArray<string | IJsonLdNodeObject>;
145
+ /**
146
+ * In reply to.
147
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-inreplyto
148
+ */
149
+ inReplyTo?: ObjectOrArray<string | IJsonLdNodeObject>;
150
+ /**
151
+ * Replies collection.
152
+ *
153
+ * Typically an embedded `Collection` of Objects that are replies to this object.
154
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-replies
155
+ */
156
+ replies?: IJsonLdNodeObject;
157
+ /**
158
+ * Preview.
159
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-preview
160
+ */
161
+ preview?: ObjectOrArray<string | IJsonLdNodeObject>;
162
+ /**
163
+ * To.
164
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-to
165
+ */
166
+ to?: ObjectOrArray<string | IJsonLdNodeObject>;
167
+ /**
168
+ * BTo.
169
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-bto
170
+ */
171
+ bto?: ObjectOrArray<string | IJsonLdNodeObject>;
172
+ /**
173
+ * CC.
174
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-cc
175
+ */
176
+ cc?: ObjectOrArray<string | IJsonLdNodeObject>;
177
+ /**
178
+ * BCC.
179
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-bcc
180
+ */
181
+ bcc?: ObjectOrArray<string | IJsonLdNodeObject>;
182
+ /**
183
+ * MIME media type of the referenced resource.
184
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-mediatype
185
+ */
186
+ mediaType?: string;
187
+ }
@@ -0,0 +1,21 @@
1
+ import type { ObjectOrArray } from "@twin.org/core";
2
+ import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
3
+ import type { ActivityStreamsObjectTypes } from "./activityStreamsObjectTypes.js";
4
+ import type { IActivityStreamsCollection } from "./IActivityStreamsCollection.js";
5
+ /**
6
+ * A W3C Activity Streams OrderedCollection.
7
+ *
8
+ * An `OrderedCollection` is a `Collection` whose items are explicitly ordered.
9
+ * @see https://www.w3.org/TR/activitystreams-core/#collections
10
+ */
11
+ export interface IActivityStreamsOrderedCollection extends IActivityStreamsCollection {
12
+ /**
13
+ * OrderedCollection type.
14
+ */
15
+ type: ObjectOrArray<typeof ActivityStreamsObjectTypes.OrderedCollection | string>;
16
+ /**
17
+ * The ordered items of the collection.
18
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-ordereditems
19
+ */
20
+ orderedItems?: ObjectOrArray<string | IJsonLdNodeObject>;
21
+ }
@@ -0,0 +1,23 @@
1
+ import type { ObjectOrArray } from "@twin.org/core";
2
+ import type { ActivityStreamsObjectTypes } from "./activityStreamsObjectTypes.js";
3
+ import type { IActivityStreamsCollectionPage } from "./IActivityStreamsCollectionPage.js";
4
+ import type { IActivityStreamsOrderedCollection } from "./IActivityStreamsOrderedCollection.js";
5
+ /**
6
+ * A W3C Activity Streams OrderedCollectionPage.
7
+ *
8
+ * An `OrderedCollectionPage` is a page from an `OrderedCollection`. When
9
+ * `orderedItems` are present, `startIndex` can be used as an offset for the first
10
+ * item in the page.
11
+ * @see https://www.w3.org/TR/activitystreams-core/#collections
12
+ */
13
+ export interface IActivityStreamsOrderedCollectionPage extends IActivityStreamsCollectionPage, IActivityStreamsOrderedCollection {
14
+ /**
15
+ * OrderedCollectionPage type.
16
+ */
17
+ type: ObjectOrArray<typeof ActivityStreamsObjectTypes.OrderedCollectionPage | string>;
18
+ /**
19
+ * Relative index position of the first item in this page.
20
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-startindex
21
+ */
22
+ startIndex?: number;
23
+ }
@@ -0,0 +1,15 @@
1
+ import type { ObjectOrArray } from "@twin.org/core";
2
+ import type { ActivityStreamsObjectTypes } from "./activityStreamsObjectTypes.js";
3
+ import type { IActivityStreamsActor } from "./IActivityStreamsActor.js";
4
+ /**
5
+ * A W3C Activity Streams Organization.
6
+ *
7
+ * An `Organization` represents an organization.
8
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-organization
9
+ */
10
+ export interface IActivityStreamsOrganization extends IActivityStreamsActor {
11
+ /**
12
+ * Organization type.
13
+ */
14
+ type: ObjectOrArray<typeof ActivityStreamsObjectTypes.Organization | string>;
15
+ }
@@ -0,0 +1,15 @@
1
+ import type { ObjectOrArray } from "@twin.org/core";
2
+ import type { ActivityStreamsObjectTypes } from "./activityStreamsObjectTypes.js";
3
+ import type { IActivityStreamsDocument } from "./IActivityStreamsDocument.js";
4
+ /**
5
+ * A W3C Activity Streams Page.
6
+ *
7
+ * A `Page` is a `Document` that represents a Web Page.
8
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-page
9
+ */
10
+ export interface IActivityStreamsPage extends IActivityStreamsDocument {
11
+ /**
12
+ * Page type.
13
+ */
14
+ type: ObjectOrArray<typeof ActivityStreamsObjectTypes.Page | string>;
15
+ }
@@ -0,0 +1,15 @@
1
+ import type { ObjectOrArray } from "@twin.org/core";
2
+ import type { ActivityStreamsObjectTypes } from "./activityStreamsObjectTypes.js";
3
+ import type { IActivityStreamsActor } from "./IActivityStreamsActor.js";
4
+ /**
5
+ * A W3C Activity Streams Person.
6
+ *
7
+ * A `Person` represents an individual person.
8
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-person
9
+ */
10
+ export interface IActivityStreamsPerson extends IActivityStreamsActor {
11
+ /**
12
+ * Person type.
13
+ */
14
+ type: ObjectOrArray<typeof ActivityStreamsObjectTypes.Person | string>;
15
+ }
@@ -0,0 +1,60 @@
1
+ import type { ObjectOrArray } from "@twin.org/core";
2
+ import type { ActivityStreamsObjectTypes } from "./activityStreamsObjectTypes.js";
3
+ import type { IActivityStreamsObject } from "./IActivityStreamsObject.js";
4
+ /**
5
+ * A W3C Activity Streams Place.
6
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-place
7
+ */
8
+ export interface IActivityStreamsPlace extends IActivityStreamsObject {
9
+ /**
10
+ * Place type.
11
+ */
12
+ type: ObjectOrArray<typeof ActivityStreamsObjectTypes.Place | string>;
13
+ /**
14
+ * The latitude of the Place.
15
+ *
16
+ * The Activity Streams vocabulary defines this as an `xsd:float`.
17
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-latitude
18
+ */
19
+ latitude?: number;
20
+ /**
21
+ * The longitude of the Place.
22
+ *
23
+ * The Activity Streams vocabulary defines this as an `xsd:float`.
24
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-longitude
25
+ */
26
+ longitude?: number;
27
+ /**
28
+ * The altitude of the Place.
29
+ *
30
+ * Measurement units are specified using the `units` property. If `units` is not specified,
31
+ * the default is assumed to be "m" (meters).
32
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-altitude
33
+ */
34
+ altitude?: number;
35
+ /**
36
+ * The accuracy of the Place.
37
+ *
38
+ * Indicates the accuracy of position coordinates on a Place objects.
39
+ * Expressed in properties of percentage. e.g. "94.0" means "94.0% accurate".
40
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-accuracy
41
+ */
42
+ accuracy?: number;
43
+ /**
44
+ * The radius from the given `latitude` and `longitude`.
45
+ *
46
+ * Measurement units are specified using the `units` property. If `units` is not specified,
47
+ * the default is assumed to be "m" (meters).
48
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-radius
49
+ */
50
+ radius?: number;
51
+ /**
52
+ * Measurement units for the `radius` and `altitude` properties.
53
+ *
54
+ * If not specified, the default is assumed to be "m" (meters). The Activity Streams
55
+ * vocabulary allows values such as "cm", "feet", "inches", "km", "m", "miles", or any
56
+ * other unit expressed as a URI.
57
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-units
58
+ */
59
+ units?: string;
60
+ }
@@ -0,0 +1,23 @@
1
+ import type { ObjectOrArray } from "@twin.org/core";
2
+ import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
3
+ import type { ActivityStreamsObjectTypes } from "./activityStreamsObjectTypes.js";
4
+ import type { IActivityStreamsObject } from "./IActivityStreamsObject.js";
5
+ /**
6
+ * A W3C Activity Streams Profile.
7
+ *
8
+ * A `Profile` is a content object that describes another `Object`.
9
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-profile
10
+ */
11
+ export interface IActivityStreamsProfile extends IActivityStreamsObject {
12
+ /**
13
+ * Profile type.
14
+ */
15
+ type: ObjectOrArray<typeof ActivityStreamsObjectTypes.Profile | string>;
16
+ /**
17
+ * The object being described.
18
+ *
19
+ * This is the target entity that the `Profile` is about.
20
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-describes
21
+ */
22
+ describes?: string | IJsonLdNodeObject;
23
+ }
@@ -0,0 +1,13 @@
1
+ import type { IActivityStreamsQuestionAnyOfChoice } from "./IActivityStreamsQuestionAnyOfChoice.js";
2
+ import type { IActivityStreamsQuestionBase } from "./IActivityStreamsQuestionBase.js";
3
+ import type { IActivityStreamsQuestionNeitherChoice } from "./IActivityStreamsQuestionNeitherChoice.js";
4
+ import type { IActivityStreamsQuestionOneOfChoice } from "./IActivityStreamsQuestionOneOfChoice.js";
5
+ /**
6
+ * A W3C Activity Streams Question.
7
+ *
8
+ * A `Question` represents a question being asked. Use `oneOf` for exclusive
9
+ * choices, `anyOf` for inclusive choices, and `closed` to indicate when the question
10
+ * is closed.
11
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-question
12
+ */
13
+ export type IActivityStreamsQuestion = IActivityStreamsQuestionBase & (IActivityStreamsQuestionAnyOfChoice | IActivityStreamsQuestionOneOfChoice | IActivityStreamsQuestionNeitherChoice);
@@ -0,0 +1,17 @@
1
+ import type { ObjectOrArray } from "@twin.org/core";
2
+ import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
3
+ /**
4
+ * Represents a Question with an inclusive list of possible answers, but not an exclusive list.
5
+ */
6
+ export interface IActivityStreamsQuestionAnyOfChoice {
7
+ /**
8
+ * Specifies an inclusive list of possible answers.
9
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-anyof
10
+ */
11
+ anyOf: ObjectOrArray<IJsonLdNodeObject>;
12
+ /**
13
+ * Specifies an exclusive list of possible answers.
14
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-oneof
15
+ */
16
+ oneOf?: never;
17
+ }
@@ -0,0 +1,22 @@
1
+ import type { ObjectOrArray } from "@twin.org/core";
2
+ import type { ActivityStreamsTypes } from "./activityStreamsTypes.js";
3
+ import type { IActivityStreamsIntransitiveActivity } from "./IActivityStreamsIntransitiveActivity.js";
4
+ /**
5
+ * A W3C Activity Streams Question base.
6
+ *
7
+ * A `Question` represents a question being asked. Use `oneOf` for exclusive
8
+ * choices, `anyOf` for inclusive choices, and `closed` to indicate when the question
9
+ * is closed.
10
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-question
11
+ */
12
+ export interface IActivityStreamsQuestionBase extends IActivityStreamsIntransitiveActivity {
13
+ /**
14
+ * Question type.
15
+ */
16
+ type: ObjectOrArray<typeof ActivityStreamsTypes.Question | string>;
17
+ /**
18
+ * Indicates that the Question has been closed.
19
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-closed
20
+ */
21
+ closed?: boolean | string;
22
+ }
@@ -0,0 +1,13 @@
1
+ /**
2
+ * Represents a Question with neither anyOf nor oneOf.
3
+ */
4
+ export interface IActivityStreamsQuestionNeitherChoice {
5
+ /**
6
+ * Specifies an inclusive list of possible answers.
7
+ */
8
+ anyOf?: never;
9
+ /**
10
+ * Specifies an exclusive list of possible answers.
11
+ */
12
+ oneOf?: never;
13
+ }
@@ -0,0 +1,17 @@
1
+ import type { ObjectOrArray } from "@twin.org/core";
2
+ import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
3
+ /**
4
+ * Represents a Question with an exclusive list of possible answers, but not an inclusive list.
5
+ */
6
+ export interface IActivityStreamsQuestionOneOfChoice {
7
+ /**
8
+ * Specifies an inclusive list of possible answers.
9
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-anyof
10
+ */
11
+ anyOf?: never;
12
+ /**
13
+ * Specifies an exclusive list of possible answers.
14
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-oneof
15
+ */
16
+ oneOf: ObjectOrArray<IJsonLdNodeObject>;
17
+ }
@@ -0,0 +1,35 @@
1
+ import type { ObjectOrArray } from "@twin.org/core";
2
+ import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
3
+ import type { ActivityStreamsObjectTypes } from "./activityStreamsObjectTypes.js";
4
+ import type { IActivityStreamsObject } from "./IActivityStreamsObject.js";
5
+ /**
6
+ * A W3C Activity Streams Relationship.
7
+ *
8
+ * A `Relationship` can be used to describe a relationship between two entities.
9
+ * It is commonly used as a reified statement, using `subject` (subject), `relationship`
10
+ * (predicate), and `object` (object).
11
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-relationship
12
+ */
13
+ export interface IActivityStreamsRelationship extends IActivityStreamsObject {
14
+ /**
15
+ * Relationship type.
16
+ */
17
+ type: ObjectOrArray<typeof ActivityStreamsObjectTypes.Relationship | string>;
18
+ /**
19
+ * Subject of the relationship.
20
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-subject
21
+ */
22
+ subject?: string | IJsonLdNodeObject;
23
+ /**
24
+ * Object of the relationship.
25
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-object-term
26
+ */
27
+ object?: IJsonLdNodeObject;
28
+ /**
29
+ * The relationship predicate.
30
+ *
31
+ * For example, a URI identifying the relationship type.
32
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-relationship
33
+ */
34
+ relationship?: string | IJsonLdNodeObject;
35
+ }
@@ -0,0 +1,15 @@
1
+ import type { ObjectOrArray } from "@twin.org/core";
2
+ import type { ActivityStreamsObjectTypes } from "./activityStreamsObjectTypes.js";
3
+ import type { IActivityStreamsActor } from "./IActivityStreamsActor.js";
4
+ /**
5
+ * A W3C Activity Streams Service.
6
+ *
7
+ * A `Service` represents a service of any kind.
8
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-service
9
+ */
10
+ export interface IActivityStreamsService extends IActivityStreamsActor {
11
+ /**
12
+ * Service type.
13
+ */
14
+ type: ObjectOrArray<typeof ActivityStreamsObjectTypes.Service | string>;
15
+ }
@@ -0,0 +1,27 @@
1
+ import type { ObjectOrArray } from "@twin.org/core";
2
+ import type { ActivityStreamsObjectTypes } from "./activityStreamsObjectTypes.js";
3
+ import type { IActivityStreamsObject } from "./IActivityStreamsObject.js";
4
+ /**
5
+ * A W3C Activity Streams Tombstone.
6
+ *
7
+ * A `Tombstone` represents an object that has been deleted. Implementations can
8
+ * include `formerType` and `deleted` to provide additional context.
9
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-tombstone
10
+ */
11
+ export interface IActivityStreamsTombstone extends IActivityStreamsObject {
12
+ /**
13
+ * Tombstone type.
14
+ */
15
+ type: ObjectOrArray<typeof ActivityStreamsObjectTypes.Tombstone | string>;
16
+ /**
17
+ * The date and time at which the object was deleted.
18
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-deleted
19
+ * @json-schema format:date-time
20
+ */
21
+ deleted?: string;
22
+ /**
23
+ * The former type of the deleted object.
24
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-formertype
25
+ */
26
+ formerType?: ObjectOrArray<string>;
27
+ }
@@ -0,0 +1,15 @@
1
+ import type { ObjectOrArray } from "@twin.org/core";
2
+ import type { ActivityStreamsObjectTypes } from "./activityStreamsObjectTypes.js";
3
+ import type { IActivityStreamsDocument } from "./IActivityStreamsDocument.js";
4
+ /**
5
+ * A W3C Activity Streams Video.
6
+ *
7
+ * A `Video` is a video document of any kind.
8
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-video
9
+ */
10
+ export interface IActivityStreamsVideo extends IActivityStreamsDocument {
11
+ /**
12
+ * Video type.
13
+ */
14
+ type: ObjectOrArray<typeof ActivityStreamsObjectTypes.Video | string>;
15
+ }
@@ -1,6 +1,7 @@
1
+ import type { SingleOccurrenceArray } from "@twin.org/core";
1
2
  import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
2
3
  import type { ActivityStreamsContexts } from "./activityStreamsContexts.js";
3
4
  /**
4
5
  * The Activity Streams JSON-LD context type.
5
6
  */
6
- export type ActivityStreamsContextType = typeof ActivityStreamsContexts.ContextRoot | [typeof ActivityStreamsContexts.ContextRoot] | [...IJsonLdContextDefinitionElement[], typeof ActivityStreamsContexts.ContextRoot];
7
+ export type ActivityStreamsContextType = typeof ActivityStreamsContexts.Context | SingleOccurrenceArray<IJsonLdContextDefinitionElement, typeof ActivityStreamsContexts.Context>;
@@ -3,17 +3,23 @@
3
3
  */
4
4
  export declare const ActivityStreamsContexts: {
5
5
  /**
6
- * The Activity Streams LD Context.
6
+ * The canonical RDF namespace URI.
7
7
  */
8
- readonly ContextRoot: "https://www.w3.org/ns/activitystreams";
8
+ readonly Namespace: "https://www.w3.org/ns/activitystreams#";
9
9
  /**
10
- * The Activity Streams namespace.
10
+ * The value to use in @context.
11
+ * Note: Context differs from Namespace (no trailing #) as per Activity Streams 2.0 specification.
12
+ * The Activity Streams JSON-LD context URL format does not include a trailing hash.
11
13
  */
12
- readonly ActivityStreamsNamespace: "https://www.w3.org/ns/activitystreams#";
14
+ readonly Context: "https://www.w3.org/ns/activitystreams";
13
15
  /**
14
- * The TWIN context for Activity Streams.
16
+ * The JSON-LD Context URL.
15
17
  */
16
- readonly TwinContext: "https://schema.twindev.org/w3c-activity-streams";
18
+ readonly JsonLdContext: "https://www.w3.org/ns/activitystreams.jsonld";
19
+ /**
20
+ * The namespace location of the hosted version of the JSON Schema.
21
+ */
22
+ readonly JsonSchemaNamespace: "https://schema.twindev.org/w3c-activity-streams/";
17
23
  };
18
24
  /**
19
25
  * The LD Contexts concerning Activity Streams.
@@ -0,0 +1,21 @@
1
+ /**
2
+ * The link types concerning Activity Streams.
3
+ * @see https://www.w3.org/TR/activitystreams-core/#link
4
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#link
5
+ */
6
+ export declare const ActivityStreamsLinkTypes: {
7
+ /**
8
+ * Link
9
+ * @see https://www.w3.org/TR/activitystreams-core/#link
10
+ */
11
+ readonly Link: "Link";
12
+ /**
13
+ * Mention
14
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-mention
15
+ */
16
+ readonly Mention: "Mention";
17
+ };
18
+ /**
19
+ * The link types concerning Activity Streams.
20
+ */
21
+ export type ActivityStreamsLinkTypes = (typeof ActivityStreamsLinkTypes)[keyof typeof ActivityStreamsLinkTypes];