Merge pull request #50 from sambauers/sambauers/typescript

.github/workflows/release.yml

@@ -1,7 +1,5 @@
 name: Release
 
-
-
 on:
   workflow_run:
     workflows:
@@ -20,29 +18,22 @@ jobs:
     if: ${{ github.event.workflow_run.conclusion == 'success' }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Setup Node
-        uses: actions/setup-node@v2
-
-      - name: Locate Yarn Cache Directory
-        id: locate-yarn-cache
-        run: echo "::set-output name=dir::$(yarn cache dir)"
-
-      - name: Retrieve Yarn Cache
-        id: retrieve-yarn-cache
-        uses: actions/cache@v2
+        uses: actions/setup-node@v3
         with:
-          path: ${{ steps.locate-yarn-cache.outputs.dir }}
-          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-yarn-
+          node-version-file: '.nvmrc'
+          cache: 'yarn'
 
       - name: Install Packages
         run: yarn install
 
+      - name: Build distribution
+        run: yarn build
+
       - name: Release
-        run: npx semantic-release
+        run: yarn semantic-release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/test.yml

@@ -7,23 +7,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Setup Node
-        uses: actions/setup-node@v2
-
-      - name: Locate Yarn Cache Directory
-        id: locate-yarn-cache
-        run: echo "::set-output name=dir::$(yarn cache dir)"
-
-      - name: Retrieve Yarn Cache
-        id: retrieve-yarn-cache
-        uses: actions/cache@v2
+        uses: actions/setup-node@v3
         with:
-          path: ${{ steps.locate-yarn-cache.outputs.dir }}
-          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-yarn-
+          node-version-file: '.nvmrc'
+          cache: 'yarn'
 
       - name: Install Packages
         run: yarn install

.nvmrc

@@ -0,0 +1 @@
+lts/*

.releaserc

@@ -10,5 +10,16 @@
       "name": "alpha",
       "prerelease": true
     }
+  ],
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    [
+      "@semantic-release/npm",
+      {
+        "pkgRoot": "dist"
+      }
+    ],
+    "@semantic-release/github"
   ]
 }

__tests__/buildCSPHeaders.js → __tests__/buildCSPHeaders.ts

@@ -1,44 +1,18 @@
 // Local imports
-const buildCSPHeaders = require('../lib/buildCSPHeaders')
-
-
-
-
-
-// Local constants
-const DEFAULT_CSP = {
-	'base-uri': '\'none\'',
-	'child-src': '\'none\'',
-	'connect-src': '\'self\'',
-	'default-src': '\'self\'',
-	'font-src': '\'self\'',
-	'form-action': '\'self\'',
-	'frame-ancestors': '\'none\'',
-	'frame-src': '\'none\'',
-	'img-src': '\'self\'',
-	'manifest-src': '\'self\'',
-	'media-src': '\'self\'',
-	'object-src': '\'none\'',
-	'prefetch-src': '\'self\'',
-	'script-src': '\'self\'',
-	'style-src': '\'self\'',
-	'worker-src': '\'self\'',
-}
-
-
-
-
+import buildCSPHeaders from '../src/lib/buildCSPHeaders'
+import { CSP_REQUIRED_DIRECTIVE_DEFAULTS } from '../src/models/CSP'
+import type { NextSafeConfig } from '../src/models/nextSafe'
 
 describe('buildCSPHeaders', () => {
-	function testCSPWithConfig(testName, config) {
+	function testCSPWithConfig(testName: string, config?: NextSafeConfig) {
 		test(testName, () => {
 			const builtCSPHeaders = buildCSPHeaders(config)
 			const expectedCSP = {
-				...DEFAULT_CSP,
+				...CSP_REQUIRED_DIRECTIVE_DEFAULTS,
 				...(config?.contentSecurityPolicy || {}),
 			}
 
-			if (config?.isDev) {
+			if (config?.isDev && config.contentSecurityPolicy !== false) {
 				if (!config.contentSecurityPolicy?.['connect-src']) {
 					expectedCSP['connect-src'] = '\'self\' webpack://*'
 				}

__tests__/buildPermissionsPolicyHeaders.js → __tests__/buildPermissionsPolicyHeaders.ts

@@ -1,7 +1,7 @@
-const buildPermissionsPolicyHeaders = require('../lib/buildPermissionsPolicyHeaders')
+// Local imports
+import buildPermissionsPolicyHeaders from '../src/lib/buildPermissionsPolicyHeaders'
 
 describe('buildPermissionsPolicyHeaders', () => {
-
 	test('with defaults', () => {
 		const result = buildPermissionsPolicyHeaders()
 
@@ -41,5 +41,4 @@ describe('buildPermissionsPolicyHeaders', () => {
 			]
 		)
 	})
-
 })

__tests__/crunchCSPHeaderValue.ts

@@ -0,0 +1,44 @@
+// Local imports
+import crunchCSPHeaderValue from '../src/lib/crunchCSPHeaderValue'
+
+describe('crunchCSPHeaderValue', () => {
+	test('with single header', () => {
+		const crunchedHeaders = crunchCSPHeaderValue({
+			'base-uri': 'header-value',
+		})
+
+		expect(crunchedHeaders).toEqual('base-uri header-value;')
+	})
+
+	test('with multiple headers', () => {
+		const crunchedHeaders = crunchCSPHeaderValue({
+			'base-uri': 'header-value1',
+			'child-src': 'header-value2',
+		})
+
+		expect(crunchedHeaders).toEqual('base-uri header-value1;child-src header-value2;')
+	})
+
+	test('with values array', () => {
+		const crunchedHeaders = crunchCSPHeaderValue({
+			'base-uri': [
+				'header-value1',
+				'header-value2',
+			],
+		})
+
+		expect(crunchedHeaders).toEqual('base-uri header-value1 header-value2;')
+	})
+
+	test('with mixed value types', () => {
+		const crunchedHeaders = crunchCSPHeaderValue({
+			'base-uri': 'header-value1',
+			'child-src': [
+				'header-value2',
+				'header-value3',
+			],
+		})
+
+		expect(crunchedHeaders).toEqual('base-uri header-value1;child-src header-value2 header-value3;')
+	})
+})

__tests__/crunchFeaturePolicyHeader.js → __tests__/crunchFeaturePolicyHeader.ts

@@ -1,9 +1,5 @@
 // Local imports
-const crunchFeaturePolicyHeader = require('../lib/crunchFeaturePolicyHeader')
-
-
-
-
+import crunchFeaturePolicyHeader from '../src/lib/crunchFeaturePolicyHeader'
 
 describe('crunchFeaturePolicyHeader', () => {
 	test('with single header', () => {

__tests__/crunchPermissionsPolicyHeader.js → __tests__/crunchPermissionsPolicyHeader.ts

@@ -1,9 +1,5 @@
 // Local imports
-const crunchPermissionsPolicyHeader = require('../lib/crunchPermissionsPolicyHeader')
-
-
-
-
+import crunchPermissionsPolicyHeader from '../src/lib/crunchPermissionsPolicyHeader'
 
 describe('crunchPermissionsPolicyHeader', () => {
 	test('with single header', () => {

jest.config.js

@@ -4,6 +4,8 @@
  */
 
 module.exports = {
+	preset: 'ts-jest',
+
 	// Automatically clear mock calls and instances between every test
 	clearMocks: true,
 
@@ -14,8 +16,8 @@ module.exports = {
 	moduleDirectories: ['node_modules', 'shared'],
 
 	// An array of file extensions your modules use
-	moduleFileExtensions: ['js'],
+	moduleFileExtensions: ['ts', 'js'],
 
 	// A list of paths to modules that run some code to configure or set up the testing framework before each test
 	setupFilesAfterEnv: [],
-};
+}