@appsemble/utils 0.20.9 → 0.20.12

package/constants/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,8CAA4B;AAC5B,yCAAuB;AACvB,0CAAwB;AACxB,2CAAyB;AACzB,2CAAyB;AACzB,6CAA2B;AAC3B,0CAAwB;AACxB,+CAA6B"}

package/constants/index.ts

@@ -0,0 +1,9 @@
+export * from './baseTheme';
+export * from './asciiLogo';
+export * from './date';
+export * from './fonts';
+export * from './locale';
+export * from './scopes';
+export * from './patterns';
+export * from './roles';
+export * from './Permission';

package/constants/locale.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"locale.js","sourceRoot":"","sources":["locale.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACU,QAAA,aAAa,GAAG,IAAI,CAAC"}

package/constants/locale.ts

@@ -0,0 +1,4 @@
+/**
+ * The default locale language code across Appsemble Studio and apps.
+ */
+export const defaultLocale = 'en';

package/constants/patterns.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"patterns.js","sourceRoot":"","sources":["patterns.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACU,QAAA,aAAa,GAAG,eAAe,CAAC;AAE7C;;GAEG;AACU,QAAA,QAAQ,GAAG,kBAAkB,CAAC;AAE3C;;GAEG;AACU,QAAA,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,qBAAa,CAAC,MAAM,GAAG,CAAC,CAAC;AAE9D;;GAEG;AACU,QAAA,iBAAiB,GAAG,wCAAwC,CAAC;AAE1E;;GAEG;AACU,QAAA,UAAU,GAAG,IAAI,MAAM,CAAC,IAAI,yBAAiB,CAAC,MAAM,GAAG,CAAC,CAAC;AAEtE;;GAEG;AACU,QAAA,gBAAgB,GAAG,IAAI,MAAM,CACxC,KAAK,yBAAiB,CAAC,MAAM,IAAI,yBAAiB,CAAC,MAAM,GAAG,CAC7D,CAAC;AAEW,QAAA,aAAa,GAAG,IAAI,MAAM,CAAC,KAAK,yBAAiB,CAAC,MAAM,kBAAkB,CAAC,CAAC;AAEzF;;GAEG;AACU,QAAA,wBAAwB,GAAG,wCAAwC,CAAC;AAEjF;;GAEG;AACU,QAAA,YAAY,GAAG,8DAA8D,CAAC;AAE3F;;GAEG;AACU,QAAA,UAAU,GAAG,yBAAyB,CAAC"}

package/constants/patterns.test.d.ts

@@ -0,0 +1 @@
+export {};

package/constants/patterns.test.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const patterns_1 = require("./patterns");
+describe('partialNormalized', () => {
+    it.each([
+        ['Ffoo', 'foo'],
+        ['barB', 'bar'],
+        ['I am victorous', 'am'],
+    ])('should match %j as %j', (input, expected) => {
+        const match = input.match(patterns_1.partialNormalized);
+        expect(match).not.toBeNull();
+        expect(match).toHaveLength(2);
+        expect([...match]).toStrictEqual([expected, expected]);
+    });
+    it('should be reusable to compose a new regular expression', () => {
+        const composed = new RegExp(`^@${patterns_1.partialNormalized.source}/${patterns_1.partialNormalized.source}$`);
+        const match = '@foo/bar'.match(composed);
+        expect(match).not.toBeNull();
+        expect(match).toHaveLength(3);
+        expect([...match]).toStrictEqual(['@foo/bar', 'foo', 'bar']);
+    });
+});
+describe('normalized', () => {
+    it.each([
+        'foo',
+        'bar',
+        'a',
+        'ab',
+        'hyphenated-string',
+        'multi-hyphenated-string',
+        '1',
+        '10-second-move',
+        '13-37',
+    ])('should match %j', (string) => {
+        expect(string).toMatch(patterns_1.normalized);
+    });
+    it.each([
+        '-',
+        'Uppercase',
+        'uppercasE',
+        'camelCase',
+        'double--hyphen',
+        'trouble--double--hyphen',
+        'triple---hyphen',
+        'under_score',
+        'aććëņtèd',
+        '🐱',
+    ])('should not match %j', (string) => {
+        expect(string).not.toMatch(patterns_1.normalized);
+    });
+});
+describe('domainPattern', () => {
+    it.each([
+        'example.com',
+        'valid.com',
+        'definitely.valid.org',
+        'a.nl',
+        'very.deeply.nested.domain.name.example',
+    ])('should match %j', (string) => {
+        expect(string).toMatch(patterns_1.domainPattern);
+    });
+    it.each([
+        'a',
+        'a.a',
+        '.com',
+        '-.de',
+        'valid.ínválíd.com',
+        'example.COM',
+        'EXAMPLE.com',
+        'EXAMPLE.COM',
+        'This is a random string',
+    ])('should not match %j', (string) => {
+        expect(string).not.toMatch(patterns_1.domainPattern);
+    });
+});
+describe('googleAnalyticsIDPattern', () => {
+    it.each(['', 'UA-12345678-9', 'G-0123456789ABC', 'UA-211654446-1'])('should match %j', (string) => {
+        expect(string).toMatch(patterns_1.googleAnalyticsIDPattern);
+    });
+    it.each([' ', 'AU-123456789-0', 'UA-123-123', 'UA-1234-12345', 'G-012345678abc'])('should match %j', (string) => {
+        expect(string).not.toMatch(patterns_1.googleAnalyticsIDPattern);
+    });
+});
+//# sourceMappingURL=patterns.test.js.map

package/constants/patterns.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"patterns.test.js","sourceRoot":"","sources":["patterns.test.ts"],"names":[],"mappings":";;AAAA,yCAAoG;AAEpG,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IACjC,EAAE,CAAC,IAAI,CAAC;QACN,CAAC,MAAM,EAAE,KAAK,CAAC;QACf,CAAC,MAAM,EAAE,KAAK,CAAC;QACf,CAAC,gBAAgB,EAAE,IAAI,CAAC;KACzB,CAAC,CAAC,uBAAuB,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;QAC9C,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,4BAAiB,CAAC,CAAC;QAC7C,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;QAC7B,MAAM,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC9B,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;IACzD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wDAAwD,EAAE,GAAG,EAAE;QAChE,MAAM,QAAQ,GAAG,IAAI,MAAM,CAAC,KAAK,4BAAiB,CAAC,MAAM,IAAI,4BAAiB,CAAC,MAAM,GAAG,CAAC,CAAC;QAC1F,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACzC,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;QAC7B,MAAM,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC9B,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,UAAU,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IAC1B,EAAE,CAAC,IAAI,CAAC;QACN,KAAK;QACL,KAAK;QACL,GAAG;QACH,IAAI;QACJ,mBAAmB;QACnB,yBAAyB;QACzB,GAAG;QACH,gBAAgB;QAChB,OAAO;KACR,CAAC,CAAC,iBAAiB,EAAE,CAAC,MAAM,EAAE,EAAE;QAC/B,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,qBAAU,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,IAAI,CAAC;QACN,GAAG;QACH,WAAW;QACX,WAAW;QACX,WAAW;QACX,gBAAgB;QAChB,yBAAyB;QACzB,iBAAiB;QACjB,aAAa;QACb,UAAU;QACV,IAAI;KACL,CAAC,CAAC,qBAAqB,EAAE,CAAC,MAAM,EAAE,EAAE;QACnC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,qBAAU,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;IAC7B,EAAE,CAAC,IAAI,CAAC;QACN,aAAa;QACb,WAAW;QACX,sBAAsB;QACtB,MAAM;QACN,wCAAwC;KACzC,CAAC,CAAC,iBAAiB,EAAE,CAAC,MAAM,EAAE,EAAE;QAC/B,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,wBAAa,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,IAAI,CAAC;QACN,GAAG;QACH,KAAK;QACL,MAAM;QACN,MAAM;QACN,mBAAmB;QACnB,aAAa;QACb,aAAa;QACb,aAAa;QACb,yBAAyB;KAC1B,CAAC,CAAC,qBAAqB,EAAE,CAAC,MAAM,EAAE,EAAE;QACnC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,wBAAa,CAAC,CAAC;IAC5C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,0BAA0B,EAAE,GAAG,EAAE;IACxC,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,eAAe,EAAE,iBAAiB,EAAE,gBAAgB,CAAC,CAAC,CACjE,iBAAiB,EACjB,CAAC,MAAM,EAAE,EAAE;QACT,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,mCAAwB,CAAC,CAAC;IACnD,CAAC,CACF,CAAC;IAEF,EAAE,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,gBAAgB,EAAE,YAAY,EAAE,eAAe,EAAE,gBAAgB,CAAC,CAAC,CAC/E,iBAAiB,EACjB,CAAC,MAAM,EAAE,EAAE;QACT,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,mCAAwB,CAAC,CAAC;IACvD,CAAC,CACF,CAAC;AACJ,CAAC,CAAC,CAAC"}

package/constants/patterns.test.ts

@@ -0,0 +1,95 @@
+import { domainPattern, googleAnalyticsIDPattern, normalized, partialNormalized } from './patterns';
+
+describe('partialNormalized', () => {
+  it.each([
+    ['Ffoo', 'foo'],
+    ['barB', 'bar'],
+    ['I am victorous', 'am'],
+  ])('should match %j as %j', (input, expected) => {
+    const match = input.match(partialNormalized);
+    expect(match).not.toBeNull();
+    expect(match).toHaveLength(2);
+    expect([...match]).toStrictEqual([expected, expected]);
+  });
+
+  it('should be reusable to compose a new regular expression', () => {
+    const composed = new RegExp(`^@${partialNormalized.source}/${partialNormalized.source}$`);
+    const match = '@foo/bar'.match(composed);
+    expect(match).not.toBeNull();
+    expect(match).toHaveLength(3);
+    expect([...match]).toStrictEqual(['@foo/bar', 'foo', 'bar']);
+  });
+});
+
+describe('normalized', () => {
+  it.each([
+    'foo',
+    'bar',
+    'a',
+    'ab',
+    'hyphenated-string',
+    'multi-hyphenated-string',
+    '1',
+    '10-second-move',
+    '13-37',
+  ])('should match %j', (string) => {
+    expect(string).toMatch(normalized);
+  });
+
+  it.each([
+    '-',
+    'Uppercase',
+    'uppercasE',
+    'camelCase',
+    'double--hyphen',
+    'trouble--double--hyphen',
+    'triple---hyphen',
+    'under_score',
+    'aććëņtèd',
+    '🐱',
+  ])('should not match %j', (string) => {
+    expect(string).not.toMatch(normalized);
+  });
+});
+
+describe('domainPattern', () => {
+  it.each([
+    'example.com',
+    'valid.com',
+    'definitely.valid.org',
+    'a.nl',
+    'very.deeply.nested.domain.name.example',
+  ])('should match %j', (string) => {
+    expect(string).toMatch(domainPattern);
+  });
+
+  it.each([
+    'a',
+    'a.a',
+    '.com',
+    '-.de',
+    'valid.ínválíd.com',
+    'example.COM',
+    'EXAMPLE.com',
+    'EXAMPLE.COM',
+    'This is a random string',
+  ])('should not match %j', (string) => {
+    expect(string).not.toMatch(domainPattern);
+  });
+});
+
+describe('googleAnalyticsIDPattern', () => {
+  it.each(['', 'UA-12345678-9', 'G-0123456789ABC', 'UA-211654446-1'])(
+    'should match %j',
+    (string) => {
+      expect(string).toMatch(googleAnalyticsIDPattern);
+    },
+  );
+
+  it.each([' ', 'AU-123456789-0', 'UA-123-123', 'UA-1234-12345', 'G-012345678abc'])(
+    'should match %j',
+    (string) => {
+      expect(string).not.toMatch(googleAnalyticsIDPattern);
+    },
+  );
+});

package/constants/patterns.ts

@@ -0,0 +1,48 @@
+/**
+ * A pattern for extracting a semver value.
+ */
+export const partialSemver = /\d+\.\d+\.\d+/;
+
+/**
+ * A pattern for validating a hexadecimal RGB color.
+ */
+export const hexColor = /^#[\dA-Fa-f]{6}$/;
+
+/**
+ * A pattern for matching a full semver.
+ */
+export const semver = new RegExp(`^${partialSemver.source}$`);
+
+/**
+ * A pattern for extracting a normalized string.
+ */
+export const partialNormalized = /([\da-z](?:(?!.*--)[\da-z-]*[\da-z])?)/;
+
+/**
+ * A pattern for exactly matching a lower case hyphen separated string.
+ */
+export const normalized = new RegExp(`^${partialNormalized.source}$`);
+
+/**
+ * A pattern for matching the block name pattern of @organization/block.
+ */
+export const blockNamePattern = new RegExp(
+  `^@${partialNormalized.source}/${partialNormalized.source}$`,
+);
+
+export const domainPattern = new RegExp(`^(${partialNormalized.source}+\\.)+[a-z]{2,}$`);
+
+/**
+ * A pattern to match a Google Analytics ID or an empty string.
+ */
+export const googleAnalyticsIDPattern = /^(|UA-\d{4,10}-\d{1,4}|G-[\dA-Z]{4,})$/;
+
+/**
+ * A pattern which matches a UUID 4.
+ */
+export const uuid4Pattern = /^[\d[a-f]{8}-[\da-f]{4}-4[\da-f]{3}-[\da-f]{4}-[\d[a-f]{12}$/;
+
+/**
+ * A pattern which matches a JSON web token.
+ */
+export const jwtPattern = /^[\w-]+(?:\.[\w-]+){2}$/;

package/constants/roles.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"roles.js","sourceRoot":"","sources":["roles.ts"],"names":[],"mappings":";;;AAAA,6CAA0C;AAE1C,MAAM,MAAM,GAAG,CAAC,uBAAU,CAAC,QAAQ,EAAE,uBAAU,CAAC,WAAW,CAAC,CAAC;AAC7D,MAAM,UAAU,GAAG,CAAC,GAAG,MAAM,EAAE,uBAAU,CAAC,eAAe,CAAC,CAAC;AAC3D,MAAM,SAAS,GAAG,CAAC,GAAG,MAAM,EAAE,uBAAU,CAAC,UAAU,EAAE,uBAAU,CAAC,aAAa,CAAC,CAAC;AAC/E,MAAM,OAAO,GAAG,CAAC,GAAG,SAAS,EAAE,uBAAU,CAAC,YAAY,EAAE,uBAAU,CAAC,eAAe,CAAC,CAAC;AAEpF,MAAM,SAAS,GAAG;IAChB,GAAG,MAAM;IACT,uBAAU,CAAC,QAAQ;IACnB,uBAAU,CAAC,eAAe;IAC1B,uBAAU,CAAC,YAAY;IACvB,uBAAU,CAAC,eAAe;IAC1B,uBAAU,CAAC,iBAAiB;IAC5B,uBAAU,CAAC,UAAU;IACrB,uBAAU,CAAC,aAAa;CACzB,CAAC;AACF,MAAM,UAAU,GAAG;IACjB,GAAG,SAAS;IACZ,uBAAU,CAAC,UAAU;IACrB,uBAAU,CAAC,UAAU;IACrB,uBAAU,CAAC,eAAe;IAC1B,uBAAU,CAAC,YAAY;IACvB,uBAAU,CAAC,WAAW;IACtB,uBAAU,CAAC,aAAa;CACzB,CAAC;AACF,MAAM,KAAK,GAAG;IACZ,GAAG,UAAU;IACb,uBAAU,CAAC,gBAAgB;IAC3B,uBAAU,CAAC,aAAa;IACxB,uBAAU,CAAC,WAAW;CACvB,CAAC;AAEW,QAAA,KAAK,GAAG;IACnB,MAAM,EAAE,MAAM;IACd,UAAU;IACV,SAAS;IACT,OAAO;IACP,SAAS;IACT,UAAU;IACV,KAAK;CACG,CAAC;AAIX,IAAY,QAGX;AAHD,WAAY,QAAQ;IAClB,6BAAiB,CAAA;IACjB,+BAAmB,CAAA;AACrB,CAAC,EAHW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAGnB"}

package/constants/roles.ts

@@ -0,0 +1,49 @@
+import { Permission } from './Permission';
+
+const member = [Permission.ViewApps, Permission.ViewMembers];
+const Translator = [...member, Permission.EditAppMessages];
+const APIReader = [...member, Permission.ReadAssets, Permission.ReadResources];
+const APIUser = [...APIReader, Permission.ManageAssets, Permission.ManageResources];
+
+const AppEditor = [
+  ...member,
+  Permission.EditApps,
+  Permission.EditAppMessages,
+  Permission.ManageAssets,
+  Permission.ManageResources,
+  Permission.PushNotifications,
+  Permission.ReadAssets,
+  Permission.ReadResources,
+];
+const Maintainer = [
+  ...AppEditor,
+  Permission.CreateApps,
+  Permission.DeleteApps,
+  Permission.EditAppSettings,
+  Permission.InviteMember,
+  Permission.ManageTeams,
+  Permission.PublishBlocks,
+];
+const Owner = [
+  ...Maintainer,
+  Permission.EditOrganization,
+  Permission.ManageMembers,
+  Permission.ManageRoles,
+];
+
+export const roles = {
+  Member: member,
+  Translator,
+  APIReader,
+  APIUser,
+  AppEditor,
+  Maintainer,
+  Owner,
+} as const;
+
+export type Role = keyof typeof roles;
+
+export enum TeamRole {
+  Member = 'member',
+  Manager = 'manager',
+}

package/constants/scopes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scopes.js","sourceRoot":"","sources":["scopes.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACU,QAAA,MAAM,GAAG;IACpB,YAAY;IACZ,cAAc;IACd,qBAAqB;IACrB,gBAAgB;IAChB,iBAAiB;IACjB,cAAc;IACd,YAAY;IACZ,aAAa;CACL,CAAC"}

package/constants/scopes.ts

@@ -0,0 +1,13 @@
+/**
+ * All known OAuth2 scopes for client credentials.
+ */
+export const scopes = [
+  'apps:write',
+  'blocks:write',
+  'organizations:write',
+  'resources:read',
+  'resources:write',
+  'assets:write',
+  'teams:read',
+  'teams:write',
+] as const;

package/convertToCsv.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Converts an object or an array of objects to a valid CSV format.
+ *
+ * Implements https://tools.ietf.org/html/rfc4180
+ *
+ * @param body An object containing the data to be converted.
+ * @returns The data serialized as CSV.
+ */
+export declare function convertToCsv(body: any): string;

package/convertToCsv.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertToCsv = void 0;
+const _1 = require(".");
+/**
+ * Converts an object or an array of objects to a valid CSV format.
+ *
+ * Implements https://tools.ietf.org/html/rfc4180
+ *
+ * @param body An object containing the data to be converted.
+ * @returns The data serialized as CSV.
+ */
+function convertToCsv(body) {
+    const separator = ',';
+    const lineEnd = '\r\n';
+    const quote = '"';
+    const quoteRegex = new RegExp(quote, 'g');
+    const escape = (value) => value.includes(separator) || value.includes(lineEnd) || value.includes(quote)
+        ? `${quote}${value.replace(quoteRegex, `${quote}${quote}`)}${quote}`
+        : value;
+    if (body == null) {
+        throw new Error('No data');
+    }
+    if (typeof body !== 'object') {
+        throw new TypeError('Data is of an invalid type');
+    }
+    const data = Array.isArray(body) ? body : [body];
+    if (data.length === 0) {
+        return null;
+    }
+    const headers = [...new Set(data.flatMap((value) => Object.keys(value)))].sort(_1.compareStrings);
+    if (headers.length === 0) {
+        throw new Error('No headers could be found');
+    }
+    const lines = data.map((object) => {
+        const values = headers.map((header) => {
+            let value = object[header];
+            if (value == null) {
+                return '';
+            }
+            if (value.toJSON instanceof Function) {
+                value = value.toJSON();
+            }
+            if (typeof value !== 'string') {
+                value = JSON.stringify(value);
+            }
+            return escape(value);
+        });
+        return values.join(separator);
+    });
+    return `${headers.map((header) => escape(header)).join(separator)}${lineEnd}${lines.join(lineEnd)}${lineEnd}`;
+}
+exports.convertToCsv = convertToCsv;
+//# sourceMappingURL=convertToCsv.js.map

package/convertToCsv.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"convertToCsv.js","sourceRoot":"","sources":["convertToCsv.ts"],"names":[],"mappings":";;;AAAA,wBAAmC;AAEnC;;;;;;;GAOG;AACH,SAAgB,YAAY,CAAC,IAAS;IACpC,MAAM,SAAS,GAAG,GAAG,CAAC;IACtB,MAAM,OAAO,GAAG,MAAM,CAAC;IACvB,MAAM,KAAK,GAAG,GAAG,CAAC;IAClB,MAAM,UAAU,GAAG,IAAI,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAC1C,MAAM,MAAM,GAAG,CAAC,KAAa,EAAU,EAAE,CACvC,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC;QAC3E,CAAC,CAAC,GAAG,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,UAAU,EAAE,GAAG,KAAK,GAAG,KAAK,EAAE,CAAC,GAAG,KAAK,EAAE;QACpE,CAAC,CAAC,KAAK,CAAC;IAEZ,IAAI,IAAI,IAAI,IAAI,EAAE;QAChB,MAAM,IAAI,KAAK,CAAC,SAAS,CAAC,CAAC;KAC5B;IAED,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;QAC5B,MAAM,IAAI,SAAS,CAAC,4BAA4B,CAAC,CAAC;KACnD;IAED,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAEjD,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;QACrB,OAAO,IAAI,CAAC;KACb;IAED,MAAM,OAAO,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,iBAAc,CAAC,CAAC;IAE/F,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE;QACxB,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;KAC9C;IAED,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;QAChC,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;YACpC,IAAI,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;YAC3B,IAAI,KAAK,IAAI,IAAI,EAAE;gBACjB,OAAO,EAAE,CAAC;aACX;YAED,IAAK,KAAc,CAAC,MAAM,YAAY,QAAQ,EAAE;gBAC9C,KAAK,GAAI,KAAc,CAAC,MAAM,EAAE,CAAC;aAClC;YAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;gBAC7B,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;aAC/B;YAED,OAAO,MAAM,CAAC,KAAe,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,GAAG,KAAK,CAAC,IAAI,CACtF,OAAO,CACR,GAAG,OAAO,EAAE,CAAC;AAChB,CAAC;AAtDD,oCAsDC"}

package/convertToCsv.test.d.ts

@@ -0,0 +1 @@
+export {};

package/convertToCsv.test.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const convertToCsv_1 = require("./convertToCsv");
+describe('convertToCsv', () => {
+    it('should throw an error if input is null', () => {
+        const input = null;
+        expect(() => (0, convertToCsv_1.convertToCsv)(input)).toThrow(new Error('No data'));
+    });
+    it('should return an error if the input has no keys', () => {
+        const input = {};
+        expect(() => (0, convertToCsv_1.convertToCsv)(input)).toThrow(new Error('No headers could be found'));
+    });
+    it('sould return an error if the input is a primitive', () => {
+        const input = 'foo';
+        expect(() => (0, convertToCsv_1.convertToCsv)(input)).toThrow(new TypeError('Data is of an invalid type'));
+    });
+    it('should correctly combines all headers', () => {
+        const input = [
+            { foo: 123, baz: 1 },
+            { foo: 123, bar: 'bar' },
+        ];
+        const output = 'bar,baz,foo\r\n,1,123\r\nbar,,123\r\n';
+        expect((0, convertToCsv_1.convertToCsv)(input)).toStrictEqual(output);
+    });
+    it('should support an arrays of objects', () => {
+        const input = [{ foo: 123 }, { foo: 321 }];
+        const output = 'foo\r\n123\r\n321\r\n';
+        expect((0, convertToCsv_1.convertToCsv)(input)).toStrictEqual(output);
+    });
+    it('should escape strings containing commas', () => {
+        const input = [{ 'foo,bar': 'foo,bar' }];
+        const output = '"foo,bar"\r\n"foo,bar"\r\n';
+        expect((0, convertToCsv_1.convertToCsv)(input)).toStrictEqual(output);
+    });
+    it('should escape strings containing newlines', () => {
+        const input = { 'foo\r\nline2': 'foo\r\nbar' };
+        const output = '"foo\r\nline2"\r\n"foo\r\nbar"\r\n';
+        expect((0, convertToCsv_1.convertToCsv)(input)).toStrictEqual(output);
+    });
+    it('should escape quotes', () => {
+        const input = { 'foo "example" bar': 'Lots of "str"ings"' };
+        const output = '"foo ""example"" bar"\r\n"Lots of ""str""ings"""\r\n';
+        expect((0, convertToCsv_1.convertToCsv)(input)).toStrictEqual(output);
+    });
+    it('should convert date objects', () => {
+        const input = { foo: new Date(0) };
+        const output = 'foo\r\n1970-01-01T00:00:00.000Z\r\n';
+        expect((0, convertToCsv_1.convertToCsv)(input)).toStrictEqual(output);
+    });
+    it('should return null on empty results', () => {
+        const input = [];
+        const output = null;
+        expect((0, convertToCsv_1.convertToCsv)(input)).toStrictEqual(output);
+    });
+});
+//# sourceMappingURL=convertToCsv.test.js.map

package/convertToCsv.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"convertToCsv.test.js","sourceRoot":"","sources":["convertToCsv.test.ts"],"names":[],"mappings":";;AAAA,iDAA8C;AAE9C,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;QAChD,MAAM,KAAK,GAAQ,IAAI,CAAC;QAExB,MAAM,CAAC,GAAG,EAAE,CAAC,IAAA,2BAAY,EAAC,KAAY,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;IACzE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;QACzD,MAAM,KAAK,GAAG,EAAE,CAAC;QAEjB,MAAM,CAAC,GAAG,EAAE,CAAC,IAAA,2BAAY,EAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC,CAAC;IACpF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mDAAmD,EAAE,GAAG,EAAE;QAC3D,MAAM,KAAK,GAAG,KAAK,CAAC;QAEpB,MAAM,CAAC,GAAG,EAAE,CAAC,IAAA,2BAAY,EAAC,KAAY,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,SAAS,CAAC,4BAA4B,CAAC,CAAC,CAAC;IAChG,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAC/C,MAAM,KAAK,GAAG;YACZ,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE;YACpB,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE;SACzB,CAAC;QACF,MAAM,MAAM,GAAG,uCAAuC,CAAC;QAEvD,MAAM,CAAC,IAAA,2BAAY,EAAC,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;QAC7C,MAAM,KAAK,GAAG,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC;QAC3C,MAAM,MAAM,GAAG,uBAAuB,CAAC;QAEvC,MAAM,CAAC,IAAA,2BAAY,EAAC,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;QACjD,MAAM,KAAK,GAAG,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,CAAC;QACzC,MAAM,MAAM,GAAG,4BAA4B,CAAC;QAE5C,MAAM,CAAC,IAAA,2BAAY,EAAC,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACnD,MAAM,KAAK,GAAG,EAAE,cAAc,EAAE,YAAY,EAAE,CAAC;QAC/C,MAAM,MAAM,GAAG,oCAAoC,CAAC;QAEpD,MAAM,CAAC,IAAA,2BAAY,EAAC,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sBAAsB,EAAE,GAAG,EAAE;QAC9B,MAAM,KAAK,GAAG,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,CAAC;QAC5D,MAAM,MAAM,GAAG,sDAAsD,CAAC;QAEtE,MAAM,CAAC,IAAA,2BAAY,EAAC,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;QACrC,MAAM,KAAK,GAAG,EAAE,GAAG,EAAE,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QACnC,MAAM,MAAM,GAAG,qCAAqC,CAAC;QAErD,MAAM,CAAC,IAAA,2BAAY,EAAC,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;QAC7C,MAAM,KAAK,GAAU,EAAE,CAAC;QACxB,MAAM,MAAM,GAAQ,IAAI,CAAC;QAEzB,MAAM,CAAC,IAAA,2BAAY,EAAC,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/convertToCsv.test.ts

@@ -0,0 +1,73 @@
+import { convertToCsv } from './convertToCsv';
+
+describe('convertToCsv', () => {
+  it('should throw an error if input is null', () => {
+    const input: any = null;
+
+    expect(() => convertToCsv(input as any)).toThrow(new Error('No data'));
+  });
+
+  it('should return an error if the input has no keys', () => {
+    const input = {};
+
+    expect(() => convertToCsv(input)).toThrow(new Error('No headers could be found'));
+  });
+
+  it('sould return an error if the input is a primitive', () => {
+    const input = 'foo';
+
+    expect(() => convertToCsv(input as any)).toThrow(new TypeError('Data is of an invalid type'));
+  });
+
+  it('should correctly combines all headers', () => {
+    const input = [
+      { foo: 123, baz: 1 },
+      { foo: 123, bar: 'bar' },
+    ];
+    const output = 'bar,baz,foo\r\n,1,123\r\nbar,,123\r\n';
+
+    expect(convertToCsv(input)).toStrictEqual(output);
+  });
+
+  it('should support an arrays of objects', () => {
+    const input = [{ foo: 123 }, { foo: 321 }];
+    const output = 'foo\r\n123\r\n321\r\n';
+
+    expect(convertToCsv(input)).toStrictEqual(output);
+  });
+
+  it('should escape strings containing commas', () => {
+    const input = [{ 'foo,bar': 'foo,bar' }];
+    const output = '"foo,bar"\r\n"foo,bar"\r\n';
+
+    expect(convertToCsv(input)).toStrictEqual(output);
+  });
+
+  it('should escape strings containing newlines', () => {
+    const input = { 'foo\r\nline2': 'foo\r\nbar' };
+    const output = '"foo\r\nline2"\r\n"foo\r\nbar"\r\n';
+
+    expect(convertToCsv(input)).toStrictEqual(output);
+  });
+
+  it('should escape quotes', () => {
+    const input = { 'foo "example" bar': 'Lots of "str"ings"' };
+    const output = '"foo ""example"" bar"\r\n"Lots of ""str""ings"""\r\n';
+
+    expect(convertToCsv(input)).toStrictEqual(output);
+  });
+
+  it('should convert date objects', () => {
+    const input = { foo: new Date(0) };
+    const output = 'foo\r\n1970-01-01T00:00:00.000Z\r\n';
+
+    expect(convertToCsv(input)).toStrictEqual(output);
+  });
+
+  it('should return null on empty results', () => {
+    const input: any[] = [];
+    const output: any = null;
+
+    expect(convertToCsv(input)).toStrictEqual(output);
+  });
+});

package/convertToCsv.ts

@@ -0,0 +1,65 @@
+import { compareStrings } from '.';
+
+/**
+ * Converts an object or an array of objects to a valid CSV format.
+ *
+ * Implements https://tools.ietf.org/html/rfc4180
+ *
+ * @param body An object containing the data to be converted.
+ * @returns The data serialized as CSV.
+ */
+export function convertToCsv(body: any): string {
+  const separator = ',';
+  const lineEnd = '\r\n';
+  const quote = '"';
+  const quoteRegex = new RegExp(quote, 'g');
+  const escape = (value: string): string =>
+    value.includes(separator) || value.includes(lineEnd) || value.includes(quote)
+      ? `${quote}${value.replace(quoteRegex, `${quote}${quote}`)}${quote}`
+      : value;
+
+  if (body == null) {
+    throw new Error('No data');
+  }
+
+  if (typeof body !== 'object') {
+    throw new TypeError('Data is of an invalid type');
+  }
+
+  const data = Array.isArray(body) ? body : [body];
+
+  if (data.length === 0) {
+    return null;
+  }
+
+  const headers = [...new Set(data.flatMap((value) => Object.keys(value)))].sort(compareStrings);
+
+  if (headers.length === 0) {
+    throw new Error('No headers could be found');
+  }
+
+  const lines = data.map((object) => {
+    const values = headers.map((header) => {
+      let value = object[header];
+      if (value == null) {
+        return '';
+      }
+
+      if ((value as Date).toJSON instanceof Function) {
+        value = (value as Date).toJSON();
+      }
+
+      if (typeof value !== 'string') {
+        value = JSON.stringify(value);
+      }
+
+      return escape(value as string);
+    });
+
+    return values.join(separator);
+  });
+
+  return `${headers.map((header) => escape(header)).join(separator)}${lineEnd}${lines.join(
+    lineEnd,
+  )}${lineEnd}`;
+}

package/formatRequestAction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"formatRequestAction.js","sourceRoot":"","sources":["formatRequestAction.ts"],"names":[],"mappings":";;;AAGA,SAAgB,mBAAmB,CACjC,EAAE,MAAM,GAAG,KAAK,EAAE,KAAK,EAAE,GAAG,MAAM,EAA+B,EACjE,IAAa,EACb,KAA+E,EAC/E,OAAgC;IAEhC,OAAO;QACL,MAAM;QACN,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAC7C,OAAO,EAAE,EAAE;QACX,MAAM,EAAE,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,CAAC;KACpC,CAAC;AACJ,CAAC;AAZD,kDAYC"}