aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--.gitignore4
-rw-r--r--.npmignore5
-rw-r--r--README.md29
-rw-r--r--package.json2
-rw-r--r--pom.xml105
-rw-r--r--version.properties2
6 files changed, 135 insertions, 12 deletions
diff --git a/.gitignore b/.gitignore
index 48f4a65..e48b1b3 100644
--- a/.gitignore
+++ b/.gitignore
@@ -5,4 +5,6 @@ node_modules/
**/*.js.map
**/*.js
!webpack.config.js
-npm-debug.log \ No newline at end of file
+npm-debug.log
+sdc-pubsub.iml
+node/ \ No newline at end of file
diff --git a/.npmignore b/.npmignore
index 5c6c56b..56d2e84 100644
--- a/.npmignore
+++ b/.npmignore
@@ -10,4 +10,7 @@ version.properties
.idea/
.gitignore
.npm-debug.log
-INFO.yaml \ No newline at end of file
+INFO.yaml
+sdc-pubsub.iml
+node/
+pom.xml \ No newline at end of file
diff --git a/README.md b/README.md
index 5047828..9572095 100644
--- a/README.md
+++ b/README.md
@@ -11,22 +11,30 @@ npm install sdc-pubsub
```
### Loading It Up
-#### ES6
+#### CommonJS
```javascript
import {PluginPubSub} from 'sdc-pubsub'
```
-#### ES5
+#### Global Variable
+
+```html
+<!-- index.html -->
+<script src="./node_Modules/sdc-pubsub/dist/sdc-pubsub.js"></script>
+```
```javascript
-var pluginPubSub = require('PluginPubSub')
+// script.js
+var pubsub = window.sdcPubSub.PluginPubSub;
```
### Usage
#### Initialize a pubsub client
```javascript
-//eventsClientId=<received from query params>
-//parentUrl=<received from query params>
-//eventsToWaitFor = [ “CHECK_IN” ]
+// eventsClientId = client id to be used by the event bus, received from query params
+// parentUrl = event bus location url for communication, received from query params
+// eventsToWaitFor = list of events names that the event hub should wait for their completion.
+// the client should send an "ACTION_COMPLETED" event to the hub in order to notify the event hub to continue with the flow.
+// For example: [ “CHECK_IN” ]
var client = new PluginPubSub('eventsClientId, parentUrl, eventsToWaitFor')
```
@@ -38,6 +46,8 @@ client.notify(“READY”)
#### Register for an event
```javascript
+// When lisetning to event we have to specify the specific event we want to act once it being received.
+// eventData.type will hold the event name that was notified by someone else
client.on((eventData,event) => {
if(eventData.type == ”WINDOW_OUT”) {
//do logic
@@ -48,7 +58,7 @@ client.on((eventData,event) => {
### Dependencies
-* None.
+None.
### Tests
@@ -61,7 +71,10 @@ None.
### Links
-sdc onap wiki [https://wiki.onap.org/x/_TX0](https://wiki.onap.org/x/_TX0)
+* SDC onap wiki [https://wiki.onap.org/x/_TX0](https://wiki.onap.org/x/_TX0)
+* Generic designer support document [https://wiki.onap.org/display/DW/Generic+Designer+Support](https://wiki.onap.org/display/DW/Generic+Designer+Support)
+* Repository [https://gerrit.onap.org/r/gitweb?p=sdc/sdc-pubsub.git;a=summary](https://gerrit.onap.org/r/gitweb?p=sdc/sdc-pubsub.git;a=summary)
+
### License
diff --git a/package.json b/package.json
index 56915c0..58bafb7 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "sdc-pubsub",
- "version": "1.0.18",
+ "version": "1.0.20",
"description": "Publish Subscribe library using post message for sdc plugins",
"main": "index.js",
"author": "Idan Amit",
diff --git a/pom.xml b/pom.xml
new file mode 100644
index 0000000..5457ca3
--- /dev/null
+++ b/pom.xml
@@ -0,0 +1,105 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+
+ <groupId>org.openecomp.sdc</groupId>
+ <artifactId>sdc-pubsub</artifactId>
+ <version>1.0.20</version>
+ <packaging>pom</packaging>
+ <name>SDC Plugin Pubsub</name>
+
+ <properties>
+ <nexus.proxy>https://nexus.onap.org</nexus.proxy>
+ </properties>
+
+ <build>
+ <plugins>
+ <plugin>
+ <artifactId>maven-clean-plugin</artifactId>
+ <version>3.1.0</version>
+ <executions>
+ <execution>
+ <id>clean dist folder and compiled files</id>
+ <phase>clean</phase>
+ <goals>
+ <goal>clean</goal>
+ </goals>
+ <configuration>
+ <filesets>
+ <fileset>
+ <directory>${basedir}</directory>
+ <includes>
+ <include>index.d.ts</include>
+ <include>index.js</include>
+ <include>index.js.map</include>
+ </includes>
+ </fileset>
+ <fileset>
+ <directory>${basedir}/dist</directory>
+ </fileset>
+ <fileset>
+ <directory>${basedir}/lib</directory>
+ <includes>
+ <include>*.d.ts</include>
+ <include>*.js</include>
+ <include>*.js.map</include>
+ </includes>
+ </fileset>
+ </filesets>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ <plugin>
+ <groupId>com.github.eirslett</groupId>
+ <artifactId>frontend-maven-plugin</artifactId>
+ <version>1.6</version>
+ <configuration>
+ <installDirectory>${project.basedir}</installDirectory>
+ </configuration>
+ <executions>
+ <execution>
+ <id>install node and npm</id>
+ <goals>
+ <goal>install-node-and-npm</goal>
+ </goals>
+ <configuration>
+ <nodeVersion>v6.9.5</nodeVersion>
+ <npmVersion>3.10.10</npmVersion>
+ </configuration>
+ </execution>
+
+ <execution>
+ <id>npm set progress off</id>
+ <goals>
+ <goal>npm</goal>
+ </goals>
+ <configuration>
+ <arguments>set progress=false</arguments>
+ </configuration>
+ </execution>
+
+ <execution>
+ <id>npm install</id>
+ <goals>
+ <goal>npm</goal>
+ </goals>
+ <configuration>
+ <arguments>install</arguments>
+ </configuration>
+ </execution>
+
+ <execution>
+ <id>npm run build</id>
+ <goals>
+ <goal>npm</goal>
+ </goals>
+ <configuration>
+ <arguments>run build</arguments>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+</project> \ No newline at end of file
diff --git a/version.properties b/version.properties
index 4d6d32e..af317a0 100644
--- a/version.properties
+++ b/version.properties
@@ -5,7 +5,7 @@
major=1
minor=0
-patch=16
+patch=20
base_version=${major}.${minor}.${patch}