[fix] rjsf-team#4080

- Move `base64` encode/decoder object to playground, remove from utils - Add test script and config to playground
nickgros · Feb 16, 2024 · 3125910 · 3125910
1 parent 67f9c48
commit 3125910
Show file tree

Hide file tree

Showing 12 changed files with 32 additions and 38 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -22,6 +22,16 @@ should change the heading of the (upcoming) version to include a major version b
 
 - Added support for `UiSchema` `"ui:rows"` option for `textarea` elements, fixing [#4070](https://github.com/rjsf-team/react-jsonschema-form/issues/4070).
 
+# @rjsf/utils
+
+- [#4080](https://github.com/rjsf-team/react-jsonschema-form/issues/4080) - BREAKING CHANGE: Removed the `base64` object from the `@rjsf/utils` package. Note that this is a breaking change if you relied on the `base64` object exported by `@rjsf/utils`. Since this change caused [#4080](https://github.com/rjsf-team/react-jsonschema-form/issues/4080), and was only internally used by playground code, we are shipping this change in a patch release.
+
+## Dev / docs / playground
+
+- [#4080](https://github.com/rjsf-team/react-jsonschema-form/issues/4080) - Moved the `base64` encoder/decoder object to the Playground package. 
+- Added test configuration and script to the Playground. 
+
+
 # 5.17.0
 
 ## @rjsf/core

diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/playground/.babelrc b/packages/playground/.babelrc
diff --git a/packages/playground/babel.config.js b/packages/playground/babel.config.js
@@ -0,0 +1,3 @@
+const defaultConfig = require('../../babel.config');
+
+module.exports = defaultConfig;
diff --git a/packages/playground/jest.config.js b/packages/playground/jest.config.js
@@ -0,0 +1,6 @@
+module.exports = {
+  verbose: true,
+  testEnvironment: 'jsdom',
+  testMatch: ['**/test/**/*.test.[jt]s?(x)'],
+  transformIgnorePatterns: [`/node_modules/(?!nanoid)`],
+};
diff --git a/packages/playground/package.json b/packages/playground/package.json
@@ -3,7 +3,7 @@
   "version": "5.17.0",
   "description": "rjsf playground",
   "private": true,
-  "type": "module",
+  "type": "commonjs",
   "scripts": {
     "cs-check": "prettier -l \"src/**/*.ts?(x)\"",
     "cs-format": "prettier \"src/**/*.ts?(x)\" --write",
@@ -13,7 +13,8 @@
     "publish-to-gh-pages": "npm run build && gh-pages --dist build/",
     "publish-to-npm": "npm run build && npm publish",
     "start": "vite --force",
-    "preview": "vite preview"
+    "preview": "vite preview",
+    "test": "jest"
   },
   "lint-staged": {
     "src/**/*.ts?(x)": [
@@ -100,6 +101,8 @@
     "gh-pages": "^3.2.3",
     "html": "^1.0.0",
     "html-webpack-plugin": "^5.6.0",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
     "loader-utils": "^3.2.1",
     "mini-css-extract-plugin": "^2.8.0",
     "prettier": "^2.8.8",

diff --git a/packages/playground/src/components/Header.tsx b/packages/playground/src/components/Header.tsx
@@ -1,7 +1,8 @@
 import { useCallback } from 'react';
 import Form, { IChangeEvent } from '@rjsf/core';
-import { base64, RJSFSchema, UiSchema, ValidatorType } from '@rjsf/utils';
+import { RJSFSchema, UiSchema, ValidatorType } from '@rjsf/utils';
 import localValidator from '@rjsf/validator-ajv8';
+import base64 from '../utils/base64';
 
 import CopyLink from './CopyLink';
 import ThemeSelector, { ThemesType } from './ThemeSelector';

diff --git a/packages/playground/src/components/Playground.tsx b/packages/playground/src/components/Playground.tsx
@@ -1,6 +1,7 @@
 import { ComponentType, FormEvent, useCallback, useEffect, useRef, useState } from 'react';
 import { FormProps, IChangeEvent, withTheme } from '@rjsf/core';
-import { base64, ErrorSchema, RJSFSchema, RJSFValidationError, UiSchema, ValidatorType } from '@rjsf/utils';
+import { ErrorSchema, RJSFSchema, RJSFValidationError, UiSchema, ValidatorType } from '@rjsf/utils';
+import base64 from '../utils/base64';
 
 import { samples } from '../samples';
 import Header, { LiveSettings } from './Header';

diff --git a/packages/utils/src/base64.ts → packages/playground/src/utils/base64.ts b/packages/utils/src/base64.ts → packages/playground/src/utils/base64.ts
diff --git a/packages/utils/test/base64.test.ts → ...ages/playground/test/utils/base64.test.ts b/packages/utils/test/base64.test.ts → ...ages/playground/test/utils/base64.test.ts
@@ -1,4 +1,4 @@
-import { base64 } from '../src';
+import base64 from '../../src/utils/base64';
 
 describe('base64', () => {
   it('should successfully encode a ascii character', () => {

diff --git a/packages/playground/tsconfig.json b/packages/playground/tsconfig.json
@@ -20,7 +20,7 @@
     "jsx": "react-jsx",
     "types": ["vite/client"]
   },
-  "include": ["src"],
+  "include": ["src", "test"],
   "references": [
     { "path": "../antd" },
     { "path": "../bootstrap-4" },

diff --git a/packages/utils/src/index.ts b/packages/utils/src/index.ts
@@ -51,7 +51,6 @@ import utcToLocal from './utcToLocal';
 import validationDataMerge from './validationDataMerge';
 import withIdRefPrefix from './withIdRefPrefix';
 import getOptionMatchingSimpleDiscriminator from './getOptionMatchingSimpleDiscriminator';
-import base64 from './base64';
 
 export * from './types';
 export * from './enums';
@@ -121,5 +120,4 @@ export {
   utcToLocal,
   validationDataMerge,
   withIdRefPrefix,
-  base64,
 };
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		const defaultConfig = require('../../babel.config');

		module.exports = defaultConfig;