@seibert/forge-storage-inspector

Forge Storage Inspector

Forge Storage Inspector is a small typescript module to query the Atlassian Forge storage of your Atlassian Forge app. By using it alongside the Forge Storage Inspector Client (see: https://bitbucket.org/seibert-media/forge-storage-inspector-client/src/master/) you are able to display, traverse and edit your storage with a GUI.

Usage

Install it in your Forge app project:

npm i @seibert/forge-storage-inspector

Add a web trigger to your Forge app manifest:

modules:
  webtrigger:
    - key: webtrigger-key
      function: runWebtrigger
  function:
    - key: runWebtrigger
      handler: index.runWebtrigger

Handle the web trigger request in your index module and pass the request to the forge storage inspector module:

import {handleWebTriggerRequest} from "@seibert/forge-storage-inspector";

export const runWebtrigger = async (req: any) => {
    return handleWebTriggerRequest(req);
};

Checkout the Forge Storage Client

git clone [e-mail]:seibert-media/forge-storage-inspector-client.git

Start the client:

npm start

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT