@ripwords/myinvois-client 0.0.1

package/src/types/msic/9X.d.ts

@@ -0,0 +1,186 @@
+export type MSIC_9X_CODE =
+  | '90001'
+  | '90002'
+  | '90003'
+  | '90004'
+  | '90005'
+  | '90006'
+  | '90007'
+  | '90009'
+  | '91011'
+  | '91012'
+  | '91021'
+  | '91022'
+  | '91031'
+  | '91032'
+  | '92000'
+  | '93111'
+  | '93112'
+  | '93113'
+  | '93114'
+  | '93115'
+  | '93116'
+  | '93117'
+  | '93118'
+  | '93119'
+  | '93120'
+  | '93191'
+  | '93192'
+  | '93193'
+  | '93199'
+  | '93210'
+  | '93291'
+  | '93292'
+  | '93293'
+  | '93294'
+  | '93295'
+  | '93296'
+  | '93297'
+  | '93299'
+  | '94110'
+  | '94120'
+  | '94200'
+  | '94910'
+  | '94920'
+  | '94990'
+  | '95111'
+  | '95112'
+  | '95113'
+  | '95121'
+  | '95122'
+  | '95123'
+  | '95124'
+  | '95125'
+  | '95126'
+  | '95127'
+  | '95211'
+  | '95212'
+  | '95213'
+  | '95214'
+  | '95221'
+  | '95222'
+  | '95230'
+  | '95240'
+  | '95291'
+  | '95292'
+  | '95293'
+  | '95294'
+  | '95295'
+  | '95296'
+  | '95299'
+  | '96011'
+  | '96012'
+  | '96013'
+  | '96014'
+  | '96020'
+  | '96031'
+  | '96032'
+  | '96033'
+  | '96034'
+  | '96035'
+  | '96091'
+  | '96092'
+  | '96093'
+  | '96094'
+  | '96095'
+  | '96096'
+  | '96097'
+  | '96099'
+  | '97000'
+  | '98100'
+  | '98200'
+  | '99000'
+
+export enum MSIC_9X {
+  THEATRICAL_PRODUCTION = '90001',
+  CONCERT_HALLS = '90002',
+  VISUAL_ARTISTS = '90003',
+  WRITERS = '90004',
+  JOURNALISTS = '90005',
+  ART_RESTORATION = '90006',
+  ARTS_EVENT_PRODUCTION = '90007',
+  OTHER_CREATIVE_ARTS = '90009',
+  LIBRARIES = '91011',
+  PHOTO_LIBRARIES = '91012',
+  MUSEUMS = '91021',
+  HISTORICAL_SITES = '91022',
+  BOTANICAL_ZOOLOGICAL = '91031',
+  NATURE_RESERVES = '91032',
+  GAMBLING = '92000',
+  SPORTS_FACILITIES = '93111',
+  AUTO_RACING = '93112',
+  EQUESTRIAN = '93113',
+  SWIMMING_FACILITIES = '93114',
+  ATHLETICS_FACILITIES = '93115',
+  GOLF_COURSES = '93116',
+  BOWLING_CENTRES = '93117',
+  FITNESS_CENTRES = '93118',
+  SPORTS_EVENTS = '93119',
+  SPORTS_CLUBS = '93120',
+  SPORTS_PROMOTERS = '93191',
+  SPORTS_REGULATORS = '93192',
+  SPORTS_PROMOTION = '93193',
+  OTHER_SPORTS = '93199',
+  AMUSEMENT_PARKS = '93210',
+  RECREATION_PARKS = '93291',
+  RECREATIONAL_TRANSPORT = '93292',
+  LEISURE_EQUIPMENT_RENTAL = '93293',
+  RECREATIONAL_FAIRS = '93294',
+  DISCOTHEQUES = '93295',
+  EVENT_PRODUCTION = '93296',
+  CYBER_CAFE = '93297',
+  OTHER_RECREATION = '93299',
+  BUSINESS_ORGANIZATIONS = '94110',
+  PROFESSIONAL_ORGANIZATIONS = '94120',
+  TRADE_UNIONS = '94200',
+  RELIGIOUS_ORGANIZATIONS = '94910',
+  POLITICAL_ORGANIZATIONS = '94920',
+  OTHER_ORGANIZATIONS = '94990',
+  ELECTRONIC_REPAIR = '95111',
+  COMPUTER_REPAIR = '95112',
+  PDA_REPAIR = '95113',
+  CORDLESS_PHONE_REPAIR = '95121',
+  MOBILE_PHONE_REPAIR = '95122',
+  MODEM_REPAIR = '95123',
+  FAX_REPAIR = '95124',
+  COMMUNICATIONS_REPAIR = '95125',
+  RADIO_REPAIR = '95126',
+  CAMERA_REPAIR = '95127',
+  TV_REPAIR = '95211',
+  VIDEO_PLAYER_REPAIR = '95212',
+  CD_PLAYER_REPAIR = '95213',
+  VIDEO_CAMERA_REPAIR = '95214',
+  APPLIANCE_REPAIR = '95221',
+  GARDEN_EQUIPMENT_REPAIR = '95222',
+  FOOTWEAR_REPAIR = '95230',
+  FURNITURE_REPAIR = '95240',
+  BICYCLE_REPAIR = '95291',
+  CLOTHING_REPAIR = '95292',
+  JEWELRY_REPAIR = '95293',
+  WATCH_REPAIR = '95294',
+  SPORTS_EQUIPMENT_REPAIR = '95295',
+  MUSICAL_INSTRUMENT_REPAIR = '95296',
+  OTHER_REPAIRS = '95299',
+  LAUNDRY = '96011',
+  CARPET_CLEANING = '96012',
+  UNIFORM_RENTAL = '96013',
+  DIAPER_SERVICE = '96014',
+  BEAUTY_SERVICES = '96020',
+  MORTUARY_SERVICES = '96031',
+  FUNERAL_SERVICES = '96032',
+  FUNERAL_PARLOUR_RENTAL = '96033',
+  GRAVE_SALES = '96034',
+  GRAVE_MAINTENANCE = '96035',
+  WELLNESS_SERVICES = '96091',
+  ASTROLOGY_SERVICES = '96092',
+  DATING_SERVICES = '96093',
+  PET_CARE = '96094',
+  GENEALOGY = '96095',
+  PERSONAL_SERVICES = '96096',
+  VENDING_MACHINES = '96097',
+  OTHER_SERVICES = '96099',
+  DOMESTIC_PERSONNEL = '97000',
+  HOUSEHOLD_GOODS_PRODUCTION = '98100',
+  HOUSEHOLD_SERVICES = '98200',
+  EXTRATERRITORIAL_ORGANIZATIONS = '99000',
+}

package/src/types/msic-codes.d.ts

@@ -0,0 +1,37 @@
+import type { MSIC_0X_CODE } from './msic/0X.d.ts'
+import type { MSIC_1X_CODE } from './msic/1X.d.ts'
+import type { MSIC_2X_CODE } from './msic/2X.d.ts'
+import type { MSIC_3X_CODE } from './msic/3X.d.ts'
+import type { MSIC_4X_CODE } from './msic/4X.d.ts'
+import type { MSIC_5X_CODE } from './msic/5X.d.ts'
+import type { MSIC_6X_CODE } from './msic/6X.d.ts'
+import type { MSIC_7X_CODE } from './msic/7X.d.ts'
+import type { MSIC_8X_CODE } from './msic/8X.d.ts'
+import type { MSIC_9X_CODE } from './msic/9X.d.ts'
+
+export type MSICCode = {
+  code: string
+  description: string
+  msicCategoryReference: string
+}
+
+/**
+ * Represents the allowed 5-digit Malaysia Standard Industrial Classification (MSIC) codes.
+ * Based on the documentation: https://sdk.myinvois.hasil.gov.my/codes/msic-codes/
+ * Interface representing an MSIC code entry.
+ * Contains the 5-digit code and its description.
+ */
+export interface MsicEntry {
+  code:
+    | MSIC_0X_CODE
+    | MSIC_1X_CODE
+    | MSIC_2X_CODE
+    | MSIC_3X_CODE
+    | MSIC_4X_CODE
+    | MSIC_5X_CODE
+    | MSIC_6X_CODE
+    | MSIC_7X_CODE
+    | MSIC_8X_CODE
+    | MSIC_9X_CODE
+  description: string
+}

package/src/types/payment-modes.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Represents the allowed codes for payment modes.
+ * Based on the documentation: https://sdk.myinvois.hasil.gov.my/codes/payment-methods/
+ */
+export type PaymentModeCode =
+  | '01' // Cash
+  | '02' // Cheque
+  | '03' // Bank Transfer
+  | '04' // Credit Card
+  | '05' // Debit Card
+  | '06' // e-Wallet / Digital Wallet
+  | '07' // Digital Bank
+  | '08' // Others
+
+/**
+ * Enum representing the allowed payment mode codes with descriptive names.
+ * Provides a more readable way to reference payment modes.
+ *
+ * @example
+ * const mode = PaymentModeCodeEnum.Cash;
+ * console.log(mode); // Output: "01"
+ */
+export enum PaymentModeCodeEnum {
+  Cash = '01',
+  Cheque = '02',
+  BankTransfer = '03',
+  CreditCard = '04',
+  DebitCard = '05',
+  EWalletDigitalWallet = '06',
+  DigitalBank = '07',
+  Others = '08',
+}
+
+/**
+ * Interface representing a payment mode entry.
+ * Contains the code and its corresponding description.
+ */
+export interface PaymentMode {
+  code: PaymentModeCode
+  description: string
+}

package/src/types/signatures.d.ts

@@ -0,0 +1,169 @@
+/**
+ * Represents the Digest Method structure used within the signature.
+ */
+export interface DigestMethod {
+  /** Algorithm used for digest. Should be http://www.w3.org/2001/04/xmlenc#sha256 */
+  Algorithm: string
+}
+
+/**
+ * Represents the Cert Digest structure.
+ */
+export interface CertDigest {
+  /** Digest method details. */
+  "ds:DigestMethod": DigestMethod
+  /** Base64 encoded HEX-SHA256 certificate information (CertDigest). */
+  "ds:DigestValue": string // base64binary
+}
+
+/**
+ * Represents the Issuer Serial structure within the Signing Certificate.
+ */
+export interface IssuerSerial {
+  /** CN of the certificate issuer (Organization name). */
+  "ds:X509IssuerName": string
+  /** Digital certificate serial number. */
+  "ds:X509SerialNumber": string // xsd:normalizedString -> string
+}
+
+/**
+ * Represents the Certificate structure within Signing Certificate.
+ */
+export interface Cert {
+  /** Certificate digest details. */
+  "xades:CertDigest": CertDigest
+  /** Issuer details. */
+  "xades:IssuerSerial": IssuerSerial
+}
+
+/**
+ * Represents the Signing Certificate structure.
+ */
+export interface SigningCertificate {
+  /** Certificate details. */
+  "xades:Cert": Cert
+}
+
+/**
+ * Represents the Signed Signature Properties.
+ */
+export interface SignedSignatureProperties {
+  /** UTC timestamp of signing (YYYY-MM-DDTHH:mm:ssZ). */
+  "xades:SigningTime": string // dateTime
+  /** Signing certificate details. */
+  "xades:SigningCertificate": SigningCertificate
+  // Note: Other optional properties like SignaturePolicyIdentifier might exist
+}
+
+/**
+ * Represents the Signed Properties structure.
+ */
+export interface SignedProperties {
+  /** Target attribute, should be 'signature'. */
+  Target: string
+  /** ID attribute, should be 'id-xades-signed-props'. */
+  Id: string
+  /** Signed signature properties. */
+  "xades:SignedSignatureProperties": SignedSignatureProperties
+}
+
+/**
+ * Represents the Qualifying Properties structure (Object element).
+ */
+export interface QualifyingProperties {
+  /** Target attribute, should be 'signature'. */
+  Target: string
+  /** Signed properties details. */
+  "xades:SignedProperties": SignedProperties
+  // Note: UnsignedProperties might exist but are not detailed in the mandatory part
+}
+
+/**
+ * Represents the X509 Data structure within KeyInfo.
+ */
+export interface X509Data {
+  /** Base64 encoded X509 certificate. */
+  "ds:X509Certificate": string // base64binary
+}
+
+/**
+ * Represents the Key Information structure.
+ */
+export interface KeyInfo {
+  /** X509 certificate data. */
+  "ds:X509Data": X509Data
+}
+
+/**
+ * Represents the Transform structure within Reference.
+ */
+export interface Transform {
+  /** Algorithm attribute for the transform. */
+  Algorithm: string
+}
+
+/**
+ * Represents a Reference within SignedInfo.
+ */
+export interface Reference {
+  /** ID attribute for the reference (e.g., 'id-doc-signed-data', 'id-xades-signed-props'). */
+  Id?: string
+  /** URI attribute for the reference (e.g., '', '#id-xades-signed-props'). */
+  URI: string
+  /** Optional Transforms applied. */
+  "ds:Transforms"?: {
+    "ds:Transform": Transform | Transform[] // Can be single or multiple transforms
+  }
+  /** Digest method details. */
+  "ds:DigestMethod": DigestMethod
+  /** Base64 encoded digest value (DocDigest or PropsDigest). */
+  "ds:DigestValue": string // base64binary
+}
+
+/**
+ * Represents the Canonicalization Method structure.
+ */
+export interface CanonicalizationMethod {
+  /** Algorithm used for canonicalization. Should be http://www.w3.org/2006/12/xml-c14n11 */
+  Algorithm: string
+}
+
+/**
+ * Represents the Signature Method structure.
+ */
+export interface SignatureMethod {
+  /** Algorithm used for signing. Should be http://www.w3.org/2001/04/xmldsig-more#rsa-sha256 */
+  Algorithm: string
+}
+
+/**
+ * Represents the Signed Information structure.
+ */
+export interface SignedInfo {
+  /** Canonicalization method details. */
+  "ds:CanonicalizationMethod": CanonicalizationMethod
+  /** Signature method details. */
+  "ds:SignatureMethod": SignatureMethod
+  /** References to signed data and properties. Should contain two references. */
+  "ds:Reference": [Reference, Reference] // Expecting two: one for document, one for signed properties
+}
+
+/**
+ * Represents the root Signature element (IssuerDigitalSignature).
+ * Based on the documentation: https://sdk.myinvois.hasil.gov.my/signature/
+ * Conforms to XAdES enveloped signature requirements for UBL.
+ */
+export interface IssuerDigitalSignature {
+  /** ID attribute, should be 'DocSig'. */
+  Id: string
+  /** Signed information details. */
+  "ds:SignedInfo": SignedInfo
+  /** Base64 encoded signature value (Sig). */
+  "ds:SignatureValue": string // base64binary
+  /** Public key information (certificate). */
+  "ds:KeyInfo": KeyInfo
+  /** Object containing signed properties. */
+  "ds:Object": {
+    "xades:QualifyingProperties": QualifyingProperties
+  }
+}

package/src/types/state-codes.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Represents the allowed codes for Malaysian states and federal territories.
+ * Based on the documentation: https://sdk.myinvois.hasil.gov.my/codes/state-codes/
+ */
+export type StateCode =
+  | '01' // Johor
+  | '02' // Kedah
+  | '03' // Kelantan
+  | '04' // Melaka
+  | '05' // Negeri Sembilan
+  | '06' // Pahang
+  | '07' // Pulau Pinang
+  | '08' // Perak
+  | '09' // Perlis
+  | '10' // Selangor
+  | '11' // Terengganu
+  | '12' // Sabah
+  | '13' // Sarawak
+  | '14' // Wilayah Persekutuan Kuala Lumpur
+  | '15' // Wilayah Persekutuan Labuan
+  | '16' // Wilayah Persekutuan Putrajaya
+  | '17' // Not Applicable
+
+/**
+ * Enum representing the allowed state codes with descriptive names.
+ * Provides a more readable way to reference states.
+ *
+ * @example
+ * const code = StateCodeEnum.Selangor;
+ * console.log(code); // Output: "10"
+ */
+export enum StateCodeEnum {
+  Johor = '01',
+  Kedah = '02',
+  Kelantan = '03',
+  Melaka = '04',
+  NegeriSembilan = '05',
+  Pahang = '06',
+  PulauPinang = '07',
+  Perak = '08',
+  Perlis = '09',
+  Selangor = '10',
+  Terengganu = '11',
+  Sabah = '12',
+  Sarawak = '13',
+  WPKualaLumpur = '14',
+  WPLabuan = '15',
+  WPPutrajaya = '16',
+  NotApplicable = '17',
+}
+
+/**
+ * Interface representing a state code entry.
+ * Contains the code and its corresponding name.
+ */
+export interface State {
+  code: StateCode
+  name: string
+}

package/src/types/tax-types.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Represents the allowed codes for tax types.
+ * Based on the documentation: https://sdk.myinvois.hasil.gov.my/codes/tax-types/
+ */
+export type TaxTypeCode =
+  | '01' // Sales Tax
+  | '02' // Service Tax
+  | '03' // Tourism Tax
+  | '04' // High-Value Goods Tax
+  | '05' // Sales Tax on Low Value Goods
+  | '06' // Not Applicable
+  | 'E' // Tax exemption (where applicable)
+
+/**
+ * Enum representing the allowed tax type codes with descriptive names.
+ * Provides a more readable way to reference tax types.
+ *
+ * @example
+ * const code = TaxTypeCodeEnum.SalesTax;
+ * console.log(code); // Output: "01"
+ */
+export enum TaxTypeCodeEnum {
+  SalesTax = '01',
+  ServiceTax = '02',
+  TourismTax = '03',
+  HighValueGoodsTax = '04',
+  SalesTaxLowValueGoods = '05',
+  NotApplicable = '06',
+  TaxExemption = 'E',
+}
+
+/**
+ * Interface representing a tax type entry.
+ * Contains the code and its corresponding description.
+ */
+export interface TaxType {
+  code: TaxTypeCode
+  description: string
+}