@fedify/fedify 0.8.0-dev.167 → 0.8.0

package/CHANGES.md

@@ -6,7 +6,7 @@ Fedify changelog
 Version 0.8.0
 -------------
 
-To be released.
+Released on May 6, 2024.
 
  -  The CLI toolchain for testing and debugging is now available on JSR:
     [@fedify/cli].  You can install it with
@@ -66,6 +66,16 @@ To be released.
      -  The type of the third parameter of `doesActorOwnKey()` function became
         `DoesActorOwnKeyOptions` (was `DocumentLoader`).
 
+ -  Added `width` and `height` properties to `Document` class for better
+    compatibility with Mastodon.  [[#47]]
+
+     -  Added `Document.width` property.
+     -  Added `Document.height` property.
+     -  `new Document()` constructor now accepts `width` option.
+     -  `new Document()` constructor now accepts `height` option.
+     -  `Document.clone()` method now accepts `width` option.
+     -  `Document.clone()` method now accepts `height` option.
+
  -  Removed the dependency on *@js-temporal/polyfill* on Deno, and Fedify now
     requires `--unstable-temporal` flag.  On other runtime, it still depends
     on *@js-temporal/polyfill*.
@@ -88,6 +98,7 @@ To be released.
 [@fedify/cli]: https://jsr.io/@fedify/cli
 [releases]: https://github.com/dahlia/fedify/releases
 [FEP-8fcf]: https://codeberg.org/fediverse/fep/src/branch/main/fep/8fcf/fep-8fcf.md
+[#47]: https://github.com/dahlia/fedify/issues/47
 
 
 Version 0.7.0

package/README.md

@@ -46,7 +46,7 @@ join our [Matrix chat space][Matrix] or [GitHub Discussions].  Or tag
       [Mastodon], [Lemmy], [Pixelfed], [PeerTube], and so on.
 
 [JSR]: https://jsr.io/@fedify/fedify
-[JSR badge]: https://jsr.io/badges/@fedify/fedify?v=0.6.0
+[JSR badge]: https://jsr.io/badges/@fedify/fedify
 [npm]: https://www.npmjs.com/package/@fedify/fedify
 [npm badge]: https://img.shields.io/npm/v/@fedify/fedify?logo=npm
 [GitHub Actions]: https://github.com/dahlia/fedify/actions/workflows/build.yaml

package/esm/vocab/document.yaml

@@ -5,4 +5,22 @@ extends: "https://www.w3.org/ns/activitystreams#Object"
 entity: true
 description: Represents a document of any kind.
 defaultContext: "https://www.w3.org/ns/activitystreams"
-properties: []
+
+properties:
+- singularName: width
+  functional: true
+  uri: "https://www.w3.org/ns/activitystreams#width"
+  description: |
+    Specifies a hint as to the rendering width in
+    device-independent pixels of the linked resource.
+  range:
+  - "http://www.w3.org/2001/XMLSchema#nonNegativeInteger"
+
+- singularName: height
+  functional: true
+  uri: "https://www.w3.org/ns/activitystreams#height"
+  description: |
+    Specifies a hint as to the rendering height in
+    device-independent pixels of the linked resource. 
+  range:
+  - "http://www.w3.org/2001/XMLSchema#nonNegativeInteger"

package/esm/vocab/vocab.js

@@ -5825,6 +5825,8 @@ export class Document extends Object {
     static get typeId() {
         return new URL("https://www.w3.org/ns/activitystreams#Document");
     }
+    #_2e9AP7WdHBJYAgXG6GEyq7nSkNMe = [];
+    #_2cGKFeFJMmiNpGZFEF75mCwFQsKb = [];
     /**
      * Constructs a new instance of Document with the given values.
      * @param values The values to initialize the instance with.
@@ -5832,6 +5834,12 @@ export class Document extends Object {
      */
     constructor(values, { documentLoader, contextLoader, } = {}) {
         super(values, { documentLoader, contextLoader });
+        if ("width" in values && values.width != null) {
+            this.#_2e9AP7WdHBJYAgXG6GEyq7nSkNMe = [values.width];
+        }
+        if ("height" in values && values.height != null) {
+            this.#_2cGKFeFJMmiNpGZFEF75mCwFQsKb = [values.height];
+        }
     }
     /**
      * Clones this instance, optionally updating it with the given values.
@@ -5841,8 +5849,32 @@ export class Document extends Object {
      */
     clone(values = {}, options = {}) {
         const clone = super.clone(values, options);
+        clone.#_2e9AP7WdHBJYAgXG6GEyq7nSkNMe = this.#_2e9AP7WdHBJYAgXG6GEyq7nSkNMe;
+        if ("width" in values && values.width != null) {
+            clone.#_2e9AP7WdHBJYAgXG6GEyq7nSkNMe = [values.width];
+        }
+        clone.#_2cGKFeFJMmiNpGZFEF75mCwFQsKb = this.#_2cGKFeFJMmiNpGZFEF75mCwFQsKb;
+        if ("height" in values && values.height != null) {
+            clone.#_2cGKFeFJMmiNpGZFEF75mCwFQsKb = [values.height];
+        }
         return clone;
     }
+    /** Specifies a hint as to the rendering width in
+     * device-independent pixels of the linked resource.
+     */
+    get width() {
+        if (this.#_2e9AP7WdHBJYAgXG6GEyq7nSkNMe.length < 1)
+            return null;
+        return this.#_2e9AP7WdHBJYAgXG6GEyq7nSkNMe[0];
+    }
+    /** Specifies a hint as to the rendering height in
+     * device-independent pixels of the linked resource.
+     */
+    get height() {
+        if (this.#_2cGKFeFJMmiNpGZFEF75mCwFQsKb.length < 1)
+            return null;
+        return this.#_2cGKFeFJMmiNpGZFEF75mCwFQsKb[0];
+    }
     /**
      * Converts this object to a JSON-LD structure.
      * @returns The JSON-LD representation of this object.
@@ -5859,6 +5891,26 @@ export class Document extends Object {
             expand: true,
         });
         const values = baseValues[0];
+        array = [];
+        for (const v of this.#_2e9AP7WdHBJYAgXG6GEyq7nSkNMe) {
+            array.push({
+                "@type": "http://www.w3.org/2001/XMLSchema#nonNegativeInteger",
+                "@value": v,
+            });
+        }
+        if (array.length > 0) {
+            values["https://www.w3.org/ns/activitystreams#width"] = array;
+        }
+        array = [];
+        for (const v of this.#_2cGKFeFJMmiNpGZFEF75mCwFQsKb) {
+            array.push({
+                "@type": "http://www.w3.org/2001/XMLSchema#nonNegativeInteger",
+                "@value": v,
+            });
+        }
+        if (array.length > 0) {
+            values["https://www.w3.org/ns/activitystreams#height"] = array;
+        }
         values["@type"] = ["https://www.w3.org/ns/activitystreams#Document"];
         if (this.id)
             values["@id"] = this.id.href;
@@ -5923,10 +5975,46 @@ export class Document extends Object {
         if (!(instance instanceof Document)) {
             throw new TypeError("Unexpected type: " + instance.constructor.name);
         }
+        const _2e9AP7WdHBJYAgXG6GEyq7nSkNMe = [];
+        for (const v of values["https://www.w3.org/ns/activitystreams#width"] ?? []) {
+            if (v == null)
+                continue;
+            _2e9AP7WdHBJYAgXG6GEyq7nSkNMe.push(v["@value"]);
+        }
+        instance.#_2e9AP7WdHBJYAgXG6GEyq7nSkNMe = _2e9AP7WdHBJYAgXG6GEyq7nSkNMe;
+        const _2cGKFeFJMmiNpGZFEF75mCwFQsKb = [];
+        for (const v of values["https://www.w3.org/ns/activitystreams#height"] ?? []) {
+            if (v == null)
+                continue;
+            _2cGKFeFJMmiNpGZFEF75mCwFQsKb.push(v["@value"]);
+        }
+        instance.#_2cGKFeFJMmiNpGZFEF75mCwFQsKb = _2cGKFeFJMmiNpGZFEF75mCwFQsKb;
         return instance;
     }
     _getCustomInspectProxy() {
         const proxy = super._getCustomInspectProxy();
+        const _2e9AP7WdHBJYAgXG6GEyq7nSkNMe = this.#_2e9AP7WdHBJYAgXG6GEyq7nSkNMe
+            // deno-lint-ignore no-explicit-any
+            .map((v) => v instanceof URL
+            ? {
+                [Symbol.for("Deno.customInspect")]: (inspect, options) => "URL " + inspect(v.href, options),
+                [Symbol.for("nodejs.util.inspect.custom")]: (_depth, options, inspect) => "URL " + inspect(v.href, options),
+            }
+            : v);
+        if (_2e9AP7WdHBJYAgXG6GEyq7nSkNMe.length == 1) {
+            proxy.width = _2e9AP7WdHBJYAgXG6GEyq7nSkNMe[0];
+        }
+        const _2cGKFeFJMmiNpGZFEF75mCwFQsKb = this.#_2cGKFeFJMmiNpGZFEF75mCwFQsKb
+            // deno-lint-ignore no-explicit-any
+            .map((v) => v instanceof URL
+            ? {
+                [Symbol.for("Deno.customInspect")]: (inspect, options) => "URL " + inspect(v.href, options),
+                [Symbol.for("nodejs.util.inspect.custom")]: (_depth, options, inspect) => "URL " + inspect(v.href, options),
+            }
+            : v);
+        if (_2cGKFeFJMmiNpGZFEF75mCwFQsKb.length == 1) {
+            proxy.height = _2cGKFeFJMmiNpGZFEF75mCwFQsKb[0];
+        }
         return proxy;
     }
     [Symbol.for("Deno.customInspect")](inspect, options) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/fedify",
-  "version": "0.8.0-dev.167+c47b7e4d",
+  "version": "0.8.0",
   "description": "An ActivityPub server framework",
   "keywords": [
     "ActivityPub",

package/types/vocab/vocab.d.ts

@@ -1826,6 +1826,7 @@ export declare class Article extends Object {
 /** Represents a document of any kind.
  */
 export declare class Document extends Object {
+    #private;
     /**
      * The type URI of {@link Document}: `https://www.w3.org/ns/activitystreams#Document`.
      */
@@ -1879,6 +1880,8 @@ export declare class Document extends Object {
         mediaType?: string | null;
         duration?: dntShim.Temporal.Duration | null;
         sensitive?: boolean | null;
+        width?: number | null;
+        height?: number | null;
     }, { documentLoader, contextLoader, }?: {
         documentLoader?: DocumentLoader;
         contextLoader?: DocumentLoader;
@@ -1933,10 +1936,20 @@ export declare class Document extends Object {
         mediaType?: string | null;
         duration?: dntShim.Temporal.Duration | null;
         sensitive?: boolean | null;
+        width?: number | null;
+        height?: number | null;
     }, options?: {
         documentLoader?: DocumentLoader;
         contextLoader?: DocumentLoader;
     }): Document;
+    /** Specifies a hint as to the rendering width in
+     * device-independent pixels of the linked resource.
+     */
+    get width(): number | null;
+    /** Specifies a hint as to the rendering height in
+     * device-independent pixels of the linked resource.
+     */
+    get height(): number | null;
     /**
      * Converts this object to a JSON-LD structure.
      * @returns The JSON-LD representation of this object.
@@ -2013,6 +2026,8 @@ export declare class Audio extends Document {
         mediaType?: string | null;
         duration?: dntShim.Temporal.Duration | null;
         sensitive?: boolean | null;
+        width?: number | null;
+        height?: number | null;
     }, { documentLoader, contextLoader, }?: {
         documentLoader?: DocumentLoader;
         contextLoader?: DocumentLoader;
@@ -2067,6 +2082,8 @@ export declare class Audio extends Document {
         mediaType?: string | null;
         duration?: dntShim.Temporal.Duration | null;
         sensitive?: boolean | null;
+        width?: number | null;
+        height?: number | null;
     }, options?: {
         documentLoader?: DocumentLoader;
         contextLoader?: DocumentLoader;
@@ -4126,6 +4143,8 @@ export declare class Image extends Document {
         mediaType?: string | null;
         duration?: dntShim.Temporal.Duration | null;
         sensitive?: boolean | null;
+        width?: number | null;
+        height?: number | null;
     }, { documentLoader, contextLoader, }?: {
         documentLoader?: DocumentLoader;
         contextLoader?: DocumentLoader;
@@ -4180,6 +4199,8 @@ export declare class Image extends Document {
         mediaType?: string | null;
         duration?: dntShim.Temporal.Duration | null;
         sensitive?: boolean | null;
+        width?: number | null;
+        height?: number | null;
     }, options?: {
         documentLoader?: DocumentLoader;
         contextLoader?: DocumentLoader;
@@ -5532,6 +5553,8 @@ export declare class Page extends Document {
         mediaType?: string | null;
         duration?: dntShim.Temporal.Duration | null;
         sensitive?: boolean | null;
+        width?: number | null;
+        height?: number | null;
     }, { documentLoader, contextLoader, }?: {
         documentLoader?: DocumentLoader;
         contextLoader?: DocumentLoader;
@@ -5586,6 +5609,8 @@ export declare class Page extends Document {
         mediaType?: string | null;
         duration?: dntShim.Temporal.Duration | null;
         sensitive?: boolean | null;
+        width?: number | null;
+        height?: number | null;
     }, options?: {
         documentLoader?: DocumentLoader;
         contextLoader?: DocumentLoader;
@@ -7469,6 +7494,8 @@ export declare class Video extends Document {
         mediaType?: string | null;
         duration?: dntShim.Temporal.Duration | null;
         sensitive?: boolean | null;
+        width?: number | null;
+        height?: number | null;
     }, { documentLoader, contextLoader, }?: {
         documentLoader?: DocumentLoader;
         contextLoader?: DocumentLoader;
@@ -7523,6 +7550,8 @@ export declare class Video extends Document {
         mediaType?: string | null;
         duration?: dntShim.Temporal.Duration | null;
         sensitive?: boolean | null;
+        width?: number | null;
+        height?: number | null;
     }, options?: {
         documentLoader?: DocumentLoader;
         contextLoader?: DocumentLoader;