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

package/docs/reference/interfaces/IActivityStreamsVideo.md

@@ -0,0 +1,525 @@
+# Interface: IActivityStreamsVideo
+
+A W3C Activity Streams Video.
+
+A `Video` is a video document of any kind.
+
+## See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-video
+
+## Extends
+
+- [`IActivityStreamsDocument`](IActivityStreamsDocument.md)
+
+## Properties
+
+### @context {#context}
+
+> **@context**: [`ActivityStreamsContextType`](../type-aliases/ActivityStreamsContextType.md)
+
+The LD Context.
+
+#### Inherited from
+
+[`IActivityStreamsDocument`](IActivityStreamsDocument.md).[`@context`](IActivityStreamsDocument.md#context)
+
+***
+
+### id? {#id}
+
+> `optional` **id?**: `string`
+
+Global identifier.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-id
+
+#### Inherited from
+
+[`IActivityStreamsDocument`](IActivityStreamsDocument.md).[`id`](IActivityStreamsDocument.md#id)
+
+***
+
+### name? {#name}
+
+> `optional` **name?**: `string` \| `IJsonLdLanguageMap`
+
+Natural language name.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-name
+
+#### Inherited from
+
+[`IActivityStreamsDocument`](IActivityStreamsDocument.md).[`name`](IActivityStreamsDocument.md#name)
+
+***
+
+### nameMap? {#namemap}
+
+> `optional` **nameMap?**: `IJsonLdLanguageMap`
+
+Natural language name map.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-core/#naturalLanguageValues
+
+#### Inherited from
+
+[`IActivityStreamsDocument`](IActivityStreamsDocument.md).[`nameMap`](IActivityStreamsDocument.md#namemap)
+
+***
+
+### summary? {#summary}
+
+> `optional` **summary?**: `string` \| `IJsonLdLanguageMap`
+
+Natural language summary.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-summary
+
+#### Inherited from
+
+[`IActivityStreamsDocument`](IActivityStreamsDocument.md).[`summary`](IActivityStreamsDocument.md#summary)
+
+***
+
+### summaryMap? {#summarymap}
+
+> `optional` **summaryMap?**: `IJsonLdLanguageMap`
+
+Natural language summary map.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-core/#naturalLanguageValues
+
+#### Inherited from
+
+[`IActivityStreamsDocument`](IActivityStreamsDocument.md).[`summaryMap`](IActivityStreamsDocument.md#summarymap)
+
+***
+
+### content? {#content}
+
+> `optional` **content?**: `string` \| `IJsonLdLanguageMap`
+
+Natural language content.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-content
+
+#### Inherited from
+
+[`IActivityStreamsDocument`](IActivityStreamsDocument.md).[`content`](IActivityStreamsDocument.md#content)
+
+***
+
+### contentMap? {#contentmap}
+
+> `optional` **contentMap?**: `IJsonLdLanguageMap`
+
+Natural language content map.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-core/#naturalLanguageValues
+
+#### Inherited from
+
+[`IActivityStreamsDocument`](IActivityStreamsDocument.md).[`contentMap`](IActivityStreamsDocument.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
+
+[`IActivityStreamsDocument`](IActivityStreamsDocument.md).[`url`](IActivityStreamsDocument.md#url)
+
+***
+
+### image? {#image}
+
+> `optional` **image?**: `ObjectOrArray`\<`string` \| `IJsonLdNodeObject`\>
+
+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
+
+[`IActivityStreamsDocument`](IActivityStreamsDocument.md).[`image`](IActivityStreamsDocument.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
+
+[`IActivityStreamsDocument`](IActivityStreamsDocument.md).[`icon`](IActivityStreamsDocument.md#icon)
+
+***
+
+### published? {#published}
+
+> `optional` **published?**: `string`
+
+Published date-time.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-published
+
+#### Inherited from
+
+[`IActivityStreamsDocument`](IActivityStreamsDocument.md).[`published`](IActivityStreamsDocument.md#published)
+
+***
+
+### updated? {#updated}
+
+> `optional` **updated?**: `string`
+
+Updated date-time.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-updated
+
+#### Inherited from
+
+[`IActivityStreamsDocument`](IActivityStreamsDocument.md).[`updated`](IActivityStreamsDocument.md#updated)
+
+***
+
+### startTime? {#starttime}
+
+> `optional` **startTime?**: `string`
+
+Start time.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-starttime
+
+#### Inherited from
+
+[`IActivityStreamsDocument`](IActivityStreamsDocument.md).[`startTime`](IActivityStreamsDocument.md#starttime)
+
+***
+
+### endTime? {#endtime}
+
+> `optional` **endTime?**: `string`
+
+End time.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-endtime
+
+#### Inherited from
+
+[`IActivityStreamsDocument`](IActivityStreamsDocument.md).[`endTime`](IActivityStreamsDocument.md#endtime)
+
+***
+
+### duration? {#duration}
+
+> `optional` **duration?**: `string`
+
+Duration.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-duration
+
+#### Inherited from
+
+[`IActivityStreamsDocument`](IActivityStreamsDocument.md).[`duration`](IActivityStreamsDocument.md#duration)
+
+***
+
+### generator? {#generator}
+
+> `optional` **generator?**: `ObjectOrArray`\<`string` \| `IJsonLdNodeObject`\>
+
+The generator of the object.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-generator
+
+#### Inherited from
+
+[`IActivityStreamsDocument`](IActivityStreamsDocument.md).[`generator`](IActivityStreamsDocument.md#generator)
+
+***
+
+### attachment? {#attachment}
+
+> `optional` **attachment?**: `ObjectOrArray`\<`string` \| `IJsonLdNodeObject`\>
+
+Attachments.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-attachment
+
+#### Inherited from
+
+[`IActivityStreamsDocument`](IActivityStreamsDocument.md).[`attachment`](IActivityStreamsDocument.md#attachment)
+
+***
+
+### attributedTo? {#attributedto}
+
+> `optional` **attributedTo?**: `ObjectOrArray`\<`string` \| `IJsonLdNodeObject`\>
+
+Objects attributed to.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-attributedto
+
+#### Inherited from
+
+[`IActivityStreamsDocument`](IActivityStreamsDocument.md).[`attributedTo`](IActivityStreamsDocument.md#attributedto)
+
+***
+
+### audience? {#audience}
+
+> `optional` **audience?**: `ObjectOrArray`\<`string` \| `IJsonLdNodeObject`\>
+
+Audience.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-audience
+
+#### Inherited from
+
+[`IActivityStreamsDocument`](IActivityStreamsDocument.md).[`audience`](IActivityStreamsDocument.md#audience)
+
+***
+
+### context? {#context-1}
+
+> `optional` **context?**: `ObjectOrArray`\<`string` \| `IJsonLdNodeObject`\>
+
+Context.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-context
+
+#### Inherited from
+
+[`IActivityStreamsDocument`](IActivityStreamsDocument.md).[`context`](IActivityStreamsDocument.md#context-1)
+
+***
+
+### location? {#location}
+
+> `optional` **location?**: `ObjectOrArray`\<`string` \| `IJsonLdNodeObject`\>
+
+Location.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-location
+
+#### Inherited from
+
+[`IActivityStreamsDocument`](IActivityStreamsDocument.md).[`location`](IActivityStreamsDocument.md#location)
+
+***
+
+### tag? {#tag}
+
+> `optional` **tag?**: `ObjectOrArray`\<`string` \| `IJsonLdNodeObject`\>
+
+Tag.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-tag
+
+#### Inherited from
+
+[`IActivityStreamsDocument`](IActivityStreamsDocument.md).[`tag`](IActivityStreamsDocument.md#tag)
+
+***
+
+### inReplyTo? {#inreplyto}
+
+> `optional` **inReplyTo?**: `ObjectOrArray`\<`string` \| `IJsonLdNodeObject`\>
+
+In reply to.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-inreplyto
+
+#### Inherited from
+
+[`IActivityStreamsDocument`](IActivityStreamsDocument.md).[`inReplyTo`](IActivityStreamsDocument.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
+
+[`IActivityStreamsDocument`](IActivityStreamsDocument.md).[`replies`](IActivityStreamsDocument.md#replies)
+
+***
+
+### preview? {#preview}
+
+> `optional` **preview?**: `ObjectOrArray`\<`string` \| `IJsonLdNodeObject`\>
+
+Preview.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-preview
+
+#### Inherited from
+
+[`IActivityStreamsDocument`](IActivityStreamsDocument.md).[`preview`](IActivityStreamsDocument.md#preview)
+
+***
+
+### to? {#to}
+
+> `optional` **to?**: `ObjectOrArray`\<`string` \| `IJsonLdNodeObject`\>
+
+To.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-to
+
+#### Inherited from
+
+[`IActivityStreamsDocument`](IActivityStreamsDocument.md).[`to`](IActivityStreamsDocument.md#to)
+
+***
+
+### bto? {#bto}
+
+> `optional` **bto?**: `ObjectOrArray`\<`string` \| `IJsonLdNodeObject`\>
+
+BTo.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-bto
+
+#### Inherited from
+
+[`IActivityStreamsDocument`](IActivityStreamsDocument.md).[`bto`](IActivityStreamsDocument.md#bto)
+
+***
+
+### cc? {#cc}
+
+> `optional` **cc?**: `ObjectOrArray`\<`string` \| `IJsonLdNodeObject`\>
+
+CC.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-cc
+
+#### Inherited from
+
+[`IActivityStreamsDocument`](IActivityStreamsDocument.md).[`cc`](IActivityStreamsDocument.md#cc)
+
+***
+
+### bcc? {#bcc}
+
+> `optional` **bcc?**: `ObjectOrArray`\<`string` \| `IJsonLdNodeObject`\>
+
+BCC.
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-bcc
+
+#### Inherited from
+
+[`IActivityStreamsDocument`](IActivityStreamsDocument.md).[`bcc`](IActivityStreamsDocument.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
+
+[`IActivityStreamsDocument`](IActivityStreamsDocument.md).[`mediaType`](IActivityStreamsDocument.md#mediatype)
+
+***
+
+### type {#type}
+
+> **type**: `ObjectOrArray`\<`string`\>
+
+Video type.
+
+#### Overrides
+
+[`IActivityStreamsDocument`](IActivityStreamsDocument.md).[`type`](IActivityStreamsDocument.md#type)

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

@@ -1,5 +1,5 @@
 # Type Alias: ActivityStreamsContextType
 
-> **ActivityStreamsContextType** = *typeof* [`ContextRoot`](../variables/ActivityStreamsContexts.md#contextroot) \| \[*typeof* [`ContextRoot`](../variables/ActivityStreamsContexts.md#contextroot)\] \| \[`...IJsonLdContextDefinitionElement[]`, *typeof* [`ContextRoot`](../variables/ActivityStreamsContexts.md#contextroot)\]
+> **ActivityStreamsContextType** = *typeof* [`Context`](../variables/ActivityStreamsContexts.md#context) \| `SingleOccurrenceArray`\<`IJsonLdContextDefinitionElement`, *typeof* [`Context`](../variables/ActivityStreamsContexts.md#context)\>
 
 The Activity Streams JSON-LD context type.

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

@@ -0,0 +1,5 @@
+# Type Alias: ActivityStreamsLinkTypes
+
+> **ActivityStreamsLinkTypes** = *typeof* [`ActivityStreamsLinkTypes`](../variables/ActivityStreamsLinkTypes.md)\[keyof *typeof* [`ActivityStreamsLinkTypes`](../variables/ActivityStreamsLinkTypes.md)\]
+
+The link types concerning Activity Streams.

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

@@ -0,0 +1,5 @@
+# Type Alias: ActivityStreamsObjectTypes
+
+> **ActivityStreamsObjectTypes** = *typeof* [`ActivityStreamsObjectTypes`](../variables/ActivityStreamsObjectTypes.md)\[keyof *typeof* [`ActivityStreamsObjectTypes`](../variables/ActivityStreamsObjectTypes.md)\]
+
+The object types concerning Activity Streams.

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

@@ -0,0 +1,13 @@
+# Type Alias: IActivityStreamsQuestion
+
+> **IActivityStreamsQuestion** = [`IActivityStreamsQuestionBase`](../interfaces/IActivityStreamsQuestionBase.md) & [`IActivityStreamsQuestionAnyOfChoice`](../interfaces/IActivityStreamsQuestionAnyOfChoice.md) \| [`IActivityStreamsQuestionOneOfChoice`](../interfaces/IActivityStreamsQuestionOneOfChoice.md) \| [`IActivityStreamsQuestionNeitherChoice`](../interfaces/IActivityStreamsQuestionNeitherChoice.md)
+
+A W3C Activity Streams Question.
+
+A `Question` represents a question being asked. Use `oneOf` for exclusive
+choices, `anyOf` for inclusive choices, and `closed` to indicate when the question
+is closed.
+
+## See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-question

package/docs/reference/variables/ActivityStreamsContexts.md

@@ -6,20 +6,28 @@ The LD Contexts concerning Activity Streams.
 
 ## Type Declaration
 
-### ContextRoot
+### Namespace {#namespace}
 
-> `readonly` **ContextRoot**: `"https://www.w3.org/ns/activitystreams"` = `"https://www.w3.org/ns/activitystreams"`
+> `readonly` **Namespace**: `"https://www.w3.org/ns/activitystreams#"` = `"https://www.w3.org/ns/activitystreams#"`
 
-The Activity Streams LD Context.
+The canonical RDF namespace URI.
 
-### ActivityStreamsNamespace
+### Context {#context}
 
-> `readonly` **ActivityStreamsNamespace**: `"https://www.w3.org/ns/activitystreams#"` = `"https://www.w3.org/ns/activitystreams#"`
+> `readonly` **Context**: `"https://www.w3.org/ns/activitystreams"` = `"https://www.w3.org/ns/activitystreams"`
 
-The Activity Streams namespace.
+The value to use in @context.
+Note: Context differs from Namespace (no trailing #) as per Activity Streams 2.0 specification.
+The Activity Streams JSON-LD context URL format does not include a trailing hash.
 
-### TwinContext
+### JsonLdContext {#jsonldcontext}
 
-> `readonly` **TwinContext**: `"https://schema.twindev.org/w3c-activity-streams"` = `"https://schema.twindev.org/w3c-activity-streams"`
+> `readonly` **JsonLdContext**: `"https://www.w3.org/ns/activitystreams.jsonld"` = `"https://www.w3.org/ns/activitystreams.jsonld"`
 
-The TWIN context for Activity Streams.
+The JSON-LD Context URL.
+
+### JsonSchemaNamespace {#jsonschemanamespace}
+
+> `readonly` **JsonSchemaNamespace**: `"https://schema.twindev.org/w3c-activity-streams/"` = `"https://schema.twindev.org/w3c-activity-streams/"`
+
+The namespace location of the hosted version of the JSON Schema.

package/docs/reference/variables/ActivityStreamsLinkTypes.md

@@ -0,0 +1,32 @@
+# Variable: ActivityStreamsLinkTypes
+
+> `const` **ActivityStreamsLinkTypes**: `object`
+
+The link types concerning Activity Streams.
+
+## Type Declaration
+
+### Link {#link}
+
+> `readonly` **Link**: `"Link"` = `"Link"`
+
+Link
+
+#### See
+
+https://www.w3.org/TR/activitystreams-core/#link
+
+### Mention {#mention}
+
+> `readonly` **Mention**: `"Mention"` = `"Mention"`
+
+Mention
+
+#### See
+
+https://www.w3.org/TR/activitystreams-vocabulary/#dfn-mention
+
+## See
+
+ - https://www.w3.org/TR/activitystreams-core/#link
+ - https://www.w3.org/TR/activitystreams-vocabulary/#link