@croct/plug 0.16.2 → 0.16.3

package/README.md

@@ -1,196 +1,56 @@
 <p align="center">
-   <img width="100%" alt="Plug JS" title="Plug JS" src="https://user-images.githubusercontent.com/943036/99672355-0c7aee80-2a52-11eb-9e89-012567237af9.png">
+  <a href="https://croct.com" target="_blank">
+    <picture>
+        <source media="(min-width: 769px) and (prefers-color-scheme: light)" srcset="https://github.com/croct-tech/plug-js/blob/master/.github/assets/header-light.svg">
+        <source media="(min-width: 769px) and (prefers-color-scheme: dark)" srcset="https://github.com/croct-tech/plug-js/blob/master/.github/assets/header-dark.svg">
+        <source media="(max-width: 768px) and (prefers-color-scheme: dark)" srcset="https://github.com/croct-tech/plug-js/blob/master/.github/assets/header-dark-mobile.svg">
+        <source media="(max-width: 768px) and (prefers-color-scheme: light)" srcset="https://github.com/croct-tech/plug-js/blob/master/.github/assets/header-light-mobile.svg">
+        <img src="https://github.com/croct-tech/plug-js/blob/master/.github/assets/header-light-mobile.svg" alt="Croct JavaScript SDK" title="Croct JavaScript SDK" width="100%">
+    </picture>
+  </a>
+  <br/>
+  <strong>Croct JavaScript SDK</strong><br/>
+  Bring dynamic, personalized content natively into your applications.
 </p>
-
-<br/><br/>
-
+<div align="center">
+    <strong>📘 <a href="https://docs.croct.com/reference/sdk/javascript/installation">Quick start &rarr;</a></strong>
+</div>
+<br/>
 <p align="center">
     <a href="https://www.npmjs.com/package/@croct/plug"><img alt="Version" src="https://img.shields.io/npm/v/@croct/plug"/></a>
-    <a href="https://github.com/croct-tech/plug-js/actions?query=workflow%3AValidations"><img alt="Build" src="https://github.com/croct-tech/plug-js/workflows/Validations/badge.svg"/></a>
-    <a href="https://codeclimate.com/repos/5e7251a86589d75edf000f9e/maintainability"><img alt="Maintainability" src="https://api.codeclimate.com/v1/badges/2288af031dccbec256d9/maintainability"/></a>
-    <a href="https://codeclimate.com/repos/5e7251a86589d75edf000f9e/test_coverage"><img alt="Coverage" src="https://api.codeclimate.com/v1/badges/2288af031dccbec256d9/test_coverage"/></a>
     <img alt="Gzipped bundle size" src="https://img.badgesize.io/https:/cdn.croct.io/js/v1/lib/plug.js?style=flat&compression=gzip" />
-    <br /> <br /> <br/>
-    <a href="https://github.com/croct-tech/plug-js/releases">📦 Releases</a>
-    ·
-    <a href="https://github.com/croct-tech/plug-js/issues/new?labels=bug&template=bug-report.md">🐞 Report Bug</a>
-    ·
-    <a href="https://github.com/croct-tech/plug-js/issues/new?labels=enhancement&template=feature-request.md">✨ Request Feature</a>
+    <a href="https://codeclimate.com/repos/5e7251a86589d75edf000f9e/test_coverage"><img alt="Coverage" src="https://api.codeclimate.com/v1/badges/2288af031dccbec256d9/test_coverage"/></a>
 </p>
 
-## Overview
+## Introduction
 
-Plug JS is the easiest way to collect, manage, and consume real-time data to fuel personalized experiences. 
-A single line of code gives you a fully-featured devkit for building natively personalized applications.
-
-- **Zero configuration.** No setup steps required.
-- **No backend necessary.** Deliver personalized experiences from static sites.
-- **Fast queries.** Double-digit millisecond latency for real-time evaluations.
-- **Fully extensible API.** Easily add and share new features via plugins.
-- **Type-Safe.** Typescript typings included.
-- **Playground integration** One-click to connect, no configuration needed.
+Croct is a headless CMS that helps you manage content, run AB tests, and personalize experiences without the hassle of complex integrations.
 
 ## Installation
 
-There are two ways to install the Croct SDK: 
-
-### NPM
-
-The recommended way to install the SDK is via [NPM](https://npmjs.com). It pairs nicely with module bundlers such as 
-Webpack or Browserify and includes Typescript typings.
-
-In most cases, it should be as simple as running the following in your project:
+Run this command to install the SDK:
 
 ```sh
 npm install @croct/plug
 ```
-
-Then, call [`croct.plug`](docs/plug.md#plug) passing the App ID to initialize the SDK:
-
-```js
-import croct from '@croct/plug';
-
-croct.plug({appId: '<APP_ID>'});
-```
-
-### Script Tag
-
-To install the SDK as a script tag, add the following line to the `<head>` tag of your site on any pages you plan to use the SDK to personalize or track events:
-
-```html
-<script src="https://cdn.croct.io/js/v1/lib/plug.js?appId=<APP_ID>"></script>
-<script>croct.plug();</script>
-```
-
-You should replace the `<APP_ID>` placeholder with the respective App ID. For more information about the available options, see [`croct.plug`](docs/plug.md#plug).
-
-## Getting Started
-
-> 🏖️ **Just for your convenience**  
-> We will use CodePen throughout the tutorial to let you play with the examples right in your browser.
-
-Follow the steps below to connect the playground with CodePen:
-
-1. [Open the playground](http://play.croct.com/)
-2. Click on the _"Don't have an API Key?"_ link to proceed in sandbox mode
-3. Enter the URL `https://codepen.io/pen`
-4. Click on _"Let's play!"_
-
-<br />
-
-<p align="center">
-    <img src="https://user-images.githubusercontent.com/943036/99390593-a8242780-28b7-11eb-8966-761aea2b3b3d.gif" alt="Connecting" title="Connecting" width="600" />
-</p>
-
-> 💡️ **Hint**  
-> You will typically use an API key to connect to your development, staging, or production environments in real cases,
-> but you can also use a local URL, such as `https://localhost/myapp`.
-
-Now, try evaluating the expression below:
-
-```
-user is returning
-```
-
-After clicking on the _Evaluate_ button, you will see the result at the bottom of the page, which is either `true` or 
-`false` depending on whether it is the first time playing with this example.
-
-Let's now implement our first personalization feature. Click on the three-dots icon on the editor's top right corner 
-and select _"Open in CodePen"_. Then, copy the code below and paste into the HTML panel:
-
-```html
-<button onclick="hey()">👋 Say hey</button>
-
-<script>  
-  function welcome() {
-    if (confirm('Welcome! Do you want to take a look at our quick start guide?')) {
-      window.open('https://croct.link/plug-js/quick-start');
-    }
-  }
-  
-  function welcomeBack() {
-    if (confirm('Welcome back! How about joining us on Slack this time?')) {
-      window.open('https://croct.link/community');
-    }
-  }
-  
-  function hey() {
-    croct.evaluate('user is returning')
-       .then(returning => returning ? welcomeBack() : welcome()); 
-  }
-</script>
-```
-
-Try clicking _"👋 Say Hey"_, and you should see a personalized greeting.
-
-🎉 **Congratulations!** You have successfully implemented your first personalization feature using Croct. For a more 
-in-depth walk-through, check out our [quick start guide](docs/quick-start.md). 
+See our [quick start guide](https://docs.croct.com/reference/sdk/javascript/installation) for more details.
 
 ## Documentation
 
-The following references provide guidance to help you get started, integrate, and troubleshoot problems:
-
-- [Quick Start Guide](docs/quick-start.md)
-- [Plug Reference](docs/plug.md)
-- [Tracker Reference](docs/tracker.md)
-- [Evaluator Reference](docs/evaluator.md)
-- [Event Reference](docs/events.md)
-- [Patch Reference](docs/patch.md)
-- [User Reference](docs/user.md)
-- [Session Reference](docs/session.md)
-- [Testing](docs/testing.md)
-- [Troubleshooting](docs/troubleshooting.md)
-
-If you are new to the Croct platform, the [quick start guide](docs/quick-start.md) is a good starting point for 
-application developers to begin learning the essential concepts.
+Visit our [official documentation](https://docs.croct.com/reference/sdk/javascript/installation).
 
 ## Support
 
-If the [troubleshooting section](docs/troubleshooting.md) does not cover your problem, don't worry, there are 
-alternative ways to get help from the Croct community.
-
-### Stack Overflow
-
-Someone else from the community may have already asked a similar question or may be able to help with your problem. 
-
-The Croct team will also monitor posts with the "croct" tag. If there aren't any existing questions that help,
-please [ask a new one](https://stackoverflow.com/questions/ask?tags=croct%20plugjs).
+Join our official [Slack channel](https://croct.link/community) to get help from the Croct team and other developers.
 
-### GitHub
+## Contribution
 
-If you have what looks like a bug, or you would like to make a feature request, please 
-[open a new issue on GitHub](https://github.com/croct-tech/plug-js/issues/new/choose).
-
-Before you file an issue, a good practice is to search for issues to see whether others have the same or similar problems. 
-If you are unable to find an open issue addressing the problem, then feel free to open a new one. 
-
-### Slack Channel
-
-Many people from the Croct community hang out on the Croct Slack Group. 
-Feel free to [join us and start a conversation](https://croct.link/community).
-
-## Contributing
-
-Contributions to the package are always welcome! 
+Contributions are always welcome! 
 
 - Report any bugs or issues on the [issue tracker](https://github.com/croct-tech/plug-js/issues).
 - For major changes, please [open an issue](https://github.com/croct-tech/plug-js/issues) first to discuss what you would like to change.
-- Please make sure to update tests as appropriate.
-
-## Testing
-
-Before running the test suites, the development dependencies must be installed:
-
-```sh
-npm install
-```
-
-Then, to run all tests:
-
-```sh
-npm test
-```
+- Please make sure to update tests as appropriate. Run tests with `npm test`.
 
 ## License
 
-This project is released under the [MIT License](LICENSE).
+This library is licensed under the [MIT license](LICENSE).

package/constants.d.ts

@@ -2,4 +2,4 @@ export declare const CDN_URL = "https://cdn.croct.io/js/v1/lib/plug.js";
 export declare const PLAYGROUND_ORIGIN = "https://play.croct.com";
 export declare const PLAYGROUND_CONNECT_URL = "https://play.croct.com/connect.html";
 export declare const PREVIEW_WIDGET_ORIGIN = "https://cdn.croct.io";
-export declare const PREVIEW_WIDGET_URL = "https://cdn.croct.io/js/v1/lib/plug/widget-0.16.2.html";
+export declare const PREVIEW_WIDGET_URL = "https://cdn.croct.io/js/v1/lib/plug/widget-0.16.3.html";

package/constants.js

@@ -5,5 +5,5 @@ exports.CDN_URL = 'https://cdn.croct.io/js/v1/lib/plug.js';
 exports.PLAYGROUND_ORIGIN = 'https://play.croct.com';
 exports.PLAYGROUND_CONNECT_URL = 'https://play.croct.com/connect.html';
 exports.PREVIEW_WIDGET_ORIGIN = 'https://cdn.croct.io';
-exports.PREVIEW_WIDGET_URL = 'https://cdn.croct.io/js/v1/lib/plug/widget-0.16.2.html';
+exports.PREVIEW_WIDGET_URL = 'https://cdn.croct.io/js/v1/lib/plug/widget-0.16.3.html';
 //# sourceMappingURL=constants.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@croct/plug",
-  "version": "0.16.2",
+  "version": "0.16.3",
   "description": "A fully-featured devkit for building natively personalized applications.",
   "license": "MIT",
   "author": {
@@ -34,14 +34,14 @@
   },
   "dependencies": {
     "@croct/json": "^2.1.0",
-    "@croct/sdk": "^0.17.4",
+    "@croct/sdk": "^0.17.5",
     "tslib": "^2.7.0"
   },
   "devDependencies": {
     "@croct/eslint-plugin": "^0.7.1",
-    "@rollup/plugin-commonjs": "^26.0.1",
+    "@rollup/plugin-commonjs": "^28.0.0",
     "@rollup/plugin-node-resolve": "^15.2.3",
-    "@rollup/plugin-replace": "^5.0.7",
+    "@rollup/plugin-replace": "^6.0.0",
     "@rollup/plugin-terser": "^0.4.4",
     "@rollup/plugin-typescript": "^11.1.6",
     "@types/jest": "^29.5.12",