Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: support additional parameter for optional date timezone #525

Merged
merged 6 commits into from
Mar 9, 2023
Merged

feat: support additional parameter for optional date timezone #525

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f417480
feat: support additional parameter for optional date timezone
Scrib3r Mar 1, 2023
b19e075
fix: fix checking for undefined options in toXmlDate
Scrib3r Mar 1, 2023
91d2991
fix: fix broken tests
Scrib3r Mar 1, 2023
3c2b2da
test: create some additional tests for date parsing
Scrib3r Mar 1, 2023
51c5f1c
refactor: simplify passing option parameter to xmlDateOrTime
Scrib3r Mar 2, 2023
0c943d4
refactor: remove reassigning passed value on date formatting functions
Scrib3r Mar 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 51 additions & 18 deletions src/parser/xmlHandler.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,28 @@ var NamespaceContext = require('./nscontext');


class XMLHandler {
/**
* @param {Object} [schemas]
* @param {Object} [options]
* @param {boolean} [options.enforceRestrictions]
* @param {string} [options.valueKey]
* @param {string} [options.xmlKey]
* @param {string} [options.attributesKey]
* @param {string} [options.xsiTypeKey]
* @param {Object} [options.date]
* @param {Object} [options.date.timezone]
* @param {boolean} [options.date.timezone.enabled]
*/
constructor(schemas, options) {
this.schemas = schemas || {};
this.options = options || {};
this.options.valueKey = this.options.valueKey || '$value';
this.options.xmlKey = this.options.xmlKey || '$xml';
this.options.attributesKey = this.options.attributesKey || '$attributes';
this.options.xsiTypeKey = this.options.xsiTypeKey || '$xsiType';
this.options.date = this.options.date || {};
this.options.date.timezone = this.options.date.timezone || {};
this.options.date.timezone.enabled = typeof this.options.date.timezone.enabled === 'boolean' ? this.options.date.timezone.enabled : true;
}

jsonToXml(node, nsContext, descriptor, val) {
Expand All @@ -42,7 +57,7 @@ class XMLHandler {
var name;
let nameSpaceContextCreated = false;
if (descriptor instanceof AttributeDescriptor) {
val = toXmlDateOrTime(descriptor, val);
val = toXmlDateOrTime(descriptor, val, this.options.date);
name = descriptor.qname.name;
if (descriptor.form === 'unqualified') {
node.attribute(name, val);
Expand Down Expand Up @@ -116,7 +131,7 @@ class XMLHandler {
&& typeof val[this.options.xmlKey] !== "undefined") {
val = val[this.options.xmlKey];
element = node.element(elementName);
val = toXmlDateOrTime(descriptor, val);
val = toXmlDateOrTime(descriptor, val, this.options.date);
element.raw(val);
} else {
// Enforce the type restrictions if configured for such
Expand All @@ -137,7 +152,7 @@ class XMLHandler {
}
}
}
val = toXmlDateOrTime(descriptor, val);
val = toXmlDateOrTime(descriptor, val, this.options.date);
element = isSimple ? node.element(elementName, val) : node.element(elementName);
}

Expand Down Expand Up @@ -195,7 +210,7 @@ class XMLHandler {
//val is not an object - simple or date types
if (val != null && ( typeof val !== 'object' || val instanceof Date)) {
// for adding a field value nsContext.popContext() shouldnt be called
val = toXmlDateOrTime(descriptor, val);
val = toXmlDateOrTime(descriptor, val, this.options.date);
element.text(val);
//add $attributes. Attribute can be an attribute defined in XSD or an xsi:type.
//e.g of xsi:type <name xmlns=".." xmlns:xsi="..." xmlns:ns="..." xsi:type="ns:string">some name</name>
Expand Down Expand Up @@ -288,7 +303,7 @@ class XMLHandler {
mapObject(node, nsContext, descriptor, val, attrs) {
if (val == null) return node;
if (typeof val !== 'object' || (val instanceof Date)) {
val = toXmlDateOrTime(descriptor, val);
val = toXmlDateOrTime(descriptor, val, this.options.date);
node.text(val);
return node;
}
Expand Down Expand Up @@ -868,32 +883,50 @@ function parseValue(text, descriptor) {
return value;
}

function toXmlDate(date) {
date = new Date(date);
var isoStr = date.toISOString();
return isoStr.split('T')[0] + 'Z';
/**
*
* @param {string | Date} date
* @param {Object} [options]
* @param {Object} [options.timezone]
* @param {boolean} [options.timezone.enabled]
* @returns
*/
function toXmlDate(date, options) {
const isoStr = new Date(date).toISOString();
const formattedDate = isoStr.split('T')[0];
const withTimezone = (options && options.timezone) && typeof options.timezone.enabled === 'boolean' ? options.timezone.enabled : true;
if (!withTimezone) {
return formattedDate;
}
return formattedDate + 'Z';
}

function toXmlTime(date) {
date = new Date(date);
var isoStr = date.toISOString();
const isoStr = new Date(date).toISOString();
return isoStr.split('T')[1];
}

function toXmlDateTime(date) {
date = new Date(date);
var isoStr = date.toISOString();
return isoStr;
return new Date(date).toISOString();
}

function toXmlDateOrTime(descriptor, val) {
/**
*
* @param {object} descriptor
* @param {* | null} val
* @param {Object} options
* @param {Object} options.timezone
* @param {boolean} options.timezone.enabled
* @returns {string}
*/
function toXmlDateOrTime(descriptor, val, options) {
if (!descriptor || !descriptor.type || val === null) return val;
if (descriptor.type.name === 'date') {
val = toXmlDate(val);
return toXmlDate(val, options);
} else if (descriptor.type.name === 'time') {
val = toXmlTime(val);
return toXmlTime(val);
} else if (descriptor.type.name === 'dateTime') {
val = toXmlDateTime(val);
return toXmlDateTime(val);
}
return val;
}
Expand Down
19 changes: 19 additions & 0 deletions test/xs-date-format-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,15 @@ describe('xs-date-format-tests', function() {
assert.equal(xmlDate, '2019-03-27Z');
});

it('converts date to xml date without Z', function() {
var xmlDate = xmlHandler.toXmlDate(inputDate, {
timezone: {
enabled: false,
},
});
assert.equal(xmlDate, '2019-03-27');
});

it('converts date to xml time', function () {
var xmlTime = xmlHandler.toXmlTime(inputDate);
assert.equal(xmlTime, '04:01:01.000Z');
Expand All @@ -70,6 +79,16 @@ describe('xs-date-format-tests', function() {
assert.equal(xmlDate, '2019-03-27Z');
});

it('converts string to xml date without Z', function() {
var xmlDate = xmlHandler.toXmlDate(inputDateStr, {
timezone: {
enabled: false,
},
});
assert.equal(xmlDate, '2019-03-27');
});


it('converts string to xml time', function () {
var xmlTime = xmlHandler.toXmlTime(inputDateStr);
assert.equal(xmlTime, '04:01:01.000Z');
Expand Down