Package Exports

@forge4flow/forge4flow-js
@forge4flow/forge4flow-js/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@forge4flow/forge4flow-js) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@forge4flow/forge4flow-js

Use Forge4FlowClient as an ES module.

Installation

Use npm to install the Forge4FlowClient module:

npm install @forge4flow/forge4flow-js

Usage

Import the Forge4FlowClient and initiate the client & login or pass a sessionToken in as part of the configurations:

IMPORTANT: Ensure you have configured FCL alrady or these methods will fails

import Forge4FlowClient from "@forge4flow/forge4flow-js";

// A valid session token is required to initialize the Client
const forge4Flow = new Forge4FlowClient({
  clientKey: "client_test_f5dsKVeYnVSLHGje44zAygqgqXiLJBICbFzCiAg1E=",
  endpoint: "https://your-core-endpont",
  sessionToken: "Optional Value", // DO NOT CALL LOGIN IF PASSING IN A SESSION TOKEN
});

forge4Flow.login();

`check`

This function returns a Promise that resolves with true if the user for the current session token has the specified warrant and false otherwise.

//
// Example Scenario:
// An e-commerce website where Store Owners can edit their own Store's info
//
forge4Flow
  .check({ object: myReport, relation: "editor" })
  .then((isAuthorized) => {
    if (isAuthorized) {
      // Carry out logic to allow user to edit a Store
    }
  });

Or using async/await:

//
// Example Scenario:
// An e-commerce website where Store Owners can edit their own Store's info
//
const isAuthorized = await forge4Flow.check({
  object: myReport,
  relation: "editor",
});
if (isAuthorized) {
  // Carry out logic to allow user to edit a Store
}

`checkMany`

This function returns a Promise that resolves with true if the user for the current session token has allOf or anyOf (depending on the passed in op) the specified warrants and false otherwise.

CheckOp.AnyOf specifies that the access check request will be authorized if any of the warrants are matched and will not be authorized otherwise.

CheckOp.AllOf specifies that the access check request will be authorized if all of the warrants are matched and will not be authorized otherwise.

forge4Flow
  .checkMany({
    op: CheckOp.AllOf,
    warrants: [
      {
        object: tenantA,
        relation: "member",
      },
      {
        object: reportA,
        relation: "editor",
      },
    ],
  })
  .then((isAuthorized) => {
    if (isAuthorized) {
      // Carry out logic if user is member of tenantA AND editor of reportA
    }
  });

Or using async/await:

const isAuthorized = await forge4Flow.checkMany({
  op: CheckOp.AllOf,
  warrants: [
    {
      object: tenantA,
      relation: "member",
    },
    {
      object: reportA,
      relation: "editor",
    },
  ],
});
if (isAuthorized) {
  // Carry out logic if user is member of tenantA AND editor of reportA
}

`hasPermission`

This function returns a Promise that resolves with true if the user for the current session token has the specified permission and false otherwise.

forge4Flow
  .hasPermission({ permissionId: "view-items" })
  .then((canViewItems) => {
    if (canViewItems) {
      // Carry out logic if user has permission view-items
    }
  });

Or using async/await:

const canViewItems = await forge4Flow.hasPermission({
  permissionId: "view-items",
});
if (canViewItems) {
  // Carry out logic if user has permission view-items
}

`hasFeature`

This function returns a Promise that resolves with true if the user for the current session token has the specified feature and false otherwise.

forge4Flow.hasFeature({ featureId: "save-items" }).then((canSaveItems) => {
  if (canSaveItems) {
    // Carry out logic if user has feature save-items
  }
});

Or using async/await:

const canSaveItems = await forge4Flow.hasFeature({ featureId: "save-items" });
if (canSaveItems) {
  // Carry out logic if user has feature save-items
}