feat(themes): Create user APIs for managing themes by kanikabansal08 · Pull Request #8387 · juspay/hyperswitch

kanikabansal08 · 2025-06-19T08:00:32Z

Type of Change

Description

This PR adds user APIs to manage themes. Earlier themes was being managed using Admin apis.
These are the following APIs

Create Theme
Delete Theme
Update Theme
Upload Asset
Find Theme by Theme ID
List themes by entity level
Get Theme by lineage

Added Theme resource and ThemeManage permission group
Assigned ThemeManage permission to OrganizationAdmin role

Additional Changes

This PR modifies the API contract
This PR modifies the database schema
This PR modifies application configuration/environment variables

Motivation and Context

How did you test it?

Create theme

curl --location 'http://localhost:8080/user/theme' \
--header 'Content-Type: application/json' \
--header 'cookie: login_token=••••••' \
--header 'Authorization: ••••••' \
--data '{
    "entity_type": "merchant",
    "theme_name": "Test_integ",
    "theme_data": {
        "settings": {
            "colors": {
                "primary": "#3498db",
                "sidebar": "#2ecc71"
            },
            "buttons": {
                "primary": {
                    "hoverBackgroundColor": "#27ae60"
                }
            }
        }
    }
}'

Get theme by theme ID

curl --location --request GET 'http://localhost:8080/user/theme/9e144c3e-a68c-4653-b180-5771380df699' \
--header 'cookie: login_token=••••••' \
--header 'Authorization: ••••••'

Update theme

curl --location --request PUT 'http://localhost:8080/user/theme/9e144c3e-a68c-4653-b180-5771380df699' \
--header 'cookie: login_token=••••••' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••'  \
--data '{
    "theme_data": {
        "settings": {
            "colors": {
                "primary": "#ffffff",
                "sidebar": "#2ecc71"
            },
            "buttons": {
                "primary": {
                    "hoverBackgroundColor": "#27ae60"
                }
            }
        }
    },
    "email_config": {
        "entity_name": "Merchant123",
        "entity_logo_url": "https://app.hyperswitch.io/email-assets/HyperswitchLogo.png",
        "primary_color": "#006DF9",
        "foreground_color": "#111326",
        "background_color": "#FFFFFF"
    }
}'

Upload Asset

curl --location 'http://localhost:8080/user/theme/9e144c3e-a68c-4653-b180-5771380df699' \
--header 'cookie: login_token=••••••' \
--header 'Authorization: ••••••'  \
--form 'asset_name="logo.png"' \
--form 'asset_data=@"/Users/kanika.bansal/Desktop/zurichLogo.png"'

Delete Theme

curl --location --request DELETE 'http://localhost:8080/user/theme/9e144c3e-a68c-4653-b180-5771380df699' \
--header 'cookie: login_token=••••••' \
--header 'Authorization: ••••••'

List themes by entity level

curl --location 'http://localhost:8080/user/theme/list?entity_type=organization' \
--header 'cookie: login_token=••••••' \
--header 'Authorization: ••••••'

Get theme by lineage

curl --location 'http://localhost:8080/user/theme?entity_type=merchant' \
--header 'cookie: login_token=••••••' \
--header 'Authorization: ••••••'

Response

Delete Theme and Upload Asset: 200 OK
list themes by entity level


[
        {
            "theme_id": "2bab0cbb-491b-420e-aa82-cdd02e1a890d",
            "theme_name": "Test_org",
            "entity_type": "organization",
            "tenant_id": "public",
            "org_id": "o1",
            "merchant_id": null,
            "profile_id": null,
            "email_config": {
                "entity_name": "Hyperswitch",
                "entity_logo_url": "https://app.hyperswitch.io/email-assets/HyperswitchLogo.png",
                "primary_color": "#006DF9",
                "foreground_color": "#111326",
                "background_color": "#FFFFFF"
            },
            "theme_data": {
                "settings": {
                    "colors": {
                        "primary": "#3498db",
                        "secondary": null,
                        "background": null
                    },
                    "sidebar": null,
                    "typography": null,
                    "buttons": {
                        "primary": {
                            "backgroundColor": null,
                            "textColor": null,
                            "hoverBackgroundColor": "#27ae60"
                        },
                        "secondary": null
                    },
                    "borders": null,
                    "spacing": null
                },
                "urls": null
            }
        },
        {
            "theme_id": "8ffbed01-5b65-4f7f-8323-bcb0689a2e3c",
            "theme_name": "Test_o1_m2_profile",
            "entity_type": "profile",
            "tenant_id": "public",
            "org_id": "o1",
            "merchant_id": "m1",
            "profile_id": "p1",
            "email_config": {
                "entity_name": "Hyperswitch",
                "entity_logo_url": "https://app.hyperswitch.io/email-assets/HyperswitchLogo.png",
                "primary_color": "#006DF9",
                "foreground_color": "#111326",
                "background_color": "#FFFFFF"
            },
            "theme_data": {
                "settings": {
                    "colors": {
                        "primary": "#3498db",
                        "secondary": null,
                        "background": null
                    },
                    "sidebar": null,
                    "typography": null,
                    "buttons": {
                        "primary": {
                            "backgroundColor": null,
                            "textColor": null,
                            "hoverBackgroundColor": "#27ae60"
                        },
                        "secondary": null
                    },
                    "borders": null,
                    "spacing": null
                },
                "urls": null
            }
        },
        {
            "theme_id": "9b0186c1-7ae2-412c-b91f-a5439cae5839",
            "theme_name": "Test_o1_merchant",
            "entity_type": "merchant",
            "tenant_id": "public",
            "org_id": "o1",
            "merchant_id": "m1",
            "profile_id": null,
            "email_config": {
                "entity_name": "Hyperswitch",
                "entity_logo_url": "https://app.hyperswitch.io/email-assets/HyperswitchLogo.png",
                "primary_color": "#006DF9",
                "foreground_color": "#111326",
                "background_color": "#FFFFFF"
            },
            "theme_data": {
                "settings": {
                    "colors": {
                        "primary": "#3498db",
                        "secondary": null,
                        "background": null
                    },
                    "sidebar": null,
                    "typography": null,
                    "buttons": {
                        "primary": {
                            "backgroundColor": null,
                            "textColor": null,
                            "hoverBackgroundColor": "#27ae60"
                        },
                        "secondary": null
                    },
                    "borders": null,
                    "spacing": null
                },
                "urls": null
            }
        },
        {
            "theme_id": "929dcbb1-9dbf-4062-8b32-80683e6a8418",
            "theme_name": "Test_o1_m1_profile",
            "entity_type": "profile",
            "tenant_id": "public",
            "org_id": "o1",
            "merchant_id": "m1",
            "profile_id": "p2",
            "email_config": {
                "entity_name": "Hyperswitch",
                "entity_logo_url": "https://app.hyperswitch.io/email-assets/HyperswitchLogo.png",
                "primary_color": "#006DF9",
                "foreground_color": "#111326",
                "background_color": "#FFFFFF"
            },
            "theme_data": {
                "settings": {
                    "colors": {
                        "primary": "#3498db",
                        "secondary": null,
                        "background": null
                    },
                    "sidebar": null,
                    "typography": null,
                    "buttons": {
                        "primary": {
                            "backgroundColor": null,
                            "textColor": null,
                            "hoverBackgroundColor": "#27ae60"
                        },
                        "secondary": null
                    },
                    "borders": null,
                    "spacing": null
                },
                "urls": null
            }
        }
    ]

Everything else

{
    "theme_id": "9e144c3e-a68c-4653-b180-5771380df699",
    "theme_name": "Test_Integ",
    "entity_type": "merchant",
    "tenant_id": "t1",
    "org_id": "o1",
    "merchant_id": "m1",
    "profile_id": null,
    "email_config": {
        "entity_name": "Hyperswitch",
        "entity_logo_url": "https://app.hyperswitch.io/email-assets/HyperswitchLogo.png",
        "primary_color": "#006DF9",
        "foreground_color": "#111326",
        "background_color": "#FFFFFF"
    },
    "theme_data": {
        "settings": {
            "colors": {
                "primary": "#3498db",
                "secondary": null,
                "background": null
            },
            "sidebar": null,
            "typography": null,
            "buttons": {
                "primary": {
                    "backgroundColor": null,
                    "textColor": null,
                    "hoverBackgroundColor": "#27ae60"
                },
                "secondary": null
            },
            "borders": null,
            "spacing": null
        },
        "urls": null
    }
}

Checklist

I formatted the code cargo +nightly fmt --all
I addressed lints thrown by cargo clippy
I reviewed the submitted code
I added unit tests for my changes where possible

semanticdiff-com · 2025-06-19T08:00:35Z

Review changes with

Changed Files

File	Status
crates/api_models/src/events/user.rs	69% smaller
crates/router/src/services/authorization/permission_groups.rs	49% smaller
crates/router/src/routes/lock_utils.rs	6% smaller
crates/router/src/db/user/theme.rs	3% smaller
crates/router/src/core/user/theme.rs	1% smaller
crates/router/src/routes/user/theme.rs	1% smaller
crates/api_models/src/user/theme.rs	0% smaller
crates/common_enums/src/enums.rs	0% smaller
crates/common_utils/src/id_type/profile.rs	0% smaller
crates/common_utils/src/types/user/theme.rs	0% smaller
crates/diesel_models/src/query/user/theme.rs	0% smaller
crates/router/src/db/kafka_store.rs	0% smaller
crates/router/src/routes/app.rs	0% smaller
crates/router/src/services/authorization/info.rs	0% smaller
crates/router/src/services/authorization/permissions.rs	0% smaller
crates/router/src/services/authorization/roles/predefined_roles.rs	0% smaller
crates/router/src/utils/user/theme.rs	0% smaller
crates/router_env/src/logger/types.rs	0% smaller

crates/common_utils/src/id_type/profile.rs

crates/api_models/src/user/theme.rs

crates/diesel_models/src/query/user/theme.rs

crates/router/src/core/user/theme.rs

crates/router/src/routes/user/theme.rs

crates/router/src/core/user/theme.rs

crates/router/src/routes/user/theme.rs

crates/router/src/utils/user/theme.rs

crates/api_models/src/events.rs

crates/api_models/src/user/theme.rs

tsdk02 · 2025-07-11T08:39:40Z

Analytics changes LGTM

crates/api_models/src/user/theme.rs

crates/router/src/db/user/theme.rs

…rver * 'main' of github.com:juspay/hyperswitch: (24 commits) chore(version): 2025.07.28.1 feat(core): Hyperswitch <|> UCS Mandate flow integration (#8738) feat(themes): Create user APIs for managing themes (#8387) chore: update devDependencies for cypress (#8735) refactor: Add routing_approach other variant to handle unknown data (#8754) chore(version): 2025.07.28.0 refactor(connector): [facilitapay] move destination bank account number to connector metadata (#8704) feat(recovery-events): add revenue recovery topic and vector config to push these events to s3 (#8285) ci(cypress): add authorizedotnet connector (#8688) refactor(schema): add a new column for storing large customer user agents in mandate table (#8616) feat(authentication): add authentication api for modular authentication (#8459) feat(connector): [MPGS] template code (#8544) fix(chat): append request id to headers for chat request (#8680) feat(connector): [Flexiti]template code for flexiti connector (#8714) chore(version): 2025.07.25.0 feat(core): Consuming locale in PaymentsAuthorizeData from SessionState (#8731) fix(payment-methods): fetch payment method details in payouts flow (#8729) refactor(core): remove hardcoded timeout limit of 5s for outgoing webhook requests (#8725) feat(connector): [Breadpay]Add support for Breadpay connector (#8676) fix(feature_matrix): refunds are supported by jpmorgan (#8699) ...

feat(themes): Create user APIs for managing themes

1d4af87

kanikabansal08 self-assigned this Jun 19, 2025

kanikabansal08 added the S-in-progress Status: Implementation is underway label Jun 19, 2025

kanikabansal08 requested review from a team as code owners June 19, 2025 08:00

kanikabansal08 added 2 commits June 19, 2025 13:30

Merge branch 'main' into theme-user-apis

5f01d01

feat(themes): Create user APIs for managing themes

756f9d0

kanikabansal08 added C-feature Category: Feature request or enhancement and removed S-in-progress Status: Implementation is underway labels Jun 19, 2025

kanikabansal08 linked an issue Jun 20, 2025 that may be closed by this pull request

Themes via Dashboard BE juspay/hyperswitch-control-center#3203

Closed

2 tasks

kanikabansal08 added 11 commits June 20, 2025 17:19

feat(themes): Create user APIs for managing themes

a9796d5

feat(themes): Add comments in routes

f40a23b

Merge branch 'main' into theme-user-apis

7f82a80

feat(themes): Add validation for lineage while updating themes user

942a8c9

feat(themes): Add validation for lineage while updating themes user

c41acc1

Merge branch 'main' into theme-user-apis

d81146a

feat(themes): Clippy fix

acd03a6

feat(themes): functions optimisation

1c6ed49

feat(theme): list api for themes

cb6b69e

Merge branch 'main' into theme-user-apis

7dbed4f

Merge branch 'main' into theme-user-apis

f825f68

ThisIsMani reviewed Jun 26, 2025

View reviewed changes

feat(theme): addressed comments

c961b86

kanikabansal08 requested a review from a team as a code owner June 29, 2025 10:37

Merge branch 'main' into theme-user-apis

4c0b5fa

kanikabansal08 mentioned this pull request Jun 30, 2025

feat: theme permission configuration juspay/hyperswitch-control-center#3233

Closed

13 tasks

kanikabansal08 added 2 commits July 1, 2025 13:32

feat(theme): API to get user theme using lineage

1380ade

Merge branch 'main' into theme-user-apis

5b0e129

ThisIsMani reviewed Jul 2, 2025

View reviewed changes

crates/api_models/src/events.rs Outdated Show resolved Hide resolved

crates/api_models/src/user/theme.rs Outdated Show resolved Hide resolved

crates/api_models/src/user/theme.rs Outdated Show resolved Hide resolved

kanikabansal08 and others added 3 commits July 4, 2025 17:04

fix: addressed comments

a57e9b7

feat: theme changes

b732562

chore: run formatter

b69371b

ThisIsMani previously approved these changes Jul 9, 2025

View reviewed changes

tsdk02 previously approved these changes Jul 11, 2025

View reviewed changes

Merge branch 'main' into theme-user-apis

7793f6a

su-shivanshmathur reviewed Jul 15, 2025

View reviewed changes

crates/api_models/src/user/theme.rs Show resolved Hide resolved

su-shivanshmathur reviewed Jul 15, 2025

View reviewed changes

crates/router/src/db/user/theme.rs Show resolved Hide resolved

su-shivanshmathur requested a review from a team July 16, 2025 09:32

kanikabansal08 added 2 commits July 16, 2025 17:14

Merge branch 'main' into theme-user-apis

88df9f5

Merge branch 'main' into theme-user-apis

2ea90b6

kanikabansal08 requested a review from su-shivanshmathur July 18, 2025 09:40

su-shivanshmathur previously approved these changes Jul 18, 2025

View reviewed changes

kanikabansal08 added 3 commits July 21, 2025 12:38

Merge branch 'main' into theme-user-apis

591d675

Merge branch 'main' into theme-user-apis

bae9fc8

fix: clippy error

a14e379

kanikabansal08 dismissed stale reviews from tsdk02, ThisIsMani, and su-shivanshmathur via a14e379 July 24, 2025 07:24

Merge branch 'main' into theme-user-apis

66d8bb2

tsdk02 approved these changes Jul 25, 2025

View reviewed changes

ThisIsMani approved these changes Jul 25, 2025

View reviewed changes

kanikabansal08 mentioned this pull request Jul 25, 2025

feat: theme folder structure , api types and permissions changes juspay/hyperswitch-control-center#3351

Merged

13 tasks

su-shivanshmathur approved these changes Jul 28, 2025

View reviewed changes

likhinbopanna added this pull request to the merge queue Jul 28, 2025

Merged via the queue into main with commit 20049d5 Jul 28, 2025
15 of 20 checks passed

likhinbopanna deleted the theme-user-apis branch July 28, 2025 07:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(themes): Create user APIs for managing themes#8387

feat(themes): Create user APIs for managing themes#8387
likhinbopanna merged 30 commits intomainfrom
theme-user-apis

kanikabansal08 commented Jun 19, 2025 •

edited

Loading

Uh oh!

semanticdiff-com bot commented Jun 19, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tsdk02 commented Jul 11, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

kanikabansal08 commented Jun 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Type of Change

Description

Additional Changes

Motivation and Context

How did you test it?

Checklist

Uh oh!

semanticdiff-com bot commented Jun 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tsdk02 commented Jul 11, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

kanikabansal08 commented Jun 19, 2025 •

edited

Loading

semanticdiff-com bot commented Jun 19, 2025 •

edited

Loading