@pubid/pubid 0.1.3 → 0.1.4

package/dist/flavors/nist/model.d.ts

@@ -0,0 +1,155 @@
+import { BaseIdentifier } from "../../model/identifier.js";
+import type { IdentifierStatic } from "../../model/identifier.js";
+import { type FieldMapping } from "../../model/attribute.js";
+import { Component } from "../../model/component.js";
+/**
+ * Port of lib/pubid/nist/identifiers/base.rb + components/*. The wire
+ * hash mirrors the Ruby compact shape: series/subseries/volume are bare
+ * scalars, first/second_number are dropped (build artifacts), and the
+ * components serialize as their plain field hashes.
+ */
+export declare class NistCode extends Component {
+    readonly value: string;
+    constructor(attrs: Record<string, unknown>);
+    render(): string;
+    toWire(): Record<string, unknown>;
+}
+export declare class NistPart {
+    readonly type: string;
+    readonly value: string;
+    constructor(attrs: Record<string, unknown>);
+    toWire(): Record<string, unknown>;
+    render(notation?: string): string;
+}
+export declare class NistVolume {
+    readonly value: string;
+    constructor(attrs: Record<string, unknown>);
+    toWire(): Record<string, unknown>;
+    render(): string;
+}
+export declare class NistIssueNumber {
+    readonly number: string;
+    constructor(attrs: Record<string, unknown>);
+    toWire(): Record<string, unknown>;
+    render(): string;
+}
+export declare class NistEdition {
+    readonly type: string | undefined;
+    readonly id: string | undefined;
+    readonly additional_text: string | undefined;
+    readonly original_prefix: string | undefined;
+    constructor(attrs: Record<string, unknown>);
+    toWire(): Record<string, unknown>;
+    render(): string;
+}
+export declare class NistUpdate {
+    readonly number: string | undefined;
+    readonly year: string | undefined;
+    readonly month: string | undefined;
+    readonly prefix: string | undefined;
+    constructor(attrs: Record<string, unknown>);
+    toWire(): Record<string, unknown>;
+    render(format?: "short" | "mr"): string;
+    private yearMonth;
+}
+export declare class NistTranslation {
+    readonly code: string;
+    constructor(attrs: Record<string, unknown>);
+    toWire(): Record<string, unknown>;
+    render(format?: "short" | "mr"): string;
+}
+export declare class NistStage {
+    readonly id: string;
+    readonly type: string;
+    constructor(attrs: Record<string, unknown>);
+    toWire(): Record<string, unknown>;
+    render(): string;
+}
+export declare class NistVersion {
+    readonly value: string;
+    constructor(attrs: Record<string, unknown>);
+    toWire(): Record<string, unknown>;
+    render(): string;
+}
+export declare class NistSupplement {
+    readonly number: string | undefined;
+    readonly year: string | undefined;
+    readonly month: string | undefined;
+    readonly month_end: string | undefined;
+    readonly year_end: string | undefined;
+    readonly has_revision: boolean;
+    readonly suffix: string | undefined;
+    constructor(attrs: Record<string, unknown>);
+    toWire(): Record<string, unknown> | undefined;
+    static fromRaw(value: string | undefined, hasRevision?: boolean): NistSupplement;
+    isRange(): boolean;
+    valueString(): string;
+    render(): string;
+}
+export type SeriesPolicy = {
+    preserveLetterSuffix: boolean;
+    modernEditionDate: boolean;
+    partNumAsComponent: boolean;
+};
+export declare function seriesPolicy(series: string | undefined): SeriesPolicy;
+export declare abstract class NistIdentifier extends BaseIdentifier {
+    static attributes: import("../../model/attribute.js").AttributeTable;
+    static mappings: FieldMapping[];
+    readonly publisher: string | undefined;
+    readonly series: NistCode | undefined;
+    readonly subseries: NistCode | undefined;
+    readonly number: string | undefined;
+    readonly edition: NistEdition | undefined;
+    readonly volume: NistVolume | undefined;
+    readonly part: NistPart | undefined;
+    readonly stage: NistStage | undefined;
+    readonly version_component: NistVersion | undefined;
+    readonly update_component: NistUpdate | undefined;
+    readonly update: NistUpdate | undefined;
+    readonly translation_component: NistTranslation | undefined;
+    readonly translation: string | undefined;
+    readonly issue_number: NistIssueNumber | undefined;
+    readonly parsed_format: string | undefined;
+    readonly publisher_was_parsed: boolean | undefined;
+    readonly parts: string[] | undefined;
+    readonly revision_year: string | undefined;
+    readonly revision_month: string | undefined;
+    readonly edition_year: string | undefined;
+    readonly version: string | undefined;
+    readonly year: number | undefined;
+    readonly supplement: NistSupplement | undefined;
+    readonly errata: string | undefined;
+    readonly index: string | undefined;
+    readonly insert: string | undefined;
+    readonly section: string | undefined;
+    readonly appendix: string | undefined;
+    readonly addendum: string | undefined;
+    readonly addendum_number: string | undefined;
+    readonly draft: string | undefined;
+    readonly draft_number: string | undefined;
+    readonly date_year: string | undefined;
+    readonly date_month: string | undefined;
+    readonly date_day: string | undefined;
+    readonly dated_seq: string | undefined;
+    seriesCode(): string | undefined;
+    defaultPublisher(): string;
+    revision(): string | undefined;
+    supplementShort(): string;
+    appendShortComponents(skipPart?: boolean): string;
+    appendMrComponents(skipPart?: boolean): string;
+    effectiveSeries(): string | undefined;
+    shortRenderPublisher(): string | undefined;
+    renderShort(): string;
+    renderMr(): string;
+    render(): string;
+}
+export declare abstract class NistSupplementIdentifier extends NistIdentifier {
+    static attributes: import("../../model/attribute.js").AttributeTable;
+    readonly base: NistIdentifier | undefined;
+    readonly supplement_date_range_start: string | undefined;
+    readonly supplement_date_range_end: string | undefined;
+    readonly implicit_supplement: boolean | undefined;
+    render(): string;
+}
+export declare const NIST_CLASSES: Map<string, IdentifierStatic>;
+export declare const SP_SUBSERIES: string[];