@rockcarver/frodo-lib 0.19.1 → 0.19.2

package/types/ops/utils/ExportImportUtils.d.ts

@@ -1,5 +1,4 @@
 import { ExportMetaData } from '../OpsTypes';
-export declare function getCurrentTimestamp(): string;
 export declare function getMetadata(): ExportMetaData;
 export declare function titleCase(input: any): any;
 export declare function getRealmString(): string;

package/types/ops/utils/ExportImportUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/ops/utils/ExportImportUtils.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAG7C,wBAAgB,mBAAmB,WAGlC;AAED,wBAAgB,WAAW,IAAI,cAAc,CAU5C;AAOD,wBAAgB,SAAS,CAAC,KAAK,KAAA,OAO9B;AAED,wBAAgB,cAAc,WAK7B;AAED,wBAAgB,wBAAwB,CAAC,OAAO,KAAA,SAM/C;AAED,wBAAgB,2BAA2B,CAAC,WAAW,KAAA,SAMtD;AAED,wBAAgB,wBAAwB,CAAC,SAAS,KAAA,UAIjD;AAED,wBAAgB,2BAA2B,CAAC,SAAS,KAAA,OAIpD;AAGD,wBAAgB,cAAc,CAAC,QAAQ,KAAA,GAAG,OAAO,CAEhD;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,SAAS,UAG3E;AAED,wBAAgB,mBAAmB,WAalC;AAED,wBAAgB,UAAU,CAAC,IAAI,KAAA,EAAE,IAAI,KAAA,EAAE,UAAU,KAAA,EAAE,QAAQ,KAAA,QAkB1D;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,IAAI,KAAA,EAAE,QAAQ,KAAA,EAAE,WAAW,UAAO,GAAG,OAAO,CAU1E;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,KAAA,EAAE,QAAQ,KAAA,QAM9C;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAC7B,QAAQ,EAAE,MAAM,EAChB,IAAI,UAAO,EACX,IAAI,SAAO,GACV,MAAM,EAAE,CAqBV;AAED;;;;;GAKG;AACH,wBAAsB,kBAAkB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAgB7E","file":"ExportImportUtils.d.ts","sourcesContent":["import fs from 'fs';\nimport { lstat, readdir } from 'fs/promises';\nimport { join } from 'path';\nimport slugify from 'slugify';\nimport {\n  decode,\n  decodeBase64Url,\n  encode,\n  encodeBase64Url,\n} from '../../api/utils/Base64';\nimport * as state from '../../shared/State';\nimport { FRODO_METADATA_ID } from '../../storage/StaticStorage';\nimport { ExportMetaData } from '../OpsTypes';\nimport { debugMessage, printMessage } from './Console';\n\nexport function getCurrentTimestamp() {\n  const ts = new Date();\n  return ts.toISOString();\n}\n\nexport function getMetadata(): ExportMetaData {\n  const metadata: ExportMetaData = {\n    origin: state.getHost(),\n    originAmVersion: state.getAmVersion(),\n    exportedBy: state.getUsername(),\n    exportDate: getCurrentTimestamp(),\n    exportTool: FRODO_METADATA_ID,\n    exportToolVersion: state.getFrodoVersion(),\n  };\n  return metadata;\n}\n\n/*\n * Output str in title case\n *\n * e.g.: 'ALL UPPERCASE AND all lowercase' = 'All Uppercase And All Lowercase'\n */\nexport function titleCase(input) {\n  const str = input.toString();\n  const splitStr = str.toLowerCase().split(' ');\n  for (let i = 0; i < splitStr.length; i += 1) {\n    splitStr[i] = splitStr[i].charAt(0).toUpperCase() + splitStr[i].slice(1);\n  }\n  return splitStr.join(' ');\n}\n\nexport function getRealmString() {\n  const realm = state.getRealm();\n  return realm\n    .split('/')\n    .reduce((result, item) => `${result}${titleCase(item)}`, '');\n}\n\nexport function convertBase64TextToArray(b64text) {\n  let arrayOut = [];\n  let plainText = decode(b64text);\n  plainText = plainText.replace(/\\t/g, '    ');\n  arrayOut = plainText.split('\\n');\n  return arrayOut;\n}\n\nexport function convertBase64UrlTextToArray(b64UTF8Text) {\n  let arrayOut = [];\n  let plainText = decodeBase64Url(b64UTF8Text);\n  plainText = plainText.replace(/\\t/g, '    ');\n  arrayOut = plainText.split('\\n');\n  return arrayOut;\n}\n\nexport function convertTextArrayToBase64(textArray) {\n  const joinedText = textArray.join('\\n');\n  const b64encodedScript = encode(joinedText);\n  return b64encodedScript;\n}\n\nexport function convertTextArrayToBase64Url(textArray) {\n  const joinedText = textArray.join('\\n');\n  const b64encodedScript = encodeBase64Url(joinedText);\n  return b64encodedScript;\n}\n\n// eslint-disable-next-line no-unused-vars\nexport function validateImport(metadata): boolean {\n  return metadata || true;\n}\n\nexport function getTypedFilename(name: string, type: string, suffix = 'json') {\n  const slug = slugify(name.replace(/^http(s?):\\/\\//, ''));\n  return `${slug}.${type}.${suffix}`;\n}\n\nexport function getWorkingDirectory() {\n  let wd = '.';\n  if (state.getDirectory()) {\n    wd = state.getDirectory().replace(/\\/$/, '');\n    // create directory if it doesn't exist\n    if (!fs.existsSync(wd)) {\n      debugMessage(\n        `ExportImportUtils.getWorkingDirectory: creating directory '${wd}'`\n      );\n      fs.mkdirSync(wd, { recursive: true });\n    }\n  }\n  return wd;\n}\n\nexport function saveToFile(type, data, identifier, filename) {\n  const exportData = {};\n  exportData['meta'] = getMetadata();\n  exportData[type] = {};\n\n  if (Array.isArray(data)) {\n    data.forEach((element) => {\n      exportData[type][element[identifier]] = element;\n    });\n  } else {\n    exportData[type][data[identifier]] = data;\n  }\n  fs.writeFile(filename, JSON.stringify(exportData, null, 2), (err) => {\n    if (err) {\n      return printMessage(`ERROR - can't save ${type} to file`, 'error');\n    }\n    return '';\n  });\n}\n\n/**\n * Save JSON object to file\n * @param {Object} data data object\n * @param {String} filename file name\n * @return {boolean} true if successful, false otherwise\n */\nexport function saveJsonToFile(data, filename, includeMeta = true): boolean {\n  const exportData = data;\n  if (includeMeta) exportData.meta = getMetadata();\n  try {\n    fs.writeFileSync(filename, JSON.stringify(exportData, null, 2));\n    return true;\n  } catch (err) {\n    printMessage(`ERROR - can't save ${filename}`, 'error');\n    return false;\n  }\n}\n\n/**\n * Append text data to file\n * @param {String} data text data\n * @param {String} filename file name\n */\nexport function appendTextToFile(data, filename) {\n  try {\n    fs.appendFileSync(filename, data);\n  } catch (error) {\n    printMessage(`${error.message}`, 'error');\n  }\n}\n\n/**\n * Find files by name\n * @param {string} fileName file name to search for\n * @param {boolean} fast return first result and stop search\n * @param {string} path path to directory where to start the search\n * @returns {string[]} array of found file paths relative to starting directory\n */\nexport function findFilesByName(\n  fileName: string,\n  fast = true,\n  path = './'\n): string[] {\n  const entries = fs.readdirSync(path, {\n    encoding: 'utf8',\n    withFileTypes: true,\n  });\n\n  // Get files within the current directory and add a path key to the file objects\n  const files: string[] = entries\n    .filter((entry) => !entry.isDirectory())\n    .filter((file) => file.name === fileName)\n    // .map((file) => ({ ...file, path: path + file.name }));\n    .map((file) => path + file.name);\n\n  if (fast && files.length > 0) return files;\n\n  // search sub-folders\n  const folders = entries.filter((entry) => entry.isDirectory());\n  for (const folder of folders)\n    files.push(...findFilesByName(fileName, fast, `${path}${folder.name}/`));\n\n  return files;\n}\n\n/**\n * find all (nested) files in a directory\n *\n * @param directory directory to search\n * @returns list of files\n */\nexport async function readFilesRecursive(directory: string): Promise<string[]> {\n  const items = await readdir(directory);\n\n  const filePathsNested = await Promise.all(\n    items.map(async (entity) => {\n      const path = join(directory, entity);\n      const isDirectory = (await lstat(path)).isDirectory();\n\n      if (isDirectory) {\n        return readFilesRecursive(path);\n      }\n      return path;\n    })\n  );\n\n  return filePathsNested.flat();\n}\n"]}
+{"version":3,"sources":["../src/ops/utils/ExportImportUtils.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAG7C,wBAAgB,WAAW,IAAI,cAAc,CAU5C;AAOD,wBAAgB,SAAS,CAAC,KAAK,KAAA,OAO9B;AAED,wBAAgB,cAAc,WAK7B;AAED,wBAAgB,wBAAwB,CAAC,OAAO,KAAA,SAM/C;AAED,wBAAgB,2BAA2B,CAAC,WAAW,KAAA,SAMtD;AAED,wBAAgB,wBAAwB,CAAC,SAAS,KAAA,UAIjD;AAED,wBAAgB,2BAA2B,CAAC,SAAS,KAAA,OAIpD;AAGD,wBAAgB,cAAc,CAAC,QAAQ,KAAA,GAAG,OAAO,CAEhD;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,SAAS,UAG3E;AAED,wBAAgB,mBAAmB,WAalC;AAED,wBAAgB,UAAU,CAAC,IAAI,KAAA,EAAE,IAAI,KAAA,EAAE,UAAU,KAAA,EAAE,QAAQ,KAAA,QAkB1D;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,IAAI,KAAA,EAAE,QAAQ,KAAA,EAAE,WAAW,UAAO,GAAG,OAAO,CAU1E;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,KAAA,EAAE,QAAQ,KAAA,QAM9C;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAC7B,QAAQ,EAAE,MAAM,EAChB,IAAI,UAAO,EACX,IAAI,SAAO,GACV,MAAM,EAAE,CAqBV;AAED;;;;;GAKG;AACH,wBAAsB,kBAAkB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAgB7E","file":"ExportImportUtils.d.ts","sourcesContent":["import fs from 'fs';\nimport { lstat, readdir } from 'fs/promises';\nimport { join } from 'path';\nimport slugify from 'slugify';\nimport {\n  decode,\n  decodeBase64Url,\n  encode,\n  encodeBase64Url,\n} from '../../api/utils/Base64';\nimport * as state from '../../shared/State';\nimport { FRODO_METADATA_ID } from '../../storage/StaticStorage';\nimport { ExportMetaData } from '../OpsTypes';\nimport { debugMessage, printMessage } from './Console';\n\nexport function getMetadata(): ExportMetaData {\n  const metadata: ExportMetaData = {\n    origin: state.getHost(),\n    originAmVersion: state.getAmVersion(),\n    exportedBy: state.getUsername(),\n    exportDate: new Date().toISOString(),\n    exportTool: FRODO_METADATA_ID,\n    exportToolVersion: state.getFrodoVersion(),\n  };\n  return metadata;\n}\n\n/*\n * Output str in title case\n *\n * e.g.: 'ALL UPPERCASE AND all lowercase' = 'All Uppercase And All Lowercase'\n */\nexport function titleCase(input) {\n  const str = input.toString();\n  const splitStr = str.toLowerCase().split(' ');\n  for (let i = 0; i < splitStr.length; i += 1) {\n    splitStr[i] = splitStr[i].charAt(0).toUpperCase() + splitStr[i].slice(1);\n  }\n  return splitStr.join(' ');\n}\n\nexport function getRealmString() {\n  const realm = state.getRealm();\n  return realm\n    .split('/')\n    .reduce((result, item) => `${result}${titleCase(item)}`, '');\n}\n\nexport function convertBase64TextToArray(b64text) {\n  let arrayOut = [];\n  let plainText = decode(b64text);\n  plainText = plainText.replace(/\\t/g, '    ');\n  arrayOut = plainText.split('\\n');\n  return arrayOut;\n}\n\nexport function convertBase64UrlTextToArray(b64UTF8Text) {\n  let arrayOut = [];\n  let plainText = decodeBase64Url(b64UTF8Text);\n  plainText = plainText.replace(/\\t/g, '    ');\n  arrayOut = plainText.split('\\n');\n  return arrayOut;\n}\n\nexport function convertTextArrayToBase64(textArray) {\n  const joinedText = textArray.join('\\n');\n  const b64encodedScript = encode(joinedText);\n  return b64encodedScript;\n}\n\nexport function convertTextArrayToBase64Url(textArray) {\n  const joinedText = textArray.join('\\n');\n  const b64encodedScript = encodeBase64Url(joinedText);\n  return b64encodedScript;\n}\n\n// eslint-disable-next-line no-unused-vars\nexport function validateImport(metadata): boolean {\n  return metadata || true;\n}\n\nexport function getTypedFilename(name: string, type: string, suffix = 'json') {\n  const slug = slugify(name.replace(/^http(s?):\\/\\//, ''));\n  return `${slug}.${type}.${suffix}`;\n}\n\nexport function getWorkingDirectory() {\n  let wd = '.';\n  if (state.getDirectory()) {\n    wd = state.getDirectory().replace(/\\/$/, '');\n    // create directory if it doesn't exist\n    if (!fs.existsSync(wd)) {\n      debugMessage(\n        `ExportImportUtils.getWorkingDirectory: creating directory '${wd}'`\n      );\n      fs.mkdirSync(wd, { recursive: true });\n    }\n  }\n  return wd;\n}\n\nexport function saveToFile(type, data, identifier, filename) {\n  const exportData = {};\n  exportData['meta'] = getMetadata();\n  exportData[type] = {};\n\n  if (Array.isArray(data)) {\n    data.forEach((element) => {\n      exportData[type][element[identifier]] = element;\n    });\n  } else {\n    exportData[type][data[identifier]] = data;\n  }\n  fs.writeFile(filename, JSON.stringify(exportData, null, 2), (err) => {\n    if (err) {\n      return printMessage(`ERROR - can't save ${type} to file`, 'error');\n    }\n    return '';\n  });\n}\n\n/**\n * Save JSON object to file\n * @param {Object} data data object\n * @param {String} filename file name\n * @return {boolean} true if successful, false otherwise\n */\nexport function saveJsonToFile(data, filename, includeMeta = true): boolean {\n  const exportData = data;\n  if (includeMeta) exportData.meta = getMetadata();\n  try {\n    fs.writeFileSync(filename, JSON.stringify(exportData, null, 2));\n    return true;\n  } catch (err) {\n    printMessage(`ERROR - can't save ${filename}`, 'error');\n    return false;\n  }\n}\n\n/**\n * Append text data to file\n * @param {String} data text data\n * @param {String} filename file name\n */\nexport function appendTextToFile(data, filename) {\n  try {\n    fs.appendFileSync(filename, data);\n  } catch (error) {\n    printMessage(`${error.message}`, 'error');\n  }\n}\n\n/**\n * Find files by name\n * @param {string} fileName file name to search for\n * @param {boolean} fast return first result and stop search\n * @param {string} path path to directory where to start the search\n * @returns {string[]} array of found file paths relative to starting directory\n */\nexport function findFilesByName(\n  fileName: string,\n  fast = true,\n  path = './'\n): string[] {\n  const entries = fs.readdirSync(path, {\n    encoding: 'utf8',\n    withFileTypes: true,\n  });\n\n  // Get files within the current directory and add a path key to the file objects\n  const files: string[] = entries\n    .filter((entry) => !entry.isDirectory())\n    .filter((file) => file.name === fileName)\n    // .map((file) => ({ ...file, path: path + file.name }));\n    .map((file) => path + file.name);\n\n  if (fast && files.length > 0) return files;\n\n  // search sub-folders\n  const folders = entries.filter((entry) => entry.isDirectory());\n  for (const folder of folders)\n    files.push(...findFilesByName(fileName, fast, `${path}${folder.name}/`));\n\n  return files;\n}\n\n/**\n * find all (nested) files in a directory\n *\n * @param directory directory to search\n * @returns list of files\n */\nexport async function readFilesRecursive(directory: string): Promise<string[]> {\n  const items = await readdir(directory);\n\n  const filePathsNested = await Promise.all(\n    items.map(async (entity) => {\n      const path = join(directory, entity);\n      const isDirectory = (await lstat(path)).isDirectory();\n\n      if (isDirectory) {\n        return readFilesRecursive(path);\n      }\n      return path;\n    })\n  );\n\n  return filePathsNested.flat();\n}\n"]}