Merge pull request #549 from dahlia/main

Add backward compatibility for @fedify/fedify/vocab module

Author: dahlia

CHANGES.md

@@ -90,6 +90,12 @@ To be released.
      -  Removed `@fedify/fedify/x/sveltekit` in favor of `@fedify/sveltekit`.
      -  Removed `@fedify/fedify/x/fresh` (Fresh integration). [[#466]]
 
+ -  Deprecated the `@fedify/fedify/vocab` module in favor of the new
+    `@fedify/vocab` package.  The `@fedify/fedify/vocab` module now re-exports
+    all exports from `@fedify/vocab` for backward compatibility, but will be
+    removed in a future version.  Please migrate to `@fedify/vocab` directly.
+    [[#437], [#517] by ChanHaeng Lee]
+
  -  The `KvStore.list()` method is now required instead of optional.
     This method was added as optional in version 1.10.0 to give existing
     implementations time to add support.  All official `KvStore` implementations
@@ -119,13 +125,15 @@ To be released.
 [#393]: https://github.com/fedify-dev/fedify/pulls/393
 [#433]: https://github.com/fedify-dev/fedify/pull/433
 [#434]: https://github.com/fedify-dev/fedify/pull/434
+[#437]: https://github.com/fedify-dev/fedify/issues/437
 [#441]: https://github.com/fedify-dev/fedify/issues/441
 [#444]: https://github.com/fedify-dev/fedify/issues/444
 [#445]: https://github.com/fedify-dev/fedify/pull/445
 [#451]: https://github.com/fedify-dev/fedify/pull/451
 [#466]: https://github.com/fedify-dev/fedify/issues/466
 [#499]: https://github.com/fedify-dev/fedify/issues/499
 [#506]: https://github.com/fedify-dev/fedify/pull/506
+[#517]: https://github.com/fedify-dev/fedify/pull/517
 [#536]: https://github.com/fedify-dev/fedify/issues/536
 [#538]: https://github.com/fedify-dev/fedify/issues/538
 [#540]: https://github.com/fedify-dev/fedify/pull/540
@@ -283,18 +291,16 @@ To be released.
     including parsing and generating WebFinger documents.
     [[#517] by ChanHaeng Lee]
 
-[#517]: https://github.com/fedify-dev/fedify/pull/517
-
 ### @fedify/vocab
 
  -  Created ActivityPub Vocabulary API package as the *@fedify/vocab* package.
     This package contains the generated Activity Vocabulary classes and
     related types, separated from the main *@fedify/fedify* package to
     improve modularity and enable custom vocabulary extensions.
+    The previous `@fedify/fedify/vocab` module is now deprecated and
+    re-exports all exports from this package for backward compatibility.
     [[#437], [#517] by ChanHaeng Lee]
 
-[#437]: https://github.com/fedify-dev/fedify/issues/437
-
 ### @fedify/sqlite
 
  -  Added `SqliteMessageQueue` class implementing `MessageQueue` interface

packages/fedify/deno.json

@@ -9,7 +9,8 @@
     "./nodeinfo": "./src/nodeinfo/mod.ts",
     "./otel": "./src/otel/mod.ts",
     "./sig": "./src/sig/mod.ts",
-    "./utils": "./src/utils/mod.ts"
+    "./utils": "./src/utils/mod.ts",
+    "./vocab": "./src/vocab/mod.ts"
   },
   "imports": {
     "@multiformats/base-x": "npm:@multiformats/base-x@^4.0.1",

packages/fedify/package.json

@@ -107,6 +107,16 @@
       "import": "./dist/utils/mod.js",
       "require": "./dist/utils/mod.cjs",
       "default": "./dist/utils/mod.js"
+    },
+    "./vocab": {
+      "types": {
+        "import": "./dist/vocab/mod.d.ts",
+        "require": "./dist/vocab/mod.d.cts",
+        "default": "./dist/vocab/mod.d.ts"
+      },
+      "import": "./dist/vocab/mod.js",
+      "require": "./dist/vocab/mod.cjs",
+      "default": "./dist/vocab/mod.js"
     }
   },
   "dependencies": {

packages/fedify/src/vocab/mod.ts

@@ -0,0 +1,13 @@
+/**
+ * A set of type-safe object mappings for the [Activity
+ * Vocabulary](https://www.w3.org/TR/activitystreams-vocabulary/).
+ *
+ * @deprecated This module has been moved to the `@fedify/vocab` package.
+ *             Please use `@fedify/vocab` instead of `@fedify/fedify/vocab`.
+ *             This module will be removed in a future version.
+ *             See {@link https://github.com/fedify-dev/fedify/issues/437}
+ *             and {@link https://github.com/fedify-dev/fedify/pull/517}
+ *             for more details.
+ * @module
+ */
+export * from "@fedify/vocab";

packages/fedify/tsdown.config.ts

@@ -12,6 +12,7 @@ export default [
       "./src/otel/mod.ts",
       "./src/utils/mod.ts",
       "./src/sig/mod.ts",
+      "./src/vocab/mod.ts",
     ],
     dts: true,
     format: ["esm", "cjs"],