@cirrobio/sdk 0.2.22 → 0.3.0

package/dist/file/calculate-size.d.ts

@@ -0,0 +1,7 @@
+import { FileSystemObject } from "./file-object.model";
+/**
+ * Calculate the total size of all files in a directory.
+ * @param files - An array of FileSystemObject representing the files in the directory.
+ * @return The total size of all files in bytes.
+ */
+export declare function calculateTotalSize(files: Array<FileSystemObject>): number;

package/dist/file/calculate-size.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.calculateTotalSize = void 0;
+/**
+ * Calculate the total size of all files in a directory.
+ * @param files - An array of FileSystemObject representing the files in the directory.
+ * @return The total size of all files in bytes.
+ */
+function calculateTotalSize(files) {
+    let totalSize = 0;
+    for (const file of files) {
+        totalSize += file.size;
+    }
+    return totalSize;
+}
+exports.calculateTotalSize = calculateTotalSize;

package/dist/file.d.ts

@@ -9,4 +9,5 @@ export { s3UriToParams } from './file/util/s3-utils';
 export { createS3Client } from './file/util/s3-client';
 export { credentialsCache, credentialsMutex } from './file/util/credentials-mutex.so';
 export { getProjectS3Bucket } from './file/shared';
+export { calculateTotalSize } from './file/calculate-size';
 export { Progress, Upload } from '@aws-sdk/lib-storage';

package/dist/file.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Upload = exports.getProjectS3Bucket = exports.credentialsMutex = exports.credentialsCache = exports.createS3Client = exports.s3UriToParams = exports.FileSystemObjectType = exports.ProjectFileAccessContext = exports.uploadFile = exports.getSignedUrl = exports.deleteFile = exports.FileService = void 0;
+exports.Upload = exports.calculateTotalSize = exports.getProjectS3Bucket = exports.credentialsMutex = exports.credentialsCache = exports.createS3Client = exports.s3UriToParams = exports.FileSystemObjectType = exports.ProjectFileAccessContext = exports.uploadFile = exports.getSignedUrl = exports.deleteFile = exports.FileService = void 0;
 __exportStar(require("./file/extensions.fn"), exports);
 var file_service_1 = require("./file/file.service");
 Object.defineProperty(exports, "FileService", { enumerable: true, get: function () { return file_service_1.FileService; } });
@@ -37,5 +37,7 @@ Object.defineProperty(exports, "credentialsCache", { enumerable: true, get: func
 Object.defineProperty(exports, "credentialsMutex", { enumerable: true, get: function () { return credentials_mutex_so_1.credentialsMutex; } });
 var shared_1 = require("./file/shared");
 Object.defineProperty(exports, "getProjectS3Bucket", { enumerable: true, get: function () { return shared_1.getProjectS3Bucket; } });
+var calculate_size_1 = require("./file/calculate-size");
+Object.defineProperty(exports, "calculateTotalSize", { enumerable: true, get: function () { return calculate_size_1.calculateTotalSize; } });
 var lib_storage_1 = require("@aws-sdk/lib-storage");
 Object.defineProperty(exports, "Upload", { enumerable: true, get: function () { return lib_storage_1.Upload; } });

package/dist/formatters/bytes-to-string.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Format bytes as human-readable text.
+ * @param bytes Number of bytes.
+ * @param si True to use metric(SI) units, aka powers of 1000. False to use
+ * binary(IEC), aka powers of 1024.
+   * @param dp Number of decimal places to display.
+ *
+ * @return Formatted string.
+ */
+export declare function bytesToString(bytes: any, si?: boolean, dp?: number): string;

package/dist/formatters/bytes-to-string.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.bytesToString = void 0;
+/**
+ * Format bytes as human-readable text.
+ * @param bytes Number of bytes.
+ * @param si True to use metric(SI) units, aka powers of 1000. False to use
+ * binary(IEC), aka powers of 1024.
+   * @param dp Number of decimal places to display.
+ *
+ * @return Formatted string.
+ */
+function bytesToString(bytes, si = false, dp = 1) {
+    const thresh = si ? 1000 : 1024;
+    if (Math.abs(bytes) < thresh) {
+        return `${bytes} B`;
+    }
+    const units = si
+        ? ['kB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB']
+        : ['KiB', 'MiB', 'GiB', 'TiB', 'PiB', 'EiB', 'ZiB', 'YiB'];
+    let u = -1;
+    const r = 10 ** dp;
+    do {
+        bytes /= thresh;
+        ++u;
+    } while (Math.round(Math.abs(bytes) * r) / r >= thresh
+        && u < units.length - 1);
+    return `${bytes.toFixed(dp)} ${units[u]}`;
+}
+exports.bytesToString = bytesToString;

package/dist/formatters/json-pretty-print.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Pretty prints a JSON object with the specified indentation level.
+ * @param obj JSON object to be pretty printed.
+ * @param indentLevel Number of spaces to use for indentation.
+ */
+export declare function jsonPrettyPrint(obj: object, indentLevel?: number): string;

package/dist/formatters/json-pretty-print.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.jsonPrettyPrint = void 0;
+/**
+ * Pretty prints a JSON object with the specified indentation level.
+ * @param obj JSON object to be pretty printed.
+ * @param indentLevel Number of spaces to use for indentation.
+ */
+function jsonPrettyPrint(obj, indentLevel = 2) {
+    return JSON.stringify(obj, null, indentLevel);
+}
+exports.jsonPrettyPrint = jsonPrettyPrint;

package/dist/formatters/normalize-date.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Normalizes a date to UTC by adjusting for the timezone offset.
+ * Useful when you are working with dates that may not include time information.
+ * @param date
+ */
+export declare function normalizeDate(date: Date | string | undefined | null): Date;

package/dist/formatters/normalize-date.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeDate = void 0;
+/**
+ * Normalizes a date to UTC by adjusting for the timezone offset.
+ * Useful when you are working with dates that may not include time information.
+ * @param date
+ */
+function normalizeDate(date) {
+    if (!date)
+        throw new Error("Attempt to normalize undefined");
+    if (!(date instanceof Date))
+        date = new Date(date);
+    return new Date(date.getTime() - date.getTimezoneOffset() * -60000);
+}
+exports.normalizeDate = normalizeDate;

package/dist/formatters/normalize-string.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Normalize a string by trimming it and returning null if it is empty.
+ * @param input The string to normalize.
+ */
+export declare function normalizeString(input: string): string;

package/dist/formatters/normalize-string.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeString = void 0;
+/**
+ * Normalize a string by trimming it and returning null if it is empty.
+ * @param input The string to normalize.
+ */
+function normalizeString(input) {
+    if (!(input === null || input === void 0 ? void 0 : input.trim()))
+        return null;
+    return input.trim();
+}
+exports.normalizeString = normalizeString;

package/dist/formatters/slash.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Removes the starting slash from a path.
+ * @param path Input path
+ */
+export declare function removeStartingSlash(path: string): string;
+/**
+ * Removes the ending slash from a path.
+ * @param path Input path
+ */
+export declare function removeEndingSlash(path: string): string;

package/dist/formatters/slash.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removeEndingSlash = exports.removeStartingSlash = void 0;
+/**
+ * Removes the starting slash from a path.
+ * @param path Input path
+ */
+function removeStartingSlash(path) {
+    return (path === null || path === void 0 ? void 0 : path.startsWith('/')) ? path.substring(1) : path;
+}
+exports.removeStartingSlash = removeStartingSlash;
+/**
+ * Removes the ending slash from a path.
+ * @param path Input path
+ */
+function removeEndingSlash(path) {
+    return (path === null || path === void 0 ? void 0 : path.endsWith('/')) ? path.slice(0, -1) : path;
+}
+exports.removeEndingSlash = removeEndingSlash;

package/dist/formatters/to-date-format.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Converts a date string or Date object to MM/DD/YY date string.
+ * Ex., "2023-10-01" -> "10/01/23"
+ * @param date Input date string or Date object.
+ */
+export declare function toDateFormat(date: string | Date): string;

package/dist/formatters/to-date-format.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toDateFormat = void 0;
+const dateFormat = new Intl.DateTimeFormat('en-US', { month: '2-digit', day: '2-digit', year: '2-digit' });
+/**
+ * Converts a date string or Date object to MM/DD/YY date string.
+ * Ex., "2023-10-01" -> "10/01/23"
+ * @param date Input date string or Date object.
+ */
+function toDateFormat(date) {
+    if (!date)
+        return null;
+    const d = (typeof date === 'string') ? new Date(date) : date;
+    return dateFormat.format(d);
+}
+exports.toDateFormat = toDateFormat;

package/dist/formatters/to-friendly-name.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Converts a field name to a more human-readable format.
+ * Ex., "helloWorld" -> "Hello World"
+ * @param value The value to convert.
+ */
+export declare function toFriendlyName(value: string): string;

package/dist/formatters/to-friendly-name.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toFriendlyName = void 0;
+const to_title_case_1 = require("./to-title-case");
+/**
+ * Converts a field name to a more human-readable format.
+ * Ex., "helloWorld" -> "Hello World"
+ * @param value The value to convert.
+ */
+function toFriendlyName(value) {
+    let _value = value.split(/(?=[A-Z])/).join(' ');
+    _value = _value.split('_').join(' ');
+    _value = _value.split('|').join(' ');
+    _value = _value.replace(/ +/g, ' ');
+    return (0, to_title_case_1.toTitleCase)(_value);
+}
+exports.toFriendlyName = toFriendlyName;

package/dist/formatters/to-money.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Converts a number or bigint to a formatted money string.
+ * Ex., 1234.56 -> $1,234.56
+ * @param value Input number or bigint value.
+ */
+export declare function toMoney(value: number | bigint): string;

package/dist/formatters/to-money.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toMoney = void 0;
+const money = new Intl.NumberFormat('en-US', {
+    style: 'currency',
+    currency: 'USD',
+});
+/**
+ * Converts a number or bigint to a formatted money string.
+ * Ex., 1234.56 -> $1,234.56
+ * @param value Input number or bigint value.
+ */
+function toMoney(value) {
+    return money.format(value);
+}
+exports.toMoney = toMoney;

package/dist/formatters/to-pascal-case.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Converts a string to PascalCase.
+ * Ex., "hello world" -> "HelloWorld"
+ * @param value The string to convert.
+ */
+export declare function toPascalCase(value: string): string;

package/dist/formatters/to-pascal-case.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toPascalCase = void 0;
+/**
+ * Converts a string to PascalCase.
+ * Ex., "hello world" -> "HelloWorld"
+ * @param value The string to convert.
+ */
+function toPascalCase(value) {
+    return value.replace(/(\w)(\w*)/g, (g0, g1, g2) => g1.toUpperCase() + g2.toLowerCase());
+}
+exports.toPascalCase = toPascalCase;

package/dist/formatters/to-title-case.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Converts a string to Title case.
+ * Ex., "hello world" -> "Hello world"
+ * @param value
+ */
+export declare function toTitleCase(value: string): string;

package/dist/formatters/to-title-case.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toTitleCase = void 0;
+/**
+ * Converts a string to Title case.
+ * Ex., "hello world" -> "Hello world"
+ * @param value
+ */
+function toTitleCase(value) {
+    if (!value)
+        return null;
+    return value[0].toUpperCase() + value.slice(1).toLowerCase();
+}
+exports.toTitleCase = toTitleCase;

package/dist/formatters.d.ts

@@ -0,0 +1,10 @@
+export { jsonPrettyPrint } from './formatters/json-pretty-print';
+export { bytesToString } from './formatters/bytes-to-string';
+export { normalizeDate } from './formatters/normalize-date';
+export { normalizeString } from './formatters/normalize-string';
+export { removeStartingSlash, removeEndingSlash } from './formatters/slash';
+export { toDateFormat } from './formatters/to-date-format';
+export { toFriendlyName } from './formatters/to-friendly-name';
+export { toMoney } from './formatters/to-money';
+export { toPascalCase } from './formatters/to-pascal-case';
+export { toTitleCase } from './formatters/to-title-case';

package/dist/formatters.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toTitleCase = exports.toPascalCase = exports.toMoney = exports.toFriendlyName = exports.toDateFormat = exports.removeEndingSlash = exports.removeStartingSlash = exports.normalizeString = exports.normalizeDate = exports.bytesToString = exports.jsonPrettyPrint = void 0;
+var json_pretty_print_1 = require("./formatters/json-pretty-print");
+Object.defineProperty(exports, "jsonPrettyPrint", { enumerable: true, get: function () { return json_pretty_print_1.jsonPrettyPrint; } });
+var bytes_to_string_1 = require("./formatters/bytes-to-string");
+Object.defineProperty(exports, "bytesToString", { enumerable: true, get: function () { return bytes_to_string_1.bytesToString; } });
+var normalize_date_1 = require("./formatters/normalize-date");
+Object.defineProperty(exports, "normalizeDate", { enumerable: true, get: function () { return normalize_date_1.normalizeDate; } });
+var normalize_string_1 = require("./formatters/normalize-string");
+Object.defineProperty(exports, "normalizeString", { enumerable: true, get: function () { return normalize_string_1.normalizeString; } });
+var slash_1 = require("./formatters/slash");
+Object.defineProperty(exports, "removeStartingSlash", { enumerable: true, get: function () { return slash_1.removeStartingSlash; } });
+Object.defineProperty(exports, "removeEndingSlash", { enumerable: true, get: function () { return slash_1.removeEndingSlash; } });
+var to_date_format_1 = require("./formatters/to-date-format");
+Object.defineProperty(exports, "toDateFormat", { enumerable: true, get: function () { return to_date_format_1.toDateFormat; } });
+var to_friendly_name_1 = require("./formatters/to-friendly-name");
+Object.defineProperty(exports, "toFriendlyName", { enumerable: true, get: function () { return to_friendly_name_1.toFriendlyName; } });
+var to_money_1 = require("./formatters/to-money");
+Object.defineProperty(exports, "toMoney", { enumerable: true, get: function () { return to_money_1.toMoney; } });
+var to_pascal_case_1 = require("./formatters/to-pascal-case");
+Object.defineProperty(exports, "toPascalCase", { enumerable: true, get: function () { return to_pascal_case_1.toPascalCase; } });
+var to_title_case_1 = require("./formatters/to-title-case");
+Object.defineProperty(exports, "toTitleCase", { enumerable: true, get: function () { return to_title_case_1.toTitleCase; } });

package/dist/index.d.ts

@@ -1,2 +1,4 @@
 export * from './file';
 export * from './api';
+export * from './formatters';
+export * from './util';

package/dist/index.js

@@ -16,3 +16,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./file"), exports);
 __exportStar(require("./api"), exports);
+__exportStar(require("./formatters"), exports);
+__exportStar(require("./util"), exports);

package/dist/util/download.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Download a blob as a file with the specified file name.
+ */
+export declare function downloadBlob(blob: Blob, fileName: string): void;
+/**
+ * Downloads the specified content as a file with the specified file name and type.
+ */
+export declare function downloadContent(content: any, fileName: string, fileType?: string): void;

package/dist/util/download.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.downloadContent = exports.downloadBlob = void 0;
+/**
+ * Download a blob as a file with the specified file name.
+ */
+function downloadBlob(blob, fileName) {
+    const url = window.URL.createObjectURL(blob);
+    const a = document.createElement('a');
+    a.href = url;
+    a.download = fileName;
+    a.click();
+}
+exports.downloadBlob = downloadBlob;
+/**
+ * Downloads the specified content as a file with the specified file name and type.
+ */
+function downloadContent(content, fileName, fileType = 'text/plain') {
+    const blob = new Blob([content], { type: fileType });
+    downloadBlob(blob, fileName);
+}
+exports.downloadContent = downloadContent;

package/dist/util/extract-from-object.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Extracts a value from an object using the json path notation, i.e. $.test.id
+ * @param path JSON path to the value
+ * @param obj Object to extract the value from
+ */
+export declare function extractFromObject(path: string, obj: object): any;

package/dist/util/extract-from-object.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractFromObject = void 0;
+/**
+ * Extracts a value from an object using the json path notation, i.e. $.test.id
+ * @param path JSON path to the value
+ * @param obj Object to extract the value from
+ */
+function extractFromObject(path, obj) {
+    const pathParts = path.slice(2).split('.');
+    return pathParts.reduce(function (o, k) {
+        return o && o[k];
+    }, obj);
+}
+exports.extractFromObject = extractFromObject;

package/dist/util/handle-promise.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Ignores dangling promise rejections.
+ * @param err The error to ignore.
+ */
+export declare function handlePromiseError(err: any): void;

package/dist/util/handle-promise.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handlePromiseError = void 0;
+/**
+ * Ignores dangling promise rejections.
+ * @param err The error to ignore.
+ */
+function handlePromiseError(err) {
+    console.warn(err);
+}
+exports.handlePromiseError = handlePromiseError;

package/dist/util.d.ts

@@ -0,0 +1,3 @@
+export { extractFromObject } from './util/extract-from-object';
+export { handlePromiseError } from './util/handle-promise';
+export { downloadBlob, downloadContent } from './util/download';

package/dist/util.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.downloadContent = exports.downloadBlob = exports.handlePromiseError = exports.extractFromObject = void 0;
+var extract_from_object_1 = require("./util/extract-from-object");
+Object.defineProperty(exports, "extractFromObject", { enumerable: true, get: function () { return extract_from_object_1.extractFromObject; } });
+var handle_promise_1 = require("./util/handle-promise");
+Object.defineProperty(exports, "handlePromiseError", { enumerable: true, get: function () { return handle_promise_1.handlePromiseError; } });
+var download_1 = require("./util/download");
+Object.defineProperty(exports, "downloadBlob", { enumerable: true, get: function () { return download_1.downloadBlob; } });
+Object.defineProperty(exports, "downloadContent", { enumerable: true, get: function () { return download_1.downloadContent; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cirrobio/sdk",
-  "version": "0.2.22",
+  "version": "0.3.0",
   "description": "SDK for Cirro",
   "author": "CirroBio",
   "repository": {
@@ -14,7 +14,8 @@
   "typings": "./dist/index.d.ts",
   "scripts": {
     "build": "tsc",
-    "prepare": "npm run build"
+    "prepare": "npm run build",
+    "test": "jest --coverage --silent"
   },
   "jest": {
     "coverageReporters": [

package/src/file/calculate-size.ts

@@ -0,0 +1,14 @@
+import { FileSystemObject } from "./file-object.model";
+
+/**
+ * Calculate the total size of all files in a directory.
+ * @param files - An array of FileSystemObject representing the files in the directory.
+ * @return The total size of all files in bytes.
+ */
+export function calculateTotalSize(files: Array<FileSystemObject>): number {
+  let totalSize = 0;
+  for (const file of files) {
+    totalSize += file.size;
+  }
+  return totalSize;
+}

package/src/file.ts

@@ -9,4 +9,5 @@ export { s3UriToParams } from './file/util/s3-utils'
 export { createS3Client } from './file/util/s3-client'
 export { credentialsCache, credentialsMutex } from './file/util/credentials-mutex.so';
 export { getProjectS3Bucket } from './file/shared'
+export { calculateTotalSize } from './file/calculate-size'
 export { Progress, Upload } from '@aws-sdk/lib-storage';

package/src/formatters/__tests__/formatters.spec.ts

@@ -0,0 +1,65 @@
+import { bytesToString } from "../bytes-to-string";
+import { normalizeDate } from "../normalize-date";
+import { removeEndingSlash, removeStartingSlash } from "../slash";
+import { toFriendlyName } from "../to-friendly-name";
+import { toMoney } from "../to-money";
+import { toTitleCase } from "../to-title-case";
+
+describe('bytesToString', () => {
+  it('should convert IEC bytes to string', () => {
+    expect(bytesToString(12521, false)).toBe('12.2 KiB');
+  });
+
+  it('should convert SI bytes to string', () => {
+    expect(bytesToString(12521, true, 2)).toBe('12.52 kB');
+  });
+});
+
+describe('normalizeDate', () => {
+  it('should work on a string input', () => {
+    const dateString = '2022-12-01'
+    const output = normalizeDate(dateString).toISOString().split('T')[0]
+    expect(output).toEqual(dateString);
+  });
+
+  it('should work on a Date object input', () => {
+    const dateString = '2022-12-01'
+    const output = normalizeDate(new Date(dateString)).toISOString().split('T')[0]
+    expect(output).toEqual(dateString);
+  });
+});
+
+describe('removeStartingSlash', () => {
+  it('should remove the starting slash from a string', () => {
+    expect(removeStartingSlash('/example/path/')).toBe('example/path/');
+  });
+});
+
+describe('removeEndingSlash', () => {
+  it('should remove the ending slash from a string', () => {
+    expect(removeEndingSlash('/example/path/')).toBe('/example/path');
+  });
+});
+
+describe('toFriendlyName', () => {
+  it('should add correct spaces to a string', () => {
+    expect(toFriendlyName('ExampleUnfriendly|Name_here')).toBe('Example unfriendly name here');
+
+  });
+});
+
+describe('toMoney', () => {
+  it('convert an integer value to a money-formatted string', () => {
+    expect(toMoney(25)).toBe('$25.00');
+  });
+
+  it('convert a float value to a money-formatted string', () => {
+    expect(toMoney(117.15)).toBe('$117.15');
+  });
+});
+
+describe('toTitleCase', () => {
+  it('should convert a string to title case', () => {
+    expect(toTitleCase('convert To Title case')).toBe('Convert to title case');
+  });
+});

package/src/formatters/bytes-to-string.ts

@@ -0,0 +1,32 @@
+/**
+ * Format bytes as human-readable text.
+ * @param bytes Number of bytes.
+ * @param si True to use metric(SI) units, aka powers of 1000. False to use
+ * binary(IEC), aka powers of 1024.
+   * @param dp Number of decimal places to display.
+ *
+ * @return Formatted string.
+ */
+export function bytesToString(bytes, si = false, dp = 1): string {
+  const thresh = si ? 1000 : 1024;
+
+  if (Math.abs(bytes) < thresh) {
+    return `${bytes} B`;
+  }
+
+  const units = si
+    ? ['kB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB']
+    : ['KiB', 'MiB', 'GiB', 'TiB', 'PiB', 'EiB', 'ZiB', 'YiB'];
+  let u = -1;
+  const r = 10 ** dp;
+
+  do {
+    bytes /= thresh;
+    ++u;
+  } while (
+    Math.round(Math.abs(bytes) * r) / r >= thresh
+    && u < units.length - 1
+    );
+
+  return `${bytes.toFixed(dp)} ${units[u]}`;
+}

package/src/formatters/json-pretty-print.ts

@@ -0,0 +1,8 @@
+/**
+ * Pretty prints a JSON object with the specified indentation level.
+ * @param obj JSON object to be pretty printed.
+ * @param indentLevel Number of spaces to use for indentation.
+ */
+export function jsonPrettyPrint(obj: object, indentLevel=2): string {
+  return JSON.stringify(obj, null, indentLevel);
+}

package/src/formatters/normalize-date.ts

@@ -0,0 +1,10 @@
+/**
+ * Normalizes a date to UTC by adjusting for the timezone offset.
+ * Useful when you are working with dates that may not include time information.
+ * @param date
+ */
+export function normalizeDate(date: Date | string | undefined | null): Date {
+  if (!date) throw new Error("Attempt to normalize undefined");
+  if (!(date instanceof Date)) date = new Date(date);
+  return new Date(date.getTime() - date.getTimezoneOffset() * -60000);
+}

package/src/formatters/normalize-string.ts

@@ -0,0 +1,8 @@
+/**
+ * Normalize a string by trimming it and returning null if it is empty.
+ * @param input The string to normalize.
+ */
+export function normalizeString(input: string): string {
+  if (!input?.trim()) return null;
+  return input.trim();
+}

package/src/formatters/slash.ts

@@ -0,0 +1,15 @@
+/**
+ * Removes the starting slash from a path.
+ * @param path Input path
+ */
+export function removeStartingSlash(path: string): string {
+  return path?.startsWith('/') ? path.substring(1) : path;
+}
+
+/**
+ * Removes the ending slash from a path.
+ * @param path Input path
+ */
+export function removeEndingSlash(path: string): string {
+  return path?.endsWith('/') ? path.slice(0, -1) : path;
+}

package/src/formatters/to-date-format.ts

@@ -0,0 +1,12 @@
+const dateFormat = new Intl.DateTimeFormat('en-US', { month: '2-digit', day: '2-digit', year: '2-digit' });
+
+/**
+ * Converts a date string or Date object to MM/DD/YY date string.
+ * Ex., "2023-10-01" -> "10/01/23"
+ * @param date Input date string or Date object.
+ */
+export function toDateFormat(date: string | Date): string {
+  if (!date) return null;
+  const d: Date = (typeof date === 'string') ? new Date(date) : date
+  return dateFormat.format(d);
+}

package/src/formatters/to-friendly-name.ts

@@ -0,0 +1,14 @@
+import { toTitleCase } from './to-title-case';
+
+/**
+ * Converts a field name to a more human-readable format.
+ * Ex., "helloWorld" -> "Hello World"
+ * @param value The value to convert.
+ */
+export function toFriendlyName(value: string): string {
+  let _value = value.split(/(?=[A-Z])/).join(' ');
+  _value = _value.split('_').join(' ');
+  _value = _value.split('|').join(' ');
+  _value = _value.replace(/ +/g, ' ');
+  return toTitleCase(_value);
+}

package/src/formatters/to-money.ts

@@ -0,0 +1,13 @@
+const money = new Intl.NumberFormat('en-US', {
+  style: 'currency',
+  currency: 'USD',
+});
+
+/**
+ * Converts a number or bigint to a formatted money string.
+ * Ex., 1234.56 -> $1,234.56
+ * @param value Input number or bigint value.
+ */
+export function toMoney(value: number | bigint): string {
+  return money.format(value);
+}

package/src/formatters/to-pascal-case.ts

@@ -0,0 +1,8 @@
+/**
+ * Converts a string to PascalCase.
+ * Ex., "hello world" -> "HelloWorld"
+ * @param value The string to convert.
+ */
+export function toPascalCase(value: string): string {
+  return value.replace(/(\w)(\w*)/g, (g0, g1, g2) => g1.toUpperCase() + g2.toLowerCase());
+}

package/src/formatters/to-title-case.ts

@@ -0,0 +1,9 @@
+/**
+ * Converts a string to Title case.
+ * Ex., "hello world" -> "Hello world"
+ * @param value
+ */
+export function toTitleCase(value: string): string {
+  if (!value) return null;
+  return value[0].toUpperCase() + value.slice(1).toLowerCase();
+}

package/src/formatters.ts

@@ -0,0 +1,10 @@
+export { jsonPrettyPrint } from './formatters/json-pretty-print';
+export { bytesToString } from './formatters/bytes-to-string';
+export { normalizeDate } from './formatters/normalize-date';
+export { normalizeString } from './formatters/normalize-string';
+export { removeStartingSlash, removeEndingSlash } from './formatters/slash';
+export { toDateFormat } from './formatters/to-date-format';
+export { toFriendlyName } from './formatters/to-friendly-name';
+export { toMoney } from './formatters/to-money';
+export { toPascalCase } from './formatters/to-pascal-case';
+export { toTitleCase } from './formatters/to-title-case';

package/src/index.ts

@@ -1,2 +1,4 @@
 export * from './file';
 export * from './api';
+export * from './formatters';
+export * from './util';

package/src/util/download.ts

@@ -0,0 +1,18 @@
+/**
+ * Download a blob as a file with the specified file name.
+ */
+export function downloadBlob(blob: Blob, fileName: string): void {
+  const url = window.URL.createObjectURL(blob);
+  const a = document.createElement('a');
+  a.href = url;
+  a.download = fileName;
+  a.click();
+}
+
+/**
+ * Downloads the specified content as a file with the specified file name and type.
+ */
+export function downloadContent(content: any, fileName: string, fileType = 'text/plain'): void {
+  const blob = new Blob([content], { type: fileType });
+  downloadBlob(blob, fileName);
+}

package/src/util/extract-from-object.ts

@@ -0,0 +1,11 @@
+/**
+ * Extracts a value from an object using the json path notation, i.e. $.test.id
+ * @param path JSON path to the value
+ * @param obj Object to extract the value from
+ */
+export function extractFromObject(path: string, obj: object): any {
+  const pathParts = path.slice(2).split('.')
+  return pathParts.reduce(function(o, k) {
+    return o && o[k];
+  }, obj);
+}

package/src/util/handle-promise.ts

@@ -0,0 +1,7 @@
+/**
+ * Ignores dangling promise rejections.
+ * @param err The error to ignore.
+ */
+export function handlePromiseError(err): void {
+  console.warn(err);
+}

package/src/util.ts

@@ -0,0 +1,3 @@
+export { extractFromObject } from './util/extract-from-object'
+export { handlePromiseError } from './util/handle-promise'
+export { downloadBlob, downloadContent } from './util/download';

package/tsconfig.json

@@ -15,6 +15,7 @@
   },
   "exclude": [
     "dist",
-    "node_modules"
+    "node_modules",
+    "src/**/*.spec.ts"
   ]
 }