@cjser/npm-keyword 8.0.0-cjser.2

package/dist-cjser/index.cjs

@@ -0,0 +1,70 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// packages/@cjser/npm-keyword.tmp-26-1778153805526/index.js
+var index_exports = {};
+__export(index_exports, {
+  npmKeyword: () => npmKeyword,
+  npmKeywordCount: () => npmKeywordCount,
+  npmKeywordNames: () => npmKeywordNames
+});
+module.exports = __toCommonJS(index_exports);
+var import_ky_v1_14_3 = __toESM(require("@cjser/ky__v1_14_3"), 1);
+var import_registry_url_v6_0_1 = __toESM(require("@cjser/registry-url__v6_0_1"), 1);
+var get = async (keyword, { size = 250 } = {}) => {
+  if (typeof keyword !== "string" && !Array.isArray(keyword)) {
+    throw new TypeError("The keyword must be either a string or an array of strings");
+  }
+  if (size === 0 || size > 250) {
+    throw new TypeError("The `size` option must be in the range 1...250");
+  }
+  keyword = encodeURIComponent(keyword).replace("%2C", "+");
+  const url = `${(0, import_registry_url_v6_0_1.default)()}-/v1/search?text=keywords:${keyword}&size=${size}`;
+  return (0, import_ky_v1_14_3.default)(url).json();
+};
+async function npmKeyword(keyword, options) {
+  const { objects } = await get(keyword, options);
+  return objects.map((element) => ({
+    name: element.package.name,
+    description: element.package.description
+  }));
+}
+async function npmKeywordNames(keyword, options) {
+  const { objects } = await get(keyword, options);
+  return objects.map((element) => element.package.name);
+}
+async function npmKeywordCount(keyword) {
+  const { total } = await get(keyword, { size: 1 });
+  return total;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  npmKeyword,
+  npmKeywordCount,
+  npmKeywordNames
+});

package/index.d.ts

@@ -0,0 +1,63 @@
+export type Options = {
+	/**
+	Limits the amount of results.
+
+	@default 250
+	*/
+	readonly size?: number;
+};
+
+export type PackageDescriptor = {
+	readonly name: string;
+	readonly description: string;
+};
+
+/**
+Get a list of npm packages with certain keywords.
+
+@param keyword - One or more keywords. Only matches packages that have *all* the given keywords.
+@returns A list of packages having the specified keywords in their package.json `keyword` property.
+
+@example
+```
+import {npmKeyword} from '@cjser/npm-keyword';
+
+console.log(await npmKeyword('gulpplugin'));
+//=> [{name: 'gulp-autoprefixer', description: '…'}, …]
+```
+*/
+export function npmKeyword(keyword: string | readonly string[], options?: Options): Promise<PackageDescriptor[]>;
+
+/**
+Get a list of npm package names with certain keywords.
+
+@param keyword - One or more keywords. Only matches packages that have *all* the given keywords. Example: `['string', 'camelcase']`.
+@returns A list of package names. Use this if you don't need the description as it's faster.
+
+@example
+```
+import {npmKeywordNames} from '@cjser/npm-keyword';
+
+console.log(await npmKeywordNames('gulpplugin'));
+//=> ['gulp-autoprefixer', …]
+```
+*/
+export function npmKeywordNames(keyword: string | readonly string[], options?: Options): Promise<string[]>;
+
+/**
+Get the count of npm packages names with certain keywords.
+
+@param keyword - One or more keywords. Only matches packages that have *all* the given keywords. Example: `['string', 'camelcase']`.
+@returns The count of packages.
+
+@example
+```
+import {npmKeywordCount} from '@cjser/npm-keyword';
+
+console.log(await npmKeywordCount('gulpplugin'));
+//=> 3457
+```
+*/
+export function npmKeywordCount(keyword: string | readonly string[]): Promise<number>;
+
+export default npmKeyword;

package/index.js

@@ -0,0 +1,37 @@
+import ky from '@cjser/ky__v1_14_3';
+import registryUrl from '@cjser/registry-url__v6_0_1';
+
+const get = async (keyword, {size = 250} = {}) => {
+	if (typeof keyword !== 'string' && !Array.isArray(keyword)) {
+		throw new TypeError('The keyword must be either a string or an array of strings');
+	}
+
+	if (size === 0 || size > 250) {
+		throw new TypeError('The `size` option must be in the range 1...250');
+	}
+
+	keyword = encodeURIComponent(keyword).replace('%2C', '+');
+
+	const url = `${registryUrl()}-/v1/search?text=keywords:${keyword}&size=${size}`;
+
+	return ky(url).json();
+};
+
+export async function npmKeyword(keyword, options) {
+	const {objects} = await get(keyword, options);
+
+	return objects.map(element => ({
+		name: element.package.name,
+		description: element.package.description,
+	}));
+}
+
+export async function npmKeywordNames(keyword, options) {
+	const {objects} = await get(keyword, options);
+	return objects.map(element => element.package.name);
+}
+
+export async function npmKeywordCount(keyword) {
+	const {total} = await get(keyword, {size: 1});
+	return total;
+}

package/license

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
+
+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/package.json

@@ -0,0 +1,79 @@
+{
+  "name": "@cjser/npm-keyword",
+  "version": "8.0.0-cjser.2",
+  "description": "Get a list of npm packages with keywords",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://code.moenext.com/3rdeye/cjser.git"
+  },
+  "funding": "https://github.com/sponsors/sindresorhus",
+  "author": {
+    "name": "Sindre Sorhus",
+    "email": "sindresorhus@gmail.com",
+    "url": "https://sindresorhus.com"
+  },
+  "type": "module",
+  "exports": {
+    "types": "./index.d.ts",
+    "require": "./dist-cjser/index.cjs",
+    "default": "./index.js"
+  },
+  "sideEffects": false,
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "test": "xo && ava && tsd"
+  },
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "dist-cjser"
+  ],
+  "keywords": [
+    "npm",
+    "keyword",
+    "package",
+    "packages",
+    "pkg",
+    "registry",
+    "find",
+    "search"
+  ],
+  "dependencies": {
+    "@cjser/ky__v1_14_3": "1.14.3-cjser.2",
+    "@cjser/registry-url__v6_0_1": "6.0.1-cjser.2"
+  },
+  "devDependencies": {
+    "ava": "^6.1.1",
+    "tsd": "^0.30.7",
+    "xo": "^0.57.0"
+  },
+  "types": "./index.d.ts",
+  "main": "./dist-cjser/index.cjs",
+  "cjser": {
+    "sourceVersion": "8.0.0",
+    "cjserVersion": 2,
+    "original": {
+      "name": "npm-keyword",
+      "version": "8.0.0",
+      "exports": {
+        "types": "./index.d.ts",
+        "default": "./index.js"
+      },
+      "repository": "sindresorhus/npm-keyword",
+      "dependencies": {
+        "ky": "^1.2.1",
+        "registry-url": "^6.0.1"
+      },
+      "files": [
+        "index.js",
+        "index.d.ts"
+      ],
+      "scripts": {
+        "test": "xo && ava && tsd"
+      }
+    }
+  }
+}

package/readme.md

@@ -0,0 +1,96 @@
+# npm-keyword
+
+> Get a list of npm packages with keywords
+
+## Install
+
+```sh
+npm install npm-keyword
+```
+
+## Usage
+
+```js
+import {npmKeyword, npmKeywordNames, npmKeywordCount} from 'npm-keyword';
+
+console.log(await npmKeyword('gulpplugin'));
+//=> [{name: 'gulp-autoprefixer', description: '…'}, …]
+
+console.log(await npmKeywordNames('gulpplugin'));
+//=> ['gulp-autoprefixer', …]
+
+console.log(await npmKeywordCount('gulpplugin'));
+//=> 3457
+```
+
+## Caveat
+
+The list of packages will contain a maximum of 250 packages matching the keywords. This limitation is caused by the [npm registry API](https://github.com/npm/registry/blob/master/docs/REGISTRY-API.md#get-v1search).
+
+## API
+
+### npmKeyword(keywords, options?)
+
+Returns a promise for a list of packages having the specified keyword in their package.json `keywords` property.
+
+#### keywords
+
+Type: `string | string[]`\
+Example: `['string', 'camelcase']`
+
+One or more keywords. Only matches packages that have *all* the given keywords.
+
+#### options
+
+Type: `object`
+
+##### size
+
+Type: `number`\
+Default: `250`
+
+Limits the amount of results.
+
+### npmKeywordNames(keywords, options?)
+
+Returns a promise for a list of package names.
+
+#### keywords
+
+Type: `string | string[]`\
+Example: `['string', 'camelcase']`
+
+One or more keywords. Only matches packages that have *all* the given keywords.
+
+#### options
+
+Type: `object`
+
+##### size
+
+Type: `number`\
+Default: `250`
+
+Limits the amount of results.
+
+### npmKeywordCount(keywords)
+
+Returns a promise for the count of packages.
+
+#### keywords
+
+Type: `string | string[]`\
+Example: `['string', 'camelcase']`
+
+One or more keywords. Only matches packages that have *all* the given keywords.
+
+## Related
+
+- [package-json](https://github.com/sindresorhus/package-json) - Get the package.json of a package from the npm registry
+- [npm-user](https://github.com/sindresorhus/npm-user) - Get user info of an npm user
+- [npm-email](https://github.com/sindresorhus/npm-email) - Get the email of an npm user
+
+## cjser
+
+This package is a CommonJS-compatible build generated by cjser for projects that still need `require()` support. The source version matches the original npm package version, with a cjser prerelease suffix for this generated build.
+Original repository: https://github.com/sindresorhus/npm-keyword