@pubid/pubid 0.1.32 → 0.1.34

package/dist/pubid-urn/schemas/ogc.d.ts

@@ -0,0 +1,8 @@
+/**
+ * The pubid-scheme URN schema of OGC — the transcription
+ * of lib/pubid/<flavor>/pubid_urn_schema.rb (pubid#656, completed by
+ * #670; design in docs/URN-SCHEMES.adoc). GENERATED by
+ * scripts/port-urn-schemas.rb from the ruby declaration: edit the ruby
+ * schema and regenerate, never this table by hand.
+ */
+export declare const ogcSchema: import("../schema.js").FlavorSchema;

package/dist/pubid-urn/schemas/ogc.js

@@ -0,0 +1,14 @@
+/**
+ * The pubid-scheme URN schema of OGC — the transcription
+ * of lib/pubid/<flavor>/pubid_urn_schema.rb (pubid#656, completed by
+ * #670; design in docs/URN-SCHEMES.adoc). GENERATED by
+ * scripts/port-urn-schemas.rb from the ruby declaration: edit the ruby
+ * schema and regenerate, never this table by hand.
+ */
+import { define } from "../index.js";
+export const ogcSchema = define("ogc", (s) => {
+    s.atom("year", "year");
+    s.atom("revision", "rev");
+    s.type("pubid:ogc:document", "document");
+    s.type("pubid:ogc:identifier", "id");
+});

package/dist/pubid-urn/schemas/oiml.d.ts

@@ -0,0 +1,8 @@
+/**
+ * The pubid-scheme URN schema of OIML — the transcription
+ * of lib/pubid/<flavor>/pubid_urn_schema.rb (pubid#656, completed by
+ * #670; design in docs/URN-SCHEMES.adoc). GENERATED by
+ * scripts/port-urn-schemas.rb from the ruby declaration: edit the ruby
+ * schema and regenerate, never this table by hand.
+ */
+export declare const oimlSchema: import("../schema.js").FlavorSchema;

package/dist/pubid-urn/schemas/oiml.js

@@ -0,0 +1,39 @@
+/**
+ * The pubid-scheme URN schema of OIML — the transcription
+ * of lib/pubid/<flavor>/pubid_urn_schema.rb (pubid#656, completed by
+ * #670; design in docs/URN-SCHEMES.adoc). GENERATED by
+ * scripts/port-urn-schemas.rb from the ruby declaration: edit the ruby
+ * schema and regenerate, never this table by hand.
+ */
+import { define } from "../index.js";
+export const oimlSchema = define("oiml", (s) => {
+    s.atom("publisher", "pub");
+    s.atom("part", "part");
+    s.atom("year", "year");
+    s.atom("edition", "ed");
+    s.atom("stage", "stage");
+    s.atom("language", "lang");
+    s.atom("amendment", "amendment");
+    s.atom("family", "family");
+    s.atom("iteration", "iteration");
+    s.atom("letter", "letter");
+    s.atom("trailing", "trailing", "bool");
+    s.atom("first", "first", "id");
+    s.atom("second", "second", "id");
+    s.facet("parsed_format", "format");
+    s.facet("space_separator", "sp", "bool");
+    s.type("pubid:oiml:amendment", "amd");
+    s.type("pubid:oiml:annex", "annex");
+    s.type("pubid:oiml:basic-publication", "bp");
+    s.type("pubid:oiml:bulletin", "bulletin");
+    s.type("pubid:oiml:certification-system", "cs");
+    s.type("pubid:oiml:document", "document");
+    s.type("pubid:oiml:dual-published", "dp", { core: [] });
+    s.type("pubid:oiml:errata", "err");
+    s.type("pubid:oiml:expert-report", "er");
+    s.type("pubid:oiml:guide", "guide");
+    s.type("pubid:oiml:identifier", "id", { core: [] });
+    s.type("pubid:oiml:recommendation", "rec");
+    s.type("pubid:oiml:seminar-report", "sr");
+    s.type("pubid:oiml:vocabulary", "v");
+});

package/dist/pubid-urn/schemas/omg.d.ts

@@ -0,0 +1,8 @@
+/**
+ * The pubid-scheme URN schema of OMG — the transcription
+ * of lib/pubid/<flavor>/pubid_urn_schema.rb (pubid#656, completed by
+ * #670; design in docs/URN-SCHEMES.adoc). GENERATED by
+ * scripts/port-urn-schemas.rb from the ruby declaration: edit the ruby
+ * schema and regenerate, never this table by hand.
+ */
+export declare const omgSchema: import("../schema.js").FlavorSchema;

package/dist/pubid-urn/schemas/omg.js

@@ -0,0 +1,15 @@
+/**
+ * The pubid-scheme URN schema of OMG — the transcription
+ * of lib/pubid/<flavor>/pubid_urn_schema.rb (pubid#656, completed by
+ * #670; design in docs/URN-SCHEMES.adoc). GENERATED by
+ * scripts/port-urn-schemas.rb from the ruby declaration: edit the ruby
+ * schema and regenerate, never this table by hand.
+ */
+import { define } from "../index.js";
+export const omgSchema = define("omg", (s) => {
+    s.atom("part", "part");
+    s.atom("version", "v");
+    s.atom("acronym", "acronym");
+    s.type("pubid:omg:identifier", "id", { core: [] });
+    s.type("pubid:omg:specification", "spec", { core: [] });
+});

package/dist/pubid-urn/schemas/plateau.d.ts

@@ -0,0 +1,8 @@
+/**
+ * The pubid-scheme URN schema of PLATEAU — the transcription
+ * of lib/pubid/<flavor>/pubid_urn_schema.rb (pubid#656, completed by
+ * #670; design in docs/URN-SCHEMES.adoc). GENERATED by
+ * scripts/port-urn-schemas.rb from the ruby declaration: edit the ruby
+ * schema and regenerate, never this table by hand.
+ */
+export declare const plateauSchema: import("../schema.js").FlavorSchema;

package/dist/pubid-urn/schemas/plateau.js

@@ -0,0 +1,20 @@
+/**
+ * The pubid-scheme URN schema of PLATEAU — the transcription
+ * of lib/pubid/<flavor>/pubid_urn_schema.rb (pubid#656, completed by
+ * #670; design in docs/URN-SCHEMES.adoc). GENERATED by
+ * scripts/port-urn-schemas.rb from the ruby declaration: edit the ruby
+ * schema and regenerate, never this table by hand.
+ */
+import { define } from "../index.js";
+export const plateauSchema = define("plateau", (s) => {
+    s.atom("publisher", "pub");
+    s.atom("edition", "ed");
+    s.atom("annex", "annex", "int");
+    s.type("pubid:plateau:annex", "annex", {
+        core: [],
+        atoms: [["letter", "letter"]],
+    });
+    s.type("pubid:plateau:handbook", "hb", { core: [["number", "int"]] });
+    s.type("pubid:plateau:identifier", "id", { core: [["number", "int"]] });
+    s.type("pubid:plateau:technical-report", "tr", { core: [["number", "int"]] });
+});

package/dist/pubid-urn/schemas/sae.d.ts

@@ -0,0 +1,8 @@
+/**
+ * The pubid-scheme URN schema of SAE — the transcription
+ * of lib/pubid/<flavor>/pubid_urn_schema.rb (pubid#656, completed by
+ * #670; design in docs/URN-SCHEMES.adoc). GENERATED by
+ * scripts/port-urn-schemas.rb from the ruby declaration: edit the ruby
+ * schema and regenerate, never this table by hand.
+ */
+export declare const saeSchema: import("../schema.js").FlavorSchema;

package/dist/pubid-urn/schemas/sae.js

@@ -0,0 +1,18 @@
+/**
+ * The pubid-scheme URN schema of SAE — the transcription
+ * of lib/pubid/<flavor>/pubid_urn_schema.rb (pubid#656, completed by
+ * #670; design in docs/URN-SCHEMES.adoc). GENERATED by
+ * scripts/port-urn-schemas.rb from the ruby declaration: edit the ruby
+ * schema and regenerate, never this table by hand.
+ */
+import { define } from "../index.js";
+export const saeSchema = define("sae", (s) => {
+    s.atom("type.abbr", "typeabbr");
+    s.atom("revision", "rev");
+    s.atom("amendment", "amd");
+    s.atom("part", "part");
+    s.atom("date.year", "year", "int");
+    s.atom("date.month", "month", "int");
+    s.atom("year", "yearflat");
+    s.type("pubid:sae:identifier", "id");
+});

package/dist/pubid-urn/schemas/tgpp.d.ts

@@ -0,0 +1,8 @@
+/**
+ * The pubid-scheme URN schema of 3GPP — the transcription
+ * of lib/pubid/<flavor>/pubid_urn_schema.rb (pubid#656, completed by
+ * #670; design in docs/URN-SCHEMES.adoc). GENERATED by
+ * scripts/port-urn-schemas.rb from the ruby declaration: edit the ruby
+ * schema and regenerate, never this table by hand.
+ */
+export declare const tgppSchema: import("../schema.js").FlavorSchema;

package/dist/pubid-urn/schemas/tgpp.js

@@ -0,0 +1,17 @@
+/**
+ * The pubid-scheme URN schema of 3GPP — the transcription
+ * of lib/pubid/<flavor>/pubid_urn_schema.rb (pubid#656, completed by
+ * #670; design in docs/URN-SCHEMES.adoc). GENERATED by
+ * scripts/port-urn-schemas.rb from the ruby declaration: edit the ruby
+ * schema and regenerate, never this table by hand.
+ */
+import { define } from "../index.js";
+export const tgppSchema = define("3gpp", (s) => {
+    s.atom("parts", "part", "list");
+    s.atom("version", "v");
+    s.atom("release", "release");
+    s.atom("suffix", "suffix");
+    s.type("pubid:3gpp:identifier", "id");
+    s.type("pubid:3gpp:technical-report", "tr");
+    s.type("pubid:3gpp:technical-specification", "ts");
+});

package/dist/pubid-urn/schemas/un.d.ts

@@ -0,0 +1,8 @@
+/**
+ * The pubid-scheme URN schema of UN — the transcription
+ * of lib/pubid/<flavor>/pubid_urn_schema.rb (pubid#656, completed by
+ * #670; design in docs/URN-SCHEMES.adoc). GENERATED by
+ * scripts/port-urn-schemas.rb from the ruby declaration: edit the ruby
+ * schema and regenerate, never this table by hand.
+ */
+export declare const unSchema: import("../schema.js").FlavorSchema;

package/dist/pubid-urn/schemas/un.js

@@ -0,0 +1,13 @@
+/**
+ * The pubid-scheme URN schema of UN — the transcription
+ * of lib/pubid/<flavor>/pubid_urn_schema.rb (pubid#656, completed by
+ * #670; design in docs/URN-SCHEMES.adoc). GENERATED by
+ * scripts/port-urn-schemas.rb from the ruby declaration: edit the ruby
+ * schema and regenerate, never this table by hand.
+ */
+import { define } from "../index.js";
+export const unSchema = define("un", (s) => {
+    s.atom("path", "path", "list");
+    s.type("pubid:un:document", "document");
+    s.type("pubid:un:identifier", "id");
+});

package/dist/pubid-urn/schemas/w3c.d.ts

@@ -0,0 +1,8 @@
+/**
+ * The pubid-scheme URN schema of W3C — the transcription
+ * of lib/pubid/<flavor>/pubid_urn_schema.rb (pubid#656, completed by
+ * #670; design in docs/URN-SCHEMES.adoc). GENERATED by
+ * scripts/port-urn-schemas.rb from the ruby declaration: edit the ruby
+ * schema and regenerate, never this table by hand.
+ */
+export declare const w3cSchema: import("../schema.js").FlavorSchema;

package/dist/pubid-urn/schemas/w3c.js

@@ -0,0 +1,23 @@
+/**
+ * The pubid-scheme URN schema of W3C — the transcription
+ * of lib/pubid/<flavor>/pubid_urn_schema.rb (pubid#656, completed by
+ * #670; design in docs/URN-SCHEMES.adoc). GENERATED by
+ * scripts/port-urn-schemas.rb from the ruby declaration: edit the ruby
+ * schema and regenerate, never this table by hand.
+ */
+import { define } from "../index.js";
+export const w3cSchema = define("w3c", (s) => {
+    s.atom("date", "date");
+    s.type("pubid:w3c:candidate-recommendation", "cr");
+    s.type("pubid:w3c:candidate-recommendation-draft", "crd");
+    s.type("pubid:w3c:draft-note", "dn");
+    s.type("pubid:w3c:identifier", "id");
+    s.type("pubid:w3c:note", "note");
+    s.type("pubid:w3c:obsolete-recommendation", "or");
+    s.type("pubid:w3c:proposed-edited-recommendation", "per");
+    s.type("pubid:w3c:proposed-recommendation", "pr");
+    s.type("pubid:w3c:recommendation", "rec");
+    s.type("pubid:w3c:standard", "std");
+    s.type("pubid:w3c:superseded-recommendation", "sr");
+    s.type("pubid:w3c:working-draft", "wd");
+});

package/dist/pubid-urn/schemas/xsf.d.ts

@@ -0,0 +1,8 @@
+/**
+ * The pubid-scheme URN schema of XSF — the transcription
+ * of lib/pubid/<flavor>/pubid_urn_schema.rb (pubid#656, completed by
+ * #670; design in docs/URN-SCHEMES.adoc). GENERATED by
+ * scripts/port-urn-schemas.rb from the ruby declaration: edit the ruby
+ * schema and regenerate, never this table by hand.
+ */
+export declare const xsfSchema: import("../schema.js").FlavorSchema;

package/dist/pubid-urn/schemas/xsf.js

@@ -0,0 +1,12 @@
+/**
+ * The pubid-scheme URN schema of XSF — the transcription
+ * of lib/pubid/<flavor>/pubid_urn_schema.rb (pubid#656, completed by
+ * #670; design in docs/URN-SCHEMES.adoc). GENERATED by
+ * scripts/port-urn-schemas.rb from the ruby declaration: edit the ruby
+ * schema and regenerate, never this table by hand.
+ */
+import { define } from "../index.js";
+export const xsfSchema = define("xsf", (s) => {
+    s.type("pubid:xsf:identifier", "id");
+    s.type("pubid:xsf:xep", "xep");
+});

package/dist/pubid-urn/slug.d.ts

@@ -0,0 +1,20 @@
+/**
+ * The slug form (relaton#441): the URN wearing HTTP-path clothes — the
+ * TS mirror of Pubid::PubidUrn.to_slug/from_slug.
+ *
+ * Each ":" segment becomes a "/" segment, after the "urn:pubid:" prefix
+ * is cut — "urn:pubid:iso:is:9001:year-2015" is "iso/is/9001/year-2015".
+ * The contract's path-safety gate guarantees no segment carries a "/",
+ * so the transform is bijective: {@linkcode fromSlug} rebuilds the exact
+ * URN. The flat form is the flat `/`-joined string, fit for filenames.
+ */
+import type { BaseIdentifier } from "../model/identifier.js";
+/** The slug of an identifier or of its pubid-scheme URN, with no leading
+ *  or trailing "/". A String input must be a canonical pubid-scheme URN.
+ *  @raise UrnParseError when a String is not a canonical pubid-scheme URN. */
+export declare function toSlug(source: BaseIdentifier | string): string;
+/** The slug parse side: "/"-joined segments rebuild the URN and parse
+ *  through the canonical gate, so a slug of a landed flavor round-trips
+ *  by toHash exactly like its URN.
+ *  @raise UrnParseError for a malformed, unknown or non-canonical slug. */
+export declare function fromSlug(slug: string): BaseIdentifier;

package/dist/pubid-urn/slug.js

@@ -0,0 +1,47 @@
+/**
+ * The slug form (relaton#441): the URN wearing HTTP-path clothes — the
+ * TS mirror of Pubid::PubidUrn.to_slug/from_slug.
+ *
+ * Each ":" segment becomes a "/" segment, after the "urn:pubid:" prefix
+ * is cut — "urn:pubid:iso:is:9001:year-2015" is "iso/is/9001/year-2015".
+ * The contract's path-safety gate guarantees no segment carries a "/",
+ * so the transform is bijective: {@linkcode fromSlug} rebuilds the exact
+ * URN. The flat form is the flat `/`-joined string, fit for filenames.
+ */
+import { PREFIX, generate, parse } from "./index.js";
+import { InvalidInputError, UrnParseError } from "./errors.js";
+import { MAX_LENGTH } from "./index.js";
+/** The slug of an identifier or of its pubid-scheme URN, with no leading
+ *  or trailing "/". A String input must be a canonical pubid-scheme URN.
+ *  @raise UrnParseError when a String is not a canonical pubid-scheme URN. */
+export function toSlug(source) {
+    let urn;
+    if (typeof source === "string") {
+        parse(source);
+        urn = source;
+    }
+    else if (source !== null && typeof source === "object" && typeof source.toHash === "function") {
+        urn = generate(source.toHash());
+    }
+    else {
+        throw new InvalidInputError("to_slug takes an identifier or a pubid-scheme URN string");
+    }
+    return urn.slice(PREFIX.length).replaceAll(":", "/");
+}
+/** The slug parse side: "/"-joined segments rebuild the URN and parse
+ *  through the canonical gate, so a slug of a landed flavor round-trips
+ *  by toHash exactly like its URN.
+ *  @raise UrnParseError for a malformed, unknown or non-canonical slug. */
+export function fromSlug(slug) {
+    if (typeof slug !== "string") {
+        throw new InvalidInputError("input is not a String");
+    }
+    if (slug.length > MAX_LENGTH) {
+        throw new InvalidInputError(`slug exceeds ${MAX_LENGTH} characters`);
+    }
+    // ruby split("/", -1): trailing separators make empty segments too.
+    if (slug.split("/").some((segment) => segment === "")) {
+        throw new UrnParseError("slug has empty segments");
+    }
+    return parse(PREFIX + slug.replaceAll("/", ":"));
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pubid/pubid",
-  "version": "0.1.32",
+  "version": "0.1.34",
   "description": "TypeScript PubID identifiers: resolution, normalization and canonical hashes for every identifier in the pubid-testsuite corpus (41 standards bodies), with a conformance runner mirroring the Ruby reference",
   "type": "module",
   "license": "MIT",
@@ -13,6 +13,7 @@
     "build": "tsc -p tsconfig.json",
     "test": "tsc -p tsconfig.test.json && node --test dist-test/test/*.test.js",
     "conformance": "tsc -p tsconfig.json && node dist/conformance/cli.js",
+    "probe:urn": "node scripts/probe-pubid-urn.mjs",
     "prepublishOnly": "tsc -p tsconfig.json",
     "artifact": "tsc -p tsconfig.json && node scripts/build-artifact.mjs",
     "doc:api": "node scripts/api-reference.mjs"