@edular/modules

Shared constants and utils for modules handling in Edular project.

How to use the library

yarn add @edular/modules

or

npm install --save @edular/modules

Initialize

Wrap your parent component with EdularModulesProvider

//App.tsx
import { EdularModulesProvider } from '@edular/modules';

// ...
return (
  <EdularModulesProvider>
    <ChildComponent />
  </EdularModulesProvider>
);

Somewhere in the app when you have profile and token ready

import { useEdularModuleContext } from '@edular/modules';

function OtherComponent() {
  const profile = useSelector(getActiveProfileState);
  const {
    initialize, // Initialize modules
    refreshModules, // Use this in case you need to refresh modules
  } = useEdularModuleContext();

  useEffect(() => {
    if (!profile) {
      return;
    }
    initialize({
      profileId: profile.id,
      token: keychain.getTokens().accessToken,
      baseUrl: config.edularApiBaseUrl,
    });
  }, [profile]);

  // In mobile, I would like to refresh module whenever app is bring back to foreground
  useAppState(state => {
    if (state === 'active') {
      refreshModules();
    }
  });
}

Usage

In functional component

import { useEdularModuleContext, Modules } from '@edular/modules';

function SomeComponent() {
  const { isModuleEnable } = useEdularModuleContext();

  return (
    <Component>
      {isModuleEnable(Modules.Admissions) && <AdmissionsComponent />}
    </Component>
  );
}

In class component

import { EdularModulesContext, Modules } from '@edular/modules';

class SomeComponent() {
  static contextType = EdularModulesContext

  render() {
    const { isModuleEnable} = this.context

    return (
      <Component>
        {isModuleEnable(Modules.Admissions) && <AdmissionsComponent />}
      </Component>
    )
  }
}

Modules

The repository contains the modules.ts file that exports Modules object — all available modules. The file is generated based on the modules list from the main Edular database.

Scripts

• build — building the library artifacts (lib/ directory)
• build:clean — clean the build directory lib/
• generate-modules — generate modules.ts with the Modules object exported

How to publish new version

1. Start the edular-core and run yarn generate-modules to generate new modules.ts.
2. Commit the change and run npm version major|minor|patch -m "bump %s" to bump new version.
3. Publish to npm registry by running yarn publish.
4. Update the version in package.json manually or use npm for that:

npm version <major|minor|patch>

2. Commit the changes and push them to the remote repository

3. Publish new version to npm registry

npm publish