expensify-common 1.0.1 → 2.0.2

package/README.md

@@ -1,14 +1,16 @@
 # `expensify-common`
-This is a collection of JS libraries and components which are used across various Expensify projects. These libraries are provided as-is, and the repos which use them will need to do their own bundling, minifying, and uglifying.
+This is a collection of JS/TS libraries and components which are used across various Expensify projects. These libraries are provided as-is, and the repos which use them will need to do their own bundling, minifying, and uglifying.
 
 # Installation
-1. Clone this repo to a directory of your choosing
-2. Run `npm install` to install all the dependencies
+`expensify-common` is published to [`npm`](https://www.npmjs.com/package/expensify-common)
+
+```shell
+npm install expensify-common
+```
 
 # Development
 * Write all code as ES6.
-* Always lint your code with `npm run grunt watch`
-* Make sure you're using http://editorconfig.org/
+* Always lint your code with `npm run lint`
 
 ## Testing your code while you are developing
 The best way to test your code while you are developing changes is via `npm link`.
@@ -17,6 +19,8 @@ The best way to test your code while you are developing changes is via `npm link
 1. `cd` into the project directory that has a dependency on `expensify-common`
 1. Run `npm link expensify-common`
 
+If that does not work, another option is running `npm i expensify-common ../expensify-common --save`.
+
 Alternatively, you can edit files directly in a project's `node_modules` then apply those changes to this repository.
 
 # Proposing a Change (Non-Expensify Contributors)
@@ -26,4 +30,9 @@ Alternatively, you can edit files directly in a project's `node_modules` then ap
 1. They will review and accept your changes, merge them, then deploy a new version
 
 # Deploying a Change (Expensify Only)
-1. Once the PR has been merged update the `package.json` commit hash in any repos with a dependency on `expensify-common`
+Once the PR has been merged, install the new version of the package with `npm install expensify-common@x.x.x` command. Be sure to check the repos below to confirm whether or not they are affected by your changes!
+- Expensify/Web-Expensify
+- Expensify/Web-Secure
+- Expensify/Mobile-Expensify
+- Expensify/App
+- Expensify/Comp

package/dist/API.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @param {Network} network
+ * @param {Object} [args]
+ * @param {Function} [args.enhanceParameters] A function that takes the existing command parameters and returns a
+ *                      modified version of them (for things like adding CSRF tokens)
+ *
+ * @returns {Object}
+ */
+export default function API(network: Network, args?: {
+    enhanceParameters?: Function | undefined;
+} | undefined): Object;