@microlink/react-json-view 1.19.1 → 1.22.2

package/index.d.ts

@@ -0,0 +1,301 @@
+import * as React from 'react';
+
+export interface ReactJsonViewProps {
+  /**
+   * This property contains your input JSON.
+   *
+   * Required.
+   */
+  src: object;
+  /**
+   * Contains the name of your root node. Use null or false for no name.
+   *
+   * Default: "root"
+   */
+  name?: string | null | false;
+  /**
+   * RJV supports base-16 themes. Check out the list of supported themes in the demo.
+   * A custom "rjv-default" theme applies by default.
+   *
+   * Default: "rjv-default"
+   */
+  theme?: ThemeKeys | ThemeObject;
+  /**
+   * Style attributes for react-json-view container.
+   * Explicit style attributes will override attributes provided by a theme.
+   *
+   * Default: "rjv-default"
+   */
+  style?: React.CSSProperties;
+  /**
+   * Style of expand/collapse icons. Accepted values are "circle", triangle" or "square".
+   *
+   * Default: {}
+   */
+  iconStyle?: 'circle' | 'triangle' | 'square';
+  /**
+   * Set the indent-width for nested objects.
+   *
+   * Default: 4
+   */
+  indentWidth?: number;
+  /**
+   * When set to true, all nodes will be collapsed by default.
+   * Use an integer value to collapse at a particular depth.
+   *
+   * Default: false
+   */
+  collapsed?: boolean | number;
+  /**
+   * When an integer value is assigned, strings will be cut off at that length.
+   * Collapsed strings are followed by an ellipsis.
+   * String content can be expanded and collapsed by clicking on the string value.
+   *
+   * Default: false
+   */
+  collapseStringsAfterLength?: number | false;
+  /**
+   * Callback function to provide control over what objects and arrays should be collapsed by default.
+   * An object is passed to the callback containing name, src, type ("array" or "object") and namespace.
+   *
+   * Default: false
+   */
+  shouldCollapse?: false | ((field: CollapsedFieldProps) => boolean);
+  /**
+   * When an integer value is assigned, arrays will be displayed in groups by count of the value.
+   * Groups are displayed with brakcet notation and can be expanded and collapsed by clickong on the brackets.
+   *
+   * Default: 100
+   */
+  groupArraysAfterLength?: number;
+  /**
+   * When prop is not false, the user can copy objects and arrays to clipboard by clicking on the clipboard icon.
+   * Copy callbacks are supported.
+   *
+   * Default: true
+   */
+  enableClipboard?: boolean | ((copy: OnCopyProps) => void);
+  /**
+   * When set to true, objects and arrays are labeled with size.
+   *
+   * Default: true
+   */
+  displayObjectSize?: boolean;
+  /**
+   * When set to true, data type labels prefix values.
+   *
+   * Default: true
+   */
+  displayDataTypes?: boolean;
+  /**
+   * set to false to remove quotes from keys (eg. "name": vs. name:)
+   *
+   * Default: true
+   */
+  quotesOnKeys?: boolean;
+  /**
+   * When a callback function is passed in, edit functionality is enabled.
+   * The callback is invoked before edits are completed. Returning false
+   * from onEdit will prevent the change from being made. see: onEdit docs.
+   *
+   * Default: false
+   */
+  onEdit?: ((edit: InteractionProps) => false | any) | false;
+  /**
+   * When a callback function is passed in, add functionality is enabled.
+   * The callback is invoked before additions are completed.
+   * Returning false from onAdd will prevent the change from being made. see: onAdd docs
+   *
+   * Default: false
+   */
+  onAdd?: ((add: InteractionProps) => false | any) | false;
+  /**
+   * When a callback function is passed in, delete functionality is enabled.
+   * The callback is invoked before deletions are completed.
+   * Returning false from onDelete will prevent the change from being made. see: onDelete docs
+   *
+   * Default: false
+   */
+  onDelete?: ((del: InteractionProps) => false | any) | false;
+  /**
+   * When a function is passed in, clicking a value triggers the onSelect method to be called.
+   *
+   * Default: false
+   */
+  onSelect?: ((select: OnSelectProps) => void) | false;
+  /**
+   * Custom message for validation failures to onEdit, onAdd, or onDelete callbacks.
+   *
+   * Default: "Validation Error"
+   */
+  validationMessage?: string;
+  /**
+   * Set to true to sort object keys.
+   *
+   * Default: false
+   */
+  sortKeys?: boolean;
+  /**
+   * Set to a value to be used as defaultValue when adding new key to json
+   *
+   * Default: null
+   */
+  defaultValue?: TypeDefaultValue | TypeDefaultValue[] | null;
+  /**
+   * Whether to select the textarea contents on edit
+   *
+   * Default: false
+   */
+  selectOnFocus?: boolean;
+  /**
+   * The key modifier to be combined with a click on JSON values to edit them
+   *
+   * Default: (e) => e.metaKey || e.ctrlKey
+   */
+  keyModifier?: (event: Event, type: 'edit' | 'submit') => boolean;
+}
+
+export interface OnCopyProps {
+  /**
+   * The JSON tree source object
+   */
+  src: object;
+  /**
+   * List of keys.
+   */
+  namespace: Array<string | null>;
+  /**
+   * The last key in the namespace array.
+   */
+  name: string | null;
+}
+
+export interface CollapsedFieldProps {
+  /**
+   * The name of the entry.
+   */
+  name: string | null;
+  /**
+   * The corresponding JSON subtree.
+   */
+  src: object;
+  /**
+   * The type of src. Can only be "array" or "object".
+   */
+  type: 'array' | 'object';
+  /**
+   * The scopes above the current entry.
+   */
+  namespace: Array<string | null>;
+}
+
+export interface InteractionProps {
+  /**
+   * The updated subtree of the JSON tree.
+   */
+  updated_src: object;
+  /**
+   * The existing subtree of the JSON tree.
+   */
+  existing_src: object;
+  /**
+   * The key of the entry that is interacted with.
+   */
+  name: string | null;
+  /**
+   * List of keys.
+   */
+  namespace: Array<string | null>;
+  /**
+   * The original value of the entry that is interacted with.
+   */
+  existing_value: object | string | number | boolean | null;
+  /**
+   * The updated value of the entry that is interacted with.
+   */
+  new_value?: object | string | number | boolean | null;
+}
+
+export interface OnSelectProps {
+  /**
+   * The name of the currently selected entry.
+   */
+  name: string | null;
+  /**
+   * The value of the currently selected entry.
+   */
+  value: object | string | number | boolean | null;
+  /**
+   * The type of the value. For "number" type, it will be replaced with the more
+   * accurate types: "float", "integer", or "nan".
+   */
+  type: string;
+  /**
+   * List of keys representing the scopes above the selected entry.
+   */
+  namespace: Array<string | null>;
+
+}
+
+export type TypeDefaultValue = string | number | boolean | object;
+
+export interface ThemeObject {
+  base00: string;
+  base01: string;
+  base02: string;
+  base03: string;
+  base04: string;
+  base05: string;
+  base06: string;
+  base07: string;
+  base08: string;
+  base09: string;
+  base0A: string;
+  base0B: string;
+  base0C: string;
+  base0D: string;
+  base0E: string;
+  base0F: string;
+}
+
+export type ThemeKeys =
+  | 'apathy'
+  | 'apathy:inverted'
+  | 'ashes'
+  | 'bespin'
+  | 'brewer'
+  | 'bright:inverted'
+  | 'bright'
+  | 'chalk'
+  | 'codeschool'
+  | 'colors'
+  | 'eighties'
+  | 'embers'
+  | 'flat'
+  | 'google'
+  | 'grayscale'
+  | 'grayscale:inverted'
+  | 'greenscreen'
+  | 'harmonic'
+  | 'hopscotch'
+  | 'isotope'
+  | 'marrakesh'
+  | 'mocha'
+  | 'monokai'
+  | 'ocean'
+  | 'paraiso'
+  | 'pop'
+  | 'railscasts'
+  | 'rjv-default'
+  | 'shapeshifter'
+  | 'shapeshifter:inverted'
+  | 'solarized'
+  | 'summerfruit'
+  | 'summerfruit:inverted'
+  | 'threezerotwofour'
+  | 'tomorrow'
+  | 'tube'
+  | 'twilight';
+
+declare const ReactJson: React.ComponentType<ReactJsonViewProps>;
+export default ReactJson;

package/package.json

@@ -1,18 +1,160 @@
 {
   "name": "@microlink/react-json-view",
   "description": "Interactive react component for displaying javascript arrays and JSON objects.",
-  "homepage": "https://github.com/mac-s-g/react-json-view",
-  "version": "1.19.1",
+  "homepage": "https://github.com/microlinkhq/react-json-view",
+  "version": "1.22.2",
   "main": "dist/main.js",
   "author": {
     "name": "Mac Gainor"
   },
+  "contributors": [
+    {
+      "name": "mac",
+      "email": "mac.gainor@gmail.com"
+    },
+    {
+      "name": "Brad Adams",
+      "email": "hi@breadadams.com"
+    },
+    {
+      "name": "Kiko Beats",
+      "email": "josefrancisco.verdu@gmail.com"
+    },
+    {
+      "name": "Xuefei Li",
+      "email": "frankvsense@gmail.com"
+    },
+    {
+      "name": "Caina Leao",
+      "email": "caina.leao@endemolshine.com"
+    },
+    {
+      "name": "Tom McLaughlin",
+      "email": "tom@codedown.io"
+    },
+    {
+      "name": "Andy Baird",
+      "email": "andy@threadsculture.com"
+    },
+    {
+      "name": "Daniel Santos",
+      "email": "dsantosp12@gmail.com"
+    },
+    {
+      "name": "mac-s-g",
+      "email": "mac@conversica.com"
+    },
+    {
+      "name": "Pravdomil",
+      "email": "pravdomil.toman@gmail.com"
+    },
+    {
+      "name": "jorgejar",
+      "email": "jorge.jaramillo@docker.com"
+    },
+    {
+      "name": "superfaz",
+      "email": "16510828+superfaz@users.noreply.github.com"
+    },
+    {
+      "name": "Varad Chemburkar",
+      "email": "vhc1992@gmail.com"
+    },
+    {
+      "name": "Jason Etcovitch",
+      "email": "jasonetco@gmail.com"
+    },
+    {
+      "name": "John Arthur",
+      "email": "thorjarhun@users.noreply.github.com"
+    },
+    {
+      "name": "Jack",
+      "email": "jackdh@users.noreply.github.com"
+    },
+    {
+      "name": "Guillaume FORTAINE",
+      "email": "guillaume.fortaine@ingenico.com"
+    },
+    {
+      "name": "Michael Reynolds",
+      "email": "michael.reynolds@paybase.io"
+    },
+    {
+      "name": "Oleg Proskurin",
+      "email": "regx@usul.su"
+    },
+    {
+      "name": "EvertE",
+      "email": "evert.etienne@sitemark.com"
+    },
+    {
+      "name": "REDMOND\\xuefl",
+      "email": "xuefl@microsoft.com"
+    },
+    {
+      "name": "Rubens Mariuzzo",
+      "email": "rubens@mariuzzo.com"
+    },
+    {
+      "name": "Ryan Haywood",
+      "email": "ryan@ryanhaywood.com"
+    },
+    {
+      "name": "Taylor Birkeland",
+      "email": "tabirkeland@gmail.com"
+    },
+    {
+      "name": "Dheeraj Yennam",
+      "email": "dyennam@gmail.com"
+    },
+    {
+      "name": "Uzi Kilon",
+      "email": "uzikilon@users.noreply.github.com"
+    },
+    {
+      "name": "Aaron Cunnington",
+      "email": "azcn2503@gmail.com"
+    },
+    {
+      "name": "DELORD Vincent",
+      "email": "vincent.delord@renault.com"
+    },
+    {
+      "name": "casey langen",
+      "email": "clangen@nerdwallet.com"
+    },
+    {
+      "name": "Craig Kochis",
+      "email": "cjkochis@gmail.com"
+    },
+    {
+      "name": "Cai Leao",
+      "email": "cainaleaouk@users.noreply.github.com"
+    },
+    {
+      "name": "Bob Thomas",
+      "email": "BThomas@tripwire.com"
+    },
+    {
+      "name": "Ashwin Menkudle",
+      "email": "ashwinmenkudle@gmail.com"
+    },
+    {
+      "name": "shybyte",
+      "email": "ein@volloeko.de"
+    },
+    {
+      "name": "Jeremy Liberman",
+      "email": "mrleebo@msn.com"
+    }
+  ],
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/mac-s-g/react-json-view.git"
+    "url": "git+https://github.com/microlinkhq/react-json-view.git"
   },
   "bugs": {
-    "url": "https://github.com/mac-s-g/react-json-view/issues"
+    "url": "https://github.com/microlinkhq/react-json-view/issues"
   },
   "keywords": [
     "array-viewer",
@@ -37,72 +179,72 @@
     "treeview"
   ],
   "dependencies": {
-    "flux": "^3.1.3",
-    "react-base16-styling": "^0.6.0",
-    "react-lifecycles-compat": "^3.0.4",
-    "react-textarea-autosize": "^6.1.0"
+    "flux": "~4.0.1",
+    "react-base16-styling": "~0.6.0",
+    "react-lifecycles-compat": "~3.0.4",
+    "react-textarea-autosize": "~8.3.2"
   },
   "devDependencies": {
-    "babel-core": "^6.26.3",
-    "babel-eslint": "^8.2.5",
-    "babel-loader": "^7.1.4",
-    "babel-plugin-react-html-attrs": "^2.0.0",
-    "babel-plugin-transform-class-properties": "^6.24.1",
-    "babel-plugin-transform-function-bind": "^6.22.0",
-    "babel-plugin-transform-node-env-inline": "^0.2.0",
-    "babel-preset-es2015": "^6.24.1",
-    "babel-preset-react": "^6.24.1",
-    "babel-preset-stage-0": "^6.24.1",
-    "chai": "^4.1.2",
-    "coveralls": "^3.0.1",
-    "css-loader": "^0.28.11",
-    "enzyme": "^3.2.0",
-    "enzyme-adapter-react-16": "^1.1.1",
-    "eslint": "^5.0.1",
-    "eslint-plugin-babel": "^5.1.0",
-    "eslint-plugin-react": "^7.10.0",
-    "html-webpack-plugin": "2.30.1",
-    "ignore-styles": "^5.0.1",
-    "istanbul": "^0.4.5",
-    "jsdom": "^11.11.0",
-    "mocha": "^4.0.1",
-    "moment": "^2.22.2",
-    "node-sass": "^4.9.0",
-    "nyc": "^11.9.0",
-    "react": "^16.4.0",
-    "react-dom": "^16.4.0",
-    "react-github-button": "^0.1.11",
-    "react-hot-loader": "^3.0.0-beta.6",
-    "react-select": "^1.1.0",
-    "react-test-renderer": "^16.4.0",
-    "sass-loader": "^6.0.7",
-    "sinon": "^4.5.0",
-    "style-loader": "^0.18.2",
-    "webpack": "^3.12.0",
-    "webpack-bundle-size-analyzer": "^2.7.0",
-    "webpack-dev-server": "^2.11.2"
+    "@babel/core": "^7.13.0",
+    "@babel/eslint-parser": "~7.12.1",
+    "@babel/plugin-syntax-class-properties": "~7.12.1",
+    "@babel/plugin-syntax-jsx": "~7.12.1",
+    "@babel/register": "7.12.10",
+    "babel-plugin-react-html-attrs": "~2.1.0",
+    "chai": "~4.2.0",
+    "css-loader": "~4.3.0",
+    "enzyme": "~3.2.0",
+    "enzyme-adapter-react-16": "~1.15.5",
+    "eslint": "~7.16.0",
+    "eslint-plugin-prettier": "~3.3.1",
+    "eslint-plugin-react": "~7.21.5",
+    "html-webpack-plugin": "^4.5.2",
+    "ignore-styles": "~5.0.1",
+    "jsdom": "~16.4.0",
+    "mocha": "~8.2.1",
+    "moment": "~2.29.1",
+    "nyc": "~15.1.0",
+    "prettier": "~2.2.1",
+    "react": "~16.14.0",
+    "react-dom": "~16.14.0",
+    "react-github-button": "~0.1.11",
+    "react-hot-loader": "~4.13.0",
+    "react-scripts": "4.0.3",
+    "react-select": "~1.1.0",
+    "react-test-renderer": "~16.14.0",
+    "sass": "~1.47.0",
+    "sass-loader": "~10.1.1",
+    "sinon": "~9.2.3",
+    "style-loader": "~1.3.0",
+    "typescript": "^4.5.4",
+    "webpack": "~4.46.0",
+    "webpack-bundle-analyzer": "~3.9.0",
+    "webpack-bundle-size-analyzer": "~3.1.0",
+    "webpack-cli": "~3.3.12",
+    "webpack-dev-server": "~3.11.2"
   },
   "files": [
-    "dist"
+    "dist",
+    "index.d.ts"
   ],
+  "license": "MIT",
+  "peerDependencies": {
+    "react": ">= 15",
+    "react-dom": ">= 15"
+  },
   "scripts": {
-    "build": "webpack --config webpack/webpack.config.js -p --display-error-details --progress --optimize-minimize",
-    "build:demo": "webpack --config webpack/webpack.config-demo.js -p --display-error-details --progress --optimize-minimize",
-    "dev": "webpack-dev-server --config webpack/webpack.config-dev.js --open",
-    "lint": "./node_modules/.bin/eslint src",
-    "lint-fixup": "./node_modules/.bin/eslint src --ext .js,.jsx --fix",
+    "build": "NODE_ENV=production webpack --config webpack/webpack.config.js -p --display-error-details --progress --optimize-minimize",
+    "build:demo": "NODE_ENV=production webpack --config webpack/webpack.config-demo.js -p --display-error-details --progress --optimize-minimize",
+    "dev": "NODE_ENV=development webpack-dev-server --config webpack/webpack.config-dev.js --open",
+    "lint": "NODE_ENV=test ./node_modules/.bin/eslint src",
+    "lint-fixup": "NODE_ENV=test ./node_modules/.bin/eslint src --ext .js,.jsx --fix",
     "modules:debug": "./docker/debug.sh",
     "modules:size-analyzer": "webpack --config webpack/webpack.config.js --json | webpack-bundle-size-analyzer",
     "modules:tree": "webpack --config webpack/webpack.config.js --json ",
-    "prebuild": "npm run test:unit",
-    "test": "npm run test:unit && npm run test:coverage",
-    "test:coverage": "nyc report --reporter=text-lcov | coveralls",
-    "test:unit": "nyc mocha test/**/*-test.js",
-    "test:watch": "nyc mocha -w test/**/*-test.js"
-  },
-  "license": "MIT",
-  "peerDependencies": {
-    "react": "^17.0.0 || ^16.0.0 || ^15.5.4",
-    "react-dom": "^17.0.0 || ^16.0.0 || ^15.5.4"
+    "prebuild": "NODE_ENV=test npm run test:unit",
+    "test": "npm run test:coverage",
+    "test:coverage": "NODE_ENV=test nyc --reporter=text-lcov mocha test/**/*-test.js",
+    "test:unit": "NODE_ENV=test nyc mocha test/**/*-test.js",
+    "test:watch": "NODE_ENV=test nyc mocha -w test/**/*-test.js"
   }
-}
+}