@ripwords/myinvois-client 0.0.10 → 0.1.0

package/test/transform.test.ts

@@ -0,0 +1,158 @@
+import { describe, it, expect } from 'vitest'
+import { transformXmlInvoice } from '../src/utils/signature/transform'
+
+// Helper function to normalize whitespace for comparisons
+const normalize = (str: string) => str.replace(/\s+/g, ' ').trim()
+
+describe('transformXmlInvoice', () => {
+  it('should remove XML declaration, UBLExtensions, and Signature', () => {
+    // Note: Backticks used for multi-line strings
+    const inputXml = `<?xml version="1.0" encoding="UTF-8"?>
+<Invoice xmlns="urn:oasis:names:specification:ubl:schema:xsd:Invoice-2"
+         xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2"
+         xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2"
+         xmlns:ext="urn:oasis:names:specification:ubl:schema:xsd:CommonExtensionComponents-2">
+    <ext:UBLExtensions>
+        <ext:UBLExtension>
+            <ext:ExtensionContent>
+                <!-- Signature Block -->
+            </ext:ExtensionContent>
+        </ext:UBLExtension>
+    </ext:UBLExtensions>
+    <cac:Signature>
+        <cbc:ID>urn:oasis:names:specification:ubl:signature:Invoice</cbc:ID>
+        <cac:SignatoryParty>
+            <cac:PartyIdentification>
+                <cbc:ID>SignerID</cbc:ID>
+            </cac:PartyIdentification>
+        </cac:SignatoryParty>
+        <cac:DigitalSignatureAttachment>
+            <cac:ExternalReference>
+                <cbc:URI>#SignatureID</cbc:URI>
+            </cac:ExternalReference>
+        </cac:DigitalSignatureAttachment>
+    </cac:Signature>
+    <cbc:ID>INV123</cbc:ID>
+    <cac:AccountingSupplierParty>
+        <cac:Party>
+            <cac:PartyName>
+                <cbc:Name>Supplier Inc.</cbc:Name>
+            </cac:PartyName>
+        </cac:Party>
+    </cac:AccountingSupplierParty>
+</Invoice>`
+
+    const expectedXml = `
+<Invoice xmlns="urn:oasis:names:specification:ubl:schema:xsd:Invoice-2"
+         xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2"
+         xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2"
+         xmlns:ext="urn:oasis:names:specification:ubl:schema:xsd:CommonExtensionComponents-2">
+
+    <cbc:ID>INV123</cbc:ID>
+    <cac:AccountingSupplierParty>
+        <cac:Party>
+            <cac:PartyName>
+                <cbc:Name>Supplier Inc.</cbc:Name>
+            </cac:PartyName>
+        </cac:Party>
+    </cac:AccountingSupplierParty>
+</Invoice>`
+
+    expect(normalize(transformXmlInvoice(inputXml))).toEqual(
+      normalize(expectedXml),
+    )
+  })
+
+  it('should only remove XML declaration if others are absent', () => {
+    const inputXml = `<?xml version="1.0" encoding="UTF-8"?>
+<Invoice><ID>1</ID></Invoice>`
+    const expectedXml = `<Invoice><ID>1</ID></Invoice>`
+    expect(transformXmlInvoice(inputXml)).toEqual(expectedXml)
+  })
+
+  it('should only remove UBLExtensions if others are absent', () => {
+    const inputXml = `<Invoice xmlns:ext="urn:ext"><ext:UBLExtensions><data/></ext:UBLExtensions><ID>1</ID></Invoice>`
+    const expectedXml = `<Invoice xmlns:ext="urn:ext"><ID>1</ID></Invoice>`
+    expect(transformXmlInvoice(inputXml)).toEqual(expectedXml)
+  })
+
+  it('should only remove Signature if others are absent', () => {
+    const inputXml = `<Invoice xmlns:cac="urn:cac"><cac:Signature><data/></cac:Signature><ID>1</ID></Invoice>`
+    const expectedXml = `<Invoice xmlns:cac="urn:cac"><ID>1</ID></Invoice>`
+    expect(transformXmlInvoice(inputXml)).toEqual(expectedXml)
+  })
+
+  it('should return unchanged XML if no transformations are needed', () => {
+    const inputXml = `<Invoice><ID>1</ID><Amount>100</Amount></Invoice>`
+    expect(transformXmlInvoice(inputXml)).toEqual(inputXml)
+  })
+
+  it('should handle XML without specified elements gracefully', () => {
+    const inputXml = `<Invoice><ID>1</ID></Invoice>`
+    const expectedXml = `<Invoice><ID>1</ID></Invoice>`
+    expect(transformXmlInvoice(inputXml)).toEqual(expectedXml)
+  })
+
+  it('should throw an error for invalid XML', () => {
+    // Correctly define invalidXml for this test scope
+    const invalidXml = `<Invoice><ID>1</ID` // Missing closing tag
+    // Adjust the regex to match the actual error format from the handler
+    expect(() => transformXmlInvoice(invalidXml)).toThrow(
+      /^ERROR: \[xmldom error\]/,
+    )
+  })
+
+  it('should remove elements regardless of namespace prefixes', () => {
+    const inputXml = `<?xml version="1.0"?>
+<inv:Invoice xmlns:inv="urn:invoice" xmlns:common="urn:common" xmlns:sig="urn:signature">
+    <common:UBLExtensions><data/></common:UBLExtensions>
+    <sig:Signature><data/></sig:Signature>
+    <inv:ID>INV999</inv:ID>
+</inv:Invoice>`
+    const expectedXml = `<inv:Invoice xmlns:inv="urn:invoice" xmlns:common="urn:common" xmlns:sig="urn:signature">
+
+    <inv:ID>INV999</inv:ID>
+</inv:Invoice>`
+
+    expect(normalize(transformXmlInvoice(inputXml))).toEqual(
+      normalize(expectedXml),
+    )
+  })
+
+  it('should handle self-closing UBLExtensions and Signature tags', () => {
+    const inputXml = `<?xml version="1.0"?>
+<Invoice xmlns:ext="urn:ext" xmlns:cac="urn:cac">
+    <ext:UBLExtensions />
+    <cac:Signature />
+    <ID>1</ID>
+</Invoice>`
+    const expectedXml = `<Invoice xmlns:ext="urn:ext" xmlns:cac="urn:cac">
+
+    <ID>1</ID>
+</Invoice>`
+    expect(normalize(transformXmlInvoice(inputXml))).toEqual(
+      normalize(expectedXml),
+    )
+  })
+
+  it('should handle nested UBLExtensions/Signature (though unlikely structure)', () => {
+    const inputXml = `<?xml version="1.0"?>
+<Invoice xmlns:ext="urn:ext" xmlns:cac="urn:cac">
+    <SomeElement>
+        <ext:UBLExtensions><Data1/></ext:UBLExtensions>
+    </SomeElement>
+    <cac:Signature><Data2/></cac:Signature>
+    <ID>1</ID>
+</Invoice>`
+    const expectedXml = `<Invoice xmlns:ext="urn:ext" xmlns:cac="urn:cac">
+    <SomeElement>
+
+    </SomeElement>
+
+    <ID>1</ID>
+</Invoice>`
+    expect(normalize(transformXmlInvoice(inputXml))).toEqual(
+      normalize(expectedXml),
+    )
+  })
+})

package/tsconfig.json

@@ -8,6 +8,10 @@
     "resolveJsonModule": true,
     "moduleDetection": "force",
     "isolatedModules": true, // Often recommended for bundlers
+    "declaration": true,
+    "declarationMap": true,
+    "isolatedDeclarations": true,
+    "composite": true,
     /* Strictness */
     "strict": true,
     "noUncheckedIndexedAccess": true,
@@ -27,7 +31,9 @@
     "src/**/*.ts",
     "src/**/*.d.ts",
     "rolldown.config.ts",
-    "test/MyInvoisClient.test.ts"
+    "test/MyInvoisClient.test.ts",
+    "test/base64.test.ts",
+    "test/transform.test.ts"
   ],
   "exclude": [
     "node_modules",

package/tsdown.config.ts

@@ -0,0 +1,31 @@
+import { defineConfig } from 'tsdown'
+
+const external = [
+  'xmldom-ts',
+  'xpath-ts',
+  'xml-c14n',
+  'xml-crypto',
+  'crypto',
+  '@xmldom/xmldom',
+]
+
+export default [
+  defineConfig({
+    entry: ['./src'],
+    dts: {
+      isolatedDeclarations: true,
+    },
+    external,
+  }),
+  defineConfig({
+    entry: ['./src'],
+    format: 'cjs',
+    sourcemap: true,
+    platform: 'node',
+    outputOptions: {
+      entryFileNames: 'index.cjs',
+      chunkFileNames: '[name]-[hash].cjs',
+    },
+    external,
+  }),
+]

package/dist/index.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.cjs","names":["environment: 'sandbox' | 'production'","client: ClientCredentials","tokenResponse: TokenResponse","clientId: string","clientSecret: string","environment: 'sandbox' | 'production'","onBehalfOf?: string","debug?: boolean","path: string","options: Parameters<typeof fetch>[1]","tin: string","nric: string"],"sources":["../src/utils/getBaseUrl.ts","../src/api/platform/platformLogin.ts","../src/utils/MyInvoisClient.ts"],"sourcesContent":["export const getBaseUrl = (environment: 'sandbox' | 'production') => {\n  return environment === 'sandbox'\n    ? 'https://preprod-api.myinvois.hasil.gov.my'\n    : 'https://api.myinvois.hasil.gov.my'\n}\n","import type { ClientCredentials, TokenResponse } from 'src/types'\n\nexport const platformLogin = async (client: ClientCredentials) => {\n  const { clientId, clientSecret, baseUrl, onBehalfOf, debug } = client\n  try {\n    const response = await fetch(`${baseUrl}/connect/token`, {\n      method: 'POST',\n      headers: {\n        'Content-Type': 'application/x-www-form-urlencoded',\n        ...(onBehalfOf ? { onbehalfof: onBehalfOf } : {}),\n      },\n      body: new URLSearchParams({\n        grant_type: 'client_credentials',\n        client_id: clientId,\n        client_secret: clientSecret,\n        scope: 'InvoicingAPI',\n      }),\n    })\n\n    const tokenResponse: TokenResponse = await response.json()\n    return {\n      token: tokenResponse.access_token,\n      tokenExpiration: new Date(Date.now() + tokenResponse.expires_in * 1000),\n    }\n  } catch (error) {\n    if (debug) console.error(error)\n    throw error\n  }\n}\n","import { getBaseUrl } from './getBaseUrl'\nimport { platformLogin } from '../api/platform/platformLogin'\n\nexport class MyInvoisClient {\n  private readonly baseUrl: string\n  private readonly clientId: string\n  private readonly clientSecret: string\n  private readonly onBehalfOf?: string\n  private readonly debug: boolean\n  private token = ''\n  private tokenExpiration: Date | undefined\n\n  constructor(\n    clientId: string,\n    clientSecret: string,\n    environment: 'sandbox' | 'production',\n    onBehalfOf?: string,\n    debug?: boolean,\n  ) {\n    this.clientId = clientId\n    this.clientSecret = clientSecret\n    this.baseUrl = getBaseUrl(environment)\n    this.debug = (debug ?? process.env.MYINVOIS_DEBUG === 'true') ? true : false\n    this.onBehalfOf = onBehalfOf\n  }\n\n  private async refreshToken() {\n    const tokenResponse = await platformLogin({\n      clientId: this.clientId,\n      clientSecret: this.clientSecret,\n      baseUrl: this.baseUrl,\n      onBehalfOf: this.onBehalfOf,\n      debug: this.debug,\n    })\n\n    this.token = tokenResponse.token\n    this.tokenExpiration = tokenResponse.tokenExpiration\n  }\n\n  private async getToken() {\n    if (!this.tokenExpiration || this.tokenExpiration < new Date()) {\n      if (this.debug) {\n        console.log('Refreshing token')\n      }\n      await this.refreshToken()\n    }\n\n    return this.token\n  }\n\n  private async fetch(path: string, options: Parameters<typeof fetch>[1] = {}) {\n    const token = await this.getToken()\n\n    return fetch(`${this.baseUrl}${path}`, {\n      ...options,\n      headers: { ...options.headers, Authorization: `Bearer ${token}` },\n    })\n  }\n\n  /**\n   * Validates a TIN against a NRIC\n   *\n   * @param tin\n   * @param nric\n   * @returns true if the TIN is valid, false otherwise\n   */\n  async verifyTin(tin: string, nric: string): Promise<boolean> {\n    try {\n      const response = await this.fetch(\n        `/api/v1.0/taxpayer/validate/${tin}?idType=NRIC&idValue=${nric}`,\n        {\n          method: 'GET',\n        },\n      )\n\n      if (response.status === 200) {\n        return true\n      }\n\n      return false\n    } catch (error) {\n      if (this.debug) {\n        console.error(error)\n      }\n      return false\n    }\n  }\n}\n"],"mappings":";;;MAAa,aAAa,CAACA,gBAA0C;AACnE,QAAO,gBAAgB,YACnB,8CACA;AACL;;;;MCFY,gBAAgB,OAAOC,WAA8B;CAChE,MAAM,EAAE,UAAU,cAAc,SAAS,YAAY,OAAO,GAAG;AAC/D,KAAI;EACF,MAAM,WAAW,MAAM,OAAO,EAAE,QAAQ,iBAAiB;GACvD,QAAQ;GACR,SAAS;IACP,gBAAgB;IAChB,GAAI,aAAa,EAAE,YAAY,WAAY,IAAG,CAAE;GACjD;GACD,MAAM,IAAI,gBAAgB;IACxB,YAAY;IACZ,WAAW;IACX,eAAe;IACf,OAAO;GACR;EACF,EAAC;EAEF,MAAMC,gBAA+B,MAAM,SAAS,MAAM;AAC1D,SAAO;GACL,OAAO,cAAc;GACrB,iBAAiB,IAAI,KAAK,KAAK,KAAK,GAAG,cAAc,aAAa;EACnE;CACF,SAAQ,OAAO;AACd,MAAI,MAAO,SAAQ,MAAM,MAAM;AAC/B,QAAM;CACP;AACF;;;;ICzBY,iBAAN,MAAqB;CAC1B,AAAiB;CACjB,AAAiB;CACjB,AAAiB;CACjB,AAAiB;CACjB,AAAiB;CACjB,AAAQ,QAAQ;CAChB,AAAQ;CAER,YACEC,UACAC,cACAC,aACAC,YACAC,OACA;AACA,OAAK,WAAW;AAChB,OAAK,eAAe;AACpB,OAAK,UAAU,WAAW,YAAY;AACtC,OAAK,QAAS,SAAS,QAAQ,IAAI,mBAAmB,SAAU,OAAO;AACvE,OAAK,aAAa;CACnB;CAED,MAAc,eAAe;EAC3B,MAAM,gBAAgB,MAAM,cAAc;GACxC,UAAU,KAAK;GACf,cAAc,KAAK;GACnB,SAAS,KAAK;GACd,YAAY,KAAK;GACjB,OAAO,KAAK;EACb,EAAC;AAEF,OAAK,QAAQ,cAAc;AAC3B,OAAK,kBAAkB,cAAc;CACtC;CAED,MAAc,WAAW;AACvB,OAAK,KAAK,mBAAmB,KAAK,kBAAkB,IAAI,QAAQ;AAC9D,OAAI,KAAK,MACP,SAAQ,IAAI,mBAAmB;AAEjC,SAAM,KAAK,cAAc;EAC1B;AAED,SAAO,KAAK;CACb;CAED,MAAc,MAAMC,MAAcC,UAAuC,CAAE,GAAE;EAC3E,MAAM,QAAQ,MAAM,KAAK,UAAU;AAEnC,SAAO,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,GAAG;GACrC,GAAG;GACH,SAAS;IAAE,GAAG,QAAQ;IAAS,gBAAgB,SAAS,MAAM;GAAG;EAClE,EAAC;CACH;;;;;;;;CASD,MAAM,UAAUC,KAAaC,MAAgC;AAC3D,MAAI;GACF,MAAM,WAAW,MAAM,KAAK,OACzB,8BAA8B,IAAI,uBAAuB,KAAK,GAC/D,EACE,QAAQ,MACT,EACF;AAED,OAAI,SAAS,WAAW,IACtB,QAAO;AAGT,UAAO;EACR,SAAQ,OAAO;AACd,OAAI,KAAK,MACP,SAAQ,MAAM,MAAM;AAEtB,UAAO;EACR;CACF;AACF"}

package/rolldown.config.ts

@@ -1,26 +0,0 @@
-import { defineConfig } from 'rolldown'
-import { dts } from 'rolldown-plugin-dts'
-
-export default defineConfig([
-  {
-    input: 'src/index.ts',
-    plugins: [
-      dts({
-        isolatedDeclaration: true,
-      }),
-    ],
-    output: {
-      dir: 'dist',
-    },
-  },
-  {
-    input: 'src/index.ts',
-    output: {
-      dir: 'dist',
-      format: 'commonjs',
-      sourcemap: true,
-      entryFileNames: 'index.cjs',
-      chunkFileNames: '[name]-[hash].cjs',
-    },
-  },
-])