@builder.io/plugin-commercelayer 0.0.2

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2021 Builder.io, Inc <steve@builder.io>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,86 @@
+# Builder.io CommerceLayer plugin
+
+Easily connect your CommerceLayer APIs to your Builder.io content!
+
+## Installation
+
+Go to [builder.io/account/organization](https://builder.io/account/organization) and type `@builder.io/plugin-commercelayer` , then hit save, a prompt will ask you for your Client ID / Client Secret.
+
+![Installation screenshot](https://cdn.builder.io/api/v1/image/assets%2F6d39f4449e2b4e6792a793bb8c1d9615%2F18a7201313914cccae7f0311a1a614ae)
+
+You will now see three new field types (for [model](https://builder.io/c/docs/guides/getting-started-with-models) fields, [symbol](https://builder.io/c/docs/guides/symbols) inputs, [custom components](https://builder.io/c/docs/custom-react-components) fields), and [custom targeting attributes](https://www.builder.io/c/docs/guides/targeting-and-scheduling#custom-targeting) that can be used in three different contexts:
+
+### Custom targeting
+
+Custom targeting in Builder.io allow users to target content by a multitude of attributes, and in this plugin you'll be able to add specific content to CommerceLayer products, for this you'll need first to set the target attributes on the host site, either by setting the `userAttributes` if you're rendering client side:
+
+```ts
+builder.setUserAttributes({
+  product: currentProduct.id,
+});
+```
+
+Or by passing it as a query param to the [content API](https://www.builder.io/c/docs/query-api#:~:text=userAttributes) call, or in [graqhql query](https://www.builder.io/c/docs/graphql-api#:~:text=with%20targeting) for e.g in Gatsby or nextjs.
+
+- `CommerceLayer Product` when used as a custom targeting type, it'll target contexts where the field is set to the product ID, you'll need to set the product ID on the host environment, using one of the methods above. Alternatively, if you want to target by product handle (slug) use the `CommerceLayer Product Handle` type in your custom targeting attributes.
+
+### Symbol Inputs
+
+Using the field types `CommerceLayer Product` as inputs, the UIs will prompt to search for products. When consumed by APIs, SDKs, or in the Builder.io UIs, the value will be resolved automatically the in the form of a Builder.io `Request` object
+
+```js
+{
+  "yourFieldName": {
+    "@type": "@builder.io/core:Request",
+    "request": {
+      "url": "..."
+    },
+    "data": {
+      // Response data from the API request, e.g.:
+      "product": {
+        /* ... */
+      }
+    }
+  }
+}
+```
+
+## How to develop?
+
+### Install
+
+```bash
+git clone https://github.com/BuilderIO/builder.git
+cd plugins/commercelayer
+npm install
+```
+
+### Run
+
+```bash
+npm start
+```
+
+### Add the plugin in Builder.io
+
+Go to [builder.io/account/organization](https://builder.io/account/organization) and add the localhost URL to the plugin from the plugin settings (`http://localhost:1268/plugin.system.js?pluginId=@builder.io/plugin-commercelayer`)
+
+**NOTE:** Loading `http://` content on an `https://` website will give you a warning. Be sure to click the shield in the top right of your browser and choose "load unsafe scripts" to allow the HTTP content on Builder's HTTPS site when developing locally
+
+<img alt="Load unsafe script example" src="https://i.stack.imgur.com/uSaLL.png">
+
+Now as you develop you can restart Builder to see the latest version of your plugin.
+
+To uninstall your plugin,remove it in the plugins UI
+
+### Seeing the plugin in action
+
+Try creating a custom [model](https://builder.io/c/docs/guides/getting-started-with-models), [component](https://builder.io/c/docs/custom-react-components), or [symbol](https://builder.io/c/docs/guides/symbols) using an CommerceLayer field, and edit away!
+
+<img src="https://i.imgur.com/uVOLn7A.gif" alt="Seeing your plugin in the editor example gif">
+
+### Frameworks
+
+Builder.io uses [React](https://github.com/facebook/react) and [Material UI](https://github.com/mui-org/material-ui) for the UI, and [Emotion](https://github.com/emotion-js/emotion) for styling.
+
+Using these frameworks in Builder plugins ensures a better experience and performance.