slate-serializers - npm Package Compare versions

Comparing version 0.4.1 to 1.0.0

package.json

 {
   "name": "slate-serializers",
-  "version": "0.4.1",
-  "description": "Serialize Slate JSON objects to HTML and vice versa. Define rules to modify the end result.",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
-  "scripts": {
-    "build": "tsc",
-    "format": "npx prettier --write .",
-    "lint": "tslint -p tsconfig.json",
-    "release": "standard-version",
-    "prepare": "npm run build",
-    "prepublishOnly": "npm test && npm run lint",
-    "test": "jest"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/thompsonsj/slate-serializers.git"
-  },
-  "files": [
-    "lib/**/*"
-  ],
-  "author": "",
-  "license": "ISC",
-  "bugs": {
-    "url": "https://github.com/thompsonsj/slate-serializers/issues"
-  },
-  "homepage": "https://github.com/thompsonsj/slate-serializers#readme",
-  "devDependencies": {
-    "@commitlint/cli": "^17.6.3",
-    "@commitlint/config-conventional": "^17.6.3",
-    "@types/html-escaper": "^3.0.0",
-    "@types/jest": "^29.5.1",
-    "@types/react": ">=16",
-    "@types/react-test-renderer": "^18.0.0",
-    "commitizen": "^4.3.0",
-    "husky": "^8.0.3",
-    "jest": "^29.5.0",
-    "jest-environment-jsdom": "^29.5.0",
-    "jsdom": "^21.1.1",
-    "postcss": "^8.4.24",
-    "postcss-js": "^4.0.1",
-    "prettier": "2.8.8",
-    "react-test-renderer": "^18.2.0",
-    "ts-jest": "^29.1.0",
-    "tslint": "^6.1.3",
-    "tslint-config-prettier": "^1.18.0",
-    "typescript": "^5.0.4"
-  },
-  "commitlint": {
-    "extends": [
-      "@commitlint/config-conventional"
-    ]
-  },
+  "version": "1.0.0",
+  "type": "commonjs",
   "dependencies": {
-    "@testing-library/react": "^14.0.0",
     "css-select": "^5.1.0",
@@ -63,3 +12,2 @@ "dom-serializer": "^2.0.0",
     "htmlparser2": "~7.2.0",
-    "nanoid": "^4.0.2",
     "slate": "^0.94.1",
@@ -69,6 +17,9 @@ "slate-hyperscript": "^0.77.0"
   "peerDependencies": {
-    "@types/react": ">=16",
-    "react": ">=16",
-    "react-dom": ">=16"
-  }
+    "@slate-serializers/dom": "1.0.0",
+    "@slate-serializers/html": "1.0.0",
+    "@slate-serializers/utilities": "1.0.0",
+    "tslib": "2.5.0"
+  },
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts"
 }

README.md

 # slate-serializers
 
-A collection of serializers to convert [Slate](https://www.npmjs.com/package/slate) JSON objects to various formats and vice versa. Designed to work in both Node.js and browser environments.
+This package has been split into separate packages. As more serializers are introduced, the number of dependencies increase. It makes sense to maintain separate packages to keep the serializers as efficient as possible for their desired use case.
+ 
+There is no need to change - `slate-serializers` will continue to be maintained alongside the new serializers. However, upgrading will keep the dependency tree minimal for your project.
 
-Serializers included so far:
+Original docs available at [packages/slate-serializers/docs/original.md](packages/slate-serializers/docs/original.md).
 
-- [`slateToHtml`](#slatetohtml)
-- [`htmlToSlate`](#htmltoslate)
-- [`slateToDom`](#slatetodom)
+## New packages
 
-View the demo at [https://thompsonsj.github.io/slate-serializers-demo](https://thompsonsj.github.io/slate-serializers-demo).
+An overview is available at [README.md](README.md).
 
-## Setup
+## Upgrade
 
-### Compatibility
+### HTML serializers
 
-Serializers are only compatible with Slate >=0.50.0. Earlier versions used a different data model.
+Change import from `slate-serializers` to `@slate-serializers/html`.
 
-Note that compatibility has only been tested with Slate v0.72.8. These serializers are still in active development/testing.
+If importing configuration objects, change the name as follows.
+  - `slateToDomConfig` to `slateToHtmlConfig`.
+  - `payloadSlateToDomConfig` to `payloadSlateToHtmlConfig`.
+  - `slateDemoSlateToDomConfig` to `slateDemoSlateToHtmlConfig`
 
-### Install
+### DOM serializer
 
-```bash
-yarn add slate-serializers
-# or
-npm install slate-serializers
-```
-
-### Configuration
-
-Each serializer uses a default configuration, which may not transform your data effectively.
-
-One of the principles of Slate is its [**schema-less core**](https://docs.slatejs.org/#principles).
-
-Check configuration objects in [src/config/](src/config/). Extend the default configuration or write your own in order to apply your schema/transformation rules.
-
-## Serializers
-
-### slateToHtml
-
-```ts
-import { slateToHtml } from 'slate-serializers'
-
-const slate = [
-  {
-    children: [
-      {
-        text: 'Heading 1',
-      },
-    ],
-    type: 'h1',
-  },
-  {
-    children: [
-      {
-        text: 'Paragraph 1',
-      },
-    ],
-    type: 'p',
-  },
-]
-
-const serializedToHtml = slateToHtml(slate)
-// output
-// <h1>Heading 1</h1><p>Paragraph 1</p>
-```
-
-#### Configuration
-
-By default, `slateToHtml` incorporates transformation rules based on the example in [Deserializing | Serializing | Slate](https://docs.slatejs.org/concepts/10-serializing#deserializing).
-
-If you are using [Payload CMS](https://payloadcms.com/), import the Payload configuration file and pass it as a parameter to the serializer.
-
-```ts
-import { slateToHtml, payloadSlateToDomConfig } from 'slate-serializers'
-
-const slate = [
-  {
-    children: [
-      {
-        text: 'Heading 1',
-      },
-    ],
-    type: 'h1',
-  },
-]
-
-const serializedToHtml = slateToHtml(slate, payloadSlateToDomConfig)
-```
-
-You can create your own configuration file that implements your schema. See [src/config/slateToDom/payload.ts](src/config/slateToDom/payload.ts) for an example of how to extend the default configuration or copy [src/config/slateToDom/default.ts](src/config/slateToDom/default.ts) and rewrite it as appropriate.
-
-### htmlToSlate
-
-```ts
-import { htmlToSlate } from 'slate-serializers'
-
-const html = `<h1>Heading 1</h1><p>Paragraph 1</p>`
-
-const serializedToSlate = htmlToSlate(html)
-// output
-/*
-[
-  {
-    children: [
-      {
-        text: 'Heading 1',
-      },
-    ],
-    type: 'h1',
-  },
-  {
-    children: [
-      {
-        text: 'Paragraph 1',
-      },
-    ],
-    type: 'p',
-  },
-]
-/*
-```
-
-#### Configuration
-
-By default, `htmlToSlate` incorporates transformation rules based on the example in [HTML | Serializing | Slate](https://docs.slatejs.org/concepts/10-serializing#html).
-
-If you are using [Payload CMS](https://payloadcms.com/), import the Payload configuration file and pass it as a parameter to the serializer.
-
-```ts
-import { htmlToSlate, payloadHtmlToSlateConfig } from 'slate-serializers'
-
-const html = `<h1>Heading 1</h1><p>Paragraph 1</p>`
-
-const serializedToSlate = htmlToSlate(html, payloadHtmlToSlateConfig)
-```
-
-You can create your own configuration file that implements your schema. See [src/config/htmlToSlate/payload.ts](src/config/htmlToSlate/payload.ts) for an example of how to extend the default configuration or copy [src/config/htmlToSlate/default.ts](src/config/htmlToSlate/default.ts) and rewrite it as appropriate.
-
-For a breakdown of configuration options, see [docs/config/htmlToSlate.md](docs/config/htmlToSlate.md).
-
-#### Whitespace
-
-`htmlToSlate` processes whitespace in a similar way to browsers. It minifies whitespace while trying to preserve meaning. For details, see [docs/engineering.md#whitespace](docs/engineering.md#whitespace).
-
-### slateToDom
-
-`slateToHtml` is a simple wrapper that runs [`dom-serializer`](https://www.npmjs.com/package/dom-serializer) on the output from `slateToDom`.
-
-`slateToDom` is made available in case you wish to work with the DOM output yourself or run `dom-serializer` using any of the available options.
-
-It accepts the same configuration object as [slateToHtml](#slatetohtml).
-
-### Commits
-
-TLDR: contributors can format commit messages in any way, maintainers should use conventional commits.
-
-This repository uses [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/).
-
-Conventional commits are not enforced. General guidance:
-
-- Commit messages can be formatted in any way on a pull request.
-- Conventional commit messages are preferred on pull request squash and merge.
-
-Run `npx cz` instead of `git commit` to lint commit messages using [@commitlint/cli](https://www.npmjs.com/package/@commitlint/cli).
+Change import from `slate-serializers` to `@slate-serializers/dom`.

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

No contributors or author data

Maintenance

Package does not specify a list of contributors or an author in package.json.

Found 1 instance in 1 package

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

No License Found

License

(Experimental) License information could not be found.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Dependency count

12

decreased by-7.69%

Dev dependency count

0

decreased by-100%

Worsened metrics

Total package byte prevSize

5242

decreased by-89.73%

Number of package files

8

decreased by-84%

Number of low license alerts

1

increased byInfinity%

Lines of code

37

decreased by-96.98%

Number of low maintenance alerts

2

increased by100%

Number of lines in readme file

27

decreased by-83.73%

Number of low supply chain risk alerts

1

increased byInfinity%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Added@slate-serializers/dom@1.0.0(transitive)

• + Added@slate-serializers/html@1.0.0(transitive)

• + Added@slate-serializers/utilities@0.6.71.0.0(transitive)

• + Addedtslib@2.5.0(transitive)

• - Removed@testing-library/react@^14.0.0

• - Removednanoid@^4.0.2

• - Removed@babel/code-frame@7.26.2(transitive)

• - Removed@babel/helper-validator-identifier@7.25.9(transitive)

• - Removed@babel/runtime@7.26.0(transitive)

• - Removed@testing-library/dom@9.3.4(transitive)

• - Removed@testing-library/react@14.3.1(transitive)

• - Removed@types/aria-query@5.0.4(transitive)

• - Removed@types/prop-types@15.7.14(transitive)

• - Removed@types/react@18.3.1819.0.7(transitive)

• - Removed@types/react-dom@18.3.5(transitive)

• - Removedansi-regex@5.0.1(transitive)

• - Removedansi-styles@4.3.05.2.0(transitive)

• - Removedaria-query@5.1.3(transitive)

• - Removedarray-buffer-byte-length@1.0.2(transitive)

• - Removedavailable-typed-arrays@1.0.7(transitive)

• - Removedcall-bind@1.0.8(transitive)

• - Removedcall-bind-apply-helpers@1.0.1(transitive)

• - Removedcall-bound@1.0.3(transitive)

• - Removedchalk@4.1.2(transitive)

• - Removedcolor-convert@2.0.1(transitive)

• - Removedcolor-name@1.1.4(transitive)

• - Removedcsstype@3.1.3(transitive)

• - Removeddeep-equal@2.2.3(transitive)

• - Removeddefine-data-property@1.1.4(transitive)

• - Removeddefine-properties@1.2.1(transitive)

• - Removeddom-accessibility-api@0.5.16(transitive)

• - Removeddunder-proto@1.0.1(transitive)

• - Removedes-define-property@1.0.1(transitive)

• - Removedes-errors@1.3.0(transitive)

• - Removedes-get-iterator@1.1.3(transitive)

• - Removedes-object-atoms@1.1.1(transitive)

• - Removedfor-each@0.3.3(transitive)

• - Removedfunction-bind@1.1.2(transitive)

• - Removedfunctions-have-names@1.2.3(transitive)

• - Removedget-intrinsic@1.2.7(transitive)

• - Removedget-proto@1.0.1(transitive)

• - Removedgopd@1.2.0(transitive)

• - Removedhas-bigints@1.1.0(transitive)

• - Removedhas-flag@4.0.0(transitive)

• - Removedhas-property-descriptors@1.0.2(transitive)

• - Removedhas-symbols@1.1.0(transitive)

• - Removedhas-tostringtag@1.0.2(transitive)

• - Removedhasown@2.0.2(transitive)

• - Removedinternal-slot@1.1.0(transitive)

• - Removedis-arguments@1.2.0(transitive)

• - Removedis-array-buffer@3.0.5(transitive)

• - Removedis-bigint@1.1.0(transitive)

• - Removedis-boolean-object@1.2.1(transitive)

• - Removedis-callable@1.2.7(transitive)

• - Removedis-date-object@1.1.0(transitive)

• - Removedis-map@2.0.3(transitive)

• - Removedis-number-object@1.1.1(transitive)

• - Removedis-regex@1.2.1(transitive)

• - Removedis-set@2.0.3(transitive)

• - Removedis-shared-array-buffer@1.0.4(transitive)

• - Removedis-string@1.1.1(transitive)

• - Removedis-symbol@1.1.1(transitive)

• - Removedis-weakmap@2.0.2(transitive)

• - Removedis-weakset@2.0.4(transitive)

• - Removedisarray@2.0.5(transitive)

• - Removedjs-tokens@4.0.0(transitive)

• - Removedloose-envify@1.4.0(transitive)

• - Removedlz-string@1.5.0(transitive)

• - Removedmath-intrinsics@1.1.0(transitive)

• - Removednanoid@4.0.2(transitive)

• - Removedobject-inspect@1.13.3(transitive)

• - Removedobject-is@1.1.6(transitive)

• - Removedobject-keys@1.1.1(transitive)

• - Removedobject.assign@4.1.7(transitive)

• - Removedpicocolors@1.1.1(transitive)

• - Removedpossible-typed-array-names@1.0.0(transitive)

• - Removedpretty-format@27.5.1(transitive)

• - Removedreact@18.3.119.0.0(transitive)

• - Removedreact-dom@18.3.119.0.0(transitive)

• - Removedreact-is@17.0.2(transitive)

• - Removedregenerator-runtime@0.14.1(transitive)

• - Removedregexp.prototype.flags@1.5.4(transitive)

• - Removedsafe-regex-test@1.1.0(transitive)

• - Removedscheduler@0.23.20.25.0(transitive)

• - Removedset-function-length@1.2.2(transitive)

• - Removedset-function-name@2.0.2(transitive)

• - Removedside-channel@1.1.0(transitive)

• - Removedside-channel-list@1.0.0(transitive)

• - Removedside-channel-map@1.0.1(transitive)

• - Removedside-channel-weakmap@1.0.2(transitive)

• - Removedstop-iteration-iterator@1.1.0(transitive)

• - Removedsupports-color@7.2.0(transitive)

• - Removedwhich-boxed-primitive@1.1.1(transitive)

• - Removedwhich-collection@1.0.2(transitive)

• - Removedwhich-typed-array@1.1.18(transitive)