Merge pull request #56 from x0k/omit-extra-data

Omit extra data

Author: x0k

.changeset/late-roses-cheat.md

@@ -0,0 +1,5 @@
+---
+"@sjsf/form": minor
+---
+
+Add omit extra data submodule

.changeset/ten-gorillas-accept.md

@@ -0,0 +1,5 @@
+---
+"docs": patch
+---
+
+Update state transformation guide

.changeset/twelve-papayas-reply.md

@@ -0,0 +1,5 @@
+---
+"@sjsf/sveltekit": patch
+---
+
+Reuse core schema utils

apps/docs/src/content/docs/advanced/state-transformation.mdx

@@ -16,10 +16,7 @@ For this you can use `omitExtraData` function.
 
 :::note
 
-Currently function `omitExtraData` is imported from `@sjsf/form/legacy-omit-extra-data` and
-will be deprecated because it's implementation does not meet the requirements of our code base.
-
-It will be replaced with `@sjsf/form/omit-extra-data` import in the major release.
+The `omitExtraData` function does not perform data validation!
 
 :::
 
@@ -29,11 +26,10 @@ It will be replaced with `@sjsf/form/omit-extra-data` import in the major releas
   import { createForm3 } from "@sjsf/form";
   import { translation } from "@sjsf/form/translations/en";
   import { theme } from "@sjsf/form/basic-theme";
-  import { omitExtraData2 } from "@sjsf/form/legacy-omit-extra-data";
+  import { omitExtraData } from "@sjsf/form/omit-extra-data";
 
   import { schema, uiSchema, initialValue } from "./schema";
   import { validator } from "./validator";
-  import { transform } from "./transform";
   
   const form = createForm3({
     ...theme,
@@ -43,7 +39,7 @@ It will be replaced with `@sjsf/form/omit-extra-data` import in the major releas
     validator,
     translation,
     getSnapshot() {
-      return omitExtraData2(validator, defaultMerger, schema, $state.snapshot(form.formValue))
+      return omitExtraData(validator, defaultMerger, schema, $state.snapshot(form.formValue))
     },
     onSubmit(value) {
       console.log("transformed", value);

packages/form/package.json

@@ -82,6 +82,10 @@
       "types": "./dist/focus-on-first-error.d.ts",
       "svelte": "./dist/focus-on-first-error.js"
     },
+    "./omit-extra-data": {
+      "types": "./dist/omit-extra-data.d.ts",
+      "default": "./dist/omit-extra-data.js"
+    },
     "./legacy-omit-extra-data": {
       "types": "./dist/legacy-omit-extra-data.d.ts",
       "default": "./dist/legacy-omit-extra-data.js"

packages/form/src/core/definitions.ts

@@ -4,24 +4,37 @@
 
 import jsonpointer from "jsonpointer";
 
-import { REF_KEY, type Schema } from "./schema.js";
+import {
+  isSchema,
+  REF_KEY,
+  type Schema,
+  type SchemaDefinition,
+} from "./schema.js";
 import { mergeSchemas } from "./merge.js";
 
-export function findSchemaDefinition(
-  ref: string,
-  rootSchema: Schema,
-  stack = new Set<string>()
-): Schema {
+export function resolveRef(ref: string, rootSchema: Schema) {
   if (!ref.startsWith("#")) {
     throw new Error(`Invalid reference: ${ref}, must start with #`);
   }
-  const current: Schema | undefined = jsonpointer.get(
+  const schemaDef: SchemaDefinition | undefined = jsonpointer.get(
     rootSchema,
     decodeURIComponent(ref.substring(1))
   );
-  if (current === undefined) {
+  if (schemaDef === undefined) {
     throw new Error(`Could not find a definition for ${ref}.`);
   }
+  return schemaDef;
+}
+
+export function findSchemaDefinition(
+  ref: string,
+  rootSchema: Schema,
+  stack = new Set<string>()
+): Schema {
+  const current = resolveRef(ref, rootSchema);
+  if (!isSchema(current)) {
+    throw new Error(`Definition for ${ref} should be a schema (object)`);
+  }
   const nextRef = current[REF_KEY];
   if (nextRef) {
     // Check for circular references.

packages/form/src/core/index.ts

@@ -6,6 +6,7 @@ export * from "./value.js";
 export * from "./is-select.js";
 export * from "./default-state.js";
 export * from "./merge.js";
+export * from "./definitions.js";
 export * from "./order-properties.js";
 export * from "./is-additional-property.js";
 export * from "./is-file-schema.js";
@@ -25,3 +26,4 @@ export * from "./schema-value-traverser.js";
 export * from "./schema-transformer.js";
 export * from "./path.js";
 export * from "./deep-equal.js";
+export * from "./known-properties.js";

packages/form/src/core/known-properties.ts

@@ -0,0 +1,41 @@
+import { resolveRef } from "./definitions.js";
+import { isSchema, type Schema } from "./schema.js";
+
+export function* getKnownProperties(
+  { $ref: ref, properties, dependencies, oneOf, allOf, anyOf }: Schema,
+  rootSchema: Schema,
+  stack = new Set<string>()
+): Generator<string> {
+  if (ref) {
+    if (stack.has(ref)) {
+      return;
+    }
+    stack.add(ref);
+    const resolved = resolveRef(ref, rootSchema);
+    if (isSchema(resolved)) {
+      yield* getKnownProperties(resolved, rootSchema, stack);
+    }
+    return;
+  }
+  if (properties) {
+    for (const key of Object.keys(properties)) {
+      yield key;
+    }
+  }
+  for (const alternatives of [oneOf, allOf, anyOf]) {
+    if (Array.isArray(alternatives)) {
+      for (const alternative of alternatives) {
+        if (isSchema(alternative)) {
+          yield* getKnownProperties(alternative, rootSchema, stack);
+        }
+      }
+    }
+  }
+  if (dependencies !== undefined) {
+    for (const dependency of Object.values(dependencies)) {
+      if (!Array.isArray(dependency) && isSchema(dependency)) {
+        yield* getKnownProperties(dependency, rootSchema, stack);
+      }
+    }
+  }
+}

packages/form/src/core/type.ts

@@ -1,4 +1,4 @@
-import type { Schema, SchemaType } from "./schema.js";
+import { isSchema, type Schema, type SchemaType } from "./schema.js";
 
 export function typeOfValue(
   value: null | boolean | number | string | object
@@ -29,12 +29,29 @@ export function typeOfSchema(schema: Schema): SchemaType | SchemaType[] {
   if (schema.const !== undefined) {
     return typeOfValue(schema.const);
   }
-  if (schema.properties || schema.additionalProperties) {
+  if (
+    schema.properties ||
+    schema.additionalProperties ||
+    schema.propertyNames ||
+    schema.patternProperties
+  ) {
     return "object";
   }
   if (Array.isArray(schema.enum) && schema.enum.length > 0) {
     return Array.from(new Set(schema.enum.map(typeOfValue)));
   }
+  const alt = schema.allOf ?? schema.anyOf ?? schema.oneOf;
+  if (alt) {
+    let types: SchemaType[] = [];
+    for (let i = 0; i < alt.length; i++) {
+      const item = alt[i]!;
+      if (!isSchema(item)) {
+        continue;
+      }
+      types = types.concat(typeOfSchema(item));
+    }
+    return Array.from(new Set(types));
+  }
   return "null";
 }
 

packages/form/src/legacy-omit-extra-data.ts

@@ -73,6 +73,9 @@ export function omitExtraData(
   return omitExtraData2(validator, merger, schema, formData);
 }
 
+/**
+ * @deprecated use `omitExtraData` from `form/omit-extra-data` instead
+ */
 export function omitExtraData2(
   validator: Validator,
   merger: Merger2,