@remoteoss/json-schema-form 0.11.0-dev.20240725074901 → 0.11.1-beta.0

package/CHANGELOG.md

@@ -1,8 +1,33 @@
+#### 0.11.1-beta.0 (2024-07-26)
+
+##### Chores
+
+* **modify:**  Add missing Typescript declarations ([#84](https://github.com/remoteoss/json-schema-form/pull/84)) ([86b3af2a](https://github.com/remoteoss/json-schema-form/commit/86b3af2a31981718ad349ac8d08fbdce3aa86acf))
+
+#### 0.11.0-beta.0 (2024-07-25)
+
+##### Breaking changes
+
+- **modify:**
+  - Change the return result to include warnings ([#83](https://github.com/remoteoss/json-schema-form/pull/83)) ([e07fcec8](https://github.com/remoteoss/json-schema-form/commit/e07fcec8e11cfcba2b477e5e6339cebbcc42038c))
+
+##### New Features
+
+- **modify:**
+  - Allow picking fields ([#79](https://github.com/remoteoss/json-schema-form/pull/79)) ([2e044021](https://github.com/remoteoss/json-schema-form/commit/2e044021f30292be81cede3805eefb4f1ea96dd9))
+  - Add x-jsf-presentation shorthand ([#81](https://github.com/remoteoss/json-schema-form/pull/81)) ([7cfaab0b](https://github.com/remoteoss/json-schema-form/commit/7cfaab0bdbb05a1555f6c1d74b26b1e6d7fa8c43))
+  - Allow creating fields ([#80](https://github.com/remoteoss/json-schema-form/pull/80)) ([8a82254d](https://github.com/remoteoss/json-schema-form/commit/8a82254d7cf5799471fa0bf2d3d09179f1327187))
+  - Allow customize fields order ([#78](https://github.com/remoteoss/json-schema-form/pull/78)) ([adc88179](https://github.com/remoteoss/json-schema-form/commit/adc88179a5d1e5bd85371c0cc581b35964bf6edf))
+
+##### Bug Fixes
+
+- **modify:** Customize attrs as Array now overrides the value ([#82](https://github.com/remoteoss/json-schema-form/pull/82)) ([7cc0853e](https://github.com/remoteoss/json-schema-form/commit/7cc0853e30f0c06ff160d8a3e4c4b4e402a1e520))
+
 #### 0.10.1-beta.0 (2024-07-23)
 
 ##### Chores
 
-* **Text field docs:**  Change naming of ID number property ([#74](https://github.com/remoteoss/json-schema-form/pull/74)) ([338ddd2a](https://github.com/remoteoss/json-schema-form/commit/338ddd2a5f008ec089f38db834f075100b856001))
+- **Text field docs:** Change naming of ID number property ([#74](https://github.com/remoteoss/json-schema-form/pull/74)) ([338ddd2a](https://github.com/remoteoss/json-schema-form/commit/338ddd2a5f008ec089f38db834f075100b856001))
 
 #### 0.10.0-beta.0 (2024-06-20)
 

package/dist/index.cjs

@@ -1,8 +1,8 @@
 
 /*!
  Copyright (c) 2024 Remote Technology, Inc.
- NPM Package: @remoteoss/json-schema-form@0.11.0-dev.20240725074901
- Generated: Thu, 25 Jul 2024 07:49:16 GMT
+ NPM Package: @remoteoss/json-schema-form@0.11.1-beta.0
+ Generated: Fri, 26 Jul 2024 12:33:47 GMT
 
  MIT License
 
@@ -1853,9 +1853,10 @@ function mergeReplaceArray(_, newVal) {
   return Array.isArray(newVal) ? newVal : void 0;
 }
 function standardizeAttrs(attrs) {
-  const { errorMessage, properties, ...rest } = attrs;
+  const { errorMessage, presentation, properties, ...rest } = attrs;
   return {
     ...rest,
+    ...presentation ? { "x-jsf-presentation": presentation } : {},
     ...errorMessage ? { "x-jsf-errorMessage": errorMessage } : {}
   };
 }
@@ -2025,9 +2026,9 @@ function pickFields(originalSchema, fieldsToPick) {
     });
     warnings.push({
       type: WARNING_TYPES.PICK_MISSED_FIELD,
-      message: `The picked fields have related conditional fields that got added automatically. ${Object.keys(
+      message: `The picked fields are in conditionals that refeer other fields. They added automatically: ${Object.keys(
         missingFields
-      ).join(", ")}. Check "meta" for more details.`,
+      ).map((name) => `"${name}"`).join(", ")}. Check "meta" for more details.`,
       meta: missingFields
     });
   }

package/dist/index.js

@@ -1,8 +1,8 @@
 
 /*!
  Copyright (c) 2024 Remote Technology, Inc.
- NPM Package: @remoteoss/json-schema-form@0.11.0-dev.20240725074901
- Generated: Thu, 25 Jul 2024 07:49:16 GMT
+ NPM Package: @remoteoss/json-schema-form@0.11.1-beta.0
+ Generated: Fri, 26 Jul 2024 12:33:47 GMT
 
  MIT License
 
@@ -1816,9 +1816,10 @@ function mergeReplaceArray(_, newVal) {
   return Array.isArray(newVal) ? newVal : void 0;
 }
 function standardizeAttrs(attrs) {
-  const { errorMessage, properties, ...rest } = attrs;
+  const { errorMessage, presentation, properties, ...rest } = attrs;
   return {
     ...rest,
+    ...presentation ? { "x-jsf-presentation": presentation } : {},
     ...errorMessage ? { "x-jsf-errorMessage": errorMessage } : {}
   };
 }
@@ -1988,9 +1989,9 @@ function pickFields(originalSchema, fieldsToPick) {
     });
     warnings.push({
       type: WARNING_TYPES.PICK_MISSED_FIELD,
-      message: `The picked fields have related conditional fields that got added automatically. ${Object.keys(
+      message: `The picked fields are in conditionals that refeer other fields. They added automatically: ${Object.keys(
         missingFields
-      ).join(", ")}. Check "meta" for more details.`,
+      ).map((name) => `"${name}"`).join(", ")}. Check "meta" for more details.`,
       meta: missingFields
     });
   }

package/dist/standalone.js

@@ -1,8 +1,8 @@
 
 /*!
  Copyright (c) 2024 Remote Technology, Inc.
- NPM Package: @remoteoss/json-schema-form@0.11.0-dev.20240725074901
- Generated: Thu, 25 Jul 2024 07:49:16 GMT
+ NPM Package: @remoteoss/json-schema-form@0.11.1-beta.0
+ Generated: Fri, 26 Jul 2024 12:33:47 GMT
 
  MIT License
 
@@ -13332,9 +13332,10 @@ function mergeReplaceArray(_, newVal) {
   return Array.isArray(newVal) ? newVal : void 0;
 }
 function standardizeAttrs(attrs) {
-  const { errorMessage, properties, ...rest } = attrs;
+  const { errorMessage, presentation, properties, ...rest } = attrs;
   return {
     ...rest,
+    ...presentation ? { "x-jsf-presentation": presentation } : {},
     ...errorMessage ? { "x-jsf-errorMessage": errorMessage } : {}
   };
 }
@@ -13504,9 +13505,9 @@ function pickFields(originalSchema, fieldsToPick) {
     });
     warnings.push({
       type: WARNING_TYPES.PICK_MISSED_FIELD,
-      message: `The picked fields have related conditional fields that got added automatically. ${Object.keys(
+      message: `The picked fields are in conditionals that refeer other fields. They added automatically: ${Object.keys(
         missingFields
-      ).join(", ")}. Check "meta" for more details.`,
+      ).map((name) => `"${name}"`).join(", ")}. Check "meta" for more details.`,
       meta: missingFields
     });
   }

package/json-schema-form.d.ts

@@ -2,7 +2,6 @@
  * Shorthand to lookup for keys with `x-jsf-*` preffix.
  */
 export function pickXKey(node: Object, key: 'presentation' | 'errorMessage'): Object | undefined;
-
 type ValidationTypes =
   | 'type'
   | 'minimum'
@@ -104,6 +103,54 @@ type HeadlessFormOutput = {
 };
 
 type JSONSchemaObjectType = Record<string, unknown>;
+type FieldName = string;
+type FieldAttrs = Record<string, unknown>;
+
+type FieldAttrsCallbackFn = (fieldName: FieldName, fieldAttrs: FieldAttrs) => FieldAttrs;
+
+type ModConfigProperties = Record<FieldName, FieldAttrs | FieldAttrsCallbackFn>;
+
+type ModifyConfig = {
+  /**
+   * An object with the fields to be modified with the returned attributes.
+   */
+  fields?: ModConfigProperties;
+  /**
+   * A callback function that runs through all fields, to modify them with the returned attributes.
+   */
+  allFields?: FieldAttrsCallbackFn;
+  /**
+   * An object of new fields to be created with the new attributes.
+   */
+  create?: ModConfigProperties;
+  /**
+   * An array of the fields to keep, removing the remaining fields.
+   */
+  pick?: FieldName[];
+  /* An array of fieldNames with the new order. Can be an object or callback function */
+  orderRoot?: FieldName[] | ((originalOrder: FieldName[]) => FieldName[]);
+  /**
+   * Mutes any logs or warnings from the library.
+   */
+  muteLogging?: boolean;
+};
+
+type WarningType =
+  | 'FIELD_TO_CHANGE_NOT_FOUND'
+  | 'ORDER_MISSING_FIELDS'
+  | 'FIELD_TO_CREATE_EXISTS'
+  | 'PICK_MISSED_FIELD';
+
+type Warning = {
+  message: string;
+  type: WarningType;
+  meta?: Record<string, unknown>;
+};
+
+type ModifyOutput = {
+  schema: JSONSchemaObjectType;
+  warnings: Warning[];
+};
 
 /**
  * Generates the Headless form based on the provided JSON schema
@@ -114,27 +161,17 @@ export function createHeadlessForm(
   customConfig?: JSFConfig
 ): HeadlessFormOutput;
 
-type MutationsConfig = {
-  /**
-   * An object with the list of fields to be mutated.
-   */
-  fields: Record<string, unknown>;
-  /**
-   * a callback function that applies a mutation to all the fields.
-   * @param fieldName
-   * @param fieldAttrs
-   * @returns
-   */
-  allFields: (fieldName: string, fieldAttrs: Record<string, unknown>) => Record<string, unknown>;
-};
-
+/**
+ * Returns a new JSON Schema modified based a given configuration.
+ * This does not mutate the original JSON Schema.
+ */
 export function modify(
   /**
-   * The original JSON schema to be modified.
+   * The original JSON schema as base to the modifications.
    */
   originalSchema: JSONSchemaObjectType,
   /**
-   * The configuration object containing the fields and allFields properties.
+   * The configuration object to create a new JSON Schema based on the originalSchema.
    */
-  config?: MutationsConfig
-);
+  config?: ModifyConfig
+): ModifyOutput;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remoteoss/json-schema-form",
-  "version": "0.11.0-dev.20240725074901",
+  "version": "0.11.1-beta.0",
   "description": "Headless UI form powered by JSON Schemas",
   "author": "Remote.com <engineering@remote.com> (https://remote.com/)",
   "license": "MIT",

package/src/tests/modify.test.js

@@ -53,6 +53,9 @@ const schemaPet = {
       properties: {
         street: {
           title: 'Street',
+          'x-jsf-presentation': {
+            inputType: 'text',
+          },
         },
       },
     },
@@ -356,7 +359,7 @@ describe('modify() - basic mutations', () => {
     });
   });
 
-  it('error message', () => {
+  it('customize x-jsf-errorMessage (shorthand)', () => {
     const result = modify(schemaPet, {
       fields: {
         pet_age: (fieldAttrs) => {
@@ -396,6 +399,53 @@ describe('modify() - basic mutations', () => {
       },
     });
   });
+
+  it('customize x-jsf-presentation (shorthand)', () => {
+    const result = modify(schemaPet, {
+      fields: {
+        pet_age: () => {
+          return {
+            presentation: {
+              'data-foo': 123,
+            },
+          };
+        },
+        'pet_address.street': {
+          presentation: {
+            'data-foo': 456,
+          },
+        },
+      },
+    });
+
+    const originalPetAgePresentation = schemaPet.properties.pet_age['x-jsf-presentation'];
+    expect(originalPetAgePresentation).toBeDefined();
+
+    const originalPetStreetPresentation =
+      schemaPet.properties.pet_address.properties.street['x-jsf-presentation'];
+    expect(originalPetStreetPresentation).toBeDefined();
+
+    expect(result.schema).toMatchObject({
+      properties: {
+        pet_age: {
+          'x-jsf-presentation': {
+            ...originalPetAgePresentation,
+            'data-foo': 123,
+          },
+        },
+        pet_address: {
+          properties: {
+            street: {
+              'x-jsf-presentation': {
+                ...originalPetStreetPresentation,
+                'data-foo': 456,
+              },
+            },
+          },
+        },
+      },
+    });
+  });
 });
 
 const schemaTickets = {
@@ -700,7 +750,7 @@ describe('modify() - pick fields', () => {
       {
         type: 'PICK_MISSED_FIELD',
         message:
-          'The picked fields have related conditional fields that got added automatically. premium_id, reason. Check "meta" for more details.',
+          'The picked fields are in conditionals that refeer other fields. They added automatically: "premium_id", "reason". Check "meta" for more details.',
         meta: { premium_id: { path: 'allOf[1].then' }, reason: { path: 'allOf[2].then' } },
       },
     ]);
@@ -729,7 +779,7 @@ describe('modify() - pick fields', () => {
       {
         type: 'PICK_MISSED_FIELD',
         message:
-          'The picked fields have related conditional fields that got added automatically. has_premium. Check "meta" for more details.',
+          'The picked fields are in conditionals that refeer other fields. They added automatically: "has_premium". Check "meta" for more details.',
         meta: { has_premium: { path: 'allOf[1].if' } },
       },
     ]);