SVGO v3.0.2 Partially Compiled

[Zemnmez]

Describe the bug
V3.0.2 contains a .d.ts ("svgo.d.ts") that imports a .ts ("types.ts") in the NPM package. Some tools, like api-extractor choke on this, because .ts files are not meant to be included in node_modules packages since they are a build input.

Expected behavior
Types.ts should be compiled to types.d.ts

Screenshots

Desktop (please complete the following information):

• SVGO Version 3.0.2
• NodeJs Version N/A
• OS: MacOS (via Bazel)

Workaround
Apply a patch deleting types.ts, and replacing it with a types.d.ts:

export type XastDoctype = {
    type: 'doctype';
    name: string;
    data: {
        doctype: string;
    };
};
export type XastInstruction = {
    type: 'instruction';
    name: string;
    value: string;
};
export type XastComment = {
    type: 'comment';
    value: string;
};
export type XastCdata = {
    type: 'cdata';
    value: string;
};
export type XastText = {
    type: 'text';
    value: string;
};
export type XastElement = {
    type: 'element';
    name: string;
    attributes: Record<string, string>;
    children: Array<XastChild>;
};
export type XastChild = XastDoctype | XastInstruction | XastComment | XastCdata | XastText | XastElement;
export type XastRoot = {
    type: 'root';
    children: Array<XastChild>;
};
export type XastParent = XastRoot | XastElement;
export type XastNode = XastRoot | XastChild;
export type StringifyOptions = {
    doctypeStart?: string;
    doctypeEnd?: string;
    procInstStart?: string;
    procInstEnd?: string;
    tagOpenStart?: string;
    tagOpenEnd?: string;
    tagCloseStart?: string;
    tagCloseEnd?: string;
    tagShortStart?: string;
    tagShortEnd?: string;
    attrStart?: string;
    attrEnd?: string;
    commentStart?: string;
    commentEnd?: string;
    cdataStart?: string;
    cdataEnd?: string;
    textStart?: string;
    textEnd?: string;
    indent?: number | string;
    regEntities?: RegExp;
    regValEntities?: RegExp;
    encodeEntity?: (char: string) => string;
    pretty?: boolean;
    useShortTags?: boolean;
    eol?: 'lf' | 'crlf';
    finalNewline?: boolean;
};
type VisitorNode<Node> = {
    enter?: (node: Node, parentNode: XastParent) => void | symbol;
    exit?: (node: Node, parentNode: XastParent) => void;
};
type VisitorRoot = {
    enter?: (node: XastRoot, parentNode: null) => void;
    exit?: (node: XastRoot, parentNode: null) => void;
};
export type Visitor = {
    doctype?: VisitorNode<XastDoctype>;
    instruction?: VisitorNode<XastInstruction>;
    comment?: VisitorNode<XastComment>;
    cdata?: VisitorNode<XastCdata>;
    text?: VisitorNode<XastText>;
    element?: VisitorNode<XastElement>;
    root?: VisitorRoot;
};
export type PluginInfo = {
    path?: string;
    multipassCount: number;
};
export type Plugin<Params> = (root: XastRoot, params: Params, info: PluginInfo) => null | Visitor;
export type Specificity = [number, number, number, number];
export type StylesheetDeclaration = {
    name: string;
    value: string;
    important: boolean;
};
export type StylesheetRule = {
    dynamic: boolean;
    selector: string;
    specificity: Specificity;
    declarations: Array<StylesheetDeclaration>;
};
export type Stylesheet = {
    rules: Array<StylesheetRule>;
    parents: Map<XastElement, XastParent>;
};
type StaticStyle = {
    type: 'static';
    inherited: boolean;
    value: string;
};
type DynamicStyle = {
    type: 'dynamic';
    inherited: boolean;
};
export type ComputedStyles = Record<string, StaticStyle | DynamicStyle>;
export type PathDataCommand = 'M' | 'm' | 'Z' | 'z' | 'L' | 'l' | 'H' | 'h' | 'V' | 'v' | 'C' | 'c' | 'S' | 's' | 'Q' | 'q' | 'T' | 't' | 'A' | 'a';
export type PathDataItem = {
    command: PathDataCommand;
    args: Array<number>;
};
export type DataUri = 'base64' | 'enc' | 'unenc';
export {};

Here is my patch:

diff --git a/lib/types.d.ts b/lib/types.d.ts
new file mode 100644
index 0000000000000000000000000000000000000000..88b73182c320e4751e2b5029dffe71d497478294
--- /dev/null
+++ b/lib/types.d.ts
@@ -0,0 +1,120 @@
+export type XastDoctype = {
+    type: 'doctype';
+    name: string;
+    data: {
+        doctype: string;
+    };
+};
+export type XastInstruction = {
+    type: 'instruction';
+    name: string;
+    value: string;
+};
+export type XastComment = {
+    type: 'comment';
+    value: string;
+};
+export type XastCdata = {
+    type: 'cdata';
+    value: string;
+};
+export type XastText = {
+    type: 'text';
+    value: string;
+};
+export type XastElement = {
+    type: 'element';
+    name: string;
+    attributes: Record<string, string>;
+    children: Array<XastChild>;
+};
+export type XastChild = XastDoctype | XastInstruction | XastComment | XastCdata | XastText | XastElement;
+export type XastRoot = {
+    type: 'root';
+    children: Array<XastChild>;
+};
+export type XastParent = XastRoot | XastElement;
+export type XastNode = XastRoot | XastChild;
+export type StringifyOptions = {
+    doctypeStart?: string;
+    doctypeEnd?: string;
+    procInstStart?: string;
+    procInstEnd?: string;
+    tagOpenStart?: string;
+    tagOpenEnd?: string;
+    tagCloseStart?: string;
+    tagCloseEnd?: string;
+    tagShortStart?: string;
+    tagShortEnd?: string;
+    attrStart?: string;
+    attrEnd?: string;
+    commentStart?: string;
+    commentEnd?: string;
+    cdataStart?: string;
+    cdataEnd?: string;
+    textStart?: string;
+    textEnd?: string;
+    indent?: number | string;
+    regEntities?: RegExp;
+    regValEntities?: RegExp;
+    encodeEntity?: (char: string) => string;
+    pretty?: boolean;
+    useShortTags?: boolean;
+    eol?: 'lf' | 'crlf';
+    finalNewline?: boolean;
+};
+type VisitorNode<Node> = {
+    enter?: (node: Node, parentNode: XastParent) => void | symbol;
+    exit?: (node: Node, parentNode: XastParent) => void;
+};
+type VisitorRoot = {
+    enter?: (node: XastRoot, parentNode: null) => void;
+    exit?: (node: XastRoot, parentNode: null) => void;
+};
+export type Visitor = {
+    doctype?: VisitorNode<XastDoctype>;
+    instruction?: VisitorNode<XastInstruction>;
+    comment?: VisitorNode<XastComment>;
+    cdata?: VisitorNode<XastCdata>;
+    text?: VisitorNode<XastText>;
+    element?: VisitorNode<XastElement>;
+    root?: VisitorRoot;
+};
+export type PluginInfo = {
+    path?: string;
+    multipassCount: number;
+};
+export type Plugin<Params> = (root: XastRoot, params: Params, info: PluginInfo) => null | Visitor;
+export type Specificity = [number, number, number, number];
+export type StylesheetDeclaration = {
+    name: string;
+    value: string;
+    important: boolean;
+};
+export type StylesheetRule = {
+    dynamic: boolean;
+    selector: string;
+    specificity: Specificity;
+    declarations: Array<StylesheetDeclaration>;
+};
+export type Stylesheet = {
+    rules: Array<StylesheetRule>;
+    parents: Map<XastElement, XastParent>;
+};
+type StaticStyle = {
+    type: 'static';
+    inherited: boolean;
+    value: string;
+};
+type DynamicStyle = {
+    type: 'dynamic';
+    inherited: boolean;
+};
+export type ComputedStyles = Record<string, StaticStyle | DynamicStyle>;
+export type PathDataCommand = 'M' | 'm' | 'Z' | 'z' | 'L' | 'l' | 'H' | 'h' | 'V' | 'v' | 'C' | 'c' | 'S' | 's' | 'Q' | 'q' | 'T' | 't' | 'A' | 'a';
+export type PathDataItem = {
+    command: PathDataCommand;
+    args: Array<number>;
+};
+export type DataUri = 'base64' | 'enc' | 'unenc';
+export {};
\ No newline at end of file
diff --git a/lib/types.ts b/lib/types.ts
deleted file mode 100644
index f6260c6ab4648a21f41c377e5abb42e4d2004b84..0000000000000000000000000000000000000000

[Exotelis]

The plugin.ts is also causing issues! Spent couple of hours finding out why my build was no longer working.
Please provide a new release as soon as possible.

[Exotelis]

@deepsweet I don't know who is maintaining this package currently. May I ask you to publish a new release with the fix @Zemnmez and I provided? Since this is a critical and blocking issue I would appreciate your help a lot.

[Zemnmez]

Is there an issue I can follow for the publication of that version? Thanks!

…

On 26 Nov 2023, at 15:39, Seth Falco ***@***.***> wrote: Closed #1766 <https://www.google.com/url?q=https://github.com/svg/svgo/issues/1766&source=gmail-imap&ust=1701646748000000&usg=AOvVaw2q_QLYlxhdZz9vjW6MpUou> as completed via #1780 <https://www.google.com/url?q=https://github.com/svg/svgo/pull/1780&source=gmail-imap&ust=1701646748000000&usg=AOvVaw274UVWp8ENW-U9mB9Hm1JG>. — Reply to this email directly, view it on GitHub <https://www.google.com/url?q=https://github.com/svg/svgo/issues/1766%23event-11064475219&source=gmail-imap&ust=1701646748000000&usg=AOvVaw0x_afYb1b3Y8r7gJNQTQvv>, or unsubscribe <https://www.google.com/url?q=https://github.com/notifications/unsubscribe-auth/ABDJGLTXPOTJBLUYATGXLJLYGPHJTAVCNFSM6AAAAAAXXPORHGVHI2DSMVQWIX3LMV45UABCJFZXG5LFIV3GK3TUJZXXI2LGNFRWC5DJN5XDWMJRGA3DINBXGUZDCOI&source=gmail-imap&ust=1701646748000000&usg=AOvVaw3qVVwF3Po4ZvKY6NBYxoKF>. You are receiving this because you were mentioned.

[SethFalco]

No there isn't, but I'd be happy to ping you here once it's released.
I'll do it on Friday (1 December 2023) at the latest, but just reviewing other pull requests and issues at the moment.

[Zemnmez]

Sounds good to me :)

…

On 26 Nov 2023, at 15:52, Seth Falco ***@***.***> wrote: No there isn't, but I'd be happy to ping you here once it's released. I'll do it on Friday (1 December 2023) at the latest, but just reviewing other pull requests and issues at the moment. — Reply to this email directly, view it on GitHub <https://www.google.com/url?q=https://github.com/svg/svgo/issues/1766%23issuecomment-1826943536&source=gmail-imap&ust=1701647542000000&usg=AOvVaw1js6_VfgEG1Hrbl2za5RUB>, or unsubscribe <https://www.google.com/url?q=https://github.com/notifications/unsubscribe-auth/ABDJGLU6KITPJOPNAZ454IDYGPI3JAVCNFSM6AAAAAAXXPORHGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQMRWHE2DGNJTGY&source=gmail-imap&ust=1701647542000000&usg=AOvVaw3d9H5n8HhiAbwUocbze-Vi>. You are receiving this because you were mentioned.

[SethFalco]

@Zemnmez

v3.0.5 has just been published.

[Zemnmez]

Thank you!On 30 Nov 2023, at 08:20, Seth Falco ***@***.***> wrote: @Zemnmez v3.0.5 has just been published. —Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you were mentioned.Message ID: ***@***.***>