Nihilistic Party Mantra

    @mmb-digital/one-login
    TypeScript icon, indicating that this package has built-in type declarations

    0.1.11 • Public • Published

    OneLogin

    The purpose of this repository is to provide components, functions or applications used to authorize/authenticate users. At this point we focus only on BankId.

    BankId

    The process of login using BankId consists of three steps:

    1. Bank selection
    2. Log in to the bank
    3. Data post processing

    At this moment we provide React component only for the first step. The component loads list of available banks and redirects user to the login page of selected bank. To do so component needs following config prop:

    • apiBasePath - API GW base path (e.g. https://api-test.moneta.cz)
    • authTokenClientSecret - client secret used to obtain authorization token. Can be generated in API GW portal
    • authTokenClientId - client id used to obtain authorization token. Can be generated in API GW portal
    • scope - bank id scope. 'openid' should be sufficient in the majority of cases. For other options refer to bank id specification.
    • returnUrl - API GW calls this URL when user logs in successfully
    • state - function returning identification string. The value will be present in return URL when API GW redirects user back to the process. To Repository provides one component BankId which handles the process of

    There is also component prop required by the BankId component. Either use defaultComponents provided by the repository or provide your own.

    defaultComponents

    Should be used in case the application is written using ds-lilly. Just use the BankId component and import small css.

    <BankId
      components={defaultBankIdComponents}
      config={{
        apiBasePath: 'https://api-test.moneta.cz',
        authTokenClientSecret: 'secret',
        authTokenClientId: 'token',
        scope: 'openid',
        state: () => 'state',
        returnUrl: 'https://api-test.moneta.cz/api/return-url',
      }}
    />
    @import '~@mmb-digital/one-login/dist/one-login.css'; /* or alternative */

    Own components

    In case your application is not build using ds-lilly just provide your own components and import two css files as shown bellow

    <BankId
      components={{
        loaderComponent: OwnLoader,
        titleComponent: OwnTitle,
        errorComponent: OwnError,
        textComponent: OwnText,
        linkComponent: OwnLink,
      }}
      config={{
        apiBasePath: 'https://api-test.moneta.cz',
        authTokenClientSecret: 'secret',
        authTokenClientId: 'token',
        scope: 'openid',
        state: () => 'state',
        returnUrl: 'https://api-test.moneta.cz/api/return-url',
      }}
    />
    @import '~@mmb-digital/one-login/dist/without-lilly.css'; /* or alternative import of css */
    @import '~@mmb-digital/one-login/dist/one-login.css'; /* or alternative of css */

    Original README generated by TSDX follows

    TSDX React w/ Storybook User Guide

    Congrats! You just saved yourself hours of work by bootstrapping this project with TSDX. Let’s get you oriented with what’s here and how to use it.

    This TSDX setup is meant for developing React component libraries (not apps!) that can be published to NPM. If you’re looking to build a React-based app, you should use create-react-app, razzle, nextjs, gatsby, or react-static.

    If you’re new to TypeScript and React, checkout this handy cheatsheet

    Commands

    TSDX scaffolds your new library inside /src, and also sets up a Parcel-based playground for it inside /example.

    The recommended workflow is to run TSDX in one terminal:

    npm start # or yarn start

    This builds to /dist and runs the project in watch mode so any edits you save inside src causes a rebuild to /dist.

    Then run either Storybook or the example playground:

    Storybook

    Run inside another terminal:

    yarn storybook

    This loads the stories from ./stories.

    NOTE: Stories should reference the components as if using the library, similar to the example playground. This means importing from the root project directory. This has been aliased in the tsconfig and the storybook webpack config as a helper.

    Configuration

    Code quality is set up for you with prettier, husky, and lint-staged. Adjust the respective fields in package.json accordingly.

    Jest

    Jest tests are set up to run with npm test or yarn test.

    Bundle analysis

    Calculates the real cost of your library using size-limit with npm run size and visulize it with npm run analyze.

    Setup Files

    This is the folder structure we set up for you:

    /example
      index.html
      index.tsx       # test your component here in a demo app
      package.json
      tsconfig.json
    /src
      index.tsx       # EDIT THIS
    /test
      blah.test.tsx   # EDIT THIS
    /stories
      Thing.stories.tsx # EDIT THIS
    /.storybook
      main.js
      preview.js
    .gitignore
    package.json
    README.md         # EDIT THIS
    tsconfig.json
    

    React Testing Library

    We do not set up react-testing-library for you yet, we welcome contributions and documentation on this.

    Rollup

    TSDX uses Rollup as a bundler and generates multiple rollup configs for various module formats and build settings. See Optimizations for details.

    TypeScript

    tsconfig.json is set up to interpret dom and esnext types, as well as react for jsx. Adjust according to your needs.

    Continuous Integration

    Optimizations

    Please see the main tsdx optimizations docs. In particular, know that you can take advantage of development-only optimizations:

    // ./types/index.d.ts
    declare var __DEV__: boolean;
    
    // inside your code...
    if (__DEV__) {
      console.log('foo');
    }

    You can also choose to install and use invariant and warning functions.

    Module Formats

    CJS, ESModules, and UMD module formats are supported.

    The appropriate paths are configured in package.json and dist/index.js accordingly. Please report if any issues are found.

    Named Exports

    Per Palmer Group guidelines, always use named exports. Code split inside your React app instead of your React library.

    Including Styles

    There are many ways to ship styles, including with CSS-in-JS. TSDX has no opinion on this, configure how you like.

    For vanilla CSS, you can include it at the root directory and add it to the files section in your package.json, so that it can be imported separately by your users and run through their bundler's loader.

    Publishing to NPM

    We recommend using np.

    Usage with Lerna

    When creating a new package with TSDX within a project set up with Lerna, you might encounter a Cannot resolve dependency error when trying to run the example project. To fix that you will need to make changes to the package.json file inside the example directory.

    The problem is that due to the nature of how dependencies are installed in Lerna projects, the aliases in the example project's package.json might not point to the right place, as those dependencies might have been installed in the root of your Lerna project.

    Change the alias to point to where those packages are actually installed. This depends on the directory structure of your Lerna project, so the actual path might be different from the diff below.

       "alias": {
    -    "react": "../node_modules/react",
    -    "react-dom": "../node_modules/react-dom"
    +    "react": "../../../node_modules/react",
    +    "react-dom": "../../../node_modules/react-dom"
       },

    An alternative to fixing this problem would be to remove aliases altogether and define the dependencies referenced as aliases as dev dependencies instead. However, that might cause other problems.

    Keywords

    none

    Install

    npm i @mmb-digital/one-login

    DownloadsWeekly Downloads

    61

    Version

    0.1.11

    License

    UNLICENCED

    Unpacked Size

    589 kB

    Total Files

    53

    Last publish

    Collaborators

    • novotnydaniel
    • roman.polansky
    • jerryna
    • machy
    • roman.hala
    • josefzamrzla
    • michal.sida
    • kakin