beavuck-time 2.1.21

package/src/server.ts

@@ -0,0 +1,53 @@
+// src/server.ts
+
+import {api} from './api'
+import {logger} from './config/logger'
+import {tryParseUrl} from './utils/urlUtil'
+import dotenvx from '@dotenvx/dotenvx'
+
+dotenvx.config()
+
+const API_PORT = process.env.API_PORT ?? 3000
+
+const HOST_URL = process.env.HOST_URL ?? ''
+const TRUSTED_ORIGINS = process.env.TRUSTED_ORIGINS ?? ''
+
+const SIGTERM = 'SIGTERM'
+const SIGINT = 'SIGINT'
+
+if (!HOST_URL || !tryParseUrl(HOST_URL)) {
+  logger.error('HOST_URL not set in environment variables (or is not a valid URL)')
+  process.exit(1)
+}
+
+if (!TRUSTED_ORIGINS) {
+  logger.error('TRUSTED_ORIGINS not set in environment variables')
+  process.exit(1)
+}
+
+const server = api.listen(API_PORT, () => {
+  logger.info(
+    `
+| |                               | |                                          ,=.
+| |__   ___  __ ___   ___   _  ___| | __                        ,=""""==.__.="  o".___
+| '_ \\ / _ \\/ _\` \\ \\ / / | | |/ __| |/ /                  ,=.=="                  ___/
+| |_) |  __/ (_| |\\ V /| |_| | (__|   <             ,==.,"    ,          , \\,===""
+|_.__/ \\___|\\__,_| \\_/  \\__,_|\\___|_|\\_\\          <     ,==)  \\"'"=._.==)  \\
+                                                    \`==''    \`"           \`"
+ 
+ Beavuck Time microservice started successfully
+ 
+ Ready on API port ${API_PORT} (if this is running in a container, this port number is internal to the container)`,
+  )
+})
+
+const gracefulShutdown = (signal: string) => {
+  logger.info(`${signal} signal received: closing HTTP server`)
+  server.close(() => {
+    logger.info('HTTP server closed')
+    process.exit(0)
+  })
+}
+
+process.on(SIGTERM, () => gracefulShutdown(SIGTERM))
+process.on(SIGINT, () => gracefulShutdown(SIGINT))

package/src/services/nowService.ts

@@ -0,0 +1,9 @@
+// src/services/nowService.ts
+
+import {Now} from '../models/now'
+
+export class NowService {
+  public get(): Now {
+    return new Now()
+  }
+}

package/src/types/isoTimestamp.ts

@@ -0,0 +1,8 @@
+/**
+ * Stringified date-time in RFC 3339 format (often referred to as ISO 8601 format)
+ * See [RFC 3339 section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6)
+ * @example 2019-08-24T14:15:22Z
+ * @format date-time
+ */
+export type IsoTimestamp = string
+export const RFC_3339_FORMAT = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}Z$/

package/src/utils/urlUtil.ts

@@ -0,0 +1,29 @@
+// src/utils/urlUtil.ts
+
+import {URL} from 'url'
+import {logger} from '../config/logger'
+
+export function isSameOrigin(thisUrl?: URL, thatUrl?: URL): boolean {
+  logger.debug(`Comparing origins: ${thisUrl?.origin} and ${thatUrl?.origin}`)
+  if (!thisUrl || !thatUrl) return false
+  if (thisUrl.origin === thatUrl.origin) return true
+
+  const isSameProtocol = thisUrl.protocol === thatUrl.protocol
+  const isSameHost = thisUrl.hostname === thatUrl.hostname
+  const isSamePort = thisUrl.port === thatUrl.port
+
+  return isSameProtocol && isSameHost && isSamePort
+}
+
+export function tryParseUrl(urlString?: string): URL | undefined {
+  if (!urlString) {
+    logger.debug('Empty URL string')
+    return undefined
+  }
+  try {
+    return new URL(urlString)
+  } catch (error: unknown) {
+    logger.warn(`Invalid URL string: ${urlString} (${error})`)
+  }
+  return undefined
+}

package/tsconfig.json

@@ -0,0 +1,38 @@
+{
+  "compilerOptions": {
+    /* Basic Options */
+    "incremental": true,
+    "target": "ES2023",
+    "module": "commonjs",
+    "outDir": "build",
+    "rootDir": "src",
+    /* Strict Type-Checking Options */
+    "strict": true,
+    "noImplicitAny": true,
+    "strictNullChecks": true,
+    "strictFunctionTypes": true,
+    "strictBindCallApply": true,
+    "strictPropertyInitialization": true,
+    "noImplicitThis": true,
+    "alwaysStrict": true,
+    /* Additional Checks */
+    "allowUnreachableCode": false,
+    "allowUnusedLabels": false,
+    "noEmitOnError": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    /* Module Resolution Options */
+    "moduleResolution": "node",
+    "baseUrl": ".",
+    "esModuleInterop": true,
+    "resolveJsonModule": true,
+    /* Experimental Options */
+    "experimentalDecorators": true,
+    /* Advanced Options */
+    "forceConsistentCasingInFileNames": true
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["node_modules"]
+}

package/tsoa.json

@@ -0,0 +1,12 @@
+{
+  "entryFile": "src/server.ts",
+  "noImplicitAdditionalProperties": "throw-on-extras",
+  "controllerPathGlobs": ["src/controllers/*Controller.ts"],
+  "spec": {
+    "outputDirectory": "openapi",
+    "specVersion": 3
+  },
+  "routes": {
+    "routesDir": "src/routes"
+  }
+}