@candlerip/shared 0.0.4

package/dist/common/type/object/index.js

@@ -0,0 +1 @@
+export * from './type-guards.js';

package/dist/common/type/object/type-guards.d.ts

@@ -0,0 +1 @@
+export declare const isObject: (data?: unknown) => data is Record<string, unknown>;

package/dist/common/type/object/type-guards.js

@@ -0,0 +1,11 @@
+import { isArray } from '../array/index.js';
+import { isNull } from '../null/index.js';
+export const isObject = (data) => {
+    if (typeof data !== 'object') {
+        return false;
+    }
+    if (isNull(data)) {
+        return false;
+    }
+    return !isArray(data);
+};

package/dist/devops/eslint/configs.d.ts

@@ -0,0 +1,2 @@
+import { Linter } from 'eslint';
+export declare const ESLINT_RULES: Partial<Linter.RulesRecord>;

package/dist/devops/eslint/configs.js

@@ -0,0 +1,8 @@
+export const ESLINT_RULES = {
+    'no-console': [
+        2,
+        {
+            allow: ['error', 'info'],
+        },
+    ],
+};

package/dist/devops/eslint/index.d.ts

@@ -0,0 +1,2 @@
+export * from './configs.js';
+export * from './utils/index.js';

package/dist/devops/eslint/index.js

@@ -0,0 +1,2 @@
+export * from './configs.js';
+export * from './utils/index.js';

package/dist/devops/eslint/utils/compose-eslint-config/index.d.ts

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

package/dist/devops/eslint/utils/compose-eslint-config/index.js

@@ -0,0 +1,20 @@
+import eslint from '@eslint/js';
+import { defineConfig } from 'eslint/config';
+import tseslint from 'typescript-eslint';
+import * as globals from 'globals';
+import { ESLINT_RULES } from '../../configs.js';
+export const composeEslintConfig = (props = {}) => {
+    const { ignores = [] } = props;
+    return defineConfig(eslint.configs.recommended, ...tseslint.configs.recommended, {
+        ignores,
+    }, {
+        languageOptions: {
+            globals: {
+                ...globals.browser,
+                ...globals.node,
+            },
+        },
+    }, {
+        rules: ESLINT_RULES,
+    });
+};

package/dist/devops/eslint/utils/compose-eslint-config/type.d.ts

@@ -0,0 +1,4 @@
+import { Config } from 'typescript-eslint';
+export type ComposeEslintConfig = (props?: {
+    ignores?: string[];
+}) => Config;

package/dist/devops/eslint/utils/compose-eslint-config/type.js

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

package/dist/devops/eslint/utils/index.d.ts

@@ -0,0 +1 @@
+export * from './compose-eslint-config/index.js';

package/dist/devops/eslint/utils/index.js

@@ -0,0 +1 @@
+export * from './compose-eslint-config/index.js';

package/dist/devops/index.d.ts

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

package/dist/devops/index.js

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

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@candlerip/shared",
+  "version": "0.0.4",
+  "type": "module",
+  "engines": {
+    "node": "=22.19.0"
+  },
+  "files": [
+    "devops",
+    "dist",
+    "src",
+    "package-lock.json",
+    "package.json"
+  ],
+  "bin": {
+    "crs-eslint": "devops/eslint/eslint.sh",
+    "crs-prettier": "devops/prettier/prettier.sh",
+    "crs-tsc-build": "devops/typescript/tsc-build.sh",
+    "crs-tsc-watch": "devops/typescript/tsc-watch.sh"
+  },
+  "exports": {
+    "./backend/environment": "./dist/backend/environment/index.js",
+    "./common": "./dist/common/index.js",
+    "./devops": "./dist/devops/index.js"
+  },
+  "scripts": {
+    "build": "sh ./devops/typescript/tsc-build.sh",
+    "publish-package": "sh ./devops/publish-package.sh",
+    "start": "sh ./devops/typescript/tsc-watch.sh"
+  },
+  "dependencies": {
+    "eslint": "^9.35.0",
+    "globals": "^16.4.0",
+    "jiti": "^2.5.1",
+    "prettier": "^3.6.2",
+    "tsc-alias": "^1.8.16",
+    "typescript": "^5.9.2",
+    "typescript-eslint": "^8.43.0"
+  },
+  "devDependencies": {
+    "@types/node": "^24.3.1"
+  }
+}

package/src/backend/environment/env-file/index.ts

@@ -0,0 +1 @@
+export * from './utils';

package/src/backend/environment/env-file/utils/index.ts

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

package/src/backend/environment/env-file/utils/load-env-file/index.ts

@@ -0,0 +1,53 @@
+import fs from 'fs';
+import { ErrorWorker } from '../../../../../common';
+import { LoadEnvFile } from './type';
+
+export const loadEnvFile: LoadEnvFile = (environmentMode) => {
+  const { composeError } = ErrorWorker({ info: { environmentMode } });
+
+  let fileName = '.env';
+  if (environmentMode) {
+    fileName += `.${environmentMode}`;
+  }
+
+  const parsed = {} as Record<string, string>;
+
+  try {
+    const file = fs.readFileSync(fileName, 'utf-8');
+    file.split('\n').forEach((fileLine) => {
+      if (fileLine.length === 0) {
+        return;
+      }
+      const envVar = fileLine.split('=');
+      parsed[`${envVar[0]}`] = envVar[1];
+    });
+  } catch (err) {
+    return {
+      error: composeError(`Error loading ${fileName}`, {
+        info: {
+          err,
+          fileName,
+        },
+      }),
+    };
+  }
+
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  const data = {} as any;
+
+  (Object.keys(parsed) as Array<keyof typeof parsed>).forEach((key) => {
+    const parsedItem = parsed[key];
+
+    if (['false', 'true'].includes(parsedItem)) {
+      data[key] = Boolean(parsedItem === 'true');
+    } else if (!Number.isNaN(parseInt(parsedItem))) {
+      data[key] = parseInt(parsedItem);
+    } else {
+      data[key] = parsedItem;
+    }
+  });
+
+  return {
+    data,
+  };
+};

package/src/backend/environment/env-file/utils/load-env-file/type.ts

@@ -0,0 +1,5 @@
+import { EnvironmentMode, EnvironmentVariables, TError } from '../../../../../common';
+
+export type LoadEnvFile = <T extends Array<keyof EnvironmentVariables> = never>(
+  environmentMode?: EnvironmentMode,
+) => TError<{ [K in T[number]]: EnvironmentVariables[K] }>;

package/src/backend/environment/index.ts

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

package/src/common/environment/environment-mode/configs.ts

@@ -0,0 +1 @@
+export const ENVIRONMENT_MODES = ['development', 'production'] as const;

package/src/common/environment/environment-mode/domains.ts

@@ -0,0 +1,3 @@
+import { ENVIRONMENT_MODES } from './configs';
+
+export type EnvironmentMode = (typeof ENVIRONMENT_MODES)[number];

package/src/common/environment/environment-mode/index.ts

@@ -0,0 +1,5 @@
+export * from './configs';
+
+export * from './domains';
+
+export * from './type-guards';

package/src/common/environment/environment-mode/type-guards/index.ts

@@ -0,0 +1,5 @@
+export * from './is-development';
+
+export * from './is-environment-mode';
+
+export * from './is-production';

package/src/common/environment/environment-mode/type-guards/is-development.ts

@@ -0,0 +1 @@
+export const isDevelopment = (data?: unknown): data is 'development' => data === 'development';

package/src/common/environment/environment-mode/type-guards/is-environment-mode.ts

@@ -0,0 +1,4 @@
+import { ENVIRONMENT_MODES } from '../configs';
+import { EnvironmentMode } from '../domains';
+
+export const isEnvironmentMode = (data?: unknown): data is EnvironmentMode => ENVIRONMENT_MODES.some((it) => data === it);

package/src/common/environment/environment-mode/type-guards/is-production.ts

@@ -0,0 +1 @@
+export const isProduction = (data?: unknown): data is 'production' => data === 'production';

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

@@ -0,0 +1,19 @@
+import { EnvironmentMode } from '../environment-mode';
+
+export type EnvironmentVariables = {
+  APP_NAME: string;
+  AWS_REGION: string;
+  AWS_S3_IMAGES_BUCKET_NAME: string;
+  CACHE_SERVICE_PORT: string;
+  CACHE_ENABLED: boolean;
+  DATABASE_URL: string;
+  DOMAIN_NAME: string;
+  FRONTEND_URL: string;
+  LOGGER_SERVICE_PORT: string;
+  MOBILE_APP_URL: string;
+  NODE_ENV: EnvironmentMode;
+  RABBITMQ_URL: string;
+  REDIS_PWD: string;
+  REDIS_URL: string;
+  REDIS_URL_APP: string;
+};

package/src/common/environment/environment-variables/index.ts

@@ -0,0 +1,3 @@
+export * from './domains';
+
+export * from './singletons';

package/src/common/environment/environment-variables/singletons/index.ts

@@ -0,0 +1,29 @@
+import { isDevelopment as isDev, isProduction as isProd } from '../../environment-mode';
+import { EnvironmentVariables } from '../domains';
+import { GetEnv, GetEnvs, Init, IsDevelopment, IsProduction } from './type';
+
+export const EnvironmentVariablesSingleton = (() => {
+  let _envs: Partial<EnvironmentVariables>;
+
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  const getEnv: GetEnv = (name) => _envs[name] as any;
+
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  const getEnvs: GetEnvs = (names) => names.reduce((acc, curr) => ({ ...acc, [`${curr}`]: _envs[curr] }), {}) as any;
+
+  const init: Init = (envs) => {
+    _envs = envs;
+  };
+
+  const isDevelopment: IsDevelopment = () => isDev(_envs.NODE_ENV);
+
+  const isProduction: IsProduction = () => isProd(_envs.NODE_ENV);
+
+  return {
+    getEnv,
+    getEnvs,
+    init,
+    isDevelopment,
+    isProduction,
+  };
+})();

package/src/common/environment/environment-variables/singletons/type.ts

@@ -0,0 +1,11 @@
+import { EnvironmentVariables } from '../domains';
+
+export type GetEnv = <T extends keyof EnvironmentVariables = never>(name: T) => EnvironmentVariables[T];
+
+export type GetEnvs = <T extends keyof EnvironmentVariables = never>(names: T[]) => Pick<EnvironmentVariables, T>;
+
+export type Init = (envs: Partial<EnvironmentVariables>) => void;
+
+export type IsDevelopment = () => boolean;
+
+export type IsProduction = () => boolean;

package/src/common/environment/index.ts

@@ -0,0 +1,3 @@
+export * from './environment-mode';
+
+export * from './environment-variables';

package/src/common/error/domains.ts

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

package/src/common/error/index.ts

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

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

@@ -0,0 +1,9 @@
+import { ServiceSingleton } from '../../../service';
+import { ComposeError } from './type';
+
+export const composeError: ComposeError = (message, info) => ({
+  id: Math.random().toString(16).slice(2).toUpperCase(),
+  info,
+  message: message ?? '',
+  serviceName: ServiceSingleton.getServiceName(),
+});

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

@@ -0,0 +1,3 @@
+import { Error } from '../../domains';
+
+export type ComposeError = (message?: string, info?: Record<string, unknown>) => Error;

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

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

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

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

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

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

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

@@ -0,0 +1,41 @@
+import { _ComposeInfo, ErrorWorkerType, GetError, ResetError, AddErrorInfo, AddErrorMessage, ComposeError } from './type';
+import { composeError as composeErrorFunc } from '../utils';
+
+export const ErrorWorker: ErrorWorkerType = (props) => {
+  let _error = props ? composeErrorFunc(props.message, props.info) : undefined;
+
+  const _composeInfo: _ComposeInfo = (info) => {
+    if (_error) {
+      _error.info = {
+        ..._error.info,
+        ...info,
+      };
+      return;
+    }
+    _error = composeErrorFunc(undefined, info);
+  };
+
+  const addErrorInfo: AddErrorInfo = (info) => {
+    _composeInfo(info);
+  };
+
+  const addErrorMessage: AddErrorMessage = (message) => {
+    _error = composeErrorFunc(message);
+  };
+
+  const composeError: ComposeError = (message, info) => composeErrorFunc(message, info ?? _error?.info);
+
+  const getError: GetError = () => (_error ? { error: _error } : undefined);
+
+  const resetError: ResetError = () => {
+    _error = undefined;
+  };
+
+  return {
+    addErrorInfo,
+    addErrorMessage,
+    composeError,
+    getError,
+    resetError,
+  };
+};

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

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

package/src/common/helpers/index.ts

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

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

@@ -0,0 +1,16 @@
+import { isObject } from '../../type';
+import { RevealAllObjectProps } from './type';
+
+export const revealAllObjectProps: RevealAllObjectProps = (obj) => {
+  const newObj = {} as Record<string, unknown>;
+
+  Object.getOwnPropertyNames(obj).forEach((key) => {
+    if (isObject(obj[key])) {
+      newObj[key] = revealAllObjectProps(obj[key]);
+    } else {
+      newObj[key] = obj[key];
+    }
+  });
+
+  return newObj;
+};

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

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

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

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

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

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

package/src/common/index.ts

@@ -0,0 +1,9 @@
+export * from './environment';
+
+export * from './error';
+
+export * from './helpers';
+
+export * from './service';
+
+export * from './type';

package/src/common/service/index.ts

@@ -0,0 +1 @@
+export * from './singletons';

package/src/common/service/singletons/index.ts

@@ -0,0 +1,16 @@
+import { GetServiceName, Init } from './type';
+
+export const ServiceSingleton = (() => {
+  let _serviceName: string;
+
+  const getServiceName: GetServiceName = () => _serviceName;
+
+  const init: Init = (serviceName) => {
+    _serviceName = serviceName;
+  };
+
+  return {
+    getServiceName,
+    init,
+  };
+})();

package/src/common/service/singletons/type.ts

@@ -0,0 +1,3 @@
+export type GetServiceName = () => string;
+
+export type Init = (serviceName: string) => void;

package/src/common/type/array/index.ts

@@ -0,0 +1 @@
+export * from './type-guards';

package/src/common/type/array/type-guards.ts

@@ -0,0 +1,11 @@
+export const isArray = <T>(data?: unknown, typeGuard?: (data?: unknown) => data is T): data is T[] => {
+  if (!Array.isArray(data)) {
+    return false;
+  }
+
+  if (typeGuard && !data.every((a) => typeGuard(a))) {
+    return false;
+  }
+
+  return true;
+};

package/src/common/type/index.ts

@@ -0,0 +1,5 @@
+export * from './array';
+
+export * from './null';
+
+export * from './object';

package/src/common/type/null/index.ts

@@ -0,0 +1 @@
+export * from './type-guards';

package/src/common/type/null/type-guards.ts

@@ -0,0 +1 @@
+export const isNull = (data?: unknown): data is null => data === null;

package/src/common/type/object/index.ts

@@ -0,0 +1 @@
+export * from './type-guards';

package/src/common/type/object/type-guards.ts

@@ -0,0 +1,12 @@
+import { isArray } from '../array';
+import { isNull } from '../null';
+
+export const isObject = (data?: unknown): data is Record<string, unknown> => {
+  if (typeof data !== 'object') {
+    return false;
+  }
+  if (isNull(data)) {
+    return false;
+  }
+  return !isArray(data);
+};

package/src/devops/eslint/configs.ts

@@ -0,0 +1,10 @@
+import { Linter } from 'eslint';
+
+export const ESLINT_RULES: Partial<Linter.RulesRecord> = {
+  'no-console': [
+    2,
+    {
+      allow: ['error', 'info'],
+    },
+  ],
+};

package/src/devops/eslint/index.ts

@@ -0,0 +1,3 @@
+export * from './configs';
+
+export * from './utils';

package/src/devops/eslint/utils/compose-eslint-config/index.ts

@@ -0,0 +1,29 @@
+import eslint from '@eslint/js';
+import { defineConfig } from 'eslint/config';
+import tseslint from 'typescript-eslint';
+import * as globals from 'globals';
+import { ComposeEslintConfig } from './type';
+import { ESLINT_RULES } from '../../configs';
+
+export const composeEslintConfig: ComposeEslintConfig = (props = {}) => {
+  const { ignores = [] } = props;
+
+  return defineConfig(
+    eslint.configs.recommended,
+    ...tseslint.configs.recommended,
+    {
+      ignores,
+    },
+    {
+      languageOptions: {
+        globals: {
+          ...globals.browser,
+          ...globals.node,
+        },
+      },
+    },
+    {
+      rules: ESLINT_RULES,
+    },
+  );
+};

package/src/devops/eslint/utils/compose-eslint-config/type.ts

@@ -0,0 +1,3 @@
+import { Config } from 'typescript-eslint';
+
+export type ComposeEslintConfig = (props?: { ignores?: string[] }) => Config;

package/src/devops/eslint/utils/index.ts

@@ -0,0 +1 @@
+export * from './compose-eslint-config';

package/src/devops/index.ts

@@ -0,0 +1 @@
+export * from './eslint';