@duffel/components 3.0.4-canary → 3.0.6-canary

package/.eslintrc.js

@@ -9,7 +9,7 @@ module.exports = {
     node: true,
     jest: true,
   },
-  ignorePatterns: ["**/dist/**", "react-dist/**", "__generated__**"],
+  ignorePatterns: ["**/cdn-dist/**", "react-dist/**", "__generated__**"],
   parser: "@typescript-eslint/parser",
   extends: [
     "eslint:recommended",

package/README.md

@@ -1,9 +1,27 @@
 # @duffel/components
 
-## Ancillaries component
+This package is a component library to help you build your travel product using the [Duffel API](https://duffel.com/docs).
 
-### What is this?
+## Get started
 
-The ancillaries component is a JavaScript component you can use to allow your customers to add ancillaries to their order. It's simple to add to your website and can be customised to fit your brand.
+### Installing
 
-> [See live demo here](https://codesandbox.io/s/duffel-ancillaries-example-1nxuu7)
+```sh
+yarn add @duffel/components
+# -- or --
+npm i @duffel/components
+```
+
+### (alternative) Load from CDN:
+
+```html
+<script src="https://assets.duffel.com/components/3.0.5-canary/index.js"></script>
+```
+
+## Components
+
+### Ancillaries component
+
+The ancillaries component allows your customers to add ancillaries to their order. It's simple to add to your website and can be customised to fit your brand. This component is avaiable through npm and our cdn.
+
+- [Find live demo on codesandbox.io&nbsp;&nbsp;↗](https://codesandbox.io/s/duffel-ancillaries-example-1nxuu7)

package/config/esbuild.base.config.js

@@ -10,5 +10,5 @@ module.exports = {
   minify: true,
   sourcemap: true,
   treeShaking: true,
-  outdir: "dist/ancillaries",
+  outdir: "cdn-dist",
 };

package/config/esbuild.cdn.config.js

@@ -34,14 +34,14 @@ esbuild
         org: "duffel",
         project: "ancillaries-component",
         // Specify the directory containing build artifacts
-        include: "./dist",
+        include: "./cdn-dist",
         authToken: process.env.SENTRY_AUTH_TOKEN,
         logLevel: "info",
-        release: `element-${VERSION}`,
+        release: `cdn-${VERSION}`,
       }),
       esbuildCopyStaticFiles({
         src: "src/fixtures",
-        dest: "dist/ancillaries/fixtures",
+        dest: "cdn-dist/fixtures",
         dereference: true,
         recursive: true,
       }),

package/config/esbuild.dev.config.js

@@ -27,7 +27,7 @@ const COMPONENT_CDN = process.env.COMPONENT_CDN.startsWith("http://localhost:")
       // the component will attempt to fetch it from the hosted folder.
       require("esbuild-copy-static-files")({
         src: "src/fixtures",
-        dest: "dist/ancillaries/fixtures",
+        dest: "cdn-dist/fixtures",
         dereference: true,
         recursive: true,
       }),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@duffel/components",
-  "version": "3.0.4-canary",
+  "version": "3.0.6-canary",
   "private": false,
   "license": "MIT",
   "main": "react-dist/index.js",
@@ -150,11 +150,10 @@
     "Duffel",
     "ancillaries",
     "seats",
-    "seat map",
+    "seat maps",
     "baggage",
     "travel"
   ],
-  "author": "duffel.com",
   "bugs": {
     "url": "https://github.com/duffelhq/duffel-checkout/issues"
   },

package/react-dist/custom-elements.d.ts

@@ -1 +1,5 @@
+/**
+ * This file is one of the entry points for the library -- `@duffel/components/custom-elements`.
+ * If you'd like to expose other custom element functions, please add them here.
+ */
 export { onDuffelAncillariesPayloadReady, renderDuffelAncillariesCustomElement, } from "./components/DuffelAncillariesCustomElement";