@cirrobio/sdk 0.12.9 → 0.12.12

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 as number);
+}

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

@@ -0,0 +1,16 @@
+/**
+ * Converts a string to PascalCase.
+ * Ex., "hello world" -> "HelloWorld"
+ * @param value The string to convert.
+ */
+export function toPascalCase(value: string): string {
+  return value
+    // Split on non-alphanumeric characters and spaces
+    .split(/[^a-zA-Z0-9]+/)
+    // Filter out empty strings
+    .filter(word => word.length > 0)
+    // Capitalize first letter and lowercase the rest
+    .map(word => word.charAt(0).toUpperCase() + word.slice(1).toLowerCase())
+    // Join all words together
+    .join('');
+}

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

@@ -0,0 +1,6 @@
+export * from './file';
+export * from './api';
+export * from './auth';
+export * from './data';
+export * from './formatters';
+export * from './util';

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

@@ -0,0 +1,29 @@
+import { extractFromObject } from "../extract-from-object";
+
+describe("extractFromObject", () => {
+  const obj = {
+    user: {
+      name: "Cirro",
+      age: 30
+    },
+    test: 'test'
+  };
+
+  it("basic path extraction", () => {
+    expect(extractFromObject("$.user.name", obj)).toBe("Cirro");
+    expect(extractFromObject("$.user.age", obj)).toBe(30);
+    expect(extractFromObject("$.test", obj)).toBe("test");
+  });
+
+  it("should extract entire nested object", () => {
+    expect(extractFromObject("$.user", obj)).toEqual(obj.user);
+  });
+
+  it("should return undefined for non-existent property", () => {
+    expect(extractFromObject("$.bad", obj)).toBeUndefined();
+  });
+
+  it("should handle empty object", () => {
+    expect(extractFromObject("$.name", {})).toBeUndefined();
+  });
+});

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/get-resource-name.ts

@@ -0,0 +1,7 @@
+
+const resourcePrefix = 'project-';
+
+export function getResourceName(projectId: string): string {
+  return `${resourcePrefix}${projectId}`;
+}
+

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,4 @@
+export { extractFromObject } from './util/extract-from-object'
+export { handlePromiseError } from './util/handle-promise'
+export { downloadBlob, downloadContent } from './util/download';
+export { getResourceName } from './util/get-resource-name';