@pubid/pubid 0.1.3 → 0.1.5

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

@@ -0,0 +1,144 @@
+import { BaseIdentifier } from "../../model/identifier.js";
+import type { IdentifierStatic } from "../../model/identifier.js";
+import { type AttributeTable, type FieldMapping } from "../../model/attribute.js";
+/**
+ * Port of lib/pubid/ieee: Components::Code/Draft/TypedStage, the
+ * Identifiers::* family, Renderer, UrnGenerator and Compaction.
+ *
+ * Wire: the split code columns (number/prefix/parts/separator) on
+ * CodeNumber leaves; typed_stage compacted to a `stage` scalar when the
+ * registry rebuilds it byte-identically (else the full object, fails
+ * closed); the draft serializes as its rendered string minus the "/".
+ */
+export interface TypedStageRecord {
+    abbr: string[];
+    stage_code: string;
+    type_code: string;
+    iso_stage_equivalent?: string;
+    ieee_draft_equivalent?: string;
+    approval_status?: string;
+    project_status?: boolean;
+}
+export declare const TYPED_STAGES: TypedStageRecord[];
+export declare function locateStage(abbr: string): TypedStageRecord | undefined;
+export declare class IeeeTypedStage {
+    readonly record: TypedStageRecord;
+    constructor(record: TypedStageRecord);
+    get abbr(): string[];
+    get projectStatus(): boolean;
+    get ieeeDraftEquivalent(): string | undefined;
+    get typeCode(): string;
+    toWire(): Record<string, unknown>;
+    render(): string;
+}
+export declare class IeeeCode {
+    readonly prefix: string | undefined;
+    readonly number: string;
+    readonly parts: string[];
+    readonly originalSeparator: string | undefined;
+    constructor(attrs: Record<string, unknown>);
+    static parse(codeStr: string): IeeeCode | undefined;
+    render(): string;
+}
+export declare class IeeeDraft {
+    readonly version: string;
+    readonly revision: string | undefined;
+    readonly isoStage: string | undefined;
+    readonly isoIteration: string | undefined;
+    readonly year: string | undefined;
+    readonly month: string | undefined;
+    readonly day: string | undefined;
+    readonly originalMonth: string | undefined;
+    readonly commaBeforeMonth: boolean;
+    /** Distinguishes an explicit `false` from "not recorded" (Ruby's nil). */
+    readonly commaBeforeMonthSet: boolean;
+    constructor(attrs: Record<string, unknown>);
+    static parse(value: string): IeeeDraft | undefined;
+    render(): string;
+}
+export declare const RELATIONSHIP_PREFIXES: Record<string, string>;
+export declare class IeeeRelationship {
+    readonly relationshipType: string;
+    readonly relatedIds: {
+        toHuman(): string;
+    }[];
+    readonly intermediateAmendments: {
+        toHuman(): string;
+    }[];
+    readonly approvedAmendmentsFlag: boolean;
+    constructor(relationshipType: string, relatedIds: {
+        toHuman(): string;
+    }[], intermediateAmendments: {
+        toHuman(): string;
+    }[], approvedAmendmentsFlag?: boolean);
+    render(): string;
+}
+export declare abstract class IeeeIdentifier extends BaseIdentifier {
+    static attributes: AttributeTable;
+    static mappings: FieldMapping[];
+    readonly publisher: string;
+    readonly copublisher: string[];
+    readonly year: string | undefined;
+    readonly type: string | undefined;
+    readonly draft_status: string | undefined;
+    readonly draft: string | undefined;
+    readonly revision: string | undefined;
+    readonly edition: string | undefined;
+    readonly month: string | undefined;
+    readonly day: string | undefined;
+    readonly redline: boolean | undefined;
+    readonly edition_month: string | undefined;
+    readonly space_before_draft: boolean | undefined;
+    readonly typed_stage: IeeeTypedStage | undefined;
+    readonly parenthetical_content: string | undefined;
+    readonly nickname: string | undefined;
+    readonly adoption: string | undefined;
+    readonly amendment_to: string | undefined;
+    readonly note: string | undefined;
+    readonly iso_identifier: string | undefined;
+    readonly revision_of: string | undefined;
+    readonly ashrae_number: string | undefined;
+    readonly ashrae_year: string | undefined;
+    readonly crossref: string | undefined;
+    readonly reaffirmed: string | undefined;
+    readonly interpretation: boolean | undefined;
+    readonly relationships: IeeeRelationship[] | undefined;
+    private draftObjCache;
+    draftObject(): IeeeDraft | undefined;
+    get codeObj(): IeeeCode | undefined;
+    root(): IeeeIdentifier;
+    yearForUrn(): string | undefined;
+    toHash(): Record<string, unknown>;
+    static fromHash(hash: Record<string, unknown>): BaseIdentifier;
+}
+export declare function renderIeeeBase(id: IeeeIdentifier): string;
+export interface ClassSpec {
+    kind: string;
+}
+export declare const SupplementBaseDefs: {
+    base: {
+        type: IdentifierStatic;
+    };
+};
+export declare const StandardClass: IdentifierStatic;
+export declare const ProjectDraftIdentifierClass: IdentifierStatic;
+export declare const SiStandardClass: IdentifierStatic;
+export declare const CorrigendumClass: IdentifierStatic;
+export declare const AmendmentClass: IdentifierStatic;
+export declare const InterpretationClass: IdentifierStatic;
+export declare const ConformanceClass: IdentifierStatic;
+export declare const DualPublishedClass: IdentifierStatic;
+export declare const DualIdentifierClass: IdentifierStatic;
+export declare const ParentheticalClass: IdentifierStatic;
+export declare const AdoptedStandardClass: IdentifierStatic;
+export declare const CsaDualPublishedClass: IdentifierStatic;
+export declare const MultiNumberedClass: IdentifierStatic;
+export declare const JointDevelopmentClass: IdentifierStatic;
+export declare const IecIeeeCopublishedClass: IdentifierStatic;
+export declare const AieeClass: IdentifierStatic;
+export declare const IreClass: IdentifierStatic;
+export declare const NescEditionClass: IdentifierStatic;
+export declare const NescHandbookClass: IdentifierStatic;
+export declare const NescRedlineClass: IdentifierStatic;
+export declare const NescStandardClass: IdentifierStatic;
+export declare const NescDraftClass: IdentifierStatic;