declapract-typescript-ehmpathy 0.31.11 → 0.33.0

package/dist/practices/commands/best-practice/package.json

@@ -0,0 +1,6 @@
+{
+  "dependencies": {
+    "visualogic": "@declapract{check.minVersion('1.0.1')}",
+    "@ehmpathy/as-command": "@declapract{check.minVersion('1.2.1')}"
+  }
+}

package/dist/practices/commands/best-practice/package.json.declapract.ts

@@ -0,0 +1,3 @@
+import { FileCheckType } from 'declapract';
+
+export const check = FileCheckType.CONTAINS;

package/dist/practices/commands/best-practice/src/contract/commands/__tmp__/.gitignore

@@ -0,0 +1,3 @@
+*
+!.gitignore
+!directory.ts

package/dist/practices/commands/best-practice/src/contract/commands/__tmp__/directory.ts

@@ -0,0 +1,4 @@
+export const COMMANDS_OUTPUT_DIRECTORY = __dirname
+  .split('/')
+  .slice(0, -1)
+  .join('/');

package/dist/practices/commands/best-practice/src/contract/commands/sayHello.ts

@@ -0,0 +1,20 @@
+import { asCommand } from '@ehmpathy/as-command';
+import { UnexpectedCodePathError } from '@ehmpathy/error-fns';
+import { ProcedureInput, getResourceNameFromFileName } from 'visualogic';
+
+import { stage } from '../../utils/environment';
+import { log } from '../../utils/logger';
+import { COMMANDS_OUTPUT_DIRECTORY } from './__tmp__/directory';
+
+const command = asCommand(
+  {
+    name: getResourceNameFromFileName(__filename),
+    stage,
+    dir: COMMANDS_OUTPUT_DIRECTORY,
+    log,
+  },
+  async () => console.log('hello world'),
+);
+
+// STAGE=prod npx tsx src/contract/commands/sayHello.ts
+if (require.main === module) void command({});

package/dist/practices/domain/best-practice/package.json

@@ -1,7 +1,7 @@
 {
   "dependencies": {
-    "domain-objects": "@declapract{check.minVersion('0.10.3')}",
+    "domain-objects": "@declapract{check.minVersion('0.21.9')}",
     "joi": "@declapract{check.minVersion('17.4.0')}",
-    "type-fns": "@declapract{check.minVersion('0.8.1')}"
+    "type-fns": "@declapract{check.minVersion('0.16.0')}"
   }
 }

package/dist/practices/environments/best-practice/src/utils/environment.ts

@@ -1,3 +1,4 @@
+import { UnexpectedCodePathError } from '@ehmpathy/error-fns';
 import { createIsOfEnum } from 'type-fns';
 
 export enum Stage {
@@ -7,6 +8,22 @@ export enum Stage {
 }
 export const isOfStage = createIsOfEnum(Stage);
 
+/**
+ * verify that the server is on UTC timezone
+ *
+ * why?
+ * - non UTC timezone usage causes problems and takes a while to track down
+ * - by failing fast if the server our code runs in is not in UTC, we avoid these issues
+ * =>
+ * - create a pit of success
+ */
+const TIMEZONE = process.env.TZ;
+if (TIMEZONE !== 'UTC')
+  throw new UnexpectedCodePathError(
+    'env.TZ is not set to UTC. this can cause issues. please set the env var',
+    { found: TIMEZONE, desire: 'UTC' },
+  );
+
 /**
  * this allows us to infer what the stage should be in environments that do not have STAGE specified
  * - e.g., when running locally

package/dist/practices/lambda-handlers/best-practice/package.json

@@ -1,6 +1,6 @@
 {
   "dependencies": {
-    "simple-lambda-handlers": "@declapract{check.minVersion('0.9.0')}"
+    "simple-lambda-handlers": "@declapract{check.minVersion('0.9.1')}"
   },
   "devDependencies": {}
 }

package/dist/practices/persist-with-rds/best-practice/package.json

@@ -4,10 +4,10 @@
     "yesql": "@declapract{check.minVersion('3.2.2')}"
   },
   "devDependencies": {
-    "sql-code-generator": "@declapract{check.minVersion('0.9.3')}",
-    "sql-dao-generator": "@declapract{check.minVersion('0.4.0')}",
+    "sql-code-generator": "@declapract{check.minVersion('0.10.0')}",
+    "sql-dao-generator": "@declapract{check.minVersion('0.8.1')}",
     "sql-schema-control": "@declapract{check.minVersion('1.5.0')}",
-    "sql-schema-generator": "@declapract{check.minVersion('0.23.0')}",
+    "sql-schema-generator": "@declapract{check.minVersion('0.25.0')}",
     "@types/yesql": "@declapract{check.minVersion('3.2.2')}",
     "@types/pg": "@declapract{check.minVersion('8.6.1')}"
   },

package/dist/practices/serverless/best-practice/serverless.yml

@@ -17,6 +17,7 @@ provider:
     environment: ${self:provider.stage}
     product: ${self:service}
   environment:
+    TZ: UTC # guarantee that utc timezone will be used explicitly, to facilitate a pit of success
     NODE_ENV: production # deploy with production optimizations of all resources, to make `dev` and `prod` stage deployments equivalent functionally (i.e., the same code paths in dev and prod)
     STAGE: ${self:provider.stage} # deploy specifying which stage we're targeting, to enable targeting the correct config + resources (e.g., hit dev db -vs- prod db)
     AWS_NODEJS_CONNECTION_REUSE_ENABLED: true # https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/node-reusing-connections.html

package/dist/useCases.yml

@@ -32,6 +32,7 @@ use-cases:
       - artifact
       - cicd-service
       - config
+      - commands
       - dates-and-times
       - environments-aws
       - lambda-clients

package/package.json

@@ -2,7 +2,7 @@
   "name": "declapract-typescript-ehmpathy",
   "author": "ehmpathy",
   "description": "declapract best practices declarations for typescript",
-  "version": "0.31.11",
+  "version": "0.33.0",
   "main": "src/index.js",
   "repository": "ehmpathy/declapract-typescript-ehmpathy",
   "homepage": "https://github.com/ehmpathy/declapract-typescript-ehmpathy",
@@ -38,10 +38,10 @@
     "postinstall": "[ -d .git ] && npx husky install || exit 0"
   },
   "dependencies": {
+    "@ehmpathy/error-fns": "1.3.1",
     "expect": "29.4.2",
     "flat": "5.0.2",
-    "lodash.uniq": "4.5.0",
-    "type-fns": "0.8.1"
+    "lodash.uniq": "4.5.0"
   },
   "peerDependencies": {
     "declapract": "0.11.2"
@@ -69,6 +69,9 @@
     "prettier": "2.8.1",
     "ts-jest": "29.0.3",
     "ts-node": "10.9.1",
+    "type-fns": "0.8.1",
+    "@ehmpathy/as-command": "1.0.1",
+    "visualogic": "1.2.1",
     "typescript": "4.9.4"
   },
   "config": {