@fedify/vocab 2.0.0-dev.0

package/src/source.yaml

@@ -0,0 +1,26 @@
+$schema: ../../vocab-tools/schema.yaml
+name: Source
+compactName: as:Source
+uri: "https://www.w3.org/ns/activitystreams#Source"
+entity: false
+description: Contents of {@link Object}'s `source`.
+defaultContext: "https://www.w3.org/ns/activitystreams"
+
+properties:
+- pluralName: contents
+  singularName: content
+  singularAccessor: true
+  compactName: content
+  uri: "https://www.w3.org/ns/activitystreams#content"
+  description: The source content.
+  range:
+  - "http://www.w3.org/2001/XMLSchema#string"
+  - "http://www.w3.org/1999/02/22-rdf-syntax-ns#langString"
+
+- singularName: mediaType
+  functional: true
+  compactName: mediaType
+  uri: "https://www.w3.org/ns/activitystreams#mediaType"
+  description: The MIME media type of the source content.
+  range:
+  - "http://www.w3.org/2001/XMLSchema#string"

package/src/tentativeaccept.yaml

@@ -0,0 +1,14 @@
+$schema: ../../vocab-tools/schema.yaml
+name: TentativeAccept
+compactName: TentativeAccept
+uri: "https://www.w3.org/ns/activitystreams#TentativeAccept"
+extends: "https://www.w3.org/ns/activitystreams#Accept"
+entity: true
+description: |
+  A specialization of {@link Accept} indicating that
+  the acceptance is tentative.
+defaultContext:
+- "https://w3id.org/identity/v1"
+- "https://www.w3.org/ns/activitystreams"
+- "https://w3id.org/security/data-integrity/v1"
+properties: []

package/src/tentativereject.yaml

@@ -0,0 +1,14 @@
+$schema: ../../vocab-tools/schema.yaml
+name: TentativeReject
+compactName: TentativeReject
+uri: "https://www.w3.org/ns/activitystreams#TentativeReject"
+extends: "https://www.w3.org/ns/activitystreams#Reject"
+entity: true
+description: |
+  A specialization of {@link Reject} in which
+  the rejection is considered tentative.
+defaultContext:
+- "https://w3id.org/identity/v1"
+- "https://www.w3.org/ns/activitystreams"
+- "https://w3id.org/security/data-integrity/v1"
+properties: []

package/src/tombstone.yaml

@@ -0,0 +1,24 @@
+$schema: ../../vocab-tools/schema.yaml
+name: Tombstone
+compactName: Tombstone
+uri: "https://www.w3.org/ns/activitystreams#Tombstone"
+extends: "https://www.w3.org/ns/activitystreams#Object"
+entity: true
+description: |
+  A `Tombstone` represents a content object that has been deleted.
+  It can be used in {@link Collection}s to signify that there used to be
+  an object at this position, but it has been deleted.
+defaultContext:
+- "https://www.w3.org/ns/activitystreams"
+- "https://w3id.org/security/data-integrity/v1"
+
+properties:
+- singularName: deleted
+  functional: true
+  compactName: deleted
+  uri: "https://www.w3.org/ns/activitystreams#deleted"
+  description: |
+    On a `Tombstone` object, the `deleted` property is a timestamp for when
+    the object was deleted.
+  range:
+  - "http://www.w3.org/2001/XMLSchema#dateTime"

package/src/travel.yaml

@@ -0,0 +1,16 @@
+$schema: ../../vocab-tools/schema.yaml
+name: Travel
+compactName: Travel
+uri: "https://www.w3.org/ns/activitystreams#Travel"
+extends: "https://www.w3.org/ns/activitystreams#IntransitiveActivity"
+entity: true
+description: |
+  Indicates that the `actor` is traveling to `target` from `origin`.
+  `Travel` is an `IntransitiveObject` whose `actor` specifies the direct object.
+  If the `target` or `origin` are not specified,
+  either can be determined by context.
+defaultContext:
+- "https://w3id.org/identity/v1"
+- "https://www.w3.org/ns/activitystreams"
+- "https://w3id.org/security/data-integrity/v1"
+properties: []

package/src/type.test.ts

@@ -0,0 +1,20 @@
+import { test } from "@fedify/fixture";
+import { deepStrictEqual } from "node:assert/strict";
+import { getTypeId } from "./type.ts";
+import { Person } from "./vocab.ts";
+
+test("getTypeId()", () => {
+  const obj = new Person({});
+  deepStrictEqual(
+    getTypeId(obj),
+    new URL("https://www.w3.org/ns/activitystreams#Person"),
+  );
+  const obj2: Person | null = null;
+  deepStrictEqual(getTypeId(obj2), null);
+  const obj3: Person | undefined = undefined;
+  deepStrictEqual(getTypeId(obj3), undefined);
+  const obj4: Person | null | undefined = null;
+  deepStrictEqual(getTypeId(obj4), null);
+  const obj5: Person | null | undefined = undefined;
+  deepStrictEqual(getTypeId(obj5), undefined);
+});

package/src/type.ts

@@ -0,0 +1,102 @@
+import type { Link, Object } from "./vocab.ts";
+
+/**
+ * Returns the type URI of the given object.
+ *
+ * @example
+ * ``` typescript
+ * import { getTypeId, Person } from "@fedify/fedify";
+ *
+ * const obj = new Person({});
+ * console.log(getTypeId(obj));
+ * // => new URL("https://www.w3.org/ns/activitystreams#Person")
+ * ```
+ *
+ * @param object The Activity Vocabulary object.
+ * @returns The type URI of the object, e.g.,
+ *          `new URL("https://www.w3.org/ns/activitystreams#Person")`.
+ *          If the given `object` is `null` or `undefined`, returns `null` or
+ *          `undefined`, respectively.
+ * @since 1.3.0
+ */
+export function getTypeId(object: Object | Link): URL;
+
+/**
+ * Returns the type URI of the given object.
+ *
+ * @example
+ * ``` typescript
+ * import { getTypeId, Person } from "@fedify/fedify";
+ *
+ * const obj = new Person({});
+ * console.log(getTypeId(obj));
+ * // => new URL("https://www.w3.org/ns/activitystreams#Person")
+ * ```
+ *
+ * @param object The Activity Vocabulary object.
+ * @returns The type URI of the object, e.g.,
+ *          `new URL("https://www.w3.org/ns/activitystreams#Person")`.
+ *          If the given `object` is `null` or `undefined`, returns `null` or
+ *          `undefined`, respectively.
+ * @since 1.3.0
+ */
+export function getTypeId(object: Object | Link | undefined): URL | undefined;
+
+/**
+ * Returns the type URI of the given object.
+ *
+ * @example
+ * ``` typescript
+ * import { getTypeId, Person } from "@fedify/fedify";
+ *
+ * const obj = new Person({});
+ * console.log(getTypeId(obj));
+ * // => new URL("https://www.w3.org/ns/activitystreams#Person")
+ * ```
+ *
+ * @param object The Activity Vocabulary object.
+ * @returns The type URI of the object, e.g.,
+ *          `new URL("https://www.w3.org/ns/activitystreams#Person")`.
+ *          If the given `object` is `null` or `undefined`, returns `null` or
+ *          `undefined`, respectively.
+ * @since 1.3.0
+ */
+export function getTypeId(object: Object | Link | null): URL | null;
+
+/**
+ * Returns the type URI of the given object.
+ *
+ * @example
+ * ``` typescript
+ * import { getTypeId, Person } from "@fedify/fedify";
+ *
+ * const obj = new Person({});
+ * console.log(getTypeId(obj));
+ * // => new URL("https://www.w3.org/ns/activitystreams#Person")
+ * ```
+ *
+ * @param object The Activity Vocabulary object.
+ * @returns The type URI of the object, e.g.,
+ *          `new URL("https://www.w3.org/ns/activitystreams#Person")`.
+ *          If the given `object` is `null` or `undefined`, returns `null` or
+ *          `undefined`, respectively.
+ * @since 1.3.0
+ */
+export function getTypeId(
+  object: Object | Link | null | undefined,
+): URL | null | undefined;
+
+export function getTypeId(
+  object: Object | Link | undefined | null,
+): URL | undefined | null {
+  // TODO: Deno 2.4.2's TypeScript doesn't properly narrow the type with `object == null` check,
+  // so we need an explicit type assertion here. This should be revisited when upgrading
+  // to newer versions that might fix this type narrowing issue.
+  if (object == null) return object as undefined | null;
+  const cls = object.constructor as
+    & (new (...args: unknown[]) => Object | Link)
+    & {
+      typeId: URL;
+    };
+  return cls.typeId;
+}

package/src/undo.yaml

@@ -0,0 +1,26 @@
+$schema: ../../vocab-tools/schema.yaml
+name: Undo
+compactName: Undo
+uri: "https://www.w3.org/ns/activitystreams#Undo"
+extends: "https://www.w3.org/ns/activitystreams#Activity"
+entity: true
+description: |
+  Indicates that the `actor` is undoing the `object`.  In most cases,
+  the `object` will be an {@link Activity} describing some previously performed
+  action (for instance, a person may have previously "liked" an article but,
+  for whatever reason, might choose to undo that like at some later point in
+  time).
+
+  The `target` and `origin` typically have no defined meaning.
+defaultContext:
+- "https://w3id.org/identity/v1"
+- "https://www.w3.org/ns/activitystreams"
+- "https://w3id.org/security/v1"
+- "https://w3id.org/security/data-integrity/v1"
+- "https://www.w3.org/ns/did/v1"
+- "https://w3id.org/security/multikey/v1"
+- litepub: "http://litepub.social/ns#"
+  toot: "http://joinmastodon.org/ns#"
+  EmojiReact: "litepub:EmojiReact"
+  Emoji: "toot:Emoji"
+properties: []

package/src/update.yaml

@@ -0,0 +1,58 @@
+$schema: ../../vocab-tools/schema.yaml
+name: Update
+compactName: Update
+uri: "https://www.w3.org/ns/activitystreams#Update"
+extends: "https://www.w3.org/ns/activitystreams#Activity"
+entity: true
+description: |
+  Indicates that the `actor` has updated the `object`.  Note, however,
+  that this vocabulary does not define a mechanism for describing the actual
+  set of modifications made to `object`.
+
+  The `target` and `origin` typically have no defined meaning.
+defaultContext:
+- "https://w3id.org/identity/v1"
+- "https://www.w3.org/ns/activitystreams"
+- "https://w3id.org/security/v1"
+- "https://w3id.org/security/data-integrity/v1"
+- "https://www.w3.org/ns/did/v1"
+- "https://w3id.org/security/multikey/v1"
+- alsoKnownAs:
+    "@id": "as:alsoKnownAs"
+    "@type": "@id"
+  manuallyApprovesFollowers: "as:manuallyApprovesFollowers"
+  sensitive: "as:sensitive"
+  movedTo:
+    "@id": "as:movedTo"
+    "@type": "@id"
+  quoteUrl: "as:quoteUrl"
+  toot: "http://joinmastodon.org/ns#"
+  featured:
+    "@id": "toot:featured"
+    "@type": "@id"
+  featuredTags:
+    "@id": "toot:featuredTags"
+    "@type": "@id"
+  discoverable: "toot:discoverable"
+  suspended: "toot:suspended"
+  memorial: "toot:memorial"
+  indexable: "toot:indexable"
+  votersCount:
+    "@id": "toot:votersCount"
+    "@type": "http://www.w3.org/2001/XMLSchema#nonNegativeInteger"
+  Emoji: "toot:Emoji"
+  Hashtag: "as:Hashtag"
+  schema: "http://schema.org#"
+  PropertyValue: "schema:PropertyValue"
+  value: "schema:value"
+  ChatMessage: "http://litepub.social/ns#ChatMessage"
+  fedibird: "http://fedibird.com/ns#"
+  quoteUri: "fedibird:quoteUri"
+  misskey: "https://misskey-hub.net/ns#"
+  _misskey_quote: "misskey:_misskey_quote"
+  _misskey_followedMessage: "misskey:_misskey_followedMessage"
+  isCat: "misskey:isCat"
+  emojiReactions:
+    "@id": "fedibird:emojiReactions"
+    "@type": "@id"
+properties: []

package/src/utils.ts

@@ -0,0 +1,9 @@
+import { ok } from "node:assert";
+
+export function assertInstanceOf<T>(
+  value: unknown,
+  // deno-lint-ignore no-explicit-any
+  constructor: new (...args: any[]) => T,
+): asserts value is T {
+  ok(value instanceof constructor);
+}

package/src/video.yaml

@@ -0,0 +1,11 @@
+$schema: ../../vocab-tools/schema.yaml
+name: Video
+compactName: Video
+uri: "https://www.w3.org/ns/activitystreams#Video"
+extends: "https://www.w3.org/ns/activitystreams#Document"
+entity: true
+description: Represents a video document of any kind.
+defaultContext:
+- "https://www.w3.org/ns/activitystreams"
+- "https://w3id.org/security/data-integrity/v1"
+properties: []

package/src/view.yaml

@@ -0,0 +1,13 @@
+$schema: ../../vocab-tools/schema.yaml
+name: View
+compactName: View
+uri: "https://www.w3.org/ns/activitystreams#View"
+extends: "https://www.w3.org/ns/activitystreams#Activity"
+entity: true
+description: |
+  Indicates that the `actor` has viewed the object.
+defaultContext:
+- "https://w3id.org/identity/v1"
+- "https://www.w3.org/ns/activitystreams"
+- "https://w3id.org/security/data-integrity/v1"
+properties: []

package/src/vocab.bench.ts

@@ -0,0 +1,204 @@
+import { Collection, Object } from "./vocab.ts";
+
+const jsonLd = {
+  "@context": [
+    "https://www.w3.org/ns/activitystreams",
+    "https://w3id.org/security/v1",
+    {
+      "manuallyApprovesFollowers": "as:manuallyApprovesFollowers",
+      "toot": "http://joinmastodon.org/ns#",
+      "featured": {
+        "@id": "toot:featured",
+        "@type": "@id",
+      },
+      "featuredTags": {
+        "@id": "toot:featuredTags",
+        "@type": "@id",
+      },
+      "alsoKnownAs": {
+        "@id": "as:alsoKnownAs",
+        "@type": "@id",
+      },
+      "movedTo": {
+        "@id": "as:movedTo",
+        "@type": "@id",
+      },
+      "schema": "http://schema.org#",
+      "PropertyValue": "schema:PropertyValue",
+      "value": "schema:value",
+      "discoverable": "toot:discoverable",
+      "Device": "toot:Device",
+      "Ed25519Signature": "toot:Ed25519Signature",
+      "Ed25519Key": "toot:Ed25519Key",
+      "Curve25519Key": "toot:Curve25519Key",
+      "EncryptedMessage": "toot:EncryptedMessage",
+      "publicKeyBase64": "toot:publicKeyBase64",
+      "deviceId": "toot:deviceId",
+      "claim": {
+        "@type": "@id",
+        "@id": "toot:claim",
+      },
+      "fingerprintKey": {
+        "@type": "@id",
+        "@id": "toot:fingerprintKey",
+      },
+      "identityKey": {
+        "@type": "@id",
+        "@id": "toot:identityKey",
+      },
+      "devices": {
+        "@type": "@id",
+        "@id": "toot:devices",
+      },
+      "messageFranking": "toot:messageFranking",
+      "messageType": "toot:messageType",
+      "cipherText": "toot:cipherText",
+      "suspended": "toot:suspended",
+      "memorial": "toot:memorial",
+      "indexable": "toot:indexable",
+      "Hashtag": "as:Hashtag",
+      "focalPoint": {
+        "@container": "@list",
+        "@id": "toot:focalPoint",
+      },
+    },
+  ],
+  "id": "https://fosstodon.org/users/hongminhee",
+  "type": "Person",
+  "following": "https://fosstodon.org/users/hongminhee/following",
+  "followers": "https://fosstodon.org/users/hongminhee/followers",
+  "inbox": "https://fosstodon.org/users/hongminhee/inbox",
+  "outbox": "https://fosstodon.org/users/hongminhee/outbox",
+  "featured": "https://fosstodon.org/users/hongminhee/collections/featured",
+  "featuredTags": "https://fosstodon.org/users/hongminhee/collections/tags",
+  "preferredUsername": "hongminhee",
+  "name": "洪 民憙 (Hong Minhee)",
+  "summary":
+    '<p>An intersectionalist, feminist, and socialist guy living in Seoul (UTC+09:00).  Who&#39;s behind <span class="h-card" translate="no"><a href="https://hollo.social/@fedify" class="u-url mention">@<span>fedify</span></a></span> and <span class="h-card" translate="no"><a href="https://hollo.social/@hollo" class="u-url mention">@<span>hollo</span></a></span>.  Write some free software in <a href="https://fosstodon.org/tags/Haskell" class="mention hashtag" rel="tag">#<span>Haskell</span></a>, <a href="https://fosstodon.org/tags/Rust" class="mention hashtag" rel="tag">#<span>Rust</span></a>, <a href="https://fosstodon.org/tags/TypeScript" class="mention hashtag" rel="tag">#<span>TypeScript</span></a>, &amp; <a href="https://fosstodon.org/tags/Python" class="mention hashtag" rel="tag">#<span>Python</span></a>.  They/them.</p><p><a href="https://fosstodon.org/tags/%E5%9C%8B%E6%BC%A2%E6%96%87%E6%B7%B7%E7%94%A8" class="mention hashtag" rel="tag">#<span>國漢文混用</span></a> <a href="https://fosstodon.org/tags/%ED%95%9C%EA%B5%AD%EC%96%B4" class="mention hashtag" rel="tag">#<span>한국어</span></a> (<a href="https://fosstodon.org/tags/%E6%9C%9D%E9%AE%AE%E8%AA%9E" class="mention hashtag" rel="tag">#<span>朝鮮語</span></a>) <a href="https://fosstodon.org/tags/English" class="mention hashtag" rel="tag">#<span>English</span></a> <a href="https://fosstodon.org/tags/%E6%97%A5%E6%9C%AC%E8%AA%9E" class="mention hashtag" rel="tag">#<span>日本語</span></a></p>',
+  "url": "https://fosstodon.org/@hongminhee",
+  "manuallyApprovesFollowers": false,
+  "discoverable": true,
+  "indexable": true,
+  "published": "2024-06-19T00:00:00Z",
+  "memorial": false,
+  "devices": "https://fosstodon.org/users/hongminhee/collections/devices",
+  "alsoKnownAs": [
+    "https://todon.eu/users/hongminhee",
+    "https://mastodon.social/users/hongminhee",
+  ],
+  "publicKey": {
+    "id": "https://fosstodon.org/users/hongminhee#main-key",
+    "owner": "https://fosstodon.org/users/hongminhee",
+    "publicKeyPem":
+      "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArvxgF3bUeGeoat8MMKH2\nRsWrQGuaZ1VyZ5Eo55urrcii96TX47Xqznv7YHXSYf/W0b647wYWzkh1vb0jzfS+\nJ9sh1MmniiBSqb46FII6Ou7R/QJaBbSFKStdHlrlbTQZNzmUqE0y29mxxlP7Sqdd\nJjiPKrcQEMkG5TRNxwkR4pPSP0oj/4++aEApcM+qqk56bs5c3sHaQKMdh0qFtMAb\npcTpD9CooEDzeQoaxlsvNuWFu7WjDuLAdARFingfDfUy42d0OSW5yy9PhSmWdfYX\nrTzfB2aekQIAczbrxZ82PrSzB3pR0LDR4ZRu22nWsU57jyHjNdbwwTGRNrhRdBzK\nOwIDAQAB\n-----END PUBLIC KEY-----\n",
+  },
+  "tag": [
+    {
+      "type": "Hashtag",
+      "href": "https://fosstodon.org/tags/haskell",
+      "name": "#haskell",
+    },
+    {
+      "type": "Hashtag",
+      "href": "https://fosstodon.org/tags/python",
+      "name": "#python",
+    },
+    {
+      "type": "Hashtag",
+      "href": "https://fosstodon.org/tags/rust",
+      "name": "#rust",
+    },
+    {
+      "type": "Hashtag",
+      "href": "https://fosstodon.org/tags/english",
+      "name": "#english",
+    },
+    {
+      "type": "Hashtag",
+      "href": "https://fosstodon.org/tags/%E6%97%A5%E6%9C%AC%E8%AA%9E",
+      "name": "#日本語",
+    },
+    {
+      "type": "Hashtag",
+      "href": "https://fosstodon.org/tags/typescript",
+      "name": "#typescript",
+    },
+    {
+      "type": "Hashtag",
+      "href": "https://fosstodon.org/tags/%ED%95%9C%EA%B5%AD%EC%96%B4",
+      "name": "#한국어",
+    },
+    {
+      "type": "Hashtag",
+      "href":
+        "https://fosstodon.org/tags/%E5%9C%8B%E6%BC%A2%E6%96%87%E6%B7%B7%E7%94%A8",
+      "name": "#國漢文混用",
+    },
+    {
+      "type": "Hashtag",
+      "href": "https://fosstodon.org/tags/%E6%9C%9D%E9%AE%AE%E8%AA%9E",
+      "name": "#朝鮮語",
+    },
+  ],
+  "attachment": [
+    {
+      "type": "PropertyValue",
+      "name": "Website",
+      "value":
+        '<a href="https://hongminhee.org/" target="_blank" rel="nofollow noopener noreferrer me" translate="no"><span class="invisible">https://</span><span class="">hongminhee.org/</span><span class="invisible"></span></a>',
+    },
+    {
+      "type": "PropertyValue",
+      "name": "GitHub",
+      "value":
+        '<a href="https://github.com/dahlia" target="_blank" rel="nofollow noopener noreferrer me" translate="no"><span class="invisible">https://</span><span class="">github.com/dahlia</span><span class="invisible"></span></a>',
+    },
+    {
+      "type": "PropertyValue",
+      "name": "Keyoxide",
+      "value":
+        '<a href="https://keyoxide.org/374B15AF323796A62AB1BCE3C429ECD57EED6CCA" target="_blank" rel="nofollow noopener noreferrer me" translate="no"><span class="invisible">https://</span><span class="ellipsis">keyoxide.org/374B15AF323796A62</span><span class="invisible">AB1BCE3C429ECD57EED6CCA</span></a>',
+    },
+    {
+      "type": "PropertyValue",
+      "name": "Matrix",
+      "value":
+        '<span class="h-card" translate="no"><a href="https://fosstodon.org/@hongminhee" class="u-url mention">@<span>hongminhee</span></a></span>:matrix.org',
+    },
+  ],
+  "endpoints": {
+    "sharedInbox": "https://fosstodon.org/inbox",
+  },
+  "icon": {
+    "type": "Image",
+    "mediaType": "image/jpeg",
+    "url":
+      "https://cdn.fosstodon.org/accounts/avatars/112/643/523/844/583/361/original/de4e086cad8412c6.jpg",
+  },
+  "image": {
+    "type": "Image",
+    "mediaType": "image/jpeg",
+    "url":
+      "https://cdn.fosstodon.org/accounts/headers/112/643/523/844/583/361/original/d7fd4c4f9e73502f.jpg",
+  },
+};
+
+Deno.bench("Object.toJsonLd()", async (b) => {
+  const object = await Object.fromJsonLd(jsonLd);
+
+  b.start();
+  await object.toJsonLd();
+  b.end();
+});
+
+const person = await Object.fromJsonLd(jsonLd);
+const people: Object[] = [];
+for (let i = 0; i < 2500; i++) people.push(person);
+
+Deno.bench("Collection.toJsonLd()", async (b) => {
+  const collection = new Collection({ items: people });
+
+  b.start();
+  await collection.toJsonLd();
+  b.end();
+});