cozy-harvest-lib 14.1.0 → 14.2.0

package/.storybook/StoryContainer.tsx

@@ -0,0 +1,47 @@
+import React, { ReactNode } from 'react'
+import { Provider as ReduxProvider } from 'react-redux'
+
+import CozyClient, { CozyProvider as CozyClientProvider } from 'cozy-client'
+import { useCozyDialog } from 'cozy-ui/transpiled/react/CozyDialogs'
+import I18n from 'cozy-ui/transpiled/react/I18n'
+import { BreakpointsProvider } from 'cozy-ui/transpiled/react/hooks/useBreakpoints'
+import CozyTheme from 'cozy-ui/transpiled/react/CozyTheme'
+import DialogContext from '../src/components/DialogContext'
+import enLocale from '../src/locales/en.json'
+
+const defaultClient = new CozyClient()
+defaultClient.ensureStore()
+
+export const StoryContainer = ({ children }: {children: ReactNode}) => {
+  return (
+    <CozyClientProvider client={defaultClient}>
+      <CozyTheme>
+        <BreakpointsProvider>
+          <DialogContextApp>
+            <I18n lang="en" dictRequire={() => enLocale}>
+              <ReduxProvider store={defaultClient.store}>
+                <div style={{position: "relative"}}>{children}</div>
+              </ReduxProvider>
+            </I18n>
+          </DialogContextApp>
+        </BreakpointsProvider>
+      </CozyTheme>
+    </CozyClientProvider>
+  )
+}
+
+const DialogContextApp = ({ children }: {children: ReactNode}) => {
+  const dialogContext = useCozyDialog({
+    size: 'l',
+    open: true,
+    onClose: null,
+    disableTitleAutoPadding: true
+  })
+  return (
+    <DialogContext.Provider value={dialogContext}>
+      {children}
+    </DialogContext.Provider>
+  )
+}
+
+

package/.storybook/fixtures/AccountSelectorHeader.fixtures.ts

@@ -0,0 +1,334 @@
+export const AccountSelectorHeaderFixtures = {
+  konnector: {
+    type: 'konnector',
+    id: 'io.cozy.konnectors/stub',
+    attributes: {
+      banksTransactionRegExp: '(someRegex)',
+      categories: ['insurance'],
+      checksum: '1337',
+      created_at: '2023-03-29T10:24:07.4799633+02:00',
+      data_types: ['bill'],
+      developer: {
+        name: 'John Doe',
+        url: 'https://john.doe.it'
+      },
+      editor: 'Cozy',
+      features: [
+        'LOGIN_OK',
+        'METADATA_DEDUP',
+        'IDENTITY',
+        'DOC_QUALIFICATION',
+        'HEALTH',
+        'CARBON_COPY',
+        'SENTRY_V2'
+      ],
+      fields: {
+        login: {
+          max: 13,
+          min: 13,
+          type: 'text'
+        },
+        password: {
+          type: 'password'
+        }
+      },
+      folders: [
+        {
+          defaultDir: '$administrative/$konnector/$account'
+        }
+      ],
+      icon: 'icon.svg',
+      langs: ['fr'],
+      language: 'node',
+      locales: {
+        en: {
+          long_description: 'long description',
+          permissions: {
+            accounts: {
+              description: "Required to get the account's data"
+            },
+            'bank operations': {
+              description: 'Required to link bills to bank operations'
+            },
+            bills: {
+              description: 'Required to save the bills data'
+            },
+            carboncopy: {
+              description: 'Required for carbon copy documents'
+            },
+            files: {
+              description: 'Required to save the bills'
+            },
+            identities: {
+              description: 'Required to save your identity'
+            }
+          },
+          short_description: 'Retrieves all your stub invoices'
+        },
+        fr: {
+          fields: {
+            login: {
+              label: 'Numéro de sécurité sociale',
+              placeholder: '13 chiffres'
+            }
+          },
+          long_description: 'long description',
+          permissions: {
+            accounts: {
+              description: 'Utilisé pour obtenir les données du compte'
+            },
+            'bank operations': {
+              description:
+                'Utilisé pour lier les factures aux opérations bancaires'
+            },
+            bills: {
+              description: 'Utilisé pour sauvegarder les données des factures'
+            },
+            carboncopy: {
+              description:
+                "Utilisé pour certifier que vos fichiers sont copie conforme avec les documents d'origine"
+            },
+            files: {
+              description: 'Utilisé pour sauvegarder les factures'
+            },
+            identities: {
+              description: 'Utilisé pour sauvegarder votre identité'
+            }
+          },
+          short_description:
+            'Récupère dans votre Cozy les relevés de remboursements, votre attestations et vos messages'
+        }
+      },
+      manifest_version: '2',
+      name: 'Stub',
+      permissions: {
+        'bank operations': {
+          type: 'io.cozy.bank.operations'
+        },
+        bills: {
+          type: 'io.cozy.bills'
+        },
+        files: {
+          type: 'io.cozy.files'
+        },
+        carbon_copy: {
+          type: 'io.cozy.certified.carbon_copy'
+        },
+        accounts: {
+          type: 'io.cozy.accounts'
+        },
+        identities: {
+          type: 'io.cozy.identities'
+        }
+      },
+      slug: 'stub',
+      source: 'registry://stub/stable',
+      state: 'ready',
+      time_interval: [0, 24],
+      type: 'konnector',
+      updated_at: '2023-03-29T10:24:07.4799636+02:00',
+      vendor_link: 'https://stub.it',
+      version: '1.18.0'
+    },
+    meta: {
+      rev: '1'
+    },
+    links: {
+      self: '/konnectors/stub',
+      icon: '/konnectors/stub/icon/1',
+      permissions: '/permissions/konnectors/stub'
+    },
+    banksTransactionRegExp: '(someRegex)',
+    checksum:
+      'f7e732e7afc7f6b5f697c375aba570424aa6b28590b380203ef9849a071e87c7',
+    created_at: '2023-03-29T10:24:07.4799633+02:00',
+    editor: 'Cozy',
+    icon: 'icon.svg',
+    language: 'node',
+    manifest_version: '2',
+    name: 'Stub',
+    slug: 'stub',
+    source: 'registry://stub/stable',
+    state: 'ready',
+    updated_at: '2023-03-29T10:24:07.4799636+02:00',
+    vendor_link: 'https://stub.it',
+    version: '1',
+    _type: 'io.cozy.konnectors',
+    triggers: {
+      data: [
+        {
+          type: '@cron',
+          id: '1337',
+          attributes: {
+            _id: '1337',
+            _rev: '1',
+            domain: 'dev:8080',
+            prefix: 'dev1337',
+            type: '@cron',
+            worker: 'konnector',
+            arguments: '0 11 2 * * 3',
+            debounce: '',
+            options: null,
+            message: {
+              account: '1337',
+              konnector: 'stub',
+              folder_to_save: '1337'
+            },
+            current_state: {
+              trigger_id: '1337',
+              status: 'done',
+              last_success: '2023-06-23T10:37:40.6638338+02:00',
+              last_successful_job_id: '1337',
+              last_execution: '2023-06-23T10:37:40.6638338+02:00',
+              last_executed_job_id: '1337',
+              last_failure: '2023-04-26T09:10:39.4642864+02:00',
+              last_failed_job_id: '1337',
+              last_error: 'VENDOR_DOWN',
+              last_manual_execution: '2023-06-23T10:37:40.6638338+02:00',
+              last_manual_job_id: '1337'
+            },
+            cozyMetadata: {
+              doctypeVersion: '1',
+              metadataVersion: 1,
+              createdAt: '2023-03-29T10:25:41.8226664+02:00',
+              createdByApp: 'home',
+              updatedAt: '2023-03-29T10:25:41.8226664+02:00'
+            }
+          },
+          meta: {},
+          links: {
+            self: '/jobs/triggers/1337'
+          },
+          _id: '1337',
+          _rev: '1',
+          domain: 'dev:8080',
+          prefix: 'dev1337',
+          worker: 'konnector',
+          arguments: '0 11 2 * * 3',
+          debounce: '',
+          options: null,
+          _type: 'io.cozy.triggers'
+        }
+      ]
+    }
+  },
+  account: {
+    id: '1337',
+    _id: '1337',
+    _type: 'io.cozy.accounts',
+    _rev: '1',
+    account_type: 'stub',
+    auth: {
+      credentials_encrypted: '1337',
+      login: '1 55 55 12 784 125'
+    },
+    cozyMetadata: {
+      createdAt: '2023-03-29T10:25:41.6712839+02:00',
+      createdByApp: 'home',
+      doctypeVersion: '',
+      metadataVersion: 1,
+      updatedAt: '2023-06-23T08:37:37.541Z',
+      updatedByApps: [
+        {
+          date: '2023-06-23T08:37:37.541Z'
+        },
+        {
+          date: '2023-03-29T10:25:41.6712839+02:00',
+          slug: 'home'
+        }
+      ]
+    },
+    defaultFolderPath: '/Stub/1 55 55 12 784 125',
+    identifier: 'login',
+    name: '1 55 55 12 784 125',
+    state: 'LOGIN_SUCCESS'
+  },
+  accountsAndTriggers: [
+    {
+      account: {
+        id: '1337',
+        _id: '1337',
+        _type: 'io.cozy.accounts',
+        _rev: '1',
+        account_type: 'stub',
+        auth: {
+          credentials_encrypted: '1337',
+          login: '1 55 55 12 784 125'
+        },
+        cozyMetadata: {
+          createdAt: '2023-03-29T10:25:41.6712839+02:00',
+          createdByApp: 'home',
+          doctypeVersion: '',
+          metadataVersion: 1,
+          updatedAt: '2023-06-23T08:37:37.541Z',
+          updatedByApps: [
+            {
+              date: '2023-06-23T08:37:37.541Z'
+            },
+            {
+              date: '2023-03-29T10:25:41.6712839+02:00',
+              slug: 'home'
+            }
+          ]
+        },
+        defaultFolderPath: '/Stub/1 55 55 12 784 125',
+        identifier: 'login',
+        name: '1 55 55 12 784 125',
+        state: 'LOGIN_SUCCESS'
+      },
+      trigger: {
+        type: '@cron',
+        id: '1337',
+        attributes: {
+          _id: '1337',
+          _rev: '1',
+          domain: 'dev:8080',
+          prefix: 'dev1337',
+          type: '@cron',
+          worker: 'konnector',
+          arguments: '0 11 2 * * 3',
+          debounce: '',
+          options: null,
+          message: {
+            account: '1337',
+            konnector: 'stub',
+            folder_to_save: '1337'
+          },
+          current_state: {
+            trigger_id: '1337',
+            status: 'done',
+            last_success: '2023-06-23T10:37:40.6638338+02:00',
+            last_successful_job_id: '1337',
+            last_execution: '2023-06-23T10:37:40.6638338+02:00',
+            last_executed_job_id: '1337',
+            last_failure: '2023-04-26T09:10:39.4642864+02:00',
+            last_failed_job_id: '1337',
+            last_error: 'VENDOR_DOWN',
+            last_manual_execution: '2023-06-23T10:37:40.6638338+02:00',
+            last_manual_job_id: '1337'
+          },
+          cozyMetadata: {
+            doctypeVersion: '1',
+            metadataVersion: 1,
+            createdAt: '2023-03-29T10:25:41.8226664+02:00',
+            createdByApp: 'home',
+            updatedAt: '2023-03-29T10:25:41.8226664+02:00'
+          }
+        },
+        meta: {},
+        links: {
+          self: '/jobs/triggers/1337'
+        },
+        _id: '1337',
+        _rev: '1',
+        domain: 'dev:8080',
+        prefix: 'dev1337',
+        worker: 'konnector',
+        arguments: '0 11 2 * * 3',
+        debounce: '',
+        options: null,
+        _type: 'io.cozy.triggers'
+      }
+    }
+  ]
+}

package/.storybook/main.ts

@@ -0,0 +1,20 @@
+import type { StorybookConfig } from '@storybook/react-webpack5';
+
+const config: StorybookConfig = {
+  stories: ["../src/**/*.mdx", "../src/**/*.stories.@(js|jsx|ts|tsx)"],
+  addons: [
+    "@storybook/addon-links",
+    "@storybook/addon-essentials",
+    "@storybook/addon-interactions",
+  ],
+  framework: {
+    name: "@storybook/react-webpack5",
+    options: {},
+  },
+  docs: {
+    autodocs: true
+  },
+  staticDirs: ['./public'],
+};
+
+export default config;

package/.storybook/preview-head.html

@@ -0,0 +1,20 @@
+<!-- This is the `head` of the preview iframe -->
+<!-- Pull in static files served from your Static directory or the internet -->
+
+<style>
+  @font-face {
+    font-family: Lato;
+    font-style: normal;
+    font-weight: normal;
+    src: url("/Lato-Regular.immutable.woff2") format("woff2");
+    font-display: fallback;
+  }
+
+  @font-face {
+    font-family: Lato;
+    font-style: normal;
+    font-weight: bold;
+    src: url("/Lato-Bold.immutable.woff2") format("woff2");
+    font-display: fallback;
+  }
+</style>

package/.storybook/preview.tsx

@@ -0,0 +1,30 @@
+import type { Preview } from "@storybook/react";
+
+import 'cozy-ui/dist/cozy-ui.min.css'
+import 'cozy-ui/dist/cozy-ui.utils.min.css'
+import 'cozy-ui/transpiled/react/stylesheet.css'
+import React from "react";
+import { StoryContainer } from "./StoryContainer";
+
+const preview: Preview = {
+  decorators: [
+    (Story) => (
+      <StoryContainer>
+        <div style={{position: "relative"}}>
+          <Story />
+        </div>
+      </StoryContainer>
+    ),
+  ],
+  parameters: {
+    actions: { argTypesRegex: "^on[A-Z].*" },
+    controls: {
+      matchers: {
+        color: /(background|color)$/i,
+        date: /Date$/,
+      },
+    },
+  },
+};
+
+export default preview;

package/CHANGELOG.md

@@ -3,6 +3,32 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [14.2.0](https://github.com/cozy/cozy-libs/compare/cozy-harvest-lib@14.1.1...cozy-harvest-lib@14.2.0) (2023-06-27)
+
+
+### Features
+
+* **harvest:** Add first story ([990773d](https://github.com/cozy/cozy-libs/commit/990773d22d1155b166ef163efe1918cd7468229a))
+* **harvest:** Convert Storybook to TS ([02b56a2](https://github.com/cozy/cozy-libs/commit/02b56a20e810e689e5405c32e7a23d8038bd7d35))
+* **harvest:** Implement first Story ([1629b46](https://github.com/cozy/cozy-libs/commit/1629b46ef3ce599c47e3cedb63dee6be1f7fb66e))
+* **harvest:** Install Storybook in the project ([9ec05a4](https://github.com/cozy/cozy-libs/commit/9ec05a4cbb2b97826291089bb2b2059cf74eafa0))
+
+
+
+
+
+## [14.1.1](https://github.com/cozy/cozy-libs/compare/cozy-harvest-lib@14.1.0...cozy-harvest-lib@14.1.1) (2023-06-23)
+
+
+### Bug Fixes
+
+* Do not display reconnection webview for USER_ACTION_NEEDED state ([a0c04fe](https://github.com/cozy/cozy-libs/commit/a0c04fea02d2f401bf4c2d9324236b8d2d29df03))
+* Show accounts paywall for oAuth konnector ([e30c737](https://github.com/cozy/cozy-libs/commit/e30c7370e7e1ce41c8238acc3e97f53380935b74))
+
+
+
+
+
 # [14.1.0](https://github.com/cozy/cozy-libs/compare/cozy-harvest-lib@14.0.0...cozy-harvest-lib@14.1.0) (2023-06-23)
 
 

package/README.md

@@ -155,10 +155,146 @@ ReactDOM.render(
 )
 ```
 
-# API
-
-See the [Styleguidist](https://docs.cozy.io/cozy-libs/cozy-harvest-lib/).
-
 # Doc and example about manifests
 
 <https://docs.cozy.io/en/tutorials/konnector/#the-manifest>
+
+# Working with Storybook
+
+## Run Storybook
+
+```
+yarn storybook
+```
+
+## Build Storybook
+
+```
+yarn build-storybook
+```
+
+## Add a new story
+
+Create a new file next to the component you want to add a story for, with the `.stories.{ts,tsx}` extension (depending if you need to write JSX or not in the story).
+
+### For Javascript components
+
+Storybook expects a component with typed props for better parameter inference, so if your component is not typed, you can still create an interface for the props in the story file.
+
+```ts
+import type { Meta, StoryObj } from '@storybook/react'
+
+// Import with a different name to avoid conflict with the typed Button component
+import _Button from './Button'
+
+// Create a typed alias for the component with the same name and the same props
+const Button = _Button as (props: {
+  onClick: () => void
+  title: string
+  disabled?: boolean
+}) => JSX.Element
+
+// Create a meta object for the story, this is mandatory
+const meta: Meta<typeof Button> = {
+  // Make onClick an action for all stories so that you can see the click events in the Storybook UI
+  argTypes: {
+    onClick: { action: 'onClick' }
+  },
+  component: Button
+}
+
+// Export the meta object as default export so that Storybook can use it automatically
+export default meta
+
+// Create a typed alias for the StoryObj type corresponding to the component
+type Story = StoryObj<typeof Button>
+
+// Create as many stories as you want and cast them to the Story type
+
+// This story will be named "Default" by Storybook
+export const Default: Story = {
+  args: {
+    title: 'Foobar'
+  }
+}
+
+export const Disabled: Story = {
+  // The story can have a custom name if you specify it here
+  name: 'Disabled state',
+  args: {
+    disabled: true,
+    title: 'Barfoo',
+  }
+}
+```
+
+### For Typescript components
+
+If your component is already typed, you can import it directly and use it in the story. Everything else is the same as for Javascript components.
+
+```ts
+import type { Meta, StoryObj } from '@storybook/react'
+
+import Button from './Button'
+
+const meta: Meta<typeof Button> = {
+  argTypes: {
+    onClick: { action: 'onClick' }
+  },
+  component: Button
+}
+
+export default meta
+
+type Story = StoryObj<typeof Button>
+
+export const Default: Story = {
+  args: {
+    title: 'Foobar'
+  }
+}
+
+export const Disabled: Story = {
+  name: 'Disabled state',
+  args: {
+    disabled: true,
+    title: 'Barfoo',
+  }
+}
+```
+
+## Configure Storybook
+
+The Storybook configuration is in the `.storybook` folder.
+
+### Add a new addon
+
+Addons are plugins that add features to Storybook. You can find a list of addons [here](https://storybook.js.org/addons/).
+
+To add a new addon, install it with `yarn add -D` and add it to the `addons` array in `.storybook/main.js`.
+
+### Add a new webpack loader
+
+Webpack loaders are used to load files in Storybook. You can find a list of loaders [here](https://webpack.js.org/loaders/).
+
+To add a new loader, install it with `yarn add -D` and add it to the `webpackFinal` function in `.storybook/main.js`.
+
+### Add a new webpack plugin
+
+Webpack plugins are used to modify the webpack configuration in Storybook. You can find a list of plugins [here](https://webpack.js.org/plugins/).
+
+To add a new plugin, install it with `yarn add -D` and add it to the `webpackFinal` function in `.storybook/main.js`.
+
+### Add a new webpack alias
+
+Webpack aliases are used to create shortcuts to import files in Storybook. You can find more information about aliases [here](https://webpack.js.org/configuration/resolve/#resolvealias).
+
+To add a new alias, add it to the `webpackFinal` function in `.storybook/main.js`.
+
+### Configure the Storybook UI
+
+The Storybook UI can be configured in `.storybook/preview.js` and `preview-head.html`.
+
+## For more information about Storybook
+
+See the [official documentation](https://storybook.js.org/docs/react/get-started/introduction).

package/dist/components/AccountSelectBox/AccountSelectorHeader.js

@@ -26,7 +26,7 @@ export var AccountSelectorHeader = function AccountSelectorHeader(_ref) {
 
   return /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(DialogBackButton, {
     onClick: function onClick() {
-      return replaceHistory("/accounts/".concat(account._id));
+      return replaceHistory("/accounts/".concat(String(account._id)));
     }
   }), /*#__PURE__*/React.createElement(DialogTitle, _extends({}, rest, {
     className: cx('dialogTitleWithBack dialogTitleWithClose', // eslint-disable-next-line @typescript-eslint/no-unsafe-argument

package/dist/components/AccountSelectBox/AccountSelectorHeader.stories.js

@@ -0,0 +1,31 @@
+import { AccountSelectorHeader } from './AccountSelectorHeader';
+import { AccountSelectorHeaderFixtures } from '../../../.storybook/fixtures/AccountSelectorHeader.fixtures';
+var meta = {
+  component: AccountSelectorHeader,
+  argTypes: {
+    replaceHistory: {
+      action: 'replaceHistory'
+    },
+    pushHistory: {
+      action: 'pushHistory'
+    }
+  },
+  args: {
+    account: AccountSelectorHeaderFixtures.account,
+    accountsAndTriggers: AccountSelectorHeaderFixtures.accountsAndTriggers,
+    konnector: AccountSelectorHeaderFixtures.konnector
+  }
+};
+export default meta;
+export var WithAccountSelection = {
+  name: 'With account selection',
+  args: {
+    showAccountSelection: true
+  }
+};
+export var WithoutAccountSelection = {
+  name: 'Without account selection',
+  args: {
+    showAccountSelection: false
+  }
+};