npm - @qubit-ltd/rollup-builder - Versions diffs - 1.8.4 - Mend

@qubit-ltd/rollup-builder 1.8.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.

Files changed (49) hide show

package/LICENSE +201 -0
package/README.md +335 -0
package/README.zh_CN.md +288 -0
package/dist/rollup-builder.cjs +793 -0
package/dist/rollup-builder.cjs.map +1 -0
package/dist/rollup-builder.min.cjs +1 -0
package/dist/rollup-builder.min.cjs.map +1 -0
package/dist/rollup-builder.min.mjs +1 -0
package/dist/rollup-builder.min.mjs.map +1 -0
package/dist/rollup-builder.mjs +791 -0
package/dist/rollup-builder.mjs.map +1 -0
package/doc/api/fonts/OpenSans-Bold-webfont.eot +0 -0
package/doc/api/fonts/OpenSans-Bold-webfont.svg +1838 -0
package/doc/api/fonts/OpenSans-Bold-webfont.woff +0 -0
package/doc/api/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
package/doc/api/fonts/OpenSans-BoldItalic-webfont.svg +1838 -0
package/doc/api/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
package/doc/api/fonts/OpenSans-Italic-webfont.eot +0 -0
package/doc/api/fonts/OpenSans-Italic-webfont.svg +1838 -0
package/doc/api/fonts/OpenSans-Italic-webfont.woff +0 -0
package/doc/api/fonts/OpenSans-Light-webfont.eot +0 -0
package/doc/api/fonts/OpenSans-Light-webfont.svg +1839 -0
package/doc/api/fonts/OpenSans-Light-webfont.woff +0 -0
package/doc/api/fonts/OpenSans-LightItalic-webfont.eot +0 -0
package/doc/api/fonts/OpenSans-LightItalic-webfont.svg +1843 -0
package/doc/api/fonts/OpenSans-LightItalic-webfont.woff +0 -0
package/doc/api/fonts/OpenSans-Regular-webfont.eot +0 -0
package/doc/api/fonts/OpenSans-Regular-webfont.svg +1839 -0
package/doc/api/fonts/OpenSans-Regular-webfont.woff +0 -0
package/doc/api/fonts/OpenSans-Semibold-webfont.eot +0 -0
package/doc/api/fonts/OpenSans-Semibold-webfont.svg +1838 -0
package/doc/api/fonts/OpenSans-Semibold-webfont.ttf +0 -0
package/doc/api/fonts/OpenSans-Semibold-webfont.woff +0 -0
package/doc/api/fonts/OpenSans-SemiboldItalic-webfont.eot +0 -0
package/doc/api/fonts/OpenSans-SemiboldItalic-webfont.svg +1838 -0
package/doc/api/fonts/OpenSans-SemiboldItalic-webfont.ttf +0 -0
package/doc/api/fonts/OpenSans-SemiboldItalic-webfont.woff +0 -0
package/doc/api/global.html +2913 -0
package/doc/api/index.html +418 -0
package/doc/api/scripts/linenumber.js +34 -0
package/doc/api/scripts/prettify/Apache-License-2.0.txt +202 -0
package/doc/api/scripts/prettify/lang-css.js +2 -0
package/doc/api/scripts/prettify/prettify.js +28 -0
package/doc/api/styles/jsdoc-default.css +699 -0
package/doc/api/styles/prettify-jsdoc.css +120 -0
package/doc/api/styles/prettify-tomorrow.css +141 -0
package/doc/rollup-builder.min.visualization.html +4842 -0
package/doc/rollup-builder.visualization.html +4842 -0
package/package.json +85 -0

package/doc/api/index.html ADDED Viewed

@@ -0,0 +1,418 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <title>Home - Documentation</title>
+    <script src="scripts/prettify/prettify.js"></script>
+    <script src="scripts/prettify/lang-css.js"></script>
+    <!--[if lt IE 9]>
+      <script src="https://cdn.bootcdn.net/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="https://cdn.bootcdn.net/ajax/libs/ionicons/2.0.1/css/ionicons.min.css">
+    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+</head>
+<body>
+<input type="checkbox" id="nav-trigger" class="nav-trigger" />
+<label for="nav-trigger" class="navicon-button x">
+  <div class="navicon"></div>
+</label>
+<label for="nav-trigger" class="overlay"></label>
+<nav>
+    <li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#configAliasPlugin">configAliasPlugin</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#configAnalyzerPlugin">configAnalyzerPlugin</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#configBabelPlugin">configBabelPlugin</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#configCommonJsPlugin">configCommonJsPlugin</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#configNodeResolvePlugin">configNodeResolvePlugin</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#configTerserPlugin">configTerserPlugin</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#configVisualizerPlugin">configVisualizerPlugin</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#getRollupExternal">getRollupExternal</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#getRollupOutput">getRollupOutput</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#getRollupPlugins">getRollupPlugins</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#rollupBuilder">rollupBuilder</a></span></li>
+</nav>
+<div id="main">
+    <section class="readme">
+        <article><h1>Rollup Builder</h1>
+<p><a href="https://npmjs.com/package/@haixing_hu/rollup-builder"><img src="https://img.shields.io/npm/v/@haixing_hu/rollup-builder.svg" alt="npm package"></a>
+<a href="https://www.apache.org/licenses/LICENSE-2.0"><img src="https://img.shields.io/badge/License-Apache-blue.svg" alt="License"></a>
+<a href="README.zh_CN.md"><img src="https://img.shields.io/badge/%E6%96%87%E6%A1%A3-%E4%B8%AD%E6%96%87%E7%89%88-blue.svg" alt="中文文档"></a>
+<a href="https://dl.circleci.com/status-badge/redirect/gh/Haixing-Hu/rollup-builder/tree/master"><img src="https://dl.circleci.com/status-badge/img/gh/Haixing-Hu/rollup-builder/tree/master.svg?style=shield" alt="CircleCI"></a></p>
+<p><code>rollup-builder</code> provides a utility function to simplify the process of building
+JavaScript libraries using the <a href="https://rollupjs.org/">Rollup</a> bundler. It allows you to generate various
+formats such as CommonJS (CJS), ES Module (ESM), and Universal Module Definition
+(UMD), and gives you the option to choose whether to perform code minification.</p>
+<h2>Table of Contents</h2>
+<ul>
+<li><a href="#features">Features</a></li>
+<li><a href="#installation">Installation</a></li>
+<li><a href="#usage">Usage</a></li>
+<li><a href="#configuration">Configuration Options</a></li>
+<li><a href="#mix-default-named">Mixing Default and Named Exports</a></li>
+<li><a href="#contributions">Contributions</a></li>
+<li><a href="#license">License</a></li>
+</ul>
+<h2><span id="features">Features</span></h2>
+<ul>
+<li>Build JavaScript libraries in multiple formats, making them compatible with a
+variety of environments.</li>
+<li>Minify your library for production use with ease.</li>
+<li>Automatic generation of sourcemaps for debugging.</li>
+<li>Configure the library's format, filename, and more using simple options.</li>
+<li>You can <a href="#mix-default-named">mix default and named exports</a> in ESM modules and
+the <a href="https://rollupjs.org/">Rollup</a> will generate code in CJS or UMD format that compatible with both
+CommonJS and ES6.</li>
+<li>Highly customizable using <a href="https://rollupjs.org/">Rollup</a> plugins and custom configurations.</li>
+</ul>
+<h2><span id="installation">Installation</span></h2>
+<p>You can install <code>rollup-builder</code> as a development dependency using <code>npm</code> or <code>yarn</code>:</p>
+<pre class="prettyprint source lang-bash"><code>npm install @haixing_hu/rollup-builder --save-dev
+# or
+yarn add @haixing_hu/rollup-builder --dev
+</code></pre>
+<h2><span id="usage">Usage</span></h2>
+<ol>
+<li>
+<p>Create a <a href="https://rollupjs.org/">Rollup</a> configuration file (usually named <code>rollup.config.mjs</code>) and
+export a function that defines the library's build options. You can use the
+provided <code>rollupBuilder</code> function to streamline this process.</p>
+<p>Example <code>rollup.config.mjs</code>:</p>
+<pre class="prettyprint source lang-js"><code>import rollupBuilder from '@haixing_hu/rollup-builder';
+export default rollupBuilder('MyLibrary', import.meta.url);
+</code></pre>
+</li>
+<li>
+<p>Customize the <code>rollup.config.mjs</code> file to match your library's specific
+requirements. You can specify the input file, formats, filename prefix, and
+other options. Refer to the <a href="#configuration">Configuration Options</a> section
+for more details.</p>
+<p>Example <code>rollup.config.mjs</code>:</p>
+<pre class="prettyprint source lang-js"><code>import rollupBuilder from '@haixing_hu/rollup-builder';
+export default rollupBuilder('MyLibrary', import.meta.url, {
+  formats: ['cjs', 'esm'],
+  minify: true,
+  // Customize additional options as needed.
+});
+</code></pre>
+</li>
+<li>
+<p>Run the <a href="https://rollupjs.org/">Rollup</a> build process using the following command:</p>
+<pre class="prettyprint source lang-bash"><code>rollup -c rollup.config.mjs
+</code></pre>
+</li>
+<li>
+<p>The resulting library files will be placed in the <code>dist</code> directory, following
+the format you specified. For example, if you specified <code>formats: ['cjs', 'esm']</code>,
+the following files will be generated:</p>
+<pre class="prettyprint source lang-bash"><code> dist/my-library.cjs.js
+ dist/my-library.cjs.min.js
+ dist/my-library.esm.mjs
+ dist/my-library.esm.min.mjs
+</code></pre>
+</li>
+<li>
+<p>You should modify your <code>package.json</code> file to specify the entry point of your
+library. For example, if you specified <code>formats: ['cjs', 'esm']</code>, you should
+add the following lines to your <code>package.json</code> file:</p>
+<pre class="prettyprint source lang-json"><code>{
+  &quot;main&quot;: &quot;dist/my-library.cjs.min.js&quot;,
+  &quot;module&quot;: &quot;dist/my-library.esm.min.mjs&quot;,
+  &quot;exports&quot;: {
+      &quot;.&quot;: {
+         &quot;require&quot;: &quot;./dist/my-library.cjs.min.js&quot;,
+         &quot;import&quot;: &quot;./dist/my-library.esm.min.mjs&quot;
+      }
+  }
+}
+</code></pre>
+</li>
+<li>
+<p>You should add the following dev dependencies to your library:</p>
+<pre class="prettyprint source lang-bash"><code>yarn add --dev @babel/core @babel/plugin-transform-runtime @babel/preset-env \
+  @rollup/plugin-alias @rollup/plugin-babel @rollup/plugin-commonjs \
+  @rollup/plugin-node-resolve @rollup/plugin-terser rollup rollup-plugin-analyzer
+</code></pre>
+<p>or</p>
+<pre class="prettyprint source lang-bash"><code>npm install -D @babel/core @babel/plugin-transform-runtime @babel/preset-env \
+  @rollup/plugin-alias @rollup/plugin-babel @rollup/plugin-commonjs \
+  @rollup/plugin-node-resolve @rollup/plugin-terser rollup rollup-plugin-analyzer
+</code></pre>
+</li>
+</ol>
+<h2><span id="configuration">Configuration Options</span></h2>
+<ul>
+<li><code>libraryName: string</code>: The name of your library (used in the UMD format).</li>
+<li><code>importMetaUrl: string</code>: The <code>import.meta.url</code> of the caller module.</li>
+<li><code>options: object</code>: Additional build options, including:
+<ul>
+<li>
+<p><code>debug: boolean</code>: Whether to print debug information. If this field is not
+specified, the default value is <code>false</code>.</p>
+</li>
+<li>
+<p><code>formats: [string]</code>: An array of formats to build. It can be an array
+of the following values:</p>
+<ul>
+<li><code>'cjs'</code>: the CommonJS format.</li>
+<li><code>'umd'</code>: the UMD format.</li>
+<li><code>'esm'</code>: the ES module format.</li>
+</ul>
+<p>If this field is not specified, the default value is <code>['cjs', 'esm']</code>.</p>
+</li>
+<li>
+<p><code>exports: string</code>: the export mode to use. It can be one of the following
+values:</p>
+<ul>
+<li><code>'auto'</code>: automatically guesses your intentions based on what the
+input module exports.</li>
+<li><code>'default'</code>: if you are only exporting one thing using
+<code>export default ...</code>; note that this can cause issues when generating
+CommonJS output that is meant to be interchangeable with ESM output.</li>
+<li><code>'named'</code>: if you are using named exports.</li>
+<li><code>'none'</code>: if you are not exporting anything (e.g. you are building an
+app, not a library)</li>
+<li><code>'mixed'</code>: if you are using named exports mixed with a default export.
+Note that this is not a standard exports mode officially supported by
+<a href="https://rollupjs.org/">Rollup</a>, instead, it is an additional mode add by this library.
+Refer to the <a href="#mix-default-named">Mixing Default and Named Exports</a> for
+more details.</li>
+</ul>
+<p>If this field is not specified, the default value is <code>'auto'</code>.</p>
+</li>
+<li>
+<p><code>nodeEnv: string</code>: The <code>NODE_ENV</code> environment variable. If this field is
+not specified, the default value is <code>process.env.NODE_ENV</code>.</p>
+</li>
+<li>
+<p><code>minify: boolean</code>: Whether to minify the code. If this field is not
+specified, the default value will be <code>true</code> for production environment,
+and <code>false</code> otherwise.</p>
+</li>
+<li>
+<p><code>sourcemap: boolean</code>: Whether to generate sourcemaps. If this field is not
+specified, the default value is <code>true</code>.</p>
+</li>
+<li>
+<p><code>input: string</code>: The input file of the library. If this field is not
+specified, the default value is <code>src/index.js</code>.</p>
+</li>
+<li>
+<p><code>outputDir: string</code>: The output directory of the library. If this field
+is not specified, the default value is <code>dist</code>.</p>
+</li>
+<li>
+<p><code>filenamePrefix: string</code>: The prefix for the output filename. If this
+field is not specified, the default value the dash-case of the library
+name.</p>
+</li>
+<li>
+<p><code>externals: [string]</code>: the additional external packages, each can be
+specified with either a string or a regular expression. If this field is
+not specified, the default value is an empty array.</p>
+</li>
+<li>
+<p><code>useAliasPlugin: boolean</code>: whether to use the <code>@rollup/plugin-alias</code>
+plugin. If this field is not specified, the default value is <code>true</code>.</p>
+</li>
+<li>
+<p><code>aliasPluginOptions: object</code>: the options for the <code>@rollup/plugin-alias</code>
+plugin. If this field is not specified, the default value is:</p>
+<pre class="prettyprint source lang-js"><code>{
+  entries: {
+    'src': fileURLToPath(new URL('src', importMetaUrl)),
+  },
+}
+</code></pre>
+</li>
+<li>
+<p><code>useNodeResolvePlugin: boolean</code>: whether to use the <code>@rollup/plugin-node-resolve</code>
+plugin. If this field is not specified, the default value is <code>true</code>.</p>
+</li>
+<li>
+<p><code>nodeResolvePluginOptions: object</code>: the options for the <code>@rollup/plugin-node-resolve</code>
+plugin. If this field is not specified, the default value is: <code>{}</code>.</p>
+</li>
+<li>
+<p><code>useCommonjsPlugin: boolean</code>: whether to use the <code>@rollup/plugin-commonjs</code> plugin.
+If this field is not specified, the default value is <code>true</code>.</p>
+</li>
+<li>
+<p><code>commonjsPluginOptions: object</code>: the options for the <code>@rollup/plugin-commonjs</code>
+plugin. If this field is not specified, the default value is:</p>
+<pre class="prettyprint source lang-js"><code>{
+  include: ['node_modules/**']
+}
+</code></pre>
+</li>
+<li>
+<p><code>useBabelPlugin: boolean</code>: whether to use the <code>@rollup/plugin-babel</code> plugin.
+If this field is not specified, the default value is <code>true</code>.</p>
+</li>
+<li>
+<p><code>babelPluginOptions: object</code>: the options for the <code>@rollup/plugin-babel</code> plugin.
+If this field is not specified, the default value is:</p>
+<pre class="prettyprint source lang-js"><code>{
+  babelHelpers: 'runtime',
+  exclude: ['node_modules/**'],
+  presets: [
+    '@babel/preset-env',
+  ],
+  plugins: [
+    '@babel/plugin-transform-runtime',
+  ]
+}
+</code></pre>
+<p>Note that if use the <code>@rollup/plugin-babel</code> plugin, you can also specify
+the configuration of Babel in the standard Babel configuration files,
+such as <code>babel.config.js</code>, <code>.babelrc</code>, etc.</p>
+</li>
+<li>
+<p><code>terserOptions: object</code>: the options for the <code>@rollup/plugin-terser</code> plugin.
+If this field is not specified, the default value is: <code>{}</code>. Whether
+to use the <code>@rollup/plugin-terser</code> plugin depends on the <code>minify</code>
+field of the options or the <code>NODE_ENV</code> environment variable.</p>
+</li>
+<li>
+<p><code>useAnalyzerPlugin: boolean</code>: whether to use the <code>rollup-plugin-analyzer</code> plugin.
+If this field is not specified, the default value is <code>true</code>.</p>
+</li>
+<li>
+<p><code>analyzerOptions: object</code>: the options for the <code>rollup-plugin-analyzer</code> plugin.
+If this field is not specified, the default value is:</p>
+<pre class="prettyprint source lang-js"><code>{
+  hideDeps: true,
+  limit: 0,
+  summaryOnly: true,
+}
+</code></pre>
+</li>
+<li>
+<p><code>useVisualizerPlugin: boolean</code>: whether to use the <code>rollup-plugin-visualizer</code> plugin.
+If this field is not specified, the default value is <code>true</code>.</p>
+</li>
+<li>
+<p><code>visualizerPluginOptions: object</code>: the options for the <code>rollup-plugin-visualizer</code> plugin.
+If this field is not specified, the default value is:</p>
+<pre class="prettyprint source lang-js"><code>{
+  filename: './doc/${filenameBase}.visualization.html',
+  gzipSize: true,
+  brotliSize: true,
+}
+</code></pre>
+<p>where the <code>filenameBase</code> is the basename of the compiled library file in the
+<code>./dist</code> directory.</p>
+</li>
+<li>
+<p><code>plugins: [object]</code>: the additional <a href="https://rollupjs.org/">Rollup</a> plugins. If this field is not
+specified, the default value is an empty array.</p>
+</li>
+</ul>
+</li>
+</ul>
+<h2><span id="mix-default-named">Mixing Default and Named Exports</span></h2>
+<p>If an ESM module has both default export and named exports, <a href="https://rollupjs.org/">Rollup</a> cannot
+handle it correctly. For example, the following is a source ESM module:</p>
+<pre class="prettyprint source lang-js"><code>export { Foo, Bar };
+export default Foo;
+</code></pre>
+<p>The rollup will translate it into the following codes:</p>
+<pre class="prettyprint source lang-js"><code>exports.Foo = Foo;
+exports.Bar = Bar;
+exports.default = Foo;
+</code></pre>
+<p>However, a common-js consumer will use the module as follows:</p>
+<pre class="prettyprint source lang-js"><code>const Foo = require('my-module');
+</code></pre>
+<p>which will cause an error. The correct usage should be</p>
+<pre class="prettyprint source lang-js"><code>const Foo = require('my-module').default
+</code></pre>
+<p>But unfortunately, <a href="https://rollupjs.org/">Rollup</a> will translate the ESM default import as follows:</p>
+<pre class="prettyprint source lang-js"><code>// source
+import Foo from 'my-module';
+// translated
+const Foo = require('my-module');
+</code></pre>
+<p>Note that the above translation has no <code>.default</code> suffix, which will cause an error.</p>
+<p>If you mix default and named exports in an ESM module, <a href="https://rollupjs.org/">Rollup</a> will generate
+a warning message as follows:</p>
+<pre class="prettyprint source lang-bash"><code>(!) Mixing named and default exports
+https://rollupjs.org/configuration-options/#output-exports
+The following entry modules are using named and default exports together:
+src/index.js
+Consumers of your bundle will have to use chunk.default to access their default export, which may not be what you want. Use `output.exports: &quot;named&quot;` to disable this warning.
+</code></pre>
+<p>The workaround is copied from the <a href="https://github.com/rollup/plugins/blob/master/shared/rollup.config.mjs">source code of the official rollup plugins</a>.
+It makes the rollup option <code>output.exports</code> to <code>'named'</code> and adds a simple footer
+statements to each <code>CJS</code> format bundle:</p>
+<pre class="prettyprint source lang-js"><code>module.exports = Object.assign(exports.default, exports);
+</code></pre>
+<p>With this workaround, <a href="https://rollupjs.org/">Rollup</a> will transform mixed exports into the following form:</p>
+<pre class="prettyprint source lang-js"><code>exports.Foo = Foo;
+exports.Bar = Bar;
+exports.default = Foo;
+module.exports = Object.assign(exports.default, exports);
+</code></pre>
+<p>Thus, the caller can directly use the following methods to import the default export:</p>
+<pre class="prettyprint source lang-js"><code>const Foo = require('my-module');
+// or
+import Foo from 'my-module';
+</code></pre>
+<p>See the following web pages for more details:</p>
+<ul>
+<li><a href="https://rollupjs.org/configuration-options/#output-exports">Rollup Configuration Options: output.exports</a></li>
+<li><a href="https://github.com/rollup/rollup/issues/1961">Issue #1961: Question regarding mixing default and named exports</a></li>
+<li><a href="https://stackoverflow.com/questions/58246998/mixing-default-and-named-exports-with-rollup">StackOverflow: Mixing default and named exports with Rollup</a></li>
+<li><a href="https://github.com/avisek/rollup-patch-seamless-default-export">Github Repository: rollup-patch-seamless-default-export</a></li>
+</ul>
+<p><strong>NOTE:</strong> In order to use this feature, you must specify the <code>exports</code> option to
+<code>'mixed'</code> in the <code>rollup.config.mjs</code> file, i.e.,</p>
+<pre class="prettyprint source lang-js"><code>import rollupBuilder from '@haixing_hu/rollup-builder';
+export default rollupBuilder('MyLibrary', import.meta.url, { exports: 'mixed' });
+</code></pre>
+<h2><span id="contributions">Contributions</span></h2>
+<p>Contributions are welcome! If you find any issues or have suggestions for
+improvements, please feel free to open an issue or create a pull request.</p>
+<h2><span id="license">License</span></h2>
+<p>This project is licensed under the Apache 2.0 License.
+See the <a href="LICENSE">LICENSE</a> file for details.</p></article>
+    </section>
+</div>
+<br class="clear">
+<footer>
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a>
+     on Sun Jan 05 2025 14:08:32 GMT+0800 (China Standard Time)
+    using the <a href="https://github.com/Haixing-Hu/jsdoc-minami">customized Minami theme</a>.
+</footer>
+<script>prettyPrint();</script>
+<script src="scripts/linenumber.js"></script>
+</body>
+</html>

package/doc/api/scripts/linenumber.js ADDED Viewed

@@ -0,0 +1,34 @@
+////////////////////////////////////////////////////////////////////////////////
+//
+//    Copyright (c) 2022 - 2023.
+//    Haixing Hu, Qubit Co. Ltd.
+//
+//    All rights reserved.
+//
+////////////////////////////////////////////////////////////////////////////////
+/*global document */
+(function() {
+    var source = document.getElementsByClassName('prettyprint source linenums');
+    var i = 0;
+    var lineNumber = 0;
+    var lineId;
+    var lines;
+    var totalLines;
+    var anchorHash;
+    if (source && source[0]) {
+        anchorHash = document.location.hash.substring(1);
+        lines = source[0].getElementsByTagName('li');
+        totalLines = lines.length;
+        for (; i < totalLines; i++) {
+            lineNumber++;
+            lineId = 'line' + lineNumber;
+            lines[i].id = lineId;
+            if (lineId === anchorHash) {
+                lines[i].className += ' selected';
+            }
+        }
+    }
+})();

package/doc/api/scripts/prettify/Apache-License-2.0.txt ADDED Viewed

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+   1. Definitions.
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+   END OF TERMS AND CONDITIONS
+   APPENDIX: How to apply the Apache License to your work.
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+   Copyright [yyyy] [name of copyright owner]
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.