@appsemble/node-utils 0.20.9 → 0.20.12

package/{dist/AppsembleError.d.ts → AppsembleError.d.ts}

@@ -6,7 +6,7 @@
  */
 export declare class AppsembleError extends Error {
     /**
-     * @param message - The error message to show to the user.
+     * @param message The error message to show to the user.
      */
     constructor(message: string);
 }

package/{dist/AppsembleError.js → AppsembleError.js}

@@ -9,7 +9,7 @@ exports.AppsembleError = void 0;
  */
 class AppsembleError extends Error {
     /**
-     * @param message - The error message to show to the user.
+     * @param message The error message to show to the user.
      */
     constructor(message) {
         super(message);

package/AppsembleError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AppsembleError.js","sourceRoot":"","sources":["AppsembleError.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACH,MAAa,cAAe,SAAQ,KAAK;IACvC;;OAEG;IACH,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,gBAAgB,CAAC;QAC7B,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IAClD,CAAC;CACF;AATD,wCASC"}

package/AppsembleError.test.d.ts

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

package/AppsembleError.test.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const AppsembleError_1 = require("./AppsembleError");
+it('should define AppsembleError as its name', () => {
+    const error = new AppsembleError_1.AppsembleError('message');
+    expect(error.name).toBe('AppsembleError');
+});
+//# sourceMappingURL=AppsembleError.test.js.map

package/AppsembleError.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AppsembleError.test.js","sourceRoot":"","sources":["AppsembleError.test.ts"],"names":[],"mappings":";;AAAA,qDAAkD;AAElD,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;IAClD,MAAM,KAAK,GAAG,IAAI,+BAAc,CAAC,SAAS,CAAC,CAAC;IAC5C,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;AAC5C,CAAC,CAAC,CAAC"}

package/AppsembleError.test.ts

@@ -0,0 +1,6 @@
+import { AppsembleError } from './AppsembleError';
+
+it('should define AppsembleError as its name', () => {
+  const error = new AppsembleError('message');
+  expect(error.name).toBe('AppsembleError');
+});

package/AppsembleError.ts

@@ -0,0 +1,16 @@
+/**
+ * Used for throwing known Appsemble errors.
+ *
+ * This is used when the normal control flow needs to be aborted, but for reasons known. When an
+ * instance of `AppsembleError` is thrown, the message will be logged, but not the stack trace.
+ */
+export class AppsembleError extends Error {
+  /**
+   * @param message The error message to show to the user.
+   */
+  constructor(message: string) {
+    super(message);
+    this.name = 'AppsembleError';
+    Error.captureStackTrace(this, this.constructor);
+  }
+}

package/__fixtures__/hello.txt

@@ -0,0 +1 @@
+Hello world!

package/__fixtures__/invalid-json.json

@@ -0,0 +1,3 @@
+{
+  // comment
+}

package/__fixtures__/json.json

@@ -0,0 +1 @@
+{ "json": "json" }

package/__fixtures__/yaml.yaml

@@ -0,0 +1 @@
+yaml: yaml

package/__mocks__/os.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This mock ensures the values of `os` are consistent across platforms in tests.
+ */
+declare const _default: any;
+export = _default;

package/__mocks__/os.js

@@ -0,0 +1,8 @@
+"use strict";
+const actual = jest.requireActual('os');
+module.exports = {
+    ...actual,
+    type: () => 'Linux',
+    arch: () => 'x64',
+};
+//# sourceMappingURL=os.js.map

package/__mocks__/os.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"os.js","sourceRoot":"","sources":["os.ts"],"names":[],"mappings":";AAAA,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;AAKxC,iBAAS;IACP,GAAG,MAAM;IACT,IAAI,EAAE,GAAG,EAAE,CAAC,OAAO;IACnB,IAAI,EAAE,GAAG,EAAE,CAAC,KAAK;CAClB,CAAC"}

package/__mocks__/os.ts

@@ -0,0 +1,10 @@
+const actual = jest.requireActual('os');
+
+/**
+ * This mock ensures the values of `os` are consistent across platforms in tests.
+ */
+export = {
+  ...actual,
+  type: () => 'Linux',
+  arch: () => 'x64',
+};

package/{dist/basicAuth.d.ts → basicAuth.d.ts}

@@ -1,8 +1,8 @@
 /**
  * Create a basic auth authorization header from a username and password.
  *
- * @param username - The username to serialize.
- * @param password - The password to serialize.
+ * @param username The username to serialize.
+ * @param password The password to serialize.
  * @returns An HTTP basic auth authorization header.
  */
 export declare function basicAuth(username: string, password: string): string;

package/{dist/basicAuth.js → basicAuth.js}

@@ -4,8 +4,8 @@ exports.basicAuth = void 0;
 /**
  * Create a basic auth authorization header from a username and password.
  *
- * @param username - The username to serialize.
- * @param password - The password to serialize.
+ * @param username The username to serialize.
+ * @param password The password to serialize.
  * @returns An HTTP basic auth authorization header.
  */
 function basicAuth(username, password) {

package/basicAuth.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"basicAuth.js","sourceRoot":"","sources":["basicAuth.ts"],"names":[],"mappings":";;;AAAA;;;;;;GAMG;AACH,SAAgB,SAAS,CAAC,QAAgB,EAAE,QAAgB;IAC1D,OAAO,SAAS,MAAM,CAAC,IAAI,CAAC,GAAG,QAAQ,IAAI,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;AAC9E,CAAC;AAFD,8BAEC"}

package/basicAuth.test.d.ts

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

package/basicAuth.test.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const basicAuth_1 = require("./basicAuth");
+it('should serialize credentials', () => {
+    const result = (0, basicAuth_1.basicAuth)('me', 'password1');
+    expect(result).toBe('Basic bWU6cGFzc3dvcmQx');
+});
+//# sourceMappingURL=basicAuth.test.js.map

package/basicAuth.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"basicAuth.test.js","sourceRoot":"","sources":["basicAuth.test.ts"],"names":[],"mappings":";;AAAA,2CAAwC;AAExC,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;IACtC,MAAM,MAAM,GAAG,IAAA,qBAAS,EAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IAC5C,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;AAChD,CAAC,CAAC,CAAC"}

package/basicAuth.test.ts

@@ -0,0 +1,6 @@
+import { basicAuth } from './basicAuth';
+
+it('should serialize credentials', () => {
+  const result = basicAuth('me', 'password1');
+  expect(result).toBe('Basic bWU6cGFzc3dvcmQx');
+});

package/basicAuth.ts

@@ -0,0 +1,10 @@
+/**
+ * Create a basic auth authorization header from a username and password.
+ *
+ * @param username The username to serialize.
+ * @param password The password to serialize.
+ * @returns An HTTP basic auth authorization header.
+ */
+export function basicAuth(username: string, password: string): string {
+  return `Basic ${Buffer.from(`${username}:${password}`).toString('base64')}`;
+}

package/{dist/formData.d.ts → formData.d.ts}

@@ -2,7 +2,7 @@ import FormData from 'form-data';
 /**
  * A convenience function for creating form data.
  *
- * @param data - A key / value record of fields to append to the form data.  Booleans, numbersm
+ * @param data A key / value record of fields to append to the form data.  Booleans, numbers,
  * strings, and `null` will be added to the form data raw. Objects will be transformed to JSON
  * objects. Arrays will be iterated over and every item will be appended for the given key.
  * @returns The data represented as form data.

package/{dist/formData.js → formData.js}

@@ -24,7 +24,7 @@ function appendFormData(key, value, form) {
 /**
  * A convenience function for creating form data.
  *
- * @param data - A key / value record of fields to append to the form data.  Booleans, numbersm
+ * @param data A key / value record of fields to append to the form data.  Booleans, numbers,
  * strings, and `null` will be added to the form data raw. Objects will be transformed to JSON
  * objects. Arrays will be iterated over and every item will be appended for the given key.
  * @returns The data represented as form data.

package/formData.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"formData.js","sourceRoot":"","sources":["formData.ts"],"names":[],"mappings":";;;;;;AAAA,2BAAgC;AAEhC,0DAAiC;AAEjC,SAAS,cAAc,CAAC,GAAW,EAAE,KAAU,EAAE,IAAc;IAC7D,IAAI,KAAK,KAAK,SAAS,EAAE;QACvB,OAAO;KACR;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;QACxB,KAAK,MAAM,GAAG,IAAI,KAAK,EAAE;YACvB,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;SAChC;KACF;SAAM;QACL,IAAI,CAAC,MAAM,CACT,GAAG,EACH,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,YAAY,eAAU;YAChF,CAAC,CAAC,KAAK;YACP,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAC1B,CAAC;KACH;AACH,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,cAAc,CAAC,IAAyB;IACtD,MAAM,IAAI,GAAG,IAAI,mBAAQ,EAAE,CAAC;IAC5B,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QAC/C,cAAc,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;KAClC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAND,wCAMC"}

package/formData.test.d.ts

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

package/formData.test.js

@@ -0,0 +1,94 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const formData_1 = require("./formData");
+describe('createFormData', () => {
+    it('should handle strings', () => {
+        const form = (0, formData_1.createFormData)({ foo: 'bar' });
+        const boundary = form.getBoundary();
+        expect(String(form.getBuffer())).toBe(`--${boundary}\r
+Content-Disposition: form-data; name="foo"\r
+\r
+bar\r
+--${boundary}--\r
+`);
+    });
+    it('should handle numbers', () => {
+        const form = (0, formData_1.createFormData)({ answer: 42 });
+        const boundary = form.getBoundary();
+        expect(String(form.getBuffer())).toBe(`--${boundary}\r
+Content-Disposition: form-data; name="answer"\r
+\r
+42\r
+--${boundary}--\r
+`);
+    });
+    it('should handle booleans', () => {
+        const form = (0, formData_1.createFormData)({ really: true });
+        const boundary = form.getBoundary();
+        expect(String(form.getBuffer())).toBe(`--${boundary}\r
+Content-Disposition: form-data; name="really"\r
+\r
+true\r
+--${boundary}--\r
+`);
+    });
+    it('should handle buffers', () => {
+        const form = (0, formData_1.createFormData)({ buf: Buffer.from('fer') });
+        const boundary = form.getBoundary();
+        expect(String(form.getBuffer())).toBe(`--${boundary}\r
+Content-Disposition: form-data; name="buf"\r
+Content-Type: application/octet-stream\r
+\r
+fer\r
+--${boundary}--\r
+`);
+    });
+    it('should handle null', () => {
+        const form = (0, formData_1.createFormData)({ really: true });
+        const boundary = form.getBoundary();
+        expect(String(form.getBuffer())).toBe(`--${boundary}\r
+Content-Disposition: form-data; name="really"\r
+\r
+true\r
+--${boundary}--\r
+`);
+    });
+    it('should ignore undefined', () => {
+        const form = (0, formData_1.createFormData)({ defined: undefined });
+        const boundary = form.getBoundary();
+        expect(String(form.getBuffer())).toBe(`--${boundary}--\r\n`);
+    });
+    it('should convert objects to JSON', () => {
+        const form = (0, formData_1.createFormData)({ deeply: { nested: 'data' } });
+        const boundary = form.getBoundary();
+        expect(String(form.getBuffer())).toBe(`--${boundary}\r
+Content-Disposition: form-data; name="deeply"\r
+\r
+{"nested":"data"}\r
+--${boundary}--\r
+`);
+    });
+    it('should append multiple entries if the input is an array', () => {
+        const form = (0, formData_1.createFormData)({ array: [42, 'bananas', null, { fruit: true }] });
+        const boundary = form.getBoundary();
+        expect(String(form.getBuffer())).toBe(`--${boundary}\r
+Content-Disposition: form-data; name="array"\r
+\r
+42\r
+--${boundary}\r
+Content-Disposition: form-data; name="array"\r
+\r
+bananas\r
+--${boundary}\r
+Content-Disposition: form-data; name="array"\r
+\r
+null\r
+--${boundary}\r
+Content-Disposition: form-data; name="array"\r
+\r
+{"fruit":true}\r
+--${boundary}--\r
+`);
+    });
+});
+//# sourceMappingURL=formData.test.js.map

package/formData.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"formData.test.js","sourceRoot":"","sources":["formData.test.ts"],"names":[],"mappings":";;AAAA,yCAA4C;AAE5C,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;IAC9B,EAAE,CAAC,uBAAuB,EAAE,GAAG,EAAE;QAC/B,MAAM,IAAI,GAAG,IAAA,yBAAc,EAAC,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC;QAC5C,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QACpC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,IAAI,CACnC,KAAK,QAAQ;;;;IAIf,QAAQ;CACX,CACI,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uBAAuB,EAAE,GAAG,EAAE;QAC/B,MAAM,IAAI,GAAG,IAAA,yBAAc,EAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC;QAC5C,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QACpC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,IAAI,CACnC,KAAK,QAAQ;;;;IAIf,QAAQ;CACX,CACI,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wBAAwB,EAAE,GAAG,EAAE;QAChC,MAAM,IAAI,GAAG,IAAA,yBAAc,EAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QAC9C,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QACpC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,IAAI,CACnC,KAAK,QAAQ;;;;IAIf,QAAQ;CACX,CACI,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uBAAuB,EAAE,GAAG,EAAE;QAC/B,MAAM,IAAI,GAAG,IAAA,yBAAc,EAAC,EAAE,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACzD,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QACpC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,IAAI,CACnC,KAAK,QAAQ;;;;;IAKf,QAAQ;CACX,CACI,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAC5B,MAAM,IAAI,GAAG,IAAA,yBAAc,EAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QAC9C,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QACpC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,IAAI,CACnC,KAAK,QAAQ;;;;IAIf,QAAQ;CACX,CACI,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yBAAyB,EAAE,GAAG,EAAE;QACjC,MAAM,IAAI,GAAG,IAAA,yBAAc,EAAC,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC;QACpD,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QACpC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,QAAQ,QAAQ,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;QACxC,MAAM,IAAI,GAAG,IAAA,yBAAc,EAAC,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;QAC5D,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QACpC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,IAAI,CACnC,KAAK,QAAQ;;;;IAIf,QAAQ;CACX,CACI,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yDAAyD,EAAE,GAAG,EAAE;QACjE,MAAM,IAAI,GAAG,IAAA,yBAAc,EAAC,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC;QAC/E,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QACpC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,IAAI,CACnC,KAAK,QAAQ;;;;IAIf,QAAQ;;;;IAIR,QAAQ;;;;IAIR,QAAQ;;;;IAIR,QAAQ;CACX,CACI,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/formData.test.ts

@@ -0,0 +1,113 @@
+import { createFormData } from './formData';
+
+describe('createFormData', () => {
+  it('should handle strings', () => {
+    const form = createFormData({ foo: 'bar' });
+    const boundary = form.getBoundary();
+    expect(String(form.getBuffer())).toBe(
+      `--${boundary}\r
+Content-Disposition: form-data; name="foo"\r
+\r
+bar\r
+--${boundary}--\r
+`,
+    );
+  });
+
+  it('should handle numbers', () => {
+    const form = createFormData({ answer: 42 });
+    const boundary = form.getBoundary();
+    expect(String(form.getBuffer())).toBe(
+      `--${boundary}\r
+Content-Disposition: form-data; name="answer"\r
+\r
+42\r
+--${boundary}--\r
+`,
+    );
+  });
+
+  it('should handle booleans', () => {
+    const form = createFormData({ really: true });
+    const boundary = form.getBoundary();
+    expect(String(form.getBuffer())).toBe(
+      `--${boundary}\r
+Content-Disposition: form-data; name="really"\r
+\r
+true\r
+--${boundary}--\r
+`,
+    );
+  });
+
+  it('should handle buffers', () => {
+    const form = createFormData({ buf: Buffer.from('fer') });
+    const boundary = form.getBoundary();
+    expect(String(form.getBuffer())).toBe(
+      `--${boundary}\r
+Content-Disposition: form-data; name="buf"\r
+Content-Type: application/octet-stream\r
+\r
+fer\r
+--${boundary}--\r
+`,
+    );
+  });
+
+  it('should handle null', () => {
+    const form = createFormData({ really: true });
+    const boundary = form.getBoundary();
+    expect(String(form.getBuffer())).toBe(
+      `--${boundary}\r
+Content-Disposition: form-data; name="really"\r
+\r
+true\r
+--${boundary}--\r
+`,
+    );
+  });
+
+  it('should ignore undefined', () => {
+    const form = createFormData({ defined: undefined });
+    const boundary = form.getBoundary();
+    expect(String(form.getBuffer())).toBe(`--${boundary}--\r\n`);
+  });
+
+  it('should convert objects to JSON', () => {
+    const form = createFormData({ deeply: { nested: 'data' } });
+    const boundary = form.getBoundary();
+    expect(String(form.getBuffer())).toBe(
+      `--${boundary}\r
+Content-Disposition: form-data; name="deeply"\r
+\r
+{"nested":"data"}\r
+--${boundary}--\r
+`,
+    );
+  });
+
+  it('should append multiple entries if the input is an array', () => {
+    const form = createFormData({ array: [42, 'bananas', null, { fruit: true }] });
+    const boundary = form.getBoundary();
+    expect(String(form.getBuffer())).toBe(
+      `--${boundary}\r
+Content-Disposition: form-data; name="array"\r
+\r
+42\r
+--${boundary}\r
+Content-Disposition: form-data; name="array"\r
+\r
+bananas\r
+--${boundary}\r
+Content-Disposition: form-data; name="array"\r
+\r
+null\r
+--${boundary}\r
+Content-Disposition: form-data; name="array"\r
+\r
+{"fruit":true}\r
+--${boundary}--\r
+`,
+    );
+  });
+});

package/formData.ts

@@ -0,0 +1,37 @@
+import { ReadStream } from 'fs';
+
+import FormData from 'form-data';
+
+function appendFormData(key: string, value: any, form: FormData): void {
+  if (value === undefined) {
+    return;
+  }
+  if (Array.isArray(value)) {
+    for (const val of value) {
+      appendFormData(key, val, form);
+    }
+  } else {
+    form.append(
+      key,
+      typeof value === 'string' || Buffer.isBuffer(value) || value instanceof ReadStream
+        ? value
+        : JSON.stringify(value),
+    );
+  }
+}
+
+/**
+ * A convenience function for creating form data.
+ *
+ * @param data A key / value record of fields to append to the form data.  Booleans, numbers,
+ * strings, and `null` will be added to the form data raw. Objects will be transformed to JSON
+ * objects. Arrays will be iterated over and every item will be appended for the given key.
+ * @returns The data represented as form data.
+ */
+export function createFormData(data: Record<string, any>): FormData {
+  const form = new FormData();
+  for (const [key, value] of Object.entries(data)) {
+    appendFormData(key, value, form);
+  }
+  return form;
+}

package/{dist/fs.d.ts → fs.d.ts}

@@ -5,15 +5,15 @@ import { Promisable } from 'type-fest';
 /**
  * Test if the error is a NodeJS errno exception.
  *
- * @param error - The value to check
- * @param code - If specified, theck if the code matches
+ * @param error The value to check
+ * @param code If specified, theck if the code matches
  * @returns Whether or not the error is a NodeJS errno exception.
  */
 export declare function isErrno(error: unknown, code?: string): error is NodeJS.ErrnoException;
 /**
  * Read the content of a JSON or YAML file.
  *
- * @param path - The path to the file to read.
+ * @param path The path to the file to read.
  * @returns A tuple of the parsed content and the content as a string.
  */
 export declare function readData<R>(path: string): Promise<[R, string]>;
@@ -34,9 +34,9 @@ interface WriteDataOptions {
  *
  * If `prettier` is available, the content is also formatted.
  *
- * @param path - The file path to write the data to.
- * @param data - The data to write to the file.
- * @param options - Additional options for processing the data.
+ * @param path The file path to write the data to.
+ * @param data The data to write to the file.
+ * @param options Additional options for processing the data.
  * @returns The formatted content.
  */
 export declare function writeData(path: string, data: unknown, { compare, sort }?: WriteDataOptions): Promise<string>;
@@ -47,10 +47,10 @@ interface OpenDirSafeOptions {
 /**
  * Read the contents of a directory.
  *
- * @param directory - The path of the directory to open.
- * @param onFile - A callback which will get called for every file. This will be called with the
- * full file path as its first argument and its `Dirent` object as the second argument.
- * @param options - Additional options.
+ * @param directory The path of the directory to open.
+ * @param onFile A callback which will get called for every file. This will be called with the full
+ * file path as its first argument and its `Dirent` object as the second argument.
+ * @param options Additional options.
  */
 export declare function opendirSafe(directory: string, onFile: (fullpath: string, stat: Dirent) => Promisable<void>, options?: OpenDirSafeOptions): Promise<void>;
 export {};

package/{dist/fs.js → fs.js}

@@ -27,7 +27,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.opendirSafe = exports.writeData = exports.readData = exports.isErrno = void 0;
-const fs_1 = require("fs");
+const promises_1 = require("fs/promises");
 const path_1 = require("path");
 const utils_1 = require("@appsemble/utils");
 const parse_json_1 = __importDefault(require("parse-json"));
@@ -37,8 +37,8 @@ const _1 = require(".");
 /**
  * Test if the error is a NodeJS errno exception.
  *
- * @param error - The value to check
- * @param code - If specified, theck if the code matches
+ * @param error The value to check
+ * @param code If specified, theck if the code matches
  * @returns Whether or not the error is a NodeJS errno exception.
  */
 function isErrno(error, code) {
@@ -55,14 +55,14 @@ exports.isErrno = isErrno;
 /**
  * Read the content of a JSON or YAML file.
  *
- * @param path - The path to the file to read.
+ * @param path The path to the file to read.
  * @returns A tuple of the parsed content and the content as a string.
  */
 async function readData(path) {
     let content;
     const ext = (0, path_1.extname)(path);
     try {
-        content = await fs_1.promises.readFile(path, 'utf8');
+        content = await (0, promises_1.readFile)(path, 'utf8');
     }
     catch {
         throw new _1.AppsembleError(`Error reading file ${path}`);
@@ -86,9 +86,9 @@ exports.readData = readData;
  *
  * If `prettier` is available, the content is also formatted.
  *
- * @param path - The file path to write the data to.
- * @param data - The data to write to the file.
- * @param options - Additional options for processing the data.
+ * @param path The file path to write the data to.
+ * @param data The data to write to the file.
+ * @param options Additional options for processing the data.
  * @returns The formatted content.
  */
 async function writeData(path, data, { compare = utils_1.compareStrings, sort = true } = {}) {
@@ -107,23 +107,23 @@ async function writeData(path, data, { compare = utils_1.compareStrings, sort =
         buffer =
             ext === '.yml' || ext === '.yaml' ? (0, yaml_1.stringify)(sorted) : JSON.stringify(sorted, undefined, 2);
     }
-    await fs_1.promises.mkdir((0, path_1.dirname)(path), { recursive: true });
-    await fs_1.promises.writeFile(path, buffer);
+    await (0, promises_1.mkdir)((0, path_1.dirname)(path), { recursive: true });
+    await (0, promises_1.writeFile)(path, buffer);
     return buffer;
 }
 exports.writeData = writeData;
 /**
  * Read the contents of a directory.
  *
- * @param directory - The path of the directory to open.
- * @param onFile - A callback which will get called for every file. This will be called with the
- * full file path as its first argument and its `Dirent` object as the second argument.
- * @param options - Additional options.
+ * @param directory The path of the directory to open.
+ * @param onFile A callback which will get called for every file. This will be called with the full
+ * file path as its first argument and its `Dirent` object as the second argument.
+ * @param options Additional options.
  */
 async function opendirSafe(directory, onFile, options = {}) {
     let stats;
     try {
-        stats = await fs_1.promises.stat(directory);
+        stats = await (0, promises_1.stat)(directory);
     }
     catch (err) {
         if (options.allowMissing && isErrno(err, 'ENOENT')) {
@@ -134,7 +134,7 @@ async function opendirSafe(directory, onFile, options = {}) {
     if (!stats.isDirectory()) {
         throw new _1.AppsembleError(`Expected ${directory} to be a directory`);
     }
-    const dir = await fs_1.promises.opendir(directory);
+    const dir = await (0, promises_1.opendir)(directory);
     for await (const file of dir) {
         const fullPath = (0, path_1.join)(directory, file.name);
         await onFile(fullPath, file);

package/fs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fs.js","sourceRoot":"","sources":["fs.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,0CAAwE;AACxE,+BAA8C;AAE9C,4CAAkD;AAClD,4DAAmC;AACnC,0DAAiC;AAEjC,+BAAwC;AAExC,wBAAmC;AAEnC;;;;;;GAMG;AACH,SAAgB,OAAO,CAAC,KAAc,EAAE,IAAa;IACnD,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QACvC,OAAO,KAAK,CAAC;KACd;IACD,MAAM,GAAG,GAAG,KAA8B,CAAC;IAC3C,IAAI,IAAI,EAAE;QACR,OAAO,GAAG,CAAC,IAAI,KAAK,IAAI,CAAC;KAC1B;IACD,OAAO,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ,CAAC;AACtC,CAAC;AATD,0BASC;AAED;;;;;GAKG;AACI,KAAK,UAAU,QAAQ,CAAI,IAAY;IAC5C,IAAI,OAAe,CAAC;IACpB,MAAM,GAAG,GAAG,IAAA,cAAO,EAAC,IAAI,CAAC,CAAC;IAC1B,IAAI;QACF,OAAO,GAAG,MAAM,IAAA,mBAAQ,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC;KACxC;IAAC,MAAM;QACN,MAAM,IAAI,iBAAc,CAAC,sBAAsB,IAAI,EAAE,CAAC,CAAC;KACxD;IACD,IAAI,GAAG,KAAK,OAAO,IAAI,GAAG,KAAK,MAAM,IAAI,GAAG,KAAK,OAAO,EAAE;QACxD,MAAM,IAAI,iBAAc,CAAC,2BAA2B,IAAI,EAAE,CAAC,CAAC;KAC7D;IACD,IAAI;QACF,OAAO;YACL,GAAG,KAAK,OAAO,CAAC,CAAC,CAAC,IAAA,oBAAS,EAAC,OAAO,CAAC,CAAC,CAAC,CAAE,IAAA,YAAK,EAAC,OAAO,EAAE,EAAE,aAAa,EAAE,KAAM,EAAE,CAAO;YACvF,OAAO;SACR,CAAC;KACH;IAAC,OAAO,KAAc,EAAE;QACvB,MAAM,IAAI,iBAAc,CAAC,iBAAiB,IAAI,KAAM,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC;KAChF;AACH,CAAC;AAnBD,4BAmBC;AAgBD;;;;;;;;;GASG;AACI,KAAK,UAAU,SAAS,CAC7B,IAAY,EACZ,IAAa,EACb,EAAE,OAAO,GAAG,sBAAc,EAAE,IAAI,GAAG,IAAI,KAAuB,EAAE;IAEhE,MAAM,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,IAAA,mBAAQ,EAAC,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC3F,IAAI,MAAc,CAAC;IACnB,IAAI;QACF,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,aAAa,EAAE,GAAG,wDAAa,UAAU,GAAC,CAAC;QACxE,MAAM,EAAE,cAAc,EAAE,GAAG,MAAM,WAAW,CAAC,IAAI,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;QAC5E,MAAM,eAAe,GAAG,MAAM,aAAa,CAAC,IAAI,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC;QAC1E,eAAe,CAAC,MAAM,GAAG,cAAc,CAAC;QACxC,MAAM,GAAG,cAAc,KAAK,MAAM,CAAC,CAAC,CAAC,IAAA,gBAAS,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;QAC9F,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;KAC1C;IAAC,MAAM;QACN,MAAM,GAAG,GAAG,IAAA,cAAO,EAAC,IAAI,CAAC,CAAC;QAC1B,MAAM;YACJ,GAAG,KAAK,MAAM,IAAI,GAAG,KAAK,OAAO,CAAC,CAAC,CAAC,IAAA,gBAAS,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;KAChG;IACD,MAAM,IAAA,gBAAK,EAAC,IAAA,cAAO,EAAC,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAChD,MAAM,IAAA,oBAAS,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC9B,OAAO,MAAM,CAAC;AAChB,CAAC;AAtBD,8BAsBC;AAOD;;;;;;;GAOG;AACI,KAAK,UAAU,WAAW,CAC/B,SAAiB,EACjB,MAA4D,EAC5D,UAA8B,EAAE;IAEhC,IAAI,KAAY,CAAC;IACjB,IAAI;QACF,KAAK,GAAG,MAAM,IAAA,eAAI,EAAC,SAAS,CAAC,CAAC;KAC/B;IAAC,OAAO,GAAY,EAAE;QACrB,IAAI,OAAO,CAAC,YAAY,IAAI,OAAO,CAAC,GAAG,EAAE,QAAQ,CAAC,EAAE;YAClD,OAAO;SACR;QACD,MAAM,IAAI,iBAAc,CAAC,YAAY,SAAS,oBAAoB,CAAC,CAAC;KACrE;IACD,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,EAAE;QACxB,MAAM,IAAI,iBAAc,CAAC,YAAY,SAAS,oBAAoB,CAAC,CAAC;KACrE;IACD,MAAM,GAAG,GAAG,MAAM,IAAA,kBAAO,EAAC,SAAS,CAAC,CAAC;IACrC,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,GAAG,EAAE;QAC5B,MAAM,QAAQ,GAAG,IAAA,WAAI,EAAC,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5C,MAAM,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAC7B,IAAI,OAAO,CAAC,SAAS,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE;YAC3C,MAAM,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;SAC9C;KACF;AACH,CAAC;AAzBD,kCAyBC"}

package/fs.test.d.ts

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