encommon 0.21.0__py3-none-any.whl → 0.22.0__py3-none-any.whl

encommon/webkit/scripts/helpers.js

@@ -0,0 +1,247 @@
+/*
+Functions and routines associated with Enasis Network Common Library.
+
+This file is part of Enasis Network software eco-system. Distribution
+is permitted, for more information consult the project license file.
+*/
+
+
+
+function assert(
+  condition,
+) {
+  // Assert the provided condition similar how using Python.
+
+  if (condition)
+    return true;
+
+  throw new Error('Assertion'); }
+
+
+
+function whenready(
+  callback,
+) {
+  // Attach the callback to the window session ready state.
+
+  assert(!isnull(callback));
+
+  let state =
+    document.readyState;
+
+  if (state == 'loading')
+    document
+    .addEventListener(
+      'DOMContentLoaded',
+      callback);
+
+  else callback(); }
+
+
+
+function isnull(
+  value,
+) {
+  // Return the boolean indicating the conditional outcome.
+
+  let haystack = [null, undefined];
+
+  if (haystack.includes(value))
+    return true;
+
+  return false; }
+
+
+
+function isempty(
+  value,
+) {
+  // Return the boolean indicating the conditional outcome.
+
+  if (isstr(value))
+    return value.length == 0;
+
+  if (isdict(value)) {
+
+    let keys =
+      Object.keys(value)
+      .length;
+
+    if (length == 0)
+        return true; }
+
+  if (islist(value))
+    return value.length == 0;
+
+  return isnull(value); }
+
+
+
+function isbool(
+  value,
+) {
+  // Return the boolean indicating the conditional outcome.
+
+  let haystack = [true, false];
+
+  if (haystack.includes(value))
+    return true;
+
+  return false; }
+
+
+
+function isstr(
+  value,
+) {
+  // Return the boolean indicating the conditional outcome.
+
+  if (typeof value === 'string')
+    return true;
+
+  return false; }
+
+
+
+function isnum(
+  value,
+) {
+  // Return the boolean indicating the conditional outcome.
+
+  if (typeof value === 'number')
+    return true;
+
+  return false; }
+
+
+
+function isquery(
+  value,
+) {
+  // Return the boolean indicating the conditional outcome.
+
+  try {
+
+    if (value.enquery)
+      return true; }
+
+  catch (e) { }
+
+  return false; }
+
+
+
+function isnode(
+  value,
+) {
+  // Return the boolean indicating the conditional outcome.
+
+  if (value instanceof Node)
+    return true;
+
+  return false; }
+
+
+
+function isnodes(
+  value,
+) {
+  // Return the boolean indicating the conditional outcome.
+
+  if (value instanceof NodeList)
+    return true;
+
+  return false; }
+
+
+
+function istime(
+  value,
+) {
+  // Return the boolean indicating the conditional outcome.
+
+  let date =
+    new Date(value);
+
+  if (!isNaN(date.getTime()))
+      return true;
+
+  return false; }
+
+
+
+function islist(
+  value,
+) {
+  // Return the boolean indicating the conditional outcome.
+
+  if (Array.isArray(value))
+    return true;
+
+  return false; }
+
+
+
+function isdict(
+  value,
+) {
+  // Return the boolean indicating the conditional outcome.
+
+  if (typeof(value) == 'object'
+      && !isnull(value)
+      && !Array.isArray(value))
+    return true;
+
+  return false; }
+
+
+
+function istrue(
+  value,
+) {
+  // Return the boolean indicating the conditional outcome.
+
+  if (value === true)
+    return true;
+
+  return false; }
+
+
+
+function isfalse(
+  value,
+) {
+  // Return the boolean indicating the conditional outcome.
+
+  if (value === false)
+    return true;
+
+  return false; }
+
+
+
+function loads(
+  value,
+) {
+  // Return the object value from the provided JSON string.
+
+  assert(isstr(value));
+
+  return JSON.parse(value); }
+
+
+
+function dumps(
+  value,
+  indent=null,
+) {
+  // Return the JSON string from the provided object value.
+
+  assert(!isnull(value));
+  assert(!isstr(value));
+
+  let returned =
+    JSON.stringify(
+      value, null, indent);
+
+  return returned; }

encommon/webkit/scripts/image.js

@@ -0,0 +1,39 @@
+/*
+Functions and routines associated with Enasis Network Common Library.
+
+This file is part of Enasis Network software eco-system. Distribution
+is permitted, for more information consult the project license file.
+*/
+
+
+
+function svgicon(
+  image,
+  dimension=null,
+) {
+  // Return the simple construct for SVG based icon images.
+
+  assert(!isnull(image));
+
+
+  let element =
+    $('<div/>').addClass(
+      'encommon_svgicon');
+
+
+  element.attr(
+    'data-image',
+    image);
+
+  if (!isnull(dimension)) {
+
+    element.css(
+      'height',
+      dimension);
+
+    element.css(
+      'width',
+      dimension); }
+
+
+  return element; }

encommon/webkit/scripts/message.js

@@ -0,0 +1,31 @@
+/*
+Functions and routines associated with Enasis Network Common Library.
+
+This file is part of Enasis Network software eco-system. Distribution
+is permitted, for more information consult the project license file.
+*/
+
+
+
+function message(
+  level,
+  about=null,
+) {
+  // Generate the severity based toast like message element.
+
+  assert(!isnull(level));
+
+
+  let element =
+    $('<div/>').addClass(
+      'encommon_message');
+
+
+  element.attr(
+    'data-level',
+    level);
+
+  element.html(about);
+
+
+  return element; }

encommon/webkit/scripts/moderate.js

@@ -0,0 +1,71 @@
+/*
+Functions and routines associated with Enasis Network Common Library.
+
+This file is part of Enasis Network software eco-system. Distribution
+is permitted, for more information consult the project license file.
+*/
+
+
+
+function moderate(
+  label=null,
+  icon=null,
+  small=null,
+) {
+  // Construct for containing a wide variety of value types.
+
+
+  let element =
+    $('<div/>').addClass(
+      'encommon_moderate');
+
+
+  if (!isnull(icon)) {
+
+    if (isstr(icon))
+      icon = svgicon(icon);
+
+    let _icon =
+      $('<div/>')
+      .addClass('_icon')
+      .replace(icon);
+
+    element.append(_icon); }
+
+
+  let value =
+    $('<div/>')
+    .addClass('_value');
+
+
+  let _value = false;
+
+  if (!isnull(label)) {
+
+    let _label =
+      $('<div/>')
+      .addClass('_label')
+      .html(label);
+
+    value.append(_label);
+
+    _value = true; }
+
+
+  if (!isnull(small)) {
+
+    let _small =
+      $('<div/>')
+      .addClass('_small')
+      .html(small);
+
+    value.append(_small);
+
+    _value = true; }
+
+
+  if (istrue(_value))
+    element.append(value);
+
+
+  return element; }

encommon/webkit/scripts/numeric.js

@@ -0,0 +1,189 @@
+/*
+Functions and routines associated with Enasis Network Common Library.
+
+This file is part of Enasis Network software eco-system. Distribution
+is permitted, for more information consult the project license file.
+*/
+
+
+
+function numeric(
+  value,
+  unit=null,
+) {
+  // Construct for containing a wide variety of value types.
+
+  assert(!isnull(value));
+
+
+  let element =
+    $('<div/>').addClass(
+      'encommon_numeric');
+
+
+  if (!isnum(value))
+    value =
+      parseFloat(value);
+
+  value = Number(
+    value.toFixed(1));
+
+
+  let parts =
+    value.toString()
+    .split('.');
+
+
+  element.append(
+    $('<span/>')
+    .addClass('_value')
+    .text(parts[0]));
+
+
+  if (parts.length == 2) {
+
+    element.append(
+      $('<span/>')
+      .addClass('_delim')
+      .text('.'));
+
+    element.append(
+      $('<span/>')
+      .addClass('_decimal')
+      .text(parts[1])); }
+
+
+  if (!isnull(unit))
+
+    element.append(
+      $('<span/>')
+      .addClass('_unit')
+      .html(unit));
+
+
+  return element; }
+
+
+
+function numeric_count(
+  value,
+) {
+  // Construct for containing a wide variety of value types.
+
+  assert(!isnull(value));
+
+
+  if (!isnum(value))
+    value =
+      parseFloat(value);
+
+  let unit = '';
+
+  if (value >= 1e12) {
+    value /= 1e12;
+    unit = 'trillion'; }
+
+  else if (value >= 1e9) {
+    value /= 1e9;
+    unit = 'billion'; }
+
+  else if (value >= 1e6) {
+    value /= 1e6;
+    unit = 'million'; }
+
+  else if (value >= 1e3) {
+    value /= 1e3;
+    unit = 'thousand'; }
+
+
+  let element =
+    numeric(value, unit);
+
+
+  return element; }
+
+
+
+function numeric_bytes(
+  value,
+) {
+  // Construct for containing a wide variety of value types.
+
+  assert(!isnull(value));
+
+
+  if (!isnum(value))
+    value =
+      parseFloat(value);
+
+  let unit = 'B';
+
+  if (value >= 1e12) {
+    value /= 1e12;
+    unit = 'TB'; }
+
+  else if (value >= 1e9) {
+    value /= 1e9;
+    unit = 'GB'; }
+
+  else if (value >= 1e6) {
+    value /= 1e6;
+    unit = 'MB'; }
+
+  else if (value >= 1e3) {
+    value /= 1e3;
+    unit = 'KB'; }
+
+
+  let element =
+    numeric(value, unit);
+
+
+  return element; }
+
+
+
+function numeric_ftemp(
+  value,
+) {
+  // Construct for containing a wide variety of value types.
+
+  assert(!isnull(value));
+
+
+  if (!isnum(value))
+    value =
+      parseFloat(value);
+
+  let unit = '°F';
+
+
+  let element =
+    numeric(value, unit);
+
+
+  return element; }
+
+
+
+function numeric_cftemp(
+  value,
+) {
+  // Construct for containing a wide variety of value types.
+
+  assert(!isnull(value));
+
+
+  if (!isnum(value))
+    value =
+      parseFloat(value);
+
+  value = value * (9 / 5);
+  value += 32;
+
+
+  let element =
+    numeric_ftemp(value);
+
+
+  return element; }

encommon/webkit/scripts/statate.js

@@ -0,0 +1,35 @@
+/*
+Functions and routines associated with Enasis Network Common Library.
+
+This file is part of Enasis Network software eco-system. Distribution
+is permitted, for more information consult the project license file.
+*/
+
+
+
+function statate(
+  status,
+  label=null,
+  small=null,
+) {
+  // Construct for containing the value status information.
+
+  assert(!isnull(status));
+
+
+  let element =
+    moderate(
+      label,
+      svgicon(status),
+      small);
+
+
+  element.addClass(
+    'encommon_statate');
+
+  element.attr(
+    'data-status',
+    status);
+
+
+  return element; }

encommon/webkit/scripts/tagues.js

@@ -0,0 +1,34 @@
+/*
+Functions and routines associated with Enasis Network Common Library.
+
+This file is part of Enasis Network software eco-system. Distribution
+is permitted, for more information consult the project license file.
+*/
+
+
+
+function tagues(
+  values,
+  brafter=true,
+) {
+  // Construct for containing the values that are tag like.
+
+  assert(!isnull(values));
+
+
+  let element =
+    $('<div/>').addClass(
+      'encommon_tagues');
+
+
+  if (!islist(values))
+    values = [values];
+
+  for (const x of values)
+    element.append(
+      $('<div/>')
+      .addClass('_value')
+      .text(x));
+
+
+  return element; }

encommon/webkit/styles/color.css

@@ -0,0 +1,57 @@
+/*
+Functions and routines associated with Enasis Network Common Library.
+
+This file is part of Enasis Network software eco-system. Distribution
+is permitted, for more information consult the project license file.
+*/
+
+
+
+/********************************************/
+/* Standard structure for colordiv elements */
+/********************************************/
+
+div.encommon_colordiv {
+  display: inline-block; }
+
+
+
+/********************************************/
+/* Extended structure for colordiv elements */
+/********************************************/
+
+div.encommon_colordiv
+ >._value {
+  border-width: .2rem .2rem .2rem .2rem;
+  border-style: solid;
+  border-color: rgba(var(--foreground), 0.4);
+  display: inline-block;
+  border-radius: .5rem .5rem .5rem .5rem;
+  height: 1.8rem;
+  width: 1.8rem; }
+
+
+
+/********************************************/
+/* Extended structure for colordiv elements */
+/********************************************/
+
+div.encommon_colordiv
+ >._label {
+  background-color: rgba(var(--foreground), .2);
+  border-radius: .2rem .2rem .2rem .2rem;
+  display: inline-block;
+  font-size: 1rem;
+  line-height: 1rem;
+  margin-left: .2rem;
+  padding: .2rem .3rem .2rem .3rem; }
+
+
+
+/********************************************/
+/* Extended structure for datagrid elements */
+/********************************************/
+
+table.encommon_datagrid
+ >tbody>tr>td:has(.encommon_colordiv) {
+  text-align: center; }