Skip to content

feat(platforms): Add custom event and update README - #6

Merged
sarshad01 merged 13 commits into
masterfrom
feature/PO-2849-app-function-types-version
Aug 4, 2026
Merged

feat(platforms): Add custom event and update README#6
sarshad01 merged 13 commits into
masterfrom
feature/PO-2849-app-function-types-version

Conversation

@shamoon1997

@shamoon1997 shamoon1997 commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

The PR expands the starter kit with a registered custom-event example and substantially updates its setup and platform documentation.

  • Adds a custom.event.sync handler to the exported event map.
  • Upgrades the App Functions types package and changes CLI installation behavior.
  • Adds local environment configuration guidance and broadens the event, testing, deployment, and troubleshooting documentation.
  • Updates repository ownership and generated dependency-file ignore rules.

Confidence Score: 5/5

The PR appears safe to merge within the scope permitted for this follow-up review.

No blocking failure remains in the eligible follow-up findings.

Important Files Changed

Filename Overview
src/functions/custom-event-sync.ts Adds an example custom-event handler that reads event data, records receipt, and returns a successful response.
src/index.ts Registers custom.event.sync alongside the existing order and customer handlers.
package.json Renames the package, removes the global-install hook, makes the CLI a runtime dependency, and upgrades the types package.
README.md Reworks the starter-kit documentation with expanded setup, event reference, custom-event, testing, and deployment guidance.
test/index.spec.ts Reformats the partial-fixture helper and updates starter-kit terminology.

Sequence Diagram

sequenceDiagram
    participant Platform as Salla Platform
    participant Events as Exported events map
    participant Handler as customEventSync
    participant Logs as Function logs
    Platform->>Events: Dispatch custom.event.sync context
    Events->>Handler: Invoke registered handler
    Handler->>Logs: Write custom-event receipt
    Handler-->>Platform: Return FunctionResponse
Loading

Reviews (13): Last reviewed commit: "updates" | Re-trigger Greptile

@sallainternalbot
sallainternalbot Bot marked this pull request as draft August 3, 2026 11:01
@shamoon1997
shamoon1997 marked this pull request as ready for review August 3, 2026 11:01
@shamoon1997
shamoon1997 requested a review from mzfrshk August 3, 2026 11:03
Comment thread package.json Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
@shamoon1997
shamoon1997 requested a review from mzfrshk August 3, 2026 13:27
@mzfrshk mzfrshk changed the title feat(platforms): PO-2849 app function types version feat(platforms): Add custom event and update README Aug 4, 2026
@mzfrshk

mzfrshk commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

/merge

@sallainternalbot

Copy link
Copy Markdown

⚠️ Merge Blocked

I wasn't able to complete the merge due to the following issues:

🚫 Insufficient Permissions

You don’t have permission to merge the following PRs:

Ask a team member with write access to assist.


👥 Missing Required Approvals

These PRs need to be approved by reviewers:

Please request review and ensure all approvals are completed.


Once all issues are resolved, you can try the merge again.
If anything seems off, feel free to ask for help — I've got your back! 🤖

@sarshad01
sarshad01 merged commit c1b4d67 into master Aug 4, 2026
6 checks passed
@sarshad01
sarshad01 deleted the feature/PO-2849-app-function-types-version branch August 4, 2026 13:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants