feat(sdk): added app sortKey and sortDirection

[TheBestMoshe]

Summary by CodeRabbit

• New Features

  • Added new sorting options to app retrieval, allowing users to sort apps by name, featured weight, or name slug in ascending or descending order.

• Documentation

  • Updated the changelog to reflect the new sorting options and the latest version release.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

3 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
docs-v2	⬜️ Ignored (Inspect)	Visit Preview		Jul 1, 2025 6:40pm
pipedream-docs	⬜️ Ignored (Inspect)			Jul 1, 2025 6:40pm
pipedream-docs-redirect-do-not-edit	⬜️ Ignored (Inspect)			Jul 1, 2025 6:40pm

[coderabbitai]

Walkthrough

The changes introduce two new optional sorting parameters, sortKey and sortDirection, to the getApps method in the SDK. The GetAppsOpts type and the method implementation are updated to support these options. Documentation and versioning are updated accordingly.

Changes

File(s)	Change Summary
packages/sdk/CHANGELOG.md	Added changelog entry for version 1.6.10, documenting new sortKey and sortDirection options.
packages/sdk/package.json	Bumped package version from 1.6.9 to 1.6.10.
packages/sdk/src/shared/index.ts	Extended GetAppsOpts type and updated getApps method to support new sorting parameters.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant SDK (getApps)
    participant API

    Client->>SDK (getApps): Call with opts (including sortKey, sortDirection)
    SDK (getApps)->>API: GET /apps?sortKey=...&sortDirection=...
    API-->>SDK (getApps): Return apps list
    SDK (getApps)-->>Client: Return sorted apps list

Loading

Poem

A hop and a skip, two options appear,
Sorting the apps brings order and cheer.
With sortKey and sortDirection, the list you command,
Now fetch your apps just as you planned!
🐇✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/sdk/src/shared/index.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs
at Object.getPackageJSONURL (node:internal/modules/package_json_reader:255:9)
at packageResolve (node:internal/modules/esm/resolve:767:81)
at moduleResolve (node:internal/modules/esm/resolve:853:18)
at defaultResolve (node:internal/modules/esm/resolve:983:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:801:12)
at #cachedDefaultResolve (node:internal/modules/esm/loader:725:25)
at ModuleLoader.resolve (node:internal/modules/esm/loader:708:38)
at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:309:38)
at #link (node:internal/modules/esm/module_job:202:49)

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c888690 and 3bae499.

📒 Files selected for processing (3)

• packages/sdk/CHANGELOG.md (1 hunks)
• packages/sdk/package.json (1 hunks)
• packages/sdk/src/shared/index.ts (2 hunks)

🧰 Additional context used

🧠 Learnings (1)

packages/sdk/package.json (1)

Learnt from: jcortes
PR: PipedreamHQ/pipedream#14935
File: components/sailpoint/package.json:15-18
Timestamp: 2024-12-12T19:23:09.039Z
Learning: When developing Pipedream components, do not add built-in Node.js modules like `fs` to `package.json` dependencies, as they are native modules provided by the Node.js runtime.

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Lint Code Base

🔇 Additional comments (4)

packages/sdk/src/shared/index.ts (2)

258-269: LGTM! Well-defined sorting options with clear documentation.

The type definitions are well-structured with appropriate union types and clear documentation of default values. The allowed values for sortKey provide meaningful sorting options, and the binary sortDirection follows standard conventions.

---

1193-1198: LGTM! Implementation follows established patterns.

The implementation correctly maps the optional sorting parameters to query parameters using snake_case naming, which is consistent with other parameters in the method (e.g., has_actions, has_components). The conditional checks ensure parameters are only added when provided.

packages/sdk/package.json (1)

4-4: LGTM! Appropriate version increment for new optional features.

The patch version bump from 1.6.9 to 1.6.10 is appropriate for adding new optional parameters that don't break existing functionality.

packages/sdk/CHANGELOG.md (1)

5-10: LGTM! Clear and accurate changelog documentation.

The changelog entry properly documents the new sorting options with appropriate formatting and version information that matches the package.json update.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.