Release 1.1.0 (#6)

* Make types required & update docs & refactor (#3)

* Add types & docs for actors

* Add type field to documents

* Move APArticle to documents

* Type for APArticle

* Move APNote

* Set type to APCollection(Page)

* Refactor APOrderedCollection(Page)

* Missed actor docs

* Add types (simple activities)

* Added docs to Activity

* Rename ./common to ./objects

* Object types

* Fix APQuestion

* Add APRoot and remove context field from object (#5)

* docs & chore 1.1.0

Author: siranweb

README.md

@@ -1,5 +1,5 @@
 # ActivityPub Types
-Extracted types and refactor from [activitypub-models](https://github.com/SiranWeb/activitypub-models) repo.
+TypeScript typings for ActivityPub
 
 ## Installation
 ```bash
@@ -8,20 +8,72 @@ npm i activitypub-types
 yarn add activitypub-types
 ```
 
-## Available types
+## How to use
 Implemented and documented every structure from [specification](https://www.w3.org/TR/activitystreams-vocabulary).
-You can use interfaces and extend them by yourself, or you can use specified fields types:
+You can use interfaces and extend them by yourself, or you can use specified fields types.
+
+To specify object use correct type:
+```ts
+import { APAdd } from 'activitypub-types';
+const addActivity: APAdd = {
+    type: 'Add',
+    actor: 'https://actor.example.org',
+    // ...
+}
+```
+Fields in types are pretty flexible, so you can pass different variations:
+```ts
+import { APAdd, APActor } from 'activitypub-types';
+
+const actor1 = 'https://actor.example.org';
+
+const actor2: APActor = {
+    type: 'Person',
+    id: 'https://actor2.example.org',
+    summary: 'Another actor',
+    inbox: 'https://actor2.example.org/inbox',
+    outbox: 'https://actor2.example.org/outbox',
+};
+
+const addActivity: APAdd = {
+    type: 'Add',
+    actor: [actor1, actor2],
+    // ...
+};
+```
+
+To provide `@context` field use `APRoot`:
 ```typescript
-// All models interfaces starts with AP
-import { APObject, APNote, ContextField, ContentMapField } from 'activitypub-types';
+import { APAdd, APRoot } from 'activitypub-types';
+
+const addActivity: APRoot<APAdd> = {
+    '@context': 'https://www.w3.org/ns/activitystreams',
+    type: 'Add',
+    // ...
+}
+```
+
+If you need field types themselves, you can import as well:
+```typescript
+import { TypeField, NameField } from 'activitypub-types';
+
+interface APExample {
+    type: TypeField;
+    name?: NameField;
+    // ...
+}
 ```
 
 ## Changelog
-### v1.0.3
-- Use `orderedItems` instead of `items` in `OrderedCollection` ([#1](https://github.com/siranweb/activitypub-types/pull/1), thanks [@RangerMauve](https://github.com/RangerMauve))
+### v1.1.0
+- Update activities and documents types ([#3](https://github.com/siranweb/activitypub-types/pull/3), by [@Saiv46](https://github.com/Saiv46))
+- Add `APRoot` type and removed `@context` from `APObject` ([#5](https://github.com/siranweb/activitypub-types/pull/5))
+- Improve AP documentation ([#3](https://github.com/siranweb/activitypub-types/pull/3), by [@Saiv46](https://github.com/Saiv46))
+- Update README docs
+- Refactor ([#3](https://github.com/siranweb/activitypub-types/pull/3), by [@Saiv46](https://github.com/Saiv46))
 
-## Contact
-You can contact me via [matrix](https://matrix.to/#/@siranweb:matrix.org) or [telegram](https://t.me/siranweb)
+### v1.0.3
+- Use `orderedItems` instead of `items` in `OrderedCollection` ([#1](https://github.com/siranweb/activitypub-types/pull/1), by [@RangerMauve](https://github.com/RangerMauve))
 
 ## License
-[MIT](LICENSE)
+[MIT](LICENSE)

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "activitypub-types",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "description": "ActivityPub Typescript types",
   "main": "./dist/index.js",
   "scripts": {
@@ -23,8 +23,6 @@
   ],
   "files": [
     "dist",
-    "LICENSE",
-    "README.md",
     "package.json",
     "package-lock.json"
   ],

package.json

@@ -1,2 +1,3 @@
 export * from './fields';
-export * from './model-interfaces';
+export * from './model-interfaces';
+export * from './utils';

src/index.ts

@@ -1,3 +1,12 @@
 import { APActivity } from './activity.interface';
 
-export type APAccept = APActivity
+/**
+ * Indicates that the `actor` accepts the `object`.
+ * The `target` property can be used in certain circumstances
+ * to indicate the context into which the `object` has been accepted.
+ * 
+ * {@link https://www.w3.org/TR/activitystreams-vocabulary/#dfn-accept Docs}
+ */
+export interface APAccept extends APActivity {
+	type: 'Accept';
+}

src/model-interfaces/activities/accept.interface.ts

@@ -1,4 +1,4 @@
-import { APObject } from '../common/object.interface';
+import { APObject } from '../objects/object.interface';
 import {
     ActorField,
     InstrumentField,
@@ -8,6 +8,17 @@ import {
     TargetField
 } from '../../fields';
 
+/**
+ * An `Activity` is a subtype of [Object](../objects/object.interface.ts)
+ * that describes some form of action that may happen,
+ * is currently happening, or has already happened.
+ * The `Activity` type itself serves as an abstract base
+ * type for all types of activities.
+ * It is important to note that the `Activity` type itself does not
+ * carry any specific semantics about the kind of action being taken.
+ * 
+ * {@link https://www.w3.org/TR/activitystreams-vocabulary/#dfn-activity Docs}
+ */
 export interface APActivity extends APObject {
 
     /**

src/model-interfaces/activities/activity.interface.ts

@@ -1,3 +1,13 @@
 import { APActivity } from './activity.interface';
 
-export type APAdd = APActivity
+/**
+ * Indicates that the `actor` has added the `object` to the `target`.
+ * If the `target` property is not explicitly specified,
+ * the target would need to be determined implicitly by context.
+ * The origin can be used to identify the `context` from which the `object` originated.
+ * 
+ * {@link https://www.w3.org/TR/activitystreams-vocabulary/#dfn-add Docs}
+ */
+export interface APAdd extends APActivity {
+	type: 'Add';
+}

src/model-interfaces/activities/add.interface.ts

@@ -1,3 +1,11 @@
 import { APActivity } from './activity.interface';
 
-export type APAnnounce = APActivity
+/**
+ * Indicates that the `actor` is calling the `target`'s attention the `object`.
+ * The `origin` typically has no defined meaning.  
+ * 
+ * {@link https://www.w3.org/TR/activitystreams-vocabulary/#dfn-announce Docs}
+ */
+export interface APAnnounce extends APActivity {
+	type: 'Announce';
+}

src/model-interfaces/activities/announce.interface.ts

@@ -1,3 +1,13 @@
 import { APIntransitiveActivity } from './intransitive-activity.interface';
 
-export type APArrive = APIntransitiveActivity
+/**
+ * An [IntransitiveActivity](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-intransitiveactivity)
+ * that indicates that the actor has arrived at the `location`.
+ * The `origin` can be used to identify the `context` from which the actor originated.
+ * The `target` typically has no defined meaning.
+ * 
+ * {@link https://www.w3.org/TR/activitystreams-vocabulary/#dfn-arrive Docs}
+ */
+export interface APArrive extends APIntransitiveActivity {
+	type: 'Arrive';
+}

src/model-interfaces/activities/arrive.interface.ts

@@ -1,3 +1,14 @@
 import { APIgnore } from './ignore.interface';
 
-export type APBlock = APIgnore
+/**
+ * Indicates that the `actor` is blocking the `object`.
+ * Blocking is a stronger form of [Ignore](./ignore.interface.ts).
+ * The typical use is to support social systems that allow
+ * one user to block activities or content of other users.
+ * The `target` and `origin` typically have no defined meaning.
+ * 
+ * {@link https://www.w3.org/TR/activitystreams-vocabulary/#dfn-block Docs}
+ */
+export interface APBlock extends Omit<APIgnore, 'type'> {
+	type: 'Block';
+}

src/model-interfaces/activities/block.interface.ts

@@ -1,3 +1,10 @@
 import { APActivity } from './activity.interface';
 
-export type APCreate = APActivity
+/**
+ * Indicates that the `actor` has created the `object`.
+ * 
+ * {@link https://www.w3.org/TR/activitystreams-vocabulary/#dfn-create Docs}
+ */
+export interface APCreate extends APActivity {
+	type: 'Create';
+}

src/model-interfaces/activities/create.interface.ts

@@ -1,3 +1,12 @@
 import { APActivity } from './activity.interface';
 
-export type APDelete = APActivity
+/**
+ * Indicates that the `actor` has deleted the object.
+ * If specified, the `origin` indicates the context
+ * from which the object was deleted.
+ * 
+ * {@link https://www.w3.org/TR/activitystreams-vocabulary/#dfn-delete Docs}
+ */
+export interface APDelete extends APActivity {
+	type: 'Delete';
+}

src/model-interfaces/activities/delete.interface.ts

@@ -1,3 +1,10 @@
 import { APActivity } from './activity.interface';
 
-export type APDislike = APActivity
+/**
+ * Indicates that the `actor` dislikes the `object`.
+ * 
+ * {@link https://www.w3.org/TR/activitystreams-vocabulary/#dfn-dislike Docs}
+ */
+export interface APDislike extends APActivity {
+	type: 'Dislike';
+}

src/model-interfaces/activities/dislike.interface.ts

@@ -1,3 +1,12 @@
 import { APActivity } from './activity.interface';
 
-export type APFlag = APActivity
+/**
+ * Indicates that the `actor` is "flagging" the `object`.
+ * Flagging is defined in the sense common to many social platforms
+ * as reporting content as being inappropriate for any number of reasons.
+ * 
+ * {@link https://www.w3.org/TR/activitystreams-vocabulary/#dfn-flag Docs}
+ */
+export interface APFlag extends APActivity {
+	type: 'Flag';
+}

src/model-interfaces/activities/flag.interface.ts

@@ -1,3 +1,14 @@
 import { APActivity } from './activity.interface';
 
-export type APFollow = APActivity
+/**
+ * Indicates that the `actor` is "following" the `object`.
+ * Following is defined in the sense typically used within
+ * Social systems in which the actor is interested in any
+ * activity performed by or on the object.
+ * The `target` and `origin` typically have no defined meaning.
+ * 
+ * {@link https://www.w3.org/TR/activitystreams-vocabulary/#dfn-follow Docs}
+ */
+export interface APFollow extends APActivity {
+	type: 'Follow';
+}

src/model-interfaces/activities/follow.interface.ts

@@ -1,3 +1,11 @@
 import { APActivity } from './activity.interface';
 
-export type APIgnore = APActivity
+/**
+ * Indicates that the `actor` is ignoring the `object`.
+ * The `target` and `origin` typically have no defined meaning.  
+ * 
+ * {@link https://www.w3.org/TR/activitystreams-vocabulary/#dfn-ignore Docs}
+ */
+export interface APIgnore extends APActivity {
+	type: 'Ignore';
+}

src/model-interfaces/activities/ignore.interface.ts

@@ -1,3 +1,9 @@
 import { APActivity } from './activity.interface';
 
-export type APIntransitiveActivity = Omit<APActivity, 'object'>
+/**
+ * Instances of `IntransitiveActivity` are a subtype of `Activity` representing intransitive actions.
+ * The `object` property is therefore inappropriate for these activities.
+ * 
+ * {@link https://www.w3.org/TR/activitystreams-vocabulary/#dfn-intransitiveactivity Docs}
+ */
+export type APIntransitiveActivity = Omit<APActivity, 'object'>

src/model-interfaces/activities/intransitive-activity.interface.ts

@@ -1,3 +1,12 @@
 import { APOffer } from './offer.interface';
 
-export type APInvite = APOffer
+/**
+ * A specialization of [Offer](./offer.interface.ts)
+ * in which the `actor` is extending an invitation
+ * for the `object` to the `target`. 
+ * 
+ * {@link https://www.w3.org/TR/activitystreams-vocabulary/#dfn-invite Docs}
+ */
+export interface APInvite extends Omit<APOffer, 'type'> {
+	type: 'Invite';
+}

src/model-interfaces/activities/invite.interface.ts

@@ -1,3 +1,11 @@
 import { APActivity } from './activity.interface';
 
-export type APJoin = APActivity
+/**
+ * Indicates that the `actor` has joined the `object`.
+ * The `target` and `origin` typically have no defined meaning.
+ * 
+ * {@link https://www.w3.org/TR/activitystreams-vocabulary/#dfn-join Docs}
+ */
+export interface APJoin extends APActivity {
+	type: 'Join';
+}

src/model-interfaces/activities/join.interface.ts

@@ -1,3 +1,11 @@
 import { APActivity } from './activity.interface';
 
-export type APLeave = APActivity
+/**
+ * Indicates that the `actor` has left the `object`.
+ * The `target` and `origin` typically have no meaning.
+ * 
+ * {@link https://www.w3.org/TR/activitystreams-vocabulary/#dfn-leave Docs}
+ */
+export interface APLeave extends APActivity {
+	type: 'Leave';
+}

src/model-interfaces/activities/leave.interface.ts

@@ -1,3 +1,11 @@
 import { APActivity } from './activity.interface';
 
-export type APLike = APActivity
+/**
+ * Indicates that the `actor` likes, recommends or endorses the `object`.
+ * The `target` and `origin` typically have no defined meaning.
+ * 
+ * {@link https://www.w3.org/TR/activitystreams-vocabulary/#dfn-like Docs}
+ */
+export interface APLike extends APActivity {
+	type: 'Like';
+}

src/model-interfaces/activities/like.interface.ts

@@ -1,3 +1,10 @@
 import { APActivity } from './activity.interface';
 
-export type APListen = APActivity
+/**
+ * Indicates that the `actor` has listened to the `object`.
+ * 
+ * {@link https://www.w3.org/TR/activitystreams-vocabulary/#dfn-listen Docs}
+ */
+export interface APListen extends APActivity {
+	type: 'Listen';
+}

src/model-interfaces/activities/listen.interface.ts

@@ -1,3 +1,11 @@
 import { APActivity } from './activity.interface';
 
-export type APMove = APActivity
+/**
+ * Indicates that the `actor` has moved `object` from `origin` to `target`.
+ * If the `origin` or `target` are not specified, either can be determined by context.
+ * 
+ * {@link https://www.w3.org/TR/activitystreams-vocabulary/#dfn-move Docs}
+ */
+export interface APMove extends APActivity {
+	type: 'Move';
+}