@openstax/ts-utils 1.2.8 → 1.2.9

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@openstax/ts-utils",
   "sideEffects": false,
-  "version": "1.2.8",
+  "version": "1.2.9",
   "main": "index.js",
   "types": "index.d.ts",
   "exports": {
@@ -27,7 +27,8 @@
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "script"
   ],
   "typesVersions": {
     "*": {

package/script/bin/copy-from-template.bash

@@ -0,0 +1,32 @@
+#!/usr/bin/env bash
+# spell-checker: ignore pipefail
+set -euo pipefail; if [ -n "${DEBUG-}" ]; then set -x; fi
+
+project_dir=$(pwd)
+
+temp_dir="$(dirname "$(mktemp -u)")/service-template"
+patch_file=$(mktemp -t tst-patch.XXX)
+
+if [ -d "$temp_dir" ]; then
+  cd "$temp_dir"
+  git pull
+else
+  git clone git@github.com:openstax/typescript-service-template.git "$temp_dir"
+  cd "$temp_dir"
+fi
+
+read -d '\n' -r -a sync_ignore <<< "$(awk '{print ":\!*" $0}' "$project_dir/.syncignore")" || true
+
+sync_from=$(git hash-object -t tree /dev/null)
+if [ -f "$project_dir/.lastsync" ]; then
+  sync_from=$(< "$project_dir/.lastsync")
+fi
+
+git rev-parse HEAD > "$project_dir/.lastsync"
+git --no-pager diff --binary "$sync_from" "${sync_ignore[@]}" > "$patch_file"
+
+cd "$project_dir"
+
+git apply --reject --whitespace=nowarn "$patch_file" || true
+
+echo "$project_dir"

package/script/bin/delete-stack.bash

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+# spell-checker: ignore pipefail
+set -euo pipefail; if [ -n "${DEBUG-}" ]; then set -x; fi
+
+if [ -z "${AWS_DEFAULT_REGION:-}" ]; then echo "AWS_DEFAULT_REGION must be set" > /dev/stderr; exit 1; fi
+
+name=$1
+region=$2
+
+printf "\nchecking %s stack..." "$name"
+if AWS_DEFAULT_REGION="$region" yarn -s ts-utils stack-exists "$name"; then
+  printf " deleting it"
+  AWS_DEFAULT_REGION="$region" aws cloudformation delete-stack --region "$region" --stack-name "$name"
+
+  while AWS_DEFAULT_REGION="$region" yarn -s ts-utils stack-exists "$name"; do
+    printf "."
+    sleep 5
+  done
+  echo
+else
+  echo "stack not found."
+fi

package/script/bin/deploy.bash

@@ -0,0 +1,41 @@
+#!/usr/bin/env bash
+# spell-checker: ignore pipefail
+set -euo pipefail; if [ -n "${DEBUG-}" ]; then set -x; fi
+
+source $(yarn -s ts-utils which init-constants-script)
+
+if [ -z "${APPLICATION:-}" ]; then echo "APPLICATION must be set" > /dev/stderr; exit 1; fi
+if [ -z "${OWNER:-}" ]; then echo "OWNER must be set" > /dev/stderr; exit 1; fi
+if [ -z "${PROJECT:-}" ]; then echo "PROJECT must be set" > /dev/stderr; exit 1; fi
+if [ -z "${AWS_DEFAULT_REGION:-}" ]; then echo "AWS_DEFAULT_REGION must be set" > /dev/stderr; exit 1; fi
+
+if [ "$#" -lt 1 ]; then
+  cat <<HEREDOC
+
+  Usage: yarn -s ts-utils deploy <environment>
+
+  Deploys the given $APPLICATION environment
+
+HEREDOC
+
+  exit 1
+fi
+
+ENVIRONMENT=$1
+export ENVIRONMENT;
+
+# this outputs the account alias, eg "openstax" or "openstax-dev-sandbox"
+AWS_ACCOUNT=$(aws iam list-account-aliases --output text --query 'AccountAliases[0]')
+export AWS_ACCOUNT;
+
+if [ -z "$AWS_ACCOUNT" ]; then
+  echo "authorized. aws account not set, make sure you're logged in" > /dev/stderr
+  exit 1
+fi
+
+if [ ! -f "./deploy/deploy.bash" ]; then
+  echo "could not find project deployment script at ./deploy/deploy.bash" > /dev/stderr;
+  exit 1
+fi;
+
+./deploy/deploy.bash

package/script/bin/destroy-deployment.bash

@@ -0,0 +1,60 @@
+#!/usr/bin/env bash
+# spell-checker: ignore pipefail kwarg
+set -euo pipefail; if [ -n "${DEBUG-}" ]; then set -x; fi
+
+source $(yarn -s ts-utils which init-constants-script)
+
+if [ -z "${APPLICATION:-}" ]; then echo "APPLICATION must be set" > /dev/stderr; exit 1; fi
+if [ -z "${OWNER:-}" ]; then echo "OWNER must be set" > /dev/stderr; exit 1; fi
+if [ -z "${PROJECT:-}" ]; then echo "PROJECT must be set" > /dev/stderr; exit 1; fi
+if [ -z "${AWS_DEFAULT_REGION:-}" ]; then echo "AWS_DEFAULT_REGION must be set" > /dev/stderr; exit 1; fi
+
+function print_usage_and_exit() {
+  cat <<HEREDOC
+
+  Usage: yarn -s ts-utils destroy-deployment <environment> [options]
+
+  Destroys the given $APPLICATION environment
+
+  Options:
+    -y - skips confirmation prompts - default: don't skip
+
+HEREDOC
+
+  exit 1
+}
+
+if [ "$#" -lt 1 ]; then
+  print_usage_and_exit
+fi
+
+ENVIRONMENT=$(yarn -s ts-utils get-arg 0 "$@")
+export ENVIRONMENT;
+
+YES=$(yarn -s ts-utils get-kwarg y "$@")
+export YES
+
+if [ -z "$YES" ]; then
+  printf "This will destroy the %s %s environment. Proceed? [y/N]: " "$APPLICATION" "$ENVIRONMENT"
+  read -r do_it
+
+  if [ "$do_it" != "y" ]; then
+    exit 1
+  fi
+fi
+
+# this outputs the account alias, eg "openstax" or "openstax-dev-sandbox"
+AWS_ACCOUNT=$(aws iam list-account-aliases --output text --query 'AccountAliases[0]')
+export AWS_ACCOUNT;
+
+if [ -z "$AWS_ACCOUNT" ]; then
+  echo "authorized. aws account not set, make sure you're logged in" > /dev/stderr
+  exit 1
+fi
+
+if [ ! -f "./deploy/destroy-deployment.bash" ]; then
+  echo "could not find project destroy deployment script at ./deploy/destroy-deployment.bash" > /dev/stderr;
+  exit 1
+fi;
+
+./deploy/destroy-deployment.bash

package/script/bin/empty-bucket.bash

@@ -0,0 +1,28 @@
+#!/usr/bin/env bash
+# spell-checker: ignore pipefail
+set -euo pipefail; if [ -n "${DEBUG-}" ]; then set -x; fi
+
+cliVersion=$(aws --version)
+if [[ "$cliVersion" == aws-cli/2* ]]; then
+  pager=--no-cli-pager
+else
+  pager=
+fi
+
+bucketName=$1
+# Deleting versioned buckets is harder than non-versioned ones
+
+versions=$(aws s3api list-object-versions \
+              --bucket "$bucketName" \
+              --output json \
+              --query '{Objects: Versions[].{Key:Key,VersionId:VersionId}}' \
+              "$pager")
+
+versionsWithQuietFlag="${versions:0:$((${#versions}-1))}, \"Quiet\": true }"
+
+if [[ ${versions} =~ Objects\":\ null ]]; then
+  echo "$bucketName" is empty.
+else
+  echo "Deleting files in $bucketName."
+  aws s3api delete-objects --bucket "$bucketName" --delete "$versionsWithQuietFlag" "$pager"
+fi

package/script/bin/get-arg.bash

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+# spell-checker: ignore pipefail yargs
+set -euo pipefail; if [ -n "${DEBUG-}" ]; then set -x; fi
+
+target=$1
+shift
+args=("$@")
+
+# https://stackoverflow.com/a/61551944/14809536
+node -e "console.log(require('yargs').argv['_']['$target'] || '')" -- yargs "${args[@]+"${args[@]}"}"

package/script/bin/get-deployed-environments.bash

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+# spell-checker: ignore pipefail
+set -euo pipefail; if [ -n "${DEBUG-}" ]; then set -x; fi
+
+source $(yarn -s ts-utils which init-constants-script)
+
+if [ -z "${AWS_DEFAULT_REGION:-}" ]; then echo "AWS_DEFAULT_REGION must be set" > /dev/stderr; exit 1; fi
+
+aws cloudformation describe-stacks --query "Stacks[?Tags[?Key == 'Project' && Value == '$PROJECT'] && Tags[?Key == 'Application' && Value == '$APPLICATION'] && Tags[?Key == 'Environment' && Value != 'shared']].[Tags[?Key=='Environment'].Value]" --output text

package/script/bin/get-env-param.bash

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+# spell-checker: ignore pipefail
+set -euo pipefail; if [ -n "${DEBUG-}" ]; then set -x; fi
+
+source $(yarn -s ts-utils which init-constants-script)
+source $(yarn -s ts-utils which init-params-script)
+
+environment=$(yarn -s ts-utils get-arg 0 "$@")
+param=$(yarn -s ts-utils get-arg 1 "$@")
+
+if [ -z "$environment" ] || [ -z "$param" ]; then
+  cat <<HEREDOC
+  Usage: $(basename ${BASH_SOURCE[0]}) <environment> <parameter name> 
+
+  Shows secret value from AWS parameter store
+HEREDOC
+
+  exit 1
+fi
+
+name=$(get_param_name)
+
+get_parameter

package/script/bin/get-kwarg.bash

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+# spell-checker: ignore pipefail yargs
+set -euo pipefail; if [ -n "${DEBUG-}" ]; then set -x; fi
+
+target=$1
+shift
+args=("$@")
+
+# https://stackoverflow.com/a/61551944/14809536
+node -e "console.log(require('yargs').argv['$target'] || '')" -- yargs "${args[@]+"${args[@]}"}"

package/script/bin/get-stack-param.bash

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+# spell-checker: ignore pipefail
+set -euo pipefail; if [ -n "${DEBUG-}" ]; then set -x; fi
+
+aws cloudformation describe-stacks --stack-name "$1" --output json | \
+  jq -r --arg key "$2" '(.Stacks[0].Outputs // [])[]|select(.OutputKey == $key).OutputValue'

package/script/bin/has-flag.bash

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+# spell-checker: ignore pipefail yargs
+set -euo pipefail; if [ -n "${DEBUG-}" ]; then set -x; fi
+
+target=$1
+shift
+args=("$@")
+
+# https://stackoverflow.com/a/61551944/14809536
+node -e "if (!require('yargs').argv['$target']) { process.exit(1) }" -- yargs "${args[@]+"${args[@]}"}"

package/script/bin/init-constants-script.bash

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+# spell-checker: ignore pipefail
+set -euo pipefail; if [ -n "${DEBUG-}" ]; then set -x; fi
+
+# https://stackoverflow.com/a/28776166
+([[ -n "${ZSH_EVAL_CONTEXT:-}" && "$ZSH_EVAL_CONTEXT" =~ :file$ ]] ||
+ [[ -n "$BASH_VERSION" ]] && (return 0 2>/dev/null)) && sourced=true || sourced=false
+
+if [ "$sourced" == "false" ]; then
+  echo "env files must be sourced" > /dev/stderr
+  exit 1
+fi;
+
+# yarn seems to naturally run things from the project root, so this is just a safety check
+if [ ! -f "./deploy/constants.env" ]; then
+  echo "This command must be run from the project root directory" > /dev/stderr;
+  exit 1
+fi;
+
+source "./deploy/constants.env"

package/script/bin/init-params-script.bash

@@ -0,0 +1,118 @@
+#!/usr/bin/env bash
+# spell-checker: ignore pipefail kwarg urlparam
+set -euo pipefail; if [ -n "${DEBUG-}" ]; then set -x; fi
+
+# https://stackoverflow.com/a/28776166
+([[ -n "${ZSH_EVAL_CONTEXT:-}" && "$ZSH_EVAL_CONTEXT" =~ :file$ ]] ||
+ [[ -n "$BASH_VERSION" ]] && (return 0 2>/dev/null)) && sourced=true || sourced=false
+
+if [ "$sourced" == "false" ]; then
+  echo "env files must be sourced" > /dev/stderr
+  exit 1
+fi;
+
+# note - usually you wouldn't use exit from a sourced script, but this is never sourced
+# into an interactive shell, only as a script helper, so we want it to exit the script
+if [ -z "${APPLICATION:-}" ]; then echo "APPLICATION must be set" > /dev/stderr; exit 1; fi
+if [ -z "${OWNER:-}" ]; then echo "OWNER must be set" > /dev/stderr; exit 1; fi
+if [ -z "${PROJECT:-}" ]; then echo "PROJECT must be set" > /dev/stderr; exit 1; fi
+
+region=$(yarn -s ts-utils get-kwarg r "$@")
+region=${region:-us-east-1}
+
+# Prevent bad behavior when trying to upload URL params on aws cli v1
+aws_version=$(aws --version)
+if [ -z "${aws_version##aws-cli/1.*}" ]; then
+  # true is the default value for aws cli v1
+  original_cli_follow_urlparam=$(aws configure get cli_follow_urlparam || echo 'true')
+
+  function restore_cli_follow_urlparam() {
+    aws configure set cli_follow_urlparam "$original_cli_follow_urlparam"
+  }
+
+  # Needed to upload URLs as secret values. Explanation: https://github.com/aws/aws-cli/issues/2507
+  aws configure set cli_follow_urlparam false
+
+  trap restore_cli_follow_urlparam EXIT
+fi
+
+function get_param_name() {
+  echo "/$APPLICATION/$environment/api/$param"
+}
+
+function get_value() {
+  printf "Enter new value for \"$name\" (leave blank to skip): "
+  read -r value
+}
+
+function get_parameter() {
+  aws ssm get-parameter --region "$region" --name "$name" --with-decryption \
+     --query Parameter.Value --output text 2>&1
+}
+
+function upload_parameter() {
+  set +e
+  previous_value=$(get_parameter)
+  get_parameter_failed=$?
+  set -e
+
+  if [ "$get_parameter_failed" -eq 0 ]; then
+    echo "Parameter \"$name\" already exists"
+
+    if [ -n "${interactive:-}" ]; then
+      echo "Current value: \"$previous_value\""
+
+      get_value
+
+      if [ -z "$value" ]; then
+        echo "Skipping parameter \"$name\" (previous value kept)"
+
+        return
+      fi
+    # The parameter store (or maybe the upload command) removes trailing newlines
+    # Maybe relevant when uploading public/private key certificates
+    elif [ "$value" = "$previous_value" ] || [ "$value" = "$previous_value"$'\n' ]; then
+      echo "Skipping parameter \"$name\" as the new and previous values match"
+
+      return
+    else
+      echo "New and previous values for parameter \"$param\" differ"
+
+      if [ -z "$overwrite" ]; then
+        echo "Skipping parameter \"$name\" as the -o option was not set (previous value kept)"
+
+        return
+      fi
+    fi
+
+    if [ -n "$value" ]; then
+      echo "Overwriting parameter \"$name\" with new value"
+
+      aws ssm put-parameter --region "$region" --type SecureString \
+        --name "$name" --value "$value" --overwrite
+    else
+      echo "Skipping parameter \"$name\" (previous value kept)"
+    fi
+  elif [[ -n "${previous_value##*ParameterNotFound*}" ]]; then
+    # Error is NOT ParameterNotFound
+    printf "%s\n\n" "$previous_value"
+    exit 1
+  else
+    # Error is ParameterNotFound
+    if [ -n "${interactive:-}" ]; then
+      get_value
+
+      if [ -z "$value" ]; then
+        echo "Skipping parameter \"$name\" (not uploaded)"
+
+        return
+      fi
+    fi
+
+    echo "Uploading new parameter \"$name\""
+
+    aws ssm put-parameter --region "$region" --type SecureString --name "$name" --value "$value" \
+      --tags "Key=Project,Value=$PROJECT" "Key=Application,Value=$APPLICATION" \
+             'Key=Environment,Value=shared' "Key=Owner,Value=$OWNER"
+  fi
+}

package/script/bin/stack-exists.bash

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+# spell-checker: ignore pipefail
+set -euo pipefail; if [ -n "${DEBUG-}" ]; then set -x; fi
+
+aws cloudformation describe-stacks --stack-name "$1" > /dev/null 2>&1

package/script/bin/upload-pager-duty-endpoints.bash

@@ -0,0 +1,44 @@
+#!/usr/bin/env bash
+# spell-checker: ignore pipefail kwarg
+set -euo pipefail; if [ -n "${DEBUG-}" ]; then set -x; fi
+
+source $(yarn -s ts-utils which init-constants-script)
+source $(yarn -s ts-utils which init-params-script)
+
+# List all configured PagerDuty endpoints here
+ENDPOINTS=(
+  anytime
+  workday
+)
+
+help=$(yarn -s ts-utils get-kwarg h "$@")
+
+if [ -n "$help" ]; then
+  cat <<HEREDOC
+  Usage: $(basename ${BASH_SOURCE[0]}) [options]
+
+  Uploads PagerDuty endpoints to the AWS parameter store with proper tags
+
+  Options:
+    -h - display this help message and exit
+    -r - set AWS region - default: us-east-1
+
+HEREDOC
+
+  exit 1
+fi
+
+interactive=true
+environment=shared
+
+printf "Find or create your PagerDuty service endpoints here: https://staxly.pagerduty.com/service-directory\n\n"
+
+for endpoint in "${ENDPOINTS[@]}"; do
+  name="/external/pager_duty/$APPLICATION/${endpoint}_endpoint"
+
+  upload_parameter
+
+  echo
+done
+
+printf "\nDone uploading PagerDuty endpoints for $APPLICATION\n\n"

package/script/bin/upload-params.bash

@@ -0,0 +1,59 @@
+#!/usr/bin/env bash
+# spell-checker: ignore pipefail kwarg sparameters
+set -euo pipefail; if [ -n "${DEBUG-}" ]; then set -x; fi
+
+source $(yarn -s ts-utils which init-constants-script)
+source $(yarn -s ts-utils which init-params-script)
+
+if [ -z "${PARAMS:-}" ]; then echo "PARAMS must be set" > /dev/stderr; exit 1; fi
+
+environment=$(yarn -s ts-utils get-arg 0 "$@")
+
+if [ -z "$environment" ]; then
+  cat <<HEREDOC
+  Usage: $(basename "${BASH_SOURCE[0]}") <environment> [options]
+
+  Uploads secret values from your environment to the AWS parameter store with proper tags
+
+  Options:
+    -o - overwrite existing parameters - default: don't overwrite
+    -p - upload set parameters, even if some are missing - default: abort if any are missing
+    -r - set AWS region - default: us-east-1
+
+HEREDOC
+
+  exit 1
+fi
+
+overwrite=$(yarn -s ts-utils get-kwarg o "$@")
+partial=$(yarn -s ts-utils get-kwarg p "$@")
+
+# Check if any params are missing
+params_with_value=
+for param in "${PARAMS[@]}"; do
+  if [ -n "${!param:-}" ]; then
+    params_with_value="$params_with_value $param"
+  else
+    if [ -n "$partial" ]; then
+      echo "\"$param\" not uploaded as it is not set or not exported in your environment"
+    else
+      echo "\"$param\" is not set or not exported in your environment"
+      printf "Please set it first or use the -p option to upload only defined variables\n\n"
+      exit 1
+    fi
+  fi
+done
+
+if [ -z "$params_with_value" ]; then
+  printf '\nAborting: None of the parameters that could be uploaded have values\n\n'
+  exit 1
+fi
+
+for param in $params_with_value; do
+  name="$(get_param_name)"
+  value="${!param}"
+
+  upload_parameter
+done
+
+printf "\nSuccessfully uploaded %sparameters for %s-%s\n\n" "${partial:+partial }" "$environment" "$APPLICATION"

package/script/bin/which.bash

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+# spell-checker: ignore pipefail
+set -euo pipefail; if [ -n "${DEBUG-}" ]; then set -x; fi
+
+project_dir="$( cd "$( dirname "${BASH_SOURCE[0]}" )/../.." >/dev/null 2>&1 && pwd )"
+
+file="$project_dir"/script/bin/"$1".bash
+
+if [ ! -f "$file" ]; then
+  echo "$1 not found" > /dev/stderr;
+  exit 1;
+fi;
+
+echo "$file";

package/script/bin-entry.bash

@@ -0,0 +1,33 @@
+#!/usr/bin/env bash
+# spell-checker: ignore pipefail
+set -euo pipefail; if [ -n "${DEBUG-}" ]; then set -x; fi
+
+project_dir="$(cd "$(dirname "$0")" && cd "$(dirname "$(readlink "$0")")/.." && pwd)"
+
+script=${1-}
+
+bin="$project_dir/script/bin/"
+file="$bin$script.bash"
+
+if [ -z "$script" ]; then
+  printf "specify a command\n\neg:\n  yarn -s ts-utils [command name] [parameters]\n\n"
+
+  find "$bin" -name "*.bash" -exec basename {} \; | sed "s/\.bash//" | sort
+
+  echo
+  exit 1;
+elif [ -n "$script" ] && [ ! -f "$file" ]; then
+  printf "%s is not a valid command. did you mean:\n\n" "$script"
+
+
+  find "$bin" -name "*$script*.bash" -exec basename {} \; | sed "s/\.bash//" | sort
+
+  echo
+  exit 1;
+fi
+
+shift
+args=("$@")
+
+# https://stackoverflow.com/a/61551944/14809536
+"$file" "${args[@]+"${args[@]}"}"

package/script/build.bash

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+# spell-checker: ignore pipefail yargs mkdir withoutspecs
+set -euo pipefail; if [ -n "${DEBUG-}" ]; then set -x; fi
+
+project_dir="$( cd "$( dirname "${BASH_SOURCE[0]}" )/.." >/dev/null 2>&1 && pwd )"
+
+cd "$project_dir";
+
+tsc_args=(--noEmit false --declaration)
+
+if yarn -s ts-utils has-flag watch "$@"; then
+  tsc_args+=(--watch)
+fi
+if yarn -s ts-utils has-flag clean "$@"; then
+  rm -rf "$project_dir"/dist
+fi
+
+mkdir -p dist
+
+yarn -s tsc --project tsconfig.without-specs.esm.json "${tsc_args[@]}"
+yarn -s tsc --project tsconfig.without-specs.cjs.json "${tsc_args[@]}"