@react-sigma/layout-circlepack - npm Package Compare versions

Comparing version 4.0.3 to 5.0.0

rollup.config.mjs

+import getRollupConfig from '../../rollup.base.mjs';
+
+export default getRollupConfig('layout-circlepack');

lib/index.d.ts

@@ -1,1 +0,6 @@
-export * from "./useLayoutCirclepack";
+/**
+ * React Sigma module for layout circlepack.
+ *
+ * @module
+ */
+export * from './useLayoutCirclepack';

lib/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
+/**
+ * React Sigma module for layout circlepack.
+ *
+ * @module
+ */
 tslib_1.__exportStar(require("./useLayoutCirclepack"), exports);
 //# sourceMappingURL=index.js.map

lib/index.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAKA,gEAAsC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACH,gEAAsC"}

lib/react-sigma_layout-circlepack.esm.min.js

@@ -1,2 +0,2 @@
-import o from"graphology-layout/circlepack";import{useLayoutFactory as a}from"@react-sigma/layout-core";const r=a(o,{});export{r as useLayoutCirclepack};
+import{useLayoutFactory as o}from"@react-sigma/layout-core";import r from"graphology-layout/circlepack";function t(t={}){return o(r,t)}export{t as useLayoutCirclepack};
 //# sourceMappingURL=react-sigma_layout-circlepack.esm.min.js.map

lib/react-sigma_layout-circlepack.esm.min.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"react-sigma_layout-circlepack.esm.min.js","sources":["../src/useLayoutCirclepack.ts"],"sourcesContent":[null],"names":["useLayoutCirclepack","useLayoutFactory","circlepack"],"mappings":"wGAYa,MAAAA,EAAsBC,EAA0CC,EAAY,CAAE"}
+{"version":3,"file":"react-sigma_layout-circlepack.esm.min.js","sources":["../src/useLayoutCirclepack.ts"],"sourcesContent":[null],"names":["useLayoutCirclepack","options","useLayoutFactory","circlepack"],"mappings":"wGAWgB,SAAAA,EAAoBC,EAAmC,IACrE,OAAOC,EAA0CC,EAAYF,EAC/D"}

lib/react-sigma_layout-circlepack.umd.min.js

@@ -1,2 +0,2 @@
-!function(e,o){"object"==typeof exports&&"undefined"!=typeof module?o(exports,require("graphology-layout/circlepack"),require("@react-sigma/layout-core")):"function"==typeof define&&define.amd?define(["exports","graphology-layout/circlepack","@react-sigma/layout-core"],o):o((e="undefined"!=typeof globalThis?globalThis:e||self)["@react-sigma/layout-circlepack"]={},e.circlepack,e.layoutCore)}(this,(function(e,o,t){"use strict";const c=t.useLayoutFactory(o,{});e.useLayoutCirclepack=c}));
+!function(e,o){"object"==typeof exports&&"undefined"!=typeof module?o(exports,require("@react-sigma/layout-core"),require("graphology-layout/circlepack")):"function"==typeof define&&define.amd?define(["exports","@react-sigma/layout-core","graphology-layout/circlepack"],o):o((e="undefined"!=typeof globalThis?globalThis:e||self)["@react-sigma/layout-circlepack"]={},e.layoutCore,e.circlepack)}(this,(function(e,o,t){"use strict";e.useLayoutCirclepack=function(e={}){return o.useLayoutFactory(t,e)}}));
 //# sourceMappingURL=react-sigma_layout-circlepack.umd.min.js.map

lib/react-sigma_layout-circlepack.umd.min.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"react-sigma_layout-circlepack.umd.min.js","sources":["../src/useLayoutCirclepack.ts"],"sourcesContent":[null],"names":["useLayoutCirclepack","useLayoutFactory","circlepack"],"mappings":"6aAYa,MAAAA,EAAsBC,EAAAA,iBAA0CC,EAAY,CAAE"}
+{"version":3,"file":"react-sigma_layout-circlepack.umd.min.js","sources":["../src/useLayoutCirclepack.ts"],"sourcesContent":[null],"names":["options","useLayoutFactory","circlepack"],"mappings":"mcAWgB,SAAoBA,EAAmC,IACrE,OAAOC,EAAgBA,iBAA0BC,EAAYF,EAC/D"}

lib/useLayoutCirclepack.d.ts

@@ -1,2 +0,10 @@
-import { CirclePackLayoutOptions } from "graphology-layout/circlepack";
-export declare const useLayoutCirclepack: import("@react-sigma/layout-core").LayoutHook<CirclePackLayoutOptions>;
+import { CirclePackLayoutOptions } from 'graphology-layout/circlepack';
+/**
+ * React hook that helps you to manage [circlepack layout](https://graphology.github.io/standard-library/layout.html#circlepack).
+ *
+ * ```typescript
+ * const { positions, assign } = useLayoutCirclepack({...});
+ *```
+ * @category Hook
+ */
+export declare function useLayoutCirclepack(options?: CirclePackLayoutOptions): import("@react-sigma/layout-core").LayoutHook;

lib/useLayoutCirclepack.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.useLayoutCirclepack = void 0;
+exports.useLayoutCirclepack = useLayoutCirclepack;
 const tslib_1 = require("tslib");
+const layout_core_1 = require("@react-sigma/layout-core");
 const circlepack_1 = tslib_1.__importDefault(require("graphology-layout/circlepack"));
-const layout_core_1 = require("@react-sigma/layout-core");
-exports.useLayoutCirclepack = (0, layout_core_1.useLayoutFactory)(circlepack_1.default, {});
+/**
+ * React hook that helps you to manage [circlepack layout](https://graphology.github.io/standard-library/layout.html#circlepack).
+ *
+ * ```typescript
+ * const { positions, assign } = useLayoutCirclepack({...});
+ *```
+ * @category Hook
+ */
+function useLayoutCirclepack(options = {}) {
+    return (0, layout_core_1.useLayoutFactory)(circlepack_1.default, options);
+}
 //# sourceMappingURL=useLayoutCirclepack.js.map

lib/useLayoutCirclepack.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"useLayoutCirclepack.js","sourceRoot":"","sources":["../src/useLayoutCirclepack.ts"],"names":[],"mappings":";;;;AAAA,sFAAmF;AAEnF,0DAA4D;AAU/C,QAAA,mBAAmB,GAAG,IAAA,8BAAgB,EAA0B,oBAAU,EAAE,EAAE,CAAC,CAAC"}
+{"version":3,"file":"useLayoutCirclepack.js","sourceRoot":"","sources":["../src/useLayoutCirclepack.ts"],"names":[],"mappings":";;AAWA,kDAEC;;AAbD,0DAA4D;AAC5D,sFAAmF;AAEnF;;;;;;;GAOG;AACH,SAAgB,mBAAmB,CAAC,UAAmC,EAAE;IACvE,OAAO,IAAA,8BAAgB,EAA0B,oBAAU,EAAE,OAAO,CAAC,CAAC;AACxE,CAAC"}

LICENSE.md

@@ -1,11 +0,21 @@
-# Released under MIT License
+The MIT License (MIT)
 
-Copyright (c) 2013 Mark Otto.
+Copyright (c) 2024 The react-sigma Authors
 
-Copyright (c) 2017 Andrew Fong.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package.json

 {
   "name": "@react-sigma/layout-circlepack",
-  "version": "4.0.3",
+  "version": "5.0.0",
   "description": "React Sigma - Layout circlepack",
@@ -33,3 +33,3 @@ "author": "Benoit Simard",
     "clean": "rimraf lib tsconfig.tsbuildinfo .rollup.cache",
-    "lint": "esw --ext .ts ./src",
+    "lint": "eslint",
     "compile": "tsc -b",
@@ -40,3 +40,3 @@ "build": "npm run lint && npm run compile && rollup -c",
   "dependencies": {
-    "@react-sigma/layout-core": "^4.0.3"
+    "@react-sigma/layout-core": "^5.0.0"
   },
@@ -46,3 +46,3 @@ "peerDependencies": {
   },
-  "gitHead": "772c092b76c73c5b9f58b40ebff95a7d00fb8541"
+  "gitHead": "a64711826b2ee03f4ddd702a87b693ac94e9ae70"
 }

src/index.ts

@@ -6,2 +6,2 @@ /**
  */
-export * from "./useLayoutCirclepack";
+export * from './useLayoutCirclepack';

src/useLayoutCirclepack.ts

@@ -1,5 +0,4 @@
-import circlepack, { CirclePackLayoutOptions } from "graphology-layout/circlepack";
+import { useLayoutFactory } from '@react-sigma/layout-core';
+import circlepack, { CirclePackLayoutOptions } from 'graphology-layout/circlepack';
 
-import { useLayoutFactory } from "@react-sigma/layout-core";
-
 /**
@@ -13,2 +12,4 @@ * React hook that helps you to manage [circlepack layout](https://graphology.github.io/standard-library/layout.html#circlepack).
  */
-export const useLayoutCirclepack = useLayoutFactory<CirclePackLayoutOptions>(circlepack, {});
+export function useLayoutCirclepack(options: CirclePackLayoutOptions = {}) {
+  return useLayoutFactory<CirclePackLayoutOptions>(circlepack, options);
+}

rollup.config.js

-import terser from "@rollup/plugin-terser";
-import typescript from "@rollup/plugin-typescript";
-import eslint from "@rollup/plugin-eslint";
-
-/** @type {import("rollup").RollupOptions} */
-export default {
-  input: "src/index.ts",
-  output: [
-    {
-      file: "lib/react-sigma_layout-circlepack.esm.min.js",
-      format: "esm",
-      plugins: [terser()],
-      sourcemap: true,
-    },
-    {
-      file: "lib/react-sigma_layout-circlepack.umd.min.js",
-      format: "umd",
-      name: "@react-sigma/layout-circlepack",
-      plugins: [terser()],
-      sourcemap: true,
-    },
-  ],
-  plugins: [
-    eslint({ exclude: "./src/assets/**" }),
-    typescript({ tsconfig: "./tsconfig.json", outputToFilesystem: true }),
-    terser(),
-  ],
-  external: [
-    "sigma",
-    "graphology",
-    "react",
-    "react-dom",
-    "@react-sigma/layout-core",
-    "graphology-layout/circlepack",
-  ],
-};
-

No alert changes

Improved metrics

Total package byte prevSize

7160

1.86%

Number of package files

18

5.88%

Worsened metrics

Lines of code

80

-3.61%

Dependency changes

• + Added

  @react-sigma/core@5.0.6
  (transitive)

• + Added

  @react-sigma/layout-core@5.0.6
  (transitive)

• + Added

  graphology@0.26.0
  (transitive)

• + Added

  react@19.2.5
  (transitive)

• - Removed

  @react-sigma/core@4.0.3
  (transitive)

• - Removed

  @react-sigma/layout-core@4.0.3
  (transitive)

• - Removed

  graphology@0.25.4
  (transitive)

• - Removed

  js-tokens@4.0.0
  (transitive)

• - Removed

  loose-envify@1.4.0
  (transitive)

• - Removed

  react@18.3.1
  (transitive)

• Updated

  @react-sigma/layout-core@^5.0.0