instantsearch-ui-components 0.0.0 → 0.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015-present Algolia, Inc.
+
+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 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/README.md

@@ -1,3 +1,44 @@
-# InstantSearch UI Components
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
-These components are used by InstantSearch to build UI for search and discovery interfaces. Compatible with Vanilla JavaScript, React, and Vue).
+- [instantsearch-ui-components](#instantsearch-ui-components)
+  - [Contributing](#contributing)
+  - [License](#license)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+# instantsearch-ui-components
+
+InstantSearch UI Components is an open-source UI library used by InstantSearch to build UI for search and discovery interfaces. It exports UI components that are compatible with InstantSearch.js, React InstantSearch, and Vue InstantSearch.
+
+> Note: `instantsearch-ui-components` exists for internal usage and isn't designed for public consumption.
+
+## Contributing
+
+We welcome all contributors, from casual to regular 💙
+
+- **Bug report**. Is something not working as expected? [Send a bug report][contributing-bugreport].
+- **Feature request**. Would you like to add something to the library? [Send a feature request][contributing-featurerequest].
+- **Documentation**. Did you find a typo in the doc? [Open an issue][contributing-newissue] and we'll take care of it.
+- **Development**. If you don't know where to start, you can check the open issues that are [tagged easy][contributing-label-easy], the [bugs][contributing-label-bug] or [chores][contributing-label-chore].
+
+To start contributing to code, you need to:
+
+1.  [Fork the project](https://help.github.com/articles/fork-a-repo/)
+1.  [Clone the repository](https://help.github.com/articles/cloning-a-repository/)
+1.  Install the dependencies: `yarn`
+
+Please read [our contribution process](https://github.com/algolia/instantsearch/blob/master/CONTRIBUTING.md) to learn more.
+
+## License
+
+InstantSearch UI Components is [MIT licensed](../../LICENSE).
+
+<!-- Links -->
+
+[contributing-bugreport]: https://github.com/algolia/instantsearch/issues/new?template=BUG_REPORT.yml&labels=triage,Library%3A%20React+InstantSearch
+[contributing-featurerequest]: https://github.com/algolia/instantsearch/discussions/new?category=ideas&labels=triage,Library%3A%20React+InstantSearch&title=Feature%20request%3A%20
+[contributing-newissue]: https://github.com/algolia/instantsearch/issues/new?labels=triage,Library%3A%20React+InstantSearch
+[contributing-label-easy]: https://github.com/algolia/instantsearch/issues?q=is%3Aopen+is%3Aissue+label%3A%22Difficulty%3A+Easy%22+label%3A%22Library%3A%20React+InstantSearch%22
+[contributing-label-bug]: https://github.com/algolia/instantsearch/issues?q=is%3Aissue+is%3Aopen+label%3A%22Type%3A+Bug%22+label%3A%22Library%3A%20React+InstantSearch%22
+[contributing-label-chore]: https://github.com/algolia/instantsearch/issues?q=is%3Aissue+is%3Aopen+label%3A%22Type%3A+Chore%22+label%3A%22Library%3A%20React+InstantSearch%22

package/dist/cjs/components/Highlight.js

@@ -0,0 +1,66 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createHighlightComponent = createHighlightComponent;
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
+var _lib = require("../lib");
+var _excluded = ["parts", "highlightedTagName", "nonHighlightedTagName", "separator", "className", "classNames"];
+function createHighlightPartComponent(_ref) {
+  var createElement = _ref.createElement;
+  return function HighlightPart(_ref2) {
+    var classNames = _ref2.classNames,
+      children = _ref2.children,
+      highlightedTagName = _ref2.highlightedTagName,
+      isHighlighted = _ref2.isHighlighted,
+      nonHighlightedTagName = _ref2.nonHighlightedTagName;
+    var TagName = isHighlighted ? highlightedTagName : nonHighlightedTagName;
+    return createElement(TagName, {
+      className: isHighlighted ? classNames.highlighted : classNames.nonHighlighted
+    }, children);
+  };
+}
+function createHighlightComponent(_ref3) {
+  var createElement = _ref3.createElement,
+    Fragment = _ref3.Fragment;
+  var HighlightPart = createHighlightPartComponent({
+    createElement: createElement,
+    Fragment: Fragment
+  });
+  return function Highlight(userProps) {
+    // Not destructured in function signature, to make sure it's not exposed in
+    // the type definition.
+    var parts = userProps.parts,
+      _userProps$highlighte = userProps.highlightedTagName,
+      highlightedTagName = _userProps$highlighte === void 0 ? 'mark' : _userProps$highlighte,
+      _userProps$nonHighlig = userProps.nonHighlightedTagName,
+      nonHighlightedTagName = _userProps$nonHighlig === void 0 ? 'span' : _userProps$nonHighlig,
+      _userProps$separator = userProps.separator,
+      separator = _userProps$separator === void 0 ? ', ' : _userProps$separator,
+      className = userProps.className,
+      _userProps$classNames = userProps.classNames,
+      classNames = _userProps$classNames === void 0 ? {} : _userProps$classNames,
+      props = (0, _objectWithoutProperties2.default)(userProps, _excluded);
+    return createElement("span", (0, _extends2.default)({}, props, {
+      className: (0, _lib.cx)(classNames.root, className)
+    }), parts.map(function (part, partIndex) {
+      var isLastPart = partIndex === parts.length - 1;
+      return createElement(Fragment, {
+        key: partIndex
+      }, part.map(function (subPart, subPartIndex) {
+        return createElement(HighlightPart, {
+          key: subPartIndex,
+          classNames: classNames,
+          highlightedTagName: highlightedTagName,
+          nonHighlightedTagName: nonHighlightedTagName,
+          isHighlighted: subPart.isHighlighted
+        }, subPart.value);
+      }), !isLastPart && createElement("span", {
+        className: classNames.separator
+      }, separator));
+    }));
+  };
+}

package/dist/cjs/components/index.js

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _Highlight = require("./Highlight");
+Object.keys(_Highlight).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _Highlight[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _Highlight[key];
+    }
+  });
+});

package/dist/cjs/index.js

@@ -0,0 +1,38 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _components = require("./components");
+Object.keys(_components).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _components[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _components[key];
+    }
+  });
+});
+var _lib = require("./lib");
+Object.keys(_lib).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _lib[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _lib[key];
+    }
+  });
+});
+var _types = require("./types");
+Object.keys(_types).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _types[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _types[key];
+    }
+  });
+});

package/dist/cjs/lib/cx.js

@@ -0,0 +1,17 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.cx = cx;
+function cx() {
+  for (var _len = arguments.length, classNames = new Array(_len), _key = 0; _key < _len; _key++) {
+    classNames[_key] = arguments[_key];
+  }
+  return classNames.reduce(function (acc, className) {
+    if (Array.isArray(className)) {
+      return acc.concat(className);
+    }
+    return acc.concat([className]);
+  }, []).filter(Boolean).join(' ');
+}

package/dist/cjs/lib/index.js

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _cx = require("./cx");
+Object.keys(_cx).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _cx[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _cx[key];
+    }
+  });
+});

package/dist/cjs/package.json

@@ -0,0 +1 @@
+{ "type": "commonjs", "sideEffects": false }

package/dist/cjs/types/Renderer.js

@@ -0,0 +1 @@
+"use strict";

package/dist/cjs/types/index.js

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _Renderer = require("./Renderer");
+Object.keys(_Renderer).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _Renderer[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _Renderer[key];
+    }
+  });
+});

package/dist/cjs/version.js

@@ -0,0 +1,8 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _default = '0.3.0';
+exports.default = _default;

package/dist/es/components/Highlight.d.ts

@@ -0,0 +1,32 @@
+import type { ComponentChildren, ComponentProps, ElementType, Renderer } from '../types';
+type HighlightedPart = {
+    isHighlighted: boolean;
+    value: string;
+};
+export type HighlightClassNames = {
+    /**
+     * Class names to apply to the root element
+     */
+    root: string;
+    /**
+     * Class names to apply to the highlighted parts
+     */
+    highlighted: string;
+    /**
+     * Class names to apply to the non-highlighted parts
+     */
+    nonHighlighted: string;
+    /**
+     * Class names to apply to the separator between highlighted parts
+     */
+    separator: string;
+};
+export type HighlightProps = ComponentProps<'span'> & {
+    classNames?: Partial<HighlightClassNames>;
+    highlightedTagName?: ElementType;
+    nonHighlightedTagName?: ElementType;
+    separator?: ComponentChildren;
+    parts: HighlightedPart[][];
+};
+export declare function createHighlightComponent({ createElement, Fragment, }: Renderer): (userProps: HighlightProps) => JSX.Element;
+export {};

package/dist/es/components/Highlight.js

@@ -0,0 +1,59 @@
+import _extends from "@babel/runtime/helpers/extends";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+var _excluded = ["parts", "highlightedTagName", "nonHighlightedTagName", "separator", "className", "classNames"];
+import { cx } from "../lib/index.js";
+function createHighlightPartComponent(_ref) {
+  var createElement = _ref.createElement;
+  return function HighlightPart(_ref2) {
+    var classNames = _ref2.classNames,
+      children = _ref2.children,
+      highlightedTagName = _ref2.highlightedTagName,
+      isHighlighted = _ref2.isHighlighted,
+      nonHighlightedTagName = _ref2.nonHighlightedTagName;
+    var TagName = isHighlighted ? highlightedTagName : nonHighlightedTagName;
+    return createElement(TagName, {
+      className: isHighlighted ? classNames.highlighted : classNames.nonHighlighted
+    }, children);
+  };
+}
+export function createHighlightComponent(_ref3) {
+  var createElement = _ref3.createElement,
+    Fragment = _ref3.Fragment;
+  var HighlightPart = createHighlightPartComponent({
+    createElement: createElement,
+    Fragment: Fragment
+  });
+  return function Highlight(userProps) {
+    // Not destructured in function signature, to make sure it's not exposed in
+    // the type definition.
+    var parts = userProps.parts,
+      _userProps$highlighte = userProps.highlightedTagName,
+      highlightedTagName = _userProps$highlighte === void 0 ? 'mark' : _userProps$highlighte,
+      _userProps$nonHighlig = userProps.nonHighlightedTagName,
+      nonHighlightedTagName = _userProps$nonHighlig === void 0 ? 'span' : _userProps$nonHighlig,
+      _userProps$separator = userProps.separator,
+      separator = _userProps$separator === void 0 ? ', ' : _userProps$separator,
+      className = userProps.className,
+      _userProps$classNames = userProps.classNames,
+      classNames = _userProps$classNames === void 0 ? {} : _userProps$classNames,
+      props = _objectWithoutProperties(userProps, _excluded);
+    return createElement("span", _extends({}, props, {
+      className: cx(classNames.root, className)
+    }), parts.map(function (part, partIndex) {
+      var isLastPart = partIndex === parts.length - 1;
+      return createElement(Fragment, {
+        key: partIndex
+      }, part.map(function (subPart, subPartIndex) {
+        return createElement(HighlightPart, {
+          key: subPartIndex,
+          classNames: classNames,
+          highlightedTagName: highlightedTagName,
+          nonHighlightedTagName: nonHighlightedTagName,
+          isHighlighted: subPart.isHighlighted
+        }, subPart.value);
+      }), !isLastPart && createElement("span", {
+        className: classNames.separator
+      }, separator));
+    }));
+  };
+}

package/dist/es/components/index.d.ts

@@ -0,0 +1 @@
+export * from './Highlight';

package/dist/es/components/index.js

@@ -0,0 +1 @@
+export * from "./Highlight.js";

package/dist/es/index.d.ts

@@ -0,0 +1,3 @@
+export * from './components';
+export * from './lib';
+export * from './types';

package/dist/es/index.js

@@ -0,0 +1,3 @@
+export * from "./components/index.js";
+export * from "./lib/index.js";
+export * from "./types/index.js";

package/dist/es/lib/cx.d.ts

@@ -0,0 +1,3 @@
+type ClassValue = string | undefined | boolean | null | number;
+export declare function cx(...classNames: Array<ClassValue | ClassValue[]>): string;
+export {};

package/dist/es/lib/cx.js

@@ -0,0 +1,11 @@
+export function cx() {
+  for (var _len = arguments.length, classNames = new Array(_len), _key = 0; _key < _len; _key++) {
+    classNames[_key] = arguments[_key];
+  }
+  return classNames.reduce(function (acc, className) {
+    if (Array.isArray(className)) {
+      return acc.concat(className);
+    }
+    return acc.concat([className]);
+  }, []).filter(Boolean).join(' ');
+}

package/dist/es/lib/index.d.ts

@@ -0,0 +1 @@
+export * from './cx';

package/dist/es/lib/index.js

@@ -0,0 +1 @@
+export * from "./cx.js";

package/dist/es/types/Renderer.d.ts

@@ -0,0 +1,43 @@
+declare global {
+    namespace JSX {
+        interface Element {
+        }
+        interface IntrinsicElements {
+        }
+    }
+}
+type IntrinsicElements = keyof JSX.IntrinsicElements extends never ? Record<string, unknown> : JSX.IntrinsicElements;
+export type Pragma = (type: any, props: Record<string, any> | null, ...children: ComponentChildren[]) => JSX.Element;
+export type PragmaFrag = any;
+type ComponentChild = VNode<any> | object | string | number | boolean | null | undefined;
+export type ComponentChildren = ComponentChild[] | ComponentChild;
+type PropsWithChildren<TProps> = TProps & {
+    children?: ComponentChildren;
+};
+type FunctionComponent<TProps = Record<string, any>> = (props: PropsWithChildren<TProps>, context?: any) => JSX.Element;
+export type ElementType<TProps = any> = {
+    [TKey in keyof IntrinsicElements]: TProps extends IntrinsicElements[TKey] ? TKey : never;
+}[keyof IntrinsicElements] | FunctionComponent<TProps>;
+export type ComponentProps<TComponent extends keyof IntrinsicElements> = IntrinsicElements[TComponent];
+export type VNode<TProps = any> = {
+    type: any;
+    props: TProps & {
+        children: ComponentChildren;
+        key?: string | number | null;
+    };
+};
+export type Renderer = {
+    /**
+     * The function to create virtual nodes.
+     *
+     * @default preact.createElement
+     */
+    createElement: Pragma;
+    /**
+     * The component to use to create fragments.
+     *
+     * @default preact.Fragment
+     */
+    Fragment: PragmaFrag;
+};
+export {};

package/dist/es/types/Renderer.js

@@ -0,0 +1 @@
+export {};

package/dist/es/types/index.d.ts

@@ -0,0 +1 @@
+export * from './Renderer';

package/dist/es/types/index.js

@@ -0,0 +1 @@
+export * from "./Renderer.js";

package/dist/es/version.d.ts

@@ -0,0 +1,2 @@
+declare const _default: "0.3.0";
+export default _default;

package/dist/es/version.js

@@ -0,0 +1 @@
+export default '0.3.0';

package/package.json

@@ -1,5 +1,48 @@
 {
   "name": "instantsearch-ui-components",
-  "version": "0.0.0",
-  "description": "InstantSearch UI Components"
+  "version": "0.3.0",
+  "description": "Common UI components for InstantSearch.",
+  "types": "dist/es/index.d.ts",
+  "main": "dist/cjs/index.js",
+  "module": "dist/es/index.js",
+  "type": "module",
+  "exports": {
+    "types": "./dist/es/index.d.ts",
+    "require": "./dist/cjs/index.js",
+    "default": "./dist/es/index.js"
+  },
+  "sideEffects": false,
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/algolia/instantsearch"
+  },
+  "author": {
+    "name": "Algolia, Inc.",
+    "url": "https://www.algolia.com"
+  },
+  "keywords": [
+    "algolia",
+    "components",
+    "fast",
+    "instantsearch",
+    "react",
+    "search",
+    "jsx",
+    "vdom",
+    "hyperscript"
+  ],
+  "files": [
+    "README.md",
+    "dist"
+  ],
+  "scripts": {
+    "clean": "rm -rf dist",
+    "build": "yarn build:cjs && yarn build:es && yarn build:types",
+    "build:es": "BABEL_ENV=es babel src --root-mode upward --extensions '.js,.ts,.tsx' --out-dir dist/es --ignore '**/__tests__/**/*','**/__mocks__/**/*' --quiet",
+    "build:cjs": "BABEL_ENV=cjs babel src --root-mode upward --extensions '.js,.ts,.tsx' --out-dir dist/cjs --ignore '**/__tests__/**/*','**/__mocks__/**/*' --quiet && ../../scripts/prepare-cjs.sh",
+    "build:types": "tsc -p ./tsconfig.declaration.json --outDir ./dist/es",
+    "version": "./scripts/version.cjs"
+  },
+  "gitHead": "084aff3d29e15cea8125076c46fb753c83d4dcad"
 }