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.

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

[T99687] BREAKING CHANGE(dayjs): Migrate moment to dayjs #150

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
23 changes: 23 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [5.0.0] - 2024-05-07

### Changed features

- BREAKING: Migrate date utilities from previously using moment to now using dayjs to optimize bundle size
- Previously, parsing an incomplete input date using moment will fill the missing value. dayjs doesn't have this behavior. Considering adding `date-format` validation if your input is not guaranteed to have a valid format.
```js
const dateWithoutSeconds = '2024-05-07T13:00';
const dateFormatExpectingSeconds = 'YYYY-MM-DDTHH:mm:ss';

moment(dateWithoutSeconds, dateFormatExpectingSeconds).format()
> '2024-05-07T13:00:00+07:00'

dayjs(dateWithoutSeconds, dateFormatExpectingSeconds).format()
> 'Invalid Date'
```
29 changes: 13 additions & 16 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "satpam",
"version": "4.15.1",
"version": "5.0.0",
"description": "Simple and Effective Object Validator",
"main": "lib/index.js",
"scripts": {
Expand All @@ -22,10 +22,10 @@
},
"homepage": "https://github.com/cermati/satpam",
"dependencies": {
"dayjs": "~1.11.10",
"file-type": "~3.8.0",
"image-type": "~4.1.0",
"lodash": "~4.17.21",
"moment": "~2.29.4",
"noes": "~1.1.1",
"ramda": "~0.25.0",
"read-chunk": "~1.0.1"
Expand Down
13 changes: 9 additions & 4 deletions src/validators/date-after-or-equal.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
import always from 'ramda/src/always';
import moment from 'moment';
import dayjs from 'dayjs';
import isSameOrAfter from 'dayjs/plugin/isSameOrAfter';
import customParseFormat from 'dayjs/plugin/customParseFormat';

dayjs.extend(isSameOrAfter);
dayjs.extend(customParseFormat);

const fullName = 'dateAfterOrEqual:$1:$2:$3:$4';

Expand All @@ -18,14 +23,14 @@ const validate = (val, ruleObj) => {

let date;
const dateInputFormat = ruleObj.params[0];
const dateInput = moment(val, dateInputFormat);
const dateInput = dayjs(val, dateInputFormat);
let offset = Number(ruleObj.params[2]);
const unit = ruleObj.params[3] || 'days';

if (ruleObj.params[1].toLowerCase() === NOW) {
date = moment();
date = dayjs();
} else {
date = moment(ruleObj.params[1], dateInputFormat);
date = dayjs(ruleObj.params[1], dateInputFormat);
}

// Always start with a defaultMessage
Expand Down
11 changes: 7 additions & 4 deletions src/validators/date-after.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
import always from 'ramda/src/always';
import moment from 'moment';
import dayjs from 'dayjs';
import customParseFormat from 'dayjs/plugin/customParseFormat';

dayjs.extend(customParseFormat);

const fullName = 'dateAfter:$1:$2:$3:$4';

Expand All @@ -18,14 +21,14 @@ const validate = (val, ruleObj) => {

let date;
const dateInputFormat = ruleObj.params[0];
const dateInput = moment(val, dateInputFormat);
const dateInput = dayjs(val, dateInputFormat);
let offset = Number(ruleObj.params[2]);
const unit = ruleObj.params[3] || 'days';

if (ruleObj.params[1].toLowerCase() === NOW) {
date = moment();
date = dayjs();
} else {
date = moment(ruleObj.params[1], dateInputFormat);
date = dayjs(ruleObj.params[1], dateInputFormat);
}

// Always start with a defaultMessage
Expand Down
11 changes: 7 additions & 4 deletions src/validators/date-before-or-equal.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
import always from 'ramda/src/always';
import moment from 'moment';
import dayjs from 'dayjs';
import customParseFormat from 'dayjs/plugin/customParseFormat';

dayjs.extend(customParseFormat);

const fullName = 'dateBeforeOrEqual:$1:$2:$3:$4';

Expand All @@ -18,14 +21,14 @@ const validate = (val, ruleObj) => {

let date;
const dateInputFormat = ruleObj.params[0];
const dateInput = moment(val, dateInputFormat);
const dateInput = dayjs(val, dateInputFormat);
let offset = Number(ruleObj.params[2]);
const unit = ruleObj.params[3] || 'days';

if (ruleObj.params[1].toLowerCase() === NOW) {
date = moment();
date = dayjs();
} else {
date = moment(ruleObj.params[1], dateInputFormat);
date = dayjs(ruleObj.params[1], dateInputFormat);
}

// Always start with a defaultMessage
Expand Down
11 changes: 7 additions & 4 deletions src/validators/date-before.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
import always from 'ramda/src/always';
import moment from 'moment';
import dayjs from 'dayjs';
import customParseFormat from 'dayjs/plugin/customParseFormat';

dayjs.extend(customParseFormat);

const fullName = 'dateBefore:$1:$2:$3:$4';

Expand All @@ -18,14 +21,14 @@ const validate = (val, ruleObj) => {

let date;
const dateInputFormat = ruleObj.params[0];
const dateInput = moment(val, dateInputFormat);
const dateInput = dayjs(val, dateInputFormat);
let offset = Number(ruleObj.params[2]);
const unit = ruleObj.params[3] || 'days';

if (ruleObj.params[1].toLowerCase() === NOW) {
date = moment();
date = dayjs();
} else {
date = moment(ruleObj.params[1], dateInputFormat);
date = dayjs(ruleObj.params[1], dateInputFormat);
}

// Always start with a defaultMessage
Expand Down
7 changes: 5 additions & 2 deletions src/validators/date-format.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
import moment from 'moment';
import dayjs from 'dayjs';
import customParseFormat from 'dayjs/plugin/customParseFormat';

dayjs.extend(customParseFormat);

const fullName = 'dateFormat:$1';

Expand All @@ -7,7 +10,7 @@ const validate = (val, ruleObj) => {
return true;
}

return moment(val, ruleObj.params[0], true).isValid();
return dayjs(val, ruleObj.params[0], true).isValid();
};

const message = '<%= propertyName %> must be in format <%= ruleParams[0] %>.';
Expand Down
14 changes: 10 additions & 4 deletions src/validators/date-time-after-or-equal.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
import always from 'ramda/src/always';
import moment from 'moment';
import dayjs from 'dayjs';
import isSameOrAfter from 'dayjs/plugin/isSameOrAfter';
import customParseFormat from 'dayjs/plugin/customParseFormat';

dayjs.extend(isSameOrAfter);
dayjs.extend(customParseFormat);


const fullName = 'dateTimeAfterOrEqual:$1:$2:$3:$4';

Expand All @@ -18,14 +24,14 @@ const validate = (val, ruleObj) => {

let dateTime;
const dateTimeInputFormat = ruleObj.params[0];
const dateTimeInput = moment(val, dateTimeInputFormat);
const dateTimeInput = dayjs(val, dateTimeInputFormat);
let offset = Number(ruleObj.params[2]);
const unit = ruleObj.params[3] || 'seconds';

if (ruleObj.params[1].toLowerCase() === NOW) {
dateTime = moment();
dateTime = dayjs();
} else {
dateTime = moment(ruleObj.params[1], dateTimeInputFormat);
dateTime = dayjs(ruleObj.params[1], dateTimeInputFormat);
}

// Always start with a defaultMessage
Expand Down
11 changes: 7 additions & 4 deletions src/validators/date-time-after.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
import always from 'ramda/src/always';
import moment from 'moment';
import dayjs from 'dayjs';
import customParseFormat from 'dayjs/plugin/customParseFormat';

dayjs.extend(customParseFormat);

const fullName = 'dateTimeAfter:$1:$2:$3:$4';

Expand All @@ -18,14 +21,14 @@ const validate = (val, ruleObj) => {

let dateTime;
const dateTimeInputFormat = ruleObj.params[0];
const dateTimeInput = moment(val, dateTimeInputFormat);
const dateTimeInput = dayjs(val, dateTimeInputFormat);
let offset = Number(ruleObj.params[2]);
const unit = ruleObj.params[3] || 'seconds';

if (ruleObj.params[1].toLowerCase() === NOW) {
dateTime = moment();
dateTime = dayjs();
} else {
dateTime = moment(ruleObj.params[1], dateTimeInputFormat);
dateTime = dayjs(ruleObj.params[1], dateTimeInputFormat);
}

// Always start with a defaultMessage
Expand Down
14 changes: 10 additions & 4 deletions src/validators/date-time-before-or-equal.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
import always from 'ramda/src/always';
import moment from 'moment';
import dayjs from 'dayjs';
import isSameOrBefore from 'dayjs/plugin/isSameOrBefore';
import customParseFormat from 'dayjs/plugin/customParseFormat';

dayjs.extend(isSameOrBefore);
dayjs.extend(customParseFormat);


const fullName = 'dateTimeBeforeOrEqual:$1:$2:$3:$4';

Expand All @@ -18,14 +24,14 @@ const validate = (val, ruleObj) => {

let dateTime;
const dateTimeInputFormat = ruleObj.params[0];
const dateTimeInput = moment(val, dateTimeInputFormat);
const dateTimeInput = dayjs(val, dateTimeInputFormat);
let offset = Number(ruleObj.params[2]);
const unit = ruleObj.params[3] || 'seconds';

if (ruleObj.params[1].toLowerCase() === NOW) {
dateTime = moment();
dateTime = dayjs();
} else {
dateTime = moment(ruleObj.params[1], dateTimeInputFormat);
dateTime = dayjs(ruleObj.params[1], dateTimeInputFormat);
}

// Always start with a defaultMessage
Expand Down
11 changes: 7 additions & 4 deletions src/validators/date-time-before.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
import always from 'ramda/src/always';
import moment from 'moment';
import dayjs from 'dayjs';
import customParseFormat from 'dayjs/plugin/customParseFormat';

dayjs.extend(customParseFormat);

const fullName = 'dateTimeBefore:$1:$2:$3:$4';

Expand All @@ -18,14 +21,14 @@ const validate = (val, ruleObj) => {

let dateTime;
const dateTimeInputFormat = ruleObj.params[0];
const dateTimeInput = moment(val, dateTimeInputFormat);
const dateTimeInput = dayjs(val, dateTimeInputFormat);
let offset = Number(ruleObj.params[2]);
const unit = ruleObj.params[3] || 'seconds';

if (ruleObj.params[1].toLowerCase() === NOW) {
dateTime = moment();
dateTime = dayjs();
} else {
dateTime = moment(ruleObj.params[1], dateTimeInputFormat);
dateTime = dayjs(ruleObj.params[1], dateTimeInputFormat);
}

// Always start with a defaultMessage
Expand Down
4 changes: 2 additions & 2 deletions src/validators/date.js
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import moment from 'moment';
import dayjs from 'dayjs';

const fullName = 'date';

const validate = val => {
if (val) {
return moment(val).isValid();
return dayjs(val).isValid();
}

return true;
Expand Down
7 changes: 5 additions & 2 deletions src/validators/indonesia-id-card-number-birth-date.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
import moment from 'moment';
import dayjs from 'dayjs';
import customParseFormat from 'dayjs/plugin/customParseFormat';

dayjs.extend(customParseFormat);

const fullName = 'indonesiaIdCardNumberBirthDate:$1:$2';

Expand Down Expand Up @@ -27,7 +30,7 @@ const validate = (value, ruleObj, propertyName, inputObj) => {
const monthAndYearFromIdCard = String(value).substr(8, 4);
const birthDateInputKey = ruleObj.params[0];
const birthDateInputFormat = ruleObj.params[1];
const birthDateValue = moment(inputObj[birthDateInputKey], birthDateInputFormat).format('DDMMYY');
const birthDateValue = dayjs(inputObj[birthDateInputKey], birthDateInputFormat).format('DDMMYY');

return birthDateValue === `${birthDateFromIdCard}${monthAndYearFromIdCard}`;
};
Expand Down
Loading