@bsv/dpp-profiles 0.3.0-beta.1

package/dist/evidence-shapes.d.ts

@@ -0,0 +1,198 @@
+/**
+ * The shared evidence, measurement, document, language and date shapes
+ * (`contracts/profile-evidence.schema.json`, `spec/passport-projections.md`
+ * §5), with the few pure helpers a projection and a profile validator need:
+ * which precision a date carries, which language of a text to return, when a
+ * warranty expiry can be derived from evidence and when it cannot, and which
+ * unit conversions are explicit enough to make. None of these guesses. A
+ * month is never given a day, a fraction is never read as a percent without
+ * its basis saying so, and a missing start date yields no expiry.
+ */
+export type DatePrecision = 'day' | 'month' | 'year';
+export interface PreciseDate {
+    date: string;
+    precision: DatePrecision;
+}
+export type EvidenceGranularity = 'model' | 'batch' | 'item' | 'component';
+export type AccessScope = 'public' | 'owner' | 'legitimate' | 'authority';
+export interface SubjectRef {
+    id: string;
+    granularity: EvidenceGranularity;
+    componentRef?: string;
+}
+export interface SourceRef {
+    kind: 'source-revision' | 'credential' | 'document';
+    id: string;
+    revisionId?: string;
+    digest?: string;
+}
+export interface RelevantTime {
+    at?: string;
+    from?: string;
+    until?: string;
+    precision: DatePrecision;
+}
+export interface ClaimEvidence {
+    property: string;
+    subject: SubjectRef;
+    source: SourceRef;
+    reporter?: string;
+    issuer?: string;
+    relevantTime?: RelevantTime;
+    reportRef?: string;
+}
+export interface RelatedDocument {
+    ref: string;
+    purpose: string;
+    url?: string;
+    mediaType?: string;
+    language?: string;
+    revision?: string;
+    date?: string;
+    precision?: DatePrecision;
+    digest?: string;
+    byteLength?: number;
+    retained: boolean;
+    access: AccessScope;
+}
+export interface Certification {
+    scheme: {
+        id: string;
+        name: string;
+        version?: string;
+    };
+    certificateId: string;
+    issuer: string;
+    subject: SubjectRef;
+    validFrom?: string;
+    validUntil?: string;
+    precision?: DatePrecision;
+    documentRef?: RelatedDocument;
+    credentialRef?: {
+        id: string;
+        digest?: string;
+    };
+    verification: {
+        status: 'verified' | 'failed' | 'unknown' | 'not-checked';
+        checkedAt?: string;
+        reportRef?: string;
+    };
+}
+export type MeasurementBasis = 'fraction' | 'percent' | 'mass' | 'count' | 'per-functional-unit';
+export interface MeasurementConversion {
+    fromUnit: string;
+    toUnit: string;
+    rule: string;
+    explicit: true;
+}
+export interface Measurement {
+    property: string;
+    value: number | string;
+    unit: string;
+    basis?: MeasurementBasis;
+    functionalUnit?: string;
+    denominator?: {
+        value: number;
+        unit: string;
+    };
+    method?: {
+        id: string;
+        version?: string;
+    };
+    boundary?: string;
+    conditions?: string;
+    measuredAt?: PreciseDate;
+    effective?: {
+        from?: string;
+        until?: string;
+    };
+    subject: SubjectRef;
+    evidence?: ClaimEvidence[];
+    conversion?: MeasurementConversion;
+}
+export interface LocalisedValue {
+    language: string;
+    text: string;
+}
+export type LanguageSelection = 'exact' | 'base' | 'default';
+export interface LocalisedText {
+    values: LocalisedValue[];
+    returnedLanguage?: string;
+    selection?: LanguageSelection;
+}
+export interface WarrantyTerms {
+    duration: {
+        value: number;
+        unit: 'months' | 'years';
+    };
+    calendarRule: 'purchase-date' | 'manufacture-date' | 'first-use';
+    conditions?: string;
+}
+export interface WarrantyStart {
+    date: string;
+    precision: DatePrecision;
+    evidenceRef: string;
+}
+export interface WarrantyExpiry {
+    start: WarrantyStart;
+    terms: WarrantyTerms;
+    derived: {
+        date: string;
+        precision: DatePrecision;
+        rule: string;
+    };
+}
+/**
+ * The precision a date string carries, or undefined when it is not a real
+ * calendar date at any of the three precisions. `2026-02-30` is undefined,
+ * not a February day rounded to something.
+ */
+export declare function datePrecisionOf(text: string): DatePrecision | undefined;
+/** The primary language subtag of a BCP 47 tag, lower-cased: `de` of `de-CH`. */
+export declare function baseLanguage(tag: string): string;
+/**
+ * Which of a text's languages to return: the exact tag the reader asked for,
+ * then any value in the reader's base language (or the base of the exact
+ * tag), then the declared default. The selection is recorded so a surface
+ * can say which it got; a value is never rewritten into another language.
+ * Undefined when none of the three matches, which a caller reports rather
+ * than papering over with the first value.
+ */
+export declare function selectLanguage(values: readonly LocalisedValue[], locale: {
+    exact?: string;
+    base?: string;
+    default: string;
+}): {
+    text: string;
+    language: string;
+    selection: LanguageSelection;
+} | undefined;
+/**
+ * A warranty expiry from an evidenced start and the model's terms, at the
+ * precision the start permits: a day start yields a day (month ends clamped,
+ * so 31 January plus one month is 28 or 29 February), a month start yields a
+ * month, a year start yields a year and only for whole years. No start, a
+ * start whose text does not match its precision, or a duration a year cannot
+ * place, yields a reason and no date. Terms alone never yield an expiry.
+ */
+export declare function deriveWarrantyExpiry(start: WarrantyStart | undefined, terms: WarrantyTerms): {
+    expiry: WarrantyExpiry;
+} | {
+    reason: string;
+};
+/**
+ * The one conversion explicit enough to make without a method: a fraction
+ * whose basis says it is a fraction, to a percent. Everything else is
+ * refused with the reason, because a bare number does not say whether 0.5
+ * is a half or half a percent, and a mass-balance share is not a physical
+ * share. A converted measurement keeps its source unit in `conversion`.
+ */
+export declare function convertMeasurement(measurement: Measurement, target: {
+    unit: string;
+    basis?: MeasurementBasis;
+}): {
+    measurement: Measurement;
+} | {
+    reason: string;
+};
+//# sourceMappingURL=evidence-shapes.d.ts.map

package/dist/evidence-shapes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"evidence-shapes.d.ts","sourceRoot":"","sources":["../src/evidence-shapes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,MAAM,MAAM,aAAa,GAAG,KAAK,GAAG,OAAO,GAAG,MAAM,CAAA;AACpD,MAAM,WAAW,WAAW;IAAG,IAAI,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,aAAa,CAAA;CAAE;AACvE,MAAM,MAAM,mBAAmB,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,WAAW,CAAA;AAC1E,MAAM,MAAM,WAAW,GAAG,QAAQ,GAAG,OAAO,GAAG,YAAY,GAAG,WAAW,CAAA;AAEzE,MAAM,WAAW,UAAU;IAAG,EAAE,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,mBAAmB,CAAC;IAAC,YAAY,CAAC,EAAE,MAAM,CAAA;CAAE;AACnG,MAAM,WAAW,SAAS;IAAG,IAAI,EAAE,iBAAiB,GAAG,YAAY,GAAG,UAAU,CAAC;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE;AACpI,MAAM,WAAW,YAAY;IAAG,EAAE,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,aAAa,CAAA;CAAE;AAEtG,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,UAAU,CAAA;IACnB,MAAM,EAAE,SAAS,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,YAAY,CAAC,EAAE,YAAY,CAAA;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,eAAe;IAC9B,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,SAAS,CAAC,EAAE,aAAa,CAAA;IACzB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,QAAQ,EAAE,OAAO,CAAA;IACjB,MAAM,EAAE,WAAW,CAAA;CACpB;AAED,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IACtD,aAAa,EAAE,MAAM,CAAA;IACrB,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,UAAU,CAAA;IACnB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,SAAS,CAAC,EAAE,aAAa,CAAA;IACzB,WAAW,CAAC,EAAE,eAAe,CAAA;IAC7B,aAAa,CAAC,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IAC/C,YAAY,EAAE;QAAE,MAAM,EAAE,UAAU,GAAG,QAAQ,GAAG,SAAS,GAAG,aAAa,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;CACpH;AAED,MAAM,MAAM,gBAAgB,GAAG,UAAU,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,qBAAqB,CAAA;AAEhG,MAAM,WAAW,qBAAqB;IAAG,QAAQ,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,IAAI,CAAA;CAAE;AAEzG,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,gBAAgB,CAAA;IACxB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,WAAW,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAA;IAC7C,MAAM,CAAC,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IACzC,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,UAAU,CAAC,EAAE,WAAW,CAAA;IACxB,SAAS,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IAC7C,OAAO,EAAE,UAAU,CAAA;IACnB,QAAQ,CAAC,EAAE,aAAa,EAAE,CAAA;IAC1B,UAAU,CAAC,EAAE,qBAAqB,CAAA;CACnC;AAED,MAAM,WAAW,cAAc;IAAG,QAAQ,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE;AAClE,MAAM,MAAM,iBAAiB,GAAG,OAAO,GAAG,MAAM,GAAG,SAAS,CAAA;AAC5D,MAAM,WAAW,aAAa;IAAG,MAAM,EAAE,cAAc,EAAE,CAAC;IAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE,iBAAiB,CAAA;CAAE;AAErH,MAAM,WAAW,aAAa;IAAG,QAAQ,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,QAAQ,GAAG,OAAO,CAAA;KAAE,CAAC;IAAC,YAAY,EAAE,eAAe,GAAG,kBAAkB,GAAG,WAAW,CAAC;IAAC,UAAU,CAAC,EAAE,MAAM,CAAA;CAAE;AAC/K,MAAM,WAAW,aAAa;IAAG,IAAI,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,aAAa,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE;AAC9F,MAAM,WAAW,cAAc;IAAG,KAAK,EAAE,aAAa,CAAC;IAAC,KAAK,EAAE,aAAa,CAAC;IAAC,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,aAAa,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE;AAUjJ;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS,CAOvE;AAED,iFAAiF;AACjF,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEhD;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,SAAS,cAAc,EAAE,EAAE,MAAM,EAAE;IAAE,KAAK,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,iBAAiB,CAAA;CAAE,GAAG,SAAS,CAc1M;AAED;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,aAAa,GAAG,SAAS,EAAE,KAAK,EAAE,aAAa,GAAG;IAAE,MAAM,EAAE,cAAc,CAAA;CAAE,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAoB5I;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,gBAAgB,CAAA;CAAE,GAAG;IAAE,WAAW,EAAE,WAAW,CAAA;CAAE,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAgBlK"}

package/dist/evidence-shapes.js

@@ -0,0 +1,123 @@
+/**
+ * The shared evidence, measurement, document, language and date shapes
+ * (`contracts/profile-evidence.schema.json`, `spec/passport-projections.md`
+ * §5), with the few pure helpers a projection and a profile validator need:
+ * which precision a date carries, which language of a text to return, when a
+ * warranty expiry can be derived from evidence and when it cannot, and which
+ * unit conversions are explicit enough to make. None of these guesses. A
+ * month is never given a day, a fraction is never read as a percent without
+ * its basis saying so, and a missing start date yields no expiry.
+ */
+const DAY = /^(\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$/;
+const MONTH = /^(\d{4})-(0[1-9]|1[0-2])$/;
+const YEAR = /^\d{4}$/;
+function daysInMonth(year, month) {
+    return new Date(Date.UTC(year, month, 0)).getUTCDate();
+}
+/**
+ * The precision a date string carries, or undefined when it is not a real
+ * calendar date at any of the three precisions. `2026-02-30` is undefined,
+ * not a February day rounded to something.
+ */
+export function datePrecisionOf(text) {
+    if (YEAR.test(text))
+        return 'year';
+    if (MONTH.test(text))
+        return 'month';
+    const day = DAY.exec(text);
+    if (day == null)
+        return undefined;
+    const [, y, m, d] = day;
+    return Number(d) <= daysInMonth(Number(y), Number(m)) ? 'day' : undefined;
+}
+/** The primary language subtag of a BCP 47 tag, lower-cased: `de` of `de-CH`. */
+export function baseLanguage(tag) {
+    return tag.split('-')[0].toLowerCase();
+}
+/**
+ * Which of a text's languages to return: the exact tag the reader asked for,
+ * then any value in the reader's base language (or the base of the exact
+ * tag), then the declared default. The selection is recorded so a surface
+ * can say which it got; a value is never rewritten into another language.
+ * Undefined when none of the three matches, which a caller reports rather
+ * than papering over with the first value.
+ */
+export function selectLanguage(values, locale) {
+    const lower = (tag) => tag.toLowerCase();
+    if (locale.exact != null) {
+        const exact = values.find((v) => lower(v.language) === lower(locale.exact));
+        if (exact != null)
+            return { text: exact.text, language: exact.language, selection: 'exact' };
+    }
+    const base = locale.base != null ? baseLanguage(locale.base) : locale.exact != null ? baseLanguage(locale.exact) : undefined;
+    if (base != null) {
+        const match = values.find((v) => baseLanguage(v.language) === base);
+        if (match != null)
+            return { text: match.text, language: match.language, selection: 'base' };
+    }
+    const fallback = values.find((v) => lower(v.language) === lower(locale.default)) ?? values.find((v) => baseLanguage(v.language) === baseLanguage(locale.default));
+    if (fallback != null)
+        return { text: fallback.text, language: fallback.language, selection: 'default' };
+    return undefined;
+}
+/**
+ * A warranty expiry from an evidenced start and the model's terms, at the
+ * precision the start permits: a day start yields a day (month ends clamped,
+ * so 31 January plus one month is 28 or 29 February), a month start yields a
+ * month, a year start yields a year and only for whole years. No start, a
+ * start whose text does not match its precision, or a duration a year cannot
+ * place, yields a reason and no date. Terms alone never yield an expiry.
+ */
+export function deriveWarrantyExpiry(start, terms) {
+    if (start == null)
+        return { reason: `no evidenced ${terms.calendarRule} start; the model's terms alone give no expiry` };
+    if (datePrecisionOf(start.date) !== start.precision)
+        return { reason: `the start ${start.date} is not a ${start.precision}-precision date` };
+    if (!Number.isInteger(terms.duration.value) || terms.duration.value < 1)
+        return { reason: 'the warranty duration is not a positive whole number' };
+    const months = terms.duration.unit === 'years' ? terms.duration.value * 12 : terms.duration.value;
+    const label = `${terms.calendarRule} plus ${terms.duration.value} ${terms.duration.unit}`;
+    if (start.precision === 'year') {
+        if (months % 12 !== 0)
+            return { reason: `a year-precision start cannot place ${months} months in a year; the expiry stays underived` };
+        return { expiry: { start, terms, derived: { date: String(Number(start.date) + months / 12), precision: 'year', rule: `${label}, year precision` } } };
+    }
+    const [y, m, d] = start.date.split('-').map(Number);
+    const total = (y * 12 + (m - 1)) + months;
+    const year = Math.floor(total / 12);
+    const month = (total % 12) + 1;
+    const mm = String(month).padStart(2, '0');
+    if (start.precision === 'month') {
+        return { expiry: { start, terms, derived: { date: `${year}-${mm}`, precision: 'month', rule: `${label}, month precision; no day is invented` } } };
+    }
+    const day = Math.min(d, daysInMonth(year, month));
+    return { expiry: { start, terms, derived: { date: `${year}-${mm}-${String(day).padStart(2, '0')}`, precision: 'day', rule: `${label}, day precision, month end clamped` } } };
+}
+/**
+ * The one conversion explicit enough to make without a method: a fraction
+ * whose basis says it is a fraction, to a percent. Everything else is
+ * refused with the reason, because a bare number does not say whether 0.5
+ * is a half or half a percent, and a mass-balance share is not a physical
+ * share. A converted measurement keeps its source unit in `conversion`.
+ */
+export function convertMeasurement(measurement, target) {
+    if (typeof measurement.value !== 'number')
+        return { reason: 'a textual value cannot be converted' };
+    if (measurement.unit === target.unit && (target.basis == null || measurement.basis === target.basis))
+        return { measurement };
+    if (measurement.basis === 'fraction' && target.basis === 'percent') {
+        return {
+            measurement: {
+                ...measurement,
+                value: measurement.value * 100,
+                unit: target.unit,
+                basis: 'percent',
+                conversion: { fromUnit: measurement.unit, toUnit: target.unit, rule: 'fraction to percent: multiplied by 100', explicit: true },
+            },
+        };
+    }
+    if (measurement.basis == null)
+        return { reason: `no basis is declared for ${measurement.property}, so ${measurement.unit} cannot be read as ${target.unit}` };
+    return { reason: `no explicit conversion from ${measurement.basis} in ${measurement.unit} to ${target.basis ?? 'an undeclared basis'} in ${target.unit}` };
+}
+//# sourceMappingURL=evidence-shapes.js.map

package/dist/evidence-shapes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"evidence-shapes.js","sourceRoot":"","sources":["../src/evidence-shapes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AA8EH,MAAM,GAAG,GAAG,iDAAiD,CAAA;AAC7D,MAAM,KAAK,GAAG,2BAA2B,CAAA;AACzC,MAAM,IAAI,GAAG,SAAS,CAAA;AAEtB,SAAS,WAAW,CAAC,IAAY,EAAE,KAAa;IAC9C,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,EAAE,CAAA;AACxD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAAC,IAAY;IAC1C,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;QAAE,OAAO,MAAM,CAAA;IAClC,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;QAAE,OAAO,OAAO,CAAA;IACpC,MAAM,GAAG,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAC1B,IAAI,GAAG,IAAI,IAAI;QAAE,OAAO,SAAS,CAAA;IACjC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,GAAG,CAAA;IACvB,OAAO,MAAM,CAAC,CAAC,CAAC,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAA;AAC3E,CAAC;AAED,iFAAiF;AACjF,MAAM,UAAU,YAAY,CAAC,GAAW;IACtC,OAAO,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAE,CAAC,WAAW,EAAE,CAAA;AACzC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,cAAc,CAAC,MAAiC,EAAE,MAA0D;IAC1H,MAAM,KAAK,GAAG,CAAC,GAAW,EAAU,EAAE,CAAC,GAAG,CAAC,WAAW,EAAE,CAAA;IACxD,IAAI,MAAM,CAAC,KAAK,IAAI,IAAI,EAAE,CAAC;QACzB,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,KAAK,CAAC,MAAM,CAAC,KAAe,CAAC,CAAC,CAAA;QACrF,IAAI,KAAK,IAAI,IAAI;YAAE,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,CAAA;IAC9F,CAAC;IACD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAC5H,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;QACjB,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,IAAI,CAAC,CAAA;QACnE,IAAI,KAAK,IAAI,IAAI;YAAE,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,CAAA;IAC7F,CAAC;IACD,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAA;IACjK,IAAI,QAAQ,IAAI,IAAI;QAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,QAAQ,CAAC,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,CAAA;IACvG,OAAO,SAAS,CAAA;AAClB,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,oBAAoB,CAAC,KAAgC,EAAE,KAAoB;IACzF,IAAI,KAAK,IAAI,IAAI;QAAE,OAAO,EAAE,MAAM,EAAE,gBAAgB,KAAK,CAAC,YAAY,gDAAgD,EAAE,CAAA;IACxH,IAAI,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,KAAK,CAAC,SAAS;QAAE,OAAO,EAAE,MAAM,EAAE,aAAa,KAAK,CAAC,IAAI,aAAa,KAAK,CAAC,SAAS,iBAAiB,EAAE,CAAA;IAC5I,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,GAAG,CAAC;QAAE,OAAO,EAAE,MAAM,EAAE,sDAAsD,EAAE,CAAA;IAClJ,MAAM,MAAM,GAAG,KAAK,CAAC,QAAQ,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,GAAG,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAA;IACjG,MAAM,KAAK,GAAG,GAAG,KAAK,CAAC,YAAY,SAAS,KAAK,CAAC,QAAQ,CAAC,KAAK,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAA;IACzF,IAAI,KAAK,CAAC,SAAS,KAAK,MAAM,EAAE,CAAC;QAC/B,IAAI,MAAM,GAAG,EAAE,KAAK,CAAC;YAAE,OAAO,EAAE,MAAM,EAAE,uCAAuC,MAAM,+CAA+C,EAAE,CAAA;QACtI,OAAO,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,MAAM,GAAG,EAAE,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,kBAAkB,EAAE,EAAE,EAAE,CAAA;IACvJ,CAAC;IACD,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAyC,CAAA;IAC3F,MAAM,KAAK,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,MAAM,CAAA;IACzC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,EAAE,CAAC,CAAA;IACnC,MAAM,KAAK,GAAG,CAAC,KAAK,GAAG,EAAE,CAAC,GAAG,CAAC,CAAA;IAC9B,MAAM,EAAE,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAA;IACzC,IAAI,KAAK,CAAC,SAAS,KAAK,OAAO,EAAE,CAAC;QAChC,OAAO,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,IAAI,IAAI,EAAE,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,KAAK,uCAAuC,EAAE,EAAE,EAAE,CAAA;IACpJ,CAAC;IACD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAW,EAAE,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAA;IAC3D,OAAO,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,IAAI,IAAI,EAAE,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,KAAK,oCAAoC,EAAE,EAAE,EAAE,CAAA;AAC/K,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,kBAAkB,CAAC,WAAwB,EAAE,MAAkD;IAC7G,IAAI,OAAO,WAAW,CAAC,KAAK,KAAK,QAAQ;QAAE,OAAO,EAAE,MAAM,EAAE,qCAAqC,EAAE,CAAA;IACnG,IAAI,WAAW,CAAC,IAAI,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,IAAI,IAAI,WAAW,CAAC,KAAK,KAAK,MAAM,CAAC,KAAK,CAAC;QAAE,OAAO,EAAE,WAAW,EAAE,CAAA;IAC5H,IAAI,WAAW,CAAC,KAAK,KAAK,UAAU,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QACnE,OAAO;YACL,WAAW,EAAE;gBACX,GAAG,WAAW;gBACd,KAAK,EAAE,WAAW,CAAC,KAAK,GAAG,GAAG;gBAC9B,IAAI,EAAE,MAAM,CAAC,IAAI;gBACjB,KAAK,EAAE,SAAS;gBAChB,UAAU,EAAE,EAAE,QAAQ,EAAE,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,wCAAwC,EAAE,QAAQ,EAAE,IAAI,EAAE;aAChI;SACF,CAAA;IACH,CAAC;IACD,IAAI,WAAW,CAAC,KAAK,IAAI,IAAI;QAAE,OAAO,EAAE,MAAM,EAAE,4BAA4B,WAAW,CAAC,QAAQ,QAAQ,WAAW,CAAC,IAAI,sBAAsB,MAAM,CAAC,IAAI,EAAE,EAAE,CAAA;IAC7J,OAAO,EAAE,MAAM,EAAE,+BAA+B,WAAW,CAAC,KAAK,OAAO,WAAW,CAAC,IAAI,OAAO,MAAM,CAAC,KAAK,IAAI,qBAAqB,OAAO,MAAM,CAAC,IAAI,EAAE,EAAE,CAAA;AAC5J,CAAC"}

package/dist/gs1-epc-binary.d.ts

@@ -0,0 +1,81 @@
+/** The EPC header of the SGTIN-96 scheme (Tag Data Standard). */
+export declare const SGTIN_96_HEADER = 48;
+/** The EPC header of the SGTIN-198 scheme (Tag Data Standard). */
+export declare const SGTIN_198_HEADER = 54;
+/** The file-safe, URI-safe base 64 alphabet of the compression standard §4.1 (RFC 4648 §5). */
+export declare const URI_SAFE_BASE64_ALPHABET = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_";
+/**
+ * The SGTIN partition table of the Tag Data Standard: for each partition
+ * value, the bits and digits of the GS1 Company Prefix and of the item
+ * reference (indicator digit included). The two digit counts always sum to
+ * thirteen, so the GTIN-14 is the indicator digit, the company prefix, the
+ * rest of the item reference and a check digit.
+ */
+export declare const SGTIN_PARTITIONS: ReadonlyArray<{
+    companyPrefixBits: number;
+    companyPrefixDigits: number;
+    itemReferenceBits: number;
+    itemReferenceDigits: number;
+}>;
+/** The GS1 AI encodable character set 82, which the SGTIN-198 serial and every Digital Link qualifier value draw from. */
+export declare const GS1_CHARACTER_SET_82: RegExp;
+export interface SgtinDecoding {
+    ok: true;
+    scheme: 'sgtin-96' | 'sgtin-198';
+    /** The eight-bit EPC header, as read. */
+    header: number;
+    /** The three-bit filter value, preserved and not interpreted. */
+    filter: number;
+    partition: number;
+    companyPrefix: string;
+    /** The item reference with its indicator digit first, at the partition's digit count. */
+    itemReference: string;
+    /** The GTIN at fourteen digits, check digit computed. */
+    gtin: string;
+    serial: string;
+    /** The pure-identity EPC URI of the Tag Data Standard, with the serial percent-escaped as that standard requires. */
+    epcUri: string;
+}
+export type EpcBinaryRefusalReason = 'empty' | 'not-hex' | 'not-uri-safe-base64' | 'unsupported-epc-scheme' | 'length' | 'partition' | 'company-prefix' | 'item-reference' | 'serial';
+export interface EpcBinaryRefusal {
+    ok: false;
+    reason: EpcBinaryRefusalReason;
+    detail: string;
+    /** The header as two hex digits, when the string was long enough to read one. */
+    header?: string;
+}
+export type EpcBinaryDecoding = SgtinDecoding | EpcBinaryRefusal;
+/** A string of `0` and `1` from lower-case hexadecimal, four bits per character (compression standard §4.2.1). */
+export declare function bitsFromHex(hex: string): string | undefined;
+/** A string of `0` and `1` from the URI-safe base 64 alphabet, six bits per character (compression standard §4.1). */
+export declare function bitsFromUriSafeBase64(text: string): string | undefined;
+/**
+ * Decode an EPC binary string, given as bits, under the SGTIN-96 and SGTIN-198
+ * schemes. The bit count must be exactly the scheme's length; a hexadecimal
+ * encoding of a 198-bit string carries two padding bits, which must be zero.
+ */
+export declare function decodeEpcBinaryBits(bits: string): EpcBinaryDecoding;
+/**
+ * Decode the compression string of a special compressed GS1 Digital Link URI:
+ * the two characters after the slash select the alphabet (`eh` hexadecimal,
+ * `ex` URI-safe base 64) and the rest is the EPC binary string.
+ */
+export declare function decodeEpcCompressionString(compressionString: string): EpcBinaryDecoding;
+/**
+ * The inverse, for tests and for a writer that prints a compressed carrier:
+ * an SGTIN-96 or SGTIN-198 EPC binary string as bits, from its parts. Refuses
+ * a serial the scheme cannot carry rather than truncating it.
+ */
+export declare function encodeSgtinBits(input: {
+    scheme: 'sgtin-96' | 'sgtin-198';
+    filter: number;
+    partition: number;
+    companyPrefix: string;
+    itemReference: string;
+    serial: string;
+}): string;
+/** Bits to the `eh` form: lower-case hexadecimal, zero-padded to a multiple of four bits. */
+export declare function hexFromBits(bits: string): string;
+/** Bits to the `ex` form: the URI-safe base 64 alphabet, zero-padded to a multiple of six bits. */
+export declare function uriSafeBase64FromBits(bits: string): string;
+//# sourceMappingURL=gs1-epc-binary.d.ts.map

package/dist/gs1-epc-binary.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"gs1-epc-binary.d.ts","sourceRoot":"","sources":["../src/gs1-epc-binary.ts"],"names":[],"mappings":"AAoBA,iEAAiE;AACjE,eAAO,MAAM,eAAe,KAAO,CAAA;AACnC,kEAAkE;AAClE,eAAO,MAAM,gBAAgB,KAAO,CAAA;AAEpC,+FAA+F;AAC/F,eAAO,MAAM,wBAAwB,qEAAqE,CAAA;AAE1G;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,EAAE,aAAa,CAAC;IAAE,iBAAiB,EAAE,MAAM,CAAC;IAAC,mBAAmB,EAAE,MAAM,CAAC;IAAC,iBAAiB,EAAE,MAAM,CAAC;IAAC,mBAAmB,EAAE,MAAM,CAAA;CAAE,CAQ9J,CAAA;AAED,0HAA0H;AAC1H,eAAO,MAAM,oBAAoB,QAAwC,CAAA;AAEzE,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,IAAI,CAAA;IACR,MAAM,EAAE,UAAU,GAAG,WAAW,CAAA;IAChC,yCAAyC;IACzC,MAAM,EAAE,MAAM,CAAA;IACd,iEAAiE;IACjE,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;IACjB,aAAa,EAAE,MAAM,CAAA;IACrB,yFAAyF;IACzF,aAAa,EAAE,MAAM,CAAA;IACrB,yDAAyD;IACzD,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,qHAAqH;IACrH,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,MAAM,sBAAsB,GAC9B,OAAO,GACP,SAAS,GACT,qBAAqB,GACrB,wBAAwB,GACxB,QAAQ,GACR,WAAW,GACX,gBAAgB,GAChB,gBAAgB,GAChB,QAAQ,CAAA;AAEZ,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,KAAK,CAAA;IACT,MAAM,EAAE,sBAAsB,CAAA;IAC9B,MAAM,EAAE,MAAM,CAAA;IACd,iFAAiF;IACjF,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,MAAM,iBAAiB,GAAG,aAAa,GAAG,gBAAgB,CAAA;AAIhE,kHAAkH;AAClH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAK3D;AAED,sHAAsH;AACtH,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAStE;AAqCD;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,iBAAiB,CA0DnE;AAED;;;;GAIG;AACH,wBAAgB,0BAA0B,CAAC,iBAAiB,EAAE,MAAM,GAAG,iBAAiB,CAgBvF;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE;IAAE,MAAM,EAAE,UAAU,GAAG,WAAW,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,aAAa,EAAE,MAAM,CAAC;IAAC,aAAa,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GAAG,MAAM,CAkBpL;AAED,6FAA6F;AAC7F,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAKhD;AAED,mGAAmG;AACnG,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAK1D"}