@mui/internal-docs-infra 0.1.1-canary.2 → 0.1.1-canary.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/esm/package.json CHANGED
@@ -1 +1 @@
1
- {"type":"module"}
1
+ {"type":"module","sideEffects":false}
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/useCopier/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAG/B,KAAK,QAAQ,GAAG,MAAM,IAAI,CAAC;AAC3B,KAAK,WAAW,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC;AAC5C,KAAK,WAAW,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,iBAAiB,CAAC,KAAK,IAAI,CAAC;AACxE,MAAM,MAAM,aAAa,GAAG;IAC1B,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,wBAAgB,SAAS,CAAC,QAAQ,EAAE,CAAC,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,MAAM,EAAE,IAAI,CAAC,EAAE,aAAa;kBAO3E,KAAK,CAAC,UAAU,CAAC,iBAAiB,CAAC;;EA0BpD"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../home/runner/work/mui-public/mui-public/packages/docs-infra/src/useCopier/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAG/B,KAAK,QAAQ,GAAG,MAAM,IAAI,CAAC;AAC3B,KAAK,WAAW,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC;AAC5C,KAAK,WAAW,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,iBAAiB,CAAC,KAAK,IAAI,CAAC;AACxE,MAAM,MAAM,aAAa,GAAG;IAC1B,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,wBAAgB,SAAS,CAAC,QAAQ,EAAE,CAAC,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,MAAM,EAAE,IAAI,CAAC,EAAE,aAAa;kBAO3E,KAAK,CAAC,UAAU,CAAC,iBAAiB,CAAC;;EA0BpD"}
@@ -1,4 +1,4 @@
1
- import _regeneratorRuntime from "@babel/runtime/helpers/esm/regeneratorRuntime";
1
+ import _regenerator from "@babel/runtime/helpers/esm/regenerator";
2
2
  import _asyncToGenerator from "@babel/runtime/helpers/esm/asyncToGenerator";
3
3
  import _slicedToArray from "@babel/runtime/helpers/esm/slicedToArray";
4
4
  import * as React from 'react';
@@ -16,40 +16,39 @@ export function useCopier(contents, opts) {
16
16
  disabled = _React$useState2[0],
17
17
  setDisabled = _React$useState2[1];
18
18
  var copy = React.useCallback(/*#__PURE__*/function () {
19
- var _ref2 = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee(event) {
20
- var content;
21
- return _regeneratorRuntime().wrap(function _callee$(_context) {
22
- while (1) switch (_context.prev = _context.next) {
19
+ var _ref2 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee(event) {
20
+ var content, _t;
21
+ return _regenerator().w(function (_context) {
22
+ while (1) switch (_context.p = _context.n) {
23
23
  case 0:
24
24
  clearTimeout(copyTimeoutRef.current);
25
25
  setDisabled(true);
26
- _context.prev = 2;
26
+ _context.p = 1;
27
27
  content = typeof contents === 'function' ? contents() : contents;
28
28
  if (!content) {
29
- _context.next = 7;
29
+ _context.n = 2;
30
30
  break;
31
31
  }
32
- _context.next = 7;
32
+ _context.n = 2;
33
33
  return copyToClipboard(content);
34
- case 7:
34
+ case 2:
35
35
  onCopied == null || onCopied();
36
- _context.next = 13;
36
+ _context.n = 4;
37
37
  break;
38
- case 10:
39
- _context.prev = 10;
40
- _context.t0 = _context["catch"](2);
41
- onError == null || onError(_context.t0);
42
- case 13:
38
+ case 3:
39
+ _context.p = 3;
40
+ _t = _context.v;
41
+ onError == null || onError(_t);
42
+ case 4:
43
43
  onClick == null || onClick(event);
44
44
  copyTimeoutRef.current = setTimeout(function () {
45
45
  clearTimeout(copyTimeoutRef.current);
46
46
  setDisabled(false);
47
47
  }, timeout);
48
- case 15:
49
- case "end":
50
- return _context.stop();
48
+ case 5:
49
+ return _context.a(2);
51
50
  }
52
- }, _callee, null, [[2, 10]]);
51
+ }, _callee, null, [[1, 3]]);
53
52
  }));
54
53
  return function (_x) {
55
54
  return _ref2.apply(this, arguments);
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/useDemo/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AAK7B,OAAO,EAAa,aAAa,EAAE,MAAM,cAAc,CAAC;AAExD,KAAK,MAAM,GAAG,KAAK,CAAC;AACpB,MAAM,MAAM,OAAO,GAAG;IACpB,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACzC,CAAC;AACF,MAAM,MAAM,IAAI,GAAG;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACtC,CAAC;AAEF,KAAK,WAAW,GAAG;IACjB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,IAAI,CAAC,EAAE,aAAa,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B,CAAC;AAMF,wBAAgB,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,WAAW;;;;;;;;;;;;;;;;;;;;;;EA0ErD"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../home/runner/work/mui-public/mui-public/packages/docs-infra/src/useDemo/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AAK7B,OAAO,EAAa,aAAa,EAAE,MAAM,cAAc,CAAC;AAExD,KAAK,MAAM,GAAG,KAAK,CAAC;AACpB,MAAM,MAAM,OAAO,GAAG;IACpB,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACzC,CAAC;AACF,MAAM,MAAM,IAAI,GAAG;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACtC,CAAC;AAEF,KAAK,WAAW,GAAG;IACjB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,IAAI,CAAC,EAAE,aAAa,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B,CAAC;AAMF,wBAAgB,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,WAAW;;;;;;;;;;;;;;;;;;;;;;EA0ErD"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mui/internal-docs-infra",
3
- "version": "0.1.1-canary.2",
3
+ "version": "0.1.1-canary.4",
4
4
  "author": "MUI Team",
5
5
  "description": "MUI Infra - internal documentation creation tools.",
6
6
  "keywords": [
@@ -13,7 +13,7 @@
13
13
  "repository": {
14
14
  "type": "git",
15
15
  "url": "git+https://github.com/mui/mui-public.git",
16
- "directory": "packages/mui-docs"
16
+ "directory": "packages/docs-infra"
17
17
  },
18
18
  "license": "MIT",
19
19
  "bugs": {
@@ -39,37 +39,22 @@
39
39
  "optional": true
40
40
  }
41
41
  },
42
+ "publishConfig": {
43
+ "access": "public"
44
+ },
42
45
  "engines": {
43
46
  "node": ">=14.0.0"
44
47
  },
45
- "gitSha": "09818201a129f626de6d794ef5ad8faf3c3c6b3f",
46
- "private": false,
48
+ "gitSha": "a1f1e1c49d24c9e4efe18657ba9409ae401d1997",
49
+ "type": "commonjs",
47
50
  "exports": {
48
51
  "./package.json": "./package.json",
49
- ".": {
50
- "require": {
51
- "types": "./index.d.ts",
52
- "default": "./index.js"
53
- },
54
- "import": {
55
- "types": "./esm/index.d.ts",
56
- "default": "./esm/index.js"
57
- }
58
- },
59
52
  "./*": {
60
- "require": {
61
- "types": "./*/index.d.ts",
62
- "default": "./*/index.js"
63
- },
64
53
  "import": {
65
54
  "types": "./esm/*/index.d.ts",
66
55
  "default": "./esm/*/index.js"
67
56
  }
68
57
  },
69
- "./esm": null,
70
- "./modern": null
71
- },
72
- "publishConfig": {
73
- "access": "public"
58
+ "./esm": null
74
59
  }
75
60
  }
@@ -1,15 +0,0 @@
1
- import * as React from 'react';
2
- type OnCopied = () => void;
3
- type OnCopyError = (error: unknown) => void;
4
- type OnCopyClick = (event: React.MouseEvent<HTMLButtonElement>) => void;
5
- export type UseCopierOpts = {
6
- onCopied?: OnCopied;
7
- onError?: OnCopyError;
8
- onClick?: OnCopyClick;
9
- timeout?: number;
10
- };
11
- export declare function useCopier(contents: (() => string | undefined) | string, opts?: UseCopierOpts): {
12
- copy: (event: React.MouseEvent<HTMLButtonElement>) => Promise<void>;
13
- disabled: boolean;
14
- };
15
- export {};
@@ -1,70 +0,0 @@
1
- "use strict";
2
-
3
- var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard")["default"];
4
- var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault")["default"];
5
- Object.defineProperty(exports, "__esModule", {
6
- value: true
7
- });
8
- exports.useCopier = useCopier;
9
- var _regeneratorRuntime2 = _interopRequireDefault(require("@babel/runtime/helpers/regeneratorRuntime"));
10
- var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
11
- var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
12
- var React = _interopRequireWildcard(require("react"));
13
- var _clipboardCopy = _interopRequireDefault(require("clipboard-copy"));
14
- function useCopier(contents, opts) {
15
- var _ref = opts || {},
16
- onCopied = _ref.onCopied,
17
- onError = _ref.onError,
18
- onClick = _ref.onClick,
19
- _ref$timeout = _ref.timeout,
20
- timeout = _ref$timeout === void 0 ? 2000 : _ref$timeout;
21
- var copyTimeoutRef = React.useRef(undefined);
22
- var _React$useState = React.useState(false),
23
- _React$useState2 = (0, _slicedToArray2["default"])(_React$useState, 2),
24
- disabled = _React$useState2[0],
25
- setDisabled = _React$useState2[1];
26
- var copy = React.useCallback(/*#__PURE__*/function () {
27
- var _ref2 = (0, _asyncToGenerator2["default"])(/*#__PURE__*/(0, _regeneratorRuntime2["default"])().mark(function _callee(event) {
28
- var content;
29
- return (0, _regeneratorRuntime2["default"])().wrap(function _callee$(_context) {
30
- while (1) switch (_context.prev = _context.next) {
31
- case 0:
32
- clearTimeout(copyTimeoutRef.current);
33
- setDisabled(true);
34
- _context.prev = 2;
35
- content = typeof contents === 'function' ? contents() : contents;
36
- if (!content) {
37
- _context.next = 7;
38
- break;
39
- }
40
- _context.next = 7;
41
- return (0, _clipboardCopy["default"])(content);
42
- case 7:
43
- onCopied == null || onCopied();
44
- _context.next = 13;
45
- break;
46
- case 10:
47
- _context.prev = 10;
48
- _context.t0 = _context["catch"](2);
49
- onError == null || onError(_context.t0);
50
- case 13:
51
- onClick == null || onClick(event);
52
- copyTimeoutRef.current = setTimeout(function () {
53
- clearTimeout(copyTimeoutRef.current);
54
- setDisabled(false);
55
- }, timeout);
56
- case 15:
57
- case "end":
58
- return _context.stop();
59
- }
60
- }, _callee, null, [[2, 10]]);
61
- }));
62
- return function (_x) {
63
- return _ref2.apply(this, arguments);
64
- };
65
- }(), [contents, timeout, onCopied, onError, onClick]);
66
- return {
67
- copy: copy,
68
- disabled: disabled
69
- };
70
- }
@@ -1,51 +0,0 @@
1
- import * as React from 'react';
2
- import { Nodes } from 'hast';
3
- import { UseCopierOpts } from "../useCopier/index.js";
4
- type Source = Nodes;
5
- export type Variant = {
6
- component: React.ReactNode;
7
- fileName: string;
8
- source: Source;
9
- extraSource?: {
10
- [key: string]: Source;
11
- };
12
- };
13
- export type Demo = {
14
- name?: string;
15
- slug?: string;
16
- description?: string;
17
- variants: {
18
- [key: string]: Variant;
19
- };
20
- };
21
- type UseDemoOpts = {
22
- defaultOpen?: boolean;
23
- copy?: UseCopierOpts;
24
- githubUrlPrefix?: string;
25
- codeSandboxUrlPrefix?: string;
26
- stackBlitzPrefix?: string;
27
- };
28
- export declare function useDemo(demo: Demo, opts?: UseDemoOpts): {
29
- component: React.ReactNode;
30
- name: string | undefined;
31
- slug: string | undefined;
32
- description: string | undefined;
33
- ref: React.RefObject<HTMLDivElement | null>;
34
- variants: string[];
35
- selectedVariant: string;
36
- selectVariant: React.Dispatch<React.SetStateAction<string>>;
37
- files: {
38
- name: string;
39
- component: JSX.Element;
40
- }[];
41
- selectedFile: any;
42
- selectedFileName: string;
43
- selectFileName: React.Dispatch<React.SetStateAction<string>>;
44
- expanded: boolean;
45
- expand: () => void;
46
- setExpanded: React.Dispatch<React.SetStateAction<boolean>>;
47
- resetFocus: () => void;
48
- copy: (event: React.MouseEvent<HTMLButtonElement>) => Promise<void>;
49
- copyDisabled: boolean;
50
- };
51
- export {};
package/useDemo/index.js DELETED
@@ -1,112 +0,0 @@
1
- "use strict";
2
-
3
- var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard")["default"];
4
- var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault")["default"];
5
- Object.defineProperty(exports, "__esModule", {
6
- value: true
7
- });
8
- exports.useDemo = useDemo;
9
- var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
10
- var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
11
- var React = _interopRequireWildcard(require("react"));
12
- var _jsxRuntime = require("react/jsx-runtime");
13
- var _hastUtilToText = require("hast-util-to-text");
14
- var _hastUtilToJsxRuntime = require("hast-util-to-jsx-runtime");
15
- var _kebabCase = _interopRequireDefault(require("kebab-case"));
16
- var _useCopier2 = require("../useCopier");
17
- function toComponent(source) {
18
- return (0, _hastUtilToJsxRuntime.toJsxRuntime)(source, {
19
- Fragment: _jsxRuntime.Fragment,
20
- jsx: _jsxRuntime.jsx,
21
- jsxs: _jsxRuntime.jsxs
22
- });
23
- }
24
- function useDemo(demo, opts) {
25
- var _ref = opts || {},
26
- copyOpts = _ref.copy,
27
- _ref$defaultOpen = _ref.defaultOpen,
28
- defaultOpen = _ref$defaultOpen === void 0 ? false : _ref$defaultOpen;
29
- var slug = React.useMemo(function () {
30
- return demo.slug || (demo.name ? (0, _kebabCase["default"])(demo.name, false) : undefined);
31
- }, [demo.slug, demo.name]);
32
- var _React$useState = React.useState(defaultOpen),
33
- _React$useState2 = (0, _slicedToArray2["default"])(_React$useState, 2),
34
- expanded = _React$useState2[0],
35
- setExpanded = _React$useState2[1];
36
- var expand = React.useCallback(function () {
37
- return setExpanded(true);
38
- }, []);
39
- var ref = React.useRef(null);
40
- var resetFocus = React.useCallback(function () {
41
- var _ref$current;
42
- (_ref$current = ref.current) == null || _ref$current.focus();
43
- }, []);
44
- var variantKeys = React.useMemo(function () {
45
- return Object.keys(demo.variants);
46
- }, [demo.variants]);
47
- var _React$useState3 = React.useState(variantKeys[0]),
48
- _React$useState4 = (0, _slicedToArray2["default"])(_React$useState3, 2),
49
- selectedVariantKey = _React$useState4[0],
50
- setSelectedVariantKey = _React$useState4[1];
51
- var selectedVariant = demo.variants[selectedVariantKey];
52
- var _React$useState5 = React.useState(selectedVariant.fileName),
53
- _React$useState6 = (0, _slicedToArray2["default"])(_React$useState5, 2),
54
- selectedFileName = _React$useState6[0],
55
- setSelectedFileName = _React$useState6[1];
56
- var selectedFile = React.useMemo(function () {
57
- var _selectedVariant$extr;
58
- return selectedFileName === selectedVariant.fileName ? selectedVariant.source : (_selectedVariant$extr = selectedVariant.extraSource) == null ? void 0 : _selectedVariant$extr[selectedFileName];
59
- }, [selectedFileName, selectedVariant]);
60
-
61
- // if copying, convert the selected file's hast to text
62
- var sourceFileToText = React.useCallback(function () {
63
- return selectedFile && (0, _hastUtilToText.toText)(selectedFile, {
64
- whitespace: 'pre'
65
- });
66
- },
67
- // TODO: allow passing the filename to copy
68
- [selectedFile]);
69
- var _useCopier = (0, _useCopier2.useCopier)(sourceFileToText, copyOpts),
70
- copy = _useCopier.copy,
71
- copyDisabled = _useCopier.disabled;
72
-
73
- // transform hast source to React components
74
- var files = React.useMemo(function () {
75
- var extraSource = selectedVariant.extraSource;
76
- return [{
77
- name: selectedVariant.fileName,
78
- component: toComponent(selectedVariant.source)
79
- }].concat((0, _toConsumableArray2["default"])(extraSource ? Object.keys(extraSource).map(function (name) {
80
- return {
81
- name: name,
82
- component: toComponent(extraSource[name])
83
- };
84
- }) : []));
85
- }, [selectedVariant]);
86
- var selectedFileComponent = React.useMemo(function () {
87
- var matchedFile = files.find(function (file) {
88
- return file.name === selectedFileName;
89
- });
90
- return matchedFile ? matchedFile.component : null;
91
- }, [files, selectedFileName]);
92
- return {
93
- component: selectedVariant.component,
94
- name: demo.name,
95
- slug: slug,
96
- description: demo.description,
97
- ref: ref,
98
- variants: variantKeys,
99
- selectedVariant: selectedVariantKey,
100
- selectVariant: setSelectedVariantKey,
101
- files: files,
102
- selectedFile: selectedFileComponent,
103
- selectedFileName: selectedFileName,
104
- selectFileName: setSelectedFileName,
105
- expanded: expanded,
106
- expand: expand,
107
- setExpanded: setExpanded,
108
- resetFocus: resetFocus,
109
- copy: copy,
110
- copyDisabled: copyDisabled
111
- };
112
- }