1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2020-2023 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
import struct Foundation.Date
import struct Foundation.URL
import PackageModel
import SourceControl
import struct TSCUtility.Version
extension PackageCollectionsModel {
/// Package metadata
public struct Package: Codable, Equatable {
/// Package identity
public let identity: PackageIdentity
/// Package location
public let location: String
/// Package description
public let summary: String?
/// Keywords for the package
public let keywords: [String]?
/// Published versions of the package
public let versions: [Version]
/// The latest published version of the package
///
/// - Note:
/// This would be the latest released version, unless no release versions are published
/// in which case it will be the latest pre-release version.
///
/// E.g. given:
/// 3.0.0-beta.1
/// 2.1.1
/// 2.1.0
/// 2.0.0
/// 2.0.0-beta.2
/// 2.0.0-beta.1
/// 1.0.1
/// 1.0.0
///
/// Latest = 2.1.1
///
/// And given:
/// 1.0.0-beta.3
/// 1.0.0-beta.2
/// 1.0.0-beta.1
///
/// Latest = 1.0.0-beta.3
public var latestVersion: Version? {
self.latestReleaseVersion ?? self.latestPrereleaseVersion
}
public var latestReleaseVersion: Version? {
self.versions.latestRelease
}
public var latestPrereleaseVersion: Version? {
self.versions.latestPrerelease
}
/// Number of watchers
public let watchersCount: Int?
/// URL of the package's README
public let readmeURL: URL?
/// The package's current license info
public let license: License?
/// Package authors
public let authors: [Author]?
/// The package's programming languages
public let languages: Set<String>?
/// Initializes a `Package`
init(
identity: PackageIdentity,
location: String,
summary: String?,
keywords: [String]?,
versions: [Version],
watchersCount: Int?,
readmeURL: URL?,
license: License?,
authors: [Author]?,
languages: Set<String>?
) {
self.identity = identity
self.location = location
self.summary = summary
self.keywords = keywords
self.versions = versions
self.watchersCount = watchersCount
self.readmeURL = readmeURL
self.license = license
self.authors = authors
self.languages = languages
}
}
}
extension PackageCollectionsModel.Package {
/// A representation of package version
public struct Version: Codable, Equatable {
public typealias Target = PackageCollectionsModel.Target
public typealias Product = PackageCollectionsModel.Product
/// The version
public let version: TSCUtility.Version
/// The title or name of the version
public let title: String?
/// Package version description
public let summary: String?
/// Manifests by tools version
public let manifests: [ToolsVersion: Manifest]
/// Tools version of the default manifest
public let defaultToolsVersion: ToolsVersion
/// An array of compatible platforms and Swift versions that has been tested and verified for.
public let verifiedCompatibility: [PackageCollectionsModel.Compatibility]?
/// The package version's license
public let license: PackageCollectionsModel.License?
/// The package version's author
public let author: PackageCollectionsModel.Package.Author?
/// The package version's signer
public let signer: PackageCollectionsModel.Signer?
/// When the package version was created
public let createdAt: Date?
public struct Manifest: Equatable, Codable {
/// The Swift tools version specified in `Package.swift`.
public let toolsVersion: ToolsVersion
/// The package name
public let packageName: String
// Custom instead of `PackageModel.Target` because we don't need the additional details
/// The package version's targets
public let targets: [Target]
// Custom instead of `PackageModel.Product` because of the simplified `Target`
/// The package version's products
public let products: [Product]
/// The package version's supported platforms
public let minimumPlatformVersions: [SupportedPlatform]?
}
}
}
extension PackageCollectionsModel {
/// A representation of package target
public struct Target: Equatable, Hashable, Codable {
/// The target name
public let name: String
/// Target module name
public let moduleName: String?
}
}
extension PackageCollectionsModel {
/// A representation of package product
public struct Product: Equatable, Codable {
/// The product name
public let name: String
/// The product type
public let type: ProductType
/// The product's targets
public let targets: [Target]
}
}
extension PackageCollectionsModel {
/// Compatible platform and Swift version.
public struct Compatibility: Equatable, Codable {
/// The platform (e.g., macOS, Linux, etc.)
public let platform: PackageModel.Platform
/// The Swift version
public let swiftVersion: SwiftLanguageVersion
}
}
extension PackageCollectionsModel.Package {
/// A representation of package author
public struct Author: Equatable, Codable {
/// Author's username
public let username: String
/// Author's URL (e.g., profile)
public let url: URL?
/// Service that provides the user information
public let service: Service?
/// A representation of user service
public struct Service: Equatable, Codable {
/// The service name
public let name: String
}
}
}
extension PackageCollectionsModel {
public struct Signer: Equatable, Codable {
/// The signer type.
public let type: SignerType
/// The common name of the signing certificate's subject.
public let commonName: String
/// The organizational unit name of the signing certificate's subject.
public let organizationalUnitName: String
/// The organization name of the signing certificate's subject.
public let organizationName: String
public init(
type: SignerType,
commonName: String,
organizationalUnitName: String,
organizationName: String
) {
self.type = type
self.commonName = commonName
self.organizationalUnitName = organizationalUnitName
self.organizationName = organizationName
}
}
public enum SignerType: String, Codable {
case adp // Apple Developer Program
}
}
extension PackageCollectionsModel {
public typealias PackageMetadata = (package: PackageCollectionsModel.Package, collections: [PackageCollectionsModel.CollectionIdentifier], provider: PackageMetadataProviderContext?)
}
// MARK: - Utilities
extension PackageCollectionsModel.Package.Version: Comparable {
public static func < (lhs: PackageCollectionsModel.Package.Version, rhs: PackageCollectionsModel.Package.Version) -> Bool {
lhs.version < rhs.version
}
}
extension Array where Element == PackageCollectionsModel.Package.Version {
var latestRelease: PackageCollectionsModel.Package.Version? {
self.filter { $0.version.prereleaseIdentifiers.isEmpty }
.sorted(by: >)
.first
}
var latestPrerelease: PackageCollectionsModel.Package.Version? {
self.filter { !$0.version.prereleaseIdentifiers.isEmpty }
.sorted(by: >)
.first
}
}
extension PackageCollectionsModel.Package.Version {
public var defaultManifest: Manifest? {
self.manifests[self.defaultToolsVersion]
}
}
extension Model.Package {
var displayName: String {
self.identity.description
}
}
|