add release file (#8)

Author: sdashner

.eslintignore

@@ -1 +1,2 @@
-dist/
+**/dist/**
+**/node_modules/**

.eslintrc.js

@@ -4,25 +4,18 @@ module.exports = {
     ecmaVersion: 2020,
     sourceType: 'module',
   },
-  extends: [
-    'plugin:@typescript-eslint/recommended',
-    'plugin:jsdoc/recommended',
-    // Make sure this is always the last configuration in the extends array.
-    'plugin:prettier/recommended',
-  ],
+  extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended'],
+  plugins: ['@typescript-eslint/eslint-plugin'],
   rules: {
     '@typescript-eslint/no-unused-vars': 'error',
     '@typescript-eslint/explicit-module-boundary-types': 'error',
-    '@typescript-eslint/no-non-null-assertion': 'error',
+    '@typescript-eslint/no-non-null-assertion': 'off',
     '@typescript-eslint/no-explicit-any': 'off',
-    '@typescript-eslint/ban-ts-comment': 'off',
+    '@typescript-eslint/ban-ts-comment': 'error',
   },
   overrides: [
     {
       files: ['**/__tests__/**/*'],
-      rules: {
-        'jsdoc/require-jsdoc': 'off',
-      },
     },
   ],
 };

.github/workflows/release.yml

@@ -0,0 +1,24 @@
+name: 'publish to NPM'
+on:
+  push:
+    tags: ['*']
+
+jobs:
+  publish:
+    runs-on: 'ubuntu-latest'
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 14
+      - run: yarn install
+      - run: yarn build
+
+      - id: 'publish'
+        uses: JS-DevTools/npm-publish@v1
+        with:
+          token: ${{ secrets.NPM_AUTH_TOKEN }}
+
+      - if: steps.publish.outputs.type != 'none'
+        run: |
+          echo "Version changed: ${{ steps.publish.outputs.old-version }} => ${{ steps.publish.outputs.version }}"

CHANGELOG.md

@@ -10,6 +10,12 @@ and this project adheres to
 
 ### TBA
 
+## [v1.0.0] - 2022-10-05
+
+### Added
+
+- Public release
+
 ## [v0.1.0] - 2022-10-05
 
 ### Added

package.json

@@ -1,12 +1,15 @@
 {
   "name": "postmessage-communicator",
-  "version": "0.1.0",
+  "version": "1.0.0",
   "description": "[![Release](https://img.shields.io/github/v/release/wayfair-incubator/oss-template?display_name=tag)](CHANGELOG.md) [![Lint](https://github.com/wayfair-incubator/oss-template/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/wayfair-incubator/oss-template/actions/workflows/lint.yml) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg)](CODE_OF_CONDUCT.md) [![Maintainer](https://img.shields.io/badge/Maintainer-Wayfair-7F187F)](https://wayfair.github.io)",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": ["/dist"],
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "build": "yarn tsc",
+    "lint": "eslint src/**/*.ts",
+    "format": "prettier --write src/**/*.ts",
+    "format:check": "prettier --check src/**/*.ts"
   },
   "repository": {
     "type": "git",

src/classes/ClientCommunicator.ts

@@ -11,10 +11,10 @@ interface InitPayload {
 }
 
 export class ClientCommunicator extends Communicator {
-  init(payload: InitPayload) {
+  init(payload: InitPayload): void {
     this.post({type: ClientEvent.LoginWithToken, payload});
   }
-  refreshWithToken(token: string) {
+  refreshWithToken(token: string): void {
     this.post({type: ClientEvent.RefreshWithToken, payload: token});
   }
 }

src/classes/Communicator.ts

@@ -3,6 +3,8 @@ import {ClientEvent} from './ClientCommunicator';
 
 type EventType = VendorEvent | ClientEvent | string;
 
+type CallBack = (e: MessageEvent) => void;
+
 interface CommunicatorEvent {
   type: EventType;
   payload?: any;
@@ -16,11 +18,11 @@ export class Communicator {
     this.origin = origin;
   }
 
-  updateConfig(target: Window) {
+  updateConfig(target: Window): void {
     this.target = target;
   }
 
-  subscribe(eventType: EventType, cb: (e: MessageEvent) => void) {
+  subscribe(eventType: EventType, cb: CallBack): CallBack {
     const msg = (e: MessageEvent) => {
       if (e.origin !== this.origin || e.data.type !== eventType) {
         return;
@@ -31,11 +33,11 @@ export class Communicator {
     return msg;
   }
 
-  unsubscribe(cb: (e: MessageEvent) => void) {
+  unsubscribe(cb: CallBack): void {
     window.removeEventListener('message', cb);
   }
 
-  post({type, payload = ''}: CommunicatorEvent) {
+  post({type, payload = ''}: CommunicatorEvent): void {
     this.target.postMessage({type, payload}, this.origin);
   }
 }

src/classes/VendorCommunicator.ts

@@ -12,7 +12,7 @@ export enum VendorEvent {
   UnauthorizedToken = 'UnauthorizedToken',
 }
 
-interface MetaData {
+interface Metadata {
   title: string;
   brand: string;
   style: string;
@@ -27,8 +27,8 @@ interface EventPayload {
   customerId: string;
   projectId: string;
   versionId: number;
-  metadata: MetaData;
-  bom?: {};
+  metadata: Metadata;
+  bom?: any;
 }
 
 export class VendorCommunicator extends Communicator {
@@ -38,39 +38,39 @@ export class VendorCommunicator extends Communicator {
     this.origin = origin;
   }
 
-  addToCart(payload: EventPayload) {
+  addToCart(payload: EventPayload): void {
     this.post({type: VendorEvent.AddToCart, payload});
   }
 
-  appInitialized() {
+  appInitialized(): void {
     this.post({type: VendorEvent.AddToCart});
   }
 
-  contactDesigner(payload: EventPayload) {
+  contactDesigner(payload: EventPayload): void {
     this.post({type: VendorEvent.ContactDesigner, payload});
   }
 
-  dirtyStateChanged() {
+  dirtyStateChanged(): void {
     this.post({type: VendorEvent.DirtyStateChanged});
   }
 
-  iframeLoaded() {
+  iframeLoaded(): void {
     this.post({type: VendorEvent.IframeLoaded});
   }
 
-  projectSaved() {
+  projectSaved(): void {
     this.post({type: VendorEvent.ProjectSaved});
   }
 
-  projectDeleted() {
+  projectDeleted(): void {
     this.post({type: VendorEvent.ProjectDeleted});
   }
 
-  tokenRefreshRequested() {
+  tokenRefreshRequested(): void {
     this.post({type: VendorEvent.TokenRefreshRequested});
   }
 
-  unauthorizedToken(error: string) {
+  unauthorizedToken(error: string): void {
     this.post({type: VendorEvent.UnauthorizedToken, payload: error});
   }
 }

tsconfig.json

@@ -3,11 +3,13 @@
     "target": "ES2019",
     "declaration": true,
     "module": "commonjs",
+    "resolveJsonModule": true,
     "outDir": "./dist",
     "rootDir": "./src",
     "strict": true,
     "noImplicitAny": true,
-    "esModuleInterop": true
+    "esModuleInterop": true,
+    "strictNullChecks": true,
   },
   "exclude": ["node_modules", "**/*.test.ts"],
   "include": ["src/**/*"]