npm - @fedify/fedify - Versions diffs - 1.6.0-dev.814 → 1.6.0 - Mend

@fedify/fedify 1.6.0-dev.814 → 1.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1249) hide show

package/CONTRIBUTING.md DELETED Viewed

@@ -1,272 +0,0 @@
-<!-- deno-fmt-ignore-file -->
-Contributing guide
-==================
-Thank you for considering contributing to Fedify!  This document explains how to
-contribute to the project.
-Bug reports
------------
-If you find a bug in Fedify, first of all, please search the [GitHub issue
-tracker] to see if the bug has already been reported.  If it hasn't been
-reported yet, please open a new issue.  When you open an issue, please provide
-the following information:
- -  The version of Fedify you are using.
- -  The version of Deno you are using.
- -  The version of the operating system you are using.
- -  The steps to reproduce the bug.
- -  The expected behavior.
- -  The actual behavior.
-[GitHub issue tracker]: https://github.com/fedify-dev/fedify/issues
-Feature requests
-----------------
-If you have a feature request for Fedify, please search the [GitHub issue
-tracker] to see if the feature has already been requested.  If it hasn't been
-requested yet, please open a new issue.  When you open an issue, please provide
-the following information:
- -  The use case of the feature.
- -  The expected behavior.
- -  The reason why you think the feature should be implemented in Fedify,
-    instead of a third-party library or your own project.
-Pull requests
--------------
-### License
-Fedify is licensed under the [MIT License].  By opening a pull request,
-you agree to license your contribution under the MIT License.  If you cannot
-agree to this license, please do not open a pull request.
-[MIT License]: https://minhee.mit-license.org/2024-2025/
-### Building
-To build the project, see the [*Build* section](#build).
-### Coding conventions
-Please run the following commands before opening a pull request:
-~~~~ bash
-cd src/
-deno task check
-~~~~
-### Docs
-If you want to fix a typo or improve the documentation, you can open a pull
-request without opening an issue.
-For Markdown, we have the following conventions:
- -  80 characters at most per line, except for code blocks and URLs.
- -  Prefer [reference links] over [inline links].
- -  Prefer [setext headings] over [ATX headings].
- -  Two new lines before opening an H1/H2 heading.
- -  One space before and two spaces after a bullet.
- -  Wrap file paths in asterisks.
- -  Wrap inline code in backticks.
- -  Wrap code blocks in quadruple tildes (`~~~~`), and specify the language with
-    a single space after the opening tildes (e.g., `~~~~ bash`).
-In order to build the docs,
-see the [*Building the docs* section](#building-the-docs).
-[reference links]: https://spec.commonmark.org/0.31.2/#shortcut-reference-link
-[inline links]: https://spec.commonmark.org/0.31.2/#inline-link
-[setext headings]: https://spec.commonmark.org/0.31.2/#setext-headings
-[ATX headings]: https://spec.commonmark.org/0.31.2/#atx-headings
-### Bug fix
-If you want to fix a bug in Fedify, please search the [GitHub issue tracker] to
-see if the bug has already been reported.  If it hasn't been reported yet,
-please open a new issue to discuss the bug.
-When you open a pull request, please provide the issue number that the pull
-request is related to.
-A patch set should include the following:
- -  The regression test that demonstrates the bug.  It should fail without the
-    patch and pass with the patch.
- -  The fix for the bug.
- -  The *CHANGES.md* entry.  The entry should include the issue number,
-    the pull request number, and your name (unless you want to be anonymous).
-Bug fix pull requests should target the most oldest maintenance branch that
-the bug affects.  If you are not sure which branch to target, please ask in the
-issue tracker.
-### Feature implementation
-If you want to contribute to Fedify, please open a new issue in the [GitHub
-issue tracker] to discuss the change you want to make.  If the change is
-accepted, you can start working on the change.  When you open a pull request,
-please provide the following information:
- -  The issue number that the pull request is related to.
- -  The description of the change.
- -  The reason why the change is needed.
- -  The steps to test the change.
-A patch set should include the following:
- -  The unit tests that demonstrate the feature.
- -  The implementation of the feature.
- -  If any API change was made, the documentation update for the API.
- -  Check if examples work with the change, and update the examples if needed.
- -  The *CHANGES.md* entry.  The entry should include the issue number,
-    the pull request number, and your name (unless you want to be anonymous).
-Feature pull requests should target the *main* branch.
-Build
------
-### Directories
-The repository consists of the following directories:
- -  *cli/*: The Fedify CLI.  The CLI is built with [Deno].
- -  *docs/*: The Fedify docs.  The docs are built with [Node.js] and
-    [VitePress].
- -  *examples/*: The example projects.  Some examples are built with Deno, and
-    some are built with Node.js.
- -  *src/*: The Fedify library.  The library is built with Deno, and tested with
-    Deno, Node.js, and [Bun].
-     -  *codegen/*: The code generation scripts.
-[Deno]: https://deno.com/
-[VitePress]: https://vitepress.dev/
-[Node.js]: https://nodejs.org/
-[Bun]: https://bun.sh/
-### Development environment
-Fedify uses [Deno] as the main development environment.  Therefore, you need to
-install Deno to hack on Fedify.
-> [!TIP]
-> If you use [mise-en-place], a dev tools/env vars manager and a task runner,
-> you can easily install Deno, [Node.js], and [Bun] with following commands:
->
-> ~~~~ bash
-> mise trust
-> mise install
-> ~~~~
-The recommended editor for Fedify is [Visual Studio Code] with
-the [Deno extension] installed.  Or you can use any editor that supports Deno;
-see the [*Set Up Your Environment* section][1] in the Deno manual.
-> [!CAUTION]
->
-> Fedify heavily depends on code generation, so you need to run
-> `deno task codegen` before coding or testing.
-Assuming you have Deno and Visual Studio Code installed, you can open
-the repository in Visual Studio Code and get ready to hack on Fedify by running
-the following commands at the *root* of the repository:
-~~~~ bash
-deno task codegen
-code .
-~~~~
-Note that the `deno task codegen` command is required to run only once at
-very first time, or when you update the code generation scripts.   Otherwise,
-you can skip the command and just run:
-~~~~ bash
-code .
-~~~~
-Immediately after running the `code .` command, Visual Studio Code will open
-the repository, and you can start hacking on Fedify.  If you encounter the
-following message:
-> Do you want to install recommended 'Deno' extension from denoland for
-> this repository?
-Please click the *Install* button to install the Deno extension.
-[mise-en-place]: https://mise.jdx.dev/
-[Visual Studio Code]: https://code.visualstudio.com/
-[Deno extension]: https://marketplace.visualstudio.com/items?itemName=denoland.vscode-deno
-[1]: https://docs.deno.com/runtime/manual/getting_started/setup_your_environment/
-### Running the Fedify CLI
-If you want to test your changes in the Fedify CLI, you can run
-`deno task -f @fedify/cli run` command.  For example, if you want to test
-the `fedify lookup` subcommand, you can run the following command:
-~~~~ bash
-deno task -f @fedify/cli run lookup @fedify@hollo.social
-~~~~
-> [!TIP]
->
-> Unlike the Fedify library, the Fedify CLI does not have to be tested with
-> Node.js and Bun; you can test the CLI with Deno only.
-#### Running the tests
-If you want to test your changes in the Fedify library, you can run
-the following command:
-~~~~ bash
-deno task -f @fedify/fedify test
-~~~~
-Or you can use `--filter` option to run a specific test.  For example, if you
-want to run the `verifyRequest` test:
-~~~~ bash
-deno task -f @fedify/fedify test --filter verifyRequest
-~~~~
-If the tests pass, you should run `deno task test-all` command to test
-the library with Deno, Node.js, and [Bun]:
-~~~~ bash
-deno task test-all
-~~~~
-Of course, Node.js and Bun should be installed on your system to run the tests
-with Node.js and Bun.
-> [!TIP]
-> If you use [mise-en-place], a dev tools/env vars manager and a task runner,
-> you can easily install Deno, [Node.js], and [Bun] with a single command:
->
-> ~~~~ bash
-> mise install
-> ~~~~
-### Building the docs
-If you want to change the Fedify docs, you would like to preview the changes
-in the browser.  To do that, you need to install [Bun] first.
-Then you can run the following commands at the *docs/* directory:
-~~~~ bash
-bun install
-bun dev
-~~~~
-Once the development server is running, you can open your browser and navigate
-to *http://localhost:5173/* to view the docs.

package/FEDERATION.md DELETED Viewed

@@ -1,85 +0,0 @@
-<!-- deno-fmt-ignore-file -->
-Federation
-==========
-Supported federation protocols and standards
---------------------------------------------
- -  [ActivityPub] (S2S)
- -  [WebFinger]
- -  [HTTP Message Signatures] (RFC 9421)
- -  [HTTP Signatures] (draft-cavage-http-signatures-12)
- -  [Linked Data Signatures]
- -  [NodeInfo]
-[ActivityPub]: https://www.w3.org/TR/activitypub/
-[WebFinger]: https://datatracker.ietf.org/doc/html/rfc7033
-[HTTP Message Signatures]: https://www.rfc-editor.org/rfc/rfc9421
-[HTTP Signatures]: https://datatracker.ietf.org/doc/html/draft-cavage-http-signatures-12
-[Linked Data Signatures]: https://web.archive.org/web/20170923124140/https://w3c-dvcg.github.io/ld-signatures/
-[NodeInfo]: https://nodeinfo.diaspora.software/
-Supported FEPs
---------------
- -  [FEP-67ff][]: FEDERATION.md
- -  [FEP-8fcf][]: Followers collection synchronization across servers
- -  [FEP-f1d5][]: NodeInfo in Fediverse Software
- -  [FEP-8b32][]: Object Integrity Proofs
- -  [FEP-521a][]: Representing actor's public keys
- -  [FEP-5feb][]: Search indexing consent for actors
- -  [FEP-c7d3][]: Ownership
- -  [FEP-c0e0][]: Emoji reactions
- -  [FEP-e232][]: Object Links
-[FEP-67ff]: https://w3id.org/fep/67ff
-[FEP-8fcf]: https://w3id.org/fep/8fcf
-[FEP-f1d5]: https://w3id.org/fep/f1d5
-[FEP-8b32]: https://w3id.org/fep/8b32
-[FEP-521a]: https://w3id.org/fep/521a
-[FEP-5feb]: https://w3id.org/fep/5feb
-[FEP-c7d3]: https://w3id.org/fep/c7d3
-[FEP-c0e0]: https://w3id.org/fep/c0e0
-[FEP-e232]: https://w3id.org/fep/e232
-ActivityPub
------------
-Since Fedify is a framework, what activity types it uses is up to
-the application developers.  However, Fedify provides a set of
-activity types that are commonly used in the fediverse.  The following
-lists the activity types that Fedify provides:
- -  [`Accept`](https://jsr.io/@fedify/fedify/doc/vocab/~/Accept)
- -  [`Add`](https://jsr.io/@fedify/fedify/doc/vocab/~/Add)
- -  [`Announce`](https://jsr.io/@fedify/fedify/doc/vocab/~/Announce)
- -  [`Arrive`](https://jsr.io/@fedify/fedify/doc/vocab/~/Arrive)
- -  [`Block`](https://jsr.io/@fedify/fedify/doc/vocab/~/Block)
- -  [`ChatMessage`](https://jsr.io/@fedify/fedify/doc/vocab/~/ChatMessage)
- -  [`Create`](https://jsr.io/@fedify/fedify/doc/vocab/~/Create)
- -  [`Delete`](https://jsr.io/@fedify/fedify/doc/vocab/~/Delete)
- -  [`Dislike`](https://jsr.io/@fedify/fedify/doc/vocab/~/Dislike)
- -  [`EmojiReact`](https://jsr.io/@fedify/fedify/doc/vocab/~/EmojiReact)
- -  [`Flag`](https://jsr.io/@fedify/fedify/doc/vocab/~/Flag)
- -  [`Follow`](https://jsr.io/@fedify/fedify/doc/vocab/~/Follow)
- -  [`Ignore`](https://jsr.io/@fedify/fedify/doc/vocab/~/Ignore)
- -  [`Invite`](https://jsr.io/@fedify/fedify/doc/vocab/~/Invite)
- -  [`Join`](https://jsr.io/@fedify/fedify/doc/vocab/~/Join)
- -  [`Leave`](https://jsr.io/@fedify/fedify/doc/vocab/~/Leave)
- -  [`Like`](https://jsr.io/@fedify/fedify/doc/vocab/~/Like)
- -  [`Listen`](https://jsr.io/@fedify/fedify/doc/vocab/~/Listen)
- -  [`Move`](https://jsr.io/@fedify/fedify/doc/vocab/~/Move)
- -  [`Offer`](https://jsr.io/@fedify/fedify/doc/vocab/~/Offer)
- -  [`Question`](https://jsr.io/@fedify/fedify/doc/vocab/~/Question)
- -  [`Read`](https://jsr.io/@fedify/fedify/doc/vocab/~/Read)
- -  [`Reject`](https://jsr.io/@fedify/fedify/doc/vocab/~/Reject)
- -  [`Remove`](https://jsr.io/@fedify/fedify/doc/vocab/~/Remove)
- -  [`TentativeAccept`](https://jsr.io/@fedify/fedify/doc/vocab/~/TentativeAccept)
- -  [`TentativeReject`](https://jsr.io/@fedify/fedify/doc/vocab/~/TentativeReject)
- -  [`Travel`](https://jsr.io/@fedify/fedify/doc/vocab/~/Travel)
- -  [`Undo`](https://jsr.io/@fedify/fedify/doc/vocab/~/Undo)
- -  [`Update`](https://jsr.io/@fedify/fedify/doc/vocab/~/Update)
- -  [`View`](https://jsr.io/@fedify/fedify/doc/vocab/~/View)

package/LICENSE DELETED Viewed

@@ -1,20 +0,0 @@
-MIT License
-Copyright 2024–2025 Hong Minhee
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
-the Software, and to permit persons to whom the Software is furnished to do so,
-subject to the following conditions:
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/SECURITY.md DELETED Viewed

@@ -1,22 +0,0 @@
-<!-- deno-fmt-ignore-file -->
-Security policy
-===============
-Supported versions
-------------------
-We support the latest two minor versions of the library. For example, if the
-latest version is 0.12.0, we support 0.12.x and 0.11.x.
-Reporting a vulnerability
--------------------------
-If you think you have found a security issue, please *do not* open a public
-issue.  Instead, please open a private vulnerability report by [creating a new
-draft security advisory][1].
-We will review your report and respond within 48 hours.
-[1]: https://github.com/fedify-dev/fedify/security/advisories/new

package/SPONSORS.md DELETED Viewed

@@ -1,47 +0,0 @@
-Sponsors of Fedify
-==================
-This project exists thanks to all the people who contribute, donate, and sponsor
-it.  We are grateful for their support.  We would like to thank the following
-financial contributors:[^1]
-[^1]: Those lists are automatically updated every hour.
-<!-- cSpell: disable -->
-<!-- DO NOT EDIT(h2): this section is automatically generated by the script -->
-Corporate sponsors
-------------------
-- [<img src="https://images.opencollective.com/ghost/avatar/128.png" width="64" height="64"> Ghost](https://ghost.org)
-Supporters
-----------
-- [Daniel Supernault](https://pixelfed.org/)
-- [tkgka](https://opencollective.com/tkgka)
-- [Blaine](https://opencollective.com/blaine)
-- [Erick González Aguilar](https://opencollective.com/erick-gonzalez-aguilar)
-Backers
--------
-Robin Riley, yamanoku, Encyclia, taye, okin, Andy Piper, box464, Evan Prodromou, Rafael Goulart, malte
-One-time donations
-------------------
-Robin Riley, Markus P, Nils Bergmann, Rameez
-<!-- /DO NOT EDIT -->
-<!-- cSpell: enable -->
-Become a sponsor
-----------------
-We welcome financial contributions to help us maintain and improve this project.
-If you would like to become a financial contributor, please visit our
-[Open Collective].
-[Open Collective]: https://opencollective.com/fedify

package/esm/_dnt.polyfills.js DELETED Viewed

@@ -1,15 +0,0 @@
-// https://github.com/tc39/proposal-accessible-object-hasownproperty/blob/main/polyfill.js
-if (!Object.hasOwn) {
-    Object.defineProperty(Object, "hasOwn", {
-        value: function (object, property) {
-            if (object == null) {
-                throw new TypeError("Cannot convert undefined or null to object");
-            }
-            return Object.prototype.hasOwnProperty.call(Object(object), property);
-        },
-        configurable: true,
-        enumerable: false,
-        writable: true,
-    });
-}
-export {};

package/esm/_dnt.shims.js DELETED Viewed

@@ -1,70 +0,0 @@
-import { Deno } from "@deno/shim-deno";
-export { Deno } from "@deno/shim-deno";
-import { crypto } from "@deno/shim-crypto";
-export { crypto } from "@deno/shim-crypto";
-import { URLPattern as URLPattern } from "urlpattern-polyfill";
-export { URLPattern as URLPattern } from "urlpattern-polyfill";
-import { Temporal as Temporal } from "@js-temporal/polyfill";
-export { Temporal as Temporal } from "@js-temporal/polyfill";
-const dntGlobals = {
-    Deno,
-    crypto,
-    URLPattern,
-    Temporal,
-};
-export const dntGlobalThis = createMergeProxy(globalThis, dntGlobals);
-function createMergeProxy(baseObj, extObj) {
-    return new Proxy(baseObj, {
-        get(_target, prop, _receiver) {
-            if (prop in extObj) {
-                return extObj[prop];
-            }
-            else {
-                return baseObj[prop];
-            }
-        },
-        set(_target, prop, value) {
-            if (prop in extObj) {
-                delete extObj[prop];
-            }
-            baseObj[prop] = value;
-            return true;
-        },
-        deleteProperty(_target, prop) {
-            let success = false;
-            if (prop in extObj) {
-                delete extObj[prop];
-                success = true;
-            }
-            if (prop in baseObj) {
-                delete baseObj[prop];
-                success = true;
-            }
-            return success;
-        },
-        ownKeys(_target) {
-            const baseKeys = Reflect.ownKeys(baseObj);
-            const extKeys = Reflect.ownKeys(extObj);
-            const extKeysSet = new Set(extKeys);
-            return [...baseKeys.filter((k) => !extKeysSet.has(k)), ...extKeys];
-        },
-        defineProperty(_target, prop, desc) {
-            if (prop in extObj) {
-                delete extObj[prop];
-            }
-            Reflect.defineProperty(baseObj, prop, desc);
-            return true;
-        },
-        getOwnPropertyDescriptor(_target, prop) {
-            if (prop in extObj) {
-                return Reflect.getOwnPropertyDescriptor(extObj, prop);
-            }
-            else {
-                return Reflect.getOwnPropertyDescriptor(baseObj, prop);
-            }
-        },
-        has(_target, prop) {
-            return prop in extObj || prop in baseObj;
-        },
-    });
-}

package/esm/compat/mod.js DELETED Viewed

@@ -1,3 +0,0 @@
-import "../_dnt.polyfills.js";
-export * from "./transformers.js";
-export * from "./types.js";

package/esm/compat/transformers.js DELETED Viewed

@@ -1,95 +0,0 @@
-import * as dntShim from "../_dnt.shims.js";
-import { getLogger } from "@logtape/logtape";
-const logger = getLogger(["fedify", "compat", "transformers"]);
-/**
- * An activity transformer that assigns a new random ID to an activity if it
- * does not already have one.  This is useful for ensuring that activities
- * have an ID before they are sent to other servers.
- *
- * The generated ID is an origin URI with a fragment which contains an activity
- * type name with a random UUID:
- *
- * ```
- * https://example.com/#Follow/12345678-1234-5678-1234-567812345678
- * ```
- *
- * @typeParam TContextData The type of the context data.
- * @param activity The activity to assign an ID to.
- * @param context The context of the activity.
- * @return The activity with an ID assigned.
- * @since 1.4.0
- */
-export function autoIdAssigner(activity, context) {
-    if (activity.id != null)
-        return activity;
-    const id = new URL(`/#${activity.constructor.name}/${dntShim.crypto.randomUUID()}`, context.origin);
-    logger.warn("As the activity to send does not have an id, a new id {id} has " +
-        "been generated for it.  However, it is recommended to explicitly " +
-        "set the id for the activity.", { id: id.href });
-    return activity.clone({ id });
-}
-/**
- * An activity transformer that dehydrates the actor property of an activity
- * so that it only contains the actor's URI.  For example, suppose we have an
- * activity like this:
- *
- * ```typescript
- * import { Follow, Person } from "@fedify/fedify/vocab";
- * const input = new Follow({
- *   id: new URL("http://example.com/activities/1"),
- *   actor: new Person({
- *     id: new URL("http://example.com/actors/1"),
- *     name: "Alice",
- *     preferredUsername: "alice",
- *   }),
- *   object: new Person({
- *     id: new URL("http://example.com/actors/2"),
- *     name: "Bob",
- *     preferredUsername: "bob",
- *   }),
- * });
- * ```
- *
- * The result of applying this transformer would be:
- *
- * ```typescript
- * import { Follow, Person } from "@fedify/fedify/vocab";
- * const output = new Follow({
- *   id: new URL("http://example.com/activities/1"),
- *   actor: new URL("http://example.com/actors/1"),
- *   object: new Person({
- *     id: new URL("http://example.com/actors/2"),
- *     name: "Bob",
- *     preferredUsername: "bob",
- *   }),
- * });
- * ```
- *
- * As some ActivityPub implementations like Threads fail to deal with inlined
- * actor objects, this transformer can be used to work around this issue.
- * @typeParam TContextData The type of the context data.
- * @param activity The activity to dehydrate the actor property of.
- * @param context The context of the activity.
- * @returns The dehydrated activity.
- * @since 1.4.0
- */
-export function actorDehydrator(activity, _context) {
-    if (activity.actorIds.length < 1)
-        return activity;
-    return activity.clone({
-        actors: activity.actorIds,
-    });
-}
-/**
- * Gets the default activity transformers that are applied to all outgoing
- * activities.
- * @typeParam TContextData The type of the context data.
- * @returns The default activity transformers.
- * @since 1.4.0
- */
-export function getDefaultActivityTransformers() {
-    return [
-        autoIdAssigner,
-        actorDehydrator,
-    ];
-}

package/esm/compat/types.js DELETED Viewed

	@@ -1 +0,0 @@
1	- export {};