chore: add vanilla dispatchAction addon

Author: Bielik20

.prettierignore

@@ -2,3 +2,4 @@ dist/**/*
 coverage/**/*
 node_modules/**/*
 package-lock.json
+addons/vanilla/dispatch-action.js

addons/README.md

@@ -7,10 +7,3 @@ Addon is a piece of code that you can copy and integrate into your workflow.
 > They are NOT officially supported but can serve as an inspiration.
 > 
 > They can be changed or removed without any warning and would NOT be considered a "breaking change".
-
-## RxJs
-
-Version 1.x of PostQuecast relied heavily on RxJs. In newer versions this is no longer the case.
-
-Still, we love RxJs and recognize its power. This is why we prepared the RxJs addon.
-It consists of classes and operators to help you achieve your goals.

addons/rxjs/README.md

@@ -0,0 +1,6 @@
+# RxJs
+
+Version 1.x of PostQuecast relied heavily on RxJs. In newer versions this is no longer the case.
+
+Still, we love RxJs and recognize its power. This is why we prepared the RxJs addon.
+It consists of classes and operators to help you achieve your goals.

addons/tsconfig.json

@@ -1,6 +1,7 @@
 {
   "extends": "../tsconfig.json",
   "compilerOptions": {
+    "allowJs": true,
     "baseUrl": ".",
     "paths": {
       "@wikia/post-quecast": ["../src/index.ts"]

addons/vanilla/README.md

@@ -0,0 +1,7 @@
+# Vanilla
+
+Should you need to dispatch an action from simple iframe you may not want to load PostQuecast library to perform this simple action.
+Or you may not be able to install the package. In such a case you can use simple `dispatchAction` function defined in here.
+Just copy it to you iframe, and you can dispatch without installing anything.
+
+> Note: It is still better to use installed version of PostQuecast. Code within addons directory can change without warning.

addons/vanilla/dispatch-action.js

@@ -0,0 +1,13 @@
+export function dispatchAction(action, channelId) {
+  channelId = channelId || 'default';
+  action.timestamp = Date.now();
+
+  var data = {
+    action: action,
+    channelId: channelId,
+    private: true,
+    libId: '@wikia/post-quecast'
+  };
+
+  top.postMessage(data, '*');
+}

addons/vanilla/dispatch-action.spec.ts

@@ -0,0 +1,35 @@
+import { Action, Communicator, setupPostQuecast } from '@wikia/post-quecast';
+import { transformIntoHostStub } from '../../src/models/host.stub';
+import { dispatchAction } from './dispatch-action';
+
+describe('dispatchAction', () => {
+  const dateMock = jest.spyOn(Date, 'now');
+  let communicatorDefault: Communicator;
+  let communicatorOther: Communicator;
+
+  beforeEach(() => {
+    dateMock.mockReturnValue(10);
+    transformIntoHostStub(window);
+    setupPostQuecast();
+    communicatorDefault = new Communicator();
+    communicatorOther = new Communicator({ channelId: 'other channel' });
+  });
+
+  it('should receive dispatched message', () => {
+    const resultsDefault: Action = [];
+    const resultsOther: Action = [];
+
+    communicatorDefault.addListener((a) => resultsDefault.push(a));
+    communicatorOther.addListener((a) => resultsOther.push(a));
+
+    dispatchAction({ type: 'action A' });
+    dispatchAction({ type: 'action B', payload: 'some data' });
+    dispatchAction({ type: 'action C' }, 'other channel');
+
+    expect(resultsDefault).toEqual([
+      { type: 'action A', timestamp: 10 },
+      { type: 'action B', payload: 'some data', timestamp: 10 },
+    ]);
+    expect(resultsOther).toEqual([{ type: 'action C', timestamp: 10 }]);
+  });
+});

jest.config.js

@@ -11,7 +11,7 @@ module.exports = {
       displayName: 'addons',
       roots: ['<rootDir>/addons'],
       transform: {
-        '^.+\\.tsx?$': 'ts-jest',
+        '^.+\\.[t,j]sx?$': 'ts-jest',
       },
       globals: {
         'ts-jest': {
@@ -25,7 +25,7 @@ module.exports = {
   ],
   collectCoverageFrom: [
     'src/**/*.ts',
-    'addons/**/*.ts',
+    'addons/**/*.[t,j]s',
     '!src/index.ts',
     '!src/**/*.stub.ts',
     '!src/models/host.ts', // there is only interface there, jest is incorrectly interpreting it

src/models/host.stub.ts

@@ -8,6 +8,15 @@ export type HostStub = {
   listeners: Callback[];
 };
 
+export function transformIntoHostStub(input: object): asserts input is HostStub {
+  const stub = createHostStub();
+
+  Object.keys(stub).forEach((key) => {
+    // @ts-ignore
+    input[key] = stub[key];
+  });
+}
+
 export function createHostStub(): HostStub {
   const result: HostStub = {} as any;
   const listeners: Callback[] = [];