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

package/dist/es/schemas/ActivityStreamsTypes.json

@@ -1,37 +1,124 @@
 {
     "$schema": "https://json-schema.org/draft/2020-12/schema",
     "$id": "https://schema.twindev.org/w3c-activity-streams/ActivityStreamsTypes",
-    "description": "The types concerning Activity Streams. Section 3.1 Activity Types: https://www.w3.org/TR/activitystreams-vocabulary/#activity-types   The types concerning Activity. Section 3.1 Activity Types: https://www.w3.org/TR/activitystreams-vocabulary/#activity-types",
-    "type": "string",
-    "enum": [
-        "Activity",
-        "Accept",
-        "Add",
-        "Announce",
-        "Arrive",
-        "Block",
-        "Create",
-        "Delete",
-        "Dislike",
-        "Flag",
-        "Follow",
-        "Ignore",
-        "Invite",
-        "Join",
-        "Leave",
-        "Like",
-        "Listen",
-        "Move",
-        "Offer",
-        "Question",
-        "Reject",
-        "Read",
-        "Remove",
-        "TentativeReject",
-        "TentativeAccept",
-        "Travel",
-        "Undo",
-        "Update",
-        "View"
+    "title": "ActivityStreamsTypes",
+    "description": "The types concerning Activity.\nSection 3.1 Activity Types: https://www.w3.org/TR/activitystreams-vocabulary/#activity-types",
+    "anyOf": [
+        {
+            "const": "Activity",
+            "description": "Activity.\n\nGeneric base type for activities (actions) in Activity Streams."
+        },
+        {
+            "const": "Accept",
+            "description": "Accept.\n\nIndicates that the actor accepts the object."
+        },
+        {
+            "const": "Add",
+            "description": "Add.\n\nIndicates that the actor added the object to the target."
+        },
+        {
+            "const": "Announce",
+            "description": "Announce.\n\nIndicates that the actor is calling attention to the object."
+        },
+        {
+            "const": "Arrive",
+            "description": "Arrive.\n\nIntransitive activity indicating that the actor arrived at a location."
+        },
+        {
+            "const": "Block",
+            "description": "Block.\n\nIndicates that the actor is blocking the object (a stronger form of Ignore)."
+        },
+        {
+            "const": "Create",
+            "description": "Create.\n\nIndicates that the actor has created the object."
+        },
+        {
+            "const": "Delete",
+            "description": "Delete.\n\nIndicates that the actor has deleted the object."
+        },
+        {
+            "const": "Dislike",
+            "description": "Dislike.\n\nIndicates that the actor dislikes the object."
+        },
+        {
+            "const": "Flag",
+            "description": "Flag.\n\nIndicates that the actor is flagging the object (e.g., reporting it)."
+        },
+        {
+            "const": "Follow",
+            "description": "Follow.\n\nIndicates that the actor is following the object."
+        },
+        {
+            "const": "Ignore",
+            "description": "Ignore.\n\nIndicates that the actor is ignoring the object."
+        },
+        {
+            "const": "Invite",
+            "description": "Invite.\n\nSpecialization of Offer in which the actor is extending an invitation."
+        },
+        {
+            "const": "Join",
+            "description": "Join.\n\nIndicates that the actor has joined the object."
+        },
+        {
+            "const": "Leave",
+            "description": "Leave.\n\nIndicates that the actor has left the object."
+        },
+        {
+            "const": "Like",
+            "description": "Like.\n\nIndicates that the actor likes, recommends, or endorses the object."
+        },
+        {
+            "const": "Listen",
+            "description": "Listen.\n\nIndicates that the actor has listened to the object."
+        },
+        {
+            "const": "Move",
+            "description": "Move.\n\nIndicates that the actor has moved the object from `origin` to `target`."
+        },
+        {
+            "const": "Offer",
+            "description": "Offer.\n\nIndicates that the actor is offering the object (optionally to a target)."
+        },
+        {
+            "const": "Question",
+            "description": "Question.\n\nIntransitive activity representing a question; can express options via `oneOf`/`anyOf`."
+        },
+        {
+            "const": "Reject",
+            "description": "Reject.\n\nIndicates that the actor is rejecting the object."
+        },
+        {
+            "const": "Read",
+            "description": "Read.\n\nIndicates that the actor has read the object."
+        },
+        {
+            "const": "Remove",
+            "description": "Remove.\n\nIndicates that the actor is removing the object (optionally from an origin context)."
+        },
+        {
+            "const": "TentativeReject",
+            "description": "TentativeReject.\n\nSpecialization of Reject indicating that the rejection is tentative."
+        },
+        {
+            "const": "TentativeAccept",
+            "description": "TentativeAccept.\n\nSpecialization of Accept indicating that the acceptance is tentative."
+        },
+        {
+            "const": "Travel",
+            "description": "Travel.\n\nIntransitive activity indicating that the actor is travelling to `target` from `origin`."
+        },
+        {
+            "const": "Undo",
+            "description": "Undo.\n\nIndicates that the actor is undoing a previous activity."
+        },
+        {
+            "const": "Update",
+            "description": "Update.\n\nIndicates that the actor has updated the object."
+        },
+        {
+            "const": "View",
+            "description": "View.\n\nIndicates that the actor has viewed the object."
+        }
     ]
 }

package/dist/es/schemas/ActivityStreamsVideo.json

@@ -0,0 +1,41 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/w3c-activity-streams/ActivityStreamsVideo",
+    "title": "ActivityStreamsVideo",
+    "description": "A W3C Activity Streams Video.\n\nA `Video` is a video document of any kind.",
+    "type": "object",
+    "properties": {
+        "type": {
+            "anyOf": [
+                {
+                    "const": "Video"
+                },
+                {
+                    "type": "string"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "anyOf": [
+                            {
+                                "const": "Video"
+                            },
+                            {
+                                "type": "string"
+                            }
+                        ]
+                    }
+                }
+            ],
+            "description": "Video type."
+        }
+    },
+    "required": [
+        "type"
+    ],
+    "allOf": [
+        {
+            "$ref": "https://schema.twindev.org/w3c-activity-streams/ActivityStreamsDocument"
+        }
+    ]
+}

package/dist/types/dataTypes/activityStreamsDataTypes.d.ts

@@ -1,7 +1,11 @@
 /**
- * Data Type registration for the Data Space Connector
+ * Handle all the data types for Activity Streams.
  */
 export declare abstract class ActivityStreamsDataTypes {
+    /**
+     * Register the JSON-LD Redirects.
+     */
+    static registerRedirects(): void;
     /**
      * Register all the data types.
      */

package/dist/types/index.d.ts

@@ -1,5 +1,38 @@
 export * from "./dataTypes/activityStreamsDataTypes.js";
 export * from "./models/IActivityStreamsActivity.js";
+export * from "./models/IActivityStreamsActor.js";
+export * from "./models/IActivityStreamsApplication.js";
+export * from "./models/IActivityStreamsArticle.js";
+export * from "./models/IActivityStreamsAudio.js";
+export * from "./models/IActivityStreamsCollection.js";
+export * from "./models/IActivityStreamsCollectionPage.js";
+export * from "./models/IActivityStreamsDocument.js";
+export * from "./models/IActivityStreamsEvent.js";
+export * from "./models/IActivityStreamsGroup.js";
+export * from "./models/IActivityStreamsImage.js";
+export * from "./models/IActivityStreamsIntransitiveActivity.js";
+export * from "./models/IActivityStreamsLink.js";
+export * from "./models/IActivityStreamsMention.js";
+export * from "./models/IActivityStreamsNote.js";
+export * from "./models/IActivityStreamsObject.js";
+export * from "./models/IActivityStreamsOrderedCollection.js";
+export * from "./models/IActivityStreamsOrderedCollectionPage.js";
+export * from "./models/IActivityStreamsOrganization.js";
+export * from "./models/IActivityStreamsPage.js";
+export * from "./models/IActivityStreamsPerson.js";
+export * from "./models/IActivityStreamsPlace.js";
+export * from "./models/IActivityStreamsProfile.js";
+export * from "./models/IActivityStreamsQuestion.js";
+export * from "./models/IActivityStreamsQuestionAnyOfChoice.js";
+export * from "./models/IActivityStreamsQuestionBase.js";
+export * from "./models/IActivityStreamsQuestionNeitherChoice.js";
+export * from "./models/IActivityStreamsQuestionOneOfChoice.js";
+export * from "./models/IActivityStreamsRelationship.js";
+export * from "./models/IActivityStreamsService.js";
+export * from "./models/IActivityStreamsTombstone.js";
+export * from "./models/IActivityStreamsVideo.js";
 export * from "./models/activityStreamsContexts.js";
 export * from "./models/activityStreamsContextType.js";
+export * from "./models/activityStreamsLinkTypes.js";
+export * from "./models/activityStreamsObjectTypes.js";
 export * from "./models/activityStreamsTypes.js";

package/dist/types/models/IActivityStreamsActivity.d.ts

@@ -1,15 +1,18 @@
 import type { ObjectOrArray } from "@twin.org/core";
-import type { IJsonLdLanguageMap, IJsonLdNodeObject, IJsonLdObject } from "@twin.org/data-json-ld";
+import type { IJsonLdLanguageMap, IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import type { ActivityStreamsContextType } from "./activityStreamsContextType.js";
 import type { ActivityStreamsTypes } from "./activityStreamsTypes.js";
+import type { IActivityStreamsObject } from "./IActivityStreamsObject.js";
 /**
- * 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 https://www.w3.org/TR/activitystreams-core/#activities
  */
-export interface IActivityStreamsActivity extends IJsonLdNodeObject {
+export interface IActivityStreamsActivity extends IActivityStreamsObject {
     /**
      * The LD Context.
-     *
      */
     "@context": ActivityStreamsContextType;
     /**
@@ -18,23 +21,24 @@ export interface IActivityStreamsActivity extends IJsonLdNodeObject {
     type: ObjectOrArray<ActivityStreamsTypes | string>;
     /**
      * The generator of the Activity.
+     * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-generator
      */
-    generator?: IJsonLdObject["@id"] | IJsonLdNodeObject;
+    generator?: ObjectOrArray<string | IJsonLdNodeObject>;
     /**
      * The Actor behind the Activity.
      * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-actor
      */
-    actor: IJsonLdObject["@id"] | IJsonLdNodeObject;
+    actor?: ObjectOrArray<string | IJsonLdNodeObject>;
     /**
      * The object affected by the Activity.
      * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-object
      */
-    object: IJsonLdNodeObject;
+    object?: ObjectOrArray<string | IJsonLdNodeObject>;
     /**
      * The target of the Activity.
      * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-target
      */
-    target?: IJsonLdNodeObject;
+    target?: ObjectOrArray<string | IJsonLdNodeObject>;
     /**
      * Summary of the Activity.
      * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-summary
@@ -44,15 +48,15 @@ export interface IActivityStreamsActivity extends IJsonLdNodeObject {
      * Result of the Activity.
      * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-result
      */
-    result?: IJsonLdNodeObject;
+    result?: ObjectOrArray<string | IJsonLdNodeObject>;
     /**
      * Activity's origin.
      * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-origin
      */
-    origin?: IJsonLdObject["@id"] | IJsonLdNodeObject;
+    origin?: ObjectOrArray<string | IJsonLdNodeObject>;
     /**
-     * The date and time at which the object was updated.
-     * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-updated
+     * Instrument used in the Activity.
+     * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-instrument
      */
-    updated: string;
+    instrument?: ObjectOrArray<string | IJsonLdNodeObject>;
 }

package/dist/types/models/IActivityStreamsActor.d.ts

@@ -0,0 +1,16 @@
+import type { ObjectOrArray } from "@twin.org/core";
+import type { ActivityStreamsObjectTypes } from "./activityStreamsObjectTypes.js";
+import type { IActivityStreamsObject } from "./IActivityStreamsObject.js";
+/**
+ * A W3C Activity Streams Actor.
+ *
+ * An `Actor` is a specialised `Object` that represents the entity performing
+ * an `Activity` (for example a `Person`, `Group`, `Organization`, `Application`, or `Service`).
+ * @see https://www.w3.org/TR/activitystreams-core/#actors
+ */
+export interface IActivityStreamsActor extends IActivityStreamsObject {
+    /**
+     * Actor type.
+     */
+    type?: ObjectOrArray<typeof ActivityStreamsObjectTypes.Actor | typeof ActivityStreamsObjectTypes.Application | typeof ActivityStreamsObjectTypes.Group | typeof ActivityStreamsObjectTypes.Organization | typeof ActivityStreamsObjectTypes.Person | typeof ActivityStreamsObjectTypes.Service | string>;
+}

package/dist/types/models/IActivityStreamsApplication.d.ts

@@ -0,0 +1,15 @@
+import type { ObjectOrArray } from "@twin.org/core";
+import type { ActivityStreamsObjectTypes } from "./activityStreamsObjectTypes.js";
+import type { IActivityStreamsActor } from "./IActivityStreamsActor.js";
+/**
+ * A W3C Activity Streams Application.
+ *
+ * An `Application` represents a software application.
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-application
+ */
+export interface IActivityStreamsApplication extends IActivityStreamsActor {
+    /**
+     * Application type.
+     */
+    type: ObjectOrArray<typeof ActivityStreamsObjectTypes.Application | string>;
+}

package/dist/types/models/IActivityStreamsArticle.d.ts

@@ -0,0 +1,15 @@
+import type { ObjectOrArray } from "@twin.org/core";
+import type { ActivityStreamsObjectTypes } from "./activityStreamsObjectTypes.js";
+import type { IActivityStreamsDocument } from "./IActivityStreamsDocument.js";
+/**
+ * A W3C Activity Streams Article.
+ *
+ * An `Article` is a written work.
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-article
+ */
+export interface IActivityStreamsArticle extends IActivityStreamsDocument {
+    /**
+     * Article type.
+     */
+    type: ObjectOrArray<typeof ActivityStreamsObjectTypes.Article | string>;
+}

package/dist/types/models/IActivityStreamsAudio.d.ts

@@ -0,0 +1,15 @@
+import type { ObjectOrArray } from "@twin.org/core";
+import type { ActivityStreamsObjectTypes } from "./activityStreamsObjectTypes.js";
+import type { IActivityStreamsDocument } from "./IActivityStreamsDocument.js";
+/**
+ * A W3C Activity Streams Audio.
+ *
+ * An `Audio` is an audio document of any kind.
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-audio
+ */
+export interface IActivityStreamsAudio extends IActivityStreamsDocument {
+    /**
+     * Audio type.
+     */
+    type: ObjectOrArray<typeof ActivityStreamsObjectTypes.Audio | string>;
+}

package/dist/types/models/IActivityStreamsCollection.d.ts

@@ -0,0 +1,42 @@
+import type { ObjectOrArray } from "@twin.org/core";
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { ActivityStreamsObjectTypes } from "./activityStreamsObjectTypes.js";
+import type { IActivityStreamsObject } from "./IActivityStreamsObject.js";
+/**
+ * A W3C Activity Streams Collection.
+ *
+ * A `Collection` represents an unordered set of items. Implementations can page
+ * large collections using `first`/`last`/`current` and `CollectionPage`.
+ * @see https://www.w3.org/TR/activitystreams-core/#collections
+ */
+export interface IActivityStreamsCollection extends IActivityStreamsObject {
+    /**
+     * Collection type.
+     */
+    type: ObjectOrArray<typeof ActivityStreamsObjectTypes.Collection | string>;
+    /**
+     * Total number of items.
+     * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-totalitems
+     */
+    totalItems?: number;
+    /**
+     * The items of the collection.
+     * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-items
+     */
+    items?: ObjectOrArray<string | IJsonLdNodeObject>;
+    /**
+     * First page.
+     * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-first
+     */
+    first?: string | IJsonLdNodeObject;
+    /**
+     * Last page.
+     * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-last
+     */
+    last?: string | IJsonLdNodeObject;
+    /**
+     * Current page.
+     * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-current
+     */
+    current?: string | IJsonLdNodeObject;
+}

package/dist/types/models/IActivityStreamsCollectionPage.d.ts

@@ -0,0 +1,32 @@
+import type { ObjectOrArray } from "@twin.org/core";
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { ActivityStreamsObjectTypes } from "./activityStreamsObjectTypes.js";
+import type { IActivityStreamsCollection } from "./IActivityStreamsCollection.js";
+/**
+ * A W3C Activity Streams CollectionPage.
+ *
+ * A `CollectionPage` represents a single page of items from a larger `Collection`.
+ * Use `partOf` to reference the parent collection, and `next`/`prev` for paging links.
+ * @see https://www.w3.org/TR/activitystreams-core/#collections
+ */
+export interface IActivityStreamsCollectionPage extends IActivityStreamsCollection {
+    /**
+     * CollectionPage type.
+     */
+    type: ObjectOrArray<typeof ActivityStreamsObjectTypes.CollectionPage | string>;
+    /**
+     * Parent collection.
+     * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-partof
+     */
+    partOf?: string | IJsonLdNodeObject;
+    /**
+     * Next page.
+     * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-next
+     */
+    next?: string | IJsonLdNodeObject;
+    /**
+     * Previous page.
+     * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-prev
+     */
+    prev?: string | IJsonLdNodeObject;
+}

package/dist/types/models/IActivityStreamsDocument.d.ts

@@ -0,0 +1,15 @@
+import type { ObjectOrArray } from "@twin.org/core";
+import type { ActivityStreamsObjectTypes } from "./activityStreamsObjectTypes.js";
+import type { IActivityStreamsObject } from "./IActivityStreamsObject.js";
+/**
+ * A W3C Activity Streams Document.
+ *
+ * A `Document` is a document of any kind.
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-document
+ */
+export interface IActivityStreamsDocument extends IActivityStreamsObject {
+    /**
+     * Document type.
+     */
+    type: ObjectOrArray<typeof ActivityStreamsObjectTypes.Document | string>;
+}

package/dist/types/models/IActivityStreamsEvent.d.ts

@@ -0,0 +1,15 @@
+import type { ObjectOrArray } from "@twin.org/core";
+import type { ActivityStreamsObjectTypes } from "./activityStreamsObjectTypes.js";
+import type { IActivityStreamsObject } from "./IActivityStreamsObject.js";
+/**
+ * A W3C Activity Streams Event.
+ *
+ * An `Event` is an object that represents something that occurs at a certain time and location.
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-event
+ */
+export interface IActivityStreamsEvent extends IActivityStreamsObject {
+    /**
+     * Event type.
+     */
+    type: ObjectOrArray<typeof ActivityStreamsObjectTypes.Event | string>;
+}

package/dist/types/models/IActivityStreamsGroup.d.ts

@@ -0,0 +1,15 @@
+import type { ObjectOrArray } from "@twin.org/core";
+import type { ActivityStreamsObjectTypes } from "./activityStreamsObjectTypes.js";
+import type { IActivityStreamsActor } from "./IActivityStreamsActor.js";
+/**
+ * A W3C Activity Streams Group.
+ *
+ * A `Group` represents a group of individuals.
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-group
+ */
+export interface IActivityStreamsGroup extends IActivityStreamsActor {
+    /**
+     * Group type.
+     */
+    type: ObjectOrArray<typeof ActivityStreamsObjectTypes.Group | string>;
+}

package/dist/types/models/IActivityStreamsImage.d.ts

@@ -0,0 +1,15 @@
+import type { ObjectOrArray } from "@twin.org/core";
+import type { ActivityStreamsObjectTypes } from "./activityStreamsObjectTypes.js";
+import type { IActivityStreamsObject } from "./IActivityStreamsObject.js";
+/**
+ * A W3C Activity Streams Image.
+ *
+ * An `Image` is an image document of any kind.
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-image
+ */
+export interface IActivityStreamsImage extends IActivityStreamsObject {
+    /**
+     * Image type.
+     */
+    type: ObjectOrArray<typeof ActivityStreamsObjectTypes.Image | string>;
+}

package/dist/types/models/IActivityStreamsIntransitiveActivity.d.ts

@@ -0,0 +1,42 @@
+import type { ObjectOrArray } from "@twin.org/core";
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { ActivityStreamsObjectTypes } from "./activityStreamsObjectTypes.js";
+import type { ActivityStreamsTypes } from "./activityStreamsTypes.js";
+import type { IActivityStreamsObject } from "./IActivityStreamsObject.js";
+/**
+ * A W3C Activity Streams IntransitiveActivity.
+ *
+ * `IntransitiveActivity` objects do not have an `object` property.
+ * @see https://www.w3.org/TR/activitystreams-core/#intransitiveactivities
+ */
+export interface IActivityStreamsIntransitiveActivity extends IActivityStreamsObject {
+    /**
+     * Intransitive activity type.
+     */
+    type: ObjectOrArray<typeof ActivityStreamsObjectTypes.IntransitiveActivity | ActivityStreamsTypes | string>;
+    /**
+     * The Actor behind the Activity.
+     * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-actor
+     */
+    actor?: ObjectOrArray<string | IJsonLdNodeObject>;
+    /**
+     * The target of the Activity.
+     * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-target
+     */
+    target?: ObjectOrArray<string | IJsonLdNodeObject>;
+    /**
+     * Result of the Activity.
+     * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-result
+     */
+    result?: ObjectOrArray<string | IJsonLdNodeObject>;
+    /**
+     * Activity's origin.
+     * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-origin
+     */
+    origin?: ObjectOrArray<string | IJsonLdNodeObject>;
+    /**
+     * Instrument used in the Activity.
+     * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-instrument
+     */
+    instrument?: ObjectOrArray<string | IJsonLdNodeObject>;
+}

package/dist/types/models/IActivityStreamsLink.d.ts

@@ -0,0 +1,62 @@
+import type { ObjectOrArray } from "@twin.org/core";
+import type { IJsonLdLanguageMap, IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { ActivityStreamsContextType } from "./activityStreamsContextType.js";
+import type { ActivityStreamsLinkTypes } from "./activityStreamsLinkTypes.js";
+/**
+ * A W3C Activity Streams Link.
+ *
+ * A `Link` is used to reference a resource by URI (via `href`) and can include
+ * optional presentation metadata such as `name`, `mediaType`, `height`, and `width`.
+ * @see https://www.w3.org/TR/activitystreams-core/#link
+ */
+export interface IActivityStreamsLink {
+    /**
+     * The LD Context.
+     */
+    "@context": ActivityStreamsContextType;
+    /**
+     * Link type.
+     */
+    type: ObjectOrArray<ActivityStreamsLinkTypes | string>;
+    /**
+     * The target URI of the Link.
+     * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-href
+     * @json-schema format:uri
+     */
+    href: string;
+    /**
+     * A natural language name for the link.
+     * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-name
+     */
+    name?: string | IJsonLdLanguageMap;
+    /**
+     * A language hint for the target resource.
+     * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-hreflang
+     */
+    hreflang?: string;
+    /**
+     * MIME media type of the referenced resource.
+     * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-mediatype
+     */
+    mediaType?: string;
+    /**
+     * Link relation value(s).
+     * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-rel
+     */
+    rel?: ObjectOrArray<string>;
+    /**
+     * Desired rendered height.
+     * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-height
+     */
+    height?: number;
+    /**
+     * Desired rendered width.
+     * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-width
+     */
+    width?: number;
+    /**
+     * Preview of the link.
+     * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-preview
+     */
+    preview?: ObjectOrArray<string | IJsonLdNodeObject>;
+}

package/dist/types/models/IActivityStreamsMention.d.ts

@@ -0,0 +1,16 @@
+import type { ObjectOrArray } from "@twin.org/core";
+import type { ActivityStreamsLinkTypes } from "./activityStreamsLinkTypes.js";
+import type { IActivityStreamsLink } from "./IActivityStreamsLink.js";
+/**
+ * A W3C Activity Streams Mention.
+ *
+ * A `Mention` is a specialised `Link` typically used to identify users or
+ * objects being mentioned within content.
+ * @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-mention
+ */
+export interface IActivityStreamsMention extends IActivityStreamsLink {
+    /**
+     * Mention type.
+     */
+    type: ObjectOrArray<typeof ActivityStreamsLinkTypes.Mention | string>;
+}