@fedify/fedify 0.5.0-dev.88

package/esm/vocab/intransitiveactivity.yaml

@@ -0,0 +1,11 @@
+$schema: ../codegen/schema.yaml
+name: IntransitiveActivity
+uri: "https://www.w3.org/ns/activitystreams#IntransitiveActivity"
+extends: "https://www.w3.org/ns/activitystreams#Activity"
+entity: true
+description: |
+  Instances of `IntransitiveActivity` are a subtype of {@link Activity}
+  representing intransitive actions.  The `object` property is therefore
+  inappropriate for these activities.
+defaultContext: "https://www.w3.org/ns/activitystreams"
+properties: []

package/esm/vocab/key.yaml

@@ -0,0 +1,25 @@
+$schema: ../codegen/schema.yaml
+name: CryptographicKey
+uri: "https://w3id.org/security#Key"
+entity: true
+description: A key owned by an actor.
+defaultContext: "https://w3id.org/security/v1"
+
+properties:
+- singularName: owner
+  functional: true
+  uri: "https://w3id.org/security#owner"
+  description: An actor who owns this key.
+  range:
+  - "https://www.w3.org/ns/activitystreams#Application"
+  - "https://www.w3.org/ns/activitystreams#Group"
+  - "https://www.w3.org/ns/activitystreams#Organization"
+  - "https://www.w3.org/ns/activitystreams#Person"
+  - "https://www.w3.org/ns/activitystreams#Service"
+
+- singularName: publicKey
+  functional: true
+  uri: "https://w3id.org/security#publicKeyPem"
+  description: A PEM-encoded public key.
+  range:
+  - "fedify:publicKey"

package/esm/vocab/like.yaml

@@ -0,0 +1,10 @@
+$schema: ../codegen/schema.yaml
+name: Like
+uri: "https://www.w3.org/ns/activitystreams#Like"
+extends: "https://www.w3.org/ns/activitystreams#Activity"
+entity: true
+description: |
+  Indicates that the `actor` likes, recommends or endorses the `object`.
+  The `target` and `origin` typically have no defined meaning.
+defaultContext: "https://www.w3.org/ns/activitystreams"
+properties: []

package/esm/vocab/link.yaml

@@ -0,0 +1,92 @@
+$schema: ../codegen/schema.yaml
+name: Link
+uri: "https://www.w3.org/ns/activitystreams#Link"
+entity: false
+description: |
+  A Link is an indirect, qualified reference to a resource identified by a URL.
+  The fundamental model for links is established by RFC 5988. Many of the
+  properties defined by the Activity Vocabulary allow values that are either
+  instances of {@link Object} or {@link Link}. When a {@link Link} is used,
+  it establishes a qualified relation connecting the subject (the containing
+  object) to the resource identified by the `href`. Properties of
+  the {@link Link} are properties of the reference as opposed to properties of
+  the resource.
+defaultContext: "https://www.w3.org/ns/activitystreams"
+
+properties:
+- singularName: href
+  functional: true
+  uri: "https://www.w3.org/ns/activitystreams#href"
+  description: "The target resource pointed to by a {@link Link}."
+  range:
+  - "http://www.w3.org/2001/XMLSchema#anyURI"
+
+- pluralName: rels
+  singularName: rel
+  singularAccessor: true
+  uri: "https://www.w3.org/ns/activitystreams#rel"
+  description: |
+    A link relation associated with a {@link Link}. The value MUST conform to
+    both the HTML5 and RFC 5988 "link relation" definitions.
+
+    In the HTML5, any string not containing the space (U+0020), tab (U+0009),
+    LF (U+000A), FF (U+000C), CR (U+000D) or comma (U+002C) characters can
+    be used as a valid link relation.
+  range:
+  - "http://www.w3.org/2001/XMLSchema#string"
+
+- singularName: mediaType
+  functional: true
+  uri: "https://www.w3.org/ns/activitystreams#mediaType"
+  description: |
+    When used on a {@link Link}, identifies the MIME media type of the
+    referenced resource.
+  range:
+  - "http://www.w3.org/2001/XMLSchema#string"
+
+- pluralName: names
+  singularName: name
+  singularAccessor: true
+  uri: "https://www.w3.org/ns/activitystreams#name"
+  description: |
+    A simple, human-readable, plain-text name for the object. HTML markup MUST
+    NOT be included. The name MAY be expressed using multiple language-tagged
+    values.
+  range:
+  - "http://www.w3.org/2001/XMLSchema#string"
+  - "http://www.w3.org/1999/02/22-rdf-syntax-ns#langString"
+
+- singularName: language
+  functional: true
+  uri: "https://www.w3.org/ns/activitystreams#hreflang"
+  description: |
+    Hints as to the language used by the target resource.
+    Value MUST be a BCP 47 Language-Tag.
+  range:
+  - "fedify:langTag"
+
+- singularName: height
+  functional: true
+  uri: "https://www.w3.org/ns/activitystreams#height"
+  description: |
+    On a {@link Link}, specifies a hint as to the rendering height in
+    device-independent pixels of the linked resource. 
+  range:
+  - "http://www.w3.org/2001/XMLSchema#nonNegativeInteger"
+
+- singularName: width
+  functional: true
+  uri: "https://www.w3.org/ns/activitystreams#width"
+  description: |
+    On a {@link Link}, specifies a hint as to the rendering width in
+    device-independent pixels of the linked resource.
+  range:
+  - "http://www.w3.org/2001/XMLSchema#nonNegativeInteger"
+
+- pluralName: previews
+  singularName: preview
+  uri: "https://www.w3.org/ns/activitystreams#preview"
+  description: "Identifies an entity that provides a preview of this object."
+  range:
+  - "https://www.w3.org/ns/activitystreams#Link"
+  - "https://www.w3.org/ns/activitystreams#Object"

package/esm/vocab/lookup.d.ts

@@ -0,0 +1,42 @@
+/// <reference types="node" />
+import { type DocumentLoader } from "../runtime/docloader.js";
+import { Object } from "./vocab.js";
+/**
+ * Options for the `lookupObject` function.
+ */
+export interface LookupObjectOptions {
+    documentLoader?: DocumentLoader;
+}
+/**
+ * Looks up an ActivityStreams object by its URI (including `acct:` URIs)
+ * or a fediverse handle (e.g., `@user@server` or `user@server`).
+ *
+ * @example
+ * ``` typescript
+ * // Look up an actor by its fediverse handle:
+ * await lookupObject("@hongminhee@todon.eu");
+ * // returning a `Person` object.
+ *
+ * // A fediverse handle can omit the leading '@':
+ * await lookupObject("hongminhee@todon.eu");
+ * // returning a `Person` object.
+ *
+ * // A `acct:` URI can be used as well:
+ * await lookupObject("acct:hongminhee@todon.eu");
+ * // returning a `Person` object.
+ *
+ * // Look up an object by its URI:
+ * await lookupObject("https://todon.eu/@hongminhee/112060633798771581");
+ * // returning a `Note` object.
+ *
+ * // It can be a `URL` object as well:
+ * await lookupObject(new URL("https://todon.eu/@hongminhee/112060633798771581"));
+ * // returning a `Note` object.
+ * ```
+ *
+ * @param identifier The URI or fediverse handle to look up.
+ * @param options Lookup options.
+ * @returns The object, or `null` if not found.
+ */
+export declare function lookupObject(identifier: string | URL, options?: LookupObjectOptions): Promise<Object | null>;
+//# sourceMappingURL=lookup.d.ts.map

package/esm/vocab/lookup.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lookup.d.ts","sourceRoot":"","sources":["../../src/vocab/lookup.ts"],"names":[],"mappings":";AAAA,OAAO,EACL,KAAK,cAAc,EAEpB,MAAM,yBAAyB,CAAC;AAEjC,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEpC;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,cAAc,CAAC,EAAE,cAAc,CAAC;CACjC;AAKD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wBAAsB,YAAY,CAChC,UAAU,EAAE,MAAM,GAAG,GAAG,EACxB,OAAO,GAAE,mBAAwB,GAChC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAsCxB"}

package/esm/vocab/lookup.js

@@ -0,0 +1,82 @@
+import { fetchDocumentLoader, } from "../runtime/docloader.js";
+import { lookupWebFinger } from "../webfinger/lookup.js";
+import { Object } from "./vocab.js";
+const handleRegexp = /^@?((?:[-A-Za-z0-9._~!$&'()*+,;=]|%[A-Fa-f0-9]{2})+)@([^@]+)$/;
+/**
+ * Looks up an ActivityStreams object by its URI (including `acct:` URIs)
+ * or a fediverse handle (e.g., `@user@server` or `user@server`).
+ *
+ * @example
+ * ``` typescript
+ * // Look up an actor by its fediverse handle:
+ * await lookupObject("@hongminhee@todon.eu");
+ * // returning a `Person` object.
+ *
+ * // A fediverse handle can omit the leading '@':
+ * await lookupObject("hongminhee@todon.eu");
+ * // returning a `Person` object.
+ *
+ * // A `acct:` URI can be used as well:
+ * await lookupObject("acct:hongminhee@todon.eu");
+ * // returning a `Person` object.
+ *
+ * // Look up an object by its URI:
+ * await lookupObject("https://todon.eu/@hongminhee/112060633798771581");
+ * // returning a `Note` object.
+ *
+ * // It can be a `URL` object as well:
+ * await lookupObject(new URL("https://todon.eu/@hongminhee/112060633798771581"));
+ * // returning a `Note` object.
+ * ```
+ *
+ * @param identifier The URI or fediverse handle to look up.
+ * @param options Lookup options.
+ * @returns The object, or `null` if not found.
+ */
+export async function lookupObject(identifier, options = {}) {
+    const documentLoader = options.documentLoader ?? fetchDocumentLoader;
+    if (typeof identifier === "string") {
+        const match = handleRegexp.exec(identifier);
+        if (match)
+            identifier = `acct:${match[1]}@${match[2]}`;
+        identifier = new URL(identifier);
+    }
+    let document = null;
+    if (identifier.protocol === "http:" || identifier.protocol === "https:") {
+        try {
+            const remoteDoc = await documentLoader(identifier.href);
+            document = remoteDoc.document;
+        }
+        catch (_) {
+            // Silently ignore errors.
+        }
+    }
+    if (document == null) {
+        const jrd = await lookupWebFinger(identifier);
+        if (jrd?.links == null)
+            return null;
+        for (const l of jrd.links) {
+            if (l.type !== "application/activity+json" || l.rel !== "self")
+                continue;
+            try {
+                const remoteDoc = await documentLoader(l.href);
+                document = remoteDoc.document;
+                break;
+            }
+            catch (_) {
+                // Silently ignore errors.
+                continue;
+            }
+        }
+    }
+    if (document == null)
+        return null;
+    try {
+        return await Object.fromJsonLd(document, { documentLoader });
+    }
+    catch (e) {
+        if (e instanceof TypeError)
+            return null;
+        throw e;
+    }
+}

package/esm/vocab/lookup.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lookup.test.d.ts","sourceRoot":"","sources":["../../src/vocab/lookup.test.ts"],"names":[],"mappings":"AAAA,OAAO,2BAA2B,CAAC"}

package/esm/vocab/mention.yaml

@@ -0,0 +1,8 @@
+$schema: ../codegen/schema.yaml
+name: Mention
+uri: "https://www.w3.org/ns/activitystreams#Mention"
+extends: "https://www.w3.org/ns/activitystreams#Link"
+entity: false
+description:  A specialized {@link Link} that represents an @mention.
+defaultContext: "https://www.w3.org/ns/activitystreams"
+properties: []

package/esm/vocab/mod.d.ts

@@ -0,0 +1,55 @@
+/**
+ * A set of type-safe object mappings for the [Activity
+ * Vocabulary](https://www.w3.org/TR/activitystreams-vocabulary/).
+ *
+ * Each class in this module represents a type of object in the Activity
+ * Vocabulary.  For example, the {@link Note} class represents the
+ * [`Note` type](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-note)
+ * in the Activity Vocabulary.
+ *
+ * There are two ways to instnatiate an object of a class in this module.
+ * The first way is to use the constructor of the class.  For example:
+ *
+ * ``` typescript
+ * const note = new Note({
+ *   attributedTo: new URL("https://example.com/user"),
+ *   content: "Hello, world!",
+ * });
+ * const create = new Create({
+ *   actor: new URL("https://example.com/user"),
+ *   object: note,
+ * });
+ * ```
+ *
+ * The second way is to deserialize an object from a JSON-LD document using
+ * the `fromJsonLd()` method of the class.  For example:
+ *
+ * ``` typescript
+ * const create = await Create.fromJsonLd({
+ *   "@context": "https://www.w3.org/ns/activitystreams",
+ *   "type": "Create",
+ *   "actor": "https://example.com/user",
+ *   "object": {
+ *     "type": "Note",
+ *     "attributedTo": "https://example.com/user",
+ *     "content": "Hello, world!",
+ *   },
+ * });
+ * ```
+ *
+ * In order to serialize an object to a JSON-LD document, use the `toJsonLd()`
+ * method of the object.  For example:
+ *
+ * ``` typescript
+ * const jsonLd = await create.toJsonLd();
+ * ```
+ *
+ * Note that both `fromJsonLd()` and `toJsonLd()` are asynchronous methods
+ * that return a `Promise`.
+ *
+ * @module
+ */
+export * from "./actor.js";
+export * from "./lookup.js";
+export * from "./vocab.js";
+//# sourceMappingURL=mod.d.ts.map

package/esm/vocab/mod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../src/vocab/mod.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AACH,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC"}

package/esm/vocab/mod.js

@@ -0,0 +1,54 @@
+/**
+ * A set of type-safe object mappings for the [Activity
+ * Vocabulary](https://www.w3.org/TR/activitystreams-vocabulary/).
+ *
+ * Each class in this module represents a type of object in the Activity
+ * Vocabulary.  For example, the {@link Note} class represents the
+ * [`Note` type](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-note)
+ * in the Activity Vocabulary.
+ *
+ * There are two ways to instnatiate an object of a class in this module.
+ * The first way is to use the constructor of the class.  For example:
+ *
+ * ``` typescript
+ * const note = new Note({
+ *   attributedTo: new URL("https://example.com/user"),
+ *   content: "Hello, world!",
+ * });
+ * const create = new Create({
+ *   actor: new URL("https://example.com/user"),
+ *   object: note,
+ * });
+ * ```
+ *
+ * The second way is to deserialize an object from a JSON-LD document using
+ * the `fromJsonLd()` method of the class.  For example:
+ *
+ * ``` typescript
+ * const create = await Create.fromJsonLd({
+ *   "@context": "https://www.w3.org/ns/activitystreams",
+ *   "type": "Create",
+ *   "actor": "https://example.com/user",
+ *   "object": {
+ *     "type": "Note",
+ *     "attributedTo": "https://example.com/user",
+ *     "content": "Hello, world!",
+ *   },
+ * });
+ * ```
+ *
+ * In order to serialize an object to a JSON-LD document, use the `toJsonLd()`
+ * method of the object.  For example:
+ *
+ * ``` typescript
+ * const jsonLd = await create.toJsonLd();
+ * ```
+ *
+ * Note that both `fromJsonLd()` and `toJsonLd()` are asynchronous methods
+ * that return a `Promise`.
+ *
+ * @module
+ */
+export * from "./actor.js";
+export * from "./lookup.js";
+export * from "./vocab.js";

package/esm/vocab/note.yaml

@@ -0,0 +1,10 @@
+$schema: ../codegen/schema.yaml
+name: Note
+uri: "https://www.w3.org/ns/activitystreams#Note"
+extends: "https://www.w3.org/ns/activitystreams#Object"
+entity: true
+description: |
+  Represents a short written work typically less than a single paragraph in
+  length.
+defaultContext: "https://www.w3.org/ns/activitystreams"
+properties: []