prepare-package 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 ITW Creative Works
+
+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.

package/README.md

@@ -0,0 +1,82 @@
+<p align="center">
+  <a href="https://cdn.itwcreativeworks.com/assets/itw-creative-works/images/logo/itw-creative-works-brandmark-black-x.svg">
+    <img src="https://cdn.itwcreativeworks.com/assets/itw-creative-works/images/logo/itw-creative-works-brandmark-black-x.svg" width="100px">
+  </a>
+</p>
+
+<p align="center">
+  <img src="https://img.shields.io/github/package-json/v/itw-creative-works/promo-server.svg">
+  <br>
+  <img src="https://img.shields.io/david/itw-creative-works/promo-server.svg">
+  <img src="https://img.shields.io/david/dev/itw-creative-works/promo-server.svg">
+  <img src="https://img.shields.io/bundlephobia/min/promo-server.svg">
+  <img src="https://img.shields.io/codeclimate/maintainability-percentage/itw-creative-works/promo-server.svg">
+  <img src="https://img.shields.io/npm/dm/promo-server.svg">
+  <img src="https://img.shields.io/node/v/promo-server.svg">
+  <img src="https://img.shields.io/website/https/itwcreativeworks.com.svg">
+  <img src="https://img.shields.io/github/license/itw-creative-works/promo-server.svg">
+  <img src="https://img.shields.io/github/contributors/itw-creative-works/promo-server.svg">
+  <img src="https://img.shields.io/github/last-commit/itw-creative-works/promo-server.svg">
+  <br>
+  <br>
+  <a href="https://itwcreativeworks.com">Site</a> | <a href="https://www.npmjs.com/package/promo-server">NPM Module</a> | <a href="https://github.com/itw-creative-works/promo-server">GitHub Repo</a>
+  <br>
+  <br>
+  <strong>Promo Server</strong> is an NPM module for backend and frontend developers that exposes promotion utilities for ITW Creative Works.
+</p>
+
+## Install Promo Server
+### Install via npm
+Install with npm if you plan to use **Promo Server** in a Node.js project or in the browser.
+```shell
+npm install promo-server
+```
+If you plan to use `promo-server` in a browser environment, you will probably need to use [Webpack](https://www.npmjs.com/package/webpack), [Browserify](https://www.npmjs.com/package/browserify), or a similar service to compile it.
+
+```js
+const promoserver = new (require('promo-server'))();
+```
+
+### Install via CDN
+Install with CDN if you plan to use **Promo Server** only in a browser environment.
+```html
+<script src="https://cdn.jsdelivr.net/npm/promo-server@latest/dist/index.min.js"></script>
+<script type="text/javascript">
+  var promoserver = new PromoServer(); // The script above exposes the global variable 'PromoServer'
+</script>
+```
+
+## Features
+* Useful **promo management** for ITW Creative Works
+
+## Example Setup
+After installing via npm, simply `require` the library and begin enjoying the promo handler.
+```js
+const promoserver = new (require('promo-server'))({
+  app: 'example', // <any string>
+  platform: 'web', // web | electron | extension
+  log: true, // true | false
+  firebase: firebase // reference to firebase (one will be implied if not provided)
+});
+```
+## Usage
+### promoserver.handle(fn)
+
+Set up a handler for new promo updates that will call `fn` when there is a promo update
+```js
+promoserver.handle(function (payload) {
+  console.log('Payload', payload);
+});
+```
+
+### promoserver.setUser(user)
+
+Set the current user so things like `user.plan.id` can be considered for the handler
+```js
+promoserver.setUser({});
+```
+
+## Final Words
+If you are still having difficulty, we would love for you to post a question to [the Promo Server issues page](https://github.com/itw-creative-works/promo-server/issues). It is much easier to answer questions that include your code and relevant files! So if you can provide them, we'd be extremely grateful (and more likely to help you find the answer!)
+
+Ask us to have your project listed! :)

package/dist/index.js

@@ -0,0 +1,52 @@
+const jetpack = require('fs-jetpack');
+const fetch = require('wonderful-fetch');
+const path = require('path');
+const chalk = require('chalk');
+const thisPackageJSON = require('../package.json');
+const theirPackageJSON = require(path.join(process.cwd(), 'package.json'));
+const isLivePreparation = theirPackageJSON.name !== 'prepare-package';
+
+// fix
+theirPackageJSON.main = theirPackageJSON.main || './dist/index.js';
+theirPackageJSON.preparePackage = theirPackageJSON.preparePackage || {};
+theirPackageJSON.preparePackage.input = path.resolve(theirPackageJSON.preparePackage.input || './src');
+theirPackageJSON.preparePackage.output = path.resolve(theirPackageJSON.preparePackage.output || './dist');
+theirPackageJSON.preparePackage.replace = theirPackageJSON.preparePackage.replace || {};
+
+console.log(chalk.blue(`[prepare-package]: Preparing...`));
+console.log(chalk.blue(`[prepare-package]: ${theirPackageJSON.preparePackage.input}`));
+console.log(chalk.blue(`[prepare-package]: ${theirPackageJSON.preparePackage.output}`));
+console.log(chalk.blue(`[prepare-package]: ${theirPackageJSON.main}`));
+
+jetpack.remove(
+  theirPackageJSON.preparePackage.output,
+)
+
+jetpack.copy(
+  theirPackageJSON.preparePackage.input,
+  theirPackageJSON.preparePackage.output,
+)
+
+// Only do this part on the actual package that is using THIS package because we dont't want to replace THIS {version}
+if (isLivePreparation) {
+  function _replaceMain() {
+    let content = jetpack.read(theirPackageJSON.main)
+      // .replace(/{version}/igm, package.version)
+      .replace(/{version}/igm, package.version)
+  }
+  jetpack.write(
+    theirPackageJSON.main,
+    _replaceMain()
+  )
+}
+
+fetch(`https://purge.jsdelivr.net/npm/${theirPackageJSON.name}@latest`, {
+  json: true,
+  tries: 3,
+})
+.then(result => {
+  console.log(chalk.green(`[prepare-package]: Purged... name=${theirPackageJSON.name}`), result);
+})
+.catch(e => {
+  console.log(chalk.red(`[prepare-package]: Failed to purge... name=${theirPackageJSON.name}`, e));
+})

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "prepare-package",
+  "version": "0.0.1",
+  "description": "Prepare a Node.js package before being published",
+  "main": "dist/index.js",
+  "scripts": {
+    "test": "./node_modules/mocha/bin/mocha test/ --recursive --timeout=10000",
+    "start": "node ./src/index.js"
+  },
+  "preparePackage": {
+    "input": "src",
+    "output": "dist",
+    "replace": {}
+  },
+  "engines": {
+    "node": ">=6.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/itw-creative-works/prepare-package.git"
+  },
+  "keywords": [
+    "management",
+    "backend",
+    "frontend",
+    "productivity"
+  ],
+  "author": "ITW Creative Works",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/itw-creative-works/prepare-package/issues"
+  },
+  "homepage": "https://itwcreativeworks.com",
+  "dependencies": {
+    "chalk": "^4.1.2",
+    "fs-jetpack": "^4.3.1",
+    "wonderful-fetch": "^0.0.5"
+  },
+  "devDependencies": {
+    "fs-jetpack": "^4.3.1",
+    "mocha": "^8.0.1"
+  }
+}

package/src/index.js

@@ -0,0 +1,53 @@
+const jetpack = require('fs-jetpack');
+const fetch = require('wonderful-fetch');
+const path = require('path');
+const chalk = require('chalk');
+const thisPackageJSON = require('../package.json');
+const theirPackageJSON = require(path.join(process.cwd(), 'package.json'));
+const isLivePreparation = theirPackageJSON.name !== 'prepare-package';
+
+// fix
+theirPackageJSON.main = theirPackageJSON.main || './dist/index.js';
+theirPackageJSON.preparePackage = theirPackageJSON.preparePackage || {};
+theirPackageJSON.preparePackage.input = path.resolve(theirPackageJSON.preparePackage.input || './src');
+theirPackageJSON.preparePackage.output = path.resolve(theirPackageJSON.preparePackage.output || './dist');
+theirPackageJSON.preparePackage.replace = theirPackageJSON.preparePackage.replace || {};
+
+console.log(chalk.blue(`[prepare-package]: Preparing...`));
+console.log(chalk.blue(`[prepare-package]: ${theirPackageJSON.preparePackage.input}`));
+console.log(chalk.blue(`[prepare-package]: ${theirPackageJSON.preparePackage.output}`));
+console.log(chalk.blue(`[prepare-package]: ${theirPackageJSON.main}`));
+
+jetpack.remove(
+  theirPackageJSON.preparePackage.output,
+)
+
+jetpack.copy(
+  theirPackageJSON.preparePackage.input,
+  theirPackageJSON.preparePackage.output,
+)
+
+// Only do this part on the actual package that is using THIS package because we dont't want to replace THIS {version}
+if (isLivePreparation) {
+  function _replaceMain() {
+    let content = jetpack.read(theirPackageJSON.main)
+      // .replace(/{version}/igm, package.version)
+      .replace(/{version}/igm, package.version)
+  }
+  jetpack.write(
+    theirPackageJSON.main,
+    _replaceMain()
+  )
+}
+
+fetch(`https://purge.jsdelivr.net/npm/${theirPackageJSON.name}@latest`, {
+  json: true,
+  tries: 3,
+})
+.then(result => {
+  // console.log(chalk.green(`[prepare-package]: Purged... name=${theirPackageJSON.name}`), result);
+  console.log(chalk.green(`[prepare-package]: Purged... ${theirPackageJSON.name}`));
+})
+.catch(e => {
+  console.log(chalk.red(`[prepare-package]: Failed to purge... ${theirPackageJSON.name}`, e));
+})