@joystick.js/node-canary 0.0.0-canary.47 → 0.0.0-canary.470

package/src/lib/escape_key_value_pair.js

@@ -0,0 +1,15 @@
+import escape_html from "./escape_html.js";
+
+const escape_key_value_pair = (target = {}) => {
+  const parameters = Object.entries(target || {});
+  
+  for (let i = 0; i < parameters?.length; i += 1) {
+    const [key, value] = parameters[i];
+    delete target[key];
+    target[escape_html(key)] = escape_html(value);
+  }
+  
+  return target;
+};
+
+export default escape_key_value_pair;

package/src/lib/float_to_decimal_place.js

@@ -0,0 +1,5 @@
+const float_to_decimal_place = (float = 0, decimal_place = 2) => {
+	return parseFloat(float.toFixed(decimal_place), 10);
+};
+
+export default float_to_decimal_place;

package/src/lib/generate_id.js

@@ -0,0 +1,15 @@
+const characters = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ01234567890'.split('');
+
+const generate_id = (length = 16) => {
+	let id = '';
+  let i = 0;
+
+  while (i < length) {
+    id += characters[Math.floor(Math.random() * (characters.length - 1))];
+    i += 1;
+  }
+
+  return id;
+};
+
+export default generate_id;

package/src/lib/get_browser_safe_request.js

@@ -0,0 +1,17 @@
+import escape_key_value_pair from "./escape_key_value_pair.js";
+import get_browser_safe_user from '../app/accounts/get_browser_safe_user.js';
+
+const get_browser_safe_request = (req = {}) => {
+  const browser_safe_request = {};
+
+  browser_safe_request.headers = req.headers;
+  browser_safe_request.params = escape_key_value_pair(req.params);
+  browser_safe_request.query = escape_key_value_pair(req.query);
+  browser_safe_request.context = {
+    user: get_browser_safe_user(req.context.user),
+  };
+
+  return browser_safe_request;
+};
+
+export default get_browser_safe_request;

package/src/lib/get_joystick_build_path.js

@@ -0,0 +1,22 @@
+import fs from 'fs';
+
+const get_build_path_for_environment = () => {
+  // NOTE: The fs.existsSync() check here is determining if we're running the app in a non-development
+  // environment locally on our computer. If we do something like joystick start -e production locally,
+  // we'll still have a .joystick/build folder (whereas in an actual production build, we do not). This
+  // ensures that we don't break the render when looking for the built copy of a page/layout. Without this,
+  // we accidentally pull back the root directory and attempt to render an unbuilt copy of the page/layout.
+  if (['development', 'test'].includes(process.env.NODE_ENV) || fs.existsSync('.joystick/build')) {
+    return '.joystick/build/';
+  }
+
+  return '';
+};
+
+const get_joystick_build_path = () => {
+  const build_path_for_environment = get_build_path_for_environment();
+
+  return `${process.cwd().replace(build_path_for_environment, '')}/${build_path_for_environment}`;
+};
+
+export default get_joystick_build_path;

package/src/lib/get_origin.js

@@ -0,0 +1,7 @@
+const get_origin = () => {
+  return process.env.NODE_ENV === "development"
+    ? `http://localhost:${process.env.PORT}`
+    : process.env.ROOT_URL;
+};
+
+export default get_origin;

package/src/lib/get_platform_safe_path.js

@@ -0,0 +1,8 @@
+import os from 'os';
+
+const get_platform_safe_path = (path = '') => {
+  // NOTE: This is why serial killers exist.
+  return os.platform() === "win32" ? path.replace(/\//g, '\\') : path;
+};
+
+export default get_platform_safe_path;

package/src/lib/get_sanitized_context.js

@@ -0,0 +1,51 @@
+const get_sanitized_context = (context = {}) => {
+  const sanitized_context = { ...context };
+  
+  if (sanitized_context?.req) {
+    delete sanitized_context.req;
+
+    sanitized_context.req = {
+      method: context?.req?.method,
+      headers: context?.req?.headers,
+      url: context?.req?.url,
+    };
+  }
+  
+  if (sanitized_context?.res) {
+    delete sanitized_context.res;
+    
+    sanitized_context.res = {
+      method: context?.res?.method,
+      headers: context?.res?.headers,
+      url: context?.res?.url,
+    };
+  }
+  
+  if (sanitized_context.mongodb) {
+    delete sanitized_context.mongodb;
+  }
+  
+  if (sanitized_context.postgresql) {
+    delete sanitized_context.postgresql;
+  }
+  
+  if (sanitized_context.redis) {
+    delete sanitized_context.redis;
+  }
+  
+  if (sanitized_context._users) {
+    delete sanitized_context._users;
+  }
+  
+  if (sanitized_context._queues) {
+    delete sanitized_context._queues;
+  }
+
+  if (sanitized_context._sessions) {
+    delete sanitized_context._sessions;
+  }
+  
+  return sanitized_context;
+};
+
+export default get_sanitized_context;

package/src/lib/get_translations.js

@@ -0,0 +1,109 @@
+import fs from 'fs';
+import dynamic_import from './dynamic_import.js';
+import get_platform_safe_path from './get_platform_safe_path.js';
+import load_settings from "../app/settings/load.js";
+import path_exists from './path_exists.js';
+import types from './types.js';
+
+const settings = load_settings();
+
+const get_translations_file = async (language_file_path = '', joystick_build_path = '', render_component_path = '') => {
+  const language_file = await dynamic_import(
+    `${joystick_build_path}/i18n/${language_file_path}?v=${new Date().getTime()}`
+  );
+
+  const is_valid_language_file = language_file && types.is_object(language_file);
+
+  if (is_valid_language_file) {
+    const translations_for_page = language_file[render_component_path];
+    return translations_for_page ? translations_for_page : language_file;
+  }
+
+  return {};
+};
+
+const get_language_preference_regexes = (user_language = '', browser_languages = [], email_template_name = '') => {
+  let language_preferences = [];
+
+  if (user_language) {
+    language_preferences.push(user_language);
+  }
+
+  const filtered_browser_languages = browser_languages?.filter((language) => {
+    return !language?.includes('*');
+  });
+
+  language_preferences.push(...filtered_browser_languages);
+
+  if (settings?.config?.i18n?.defaultLanguage || settings?.config?.i18n?.default_language) {
+    language_preferences.push(
+      settings?.config?.i18n?.defaultLanguage ||
+      settings?.config?.i18n?.default_language
+    );
+  }
+
+  return language_preferences?.flatMap((language) => {
+    const variants = [language];
+
+    if (language?.length === 2) {
+      variants.push(`${language.substring(0, 2)}-`);
+    }
+
+    if (language?.length > 2) {
+      variants.push(`${language?.split('-')[0]}`);
+      variants.push(`${language?.split('-')[0]}-`);
+    }
+
+    return variants;
+  })?.map((language_string) => {
+    const last_character = language_string[language_string.length - 1];
+
+    if (last_character === '-') {
+      return new RegExp(email_template_name ? `^${email_template_name}_${language_string}[A-Z]+.js` : `^${language_string}[A-Z]+.js`, 'g');
+    }
+
+    return new RegExp(email_template_name ? `^${email_template_name}_${language_string}.js` : `^${language_string}.js`, 'g');
+  });
+};
+
+const parse_browser_languages = (languages = '') => {
+  const raw_languages = languages.split(',');
+  return raw_languages?.map((raw_language) => raw_language.split(';')[0]);
+};
+
+const get_translations = async (get_translations_options = {}) => {
+  const language_files_path = get_translations_options?.is_email ?
+    `${get_translations_options?.joystick_build_path}i18n/email` :
+    `${get_translations_options?.joystick_build_path}i18n`;
+
+  const language_files = (await path_exists(language_files_path) && fs.readdirSync(language_files_path)) || [];
+  const browser_languages = get_translations_options?.is_email ? [] : parse_browser_languages(get_translations_options?.req?.headers['accept-language']);
+  const language_preferences = get_language_preference_regexes(
+    get_translations_options?.req?.context?.user?.language,
+    browser_languages,
+    get_translations_options?.email_template_name
+  );
+
+  let matching_file = null;
+
+  for (let i = 0; i < language_preferences.length; i += 1) {
+    const language_regex = language_preferences[i];
+    const match = language_files.find((language_file) => !!language_file.match(language_regex));
+
+    if (match) {
+      matching_file = match;
+      break;
+    }
+  }
+
+  const translations_file = matching_file ? await get_translations_file(
+    matching_file,
+    get_translations_options?.joystick_build_path,
+    get_translations_options?.render_component_path
+  ) : null;
+
+
+  return translations_file || {};
+};
+
+export default get_translations;

package/src/lib/hash_string.js

@@ -0,0 +1,7 @@
+import bcrypt from "bcrypt";
+
+const hash_string = (string = '') => {
+  return bcrypt.hashSync(string, 10);
+};
+
+export default hash_string;

package/src/lib/is_valid_json.js

@@ -0,0 +1,10 @@
+const is_valid_json = (string = '') => {
+	try {
+		JSON.parse(string);
+		return true;
+	} catch {
+		return false;
+	}
+};
+
+export default is_valid_json;

package/src/lib/log.js

@@ -0,0 +1,42 @@
+import chalk from 'chalk';
+import rainbow_road from './rainbow_road.js';
+
+const log = (message = '', options = {}) => {
+  const colors = {
+    info: 'blue',
+    success: 'green',
+    warning: 'yellowBright',
+    danger: 'red',
+  };
+
+  const titles = {
+    info: '❱ Info',
+    success: '❱ Ok',
+    warning: '❱ Warning',
+    danger: '❱ Error',
+  };
+
+  const color = options.level ? colors[options.level] : 'gray';
+  const title = options.level ? titles[options.level] : 'Log';
+  const docs = options.docs || 'https://github.com/cheatcode/joystick';
+
+  console.log(`\n${rainbow_road()}\n`);
+  console.log(`${chalk[color](`${title}:`)}\n`)
+  console.log(`${chalk.white(message)}\n`);
+  console.log(`${chalk.grey('---')}\n`);
+  console.log(`${chalk.white('Relevant Documentation:')}`)
+  console.log(`\n${chalk.blue(docs)}\n`);
+  console.log(`${chalk.white('Stuck? Ask a Question:')}\n`)
+  console.log(`${chalk.blue('http://discord.cheatcode.co')}\n`);
+  
+  if (options.tools && Array.isArray(options.tools)) {
+    console.log(`${chalk.white('Helpful Tools:')}\n`);
+    options.tools.forEach((tool) => {
+      console.log(`${chalk.blue(`${tool.title} — ${tool.url}`)}\n`);
+    });
+  }
+
+  console.log(`${rainbow_road()}\n`);
+};
+
+export default log;

package/src/lib/node_path_polyfills.js

@@ -0,0 +1,23 @@
+import os from 'os';
+import { dirname } from "path";
+import { fileURLToPath as file_url_to_path } from "url";
+
+const current_file_path = file_url_to_path(import.meta.url);
+const __package = dirname(current_file_path);
+const is_windows = os.platform() === 'win32';
+
+const node_path_polyfills = {
+  __package: __package?.replace(
+    is_windows ? '\\lib' : '/lib',
+    ''
+  ),
+  __filename: (url = '') => {
+    return file_url_to_path(url);
+  },
+  __dirname: (url = '') => {
+    const currentFilePath = file_url_to_path(url);
+    return dirname(currentFilePath);
+  },
+};
+
+export default node_path_polyfills;

package/src/lib/parse_json.js

@@ -0,0 +1,9 @@
+const parse_json = (string = '') => {
+	try {
+		return JSON.parse(string);
+	} catch {
+		return {};
+	}
+};
+
+export default parse_json;

package/src/lib/path_exists.js

@@ -0,0 +1,12 @@
+import fs from 'fs';
+import get_platform_safe_path from './get_platform_safe_path.js';
+
+const path_exists = (path = '') => {
+  return new Promise((resolve) => {
+    fs.access(get_platform_safe_path(path), fs.constants.F_OK, error => {
+      resolve(!error);
+    });
+  });
+};
+
+export default path_exists;

package/src/lib/rainbow_road.js

@@ -0,0 +1,7 @@
+import chalk from 'chalk';
+
+const rainbow_road = () => {
+  return `${chalk.red('=')}${chalk.green('=')}${chalk.blue('=')}${chalk.red('=')}${chalk.green('=')}${chalk.blue('=')}`;
+};
+
+export default rainbow_road;

package/src/lib/serialize_query_parameters.js

@@ -0,0 +1,7 @@
+const serialize_query_parameters = (query_parameters = {}) => {
+  return Object.entries(query_parameters || {}).map(([key, value]) => {
+    return `${key}=${value}`;
+  })?.join('&');
+};
+
+export default serialize_query_parameters;

package/src/lib/set_cookie.js

@@ -0,0 +1,16 @@
+const set_cookie = (res = {}, cookie_name = '', cookie_value = '', expires_at = null) => {
+  if (!res || !cookie_name) return null;
+
+  const cookie_options = {
+    secure: process.env.NODE_ENV !== "development",
+    httpOnly: true,
+  };
+  
+  if (expires_at) {
+    cookie_options.expires = new Date(expires_at);
+  }
+  
+  res.cookie(cookie_name, cookie_value, cookie_options);
+};
+
+export default set_cookie;

package/src/lib/string_to_slug.js

@@ -0,0 +1,14 @@
+const string_to_slug = (string = '') => {
+	let slug = string.toLowerCase().trim();
+  // Remove accents from charaters.
+  slug = slug.normalize('NFD').replace(/[\u0300-\u036f]/g, '')
+  // Replace invalid chars with spaces.
+  slug = slug.replace(/[^a-z0-9\s-_]/g, ' ').trim();
+  // Replace multiple spaces, hyphens, or underscores with a single hyphen/underscore.
+  slug = slug.replace(/[\s-]+/g, '-');
+  slug = slug.replace(/[\s_]+/g, '_');
+  
+  return slug;
+};
+
+export default string_to_slug;

package/src/lib/timestamps.js

@@ -0,0 +1,48 @@
+const timestamps = {
+	get_current_time: (options = {}) => {
+		const timestamp = new Date().toISOString();
+		return options?.mongodb_ttl ? new Date(timestamp) : timestamp;
+	},
+	get_future_time: (unit = '', quantity = 0, options = {}) => {
+		const date = options?.start_from ? new Date(options?.start_from) : new Date();
+
+		switch (unit) {
+			case 'seconds':
+				date.setSeconds(date.getSeconds() + quantity);
+				return options?.mongodb_ttl ? new Date(date.toISOString()) : date.toISOString();
+			case 'minutes':
+				date.setMinutes(date.getMinutes() + quantity);
+				return options?.mongodb_ttl ? new Date(date.toISOString()) : date.toISOString();
+			case 'hours':
+				date.setHours(date.getHours() + quantity);
+				return options?.mongodb_ttl ? new Date(date.toISOString()) : date.toISOString();
+			case 'days':
+				date.setHours(date.getHours() + (quantity * 24));
+				return options?.mongodb_ttl ? new Date(date.toISOString()) : date.toISOString();
+			default:
+				return options?.mongodb_ttl ? new Date(date.toISOString()) : date.toISOString();
+		}
+	},
+	get_past_time: (unit = '', quantity = 0, options = {}) => {
+		const date = options?.start_from ? new Date(options?.start_from) : new Date();
+
+		switch (unit) {
+			case 'seconds':
+				date.setSeconds(date.getSeconds() - quantity);
+				return options?.mongodb_ttl ? new Date(date.toISOString()) : date.toISOString();
+			case 'minutes':
+				date.setMinutes(date.getMinutes() - quantity);
+				return options?.mongodb_ttl ? new Date(date.toISOString()) : date.toISOString();
+			case 'hours':
+				date.setHours(date.getHours() - quantity);
+				return options?.mongodb_ttl ? new Date(date.toISOString()) : date.toISOString();
+			case 'days':
+				date.setHours(date.getHours() - (quantity * 24));
+				return options?.mongodb_ttl ? new Date(date.toISOString()) : date.toISOString();
+			default:
+				return options?.mongodb_ttl ? new Date(new Date().toISOString()) : new Date().toISOString();
+		}
+	},
+};
+
+export default timestamps;

package/src/lib/types.js

@@ -0,0 +1,59 @@
+const is_any = (value) => {
+  return !!value;
+};
+
+const is_array = (value) => {
+  return !!Array.isArray(value);
+};
+
+const is_boolean = (value) => {
+  return (value === true || value === false);
+};
+
+const is_float = (value) => {
+  return Number(value) === value && value % 1 !== 0;
+};
+
+const is_function = (value) => {
+  return typeof value === 'function';
+};
+
+const is_integer = (value) => {
+  return Number(value) === value && value % 1 === 0;
+};
+
+const is_null = (value) => {
+  return value === null;
+};
+
+const is_number = (value) => {
+  return Number(value) === value;
+};
+
+const is_object = (value) => {
+  return !!(value && typeof value === "object" && !Array.isArray(value));
+};
+
+const is_string = (value) => {
+  return typeof value === "string";
+};
+
+const is_undefined = (value) => {
+  return typeof value === 'undefined';
+};
+
+const types = {
+	is_any,
+	is_array,
+	is_boolean,
+	is_float,
+	is_function,
+	is_integer,
+	is_null,
+	is_number,
+	is_object,
+	is_string,
+	is_undefined,
+};
+
+export default types;

package/src/lib/unset_cookie.js

@@ -0,0 +1,11 @@
+const unset_cookie = (cookie_name = '', res = {}) => {
+  if (!cookie_name || !res) return null;
+  
+  res.cookie(cookie_name, null, {
+    secure: process.env.NODE_ENV !== "development",
+    httpOnly: true,
+    expires: new Date(),
+  });
+};
+
+export default unset_cookie;

package/src/lib/wait.js

@@ -0,0 +1,9 @@
+const wait = (seconds = 0) => {
+	return new Promise((resolve) => {
+		setTimeout(() => {
+			resolve();
+		}, seconds * 1000);
+	});
+};
+
+export default wait;

package/src/test/track_function_call.js

@@ -0,0 +1,16 @@
+const track_function_call = (path = '', args = []) => {
+  if (process.env.NODE_ENV === 'test') {
+    process.test = {
+      ...(process.test || {}),
+      function_calls: {
+        ...(process?.test?.function_calls || {}),
+        [path]: [
+          ...((process?.test?.function_calls && process?.test?.function_calls[path]) || []),
+          { called_at: new Date().toISOString(), args },
+        ]
+      }
+    };
+  }
+};
+
+export default track_function_call;

package/README.md

@@ -1,8 +0,0 @@
-<br />
-<img style="width: 200px;" src="https://cheatcode-assets.s3.amazonaws.com/logo-transparent.png" alt="CheatCode">
-
-## @joystick.js/node (Beta)
-
-A Node.js framework for building web apps.
-
-[Read the Documentation](https://github.com/cheatcode/joystick)

package/_package.json

@@ -1,63 +0,0 @@
-{
-  "name": "@joystick.js/node",
-  "version": "1.0.0-beta.166",
-  "developmentVersion": "1.0.0-beta.1419",
-  "type": "module",
-  "description": "A Node.js framework for building web apps.",
-  "main": "./dist/index.js",
-  "scripts": {
-    "build": "node .build/index.js",
-    "canary:release": "export NODE_ENV=development && npm run build && node canary.js",
-    "production:release": "export NODE_ENV=production && npm run build && node release.js",
-    "win:development:release": "SET NODE_ENV=development&& npm run build && node release.js",
-    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
-    "test:watch": "node --experimental-vm-modules node_modules/jest/bin/jest.js --watch --detectOpenHandles"
-  },
-  "keywords": [],
-  "author": "",
-  "license": "SAUCR",
-  "dependencies": {
-    "@tuskdb/node": "^0.11.0",
-    "aws-sdk": "^2.1046.0",
-    "bcrypt": "^5.0.1",
-    "chalk": "^4.1.2",
-    "compression": "^1.7.4",
-    "cookie-parser": "^1.4.5",
-    "cors": "^2.8.5",
-    "crypto-extra": "^1.0.1",
-    "css": "^3.0.0",
-    "dayjs": "^1.10.7",
-    "express": "^4.17.1",
-    "html-to-text": "^8.0.0",
-    "juice": "^8.0.0",
-    "linkedom": "^0.14.12",
-    "mongo-uri-tool": "^1.0.1",
-    "mongodb": "^4.1.3",
-    "multer": "^1.4.4",
-    "node-cron": "^3.0.2",
-    "node-fetch": "^3.0.0",
-    "node-html-parser": "^5.1.0",
-    "nodemailer": "^6.7.0",
-    "pg": "^8.7.3",
-    "process": "^0.11.10",
-    "query-string": "^7.0.1",
-    "sanitize-html": "^2.7.3",
-    "serve-favicon": "^2.5.0",
-    "ws": "^8.4.0"
-  },
-  "devDependencies": {
-    "@babel/core": "^7.16.0",
-    "@babel/preset-env": "^7.16.0",
-    "@jest/globals": "^27.3.1",
-    "@joystick.js/ui": "^1.0.0-beta.29",
-    "babel-jest": "^27.3.1",
-    "esbuild": "^0.13.9",
-    "jest": "^27.3.1",
-    "jest-cli": "^27.3.1",
-    "jest-express": "^1.12.0",
-    "jest-mock-req-res": "^1.0.2",
-    "kill-port-process": "^3.0.1",
-    "node-port-check": "^2.0.1",
-    "ps-node": "^0.1.6"
-  }
-}

package/canary.js

@@ -1,12 +0,0 @@
-import fs from 'fs';
-import child_process from 'child_process';
-
-fs.renameSync('package.json', '_package.json');
-fs.renameSync('canary.json', 'package.json');
-
-child_process.execSync('npm version prerelease --preid=canary');
-
-child_process.execSync('npm publish --access=public');
-
-fs.renameSync('package.json', 'canary.json');
-fs.renameSync('_package.json', 'package.json');