@csaf-rs/vers-like-specifier 0.1.3 → 0.2.0

package/README.md

@@ -21,7 +21,7 @@ Add `vers-like-specifier` to your `Cargo.toml`. The package is published on http
 
 ```toml
 [dependencies]
-vers-like-specifier = "0.1"
+vers-like-specifier = "0.2"
 ```
 
 ## Usage
@@ -35,9 +35,9 @@ assert_eq!(vls.to_string(), ">=1.0.0|<2.0.0");
 
 
 let constraints = vls.constraints();
-assert_eq!(constraints[0].comparator(), &Comparator::GreaterThanOrEqual);
+assert_eq!(constraints[0].comparator(), Comparator::GreaterThanOrEqual);
 assert_eq!(constraints[0].version().to_string(), "1.0.0");
-assert_eq!(constraints[1].comparator(), &Comparator::LessThan);
+assert_eq!(constraints[1].comparator(), Comparator::LessThan);
 assert_eq!(constraints[1].version().to_string(), "2.0.0");
 
 // Because the VERS type is unknown, `contains` can only resolve a definite
@@ -46,11 +46,13 @@ assert_eq!(vls.contains("1.0.0"), Containment::Contained);
 assert_eq!(vls.contains("2.0.0"), Containment::NotContained);
 assert_eq!(vls.contains("1.5.0"), Containment::Undetermined);
 
-// The one exception: a vls pinning a single version is always decidable, since
-// containment then reduces to a plain string comparison.
-let pinned: Vls = "1.0.0".parse().unwrap();
-assert_eq!(pinned.contains("1.0.0"), Containment::Contained);
-assert_eq!(pinned.contains("2.0.0"), Containment::NotContained);
+// The one exception: a vls containing only exact-match comparators (equal, not equal) is always decidable, since
+// containment then reduces to a plain string comparison if there is a constraint with that version. If there isn't a
+// constraint with the version, it is not contained by default. 
+let exact_only: Vls = "1.0.0|!=2.0.0".parse().unwrap();
+assert_eq!(exact_only.contains("1.0.0"), Containment::Contained);
+assert_eq!(exact_only.contains("2.0.0"), Containment::NotContained);
+assert_eq!(exact_only.contains("3.0.0"), Containment::NotContained);
 ```
 
 ### JavaScript / WASM Usage
@@ -61,8 +63,6 @@ import init, { Vls, Constraint, Comparator, Containment } from "@csaf-rs/vers-li
 await init();
 
 const vls = Vls.parse(">=1.0.0|<2.0.0");
-console.log(vls.isSingleVersion()); // false
-
 const constraint = new Constraint(Comparator.GreaterThanOrEqual, "1.0.0");
 console.log(constraint.version); // "1.0.0"
 

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@csaf-rs/vers-like-specifier",
   "type": "module",
-  "description": "vls (vers-like specifier) parser",
-  "version": "0.1.3",
+  "description": "vls (VERS-like specifier) parser",
+  "version": "0.2.0",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",

package/vers_like_specifier.d.ts

@@ -9,14 +9,14 @@
 export type VersionString = string;
 
 /**
- * Errors specific to a single constraint within a VLS string.
+ * Errors specific to a single constraint within a vls string.
  */
 export type ConstraintError = "EmptyConstraint" | "EmptyConstraintVersion" | { InvalidConstraintVersionCharacters: string[] };
 
 /**
  * Errors that can occur when parsing a vls string.
  */
-export type VlsError = "EmptyInput" | "ForbiddenAnyUsed" | { InvalidCharacters: string[] } | { InvalidConstraints: ConstraintError[] } | { DuplicateConstraintVersions: string[] } | { Serialization: string };
+export type VlsError = "EmptyInput" | "ForbiddenAnyUsed" | { SingleVersionNotAllowed: string } | { InvalidCharacters: string[] } | { InvalidConstraints: ConstraintError[] } | { DuplicateConstraintVersions: string[] } | { Serialization: string };
 
 
 /**
@@ -61,7 +61,7 @@ export class Constraint {
     [Symbol.dispose](): void;
     /**
      * Construct a new [`Constraint`] from a [`Comparator`] and a version string, validating
-     * the version string against the VLS grammar. Exposed as `new Constraint(comparator, version)`
+     * the version string against the vls grammar. Exposed as `new Constraint(comparator, version)`
      * in JS.
      *
      * # Errors
@@ -93,11 +93,12 @@ export class Constraint {
  * * No constraint's version matches exactly: containment cannot be resolved, as the VERS
  *   type is unknown / unspecified → [`Containment::Undetermined`].
  *
- * The one exception is a [`Vls`] that pins a single version (see [`Vls::is_single_version`]):
- * since it has exactly one [`Comparator::Equal`] constraint, containment reduces to a plain
- * string comparison and is always decidable, regardless of VERS type. In that case,
- * *any* queried version resolves to either [`Containment::Contained`] or
- * [`Containment::NotContained`], never [`Containment::Undetermined`].
+ * The one exception is a [`Vls`] that uses only exact-match comparators (i.e.
+ * [`Comparator::Equal`] and/or [`Comparator::NotEqual`]).
+ * Here, containment is reduced to a plain string comparison and is always decidable,
+ * regardless of VERS type. In that case, *any* queried version resolves to either [`Containment::Contained`] or
+ * [`Containment::NotContained`] depending on the exact-match comparator if there is a constraint with
+ * the queried version, and always to [`Containment::NotContained`] if there is no constraint with that version.
  */
 export enum Containment {
     /**
@@ -162,11 +163,6 @@ export class Vls {
      * instance method `vls.contains(version)` in JS.
      */
     contains(version: string): Containment;
-    /**
-     * Return `true` if this specifier pins exactly one version, exposed as the
-     * instance method `vls.isSingleVersion()` in JS.
-     */
-    isSingleVersion(): boolean;
     /**
      * Parse a `vls` as a [`Vls`] string, exposed as the static `Vls.parse(vls)` in JS.
      *
@@ -188,7 +184,6 @@ export interface InitOutput {
     readonly init: () => void;
     readonly __wbg_vls_free: (a: number, b: number) => void;
     readonly vls_contains: (a: number, b: number, c: number) => number;
-    readonly vls_isSingleVersion: (a: number) => number;
     readonly vls_parse: (a: number, b: number) => [number, number, number];
     readonly __wbg_constraint_free: (a: number, b: number) => void;
     readonly constraint_comparator: (a: number) => number;

package/vers_like_specifier.js

@@ -75,7 +75,7 @@ export class Constraint {
     }
     /**
      * Construct a new [`Constraint`] from a [`Comparator`] and a version string, validating
-     * the version string against the VLS grammar. Exposed as `new Constraint(comparator, version)`
+     * the version string against the vls grammar. Exposed as `new Constraint(comparator, version)`
      * in JS.
      *
      * # Errors
@@ -112,11 +112,12 @@ if (Symbol.dispose) Constraint.prototype[Symbol.dispose] = Constraint.prototype.
  * * No constraint's version matches exactly: containment cannot be resolved, as the VERS
  *   type is unknown / unspecified → [`Containment::Undetermined`].
  *
- * The one exception is a [`Vls`] that pins a single version (see [`Vls::is_single_version`]):
- * since it has exactly one [`Comparator::Equal`] constraint, containment reduces to a plain
- * string comparison and is always decidable, regardless of VERS type. In that case,
- * *any* queried version resolves to either [`Containment::Contained`] or
- * [`Containment::NotContained`], never [`Containment::Undetermined`].
+ * The one exception is a [`Vls`] that uses only exact-match comparators (i.e.
+ * [`Comparator::Equal`] and/or [`Comparator::NotEqual`]).
+ * Here, containment is reduced to a plain string comparison and is always decidable,
+ * regardless of VERS type. In that case, *any* queried version resolves to either [`Containment::Contained`] or
+ * [`Containment::NotContained`] depending on the exact-match comparator if there is a constraint with
+ * the queried version, and always to [`Containment::NotContained`] if there is no constraint with that version.
  * @enum {0 | 1 | 2}
  */
 export const Containment = Object.freeze({
@@ -203,15 +204,6 @@ export class Vls {
         const ret = wasm.vls_contains(this.__wbg_ptr, ptr0, len0);
         return ret;
     }
-    /**
-     * Return `true` if this specifier pins exactly one version, exposed as the
-     * instance method `vls.isSingleVersion()` in JS.
-     * @returns {boolean}
-     */
-    isSingleVersion() {
-        const ret = wasm.vls_isSingleVersion(this.__wbg_ptr);
-        return ret !== 0;
-    }
     /**
      * Parse a `vls` as a [`Vls`] string, exposed as the static `Vls.parse(vls)` in JS.
      *