Merge pull request #22 from Opetushallitus/OK-673

OK-673

.github/workflows/build.yml

@@ -4,6 +4,11 @@ on:
   push:
     paths-ignore:
       - '**.md'
+
+concurrency:
+  group: ${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
 env:
   AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
   AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}

.gitignore

@@ -1,7 +1,6 @@
 node_modules
 .next
 storybook-static
-dist
 lcov-report
 coverage
 __snapshots__/__diff_output__

.prettierignore

@@ -5,3 +5,4 @@ storybook-static
 node_modules
 lcov
 coverage
+dist

README.md

@@ -31,7 +31,7 @@ Varmista myös, että vertaisriippuvuudet (peer dependency) on asennettu:
   "peerDependencies": {
     "@mui/material": "^6",
     "next": "^14 || ^15", // Pakollinen vain, jos käytät Next.js:ää
-    "react": "^18"
+    "react": "^18 || ^19"
   }
 }
 ```
@@ -173,7 +173,8 @@ Komponenttikirjaston jakeluversio muodostetaan komennolla:
 npm run build
 ```
 
-Komento muodostaa EcmaScript-moduulit `/dist`-hakemistoon käyttäen [tsup-työkalua](https://tsup.egoist.dev/). Kyseinen komento ajetaan myös aina kun tämän projektin riippuvuudet asennetaan (prepare-skripti package.json-tiedostossa). Tämä on välttämätöntä, että komponenttikirjastoa voi käyttää riippuvuutena. [Package.json-tiedoston](./package.json) export-kentässä on määritelty moduulit, jotka jakeluversio tarjoaa.
+Komento muodostaa EcmaScript-moduulit `/dist`-hakemistoon käyttäen [tsup-työkalua](https://tsup.egoist.dev/). [Package.json-tiedoston](./package.json) export-kentässä on määritelty moduulit, jotka jakeluversio tarjoaa.
+Jakeluversion tiedostot on lisätty myös Git-säilöön `/dist`-hakemistoon, jotta komentoa ei tarvitse ajaa kirjaston asennuksen yhteydessä.
 
 ## Esimerkkiprojekti
 

dist/OphButton.d.ts

@@ -0,0 +1,5 @@
+import { Button } from '@mui/material';
+
+declare const OphButton: typeof Button;
+
+export { OphButton };

dist/OphCheckbox.d.ts

@@ -0,0 +1,11 @@
+import { CheckboxProps, FormControlLabelProps } from '@mui/material';
+import react__default from 'react';
+
+type OphCheckboxProps = Omit<CheckboxProps, 'centerRipple' | 'checkedIcon' | 'disableRipple' | 'icon' | 'indeterminateIcon' | 'size' | 'LinkComponent'> & {
+    formControlLabelProps?: Omit<FormControlLabelProps, 'label' | 'control'>;
+    label?: react__default.ReactNode;
+    error?: boolean;
+};
+declare const OphCheckbox: react__default.ForwardRefExoticComponent<Omit<OphCheckboxProps, "ref"> & react__default.RefAttributes<HTMLButtonElement>>;
+
+export { OphCheckbox, type OphCheckboxProps };

dist/OphLink.d.ts

@@ -0,0 +1,22 @@
+import { LinkOwnProps, Theme } from '@mui/material';
+import { SystemProps } from '@mui/system';
+import { OverridableComponent, OverrideProps } from '@mui/material/OverridableComponent';
+
+type OmittedPropNames = keyof SystemProps<Theme> | 'paragraph' | 'TypographyClasses' | 'variantMapping' | 'align' | 'gutterBottom' | 'underline';
+interface OphAdditionalLinkProps {
+    /** Icon visibility override. If not given, icon visibility is deduced from href (relative links without icon) */
+    iconVisible?: boolean;
+}
+interface OphLinkTypeMap<AdditionalProps = {}, RootComponent extends React.ElementType = 'a'> {
+    props: AdditionalProps & Omit<LinkOwnProps, OmittedPropNames>;
+    defaultComponent: RootComponent;
+}
+type MuiOphLinkProps<RootComponent extends React.ElementType = OphLinkTypeMap['defaultComponent'], AdditionalProps = {}> = OverrideProps<OphLinkTypeMap<AdditionalProps, RootComponent>, RootComponent> & {
+    component?: React.ElementType;
+};
+type OphLinkProps<C extends React.ElementType = React.ElementType, D extends React.ElementType = OphLinkTypeMap['defaultComponent']> = {
+    component?: C;
+} & Omit<MuiOphLinkProps<D, OphAdditionalLinkProps>, 'component'>;
+declare const OphLink: OverridableComponent<OphLinkTypeMap<OphLinkProps>>;
+
+export { OphLink, type OphLinkProps };

dist/OphSelect.d.ts

@@ -0,0 +1,16 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { SelectProps } from '@mui/material';
+
+type OphSelectValue<T> = SelectProps<T>['value'];
+interface OphSelectOption<T> {
+    label: string;
+    value: OphSelectValue<T>;
+}
+interface OphSelectProps<T> extends Omit<SelectProps<T>, 'children' | 'label' | 'variant'> {
+    options: Array<OphSelectOption<T>>;
+    clearable?: boolean;
+    placeholder?: string;
+}
+declare const OphSelect: <T extends string>({ placeholder, clearable, options, ...props }: OphSelectProps<T | "">) => react_jsx_runtime.JSX.Element;
+
+export { OphSelect, type OphSelectOption, type OphSelectProps, type OphSelectValue };

dist/OphTypography.d.ts

@@ -0,0 +1,11 @@
+import * as react from 'react';
+import { TypographyProps, Theme } from '@mui/material';
+import { SystemProps } from '@mui/system';
+
+type OmittedSystemPropNames = keyof Omit<SystemProps<Theme>, 'color'>;
+type OphTypographyProps = Omit<TypographyProps & {
+    variant?: 'button' | 'body1' | 'body2' | 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'label';
+}, OmittedSystemPropNames | 'paragraph' | 'variantMapping'>;
+declare const OphTypography: react.ForwardRefExoticComponent<Omit<OphTypographyProps, "ref"> & react.RefAttributes<HTMLElement>>;
+
+export { OphTypography, type OphTypographyProps };