237 lines
14 KiB
HTML
237 lines
14 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Source: services/packagist/packagist-base.js</title>
|
|
|
|
<script src="scripts/prettify/prettify.js"> </script>
|
|
<script src="scripts/prettify/lang-css.js"> </script>
|
|
<!--[if lt IE 9]>
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
<![endif]-->
|
|
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
|
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<div id="main">
|
|
|
|
<h1 class="page-title">Source: services/packagist/packagist-base.js</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<article>
|
|
<pre class="prettyprint source linenums"><code>import Joi from 'joi'
|
|
import { BaseJsonService, NotFound } from '../index.js'
|
|
import { isStable, latest } from '../php-version.js'
|
|
|
|
const packageSchema = Joi.array().items(
|
|
Joi.object({
|
|
version: Joi.string().required(),
|
|
require: Joi.alternatives(
|
|
Joi.object().pattern(Joi.string(), Joi.string()).required(),
|
|
Joi.string().valid('__unset'),
|
|
),
|
|
}),
|
|
)
|
|
|
|
const allVersionsSchema = Joi.object({
|
|
packages: Joi.object().pattern(/^/, packageSchema).required(),
|
|
}).required()
|
|
const keywords = ['PHP']
|
|
|
|
class BasePackagistService extends BaseJsonService {
|
|
/**
|
|
* Default fetch method.
|
|
*
|
|
* This method utilizes composer metadata API which
|
|
* "... is the preferred way to access the data as it is always up to date,
|
|
* and dumped to static files so it is very efficient on our end." (comment from official documentation).
|
|
* For more information please refer to https://packagist.org/apidoc#get-package-data.
|
|
*
|
|
* @param {object} attrs Refer to individual attrs
|
|
* @param {string} attrs.user package user
|
|
* @param {string} attrs.repo package repository
|
|
* @param {Joi} attrs.schema Joi schema to validate the response transformed to JSON
|
|
* @param {string} attrs.server URL for the packagist registry server (Optional)
|
|
* @returns {object} Parsed response
|
|
*/
|
|
async fetch({ user, repo, schema, server = 'https://packagist.org' }) {
|
|
const url = `${server}/p2/${user.toLowerCase()}/${repo.toLowerCase()}.json`
|
|
|
|
return this._requestJson({
|
|
schema,
|
|
url,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Fetch dev releases method.
|
|
*
|
|
* This method utilizes composer metadata API which
|
|
* "... is the preferred way to access the data as it is always up to date,
|
|
* and dumped to static files so it is very efficient on our end." (comment from official documentation).
|
|
* For more information please refer to https://packagist.org/apidoc#get-package-data.
|
|
*
|
|
* @param {object} attrs Refer to individual attrs
|
|
* @param {string} attrs.user package user
|
|
* @param {string} attrs.repo package repository
|
|
* @param {Joi} attrs.schema Joi schema to validate the response transformed to JSON
|
|
* @param {string} attrs.server URL for the packagist registry server (Optional)
|
|
* @returns {object} Parsed response
|
|
*/
|
|
async fetchDev({ user, repo, schema, server = 'https://packagist.org' }) {
|
|
const url = `${server}/p2/${user.toLowerCase()}/${repo.toLowerCase()}~dev.json`
|
|
|
|
return this._requestJson({
|
|
schema,
|
|
url,
|
|
})
|
|
}
|
|
|
|
/**
|
|
* It is highly recommended to use base fetch method!
|
|
*
|
|
* JSON API includes additional information about downloads, dependents count, github info, etc.
|
|
* However, responses from JSON API are cached for twelve hours by packagist servers,
|
|
* so data fetch from this method might be outdated.
|
|
* For more information please refer to https://packagist.org/apidoc#get-package-data.
|
|
*
|
|
* @param {object} attrs Refer to individual attrs
|
|
* @param {string} attrs.user package user
|
|
* @param {string} attrs.repo package repository
|
|
* @param {Joi} attrs.schema Joi schema to validate the response transformed to JSON
|
|
* @param {string} attrs.server URL for the packagist registry server (Optional)
|
|
* @returns {object} Parsed response
|
|
*/
|
|
async fetchByJsonAPI({
|
|
user,
|
|
repo,
|
|
schema,
|
|
server = 'https://packagist.org',
|
|
}) {
|
|
const url = `${server}/packages/${user}/${repo}.json`
|
|
|
|
return this._requestJson({
|
|
schema,
|
|
url,
|
|
})
|
|
}
|
|
|
|
getPackageName(user, repo) {
|
|
return `${user.toLowerCase()}/${repo.toLowerCase()}`
|
|
}
|
|
|
|
/**
|
|
* Extract the array of minified versions of the given packageName,
|
|
* expand them back to their original format then return.
|
|
*
|
|
* @param {object} json The response of Packagist v2 API.
|
|
* @param {string} packageName The package name.
|
|
*
|
|
* @returns {object[]} An array of version metadata object.
|
|
*
|
|
* @see https://github.com/composer/metadata-minifier/blob/c549d23829536f0d0e984aaabbf02af91f443207/src/MetadataMinifier.php#L16-L46
|
|
*/
|
|
static expandPackageVersions(json, packageName) {
|
|
const versions = json.packages[packageName]
|
|
const expanded = []
|
|
let expandedVersion = null
|
|
|
|
for (const i in versions) {
|
|
const versionData = versions[i]
|
|
if (!expandedVersion) {
|
|
expandedVersion = { ...versionData }
|
|
expanded.push(expandedVersion)
|
|
continue
|
|
}
|
|
|
|
expandedVersion = { ...expandedVersion, ...versionData }
|
|
for (const key in expandedVersion) {
|
|
if (expandedVersion[key] === '__unset') {
|
|
delete expandedVersion[key]
|
|
}
|
|
}
|
|
expanded.push(expandedVersion)
|
|
}
|
|
|
|
return expanded
|
|
}
|
|
|
|
/**
|
|
* Find the object representation of the latest release.
|
|
*
|
|
* @param {object[]} versions An array of object representing a version.
|
|
* @param {boolean} includePrereleases Includes pre-release semver for the search.
|
|
*
|
|
* @returns {object} The object of the latest version.
|
|
* @throws {NotFound} Thrown if there is no item from the version array.
|
|
*/
|
|
findLatestRelease(versions, includePrereleases = false) {
|
|
// Find the latest version string, if not found, throw NotFound.
|
|
const versionStrings = versions
|
|
.filter(
|
|
version =>
|
|
typeof version.version === 'string' ||
|
|
version.version instanceof String,
|
|
)
|
|
.map(version => version.version)
|
|
if (versionStrings.length < 1) {
|
|
throw new NotFound({ prettyMessage: 'no released version found' })
|
|
}
|
|
|
|
let release = latest(versionStrings)
|
|
if (!includePrereleases) {
|
|
release = latest(versionStrings.filter(isStable)) || release
|
|
}
|
|
return versions.filter(version => version.version === release)[0]
|
|
}
|
|
}
|
|
const customServerDocumentationFragment = `<p>
|
|
Note that only network-accessible packagist.org and other self-hosted Packagist instances are supported.
|
|
</p>
|
|
`
|
|
|
|
const cacheDocumentationFragment = `<p>
|
|
Displayed data may be slightly outdated.
|
|
Due to performance reasons, data fetched from packagist JSON API is cached for twelve hours on packagist infrastructure.
|
|
For more information please refer to <a target="_blank" href="https://packagist.org/apidoc#get-package-data">official packagist documentation</a>.
|
|
</p>
|
|
`
|
|
|
|
export {
|
|
allVersionsSchema,
|
|
keywords,
|
|
BasePackagistService,
|
|
customServerDocumentationFragment,
|
|
cacheDocumentationFragment,
|
|
}
|
|
</code></pre>
|
|
</article>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<nav>
|
|
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-badge-maker.html">badge-maker</a></li><li><a href="module-badge-maker_lib_xml.html">badge-maker/lib/xml</a></li><li><a href="module-core_base-service_base.html">core/base-service/base</a></li><li><a href="module-core_base-service_base-graphql.html">core/base-service/base-graphql</a></li><li><a href="module-core_base-service_base-json.html">core/base-service/base-json</a></li><li><a href="module-core_base-service_base-svg-scraping.html">core/base-service/base-svg-scraping</a></li><li><a href="module-core_base-service_base-xml.html">core/base-service/base-xml</a></li><li><a href="module-core_base-service_base-yaml.html">core/base-service/base-yaml</a></li><li><a href="module-core_base-service_errors.html">core/base-service/errors</a></li><li><a href="module-core_base-service_graphql.html">core/base-service/graphql</a></li><li><a href="module-core_base-service_openapi.html">core/base-service/openapi</a></li><li><a href="module-core_base-service_resource-cache.html">core/base-service/resource-cache</a></li><li><a href="module-core_server_server.html">core/server/server</a></li><li><a href="module-core_service-test-runner_create-service-tester.html">core/service-test-runner/create-service-tester</a></li><li><a href="module-core_service-test-runner_icedfrisby-shields.html">core/service-test-runner/icedfrisby-shields</a></li><li><a href="module-core_service-test-runner_runner.html">core/service-test-runner/runner</a></li><li><a href="module-core_service-test-runner_service-tester.html">core/service-test-runner/service-tester</a></li><li><a href="module-core_service-test-runner_services-for-title.html">core/service-test-runner/services-for-title</a></li><li><a href="module-core_token-pooling_token-pool.html">core/token-pooling/token-pool</a></li><li><a href="module-services_build-status.html">services/build-status</a></li><li><a href="module-services_color-formatters.html">services/color-formatters</a></li><li><a href="module-services_contributor-count.html">services/contributor-count</a></li><li><a href="module-services_downloads.html">services/downloads</a></li><li><a href="module-services_dynamic-common.html">services/dynamic-common</a></li><li><a href="module-services_dynamic_json-path.html">services/dynamic/json-path</a></li><li><a href="module-services_endpoint-common.html">services/endpoint-common</a></li><li><a href="module-services_licenses.html">services/licenses</a></li><li><a href="module-services_package-json-helpers.html">services/package-json-helpers</a></li><li><a href="module-services_php-version.html">services/php-version</a></li><li><a href="module-services_pipenv-helpers.html">services/pipenv-helpers</a></li><li><a href="module-services_route-builder.html">services/route-builder</a></li><li><a href="module-services_steam_steam-base.html">services/steam/steam-base</a></li><li><a href="module-services_text-formatters.html">services/text-formatters</a></li><li><a href="module-services_validators.html">services/validators</a></li></ul><h3>Classes</h3><ul><li><a href="module-badge-maker_lib_xml-ElementList.html">ElementList</a></li><li><a href="module-badge-maker_lib_xml-XmlElement.html">XmlElement</a></li><li><a href="module-core_base-service_base-graphql-BaseGraphqlService.html">BaseGraphqlService</a></li><li><a href="module-core_base-service_base-json-BaseJsonService.html">BaseJsonService</a></li><li><a href="module-core_base-service_base-svg-scraping-BaseSvgScrapingService.html">BaseSvgScrapingService</a></li><li><a href="module-core_base-service_base-xml-BaseXmlService.html">BaseXmlService</a></li><li><a href="module-core_base-service_base-yaml-BaseYamlService.html">BaseYamlService</a></li><li><a href="module-core_base-service_base-BaseService.html">BaseService</a></li><li><a href="module-core_base-service_errors-Deprecated.html">Deprecated</a></li><li><a href="module-core_base-service_errors-ImproperlyConfigured.html">ImproperlyConfigured</a></li><li><a href="module-core_base-service_errors-Inaccessible.html">Inaccessible</a></li><li><a href="module-core_base-service_errors-InvalidParameter.html">InvalidParameter</a></li><li><a href="module-core_base-service_errors-InvalidResponse.html">InvalidResponse</a></li><li><a href="module-core_base-service_errors-NotFound.html">NotFound</a></li><li><a href="module-core_base-service_errors-ShieldsRuntimeError.html">ShieldsRuntimeError</a></li><li><a href="module-core_server_server-Server.html">Server</a></li><li><a href="module-core_service-test-runner_runner-Runner.html">Runner</a></li><li><a href="module-core_service-test-runner_service-tester-ServiceTester.html">ServiceTester</a></li><li><a href="module-core_token-pooling_token-pool-Token.html">Token</a></li><li><a href="module-core_token-pooling_token-pool-TokenPool.html">TokenPool</a></li><li><a href="module-services_route-builder.html">services/route-builder</a></li><li><a href="module-services_steam_steam-base-BaseSteamAPI.html">BaseSteamAPI</a></li></ul><h3>Tutorials</h3><ul><li><a href="tutorial-TUTORIAL.html">TUTORIAL</a></li><li><a href="tutorial-adding-new-config-values.html">adding-new-config-values</a></li><li><a href="tutorial-authentication.html">authentication</a></li><li><a href="tutorial-badge-urls.html">badge-urls</a></li><li><a href="tutorial-code-walkthrough.html">code-walkthrough</a></li><li><a href="tutorial-deprecating-badges.html">deprecating-badges</a></li><li><a href="tutorial-input-validation.html">input-validation</a></li><li><a href="tutorial-json-format.html">json-format</a></li><li><a href="tutorial-logos.html">logos</a></li><li><a href="tutorial-performance-testing.html">performance-testing</a></li><li><a href="tutorial-production-hosting.html">production-hosting</a></li><li><a href="tutorial-releases.html">releases</a></li><li><a href="tutorial-self-hosting.html">self-hosting</a></li><li><a href="tutorial-server-secrets.html">server-secrets</a></li><li><a href="tutorial-service-tests.html">service-tests</a></li><li><a href="tutorial-static-badges.html">static-badges</a></li></ul><h3>Global</h3><ul><li><a href="global.html#createNumRequestCounter">createNumRequestCounter</a></li><li><a href="global.html#isMetricWithPattern">isMetricWithPattern</a></li></ul>
|
|
</nav>
|
|
|
|
<br class="clear">
|
|
|
|
<footer>
|
|
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Mon Aug 07 2023 15:06:10 GMT+0000 (Coordinated Universal Time)
|
|
</footer>
|
|
|
|
<script> prettyPrint(); </script>
|
|
<script src="scripts/linenumber.js"> </script>
|
|
</body>
|
|
</html>
|