IF Commons GitHub

supply-chain/packaging/packaging

The packaging vocabulary of the software supply chain capability (commons 0002-packaging): what a package manager, a system family, a command and a package name are, so that any harness can name what it installs, where each piece comes from and how to install it the same way on every computer. Terms specialize schema.org where it has a class (schema:SoftwareApplication, schema:Action); an SBOM made from this capability writes a package URL with SPDX 3.0.1's Software/packageUrl; every other term is this namespace's own, because no established vocabulary names it.

The vocabulary is stated as typed values (commons 0012-ontology FR-009): its namespaces and terms, its code lists, the class schemas its data is made with, and the descriptions of its classes and properties, which make its Turtle.

Source: commons/ontology/src/supply-chain/packaging/packaging.ts

1 of 29 exports are imported by a test of the run. A test that imports an export may not call it or check what it returns.

PMconstno test imports it
const PM: Namespace<"pm">

The namespace of the packaging vocabulary's terms.

PMIDconstno test imports it
const PMID: Namespace<"pmid">

The namespace of the packaging individuals: the managers, families, programs, pins and the rest.

PMVconstno test imports it
const PMV: Namespace<"pmv">

The namespace of the versions of the packaging ontology: owl:versionIRI names one of them.

pmconstno test imports it
const pm: Vocabulary<"pm", { readonly PackageManager: "owl:Class"; readonly SystemFamily: "owl:Class"; readonly Command:… (2799 characters)
const pm: Vocabulary<"pm", { readonly PackageManager: "owl:Class"; readonly SystemFamily: "owl:Class"; readonly Command: "owl:Class"; readonly Prohibition: "owl:Class"; readonly Program: "owl:Class"; readonly PackageName: "owl:Class"; readonly Platform: "owl:Class"; readonly PinnedDownload: "owl:Class"; readonly Checksum: "owl:Class"; readonly Rule: "owl:Class"; readonly RecordField: "owl:Class"; readonly Operation: "owl:Class"; readonly SupportStatus: "owl:Class"; readonly Assurance: "owl:Class"; readonly ManagerKind: "owl:Class"; readonly Tier: "owl:Class"; readonly executable: "owl:DatatypeProperty"; readonly kind: "owl:ObjectProperty"; readonly needsAdministrator: "owl:DatatypeProperty"; readonly environment: "owl:DatatypeProperty"; readonly purlType: "owl:DatatypeProperty"; readonly harnessUse: "owl:DatatypeProperty"; readonly commandOf: "owl:ObjectProperty"; readonly operation: "owl:ObjectProperty"; readonly template: "owl:DatatypeProperty"; readonly nonInteractive: "owl:DatatypeProperty"; readonly missingExitStatus: "owl:DatatypeProperty"; readonly origin: "owl:DatatypeProperty"; readonly verifiedOn: "owl:DatatypeProperty"; readonly prohibitionOf: "owl:ObjectProperty"; readonly forbiddenTemplate: "owl:DatatypeProperty"; readonly detectedBy: "owl:DatatypeProperty"; readonly detectSource: "owl:DatatypeProperty"; readonly unameName: "owl:DatatypeProperty"; readonly usesManager: "owl:ObjectProperty"; readonly preferredManager: "owl:ObjectProperty"; readonly supportStatus: "owl:ObjectProperty"; readonly assurance: "owl:ObjectProperty"; readonly harnessInstallsPackages: "owl:DatatypeProperty"; readonly removalHint: "owl:DatatypeProperty"; readonly adminInstall: "owl:DatatypeProperty"; readonly note: "owl:DatatypeProperty"; readonly programName: "owl:DatatypeProperty"; readonly order: "owl:DatatypeProperty"; readonly tier: "owl:ObjectProperty"; readonly forProgram: "owl:ObjectProperty"; readonly forFamily: "owl:ObjectProperty"; readonly name: "owl:DatatypeProperty"; readonly platformName: "owl:DatatypeProperty"; readonly operatingSystem: "owl:DatatypeProperty"; readonly processor: "owl:DatatypeProperty"; readonly pinSuffix: "owl:DatatypeProperty"; readonly pinKey: "owl:DatatypeProperty"; readonly version: "owl:DatatypeProperty"; readonly forPin: "owl:ObjectProperty"; readonly forPlatform: "owl:ObjectProperty"; readonly sha256: "owl:DatatypeProperty"; readonly downloadUrl: "owl:DatatypeProperty"; readonly archiveFormat: "owl:DatatypeProperty"; readonly binPath: "owl:DatatypeProperty"; readonly unpinnedReason: "owl:DatatypeProperty"; readonly ruleSet: "owl:DatatypeProperty"; readonly pattern: "owl:DatatypeProperty"; readonly fieldName: "owl:DatatypeProperty"; readonly fieldType: "owl:DatatypeProperty"; readonly allowedValue: "owl:DatatypeProperty"; }>

The terms of the packaging vocabulary: its classes and properties.

RULE_SETSconstno test imports it
const RULE_SETS: readonly ["shell-portability", "ci-forbidden-program", "ci-forbidden-action", "host-program", "installer"]

The sets a rule belongs to (commons 0004-rules FR-001).

FIELD_TYPESconstno test imports it
const FIELD_TYPES: readonly ["text", "boolean", "date"]

The types of a field of the setup record (commons 0002-packaging FR-016).

DETECT_SOURCESconstno test imports it
const DETECT_SOURCES: readonly ["os-release", "platform", "any"]

Where the IDs that detect a family come from.

ORIGINSconstno test imports it
const ORIGINS: readonly ["upt", "archon", "memory", "upt+memory"]

Where a command comes from (commons 0002-packaging FR-003).

OPERATING_SYSTEMSconstno test imports it
const OPERATING_SYSTEMS: readonly ["linux", "macos", "windows"]

The operating systems of a platform (commons 0002-packaging FR-014).

ARCHIVE_FORMATSconstno test imports it
const ARCHIVE_FORMATS: readonly ["zip", "tar", "file"]

The formats of what a download gives (commons 0002-packaging FR-017): a zip archive, a tar archive (plain or compressed) or the one file itself.

expandAddressfunctionno test imports it
function expandAddress(template: string, version: string): string

The address a pin states (pm:downloadUrl) with {version} replaced by the pin's version: the one place that puts it in (commons 0002-packaging FR-017).

PROCESSORSconstno test imports it
const PROCESSORS: readonly ["x86_64", "aarch64"]

The processors of a platform, as uname -m says them (commons 0002-packaging FR-014).

HARNESS_USESconstno test imports it
const HARNESS_USES: readonly ["never"]

How a harness may use a manager, where it may not drive it as any other.

operationsconstno test imports it
const operations: CodeList<"pm:Operation", ValuesOf<{ readonly label: Field<LangString, "one">; readonly definition: Field<LangString, "optional">; }>, "Info" | "Install" | "InstallExact" | "ListInstalled" | "QueryCandidate" | "QueryInstalled" | "QueryVersion" | "Refresh" | "Remove" | "Search" | "Upgrade" | "UpgradeAll">

The operations of a package manager, named the same for every manager: a code list, whose keys are the union the tools branch on.

supportStatusesconstno test imports it
const supportStatuses: CodeList<"pm:SupportStatus", ValuesOf<{ readonly label: Field<LangString, "one">; readonly definition: Field<LangString, "optional">; }>, "Catalogued" | "Supported">

Whether a harness acts on a family: a code list, whose keys are the union the tools branch on.

assurancesconstno test imports it
const assurances: CodeList<"pm:Assurance", ValuesOf<{ readonly label: Field<LangString, "one">; readonly definition: Field<LangString, "optional">; }>, "NoAssurance" | "StandIn" | "Untested" | "Verified">

How far a family has been tried: a code list, whose keys are the union the tools branch on.

managerKindsconstno test imports it
const managerKinds: CodeList<"pm:ManagerKind", ValuesOf<{ readonly label: Field<LangString, "one">; readonly definition: Field<LangString, "optional">; }>, "HelperKind" | "SystemKind" | "ToolKind" | "UniversalKind">

The kinds of package manager: a code list, whose keys are the union the tools branch on.

tiersconstno test imports it
const tiers: CodeList<"pm:Tier", ValuesOf<{ readonly label: Field<LangString, "one">; readonly definition: Field<LangString, "optional">; }>, "Comfort" | "Required">

The tiers of a program: a code list, whose keys are the union the tools branch on.

Managerconstno test imports it
const Manager: ClassSchema<"pm:PackageManager", { readonly label: Field<LangString, "one">; readonly identifier: Field<s… (472 characters)
const Manager: ClassSchema<"pm:PackageManager", { readonly label: Field<LangString, "one">; readonly identifier: Field<string, "one">; readonly executable: Field<string, "one">; readonly kind: Field<Named<"pm:ManagerKind">, "one">; readonly needsAdministrator: Field<boolean, "one">; readonly environment: Field<string, "optional">; readonly purlType: Field<string, "optional">; readonly harnessUse: Field<"never", "optional">; readonly note: Field<string, "optional">; }>

The schema of a package manager (pm:PackageManager).

Commandconstno test imports it
const Command: ClassSchema<"pm:Command", { readonly commandOf: Field<Named<"pm:PackageManager">, "one">; readonly operat… (435 characters)
const Command: ClassSchema<"pm:Command", { readonly commandOf: Field<Named<"pm:PackageManager">, "one">; readonly operation: Field<Named<"pm:Operation">, "one">; readonly template: Field<string, "one">; readonly nonInteractive: Field<string, "optional">; readonly missingExitStatus: Field<number, "optional">; readonly origin: Field<"archon" | "memory" | "upt" | "upt+memory", "one">; readonly verifiedOn: Field<string, "optional">; }>

The schema of a command of a manager (pm:Command).

Familyconstno test imports it
const Family: ClassSchema<"pm:SystemFamily", { readonly label: Field<LangString, "one">; readonly identifier: Field<stri… (809 characters)
const Family: ClassSchema<"pm:SystemFamily", { readonly label: Field<LangString, "one">; readonly identifier: Field<string, "one">; readonly detectSource: Field<"any" | "os-release" | "platform", "one">; readonly detectedBy: Field<string, "many">; readonly unameName: Field<string, "optional">; readonly usesManager: Field<Named<"pm:PackageManager">, "many">; readonly preferredManager: Field<Named<"pm:PackageManager">, "optional">; readonly supportStatus: Field<Named<"pm:SupportStatus">, "one">; readonly assurance: Field<Named<"pm:Assurance">, "one">; readonly harnessInstallsPackages: Field<boolean, "optional">; readonly removalHint: Field<string, "optional">; readonly adminInstall: Field<string, "optional">; readonly verifiedOn: Field<string, "optional">; readonly note: Field<string, "optional">; }>

The schema of a system family (pm:SystemFamily).

Programconstno test imports it
const Program: ClassSchema<"pm:Program", { readonly label: Field<LangString, "one">; readonly programName: Field<string, "one">; readonly tier: Field<Named<"pm:Tier">, "one">; readonly order: Field<number, "one">; }>

The schema of a program (pm:Program).

PackageNameconstno test imports it
const PackageName: ClassSchema<"pm:PackageName", { readonly forProgram: Field<Named<"pm:Program">, "one">; readonly forFamily: Field<Named<"pm:SystemFamily">, "one">; readonly name: Field<string, "one">; }>

The schema of what a family calls a program's package (pm:PackageName).

Platformconstno test imports it
const Platform: ClassSchema<"pm:Platform", { readonly label: Field<LangString, "one">; readonly platformName: Field<string, "one">; readonly operatingSystem: Field<"linux" | "macos" | "windows", "one">; readonly processor: Field<"aarch64" | "x86_64", "one">; readonly pinSuffix: Field<string, "one">; }>

The schema of a platform (pm:Platform).

PinnedDownloadconstno test imports it
const PinnedDownload: ClassSchema<"pm:PinnedDownload", { readonly label: Field<LangString, "one">; readonly programName: Field<string, "one">; readonly pinKey: Field<string, "one">; readonly version: Field<string, "one">; readonly note: Field<LangString, "optional">; }>

The schema of a pinned download (pm:PinnedDownload).

Checksumconstno test imports it
const Checksum: ClassSchema<"pm:Checksum", { readonly forPin: Field<Named<"pm:PinnedDownload">, "one">; readonly forPlat… (420 characters)
const Checksum: ClassSchema<"pm:Checksum", { readonly forPin: Field<Named<"pm:PinnedDownload">, "one">; readonly forPlatform: Field<Named<"pm:Platform">, "one">; readonly sha256: Field<string, "one">; readonly downloadUrl: Field<string, "optional">; readonly archiveFormat: Field<"file" | "tar" | "zip", "optional">; readonly binPath: Field<string, "optional">; readonly unpinnedReason: Field<LangString, "optional">; }>

The schema of the checksum of a pinned download on a platform (pm:Checksum).

Ruleconstno test imports it
const Rule: ClassSchema<"pm:Rule", { readonly ruleSet: Field<"ci-forbidden-action" | "ci-forbidden-program" | "host-program" | "installer" | "shell-portability", "one">; readonly pattern: Field<string, "one">; readonly label: Field<LangString, "one">; readonly definition: Field<LangString, "one">; }>

The schema of a rule (pm:Rule).

RecordFieldconstno test imports it
const RecordField: ClassSchema<"pm:RecordField", { readonly fieldName: Field<string, "one">; readonly fieldType: Field<"boolean" | "date" | "text", "one">; readonly order: Field<number, "one">; readonly definition: Field<LangString, "one">; readonly allowedValue: Field<string, "many">; }>

The schema of a field of the setup record (pm:RecordField).

packagingOntologyconst
const packagingOntology: Individual<"owl:Ontology", ValuesOf<{ readonly label: Field<LangString, "optional">; readonly comment: Field<LangString, "optional">; readonly description: Field<LangString, "optional">; readonly versionInfo: Field<string, "optional">; readonly versionIri: Field<Named<"owl:Ontology">, "optional">; }>>

The ontology itself: its label, description and version.

Imported by 3 tests of the run (2 passed, 0 failed): the library's results

Titles, headings, exports, tables, columns and requirements. Esc closes.