Prepare SDK for public release

Author: marcospassos

.github/workflows/branch-validations.yaml

@@ -50,8 +50,6 @@ jobs:
         if: steps.cache-dependencies.outputs.cache-hit != 'true'
         run: npm ci
 
-      - run: npm run validate
-
   lint:
     runs-on: ubuntu-18.04
     steps:

.github/workflows/deploy-published-releases.yaml

@@ -19,33 +19,45 @@ jobs:
       - uses: actions/setup-node@v1
         with:
           node-version: 12
-          registry-url: 'https://npm.pkg.github.com'
 
       - name: Cache dependencies
         id: cache-dependencies
         uses: actions/cache@v1
         with:
           path: node_modules
           key: node_modules-${{ hashFiles('**/package-lock.json') }}
+
       - name: Install dependencies
         if: steps.cache-dependencies.outputs.cache-hit != 'true'
         run: npm ci
 
       - name: Build package
         run: |-
           npm run build
+
+      - name: Prepare release
+        run: |-
+          cp package.json LICENSE README.md build/
           cd build
+          sed -i -e "s~\"version\": \"0.0.0-dev\"~\"version\": \"${GITHUB_REF##*/}\"~" package.json
           sed -i -e "s~<@version@>~${GITHUB_REF##*/}~" constants.js
           sed -i -e "s~<@trackerEndpointUrl@>~${TRACKER_ENDPOINT}~" constants.js
           sed -i -e "s~<@evaluationEndpointUrl@>~${EVALUATION_ENDPOINT}~" constants.js
           sed -i -e "s~<@bootstrapEndpointUrl@>~${BOOTSTRAP_ENDPOINT}~" constants.js
           sed -i -e "s~<@maxExpressionLength@>~${MAX_EXPRESSION_LENGHT}~" constants.js
 
-      - name: Publish to NPM
+      - name: Publish pre-release to NPM
+        if: ${{ github.event.release.prerelease }}
         run: |-
-          cp package.json README.md build/
-          cd build
-          sed -i -e "s~\"version\": \"0.0.0-dev\"~\"version\": \"${GITHUB_REF##*/}\"~" package.json
-          npm publish
+          echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" >> ~/.npmrc
+          npm publish --access public --tag next
+        env:
+          NPM_TOKEN: ${{ secrets.BOT_TOKEN }}
+
+      - name: Publish release to NPM
+        if: ${{ !github.event.release.prerelease }}
+        run: |-
+          echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" >> ~/.npmrc
+          npm publish --access public
         env:
-          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.BOT_TOKEN }}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Croct.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -5,13 +5,14 @@
     <br />
     <strong>SDK JS</strong>
     <br />
-    The official Croct SDK for JavaScript, available for browsers and mobile devices.
+    The official Croct SDK for JavaScript.
 </p>
 <p align="center">
+<a href="https://www.npmjs.com/package/@croct/sdk"><img alt="Version" src="https://img.shields.io/npm/v/@croct/sdk"/></a>
+    <a href="https://bundlephobia.com/result?p=@croct/sdk"><img alt="Gzipped Size" src="https://img.shields.io/bundlephobia/minzip/@croct/sdk"/></a>
     <img alt="Build" src="https://github.com/croct-tech/sdk-js/workflows/Validations/badge.svg" />
     <a href="https://codeclimate.com/repos/5e7251b3172af05fe9000e27/maintainability"><img alt="Maintainability" src="https://api.codeclimate.com/v1/badges/c44df78a3ed891af11bb/maintainability" /></a>
     <a href="https://codeclimate.com/repos/5e7251b3172af05fe9000e27/test_coverage"><img alt="Coverage" src="https://api.codeclimate.com/v1/badges/c44df78a3ed891af11bb/test_coverage" /></a>
-    <img alt="License" src="https://img.shields.io/badge/license-proprietary-lightgrey" />
     <br />
     <br />
     <a href="https://github.com/croct-tech/sdk-js/releases">Releases</a>
@@ -23,12 +24,10 @@
 
 ## Installation
 
-The SDK can be installed via NPM. Before installing, make sure you are authenticated to the GitHub Packages. For more information, see ["Authenticating to GitHub Packages."](https://help.github.com/en/packages/using-github-packages-with-your-projects-ecosystem/configuring-npm-for-use-with-github-packages#authenticating-to-github-packages)
-
-Once authenticated, run the following command to install the latest version of the package: 
+The preferred way to install the Croct SDK is to use the NPM package manager. Simply enter the following command into a terminal window:
 
 ```sh
-npm install @croct-tech/sdk
+npm install @croct/sdk
 ```
 
 ## Contributing
@@ -52,7 +51,6 @@ Then, to run all tests:
 npm test
 ```
 
-## Copyright Notice
-Copyright © 2015-2020 Croct Limited, All Rights Reserved.
+## License
 
-All information contained herein is, and remains the property of Croct Limited. The intellectual, design and technical concepts contained herein are proprietary to Croct Limited s and may be covered by U.S. and Foreign Patents, patents in process, and are protected by trade secret or copyright law. Dissemination of this information or reproduction of this material is strictly forbidden unless prior written permission is obtained from Croct Limited.
+This project is released under the [MIT License](LICENSE).

package-lock.json

@@ -1,13 +1,13 @@
 {
-  "name": "@croct-tech/sdk",
+  "name": "@croct/sdk",
   "version": "0.0.0-dev",
   "description": "Croct SDK for JavaScript.",
+  "license": "MIT",
   "author": {
     "name": "Croct",
     "email": "sdk-js+lib@croct.com",
     "url": "https://croct.com"
   },
-  "license": "UNLICENSED",
   "main": "index.js",
   "types": "index.d.ts",
   "repository": {
@@ -19,7 +19,6 @@
   },
   "homepage": "https://github.com/croct-tech/sdk-js#readme",
   "scripts": {
-    "validate": "tsc --noEmit",
     "lint": "eslint 'src/**/*.ts' 'test/**/*.ts'",
     "lint-fix": "eslint --fix --fix-type suggestion --fix-type problem 'src/**/*.ts' 'test/**/*.ts'",
     "test": "jest -c jest.config.js --coverage",
@@ -48,8 +47,5 @@
   ],
   "browserslist": [
     "last 1 version"
-  ],
-  "publishConfig": {
-    "registry": "https://npm.pkg.github.com/"
-  }
+  ]
 }

package.json

@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
-    "module": "es2015",
-    "target": "es5",
+    "module": "CommonJS",
+    "target": "ES5",
     "moduleResolution": "Node",
     "allowSyntheticDefaultImports": true,
     "resolveJsonModule": true,
@@ -13,7 +13,6 @@
     "noUnusedParameters": true,
     "strictNullChecks": true,
     "removeComments": false,
-    "sourceMap": true,
     "outDir": "build",
     "downlevelIteration": true,
     "declaration": true,