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

package/docs/examples.md

@@ -1 +1,29 @@
-# @twin.org/standards-w3c-activity-streams Examples
+# Standards W3C Activity Streams Examples
+
+These snippets register type mappings and compose an activity payload with actor and object values.
+
+## ActivityStreamsDataTypes
+
+```typescript
+import {
+  ActivityStreamsContexts,
+  ActivityStreamsDataTypes,
+  ActivityStreamsObjectTypes,
+  type IActivityStreamsActivity
+} from '@twin.org/standards-w3c-activity-streams';
+
+ActivityStreamsDataTypes.registerRedirects();
+ActivityStreamsDataTypes.registerTypes();
+
+const activity: IActivityStreamsActivity = {
+  '@context': ActivityStreamsContexts.Context,
+  type: ActivityStreamsObjectTypes.Create,
+  actor: 'did:example:publisher',
+  object: {
+    type: ActivityStreamsObjectTypes.Note,
+    content: 'Shipment created'
+  }
+};
+
+console.log(activity.type); // Create
+```

package/docs/reference/classes/ActivityStreamsDataTypes.md

@@ -1,6 +1,6 @@
 # Abstract Class: ActivityStreamsDataTypes
 
-Data Type registration for the Data Space Connector
+Handle all the data types for Activity Streams.
 
 ## Constructors
 
@@ -14,7 +14,19 @@ Data Type registration for the Data Space Connector
 
 ## Methods
 
-### registerTypes()
+### registerRedirects() {#registerredirects}
+
+> `static` **registerRedirects**(): `void`
+
+Register the JSON-LD Redirects.
+
+#### Returns
+
+`void`
+
+***
+
+### registerTypes() {#registertypes}
 
 > `static` **registerTypes**(): `void`
 

package/docs/reference/index.md

@@ -7,14 +7,49 @@
 ## Interfaces
 
 - [IActivityStreamsActivity](interfaces/IActivityStreamsActivity.md)
+- [IActivityStreamsActor](interfaces/IActivityStreamsActor.md)
+- [IActivityStreamsApplication](interfaces/IActivityStreamsApplication.md)
+- [IActivityStreamsArticle](interfaces/IActivityStreamsArticle.md)
+- [IActivityStreamsAudio](interfaces/IActivityStreamsAudio.md)
+- [IActivityStreamsCollection](interfaces/IActivityStreamsCollection.md)
+- [IActivityStreamsCollectionPage](interfaces/IActivityStreamsCollectionPage.md)
+- [IActivityStreamsDocument](interfaces/IActivityStreamsDocument.md)
+- [IActivityStreamsEvent](interfaces/IActivityStreamsEvent.md)
+- [IActivityStreamsGroup](interfaces/IActivityStreamsGroup.md)
+- [IActivityStreamsImage](interfaces/IActivityStreamsImage.md)
+- [IActivityStreamsIntransitiveActivity](interfaces/IActivityStreamsIntransitiveActivity.md)
+- [IActivityStreamsLink](interfaces/IActivityStreamsLink.md)
+- [IActivityStreamsMention](interfaces/IActivityStreamsMention.md)
+- [IActivityStreamsNote](interfaces/IActivityStreamsNote.md)
+- [IActivityStreamsObject](interfaces/IActivityStreamsObject.md)
+- [IActivityStreamsOrderedCollection](interfaces/IActivityStreamsOrderedCollection.md)
+- [IActivityStreamsOrderedCollectionPage](interfaces/IActivityStreamsOrderedCollectionPage.md)
+- [IActivityStreamsOrganization](interfaces/IActivityStreamsOrganization.md)
+- [IActivityStreamsPage](interfaces/IActivityStreamsPage.md)
+- [IActivityStreamsPerson](interfaces/IActivityStreamsPerson.md)
+- [IActivityStreamsPlace](interfaces/IActivityStreamsPlace.md)
+- [IActivityStreamsProfile](interfaces/IActivityStreamsProfile.md)
+- [IActivityStreamsQuestionAnyOfChoice](interfaces/IActivityStreamsQuestionAnyOfChoice.md)
+- [IActivityStreamsQuestionBase](interfaces/IActivityStreamsQuestionBase.md)
+- [IActivityStreamsQuestionNeitherChoice](interfaces/IActivityStreamsQuestionNeitherChoice.md)
+- [IActivityStreamsQuestionOneOfChoice](interfaces/IActivityStreamsQuestionOneOfChoice.md)
+- [IActivityStreamsRelationship](interfaces/IActivityStreamsRelationship.md)
+- [IActivityStreamsService](interfaces/IActivityStreamsService.md)
+- [IActivityStreamsTombstone](interfaces/IActivityStreamsTombstone.md)
+- [IActivityStreamsVideo](interfaces/IActivityStreamsVideo.md)
 
 ## Type Aliases
 
+- [IActivityStreamsQuestion](type-aliases/IActivityStreamsQuestion.md)
 - [ActivityStreamsContextType](type-aliases/ActivityStreamsContextType.md)
 - [ActivityStreamsContexts](type-aliases/ActivityStreamsContexts.md)
+- [ActivityStreamsLinkTypes](type-aliases/ActivityStreamsLinkTypes.md)
+- [ActivityStreamsObjectTypes](type-aliases/ActivityStreamsObjectTypes.md)
 - [ActivityStreamsTypes](type-aliases/ActivityStreamsTypes.md)
 
 ## Variables
 
 - [ActivityStreamsContexts](variables/ActivityStreamsContexts.md)
+- [ActivityStreamsLinkTypes](variables/ActivityStreamsLinkTypes.md)
+- [ActivityStreamsObjectTypes](variables/ActivityStreamsObjectTypes.md)
 - [ActivityStreamsTypes](variables/ActivityStreamsTypes.md)

package/docs/reference/interfaces/IActivityStreamsActivity.md

@@ -1,6 +1,9 @@
 # Interface: IActivityStreamsActivity
 
-A W3C Activity from Activity Streams
+A W3C Activity from Activity Streams.
+
+An `Activity` describes an action performed by an `actor` on an `object`, and
+can optionally include a `target`, `result`, `origin`, or `instrument`.
 
 ## See
 
@@ -8,15 +11,11 @@ https://www.w3.org/TR/activitystreams-core/#activities
 
 ## Extends
 
-- `IJsonLdNodeObject`
-
-## 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`
+- [`IActivityStreamsObject`](IActivityStreamsObject.md)
 
 ## Properties
 
-### @context
+### @context {#context}
 
 > **@context**: [`ActivityStreamsContextType`](../type-aliases/ActivityStreamsContextType.md)
 
@@ -24,29 +23,41 @@ The LD Context.
 
 #### Overrides
 
-`IJsonLdNodeObject.@context`
+[`IActivityStreamsObject`](IActivityStreamsObject.md).[`@context`](IActivityStreamsObject.md#context)
 
 ***
 
-### type
+### type {#type}
 
 > **type**: `ObjectOrArray`\<`string`\>
 
 Activity Type.
 
+#### Overrides
+
+[`IActivityStreamsObject`](IActivityStreamsObject.md).[`type`](IActivityStreamsObject.md#type)
+
 ***
 
-### generator?
+### generator? {#generator}
 
-> `optional` **generator**: `string` \| `string`[] \| `IJsonLdNodeObject`
+> `optional` **generator?**: `ObjectOrArray`\<`string` \| `IJsonLdNodeObject`\>
 
 The generator of the Activity.
 
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-generator
+
+#### Overrides
+
+[`IActivityStreamsObject`](IActivityStreamsObject.md).[`generator`](IActivityStreamsObject.md#generator)
+
 ***
 
-### actor
+### actor? {#actor}
 
-> **actor**: `string` \| `string`[] \| `IJsonLdNodeObject` \| `undefined`
+> `optional` **actor?**: `ObjectOrArray`\<`string` \| `IJsonLdNodeObject`\>
 
 The Actor behind the Activity.
 
@@ -56,9 +67,9 @@ https://www.w3.org/TR/activitystreams-vocabulary/#dfn-actor
 
 ***
 
-### object
+### object? {#object}
 
-> **object**: `IJsonLdNodeObject`
+> `optional` **object?**: `ObjectOrArray`\<`string` \| `IJsonLdNodeObject`\>
 
 The object affected by the Activity.
 
@@ -68,9 +79,9 @@ https://www.w3.org/TR/activitystreams-vocabulary/#dfn-object
 
 ***
 
-### target?
+### target? {#target}
 
-> `optional` **target**: `IJsonLdNodeObject`
+> `optional` **target?**: `ObjectOrArray`\<`string` \| `IJsonLdNodeObject`\>
 
 The target of the Activity.
 
@@ -80,9 +91,9 @@ https://www.w3.org/TR/activitystreams-vocabulary/#dfn-target
 
 ***
 
-### summary?
+### summary? {#summary}
 
-> `optional` **summary**: `string` \| `IJsonLdLanguageMap`
+> `optional` **summary?**: `string` \| `IJsonLdLanguageMap`
 
 Summary of the Activity.
 
@@ -90,11 +101,15 @@ Summary of the Activity.
 
 https://www.w3.org/TR/activitystreams-vocabulary/#dfn-summary
 
+#### Overrides
+
+[`IActivityStreamsObject`](IActivityStreamsObject.md).[`summary`](IActivityStreamsObject.md#summary)
+
 ***
 
-### result?
+### result? {#result}
 
-> `optional` **result**: `IJsonLdNodeObject`
+> `optional` **result?**: `ObjectOrArray`\<`string` \| `IJsonLdNodeObject`\>
 
 Result of the Activity.
 
@@ -104,9 +119,9 @@ https://www.w3.org/TR/activitystreams-vocabulary/#dfn-result
 
 ***
 
-### origin?
+### origin? {#origin}
 
-> `optional` **origin**: `string` \| `string`[] \| `IJsonLdNodeObject`
+> `optional` **origin?**: `ObjectOrArray`\<`string` \| `IJsonLdNodeObject`\>
 
 Activity's origin.
 
@@ -116,12 +131,468 @@ https://www.w3.org/TR/activitystreams-vocabulary/#dfn-origin
 
 ***
 
-### updated
+### instrument? {#instrument}
+
+> `optional` **instrument?**: `ObjectOrArray`\<`string` \| `IJsonLdNodeObject`\>
+
+Instrument used in the Activity.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-instrument
+
+***
+
+### id? {#id}
+
+> `optional` **id?**: `string`
+
+Global identifier.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-id
+
+#### Inherited from
+
+[`IActivityStreamsObject`](IActivityStreamsObject.md).[`id`](IActivityStreamsObject.md#id)
+
+***
+
+### name? {#name}
+
+> `optional` **name?**: `string` \| `IJsonLdLanguageMap`
+
+Natural language name.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-name
+
+#### Inherited from
+
+[`IActivityStreamsObject`](IActivityStreamsObject.md).[`name`](IActivityStreamsObject.md#name)
+
+***
+
+### nameMap? {#namemap}
+
+> `optional` **nameMap?**: `IJsonLdLanguageMap`
+
+Natural language name map.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-core/#naturalLanguageValues
+
+#### Inherited from
+
+[`IActivityStreamsObject`](IActivityStreamsObject.md).[`nameMap`](IActivityStreamsObject.md#namemap)
+
+***
+
+### summaryMap? {#summarymap}
+
+> `optional` **summaryMap?**: `IJsonLdLanguageMap`
+
+Natural language summary map.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-core/#naturalLanguageValues
+
+#### Inherited from
+
+[`IActivityStreamsObject`](IActivityStreamsObject.md).[`summaryMap`](IActivityStreamsObject.md#summarymap)
+
+***
+
+### content? {#content}
+
+> `optional` **content?**: `string` \| `IJsonLdLanguageMap`
+
+Natural language content.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-content
+
+#### Inherited from
+
+[`IActivityStreamsObject`](IActivityStreamsObject.md).[`content`](IActivityStreamsObject.md#content)
+
+***
+
+### contentMap? {#contentmap}
+
+> `optional` **contentMap?**: `IJsonLdLanguageMap`
+
+Natural language content map.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-core/#naturalLanguageValues
+
+#### Inherited from
+
+[`IActivityStreamsObject`](IActivityStreamsObject.md).[`contentMap`](IActivityStreamsObject.md#contentmap)
+
+***
+
+### url? {#url}
+
+> `optional` **url?**: `ObjectOrArray`\<`string` \| `IJsonLdNodeObject`\>
+
+A link to the representation of the object.
+
+The value can be a URI or an embedded node object.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-url
+
+#### Inherited from
+
+[`IActivityStreamsObject`](IActivityStreamsObject.md).[`url`](IActivityStreamsObject.md#url)
+
+***
+
+### image? {#image}
 
-> **updated**: `string`
+> `optional` **image?**: `ObjectOrArray`\<`string` \| `IJsonLdNodeObject`\>
 
-The date and time at which the object was updated.
+A graphical representation of the object.
+
+The value can be a URI or an embedded `Image`/`Link` object.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-image-term
+
+#### Inherited from
+
+[`IActivityStreamsObject`](IActivityStreamsObject.md).[`image`](IActivityStreamsObject.md#image)
+
+***
+
+### icon? {#icon}
+
+> `optional` **icon?**: `ObjectOrArray`\<`string` \| `IJsonLdNodeObject`\>
+
+An icon for the object.
+
+The value can be a URI or an embedded `Image`/`Link` object.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-icon
+
+#### Inherited from
+
+[`IActivityStreamsObject`](IActivityStreamsObject.md).[`icon`](IActivityStreamsObject.md#icon)
+
+***
+
+### published? {#published}
+
+> `optional` **published?**: `string`
+
+Published date-time.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-published
+
+#### Inherited from
+
+[`IActivityStreamsObject`](IActivityStreamsObject.md).[`published`](IActivityStreamsObject.md#published)
+
+***
+
+### updated? {#updated}
+
+> `optional` **updated?**: `string`
+
+Updated date-time.
 
 #### See
 
 https://www.w3.org/TR/activitystreams-vocabulary/#dfn-updated
+
+#### Inherited from
+
+[`IActivityStreamsObject`](IActivityStreamsObject.md).[`updated`](IActivityStreamsObject.md#updated)
+
+***
+
+### startTime? {#starttime}
+
+> `optional` **startTime?**: `string`
+
+Start time.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-starttime
+
+#### Inherited from
+
+[`IActivityStreamsObject`](IActivityStreamsObject.md).[`startTime`](IActivityStreamsObject.md#starttime)
+
+***
+
+### endTime? {#endtime}
+
+> `optional` **endTime?**: `string`
+
+End time.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-endtime
+
+#### Inherited from
+
+[`IActivityStreamsObject`](IActivityStreamsObject.md).[`endTime`](IActivityStreamsObject.md#endtime)
+
+***
+
+### duration? {#duration}
+
+> `optional` **duration?**: `string`
+
+Duration.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-duration
+
+#### Inherited from
+
+[`IActivityStreamsObject`](IActivityStreamsObject.md).[`duration`](IActivityStreamsObject.md#duration)
+
+***
+
+### attachment? {#attachment}
+
+> `optional` **attachment?**: `ObjectOrArray`\<`string` \| `IJsonLdNodeObject`\>
+
+Attachments.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-attachment
+
+#### Inherited from
+
+[`IActivityStreamsObject`](IActivityStreamsObject.md).[`attachment`](IActivityStreamsObject.md#attachment)
+
+***
+
+### attributedTo? {#attributedto}
+
+> `optional` **attributedTo?**: `ObjectOrArray`\<`string` \| `IJsonLdNodeObject`\>
+
+Objects attributed to.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-attributedto
+
+#### Inherited from
+
+[`IActivityStreamsObject`](IActivityStreamsObject.md).[`attributedTo`](IActivityStreamsObject.md#attributedto)
+
+***
+
+### audience? {#audience}
+
+> `optional` **audience?**: `ObjectOrArray`\<`string` \| `IJsonLdNodeObject`\>
+
+Audience.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-audience
+
+#### Inherited from
+
+[`IActivityStreamsObject`](IActivityStreamsObject.md).[`audience`](IActivityStreamsObject.md#audience)
+
+***
+
+### context? {#context-1}
+
+> `optional` **context?**: `ObjectOrArray`\<`string` \| `IJsonLdNodeObject`\>
+
+Context.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-context
+
+#### Inherited from
+
+[`IActivityStreamsObject`](IActivityStreamsObject.md).[`context`](IActivityStreamsObject.md#context-1)
+
+***
+
+### location? {#location}
+
+> `optional` **location?**: `ObjectOrArray`\<`string` \| `IJsonLdNodeObject`\>
+
+Location.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-location
+
+#### Inherited from
+
+[`IActivityStreamsObject`](IActivityStreamsObject.md).[`location`](IActivityStreamsObject.md#location)
+
+***
+
+### tag? {#tag}
+
+> `optional` **tag?**: `ObjectOrArray`\<`string` \| `IJsonLdNodeObject`\>
+
+Tag.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-tag
+
+#### Inherited from
+
+[`IActivityStreamsObject`](IActivityStreamsObject.md).[`tag`](IActivityStreamsObject.md#tag)
+
+***
+
+### inReplyTo? {#inreplyto}
+
+> `optional` **inReplyTo?**: `ObjectOrArray`\<`string` \| `IJsonLdNodeObject`\>
+
+In reply to.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-inreplyto
+
+#### Inherited from
+
+[`IActivityStreamsObject`](IActivityStreamsObject.md).[`inReplyTo`](IActivityStreamsObject.md#inreplyto)
+
+***
+
+### replies? {#replies}
+
+> `optional` **replies?**: `IJsonLdNodeObject`
+
+Replies collection.
+
+Typically an embedded `Collection` of Objects that are replies to this object.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-replies
+
+#### Inherited from
+
+[`IActivityStreamsObject`](IActivityStreamsObject.md).[`replies`](IActivityStreamsObject.md#replies)
+
+***
+
+### preview? {#preview}
+
+> `optional` **preview?**: `ObjectOrArray`\<`string` \| `IJsonLdNodeObject`\>
+
+Preview.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-preview
+
+#### Inherited from
+
+[`IActivityStreamsObject`](IActivityStreamsObject.md).[`preview`](IActivityStreamsObject.md#preview)
+
+***
+
+### to? {#to}
+
+> `optional` **to?**: `ObjectOrArray`\<`string` \| `IJsonLdNodeObject`\>
+
+To.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-to
+
+#### Inherited from
+
+[`IActivityStreamsObject`](IActivityStreamsObject.md).[`to`](IActivityStreamsObject.md#to)
+
+***
+
+### bto? {#bto}
+
+> `optional` **bto?**: `ObjectOrArray`\<`string` \| `IJsonLdNodeObject`\>
+
+BTo.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-bto
+
+#### Inherited from
+
+[`IActivityStreamsObject`](IActivityStreamsObject.md).[`bto`](IActivityStreamsObject.md#bto)
+
+***
+
+### cc? {#cc}
+
+> `optional` **cc?**: `ObjectOrArray`\<`string` \| `IJsonLdNodeObject`\>
+
+CC.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-cc
+
+#### Inherited from
+
+[`IActivityStreamsObject`](IActivityStreamsObject.md).[`cc`](IActivityStreamsObject.md#cc)
+
+***
+
+### bcc? {#bcc}
+
+> `optional` **bcc?**: `ObjectOrArray`\<`string` \| `IJsonLdNodeObject`\>
+
+BCC.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-bcc
+
+#### Inherited from
+
+[`IActivityStreamsObject`](IActivityStreamsObject.md).[`bcc`](IActivityStreamsObject.md#bcc)
+
+***
+
+### mediaType? {#mediatype}
+
+> `optional` **mediaType?**: `string`
+
+MIME media type of the referenced resource.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-mediatype
+
+#### Inherited from
+
+[`IActivityStreamsObject`](IActivityStreamsObject.md).[`mediaType`](IActivityStreamsObject.md#mediatype)