refactor: type narrowing, replace strings with constants, remove signer from scope of this pr

Author: shunkica

src/c14n-canonicalization.ts

@@ -1,13 +1,15 @@
 import type {
-  CanonicalizationOrTransformationAlgorithm,
-  CanonicalizationOrTransformationAlgorithmProcessOptions,
+  CanonicalizationAlgorithmName,
+  CanonicalizationAlgorithm,
+  TransformAlgorithmOptions,
   NamespacePrefix,
   RenderedNamespace,
 } from "./types";
 import * as utils from "./utils";
 import * as isDomNode from "@xmldom/is-dom-node";
+import { Algorithms } from "./constants";
 
-export class C14nCanonicalization implements CanonicalizationOrTransformationAlgorithm {
+export class C14nCanonicalization implements CanonicalizationAlgorithm {
   protected includeComments = false;
 
   constructor() {
@@ -252,9 +254,10 @@ export class C14nCanonicalization implements CanonicalizationOrTransformationAlg
    * Perform canonicalization of the given node
    *
    * @param node
+   * @param options
    * @api public
    */
-  process(node: Node, options: CanonicalizationOrTransformationAlgorithmProcessOptions): string {
+  process(node: Node, options: TransformAlgorithmOptions): string {
     options = options || {};
     const defaultNs = options.defaultNs || "";
     const defaultNsForPrefix = options.defaultNsForPrefix || {};
@@ -275,8 +278,8 @@ export class C14nCanonicalization implements CanonicalizationOrTransformationAlg
     return res;
   }
 
-  getAlgorithmName() {
-    return "http://www.w3.org/TR/2001/REC-xml-c14n-20010315";
+  getAlgorithmName(): CanonicalizationAlgorithmName {
+    return Algorithms.canonicalization.C14N;
   }
 }
 
@@ -289,7 +292,7 @@ export class C14nCanonicalizationWithComments extends C14nCanonicalization {
     this.includeComments = true;
   }
 
-  getAlgorithmName() {
-    return "http://www.w3.org/TR/2001/REC-xml-c14n-20010315#WithComments";
+  getAlgorithmName(): CanonicalizationAlgorithmName {
+    return Algorithms.canonicalization.C14N_WITH_COMMENTS;
   }
 }

src/algorithms.ts src/constants.tssrc/algorithms.ts renamed to src/constants.ts

@@ -42,3 +42,15 @@ export const Algorithms = {
   hash: HASH_ALGORITHMS,
   signature: SIGNATURE_ALGORITHMS,
 };
+
+const NAMESPACES = {
+  xml: "http://www.w3.org/XML/1998/namespace",
+  xmlns: "http://www.w3.org/2000/xmlns/",
+  ds: "http://www.w3.org/2000/09/xmldsig#",
+  wsu: "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd",
+} as const;
+
+/**
+ * Commonly used namespaces
+ */
+export const Namespaces = NAMESPACES;

src/enveloped-signature.ts

@@ -2,19 +2,19 @@ import * as xpath from "xpath";
 import * as isDomNode from "@xmldom/is-dom-node";
 
 import type {
-  CanonicalizationOrTransformationAlgorithm,
-  CanonicalizationOrTransformationAlgorithmProcessOptions,
-  CanonicalizationOrTransformAlgorithmType,
+  TransformAlgorithmOptions,
+  TransformAlgorithm,
+  TransformAlgorithmName,
 } from "./types";
 
-export class EnvelopedSignature implements CanonicalizationOrTransformationAlgorithm {
+export class EnvelopedSignature implements TransformAlgorithm {
   protected includeComments = false;
 
   constructor() {
     this.includeComments = false;
   }
 
-  process(node: Node, options: CanonicalizationOrTransformationAlgorithmProcessOptions): Node {
+  process(node: Node, options: TransformAlgorithmOptions): Node {
     if (null == options.signatureNode) {
       const signature = xpath.select1(
         "./*[local-name(.)='Signature' and namespace-uri(.)='http://www.w3.org/2000/09/xmldsig#']",
@@ -55,7 +55,7 @@ export class EnvelopedSignature implements CanonicalizationOrTransformationAlgor
     return node;
   }
 
-  getAlgorithmName(): CanonicalizationOrTransformAlgorithmType {
+  getAlgorithmName(): TransformAlgorithmName {
     return "http://www.w3.org/2000/09/xmldsig#enveloped-signature";
   }
 }

src/exclusive-canonicalization.ts

@@ -1,10 +1,12 @@
 import type {
-  CanonicalizationOrTransformationAlgorithm,
-  CanonicalizationOrTransformationAlgorithmProcessOptions,
+  CanonicalizationAlgorithmName,
+  CanonicalizationAlgorithm,
+  TransformAlgorithmOptions,
   NamespacePrefix,
 } from "./types";
 import * as utils from "./utils";
 import * as isDomNode from "@xmldom/is-dom-node";
+import { Algorithms } from "./constants";
 
 function isPrefixInScope(prefixesInScope, prefix, namespaceURI) {
   let ret = false;
@@ -17,7 +19,7 @@ function isPrefixInScope(prefixesInScope, prefix, namespaceURI) {
   return ret;
 }
 
-export class ExclusiveCanonicalization implements CanonicalizationOrTransformationAlgorithm {
+export class ExclusiveCanonicalization implements CanonicalizationAlgorithm {
   protected includeComments = false;
 
   constructor() {
@@ -265,7 +267,7 @@ export class ExclusiveCanonicalization implements CanonicalizationOrTransformati
    *
    * @api public
    */
-  process(elem: Element, options: CanonicalizationOrTransformationAlgorithmProcessOptions): string {
+  process(elem: Element, options: TransformAlgorithmOptions): string {
     options = options || {};
     let inclusiveNamespacesPrefixList = options.inclusiveNamespacesPrefixList || [];
     const defaultNs = options.defaultNs || "";
@@ -319,8 +321,8 @@ export class ExclusiveCanonicalization implements CanonicalizationOrTransformati
     return res;
   }
 
-  getAlgorithmName() {
-    return "http://www.w3.org/2001/10/xml-exc-c14n#";
+  getAlgorithmName(): CanonicalizationAlgorithmName {
+    return Algorithms.canonicalization.EXCLUSIVE_C14N;
   }
 }
 
@@ -330,7 +332,7 @@ export class ExclusiveCanonicalizationWithComments extends ExclusiveCanonicaliza
     this.includeComments = true;
   }
 
-  getAlgorithmName() {
-    return "http://www.w3.org/2001/10/xml-exc-c14n#WithComments";
+  getAlgorithmName(): CanonicalizationAlgorithmName {
+    return Algorithms.canonicalization.EXCLUSIVE_C14N_WITH_COMMENTS;
   }
 }

src/index.ts

@@ -4,8 +4,7 @@ export {
   ExclusiveCanonicalizationWithComments,
 } from "./exclusive-canonicalization";
 export { SignedXml } from "./signed-xml";
-export { XmlDSigSigner } from "./xmldsig-signer";
 export { XmlDSigValidator } from "./xmldsig-validator";
-export { Algorithms } from "./algorithms";
+export { Algorithms } from "./constants";
 export * from "./types";
 export * from "./utils";