@poirazis/supercomponents-shared 1.0.9 → 1.0.11

package/src/lib/SuperForm/SuperForm.svelte

@@ -0,0 +1,149 @@
+<script lang="ts">
+  import { getContext } from "svelte";
+  import InnerForm from "./InnerForm.svelte";
+  import { writable } from "svelte/store";
+  import type { FieldSchema } from "@budibase/types";
+
+  export let dataSource: any;
+  export let size: "Medium" | "Large" = "Medium";
+  export let disabled: boolean = false;
+  export let readonly: boolean = false;
+  export let actionType: "Create" | "Update" | "View" = "Create";
+  export let initialFormStep: string | number = 1;
+
+  // Not exposed as a builder setting. Used internally to disable validation
+  // for fields rendered in things like search blocks.
+  export let disableSchemaValidation: boolean = false;
+
+  // Not exposed as a builder setting. Used internally to allow searching on
+  // auto columns.
+  export let editAutoColumns: boolean = false;
+
+  const context = getContext("context");
+  const component = getContext("component");
+  const { fetchDatasourceSchema, fetchDatasourceDefinition } =
+    getContext("sdk");
+
+  const getInitialFormStep = () => {
+    const parsedFormStep = parseInt(initialFormStep.toString());
+    if (isNaN(parsedFormStep)) {
+      return 1;
+    }
+    return parsedFormStep;
+  };
+
+  let definition: any | undefined;
+  let schema: Record<string, FieldSchema> | undefined;
+  let loaded = false;
+  let currentStep =
+    getContext("current-step") || writable(getInitialFormStep());
+
+  $: fetchSchema(dataSource);
+  $: schemaKey = generateSchemaKey(schema);
+  $: initialValues = getInitialValues(
+    actionType,
+    dataSource,
+    $component.path,
+    $context
+  );
+  $: resetKey = hashString(
+    schemaKey + JSON.stringify(initialValues) + disabled + readonly
+  );
+
+  // Returns the closes data context which isn't a built in context
+  const getInitialValues = (
+    type: string,
+    dataSource: any,
+    path: string[],
+    context: Record<string, any>
+  ) => {
+    // Only inherit values for update forms
+    if (type !== "Update") {
+      return {};
+    }
+    // Only inherit values for forms targeting internal tables
+    const dsType = dataSource?.type;
+    if (dsType !== "table" && dsType !== "viewV2") {
+      return {};
+    }
+    // Look up the component tree and find something that is provided by an
+    // ancestor that matches our datasource. This is for backwards compatibility
+    // as previously we could use the "closest" context.
+    for (let id of [...path].reverse().slice(1)) {
+      // Check for matching view datasource
+      if (
+        dataSource.type === "viewV2" &&
+        context[id]?._viewId === dataSource.id
+      ) {
+        return context[id];
+      }
+      // Check for matching table datasource
+      if (
+        dataSource.type === "table" &&
+        context[id]?.tableId === dataSource.tableId
+      ) {
+        return context[id];
+      }
+    }
+    return {};
+  };
+
+  // Fetches the form schema from this form's dataSource
+  const fetchSchema = async (dataSource: any) => {
+    try {
+      definition = await fetchDatasourceDefinition(dataSource);
+    } catch (error) {
+      definition = undefined;
+    }
+    const res = await fetchDatasourceSchema(dataSource);
+    schema = res || {};
+    if (!loaded) {
+      loaded = true;
+    }
+  };
+
+  // Generates a predictable string that uniquely identifies a schema. We can't
+  // simply stringify the whole schema as there are array fields which have
+  // random order.
+  const generateSchemaKey = (
+    schema: Record<string, FieldSchema> | undefined
+  ) => {
+    if (!schema) {
+      return null;
+    }
+    const fields = Object.keys(schema);
+    fields.sort();
+    return fields.map((field) => `${field}:${schema[field].type}`).join("-");
+  };
+
+  // Helper function to generate a hash string from input
+  function hashString(str: string) {
+    let hash = 0;
+    if (str.length === 0) return hash.toString();
+    for (let i = 0; i < str.length; i++) {
+      const char = str.charCodeAt(i);
+      hash = (hash << 5) - hash + char;
+      hash = hash & hash; // Convert to 32bit integer
+    }
+    return hash.toString();
+  }
+</script>
+
+{#if loaded}
+  {#key resetKey}
+    <InnerForm
+      {dataSource}
+      {size}
+      {disabled}
+      {readonly}
+      {schema}
+      {definition}
+      {initialValues}
+      {disableSchemaValidation}
+      {editAutoColumns}
+      {currentStep}
+    >
+      <slot />
+    </InnerForm>
+  {/key}
+{/if}