@graphenedata/cli 0.0.1

package/dist/ui/component-utilities/builtInFormats.js

@@ -0,0 +1,482 @@
+import {AUTO_FORMAT_CODE, applyColumnUnits, generateImplicitNumberFormat} from './autoFormatting'
+import ssf from 'ssf'
+
+export const SUPPORTED_CURRENCIES = [
+  {
+    primaryCode: 'usd',
+    currencySymbol: '$',
+    displayName: 'USD - United States Dollar',
+  },
+  {
+    primaryCode: 'aud',
+    currencySymbol: 'A$',
+    displayName: 'AUD - Australian Dollar',
+    escapeCurrencySymbol: true,
+  },
+  {
+    primaryCode: 'brl',
+    currencySymbol: 'R$',
+    displayName: 'BRL - Brazilian Real',
+    escapeCurrencySymbol: true,
+  },
+  {
+    primaryCode: 'cad',
+    currencySymbol: 'C$',
+    displayName: 'CAD - Canadian Dollar',
+    escapeCurrencySymbol: true,
+  },
+  {
+    primaryCode: 'cny',
+    currencySymbol: '¥',
+    displayName: 'CNY - Renminbi',
+    escapeCurrencySymbol: true,
+  },
+  {primaryCode: 'eur', currencySymbol: '€', displayName: 'EUR - Euro'},
+  {
+    primaryCode: 'gbp',
+    currencySymbol: '£',
+    displayName: 'GBP - Pound Sterling',
+    escapeCurrencySymbol: true,
+  },
+  {
+    primaryCode: 'jpy',
+    currencySymbol: '¥',
+    displayName: 'JPY - Japanese Yen',
+    escapeCurrencySymbol: true,
+  },
+  {
+    primaryCode: 'inr',
+    currencySymbol: '₹',
+    displayName: 'INR - Indian Rupee',
+    escapeCurrencySymbol: true,
+  },
+  {
+    primaryCode: 'krw',
+    currencySymbol: '₩',
+    displayName: 'KRW - South Korean won',
+    escapeCurrencySymbol: true,
+  },
+  {
+    primaryCode: 'ngn',
+    currencySymbol: '₦',
+    displayName: 'NGN -  Nigerian Naira',
+    escapeCurrencySymbol: true,
+  },
+  {
+    primaryCode: 'rub',
+    currencySymbol: 'rub',
+    displayName: 'RUB - Russian Ruble',
+    escapeCurrencySymbol: true,
+  },
+  {
+    primaryCode: 'sek',
+    currencySymbol: 'kr',
+    displayName: 'SEK - Swedish Krona',
+    escapeCurrencySymbol: true,
+  },
+]
+
+const DERIVED_CURRENCY_FORMATS = [
+  {
+    derivedSuffix: '',
+    valueFormatCode: '#,##0',
+    exampleInput: 412.17,
+    auto: true,
+  },
+  {
+    derivedSuffix: '0',
+    valueFormatCode: '#,##0',
+    exampleInput: 7043.123,
+  },
+  {
+    derivedSuffix: '1',
+    valueFormatCode: '#,##0.0',
+    exampleInput: 7043.123,
+  },
+  {
+    derivedSuffix: '2',
+    valueFormatCode: '#,##0.00',
+    exampleInput: 7043.123,
+  },
+  {
+    derivedSuffix: '0k',
+    valueFormatCode: '#,##0,"k"',
+    exampleInput: 64301.12,
+  },
+  {
+    derivedSuffix: '1k',
+    valueFormatCode: '#,##0.0,"k"',
+    exampleInput: 64301.12,
+  },
+  {
+    derivedSuffix: '2k',
+    valueFormatCode: '#,##0.00,"k"',
+    exampleInput: 64301.12,
+  },
+  {
+    derivedSuffix: '0m',
+    valueFormatCode: '#,##0,,"M"',
+    exampleInput: 4564301.12,
+  },
+  {
+    derivedSuffix: '1m',
+    valueFormatCode: '#,##0.0,,"M"',
+    exampleInput: 4564301.12,
+  },
+  {
+    derivedSuffix: '2m',
+    valueFormatCode: '#,##0.00,,"M"',
+    exampleInput: 4564301.12,
+  },
+  {
+    derivedSuffix: '0b',
+    valueFormatCode: '#,##0,,,"B"',
+    exampleInput: 9784564301.12,
+  },
+  {
+    derivedSuffix: '1b',
+    valueFormatCode: '#,##0.0,,,"B"',
+    exampleInput: 9784564301.12,
+  },
+  {
+    derivedSuffix: '2b',
+    valueFormatCode: '#,##0.00,,,"B"',
+    exampleInput: 9784564301.12,
+  },
+]
+
+const CURRENCY_FORMATS = SUPPORTED_CURRENCIES.map((currency) => {
+  let derivedFormats = []
+  DERIVED_CURRENCY_FORMATS.forEach((derivedFormat) => {
+    let next = {
+      formatTag: currency.primaryCode + derivedFormat.derivedSuffix,
+      parentFormat: currency.primaryCode,
+      formatCategory: 'currency',
+      valueType: 'number',
+      exampleInput: derivedFormat.exampleInput,
+      titleTagReplacement: ` (${currency.currencySymbol})`,
+    }
+    let symbolInFormatCode = currency.escapeCurrencySymbol
+      ? `"${currency.currencySymbol}"`
+      : currency.currencySymbol
+    if (derivedFormat.auto || AUTO_FORMAT_CODE === derivedFormat.formatCode) {
+      next.formatCode = AUTO_FORMAT_CODE
+      //TODO This should be fixed so that 1)the format is NOT recomputed for each value, 2)remove some of magic is done to make it look good.
+      next._autoFormat = {
+        autoFormatFunction: (typedValue, columnFormat, columnUnitSummary) => {
+          let format = generateImplicitNumberFormat(columnUnitSummary, 2)
+          let effectiveCode = `${symbolInFormatCode}${format._autoFormat.autoFormatCode}`
+          let suffix = ''
+          let displayValue = typedValue
+          if (format._autoFormat.truncateUnits && format._autoFormat.columnUnits) {
+            suffix = format._autoFormat.columnUnits
+            displayValue = applyColumnUnits(typedValue, format._autoFormat.columnUnits)
+          } else {
+            if (effectiveCode.endsWith('.0')) {
+              effectiveCode = effectiveCode + '0'
+            }
+          }
+          return ssf.format(effectiveCode, displayValue) + suffix
+        },
+      }
+    } else {
+      next.formatCode = `${symbolInFormatCode}${derivedFormat.valueFormatCode}`
+    }
+    if (derivedFormat.axisValueFormatCode) {
+      next.axisFormatCode = derivedFormat.axisValueFormatCode
+    }
+    derivedFormats.push(next)
+  })
+  return derivedFormats
+}).flat()
+
+export const BUILT_IN_FORMATS = [
+  ...CURRENCY_FORMATS,
+  //auto formats
+  // Date/Time:
+  {
+    formatTag: 'ddd',
+    formatCode: 'ddd',
+    formatCategory: 'date',
+    valueType: 'date',
+    exampleInput: '2022-01-09 12:45',
+  },
+  {
+    formatTag: 'dddd',
+    formatCode: 'dddd',
+    formatCategory: 'date',
+    valueType: 'date',
+    exampleInput: '2022-01-09 12:45',
+  },
+  {
+    formatTag: 'mmm',
+    formatCode: 'mmm',
+    formatCategory: 'date',
+    valueType: 'date',
+    exampleInput: '2022-01-09 12:45',
+  },
+  {
+    formatTag: 'mmmm',
+    formatCode: 'mmmm',
+    formatCategory: 'date',
+    valueType: 'date',
+    exampleInput: '2022-01-09 12:45',
+  },
+  {
+    formatTag: 'yyyy',
+    formatCode: 'yyyy',
+    formatCategory: 'date',
+    valueType: 'date',
+    exampleInput: '2022-01-09 12:45',
+  },
+  {
+    formatTag: 'shortdate',
+    formatCode: 'mmm d/yy',
+    formatCategory: 'date',
+    valueType: 'date',
+    exampleInput: '2022-01-09 12:45',
+  },
+  {
+    formatTag: 'longdate',
+    formatCode: 'mmmm d, yyyy',
+    formatCategory: 'date',
+    valueType: 'date',
+    exampleInput: '2022-01-09 12:45',
+  },
+  {
+    formatTag: 'fulldate',
+    formatCode: 'dddd mmmm d, yyyy',
+    formatCategory: 'date',
+    valueType: 'date',
+    exampleInput: '2022-01-09 12:45',
+  },
+  {
+    formatTag: 'mdy',
+    formatCode: 'm/d/y',
+    formatCategory: 'date',
+    valueType: 'date',
+    exampleInput: '2022-01-09 12:45',
+  },
+  {
+    formatTag: 'dmy',
+    formatCode: 'd/m/y',
+    formatCategory: 'date',
+    valueType: 'date',
+    exampleInput: '2022-01-09 12:45',
+  },
+  {
+    formatTag: 'hms',
+    formatCode: 'H:MM:SS AM/PM',
+    formatCategory: 'date',
+    valueType: 'date',
+    exampleInput: '2022-01-09T11:45:03',
+  },
+  // Numbers:
+  {
+    formatTag: 'num0',
+    formatCode: '#,##0',
+    formatCategory: 'number',
+    valueType: 'number',
+    exampleInput: 11.23168,
+  },
+  {
+    formatTag: 'num1',
+    formatCode: '#,##0.0',
+    formatCategory: 'number',
+    valueType: 'number',
+    exampleInput: 11.23168,
+  },
+  {
+    formatTag: 'num2',
+    formatCode: '#,##0.00',
+    formatCategory: 'number',
+    valueType: 'number',
+    exampleInput: 11.23168,
+  },
+  {
+    formatTag: 'num3',
+    formatCode: '#,##0.000',
+    formatCategory: 'number',
+    valueType: 'number',
+    exampleInput: 11.23168,
+  },
+  {
+    formatTag: 'num4',
+    formatCode: '#,##0.0000',
+    formatCategory: 'number',
+    valueType: 'number',
+    exampleInput: 11.23168,
+  },
+  {
+    formatTag: 'num0k',
+    formatCode: '#,##0,"k"',
+    formatCategory: 'number',
+    valueType: 'number',
+    exampleInput: 64201,
+  },
+  {
+    formatTag: 'num1k',
+    formatCode: '#,##0.0,"k"',
+    formatCategory: 'number',
+    valueType: 'number',
+    exampleInput: 64201,
+  },
+  {
+    formatTag: 'num2k',
+    formatCode: '#,##0.00,"k"',
+    formatCategory: 'number',
+    valueType: 'number',
+    exampleInput: 64201,
+  },
+  {
+    formatTag: 'num0m',
+    formatCode: '#,##0,,"M"',
+    formatCategory: 'number',
+    valueType: 'number',
+    exampleInput: 42539483,
+  },
+  {
+    formatTag: 'num1m',
+    formatCode: '#,##0.0,,"M"',
+    formatCategory: 'number',
+    valueType: 'number',
+    exampleInput: 42539483,
+  },
+  {
+    formatTag: 'num2m',
+    formatCode: '#,##0.00,,"M"',
+    formatCategory: 'number',
+    valueType: 'number',
+    exampleInput: 42539483,
+  },
+  {
+    formatTag: 'num0b',
+    formatCode: '#,##0,,,"B"',
+    formatCategory: 'number',
+    valueType: 'number',
+    exampleInput: 1384937584,
+  },
+  {
+    formatTag: 'num1b',
+    formatCode: '#,##0.0,,,"B"',
+    formatCategory: 'number',
+    valueType: 'number',
+    exampleInput: 1384937584,
+  },
+  {
+    formatTag: 'num2b',
+    formatCode: '#,##0.00,,,"B"',
+    formatCategory: 'number',
+    valueType: 'number',
+    exampleInput: 1384937584,
+  },
+  {
+    formatTag: 'id',
+    formatCode: '0',
+    formatCategory: 'number',
+    valueType: 'number',
+    exampleInput: '921594675',
+    titleTagReplacement: ' id',
+  },
+  {
+    formatTag: 'fract',
+    formatCode: '# ?/?',
+    formatCategory: 'number',
+    valueType: 'number',
+    exampleInput: '0.25',
+  },
+  {
+    formatTag: 'mult',
+    formatCode: '#,##0.0"x"',
+    formatCategory: 'number',
+    valueType: 'number',
+    exampleInput: '5.32',
+  },
+  {
+    formatTag: 'mult0',
+    formatCode: '#,##0"x"',
+    formatCategory: 'number',
+    valueType: 'number',
+    exampleInput: '5.32',
+  },
+  {
+    formatTag: 'mult1',
+    formatCode: '#,##0.0"x"',
+    formatCategory: 'number',
+    valueType: 'number',
+    exampleInput: '5.32',
+  },
+  {
+    formatTag: 'mult2',
+    formatCode: '#,##0.00"x"',
+    formatCategory: 'number',
+    valueType: 'number',
+    exampleInput: '5.32',
+  },
+  {
+    formatTag: 'sci',
+    formatCode: '0.00E+0',
+    formatCategory: 'number',
+    valueType: 'number',
+    exampleInput: '16546.1561',
+  },
+
+  // Percent:
+  {
+    formatTag: 'pct',
+    formatCode: AUTO_FORMAT_CODE,
+    formatCategory: 'percent',
+    valueType: 'number',
+    exampleInput: 0.731,
+    titleTagReplacement: '',
+    _autoFormat: {
+      autoFormatFunction: (typedValue, columnFormat, columnUnitSummary) => {
+        if ('number' === columnUnitSummary?.unitType) {
+          let adjustedColumnUnitSummary = {
+            min: columnUnitSummary.min * 100,
+            max: columnUnitSummary.max * 100,
+            median: columnUnitSummary.median * 100,
+            maxDecimals: Math.max(columnUnitSummary.maxDecimals - 2, 0),
+            unitType: columnUnitSummary.unitType,
+          }
+          let format = generateImplicitNumberFormat(adjustedColumnUnitSummary)
+          return ssf.format(format._autoFormat.autoFormatCode, typedValue * 100) + '%'
+        } else {
+          return ssf.format('#,##0%', typedValue)
+        }
+      },
+    },
+  },
+  {
+    formatTag: 'pct0',
+    formatCode: '#,##0%',
+    formatCategory: 'percent',
+    valueType: 'number',
+    exampleInput: 0.731,
+    titleTagReplacement: '',
+  },
+  {
+    formatTag: 'pct1',
+    formatCode: '#,##0.0%',
+    formatCategory: 'percent',
+    valueType: 'number',
+    exampleInput: 0.731,
+    titleTagReplacement: '',
+  },
+  {
+    formatTag: 'pct2',
+    formatCode: '#,##0.00%',
+    formatCategory: 'percent',
+    valueType: 'number',
+    exampleInput: 0.731,
+    titleTagReplacement: '',
+  },
+  {
+    formatTag: 'pct3',
+    formatCode: '#,##0.000%',
+    formatCategory: 'percent',
+    valueType: 'number',
+    exampleInput: 0.731,
+    titleTagReplacement: '',
+  },
+]

package/dist/ui/component-utilities/chartContext.js

@@ -0,0 +1,12 @@
+import {getContext, setContext} from 'svelte'
+const configKey = Symbol()
+const propKey = Symbol()
+
+export const strictBuild = false
+export {configKey, propKey}
+
+export const getConfigContext = () => getContext(configKey)
+export const setConfigContext = (v) => setContext(configKey, v)
+
+export const getPropContext = () => getContext(propKey)
+export const setPropContext = (v) => setContext(propKey, v)

package/dist/ui/component-utilities/chartWindowDebug.js

@@ -0,0 +1,21 @@
+const s = Symbol.for('__evidence-chart-window-debug__')
+const isBrowser = typeof window !== 'undefined'
+
+/**
+ * @param {string} key
+ * @param {unknown} value
+ */
+export const set = (key, value) => {
+  if (!isBrowser) return
+  if (!window[s]) window[s] = {}
+  window[s][key] = value
+}
+
+/**
+ * @param {string} key
+ */
+export const unset = (key) => {
+  if (!isBrowser) return
+  if (!window[s]) window[s] = {}
+  delete window[s][key]
+}

package/dist/ui/component-utilities/checkInputs.js

@@ -0,0 +1,95 @@
+export default function checkInputs (data, reqCols, optCols) {
+  // reqCols is an array of columns to check in the dataset
+  let columns = []
+
+  // Check if dataset was provided
+  if (data === undefined) {
+    throw Error('No data provided')
+  } else if (typeof data !== 'object') {
+    throw Error(
+      "'" +
+        data +
+        "'" +
+        ' is not a recognized query result. Data should be provided in the format: data = {' +
+        data.replace('data.', '') +
+        '}',
+    )
+  } else if (data[0] === undefined || data.length === 0) {
+    throw Error(
+      'Dataset is empty: query ran successfully, but no data was returned from the database',
+    )
+  }
+
+  // Check if data warehouse returned an error
+  if (data[0]?.error_object?.error != null) {
+    throw Error('SQL Error: ' + data[0]?.error_object?.error?.message)
+  }
+
+  if (reqCols != undefined) {
+    if (!(reqCols instanceof Array)) {
+      throw Error('reqCols must be passed in as an array')
+    }
+
+    // Check if columns were provided
+    for (let i = 0; i < reqCols.length; i++) {
+      if (reqCols[i] == null) {
+        throw Error(`Missing required column(s): ${reqCols[i]} not found in data set.`)
+      } else if (reqCols[i] == '') {
+        throw Error(
+          'Missing required column(s): A Empty string was provided for one of your props.',
+        )
+      }
+    }
+
+    // let errorString;
+    // if(missingCols.length > 0){
+    //     errorString = missingCols[0]
+    //     for(i = 1; i < missingCols.length; i++){
+    //         errorString = errorString + ", " + missingCols[i];
+    //     }
+    //     errorString = errorString + " not provided";
+    //     throw Error(errorString);
+    // }
+
+    // const dataIsQueryStore = data instanceof QueryStore;
+
+    // Get list of all columns in dataset
+    // we want to handle cases where the columns have not yet been fetched, but the data is avialable
+    // this is most likely to happen during pre-rendering, because column metadata is not yet included
+    // in the prerendering process
+    if (!data.columnsLoaded && data.dataLoaded) {
+      let cols = Object.keys(data[0])
+      for (let col of cols) {
+        columns.push(col)
+      }
+    } else {
+      for (let col of data.columns) {
+        columns.push(col.column_name)
+      }
+    }
+
+    // Check if provided columns are in the dataset
+    let currentCol
+    for (let i = 0; i < reqCols.length; i++) {
+      currentCol = reqCols[i]
+      if (!columns.includes(currentCol)) {
+        throw Error("'" + currentCol + "' is not a column in the dataset")
+      }
+    }
+
+    if (optCols != undefined && optCols.some((col) => col != null)) {
+      for (let i = 0; i < optCols.length; i++) {
+        currentCol = optCols[i]
+        if (currentCol == null) continue
+        if (!columns.includes(currentCol)) {
+          throw Error("'" + currentCol + "' is not a column in the dataset")
+        }
+      }
+    }
+  }
+  // IDEAS:
+  // Trigger a function call when error is caught - that function somehow sends us to the Error chart component
+  // rather than letting the rest of the current component file continue running?
+  // Almost 2 layers of error: (1) up front check errors and (2) actual execution of the chart errors
+  // (1) is handled here, (2) may need a wrapper around the main part of the component code
+}

package/dist/ui/component-utilities/convert.js

@@ -0,0 +1,15 @@
+export const toBoolean = (value) => {
+  if (typeof value === 'undefined' || value === null) return undefined
+  if (typeof value === 'string') {
+    let normalized = value.trim().toLowerCase()
+    if (normalized === 'true') return true
+    if (normalized === 'false') return false
+  }
+  return Boolean(value)
+}
+
+export const toNumber = (value) => {
+  if (typeof value === 'undefined' || value === null) return undefined
+  let num = Number(value)
+  return Number.isNaN(num) ? undefined : num
+}

package/dist/ui/component-utilities/dateParsing.js

@@ -0,0 +1,57 @@
+import {tidy, mutate} from '@tidyjs/tidy'
+
+export function standardizeDateString (date) {
+  if (date && typeof date === 'string') {
+    // Parses an individual string into a JS date object
+
+    let dateSplit = date.split(' ')
+
+    // If date doesn't contain timestamp, add one at midnight (avoids timezone interpretation issue)
+    if (!date.includes(':')) {
+      date = date + 'T00:00:00'
+    }
+
+    // Remove any character groups beyond 2 (date and time):
+    if (dateSplit.length > 2) {
+      date = dateSplit[0] + ' ' + dateSplit[1]
+    }
+
+    // Replace microseconds if needed:
+    let re = /\.([^\s]+)/
+    date = date.replace(re, '')
+
+    // Remove "Z" to avoid timezone interpretation issue:
+    date = date.replace('Z', '')
+
+    // Replace spaces with "T" to conform to ECMA standard:
+    date = date.replace(' ', 'T')
+  }
+
+  return date
+}
+
+export function convertColumnToDate (data, column) {
+  // Replaces a date column's string values with JS date objects, using the standardizeDateString function
+
+  let converted = tidy(
+    data,
+    mutate({[column]: (d) => (d[column] ? new Date(standardizeDateString(d[column])) : null)}),
+  )
+
+  if (data && typeof data === 'object') {
+    for (let key of Object.keys(data)) {
+      if (!/^\d+$/.test(key)) converted[key] = data[key]
+    }
+  }
+
+  return converted
+}
+
+export function standardizeDateColumn (data, column) {
+  // Replaces a date column's string values with standardized date strings, using the standardizeDateString function
+  // Used in Chart.svelte, where using Date objects leads to errors
+
+  data = tidy(data, mutate({[column]: (d) => standardizeDateString(d[column])}))
+
+  return data
+}

package/dist/ui/component-utilities/dropdownContext.ts

@@ -0,0 +1 @@
+export const DROPDOWN_CONTEXT = Symbol('DropdownContext')