@scm-manager/ui-forms 2.40.2-SNAPSHOT-1

package/src/input/InputField.tsx

@@ -0,0 +1,60 @@
+/*
+ * 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 Input from "./Input";
+import Help from "../base/help/Help";
+
+type InputFieldProps = {
+  label: string;
+  helpText?: string;
+  error?: string;
+  type?: "text" | "password" | "email" | "tel";
+} & Omit<React.ComponentProps<typeof Input>, "type">;
+
+/**
+ * @see https://bulma.io/documentation/form/input/
+ */
+const InputField = React.forwardRef<HTMLInputElement, InputFieldProps>(
+  ({ 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>
+          <Input variant={variant} ref={ref} {...props}></Input>
+        </Control>
+        {error ? <FieldMessage variant={variant}>{error}</FieldMessage> : null}
+      </Field>
+    );
+  }
+);
+export default InputField;

package/src/resourceHooks.ts

@@ -0,0 +1,155 @@
+/*
+ * 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 { apiClient, requiredLink } from "@scm-manager/ui-api";
+import { useMutation, useQueryClient } from "react-query";
+import { HalRepresentation, Link } from "@scm-manager/ui-types";
+
+type QueryKeyPair = [singular: string, plural: string];
+type LinkOrHalLink = string | [entity: HalRepresentation, link: string] | HalRepresentation;
+const unwrapLink = (input: LinkOrHalLink, linkName: string) => {
+  if (Array.isArray(input)) {
+    return requiredLink(input[0], input[1]);
+  } else if (typeof input === "string") {
+    return input;
+  } else {
+    return (input._links[linkName] as Link).href;
+  }
+};
+
+type MutationResult<I, O = unknown> = {
+  submit: (resource: I) => Promise<O>;
+  isLoading: boolean;
+  error: Error | null;
+  submissionResult?: O;
+};
+
+type MutatingResourceOptions = {
+  contentType?: string;
+};
+
+const createResource = <I, O = never>(link: string, contentType: string) => {
+  return (payload: I): Promise<O> => {
+    return apiClient
+      .post(link, payload, contentType)
+      .then((response) => {
+        const location = response.headers.get("Location");
+        if (!location) {
+          throw new Error("Server does not return required Location header");
+        }
+        return apiClient.get(location);
+      })
+      .then((response) => response.json());
+  };
+};
+
+type CreateResourceOptions = MutatingResourceOptions;
+
+/** @Beta */
+export const useCreateResource = <I, O>(
+  link: string,
+  [entityKey, collectionName]: QueryKeyPair,
+  idFactory: (createdResource: O) => string,
+  { contentType = "application/json" }: CreateResourceOptions = {}
+): MutationResult<I, O> => {
+  const queryClient = useQueryClient();
+  const { mutateAsync, data, isLoading, error } = useMutation<O, Error, I>(createResource<I, O>(link, contentType), {
+    onSuccess: (result) => {
+      queryClient.setQueryData([entityKey, idFactory(result)], result);
+      return queryClient.invalidateQueries(collectionName);
+    },
+  });
+  return {
+    submit: (payload: I) => mutateAsync(payload),
+    isLoading,
+    error,
+    submissionResult: data,
+  };
+};
+
+type UpdateResourceOptions = MutatingResourceOptions & {
+  collectionName?: QueryKeyPair;
+};
+
+/** @Beta */
+export const useUpdateResource = <T>(
+  link: LinkOrHalLink,
+  idFactory: (createdResource: T) => string,
+  {
+    contentType = "application/json",
+    collectionName: [entityQueryKey, collectionName] = ["", ""],
+  }: UpdateResourceOptions = {}
+): MutationResult<T> => {
+  const queryClient = useQueryClient();
+  const { mutateAsync, isLoading, error, data } = useMutation<unknown, Error, T>(
+    (resource) => apiClient.put(unwrapLink(link, "update"), resource, contentType),
+    {
+      onSuccess: async (_, payload) => {
+        await queryClient.invalidateQueries(entityQueryKey ? [entityQueryKey, idFactory(payload)] : idFactory(payload));
+        if (collectionName) {
+          await queryClient.invalidateQueries(collectionName);
+        }
+      },
+    }
+  );
+  return {
+    submit: (resource: T) => mutateAsync(resource),
+    isLoading,
+    error,
+    submissionResult: data,
+  };
+};
+
+type DeleteResourceOptions = {
+  collectionName?: QueryKeyPair;
+};
+
+/** @Beta */
+export const useDeleteResource = <T extends HalRepresentation>(
+  idFactory: (createdResource: T) => string,
+  { collectionName: [entityQueryKey, collectionName] = ["", ""] }: DeleteResourceOptions = {}
+): MutationResult<T> => {
+  const queryClient = useQueryClient();
+  const { mutateAsync, isLoading, error, data } = useMutation<unknown, Error, T>(
+    (resource) => {
+      const deleteUrl = (resource._links.delete as Link).href;
+      return apiClient.delete(deleteUrl);
+    },
+    {
+      onSuccess: async (_, resource) => {
+        const id = idFactory(resource);
+        await queryClient.removeQueries(entityQueryKey ? [entityQueryKey, id] : id);
+        if (collectionName) {
+          await queryClient.invalidateQueries(collectionName);
+        }
+      },
+    }
+  );
+  return {
+    submit: (resource: T) => mutateAsync(resource),
+    isLoading,
+    error,
+    submissionResult: data,
+  };
+};

package/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;

package/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;

package/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;

package/src/variants.ts

@@ -0,0 +1,27 @@
+/*
+ * 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.
+ */
+
+export const variants = ["danger"] as const;
+export type Variant = typeof variants[number];
+export const createVariantClass = (variant?: Variant) => (variant ? `is-${variant}` : undefined);

package/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "@scm-manager/tsconfig"
+}