--- /dev/null
+# Git will always convert line endings to LF on checkout. You should use this for files that must keep LF endings, even on Windows.
+text eol=lf
\ No newline at end of file
--- /dev/null
+.idea/
+dist/
+node_modules/
+**/*.d.ts
+**/*.js.map
+**/*.js
+!webpack.config.js
\ No newline at end of file
--- /dev/null
+[gerrit]
+host=gerrit.onap.org
+port=29418
+project=sdc-pubsub.git
\ No newline at end of file
--- /dev/null
+**/*.ts
+!**/*.d.ts
+**/*.js.map
+node_modules/
+tsconfig.json
\ No newline at end of file
--- /dev/null
+/*
+* ============LICENSE_START==========================================
+* ===================================================================
+* Copyright © 2018 AT&T Intellectual Property.
+* All rights reserved.
+* ===================================================================
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+* http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+* ============LICENSE_END============================================
+*/
--- /dev/null
+## sdc-pubsub
+
+sdc-pubsub [npm](https://www.npmjs.com/package/sdc-pubsub) package.
+
+### Installation
+
+Installing using npm:
+
+```
+npm install sdc-pubsub
+```
+
+### Loading It Up
+#### ES6
+```javascript
+import {PluginPubSub} from 'sdc-pubsub'
+```
+#### ES5
+
+```javascript
+var pluginPubSub = require('PluginPubSub')
+```
+
+### Usage
+#### Initialize a pubsub client
+```javascript
+//eventsClientId=<received from query params>
+//parentUrl=<received from query params>
+//eventsToWaitFor = [ “CHECK_IN” ]
+
+var client = new PluginPubSub('eventsClientId, parentUrl, eventsToWaitFor')
+```
+
+#### Notify about events
+```javascript
+client.notify(“READY”)
+```
+
+#### Register for an event
+```javascript
+client.on((eventData,event) => {
+ if(eventData.type == ”WINDOW_OUT”) {
+ //do logic
+ }
+ }
+)
+```
+
+### Dependencies
+
+* None.
+
+### Tests
+
+None.
+
+### Authors
+
+* Idan Amit: [https://wiki.onap.org/display/~idanamit](hhttps://wiki.onap.org/display/~idanamit)
+
+
+### Links
+
+sdc onap wiki [https://wiki.onap.org/x/_TX0](https://wiki.onap.org/x/_TX0)
+
+### License
+
+Copyright 2018 AT&T, Inc.
+
+Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0
--- /dev/null
+import { BasePubSub, IPubSubEvent, ISubscriber } from './lib/base-pubsub';
+import { PluginPubSub } from './lib/plugin-pubsub';
+
+export { BasePubSub, PluginPubSub, IPubSubEvent, ISubscriber };
--- /dev/null
+declare const window: Window;
+
+export class BasePubSub {
+
+ subscribers: Map<string, ISubscriber>;
+ eventsCallbacks: Array<Function>;
+ clientId: string;
+ eventsToWait: Map<string, Array<string>>;
+ lastEventNotified: string;
+
+ constructor(pluginId: string) {
+ this.subscribers = new Map<string, ISubscriber>();
+ this.eventsCallbacks = [];
+ this.eventsToWait = new Map<string, Array<string>>();
+ this.clientId = pluginId;
+ this.lastEventNotified = "";
+ this.onMessage = this.onMessage.bind(this);
+
+ window.addEventListener("message", this.onMessage);
+ }
+
+ public register(subscriberId: string, subscriberWindow: Window, subscriberUrl: string) {
+ const subscriber = {
+ window: subscriberWindow,
+ locationUrl: subscriberUrl || subscriberWindow.location.href
+ } as ISubscriber;
+
+ this.subscribers.set(subscriberId, subscriber);
+ }
+
+ public unregister(subscriberId: string) {
+ this.subscribers.delete(subscriberId);
+ }
+
+ public on(callback: Function) {
+ let functionExists = this.eventsCallbacks.find((func: Function) => {
+ return callback.toString() == func.toString()
+ });
+
+ if (!functionExists) {
+ this.eventsCallbacks.push(callback);
+ }
+ }
+
+ public off(callback: Function) {
+ let index = this.eventsCallbacks.indexOf(callback);
+ this.eventsCallbacks.splice(index, 1)
+ }
+
+ public notify(eventType:string, eventData?:any) {
+ let eventObj = {
+ type: eventType,
+ data: eventData,
+ originId: this.clientId
+ } as IPubSubEvent;
+
+ this.subscribers.forEach( (subscriber: ISubscriber, subscriberId: string) => {
+ subscriber.window.postMessage(eventObj, subscriber.locationUrl);
+ });
+
+ this.lastEventNotified = eventType;
+
+ return {
+ subscribe: function(callbackFn) {
+
+ if(this.subscribers.size !== 0) {
+ let subscribersToNotify = Array.from(this.subscribers.keys());
+
+ const checkNotifyComplete = (subscriberId: string) => {
+
+ let index = subscribersToNotify.indexOf(subscriberId);
+ subscribersToNotify.splice(index, 1);
+
+ if (subscribersToNotify.length === 0) {
+ callbackFn();
+ }
+ };
+
+ this.subscribers.forEach((subscriber: ISubscriber, subscriberId: string) => {
+ if (this.eventsToWait.has(subscriberId) && this.eventsToWait.get(subscriberId).indexOf(eventType) !== -1) {
+
+ const actionCompletedFunction = (eventData, subId = subscriberId) => {
+ if (eventData.type == "ACTION_COMPLETED") {
+ checkNotifyComplete(subId);
+ }
+ this.off(actionCompletedFunction);
+
+ };
+ this.on(actionCompletedFunction);
+ }
+ else {
+ checkNotifyComplete(subscriberId);
+ }
+ });
+ }
+ else {
+ callbackFn();
+ }
+ }.bind(this)
+ }
+ }
+
+ public isWaitingForEvent(eventName: string) : boolean {
+ return Array.from(this.eventsToWait.values()).some((eventsList: Array<string>) =>
+ eventsList.indexOf(eventName) !== -1
+ );
+ }
+
+ protected onMessage(event: any) {
+ if (this.subscribers.has(event.data.originId)) {
+ this.eventsCallbacks.forEach((callback: Function) => {
+ callback(event.data, event);
+ })
+ }
+ }
+}
+
+export interface IPubSubEvent {
+ type: string;
+ originId: string;
+ data: any;
+}
+
+export interface ISubscriber {
+ window: Window;
+ locationUrl: string;
+}
--- /dev/null
+import {BasePubSub} from "./base-pubsub";
+
+declare const window: Window;
+
+export class PluginPubSub extends BasePubSub {
+
+ constructor(pluginId: string, parentUrl: string, eventsToWait?: Array<string>) {
+ super(pluginId);
+ this.register('sdc-hub', window.parent, parentUrl);
+ this.subscribe(eventsToWait);
+ }
+
+ public subscribe(eventsToWait?: Array<string>) {
+ const registerData = {
+ pluginId: this.clientId,
+ eventsToWait: eventsToWait || []
+ };
+
+ this.notify('PLUGIN_REGISTER', registerData);
+ }
+
+ public unsubscribe() {
+ const unregisterData = {
+ pluginId: this.clientId
+ };
+
+ this.notify('PLUGIN_UNREGISTER', unregisterData);
+ }
+}
--- /dev/null
+{
+ "name": "sdc-pubsub",
+ "version": "1.0.15",
+ "description": "Publish Subscribe library using post message for sdc plugins",
+ "main": "index.js",
+ "author": "Idan Amit",
+ "license": "Apache-2.0",
+ "scripts": {
+ "clean": "rimraf dist && rimraf lib",
+ "build": "webpack --mode development"
+ },
+ "keywords": [
+ "sdc",
+ "pubsub",
+ "sdc-pubsub",
+ "onap"
+ ],
+ "devDependencies": {
+ "awesome-typescript-loader": "^3.1.3",
+ "typescript": "2.7.2",
+ "webpack": "4.12.0",
+ "webpack-cli": "^3.1.0",
+ "rimraf": "^2.6.2"
+ }
+}
--- /dev/null
+{
+ "compilerOptions": {
+ "moduleResolution": "node",
+ "module": "commonjs",
+ "target": "es5",
+ "lib": [ "es2015", "dom" ],
+ "allowSyntheticDefaultImports": true,
+ "suppressImplicitAnyIndexErrors": true,
+ "forceConsistentCasingInFileNames": true,
+ "sourceMap": true,
+ "declaration": true
+ },
+ "files": [
+ "./index.ts"
+ ],
+ "compileOnSave": false,
+ "buildOnSave": false
+}
\ No newline at end of file
--- /dev/null
+###########################################################
+# Versioning variables
+# Note that these variables cannot be structured (e.g. : version.release or version.snapshot etc... )
+# because they are used in Jenkins, whose plug-in doesn't support
+
+major=1
+minor=0
+patch=14
+
+base_version=${major}.${minor}.${patch}
+
+release_version=${base_version}
+snapshot_version=${base_version}-SNAPSHOT
--- /dev/null
+var path = require("path");
+var webpack = require("webpack");
+var UglifyJsPlugin = require("uglifyjs-webpack-plugin");
+
+var PATHS = {
+ entryPoint: path.resolve(__dirname, 'index.ts'),
+ bundles: path.resolve(__dirname, 'dist'),
+}
+
+var config = {
+ // These are the entry point of our library. We tell webpack to use
+ // the name we assign later, when creating the bundle. We also use
+ // the name to filter the second entry point for applying code
+ // minification via UglifyJS
+ entry: {
+ 'sdc-pubsub': [PATHS.entryPoint],
+ 'sdc-pubsub.min': [PATHS.entryPoint]
+ },
+ // The output defines how and where we want the bundles. The special
+ // value `[name]` in `filename` tell Webpack to use the name we defined above.
+ // We target a UMD and name it MyLib. When including the bundle in the browser
+ // it will be accessible at `window.MyLib`
+ output: {
+ path: PATHS.bundles,
+ filename: '[name].js',
+ libraryTarget: 'umd',
+ library: 'sdcPubSub',
+ umdNamedDefine: true
+ },
+ // Add resolve for `tsx` and `ts` files, otherwise Webpack would
+ // only look for common JavaScript file extension (.js)
+ resolve: {
+ extensions: ['.ts', '.js']
+ },
+ // Activate source maps for the bundles in order to preserve the original
+ // source when the user debugs the application
+ devtool: 'source-map',
+ plugins: [
+ // Apply minification only on the second bundle by
+ // using a RegEx on the name, which must end with `.min.js`
+ // NB: Remember to activate sourceMaps in UglifyJsPlugin
+ // since they are disabled by default!
+ new UglifyJsPlugin({
+ sourceMap: true,
+ include: /\.min\.js$/,
+ })
+ ],
+ module: {
+ // Webpack doesn't understand TypeScript files and a loader is needed.
+ // `node_modules` folder is excluded in order to prevent problems with
+ // the library dependencies, as well as `__tests__` folders that
+ // contain the tests for the library
+ rules: [
+ {
+ test: /\.ts?$/,
+ use: [
+ {
+ loader: 'awesome-typescript-loader',
+ options: {
+ configFileName: 'tsconfig.json'
+ }
+ }
+ ]
+ }]
+ }
+}
+
+module.exports = config;
\ No newline at end of file
Code Review / sdc / sdc-pubsub.git / commitdiff