chore: #179 rebuild napi types, update tests

Author: noahbald

packages/napi/index.d.ts

@@ -1,57 +1,69 @@
 /* auto-generated by NAPI-RS */
 /* eslint-disable */
-export declare class PreservePattern {
-  regex: string
-  constructor(regex: string)
-}
+/**
+ * Converts a JSON value of SVGO's `Config["plugins"]` into [`Jobs`].
+ *
+ * Note that this will deduplicate any plugins listed.
+ *
+ * # Errors
+ *
+ * If a config file cannot be deserialized into jobs. This may fail even if
+ * the config is valid for SVGO, such as if
+ *
+ * - The config contains custom plugins
+ * - The plugin parameters are incompatible with OXVG
+ * - The underlying deserialization process fails
+ *
+ * If you believe an errors should be fixed, please raise an issue
+ * [here](https://github.com/noahbald/oxvg/issues)
+ */
+export declare function convertSvgoConfig(config?: Array<any> | undefined | null): Jobs
 
 /**
- * Remove attributes based on whether it matches a pattern.
+ * Returns the given config with omitted options replaced with the config provided by `extends`.
+ * I.e. acts like `{ ...extends, ...config }`
+ */
+export declare function extend(extend: Extends, config?: Jobs | undefined | null): Jobs
+
+/**
+ * Optimise an SVG document using the provided config
  *
- * The patterns syntax is `[ element* : attribute* : value* ]`; where
+ * # Errors
+ * - If the document fails to parse
+ * - If any of the optimisations fail
+ * - If the optimised document fails to serialize
  *
- * - A regular expression matching an element's name. An asterisk or omission matches all.
- * - A regular expression matching an attribute's name.
- * - A regular expression matching an attribute's value. An asterisk or omission matches all.
+ * # Examples
  *
- * # Example
+ * Optimise svg with the default configuration
  *
- * Match `fill` attribute in `<path>` elements
+ * ```js
+ * import { optimise } from "@oxvg/napi";
  *
- * ```ignore
- * use oxvg_optimiser::{Jobs, RemoveAttrs};
+ * const result = optimise(`<svg />`);
+ * ```
  *
- * let mut remove_attrs = RemoveAttrs::default();
- * remove_attrs.attrs = vec![String::from("path:fill")];
- * let jobs = Jobs {
- *   remove_attrs: Some(remove_attrs),
- *   ..Jobs::none()
- * };
+ * Or, provide your own config
+ *
+ * ```js
+ * import { optimise } from "@oxvg/napi";
+ *
+ * // Only optimise path data
+ * const result = optimise(`<svg />`, { convertPathData: {} });
  * ```
- * # Correctness
  *
- * Removing attributes may visually change the document if they're
- * presentation attributes or selected with CSS.
+ * Or, extend a preset
  *
- * # Errors
+ * ```js
+ * import { optimise, extend, Extends } from "@oxvg/napi";
  *
- * If the regex fails to parse.
+ * const result = optimise(
+ *     `<svg />`,
+ *     extend(Extends.Default, { convertPathData: { removeUseless: false } }),
+ * );
+ * ```
  */
-export declare class RemoveAttrs {
-  /** A list of patterns that match attributes. */
-  attrs: Array<string>
-  /**
-   * The seperator for different parts of the pattern. By default this is `":"`.
-   *
-   * You may need to use this if you need to match attributes with a `:` (i.e. prefixed attributes).
-   */
-  elemSeparator: string
-  /** Whether to ignore attributes set to `currentColor` */
-  preserveCurrentColor: boolean
-  /** Instantiates and instance of remove attributes with the given configuration options. */
-  constructor(attrs: Array<string>, elemSeparator: string, preserveCurrentColor: boolean)
-}
-
+export declare function optimise(svg: string, config?: Jobs | undefined | null): string
 /**
  * Adds attributes to SVG elements in the document. This is not an optimisation
  * and will increase the size of SVG documents.
@@ -344,10 +356,10 @@ export interface CollapseGroups {
   field0: boolean
 }
 
-export declare const enum ConvertCase {
-  Upper = 0,
-  Lower = 1
-}
+export type ConvertCase =
+  | { type: 'Upper' }
+  | { type: 'Lower' }
+  | { type: 'Napi' }
 
 /**
  * Converts color references to their shortest equivalent.
@@ -428,7 +440,6 @@ export interface ConvertOneStopGradients {
  * # Correctness
  *
  * Rounding errors may result in slight visual differences.
- *
  */
 export interface ConvertPathData {
   /** Whether to remove redundant path commands. */
@@ -523,25 +534,6 @@ export interface ConvertStyleToAttrs {
   keepImportant: boolean
 }
 
-/**
- * Converts a JSON value of SVGO's `Config["plugins"]` into [`Jobs`].
- *
- * Note that this will deduplicate any plugins listed.
- *
- * # Errors
- *
- * If a config file cannot be deserialized into jobs. This may fail even if
- * the config is valid for SVGO, such as if
- *
- * - The config contains custom plugins
- * - The plugin parameters are incompatible with OXVG
- * - The underlying deserialization process fails
- *
- * If you believe an errors should be fixed, please raise an issue
- * [here](https://github.com/noahbald/oxvg/issues)
- */
-export declare function convertSvgoConfig(config?: Array<any> | undefined | null): Jobs
-
 /**
  * Merge transforms and convert to shortest form.
  *
@@ -578,28 +570,12 @@ export interface ConvertTransform {
   collapseIntoOne: boolean
 }
 
-/**
- * Returns the given config with omitted options replaced with the config provided by `extends`.
- * I.e. acts like `{ ...extends, ...config }`
- */
-export declare function extend(extend: Extends, config?: Jobs | undefined | null): Jobs
-
 /** A preset which the specified jobs can overwrite */
-export declare const enum Extends {
-  /** A preset that contains no jobs. */
-  None = 'None',
-  /**
-   * The default preset.
-   * Uses [`oxvg_optimiser::Jobs::default`]
-   */
-  Default = 'Default',
-  /**
-   * The correctness preset. Produces a preset that is less likely to
-   * visually change the document.
-   * Uses [`oxvg_optimiser::Jobs::correctness`]
-   */
-  Safe = 'Safe'
-}
+export type Extends =
+  | { type: 'None' }
+  | { type: 'Default' }
+  | { type: 'Safe' }
+  | { type: 'Napi' }
 
 /**
  * Merges styles from a `<style>` element to the `style` attribute of matching elements.
@@ -699,14 +675,6 @@ export interface Jobs {
   removeXlink?: RemoveXlink
 }
 
-/** When running calculations against arcs, the level of error tolerated */
-export interface MakeArcs {
-  /** When calculating tolerance, controls the bound compared to error */
-  threshold: number
-  /** When calculating tolerance, controls the bound compared to the radius */
-  tolerance: number
-}
-
 /**
  * Merge multipe paths into one
  *
@@ -810,46 +778,6 @@ export interface MoveGroupAttrsToElems {
   field0: boolean
 }
 
-/**
- * Optimise an SVG document using the provided config
- *
- * # Errors
- * - If the document fails to parse
- * - If any of the optimisations fail
- * - If the optimised document fails to serialize
- *
- * # Examples
- *
- * Optimise svg with the default configuration
- *
- * ```js
- * import { optimise } from "@oxvg/napi";
- *
- * const result = optimise(`<svg />`);
- * ```
- *
- * Or, provide your own config
- *
- * ```js
- * import { optimise } from "@oxvg/napi";
- *
- * // Only optimise path data
- * const result = optimise(`<svg />`, { convertPathData: {} });
- * ```
- *
- * Or, extend a preset
- *
- * ```js
- * import { optimise, extend, Extends } from "@oxvg/napi";
- *
- * const result = optimise(
- *     `<svg />`,
- *     extend(Extends.Default, { convertPathData: { removeUseless: false } }),
- * );
- * ```
- */
-export declare function optimise(svg: string, config?: Jobs | undefined | null): string
-
 /**
  * Runs a series of checks to more confidently be sure the document won't break
  * due to unsupported/unstable features.
@@ -869,16 +797,8 @@ export interface Precheck {
   precleanChecks: boolean
 }
 
-/** How many decimal points to round path command arguments */
-export type Precision =
-  | { type: 'None' }
-  | { type: 'Disabled' }
-  | { type: 'Enabled', field0: number }
-
 /** Various types of ways prefixes can be generated for an id. */
 export type PrefixGenerator =
-  | { type: 'Generator', field0: (info?: PrefixGeneratorInfo) => string }
-  | { type: 'Generator', field0: Generator }
   | { type: 'Prefix', field0: string }
   | { type: 'None' }
   | { type: 'Default' }
@@ -899,6 +819,10 @@ export interface PrefixGeneratorInfo {
  *
  * See [`super::CleanupIds`] for more details.
  *
+ * # Differences to SVGO
+ *
+ * Custom generator functions are not supported.
+ *
  * # Correctness
  *
  * Prefixing ids on inlined SVGs may affect scripting and CSS.
@@ -920,6 +844,10 @@ export interface PrefixIds {
   prefixClassNames: boolean
 }
 
+export interface PreservePattern {
+  regex: string
+}
+
 /**
  * Removes attributes from elements that match a selector.
  *
@@ -936,6 +864,51 @@ export interface RemoveAttributesBySelector {
   field0: Array<Selector>
 }
 
+/**
+ * Remove attributes based on whether it matches a pattern.
+ *
+ * The patterns syntax is `[ element* : attribute* : value* ]`; where
+ *
+ * - A regular expression matching an element's name. An asterisk or omission matches all.
+ * - A regular expression matching an attribute's name.
+ * - A regular expression matching an attribute's value. An asterisk or omission matches all.
+ *
+ * # Example
+ *
+ * Match `fill` attribute in `<path>` elements
+ *
+ * ```ignore
+ * use oxvg_optimiser::{Jobs, RemoveAttrs};
+ *
+ * let mut remove_attrs = RemoveAttrs::default();
+ * remove_attrs.attrs = vec![String::from("path:fill")];
+ * let jobs = Jobs {
+ *   remove_attrs: Some(remove_attrs),
+ *   ..Jobs::none()
+ * };
+ * ```
+ * # Correctness
+ *
+ * Removing attributes may visually change the document if they're
+ * presentation attributes or selected with CSS.
+ *
+ * # Errors
+ *
+ * If the regex fails to parse.
+ */
+export interface RemoveAttrs {
+  /** A list of patterns that match attributes. */
+  attrs: Array<string>
+  /**
+   * The seperator for different parts of the pattern. By default this is `":"`.
+   *
+   * You may need to use this if you need to match attributes with a `:` (i.e. prefixed attributes).
+   */
+  elemSeparator: string
+  /** Whether to ignore attributes set to `currentColor` */
+  preserveCurrentColor: boolean
+}
+
 /**
  * Removes XML comments from the document.
  *
@@ -1356,11 +1329,11 @@ export interface RemoveUnknownsAndDefaults {
   keepRoleAttr: boolean
 }
 
-export declare const enum RemoveUnused {
-  False = 0,
-  True = 1,
-  Force = 2
-}
+export type RemoveUnused =
+  | { type: 'False' }
+  | { type: 'True' }
+  | { type: 'Force' }
+  | { type: 'Napi' }
 
 /**
  * Removes `xmlns` prefixed elements that are never referenced by a qualified name.
@@ -1564,9 +1537,20 @@ export interface SortDefsChildren {
 }
 
 /** The method for ordering xmlns attributes */
-export declare const enum XMLNSOrder {
-  /** Sort xmlns attributes alphabetically */
-  Alphabetical = 0,
-  /** Keep xmlns attributes at the front of the list */
-  Front = 1
+export type XMLNSOrder =
+  | { type: 'Alphabetical' }
+  | { type: 'Front' }
+  | { type: 'Napi' }
+/** When running calculations against arcs, the level of error tolerated */
+export interface MakeArcs {
+  /** When calculating tolerance, controls the bound compared to error */
+  threshold: number
+  /** When calculating tolerance, controls the bound compared to the radius */
+  tolerance: number
 }
+
+/** How many decimal points to round path command arguments */
+export type Precision =
+  | { type: 'None' }
+  | { type: 'Disabled' }
+  | { type: 'Enabled', field0: number }