v0.0.4: Add WARRANT_IGNORE_ID constant (#3)

Author: kkajla12

README.md

@@ -57,6 +57,22 @@ if (await warrant.isAuthorized("store", storeId, "edit")) {
 }
 ```
 
+**NOTE:** To ignore the `objectId` when performing authorization calls using `isAuthorized`, you can pass the constant `WARRANT_IGNORE_ID`. You must have a corresponding warrant that grants access to **ANY** user on the given `objectType` for this check to succeed.
+```js
+import { Client as WarrantClient, WARRANT_IGNORE_ID } from "@warrantdev/warrant-js";
+
+// A valid session token is required to initialize the Client
+const warrant = new WarrantClient('client_test_f5dsKVeYnVSLHGje44zAygqgqXiLJBICbFzCiAg1E=', sessionToken);
+
+//
+// Example Scenario:
+// An e-commerce website where Store Owners can edit their own Store's info
+//
+if (await warrant.isAuthorized("store", WARRANT_IGNORE_ID, "edit")) {
+    // Carry out logic to allow user to edit a Store
+}
+```
+
 We’ve used a random Client Key in these code examples. Replace it with your
 [actual publishable Client Key](https://app.warrant.dev) to
 test this code through your own Warrant account.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@warrantdev/warrant-js",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "JavaScript Library to Use Warrant in Client Applications",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

src/constants.ts

@@ -1,2 +1,4 @@
 export const API_URL_BASE = "https://api.warrant.dev";
 export const API_VERSION = "v1";
+
+export const WARRANT_IGNORE_ID = "WARRANT_IGNORE_ID";

src/index.ts

@@ -1 +1,2 @@
 export { default as Client } from "./Client";
+export { WARRANT_IGNORE_ID } from "./constants";