\n\nA plugin for [Strapi Headless CMS](https://github.com/strapi/strapi) that provides flexible & configurable reactions experience to any Content Types.\n\n### Table of Contents\n\n1. [π Versions](#-versions)\n2. [β¨ Features](#-features)\n3. [β³ Installation](#-installation)\n4. [π Requirements](#-requirements)\n5. [π§ Basic configuration](#-configuration)\n6. [π§ GraphQL Configuration](#-gql-configuration)\n7. [πΈοΈ Public API - REST](#%EF%B8%8F-public-rest-api-specification)\n8. [πΈοΈ Public API - GraphQL](#%EF%B8%8F-public-graphql-api-specification)\n9. [π Enrich service for Strapi extensions](#-enrich-service-for-strapi-extensions)\n10. [π¬ FAQ](#-faq)\n11. [π€ Contributing](#-contributing)\n12. [π¨βπ» Community support](#-community-support)\n\n## π Versions\n- **Strapi v5** - (current) [v2.x](https://github.com/VirtusLab-Open-Source/strapi-plugin-reactions)\n- **Strapi v4** - [v1.x](https://github.com/VirtusLab-Open-Source/strapi-plugin-reactions/tree/strapi-v4)\n\n## β¨ Features\n\n- **Public REST & GraphQL API:** Listing, setting, unsetting, toggling and much more via *REST* or *GraphQL* API. Easy to integrate with.\n- **Any Content Type relation:** Reactions can be used to any of your Content Types without any special configuration.\n- **Emoji & Image reactions:** You can define reaction types using predefined set of [Emoji](https://github.com/ealush/emoji-picker-react) or use your own.\n- **Content Manager Injection Zone:** Making use of Strapi built-in batteries like *Injection Zones* to provide you highers user experience. Visual representation of reactions counter for any Content Types - useful!\n- **Developer Experience boosted:** A dedicated *Enrich* service provided to let you extend your Content API controllers by a single line to get reactions per each!\n\n**Request a feature by [raising an issue](https://github.com/VirtusLab-Open-Source/strapi-plugin-reactions/issues/new).**\n\n## β³ Installation\n\n### Prerequisites\n\n#### Database connection update\n\nBecause of Emoji usage, you will need (or maybe you already did it because of earlier requirements) to extend the database connection section in your Strapi project configuration.\n\n```ts\n// config/database.ts\n// config//database.ts\n\nconnection: {\n charset: 'utf8mb4',\n collation: 'utf8mb4_unicode_ci',\n // your database credentials\n}\n```\n\nBased on this specific charset, your emoji reactions are going to be saved in the database like a charm. See the [reference issue](https://github.com/strapi/strapi/issues/10676#issuecomment-1642204275) raised on Strapi repository.\n\n### Via command line\n\n(Use **yarn** to install this plugin within your Strapi project (recommended). [Install yarn with these docs](https://yarnpkg.com/lang/en/docs/install/).)\n\n```bash\nyarn add strapi-plugin-reactions@latest\n```\n\nAfter successful installation you've to re-build your Strapi instance. To archive that simply use:\n\n```bash\nyarn build\nyarn develop\n```\n\nor just run Strapi in the development mode with `--watch-admin` option:\n\n```bash\nyarn develop --watch-admin\n```\n\nThe **Reactions** plugin should appear in the **Settings** section of Strapi after you run app again.\n\nAs a next step you must configure your the plugin by adding types of reactions you want to use. See [**Configuration**](#π§-configuration) section.\n\nAll done. Enjoy π\n\n## π Requirements\n\nComplete installation requirements are exact same as for Strapi itself and can be found in the documentation under [Installation Requirements](https://docs.strapi.io/developer-docs/latest/getting-started/introduction.html).\n\n**Minimum environment requirements**\n\n- Node.js `>=18.0.0 <=20.x.x`\n- NPM `>=6.x.x`\n\nIn our minimum support we're following [official Node.js releases timelines](https://nodejs.org/en/about/releases/).\n\n**Supported Strapi versions**:\n\n- Strapi v5.10.3 (recently tested)\n- Strapi v5.x\n\n**Plugin dependencies**\n- `@strapi/plugin-graphql` - required to run because built-in support for GraphQL handled by this plugin \n\n**We recommend always using the latest version of Strapi to start your new projects**.\n\n## π§ Configuration\n\nTo start your journey with **Reactions plugin** you must first setup types of reactions using the dedicated Settings page.\n\nThere is no need to provide any specific changed in the plugin configuration files extept enabling it.\n\n```ts\nexport default () => ({\n //...\n reactions: {\n enabled: true,\n config: {\n gql: {...},\n },\n },\n //...\n});\n```\n### Properties\n- `gql` - If you're using GraphQL that's the right place to put all necessary settings. More **[ here ](#gql-configuration)**\n\n## π§ GQL Configuration\nUsing reactions with GraphQL requires both plugins to be installed and working. You can find installation guide for GraphQL plugin **[here](https://docs.strapi.io/developer-docs/latest/plugins/graphql.html#graphql)**. To properly configure GQL to work with reactions you should provide `gql` prop. This should contain union types that will be used to define GQL response format for your data while fetching:\n\n> **Important!**\n> If you're using `config/plugins.{js,ts}` to configure your plugins , please put `reactions` property before `graphql`. Otherwise types are not going to be properly added to GraphQL Schema. That's because of dynamic types which base on plugin configuration which are added on `bootstrap` stage, not `register`. This is not valid if you're using `graphql` plugin without any custom configuration, so most of cases in real.\n\n```gql\nrelated: ReactionRelated\n```\n\nThis prop should look as follows: \n\n```ts\ngql: {\n reactionRelated: [''],\n},\n```\n\nfor example: \n\n```ts\ngql: {\n reactionRelated: ['Page', 'BlogPost'],\n},\n```\nwhere `Page` and `BlogPost` are your type names for the **Content Types** you're using reactions with. \n\n## π€ RBAC\n\nPlugin provides granular permissions based on Strapi RBAC functionality.\n\n### Mandatory permissions\n\nFor any role different than **Super Admin**, to access the **Reactions settings** you must set following permissions:\n\n- _Plugins_ -> _Reactions_ -> _Reactions: Read_ - gives you the basic read access to **Reactions settings**\n- _Plugins_ -> _Reactions_ -> _Reactions: Change_ - you're able to change the configuration of plugin\n- _Plugins_ -> _Reactions_ -> _Reactions: Admin_ - you're able to perform administrator action in the global scope of a plugin\n\n\n## Data models\n\n### Reaction kind / type\n```json\n{\n \"documentId\": \"njx99iv4p4txuqp307ye8625\",\n \"name\": \"Like\",\n \"slug\": \"like\",\n \"emoji\": \"π\",\n \"emojiFallbackUrl\": \"https://cdn.jsdelivr.net/npm/emoji-datasource-apple/img/apple/64/1f44d.png\",\n \"createdAt\": \"2023-09-14T20:13:01.649Z\",\n \"updatedAt\": \"2023-09-14T20:13:01.670Z\",\n \"icon\": null\n}\n```\n\n### Reaction\n\n```json\n{\n \"documentId\": \"njx99iv4p4txuqp307ye8625\",\n \"kind\": { // Type of reaction, not provided when listing by exact kind\n \"documentId\": \"njx99iv4p4txuqp307ye8625\",\n \"slug\": \"like\",\n \"name\": \"Like\" \n },\n \"user\": { // User who trigger reaction, not provided when listing by exact user\n \"documentId\": \"njx99iv4p4txuqp307ye8625\",\n \"username\": \"Joe Doe\",\n \"email\": \"jdoe@sample.com\",\n },\n \"userId\": \"32\", // Custom User ID provided if X-Reactions-Author header passed\n \"createdAt\": \"2023-09-14T20:13:01.649Z\",\n \"updatedAt\": \"2023-09-14T20:13:01.670Z\",\n}\n```\n\n## πΈοΈ Public REST API specification\n\n### Get reaction kinds / types\n\n_GraphQL equivalent: [Public GraphQL API -> Get reaction kinds / types](#get-reaction-kinds--types-1)_\n\n`GET /api/reactions/kinds`\n\nReturn a list of available reaction kinds to use on the end user interface and expose for interaction with users.\n\n**Example URL**: `https://localhost:1337/api/reactions/kinds`\n\n**Example response body**\n\n```json\n[\n {\n \"documentId\": \"njx99iv4p4txuqp307ye8625\",\n \"name\": \"Like\",\n \"slug\": \"like\",\n \"emoji\": \"π\",\n \"emojiFallbackUrl\": \"https://cdn.jsdelivr.net/npm/emoji-datasource-apple/img/apple/64/1f44d.png\",\n \"createdAt\": \"2023-09-14T20:13:01.649Z\",\n \"updatedAt\": \"2023-09-14T20:13:01.670Z\",\n \"icon\": null\n },\n // ...\n]\n```\n\n### List all reactions associated with Content Type\n\n_GraphQL equivalent: [Public GraphQL API -> List all reactions associated with Content Type](#list-all-reactions-associated-with-content-type-1)_\n\n`GET /api/reactions/list/single/?locale=`\n`GET /api/reactions/list/collection//?locale=`\n\nReturn all reactions associated with provided Collection / Single Type UID and Content Type Document ID with following combinations:\n- all - if you're not providing the user context via `Authorization` header\n- all related with Strapi user - if call is done with user context via `Authorization` header\n- all related with non-Strapi user - if call is done with user ID via `X-Reactions-Author` header\n\n**Example URL**: `https://localhost:1337/api/reactions/list/single/api::homepage.homepage?locale=en`\n**Example URL**: `https://localhost:1337/api/reactions/list/collection/api::post.post/njx99iv4p4txuqp307ye8625?locale=en`\n\n**Example response body**\n\n```json\n[\n {\n \"documentId\": \"njx99iv4p4txuqp307ye8625\",\n \"createdAt\": \"2023-09-14T20:13:01.649Z\",\n \"updatedAt\": \"2023-09-14T20:13:01.670Z\",\n \"kind\":{\n \"documentId\": \"njx99iv4p4txuqp307ye8625\",\n \"slug\": \"like\",\n \"name\": \"Like\"\n },\n \"user\":{ // Added if Strapi user context provided to identify who made such reaction\n \"documentId\": \"njx99iv4p4txuqp307ye8625\",\n \"username\": \"mziarko+1@virtuslab.com\",\n \"email\": \"mziarko+1@virtuslab.com\"\n },\n \"userId\": 17 // Added if non-Strapi user context provided to identify who made such reaction\n },\n // ...\n]\n```\n\n### List all reactions associated with particular user\n\n_GraphQL equivalent: [Public GraphQL API -> List all reactions associated with particular user](#list-all-reactions-associated-with-particular-user-1)_\n\n`GET /api/reactions/list/user`\n`GET /api/reactions/list/user/`\n\nReturn all reactions associated with provided user:\n- for logged in user - if call is done with user context via `Authorization` header\n- for specific Strapi user ID - if you're not providing the user context via `Authorization` header and you're providing the user context via `user-id` url param\n- for specific non-Strapi user ID - if you're not providing the user context via `Authorization` header and you're providing the user context via `X-Reactions-Author` header\n\n**Example URL**: `https://localhost:1337/api/reactions/list/user`\n**Example URL**: `https://localhost:1337/api/reactions/list/user/1`\n\n**Example response body**\n\n```json\n[\n {\n \"documentId\": \"njx99iv4p4txuqp307ye8625\",\n \"createdAt\": \"2023-09-14T20:13:01.649Z\",\n \"updatedAt\": \"2023-09-14T20:13:01.670Z\",\n \"kind\":{\n \"slug\": \"like\",\n \"name\": \"Like\"\n },\n \"related\":{\n \"documentId\": \"njx99iv4p4txuqp307ye8625\",\n \"id\": 1,\n \"locale\": \"en\",\n //...\n }\n },\n // ...\n]\n```\n\n### List all reactions of kind / type associated with Content Type\n\n_GraphQL equivalent: [Public GraphQL API -> List all reactions of kind / type associated with Content Type](#list-all-reactions-of-kind--type-associated-with-content-type-1)_\n\n`GET /api/reactions/list//single/?locale=`\n`GET /api/reactions/list//collection//?locale=`\n\nReturn all reactions of specific kind / type associated with provided Collection / Single Type UID and Content Type Document ID with following combinations:\n- all - if you're not providing the user context via `Authorization` header\n- all related with Strapi user - if call is done with user context via `Authorization` header\n- all related with non-Strapi user - if call is done with user ID via `X-Reactions-Author` header\n\n**Example URL**: `https://localhost:1337/api/reactions/list/like/single/api::homepage.homepage?locale=en`\n**Example URL**: `https://localhost:1337/api/reactions/list/like/collection/api::post.post/njx99iv4p4txuqp307ye8625?locale=en`\n\n**Example response body**\n\n```json\n[\n {\n \"documentId\": \"njx99iv4p4txuqp307ye8625\",\n \"createdAt\": \"2023-09-14T20:13:01.649Z\",\n \"updatedAt\": \"2023-09-14T20:13:01.670Z\",\n \"user\":{ // Added if Strapi user context provided to identify who made such reaction\n \"documentId\": \"njx99iv4p4txuqp307ye8625\",\n \"username\": \"mziarko+1@virtuslab.com\",\n \"email\": \"mziarko+1@virtuslab.com\"\n }\n },\n \"userId\": 17 // Added if non-Strapi user context provided to identify who made such reaction\n // ...\n]\n```\n\n### List all reactions of kind associated with particular user\n\n_GraphQL equivalent: [Public GraphQL API -> List all reactions of kind associated with particular user](#list-all-reactions-of-kind-associated-with-particular-user-1)_\n\n`GET /api/reactions/list//user`\n`GET /api/reactions/list//user/`\n\nReturn all reactions of specific kind associated with provided user:\n- for logged in user - if call is done with user context via `Authorization` header\n- for specific Strapi user ID - if you're not providing the user context via `Authorization` header and you're providing the user context via `user-id` url param\n- for specific non-Strapi user ID - if you're not providing the user context via `Authorization` header and you're providing the user context via `X-Reactions-Author` header\n\n**Example URL**: `https://localhost:1337/api/reactions/list/like/user`\n**Example URL**: `https://localhost:1337/api/reactions/list/like/user/1`\n\n**Example response body**\n\n```json\n[\n {\n \"documentId\": \"njx99iv4p4txuqp307ye8625\",\n \"createdAt\": \"2023-09-14T20:13:01.649Z\",\n \"updatedAt\": \"2023-09-14T20:13:01.670Z\",\n \"kind\":{\n \"slug\": \"like\",\n \"name\": \"Like\"\n },\n \"related\":{\n \"documentId\": \"njx99iv4p4txuqp307ye8625\",\n \"id\": 1,\n \"locale\": \"en\",\n //...\n }\n },\n // ...\n]\n```\n\n### Set reaction for Content Type\n\n_GraphQL equivalent: [Public GraphQL API -> Set reaction for Content Type](#set-reaction-for-content-type-1)_\n\n`POST /api/reactions/set//single/?locale=`\n`POST /api/reactions/set//collection//?locale=`\n\nCreate reaction of specific kind / type associated with provided Collection / Single Type UID and Content Type Document ID.\n\nTo identify the reaction author, you must provide **one** of the following headers:\n\n- `Authorization` β use this header if you want to set a reaction for a Strapi user.\n- `X-Reactions-Author` β use this header if you want to set a reaction for a non-Strapi user. The value can be any identifier that uniquely distinguishes the reaction author in your system.\n\n**Example URL**: `https://localhost:1337/api/reactions/set/like/single/api::homepage.homepage?locale=en`\n**Example URL**: `https://localhost:1337/api/reactions/set/like/collection/api::post.post/njx99iv4p4txuqp307ye8625?locale=en`\n\n**Example response body**\n\n```json\n{\n \"documentId\": \"njx99iv4p4txuqp307ye8625\",\n \"createdAt\": \"2023-09-14T20:13:01.649Z\",\n \"updatedAt\": \"2023-09-14T20:13:01.670Z\",\n \"relatedUid\": \"api::post.post:njx99iv4p4txuqp307ye8625\"\n}\n```\n\n### Unset reaction for Content Type\n\n_GraphQL equivalent: [Public GraphQL API -> Unset reaction for Content Type](#unset-reaction-for-content-type-1)_\n\n`DELETE /api/reactions/unset//single/?locale=`\n`DELETE /api/reactions/unset//collection//?locale=`\n\nDelete reaction of specific kind / type associated with provided Collection / Single Type UID and Content Type Document ID.\n\nTo identify the reaction author, you must provide **one** of the following headers:\n\n- `Authorization` β use this header if you want to set a reaction for a Strapi user.\n- `X-Reactions-Author` β use this header if you want to set a reaction for a non-Strapi user. The value can be any identifier that uniquely distinguishes the reaction author in your system.\n\n**Example URL**: `https://localhost:1337/api/reactions/unset/like/single/api::homepage.homepage?locale=en`\n**Example URL**: `https://localhost:1337/api/reactions/unset/like/collection/api::post.post/njx99iv4p4txuqp307ye8625?locale=en`\n\n**Example response body**\n\n```json\ntrue\n```\n\n### Toggle reaction for Content Type\n\n_GraphQL equivalent: [Public GraphQL API -> Toggle reaction for Content Type](#toggle-reaction-for-content-type-1)_\n\n`POST /api/reactions/toggle//single/?locale=`\n`POST /api/reactions/toggle//collection//?locale=`\n\nToggle reaction of specific kind / type associated with provided Collection / Single Type UID and Content Type Document ID.\n\nTo identify the reaction author, you must provide **one** of the following headers:\n\n- `Authorization` β use this header if you want to set a reaction for a Strapi user.\n- `X-Reactions-Author` β use this header if you want to set a reaction for a non-Strapi user. The value can be any identifier that uniquely distinguishes the reaction author in your system.\n\n**Example URL**: `https://localhost:1337/api/reactions/toggle/like/single/api::homepage.homepage?locale=en`\n**Example URL**: `https://localhost:1337/api/reactions/toggle/like/collection/api::post.post/njx99iv4p4txuqp307ye8625?locale=en`\n\n**Example response body**\n\n```json\n{\n \"documentId\": \"njx99iv4p4txuqp307ye8625\",\n \"createdAt\": \"2023-09-14T20:13:01.649Z\",\n \"updatedAt\": \"2023-09-14T20:13:01.670Z\",\n \"relatedUid\": \"api::post.post:njx99iv4p4txuqp307ye8625\"\n}\n\n// or\n\ntrue\n```\n\n### Possible scenarios\n1. No reaction set yet - Calling `toggle` for a reaction sets that reaction.\n2. Same reaction already set - Calling `toggle` for a reaction that is already set will **unset** it (result: no reaction).\n3. Different reaction already set - If another reaction is set, calling `toggle` for a new reaction will **switch** to that reaction: the specified reaction becomes set, and any previously set reactions of that type are unset.\n\n## πΈοΈ Public GraphQL API specification\n\n**Testing**\n\n> To test all queries and understand the schemas use GraphQL Playground exposed by `@strapi/plugin-graphql` on `http://localhost:1337/graphql`\n\n### Get reaction kinds / types\n\n_REST API equivalent: [Public REST API -> Get reaction kinds / types](#get-reaction-kinds--types)_\n\nReturn a list of available reaction kinds to use on the end user interface and expose for interaction with users.\n\n**Example request**\n\n```graphql\nquery {\n reactionKinds {\n slug\n name\n emoji\n icon {\n url\n }\n }\n}\n```\n\n**Example response body**\n\n```json\n{\n \"data\": {\n \"reactionKinds\": [\n {\n \"slug\": \"like\",\n \"name\": \"Like\",\n \"emoji\": \"π\",\n \"icon\": null\n }\n ]\n }\n}\n```\n\n### List all reactions associated with Content Type\n\n_REST API equivalent: [Public REST API -> List all reactions associated with Content Type](#list-all-reactions-associated-with-content-type)_\n\nReturn all reactions associated with provided Collection / Single Type UID and Content Type Document ID with following combinations:\n- Query `reactionsList` β returns all reactions for the specified document. No `Authorization` header is required (public access).\n- Query `reactionsListPerUser` β returns reactions added by a specific author. One of the following headers is required:\n - `Authorization` β to fetch reactions for a Strapi user.\n - `X-Reactions-Author` β to fetch reactions for a non-Strapi user, identified by any custom author ID.\n\n**Example request**\n\n```graphql\nquery {\n reactionsList(uid: \"api::post.post\", documentId: \"njx99iv4p4txuqp307ye8625\", locale: \"en\") {\n documentId\n kind {\n slug\n name\n emoji\n }\n user {\n email\n }\n }\n}\n```\n\n```graphql\nquery {\n reactionsListPerUser(uid: \"api::post.post\", documentId: \"njx99iv4p4txuqp307ye8625\", locale: \"en\") {\n documentId\n kind {\n slug\n name\n emoji\n }\n }\n}\n```\n\n**Example response body**\n\n```json\n{\n \"data\": {\n \"reactionsList\": [\n {\n \"documentId\": \"njx99iv4p4txuqp307ye8625\",\n \"kind\": {\n \"slug\": \"like\",\n \"name\": \"Like\",\n \"emoji\": \"π\"\n },\n \"user\": {\n \"email\": \"mziarko+1@virtuslab.com\"\n },\n \"createdAt\": \"2023-09-14T20:13:01.670Z\"\n }\n ]\n }\n}\n// --------------------------------\n{\n \"data\": {\n \"reactionsListPerUser\": [\n {\n \"documentId\": \"njx99iv4p4txuqp307ye8625\",\n \"kind\": {\n \"slug\": \"like\",\n \"name\": \"Like\",\n \"emoji\": \"π\"\n },\n \"createdAt\": \"2023-09-14T20:13:01.670Z\"\n }\n ]\n }\n}\n```\n\n### List all reactions associated with particular user\n\n_REST API equivalent: [Public REST API -> List all reactions associated with particular user](#list-all-reactions-associated-with-particular-user)_\n\nReturn all reactions associated with provided user:\n- Query `reactionsListAllPerUser` β one of the following headers is required:\n - `Authorization` β to fetch reactions for a Strapi user.\n - `X-Reactions-Author` β to fetch reactions for a non-Strapi user, identified by any custom author ID.\n\n**Example request**\n\n```graphql\nquery {\n reactionsListAllPerUser {\n documentId\n createdAt\n kind {\n slug\n }\n related {\n documentId\n id\n locale\n }\n }\n}\n```\n\n```graphql\nquery {\n reactionsListAllPerUser(userId: 1) {\n documentId\n createdAt\n kind {\n slug\n }\n related {\n documentId\n id\n locale\n }\n }\n}\n```\n\n**Example response body**\n\n```json\n{\n \"data\": {\n \"reactionsListAllPerUser\": [\n {\n \"documentId\": \"njx99iv4p4txuqp307ye8625\",\n \"createdAt\": \"2023-09-14T20:13:01.670Z\",\n \"kind\": {\n \"slug\": \"like\"\n },\n \"related\": {\n \"documentId\": \"njx99iv4p4txuqp307ye8625\",\n \"id\": 1,\n \"locale\": \"en\"\n }\n }\n ]\n }\n}\n```\n\n### List all reactions of kind / type associated with Content Type\n\n_REST API equivalent: [Public REST API -> List all reactions of kind / type associated with Content Type](#list-all-reactions-of-kind--type-associated-with-content-type)_\n\nReturn all reactions of specific kind / type associated with provided Collection / Single Type UID and Content Type Document ID with following combinations:\n- Query `reactionsList` β returns all reactions for the specified document. No `Authorization` header is required (public access).\n- Query `reactionsListPerUser` β returns reactions added by a specific author. One of the following headers is required:\n - `Authorization` β to fetch reactions for a Strapi user.\n - `X-Reactions-Author` β to fetch reactions for a non-Strapi user, identified by any custom author ID.\n\n\n**Example request**\n\n```graphql\nquery {\n reactionsList(kind: \"like\", uid: \"api::post.post\", documentId: \"njx99iv4p4txuqp307ye8625\", locale: \"en\") {\n documentId\n user {\n email\n }\n createdAt\n }\n}\n```\n\n```graphql\nquery {\n reactionsListPerUser(kind: \"like\", uid: \"api::post.post\", documentId: \"njx99iv4p4txuqp307ye8625\", locale: \"en\") {\n documentId\n createdAt\n }\n}\n```\n\n**Example response body**\n\n```json\n{\n \"data\": {\n \"reactionsList\": [\n {\n \"documentId\": \"njx99iv4p4txuqp307ye8625\",\n \"user\": {\n \"email\": \"mziarko+1@virtuslab.com\"\n },\n \"createdAt\": \"2023-09-14T20:13:01.670Z\"\n }\n ]\n }\n}\n// --------------------------------\n{\n \"data\": {\n \"reactionsListPerUser\": [\n {\n \"documentId\": \"njx99iv4p4txuqp307ye8625\",\n \"createdAt\": \"2023-09-14T20:13:01.670Z\"\n }\n ]\n }\n}\n```\n\n### List all reactions of kind associated with particular user\n\n_REST API equivalent: [Public REST API -> List all reactions of kind associated with particular user](#list-all-reactions-of-kind-associated-with-particular-user)_\n\nReturn all reactions of specific kind associated with provided user:\n- Query `reactionsListAllPerUser` β one of the following headers is required:\n - `Authorization` β to fetch reactions for a Strapi user.\n - `X-Reactions-Author` β to fetch reactions for a non-Strapi user, identified by any custom author ID.\n\n**Example request**\n\n```graphql\nquery {\n reactionsListAllPerUser(kind: \"like\") {\n documentId\n createdAt\n related {\n documentId\n id\n locale\n }\n }\n}\n```\n\n```graphql\nquery {\n reactionsListAllPerUser(kind: \"like\", userId: 1) {\n documentId\n createdAt\n related {\n documentId\n id\n locale\n }\n }\n}\n```\n\n**Example response body**\n\n```json\n{\n \"data\": {\n \"reactionsListAllPerUser\": [\n {\n \"documentId\": \"njx99iv4p4txuqp307ye8625\",\n \"createdAt\": \"2023-09-14T20:13:01.670Z\",\n \"related\": {\n \"documentId\": \"njx99iv4p4txuqp307ye8625\",\n \"id\": 1,\n \"locale\": \"en\"\n }\n }\n ]\n }\n}\n```\n\n### Set reaction for Content Type\n\n_REST API equivalent: [Public REST API -> Set reaction for Content Type](#set-reaction-for-content-type)_\n\nCreate reaction of specific kind / type associated with provided Collection / Single Type UID and Content Type Document ID.\n\nTo identify the reaction author, you must provide **one** of the following headers:\n\n- `Authorization` β use this header if you want to set a reaction for a Strapi user.\n- `X-Reactions-Author` β use this header if you want to set a reaction for a non-Strapi user. The value can be any identifier that uniquely distinguishes the reaction author in your system.\n\n**Example request**\n\n```graphql\nmutation reactionSet {\n reactionSet(\n input: {\n kind: \"like\",\n uid: \"api::post.post\",\n documentId: \"njx99iv4p4txuqp307ye8625\",\n locale: \"en\"\n }\n ) {\n documentId\n }\n}\n```\n\n**Example response body**\n\n```json\n{\n \"data\": {\n \"reactionSet\": {\n \"documentId\": \"njx99iv4p4txuqp307ye8625\"\n }\n }\n}\n```\n\n### Unset reaction for Content Type\n\n_REST API equivalent: [Public REST API -> Unset reaction for Content Type](#unset-reaction-for-content-type)_\n\nDelete reaction of specific kind / type associated with provided Collection / Single Type UID and Content Type Document ID.\n\nTo identify the reaction author, you must provide **one** of the following headers:\n\n- `Authorization` β use this header if you want to set a reaction for a Strapi user.\n- `X-Reactions-Author` β use this header if you want to set a reaction for a non-Strapi user. The value can be any identifier that uniquely distinguishes the reaction author in your system.\n\n**Example request**\n\n```graphql\nmutation reactionUnset {\n reactionUnset(\n input: {\n kind: \"like\",\n uid: \"api::post.post\",\n documentId: \"njx99iv4p4txuqp307ye8625\",\n locale: \"en\"\n }\n ) {\n documentId\n }\n}\n```\n\n**Example response body**\n\n```json\n{\n \"data\": {\n \"reactionUnset\": {\n \"documentId\": null\n }\n }\n}\n```\n\n### Toggle reaction for Content Type\n\n_REST API equivalent: [Public REST API -> Toggle reaction for Content Type](#toggle-reaction-for-content-type)_\n\nToggle reaction of specific kind / type associated with provided Collection / Single Type UID and Content Type Document ID.\n\nTo identify the reaction author, you must provide **one** of the following headers:\n\n- `Authorization` β use this header if you want to set a reaction for a Strapi user.\n- `X-Reactions-Author` β use this header if you want to set a reaction for a non-Strapi user. The value can be any identifier that uniquely distinguishes the reaction author in your system.\n\n**Example request**\n\n```graphql\nmutation reactionToggle {\n reactionToggle(\n input: {\n kind: \"like\",\n uid: \"api::post.post\",\n documentId: \"njx99iv4p4txuqp307ye8625\",\n locale: \"en\"\n }\n ) {\n documentId\n }\n}\n```\n\n**Example response body**\n\n```json\n{\n \"data\": {\n \"reactionToggle\": {\n \"documentId\": \"njx99iv4p4txuqp307ye8625\"\n }\n }\n}\n\n// or\n\n{\n \"data\": {\n \"reactionToggle\": {\n \"documentId\": null\n }\n }\n}\n```\n\n### Possible scenarios\n1. No reaction set yet - Calling `toggle` for a reaction sets that reaction.\n2. Same reaction already set - Calling `toggle` for a reaction that is already set will **unset** it (result: no reaction).\n3. Different reaction already set - If another reaction is set, calling `toggle` for a new reaction will **switch** to that reaction: the specified reaction becomes set, and any previously set reactions of that type are unset.\n\n## π Enrich service for Strapi extensions\n\n### Enrich One\n\nYou can use this service method for example in your **Strapi Content API** `findOne` method to enrich the metadata of retrieved entity by associated reactions.\n\nWhat is important, service method does not modify default `data` schema of **Strapi Content API**. All additions are made in the `meta` property in the form of:\n\n```json\n// ...\n\"meta\": {\n // ...\n \"reactions\": {\n \"\": [\n // list of reactions\n ],\n // ...\n }\n}\n```\n\n#### Example extension\n```ts\n// src/api/post/controllers/post.ts\n\n'use strict';\n\n/**\n * post controller\n */\n\nimport { factories } from '@strapi/strapi'\n\nexport default factories.createCoreController('api::post.post', ({ strapi }) => ({\n async findOne(ctx) {\n const response = await super.findOne(ctx);\n\n return strapi\n .service('plugin::reactions.enrich')\n .enrichOne('api::post.post', response);\n },\n}));\n```\n\n#### Example response\n```json\n{\n \"data\":{\n \"documentId\": \"njx99iv4p4txuqp307ye8625\",\n \"attributes\":{\n // Content type attributes \n }\n },\n \"meta\":{\n \"reactions\":{\n \"like\":[{\n \"documentId\": \"njx99iv4p4txuqp307ye8625\",\n \"createdAt\": \"2023-09-14T20:13:01.649Z\",\n \"updatedAt\": \"2023-09-14T20:13:01.670Z\",\n \"relatedUid\": \"api::post.post:2\",\n \"kind\":{\n \"documentId\": \"njx99iv4p4txuqp307ye8625\",\n \"name\": \"Like\",\n \"slug\": \"like\",\n \"emoji\": \"π\",\n \"emojiFallbackUrl\": \"https://cdn.jsdelivr.net/npm/emoji-datasource-apple/img/apple/64/1f44d.png\",\n \"icon\": null\n },\n \"user\":{\n \"documentId\": \"njx99iv4p4txuqp307ye8625\",\n \"username\": \"mziarko+1@virtuslab.com\",\n \"email\": \"mziarko+1@virtuslab.com\"\n }\n },\n // ...\n ],\n // ...\n }\n }\n}\n```\n\n### Enrich Many\n\nYou can use this service method for example in your **Strapi Content API** `find` method to enrich the metadata of retrieved entities set by associated reactions.\n\nWhat is important, service method does not modify default `data` schema of **Strapi Content API**. All additions are made in the `meta` property in the form of:\n\n```json\n// ...\n\"meta\": {\n // ...\n \"reactions\": {\n \"\": {\n \"\": [\n // list of reactions\n ],\n // ...\n }\n }\n}\n```\n\n#### Example extension\n```ts\n// src/api/post/controllers/post.ts\n\n'use strict';\n\n/**\n * post controller\n */\n\nimport { factories } from '@strapi/strapi'\n\nexport default factories.createCoreController('api::post.post', ({ strapi }) => ({\n async find(ctx) {\n const response = await super.find(ctx);\n\n return strapi\n .service('plugin::reactions.enrich')\n .enrichMany('api::post.post', response);\n },\n}));\n```\n\n#### Example response\n```json\n{\n \"data\": [{\n \"documentId\": \"njx99iv4p4txuqp307ye8625\",\n \"attributes\":{\n // Content type attributes \n }\n }, {\n \"documentId\": 2,\n \"attributes\":{\n // Content type attributes \n }\n }\n ],\n \"meta\":{\n \"reactions\":{\n \"njx99iv4p4txuqp307ye8625\": {\n \"like\":[{\n \"documentId\": \"njx99iv4p4txuqp307ye8625\",\n \"createdAt\": \"2023-09-14T20:13:01.649Z\",\n \"updatedAt\": \"2023-09-14T20:13:01.670Z\",\n \"relatedUid\": \"api::post.post:2\",\n \"kind\":{\n \"documentId\": \"njx99iv4p4txuqp307ye8625\",\n \"name\": \"Like\",\n \"slug\": \"like\",\n \"emoji\": \"π\",\n \"emojiFallbackUrl\": \"https://cdn.jsdelivr.net/npm/emoji-datasource-apple/img/apple/64/1f44d.png\",\n \"icon\": null\n },\n \"user\":{\n \"documentId\": \"njx99iv4p4txuqp307ye8625\",\n \"username\": \"mziarko+1@virtuslab.com\",\n \"email\": \"mziarko+1@virtuslab.com\"\n }\n },\n // ...\n ],\n // ...\n },\n \"2\": {}\n }\n }\n}\n```\n\n## π¬ FAQ\n\n### Import / Export\n\n**Q:** I'm exporting / moving data between environments. Will I lost all reactions?\n\n**A:** No you won't lost anything. Reactions plugin is based on real relations (Polymorphic relations) and all the data should be exported / moved and re-indexed properly on your new environment.\n\n_The only thing you might need to do after import is described below_ β¬οΈ\n\n---\n\n**Q:** I've imported data to the new instance and I'm not seeing reaction linked to my Content Types or they are wrong. What to do?\n\n**A:** Most probably after the import unique identifiers of your Content Types has changed according to the new environment. \n\nYou might need to use one of special admin actions for the Reactions plugin like **\"Synchronize associations\"**. To get access to it, you must be **Super Admin** or have assigned **Settings: Admin permission** to any of your roles. \n\nThis is *not destructive* action and it just goes through all existing Reactions and update their search key according to linked Content Type UID and ID like `api::post.post:njx99iv4p4txuqp307ye8625`.\n\n---\n\n## π€ Contributing\n\nFeel free to fork and make a Pull Request to this plugin project. All the input is warmly welcome!\n\n1. Clone repository\n\n ```\n git clone git@github.com:VirtusLab-Open-Source/strapi-plugin-reactions.git\n ```\n\n2. Run `install` & `watch:link` command\n\n ```ts\n // Install all dependencies\n yarn install\n\n // Watch for file changes using `plugin-sdk` and follow the instructions provided by this official Strapi developer tool\n yarn watch:link\n ```\n\n3. Within the Strapi project, modify `config/plugins.{js,ts}` for `imgix`\n\n```ts\n//...\n'reactions': {\n enabled: true,\n //...\n}\n//...\n```\n\n4. Run your Strapi instance\n\n## π¨βπ» Community support\n\nFor general help using Strapi, please refer to [the official Strapi documentation](https://strapi.io/documentation/). For additional help, you can use one of these channels to ask a question:\n\n- [Discord](https://discord.strapi.io/) We're present on official Strapi Discord workspace. Find us by `[VirtusLab]` prefix and DM.\n- [Slack - VirtusLab Open Source](https://virtuslab-oss.slack.com) We're present on a public channel #strapi-molecules\n- [GitHub](https://github.com/VirtusLab-Open-Source/strapi-plugin-reactions/issues) (Bug reports, Contributions, Questions and Discussions)\n- [E-mail](mailto:strapi@virtuslab.com) - we will respond back as soon as possible\n\n## π License\n\n[MIT License](LICENSE.md) Copyright (c) [VirtusLab Sp. z o.o.](https://virtuslab.com/) & [Strapi Solutions](https://strapi.io/).\n","readmeFilename":"README.md"}
![\"Logo](\"https://www.sensinum.com/img/open-source/strapi-plugin-reactions/logo.png\"){kind=logo}
\n![\"GitHub](\"https://img.shields.io/github/package-json/v/VirtusLab-Open-Source/strapi-plugin-reactions?label=npm&logo=npm\")
\n \n \n ![\"Monthly](\"https://img.shields.io/npm/dm/strapi-plugin-reactions.svg\")
\n \n \n ![\"CircleCI\"](\"https://circleci.com/gh/VirtusLab-Open-Source/strapi-plugin-reactions.svg?style=shield\")
\n \n \n ![\"codecov.io\"](\"https://codecov.io/gh/VirtusLab-Open-Source/strapi-plugin-reactions/coverage.svg\")
\n \n![\"UI](\"https://www.sensinum.com/img/open-source/strapi-plugin-reactions/preview.jpg\")
\n