@openstax/ts-utils 1.21.11 → 1.23.0

package/dist/esm/types.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Returns the literal type `'yes'` if the first generic tuple array is a prefix of the second,
+ * the `'no'` literal type otherwise. Can be used in conditional types, e.g.
+ *
+ * `type WillBeString = TupleExtends<[1,2], [1,2,3]> extends 'yes' ? string : number;`
+ *
+ * There may be a better way to do this; `T1 extends T2` doesn't work
+ */
+export declare type TupleExtends<T1, T2> = T1 extends [infer T1Head, ...infer T1Tail] ? T2 extends [infer T2Head, ...infer T2Tail] ? T1Head extends T2Head ? TupleExtends<T1Tail, T2Tail> extends 'yes' ? 'yes' : 'no' : 'no' : T2 extends [] ? 'yes' : 'no' : T1 extends [] ? T2 extends [] ? 'yes' : 'no' : 'no';
+/**
+ * unions each member of the tuple
+ */
+export declare type TupleZip<T1, T2> = T1 extends [infer T1Head, ...infer T1Tail] ? T2 extends [infer T2Head, ...infer T2Tail] ? [T1Head & T2Head, ...TupleZip<T1Tail, T2Tail>] : T2 extends [] ? T1 : never : T1 extends [] ? T2 extends any[] ? T2 : never : never;
+/**
+ * If `R` is `Promise<I>`, returns `I`, otherwise returns `R`
+ * @deprecated use TypeScript builtin Awaited instead:
+ * @see https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-5.html#the-awaited-type-and-promise-improvements
+ */
+export declare type UnwrapPromise<R> = R extends Promise<infer I> ? I : R;
+/**
+ * turns `thing | thing2` into `thing & thing2`
+ * @see https://stackoverflow.com/a/50375286/14809536
+ */
+export declare type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends ((k: infer I) => void) ? I : never;
+/**
+ * make certain fields required
+ * @see https://stackoverflow.com/a/69328045/14809536
+ */
+export declare type WithRequired<T, K extends keyof T> = T & {
+    [P in K]-?: T[P];
+};

package/dist/esm/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,15 +1,14 @@
 {
   "name": "@openstax/ts-utils",
-  "version": "1.21.11",
+  "version": "1.23.0",
   "bin": {
     "ts-utils": "./script/bin-entry.bash"
   },
   "dependencies": {
     "@aws-sdk/client-dynamodb": "^3.171.0",
-    "@aws-sdk/client-s3": "^3.744.0",
+    "@aws-sdk/client-s3": "^3.171.0",
     "@aws-sdk/client-ssm": "^3.171.0",
     "@aws-sdk/client-sts": "^3.171.0",
-    "@aws-sdk/s3-request-presigner": "^3.744.0",
     "aws-sdk": "^2.1145.0",
     "cookie": "^0.5.0",
     "date-fns": "^2.29.2",
@@ -24,28 +23,22 @@
   },
   "devDependencies": {
     "@types/cookie": "^0.5.0",
-    "@types/cors": "^2.8.13",
     "@types/deep-equal": "^1.0.1",
-    "@types/express": "^4.17.13",
     "@types/jest": "^29.1.1",
     "@types/jsonwebtoken": "^9.0.1",
     "@types/lodash": "^4.14.200",
     "@types/ms": "^0.7.34",
-    "@types/multer": "^1.4.7",
     "@types/node": "^17.0.35",
     "@types/node-fetch": "^2.6.11",
     "@types/node-jose": "^1.1.12",
     "@types/uuid": "^8.3.4",
     "@typescript-eslint/eslint-plugin": "^5.13.0",
     "@typescript-eslint/parser": "^5.13.0",
-    "cors": "^2.8.5",
     "cspell": "^5.18.5",
     "eslint": "^8.10.0",
     "eslint-plugin-import": "^2.25.4",
     "eslint-plugin-jest": "^26.1.1",
-    "express": "^4.17.3",
     "jest": "^29.1.1",
-    "multer": "^1.4.5-lts.1",
     "node-fetch": "^2.7.0",
     "npm-run-all": "^4.1.5",
     "postgres": "^3.4.5",
@@ -182,10 +175,20 @@
       "import": "./dist/esm/services/apiGateway/index.js",
       "require": "./dist/cjs/services/apiGateway/index.js"
     },
-    "./services/fileServer": {
-      "browser": "./dist/cjs/services/fileServer/index.js",
-      "import": "./dist/esm/services/fileServer/index.js",
-      "require": "./dist/cjs/services/fileServer/index.js"
+    "./services/fileserver": {
+      "browser": "./dist/cjs/services/fileserver/index.js",
+      "import": "./dist/esm/services/fileserver/index.js",
+      "require": "./dist/cjs/services/fileserver/index.js"
+    },
+    "./services/fileserver/localFileServer": {
+      "browser": "./dist/cjs/services/fileserver/localFileServer/index.js",
+      "import": "./dist/esm/services/fileserver/localFileServer/index.js",
+      "require": "./dist/cjs/services/fileserver/localFileServer/index.js"
+    },
+    "./services/fileserver/s3FileServer": {
+      "browser": "./dist/cjs/services/fileserver/s3FileServer/index.js",
+      "import": "./dist/esm/services/fileserver/s3FileServer/index.js",
+      "require": "./dist/cjs/services/fileserver/s3FileServer/index.js"
     },
     "./services/postgresConnection": {
       "browser": "./dist/cjs/services/postgresConnection/index.js",
@@ -200,9 +203,6 @@
   "license": "MIT",
   "main": "index.js",
   "peerDependencies": {
-    "cors": "^2.8.5",
-    "express": "^4.17.3",
-    "multer": "^1.4.5-lts.1",
     "postgres": "^3.4.5",
     "zod": "^3.23.8"
   },

package/script/bin/deploy.bash

@@ -38,4 +38,12 @@ if [ ! -f "./deploy/deploy.bash" ]; then
   exit 1
 fi;
 
+source $(yarn -s ts-utils which init-params-script)
+
+missing_params=$(get_missing_param_names)
+if [ -n "$missing_params" ]; then
+  echo "please upload the following params before deploying: $missing_params"
+  exit 1
+fi
+
 ./deploy/deploy.bash

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

@@ -5,12 +5,12 @@ 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 "$@")
+ENVIRONMENT=$(yarn -s ts-utils get-arg 0 "$@")
 param=$(yarn -s ts-utils get-arg 1 "$@")
 
-if [ -z "$environment" ] || [ -z "$param" ]; then
+if [ -z "$ENVIRONMENT" ] || [ -z "$param" ]; then
   cat <<HEREDOC
-  Usage: $(basename ${BASH_SOURCE[0]}) <environment> <parameter name> 
+  Usage: $(basename ${BASH_SOURCE[0]}) <environment> <parameter name>
 
   Shows secret value from AWS parameter store
 HEREDOC

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

@@ -37,7 +37,7 @@ if [ -z "${aws_version##aws-cli/1.*}" ]; then
 fi
 
 function get_param_name() {
-  echo "/$APPLICATION/$environment/api/$param"
+  echo "/$APPLICATION/$ENVIRONMENT/api/$param"
 }
 
 function get_value() {
@@ -50,6 +50,15 @@ function get_parameter() {
      --query Parameter.Value --output text 2>&1
 }
 
+function get_missing_param_names() {
+  names=()
+  for param in "${PARAMS[@]}"; do
+    name=$param
+    names+=($(get_param_name))
+  done
+  aws ssm get-parameters --region "$region" --names "${names[@]}" --query InvalidParameters --output text 2>&1
+}
+
 function upload_parameter() {
   set +e
   previous_value=$(get_parameter)

package/script/bin/upload-params.bash

@@ -7,9 +7,9 @@ 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 "$@")
+ENVIRONMENT=$(yarn -s ts-utils get-arg 0 "$@")
 
-if [ -z "$environment" ]; then
+if [ -z "$ENVIRONMENT" ]; then
   cat <<HEREDOC
   Usage: $(basename "${BASH_SOURCE[0]}") <environment> [options]
 
@@ -56,4 +56,4 @@ for param in $params_with_value; do
   upload_parameter
 done
 
-printf "\nSuccessfully uploaded %sparameters for %s-%s\n\n" "${partial:+partial }" "$environment" "$APPLICATION"
+printf "\nSuccessfully uploaded %sparameters for %s-%s\n\n" "${partial:+partial }" "$ENVIRONMENT" "$APPLICATION"