Feature: Add API Key support (🚧) by grablair · Pull Request #350 · HiEventsDev/Hi.Events

grablair · 2025-01-18T18:19:33Z

Resolves #339

This is a WIP change to add API keys. The feature is implemented and admins can create API keys and they can be used to access the APIs in a granular fashion. I still need to complete all translations, and want to give @daveearley an opportunity to review this sooner rather than later.

This also adds a migration to add account_id to the token table, so tokens can be set up on a per-account basis, and the auth flow knows which account a token is attached to, as we don't have the JWT payload to tell us. (TODO: May need to implement key filtering from view for multiple-account situations)

Tested with expired tokens, tokens with missing abilities, and valid tokens.

Checklist

I have read the contributing guidelines.
My code is of good quality and follows the coding standards of the project.
I have tested my changes, and they work as expected.

Thank you for your contribution! 🎉

# Conflicts: # backend/app/DomainObjects/ProductDomainObject.php # backend/app/Services/Handlers/Order/CompleteOrderHandler.php # frontend/src/components/routes/product-widget/SelectProducts/Prices/Tiered/index.tsx # frontend/src/components/routes/product-widget/SelectProducts/index.tsx # frontend/src/locales/de.js # frontend/src/locales/de.po # frontend/src/locales/en.js # frontend/src/locales/en.po # frontend/src/locales/es.js # frontend/src/locales/es.po # frontend/src/locales/fr.js # frontend/src/locales/fr.po # frontend/src/locales/pt-br.js # frontend/src/locales/pt-br.po # frontend/src/locales/pt.js # frontend/src/locales/pt.po # frontend/src/locales/ru.js # frontend/src/locales/ru.po # frontend/src/locales/zh-cn.js # frontend/src/locales/zh-cn.po

# Conflicts: # backend/app/DomainObjects/Generated/ProductDomainObjectAbstract.php # backend/app/Services/Domain/Ticket/CreateTicketService.php # backend/app/Services/Handlers/Ticket/CreateTicketHandler.php # backend/app/Services/Handlers/Ticket/DTO/UpsertTicketDTO.php # backend/app/Services/Handlers/Ticket/EditTicketHandler.php # frontend/src/components/forms/ProductForm/index.tsx # frontend/src/components/modals/CreateTicketModal/index.tsx # frontend/src/components/modals/EditProductModal/index.tsx # frontend/src/components/routes/product-widget/AttendeeProductAndInformation/index.tsx # frontend/src/components/routes/product-widget/PrintProduct/index.tsx # frontend/src/components/routes/product-widget/SelectProducts/index.tsx # frontend/src/locales/de.js # frontend/src/locales/de.po # frontend/src/locales/en.js # frontend/src/locales/en.po # frontend/src/locales/es.js # frontend/src/locales/es.po # frontend/src/locales/fr.js # frontend/src/locales/fr.po # frontend/src/locales/pt-br.js # frontend/src/locales/pt-br.po # frontend/src/locales/pt.js # frontend/src/locales/pt.po # frontend/src/locales/ru.js # frontend/src/locales/ru.po # frontend/src/locales/zh-cn.js # frontend/src/locales/zh-cn.po # frontend/src/styles/widget/default.scss

# Conflicts: # frontend/src/components/common/AttendeeCheckInTable/QrScanner.tsx # frontend/src/components/common/AttendeeCheckInTable/index.tsx

# Conflicts: # frontend/src/components/routes/product-widget/SelectProducts/index.tsx # frontend/src/styles/widget/default.scss

…r-directory

…-ui-updates

# Conflicts: # backend/app/Services/Domain/Event/DuplicateEventService.php # frontend/src/components/routes/product-widget/SelectProducts/index.tsx

…notes Add ability to add notes to an attendee + Refactor Attendee modal

# Conflicts: # frontend/src/components/common/AttendeeList/index.tsx

# Conflicts: # backend/app/Exports/AttendeesExport.php # backend/app/Http/Actions/Attendees/GetAttendeeAction.php # backend/app/Http/Request/Attendee/CreateAttendeeRequest.php # backend/app/Resources/Attendee/AttendeeResource.php # backend/app/Services/Application/Handlers/Attendee/CreateAttendeeHandler.php # backend/app/Services/Domain/Order/OrderCancelService.php # backend/app/Services/Handlers/Attendee/EditAttendeeHandler.php # frontend/src/components/forms/CapaciyAssigmentForm/index.tsx # frontend/src/components/modals/CreateCapacityAssignmentModal/index.tsx # frontend/src/components/modals/EditAttendeeModal/index.tsx # frontend/src/components/modals/EditCapacityAssignmentModal/index.tsx # frontend/src/locales/de.js # frontend/src/locales/de.po # frontend/src/locales/en.js # frontend/src/locales/en.po # frontend/src/locales/es.js # frontend/src/locales/es.po # frontend/src/locales/fr.js # frontend/src/locales/fr.po # frontend/src/locales/pt-br.js # frontend/src/locales/pt-br.po # frontend/src/locales/pt.js # frontend/src/locales/pt.po # frontend/src/locales/ru.js # frontend/src/locales/ru.po # frontend/src/locales/zh-cn.js # frontend/src/locales/zh-cn.po

daveearley · 2025-01-18T20:32:29Z

Nice! Thanks for contributing this. I'll set aside some time tomorrow to review it.

meilechwieder · 2025-01-20T14:52:43Z

Is there somewhere a swagger documentation or the likes for the API?

daveearley

Great work here! Thank you very much for the contribution. If it's OK with you, I can use this branch as the base for auth changes and I can push up some changes/fixes.

daveearley · 2025-01-21T04:48:58Z

backend/app/Providers/AppServiceProvider.php

        Relation::enforceMorphMap([
            EventDomainObject::class => Event::class,
            OrganizerDomainObject::class => Organizer::class,
+            'user' => User::class,


Curious what the reason for this?

As soon as I added the traits required for Sanctum to the User class, I received an error about being unable to morph a User object (I unfortunately don't recall the specific error). Upon doing some google research, I discovered some other people suggesting this as a fix to the error, and it worked.

I'm sure if you remove this you'll get the same error, just in case there is a better solution I am unaware of. Or maybe you won't and I was just being gaslit. 😂

frontend/src/api/api-keys.client.ts

daveearley · 2025-01-21T05:14:44Z

frontend/src/api/client.ts

    'widget',
    '/product/',
    'check-in',
+    'csrf-cookie',


This array relates to frontend path. From what I can see csrf-cookie is a backend path.

daveearley · 2025-01-21T05:15:30Z

frontend/src/api/auth.client.ts


    login: async (user: LoginData) => {
-        const response = await api.post<LoginResponse>('auth/login', user);
+        const response = await api.get('/csrf-cookie').then(async response => {


async response can be removed as it's unused.

daveearley · 2025-01-21T05:16:40Z

frontend/src/components/modals/CreateApiKeyModal/index.tsx

+export const CreateApiKeyModal = ({onClose, onCompleted}: CreateApiKeyModalProps) => {
+    const createMutation = useCreateApiKey();
+    const queryClient = useQueryClient();
+    const formErrorHandler = useFormErrorResponseHandler();


Looks like this is unused

daveearley · 2025-01-21T05:17:29Z

frontend/src/components/modals/CreateApiKeyModal/index.tsx

+    const handleCreate = useMutation({
+        mutationFn: (apiKeyRequest: CreateApiKeyRequest) => apiKeysClient.create(apiKeyRequest),
+
+        onSuccess: (response: NewApiKey) => {


NewApiKey doesn't exist

The interface does exist, but you're right, I didn't import it in this file and I didn't specify it as the result of a Create call in the api-keys.client.ts file.

Thanks!

Co-authored-by: Dave Earley <dave.m.earley@gmail.com>

grablair · 2025-01-21T06:03:18Z

Great work here! Thank you very much for the contribution. If it's OK with you, I can use this branch as the base for auth changes and I can push up some changes/fixes.

You're welcome! Thanks for the review. Definitely feel free to use this as a jumping off point for the auth refactor.

daveearley · 2025-03-06T10:21:20Z

@grablair Don't worry about the conflicts here, I'll take care of them

daveearley · 2025-05-03T21:46:39Z

I haven't forgotten about this! There are a few bugs and performance issues that gave taken priority, but I'll get back to it as soon as I can.

Mikefluff · 2025-06-10T19:01:31Z

any progress on this? can I propose some support to make it merge to upsteam asap?

da-wilky · 2025-11-09T11:41:48Z

Any progress on this? :)

IbrahimMuhammadyau2019 · 2025-11-09T12:34:55Z

Good i like it

ethbkk1 · 2025-12-15T06:29:58Z

Another vote…

daveearley added 30 commits September 19, 2024 22:48

Rename tickets to products

7379276

Update config and tests

e3b5a72

Update ticket creation form

8871867

continued work on migration from tickets to products

3a671d0

continued work on migration from tickets to products

d64d11f

Update sorting logic for tickets. Continue work on product migration

b45e09b

Merge branch 'develop' into add-products

8a621ec

# Conflicts: # frontend/src/components/common/AttendeeCheckInTable/QrScanner.tsx # frontend/src/components/common/AttendeeCheckInTable/index.tsx

Update tests and order and attendee modals

c71df0c

Update testHandleUpdatesProductQuantitiesForFreeOrder

05df93e

Update testHandleDoesNotUpdateProductQuantitiesForPaidOrder

204f118

Update attendees modals/forms

18862b1

Merge pull request HiEventsDev#281 from HiEventsDev/develop

23fd4be

Merge pull request HiEventsDev#239 from HiEventsDev/add-products

b006e90

update migration

792f723

i18n

1592741

Update stats migration

e325817

Product bug fixes

c91299c

Add event product and daily sales reports

fb6db39

fix resend ticket

5a3e301

New -> Net

abab1d5

Remove unused classes

8bcdf58

Fix create attendee

b0702b9

Update exceptions

64a78f2

Merge branch 'develop' into v1.0.0-alpha

9494c9e

# Conflicts: # frontend/src/components/routes/product-widget/SelectProducts/index.tsx # frontend/src/styles/widget/default.scss

Update collapsable rows

0215634

Merge branch 'v1.0.0-alpha' into feature/add-event-reports

79b5580

Add promo code report

2dc6202

update promo code report

f71d42f

daveearley and others added 17 commits November 22, 2024 00:08

i18n

4806287

Update ICS file description

b77024a

Move Handlers directory

71e4f99

Merge pull request HiEventsDev#296 from HiEventsDev/chore/move-handle…

a66add4

…r-directory

Add capacity assignment migration

808c7fd

Dashboard UI updates

a10852b

i18n

8b5d336

Merge pull request HiEventsDev#304 from HiEventsDev/feature/dashboard…

92fd1f3

…-ui-updates

Merge branch 'develop' into v1.0.0-alpha

8041231

# Conflicts: # backend/app/Services/Domain/Event/DuplicateEventService.php # frontend/src/components/routes/product-widget/SelectProducts/index.tsx

Add ability to add notes to attendees

82b5491

Merge pull request HiEventsDev#320 from HiEventsDev/feature/attendee-…

8de344e

…notes Add ability to add notes to an attendee + Refactor Attendee modal

Merge branch 'develop' into v1.0.0-alpha

5e997d2

# Conflicts: # frontend/src/components/common/AttendeeList/index.tsx

Update migration

83845a6

i18n

927cbf0

Merge fixes

0b8ea8a

Add API key support

334528c

daveearley reviewed Jan 21, 2025

View reviewed changes

Apply suggestions from code review

9e693f8

Co-authored-by: Dave Earley <dave.m.earley@gmail.com>

daveearley added the v1.1.0 label Feb 14, 2025

daveearley changed the base branch from v1.0.0-alpha to develop March 6, 2025 10:06

Uh oh!

Conversation

grablair commented Jan 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Uh oh!

daveearley commented Jan 18, 2025

Uh oh!

meilechwieder commented Jan 20, 2025

Uh oh!

daveearley left a comment

Choose a reason for hiding this comment

Uh oh!

daveearley Jan 21, 2025

Choose a reason for hiding this comment

Uh oh!

grablair Jan 21, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

daveearley Jan 21, 2025

Choose a reason for hiding this comment

Uh oh!

daveearley Jan 21, 2025

Choose a reason for hiding this comment

Uh oh!

daveearley Jan 21, 2025

Choose a reason for hiding this comment

Uh oh!

daveearley Jan 21, 2025

Choose a reason for hiding this comment

Uh oh!

grablair Jan 21, 2025

Choose a reason for hiding this comment

Uh oh!

grablair commented Jan 21, 2025

Uh oh!

daveearley commented Mar 6, 2025

Uh oh!

daveearley commented May 3, 2025

Uh oh!

Mikefluff commented Jun 10, 2025

Uh oh!

da-wilky commented Nov 9, 2025

Uh oh!

IbrahimMuhammadyau2019 commented Nov 9, 2025

Uh oh!

ethbkk1 commented Dec 15, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

grablair commented Jan 18, 2025 •

edited

Loading