@pubid/pubid 0.1.3 → 0.1.5

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

@@ -0,0 +1,127 @@
+import { BaseIdentifier } from "../../model/identifier.js";
+import type { IdentifierStatic } from "../../model/identifier.js";
+import { type AttributeTable, type FieldMapping } from "../../model/attribute.js";
+import { PubidDate, Publisher } from "../../model/component.js";
+import { BaseUrnGenerator } from "../../model/urn-generator.js";
+/**
+ * Port of lib/pubid/bsi: the shared base (single_identifier.rb), the
+ * typed-stage registry (bsi.rb TYPED_STAGES_REGISTRY), the ~25 concrete
+ * identifier classes, the renderer (renderer.rb) and the URN generator
+ * (urn_generator.rb).
+ */
+export declare class BsiCode {
+    readonly value: string;
+    constructor(attrs: Record<string, unknown>);
+    render(): string;
+    toWire(): Record<string, unknown>;
+}
+export interface BsiTypedStage {
+    code: string;
+    stageCode: string;
+    typeCode: string;
+    abbr: string[];
+    name: string;
+    harmonizedStages: string[];
+}
+export declare const TYPED_STAGES_REGISTRY: BsiTypedStage[];
+export declare const DEFAULT_TYPED_STAGE: BsiTypedStage;
+export declare function locateStage(abbr: string): BsiTypedStage | undefined;
+export declare const TYPE_CLASSES: Record<string, IdentifierStatic>;
+/** Wraps a registry entry so the attribute machinery can coerce the
+ * wire's typed_stage block back into the runtime state. */
+export declare class BsiTypedStageRef {
+    readonly code: string;
+    readonly stageCode: string;
+    readonly typeCode: string;
+    readonly abbr: string[];
+    readonly name: string;
+    readonly harmonizedStages: string[];
+    constructor(attrs: Record<string, unknown>);
+}
+declare class BsiUrnGenerator extends BaseUrnGenerator<BsiIdentifier> {
+    generate(): string;
+}
+export declare class BsiIdentifier extends BaseIdentifier {
+    static polymorphicName: string;
+    static urnGenerator: typeof BsiUrnGenerator;
+    static attributes: AttributeTable;
+    /** The gem serializes the full typed-stage registry entry (type,
+     * stage, typed_stage blocks) for every non-default typed stage. */
+    static compactHash: (model: BaseIdentifier, hash: Record<string, unknown>) => void;
+    static mappings: FieldMapping[];
+    readonly publisher: Publisher | undefined;
+    readonly prefix: string | undefined;
+    readonly flex_prefix: string | undefined;
+    readonly number: string | undefined;
+    readonly iteration: string | undefined;
+    readonly part: string | undefined;
+    readonly subpart: string | undefined;
+    readonly second_number: BsiCode | undefined;
+    readonly date: PubidDate | undefined;
+    readonly edition: string | undefined;
+    readonly month: number | undefined;
+    readonly translation_lang: string | undefined;
+    readonly translation_upper: string | undefined;
+    readonly explicit_prefix: boolean | undefined;
+    readonly explicit_publisher: boolean | undefined;
+    readonly space_separated_part: boolean | undefined;
+    constructor(attrs?: Record<string, unknown>);
+    root(): BsiIdentifier;
+    render(): string;
+}
+export declare const BritishStandardClass: IdentifierStatic;
+export declare const DraftDocumentClass: IdentifierStatic;
+export declare const PublishedDocumentClass: IdentifierStatic;
+export declare const PubliclyAvailableSpecificationClass: IdentifierStatic;
+export declare const TechnicalSpecificationClass: IdentifierStatic;
+export declare const ElectronicBookClass: IdentifierStatic;
+export declare const AerospaceStandardClass: IdentifierStatic;
+export declare const FlexClass: IdentifierStatic;
+export declare const IndexClass: IdentifierStatic;
+export declare const SupplementaryIndexClass: IdentifierStatic;
+export declare const ExplanatorySupplementClass: IdentifierStatic;
+export declare const MethodClass: IdentifierStatic;
+export declare const TestMethodClass: IdentifierStatic;
+export declare const SectionClass: IdentifierStatic;
+export declare const DetailedSpecificationClass: IdentifierStatic;
+export declare const DiscClass: IdentifierStatic;
+export declare const StandaloneAmendmentClass: IdentifierStatic;
+export declare const CommitteeDocumentClass: IdentifierStatic;
+export declare class Amendment extends BsiIdentifier {
+    static polymorphicName: string;
+    static urnGenerator: typeof BsiUrnGenerator;
+    static attributes: AttributeTable;
+    static mappings: FieldMapping[];
+    readonly base: BsiIdentifier | undefined;
+    readonly year: string | undefined;
+    readonly separator: string | undefined;
+    readonly amd_suffix_form: boolean | undefined;
+    root(): BsiIdentifier;
+    render(): string;
+}
+export declare class Corrigendum extends BsiIdentifier {
+    static polymorphicName: string;
+    static urnGenerator: typeof BsiUrnGenerator;
+    static attributes: AttributeTable;
+    static mappings: FieldMapping[];
+    readonly base: BsiIdentifier | undefined;
+    readonly year: string | undefined;
+    readonly separator: string | undefined;
+    root(): BsiIdentifier;
+    render(): string;
+}
+export declare const SupplementDocumentClass: IdentifierStatic;
+export declare const AddendumDocumentClass: IdentifierStatic;
+export declare const BundledIdentifierClass: IdentifierStatic;
+export declare const SetClass: IdentifierStatic;
+export declare const ExpertCommentaryClass: IdentifierStatic;
+export declare const ValueAddedPublicationClass: IdentifierStatic;
+export declare const NationalAnnexClass: IdentifierStatic;
+export declare const AdoptedEuropeanNormClass: IdentifierStatic;
+export declare const AdoptedInternationalStandardClass: IdentifierStatic;
+interface ConsolidatedLike extends BsiIdentifier {
+    identifiers: BsiIdentifier[];
+}
+export declare const ConsolidatedIdentifierClass: IdentifierStatic;
+export declare function consolidatedUrn(id: ConsolidatedLike): string | undefined;
+export {};