@ossy/deployment-tools 0.0.43 → 0.0.45

package/package.json

@@ -1,25 +1,24 @@
 {
   "name": "@ossy/deployment-tools",
-  "version": "0.0.43",
+  "version": "0.0.45",
   "description": "Collection of scripts and tools to aid deployment of containers and static files to Amazon Web Services through GitHub Actions",
-  "type": "module",
-  "main": "src/index.js",
+  "main": "./src/index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "build": "",
-    "build:docs": "jsdoc src/index.js"
+    "build:docs": "jsdoc ./src/index.js ./package.json"
   },
   "author": "Ossy",
   "license": "ISC",
-  "bin": "src/platform-cli.js",
+  "bin": "./src/platform-cli.js",
   "dependencies": {
     "@actions/core": "^1.10.0",
     "@aws-sdk/client-sqs": "^3.186.0",
     "@aws-sdk/client-sts": "^3.188.0",
     "arg": "^5.0.2",
     "express": "^4.18.1",
-    "nanoid": "^4.0.0",
-    "node-fetch": "^3.2.6"
+    "nanoid": "^3.3.4",
+    "node-fetch": "^2.6.7"
   },
   "devDependencies": {
     "jsdoc": "^3.6.11"

package/src/aws-credentials-client.js

@@ -1,8 +1,8 @@
-import * as core from '@actions/core'
-import { STSClient, AssumeRoleWithWebIdentityCommand } from '@aws-sdk/client-sts'
-import { logInfo, logError } from './log.js'
+const core = require('@actions/core')
+const { STSClient, AssumeRoleWithWebIdentityCommand } = require('@aws-sdk/client-sts')
+const { logInfo, logError } = require('./log')
 
-export class AwsCredentialsClient {
+class AwsCredentialsClient {
 
   static resolveAwsCredentials(platformConfig) {
     // If awsRoleToAssume is present, then we assume we run in a github workflow
@@ -41,3 +41,7 @@ export class AwsCredentialsClient {
   }
 
 }
+
+module.exports = {
+  AwsCredentialsClient
+}

package/src/caddy-client.js

@@ -1,7 +1,7 @@
-import fetch from 'node-fetch'
-import { logInfo, logError } from './log.js'
+const fetch = require('node-fetch')
+const { logInfo, logError } = require('./log')
 
-export const Matchers = {
+const Matchers = {
   host: host => ({ host: [host] }),
   path: path => ({ path: [path] })
 }
@@ -17,7 +17,7 @@ const Handlers = {
   })
 }
 
-export class CaddyClient {
+class CaddyClient {
 
   static deploy(platformConfig, deploymentRequest) {
 
@@ -105,3 +105,7 @@ export class CaddyClient {
   }
 
 }
+
+module.exports = {
+  CaddyClient
+}

package/src/ci-rest-api.js

@@ -1,7 +1,7 @@
-import express from 'express'
-import { logInfo } from './log.js'
+const express = require('express')
+const { logInfo } = require('./log')
 
-export class CiRestApi {
+class CiRestApi {
 
   static start(platformConfig) {
     const server = express()
@@ -22,3 +22,7 @@ export class CiRestApi {
   }
 
 }
+
+module.exports = {
+  CiRestApi
+}

package/src/cli-commands/deploy-handler.js

@@ -1,8 +1,8 @@
-import arg from 'arg'
-import { logInfo } from '../log.js'
-import { PlatformClient } from '../platform-client.js'
+const arg = require('arg')
+const { logInfo } = require('../log')
+const { PlatformClient } = require('../platform-client')
 
-export const deployHandler = cliArgs => {
+const deployHandler = cliArgs => {
   logInfo({ message: 'Running deploy command' })
 
   const parsedArgs = arg({
@@ -30,3 +30,7 @@ export const deployHandler = cliArgs => {
     pathToOssyFile: parsedArgs['--ossyfile']
   })
 }
+
+module.exports = {
+  deployHandler
+}

package/src/cli-commands/index.js

@@ -1,10 +1,10 @@
-import { logError } from '../log.js'
-import { startHandler } from './start-handler.js'
-import { stopHandler } from './stop-handler.js'
-import { statusHandler } from './status-handler.js'
-import { deployHandler } from './deploy-handler.js'
+const { logError } = require('../log')
+const { startHandler } = require('./start-handler')
+const { stopHandler } = require('./stop-handler')
+const { statusHandler } = require('./status-handler')
+const { deployHandler } = require('./deploy-handler')
 
-export const runCliCommand = ({ name, args }) => {
+const runCliCommand = ({ name, args }) => {
 
   if (!name) return logError({ message: 'No command provided' })
 
@@ -21,3 +21,7 @@ export const runCliCommand = ({ name, args }) => {
 
   commandHandler(args)
 }
+
+module.exports = {
+  runCliCommand
+}

package/src/cli-commands/start-handler.js

@@ -1,9 +1,9 @@
-import arg from 'arg'
-import { platform } from 'os'
-import { logInfo, logError } from '../log.js'
-import { PlatformClient } from '../platform-client.js'
+const arg = require('arg')
+const { platform } = require('os')
+const { logInfo, logError } = require('../log')
+const { PlatformClient } = require('../platform-client')
 
-export const startHandler = cliArgs => {
+const startHandler = cliArgs => {
   logInfo({ message: 'Running start command' })
 
   const Platforms = {
@@ -22,3 +22,7 @@ export const startHandler = cliArgs => {
 
   PlatformClient.start(parsedArgs['--platforms'])
 }
+
+module.exports = {
+  startHandler
+}

package/src/cli-commands/status-handler.js

@@ -1,7 +1,11 @@
-import { exec } from 'child_process'
-import { logInfo } from '../log.js'
+const { exec } = require('child_process')
+const { logInfo } = require('../log')
 
-export const statusHandler = () => {
+const statusHandler = () => {
   logInfo({ message: 'Running status command' })
   exec('systemctl status deployment-tools.service')
 }
+
+module.exports = {
+  statusHandler
+}

package/src/cli-commands/stop-handler.js

@@ -1,7 +1,11 @@
-import { exec } from 'child_process'
-import { logInfo } from '../log.js'
+const { exec } = require('child_process')
+const { logInfo } = require('../log')
 
-export const stopHandler = () => {
+const stopHandler = () => {
   logInfo({ message: 'Running stop command' })
   exec('systemctl stop deployment-tools.service')
 }
+
+module.exports = {
+  stopHandler
+}

package/src/deployment-queue-client.js

@@ -1,13 +1,13 @@
-import {
+const {
   SQSClient,
   SendMessageCommand,
   DeleteMessageCommand,
   ReceiveMessageCommand
-} from '@aws-sdk/client-sqs'
-import { AwsCredentialsClient } from './aws-credentials-client.js'
-import { logInfo, logError, logDebug } from './log.js'
+} = require('@aws-sdk/client-sqs')
+const { AwsCredentialsClient } = require('./aws-credentials-client.js')
+const { logInfo, logError, logDebug } = require('./log')
 
-export class DeploymentQueueClient {
+class DeploymentQueueClient {
 
   static sendDeploymentRequest(platformConfig, deploymentRequest) {
     logInfo({ message: '[DeploymentQueueClient] Starting deployment sequence' })
@@ -72,3 +72,7 @@ export class DeploymentQueueClient {
   }
 
 }
+
+module.exports = {
+  DeploymentQueueClient
+}

package/src/docker-client.js

@@ -1,14 +1,9 @@
-import { exec } from 'child_process'
-import fs from 'fs'
-import { nanoid } from 'nanoid'
-import path from 'path'
-import { fileURLToPath } from 'url'
-import { logInfo, logError } from './log.js'
+const { exec } = require('child_process')
+const fs = require('fs')
+const { nanoid } = require('nanoid')
+const { logInfo, logError } = require('./log')
 
-const __filename = fileURLToPath(import.meta.url)
-const __dirname = path.dirname(__filename)
-
-export class DockerClient {
+class DockerClient {
 
   static createDockerNetworkForContainerManagerServer(platformConfig) {
     logInfo({ message: '[DockerClient] Creating docker network for comunication between containers' })
@@ -77,3 +72,7 @@ ${DockerClient.startContainer(platformConfig, deploymentRequest)}`
   }
 
 }
+
+module.exports = {
+  DockerClient
+}

package/src/index.js

@@ -1,3 +1,9 @@
-export { PlatformClient } from './platform-client.js'
-export { PlatformTemplateService } from './platform-template.js'
-export { PlatformConfigService } from './platform-config.js'
+const { PlatformClient } = require('./platform-client')
+const { PlatformTemplateService } = require('./platform-template')
+const { PlatformConfigService } = require('./platform-config')
+
+module.exports = {
+  PlatformClient,
+  PlatformTemplateService,
+  PlatformConfigService
+}

package/src/log.js

@@ -14,21 +14,27 @@ const TypeOfMessage = {
 const log = (...params) => { console.log(...params) }
 const prefixTo = (prefix, message) => `[${prefix}]${message.startsWith('[') ? '' : ': '}`
 
-export const logInfo = logInput => {
+const logInfo = logInput => {
   const messagePrefix = prefixTo(TypeOfMessage.Info, logInput.message)
   log(`${messagePrefix}${logInput.message}`)
 }
 
-export const logError = logInput => {
+const logError = logInput => {
   const messagePrefix = prefixTo(TypeOfMessage.Error, logInput.message)
   log(`${messagePrefix}${logInput.message}`)
   logInput.error && log('\n[Reason]:', logInput.error, '\n')
 }
 
-export const logDebug = logInput => {
+const logDebug = logInput => {
   const isDebugOn = process.env.DEBUG || false
   if (!isDebugOn) return
   const messagePrefix = prefixTo(TypeOfMessage.Debug, logInput.message)
   log(`${messagePrefix}${logInput.message}`)
   logInput.data && log('\n[Debug data]:', logInput.data, '\n')
 }
+
+module.exports = {
+  logInfo,
+  logError,
+  logDebug
+}

package/src/platform-cli.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { runCliCommand } from './cli-commands/index.js'
+const { runCliCommand } = require('./cli-commands/index')
 
 //eslint-disable-next-line no-unused-vars
 const [_, __, command, ...restArgs] = process.argv

package/src/platform-client.js

@@ -1,16 +1,16 @@
-import { resolve } from 'path'
-import { readFileSync } from 'fs'
-import { SupportedDeploymentTypes } from './types.js'
-import { PlatformTemplateService } from './platform-template.js'
-import { PlatformConfigService } from './platform-config.js'
-import { CaddyClient } from './caddy-client.js'
-import { DockerClient } from './docker-client.js'
-import { DeploymentQueueClient } from './deployment-queue-client.js'
-import { CiRestApi } from './ci-rest-api.js'
-import { logError } from './log.js'
+const { resolve } = require('path')
+const { readFileSync } = require('fs')
+const { SupportedDeploymentTypes } = require('./types')
+const { PlatformTemplateService } = require('./platform-template')
+const { PlatformConfigService } = require('./platform-config')
+const { CaddyClient } = require('./caddy-client')
+const { DockerClient } = require('./docker-client')
+const { DeploymentQueueClient } = require('./deployment-queue-client')
+const { CiRestApi } = require('./ci-rest-api')
+const { logError } = require('./log')
 
 // journalctl -u service-name.service
-export class PlatformClient {
+class PlatformClient {
 
   static start(platformTemplatesFilePath) {
     PlatformTemplateService.readFromFile(platformTemplatesFilePath).then(([firstPlatformTemplateFound]) => {
@@ -93,3 +93,7 @@ export class PlatformClient {
   }
 
 }
+
+module.exports = {
+  PlatformClient
+}

package/src/platform-config.js

@@ -1,9 +1,6 @@
-import {
-  SupportedEnvironments,
-  SupportedRegions
-} from './types.js'
+const { SupportedEnvironments, SupportedRegions } = require('./types')
 
-export class PlatformConfigService {
+class PlatformConfigService {
 
   static from(template) {
 
@@ -32,3 +29,7 @@ export class PlatformConfigService {
   }
 
 }
+
+module.exports = {
+  PlatformConfigService
+}

package/src/platform-template.js

@@ -1,10 +1,10 @@
-import { resolve } from 'path'
-import { readFileSync } from 'fs'
-import { logError, logInfo } from './log.js'
-// @param {number} [foo=1]
+const { resolve } = require('path')
+const { readFileSync } = require('fs')
+const { logError, logInfo } = require('./log')
 
 /**
  * Platform template definition
+ * @namespace PlatformTemplate
  * @typedef {Object} PlatformTemplate
  * @property {string} platformName - Name of platform
  * @property {string} domain - example.com
@@ -20,7 +20,7 @@ import { logError, logInfo } from './log.js'
  * @property {string} ciServerName - ?
  * @property {string} ciDockerNetworkName - ?
  */
-export class PlatformTemplateService {
+class PlatformTemplateService {
 
   /**
    * Reads the json file that holds the platform templates
@@ -61,3 +61,7 @@ export class PlatformTemplateService {
     return obj
   }
 }
+
+module.exports = {
+  PlatformTemplateService
+}

package/src/types.js

@@ -20,11 +20,11 @@
 //   awsKeyPairName?: string;
 // }
 
-export const SupportedRegions = {
+const SupportedRegions = {
   North: 'eu-north-1'
 }
 
-export const SupportedEnvironments = {
+const SupportedEnvironments = {
   LOCAL: 'local',
   QA: 'qa',
   TEST: 'test',
@@ -32,7 +32,7 @@ export const SupportedEnvironments = {
   PROD: 'prod'
 }
 
-export const SupportedDeploymentTypes = {
+const SupportedDeploymentTypes = {
   Container: 'CONTAINER'
   // Static = 'STATIC'
 }
@@ -63,3 +63,9 @@ export const SupportedDeploymentTypes = {
 //   authentication?: string;
 //   username?: string;
 // }
+
+module.exports = {
+  SupportedRegions,
+  SupportedEnvironments,
+  SupportedDeploymentTypes
+}