New Components - picqer #17044
New Components - picqer #17044
Conversation
luancazarine
added
the
ai-assisted
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 3 Skipped Deployments
|
|
Important Review skippedReview was skipped due to path filters ⛔ Files ignored due to path filters (1)
CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including You can disable this status message by setting the WalkthroughThis update introduces a comprehensive Picqer integration, adding a fully implemented app module, a suite of actions for orders, returns, customers, and picklists, and a webhook event source with signature verification. It also includes supporting constants, utilities, and test data. Minor changes add newlines to unrelated app files. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Action
participant PicqerApp
participant PicqerAPI
User->>Action: Provide input (e.g., create order)
Action->>PicqerApp: Call method (e.g., createOrder)
PicqerApp->>PicqerAPI: Make HTTP request
PicqerAPI-->>PicqerApp: Return API response
PicqerApp-->>Action: Return data
Action-->>User: Return result/summary
sequenceDiagram
participant PicqerAPI
participant WebhookSource
participant HTTP
participant User
PicqerAPI->>WebhookSource: Send webhook event
WebhookSource->>HTTP: Verify signature
alt Signature valid
WebhookSource->>User: Emit event with summary
HTTP->>PicqerAPI: Respond 200 OK
else Signature invalid
HTTP->>PicqerAPI: Respond 401 Unauthorized
end
Assessment against linked issues
Assessment against linked issues: Out-of-scope changes
Suggested reviewers
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Sources - New Event (Instant) Actions - Add Order Comment - Add Return Comment - Create Order - Get Customer - Get Order - Get Picklist - Get Status Per Order Line - Search Orders - Update Order
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 12
🧹 Nitpick comments (10)
components/picqer/package.json (1)
15-17: Ensure dependency list is deterministicConsider alphabetising the keys in
"dependencies"(e.g.crypto-jsbefore@pipedream/platform) or adding a lint rule that enforces order. A consistent order avoids unnecessary diff-noise on future bumps.components/picqer/common/utils.mjs (1)
4-23: Optional: deep-parse plain objectsAt the moment only top-level strings / arrays are parsed. If callers pass an object whose property values are JSON strings (common with dynamic fields), they stay unparsed. A recursive walk would make
parseObjectmore generally reusable:if (typeof obj === "string") { try { return JSON.parse(obj); } catch (e) { return obj; } } - return obj; + if (typeof obj === "object") { + return Object.fromEntries( + Object.entries(obj).map(([k, v]) => [k, parseObject(v)]), + ); + } + return obj;components/picqer/actions/get-picklist/get-picklist.mjs (1)
7-8: Component version mismatchAction version is
0.0.1while the package was bumped to0.1.0. Keeping them aligned helps consumers understand compatibility at a glance.- version: "0.0.1", + version: "0.1.0",components/picqer/actions/add-order-comment/add-order-comment.mjs (1)
7-8: Align action version with packageSame as for Get Picklist – bump to
0.1.0for consistency.components/picqer/actions/search-orders/search-orders.mjs (1)
30-41: Consider stronger typing or helper UI for date inputs
sinceDateanduntilDateare free-form strings. Wrongly-formatted timestamps will silently propagate to the API and are hard to debug.
Pipedream supports the"datetime"prop-type which renders a date-time picker in the UI.- sinceDate: { - type: "string", + sinceDate: { + type: "datetime",Same for
untilDate.
This gives users immediate feedback and prevents malformed requests.components/picqer/actions/get-customer/get-customer.mjs (1)
18-26: Handle 404 / empty responses gracefully
getCustomermight returnnullor throw when the ID is unknown. Emit a meaningful summary instead of “Successfully retrieved customer X”.try { const response = await this.picqer.getCustomer({ $, customerId: this.customerId }); - $.export("$summary", `Successfully retrieved customer ${this.customerId}`); - return response; + if (!response) $.export("$summary", `No customer found with ID ${this.customerId}`); + else $.export("$summary", `Customer ${this.customerId} retrieved`); + return response; } catch (err) { this.picqer.logError(err, $); throw err; }Prevents misleading success messages.
components/picqer/actions/update-order/update-order.mjs (1)
234-272: Consider extracting address field visibility logic.The repetitive pattern of hiding/showing address fields could be extracted to reduce duplication and improve maintainability.
Consider refactoring to:
const addressFields = [ 'deliveryName', 'deliveryContactName', 'deliveryAddress', 'deliveryAddress2', 'deliveryZipcode', 'deliveryCity', 'deliveryRegion', 'deliveryCountry', 'invoiceName', 'invoiceContactName', 'invoiceAddress', 'invoiceAddress2', 'invoiceZipcode', 'invoiceCity', 'invoiceRegion', 'invoiceCountry' ]; addressFields.forEach(field => { fixedProps[field].hidden = hasCustomerId; });components/picqer/actions/create-order/create-order.mjs (1)
310-315: Consider more descriptive error messages.The error messages could be enhanced to guide users better.
Apply this diff for clearer error messages:
- throw new ConfigurationError("Delivery Name is required if **Customer Id** is not provided"); + throw new ConfigurationError("Either Customer ID or Delivery Name must be provided. Please select a customer or enter delivery details."); } if (!customerId && !deliveryCountry) { - throw new ConfigurationError("Delivery Country is required if **Customer Id** is not provided"); + throw new ConfigurationError("Delivery Country is required when creating an order without a Customer ID. Please provide a valid ISO 3166 2-character country code.");components/picqer/picqer.app.mjs (2)
194-238: Consider adding country code validation.The delivery and invoice country fields require ISO 3166 2-char codes, but there's no validation or helper to ensure correct format.
Consider adding validation or providing a dropdown with country codes:
deliveryCountry: { type: "string", label: "Delivery Country", description: "Country of delivery address (needs to be ISO 3166 2-char code). Required if **Customer Id** is not provided.", + options: async () => { + // Return common country codes or fetch from an API + return [ + { label: "United States", value: "US" }, + { label: "Canada", value: "CA" }, + { label: "United Kingdom", value: "GB" }, + // ... more countries + ]; + }, },Alternatively, add validation in the action components that use these fields.
301-452: Consider adding JSDoc comments for better developer experience.The methods section would benefit from JSDoc comments to document parameters, return values, and potential errors. This would improve the developer experience when using this app component.
Example for one method:
/** * Create a new order in Picqer * @param {Object} opts - Request options * @param {Object} opts.$ - Pipedream context object * @param {Object} opts.data - Order data * @returns {Promise<Object>} Created order object * @throws {Error} If the API request fails */ createOrder(opts = {}) { return this._makeRequest({ method: "POST", path: "/orders", ...opts, }); },
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (16)
components/picqer/actions/add-order-comment/add-order-comment.mjs(1 hunks)components/picqer/actions/add-return-comment/add-return-comment.mjs(1 hunks)components/picqer/actions/create-order/create-order.mjs(1 hunks)components/picqer/actions/get-customer/get-customer.mjs(1 hunks)components/picqer/actions/get-order/get-order.mjs(1 hunks)components/picqer/actions/get-picklist/get-picklist.mjs(1 hunks)components/picqer/actions/get-status-per-order-line/get-status-per-order-line.mjs(1 hunks)components/picqer/actions/search-orders/search-orders.mjs(1 hunks)components/picqer/actions/update-order/update-order.mjs(1 hunks)components/picqer/common/constants.mjs(1 hunks)components/picqer/common/utils.mjs(1 hunks)components/picqer/package.json(2 hunks)components/picqer/picqer.app.mjs(1 hunks)components/picqer/sources/common/base.mjs(1 hunks)components/picqer/sources/new-event-instant/new-event-instant.mjs(1 hunks)components/picqer/sources/new-event-instant/test-event.mjs(1 hunks)
🔇 Additional comments (8)
components/picqer/package.json (1)
15-17: Re-evaluate version rangesUsing caret ranges (
^3.1.0,^4.2.0) automatically picks up new minor / patch versions at deploy time. If Picqer components are sensitive to upstream changes (especiallycrypto-jsfor signature verification), consider pinning exact versions or adding an automated lockfile-refresh step to surface breaking changes early.components/picqer/sources/new-event-instant/test-event.mjs (1)
1-43: Looks good – representative sample eventThe static payload is well-structured and mirrors the Picqer docs. No issues found.
components/picqer/actions/get-picklist/get-picklist.mjs (1)
18-24: Verify underlying method existsAssuming
picqer.app.mjsexposesgetPicklist, but this isn’t guaranteed at compile-time. Please confirm the method name and signature match; a typo will only surface at runtime.components/picqer/actions/get-status-per-order-line/get-status-per-order-line.mjs (1)
19-26: Pagination / large-response advisory
getStatusPerOrderLinecan return many lines for big orders. Ensure the underlyingpicqerhelper streams or paginates; otherwise responses might exceed Pipedream’s 6 MB limit.components/picqer/actions/get-order/get-order.mjs (1)
1-27: LGTM!Clean and straightforward implementation of the get order action. Good use of propDefinition for consistency.
components/picqer/actions/update-order/update-order.mjs (1)
309-355: Well-implemented data transformation logic.Good handling of:
- Float parsing for discount
- Array joining for multi-value custom fields
- Proper field name mapping to API format
components/picqer/common/constants.mjs (1)
1-230: Well-organized constants.Good structure with clear option objects and comprehensive event types coverage.
components/picqer/actions/create-order/create-order.mjs (1)
253-272: Good handling of required custom fields.Nice improvement over the update action by including the
requiredproperty for custom order fields.
|
/approve |
Resolves #16959.
Summary by CodeRabbit