@ripwords/myinvois-client 0.2.27 → 0.2.29

package/dist/index.js

@@ -1,7 +1,7 @@
-import { getDocument, getDocumentDetails, searchDocuments } from "./documentManagement-CIQPkmyb.js";
+import { getDocument, getDocumentDetails, searchDocuments } from "./documentManagement-CeNbp3qm.js";
 import "./formatIdValue-qTxJqj9o.js";
-import "./document-nWFcUMsi.js";
-import { getSubmissionStatus, performDocumentAction, submitDocument } from "./documentSubmission-CVwFwnDd.js";
+import "./document-DI6hw1MO.js";
+import { getSubmissionStatus, performDocumentAction, submitDocument } from "./documentSubmission-Dr4R4sKD.js";
 import { getDocumentType, getDocumentTypeVersion, getDocumentTypes } from "./documentTypeManagement-cBtVCOY3.js";
 import { getNotifications } from "./notificationManagement-n4Z5e-My.js";
 import { platformLogin } from "./platformLogin-CqI9OLYP.js";
@@ -15,6 +15,7 @@ var MyInvoisClient = class MyInvoisClient {
 	baseUrl;
 	clientId;
 	clientSecret;
+	environment;
 	onBehalfOf;
 	signingCredentials;
 	debug;
@@ -26,6 +27,7 @@ var MyInvoisClient = class MyInvoisClient {
 		this.clientId = clientId;
 		this.clientSecret = clientSecret;
 		this.baseUrl = getBaseUrl(environment);
+		this.environment = environment;
 		this.onBehalfOf = onBehalfOf;
 		this.debug = debug ?? process.env.MYINVOIS_DEBUG === "true" ? true : false;
 		const { issuerName, serialNumber } = extractCertificateInfo(certificatePem);
@@ -479,6 +481,36 @@ var MyInvoisClient = class MyInvoisClient {
 		return getDocumentType({ fetch: this.fetch.bind(this) }, id);
 	}
 	/**
+	* Generates a shareable QR code URL for a specific document.
+	*
+	* This method retrieves the document details using its unique identifier,
+	* then constructs a URL that can be used to access or share the document
+	* via the MyInvois platform. The URL format differs between sandbox and
+	* production environments.
+	*
+	* @param documentUid - The unique identifier of the document
+	* @returns Promise resolving to a string containing the QR code URL
+	*
+	* @example
+	* ```typescript
+	* const qrCodeUrl = await client.getDocumentQrCode('abc123');
+	* console.log('Shareable QR code URL:', qrCodeUrl);
+	* // Output (sandbox): https://preprod.myinvois.hasil.gov.my/abc123/share/longId
+	* // Output (production): https://myinvois.hasil.gov.my/abc123/share/longId
+	* ```
+	*
+	* @remarks
+	* - The returned URL can be embedded in a QR code for document sharing.
+	* - The method fetches the document to obtain its longId, which is required for the URL.
+	* - Ensure the documentUid is valid and accessible by the current client.
+	*/
+	async getDocumentQrCode(documentUid) {
+		const doc = await getDocument({ fetch: this.fetch.bind(this) }, documentUid);
+		console.log(doc);
+		const qrCodeBaseLink = `https://${this.environment === "sandbox" ? "preprod." : ""}myinvois.hasil.gov.my/`;
+		return qrCodeBaseLink + documentUid + "/share/" + doc.longId;
+	}
+	/**
 	* Retrieves detailed information about a specific version of a document type.
 	*
 	* This method fetches version-specific metadata, schema definitions, and validation rules

package/dist/index10.cjs

@@ -1,25 +1,62 @@
 
-//#region src/types/payment-modes.d.ts
+//#region src/types/classification-codes.d.ts
 /**
-* Enum representing the allowed payment mode codes with descriptive names.
-* Provides a more readable way to reference payment modes.
+* Enum representing the allowed classification codes with descriptive names.
+* Provides a more readable way to reference classification codes.
 *
 * @example
-* const mode = PaymentModeCodeEnum.Cash;
-* console.log(mode); // Output: "01"
+* const code = ClassificationCodeEnum.ComputerSmartphoneOrTablet;
+* console.log(code); // Output: "003"
 */
-let PaymentModeCodeEnum = /* @__PURE__ */ function(PaymentModeCodeEnum$1) {
-	PaymentModeCodeEnum$1["Cash"] = "01";
-	PaymentModeCodeEnum$1["Cheque"] = "02";
-	PaymentModeCodeEnum$1["BankTransfer"] = "03";
-	PaymentModeCodeEnum$1["CreditCard"] = "04";
-	PaymentModeCodeEnum$1["DebitCard"] = "05";
-	PaymentModeCodeEnum$1["EWalletDigitalWallet"] = "06";
-	PaymentModeCodeEnum$1["DigitalBank"] = "07";
-	PaymentModeCodeEnum$1["Others"] = "08";
-	return PaymentModeCodeEnum$1;
+let ClassificationCodeEnum = /* @__PURE__ */ function(ClassificationCodeEnum$1) {
+	ClassificationCodeEnum$1["BreastfeedingEquipment"] = "001";
+	ClassificationCodeEnum$1["ChildCareCentresAndKindergartensFees"] = "002";
+	ClassificationCodeEnum$1["ComputerSmartphoneOrTablet"] = "003";
+	ClassificationCodeEnum$1["ConsolidatedEInvoice"] = "004";
+	ClassificationCodeEnum$1["ConstructionMaterials"] = "005";
+	ClassificationCodeEnum$1["Disbursement"] = "006";
+	ClassificationCodeEnum$1["Donation"] = "007";
+	ClassificationCodeEnum$1["ECommerceEInvoiceToBuyer"] = "008";
+	ClassificationCodeEnum$1["ECommerceSelfBilledToSellerLogistics"] = "009";
+	ClassificationCodeEnum$1["EducationFees"] = "010";
+	ClassificationCodeEnum$1["GoodsOnConsignmentConsignor"] = "011";
+	ClassificationCodeEnum$1["GoodsOnConsignmentConsignee"] = "012";
+	ClassificationCodeEnum$1["GymMembership"] = "013";
+	ClassificationCodeEnum$1["InsuranceEducationMedicalBenefits"] = "014";
+	ClassificationCodeEnum$1["InsuranceTakafulLife"] = "015";
+	ClassificationCodeEnum$1["InterestFinancingExpenses"] = "016";
+	ClassificationCodeEnum$1["InternetSubscription"] = "017";
+	ClassificationCodeEnum$1["LandAndBuilding"] = "018";
+	ClassificationCodeEnum$1["MedicalExamLearningDisabilities"] = "019";
+	ClassificationCodeEnum$1["MedicalExamVaccination"] = "020";
+	ClassificationCodeEnum$1["MedicalExpensesSeriousDiseases"] = "021";
+	ClassificationCodeEnum$1["Others"] = "022";
+	ClassificationCodeEnum$1["PetroleumOperations"] = "023";
+	ClassificationCodeEnum$1["PrivateRetirementSchemeDeferredAnnuity"] = "024";
+	ClassificationCodeEnum$1["MotorVehicle"] = "025";
+	ClassificationCodeEnum$1["SubscriptionBooksJournalsEtc"] = "026";
+	ClassificationCodeEnum$1["Reimbursement"] = "027";
+	ClassificationCodeEnum$1["RentalOfMotorVehicle"] = "028";
+	ClassificationCodeEnum$1["EVChargingFacilities"] = "029";
+	ClassificationCodeEnum$1["RepairAndMaintenance"] = "030";
+	ClassificationCodeEnum$1["ResearchAndDevelopment"] = "031";
+	ClassificationCodeEnum$1["ForeignIncome"] = "032";
+	ClassificationCodeEnum$1["SelfBilledBettingGaming"] = "033";
+	ClassificationCodeEnum$1["SelfBilledImportationGoods"] = "034";
+	ClassificationCodeEnum$1["SelfBilledImportationServices"] = "035";
+	ClassificationCodeEnum$1["SelfBilledOthers"] = "036";
+	ClassificationCodeEnum$1["SelfBilledMonetaryPaymentToAgents"] = "037";
+	ClassificationCodeEnum$1["SportsEquipmentRentalFeesEtc"] = "038";
+	ClassificationCodeEnum$1["SupportingEquipmentDisabledPerson"] = "039";
+	ClassificationCodeEnum$1["VoluntaryContributionProvidentFund"] = "040";
+	ClassificationCodeEnum$1["DentalExamTreatment"] = "041";
+	ClassificationCodeEnum$1["FertilityTreatment"] = "042";
+	ClassificationCodeEnum$1["TreatmentHomeCareNursingEtc"] = "043";
+	ClassificationCodeEnum$1["VouchersGiftCardsLoyaltyPoints"] = "044";
+	ClassificationCodeEnum$1["SelfBilledNonMonetaryPaymentToAgents"] = "045";
+	return ClassificationCodeEnum$1;
 }({});
 
 //#endregion
-exports.PaymentModeCodeEnum = PaymentModeCodeEnum;
+exports.ClassificationCodeEnum = ClassificationCodeEnum;
 //# sourceMappingURL=index10.cjs.map

package/dist/index10.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index10.cjs","names":[],"sources":["../src/types/payment-modes.d.ts"],"sourcesContent":["/**\n * Represents the allowed codes for payment modes.\n * Based on the documentation: https://sdk.myinvois.hasil.gov.my/codes/payment-methods/\n */\nexport type PaymentModeCode =\n  | '01' // Cash\n  | '02' // Cheque\n  | '03' // Bank Transfer\n  | '04' // Credit Card\n  | '05' // Debit Card\n  | '06' // e-Wallet / Digital Wallet\n  | '07' // Digital Bank\n  | '08' // Others\n\n/**\n * Enum representing the allowed payment mode codes with descriptive names.\n * Provides a more readable way to reference payment modes.\n *\n * @example\n * const mode = PaymentModeCodeEnum.Cash;\n * console.log(mode); // Output: \"01\"\n */\nexport enum PaymentModeCodeEnum {\n  Cash = '01',\n  Cheque = '02',\n  BankTransfer = '03',\n  CreditCard = '04',\n  DebitCard = '05',\n  EWalletDigitalWallet = '06',\n  DigitalBank = '07',\n  Others = '08',\n}\n\n/**\n * Interface representing a payment mode entry.\n * Contains the code and its corresponding description.\n */\nexport interface PaymentMode {\n  code: PaymentModeCode\n  description: string\n}\n"],"mappings":";;;;;;;;;;AAsBA,IAAY,sEAAL;AACL;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AACD"}
+{"version":3,"file":"index10.cjs","names":[],"sources":["../src/types/classification-codes.d.ts"],"sourcesContent":["/**\n * Represents the allowed classification codes for e-Invoice items.\n * Based on the documentation: https://sdk.myinvois.hasil.gov.my/codes/classification-codes/\n */\nexport type ClassificationCode =\n  | '001' // Breastfeeding equipment\n  | '002' // Child care centres and kindergartens fees\n  | '003' // Computer, smartphone or tablet\n  | '004' // Consolidated e-Invoice\n  | '005' // Construction materials (as specified under Fourth Schedule of the Lembaga Pembangunan Industri Pembinaan Malaysia Act 1994)\n  | '006' // Disbursement\n  | '007' // Donation\n  | '008' // e-Commerce - e-Invoice to buyer / purchaser\n  | '009' // e-Commerce - Self-billed e-Invoice to seller, logistics, etc.\n  | '010' // Education fees\n  | '011' // Goods on consignment (Consignor)\n  | '012' // Goods on consignment (Consignee)\n  | '013' // Gym membership\n  | '014' // Insurance - Education and medical benefits\n  | '015' // Insurance - Takaful or life insurance\n  | '016' // Interest and financing expenses\n  | '017' // Internet subscription\n  | '018' // Land and building\n  | '019' // Medical examination for learning disabilities and early intervention or rehabilitation treatments of learning disabilities\n  | '020' // Medical examination or vaccination expenses\n  | '021' // Medical expenses for serious diseases\n  | '022' // Others\n  | '023' // Petroleum operations (as defined in Petroleum (Income Tax) Act 1967)\n  | '024' // Private retirement scheme or deferred annuity scheme\n  | '025' // Motor vehicle\n  | '026' // Subscription of books / journals / magazines / newspapers / other similar publications\n  | '027' // Reimbursement\n  | '028' // Rental of motor vehicle\n  | '029' // EV charging facilities (Installation, rental, sale / purchase or subscription fees)\n  | '030' // Repair and maintenance\n  | '031' // Research and development\n  | '032' // Foreign income\n  | '033' // Self-billed - Betting and gaming\n  | '034' // Self-billed - Importation of goods\n  | '035' // Self-billed - Importation of services\n  | '036' // Self-billed - Others\n  | '037' // Self-billed - Monetary payment to agents, dealers or distributors\n  | '038' // Sports equipment, rental / entry fees for sports facilities, registration in sports competition or sports training fees imposed by associations / sports clubs / companies registered with the Sports Commissioner or Companies Commission of Malaysia and carrying out sports activities as listed under the Sports Development Act 1997\n  | '039' // Supporting equipment for disabled person\n  | '040' // Voluntary contribution to approved provident fund\n  | '041' // Dental examination or treatment\n  | '042' // Fertility treatment\n  | '043' // Treatment and home care nursing, daycare centres and residential care centers\n  | '044' // Vouchers, gift cards, loyalty points, etc\n  | '045' // Self-billed - Non-monetary payment to agents, dealers or distributors\n\n/**\n * Enum representing the allowed classification codes with descriptive names.\n * Provides a more readable way to reference classification codes.\n *\n * @example\n * const code = ClassificationCodeEnum.ComputerSmartphoneOrTablet;\n * console.log(code); // Output: \"003\"\n */\nexport enum ClassificationCodeEnum {\n  BreastfeedingEquipment = '001',\n  ChildCareCentresAndKindergartensFees = '002',\n  ComputerSmartphoneOrTablet = '003',\n  ConsolidatedEInvoice = '004',\n  ConstructionMaterials = '005',\n  Disbursement = '006',\n  Donation = '007',\n  ECommerceEInvoiceToBuyer = '008',\n  ECommerceSelfBilledToSellerLogistics = '009',\n  EducationFees = '010',\n  GoodsOnConsignmentConsignor = '011',\n  GoodsOnConsignmentConsignee = '012',\n  GymMembership = '013',\n  InsuranceEducationMedicalBenefits = '014',\n  InsuranceTakafulLife = '015',\n  InterestFinancingExpenses = '016',\n  InternetSubscription = '017',\n  LandAndBuilding = '018',\n  MedicalExamLearningDisabilities = '019',\n  MedicalExamVaccination = '020',\n  MedicalExpensesSeriousDiseases = '021',\n  Others = '022',\n  PetroleumOperations = '023',\n  PrivateRetirementSchemeDeferredAnnuity = '024',\n  MotorVehicle = '025',\n  SubscriptionBooksJournalsEtc = '026',\n  Reimbursement = '027',\n  RentalOfMotorVehicle = '028',\n  EVChargingFacilities = '029',\n  RepairAndMaintenance = '030',\n  ResearchAndDevelopment = '031',\n  ForeignIncome = '032',\n  SelfBilledBettingGaming = '033',\n  SelfBilledImportationGoods = '034',\n  SelfBilledImportationServices = '035',\n  SelfBilledOthers = '036',\n  SelfBilledMonetaryPaymentToAgents = '037',\n  SportsEquipmentRentalFeesEtc = '038',\n  SupportingEquipmentDisabledPerson = '039',\n  VoluntaryContributionProvidentFund = '040',\n  DentalExamTreatment = '041',\n  FertilityTreatment = '042',\n  TreatmentHomeCareNursingEtc = '043',\n  VouchersGiftCardsLoyaltyPoints = '044',\n  SelfBilledNonMonetaryPaymentToAgents = '045',\n}\n\n/**\n * Interface representing a classification code entry.\n * Contains the code and its corresponding description.\n */\nexport interface Classification {\n  code: ClassificationCode\n  description: string\n}\n"],"mappings":";;;;;;;;;;AA2DA,IAAY,4EAAL;AACL;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AACD"}