@konker.dev/tiny-utils-fp 0.0.1

package/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2024 Konrad Markus <mail@konker.dev>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO   THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
+SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
+OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
+CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,45 @@
+# @konker.dev/tiny-utils-fp
+
+General utility functions for [Node.js](https://nodejs.org/) based on [Effect-TS](https://www.effect.website/)
+
+![License](https://img.shields.io/github/license/konkerdotdev/node-ts-fp-boilerplate)
+[![NPM Version](https://img.shields.io/npm/v/%40konker.dev%2Ftiny-utils-fp)](https://www.npmjs.com/package/@konker.dev/tiny-utils-fp)
+[![CI](https://github.com/konkerdotdev/tiny-utils-fp/actions/workflows/ci.yml/badge.svg)](https://github.com/konkerdotdev/tiny-utils-fp/actions/workflows/ci.yml)
+[![codecov](https://codecov.io/gh/konkerdotdev/tiny-utils-fp/graph/badge.svg?token=W3BFLXCWTH)](https://codecov.io/gh/konkerdotdev/tiny-utils-fp)
+
+## Usage
+
+Copy the contents of this repo, and:
+
+- Search and replace files for `YOUR_SRC_DIR_COULD_BE_DOT` and substitute for the desired source directory
+- Edit package.json `staticFiles` property as needed
+- Run `pnpm install`
+- Run `git init`
+- Run: `pnpm dlx husky-init && pnpm install`
+- Replace this with your actual README.md
+- Replace ISC.LICENSE as needed
+- Amend .github/workflows/cd.yml to replace `PATH_TO_PACKAGE_JSON`
+- Remember:
+  - README.md title / content
+  - package.json name
+  - package.json description
+
+## For An Existing Project
+
+- Copy the following. merging as necessary:
+  - .editorconfig
+  - .eslintignore
+  - .eslintrc.json
+  - .madgerc
+  - .nvmrc
+  - .prettierignore
+  - .prettierrc
+  - gulpfile.mjs
+  - jest.config.ts
+    - Replaces jest.config.js if applicable
+  - tsconfig.json
+- Search and replace for `YOUR_SRC_DIR_COULD_BE_DOT`
+- Merge .gitignore
+- Copy over dev dependencies not already present
+- Copy over dependencies not already present
+- LICENSE

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import * as P from '@konker.dev/effect-ts-prelude';
+export declare const md5Hex: (s: string) => P.Effect.Effect<string, Error>;
+export declare const sha256Hex: (s: string) => P.Effect.Effect<string, Error>;
+export declare const sha256HmacHex: (s: string, secret: string) => P.Effect.Effect<string, Error>;

package/dist/index.js

@@ -0,0 +1,48 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sha256HmacHex = exports.sha256Hex = exports.md5Hex = void 0;
+const P = __importStar(require("@konker.dev/effect-ts-prelude"));
+const lib_1 = require("@konker.dev/tiny-error-fp/dist/lib");
+const node_crypto_1 = __importDefault(require("node:crypto"));
+const md5Hex = (s) => P.Effect.try({
+    try: () => node_crypto_1.default.createHash('md5').update(s).digest('hex'),
+    catch: lib_1.toError,
+});
+exports.md5Hex = md5Hex;
+const sha256Hex = (s) => P.Effect.try({
+    try: () => node_crypto_1.default.createHash('sha256').update(s).digest('hex'),
+    catch: lib_1.toError,
+});
+exports.sha256Hex = sha256Hex;
+const sha256HmacHex = (s, secret) => P.Effect.try({
+    try: () => node_crypto_1.default.createHmac('sha256', secret).update(s).digest('hex'),
+    catch: lib_1.toError,
+});
+exports.sha256HmacHex = sha256HmacHex;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,iEAAmD;AAEnD,4DAA6D;AAC7D,8DAAiC;AAE1B,MAAM,MAAM,GAAG,CAAC,CAAS,EAAkC,EAAE,CAClE,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;IACX,GAAG,EAAE,GAAG,EAAE,CAAC,qBAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;IAC3D,KAAK,EAAE,aAAO;CACf,CAAC,CAAC;AAJQ,QAAA,MAAM,UAId;AAEE,MAAM,SAAS,GAAG,CAAC,CAAS,EAAkC,EAAE,CACrE,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;IACX,GAAG,EAAE,GAAG,EAAE,CAAC,qBAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;IAC9D,KAAK,EAAE,aAAO;CACf,CAAC,CAAC;AAJQ,QAAA,SAAS,aAIjB;AAEE,MAAM,aAAa,GAAG,CAAC,CAAS,EAAE,MAAc,EAAkC,EAAE,CACzF,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;IACX,GAAG,EAAE,GAAG,EAAE,CAAC,qBAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;IACtE,KAAK,EAAE,aAAO;CACf,CAAC,CAAC;AAJQ,QAAA,aAAa,iBAIrB"}

package/package.json

@@ -0,0 +1,77 @@
+{
+  "name": "@konker.dev/tiny-utils-fp",
+  "version": "0.0.1",
+  "author": "Konrad Markus <mail@konker.dev>",
+  "description": "General utility functions for Node.js TypeScript projects based on Effect-ts",
+  "license": "ISC",
+  "main": "dist/index.js",
+  "files": [
+    "dist/**/*",
+    "!dist/**/*.test.*"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/konkerdotdev/tiny-utils-fp"
+  },
+  "keywords": [
+    "node",
+    "boilerplate",
+    "typescript",
+    "functional-programming",
+    "effect-ts"
+  ],
+  "dependencies": {
+    "@effect/schema": "^0.68.23",
+    "@konker.dev/effect-ts-prelude": "^0.0.16",
+    "@konker.dev/tiny-error-fp": "^0.0.7",
+    "effect": "^3.5.3"
+  },
+  "devDependencies": {
+    "@effect/language-service": "^0.1.0",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.14.10",
+    "@typescript-eslint/eslint-plugin": "^7.16.0",
+    "@typescript-eslint/parser": "^7.16.0",
+    "@typescript-eslint/typescript-estree": "^7.16.0",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-import-resolver-typescript": "^3.6.1",
+    "eslint-plugin-deprecation": "^2.0.0",
+    "eslint-plugin-fp": "^2.3.0",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-json": "^3.1.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "eslint-plugin-simple-import-sort": "^12.1.1",
+    "eslint-plugin-sort-destructure-keys": "^1.6.0",
+    "gulp": "^4.0.2",
+    "husky": "^9.0.11",
+    "jest": "^29.7.0",
+    "leasot": "^13.3.0",
+    "madge": "^6.1.0",
+    "npx": "^10.2.2",
+    "prettier": "^3.3.3",
+    "ts-jest": "^29.2.2",
+    "ts-node": "^10.9.2",
+    "type-coverage": "^2.29.1",
+    "typescript": "^5.5.3"
+  },
+  "staticFiles": [],
+  "scripts": {
+    "test": "jest --no-cache -w 4",
+    "clean": "rm -rf dist && rm -f tsconfig.tsbuildinfo",
+    "typecheck": "tsc --noEmit",
+    "build": "pnpm run clean && tsc && gulp copy-static",
+    "type-coverage-check": "type-coverage --detail --at-least 100",
+    "circular-check": "madge --extensions ts --circular --no-color --no-spinner --warning --ts-config ./tsconfig.json src",
+    "eslint-check": "eslint --max-warnings=0 '**/*.{ts,js,json}'",
+    "fixme-check": "leasot --exit-nicely --skip-unsupported --ignore node_modules src",
+    "eslint-fix": "npx eslint --fix||true",
+    "prettier-check": "npx prettier --check --ignore-path .gitignore --ignore-path .prettierignore '**/*.{css,html,js,ts,json,md,yaml,yml}'",
+    "prettier-fix": "pnpm run prettier-check --write",
+    "lint-check": "pnpm run eslint-check && pnpm run prettier-check && pnpm run circular-check && pnpm run fixme-check",
+    "lint-fix": "pnpm run eslint-fix && pnpm run prettier-fix",
+    "pre-push": "pnpm run lint-check && pnpm run typecheck",
+    "ci": "pnpm run lint-check && pnpm run typecheck && pnpm run type-coverage-check && pnpm run test && pnpm run build && pnpm run fixme-check",
+    "cd": "pnpm run build && pnpm publish --access public"
+  }
+}