@monada-ai/monada-cargofive-integration 0.0.1

package/.storybook/main.js

@@ -0,0 +1,32 @@
+/** @type { import('@storybook/react-webpack5').StorybookConfig } */
+const config = {
+    stories: ["../test/**/*.stories.@(js|jsx|mjs|ts|tsx)"],
+    addons: [
+        "@storybook/addon-links",
+        "@storybook/addon-essentials",
+        "@storybook/addon-onboarding",
+        "@storybook/addon-interactions",
+        "@storybook/addon-themes"
+    ],
+    framework: {
+        name: "@storybook/react-webpack5",
+        options: {
+            builder: {
+                useSWC: true,
+            },
+        },
+    },
+    swc: () => ({
+        jsc: {
+            transform: {
+                react: {
+                    runtime: 'automatic'
+                }
+            }
+        }
+    }),
+    docs: {
+        autodocs: "tag",
+    },
+};
+export default config;

package/.storybook/preview.js

@@ -0,0 +1,89 @@
+import { CssBaseline, ThemeProvider, createTheme } from '@mui/material';
+import { withThemeFromJSXProvider } from '@storybook/addon-themes';
+import { red, green, grey } from '@mui/material/colors';
+
+const theme = createTheme({
+    palette: {
+        primary: {
+            main: '#605dec',
+        },
+        'chip-request-new': {
+            main: red[300],
+            contrastText: '#fff',
+        },
+        'chip-opened-by-customer': {
+            main: '#DB74FF',
+            contrastText: '#fff',
+        },
+        'chip-won': {
+            main: green[500],
+            contrastText: '#fff',
+        },
+        'chip-lost': {
+            main: red[500],
+            contrastText: '#fff',
+        },
+        'chip-sent-to-endcustomer': {
+            main: '#2185D0',
+            contrastText: '#fff',
+        },
+        'chip-submitted': {
+            main: '#AC73E5',
+            contrastText: '#fff',
+        },
+        'supplier-filter': {
+            root: {
+                background: 'green',
+                '& input': {
+                    color: '#FFF',
+                }
+            }
+        },
+        'monada-button': {
+            main: '#605DE4',
+            contrastText: '#ffffff',
+            dark: '#4d4ab6',
+        },
+        'black-button': {
+            main: '#000000',
+            contrastText: '#ffffff',
+            dark: '#4d4ab6',
+        },
+        oneoffbuilderfields: {
+            main: '#667085',
+            contrastText: '#ffffff',
+            dark: grey[500],
+        }
+    },
+    typography: {
+        fontFamily: [
+            'Poppins',
+            'sans-serif',
+        ].join(','),
+    },
+});
+
+/** @type { import('@storybook/react').Preview } */
+const preview = {
+    parameters: {
+        actions: { argTypesRegex: "^on[A-Z].*" },
+        controls: {
+            matchers: {
+                color: /(background|color)$/i,
+                date: /Date$/i,
+            },
+        },
+    },
+};
+
+export const decorators = [
+    withThemeFromJSXProvider({
+        themes: {
+            light: theme,
+        },
+        defaultTheme: 'light',
+        Provider: ThemeProvider,
+        GlobalStyles: CssBaseline,
+    })];
+
+export default preview;

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,197 @@
+# monada-cargofive-integration
+
+Integration components to connect CargoFive into the Monada application.
+
+This package provides both server-side and client-side components for integrating CargoFive's shipping rate API into Monada, enabling users to search for ocean freight rates, view carrier information, and manage CargoFive settings.
+
+## Features
+
+- **Rate Search**: Search for ocean freight rates between ports using CargoFive API
+- **Multiple Container Types**: Support for various container types (20' Dry, 40' Dry, 40' High Cube, 40' Refrigerated, etc.)
+- **Comprehensive Rate Details**: Includes freight, origin, and destination charges
+- **Carrier Information**: Displays carrier logos, names, and unique identifiers
+- **Transit Information**: Provides transit times and dates
+- **Settings Management**: Configurable API key and feature toggles
+
+## Installation
+
+```bash
+npm install @monada-ai/monada-cargofive-integration
+```
+
+## Configuration
+
+### Server Configuration
+
+The server requires an API key to authenticate with CargoFive:
+
+```javascript
+const { Server } = require('@monada-ai/monada-cargofive-integration');
+
+const cargofiveServer = new Server({
+    apiKey: 'your-api-key-here',
+    serverUri: 'https://coreapp.cargofive.com/api', // Optional, defaults to production
+    verbose: false // Optional, enables debug logging
+});
+```
+
+### Client Settings Component
+
+The Settings component accepts the following props:
+
+- `enabled` (boolean): Whether the CargoFive integration is enabled
+- `setEnabled` (function): Callback to toggle the integration
+- `apiKey` (string): CargoFive API key
+- `setApiKey` (function): Callback to update the API key
+- `useCargofiveForRates` (boolean): Enable CargoFive for locations and supplier pricing searches
+- `setUseCargofiveForRates` (function): Callback to toggle this feature
+
+## Usage
+
+### Server-Side Rate Search
+
+```javascript
+const rates = await cargofiveServer.run({
+    sourcePort: {
+        id: 'ILHFA',
+        externalIds: {
+            cargofiveId: '296'
+        }
+    },
+    destinationPort: {
+        id: 'PTLIS',
+        externalIds: {
+            cargofiveId: '580'
+        }
+    },
+    products: [{
+        type: "20' Dry",
+        quantity: 1,
+        dangerous: false
+    }],
+    dateBegin: new Date('2026-02-01').getTime(),
+    dateEnd: new Date('2026-03-01').getTime()
+});
+```
+
+### Response Format
+
+The server returns an array of rate objects with the following structure:
+
+```javascript
+{
+    id: "cargofive-{rate-uuid}",
+    type: "spot" | "contract",
+    created: timestamp,
+    transportationMethod: "sea",
+    source: { /* port object */ },
+    destination: { /* port object */ },
+    supplier: {
+        organization: "Carrier Name",
+        uniqueId: "Carrier Code",
+        logo: "https://..."
+    },
+    product: {
+        id: "product-uuid",
+        type: "20' Dry",
+        quantity: 1,
+        dangerous: false
+    },
+    offer: {
+        validFrom: date | null,
+        validUntil: date | null,
+        transitTime: string | null,
+        transitDates: [{
+            etd: "2026-02-02",
+            eta: "2026-02-23"
+        }],
+        availability: {
+            available: true,
+            count: null
+        },
+        transshipment: "",
+        sections: [
+            {
+                id: "section-uuid",
+                title: "Freight" | "Origin" | "Destination",
+                offers: [{
+                    id: "offer-uuid",
+                    fields: [{
+                        id: "field-uuid",
+                        title: "Charge Name",
+                        type: "per-unit-type" | "flat",
+                        values: {
+                            "product-uuid": {
+                                value: 302,
+                                currency: "USD"
+                            }
+                        }
+                    }]
+                }]
+            }
+        ]
+    },
+    attributes: {
+        cargofiveRate: { /* full CargoFive rate object */ }
+    },
+    notes: ""
+}
+```
+
+## Error Handling
+
+The server throws the following exceptions:
+
+- `ConfigurationErrorException`: Thrown when API key or server URI is missing
+- `InvalidTokenException`: Thrown when API key is invalid (401/403 responses)
+- `TooManyRequestsException`: Thrown when rate limit is exceeded (429 responses)
+
+## Testing
+
+Server code can be tested using:
+
+```bash
+npm test
+```
+
+The test suite includes:
+- Configuration validation tests
+- Rate search tests
+- Error handling tests
+- Full integration tests comparing against expected results
+
+## Development
+
+### Running Storybook
+
+To view and develop the client components:
+
+```bash
+npm run storybook
+```
+
+### Building
+
+To build the package for distribution:
+
+```bash
+npm run build
+```
+
+## API Endpoints
+
+The integration uses the following CargoFive API endpoints:
+
+- `GET /v1/public/rates`: Search for rates between ports
+
+## Port Configuration
+
+Ports should include `externalIds.cargofiveId` for optimal matching. If not available, the integration falls back to using the port `id`.
+
+## License
+
+ISC
+
+## Author
+
+Yoav Amit

package/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [['@babel/preset-env', {targets: {node: 'current'}}]],
+};

package/jest.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+transformIgnorePatterns: [
+							 "node_modules/(?!(until-async|msw)/)"
+],
+};

package/package.json

@@ -0,0 +1,75 @@
+{
+    "name": "@monada-ai/monada-cargofive-integration",
+    "version": "0.0.1",
+    "description": "All that is needed to integrate CargoFive into monada (server & client code)",
+    "main": "./dist/",
+    "publishConfig": {
+        "access": "public"
+    },
+    "scripts": {
+        "test": "jest",
+        "prepublish": "npm run build",
+        "build": "rm -rf dist && webpack && cp -r src/server dist/server && cp -r src/utils dist/utils",
+        "storybook": "storybook dev -p 6006",
+        "build-storybook": "storybook build"
+    },
+    "repository": {
+        "type": "git",
+        "url": "monada-cargofive-integration"
+    },
+    "author": "Yoav Amit",
+    "license": "ISC",
+    "devDependencies": {
+        "@babel/preset-env": "^7.28.5",
+        "@emotion/react": "^11.11.3",
+        "@emotion/styled": "^11.11.0",
+        "@fortawesome/pro-light-svg-icons": "^6.5.1",
+        "@fortawesome/pro-solid-svg-icons": "^6.5.1",
+        "@fortawesome/react-fontawesome": "^0.2.0",
+        "@monada-ai/monada-shipping-companies-logos": "*",
+        "@mui/lab": "^5.0.0-alpha.159",
+        "@mui/material": "^5.15.3",
+        "@storybook/addon-essentials": "^7.6.7",
+        "@storybook/addon-interactions": "^7.6.7",
+        "@storybook/addon-links": "^7.6.7",
+        "@storybook/addon-onboarding": "^1.0.10",
+        "@storybook/addon-themes": "^7.6.7",
+        "@storybook/blocks": "^7.6.7",
+        "@storybook/react": "^7.6.7",
+        "@storybook/react-webpack5": "^7.6.7",
+        "@storybook/test": "^7.6.7",
+        "axios": "^1.6.5",
+        "babel-jest": "^30.2.0",
+        "currency-list": "^1.0.8",
+        "jest": "^29.7.0",
+        "lodash": "^4.17.21",
+        "msw": "^2.0.12",
+        "mui": "^0.0.1",
+        "prop-types": "^15.8.1",
+        "react": "^18.2.0",
+        "react-dnd": "^16.0.1",
+        "react-dnd-html5-backend": "^16.0.1",
+        "react-dom": "^18.2.0",
+        "storybook": "^7.6.7",
+        "webpack-cli": "^5.1.4"
+    },
+    "peerDependencies": {
+        "@emotion/react": "^11.11.3",
+        "@emotion/styled": "^11.11.0",
+        "@fortawesome/pro-light-svg-icons": "^6.5.1",
+        "@fortawesome/pro-solid-svg-icons": "^6.5.1",
+        "@fortawesome/react-fontawesome": "^0.2.0",
+        "@monada-ai/monada-shipping-companies-logos": "*",
+        "@mui/lab": "^5.0.0-alpha.159",
+        "@mui/material": "^5.15.3",
+        "axios": "^1.6.5",
+        "currency-list": "^1.0.8",
+        "lodash": "^4.17.21",
+        "mui": "^0.0.1",
+        "prop-types": "^15.8.1",
+        "react": "^18.2.0",
+        "react-dnd": "^16.0.1",
+        "react-dnd-html5-backend": "^16.0.1",
+        "react-dom": "^18.2.0"
+    }
+}