Add ConfigurationAdapterBase and extension points for trash bin

Adds the new abstract class ConfigurationAdapterBase to simplify the creation of global configuration views. In addition there is some cleanup, interfaces and extension points for the repository trash bin plugin.

Committed-by: Eduard Heimbuch <eduard.heimbuch@cloudogu.com>
Co-authored-by: Eduard Heimbuch <eduard.heimbuch@cloudogu.com>
Co-authored-by: René Pfeuffer <rene.pfeuffer@cloudogu.com>
Co-authored-by: Konstantin Schaper <konstantin.schaper@cloudogu.com>

scm-ui/ui-forms/src/ConfigurationForm.tsx

@@ -0,0 +1,54 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2020-present Cloudogu GmbH and Contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+import {useConfigLink} from "@scm-manager/ui-api";
+import {Loading} from "@scm-manager/ui-components";
+import React, {ComponentProps} from "react";
+import {HalRepresentation} from "@scm-manager/ui-types";
+import Form from "./Form";
+
+type Props<T extends HalRepresentation> = Pick<ComponentProps<typeof Form<T, T>>, "translationPath" | "children"> & {
+  link: string;
+};
+
+/** @Beta */
+export function ConfigurationForm<T extends HalRepresentation>({link, translationPath, children}: Props<T>) {
+  const {initialConfiguration, isReadOnly, update, isLoading} = useConfigLink<T>(link);
+
+  if (isLoading || !initialConfiguration) {
+    return <Loading/>;
+  }
+
+  return (
+    <Form<T, T>
+      onSubmit={update}
+      translationPath={translationPath}
+      defaultValues={initialConfiguration}
+      readOnly={isReadOnly}
+    >
+      {children}
+    </Form>
+  );
+}
+
+export default ConfigurationForm;

scm-ui/ui-forms/src/Form.tsx

@@ -33,6 +33,7 @@ import ControlledInputField from "./input/ControlledInputField";
 import ControlledCheckboxField from "./checkbox/ControlledCheckboxField";
 import ControlledSecretConfirmationField from "./input/ControlledSecretConfirmationField";
 import { HalRepresentation } from "@scm-manager/ui-types";
+import ControlledSelectField from "./select/ControlledSelectField";
 
 type RenderProps<T extends Record<string, unknown>> = Omit<
   UseFormReturn<T>,
@@ -61,6 +62,7 @@ type Props<FormType extends Record<string, unknown>, DefaultValues extends FormT
   submitButtonTestId?: string;
 };
 
+/** @Beta */
 function Form<FormType extends Record<string, unknown>, DefaultValues extends FormType>({
   children,
   onSubmit,
@@ -84,11 +86,11 @@ function Form<FormType extends Record<string, unknown>, DefaultValues extends Fo
   useEffect(() => {
     if (isSubmitSuccessful) {
       setShowSuccessNotification(true);
-      reset(defaultValues as never);
     }
-    /* eslint-disable-next-line react-hooks/exhaustive-deps */
   }, [isSubmitSuccessful]);
 
+  useEffect(() => reset(defaultValues as never), [defaultValues, reset]);
+
   useEffect(() => {
     if (isDirty) {
       setShowSuccessNotification(false);
@@ -158,4 +160,5 @@ export default Object.assign(Form, {
   Input: ControlledInputField,
   Checkbox: ControlledCheckboxField,
   SecretConfirmation: ControlledSecretConfirmationField,
+  Select: ControlledSelectField,
 });

scm-ui/ui-forms/src/index.ts

@@ -23,4 +23,5 @@
  */
 
 export { default as Form } from "./Form";
+export { default as ConfigurationForm } from "./ConfigurationForm";
 export * from "./resourceHooks";

scm-ui/ui-forms/src/resourceHooks.ts

@@ -66,6 +66,7 @@ const createResource = <I, O = never>(link: string, contentType: string) => {
 
 type CreateResourceOptions = MutatingResourceOptions;
 
+/** @Beta */
 export const useCreateResource = <I, O>(
   link: string,
   [entityKey, collectionName]: QueryKeyPair,
@@ -91,6 +92,7 @@ type UpdateResourceOptions = MutatingResourceOptions & {
   collectionName?: QueryKeyPair;
 };
 
+/** @Beta */
 export const useUpdateResource = <T>(
   link: LinkOrHalLink,
   idFactory: (createdResource: T) => string,
@@ -123,6 +125,7 @@ type DeleteResourceOptions = {
   collectionName?: QueryKeyPair;
 };
 
+/** @Beta */
 export const useDeleteResource = <T extends HalRepresentation>(
   idFactory: (createdResource: T) => string,
   { collectionName: [entityQueryKey, collectionName] = ["", ""] }: DeleteResourceOptions = {}

scm-ui/ui-forms/src/select/ControlledSelectField.tsx

@@ -0,0 +1,77 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2020-present Cloudogu GmbH and Contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+import React, { ComponentProps } from "react";
+import { Controller, ControllerRenderProps, Path } from "react-hook-form";
+import classNames from "classnames";
+import { useScmFormContext } from "../ScmFormContext";
+import SelectField from "./SelectField";
+
+type Props<T extends Record<string, unknown>> = Omit<
+  ComponentProps<typeof SelectField>,
+  "error" | "label" | "required" | keyof ControllerRenderProps
+> & {
+  rules?: ComponentProps<typeof Controller>["rules"];
+  name: Path<T>;
+  label?: string;
+};
+
+function ControlledSelectField<T extends Record<string, unknown>>({
+  name,
+  label,
+  helpText,
+  rules,
+  className,
+  testId,
+  defaultValue,
+  readOnly,
+  ...props
+}: Props<T>) {
+  const { control, t, readOnly: formReadonly } = useScmFormContext();
+  const labelTranslation = label || t(`${name}.label`) || "";
+  const helpTextTranslation = helpText || t(`${name}.helpText`);
+  return (
+    <Controller
+      control={control}
+      name={name}
+      rules={rules}
+      defaultValue={defaultValue as never}
+      render={({ field, fieldState }) => (
+        <SelectField
+          className={classNames("column", className)}
+          readOnly={readOnly ?? formReadonly}
+          required={rules?.required as boolean}
+          {...props}
+          {...field}
+          label={labelTranslation}
+          helpText={helpTextTranslation}
+          error={fieldState.error ? fieldState.error.message || t(`${name}.error.${fieldState.error.type}`) : undefined}
+          testId={testId ?? `select-${name}`}
+        />
+      )}
+    />
+  );
+}
+
+export default ControlledSelectField;

scm-ui/ui-forms/src/select/Select.tsx

@@ -0,0 +1,43 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2020-present Cloudogu GmbH and Contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+import React, { InputHTMLAttributes } from "react";
+import classNames from "classnames";
+import { createVariantClass, Variant } from "../variants";
+import { createAttributesForTesting } from "@scm-manager/ui-components";
+
+type Props = {
+  variant?: Variant;
+  testId?: string;
+} & InputHTMLAttributes<HTMLSelectElement>;
+
+const Select = React.forwardRef<HTMLSelectElement, Props>(({ variant, children, className, testId, ...props }, ref) => (
+  <div className={classNames("select", { "is-multiple": props.multiple }, createVariantClass(variant), className)}>
+    <select ref={ref} {...props} {...createAttributesForTesting(testId)}>
+      {children}
+    </select>
+  </div>
+));
+
+export default Select;

scm-ui/ui-forms/src/select/SelectField.tsx

@@ -0,0 +1,59 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2020-present Cloudogu GmbH and Contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+import React from "react";
+import Field from "../base/Field";
+import Control from "../base/Control";
+import Label from "../base/label/Label";
+import FieldMessage from "../base/field-message/FieldMessage";
+import Help from "../base/help/Help";
+import Select from "./Select";
+
+type Props = {
+  label: string;
+  helpText?: string;
+  error?: string;
+} & React.ComponentProps<typeof Select>;
+
+/**
+ * @see https://bulma.io/documentation/form/select/
+ */
+const SelectField = React.forwardRef<HTMLSelectElement, Props>(
+  ({ label, helpText, error, className, ...props }, ref) => {
+    const variant = error ? "danger" : undefined;
+    return (
+      <Field className={className}>
+        <Label>
+          {label}
+          {helpText ? <Help className="ml-1" text={helpText} /> : null}
+        </Label>
+        <Control>
+          <Select variant={variant} ref={ref} {...props}></Select>
+        </Control>
+        {error ? <FieldMessage variant={variant}>{error}</FieldMessage> : null}
+      </Field>
+    );
+  }
+);
+export default SelectField;