@candlerip/shared 0.0.23 → 0.0.42

package/devops/npm/publish-to-npm-registry.sh

@@ -3,9 +3,13 @@ set -e
 
 npm config set //registry.npmjs.org/:_authToken $NPM_ACCESS_TOKEN
 
+ls -al
+cat package.json
+cat ~/.npmrc
+
 if [ -d "devops" ]; then
     cp -r devops dist
 fi
 cp package.json dist
 
-npm publish ./dist --access=public
+npm publish ./dist --access public

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@candlerip/shared",
-  "version": "0.0.23",
+  "version": "0.0.42",
   "type": "module",
   "engines": {
     "node": "=22.19.0"
@@ -8,7 +8,7 @@
   "main": "src/index.js",
   "bin": {
     "crs-cdk-deploy": "devops/cdk/cdk-deploy.sh",
-    "crs-create-env-file": "devops/environment/create-env-file.sh",
+    "crs-create-env-file": "src/devops/env-file/create-env-file/index.js",
     "crs-publish-to-docker-hub": "./devops/docker/publish-to-docker-hub.sh",
     "crs-eslint": "devops/eslint/eslint.sh",
     "crs-publish-to-npm-registry": "devops/npm/publish-to-npm-registry.sh",
@@ -20,11 +20,17 @@
     "dev": "sh ./devops/typescript/tsc-watch.sh"
   },
   "dependencies": {
+    "@aws-sdk/client-ssm": "^3.917.0",
     "eslint": "^9.28.0",
     "globals": "^16.2.0",
     "prettier": "^3.5.3",
     "tsc-alias": "^1.8.16",
     "typescript": "^5.8.3",
-    "typescript-eslint": "^8.33.1"
+    "typescript-eslint": "^8.33.1",
+    "yargs": "^18.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^24.9.1",
+    "@types/yargs": "^17.0.34"
   }
 }

package/src/devops/env-file/create-env-file/convert-environment-variable-name-to-ssm-parameter-name/index.d.ts

@@ -0,0 +1,2 @@
+import { ConvertEnvironmentVariableNameToSsmParameterName } from './types.js';
+export declare const convertEnvironmentVariableNameToSsmParameterName: ConvertEnvironmentVariableNameToSsmParameterName;

package/src/devops/env-file/create-env-file/convert-environment-variable-name-to-ssm-parameter-name/index.js

@@ -0,0 +1,8 @@
+import { MODE_INDEPENDENT_ENVIRONMENT_VARIABLE_NAMES } from '../../../../environment/index.js';
+export const convertEnvironmentVariableNameToSsmParameterName = (environmentVariableName, environmentMode) => {
+    let parameterName = environmentVariableName;
+    if (!MODE_INDEPENDENT_ENVIRONMENT_VARIABLE_NAMES.includes(environmentVariableName)) {
+        parameterName = `${parameterName}_${environmentMode.toUpperCase()}`;
+    }
+    return parameterName.replace('AWS', 'AMAZONWEBSERVICES');
+};

package/src/devops/env-file/create-env-file/convert-environment-variable-name-to-ssm-parameter-name/types.d.ts

@@ -0,0 +1,2 @@
+import { EnvironmentMode, EnvironmentVariableName } from '../../../../environment/index.js';
+export type ConvertEnvironmentVariableNameToSsmParameterName = (environmentVariableName: EnvironmentVariableName, environmentMode: EnvironmentMode) => string;

package/src/devops/env-file/create-env-file/convert-environment-variable-name-to-ssm-parameter-name/types.js

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

package/src/devops/env-file/create-env-file/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/src/devops/env-file/create-env-file/index.js

@@ -0,0 +1,41 @@
+#!/usr/bin/env node
+import { SERVICE_ENVIRONMENT_VARIABLE_NAMES } from '../../../service/index.js';
+import { SSMClient, GetParametersCommand } from '@aws-sdk/client-ssm';
+import * as fs from 'fs';
+import { isEnvironmentMode } from '../../../environment/index.js';
+import { validateParameters } from './validate-parameters/index.js';
+import { convertEnvironmentVariableNameToSsmParameterName } from './convert-environment-variable-name-to-ssm-parameter-name/index.js';
+const parameters = validateParameters();
+if (parameters) {
+    const { environmentMode, environmentVariableName, fileName, serviceName } = parameters;
+    const ssmClient = new SSMClient();
+    let parameterNames = [];
+    if (environmentVariableName) {
+        parameterNames = [convertEnvironmentVariableNameToSsmParameterName(environmentVariableName, environmentMode)];
+    }
+    else if (serviceName) {
+        const envNames = SERVICE_ENVIRONMENT_VARIABLE_NAMES[serviceName];
+        parameterNames = envNames.map((envName) => convertEnvironmentVariableNameToSsmParameterName(envName, environmentMode));
+    }
+    const environmentVariables = {};
+    for (let i = 0; i < parameterNames.length; i += 10) {
+        const response = await ssmClient.send(new GetParametersCommand({
+            Names: parameterNames.slice(i, i + 10),
+        }));
+        parameterNames.forEach((parameterName) => {
+            let envName = parameterName.replace('AMAZONWEBSERVICES', 'AWS');
+            const parts = envName.split('_');
+            const lastPart = parts.pop()?.toLowerCase();
+            if (isEnvironmentMode(lastPart)) {
+                envName = parts.join('_');
+            }
+            const value = response.Parameters?.find((p) => p.Name === envName)?.Value;
+            environmentVariables[envName] = value;
+        });
+        fs.writeFileSync(fileName, environmentVariableName
+            ? Object.values(environmentVariables)[0]
+            : Object.entries(environmentVariables)
+                .map(([k, v]) => `${k}=${v}`)
+                .join('\n'), 'utf8');
+    }
+}

package/src/devops/env-file/create-env-file/types.d.ts

@@ -0,0 +1,6 @@
+export type Args = {
+    'environment-mode'?: string;
+    'environment-variable-name'?: string;
+    'file-name'?: string;
+    'service-name'?: string;
+};

package/src/devops/env-file/create-env-file/types.js

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

package/src/devops/env-file/create-env-file/validate-parameters/index.d.ts

@@ -0,0 +1,2 @@
+import { ValidateParameters } from './types.js';
+export declare const validateParameters: ValidateParameters;

package/src/devops/env-file/create-env-file/validate-parameters/index.js

@@ -0,0 +1,52 @@
+import { isServiceName } from '../../../../service/index.js';
+import yargs from 'yargs';
+import { hideBin } from 'yargs/helpers';
+import { isString } from '../../../../type/index.js';
+import { consoleError, ErrorWorker } from '../../../../error/index.js';
+import { isEnvironmentMode, isEnvironmentVariableName } from '../../../../environment/index.js';
+export const validateParameters = () => {
+    const argv = yargs(hideBin(process.argv)).parse();
+    const environmentMode = argv['environment-mode'];
+    const environmentVariableNameArg = argv['environment-variable-name'];
+    const serviceNameArg = argv['service-name'];
+    const fileName = argv['file-name'];
+    const { composeError } = ErrorWorker({
+        info: {
+            args: process.argv,
+        },
+    });
+    if (!isString(fileName)) {
+        consoleError(composeError('Invalid or missing file-name parameter'));
+        process.exit(1);
+    }
+    if (!isEnvironmentMode(environmentMode)) {
+        consoleError(composeError('Invalid environment-mode parameter'));
+        process.exit(1);
+    }
+    if (!environmentVariableNameArg && !serviceNameArg) {
+        consoleError(composeError('Missing environment-variable-name or service-name parameter'));
+        process.exit(1);
+    }
+    let environmentVariableName;
+    if (environmentVariableNameArg) {
+        if (!isEnvironmentVariableName(environmentVariableNameArg)) {
+            consoleError(composeError('Invalid environment-variable-name parameter'));
+            process.exit(1);
+        }
+        environmentVariableName = environmentVariableNameArg;
+    }
+    let serviceName;
+    if (serviceNameArg) {
+        if (!isServiceName(serviceNameArg)) {
+            consoleError(composeError('Invalid service-name parameter'));
+            process.exit(1);
+        }
+        serviceName = serviceNameArg;
+    }
+    return {
+        environmentMode,
+        environmentVariableName,
+        fileName,
+        serviceName,
+    };
+};

package/src/devops/env-file/create-env-file/validate-parameters/types.d.ts

@@ -0,0 +1,8 @@
+import { ServiceName } from '../../../../service/index.js';
+import { EnvironmentMode, EnvironmentVariableName } from '../../../../environment/index.js';
+export type ValidateParameters = () => {
+    environmentMode: EnvironmentMode;
+    environmentVariableName?: EnvironmentVariableName;
+    fileName: string;
+    serviceName?: ServiceName;
+} | void;

package/src/devops/env-file/create-env-file/validate-parameters/types.js

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

package/src/devops/env-file/index.d.ts

@@ -0,0 +1 @@
+export * from './create-env-file/index.js';

package/src/devops/env-file/index.js

@@ -0,0 +1 @@
+export * from './create-env-file/index.js';

package/src/devops/index.d.ts

@@ -0,0 +1 @@
+export * from './env-file/index.js';

package/src/devops/index.js

@@ -0,0 +1 @@
+export * from './env-file/index.js';

package/src/environment/environment-variable-name/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const ENVIRONMENT_VARIABLE_NAMES: readonly ["APP_NAME", "APP_PORT", "AWS_REGION", "AWS_S3_IMAGES_BUCKET_NAME", "CACHE_SERVICE_PORT", "DATABASE_URL", "DOMAIN_NAME", "FRONTEND_URL", "LOGGER_SERVICE_PORT", "MOBILE_APP_URL", "NODE_ENV", "RABBITMQ_URL", "REDIS_PWD", "REDIS_URL", "REDIS_URL_APP", "SSL_PRIVATE_KEY"];
+export declare const MODE_INDEPENDENT_ENVIRONMENT_VARIABLE_NAMES: readonly ["APP_NAME", "APP_PORT", "AWS_REGION", "CACHE_SERVICE_PORT", "DOMAIN_NAME", "LOGGER_SERVICE_PORT", "REDIS_PWD", "SSL_PRIVATE_KEY"];

package/src/environment/environment-variable-name/constants.js

@@ -0,0 +1,28 @@
+export const ENVIRONMENT_VARIABLE_NAMES = [
+    'APP_NAME',
+    'APP_PORT',
+    'AWS_REGION',
+    'AWS_S3_IMAGES_BUCKET_NAME',
+    'CACHE_SERVICE_PORT',
+    'DATABASE_URL',
+    'DOMAIN_NAME',
+    'FRONTEND_URL',
+    'LOGGER_SERVICE_PORT',
+    'MOBILE_APP_URL',
+    'NODE_ENV',
+    'RABBITMQ_URL',
+    'REDIS_PWD',
+    'REDIS_URL',
+    'REDIS_URL_APP',
+    'SSL_PRIVATE_KEY',
+];
+export const MODE_INDEPENDENT_ENVIRONMENT_VARIABLE_NAMES = [
+    'APP_NAME',
+    'APP_PORT',
+    'AWS_REGION',
+    'CACHE_SERVICE_PORT',
+    'DOMAIN_NAME',
+    'LOGGER_SERVICE_PORT',
+    'REDIS_PWD',
+    'SSL_PRIVATE_KEY',
+];

package/src/environment/environment-variable-name/domains.d.ts

@@ -1,2 +1,2 @@
-import { EnvironmentVariables } from '../environment-variables/index.js';
-export type EnvironmentVariableName = keyof EnvironmentVariables;
+import { ENVIRONMENT_VARIABLE_NAMES } from './constants.js';
+export type EnvironmentVariableName = (typeof ENVIRONMENT_VARIABLE_NAMES)[number];

package/src/environment/environment-variable-name/index.d.ts

@@ -1 +1,3 @@
+export * from './constants.js';
 export * from './domains.js';
+export * from './type-guards.js';

package/src/environment/environment-variable-name/index.js

@@ -1 +1,3 @@
+export * from './constants.js';
 export * from './domains.js';
+export * from './type-guards.js';

package/src/environment/environment-variable-name/type-guards.d.ts

@@ -0,0 +1,2 @@
+import { EnvironmentVariableName } from './domains.js';
+export declare const isEnvironmentVariableName: (data?: unknown) => data is EnvironmentVariableName;

package/src/environment/environment-variable-name/type-guards.js

@@ -0,0 +1,2 @@
+import { ENVIRONMENT_VARIABLE_NAMES } from './constants.js';
+export const isEnvironmentVariableName = (data) => ENVIRONMENT_VARIABLE_NAMES.some((it) => data === it);

package/src/environment/environment-variables/domains.d.ts

@@ -5,10 +5,8 @@ export type EnvironmentVariables = {
     AWS_REGION: string;
     AWS_S3_IMAGES_BUCKET_NAME: string;
     CACHE_SERVICE_PORT: number;
-    CACHE_ENABLED: boolean;
     DATABASE_URL: string;
     DOMAIN_NAME: string;
-    EC2_IP_ADDRESS: string;
     FRONTEND_URL: string;
     LOGGER_SERVICE_PORT: number;
     MOBILE_APP_URL: string;

package/src/error/domains.d.ts

@@ -0,0 +1,14 @@
+export interface Error {
+    id: string;
+    info?: ErrorInfo;
+    message: ErrorMessage;
+}
+export type ErrorInfo = Record<string, unknown>;
+export type ErrorMessage = string;
+export type TError<T = never> = {
+    data: T;
+    error?: never;
+} | {
+    error: Error;
+    data?: never;
+};

package/src/error/domains.js

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

package/src/error/index.d.ts

@@ -0,0 +1,3 @@
+export * from './domains.js';
+export * from './utils/index.js';
+export * from './workers/index.js';

package/src/error/index.js

@@ -0,0 +1,3 @@
+export * from './domains.js';
+export * from './utils/index.js';
+export * from './workers/index.js';

package/src/error/utils/compose-error/index.d.ts

@@ -0,0 +1,2 @@
+import { ComposeError } from './type.js';
+export declare const composeError: ComposeError;

package/src/error/utils/compose-error/index.js

@@ -0,0 +1,5 @@
+export const composeError = (message, info) => ({
+    id: Math.random().toString(16).slice(2).toUpperCase(),
+    info,
+    message: message ?? '',
+});

package/src/error/utils/compose-error/type.d.ts

@@ -0,0 +1,2 @@
+import { Error, ErrorInfo, ErrorMessage } from '../../domains.js';
+export type ComposeError = (message?: ErrorMessage, info?: ErrorInfo) => Error;

package/src/error/utils/compose-error/type.js

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

package/src/error/utils/console-error/index.d.ts

@@ -0,0 +1,2 @@
+import { ConsoleError } from './type.js';
+export declare const consoleError: ConsoleError;

package/src/error/utils/console-error/index.js

@@ -0,0 +1,9 @@
+import { stringify } from '../../../helpers/index.js';
+export const consoleError = (error) => {
+    const { id, info, message } = error;
+    let msg = `ERROR: ${message} (ID) ${id}`;
+    if (info) {
+        msg += ` (INFO) ${stringify(info)}`;
+    }
+    console.error(msg);
+};

package/src/error/utils/console-error/type.d.ts

@@ -0,0 +1,2 @@
+import { Error } from '../../domains.js';
+export type ConsoleError = (error: Error) => void;

package/src/error/utils/console-error/type.js

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

package/src/error/utils/index.d.ts

@@ -0,0 +1,2 @@
+export * from './compose-error/index.js';
+export * from './console-error/index.js';

package/src/error/utils/index.js

@@ -0,0 +1,2 @@
+export * from './compose-error/index.js';
+export * from './console-error/index.js';

package/src/error/workers/index.d.ts

@@ -0,0 +1,2 @@
+import { ErrorWorkerType } from './type.js';
+export declare const ErrorWorker: ErrorWorkerType;

package/src/error/workers/index.js

@@ -0,0 +1,32 @@
+import { composeError as composeErrorFunc } from '../utils/index.js';
+export const ErrorWorker = (props) => {
+    let _error = props ? composeErrorFunc(props.message, props.info) : undefined;
+    const _composeInfo = (info) => {
+        if (_error) {
+            _error.info = {
+                ..._error.info,
+                ...info,
+            };
+            return;
+        }
+        _error = composeErrorFunc(undefined, info);
+    };
+    const addErrorInfo = (info) => {
+        _composeInfo(info);
+    };
+    const addErrorMessage = (message) => {
+        _error = composeErrorFunc(message);
+    };
+    const composeError = (message, info) => composeErrorFunc(message, info ?? _error?.info);
+    const getError = () => (_error ? { error: _error } : undefined);
+    const resetError = () => {
+        _error = undefined;
+    };
+    return {
+        addErrorInfo,
+        addErrorMessage,
+        composeError,
+        getError,
+        resetError,
+    };
+};

package/src/error/workers/type.d.ts

@@ -0,0 +1,19 @@
+import { Error, ErrorInfo, ErrorMessage } from '../domains.js';
+export type ErrorWorkerType = (props?: {
+    message?: ErrorMessage;
+    info?: ErrorInfo;
+}) => {
+    addErrorInfo: AddErrorInfo;
+    addErrorMessage: AddErrorMessage;
+    composeError: ComposeError;
+    getError: GetError;
+    resetError: ResetError;
+};
+export type _ComposeInfo = (info?: ErrorInfo) => void;
+export type AddErrorInfo = (info: ErrorInfo) => void;
+export type AddErrorMessage = (message: ErrorMessage) => void;
+export type ComposeError = (message: ErrorMessage, info?: ErrorInfo) => Error;
+export type GetError = () => {
+    error: Error;
+} | undefined;
+export type ResetError = () => void;

package/src/error/workers/type.js

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

package/src/helpers/index.d.ts

@@ -0,0 +1,2 @@
+export * from './reveal-all-object-props/index.js';
+export * from './stringify/index.js';

package/src/helpers/index.js

@@ -0,0 +1,2 @@
+export * from './reveal-all-object-props/index.js';
+export * from './stringify/index.js';

package/src/helpers/reveal-all-object-props/index.d.ts

@@ -0,0 +1,2 @@
+import { RevealAllObjectProps } from './type.js';
+export declare const revealAllObjectProps: RevealAllObjectProps;

package/src/helpers/reveal-all-object-props/index.js

@@ -0,0 +1,13 @@
+import { isObject } from '../../type/index.js';
+export const revealAllObjectProps = (obj) => {
+    const newObj = {};
+    Object.getOwnPropertyNames(obj).forEach((key) => {
+        if (isObject(obj[key])) {
+            newObj[key] = revealAllObjectProps(obj[key]);
+        }
+        else {
+            newObj[key] = obj[key];
+        }
+    });
+    return newObj;
+};

package/src/helpers/reveal-all-object-props/type.d.ts

@@ -0,0 +1 @@
+export type RevealAllObjectProps = (obj: Record<string, unknown>) => Record<string, unknown>;

package/src/helpers/reveal-all-object-props/type.js

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

package/src/helpers/stringify/index.d.ts

@@ -0,0 +1,2 @@
+import { Stringify } from './type.js';
+export declare const stringify: Stringify;

package/src/helpers/stringify/index.js

@@ -0,0 +1,3 @@
+import { isObject } from '../../type/index.js';
+import { revealAllObjectProps } from '../reveal-all-object-props/index.js';
+export const stringify = (obj) => JSON.stringify(isObject(obj) ? revealAllObjectProps(obj) : obj);

package/src/helpers/stringify/type.d.ts

@@ -0,0 +1 @@
+export type Stringify = (obj: unknown) => string;

package/src/helpers/stringify/type.js

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

package/src/index.d.ts

@@ -1,3 +1,5 @@
 export * from './environment/index.js';
+export * from './error/index.js';
+export * from './helpers/index.js';
 export * from './service/index.js';
 export * from './type/index.js';

package/src/index.js

@@ -1,3 +1,5 @@
 export * from './environment/index.js';
+export * from './error/index.js';
+export * from './helpers/index.js';
 export * from './service/index.js';
 export * from './type/index.js';

package/src/service/service-environment-variable-names/constants.js

@@ -1,5 +1,4 @@
 export const SERVICE_ENVIRONMENT_VARIABLE_NAMES = {
-    'environment-service': ['APP_NAME'],
     'cache-service': ['APP_NAME', 'MOBILE_APP_URL'],
-    nginx: ['APP_PORT', 'EC2_IP_ADDRESS', 'SSL_PRIVATE_KEY'],
+    nginx: ['APP_PORT', 'SSL_PRIVATE_KEY'],
 };

package/src/service/service-name/constants.d.ts

@@ -1 +1 @@
-export declare const SERVICE_NAMES: readonly ["cache-service", "nginx", "environment-service"];
+export declare const SERVICE_NAMES: readonly ["cache-service", "nginx"];

package/src/service/service-name/constants.js

@@ -1 +1 @@
-export const SERVICE_NAMES = ['cache-service', 'nginx', 'environment-service'];
+export const SERVICE_NAMES = ['cache-service', 'nginx'];

package/src/service/service-name/index.d.ts

@@ -1,2 +1,3 @@
 export * from './constants.js';
 export * from './domains.js';
+export * from './type-guards.js';

package/src/service/service-name/index.js

@@ -1,2 +1,3 @@
 export * from './constants.js';
 export * from './domains.js';
+export * from './type-guards.js';

package/src/service/service-name/type-guards.d.ts

@@ -0,0 +1,2 @@
+import { ServiceName } from './domains.js';
+export declare const isServiceName: (data?: unknown) => data is ServiceName;

package/src/service/service-name/type-guards.js

@@ -0,0 +1,2 @@
+import { SERVICE_NAMES } from './constants.js';
+export const isServiceName = (data) => SERVICE_NAMES.some((it) => data === it);