@interweave/interweave - npm Package Compare versions

Comparing version 0.0.16 to 0.0.17

dist/interfaces.d.ts

@@ -270,2 +270,5 @@ export interface Error {
     };
+    /**
+     * Control who has access to this interface
+     */
     access?: {
@@ -291,2 +294,27 @@ /**
     };
+    /**
+     * Specify authorization flows required to access your API
+     */
+    authorization?: {
+        /**
+         * Keys are project scoped.
+         * Any interfaces within the project that specify this key will refer to the first saved token found for a given user
+         */
+        [key: string]: {
+            /**
+             * Trigger a modal asking for the token
+             */
+            type: "token";
+            /**
+             * Headers object to modify a Request that uses this authorization key
+             */
+            headers?: {
+                /**
+                 * Token variable is accessible in the value by wrapping the word token in braces.
+                 * So a key:value pair here of `'authorization': 'Bearer {token}'` will produce the expected result of `Bearer xzy123`.
+                 */
+                [headerName: string]: string;
+            };
+        };
+    };
 }
@@ -293,0 +321,0 @@ export type Users = {

package.json

 {
 	"name": "@interweave/interweave",
-	"version": "0.0.16",
+	"version": "0.0.17",
 	"description": "",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

src/interfaces.ts

@@ -297,2 +297,5 @@ export interface Error {
 	};
+	/**
+	 * Control who has access to this interface
+	 */
 	access?: {
@@ -323,2 +326,27 @@ /**
 	};
+	/**
+	 * Specify authorization flows required to access your API
+	 */
+	authorization?: {
+		/**
+		 * Keys are project scoped.
+		 * Any interfaces within the project that specify this key will refer to the first saved token found for a given user
+		 */
+		[key: string]: {
+			/**
+			 * Trigger a modal asking for the token
+			 */
+			type: "token";
+			/**
+			 * Headers object to modify a Request that uses this authorization key
+			 */
+			headers?: {
+				/**
+				 * Token variable is accessible in the value by wrapping the word token in braces.
+				 * So a key:value pair here of `'authorization': 'Bearer {token}'` will produce the expected result of `Bearer xzy123`.
+				 */
+				[headerName: string]: string;
+			};
+		};
+	};
 }
@@ -325,0 +353,0 @@ export type Users = {

No alert changes

Improved metrics

Total package byte prevSize

94028

increased by1.91%

Lines of code

2709

increased by2.11%

No dependency changes