update: move org_uid to headers

To ensure that the getAllStacks only receive the list of stacks that the
user is currently a member of, we updated the url to /stacks. Now, this
route accepts the organization uid through headers.

Also, this route now uses getStacks instead of getAllStacks as that
route was redundant. But, the event adds the api key by default. So, we
have added another key to skip the api key in the headers.

Author: Deepak-Kharah

__test__/stack.test.ts

@@ -52,12 +52,58 @@ describe("Stack", () => {
             });
         });
 
-        it("getAllStacks", (done) => {
+        it("getAllStacks should get called with default org Uid when not provided", (done) => {
             stack.getAllStacks().then((data) => {
                 expect(data.length).toBe(0);
                 expect(connection.sendToParent).toHaveBeenCalledWith(
                     "stackQuery",
-                    { org_uid: getStack().org_uid, action: "getAllStacks" }
+                    {
+                        headers: { organization_uid: getStack().org_uid },
+                        action: "getStacks",
+                        params: {},
+                        skip_api_key: true,
+                    }
+                );
+                done();
+            });
+        });
+
+        it("getAllStacks should get called with provided org Uid", (done) => {
+            let orgUid = "some-org-uid";
+            stack.getAllStacks({ orgUid }).then((data) => {
+                expect(data.length).toBe(0);
+                expect(connection.sendToParent).toHaveBeenCalledWith(
+                    "stackQuery",
+                    {
+                        headers: { organization_uid: orgUid },
+                        action: "getStacks",
+                        params: {},
+                        skip_api_key: true,
+                    }
+                );
+                done();
+            });
+        });
+
+        it("getAllStacks should throw error when uid is not string", async () => {
+            let orgUid = 123 as any;
+            await expect(stack.getAllStacks({ orgUid })).rejects.toThrowError(
+                "orgUid must be a string"
+            );
+        });
+
+        it("getAllStacks should send query params", (done) => {
+            let params = { sample: "parameter" };
+            stack.getAllStacks({ params }).then((data) => {
+                expect(data.length).toBe(0);
+                expect(connection.sendToParent).toHaveBeenCalledWith(
+                    "stackQuery",
+                    {
+                        headers: { organization_uid: getStack().org_uid },
+                        action: "getStacks",
+                        params,
+                        skip_api_key: true,
+                    }
                 );
                 done();
             });

src/stack/index.ts

@@ -1,7 +1,7 @@
 import Asset from './api/asset/index';
 import ContentType from './api/content-type/index';
 import { onData, onError } from "../utils";
-import { BranchDetail, StackAdditionalData, StackDetail, StackSearchQuery } from '../types/stack.types';
+import { BranchDetail, GetAllStacksOptions, StackAdditionalData, StackDetail, StackSearchQuery } from '../types/stack.types';
 
 
 /**
@@ -66,10 +66,24 @@ class Stack {
 
   /**
    * This method returns all the stacks in the current organization.
+   * @param query asks for organization UID and query params to get all stacks
    * @returns Stacks within current organization
    */
-  getAllStacks(): Promise<StackDetail[]> {
-    const options = { action: "getAllStacks", org_uid: this._data.org_uid };
+  async getAllStacks({orgUid = "", params = {}}: GetAllStacksOptions = {}): Promise<StackDetail[]> {
+
+    console.log("getAllStacks", orgUid, typeof orgUid);
+    
+    // validation
+    if (typeof orgUid !== 'string') {
+      throw new TypeError('orgUid must be a string');
+    }
+
+    const options = {
+        action: "getStacks",
+        headers: { organization_uid: orgUid || this._data.org_uid },
+        skip_api_key: true,
+        params
+    };
     return this._connection
       .sendToParent("stackQuery", options)
       .then(onData)

src/types/stack.types.ts

@@ -103,3 +103,8 @@ export declare interface StackSearchQuery {
     save_recent_search?: boolean;
     desc?: string;
 }
+
+export declare interface GetAllStacksOptions {
+    orgUid?: string;
+    params?: AnyObject;
+}