@geins/ralph-module-streamify - npm Package Compare versions

Comparing version 1.0.2 to 1.0.3

lib/module.js

@@ -17,2 +17,4 @@ const path = require('path');
 module.exports = async function(moduleOptions) {
+  const { nuxt } = this;
+
   const options = {
@@ -28,2 +30,4 @@ ...defaults,
 
+  consola.info(`[${options.name}]`, 'Initializing module...');
+
   this.addTemplate({
@@ -41,8 +45,17 @@ src: path.resolve(__dirname, 'module.utils.js'),
 
+  /*
   this.nuxt.hook('components:dirs', dirs => {
     dirs.push({
       path: path.resolve(__dirname, 'components'),
-      prefix: 'Ca',
+      prefix: 'Geins',
       extensions: ['vue']
     });
+  });*/
+
+  this.nuxt.hook('components:dirs', dirs => {
+    dirs.push({
+      path: path.resolve(__dirname, 'components'),
+      prefix: 'Geins',
+      extensions: ['vue']
+    });
   });
@@ -49,0 +62,0 @@

package.json

 {
   "name": "@geins/ralph-module-streamify",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Streamify module for Geins PWA Storefront Ralph",
@@ -18,2 +18,3 @@ "author": {
     "test": "jest",
+    "publish": "npm publish --access public",
     "test:unit": "jest --testRegex \"/test/unit/(.+)\\.test\\.js$\"",
@@ -36,5 +37,3 @@ "test:system": "jest --testRegex \"/test/system/(.+)\\.test\\.js$\"",
   },
-  "dependencies": {
-    "consola": "^2.3.2"
-  }
+  "dependencies": {}
 }

README.md

@@ -1,1 +0,131 @@
-# ralph-module-streamify
+[![NPM Package][npm]][npm-url]
+[![NPM Downloads][npm-downloads-per-month]][npm-trends]
+
+# Streamify module for Geins PWA Storefront Ralph
+
+A module for Geins PWA Storefront Ralph that adds streamify liveshopping streams to your storefront.
+
+## Pre-requisites
+
+- Geins Account and PWA Storefront Ralph. [Get a free trial here](https://www.geins.io)
+- Streamify Account. [Get a one here](https://www.streamify.io/)
+
+## Description
+
+This module enables you to add streamify liveshopping streams to your storefront in seconds. You can add past, present or future streams.
+
+Module can be used in any page of your storefront and is configuerd to work with Geins Cart out-of-box. Module can be added via Geins CMS or any CMS of your choice.
+
+## Installation
+
+### 1. Install the module
+
+```bash
+npm i @geins/streamify-module
+```
+
+### 2. Add the module to your Geins PWA Storefront Ralph
+
+Add the module to your Geins PWA Storefront Ralph by adding the following line to your `nuxt.config.json` file:
+
+```json
+...
+  modules: [
+    [
+        '@geins/ralph-module-streamify',
+        {
+            enabled: true,
+            debug: true,
+            apiToken: 'your-streamify-api-token',
+        }
+    ]
+  ],
+```
+
+### 3. CaWidgetJson
+
+### 3. If you already have overridden the CaWidgetJson
+
+## Module Options
+
+Add extra options to module configuration in `nuxt.config.json` file.
+| Parameter | Default | Example |
+|-|-|-|
+| enabled | `true` | Enables the module|
+| debug | `false` | Enables debug info to console |
+| apiToken | none | Your token to use Streamify API |
+| apiBaseUrl | `https://api.streamify.io'` | Base Url to API |
+| apiEndpointGetStreams | `/live/broadcast?type=upcoming&direction=asc&per_page=1` | API Endpoint to list streams |
+
+## Usage
+
+Add component to desired page of your storefront. Either by cms or as a component. You can add id to the component to show a specific stream. If no id is added the component will show the next upcoming or live stream.
+
+## Component
+
+Component name is `CaWidgetStreamify`.
+
+### Events
+
+The component emits events that translates to your Geins Cart.
+
+### Properties
+
+The properties of the component are one to one with the [Streamify Floating Player API](https://developer.streamify.io/#floating-player-js-introduction). You can add any property to the component and it will be passed to the API.
+
+| Property        | Type    | Default Value | Required | Description                                                                                        |
+| --------------- | ------- | ------------- | -------- | -------------------------------------------------------------------------------------------------- |
+| configuration   | Object  | -             | No       | Configuration object to set properties for the widget                                              |
+| id              | String  | -             | Yes      | The ID of the stream                                                                               |
+| orientation     | String  | 'landscape'   | No       | The orientation of the player. Possible values: 'landscape' or 'portrait'                          |
+| playButton      | Boolean | false         | No       | Determines whether to show the play button                                                         |
+| autoStart       | Boolean | false         | No       | Opens the minified player if the broadcast is live                                                 |
+| persistent      | Boolean | true          | No       | Determines whether the player is persisted as a mini-player while navigating between pages         |
+| googleAnalytics | Boolean | true          | No       | Enables Google Analytics integration                                                               |
+| buttonText      | String  | -             | No       | The text to customize the button in the banner. Defaults to the broadcast title if not set or used |
+| hideButton      | Boolean | false         | No       | Determines whether to hide the play button in the banner                                           |
+| hideCalendar    | Boolean | false         | No       | Determines whether to hide the calendar in the banner                                              |
+| hideTitle       | Boolean | false         | No       | Determines whether to hide the title in the banner                                                 |
+| infoButton      | Boolean | true          | No       | Determines whether to display an info button if the broadcast has a description                    |
+
+_The `configuration` object will be overriden by any property added to the component._
+
+### Use with Geins CMS
+
+Add a `JSON Widget` to your page in the [Geins CMS](https://docs.geins.io/docs/launchpads/web/content). Add the following JSON to your widget. Replace `your-stream-id` with the id of the stream you want to show. You can find the id in the Streamify App or in the Streamify.
+
+```json
+{
+  "renderWidget": "CaWidgetStreamify",
+  "data": {
+    "id": "your-stream-id",
+    "orientation": "landscape",
+    "autostart-if-live": "true",
+    "button-text": "Watch the UNBOXING of the new iPhone",
+    "ga": "true"
+  }
+}
+```
+
+All properties of the Stremify Floating Player JS can be added to the JSON. Read documentation [here](https://developer.streamify.io/#floating-player-js-introduction). Use the same name as in the streamify documentation to add properties to the JSON. The data part of the JSON is passed to the component as the `configuration` property.
+
+_If you want to show the next upcoming or live stream, remove the `id` property from the JSON._
+
+### As a component or with any CMS
+
+Add the component to your page. Add the id of the stream you want to show as a property to the component. You can find the id in the Streamify App or in the Streamify.
+
+```vue
+<CaStreamify id="your-stream-id" />
+```
+
+### Tips!
+
+- Add the component without an id and you can always start a live stream by adding a new stream in Streamify or starting a spontanius stream form your Streamify App.
+
+- Add the id of the stream to the component to keep past streams available on PDP pages.
+
+[npm]: https://img.shields.io/npm/v/@geins/ralph-module-streamify
+[npm-url]: https://www.npmjs.com/package/@geins/ralph-module-streamify
+[npm-downloads-per-month]: https://img.shields.io/npm/dm/@geins/ralph-module-streamify.svg
+[npm-trends]: https://npmtrends.com/@geins/ralph-module-streamify

No alert changes

Improved metrics

Total package byte prevSize

20290

49.66%

Dependency count

0

-100%

Lines of code

197

4.79%

Number of lines in readme file

132

6500%

Dependency changes

• - Removed

  consola@^2.3.2

• - Removed

  consola@2.15.3
  (transitive)