} resourceInfo
- */
-export const setRelationsResource = (
- instance,
- relationName,
- resourceInfo
-) => {
- createGetter(
- instance,
- relationName,
- {
- resourceLink: resourceInfo[ 0 ].href,
- single: resourceInfo[ 0 ].single,
- }
- );
- if ( isUndefined( instance.getRelationResource ) ) {
- createCallbackGetter( instance,
- 'getRelationResource',
- getRelationResourceCallback
- );
- }
-};
-
-/**
- * Sets the internal save state to the given value when current state is
- * SAVE_STATE.clean otherwise current save state is retained.
- *
- * @param {Object} instance
- * @param {string} saveState Expected to be one of SAVE_STATE constant values.
- * @param {boolean} override Set to true when overriding the default logic for
- * setting state. When true, the saveState is set to whatever the incoming
- * saveState value is.
- */
-export const setSaveState = ( instance, saveState, override = false ) => {
- const currentState = instance[ PRIVATE_PROPERTIES.SAVE_STATE ];
- switch ( saveState ) {
- case SAVE_STATE.DIRTY:
- case SAVE_STATE.NEW:
- case SAVE_STATE.CLEAN:
- if ( override ) {
- instance[ PRIVATE_PROPERTIES.SAVE_STATE ] = saveState;
- break;
- }
- instance[ PRIVATE_PROPERTIES.SAVE_STATE ] =
- currentState === SAVE_STATE.CLEAN ?
- saveState :
- currentState;
- break;
- default:
- throw new InvalidArgument(
- 'Save state for entity can only be set to either ' +
- 'SAVE_STATE.DIRTY, SAVE_STATE.NEW or SAVE_STATE.CLEAN'
- );
- }
-};
-
-/**
- * Add the field name to the fieldToPersistOnInsert property on the instance
- * if it exists.
- *
- * @param {Object} instance
- * @param {string} fieldName
- */
-export const setFieldToPersist = ( instance, fieldName ) => {
- if ( instance.fieldsToPersistOnInsert ) {
- instance.fieldsToPersistOnInsert.add( fieldName );
- }
-};
diff --git a/assets/src/data/model/entity-factory/extractors.js b/assets/src/data/model/entity-factory/extractors.js
deleted file mode 100644
index 0edee7fe9e7..00000000000
--- a/assets/src/data/model/entity-factory/extractors.js
+++ /dev/null
@@ -1,390 +0,0 @@
-/**
- * External imports
- */
-import {
- isPlainObject,
- camelCase,
- last,
- pick,
- pickBy,
- isArray,
-} from 'lodash';
-import { instanceOf } from '@eventespresso/validators';
-
-/**
- * Internal imports
- */
-import {
- Money,
- SiteCurrency,
- ServerDateTime as DateTime,
-} from '@eventespresso/value-objects';
-
-import { pluralModelName } from '../model-names';
-
-import {
- hasRawProperty,
- hasPrettyProperty,
- hasRenderedProperty,
- isDateTimeField,
- isMoneyField,
- isPrimaryKeyField,
- isEntityField,
-} from './booleans';
-import { validateTypeForField } from './validators';
-import { VALIDATE_TYPE } from './constants';
-
-/**
- * This receives a field name, it's value and the schema and converts it to the
- * related value object IF the schema indicates it is of a type that there is a
- * known value object for.
- *
- * @param {string} fieldName
- * @param {*} fieldValue
- * @param {Object} schema
- * @return {DateTime|Money|*} If this is not a value object, the original field
- * value is returned.
- */
-export const maybeConvertToValueObject = ( fieldName, fieldValue, schema ) => {
- if (
- isDateTimeField( fieldName, schema ) &&
- ! DateTime.validateIsDateTime( fieldValue )
- ) {
- return DateTime.fromISO( fieldValue );
- }
- if (
- isMoneyField( fieldName, schema ) &&
- ! ( instanceOf( fieldValue, 'Money' ) )
- ) {
- return new Money( fieldValue, SiteCurrency );
- }
- // if more VOs get added, then instead of adding more if else blocks
- // to this function and the ones below, all VO logic should be extracted
- // into some kind of ValueObjectExtractor object that would hold all of
- // the necessary callbacks for managing the detection of VO fields and
- // conversion of data to and from the various VOs
- // plz see:
- // https://github.com/eventespresso/event-espresso-core/pull/637/files#r228690789
- return fieldValue;
-};
-
-/**
- * This converts the incoming value for a field to its equivalent "raw" value
- * from a value object if it is a value object. Otherwise it just returns the
- * original incoming value. This also asserts that if the provided field is
- * expected to be a value object that the incoming value IS a valid value object
- * and it is the expected instance of a value object.
- *
- * @param {string} fieldName
- * @param {*|Money|DateTime} fieldValue
- * @param {Object} schema
- * @return {string|number|*} If the value is not a value object, returns the
- * original value
- */
-export const maybeConvertFromValueObjectWithAssertions = (
- fieldName,
- fieldValue,
- schema
-) => {
- if ( isDateTimeField( fieldName, schema ) ) {
- DateTime.assertIsDateTime( fieldValue );
- fieldValue = fieldValue.toISO();
- } else if ( isMoneyField( fieldName, schema ) ) {
- Money.assertMoney( fieldValue );
- fieldValue = fieldValue.toNumber();
- }
- return fieldValue;
-};
-
-/**
- * This converts the incoming value for a field to its equivalent "raw" value
- * if the incoming value is a value object. Otherwise it just returns the
- * original incoming value.
- *
- * @param {*|DateTime|Money}fieldValue
- * @return {*} The raw value for the value object or the original value.
- */
-export const maybeConvertFromValueObject = ( fieldValue ) => {
- if ( DateTime.validateIsDateTime( fieldValue ) ) {
- fieldValue = fieldValue.toISO();
- } else if ( instanceOf( fieldValue, 'Money' ) ) {
- fieldValue = fieldValue.toNumber();
- }
- return fieldValue;
-};
-
-/**
- * This derives the "prepared" value for the given field and value.
- *
- * "Prepared" means:
- *
- * - converting to a value object if this is a field that there are defined
- * value objects for.
- * - retrieving the "raw" value from field values that have `raw` and `rendered`
- * or `pretty` properties.
- *
- * @param {string} fieldName
- * @param {*} fieldValue
- * @param {Object} instance
- * @return {DateTime|Money|*} Returns the original incoming value if it does
- * not have a raw equivalent or is not a value object.
- */
-export const derivePreparedValueForField = (
- fieldName,
- fieldValue,
- instance
-) => {
- const validationType = validateTypeForField( fieldName, instance );
- fieldValue = isPlainObject( fieldValue ) ?
- fieldValue[ validationType ] :
- fieldValue;
- return maybeConvertToValueObject( fieldName, fieldValue, instance.schema );
-};
-
-/**
- * This returns the "rendered" or "pretty" equivalent from a value if it exists
- * as a property on it.
- *
- * @param {*} value
- * @return {*} The original value is returned if its not a plain object or if
- * it has no `rendered` or `pretty` property. However, if it is a plain object
- * and has no pretty/rendered properties but DOES have a raw property, then that
- * is returned.
- */
-export const deriveRenderedValue = ( value ) => {
- if ( ! isPlainObject( value ) ) {
- return value;
- }
- value = hasPrettyProperty( value ) ? value.pretty : value;
- value = hasRenderedProperty( value ) ? value.rendered : value;
- return hasRawProperty( value ) ? value.raw : value;
-};
-
-/**
- * Returns the name of a resource from the given `resourceLink`.
- *
- * eg. "https://api.eventespresso.com/registration" will return 'registration';
-
- * @param {string} resourceLink
- * @return {string} Returns the name of the resource from a provided resource
- * link.
- */
-export const getRelationNameFromLink = ( resourceLink ) => {
- return pluralModelName( camelCase( last( resourceLink.split( '/' ) ) ) );
-};
-
-/**
- * Returns a plain object containing the entity field names and values from the
- * provided entity instance. The values are not prepared and match exactly what
- * is currently set on this entity.
- *
- * @param {BaseEntity} entityInstance
- *
- * @return {Object} A plain object
- */
-export const getBaseFieldsAndValuesForCloning = ( entityInstance ) => {
- return Object.keys( entityInstance ).reduce( (
- fieldsAndValues,
- fieldName
- ) => {
- if (
- isEntityField( fieldName, entityInstance.schema ) &&
- ! isPrimaryKeyField( fieldName, entityInstance.schema )
- ) {
- fieldsAndValues[ fieldName ] = entityInstance[ fieldName ];
- return fieldsAndValues;
- }
- return fieldsAndValues;
- }, {} );
-};
-
-/**
- * Returns a plain object containing the entity field name and values from the
- * provided entity instance
- * @param {Object} entityInstance
- * @param {boolean} forInsert Whether to return the fields and values for
- * insert or for update.
- * @return {Object} A plain object
- */
-export const getBaseFieldsAndValuesForPersisting = (
- entityInstance,
- forInsert = false
-) => {
- const iterator = forInsert ?
- Array.from( entityInstance.fieldsToPersistOnInsert.values() ) :
- Object.keys( entityInstance );
-
- return iterator.reduce( (
- fieldsAndValues,
- fieldName
- ) => {
- if (
- isEntityField( fieldName, entityInstance.schema ) &&
- ! isPrimaryKeyField( fieldName, entityInstance.schema )
- ) {
- fieldsAndValues[ fieldName ] = maybeConvertFromValueObject(
- entityInstance[ fieldName ],
- );
- return fieldsAndValues;
- }
- return fieldsAndValues;
- }, {} );
-};
-
-/**
- * Returns the primary key(s) and values for the given entityInstance
- *
- * @param {Object} entityInstance
- * @return {Object} an array of values for the primary keys.
- */
-export const getPrimaryKeyValues = ( entityInstance ) => pick(
- entityInstance,
- entityInstance.primaryKeys
-);
-
-/**
- * This returns a plain object of entity fields from the schema for the entity
- * instance (schema for fields are extracted as well).
- *
- * @param {Object} entityInstance
- * @return {Object} A plain object with fields and schema properties that are
- * entity properties.
- */
-export const getEntityFieldsFromSchema = ( entityInstance ) => pickBy(
- entityInstance.schema,
- ( fieldValue, fieldName ) => isEntityField(
- fieldName,
- entityInstance.schema
- )
-);
-
-/**
- * This returns a plain object of extracted primaryKey fields from the schema
- * for the entity instance.
- *
- * @param {Object} entityInstance
- * @return {Object} A plain object with fields and schema properties that
- * represent primary key fields.
- */
-export const getPrimaryKeyFieldsFromSchema = ( entityInstance ) => pickBy(
- entityInstance.schema,
- ( fieldValue, fieldName ) => isPrimaryKeyField(
- fieldName,
- entityInstance.schema
- )
-);
-
-/**
- * Derives the default value to use for a given type.
- *
- * @param {string} type
- * @return {*} A value to use for the given type.
- */
-export const deriveDefaultValueForType = ( type ) => {
- if ( isArray( type ) ) {
- return type.indexOf( 'null' ) > -1 ?
- null :
- deriveDefaultValueForType( type[ 0 ] );
- }
- switch ( type ) {
- case 'string':
- return '';
- case 'number':
- case 'integer':
- return 0;
- case 'null':
- case 'object':
- return null;
- case 'boolean':
- case 'bool':
- return false;
- case 'date-time':
- return ( new Date() ).toISOString();
- }
- return null;
-};
-
-/**
- * Derives what `type` a field is from the schema.
- * It accounts for cases where the "type" of a field might be `date-time` or
- * where the type is an object and thus the `type` for the purposes of model
- * entities is defined by the `raw` property for the field.
- *
- * @param {string} fieldName
- * @param {Object} schema
- * @return {*} What type the filed is.
- */
-export const deriveTypeForField = ( fieldName, schema ) => {
- if ( isDateTimeField( fieldName, schema ) ) {
- return 'date-time';
- }
- if ( schema[ fieldName ] && schema[ fieldName ].type ) {
- if ( schema[ fieldName ].type === 'object' ) {
- if (
- schema[ fieldName ].properties &&
- hasRawProperty( schema[ fieldName ].properties )
- ) {
- return schema[ fieldName ].properties.raw.type ?
- schema[ fieldName ].properties.raw.type :
- null;
- }
- return null;
- }
- return schema[ fieldName ].type;
- }
- return null;
-};
-
-/**
- * This derives the validate type from the incoming field and value according
- * to the schema and incoming value.
- *
- * This accounts for the fact that entities may be constructed from the
- * following contexts:
- *
- * 1. Authed REST response (which could have both raw, rendered or pretty
- * values in the field value).
- * 2. Non-authed REST response (which will not have a raw value, but could have
- * a pretty or rendered value). This is potentially problematic if the
- * rendered or pretty value is of a different data type than the raw value.
- * 3. New entities built client side, which will be assumed to be prepared
- * against the "raw" validate type.
- *
- * @param {string} fieldName
- * @param {*} fieldValue
- * @param {Object} schema
- * @return {Symbol} The validate type for the field.
- */
-export const deriveValidateTypeForField = ( fieldName, fieldValue, schema ) => {
- if ( hasRawProperty( fieldValue ) ) {
- return VALIDATE_TYPE.RAW;
- }
- if ( schema[ fieldName ] && schema[ fieldName ].type ) {
- if (
- schema[ fieldName ].type === 'object' &&
- isPlainObject( fieldValue )
- ) {
- return hasRenderedProperty( fieldValue ) ?
- VALIDATE_TYPE.RENDERED :
- VALIDATE_TYPE.PRETTY;
- }
- }
- return VALIDATE_TYPE.RAW;
-};
-
-/**
- * This gets the default value for a field from the provided schema.
- *
- * @param {string} fieldName
- * @param {Object} schema
- * @return {*} The default value for the field from the schema or if not
- * present in the schema, a derived default value from the schema type.
- */
-export const getDefaultValueForField = ( fieldName, schema ) => {
- if ( schema[ fieldName ] ) {
- return schema[ fieldName ].default ?
- schema[ fieldName ].default :
- deriveDefaultValueForType( schema[ fieldName ].type );
- }
- return null;
-};
diff --git a/assets/src/data/model/entity-factory/index.js b/assets/src/data/model/entity-factory/index.js
deleted file mode 100644
index 16c67abb856..00000000000
--- a/assets/src/data/model/entity-factory/index.js
+++ /dev/null
@@ -1,2 +0,0 @@
-export { default as createEntityFactory } from './base-entity';
-export { MODEL_PREFIXES, SAVE_STATE } from './constants';
diff --git a/assets/src/data/model/entity-factory/test/assertions.js b/assets/src/data/model/entity-factory/test/assertions.js
deleted file mode 100644
index 14a69a75c66..00000000000
--- a/assets/src/data/model/entity-factory/test/assertions.js
+++ /dev/null
@@ -1,405 +0,0 @@
-/**
- * External imports
- */
-import { InvalidDateTime, InvalidSchema } from '@eventespresso/eejs';
-import { DateTime, Money, SiteCurrency } from '@eventespresso/value-objects';
-import {
- EventSchema,
- RegistrationSchemaProperties,
- EventSchemaProperties,
-} from '@test/fixtures';
-
-/**
- * Internal imports
- */
-import {
- maybeAssertValueObject,
- assertValidSchema,
- assertValidSchemaFieldProperties,
- assertValidValueForPreparedField,
- assertValidFieldAndValueAgainstSchema,
-} from '../assertions';
-import { PRIVATE_PROPERTIES, VALIDATE_TYPE } from '../constants';
-
-describe( 'Testing assertions for model-entity factory.', () => {
- const getMockInstance = ( schema, validationType ) => {
- return {
- schema,
- [ PRIVATE_PROPERTIES.VALIDATE_TYPES ]: validationType,
- };
- };
- describe( 'maybeAssertValueObject()', () => {
- const assertTest = ( fieldName, fieldValue, schema ) => () =>
- maybeAssertValueObject( fieldName, fieldValue, schema );
- const tests = [
- [
- 'Does not throw exception for field not in schema',
- 'bogusField',
- 'bogusValue',
- EventSchemaProperties,
- null,
- ],
- [
- 'Throws InvalidDateTime error for datetime field with ' +
- 'invalid value.',
- 'EVT_visible_on',
- 'invalidDate',
- EventSchemaProperties,
- InvalidDateTime,
- ],
- [
- 'Throws TypeError error for money field with invalid value',
- 'REG_final_price',
- '24',
- RegistrationSchemaProperties,
- TypeError,
- ],
- [
- 'Does not throw exception for valid field that is not a ' +
- 'value object',
- 'EVT_desc',
- 'Some description',
- EventSchemaProperties,
- null,
- ],
- [
- 'Does not throw exception for datetime field with ' +
- 'valid DateTime value object as value',
- 'EVT_visible_on',
- DateTime.fromJSDate( new Date() ),
- EventSchemaProperties,
- null,
- ],
- [
- 'Does not throw exception for money field with ' +
- 'valid Money value object as value',
- 'REG_final_price',
- new Money( 1.25, SiteCurrency ),
- RegistrationSchemaProperties,
- null,
- ],
- ];
- tests.forEach( ( [
- description,
- fieldName,
- fieldValue,
- schema,
- expectedException,
- ] ) => {
- it( description, () => {
- if ( expectedException === null ) {
- expect( assertTest( fieldName, fieldValue, schema ) )
- .not.toThrow();
- } else {
- expect( assertTest( fieldName, fieldValue, schema ) )
- .toThrow( expectedException );
- }
- } );
- } );
- } );
- describe( 'assertValidSchema()', () => {
- const testRunner = ( schema ) => () => assertValidSchema( schema );
- it( 'Throws an error with invalid schema.', () => {
- expect( testRunner( {} ) ).toThrow( InvalidSchema );
- } );
- it( 'Does not throw an error with valid schema.', () => {
- expect( testRunner( EventSchema.schema ) ).not.toThrow();
- } );
- } );
- describe( 'assertValidSchemaFieldProperties()', () => {
- const assertTest = (
- modelName,
- fieldName,
- schema
- ) => () => assertValidSchemaFieldProperties(
- modelName,
- fieldName,
- schema
- );
- const tests = [
- [
- 'Throws TypeError for field not found in schema.',
- 'invalid_field',
- EventSchemaProperties,
- TypeError,
- ],
- [
- 'Throws InvalidSchema error for schema that has field in the ' +
- 'schema, but the type for that field is "object", and there ' +
- 'is no "properties" property in the schema.',
- 'EVT_desc',
- {
- EVT_desc: {
- type: 'object',
- },
- },
- InvalidSchema,
- ],
- [
- 'Throws InvalidSchema error for schema that has field in the ' +
- 'schema, but the type for that field is "object", and there ' +
- 'is no "properties.raw" property in the schema.',
- 'EVT_desc',
- {
- EVT_desc: {
- type: 'object',
- properties: {},
- },
- },
- InvalidSchema,
- ],
- [
- 'Throws InvalidSchema error for schema that has field in the ' +
- 'schema, but the type for that field is "object", and ' +
- 'although there is a "properties.raw" property in the schema, ' +
- 'the "raw" property does not have a "type" property defined.',
- 'EVT_desc',
- {
- EVT_desc: {
- type: 'object',
- properties: {
- raw: {},
- },
- },
- },
- InvalidSchema,
- ],
- [
- 'Does not throw any errors for a valid schema for the field',
- 'EVT_desc',
- EventSchemaProperties,
- null,
- ],
- ];
- tests.forEach( ( [
- description,
- fieldName,
- schema,
- expectedException,
- ] ) => {
- it( description, () => {
- if ( expectedException === null ) {
- expect( assertTest( 'Event', fieldName, schema ) )
- .not
- .toThrow();
- } else {
- expect( assertTest( 'Event', fieldName, schema ) )
- .toThrow( expectedException );
- }
- } );
- } );
- } );
- describe( 'assertValidValueForPreparedField()', () => {
- const assertTest = (
- fieldName,
- fieldValue,
- schema,
- validationType = VALIDATE_TYPE.RAW,
- ) => () => assertValidValueForPreparedField(
- fieldName,
- fieldValue,
- getMockInstance( schema, { [ fieldName ]: validationType } )
- );
- const tests = [
- [
- 'Throws a TypeError when a provided primitive value is not ' +
- 'of the correct type for the provided field.',
- 'EVT_name',
- 10,
- EventSchemaProperties,
- TypeError,
- ],
- [
- 'Throws an InvalidDateTime error when the provided value for ' +
- 'a DateTime field is not an instance of DateTime value object',
- 'EVT_visible_on',
- 'invalid datetime',
- EventSchemaProperties,
- InvalidDateTime,
- ],
- [
- 'Throws a TypeError when the provided value for a Money ' +
- 'field is not an instance of the Money value object',
- 'REG_final_price',
- 0,
- RegistrationSchemaProperties,
- TypeError,
- ],
- [
- 'Throws a TypeError when a provided primitive value on a ' +
- 'object type field does not match the expected type for the ' +
- 'raw property schema for that object',
- 'EVT_desc',
- 10,
- EventSchemaProperties,
- TypeError,
- ],
- [
- 'Does not throw an error when the provided primitive value ' +
- 'is of the correct type for the field.',
- 'EVT_name',
- 'Some title.',
- EventSchemaProperties,
- null,
- ],
- [
- 'Does not throw an error when the provided DateTime value ' +
- 'object is of the correct type for the field.',
- 'EVT_visible_on',
- DateTime.fromJSDate( new Date() ),
- EventSchemaProperties,
- null,
- ],
- [
- 'Does not throw an error when the provided Money value ' +
- 'object is of the correct type for the field.',
- 'REG_final_price',
- new Money( 0, SiteCurrency ),
- RegistrationSchemaProperties,
- null,
- ],
- [
- 'Does not throw an error when the provided primitive value ' +
- 'on an object type field does match the expected type for the ' +
- 'raw property schema for that object.',
- 'EVT_desc',
- 'Some description',
- EventSchemaProperties,
- null,
- ],
- ];
- tests.forEach( ( [
- description,
- fieldName,
- fieldValue,
- schema,
- expectedException,
- ] ) => {
- it( description, () => {
- if ( expectedException === null ) {
- expect( assertTest( fieldName, fieldValue, schema ) )
- .not
- .toThrow();
- } else {
- expect( assertTest( fieldName, fieldValue, schema ) )
- .toThrow( expectedException );
- }
- } );
- } );
- } );
- describe( 'assertValidFieldAndValueAgainstSchema()', () => {
- const assertTest = (
- modelName,
- fieldName,
- fieldValue,
- schema,
- validationType = VALIDATE_TYPE.RAW
- ) => () => {
- assertValidFieldAndValueAgainstSchema(
- modelName,
- fieldName,
- fieldValue,
- getMockInstance( schema, { [ fieldName ]: validationType } ),
- );
- };
- const tests = [
- [
- 'Throws a TypeError when a provided primitive value is not ' +
- 'of the correct type for the provided field.',
- 'Event',
- 'EVT_name',
- 10,
- EventSchemaProperties,
- TypeError,
- ],
- [
- 'Throws a TypeError when the provided value for ' +
- 'a DateTime field is not the correct type',
- 'Event',
- 'EVT_visible_on',
- 10,
- EventSchemaProperties,
- InvalidDateTime,
- ],
- [
- 'Throws a TypeError when the provided value for a Money ' +
- 'field is not the correct type',
- 'Registration',
- 'REG_final_price',
- 1.25,
- RegistrationSchemaProperties,
- TypeError,
- ],
- [
- 'Throws a TypeError when a provided primitive value on a ' +
- 'object type field does not match the expected type for the ' +
- 'raw property schema for that object',
- 'Event',
- 'EVT_desc',
- 'some description',
- EventSchemaProperties,
- TypeError,
- ],
- [
- 'Does not throw an error when the provided primitive value ' +
- 'is of the correct type for the field.',
- 'Event',
- 'EVT_name',
- 'Some title.',
- EventSchemaProperties,
- null,
- ],
- [
- 'Does not throw an error when the provided DateTime value ' +
- 'object is of the correct type for the field.',
- 'Event',
- 'EVT_visible_on',
- ( new Date() ).toISOString(),
- EventSchemaProperties,
- null,
- ],
- [
- 'Does not throw an error when the provided Money value ' +
- 'object is of the correct type for the field.',
- 'Registration',
- 'REG_final_price',
- { raw: 1.25 },
- RegistrationSchemaProperties,
- null,
- ],
- [
- 'Does not throw an error when the provided primitive value ' +
- 'on an object type field does match the expected type for the ' +
- 'raw property schema for that object.',
- 'Event',
- 'EVT_desc',
- { raw: 'some description' },
- EventSchemaProperties,
- null,
- ],
- ];
- tests.forEach( ( [
- description,
- modelName,
- fieldName,
- fieldValue,
- schema,
- expectedException,
- ] ) => {
- it( description, () => {
- if ( expectedException === null ) {
- expect(
- assertTest( modelName, fieldName, fieldValue, schema )
- )
- .not
- .toThrow();
- } else {
- expect(
- assertTest( modelName, fieldName, fieldValue, schema )
- )
- .toThrow( expectedException );
- }
- } );
- } );
- } );
-} );
diff --git a/assets/src/data/model/entity-factory/test/base-entity.js b/assets/src/data/model/entity-factory/test/base-entity.js
deleted file mode 100644
index c7eac1a1852..00000000000
--- a/assets/src/data/model/entity-factory/test/base-entity.js
+++ /dev/null
@@ -1,723 +0,0 @@
-/**
- * External imports
- */
-import { ServerDateTime } from '@eventespresso/value-objects';
-import { PRIVATE_PROPERTIES, SAVE_STATE } from '../constants';
-import { isCuid } from 'cuid';
-import { isArray } from 'lodash';
-import {
- EventSchema,
- EventResponse,
- PasswordProtectedEventResponse,
- DateTimeSchema,
- AuthedDateTimeResponse,
- AuthedEventResponse,
-} from '@test/fixtures';
-
-/**
- * Internal imports
- */
-import createEntityFactory from '../base-entity';
-
-describe( 'createEntityFactory()', () => {
- const EventFactory = createEntityFactory(
- 'event',
- EventSchema.schema,
- [ 'EVT' ]
- );
- const Event = EventFactory.classDef;
- const baseTests = ( event, allProperties ) => {
- it( 'returns instance of', () => {
- expect( event ).toBeInstanceOf( Event );
- } );
- it( 'has expected name for class', () => {
- expect( Event.name ).toBe( 'Event' );
- } );
- it( 'has expected enumerable properties', () => {
- expect( Object.keys( event ).sort() )
- .toEqual( enumerableProperties.sort() );
- } );
- it( 'has expected properties (enumerable and non-enumerable)', () => {
- expect( Object.getOwnPropertyNames( event ).sort() )
- .toEqual( allProperties.sort() );
- } );
- it( 'has expected Symbol properties', () => {
- expect( Object.getOwnPropertySymbols( event ) ).toEqual(
- [
- PRIVATE_PROPERTIES.SAVE_STATE,
- PRIVATE_PROPERTIES.VALIDATE_TYPES,
- ]
- );
- } );
- };
- const enumerableProperties = [
- 'EVT_ID',
- 'EVT_name',
- 'EVT_desc',
- 'EVT_slug',
- 'EVT_created',
- 'EVT_short_desc',
- 'EVT_modified',
- 'EVT_wp_user',
- 'parent',
- 'EVT_order',
- 'status',
- 'comment_status',
- 'ping_status',
- 'EVT_display_desc',
- 'EVT_display_ticket_selector',
- 'EVT_visible_on',
- 'EVT_additional_limit',
- 'EVT_default_registration_status',
- 'EVT_member_only',
- 'EVT_phone',
- 'EVT_allow_overflow',
- 'EVT_timezone_string',
- 'EVT_external_URL',
- 'EVT_donations',
- ];
- const nonEnumerableEntityProperties = [
- 'id',
- 'evtId',
- 'name',
- 'evtName',
- 'setEVT_name',
- 'nameRendered',
- 'desc',
- 'evtDesc',
- 'setEVT_desc',
- 'descRendered',
- 'slug',
- 'evtSlug',
- 'setEVT_slug',
- 'slugRendered',
- 'created',
- 'evtCreated',
- 'setEVT_created',
- 'createdRendered',
- 'shortDesc',
- 'evtShortDesc',
- 'setEVT_short_desc',
- 'shortDescRendered',
- 'modified',
- 'evtModified',
- 'setEVT_modified',
- 'modifiedRendered',
- 'wpUser',
- 'evtWpUser',
- 'setEVT_wp_user',
- 'wpUserRendered',
- 'setParent',
- 'parentRendered',
- 'order',
- 'evtOrder',
- 'setEVT_order',
- 'orderRendered',
- 'setStatus',
- 'statusRendered',
- 'commentStatus',
- 'setComment_status',
- 'commentStatusRendered',
- 'pingStatus',
- 'setPing_status',
- 'pingStatusRendered',
- 'displayDesc',
- 'evtDisplayDesc',
- 'setEVT_display_desc',
- 'displayDescRendered',
- 'displayTicketSelector',
- 'evtDisplayTicketSelector',
- 'setEVT_display_ticket_selector',
- 'displayTicketSelectorRendered',
- 'visibleOn',
- 'evtVisibleOn',
- 'setEVT_visible_on',
- 'visibleOnRendered',
- 'additionalLimit',
- 'evtAdditionalLimit',
- 'setEVT_additional_limit',
- 'additionalLimitRendered',
- 'defaultRegistrationStatus',
- 'evtDefaultRegistrationStatus',
- 'defaultRegistrationStatusRendered',
- 'setEVT_default_registration_status',
- 'memberOnly',
- 'evtMemberOnly',
- 'setEVT_member_only',
- 'memberOnlyRendered',
- 'phone',
- 'evtPhone',
- 'setEVT_phone',
- 'phoneRendered',
- 'allowOverflow',
- 'evtAllowOverflow',
- 'setEVT_allow_overflow',
- 'allowOverflowRendered',
- 'timezoneString',
- 'evtTimezoneString',
- 'setEVT_timezone_string',
- 'timezoneStringRendered',
- 'externalUrl',
- 'evtExternalUrl',
- 'setEVT_external_URL',
- 'externalUrlRendered',
- 'donations',
- 'evtDonations',
- 'setEVT_donations',
- 'donationsRendered',
- 'forClone',
- 'forUpdate',
- 'forInsert',
- 'forPersist',
- 'getRendered',
- 'primaryKey',
- 'primaryKeys',
- 'hasMultiplePrimaryKeys',
- 'fieldPrefixes',
- 'fieldsToPersistOnInsert',
- 'schema',
- 'modelName',
- 'originalFieldsAndValues',
- 'protectedFields',
- ];
- const calculatedFieldProperties = [
- 'hasCalculatedField',
- ];
- const resourceProperties = [
- 'link',
- 'resourceLink',
- 'collectionResourceLink',
- 'registrationsResource',
- 'datetimesResource',
- 'questionGroupsResource',
- 'venuesResource',
- 'termRelationshipsResource',
- 'termTaxonomiesResource',
- 'messageTemplateGroupsResource',
- 'attendeesResource',
- 'wpUsersResource',
- 'postMetasResource',
- 'extraMetasResource',
- 'changeLogsResource',
- 'peopleResource',
- 'personPostsResource',
- 'getRelations',
- 'getRelationResource',
- ];
- describe( 'creating new entity', () => {
- const props = {
- EVT_name: 'Some Event',
- EVT_desc: 'Some description',
- };
- const event = EventFactory.createNew( props );
- const allProperties = [
- ...enumerableProperties,
- ...nonEnumerableEntityProperties,
- ];
- baseTests( event, allProperties );
- describe( 'Test of expected values for props', () => {
- const testConditions = [
- [
- [ 'EVT_name', 'evtName', 'name', 'nameRendered' ],
- 'Some Event',
- ],
- [
- [ 'EVT_desc', 'desc', 'evtDesc', 'descRendered' ],
- 'Some description',
- ],
- [
- [ 'EVT_slug', 'evtSlug', 'slug', 'slugRendered' ],
- '',
- ],
- [
- [ 'EVT_wp_user', 'wpUser', 'evtWpUser', 'wpUserRendered' ],
- 1,
- ],
- [
- [ 'parent', 'parentRendered' ],
- 0,
- ],
- [
- [ 'status' ],
- 'draft',
- ],
- [
- [ 'statusRendered' ],
- 'Draft',
- ],
- [
- [
- 'EVT_display_ticket_selector',
- 'evtDisplayTicketSelector',
- 'displayTicketSelector',
- 'displayTicketSelectorRendered',
- ],
- true,
- ],
- [
- [
- 'EVT_default_registration_status',
- 'evtDefaultRegistrationStatus',
- 'defaultRegistrationStatus',
- ],
- 'RPP',
- ],
- [
- [ 'defaultRegistrationStatusRendered' ],
- 'PENDING_PAYMENT',
- ],
- ];
- testConditions.forEach( ( [
- propertiesToTest,
- expectedValue,
- ] ) => {
- propertiesToTest.forEach( ( propertyName ) => {
- it( 'event.' + propertyName + ' has expected value', () => {
- expect( event[ propertyName ] )
- .toEqual( expectedValue );
- } );
- } );
- } );
- describe( 'has expected value object for date time properties',
- () => {
- const testProperties = [
- 'EVT_visible_on',
- 'evtVisibleOn',
- 'visibleOn',
- ];
- testProperties.forEach( ( testProperty ) => {
- it( 'event.' + testProperty + ' is instance of ' +
- 'DateTime', () => {
- expect( event[ testProperty ] )
- .toBeInstanceOf( ServerDateTime );
- } );
- } );
- it( 'event.visibleOnRendered is a string and has ' +
- 'expected value', () => {
- expect( event.visibleOnRendered )
- .toBe( '2018-09-17T14:36:59' );
- } );
- } );
- describe( 'primary key property values are a cuid (and the same ' +
- 'cuid)', () => {
- const idProps = [ 'EVT_ID', 'id', 'evtId' ];
- const canonicalCuid = event.EVT_ID;
- idProps.forEach( ( idProp ) => {
- it( 'event.' + idProp + ' is a cuid', () => {
- expect( isCuid( event[ idProp ] ) ).toBe( true );
- } );
- it( 'event.' + idProp + ' is the same cuid for all ' +
- 'values', () => {
- expect( event[ idProp ] ).toBe( canonicalCuid );
- } );
- } );
- } );
- } );
- describe( 'Has instance getters', () => {
- const testConditions = [
- [
- 'saveState',
- SAVE_STATE.NEW,
- ],
- [
- 'isNew',
- true,
- ],
- [
- 'isDirty',
- false,
- ],
- [
- 'isClean',
- false,
- ],
- ];
- testConditions.forEach( ( [
- methodName,
- expectedValue,
- ] ) => {
- it( 'event.' + methodName + ' is defined', () => {
- expect( event[ methodName ] ).toBeDefined();
- } );
- it( 'event.' + methodName + ' returns expected value', () => {
- expect( event[ methodName ] ).toBe( expectedValue );
- } );
- } );
- } );
- } );
- describe( 'creating entity from rest response', () => {
- const allProperties = [
- ...enumerableProperties,
- ...nonEnumerableEntityProperties,
- ...calculatedFieldProperties,
- ...resourceProperties,
- ];
- const getExpectedValueForProp = (
- canonicalProp,
- expectedEventData
- ) => {
- let expectedValue;
- if ( isArray( canonicalProp ) ) {
- const [ property, subProp ] = canonicalProp;
- if ( subProp === 'date' ) {
- expectedValue = ServerDateTime.fromISO(
- expectedEventData[ property ]
- );
- } else {
- expectedValue = expectedEventData[ property ][ subProp ];
- }
- } else {
- expectedValue = expectedEventData[ canonicalProp ];
- }
- return expectedValue;
- };
- const testRuns = ( event, testConditions, eventResponse ) => {
- testConditions.forEach( ( [
- canonicalProp,
- propertiesToTest,
- ] ) => {
- const expectedValue = getExpectedValueForProp(
- canonicalProp,
- eventResponse
- );
- propertiesToTest.forEach( ( propertyName ) => {
- it( 'event.' + propertyName + ' has expected value', () => {
- expect( event[ propertyName ] )
- .toEqual( expectedValue );
- } );
- } );
- } );
- };
- describe( 'creating entity from non-authed rest response ' +
- '(fromExisting)', () => {
- describe( 'creating entity', () => {
- const event = EventFactory.fromExisting( EventResponse );
- baseTests( event, allProperties );
- describe( 'Test of expected values for props', () => {
- const testConditions = [
- [
- 'EVT_name',
- [ 'EVT_name', 'evtName', 'name', 'nameRendered' ],
- ],
- [
- [ 'EVT_desc', 'rendered' ],
- [ 'EVT_desc', 'desc', 'evtDesc', 'descRendered' ],
- ],
- [
- 'EVT_slug',
- [ 'EVT_slug', 'evtSlug', 'slug', 'slugRendered' ],
- ],
- [
- [ 'EVT_created', 'date' ],
- [
- 'EVT_created',
- 'evtCreated',
- 'created',
- ],
- ],
- [
- 'EVT_created',
- [ 'createdRendered' ],
- ],
- [
- 'EVT_wp_user',
- [
- 'EVT_wp_user',
- 'wpUser',
- 'evtWpUser',
- 'wpUserRendered',
- ],
- ],
- [
- [ 'status', 'raw' ],
- [ 'status' ],
- ],
- [
- [ 'status', 'pretty' ],
- [ 'statusRendered' ],
- ],
- [
- 'parent',
- [ 'parent', 'parentRendered' ],
- ],
- [
- 'EVT_display_ticket_selector',
- [
- 'EVT_display_ticket_selector',
- 'evtDisplayTicketSelector',
- 'displayTicketSelector',
- 'displayTicketSelectorRendered',
- ],
- ],
- [
- [ 'EVT_default_registration_status', 'raw' ],
- [
- 'EVT_default_registration_status',
- 'evtDefaultRegistrationStatus',
- 'defaultRegistrationStatus',
- ],
- ],
- [
- [ 'EVT_default_registration_status', 'pretty' ],
- [ 'defaultRegistrationStatusRendered' ],
- ],
- ];
- testRuns( event, testConditions, EventResponse );
- } );
- } );
- } );
- describe( 'creating entity from authed rest response (fromExisting)',
- () => {
- describe( 'creating entity', () => {
- const event = EventFactory.fromExisting(
- AuthedEventResponse
- );
- baseTests( event, allProperties );
- describe( 'Test of expected values for props', () => {
- const testConditions = [
- [
- 'EVT_name',
- [ 'EVT_name', 'evtName', 'name', 'nameRendered' ],
- ],
- [
- [ 'EVT_desc', 'raw' ],
- [ 'EVT_desc', 'desc', 'evtDesc' ],
- ],
- [
- [ 'EVT_desc', 'rendered' ],
- [ 'descRendered' ],
- ],
- [
- 'EVT_slug',
- [ 'EVT_slug', 'evtSlug', 'slug', 'slugRendered' ],
- ],
- [
- [ 'EVT_created', 'date' ],
- [
- 'EVT_created',
- 'evtCreated',
- 'created',
- ],
- ],
- [
- 'EVT_created',
- [ 'createdRendered' ],
- ],
- [
- 'EVT_wp_user',
- [
- 'EVT_wp_user',
- 'wpUser',
- 'evtWpUser',
- 'wpUserRendered',
- ],
- ],
- [
- [ 'status', 'raw' ],
- [ 'status' ],
- ],
- [
- [ 'status', 'pretty' ],
- [ 'statusRendered' ],
- ],
- [
- 'parent',
- [ 'parent', 'parentRendered' ],
- ],
- [
- 'EVT_display_ticket_selector',
- [
- 'EVT_display_ticket_selector',
- 'evtDisplayTicketSelector',
- 'displayTicketSelector',
- 'displayTicketSelectorRendered',
- ],
- ],
- [
- [ 'EVT_default_registration_status', 'raw' ],
- [
- 'EVT_default_registration_status',
- 'evtDefaultRegistrationStatus',
- 'defaultRegistrationStatus',
- ],
- ],
- [
- [ 'EVT_default_registration_status', 'pretty' ],
- [ 'defaultRegistrationStatusRendered' ],
- ],
- ];
- testRuns( event, testConditions, AuthedEventResponse );
- } );
- } );
- } );
- describe( 'creating entity from authed password protected rest response' +
- ' (fromExisting)', () => {
- describe( 'creating entity', () => {
- const event = EventFactory.fromExisting(
- PasswordProtectedEventResponse
- );
- baseTests( event, allProperties );
- it( 'has expected protected fields', () => {
- expect( event.protectedFields ).toEqual(
- [
- 'password',
- 'EVT_desc',
- 'EVT_short_desc',
- 'EVT_display_desc',
- 'EVT_display_ticket_selector',
- 'EVT_visible_on',
- 'EVT_additional_limit',
- 'EVT_default_registration_status',
- 'EVT_member_only',
- 'EVT_phone',
- 'EVT_allow_overflow',
- 'EVT_timezone_string',
- 'EVT_external_URL',
- 'EVT_donations',
- 'dummy_field',
- ]
- );
- } );
- it( 'isFieldPasswordProtected getter returns expected ' +
- 'value', () => {
- expect( event.isFieldPasswordProtected( 'EVT_desc' ) )
- .toBe( true );
- expect( event.isFieldPasswordProtected( 'invalid' ) )
- .toBe( false );
- } );
- it( 'returns expected value for `isPasswordProtected` ' +
- 'getter', () => {
- expect( event.isPasswordProtected ).toBe( true );
- } );
- } );
- } );
- } );
- describe( 'multiple key prefix handling', () => {
- const DateTimeFactory = createEntityFactory(
- 'datetime',
- DateTimeSchema.schema,
- [ 'DTT_EVT', 'DTT' ],
- );
- const DateTimeEntity = DateTimeFactory.fromExisting(
- AuthedDateTimeResponse
- );
- const testConditions = [
- 'DTT_ID',
- 'dttId',
- 'id',
- 'EVT_ID',
- 'evtId',
- 'DTT_EVT_start',
- 'dttEvtStart',
- 'evtStart',
- 'start',
- 'startRendered',
- 'soldRendered',
- ];
- testConditions.forEach( ( fieldName ) => {
- test( 'The ' + fieldName + ' field exists', () => {
- expect( DateTimeEntity[ fieldName ] ).toBeDefined();
- } );
- } );
- } );
- describe( 'forPersist returns expected values', () => {
- const factory = createEntityFactory(
- 'datetime',
- DateTimeSchema.schema,
- [ 'DTT_EVT', 'DTT' ]
- );
- it( 'returns expected values with nothing provided on new entity' +
- 'instantiation', () => {
- const entity = factory.createNew( {} );
- expect( entity.forPersist ).toEqual( {
- DTT_ID: entity.id,
- } );
- } );
- it( 'returns expected values with nothing provided on new entity ' +
- 'instantiation and setters used to set values', () => {
- const entity = factory.createNew( {} );
- entity.name = 'Test Datetime';
- expect( entity.forPersist ).toEqual(
- {
- DTT_ID: entity.id,
- DTT_name: 'Test Datetime',
- }
- );
- } );
- } );
- describe( 'clone property', () => {
- const factory = createEntityFactory(
- 'event',
- EventSchema.schema,
- [ 'EVT' ]
- );
- let entity;
- beforeEach( () => {
- entity = factory.fromExisting( EventResponse );
- } );
- afterEach( () => {
- entity = null;
- } );
- describe( 'not keeping id of original', () => {
- it( 'returns a new instance of BaseEntity', () => {
- const newEntity = entity.clone();
- expect( newEntity ).not.toBe( entity );
- } );
- it( 'returns a new instance that differs only in id', () => {
- const newEntity = entity.clone();
- expect( newEntity.forUpdate ).toEqual( entity.forUpdate );
- } );
- it( 'has state of new', () => {
- const newEntity = entity.clone();
- expect( newEntity.isNew ).toBe( true );
- } );
- it( 'primary key can be modified', () => {
- const newEntity = entity.clone();
- newEntity.id = 999;
- expect( newEntity.id ).toEqual( 999 );
- expect( newEntity.isNew ).toBe( true );
- } );
- } );
- describe( 'keeping id of original', () => {
- it( 'returns a new instance of BaseEntity', () => {
- const newEntity = entity.clone( true );
- expect( newEntity ).not.toBe( entity );
- } );
- it( 'returns a new instance that shares the same id as ' +
- 'original', () => {
- const newEntity = entity.clone( true );
- expect( newEntity.id ).toEqual( entity.id );
- } );
- it( 'has same state as original', () => {
- const newEntity = entity.clone( true );
- expect( newEntity.saveState ).toEqual( entity.saveState );
- expect( newEntity.isClean ).toBe( true );
- } );
- it( 'primary key can not be modified (when save state is not ' +
- 'new)', () => {
- const newEntity = entity.clone( true );
- newEntity.id = 999;
- expect( newEntity.id ).toEqual( entity.id );
- } );
- } );
- describe( 'memized factory behaviour on clone', () => {
- const dttFactory = createEntityFactory(
- 'datetime',
- DateTimeSchema.schema,
- [ 'DTT_EVT', 'DTT' ]
- );
- const dttEntity = dttFactory.fromExisting( AuthedDateTimeResponse );
- it( 'keeps different entity factories separate', () => {
- // first clone event entity to set the memized factory value.
- entity.clone();
- // next clone datetime entity
- const dateClone = dttEntity.clone( true );
- expect( dateClone.id ).toEqual( dttEntity.id );
-
- //clone event again
- const eventClone = entity.clone( true );
- expect( eventClone.id ).toEqual( entity.id );
- } );
- } );
- } );
-} );
diff --git a/assets/src/data/model/entity-factory/test/booleans.js b/assets/src/data/model/entity-factory/test/booleans.js
deleted file mode 100644
index 5a4ff0b687d..00000000000
--- a/assets/src/data/model/entity-factory/test/booleans.js
+++ /dev/null
@@ -1,297 +0,0 @@
-/**
- * Internal imports
- */
-import {
- hasRawProperty,
- hasPrettyProperty,
- hasRenderedProperty,
- hasFormatProperty,
- hasEnumProperty,
- isDateTimeField,
- isUTCDateTimeField,
- isPrimaryKeyField,
- isReadOnly,
- isEntityField,
- isMoneyField,
- isEnumField,
- isValueObjectField,
-} from '../booleans';
-
-/**
- * External Imports
- */
-import {
- EventSchemaProperties,
- RegistrationSchemaProperties,
-} from '@test/fixtures';
-
-describe( 'Testing boolean functions for model-entity factory.', () => {
- const testRunner = (
- testConditions,
- methodToTest,
- schema = EventSchemaProperties,
- ) => {
- testConditions.forEach( ( [
- description,
- fieldName,
- expectedResponse,
- withSchema = true,
- ] ) => {
- it( description, () => {
- if ( withSchema && schema !== null ) {
- expect( methodToTest( fieldName, schema ) )
- .toBe( expectedResponse );
- } else {
- expect( methodToTest( fieldName ) )
- .toBe( expectedResponse );
- }
- } );
- } );
- };
- describe( 'hasRawProperty()', () => {
- const tests = [
- [ 'Expect false for non object.', 'some string', false ],
- [ 'Expect false for object without raw property', {}, false ],
- [ 'Expect true for object with raw property', { raw: 0 }, true ],
- ];
- testRunner( tests, hasRawProperty, null );
- } );
- describe( 'hasPrettyProperty()', () => {
- const tests = [
- [ 'Expect false for non object.', 'some string', false ],
- [ 'Expect false for object without pretty property', {}, false ],
- [
- 'Expect true for object with pretty property',
- { pretty: 0 },
- true,
- ],
- ];
- testRunner( tests, hasPrettyProperty, null );
- } );
- describe( 'hasRenderedProperty()', () => {
- const tests = [
- [ 'Expect false for non object.', 'some string', false ],
- [ 'Expect false for object without rendered property', {}, false ],
- [
- 'Expect true for object with rendered property',
- { rendered: 0 },
- true,
- ],
- ];
- testRunner( tests, hasRenderedProperty, null );
- } );
- describe( 'hasFormatProperty()', () => {
- const tests = [
- [ 'Expect false for non object.', 'some string', false ],
- [ 'Expect false for object without format property', {}, false ],
- [
- 'Expect true for object with format property',
- { format: 0 },
- true,
- ],
- ];
- testRunner( tests, hasFormatProperty, null );
- } );
- describe( 'hasEnumProperty()', () => {
- const tests = [
- [ 'Expect false for non object.', 'some string', false ],
- [ 'Expect false for object without enum property', {}, false ],
- [
- 'Expect true for object with enum property',
- { enum: 0 },
- true,
- ],
- ];
- testRunner( tests, hasEnumProperty, null );
- } );
- describe( 'isDateTimeField', () => {
- const tests = [
- [ 'Expect false for non date-time field', 'EVT_desc', false ],
- [ 'Expect true for date-time field', 'EVT_visible_on', true ],
- [
- 'Expect false for field that does not exist in schema',
- 'invalid field',
- false,
- ],
- ];
- testRunner( tests, isDateTimeField );
- } );
- describe( 'isValueObjectField', () => {
- const tests = [
- [ 'Expect true for value object field', 'EVT_visible_on', true ],
- [ 'Expect false for non value object field', 'EVT_desc', false ],
- ];
- testRunner( tests, isValueObjectField );
- } );
- describe( 'isUTCDateTimeField()', () => {
- const tests = [
- [
- 'Expect false for non date-time field with schema',
- 'EVT_desc',
- false,
- true,
- ],
- [
- 'Expect false for non UTC date-time field with schema',
- 'EVT_visible_on',
- false,
- true,
- ],
- [
- 'Expect false for UTC-like field that is not in schema',
- 'some_field_gmt',
- false,
- true,
- ],
- [
- 'Expect false for non date-time field without schema',
- 'EVT_desc',
- false,
- false,
- ],
- [
- 'Expect false for non UTC date-time field without schema',
- 'EVT_visible_on',
- false,
- false,
- ],
- [
- 'Expect true for UTC-like field that is not a date-time ' +
- 'field without schema',
- 'some_field_gmt',
- true,
- false,
- ],
- [
- 'Expect true for UTC date-time field that is in schema.',
- 'EVT_visible_on_gmt',
- true,
- true,
- ],
- ];
- testRunner( tests, isUTCDateTimeField );
- } );
- describe( 'isPrimaryKeyField()', () => {
- const tests = [
- [
- 'Expect false for valid field that is not a primary key field',
- 'EVT_desc',
- false,
- ],
- [
- 'Expect false for field that does not exist in schema',
- 'some_field',
- false,
- ],
- [
- 'Expect true for field that is a primary key field',
- 'EVT_ID',
- true,
- ],
- ];
- testRunner( tests, isPrimaryKeyField );
- } );
- describe( 'isReadOnly()', () => {
- const tests = [
- [
- 'Expect false for valid field that is not a readonly field',
- 'EVT_desc',
- false,
- ],
- [
- 'Expect false for field that does not exist in schema',
- 'some_field',
- false,
- ],
- [
- 'Expect true for field that is a read only field',
- 'EVT_ID',
- true,
- ],
- ];
- testRunner( tests, isReadOnly );
- } );
- describe( 'isEntityField()', () => {
- const tests = [
- [
- 'Expect false for valid field that is not an entity field',
- 'registrations',
- false,
- ],
- [
- 'Expect false for field that does not exist in schema',
- 'some_field',
- false,
- ],
- [
- 'Expect true for primary key field',
- 'EVT_ID',
- true,
- ],
- [
- 'Expect true for field that is an entity field (non-primary key)',
- 'EVT_desc',
- true,
- ],
- ];
- testRunner( tests, isEntityField );
- } );
- describe( 'isMoneyField()', () => {
- const tests = [
- [
- 'Expect false for valid field that is not a money field',
- 'REG_ID',
- false,
- ],
- [
- 'Expect false for field that does not exist in schema',
- 'some_field',
- false,
- ],
- [
- 'Expect true for field that is a money field',
- 'REG_final_price',
- true,
- ],
- ];
- testRunner( tests, isMoneyField, RegistrationSchemaProperties );
- } );
- describe( 'isEnumField()', () => {
- const testSchema = {
- non_enum_field: {
- type: 'string',
- },
- enum_field: {
- type: 'string',
- enum: [ 'value1', 'value2' ],
- },
- empty_enum: {
- type: 'string',
- enum: [],
- },
- };
- const tests = [
- [
- 'Expect false for valid field that is not an enum field',
- 'non_enum_field',
- false,
- ],
- [
- 'Expect false for field that does not exist in schema',
- 'some_field',
- false,
- ],
- [
- 'Expect false for field that has an enum property but it is empty',
- 'empty_enum',
- false,
- ],
- [
- 'Expect true for field that is an enum field',
- 'enum_field',
- true,
- ],
- ];
- testRunner( tests, isEnumField, testSchema );
- } );
-} );
diff --git a/assets/src/data/model/entity-factory/test/create.js b/assets/src/data/model/entity-factory/test/create.js
deleted file mode 100644
index 854172b9241..00000000000
--- a/assets/src/data/model/entity-factory/test/create.js
+++ /dev/null
@@ -1,452 +0,0 @@
-/**
- * External imports
- */
-import { InvalidArgument } from '@eventespresso/eejs';
-
-/**
- * Internal Imports
- */
-import {
- createGetter,
- createCallbackGetter,
- createGetterAndSetter,
- createAliasGetterAndSetter,
- createFluentSetter,
- createRenderedGetters,
- createPrimaryKeyFieldGetters,
- setCalculatedFieldAndValues,
- setResources,
- setRelationsResource,
- setSaveState,
-} from '../create';
-
-import { PRIVATE_PROPERTIES, SAVE_STATE } from '../constants';
-
-describe( 'testing create functions for model-entity factory', () => {
- const mockInstance = class mockClass {};
- const getMockInstance = () => new mockInstance();
- describe( 'createGetter()', () => {
- describe( 'sets up new getter on provided instance', () => {
- const testInstance = getMockInstance();
- createGetter( testInstance, 'someField', 10 );
- it( 'has getter', () => {
- expect( testInstance.someField ).toBeDefined();
- } );
- it( 'returns expected value', () => {
- expect( testInstance.someField ).toEqual( 10 );
- } );
- } );
- } );
- describe( 'createCallbackGettter', () => {
- describe( 'sets up new getter that provided callback', () => {
- const testInstance = getMockInstance();
- const mockCallback = jest.fn().mockReturnValue( 10 );
- createCallbackGetter( testInstance, 'someTest', mockCallback );
- it( 'has getter', () => {
- expect( testInstance.someTest ).toBeDefined();
- } );
- it( 'invokes callback.', () => {
- expect( mockCallback ).toHaveBeenCalled();
- } );
- it( 'invokes callback with instance as argument', () => {
- expect( mockCallback ).toHaveBeenCalledWith( testInstance );
- } );
- it( 'returns expected value', () => {
- expect( testInstance.someTest ).toEqual( 10 );
- } );
- } );
- } );
- describe( 'createGetterAndSetter', () => {
- const testInstance = getMockInstance();
- testInstance.schema = { someProp: { type: 'number' } };
- createGetterAndSetter( testInstance, 'someProp', 10 );
- // initialize saveState
- testInstance[ PRIVATE_PROPERTIES.SAVE_STATE ] = SAVE_STATE.CLEAN;
- it( 'has getter', () => {
- expect( testInstance.someProp ).toBeDefined();
- } );
- it( 'returns initial set value', () => {
- expect( testInstance.someProp ).toEqual( 10 );
- } );
- describe( 'testing setting values', () => {
- it( 'throws TypeError for value that doesn\'t match type in ' +
- 'schema', () => {
- const setInvalidValue = () => testInstance.someProp = 'invalid';
- expect( setInvalidValue ).toThrow( TypeError );
- } );
- it( 'sets new value', () => {
- testInstance.someProp = 20;
- expect( testInstance.someProp ).toEqual( 20 );
- } );
- it( 'After setting, save state should be dirty', () => {
- expect( testInstance[ PRIVATE_PROPERTIES.SAVE_STATE ] ).toBe(
- SAVE_STATE.DIRTY
- );
- } );
- } );
- } );
- describe( 'createAliasGetterAndSetter()', () => {
- const testInstance = getMockInstance();
- testInstance.schema = { originalField: { type: 'number' } };
- createGetterAndSetter( testInstance, 'originalField', 42 );
- createAliasGetterAndSetter(
- testInstance,
- 'originalField',
- 'aliasField'
- );
- it( 'has expected getter', () => {
- expect( testInstance.aliasField ).toBeDefined();
- } );
- it( 'returns expected value for initial creation', () => {
- expect( testInstance.aliasField ).toEqual( 42 );
- } );
- describe( 'testing setting new value', () => {
- it( 'throws TypeError for value that doesn\'t match type in ' +
- 'schema', () => {
- const setInvalidValue = () =>
- testInstance.aliasField = 'invalid';
- expect( setInvalidValue ).toThrow( TypeError );
- } );
- it( 'sets new value on original prop', () => {
- testInstance.aliasField = 20;
- expect( testInstance.originalField ).toEqual( 20 );
- } );
- it( 'sets new value on alias prop', () => {
- expect( testInstance.aliasField ).toEqual( 20 );
- } );
- } );
- } );
- describe( 'createFluentSetter()', () => {
- const testInstance = getMockInstance();
- testInstance.schema = { someProp: { type: 'number' } };
- createGetterAndSetter( testInstance, 'someProp', 42 );
- createFluentSetter( testInstance, 'someProp' );
- it( 'has expected getter', () => {
- expect( testInstance.setSomeProp ).toBeDefined();
- } );
- describe( 'testing setting new value', () => {
- const returnedInstance = testInstance.setSomeProp( 20 );
- it( 'throws TypeError for value that doesn\'t match type in ' +
- 'schem', () => {
- const setInvalidValue = () =>
- testInstance.setSomeProp( 'invalid' );
- expect( setInvalidValue ).toThrow( TypeError );
- } );
- it( 'sets new value on prop', () => {
- expect( testInstance.someProp ).toEqual( 20 );
- } );
- it( 'returns expected instance', () => {
- expect( returnedInstance ).toBe( testInstance );
- } );
- } );
- } );
- describe( 'createRenderedGetters()', () => {
- const testInstance = getMockInstance();
- testInstance.fieldPrefixes = [];
- createRenderedGetters( testInstance, 'someProp', 42 );
- it( 'has field getter', () => {
- expect( testInstance.somePropRendered ).toBeDefined();
- } );
- it( 'returns expected value using field getter', () => {
- expect( testInstance.somePropRendered ).toEqual( 42 );
- } );
- it( 'has general `getRendered` getter', () => {
- expect( testInstance.getRendered ).toBeDefined();
- } );
- it( 'has expected value using general `getRendered` getter', () => {
- expect( testInstance.getRendered( 'someProp' ) )
- .toEqual( 42 );
- } );
- it( 'does not error when attempting to create a new ' +
- 'renderedGetter', () => {
- expect(
- () => createRenderedGetters( testInstance, 'someOtherProp', 35 )
- ).not.toThrow();
- } );
- } );
- describe( 'createPrimaryKeyFieldGetters()', () => {
- const testSingleKeyInstance = getMockInstance();
- const testMultiKeyInstance = getMockInstance();
- testSingleKeyInstance.schema = {
- pk: { primary_key: true, type: 'number' },
- };
- testMultiKeyInstance.schema = {
- pk1: { primary_key: true, type: 'string' },
- pk2: { primary_key: true, type: 'string' },
- };
- describe( 'expected single primary key results', () => {
- const executeMethod = ( keys ) =>
- createPrimaryKeyFieldGetters( testSingleKeyInstance, keys );
- it( 'does nothing if primaryKeys argument is not an array', () => {
- executeMethod( 'invalid' );
- expect( testSingleKeyInstance.pk ).not.toBeDefined();
- } );
- describe( 'has expected getters and setters', () => {
- executeMethod( [ 'pk' ] );
- describe( 'instance.primaryKey', () => {
- it( 'is set', () => {
- expect( testSingleKeyInstance.primaryKey ).toBeDefined();
- } );
- it( 'has expected value', () => {
- expect( testSingleKeyInstance.primaryKey ).toBe( 'pk' );
- } );
- } );
- describe( 'instance.primaryKeys', () => {
- it( 'is set', () => {
- expect( testSingleKeyInstance.primaryKeys )
- .toBeDefined();
- } );
- it( 'has expected value', () => {
- expect( testSingleKeyInstance.primaryKeys )
- .toEqual( [ 'pk' ] );
- } );
- } );
- describe( 'instance.hasMultiplePrimaryKeys', () => {
- it( 'is set', () => {
- expect( testSingleKeyInstance.hasMultiplePrimaryKeys )
- .toBeDefined();
- } );
- it( 'has expected value', () => {
- expect( testSingleKeyInstance.hasMultiplePrimaryKeys )
- .toBe( false );
- } );
- } );
- } );
- } );
- describe( 'expected multiple primary key results', () => {
- createPrimaryKeyFieldGetters(
- testMultiKeyInstance,
- [ 'pk1', 'pk2' ]
- );
- describe( 'has expected getters and setters', () => {
- describe( 'instance.primaryKey', () => {
- it( 'is set', () => {
- expect( testMultiKeyInstance.primaryKey ).toBeDefined();
- } );
- it( 'has expected value', () => {
- expect( testMultiKeyInstance.primaryKey ).toBe( 'pk1' );
- } );
- } );
- describe( 'instance.primaryKeys', () => {
- it( 'is set', () => {
- expect( testMultiKeyInstance.primaryKeys )
- .toBeDefined();
- } );
- it( 'has expected value', () => {
- expect( testMultiKeyInstance.primaryKeys )
- .toEqual( [ 'pk1', 'pk2' ] );
- } );
- } );
- describe( 'instance.hasMultiplePrimaryKeys', () => {
- it( 'is set', () => {
- expect( testMultiKeyInstance.hasMultiplePrimaryKeys )
- .toBeDefined();
- } );
- it( 'has expected value', () => {
- expect( testMultiKeyInstance.hasMultiplePrimaryKeys )
- .toBe( true );
- } );
- } );
- } );
- } );
- } );
- describe( 'setCalculatedFieldAndValues()', () => {
- const testInstance = getMockInstance();
- const calculatedFieldsAndValues = {
- registration_count: 10,
- };
- setCalculatedFieldAndValues( testInstance, calculatedFieldsAndValues );
- describe( 'creates individual field getters', () => {
- it( 'has getter', () => {
- expect( testInstance.registrationCount ).toBeDefined();
- } );
- it( 'has expected value for getter', () => {
- expect( testInstance.registrationCount ).toEqual( 10 );
- } );
- } );
- describe( 'creates hasCalculatedField method', () => {
- it( 'has method', () => {
- expect( testInstance.hasCalculatedField ).toBeDefined();
- } );
- it( 'has expected value when called with known calculated field',
- () => {
- expect(
- testInstance.hasCalculatedField( 'registrationCount' )
- ).toBe( true );
- } );
- it( 'has expected value when called for a calculated field that ' +
- 'does not exist', () => {
- expect( testInstance.hasCalculatedField( 'nothere' ) )
- .toBe( false );
- } );
- } );
- } );
- describe( 'setResources()', () => {
- const testInstance = getMockInstance();
- const resources = {
- self: [
- { href: 'self link' },
- ],
- collection: [
- { href: 'collection link' },
- ],
- 'https://api.eventespresso.com/event': [
- { href: 'event relation', single: true },
- ],
- 'https://api.eventespresso.com/transaction': [
- { href: 'transaction relation', single: true },
- ],
- };
- setResources( testInstance, resources );
- describe( 'set expected resourceLink getter', () => {
- it( 'is created', () => {
- expect( testInstance.resourceLink ).toBeDefined();
- } );
- it( 'has expected value', () => {
- expect( testInstance.resourceLink ).toEqual( 'self link' );
- } );
- } );
- describe( 'set expected collectionResourceLinkGetter', () => {
- it( 'is created', () => {
- expect( testInstance.collectionResourceLink ).toBeDefined();
- } );
- it( 'has expected value', () => {
- expect( testInstance.collectionResourceLink )
- .toEqual( 'collection link' );
- } );
- } );
- describe( 'relation resource properties are as expected', () => {
- it( 'has expected properties', () => {
- expect( testInstance.eventsResource ).toBeDefined();
- expect( testInstance.transactionsResource ).toBeDefined();
- } );
- } );
- describe( 'getRelations getter is defined and has expected value',
- () => {
- it( 'is created', () => {
- expect( testInstance.getRelations ).toBeDefined();
- } );
- it( 'has expected value', () => {
- expect( testInstance.getRelations ).toEqual(
- [ 'events', 'transactions' ]
- );
- } );
- } );
- } );
- describe( 'setRelationsResource()', () => {
- const testInstance = getMockInstance();
- const relationsResourceInfo = [
- { href: 'resource link', single: true },
- ];
- setRelationsResource( testInstance, 'relation', relationsResourceInfo );
- describe( 'creates expected relation property getter', () => {
- it( 'has property created', () => {
- expect( testInstance.relation ).toBeDefined();
- } );
- it( 'has expected value for property', () => {
- expect( testInstance.relation )
- .toEqual( {
- resourceLink: 'resource link',
- single: true,
- } );
- } );
- } );
- describe( 'creates expected getRelationResource property', () => {
- it( 'has been created', () => {
- expect( testInstance.getRelationResource ).toBeDefined();
- } );
- it( 'returns expected value for known resource', () => {
- expect( testInstance.getRelationResource( 'relation' ) )
- .toEqual(
- {
- resourceLink: 'resource link',
- single: true,
- }
- );
- } );
- it( 'returns expected value for non valid resource', () => {
- expect( testInstance.getRelationResource( 'invalid' ) )
- .not.toBeDefined();
- } );
- } );
- } );
- describe( 'setSaveState()', () => {
- const testInstance = getMockInstance();
- describe( 'when current state is clean', () => {
- beforeEach( () => {
- testInstance[ PRIVATE_PROPERTIES.SAVE_STATE ] =
- SAVE_STATE.CLEAN;
- } );
- const testConditions = [
- [ 'dirty', SAVE_STATE.DIRTY, SAVE_STATE.DIRTY ],
- [ 'new', SAVE_STATE.NEW, SAVE_STATE.NEW ],
- [ 'clean', SAVE_STATE.CLEAN, SAVE_STATE.CLEAN ],
- ];
- testConditions.forEach( ( [
- description,
- stateToSet,
- expectedState,
- ] ) => {
- it( 'returns expected value for setting ' + description +
- ' state', () => {
- setSaveState( testInstance, stateToSet );
- expect( testInstance[ PRIVATE_PROPERTIES.SAVE_STATE ] )
- .toEqual( expectedState );
- } );
- } );
- } );
- describe( 'when current state is dirty', () => {
- beforeEach( () => {
- testInstance[ PRIVATE_PROPERTIES.SAVE_STATE ] =
- SAVE_STATE.DIRTY;
- } );
- const testConditions = [
- [ 'dirty', SAVE_STATE.DIRTY, SAVE_STATE.DIRTY ],
- [ 'new', SAVE_STATE.NEW, SAVE_STATE.DIRTY ],
- [ 'clean', SAVE_STATE.CLEAN, SAVE_STATE.DIRTY ],
- ];
- testConditions.forEach( ( [
- description,
- stateToSet,
- expectedState,
- ] ) => {
- it( 'returns expected value for setting ' + description +
- ' state', () => {
- setSaveState( testInstance, stateToSet );
- expect( testInstance[ PRIVATE_PROPERTIES.SAVE_STATE ] )
- .toEqual( expectedState );
- } );
- } );
- } );
- describe( 'when current state is new', () => {
- beforeEach( () => {
- testInstance[ PRIVATE_PROPERTIES.SAVE_STATE ] =
- SAVE_STATE.NEW;
- } );
- const testConditions = [
- [ 'dirty', SAVE_STATE.DIRTY, SAVE_STATE.NEW ],
- [ 'new', SAVE_STATE.NEW, SAVE_STATE.NEW ],
- [ 'clean', SAVE_STATE.CLEAN, SAVE_STATE.NEW ],
- ];
- testConditions.forEach( ( [
- description,
- stateToSet,
- expectedState,
- ] ) => {
- it( 'returns expected value for setting ' + description +
- ' state', () => {
- setSaveState( testInstance, stateToSet );
- expect( testInstance[ PRIVATE_PROPERTIES.SAVE_STATE ] )
- .toEqual( expectedState );
- } );
- } );
- } );
- describe( 'when provided state is an invalid state', () => {
- it( 'throws InvalidArgument', () => {
- expect(
- () => setSaveState( testInstance, 'invalid' )
- ).toThrow( InvalidArgument );
- } );
- } );
- } );
-} );
diff --git a/assets/src/data/model/entity-factory/test/extractors.js b/assets/src/data/model/entity-factory/test/extractors.js
deleted file mode 100644
index 6cda6f0f1c2..00000000000
--- a/assets/src/data/model/entity-factory/test/extractors.js
+++ /dev/null
@@ -1,399 +0,0 @@
-/**
- * External imports
- */
-import { InvalidDateTime } from '@eventespresso/eejs';
-import { DateTime, Money, SiteCurrency } from '@eventespresso/value-objects';
-import {
- EventSchemaProperties,
- RegistrationSchemaProperties,
-} from '@test/fixtures';
-
-/**
- * Internal imports
- */
-import {
- maybeConvertToValueObject,
- maybeConvertFromValueObject,
- maybeConvertFromValueObjectWithAssertions,
- derivePreparedValueForField,
- deriveRenderedValue,
- getRelationNameFromLink,
- deriveDefaultValueForType,
- deriveTypeForField,
- getDefaultValueForField,
- deriveValidateTypeForField,
-} from '../extractors';
-import { PRIVATE_PROPERTIES, VALIDATE_TYPE } from '../constants';
-
-describe( 'Testing extractor functions for model-entity factory.', () => {
- const getMockInstance = ( schema, validationTypes = {} ) => {
- return {
- schema,
- [ PRIVATE_PROPERTIES.VALIDATE_TYPES ]: validationTypes,
- };
- };
- describe( 'maybeConvertToValueObject()', () => {
- it( 'Converts a given string to a DateTime value object for a ' +
- 'datetime field', () => {
- expect( maybeConvertToValueObject(
- 'EVT_visible_on',
- ( new Date() ).toISOString(),
- EventSchemaProperties
- ) ).toBeInstanceOf( DateTime );
- } );
- it( 'Converts a given number to a Money value object for a money field',
- () => {
- expect( maybeConvertToValueObject(
- 'REG_final_price',
- 1.25,
- RegistrationSchemaProperties
- ) ).toBeInstanceOf( Money );
- } );
- it( 'Leaves value alone for a field that is not a value object field',
- () => {
- expect( maybeConvertToValueObject(
- 'EVT_name',
- 'Some title',
- EventSchemaProperties
- ) ).toBe( 'Some title' );
- } );
- } );
- describe( 'maybeConvertFromValueObjectWithAssertions()', () => {
- const testThrows = ( fieldName, fieldValue, schema ) => () =>
- maybeConvertFromValueObjectWithAssertions(
- fieldName,
- fieldValue,
- schema
- );
- it( 'Throws an exception when the provided value is not a DateTime ' +
- 'value object for a date-time field.', () => {
- expect( testThrows(
- 'EVT_visible_on',
- 'invalid date',
- EventSchemaProperties
- ) ).toThrow( InvalidDateTime );
- } );
- it( 'Throws an exception when the provided value is not a Money ' +
- 'value object for a money field.', () => {
- expect( testThrows(
- 'REG_final_price',
- 0,
- RegistrationSchemaProperties
- ) ).toThrow( TypeError );
- } );
- it( 'Returns expected value when the provided value is a DateTime ' +
- 'value object for a date-time field.', () => {
- const testDate = DateTime.fromJSDate( new Date() );
- expect( maybeConvertFromValueObjectWithAssertions(
- 'EVT_visible_on',
- testDate,
- EventSchemaProperties
- ) ).toEqual( testDate.toISO() );
- } );
- it( 'Returns expected value when the provided value is a Money ' +
- 'value object for a money field.', () => {
- const testMoney = new Money( 1.25, SiteCurrency );
- expect( maybeConvertFromValueObjectWithAssertions(
- 'REG_final_price',
- testMoney,
- RegistrationSchemaProperties
- ) ).toEqual( testMoney.toNumber() );
- } );
- it( 'Returns expected value when the provided value is not expected ' +
- 'to be a value object per the provided field\'s schema', () => {
- expect( maybeConvertFromValueObjectWithAssertions(
- 'EVT_name',
- 'Some title',
- EventSchemaProperties
- ) ).toEqual( 'Some title' );
- } );
- } );
- describe( 'maybeConvertFromValueObject()', () => {
- const testDate = DateTime.fromJSDate( new Date() );
- const testMoney = new Money( 1.25, SiteCurrency );
- const tests = [
- [
- 'It returns the expected value for converting a DateTime ' +
- 'object.',
- testDate,
- testDate.toISO(),
- ],
- [
- 'It returns the expected value for converting a Money ' +
- 'object.',
- testMoney,
- testMoney.toNumber(),
- ],
- [
- 'It returns the expected value for a non value object.',
- 'some value',
- 'some value',
- ],
- ];
- tests.forEach( ( [ description, testValue, expectedValue ] ) => {
- it( description, () => {
- expect( maybeConvertFromValueObject( testValue ) )
- .toEqual( expectedValue );
- } );
- } );
- } );
- describe( 'derivePreparedValueForField', () => {
- it( 'returns a DateTime value object for a date-time value', () => {
- expect( derivePreparedValueForField(
- 'EVT_visible_on',
- ( new Date() ).toISOString(),
- getMockInstance( EventSchemaProperties )
- ) ).toBeInstanceOf( DateTime );
- } );
- it( 'returns a Money object for a money value', () => {
- expect( derivePreparedValueForField(
- 'REG_final_price',
- { raw: 1.25 },
- getMockInstance( RegistrationSchemaProperties )
- ) ).toBeInstanceOf( Money );
- } );
- it( 'returns just the value for a non value object', () => {
- expect( derivePreparedValueForField(
- 'EVT_desc',
- { raw: 'Some description' },
- getMockInstance( EventSchemaProperties )
- ) ).toEqual( 'Some description' );
- } );
- } );
- describe( 'deriveRenderedValue()', () => {
- describe( 'returns the incoming value if it\'s not a plain object when',
- () => {
- it( 'is a primitive', () => {
- expect( deriveRenderedValue( 10 ) ).toBe( 10 );
- } );
- it( 'is a complex object (i.e. value object)', () => {
- expect( deriveRenderedValue(
- DateTime.fromJSDate( new Date() )
- ) ).toBeInstanceOf( DateTime );
- } );
- } );
- describe( 'It returns expected value depending on contents of plain' +
- ' object when', () => {
- const testConditions = [
- [
- 'it has a pretty property',
- {
- pretty: 'I am pretty',
- rendered: 'I am rendered',
- raw: 'I am raw',
- },
- 'I am pretty',
- ],
- [
- 'it does not have a pretty property but has a rendered ' +
- 'property',
- {
- rendered: 'I am rendered',
- raw: 'I am raw',
- },
- 'I am rendered',
- ],
- [
- 'it does not have pretty or rendered properties but has ' +
- 'a raw property',
- { raw: 'I am raw' },
- 'I am raw',
- ],
- [
- 'it does not have pretty, rendered or raw properties',
- { random: 'I am random' },
- { random: 'I am random' },
- ],
- ];
- testConditions.forEach( ( [
- description,
- testValue,
- expectedValue,
- ] ) => {
- it( description, () => {
- expect( deriveRenderedValue( testValue ) )
- .toEqual( expectedValue );
- } );
- } );
- } );
- } );
- describe( 'getRelationNameFromLink()', () => {
- it( 'returns a relation name from a given formatted link', () => {
- expect( getRelationNameFromLink(
- 'https://api.eventespresso.com/registration'
- ) ).toBe( 'registrations' );
- expect( getRelationNameFromLink(
- 'https://api.eventespresso.com/some_test_relation'
- ) ).toBe( 'someTestRelations' );
- } );
- } );
- describe( 'deriveDefaultValueForType()', () => {
- const testConditions = [
- [
- 'type is an array and it contains null',
- [ 'string', 'null' ],
- null,
- ],
- [
- 'type is an array and it does not contain null',
- [ 'string', 'number' ],
- '',
- ],
- [
- 'type is string',
- 'string',
- '',
- ],
- [
- 'type is number',
- 'number',
- 0,
- ],
- [
- 'type is integer',
- 'integer',
- 0,
- ],
- [
- 'type is null',
- 'null',
- null,
- ],
- [
- 'type is object',
- 'object',
- null,
- ],
- [
- 'type is boolean',
- 'boolean',
- false,
- ],
- [
- 'type is bool',
- 'bool',
- false,
- ],
- ];
- testConditions.forEach( ( [
- description,
- testType,
- expectedValue,
- ] ) => {
- it( description, () => {
- expect( deriveDefaultValueForType( testType ) )
- .toEqual( expectedValue );
- } );
- } );
- it( 'type is date-time', () => {
- const derivedValue = deriveDefaultValueForType( 'date-time' );
- expect( DateTime.validateISO8601( derivedValue ) ).toBe( true );
- } );
- } );
- describe( 'deriveTypeForField()', () => {
- const testConditions = [
- [
- 'it returns date-time for DateTime fields',
- 'EVT_visible_on',
- 'date-time',
- ],
- [
- 'it returns the expected type for a field that has `raw`' +
- ' property',
- 'EVT_desc',
- 'string',
- ],
- [
- 'it returns the expected type for a field that is not an object' +
- 'type (and thus no raw property)',
- 'EVT_name',
- 'string',
- ],
- ];
- testConditions.forEach( ( [
- description,
- fieldName,
- expectedValue,
- ] ) => {
- it( description, () => {
- expect( deriveTypeForField( fieldName, EventSchemaProperties ) )
- .toEqual( expectedValue );
- } );
- } );
- } );
- describe( 'getDefaultValueForField', () => {
- it( 'returns expected default value for field type', () => {
- expect( getDefaultValueForField(
- 'EVT_desc',
- EventSchemaProperties
- ) ).toEqual( { raw: '', rendered: '' } );
- expect( getDefaultValueForField(
- 'REG_final_price',
- RegistrationSchemaProperties
- ) ).toEqual( {
- pretty: '$0.00 (USD)',
- raw: 0,
- } );
- const dateValue = getDefaultValueForField(
- 'EVT_visible_on',
- EventSchemaProperties
- );
- expect( DateTime.validateISO8601( dateValue ) ).toBe( true );
- } );
- } );
- describe( 'deriveValidateTypeForField', () => {
- const testConditions = [
- [
- 'returns raw when field value has a raw property',
- 'EVT_desc',
- { raw: 'Some description' },
- EventSchemaProperties,
- VALIDATE_TYPE.RAW,
- ],
- [
- 'returns rendered when field value has a rendered property',
- 'EVT_desc',
- { rendered: 'Some description' },
- EventSchemaProperties,
- VALIDATE_TYPE.RENDERED,
- ],
- [
- 'returns pretty when field value has pretty property',
- 'status',
- { pretty: 'some status' },
- EventSchemaProperties,
- VALIDATE_TYPE.PRETTY,
- ],
- [
- 'returns raw when field value is not an object and schema ' +
- 'type is not an object',
- 'EVT_name',
- 'Some Event',
- EventSchemaProperties,
- VALIDATE_TYPE.RAW,
- ],
- [
- 'returns raw when fieldname does not exist in schema',
- 'invalid',
- 'invalid',
- EventSchemaProperties,
- VALIDATE_TYPE.RAW,
- ],
- ];
- testConditions.forEach( ( [
- description,
- fieldName,
- fieldValue,
- schema,
- expectedType,
- ] ) => {
- it( description, () => {
- expect( deriveValidateTypeForField(
- fieldName,
- fieldValue,
- schema
- ) ).toEqual( expectedType );
- } );
- } );
- } );
-} );
diff --git a/assets/src/data/model/entity-factory/test/validators.js b/assets/src/data/model/entity-factory/test/validators.js
deleted file mode 100644
index b7d24a37836..00000000000
--- a/assets/src/data/model/entity-factory/test/validators.js
+++ /dev/null
@@ -1,322 +0,0 @@
-/**
- * External imports
- */
-import { DateTime, Money, SiteCurrency } from '@eventespresso/value-objects';
-import { InvalidDateTime } from '@eventespresso/eejs';
-import {
- EventSchemaProperties,
- RegistrationSchemaProperties,
-} from '@test/fixtures';
-
-/**
- * Internal Imports
- */
-import {
- validateType,
- validateEnumType,
- isShallowValidValueForField,
-} from '../validators';
-
-describe( 'Testing validator functions for model-entity factory', () => {
- describe( 'validateType()', () => {
- const testConditions = [
- [
- 'returns false for invalid integer',
- 'integer',
- 1.26,
- false,
- ],
- [
- 'returns true for valid integer',
- 'integer',
- 2,
- true,
- ],
- [
- 'returns false for invalid number',
- 'number',
- 'invalid',
- false,
- ],
- [
- 'returns true for valid number',
- 'number',
- 1.25,
- true,
- ],
- [
- 'returns false for invalid string',
- 'string',
- 1,
- false,
- ],
- [
- 'returns true for valid string',
- 'string',
- 'valid',
- true,
- ],
- [
- 'returns false for invalid plain object',
- 'object',
- 'invalid',
- false,
- ],
- [
- 'returns true for valid plain object',
- 'object',
- {},
- true,
- ],
- [
- 'returns false for invalid boolean',
- 'bool',
- 'invalid',
- false,
- ],
- [
- 'returns true for valid boolean',
- 'bool',
- false,
- true,
- ],
- [
- 'returns false for invalid null',
- 'null',
- 'invalid',
- false,
- ],
- [
- 'returns true for valid null',
- 'null',
- null,
- true,
- ],
- [
- 'returns false for invalid type in an array of types',
- [ 'integer', 'number' ],
- 'invalid',
- false,
- ],
- [
- 'returns true for valid type in an array of types',
- [ 'integer', 'number' ],
- 1.25,
- true,
- ],
- ];
- testConditions.forEach( ( [
- description,
- testType,
- testValue,
- expectedResponse,
- ] ) => {
- it( description, () => {
- expect( validateType( testType, testValue ) )
- .toBe( expectedResponse );
- } );
- } );
- } );
- describe( 'validateEnumType()', () => {
- const testConditions = [
- [
- 'it returns false when not of the correct type',
- 10,
- false,
- ],
- [
- 'it returns false when of the correct type but not of the ' +
- 'expected enum values',
- 'invalid',
- false,
- ],
- [
- 'it returns true when of the correct type and of the ' +
- 'expected enum values',
- 'valid',
- true,
- ],
- ];
- testConditions.forEach( ( [
- description,
- testValue,
- expectedValue,
- ] ) => {
- it( description, () => {
- expect( validateEnumType(
- 'string',
- [ 'a', 'b', 'valid' ],
- testValue,
- ) ).toBe( expectedValue );
- } );
- } );
- } );
- describe( 'isShallowValidValueForField()', () => {
- const testCall = (
- fieldName,
- fieldValue,
- schema,
- expectValueObjects,
- ) => () => isShallowValidValueForField(
- fieldName,
- fieldValue,
- schema,
- expectValueObjects,
- );
- const testEnumSchema = {
- enumfield: {
- type: 'string',
- enum: [ 'a', 'b', 'c' ],
- },
- };
- const testConditions = [
- [
- 'it returns expected response for invalid primary key field ' +
- 'value.',
- 'EVT_ID',
- {},
- EventSchemaProperties,
- true,
- false,
- null,
- ],
- [
- 'it returns expected response for valid primary key ' +
- 'field value that is a string',
- 'EVT_ID',
- 'some_id',
- EventSchemaProperties,
- true,
- true,
- null,
- ],
- [
- 'it returns expected response for valid primary key field ' +
- 'value that is a number',
- 'EVT_ID',
- 12,
- EventSchemaProperties,
- true,
- true,
- null,
- ],
- [
- 'it returns expected response for invalid enum field',
- 'enumfield',
- 1.25,
- testEnumSchema,
- true,
- false,
- TypeError,
- ],
- [
- 'it returns expected response for valid enum field',
- 'enumfield',
- 'c',
- testEnumSchema,
- true,
- true,
- null,
- ],
- [
- 'it returns expected response for valid field value when ' +
- 'value objects are expected',
- 'EVT_visible_on',
- DateTime.fromJSDate( new Date() ),
- EventSchemaProperties,
- true,
- true,
- null,
- ],
- [
- 'it returns expected response for invalid field value when ' +
- 'value objects are expected',
- 'EVT_visible_on',
- 'invalid date',
- EventSchemaProperties,
- true,
- false,
- InvalidDateTime,
- ],
- [
- 'it returns expected response for valid field value when ' +
- 'value objects are not expected',
- 'EVT_visible_on',
- ( new Date() ).toISOString(),
- EventSchemaProperties,
- false,
- true,
- null,
- ],
- [
- 'it returns expected response for invalid field value that ' +
- 'of object type for the schema field when value objects are' +
- 'expected',
- 'REG_final_price',
- 1.25,
- RegistrationSchemaProperties,
- true,
- false,
- TypeError,
- ],
- [
- 'it returns expected response for valid field value that ' +
- 'is of object type for the schema field when value objects ' +
- 'are expected',
- 'REG_final_price',
- new Money( 1.25, SiteCurrency ),
- RegistrationSchemaProperties,
- true,
- true,
- null,
- ],
- [
- 'it returns expected response for invalid field value that ' +
- 'is of object type for the schema field when value objects ' +
- 'are not expected',
- 'REG_final_price',
- 1.25,
- false,
- false,
- null,
- ],
- [
- 'it returns expected response for valid field value that ' +
- 'is of object type for the schema field when value objects ' +
- 'are not expected',
- 'REG_final_price',
- { raw: 1.25 },
- false,
- true,
- null,
- ],
- ];
- testConditions.forEach( ( [
- description,
- fieldName,
- testValue,
- schema,
- expectValueObjects,
- expectedValue,
- expectedException,
- ] ) => {
- it( description, () => {
- if ( expectedException === null ) {
- expect( testCall(
- fieldName,
- testValue,
- schema,
- expectValueObjects
- )() ).toBe( expectedValue );
- } else {
- expect( testCall(
- fieldName,
- testValue,
- schema,
- expectValueObjects
- ) ).toThrow( expectedException );
- }
- } );
- } );
- } );
-} );
diff --git a/assets/src/data/model/entity-factory/validators.js b/assets/src/data/model/entity-factory/validators.js
deleted file mode 100644
index 69819590d27..00000000000
--- a/assets/src/data/model/entity-factory/validators.js
+++ /dev/null
@@ -1,171 +0,0 @@
-/**
- * External imports
- */
-import {
- isArray,
- isInteger,
- isString,
- isPlainObject,
- isBoolean,
- isNumber,
-} from 'lodash';
-import { sprintf } from '@eventespresso/i18n';
-
-/**
- * Internal Imports
- */
-import { isEnumField, isPrimaryKeyField, isValueObjectField } from './booleans';
-import { maybeConvertFromValueObjectWithAssertions } from './extractors';
-import { PRIVATE_PROPERTIES, VALIDATE_TYPE } from './constants';
-
-/**
- * Validates the incoming value for given type. Types allowed are:
- *
- * - integer: checks if value is an integer.
- * - number: checks if value is classified as a Number primitive or object (this
- * means `Infinity`, `-Infinity`, and `NaN` are considered valid for this type
- * - string
- * - object - this validates as a "plainObject", that is an object created by
- * the Object constructor or one with a [[Prototype]] of null.
- * - boolean
- * - bool: (same as boolean check)
- * - null: value must explicitly be `null`
- *
- * Note: if the passed in type does not exist, then the value is considered
- * invalid.
- *
- * @param {string|Array} type The type or types to check
- * @param {*} value The value being validated
- * @return {boolean} True means the value is valid for the given type.
- */
-export const validateType = ( type, value ) => {
- let valid = false;
- // account for type definitions that are an array of allowed types.
- if ( isArray( type ) ) {
- for ( const singleType of type ) {
- valid = validateType( singleType, value );
- if ( valid ) {
- break;
- }
- }
- // return right away because we've determined the validity of the type.
- return valid;
- }
- switch ( type ) {
- case 'integer':
- valid = isInteger( value );
- break;
- case 'number':
- valid = isNumber( value );
- break;
- case 'string':
- valid = isString( value );
- break;
- case 'object':
- valid = isPlainObject( value );
- break;
- case 'boolean':
- case 'bool':
- valid = isBoolean( value );
- break;
- case 'null':
- valid = value === null;
- break;
- }
- return valid;
-};
-
-/**
- * This validates enum type of values.
- *
- * This means that the value must be one of the provided array of enumValues as
- * well as being of the expected type.
- *
- * @param {string} type
- * @param {Array} enumValues
- * @param {*} value
- * @return {boolean} True means this value is valid.
- */
-export const validateEnumType = ( type, enumValues, value ) => {
- return validateType( type, value ) &&
- isArray( enumValues ) &&
- enumValues.indexOf( value ) > -1;
-};
-
-/**
- * This method does a shallow validation for the given value and field.
- *
- * "Shallow" here means that if the field schema is of type 'object', then the
- * validation only verifies that the value is an object. The object contents
- * are not validated.
- *
- * @param {string} fieldName
- * @param {*} fieldValue
- * @param {Object} schema
- * @param {boolean} expectValueObjects If true, then this flags the validator
- * to assume the value might be a value object and attempt to retrieve the raw
- * value from that value object for validation against the expected type in the
- * schema for that field.
- * @return {boolean} True means the value is valid.
- * @throws TypeError
- * @throws InvalidDateTime
- */
-export const isShallowValidValueForField = (
- fieldName,
- fieldValue,
- schema,
- expectValueObjects = true
-) => {
- // if field is a primary Key field then we override the validation so it can
- // be either string or number
- if ( isPrimaryKeyField( fieldName, schema ) ) {
- return validateType( 'string', fieldValue ) ||
- validateType( 'number', fieldValue );
- }
- const isEnum = isEnumField( fieldName, schema );
- const isValueObject = isValueObjectField( fieldName, schema );
- fieldValue = expectValueObjects && isValueObject ?
- maybeConvertFromValueObjectWithAssertions(
- fieldName,
- fieldValue,
- schema
- ) :
- fieldValue;
- fieldValue = expectValueObjects &&
- schema[ fieldName ].type === 'object' &&
- isValueObject ?
- { raw: fieldValue } :
- fieldValue;
- const isValid = isEnum ?
- validateEnumType(
- schema[ fieldName ].type,
- schema[ fieldName ].enum,
- fieldValue
- ) :
- validateType( schema[ fieldName ].type, fieldValue );
- // if isEnum and not valid, then lets bail with error
- if ( isEnum && ! isValid ) {
- throw new TypeError(
- sprintf(
- 'The given "%s" fieldName is not valid for the defined schema. It must be a "%s" and it must be one of "%s". The fieldValue given was "%s"',
- fieldName,
- schema[ fieldName ].enum.join(),
- fieldValue
- )
- );
- }
- return isValid;
-};
-
-/**
- * Returns what is set as the validateType for the given field and instance.
- *
- * @param {string} fieldName
- * @param {Object} instance
- * @return {string} The validation type for the given field and instance.
- */
-export const validateTypeForField = ( fieldName, instance ) => {
- return instance[ PRIVATE_PROPERTIES.VALIDATE_TYPES ][ fieldName ] ?
- instance[ PRIVATE_PROPERTIES.VALIDATE_TYPES ][ fieldName ] :
- VALIDATE_TYPE.RAW;
-};
diff --git a/assets/src/data/model/event/constants.js b/assets/src/data/model/event/constants.js
deleted file mode 100644
index 5637244caa1..00000000000
--- a/assets/src/data/model/event/constants.js
+++ /dev/null
@@ -1,14 +0,0 @@
-/**
- * External imports
- */
-import { values } from 'lodash';
-
-export const MODEL_NAME = 'event';
-
-export const EVENT_STATUS_ID = {
- SOLD_OUT: 'sold_out',
- POSTPONED: 'postponed',
- CANCELLED: 'cancelled',
-};
-
-export const EVENT_STATUS_IDS = values( EVENT_STATUS_ID );
diff --git a/assets/src/data/model/event/index.js b/assets/src/data/model/event/index.js
deleted file mode 100644
index 368ab8bf184..00000000000
--- a/assets/src/data/model/event/index.js
+++ /dev/null
@@ -1,2 +0,0 @@
-export * from './constants';
-export * from './query';
diff --git a/assets/src/data/model/event/query.js b/assets/src/data/model/event/query.js
deleted file mode 100644
index b1ebbd226de..00000000000
--- a/assets/src/data/model/event/query.js
+++ /dev/null
@@ -1,139 +0,0 @@
-/**
- * External dependencies
- */
-import moment from 'moment-timezone';
-import { isUndefined } from 'lodash';
-import PropTypes from 'prop-types';
-
-/**
- * Internal imports
- */
-import {
- getQueryString as baseGetQueryString,
- QUERY_ORDER_DESC,
- ALLOWED_ORDER_VALUES,
- GREATER_THAN,
- GREATER_THAN_AND_EQUAL,
- LESS_THAN_AND_EQUAL,
-} from '../base';
-
-export const nowDateAndTime = moment();
-
-/**
- * Described attributes for this model
- * @type {{attributes: *}}
- */
-export const queryDataTypes = {
- queryData: PropTypes.shape( {
- limit: PropTypes.number,
- orderBy: PropTypes.oneOf( [
- 'EVT_name',
- 'EVT_ID',
- 'start_date',
- 'end_date',
- 'ticket_start',
- 'ticket_end',
- ] ),
- order: PropTypes.oneOf( ALLOWED_ORDER_VALUES ),
- showExpired: PropTypes.bool,
- categorySlug: PropTypes.string,
- month: PropTypes.month,
- } ),
-};
-
-/**
- * Default attributes for this model
- * @type {
- * {
- * attributes: {
- * limit: number,
- * orderBy: string,
- * order: string,
- * showExpired: boolean
- * }
- * }
- * }
- */
-export const defaultQueryData = {
- queryData: {
- limit: 100,
- orderBy: 'start_date',
- order: QUERY_ORDER_DESC,
- showExpired: false,
- },
-};
-
-/**
- * Used to map an orderBy string to the actual value used in a REST query from
- * the context of an event.
- *
- * @param {string} orderBy
- *
- * @return { string } Returns an actual orderBy string for the REST query for
- * the provided alias
- */
-export const mapOrderBy = ( orderBy ) => {
- const orderByMap = {
- start_date: 'Datetime.DTT_EVT_start',
- end_date: 'Datetime.DTT_EVT_end',
- ticket_start: 'Datetime.Ticket.TKT_start_date',
- ticket_end: 'Datetime.Ticket.TKT_end_date',
- };
- return isUndefined( orderByMap[ orderBy ] ) ?
- orderBy :
- orderByMap[ orderBy ];
-};
-
-/**
- * Builds where conditions for an events endpoint request using provided
- * information.
- *
- * @param {boolean} showExpired Whether or not to include expired events.
- * @param {string} categorySlug Return events for the given categorySlug
- * @param {string} month Return events for the given month.
- * Can be any month format recognized by moment.
- * @return {string} The assembled where conditions.
- */
-export const whereConditions = ( {
- showExpired = false,
- categorySlug,
- month = 'none',
-} ) => {
- const where = [];
-
- if ( ! showExpired ) {
- where.push(
- 'where[Datetime.DTT_EVT_end**expired][]=' + GREATER_THAN +
- '&where[Datetime.DTT_EVT_end**expired][]=' +
- nowDateAndTime.local().format()
- );
- }
- if ( categorySlug ) {
- where.push(
- 'where[Term_Relationship.Term_Taxonomy.Term.slug]=' + categorySlug
- );
- }
- if ( month && month !== 'none' ) {
- where.push(
- 'where[Datetime.DTT_EVT_start][]=' + GREATER_THAN_AND_EQUAL +
- '&where[Datetime.DTT_EVT_start][]=' +
- moment().month( month ).startOf( 'month' ).local().format()
- );
- where.push(
- 'where[Datetime.DTT_EVT_end][]=' + LESS_THAN_AND_EQUAL +
- '&where[Datetime.DTT_EVT_end][]=' +
- moment().month( month ).endOf( 'month' ).local().format()
- );
- }
- return where.join( '&' );
-};
-
-/**
- * Return a query string for use by a REST request given a set of queryData.
- * @param { Object } queryData
- * @return { string } Returns the query string.
- */
-export const getQueryString = ( queryData = {} ) => {
- queryData = { ...defaultQueryData.queryData, ...queryData };
- return baseGetQueryString( queryData, whereConditions, mapOrderBy );
-};
diff --git a/assets/src/data/model/event/test/index.js b/assets/src/data/model/event/test/index.js
deleted file mode 100644
index 7a4a99eadab..00000000000
--- a/assets/src/data/model/event/test/index.js
+++ /dev/null
@@ -1,76 +0,0 @@
-import {
- mapOrderBy,
- whereConditions,
- getQueryString,
- nowDateAndTime,
-} from '../';
-import {
- GREATER_THAN,
- GREATER_THAN_AND_EQUAL,
- LESS_THAN_AND_EQUAL,
-} from '../../base';
-
-import moment from 'moment-timezone';
-
-const expectedNow = nowDateAndTime.local().format();
-
-describe( 'mapOrderBy()', () => {
- it( 'correctly maps incoming values to the correct expectation', () => {
- const incomingToExpectedMap = {
- start_date: 'Datetime.DTT_EVT_start',
- end_date: 'Datetime.DTT_EVT_end',
- ticket_start: 'Datetime.Ticket.TKT_start_date',
- ticket_end: 'Datetime.Ticket.TKT_end_date',
- EVT_ID: 'EVT_ID',
- };
- for ( const incomingOrderBy in incomingToExpectedMap ) {
- const expectedValue = incomingToExpectedMap[ incomingOrderBy ];
- expect( mapOrderBy( incomingOrderBy ) ).toEqual( expectedValue );
- }
- } );
-} );
-
-describe( 'whereConditions()', () => {
- it( 'returns expected default for empty object passed in', () => {
- expect( whereConditions( {} ) ).toEqual(
- 'where[Datetime.DTT_EVT_end**expired][]=' + GREATER_THAN +
- '&where[Datetime.DTT_EVT_end**expired][]=' + expectedNow
- );
- } );
- it( 'returns expected string for values passed in', () => {
- const expectedEndofDate = moment()
- .month( 'may' )
- .endOf( 'month' )
- .local()
- .format();
- const expectedStartofDate = moment()
- .month( 'may' )
- .startOf( 'month' )
- .local()
- .format();
- const testObject = {
- showExpired: false,
- categorySlug: 'test',
- month: 'may',
- };
- expect( whereConditions( testObject ) ).toEqual(
- 'where[Datetime.DTT_EVT_end**expired][]=' + GREATER_THAN +
- '&where[Datetime.DTT_EVT_end**expired][]=' + expectedNow +
- '&where[Term_Relationship.Term_Taxonomy.Term.slug]=test' +
- '&where[Datetime.DTT_EVT_start][]=' + GREATER_THAN_AND_EQUAL +
- '&where[Datetime.DTT_EVT_start][]=' + expectedStartofDate +
- '&where[Datetime.DTT_EVT_end][]=' + LESS_THAN_AND_EQUAL +
- '&where[Datetime.DTT_EVT_end][]=' + expectedEndofDate,
- );
- } );
-} );
-
-describe( 'getQueryString', () => {
- it( 'returns expected default for no arguments passed in', () => {
- expect( getQueryString() ).toEqual(
- 'limit=100&order=DESC&order_by=Datetime.DTT_EVT_start' +
- '&where[Datetime.DTT_EVT_end**expired][]=' + GREATER_THAN +
- '&where[Datetime.DTT_EVT_end**expired][]=' + expectedNow
- );
- } );
-} );
diff --git a/assets/src/data/model/index.js b/assets/src/data/model/index.js
deleted file mode 100644
index 1ff2c733ccc..00000000000
--- a/assets/src/data/model/index.js
+++ /dev/null
@@ -1,8 +0,0 @@
-export * from './default-model-state';
-export * from './endpoints';
-export * from './primary-keys';
-export * from './assertions';
-export * from './model-names';
-export * from './base';
-export * from './models';
-export * from './entity-factory';
diff --git a/assets/src/data/model/model-names.js b/assets/src/data/model/model-names.js
deleted file mode 100644
index e28861c8760..00000000000
--- a/assets/src/data/model/model-names.js
+++ /dev/null
@@ -1,54 +0,0 @@
-/**
- * Internal imports
- */
-import { primaryKeys } from './primary-keys.js';
-
-/**
- * External imports
- */
-import { keys, startCase } from 'lodash';
-import pluralize from 'pluralize';
-import memoize from 'memize';
-
-/**
- * Returns an array of model names currently exposed for REST API request.
- */
-export const MODEL_NAMES = keys( primaryKeys );
-
-/**
- * Used to normalize the plural form of a given model name.
- * @param {string} modelName
- * @return {string} Ensures the given modelName is its plural form.
- */
-export const pluralModelName = memoize(
- ( modelName ) => pluralize( modelName )
-);
-
-/**
- * Used to normalize the singular form of a given model name.
- * @param {string} modelName
- * @return {string} Ensures the given modelName is in its singular form.
- */
-export const singularModelName = memoize(
- ( modelName ) => pluralize.singular( modelName )
-);
-
-/**
- * Provides the capitalized snakecase format for the given model name typically
- * used in query strings.
- *
- * Example:
- *
- * modelNameForQueryString( 'message_template_group' );
- * // Message_Template_Group
- *
- * @param {string} modelName
- * @return {string} the formatted string.
- */
-export const modelNameForQueryString = memoize(
- ( modelName ) => {
- modelName = singularModelName( modelName );
- modelName = startCase( modelName );
- return modelName.replace( /\s/g, '_' );
- }
-);
diff --git a/assets/src/data/model/models.js b/assets/src/data/model/models.js
deleted file mode 100644
index 1241c1741f6..00000000000
--- a/assets/src/data/model/models.js
+++ /dev/null
@@ -1,16 +0,0 @@
-import * as dateTimeModel from './datetime';
-import * as eventModel from './event';
-import * as registrationModel from './registration';
-import * as statusModel from './status';
-import * as ticketModel from './ticket';
-import * as checkInModel from './checkin';
-import * as attendeeModel from './attendee';
-export {
- checkInModel,
- dateTimeModel,
- eventModel,
- registrationModel,
- statusModel,
- ticketModel,
- attendeeModel,
-};
diff --git a/assets/src/data/model/primary-keys.js b/assets/src/data/model/primary-keys.js
deleted file mode 100644
index 2d1844b72d0..00000000000
--- a/assets/src/data/model/primary-keys.js
+++ /dev/null
@@ -1,152 +0,0 @@
-/**
- * External imports
- */
-import { data } from '@eventespresso/eejs';
-import { __ } from '@eventespresso/i18n';
-import { isArray, reduce, trimEnd } from 'lodash';
-import memoize from 'memize';
-
-/**
- * Internal imports
- */
-import {
- assertEntityHasKey,
- assertIsArray,
- assertIsNotEmpty,
- assertIsMap,
-} from './assertions';
-
-/**
- * Exposes a map of modelname to primary key exposed by the eejs.data global
- * via the server.
- *
- * @type {{}}
- */
-export const { primary_keys: primaryKeys = {} } = data.paths;
-
-/**
- * Returns the values for the given keys from the provided entity.
- * This function would be used for models that have combined primary keys
- * (delivered as an array).
- *
- * @type { memoized }
- * @return { string } The string representation for the values.
- * @throws { Exception }
- */
-export const valuesForCombinedPrimaryKeys = memoize( ( keys, entity ) => {
- assertIsArray( keys );
- const primaryKey = reduce( keys, function( result, key ) {
- assertEntityHasKey( key, entity );
- return entity[ result ] + ':' + entity[ key ];
- } );
- return trimEnd( primaryKey, ':' );
-} );
-
-/**
- * Returns the value for the given key from the provided entity.
- * This function would be used for models that have only one primary key.
- *
- * @type {memoized}
- * @return { function } The value for the key in the provided entity.
- * @throws { Exception }
- */
-export const valueForPrimaryKey = memoize( ( key, entity ) => {
- assertEntityHasKey( key, entity );
- return entity[ key ];
-} );
-
-/**
- * Returns the primary key (or combined primary keys) from the available data.
- *
- * @type {memoized}
- * @return { function(string) }
- * @throws { Exception }
- */
-export const getPrimaryKey = memoize( ( modelName ) => {
- assertEntityHasKey( modelName, primaryKeys );
- return primaryKeys[ modelName ];
-} );
-
-/**
- * Returns a query string for getting the entities belonging to a model for the
- * given primary key values
- *
- * @type {memoized}
- */
-export const getPrimaryKeyQueryString = memoize(
- ( modelName, keyValues = [] ) => {
- const primaryKey = getPrimaryKey( modelName );
- return `[${ primaryKey }][IN]=` + keyValues.join();
- }
-);
-
-/**
- * Returns the values for the primary keys from the provided entity.
- *
- * @type {memoized}
- * @return { function } If the model has only one primary key then the value will
- * be a simple string. If the model has combined primary keys, then the value
- * will be as string in the format `%s.%s` for the primary key values.
- * @throws { Exception }
- */
-export const getEntityPrimaryKeyValues = memoize( ( modelName, entity ) => {
- const keys = getPrimaryKey( modelName );
- return isArray( keys ) ?
- valuesForCombinedPrimaryKeys( keys, entity ) :
- valueForPrimaryKey( keys, entity );
-} );
-
-/**
- * This receives an array of entities and returns a collection of those same
- * entities indexed by the primary key value for each entity.
- *
- * @param {string} modelName
- * @param {Array} entities
- * @return {Map} A collection indexed by the primary key values for each entity.
- * @throws {Exception}
- */
-export const keyEntitiesByPrimaryKeyValue = ( modelName, entities = [] ) => {
- assertIsNotEmpty(
- entities,
- __(
- 'The provided array of entities must not be empty',
- 'event_espresso',
- )
- );
- assertIsArray( entities );
-
- const mappedEntities = new Map();
- entities.forEach( ( entity ) => {
- mappedEntities.set(
- getEntityPrimaryKeyValues( modelName, entity ),
- entity
- );
- } );
- return mappedEntities;
-};
-
-/**
- * Creates an array of entity instances using the given factory and array
- * of entity values.
- *
- * @param {Object} factory
- * @param {Map} entities
- * @return {Map} An array of entity instances indexed by
- * their primary key value
- */
-export const createAndKeyEntitiesByPrimaryKeyValue = (
- factory,
- entities,
-) => {
- assertIsMap(
- entities,
- __(
- 'The provided object of entities must be a Map object',
- 'event_espresso',
- )
- );
- entities.forEach( ( entity, entityId ) => {
- entities.set( entityId, factory.fromExisting( entity ) );
- } );
- return entities;
-};
diff --git a/assets/src/data/model/registration/constants.js b/assets/src/data/model/registration/constants.js
deleted file mode 100644
index a6e1dccc244..00000000000
--- a/assets/src/data/model/registration/constants.js
+++ /dev/null
@@ -1,15 +0,0 @@
-/**
- * Internal Imports
- */
-import * as statusModel from '../status/constants';
-
-/**
- * External imports
- */
-import { values } from 'lodash';
-
-export const MODEL_NAME = 'registration';
-
-export const REGISTRATION_STATUS_IDS = values(
- statusModel.REGISTRATION_STATUS_ID
-);
diff --git a/assets/src/data/model/registration/index.js b/assets/src/data/model/registration/index.js
deleted file mode 100644
index 368ab8bf184..00000000000
--- a/assets/src/data/model/registration/index.js
+++ /dev/null
@@ -1,2 +0,0 @@
-export * from './constants';
-export * from './query';
diff --git a/assets/src/data/model/registration/query.js b/assets/src/data/model/registration/query.js
deleted file mode 100644
index 5c31fd6aebd..00000000000
--- a/assets/src/data/model/registration/query.js
+++ /dev/null
@@ -1,131 +0,0 @@
-/**
- * External imports
- */
-import { isUndefined, values } from 'lodash';
-import PropTypes from 'prop-types';
-
-/**
- * Internal imports
- */
-import {
- getQueryString as baseGetQueryString,
- QUERY_ORDER_DESC,
- ALLOWED_ORDER_VALUES,
-} from '../base';
-import * as statusModel from '../status/constants';
-
-/**
- * Described attributes for this model
- * @type {{attributes: *}}
- */
-export const queryDataTypes = {
- forEventId: PropTypes.number,
- forAttendeeId: PropTypes.number,
- forTransactionId: PropTypes.number,
- forTicketId: PropTypes.number,
- forStatusId: PropTypes.oneOf( values( statusModel.REGISTRATION_STATUS_ID ) ),
- queryData: PropTypes.shape( {
- limit: PropTypes.number,
- orderBy: PropTypes.oneOf( [
- 'REG_ID',
- 'REG_date',
- ] ),
- order: PropTypes.oneOf( ALLOWED_ORDER_VALUES ),
- } ),
-};
-
-export const optionsEntityMap = {
- default: {
- value: 'REG_ID',
- label: 'REG_code',
- },
-};
-
-/**
- * Default attributes for this model
- * @type {
- * {
- * attributes: {
- * limit: number,
- * orderBy: string,
- * order: string,
- * }
- * }
- * }
- */
-export const defaultQueryData = {
- queryData: {
- limit: 100,
- orderBy: 'reg_date',
- order: QUERY_ORDER_DESC,
- },
-};
-
-/**
- * Used to map an orderBy string to the actual value used in a REST query from
- * the context of a registration.
- *
- * @param {string} orderBy
- *
- * @return { string } Returns an actual orderBy string for the REST query for
- * the provided alias
- */
-export const mapOrderBy = ( orderBy ) => {
- const orderByMap = {
- reg_id: 'REG_ID',
- reg_date: 'REG_date',
- };
- return isUndefined( orderByMap[ orderBy ] ) ?
- orderBy :
- orderByMap[ orderBy ];
-};
-
-/**
- * Builds where conditions for an registrations endpoint request
- *
- * @param {number} forEventId ID of Event to retrieve registrations for
- * @param {number} forAttendeeId ID of Attendee to retrieve registrations for
- * @param {number} forTransactionId ID of Transaction to retrieve registrations for
- * @param {number} forTicketId ID of Ticket to retrieve registrations for
- * @param {string} forStatusId ID of Status to retrieve registrations for
- * @return {string} The assembled where conditions.
- */
-export const whereConditions = ( {
- forEventId = 0,
- forAttendeeId = 0,
- forTransactionId = 0,
- forTicketId = 0,
- forStatusId = '',
-} ) => {
- const where = [];
- forEventId = parseInt( forEventId, 10 );
- if ( forEventId !== 0 && ! isNaN( forEventId ) ) {
- where.push( 'where[EVT_ID]=' + forEventId );
- }
- forAttendeeId = parseInt( forAttendeeId, 10 );
- if ( forAttendeeId !== 0 && ! isNaN( forAttendeeId ) ) {
- where.push( 'where[ATT_ID]=' + forAttendeeId );
- }
- forTransactionId = parseInt( forTransactionId, 10 );
- if ( forTransactionId !== 0 && ! isNaN( forTransactionId ) ) {
- where.push( 'where[TXN_ID]=' + forTransactionId );
- }
- forTicketId = parseInt( forTicketId, 10 );
- if ( forTicketId !== 0 && ! isNaN( forTicketId ) ) {
- where.push( 'where[TKT_ID]=' + forTicketId );
- }
- if ( forStatusId !== '' && forStatusId !== null ) {
- where.push( 'where[STS_ID]=' + forStatusId );
- }
- return where.join( '&' );
-};
-
-/**
- * Return a query string for use by a REST request given a set of queryData.
- * @param { Object } queryData
- * @return { string } Returns the query string.
- */
-export const getQueryString = ( queryData = {} ) => {
- queryData = { ...defaultQueryData.queryData, ...queryData };
- return baseGetQueryString( queryData, whereConditions, mapOrderBy );
-};
diff --git a/assets/src/data/model/registration/test/index.js b/assets/src/data/model/registration/test/index.js
deleted file mode 100644
index f657bfb4df1..00000000000
--- a/assets/src/data/model/registration/test/index.js
+++ /dev/null
@@ -1,64 +0,0 @@
-import {
- mapOrderBy,
- whereConditions,
- getQueryString,
-} from '../';
-
-describe( 'mapOrderBy()', () => {
- it( 'correctly maps incoming values to the correct expectation', () => {
- const incomingToExpectedMap = {
- reg_id: 'REG_ID',
- reg_date: 'REG_date',
- };
- for ( const incomingOrderBy in incomingToExpectedMap ) {
- const expectedValue = incomingToExpectedMap[ incomingOrderBy ];
- expect( mapOrderBy( incomingOrderBy ) ).toEqual( expectedValue );
- }
- } );
-} );
-
-describe( 'whereConditions()', () => {
- it( 'returns empty string when NO parameters provided', () => {
- expect( whereConditions( {} ) ).toEqual( '' );
- } );
- it( 'returns expected string for supplied Event ID', () => {
- const testObject = { forEventId: 123 };
- expect( whereConditions( testObject ) ).toEqual( 'where[EVT_ID]=123' );
- } );
- it( 'returns expected string for supplied Attendee ID', () => {
- const testObject = { forAttendeeId: 123 };
- expect( whereConditions( testObject ) ).toEqual( 'where[ATT_ID]=123' );
- } );
- it( 'returns expected string for supplied Transaction ID', () => {
- const testObject = { forTransactionId: 123 };
- expect( whereConditions( testObject ) ).toEqual( 'where[TXN_ID]=123' );
- } );
- it( 'returns expected string for supplied Ticket ID', () => {
- const testObject = { forTicketId: 123 };
- expect( whereConditions( testObject ) ).toEqual( 'where[TKT_ID]=123' );
- } );
- it( 'returns expected string for supplied Status ID', () => {
- const testObject = { forStatusId: 'RPP' };
- expect( whereConditions( testObject ) ).toEqual( 'where[STS_ID]=RPP' );
- } );
- it( 'returns expected string when ALL parameters provided', () => {
- const testObject = {
- forEventId: 1,
- forAttendeeId: 2,
- forTransactionId: 3,
- forTicketId: 4,
- forStatusId: 'RNA',
- };
- expect( whereConditions( testObject ) ).toEqual(
- 'where[EVT_ID]=1&where[ATT_ID]=2&where[TXN_ID]=3&where[TKT_ID]=4&where[STS_ID]=RNA'
- );
- } );
-} );
-
-describe( 'getQueryString', () => {
- it( 'returns expected default for no arguments passed in', () => {
- expect( getQueryString() ).toEqual( 'limit=100&order=DESC&order_by=REG_date' );
- } );
-} );
-
-// location: assets/src/data/model/registration/test/index.js
diff --git a/assets/src/data/model/status/constants.js b/assets/src/data/model/status/constants.js
deleted file mode 100644
index 70b9afb4e48..00000000000
--- a/assets/src/data/model/status/constants.js
+++ /dev/null
@@ -1,96 +0,0 @@
-/**
- * External imports
- */
-import { values } from 'lodash';
-
-export const MODEL_NAME = 'status';
-// types
-export const STATUS_TYPE_EMAIL = 'email';
-export const STATUS_TYPE_EVENT = 'event';
-export const STATUS_TYPE_MESSAGE = 'message';
-export const STATUS_TYPE_PAYMENT = 'payment';
-export const STATUS_TYPE_REGISTRATION = 'registration';
-export const STATUS_TYPE_TRANSACTION = 'transaction';
-// email
-export const EMAIL_STATUS_ID = {
- DRAFT: 'EDR',
- SENT: 'ESN',
- EXPIRED: 'EXP',
-};
-// event
-export const EVENT_STATUS_ID = {
- ACTIVE: 'ACT',
- REGISTRATION_CLOSED: 'CLS',
- DELETED: 'DEL',
- DENIED: 'DEN',
- DRAFT: 'DRF',
- NOT_ACTIVE: 'NAC',
- NOT_OPEN: 'NOP',
- ONGOING: 'ONG',
- REGISTRATION_OPEN: 'OPN',
- PENDING: 'PND',
- SECONDARY: 'SEC',
-};
-// message
-export const MESSAGE_STATUS_ID = {
- DEBUG: 'MDO',
- EXECUTING: 'MEX',
- FAIL: 'MFL',
- INCOMPLETE: 'MIC',
- IDLE: 'MID',
- RESEND: 'MRS',
- RETRY: 'MRT',
- SENT: 'MSN',
-};
-// payment
-export const PAYMENT_STATUS_ID = {
- APPROVED: 'PAP',
- CANCELLED: 'PCN',
- DECLINED: 'PDC',
- FAILED: 'PFL',
- PENDING: 'PPN',
-};
-// registration
-export const REGISTRATION_STATUS_ID = {
- APPROVED: 'RAP',
- CANCELLED: 'RCN',
- DECLINED: 'RDC',
- INCOMPLETE: 'RIC',
- NOT_APPROVED: 'RNA',
- PENDING_PAYMENT: 'RPP',
- WAIT_LIST: 'RWL',
-};
-// transaction
-export const TRANSACTION_STATUS_ID = {
- ABANDONED: 'TAB',
- COMPLETE: 'TCM',
- FAILED: 'TFL',
- INCOMPLETE: 'TIN',
- OVERPAID: 'TOP',
-};
-
-// the following are not in the status database but are kept here for
-// convenience
-
-// custom post types
-export const CPT_STATUS_ID = {
- PUBLISH: 'publish',
- FUTURE: 'future',
- DRAFT: 'draft',
- PENDING: 'pending',
- PRIVATE: 'private',
- TRASHED: 'trash',
-};
-
-export const UNKNOWN_STATUS_ID = 'unknown';
-
-export const ALL_STATUS_IDS = [
- ...values( EMAIL_STATUS_ID ),
- ...values( EVENT_STATUS_ID ),
- ...values( MESSAGE_STATUS_ID ),
- ...values( PAYMENT_STATUS_ID ),
- ...values( REGISTRATION_STATUS_ID ),
- ...values( TRANSACTION_STATUS_ID ),
- ...values( CPT_STATUS_ID ),
- UNKNOWN_STATUS_ID,
-];
diff --git a/assets/src/data/model/status/helpers.js b/assets/src/data/model/status/helpers.js
deleted file mode 100644
index 0daf2e6bccb..00000000000
--- a/assets/src/data/model/status/helpers.js
+++ /dev/null
@@ -1,306 +0,0 @@
-/**
- * Internal imports
- */
-import * as status from './constants';
-import { EVENT_STATUS_ID } from '../event';
-import { TICKET_STATUS_ID } from '../ticket';
-import { DATETIME_STATUS_ID } from '../datetime';
-import { CHECKIN_STATUS_ID } from '../checkin';
-
-/**
- * External imports
- */
-import { __ } from '@eventespresso/i18n';
-import { Label } from '@eventespresso/value-objects';
-import { isArray } from 'lodash';
-
-/**
- * Translation map for Registration statuses
- * @type {{}}
- */
-const STATUS_TRANSLATION_MAP_REGISTRATION = {
- [ status.REGISTRATION_STATUS_ID.PENDING_PAYMENT ]: new Label(
- __( 'pending payment', 'event_espresso' ),
- __( 'pending payments', 'event_espresso' )
- ),
- [ status.REGISTRATION_STATUS_ID.APPROVED ]: Label.fromSameSingleAndPlural(
- __( 'approved', 'event_espresso' )
- ),
- [ status.REGISTRATION_STATUS_ID.NOT_APPROVED ]: Label.fromSameSingleAndPlural(
- __( 'not approved', 'event_espresso' )
- ),
- [ status.REGISTRATION_STATUS_ID.CANCELLED ]: Label.fromSameSingleAndPlural(
- __( 'cancelled', 'event_espresso' )
- ),
- [ status.REGISTRATION_STATUS_ID.INCOMPLETE ]: Label.fromSameSingleAndPlural(
- __( 'incomplete', 'event_espresso' )
- ),
- [ status.REGISTRATION_STATUS_ID.DECLINED ]: Label.fromSameSingleAndPlural(
- __( 'declined', 'event_espresso' )
- ),
- [ status.REGISTRATION_STATUS_ID.WAIT_LIST ]: new Label(
- __( 'wait list', 'event_espresso' ),
- __( 'wait lists', 'event_espresso' )
- ),
-};
-
-/**
- * Translation map for Transaction statuses
- * @type {{}}
- *
- */
-const STATUS_TRANSLATION_MAP_TRANSACTION = {
- [ status.TRANSACTION_STATUS_ID.OVERPAID ]: Label.fromSameSingleAndPlural(
- __( 'overpaid', 'event_espresso' )
- ),
- [ status.TRANSACTION_STATUS_ID.COMPLETE ]: Label.fromSameSingleAndPlural(
- __( 'complete', 'event_espresso' )
- ),
- [ status.TRANSACTION_STATUS_ID.INCOMPLETE ]: Label.fromSameSingleAndPlural(
- __( 'incomplete', 'event_espresso' )
- ),
- [ status.TRANSACTION_STATUS_ID.FAILED ]: Label.fromSameSingleAndPlural(
- __( 'failed', 'event_espresso' )
- ),
- [ status.TRANSACTION_STATUS_ID.ABANDONED ]: Label.fromSameSingleAndPlural(
- __( 'abandoned', 'event_espresso' )
- ),
-};
-
-/**
- * Translation map for payment statuses
- * @type {{}}
- */
-const STATUS_TRANSLATION_MAP_PAYMENT = {
- [ status.PAYMENT_STATUS_ID.APPROVED ]: Label.fromSameSingleAndPlural(
- __( 'accepted', 'event_espresso' )
- ),
- [ status.PAYMENT_STATUS_ID.PENDING ]: Label.fromSameSingleAndPlural(
- __( 'pending', 'event_espresso' )
- ),
- [ status.PAYMENT_STATUS_ID.CANCELLED ]: Label.fromSameSingleAndPlural(
- __( 'cancelled', 'event_espresso' ),
- ),
- [ status.PAYMENT_STATUS_ID.DECLINED ]: Label.fromSameSingleAndPlural(
- __( 'declined', 'event_espresso' ),
- ),
- [ status.PAYMENT_STATUS_ID.FAILED ]: Label.fromSameSingleAndPlural(
- __( 'failed', 'event_espresso' )
- ),
-};
-
-/**
- * Translation map for Message statuses
- * @type {{}}
- */
-const STATUS_TRANSLATION_MAP_MESSAGE = {
- [ status.MESSAGE_STATUS_ID.SENT ]: Label.fromSameSingleAndPlural(
- __( 'sent', 'event_espresso' )
- ),
- [ status.MESSAGE_STATUS_ID.IDLE ]: Label.fromSameSingleAndPlural(
- __( 'queued for sending', 'event_espresso' )
- ),
- [ status.MESSAGE_STATUS_ID.FAIL ]: Label.fromSameSingleAndPlural(
- __( 'failed', 'event_espresso' )
- ),
- [ status.MESSAGE_STATUS_ID.DEBUG ]: Label.fromSameSingleAndPlural(
- __( 'debug only', 'event_espresso' )
- ),
- [ status.MESSAGE_STATUS_ID.EXECUTING ]: Label.fromSameSingleAndPlural(
- __( 'messenger is executing', 'event_espresso' )
- ),
- [ status.MESSAGE_STATUS_ID.RESEND ]: Label.fromSameSingleAndPlural(
- __( 'queued for resending', 'event_espresso' )
- ),
- [ status.MESSAGE_STATUS_ID.INCOMPLETE ]: Label.fromSameSingleAndPlural(
- __( 'queued for generating', 'event_espresso' )
- ),
- [ status.MESSAGE_STATUS_ID.RETRY ]: Label.fromSameSingleAndPlural(
- __( 'failed sending, can be retried', 'event_espresso' )
- ),
-};
-
-/**
- * Translation map for CPT statuses
- * @type {{}}
- */
-const STATUS_TRANSLATION_MAP_CPT = {
- [ status.CPT_STATUS_ID.PUBLISH ]: Label.fromSameSingleAndPlural(
- __( 'published', 'event_espresso' )
- ),
- [ status.CPT_STATUS_ID.FUTURE ]: Label.fromSameSingleAndPlural(
- __( 'scheduled', 'event_espresso' )
- ),
- [ status.CPT_STATUS_ID.DRAFT ]: Label.fromSameSingleAndPlural(
- __( 'draft', 'event_espresso' )
- ),
- [ status.CPT_STATUS_ID.PENDING ]: Label.fromSameSingleAndPlural(
- __( 'pending', 'event_espresso' )
- ),
- [ status.CPT_STATUS_ID.PRIVATE ]: Label.fromSameSingleAndPlural(
- __( 'private', 'event_espresso' )
- ),
- [ status.CPT_STATUS_ID.TRASHED ]: Label.fromSameSingleAndPlural(
- __( 'trashed', 'event_espresso' )
- ),
-};
-
-// the following status maps are for model statuses that are not saved in the
-// status table but for convenience have their labels retrievable via here.
-
-/**
- * Translation map for Event Statuses
- * @type {{}}
- */
-const STATUS_TRANSLATION_MAP_EVENT = {
- [ EVENT_STATUS_ID.SOLD_OUT ]: Label.fromSameSingleAndPlural(
- __( 'sold out', 'event_espresso' )
- ),
- [ EVENT_STATUS_ID.POSTPONED ]: Label.fromSameSingleAndPlural(
- __( 'postponed', 'event_espresso' )
- ),
- [ EVENT_STATUS_ID.CANCELLED ]: Label.fromSameSingleAndPlural(
- __( 'cancelled', 'event_espresso' )
- ),
-};
-
-/**
- * Translation map for Ticket statuses
- * @type {{}}
- */
-const STATUS_TRANSLATION_MAP_TICKET = {
- [ TICKET_STATUS_ID.ARCHIVED ]: Label.fromSameSingleAndPlural(
- __( 'archived', 'event_espresso' )
- ),
- [ TICKET_STATUS_ID.EXPIRED ]: Label.fromSameSingleAndPlural(
- __( 'expired', 'event_espresso' )
- ),
- [ TICKET_STATUS_ID.SOLD_OUT ]: Label.fromSameSingleAndPlural(
- __( 'sold out', 'event_espresso' )
- ),
- [ TICKET_STATUS_ID.PENDING ]: Label.fromSameSingleAndPlural(
- __( 'upcoming', 'event_espresso' )
- ),
- [ TICKET_STATUS_ID.ONSALE ]: Label.fromSameSingleAndPlural(
- __( 'on sale', 'event_espresso' )
- ),
-};
-
-/**
- * Translation map for datetime statuses
- * @type {{}}
- */
-const STATUS_TRANSLATION_MAP_DATETIME = {
- [ DATETIME_STATUS_ID.CANCELLED ]: Label.fromSameSingleAndPlural(
- __( 'cancelled', 'event_espresso' )
- ),
- [ DATETIME_STATUS_ID.SOLD_OUT ]: Label.fromSameSingleAndPlural(
- __( 'sold out', 'event_espresso' )
- ),
- [ DATETIME_STATUS_ID.EXPIRED ]: Label.fromSameSingleAndPlural(
- __( 'expired', 'event_espresso' )
- ),
- [ DATETIME_STATUS_ID.INACTIVE ]: Label.fromSameSingleAndPlural(
- __( 'inactive', 'event_espresso' )
- ),
- [ DATETIME_STATUS_ID.UPCOMING ]: Label.fromSameSingleAndPlural(
- __( 'upcoming', 'event_espresso' )
- ),
- [ DATETIME_STATUS_ID.ACTIVE ]: Label.fromSameSingleAndPlural(
- __( 'active', 'event_espresso' )
- ),
- [ DATETIME_STATUS_ID.POSTPONED ]: Label.fromSameSingleAndPlural(
- __( 'postponed', 'event_espresso' )
- ),
-};
-
-/**
- * Translation map for checkin statuses
- *
- * @type {{}}
- */
-const STATUS_TRANSLATION_MAP_CHECKIN = {
- [ CHECKIN_STATUS_ID.STATUS_CHECKED_IN ]: new Label(
- __( 'check-in', 'event_espresso' ),
- __( 'check-ins', 'event_espresso' )
- ),
- [ CHECKIN_STATUS_ID.STATUS_CHECKED_OUT ]: new Label(
- __( 'check-out', 'event_espresso' ),
- __( 'check-outs', 'event_espresso' )
- ),
- [ CHECKIN_STATUS_ID.STATUS_CHECKED_NEVER ]: Label.fromSameSingleAndPlural(
- __( 'never checked in', 'event_espresso' )
- ),
-};
-
-/**
- * Combined translation map for all statuses.
- * @type {{}}
- */
-const STATUS_TRANSLATION_MAP_ALL = {
- ...STATUS_TRANSLATION_MAP_REGISTRATION,
- ...STATUS_TRANSLATION_MAP_TRANSACTION,
- ...STATUS_TRANSLATION_MAP_PAYMENT,
- ...STATUS_TRANSLATION_MAP_MESSAGE,
- ...STATUS_TRANSLATION_MAP_CPT,
- ...STATUS_TRANSLATION_MAP_EVENT,
- ...STATUS_TRANSLATION_MAP_TICKET,
- ...STATUS_TRANSLATION_MAP_DATETIME,
- ...STATUS_TRANSLATION_MAP_CHECKIN,
- [ status.UNKNOWN_STATUS_ID ]: Label.fromSameSingleAndPlural(
- __( 'unknown', 'event_espresso' )
- ),
-};
-
-/**
- * Returns the pretty status label string for the given arguments.
- *
- * @param {string} statusCode
- * @param {boolean} singular Whether to return the singular or plural label
- * value
- * @param {(sentence|lower|upper)} schema
- * @return {string} Returns the mapped pretty label for the given status code or
- * a formatted 'unkown' string if there is no mapped value for the given code.
- */
-export const prettyStatus = (
- statusCode,
- singular = true,
- schema = Label.FORMAT_SENTENCE_CASE
-) => {
- return STATUS_TRANSLATION_MAP_ALL[ statusCode ] ?
- STATUS_TRANSLATION_MAP_ALL[ statusCode ].asFormatted( singular, schema ) :
- STATUS_TRANSLATION_MAP_ALL[ status.UNKNOWN_STATUS_ID ].asFormatted(
- singular,
- schema
- );
-};
-
-/**
- * Expects an array of status codes and returns an object indexed by codes with
- * values being the formatted pretty labels for each code according to the
- * provided arguments
- *
- * @param {Array} statusCodes
- * @param {boolean} singular
- * @param {(sentence|lower|upper)} schema
- * @return {Object} An object mapping status code to pretty label.
- */
-export const prettyStatuses = (
- statusCodes,
- singular = true,
- schema = Label.FORMAT_SENTENCE_CASE
-) => {
- if ( ! isArray( statusCodes ) ) {
- throw new TypeError( 'Expect incoming statusCodes argument' +
- ' to be an array' );
- }
- const mappedStatuses = {};
- statusCodes.forEach( ( statusCode ) => {
- mappedStatuses[ statusCode ] = prettyStatus(
- statusCode,
- singular,
- schema
- );
- } );
- return mappedStatuses;
-};
diff --git a/assets/src/data/model/status/index.js b/assets/src/data/model/status/index.js
deleted file mode 100644
index fd76422aaba..00000000000
--- a/assets/src/data/model/status/index.js
+++ /dev/null
@@ -1,3 +0,0 @@
-export * from './constants';
-export * from './query';
-export * from './helpers';
diff --git a/assets/src/data/model/status/query.js b/assets/src/data/model/status/query.js
deleted file mode 100644
index 93ac9052659..00000000000
--- a/assets/src/data/model/status/query.js
+++ /dev/null
@@ -1,90 +0,0 @@
-/**
- * External imports
- */
-import { isUndefined } from 'lodash';
-import PropTypes from 'prop-types';
-
-/**
- * Internal dependencies
- */
-import {
- getQueryString as baseGetQueryString,
- QUERY_ORDER_ASC,
- ALLOWED_ORDER_VALUES,
-} from '../base';
-
-/**
- * Described attributes for this model
- * @type {{attributes: *}}
- */
-export const queryDataTypes = {
- queryData: PropTypes.shape( {
- limit: PropTypes.number,
- orderBy: PropTypes.string,
- order: PropTypes.oneOf( ALLOWED_ORDER_VALUES ),
- } ),
-};
-
-/**
- * Default attributes for this model
- * @type {
- * {
- * attributes: {
- * limit: number,
- * orderBy: string,
- * order: string,
- * }
- * }
- * }
- */
-export const defaultQueryData = {
- queryData: {
- limit: 25,
- orderBy: 'statusCode',
- order: QUERY_ORDER_ASC,
- },
-};
-
-/**
- * Used to map an orderBy string to the actual value used in a REST query from
- * the context of an event.
- *
- * @param {string} orderBy
- *
- * @return { string } Returns an actual orderBy string for the REST query for
- * the provided alias
- */
-export const mapOrderBy = ( orderBy ) => {
- const orderByMap = {
- statusCode: 'STS_code',
- };
- return isUndefined( orderByMap[ orderBy ] ) ?
- orderBy :
- orderByMap[ orderBy ];
-};
-
-/**
- * Builds where conditions for an events endpoint request using provided
- * information.
- *
- * @param {number} statusType ID for type of Status to retrieve
- * @return {string} The assembled where conditions.
- */
-export const whereConditions = ( { statusType } ) => {
- const where = [];
- if ( statusType ) {
- where.push( 'where[STS_type]=' + statusType );
- }
- return where.join( '&' );
-};
-
-/**
- * Return a query string for use by a REST request given a set of queryData.
- * @param { Object } queryData
- * @return { string } Returns the query string.
- */
-export const getQueryString = ( queryData = {} ) => {
- queryData = { ...defaultQueryData.queryData, ...queryData };
- return baseGetQueryString( queryData, whereConditions, mapOrderBy );
-};
-
diff --git a/assets/src/data/model/status/test/helpers.js b/assets/src/data/model/status/test/helpers.js
deleted file mode 100644
index 0ba1e7ac3a9..00000000000
--- a/assets/src/data/model/status/test/helpers.js
+++ /dev/null
@@ -1,70 +0,0 @@
-/**
- * External imports
- */
-import { Label } from '@eventespresso/value-objects';
-
-/**
- * Internal imports
- */
-import { prettyStatus, prettyStatuses } from '../helpers';
-import * as status from '../constants';
-
-describe( 'prettyStatus()', () => {
- it( 'returns the expected value for the given code and format', () => {
- const testCases = [
- {
- args: [
- status.REGISTRATION_STATUS_ID.PENDING_PAYMENT,
- false,
- Label.FORMAT_SENTENCE_CASE,
- ],
- expected: 'Pending Payments',
- },
- {
- args: [
- status.TRANSACTION_STATUS_ID.COMPLETE,
- true,
- Label.FORMAT_UPPERCASE,
- ],
- expected: 'COMPLETE',
- },
- {
- args: [
- status.PAYMENT_STATUS_ID.DECLINED,
- true,
- Label.FORMAT_LOWERCASE,
- ],
- expected: 'declined',
- },
- ];
- testCases.forEach( ( testCase ) => {
- expect( prettyStatus( ...testCase.args ) )
- .toBe( testCase.expected );
- } );
- } );
- it( 'returns an "unknown" label for a invalid status', () => {
- expect( prettyStatus( 'not valid' ) ).toBe( 'Unknown' );
- } );
-} );
-
-describe( 'prettyStatuses()', () => {
- it( 'throws a TypeError when provided first argument is not' +
- ' an array.', () => {
- expect( () => prettyStatuses( 'someStatus' ) ).toThrow( TypeError );
- } );
- it( 'returns the expected values for the given codes.', () => {
- expect( prettyStatuses(
- [
- status.REGISTRATION_STATUS_ID.PENDING_PAYMENT,
- status.TRANSACTION_STATUS_ID.OVERPAID,
- status.PAYMENT_STATUS_ID.CANCELLED,
- ]
- ) ).toEqual(
- {
- [ status.REGISTRATION_STATUS_ID.PENDING_PAYMENT ]: 'Pending Payment',
- [ status.TRANSACTION_STATUS_ID.OVERPAID ]: 'Overpaid',
- [ status.PAYMENT_STATUS_ID.CANCELLED ]: 'Cancelled',
- }
- );
- } );
-} );
diff --git a/assets/src/data/model/status/test/index.js b/assets/src/data/model/status/test/index.js
deleted file mode 100644
index 59098edeeb3..00000000000
--- a/assets/src/data/model/status/test/index.js
+++ /dev/null
@@ -1,72 +0,0 @@
-import {
- mapOrderBy,
- whereConditions,
- getQueryString,
-} from '../';
-import * as statusModel from 'assets/src/data/model/status/index';
-
-const testParams = [
- {
- statusType: statusModel.STATUS_TYPE_EMAIL,
- expected: 'email',
- },
- {
- statusType: statusModel.STATUS_TYPE_EVENT,
- expected: 'event',
- },
- {
- statusType: statusModel.STATUS_TYPE_MESSAGE,
- expected: 'message',
- },
- {
- statusType: statusModel.STATUS_TYPE_PAYMENT,
- expected: 'payment',
- },
- {
- statusType: statusModel.STATUS_TYPE_REGISTRATION,
- expected: 'registration',
- },
- {
- statusType: statusModel.STATUS_TYPE_TRANSACTION,
- expected: 'transaction',
- },
-];
-
-describe( 'mapOrderBy()', () => {
- it( 'correctly maps incoming values to the correct expectation', () => {
- const incomingToExpectedMap = {
- statusCode: 'STS_code',
- };
- for ( const incomingOrderBy in incomingToExpectedMap ) {
- const expectedValue = incomingToExpectedMap[ incomingOrderBy ];
- expect( mapOrderBy( incomingOrderBy ) ).toEqual( expectedValue );
- }
- } );
-} );
-
-describe( 'whereConditions()', () => {
- for ( let i = 0; i < testParams.length; i++ ) {
- it( 'returns expected where clause for statusType: ' + testParams[ i ].expected,
- () => {
- expect( whereConditions( testParams[ i ] ) )
- .toEqual( 'where[STS_type]=' + testParams[ i ].expected );
- }
- );
- }
-} );
-
-describe( 'getQueryString()', () => {
- for ( let i = 0; i < testParams.length; i++ ) {
- it( 'returns expected query string for statusType: ' + testParams[ i ].expected,
- () => {
- expect( getQueryString( testParams[ i ] ) )
- .toEqual(
- 'limit=25&' +
- 'order=ASC&' +
- 'order_by=STS_code&' +
- 'where[STS_type]=' + testParams[ i ].expected
- );
- }
- );
- }
-} );
diff --git a/assets/src/data/model/test/assertions.js b/assets/src/data/model/test/assertions.js
deleted file mode 100644
index ff801d05feb..00000000000
--- a/assets/src/data/model/test/assertions.js
+++ /dev/null
@@ -1,89 +0,0 @@
-/**
- * Internal Imports
- */
-import {
- assertEntityHasKey,
- assertImmutableObjectHasPath,
- assertIsArray,
- assertIsNotEmpty,
- assertIsMap,
-} from '../assertions';
-
-/**
- * External imports
- */
-import { Exception } from '@eventespresso/eejs';
-import { Map as IMap } from 'immutable';
-
-describe( 'Testing assertion utilities', () => {
- const tester = ( method, args ) => () => method( ...args );
- const testConditions = [
- [
- assertEntityHasKey,
- [ 'foo', { bar: 'foo' }, '' ],
- [ 'foo', { bar: 'foo' }, 'fail' ],
- [ 'foo', { foo: 'bar' }, '' ],
- ],
- [
- assertImmutableObjectHasPath,
- [ [ 'datetime', 10 ], IMap().set( 'event', IMap().set( 10, {} ) ) ],
- [
- [ 'datetime', 10 ],
- IMap().set( 'event', IMap().set( 10, {} ) ),
- 'fail',
- ],
- [ [ 'event', 10 ], IMap().set( 'event', IMap().set( 10, {} ) ) ],
- ],
- [
- assertIsArray,
- [ 'foo', '' ],
- [ 'foo', 'fail' ],
- [ [ 1, 2 ], '' ],
- ],
- [
- assertIsNotEmpty,
- [ '', '' ],
- [ {}, 'fail' ],
- [ [ 'foo' ], '' ],
- ],
- [
- assertIsMap,
- [ {}, '' ],
- [ {}, 'fail' ],
- [ new Map(), '' ],
- ],
- ];
- testConditions.forEach( ( [
- testMethod,
- throwExceptionArgs,
- customMessageArgs,
- noExceptionArgs,
- ] ) => {
- describe( testMethod.name + '()', () => {
- it( 'throws Exception when assertion fails', () => {
- expect(
- tester(
- testMethod,
- throwExceptionArgs
- )
- ).toThrow( Exception );
- } );
- it( 'throws Exception with custom message', () => {
- expect(
- tester(
- testMethod,
- customMessageArgs
- )
- ).toThrow( 'fail' );
- } );
- it( 'does not throw exception for passing assertion', () => {
- expect(
- tester(
- testMethod,
- noExceptionArgs
- )
- ).not.toThrow();
- } );
- } );
- } );
-} );
diff --git a/assets/src/data/model/test/base.js b/assets/src/data/model/test/base.js
deleted file mode 100644
index 3dfd7de9169..00000000000
--- a/assets/src/data/model/test/base.js
+++ /dev/null
@@ -1,39 +0,0 @@
-import { getQueryString } from '../';
-
-describe( 'getQueryString()', () => {
- const sampleQueryData = {
- limit: 10,
- order: 'asc',
- orderBy: 'ticket_start_date',
- };
- const sampleWhereConditions = () => {
- return 'EVT_ID=10';
- };
- const sampleMapOrderBy = () => {
- return 'Ticket.Datetime.EVT_start_date';
- };
- it( 'returns an empty string with all defaults', () => {
- expect( getQueryString() ).toEqual( '' );
- } );
- it( 'uses the expected passed in values for queryData', () => {
- expect(
- getQueryString( sampleQueryData ),
- ).toEqual(
- 'limit=10&order=asc&order_by=ticket_start_date',
- );
- } );
- it( 'uses passed in whereConditions callback', () => {
- expect(
- getQueryString( sampleQueryData, sampleWhereConditions ),
- ).toEqual(
- 'limit=10&order=asc&order_by=ticket_start_date&EVT_ID=10',
- );
- } );
- it( 'uses passed in mapOrderBy callback', () => {
- expect(
- getQueryString( sampleQueryData, undefined, sampleMapOrderBy ),
- ).toEqual(
- 'limit=10&order=asc&order_by=Ticket.Datetime.EVT_start_date',
- );
- } );
-} );
diff --git a/assets/src/data/model/test/default-model-state.js b/assets/src/data/model/test/default-model-state.js
deleted file mode 100644
index 934ee1749d2..00000000000
--- a/assets/src/data/model/test/default-model-state.js
+++ /dev/null
@@ -1,50 +0,0 @@
-import {
- DEFAULT_LISTS_STATE,
- DEFAULT_CORE_STATE,
-} from '../default-model-state';
-
-describe( 'DEFAULT_LISTS_STATE', () => {
- it( 'matches expected initial state for the models exposed ' +
- 'on the endpoints', () => {
- const expectedState = {
- datetime: {},
- datetime_ticket: {},
- event: {},
- ticket: {},
- venue: {},
- term: {},
- checkin: {},
- registration: {},
- };
- expect( DEFAULT_LISTS_STATE ).toEqual( expectedState );
- } );
-} );
-
-describe( 'DEFAULT_CORE_STATE', () => {
- it( 'matches expected initial state for the models exposed' +
- ' on the endpoints', () => {
- const expectedState = {
- entities: {
- datetime: {},
- datetime_ticket: {},
- event: {},
- ticket: {},
- venue: {},
- term: {},
- checkin: {},
- registration: {},
- },
- relations: {},
- dirty: {
- relations: {
- index: {},
- delete: {},
- add: {},
- },
- trash: {},
- delete: {},
- },
- };
- expect( DEFAULT_CORE_STATE ).toEqual( expectedState );
- } );
-} );
diff --git a/assets/src/data/model/test/endpoints.js b/assets/src/data/model/test/endpoints.js
deleted file mode 100644
index 301073ff118..00000000000
--- a/assets/src/data/model/test/endpoints.js
+++ /dev/null
@@ -1,50 +0,0 @@
-import { Exception } from '@eventespresso/eejs';
-
-import {
- endpoints,
- getEndpoint,
- applyQueryString,
-} from '../endpoints';
-
-describe( 'endpoints', () => {
- it( 'has the expected values from eejs.data', () => {
- expect( endpoints ).toEqual(
- {
- datetime: '/ee/v4.8.36/datetimes',
- datetime_ticket: '/ee/v4.8.36/datetime_tickets',
- event: '/ee/v4.8.36/events',
- ticket: '/ee/v4.8.36/tickets',
- venue: '/ee/v4.8.36/venues',
- term: '/ee/v4.8.36/terms',
- checkin: '/ee/v4.8.36/checkins',
- registration: '/ee/v4.8.36/registrations',
- },
- );
- } );
-} );
-
-describe( 'getEndpoint()', () => {
- it( 'throws an Exception if requested model is not' +
- ' available.', () => {
- const t = () => {
- getEndpoint( 'model_not_exist' );
- };
- expect( t ).toThrow( Exception );
- } );
-
- it( 'returns the correct endpoint value for the requested model', () => {
- expect(
- getEndpoint( 'event' ),
- ).toEqual( '/ee/v4.8.36/events' );
- } );
-} );
-
-describe( 'applyQueryString()', () => {
- it( 'returns the expected value for the provided query string' +
- ' for a valid model', () => {
- const queryString = 'something=1';
- expect(
- applyQueryString( 'event', queryString ),
- ).toEqual( '/ee/v4.8.36/events?' + queryString );
- } );
-} );
diff --git a/assets/src/data/model/test/model-names.js b/assets/src/data/model/test/model-names.js
deleted file mode 100644
index 52e503d8c66..00000000000
--- a/assets/src/data/model/test/model-names.js
+++ /dev/null
@@ -1,32 +0,0 @@
-import {
- MODEL_NAMES,
- modelNameForQueryString,
-} from '../model-names';
-
-describe( 'MODEL_NAMES', () => {
- it( 'returns the expected values for models', () => {
- expect( MODEL_NAMES ).toEqual(
- [
- 'event',
- 'datetime',
- 'ticket',
- 'venue',
- 'term',
- 'checkin',
- 'registration',
- ]
- );
- } );
-} );
-
-describe( 'modelNameForQueryString()', () => {
- [
- [ 'event', 'Event' ],
- [ 'message_template_group', 'Message_Template_Group' ],
- ].forEach( ( [ incomingString, expectedValue ] ) => {
- it( `returns expected format for the string: ${ incomingString }`, () => {
- expect( modelNameForQueryString( incomingString ) )
- .toBe( expectedValue );
- } );
- } );
-} );
diff --git a/assets/src/data/model/test/primary-keys.js b/assets/src/data/model/test/primary-keys.js
deleted file mode 100644
index 7ecbe7b252d..00000000000
--- a/assets/src/data/model/test/primary-keys.js
+++ /dev/null
@@ -1,180 +0,0 @@
-import { Exception } from '@eventespresso/eejs';
-
-import {
- primaryKeys,
- valuesForCombinedPrimaryKeys,
- valueForPrimaryKey,
- getPrimaryKey,
- getPrimaryKeyQueryString,
- getEntityPrimaryKeyValues,
- keyEntitiesByPrimaryKeyValue,
-} from '../primary-keys';
-
-describe( 'primaryKeys', () => {
- it( 'has the expected values from the mock data', () => {
- expect( primaryKeys ).toEqual(
- {
- datetime: 'DTT_ID',
- event: 'EVT_ID',
- ticket: 'TKT_ID',
- venue: 'VNU_ID',
- term: [ 'TERM_ID', 'TAXONOMY_ID' ],
- checkin: [ 'CHK_ID' ],
- registration: [ 'REG_ID' ],
- },
- );
- } );
-} );
-
-describe( 'valuesForCombinedPrimaryKeys()', () => {
- it( 'throws an Exception if the provided keys argument is not' +
- ' an array', () => {
- const t = () => {
- valuesForCombinedPrimaryKeys( 'EVT_ID', {} );
- };
- expect( t ).toThrow( Exception );
- expect( t ).toThrow( 'The provided value is not an array.' );
- } );
-
- it( 'throws an Exception if the provided entity does not have any' +
- ' of the keys provided', () => {
- const t = () => {
- valuesForCombinedPrimaryKeys(
- [ 'TERM_ID', 'TAXONOMY_ID' ],
- { EVT_ID: 1 },
- );
- };
- expect( t ).toThrow( Exception );
- expect( t ).toThrow( /does not have the given property/ );
- } );
- it( 'returns the expected values from the object formatted' +
- ' like "%s.%s"', () => {
- expect(
- valuesForCombinedPrimaryKeys(
- [ 'TERM_ID', 'TAXONOMY_ID' ],
- { TERM_ID: 20, TAXONOMY_ID: 30, extra: 'something' },
- ),
- ).toEqual( '20:30' );
- } );
-} );
-
-describe( 'valueForPrimaryKey()', () => {
- it( 'throws an Exception if the provided key argument does not exist in' +
- ' the provided entity', () => {
- const t = () => {
- valueForPrimaryKey( 'EVT_ID', { TERM_ID: 10 } );
- };
- expect( t ).toThrow( Exception );
- expect( t ).toThrow( /does not have the given property/ );
- } );
- it( 'returns the expected value for the provided key from the provided' +
- ' entity.', () => {
- expect( valueForPrimaryKey( 'EVT_ID', { EVT_ID: 10, name: 'Event' } ) )
- .toEqual( 10 );
- } );
-} );
-
-describe( 'getPrimaryKey()', () => {
- it( 'throws an Exception if the provided model does not exist in the data',
- () => {
- const t = () => {
- getPrimaryKey( 'invalid_model' );
- };
- expect( t ).toThrow( Exception );
- expect( t ).toThrow( /does not have the given property/ );
- },
- );
-
- it( 'returns the expected key from the mock data for the provided' +
- ' modelName', () => {
- expect( getPrimaryKey( 'event' ) ).toEqual( 'EVT_ID' );
- expect( getPrimaryKey( 'term' ) )
- .toEqual( [ 'TERM_ID', 'TAXONOMY_ID' ] );
- } );
-} );
-
-describe( 'getPrimaryKeyQueryString()', () => {
- it( 'throws an Exception if the provided model does not exist in the ' +
- 'data', () => {
- const t = () => getPrimaryKeyQueryString( 'cheese', [ 2 ] );
- expect( t ).toThrow( Exception );
- expect( t ).toThrow( /does not have the given property/ );
- } );
- it( 'returns the expected query string for the given model', () => {
- expect( getPrimaryKeyQueryString( 'event', [ 10, 11 ] ) ).toEqual(
- '[EVT_ID][IN]=10,11'
- );
- } );
-} );
-
-describe( 'getEntityPrimaryKeyValues()', () => {
- it( 'returns expected value from provided entity belonging to a model' +
- ' with a singular primary key', () => {
- expect( getEntityPrimaryKeyValues( 'event', { EVT_ID: 10 } ) )
- .toEqual( 10 );
- } );
- it( 'returns expected value from provided entity belonging to a model ' +
- 'with combined primary keys', () => {
- expect( getEntityPrimaryKeyValues(
- 'term',
- { TERM_ID: 10, TAXONOMY_ID: 20 },
- ) ).toEqual( '10:20' );
- } );
-} );
-
-describe( 'keyEntitiesByPrimaryKeyValue()', () => {
- it( 'throws an error if entities is empty', () => {
- const t = () => {
- keyEntitiesByPrimaryKeyValue( 'event', [] );
- };
- expect( t ).toThrow( Exception );
- expect( t )
- .toThrow( 'The provided array of entities must not be empty' );
- } );
- it( 'throws an error if entities is not an array', () => {
- const t = () => {
- keyEntitiesByPrimaryKeyValue( 'event', { EVT_ID: 10 } );
- };
- expect( t ).toThrow( Exception );
- expect( t )
- .toThrow( 'The provided value is not an array.' );
- } );
- it( 'returns the expected format for the entity records which is a ' +
- 'collection indexed by the primary keys for the entities' +
- ' (singular primary key)', () => {
- const expectedResponse = new Map(
- [
- [ 10, { EVT_ID: 10 } ],
- [ 20, { EVT_ID: 20 } ],
- [ 50, { EVT_ID: 50 } ],
- ]
- );
- expect( keyEntitiesByPrimaryKeyValue(
- 'event',
- [
- { EVT_ID: 10 },
- { EVT_ID: 20 },
- { EVT_ID: 50 },
- ],
- ) ).toEqual( expectedResponse );
- } );
- it( 'returns the expected format for the entity records which is a ' +
- 'collection indexed by the primary keys for the entities' +
- ' (combined primary keys)', () => {
- const expectedResponse = new Map(
- [
- [ '10:20', { TERM_ID: 10, TAXONOMY_ID: 20 } ],
- [ '20:10', { TERM_ID: 20, TAXONOMY_ID: 10 } ],
- [ '50:6', { TERM_ID: 50, TAXONOMY_ID: 6 } ],
- ]
- );
- expect( keyEntitiesByPrimaryKeyValue(
- 'term',
- [
- { TERM_ID: 10, TAXONOMY_ID: 20 },
- { TERM_ID: 20, TAXONOMY_ID: 10 },
- { TERM_ID: 50, TAXONOMY_ID: 6 },
- ],
- ) ).toEqual( expectedResponse );
- } );
-} );
diff --git a/assets/src/data/model/ticket/constants.js b/assets/src/data/model/ticket/constants.js
deleted file mode 100644
index 1e2530fb4c3..00000000000
--- a/assets/src/data/model/ticket/constants.js
+++ /dev/null
@@ -1,16 +0,0 @@
-/**
- * External imports
- */
-import { values } from 'lodash';
-
-export const MODEL_NAME = 'ticket';
-
-export const TICKET_STATUS_ID = {
- SOLD_OUT: 'TKS',
- EXPIRED: 'TKE',
- ARCHIVED: 'TKA',
- PENDING: 'TKP',
- ONSALE: 'TKO',
-};
-
-export const TICKET_STATUS_IDS = values( TICKET_STATUS_ID );
diff --git a/assets/src/data/model/ticket/index.js b/assets/src/data/model/ticket/index.js
deleted file mode 100644
index 368ab8bf184..00000000000
--- a/assets/src/data/model/ticket/index.js
+++ /dev/null
@@ -1,2 +0,0 @@
-export * from './constants';
-export * from './query';
diff --git a/assets/src/data/model/ticket/query.js b/assets/src/data/model/ticket/query.js
deleted file mode 100644
index 67734270590..00000000000
--- a/assets/src/data/model/ticket/query.js
+++ /dev/null
@@ -1,135 +0,0 @@
-/**
- * External imports
- */
-import moment from 'moment-timezone';
-import { isUndefined } from 'lodash';
-import PropTypes from 'prop-types';
-
-import {
- getQueryString as baseGetQueryString,
- QUERY_ORDER_DESC,
- ALLOWED_ORDER_VALUES,
- GREATER_THAN,
- GREATER_THAN_AND_EQUAL,
- LESS_THAN_AND_EQUAL,
-} from '../base';
-
-export const nowDateAndTime = moment();
-
-/**
- * Described attributes for this model
- * @type {{attributes: *}}
- */
-export const queryDataTypes = {
- queryData: PropTypes.shape( {
- limit: PropTypes.number,
- orderBy: PropTypes.oneOf( [
- 'TKT_name',
- 'TKT_ID',
- 'start_date',
- 'end_date',
- ] ),
- order: PropTypes.oneOf( ALLOWED_ORDER_VALUES ),
- showExpired: PropTypes.bool,
- month: PropTypes.month,
- } ),
-};
-
-/**
- * Default attributes for this model
- * @type {
- * {
- * attributes: {
- * limit: number,
- * orderBy: string,
- * order: string,
- * showExpired: boolean
- * }
- * }
- * }
- */
-export const defaultQueryData = {
- queryData: {
- limit: 100,
- orderBy: 'start_date',
- order: QUERY_ORDER_DESC,
- showExpired: false,
- },
-};
-
-/**
- * Used to map an orderBy string to the actual value used in a REST query from
- * the context of a ticket.
- *
- * @param {string} orderBy
- *
- * @return { string } Returns an actual orderBy string for the REST query for
- * the provided alias
- */
-export const mapOrderBy = ( orderBy ) => {
- const orderByMap = {
- start_date: 'TKT_start_date',
- end_date: 'TKT_end_date',
- };
- return isUndefined( orderByMap[ orderBy ] ) ?
- orderBy :
- orderByMap[ orderBy ];
-};
-
-/**
- * Builds where conditions for an tickets endpoint request using provided
- * information.
- *
- * @param {boolean} showExpired Whether or not to include expired tickets.
- * @param {string} month Return tickets for the given month. Can be
- * in any month format recognized by moment
- * @param {number} forEventId ID of Event to retrieve tickets for
- * @param {number} forDatetimeId ID of Datetime to retrieve tickets for
- * @return {string} The assembled where conditions.
- */
-export const whereConditions = ( {
- forEventId = 0,
- forDatetimeId = 0,
- showExpired = false,
- month = 'none',
-} ) => {
- const where = [];
- if ( ! showExpired ) {
- where.push(
- 'where[TKT_end_date**expired][]=' + GREATER_THAN +
- '&where[TKT_end_date**expired][]=' +
- nowDateAndTime.local().format()
- );
- }
- if ( month && month !== 'none' ) {
- where.push(
- 'where[TKT_start_date][]=' + GREATER_THAN_AND_EQUAL +
- '&where[TKT_start_date][]=' +
- moment().month( month ).startOf( 'month' ).local().format()
- );
- where.push(
- 'where[TKT_end_date][]=' + LESS_THAN_AND_EQUAL +
- '&where[TKT_end_date][]=' +
- moment().month( month ).endOf( 'month' ).local().format()
- );
- }
- forEventId = parseInt( forEventId, 10 );
- if ( forEventId !== 0 && ! isNaN( forEventId ) ) {
- where.push( 'where[Datetime.Event.EVT_ID]=' + forEventId );
- }
- forDatetimeId = parseInt( forDatetimeId, 10 );
- if ( forDatetimeId !== 0 && ! isNaN( forDatetimeId ) ) {
- where.push( 'where[Datetime.DTT_ID]=' + forDatetimeId );
- }
- return where.join( '&' );
-};
-
-/**
- * Return a query string for use by a REST request given a set of queryData.
- * @param { Object } queryData
- * @return { string } Returns the query string.
- */
-export const getQueryString = ( queryData = {} ) => {
- queryData = { ...defaultQueryData.queryData, ...queryData };
- return baseGetQueryString( queryData, whereConditions, mapOrderBy );
-};
diff --git a/assets/src/data/model/ticket/test/index.js b/assets/src/data/model/ticket/test/index.js
deleted file mode 100644
index 7755ff79052..00000000000
--- a/assets/src/data/model/ticket/test/index.js
+++ /dev/null
@@ -1,74 +0,0 @@
-import {
- mapOrderBy,
- whereConditions,
- getQueryString,
- nowDateAndTime,
-} from '../';
-import {
- GREATER_THAN,
- GREATER_THAN_AND_EQUAL,
- LESS_THAN_AND_EQUAL,
-} from '../../base';
-import moment from 'moment-timezone';
-
-const expectedNow = nowDateAndTime.local().format();
-
-describe( 'mapOrderBy()', () => {
- it( 'correctly maps incoming values to the correct expectation', () => {
- const incomingToExpectedMap = {
- start_date: 'TKT_start_date',
- end_date: 'TKT_end_date',
- };
- for ( const incomingOrderBy in incomingToExpectedMap ) {
- const expectedValue = incomingToExpectedMap[ incomingOrderBy ];
- expect( mapOrderBy( incomingOrderBy ) ).toEqual( expectedValue );
- }
- } );
-} );
-
-describe( 'whereConditions()', () => {
- it( 'returns expected default for empty object passed in', () => {
- expect( whereConditions( {} ) ).toEqual(
- 'where[TKT_end_date**expired][]=' + GREATER_THAN +
- '&where[TKT_end_date**expired][]=' + expectedNow
- );
- } );
- it( 'returns expected string for values passed in', () => {
- const expectedEndofDate = moment()
- .month( 'may' )
- .endOf( 'month' )
- .local()
- .format();
- const expectedStartofDate = moment()
- .month( 'may' )
- .startOf( 'month' )
- .local()
- .format();
- const testObject = {
- showExpired: false,
- forEventId: 20,
- forDatetimeId: 123,
- month: 'may',
- };
- expect( whereConditions( testObject ) ).toEqual(
- 'where[TKT_end_date**expired][]=' + GREATER_THAN +
- '&where[TKT_end_date**expired][]=' + expectedNow +
- '&where[TKT_start_date][]=' + GREATER_THAN_AND_EQUAL +
- '&where[TKT_start_date][]=' + expectedStartofDate +
- '&where[TKT_end_date][]=' + LESS_THAN_AND_EQUAL +
- '&where[TKT_end_date][]=' + expectedEndofDate +
- '&where[Datetime.Event.EVT_ID]=' + 20 +
- '&where[Datetime.DTT_ID]=' + 123
- );
- } );
-} );
-
-describe( 'getQueryString', () => {
- it( 'returns expected default for no arguments passed in', () => {
- expect( getQueryString() ).toEqual(
- 'limit=100&order=DESC&order_by=TKT_start_date' +
- '&where[TKT_end_date**expired][]=' + GREATER_THAN +
- '&where[TKT_end_date**expired][]=' + expectedNow
- );
- } );
-} );
diff --git a/assets/src/editor/.gitignore b/assets/src/editor/.gitignore
deleted file mode 100644
index e69de29bb2d..00000000000
diff --git a/assets/src/editor/hocs/index.js b/assets/src/editor/hocs/index.js
deleted file mode 100644
index 243f1e7b71e..00000000000
--- a/assets/src/editor/hocs/index.js
+++ /dev/null
@@ -1 +0,0 @@
-export { default as NotWithPostTypeCheck } from './not-with-post-type-check';
diff --git a/assets/src/editor/hocs/not-with-post-type-check/index.js b/assets/src/editor/hocs/not-with-post-type-check/index.js
deleted file mode 100644
index 2fab68628c2..00000000000
--- a/assets/src/editor/hocs/not-with-post-type-check/index.js
+++ /dev/null
@@ -1,41 +0,0 @@
-/**
- * External Imports
- */
-import { some, castArray } from 'lodash';
-import { withSelect } from '@wordpress/data';
-
-/**
- * A component with renders its own children oly if the current editor post type
- * is not one of the given `excludedPostTypeSlugs` prop.
- *
- * @param {string} postType
- * @param {WPElement} children
- * @param {(string|string[])} excludedPostTypeSlugs
- * @return {?WPElement} Rendered element or null.
- * @constructor
- */
-export function NotWithPostTypeCheck( {
- postType,
- children,
- excludedPostTypeSlugs,
-} ) {
- let isExcluded = false;
- if ( postType ) {
- isExcluded = some(
- castArray( excludedPostTypeSlugs ),
- ( type ) => postType === type
- );
- }
- if ( isExcluded ) {
- return null;
- }
-
- return children;
-}
-
-export default withSelect( ( select ) => {
- const { getEditedPostAttribute } = select( 'core/editor' );
- return {
- postType: getEditedPostAttribute( 'type' ),
- };
-} )( NotWithPostTypeCheck );
diff --git a/assets/src/editor/hocs/not-with-post-type-check/test/index.js b/assets/src/editor/hocs/not-with-post-type-check/test/index.js
deleted file mode 100644
index 0b398ea724b..00000000000
--- a/assets/src/editor/hocs/not-with-post-type-check/test/index.js
+++ /dev/null
@@ -1,58 +0,0 @@
-/**
- * Internal imports
- */
-import { NotWithPostTypeCheck } from '../index';
-
-/**
- * External imports
- */
-import renderer from 'react-test-renderer';
-
-describe( 'NotWithPostTypeCheck Component Test', () => {
- const SubComponent = () => {
- return Hello
;
- };
- const getTestComponent = ( postTypes ) => {
- const props = {
- postType: 'page',
- excludedPostTypeSlugs: postTypes,
- };
- return (
-
-
-
- );
- };
- const testConditions = [
- [
- 'returns null if given post types exist for post type as string',
- 'page',
- false,
- ],
- [
- 'returns null if given post types exist for post type as array',
- [ 'page', 'post' ],
- false,
- ],
- [
- 'returns expected children if given post type does not exist',
- 'post',
- true,
- ],
- ];
- testConditions.forEach( ( [
- description,
- postTypes,
- expectRendered,
- ] ) => {
- const rendered = renderer.create( getTestComponent( postTypes ) );
- const instance = rendered.root;
- it( description, () => {
- if ( expectRendered ) {
- expect( instance.children[ 0 ].type ).toEqual( SubComponent );
- } else {
- expect( instance.children ).toEqual( [] );
- }
- } );
- } );
-} );
diff --git a/assets/src/eejs/currency_config.js b/assets/src/eejs/currency_config.js
deleted file mode 100644
index 9b49a540fe1..00000000000
--- a/assets/src/eejs/currency_config.js
+++ /dev/null
@@ -1,9 +0,0 @@
-import data from './data';
-
-/**
- * Provided via the data passed along by the server.
- * This data a configuration object passed along from the server that indicates
- * the default currency settings from the server.
- * @type {{}}
- */
-export const { currency_config: currencyConfig = {} } = data;
diff --git a/assets/src/eejs/data.js b/assets/src/eejs/data.js
deleted file mode 100644
index b9bb60acae5..00000000000
--- a/assets/src/eejs/data.js
+++ /dev/null
@@ -1,6 +0,0 @@
-/**
- * This will hold arbitrary data assigned by the Assets Registry.
- * @type {{}}
- */
-const data = eejsdata.data || {};
-export default data;
diff --git a/assets/src/eejs/exceptions/general.js b/assets/src/eejs/exceptions/general.js
deleted file mode 100644
index b784f6d8020..00000000000
--- a/assets/src/eejs/exceptions/general.js
+++ /dev/null
@@ -1,32 +0,0 @@
-/**
- * General EE Exception
- * Usage: throw new eejs.Exception('some message')
- * @param {string} message
- * @param {...mixed} args
- * @return {Exception} instance
- */
-function Exception( message, ...args ) {
- const instance = new Error( message, ...args );
- Object.setPrototypeOf( instance, Object.getPrototypeOf( this ) );
- if ( Error.captureStackTrace ) {
- Error.captureStackTrace( instance, Exception );
- }
- return instance;
-}
-
-Exception.prototype = Object.create( Error.prototype, {
- constructor: {
- value: Error,
- enumerable: false,
- writable: true,
- configurable: true,
- },
-} );
-
-if ( Object.setPrototypeOf ) {
- Object.setPrototypeOf( Exception, Error );
-} else {
- Exception.__proto__ = Error;
-}
-
-export default Exception;
diff --git a/assets/src/eejs/exceptions/index.js b/assets/src/eejs/exceptions/index.js
deleted file mode 100644
index 99a8299ef28..00000000000
--- a/assets/src/eejs/exceptions/index.js
+++ /dev/null
@@ -1,9 +0,0 @@
-export { default as Exception } from './general';
-export { default as InvalidSchema } from './invalid-schema';
-export { default as InvalidArgument } from './invalid-argument';
-export { default as InvalidTimezone } from './invalid-timezone';
-export { default as InvalidISO8601String } from './invalid-iso8601-string';
-export { default as InvalidLocale } from './invalid-locale';
-export { default as InvalidDatetime } from './invalid-datetime';
-export { default as InvalidType } from './invalid-type';
-export { default as InvalidModelEntity } from './invalid-model-entity';
diff --git a/assets/src/eejs/exceptions/invalid-argument.js b/assets/src/eejs/exceptions/invalid-argument.js
deleted file mode 100644
index 4bac2dcd8d4..00000000000
--- a/assets/src/eejs/exceptions/invalid-argument.js
+++ /dev/null
@@ -1,43 +0,0 @@
-/**
- * InvalidArgument
- * Usage: throw new eejs.InvalidArgument('some message'[, argument])
- *
- * Typically this error is thrown when a function or method is called with an
- * invalid argument for a given parameter. It could still be the right type
- * but its an unexpected value.
- *
- * @param {string} message
- * @param {mixed} argumentValue Optional, the argument that caused the error.
- * @param {...mixed} args
- * @return {InvalidArgument} instance of InvalidArgument
- */
-function InvalidArgument( message, argumentValue, ...args ) {
- const instance = new Error( message, ...args );
- Object.setPrototypeOf( instance, Object.getPrototypeOf( this ) );
- instance.argumentValue = argumentValue || null;
- instance.name = instance.constructor.name;
- instance.message = instance.message !== '' ?
- 'Invalid argument provided. ' + instance.message :
- 'Invalid argument provided.';
- if ( Error.captureStackTrace ) {
- Error.captureStackTrace( instance, InvalidArgument );
- }
- return instance;
-}
-
-InvalidArgument.prototype = Object.create( Error.prototype, {
- constructor: {
- value: Error,
- enumerable: false,
- writable: true,
- configurable: true,
- },
-} );
-
-if ( Object.setPrototypeOf ) {
- Object.setPrototypeOf( InvalidArgument, Error );
-} else {
- InvalidArgument.__proto__ = Error;
-}
-
-export default InvalidArgument;
diff --git a/assets/src/eejs/exceptions/invalid-datetime.js b/assets/src/eejs/exceptions/invalid-datetime.js
deleted file mode 100644
index 77b980c59d4..00000000000
--- a/assets/src/eejs/exceptions/invalid-datetime.js
+++ /dev/null
@@ -1,27 +0,0 @@
-/**
- * Internal imports
- */
-import InvalidType from './invalid-type';
-
-/**
- * InvalidDateTime
- * Usage: throw new eejs.InvalidDateTime('some message', [datetime])
- *
- * Typically this error is thrown when a given string is not a valid datetime
- * string.
- *
- * @param {string} msg
- * @param {mixed} datetime Optional, the datetime string that is invalid
- */
-export default class InvalidDateTime extends InvalidType {
- constructor( datetime, message, ...args ) {
- super( message, ...args );
- if ( Error.captureStackTrace ) {
- Error.captureStackTrace( this, InvalidDateTime );
- }
- this.message = 'The value provided is not a valid DateTime. ' +
- this.message;
- this.datetime = datetime || '';
- this.name = 'InvalidDateTime';
- }
-}
diff --git a/assets/src/eejs/exceptions/invalid-iso8601-string.js b/assets/src/eejs/exceptions/invalid-iso8601-string.js
deleted file mode 100644
index db4d84372b2..00000000000
--- a/assets/src/eejs/exceptions/invalid-iso8601-string.js
+++ /dev/null
@@ -1,28 +0,0 @@
-/**
- * Internal Imports
- */
-import InvalidArgument from './invalid-argument';
-
-/**
- * InvalidIso8601String
- * Usage: throw new eejs.InvalidISO8601String('some message', [dateTimeString])
- *
- * Typically this error is thrown when a given string is not the correct format
- * for ISO 8601.
- *
- * @param {string} msg
- * @param {mixed} dateTimeString Optional, the timezone string that is invalid
- */
-export default class InvalidISO8601String extends InvalidArgument {
- constructor( dateTimeString, message = '', ...args ) {
- message = message ?
- 'The string provided is not a valid ISO 8601 formatted string. ' +
- message :
- 'The string provided is not a valid ISO 8601 formatted string.';
- super( message, dateTimeString, ...args );
- if ( Error.captureStackTrace ) {
- Error.captureStackTrace( this, InvalidISO8601String );
- }
- this.dateTimeString = dateTimeString || '';
- }
-}
diff --git a/assets/src/eejs/exceptions/invalid-locale.js b/assets/src/eejs/exceptions/invalid-locale.js
deleted file mode 100644
index 99928e06abf..00000000000
--- a/assets/src/eejs/exceptions/invalid-locale.js
+++ /dev/null
@@ -1,27 +0,0 @@
-/**
- * Internal imports
- */
-import InvalidArgument from './invalid-argument';
-
-/**
- * InvalidLocale
- * Usage: throw new eejs.InvalidLocale('some message', [locale])
- *
- * Typically this error is thrown when a given string is not a valid locale
- * string.
- *
- * @param {string} msg
- * @param {mixed} locale Optional, the locale string that is invalid
- */
-export default class InvalidLocale extends InvalidArgument {
- constructor(locale, message = '', ...args) {
- message = message ?
- 'The locale string provided (' + JSON.stringify(locale)+') is not valid. ' + message :
- 'The locale string provided (' + JSON.stringify(locale) + ') is not valid.';
- super(message, locale, ...args);
- if ( Error.captureStackTrace ) {
- Error.captureStackTrace( this, InvalidLocale );
- }
- this.locale = locale || '';
- }
-}
diff --git a/assets/src/eejs/exceptions/invalid-model-entity.js b/assets/src/eejs/exceptions/invalid-model-entity.js
deleted file mode 100644
index e98ff31dafd..00000000000
--- a/assets/src/eejs/exceptions/invalid-model-entity.js
+++ /dev/null
@@ -1,26 +0,0 @@
-/**
- * Internal imports
- */
-import InvalidType from './invalid-type';
-
-/**
- * InvalidSchema
- * Usage: throw new eejs.InvalidSchema('some message', [schema object])
- *
- * Typically this error is thrown when an object representing a model schema
- * (at a minimum) does not have a "properties" property).
- *
- * @param {string} msg
- * @param {mixed} schema Optional, the schema object which will be added to a
- * schema property.
- */
-export default class InvalidModelEntity extends InvalidType {
- constructor( ...args ) {
- super( ...args );
- if ( Error.captureStackTrace ) {
- Error.captureStackTrace( this, InvalidModelEntity );
- }
- this.message = 'Invalid model entity instance provided.' + this.message;
- this.modelEntity = args[ 1 ] || {};
- }
-}
diff --git a/assets/src/eejs/exceptions/invalid-schema.js b/assets/src/eejs/exceptions/invalid-schema.js
deleted file mode 100644
index 6c0842a5a1e..00000000000
--- a/assets/src/eejs/exceptions/invalid-schema.js
+++ /dev/null
@@ -1,27 +0,0 @@
-/**
- * Internal imports
- */
-import InvalidType from './invalid-type';
-
-/**
- * InvalidSchema
- * Usage: throw new eejs.InvalidSchema('some message', [schema object])
- *
- * Typically this error is thrown when an object representing a model schema
- * (at a minimum) does not have a "properties" property).
- *
- * @param {string} msg
- * @param {mixed} schema Optional, the schema object which will be added to a
- * schema property.
- */
-export default class InvalidSchema extends InvalidType {
- constructor( ...args ) {
- super( ...args );
- if ( Error.captureStackTrace ) {
- Error.captureStackTrace( this, InvalidSchema );
- }
- this.message = 'Invalid schema object provided. Must have a' +
- ' "properties" property.' + this.message;
- this.schema = args[ 1 ] || {};
- }
-}
diff --git a/assets/src/eejs/exceptions/invalid-timezone.js b/assets/src/eejs/exceptions/invalid-timezone.js
deleted file mode 100644
index 0ab34a7f477..00000000000
--- a/assets/src/eejs/exceptions/invalid-timezone.js
+++ /dev/null
@@ -1,27 +0,0 @@
-/**
- * Internal imports
- */
-import InvalidArgument from './invalid-argument';
-
-/**
- * InvalidTimezone
- * Usage: throw new eejs.InvalidTimezone('some message', [timezone])
- *
- * Typically this error is thrown when a given string is not a valid timezone
- * string.
- *
- * @param {string} msg
- * @param {mixed} timezone Optional, the timezone string that is invalid
- */
-export default class InvalidTimezone extends InvalidArgument {
- constructor( timezone, message = '', ...args ) {
- message = message ?
- 'The timezone string provided is not valid. ' + message :
- 'The timezone string provided is not valid.';
- super( message, timezone, ...args );
- if ( Error.captureStackTrace ) {
- Error.captureStackTrace( this, InvalidTimezone );
- }
- this.timezone = timezone || '';
- }
-}
diff --git a/assets/src/eejs/exceptions/invalid-type.js b/assets/src/eejs/exceptions/invalid-type.js
deleted file mode 100644
index 97122be0c1d..00000000000
--- a/assets/src/eejs/exceptions/invalid-type.js
+++ /dev/null
@@ -1,44 +0,0 @@
-/**
- * InvalidType
- * Usage: throw new eejs.InvalidType('some message'[, argument])
- *
- * This is essentially a wrapper around the native `TypeError` error handler.
- * The purpose is to allow for more custom specific type errors to be created
- * using ES6 syntax since there are usually transpiling issues using ES6 syntax
- * extending native Errors.
- *
- * @param {string} message
- * @param {mixed} argumentValue Optional, the argument that caused the error.
- * @param {...mixed} args
- * @return {InvalidType} instance of InvalidType
- */
-function InvalidType( message, argumentValue, ...args ) {
- const instance = new TypeError( message, ...args );
- Object.setPrototypeOf( instance, Object.getPrototypeOf( this ) );
- instance.argumentValue = argumentValue || null;
- instance.name = instance.constructor.name;
- instance.message = instance.message !== '' ?
- 'Invalid type provided. ' + instance.message :
- 'Invalid type provided.';
- if ( Error.captureStackTrace ) {
- Error.captureStackTrace( instance, InvalidType );
- }
- return instance;
-}
-
-InvalidType.prototype = Object.create( TypeError.prototype, {
- constructor: {
- value: TypeError,
- enumerable: false,
- writable: true,
- configurable: true,
- },
-} );
-
-if ( Object.setPrototypeOf ) {
- Object.setPrototypeOf( InvalidType, TypeError );
-} else {
- InvalidType.__proto__ = TypeError;
-}
-
-export default InvalidType;
diff --git a/assets/src/eejs/index.js b/assets/src/eejs/index.js
deleted file mode 100644
index 0db9aed79d5..00000000000
--- a/assets/src/eejs/index.js
+++ /dev/null
@@ -1,52 +0,0 @@
-/**
- * WordPress imports
- */
-import * as wpI18n from '@wordpress/i18n';
-
-/**
- * Exported to the `eejs` global.
- */
-export { default as data } from './data';
-
-/**
- * Wrapper around wp.i18n functionality so its exposed on the eejs global as
- * eejs.i18n;
- */
-export const i18n = wpI18n;
-/**
- * exporting routes to a named var
- */
-import * as r from './routes';
-export const routes = r;
-
-/**
- * Currency Configuration for the default currency from the server
- */
-export { currencyConfig as CURRENCY_CONFIG } from './currency_config';
-
-/**
- * Default timezone configuration for the default timezone settings from the
- * server
- */
-export { timezoneConfig as TIMEZONE_CONFIG } from './timezone-config';
-
-/**
- * Server locale configuration.
- */
-export { locale as SERVER_LOCALE } from './locale';
-
-/**
- * Custom exceptions
- */
-export * from './exceptions';
-
-/**
- * Middle-wares for various libraries
- */
-import * as mw from './middlewares';
-export const middleWares = mw;
-
-/**
- * environment constant indicating development server
- */
-export const __DEV__ = process.env.NODE_ENV !== 'production';
diff --git a/assets/src/eejs/locale.js b/assets/src/eejs/locale.js
deleted file mode 100644
index 2502e321a30..00000000000
--- a/assets/src/eejs/locale.js
+++ /dev/null
@@ -1,12 +0,0 @@
-import data from './data';
-
-/**
- * Provided via the data passed along by the server.
- * This data is a configuration object passed along from the server that exposes
- * the default locale settings from the server.
- * @type {{}}
- */
-export const { locale = {
- user: 'en',
- site: 'en',
-} } = data;
diff --git a/assets/src/eejs/middlewares/api-fetch/caps-middleware.js b/assets/src/eejs/middlewares/api-fetch/caps-middleware.js
deleted file mode 100644
index 31ed49aecb8..00000000000
--- a/assets/src/eejs/middlewares/api-fetch/caps-middleware.js
+++ /dev/null
@@ -1,49 +0,0 @@
-/**
- * External dependencies
- */
-import { addQueryArgs, hasQueryArg } from '@wordpress/url';
-
-export const CONTEXT_CAPS_READ = 'read';
-export const CONTEXT_CAPS_READ_ADMIN = 'read_admin';
-export const CONTEXT_CAPS_EDIT = 'edit';
-export const CONTEXT_CAPS_DELETE = 'delete';
-
-/**
- * Helper function for whether the path should have the context appended or not.
- * @param {string} pathType apiFetch accepts 'path' or 'url' so we allow for
- * checking that here.
- * @param {Object} options the options object provided to api-fetch
- * @return {boolean} Whether context should be appended or not.
- */
-function shouldBeAppended( pathType, options ) {
- return typeof options[ pathType ] === 'string' &&
- ( ! options.method || options.method === 'GET' ) &&
- ! hasQueryArg( options[ pathType ], 'caps' ) &&
- /ee\/v4\.8\.36/.exec( options[ pathType ] ) !== null;
-}
-
-/**
- * Middleware for the @wordpress/api-fetch library that the given context
- * to the `caps` query arg on every EE GET request.
- *
- * @param { string } context Defaults to 'read'
- * @return {function} middleware callback
- */
-const capsMiddleware = ( context = CONTEXT_CAPS_READ ) => ( options, next ) => {
- if ( shouldBeAppended( 'url', options ) ) {
- options.url = addQueryArgs(
- options.url,
- { caps: context }
- );
- }
-
- if ( shouldBeAppended( 'path', options ) ) {
- options.path = addQueryArgs(
- options.path,
- { caps: context }
- );
- }
- return next( options, next );
-};
-
-export default capsMiddleware;
diff --git a/assets/src/eejs/middlewares/api-fetch/index.js b/assets/src/eejs/middlewares/api-fetch/index.js
deleted file mode 100644
index 5e723cfcc38..00000000000
--- a/assets/src/eejs/middlewares/api-fetch/index.js
+++ /dev/null
@@ -1,15 +0,0 @@
-import {
- default as capsMiddleware,
- CONTEXT_CAPS_READ,
- CONTEXT_CAPS_READ_ADMIN,
- CONTEXT_CAPS_EDIT,
- CONTEXT_CAPS_DELETE,
-} from './caps-middleware';
-
-export {
- capsMiddleware,
- CONTEXT_CAPS_READ,
- CONTEXT_CAPS_READ_ADMIN,
- CONTEXT_CAPS_EDIT,
- CONTEXT_CAPS_DELETE,
-};
diff --git a/assets/src/eejs/middlewares/api-fetch/test/caps-middleware.js b/assets/src/eejs/middlewares/api-fetch/test/caps-middleware.js
deleted file mode 100644
index 3f639c7f916..00000000000
--- a/assets/src/eejs/middlewares/api-fetch/test/caps-middleware.js
+++ /dev/null
@@ -1,81 +0,0 @@
-/**
- * Internal dependencies
- */
-import {
- default as capsMiddleware,
- CONTEXT_CAPS_READ_ADMIN,
-} from '../caps-middleware';
-
-describe( 'caps context middleware tests', () => {
- const validUrl = 'https://ee.test/wp-json/ee/v4.8.36/events';
- const validPath = '/ee/v4.8.36/events';
- const invalidUrl = 'https://ee.test/wp-json/ee/events';
- const appendedUrl = validUrl + '?caps=read_admin';
- const appendedPath = validPath + '?caps=read_admin';
- [
- [
- 'because method is not GET',
- { method: 'POST', url: validUrl },
- 'url',
- validUrl,
- ],
- [
- 'because context is already present',
- { method: 'GET', path: validUrl + '?caps=something' },
- 'path',
- validUrl + '?caps=something',
- ],
- [
- 'because invalid path',
- { method: 'GET', url: invalidUrl },
- 'url',
- invalidUrl,
- ],
- ].forEach( ( [
- descriptionPart,
- options,
- optionsType,
- expectedUrl,
- ] ) => {
- it( 'should not have context appended ' + descriptionPart, () => {
- expect.hasAssertions();
- const callback = ( opts ) => {
- expect( opts[ optionsType ] ).toBe( expectedUrl );
- };
- capsMiddleware( CONTEXT_CAPS_READ_ADMIN )( options, callback );
- } );
- } );
- [
- [
- 'when the options.path property is a valid full url',
- { method: 'GET', path: validUrl },
- 'path',
- appendedUrl,
- ],
- [
- 'when the options.url property is a valid full url',
- { method: 'GET', url: validUrl },
- 'url',
- appendedUrl,
- ],
- [
- 'when the options.url property is a valid url path',
- { method: 'GET', url: validPath },
- 'url',
- appendedPath,
- ],
- ].forEach( ( [
- descriptionPart,
- options,
- optionsType,
- expectedUrl,
- ] ) => {
- it( 'should have context appended ' + descriptionPart, () => {
- expect.hasAssertions();
- const callback = ( opts ) => {
- expect( opts[ optionsType ] ).toBe( expectedUrl );
- };
- capsMiddleware( CONTEXT_CAPS_READ_ADMIN )( options, callback );
- } );
- } );
-} );
diff --git a/assets/src/eejs/middlewares/index.js b/assets/src/eejs/middlewares/index.js
deleted file mode 100644
index 7ba8ad3748e..00000000000
--- a/assets/src/eejs/middlewares/index.js
+++ /dev/null
@@ -1,2 +0,0 @@
-import * as fetch from './api-fetch';
-export const apiFetch = fetch;
diff --git a/assets/src/eejs/routes.js b/assets/src/eejs/routes.js
deleted file mode 100644
index 8f2f0dd25ad..00000000000
--- a/assets/src/eejs/routes.js
+++ /dev/null
@@ -1,149 +0,0 @@
-/**
- * Internal imports
- */
-import data from './data';
-
-/**
- * Provided via the data passed along by the server.
- * This data has to do with any paths/route information passed along from the
- * server.
- *
- * @type { {} }
- */
-const { paths = {} } = data;
-
-/**
- * The base url for the site this js is loaded on.
- * eg. 'https://mysite.com/'
- * @type { string }
- */
-export const SITE_URL = paths.site_url || '';
-
-/**
- * The base admin url for the site this js is loaded on.
- * eg. 'https://mysite.com/wp-admin/
- * @type { string }
- */
-export const ADMIN_URL = paths.admin_url || '';
-
-/**
- * A list of all main Event Espresso admin routes.
- *
- * @type { { string: string } }
- */
-export const ADMIN_ROUTES = {
- EVENTS: 'espresso_events',
- REGISTRATIONS: 'espresso_registrations',
- TRANSACTIONS: 'espresso_transactions',
- MESSAGES: 'espresso_messages',
- PRICES: 'pricing',
- REGISTRATION_FORMS: 'registration_form',
- VENUES: 'espresso_venues',
- GENERAL_SETTINGS: 'espresso_general_settings',
- PAYMENT_METHODS: 'espresso_payment_settings',
- EXTENSIONS_AND_SERVICES: 'espresso_packages',
- MAINTENANCE: 'espresso_maintenance',
- HELP_AND_SUPPORT: 'espresso_support',
- ABOUT: 'espresso_about',
-};
-
-/**
- * The string used to indicate the 'default' action route for all Event Espresso
- * admin pages.
- *
- * @type { string }
- */
-export const ADMIN_ROUTE_ACTION_DEFAULT = 'default';
-
-/**
- * A list of all admin route actions for Event Espresso admin pages.
- * Note: currently this list only includes display actions (not processing
- * actions).
- *
- * @type { { string: { string: string } } }
- */
-export const ADMIN_ROUTE_ACTIONS = {
- EVENTS: {
- OVERVIEW: ADMIN_ROUTE_ACTION_DEFAULT,
- CATEGORY_LIST: 'category_list',
- TEMPLATES: 'template_settings',
- DEFAULT_SETTINGS: 'default_event_settings',
- DEFAULT_TICKETS: 'ticket_list_table',
- },
- REGISTRATIONS: {
- OVERVIEW: ADMIN_ROUTE_ACTION_DEFAULT,
- EVENT_CHECKIN: 'event_registrations',
- CONTACT_LIST: 'contact_list',
- REPORTS: 'reports',
- },
- TRANSACTIONS: {
- OVERVIEW: ADMIN_ROUTE_ACTION_DEFAULT,
- REPORTS: 'reports',
- },
- MESSAGES: {
- MESSAGE_ACTIVITY: ADMIN_ROUTE_ACTION_DEFAULT,
- DEFAULT_MESSAGE_TEMPLATES: 'global_mtps',
- CUSTOM_MESSAGE_TEMPLATES: 'custom_mtps',
- SETTINGS: 'settings',
- },
- PRICES: {
- DEFAULT_PRICING: ADMIN_ROUTE_ACTION_DEFAULT,
- PRICE_TYPES: 'price_types',
- TAX_SETTINGS: 'tax_settings',
- },
- FORMS: {
- QUESTIONS: ADMIN_ROUTE_ACTION_DEFAULT,
- QUESTION_GROUPS: 'question_groups',
- REG_FORM_SETTINGS: 'view_reg_form_settings',
- },
- VENUES: {
- OVERVIEW: ADMIN_ROUTE_ACTION_DEFAULT,
- CATEGORIES: 'category_list',
- EDIT: 'edit',
- GOOGLE_MAPS: 'google_map_settings',
- },
- SETTINGS: {
- YOUR_ORGANIZATION: ADMIN_ROUTE_ACTION_DEFAULT,
- CRITICAL_PAGES: 'critical_pages',
- ADMIN_OPTIONS: 'admin_option_settings',
- COUNTRIES: 'country_settings',
- PRIVACY_SETTINGS: 'privacy_settings',
- },
- PAYMENT_METHODS: {
- PAYMENT_METHODS: ADMIN_ROUTE_ACTION_DEFAULT,
- SETTINGS: 'payment_settings',
- LOGS: 'payment_log',
- },
- MAINTENANCE: {
- MAINTENANCE: ADMIN_ROUTE_ACTION_DEFAULT,
- RESET_OR_DELETE_DATA: 'data_reset',
- DATETIME_UTILITIES: 'datetime_tools',
- SYSTEM_INFORMATION: 'system_status',
- },
- SUPPORT: {
- SUPPORT: ADMIN_ROUTE_ACTION_DEFAULT,
- FAQ: 'faq',
- DEVELOPERS: 'developers',
- SHORTCODES: 'shortcodes',
- },
- ABOUT: {
- WHATS_NEW: ADMIN_ROUTE_ACTION_DEFAULT,
- ABOUT: 'overview',
- CREDITS: 'credits',
- REVIEWS: 'reviews',
- },
-};
-
-/**
- * Return the admin url for a given page and action.
- * @param { string } page The main ee admin page string
- * @param { string } action This should correspond to the action for the admin
- * page.
- * @return { string } A full url for the given arguments.
- */
-export const getAdminUrl = (
- page = ADMIN_ROUTES.EVENTS,
- action = ADMIN_ROUTE_ACTION_DEFAULT
-) => {
- return `${ ADMIN_URL }admin.php?page=${ page }&action=${ action }`;
-};
diff --git a/assets/src/eejs/test/index.js b/assets/src/eejs/test/index.js
deleted file mode 100644
index 94942dbdca4..00000000000
--- a/assets/src/eejs/test/index.js
+++ /dev/null
@@ -1,32 +0,0 @@
-import {
- data,
- Exception,
- routes,
-} from '../';
-
-describe( 'eejs', () => {
- describe( 'data', () => {
- it( 'ensures data object gets set from eejsdata.data global', () => {
- expect( data.testData ).toBe( true );
- } );
- } );
-
- describe( 'Exception', () => {
- const t = () => {
- throw new Exception( 'error thrown' );
- };
- it( 'should throw error with msg "error thrown"', () => {
- expect( t ).toThrow( 'error thrown' );
- } );
- it( 'should throw an error which is an instance of "Exception"', () => {
- expect( t ).toThrow( Exception );
- } );
- } );
- describe( 'routes', () => {
- it( 'provides the url to the events admin page by default.', () => {
- expect( routes.getAdminUrl() ).toEqual(
- 'https://eetest.test/wp-admin/admin.php?page=espresso_events&action=default'
- );
- } );
- } );
-} );
diff --git a/assets/src/eejs/timezone-config.js b/assets/src/eejs/timezone-config.js
deleted file mode 100644
index 1a1de20a07b..00000000000
--- a/assets/src/eejs/timezone-config.js
+++ /dev/null
@@ -1,13 +0,0 @@
-import data from './data';
-
-/**
- * Provided via the data passed along by the server.
- * This data a configuration object passed along from the server that exposes
- * the default timezone settings from the server.
- * @type {{}}
- */
-export const { default_timezone: timezoneConfig = {
- pretty: 'UTC',
- string: 'UTC',
- offset: 0,
-} } = data;
diff --git a/assets/src/eejs/validators/index.js b/assets/src/eejs/validators/index.js
deleted file mode 100644
index 6112bd9e34b..00000000000
--- a/assets/src/eejs/validators/index.js
+++ /dev/null
@@ -1,5 +0,0 @@
-export * from './is-generator';
-export * from './is-factory';
-export * from './is-model-entity';
-export * from './is-schema';
-export * from './instance-of';
diff --git a/assets/src/eejs/validators/instance-of.js b/assets/src/eejs/validators/instance-of.js
deleted file mode 100644
index 1b6b6bcad00..00000000000
--- a/assets/src/eejs/validators/instance-of.js
+++ /dev/null
@@ -1,23 +0,0 @@
-/**
- * Helper method for determining whether the given object instance is an
- * instance of the given expected class/function name. This is a more reliable
- * method for doing instanceof checks than an `instanceof` expression.
- *
- * @param {Object} objectInstance
- * @param {string} expectedName
- * @return {boolean} True means the object is an instance of expectedName.
- */
-export function instanceOf(objectInstance, expectedName) {
- if (!objectInstance) {
- return false;
- }
- if (objectInstance.constructor) {
- if (objectInstance.constructor.name && objectInstance.constructor.name === expectedName) {
- return true;
- }
- if (objectInstance.constructor.displayName && objectInstance.constructor.displayName === expectedName) {
- return true;
- }
- }
- return objectInstance.hasOwnProperty('displayName') && objectInstance.displayName === expectedName;
-}
diff --git a/assets/src/eejs/validators/is-factory.js b/assets/src/eejs/validators/is-factory.js
deleted file mode 100644
index 8d99e707c9c..00000000000
--- a/assets/src/eejs/validators/is-factory.js
+++ /dev/null
@@ -1,38 +0,0 @@
-/**
- * External imports
- */
-import { isUndefined } from 'lodash';
-
-/**
- * Utility for checking whether the given value represents a
- * ModelEntityFactory object.
- *
- * @param {Object} factory
- * @return {boolean} true means the object is a ModelEntityFactory
- */
-export const isModelEntityFactory = ( factory ) => {
- return (
- !! factory &&
- ! isUndefined( factory.classDef ) &&
- ! isUndefined( factory.modelName ) &&
- Object.getPrototypeOf( factory.classDef ).name === 'BaseEntity'
- );
-};
-
-/**
- * Utility for checking whether the given value represents a ModelEntityFactory
- * for a specific model.
- *
- * Note: modelName is expected to be the lowercase, snakecase string for the
- * model. Eg. 'event', or 'message_template'.
- *
- * @param {Object} factory
- * @param {string} modelName
- * @return {boolean} True means the given factory
- */
-export const isModelEntityFactoryOfModel = ( factory, modelName ) => {
- return (
- isModelEntityFactory( factory ) &&
- factory.modelName === modelName
- );
-};
diff --git a/assets/src/eejs/validators/is-generator.js b/assets/src/eejs/validators/is-generator.js
deleted file mode 100644
index 1aec37c87ea..00000000000
--- a/assets/src/eejs/validators/is-generator.js
+++ /dev/null
@@ -1,16 +0,0 @@
-/**
- * Tests for whether the provide value is a generator or not.
- *
- * Note: Generators are different than GeneratorFunctions!
- * This is a Generator: function* (){}(); (an invoked GeneratorFunction)
- * this is a GeneratorFunction: function* (){}
- *
- * @param {*} object
- * @return {boolean} True if the provided value is a generator.
- */
-export const isGenerator = ( object ) => {
- return (
- !! object &&
- object[ Symbol.toStringTag ] === 'Generator'
- );
-};
diff --git a/assets/src/eejs/validators/is-model-entity.js b/assets/src/eejs/validators/is-model-entity.js
deleted file mode 100644
index 29e543a6505..00000000000
--- a/assets/src/eejs/validators/is-model-entity.js
+++ /dev/null
@@ -1,31 +0,0 @@
-/**
- * External imports
- */
-import { isObject, camelCase, upperFirst } from 'lodash';
-/**
- * Returns whether the given value is a model entity.
- *
- * @param {Object} entity
- * @return {boolean} True means it is a model entity.
- */
-export const isModelEntity = ( entity ) => {
- return (
- isObject( entity ) &&
- Object.getPrototypeOf( entity.constructor ).name === 'BaseEntity'
- );
-};
-
-/**
- * Returns whether the given value is a model entity for the given model type.
- *
- * @param {Object} entity
- * @param {string} modelName
- * @return {boolean} True means it is a model entity for the given model.
- */
-export const isModelEntityOfModel = ( entity, modelName ) => {
- modelName = upperFirst( camelCase( modelName ) );
- return (
- isModelEntity( entity ) &&
- entity.constructor.name === modelName
- );
-};
diff --git a/assets/src/eejs/validators/is-schema.js b/assets/src/eejs/validators/is-schema.js
deleted file mode 100644
index 17bce8ef70d..00000000000
--- a/assets/src/eejs/validators/is-schema.js
+++ /dev/null
@@ -1,74 +0,0 @@
-/**
- * External imports
- */
-import { isPlainObject, isUndefined, lowerCase } from 'lodash';
-
-/**
- * Returns whether the given value is a schema response object from a schema
- * request.
- *
- * @param {Object} response
- * @return {boolean} true if this is a schema response object.
- */
-export const isSchemaResponse = ( response ) => {
- return (
- hasSchemaProperty( response ) &&
- isSchema( response.schema )
- );
-};
-
-/**
- * Returns whether the given value is a schema object.
- *
- * @param {Object} schema
- * @return {boolean} true if this is a schema object.
- */
-export const isSchema = ( schema ) => {
- return (
- isPlainObject( schema ) &&
- ! isUndefined( schema.$schema ) &&
- isPlainObject( schema.properties )
- );
-};
-
-/**
- * Returns whether the given value is a schema response object for the given
- * model name
- *
- * @param {Object} response
- * @param {string} modelName
- * @return {boolean} True means this is a schema response object for the given
- * model name.
- */
-export const isSchemaResponseOfModel = ( response, modelName ) => {
- return (
- hasSchemaProperty( response ) &&
- isSchemaOfModel( response.schema, modelName )
- );
-};
-
-/**
- * Returns whether the given value is a schema object for the given model name.
- *
- * @param {Object} schema
- * @param {string} modelName
- * @return {boolean} True means this is a schema object for the given model
- * name.
- */
-export const isSchemaOfModel = ( schema, modelName ) => {
- return (
- isSchema( schema ) &&
- ! isUndefined( schema.title ) &&
- lowerCase( modelName ) === lowerCase( schema.title )
- );
-};
-
-/**
- * Returns whether the given value is an object with a schema property
- *
- * @param {*} object
- * @return {boolean} True if a plain object with a schema property
- */
-const hasSchemaProperty = ( object ) => {
- return isPlainObject( object ) && ! isUndefined( object.schema );
-};
diff --git a/assets/src/eejs/validators/test/instance-of.js b/assets/src/eejs/validators/test/instance-of.js
deleted file mode 100644
index 96de5dec2c8..00000000000
--- a/assets/src/eejs/validators/test/instance-of.js
+++ /dev/null
@@ -1,40 +0,0 @@
-/**
- * External imports.
- */
-import { Money, SiteCurrency } from '@eventespresso/value-objects';
-
-/**
- * Internal imports.
- */
-import { instanceOf } from '../instance-of';
-
-function ExampleClass() {
- this.internal = 'foo';
-}
-
-describe( 'instanceOf()', () => {
- it( 'when object instance matches instance of it returns true', () => {
- const money = new Money( 0, SiteCurrency );
- expect( instanceOf( money, 'Money' ) ).toBe( true );
- } );
- it( 'when object instance matches instance of arbitrary function new it ' +
- 'returns true', () => {
- expect( instanceOf( new ExampleClass(), 'ExampleClass' ) )
- .toBe( true );
- } );
- it( 'when class is not instantiated, returns false', () => {
- expect( instanceOf( Money, 'Money' ) ).toBe( false );
- } );
- it( 'when wrong instance, returns false', () => {
- expect( instanceOf( new ExampleClass(), 'Money' ) ).toBe( false );
- } );
- it( 'returns false when objectInstance is not an object', () => {
- [
- null,
- '',
- [ 'foo', 'bar' ],
- ].forEach( ( testValue ) => {
- expect( instanceOf( testValue, 'foo' ) ).toBe( false );
- } );
- } );
-} );
diff --git a/assets/src/eejs/validators/test/is-factory.js b/assets/src/eejs/validators/test/is-factory.js
deleted file mode 100644
index e556b372b03..00000000000
--- a/assets/src/eejs/validators/test/is-factory.js
+++ /dev/null
@@ -1,47 +0,0 @@
-/**
- * External imports
- */
-import { EventFactory, DateTimeFactory } from '@test/fixtures';
-
-/**
- * Internal imports
- */
-import {
- isModelEntityFactory,
- isModelEntityFactoryOfModel,
-} from '../is-factory';
-
-describe( 'isModelEntityFactory()', () => {
- [
- [ 0, false ],
- [ {}, false ],
- [ null, false ],
- [ 'fail', false ],
- [ { modelName: 'something', classDef: {} }, false ],
- [ true, false ],
- [ EventFactory, true ],
- ].forEach( ( [
- factoryWannabe,
- expectedResult,
- ] ) => {
- it( 'has expected result for tested value', () => {
- expect( isModelEntityFactory( factoryWannabe ) ).toBe( expectedResult );
- } );
- } );
-} );
-
-describe( 'isModelEntityFactoryOfModel', () => {
- [
- [ EventFactory, 'event', true ],
- [ DateTimeFactory, 'event', false ],
- ].forEach( ( [
- factoryWannabe,
- modelName,
- expectedResult,
- ] ) => {
- it( 'has expected result for tested value', () => {
- expect( isModelEntityFactoryOfModel( factoryWannabe, modelName ) )
- .toBe( expectedResult );
- } );
- } );
-} );
diff --git a/assets/src/eejs/validators/test/is-generator.js b/assets/src/eejs/validators/test/is-generator.js
deleted file mode 100644
index f09482680e0..00000000000
--- a/assets/src/eejs/validators/test/is-generator.js
+++ /dev/null
@@ -1,25 +0,0 @@
-/**
- * Internal imports
- */
-import { isGenerator } from '../is-generator';
-
-describe( 'isGenerator()', () => {
- function* testGenerator() {}
- [
- [ 0, false ],
- [ {}, false ],
- [ null, false ],
- [ 'fail', false ],
- [ function() {}, false ],
- [ true, false ],
- [ testGenerator, false ],
- [ testGenerator(), true ],
- ].forEach( ( [
- generator,
- expectedResult,
- ] ) => {
- it( 'returns expected result for given value', () => {
- expect( isGenerator( generator ) ).toBe( expectedResult );
- } );
- } );
-} );
diff --git a/assets/src/eejs/validators/test/is-model-entity.js b/assets/src/eejs/validators/test/is-model-entity.js
deleted file mode 100644
index c935632b78f..00000000000
--- a/assets/src/eejs/validators/test/is-model-entity.js
+++ /dev/null
@@ -1,43 +0,0 @@
-/**
- * Internal Imports
- */
-import { isModelEntity, isModelEntityOfModel } from '../is-model-entity';
-/**
- * External imports
- */
-import { EventEntity, AuthedDateTimeEntity } from '@test/fixtures';
-
-describe( 'isModelEntity()', () => {
- [
- [ 0, false ],
- [ {}, false ],
- [ null, false ],
- [ 'fail', false ],
- [ true, false ],
- [ EventEntity, true ],
- [ AuthedDateTimeEntity, true ],
- ].forEach( ( [
- entity,
- expectedResult,
- ] ) => {
- it( 'returns expected result for given value', () => {
- expect( isModelEntity( entity ) ).toBe( expectedResult );
- } );
- } );
-} );
-
-describe( 'isModelEntityOfModel()', () => {
- [
- [ EventEntity, 'event', true ],
- [ AuthedDateTimeEntity, 'event', false ],
- ].forEach( ( [
- entity,
- modelName,
- expectedResult,
- ] ) => {
- it( 'returns expected result for given value', () => {
- expect( isModelEntityOfModel( entity, modelName ) )
- .toBe( expectedResult );
- } );
- } );
-} );
diff --git a/assets/src/eejs/validators/test/is-schema.js b/assets/src/eejs/validators/test/is-schema.js
deleted file mode 100644
index 4caadaceaff..00000000000
--- a/assets/src/eejs/validators/test/is-schema.js
+++ /dev/null
@@ -1,69 +0,0 @@
-/**
- * Internal imports
- */
-import {
- isSchemaResponse,
- isSchema,
- isSchemaResponseOfModel,
- isSchemaOfModel,
-} from '../is-schema';
-
-/**
- * External Imports
- */
-import {
- EventSchema,
- DateTimeSchema,
-} from '@test/fixtures';
-
-const expectedFails = [
- 0,
- {},
- null,
- 'fail',
- { title: 'something', schema: 'soemthing else' },
- true,
-];
-
-describe( 'isSchemaResponse()', () => {
- expectedFails.forEach( ( testValue ) => {
- it( 'fails validation for given value', () => {
- expect( isSchemaResponse( testValue ) ).toBe( false );
- } );
- } );
- it( 'passes validation for schema response', () => {
- expect( isSchemaResponse( EventSchema ) ).toBe( true );
- } );
-} );
-describe( 'isSchema()', () => {
- [ ...expectedFails, EventSchema ].forEach( ( testValue ) => {
- it( 'fails validation for given value', () => {
- expect( isSchema( testValue ) ).toBe( false );
- } );
- } );
- it( 'passes validation for schema', () => {
- expect( isSchema( EventSchema.schema ) ).toBe( true );
- } );
-} );
-describe( 'isSchemaResponseOfModel()', () => {
- [ ...expectedFails, DateTimeSchema ].forEach( ( testValue ) => {
- it( 'fails validation for given value', () => {
- expect( isSchemaResponseOfModel( testValue, 'event' ) )
- .toBe( false );
- } );
- } );
- it( 'passes validation for schema', () => {
- expect( isSchemaResponseOfModel( EventSchema, 'event' ) )
- .toBe( true );
- } );
-} );
-describe( 'isSchemaOfModel()', () => {
- [ ...expectedFails, DateTimeSchema.schema ].forEach( ( testValue ) => {
- it( 'fails validation for given value', () => {
- expect( isSchemaOfModel( testValue, 'event' ) ).toBe( false );
- } );
- } );
- it( 'passes validation for schema', () => {
- expect( isSchemaOfModel( EventSchema.schema, 'event' ) ).toBe( true );
- } );
-} );
diff --git a/assets/src/eejs/vendor/index.js b/assets/src/eejs/vendor/index.js
deleted file mode 100644
index f42219a0f7e..00000000000
--- a/assets/src/eejs/vendor/index.js
+++ /dev/null
@@ -1,5 +0,0 @@
-module.exports = {
- classnames: require( 'classnames' ),
- moment: require( 'moment-timezone' ),
- cuid: require( 'cuid' ),
-};
diff --git a/assets/src/exit-modal-survey/index.js b/assets/src/exit-modal-survey/index.js
deleted file mode 100644
index dde53c545a2..00000000000
--- a/assets/src/exit-modal-survey/index.js
+++ /dev/null
@@ -1,94 +0,0 @@
-/**
- * External dependencies
- */
-import ReactDOM from 'react-dom';
-import ReactModal from 'react-modal';
-import $ from 'jquery';
-import ExitModal, { CLOSE_MODAL_EVENT } from '@eventespresso/react-exit-modal-typeform';
-import './style.css';
-import { data } from '@eventespresso/eejs';
-import { stringify } from 'querystringify';
-import { __ } from '@eventespresso/i18n';
-
-const { exitModalInfo: info = {} } = data;
-
-const queryString = stringify( {
- firstname: info.firstname,
- emailaddress: info.emailaddress,
- website: info.website,
-} );
-
-const modalProps = {
- styles: {
- content: {
- display: 'flex',
- top: '80px',
- left: '50%',
- bottom: 'auto',
- right: 'auto',
- WebkitTransform: 'translateX(-50%)',
- transform: 'translateX(-50%)',
- },
- typeFormStyle: {
- width: '600px',
- height: '600px',
- },
- },
- typeFormUrl: 'https://eventespresso.typeform.com/to/O1DDym?' + queryString,
- introText: __(
- 'Do you have a moment to share why you are deactivating Event Espresso?',
- 'event_espresso',
- ),
- doSurveyButtonText: __(
- 'Sure I\'ll help',
- 'event_espresso',
- ),
- skipButtonText: __(
- 'Skip',
- 'event_espresso',
- ),
- buttonClass: {
- doSurvey: 'button button-primary',
- closeModal: 'button button-secondary',
- },
-};
-
-/**
- * Handler for deactivation trigger
- * @param {Event} e
- * @param {element} el
- */
-const handleDeactivationClick = ( e, el ) => {
- e.preventDefault();
- const link = $( el ).attr( 'href' );
- const appContainer = document.getElementById( 'ee-exit-survey-modal' );
- ReactModal.setAppElement( appContainer );
- const modalContainer = ReactDOM.render( , //eslint-disable-line react/no-render-return-value
- appContainer,
- );
- modalContainer.el.addEventListener(
- CLOSE_MODAL_EVENT,
- function() {
- window.location.href = link;
- },
- { once: true },
- );
-};
-
-/**
- * EE caffeinated click capture but only if feature is active
- */
-if ( info.isModalActive ) {
- $( 'tr[data-slug="event-espresso"]' )
- .on( 'click', 'span.deactivate > a', function( e ) {
- handleDeactivationClick( e, this );
- } );
-
- /**
- * EE decaf click capture.
- */
- $( 'tr[data-slug="event-espresso-decaf"]' )
- .on( 'click', 'span.deactivate > a', function( e ) {
- handleDeactivationClick( e, this );
- } );
-}
diff --git a/assets/src/exit-modal-survey/style.css b/assets/src/exit-modal-survey/style.css
deleted file mode 100644
index 25163e5f3a5..00000000000
--- a/assets/src/exit-modal-survey/style.css
+++ /dev/null
@@ -1,10 +0,0 @@
-/**
- * Styles for exit modal
- */
-.ee-cancel-prompt-button {
- float:right;
-}
-
-.exit-modal-choices .button {
- margin-left:5px;
-}
\ No newline at end of file
diff --git a/assets/src/higher-order-components/base-control.js b/assets/src/higher-order-components/base-control.js
deleted file mode 100644
index f419ca92ee6..00000000000
--- a/assets/src/higher-order-components/base-control.js
+++ /dev/null
@@ -1,62 +0,0 @@
-/**
- * WordPress Imports
- */
-import {
- compose,
- createHigherOrderComponent,
- withInstanceId,
-} from '@wordpress/compose';
-import { Component } from '@wordpress/element';
-import { BaseControl } from '@wordpress/components';
-
-/**
- * External Imports
- */
-import PropTypes from 'prop-types';
-
-export default ( customId = '' ) => createHigherOrderComponent(
- compose( [
- withInstanceId,
- ( WrappedComponent ) => {
- return class extends Component {
- static propTypes = {
- label: PropTypes.string,
- instanceId: PropTypes.oneOfType( [
- PropTypes.number,
- PropTypes.string,
- ] ),
- className: PropTypes.string,
- help: PropTypes.string,
- };
-
- static defaultProps = {
- label: WrappedComponent.defaultProps &&
- WrappedComponent.defaultProps.label ?
- WrappedComponent.defaultProps.label :
- '',
- };
-
- render() {
- const {
- label,
- instanceId,
- className,
- help,
- } = this.props;
- const id = `inspector-${ customId }-control-${ instanceId }`;
- return (
-
-
-
- );
- }
- };
- },
- ] ),
- 'withBaseControl'
-);
diff --git a/assets/src/higher-order-components/index.js b/assets/src/higher-order-components/index.js
deleted file mode 100644
index 192c5810a4d..00000000000
--- a/assets/src/higher-order-components/index.js
+++ /dev/null
@@ -1,4 +0,0 @@
-export { default as withBaseControl } from './base-control';
-export { default as withMoney } from './money';
-export { default as withLatestCheckin } from './with-latest-checkin';
-
diff --git a/assets/src/higher-order-components/money.js b/assets/src/higher-order-components/money.js
deleted file mode 100644
index 841aba165a6..00000000000
--- a/assets/src/higher-order-components/money.js
+++ /dev/null
@@ -1,143 +0,0 @@
-/**
- * External imports
- */
-import { Component } from '@wordpress/element';
-import { isFunction, isArray } from 'lodash';
-import isShallowEqualArrays from '@wordpress/is-shallow-equal';
-import warning from 'warning';
-import { Money, SiteCurrency } from '@eventespresso/value-objects';
-
-/**
- * This validates whether the nextStateResponse is in the expected shape.
- * If any of the validation fails, then a console.error is triggered (via
- * warning)
- *
- * @param {{}} nextStateResponse
- */
-const validateNextState = ( nextStateResponse ) => {
- warning(
- nextStateResponse &&
- nextStateResponse.hasOwnProperty( 'convertedValues' ),
- 'The propNameMap callback for the withMoney HOC should return an' +
- ' object with a "convertedValues" key.'
- );
- if ( nextStateResponse &&
- nextStateResponse.hasOwnProperty( 'convertedValues' ) ) {
- warning(
- isArray( nextStateResponse.convertedValues ),
- 'The propNameMap callback for the withMoney HOC should return an ' +
- 'object with a "convertedValues" key that has an array' +
- ' of numbers as the value.'
- );
- }
- warning(
- nextStateResponse && nextStateResponse.hasOwnProperty( 'props' ),
- 'The propNameMap callback for the withMoneyHOC should return an' +
- ' object with a "props" key.'
- );
-};
-
-/**
- * A higher order component that converts any props matching the map provided
- * as an argument to Money value objects and passes them to the WrappedComponent
- *
- * @param {Array|function} propNameMap
- * @return {function(*): EnhancedComponent} Returns an enhanced component where
- * props that represent money values have been converted to a Money value object
- */
-const withMoney = ( propNameMap = [] ) => ( WrappedComponent ) => {
- class EnhancedComponent extends Component {
- state = {
- convertedValues: [],
- };
-
- /**
- * This provides the next state on any prop change.
- *
- * @param {{}} props
- * @return {{}} An object representing the nextState for the component.
- */
- getNextState = ( props ) => {
- let nextStateResponse,
- nextState = {},
- convertedValues = [];
- if ( isFunction( propNameMap ) ) {
- nextStateResponse = propNameMap( props, Money );
- validateNextState( nextStateResponse );
- if ( nextStateResponse && nextStateResponse.props ) {
- nextState = { ...nextStateResponse.props };
- }
- convertedValues = nextStateResponse.convertedValues ||
- convertedValues;
- } else if ( isArray( propNameMap ) ) {
- propNameMap.forEach( ( propName ) => {
- if ( props[ propName ] ) {
- nextState[ propName ] =
- new Money(
- props[ propName ],
- SiteCurrency
- );
- convertedValues.push(
- nextState[ propName ].toNumber()
- );
- }
- } );
- } else {
- warning(
- false,
- 'The propNameMap argument provided to withMoney must be either a' +
- ' function or an array'
- );
- }
- nextState.convertedValues = convertedValues;
- return nextState;
- };
-
- /**
- * Calculates whether the state should be updated using the provided
- * arguments.
- *
- * @param {{}} prevProps
- * @param {{}} prevState
- * @param {{}} nextState
- * @return {boolean} If a shallow compare of prevState.convertedValues
- * and nextState.convertedValues is false, then this returns true to
- * signal state should be updated.
- */
- shouldUpdateStateWithConvertedValues = (
- prevProps,
- prevState,
- nextState
- ) => {
- return ! isShallowEqualArrays(
- nextState.convertedValues,
- prevState.convertedValues
- ) &&
- nextState.convertedValues[ 0 ] !==
- prevState.convertedValues[ 0 ];
- };
-
- componentDidMount() {
- this.setState( this.getNextState( this.props ) );
- }
-
- componentDidUpdate( prevProps, prevState ) {
- const nextState = this.getNextState( this.props );
- if ( this.shouldUpdateStateWithConvertedValues(
- prevProps,
- prevState,
- nextState
- ) ) {
- this.setState( nextState );
- }
- }
-
- render() {
- return ;
- }
- }
-
- return EnhancedComponent;
-};
-
-export default withMoney;
diff --git a/assets/src/higher-order-components/test/base-control.js b/assets/src/higher-order-components/test/base-control.js
deleted file mode 100644
index 70a2c54a014..00000000000
--- a/assets/src/higher-order-components/test/base-control.js
+++ /dev/null
@@ -1,34 +0,0 @@
-import TestRenderer from 'react-test-renderer';
-import withBaseControl from '../base-control';
-import { BaseControl } from '@wordpress/components';
-
-describe( 'withBaseControl()', () => {
- const TestComponent = ( {} ) => {
- return ;
- };
- it( 'should generate the expected css id when there is no' +
- ' custom id provided', () => {
- const WrappedComponent = withBaseControl()( TestComponent );
- const elementInstance = TestRenderer.create( )
- .root;
- const BaseControlInstance = elementInstance.findByType( BaseControl );
- const TestComponentInstance = elementInstance.findByType( TestComponent );
-
- expect( BaseControlInstance.props.id )
- .toEqual(
- `inspector--control-${ TestComponentInstance.props.instanceId }`
- );
- } );
- it( 'should generate the expected css id when there is a custom ' +
- 'id provided', () => {
- const WrappedComponent = withBaseControl( 'custom-id' )( TestComponent );
- const elementInstance = TestRenderer.create( )
- .root;
- const BaseControlInstance = elementInstance.findByType( BaseControl );
- const TestComponentInstance = elementInstance.findByType( TestComponent );
- expect( BaseControlInstance.props.id )
- .toEqual(
- `inspector-custom-id-control-${ TestComponentInstance.props.instanceId }`
- );
- } );
-} );
diff --git a/assets/src/higher-order-components/test/money.js b/assets/src/higher-order-components/test/money.js
deleted file mode 100644
index 61447e0446c..00000000000
--- a/assets/src/higher-order-components/test/money.js
+++ /dev/null
@@ -1,146 +0,0 @@
-/**
- * Internal Imports
- */
-import withMoney from '../money';
-import { Money, SiteCurrency } from '@eventespresso/value-objects';
-
-/**
- * External Imports
- */
-import { Component } from '@wordpress/element';
-import renderer from 'react-test-renderer';
-
-jest.mock( '@eventespresso/eejs', () => ( {
- ...require.requireActual( '@eventespresso/eejs' ),
- CURRENCY_CONFIG: {
- code: 'USD',
- singularLabel: 'dollar',
- pluralLabel: 'dollars',
- sign: '$',
- signB4: true,
- decimalMark: '.',
- thousandsSeparator: ',',
- subunits: 100,
- },
-} ) );
-
-describe( 'withMoney()', () => {
- class TestComponent extends Component {
- render() {
- return ;
- }
- }
- const getEnhancedComponent = ( testMap = [] ) => {
- return withMoney( testMap )( TestComponent );
- };
-
- const getWrappedTestComponent = ( testProps, testMap = [] ) => {
- // eslint-disable-next-line @wordpress/no-unused-vars-before-return
- const Wrapped = getEnhancedComponent( testMap );
- return ;
- };
-
- it( 'Passes through props with no mapping provided', () => {
- const wrapper = renderer.create( getWrappedTestComponent(
- { propA: 'testa', propB: 'testb' }
- ) );
- const testComponent = wrapper.root.findByType( TestComponent );
- expect( testComponent.props.propA ).toBe( 'testa' );
- expect( testComponent.props.propB ).toBe( 'testb' );
- } );
-
- it( 'Gives a warning if propNameMap is not valid', () => {
- renderer.create( getWrappedTestComponent( {}, {} ) );
- const expectedMessage = 'Warning: The propNameMap argument provided to ' +
- 'withMoney must be either a function or an array';
- expect( console ).toHaveErroredWith( expectedMessage );
- renderer.create( getWrappedTestComponent( {}, '' ) );
- expect( console ).toHaveErroredWith( expectedMessage );
- } );
-
- describe( 'It gives a warning if propNameMap is a function that returns' +
- ' unexpected shape', () => {
- const expectedNoValuesWarning = 'Warning: The propNameMap callback ' +
- 'for the withMoney HOC should return an object with a ' +
- '"convertedValues" key.';
- const expectedValuesNotArrayWarning = 'Warning: The propNameMap' +
- ' callback for the withMoney HOC should return an object with a' +
- ' "convertedValues" key that has an array of numbers as the value.';
- const expectedNoPropsWarning = 'Warning: The propNameMap callback for' +
- ' the withMoneyHOC should return an object with a "props" key.';
- it( 'gives warnings for an empty object', () => {
- renderer.create( getWrappedTestComponent( {}, () => {
- return {};
- } ) );
- expect( console ).toHaveErroredWith( expectedNoValuesWarning );
- expect( console ).toHaveErroredWith( expectedNoPropsWarning );
- } );
-
- it( 'gives warnings for when object contains a convertedValues property' +
- ' but it\'s not an array', () => {
- renderer.create( getWrappedTestComponent( {}, () => {
- return { convertedValues: '', props: {} };
- } ) );
- expect( console ).toHaveErroredWith( expectedValuesNotArrayWarning );
- } );
- } );
-
- it( 'converts prop with custom map function as expected', () => {
- const wrapper = renderer.create( getWrappedTestComponent(
- { propA: 1000.25, propB: 2.25, propC: 'unconverted' },
- ( props, MoneyVo ) => {
- const conversions = {
- propA: new MoneyVo( 1000.25, SiteCurrency ),
- propB: new MoneyVo( 2.25, SiteCurrency ),
- };
- return {
- props: {
- propA: conversions.propA,
- propB: conversions.propB,
- propC: props.propC,
- },
- convertedValues: [
- conversions.propA.toString(),
- conversions.propB.toString(),
- props.propC,
- ],
- };
- }
- ) );
- const testComponent = wrapper.root.findByType( TestComponent );
- expect( testComponent.props.propA ).toBeInstanceOf( Money );
- expect( testComponent.props.propA.toNumber() ).toBe( 1000.25 );
- expect( testComponent.props.propB ).toBeInstanceOf( Money );
- expect( testComponent.props.propB.toNumber() ).toBe( 2.25 );
- expect( testComponent.props.propC ).toBe( 'unconverted' );
- } );
-
- it( 'converts prop with array map as expected', () => {
- const wrapper = renderer.create( getWrappedTestComponent(
- { propA: 1000.25, propB: 2.25, propC: 'unconverted' },
- [ 'propA', 'propB' ]
- ) );
- const testComponent = wrapper.root.findByType( TestComponent );
- expect( testComponent.props.propA ).toBeInstanceOf( Money );
- expect( testComponent.props.propA.toNumber() ).toBe( 1000.25 );
- expect( testComponent.props.propB ).toBeInstanceOf( Money );
- expect( testComponent.props.propB.toNumber() ).toBe( 2.25 );
- expect( testComponent.props.propC ).toBe( 'unconverted' );
- } );
-
- it( 'Does not rerender unnecessarily', () => {
- const propsToPass = { propA: 1000.25, propB: 2.25, propC: 'unconverted' };
- const EnhancedComponent = getEnhancedComponent( [ 'propA', 'propB' ] );
- const wrapper = renderer.create( );
- const spy = jest.spyOn( EnhancedComponent.prototype, 'setState' );
- // send same props, should be no call
- wrapper.update( );
- expect( spy ).not.toHaveBeenCalled();
-
- // this demonstrates the need for the extra conditional testing the
- // order of values in the `convertedValues` state because otherwise
- // it'd be considered shallowEqual with previous states.
- wrapper.update( );
- expect( spy ).toHaveBeenCalled();
- } );
-} );
diff --git a/assets/src/higher-order-components/test/with-latest-checkin.js b/assets/src/higher-order-components/test/with-latest-checkin.js
deleted file mode 100644
index d98f5932353..00000000000
--- a/assets/src/higher-order-components/test/with-latest-checkin.js
+++ /dev/null
@@ -1,107 +0,0 @@
-/**
- * Internal Imports
- */
-import withLatestCheckin from '../with-latest-checkin';
-
-/**
- * External imports
- */
-import { Component } from '@wordpress/element';
-import renderer from 'react-test-renderer';
-import { select, dispatch, registerStore } from '@wordpress/data';
-import { RegistrationFactory } from '@test/fixtures';
-import '../../data/index';
-
-describe( 'withLatestCheckin', () => {
- const getLatestCheckin = jest.fn().mockImplementation(
- () => ( { checkIn: true } )
- );
- const hasFinishedResolution = jest.fn().mockImplementation( () => true );
- const toggleCheckin = jest.fn();
- class TestComponent extends Component {
- render() {
- return ;
- }
- }
- const getEnhancedComponent = ( testProps ) => {
- // eslint-disable-next-line @wordpress/no-unused-vars-before-return
- const EnhancedComponent = withLatestCheckin( TestComponent );
- return ;
- };
- beforeEach( () => {
- // we don't need original store here.
- registerStore( 'core/data', { selectors: {}, reducer: () => {} } );
- select( 'eventespresso/core' ).getLatestCheckin = getLatestCheckin;
- select( 'core/data' ).hasFinishedResolution = hasFinishedResolution;
- dispatch( 'eventespresso/core' ).toggleCheckin = toggleCheckin;
- } );
- afterEach( () => {
- getLatestCheckin.mockClear();
- hasFinishedResolution.mockClear();
- toggleCheckin.mockClear();
- } );
- describe( 'has expected props when value for registration is not an ' +
- 'instance of BaseEntity', () => {
- let wrapper, testedComponent;
- beforeEach( () => {
- wrapper = renderer.create( getEnhancedComponent() );
- testedComponent = wrapper.root.findByType( TestComponent );
- } );
- it( 'selectors are not called', () => {
- expect( getLatestCheckin ).not.toHaveBeenCalled();
- expect( hasFinishedResolution ).not.toHaveBeenCalled();
- } );
- it( 'wrapped component has expected props', () => {
- expect( testedComponent.props.registration ).toBeUndefined();
- expect( testedComponent.props.datetimeId ).toBeUndefined();
- expect( testedComponent.props.checkinEntity ).toBeUndefined();
- expect( testedComponent.props.hasResolvedCheckin ).toBeUndefined();
- expect( testedComponent.props.onClick ).toBeDefined();
- } );
- it( 'onClick callback does not trigger toggleCheckin', () => {
- const onClick = testedComponent.props.onClick;
- onClick();
- expect( toggleCheckin ).not.toHaveBeenCalled();
- } );
- } );
- describe( 'has expected props when value for registration is an instance ' +
- 'of BaseEntity', () => {
- let wrapper, testedComponent;
- const registration = RegistrationFactory.createNew( {} );
- const datetimeId = 10;
- beforeEach( () => {
- wrapper = renderer.create( getEnhancedComponent( {
- registration,
- datetimeId,
- } ) );
- testedComponent = wrapper.root.findByType( TestComponent );
- } );
- it( 'selectors are called', () => {
- expect( getLatestCheckin ).toHaveBeenCalledWith(
- registration.id,
- datetimeId
- );
- expect( hasFinishedResolution ).toHaveBeenCalledWith(
- 'eventespresso/core',
- 'getLatestCheckin',
- [ registration.id, datetimeId ]
- );
- } );
- it( 'wrapped component has expected props', () => {
- expect( testedComponent.props.registration ).toBe( registration );
- expect( testedComponent.props.datetimeId ).toBe( datetimeId );
- expect( testedComponent.props.checkinEntity )
- .toEqual( { checkIn: true } );
- expect( testedComponent.props.hasResolvedCheckin ).toBe( true );
- expect( testedComponent.props.onClick ).toBeDefined();
- } );
- it( 'onClick callback triggers toggleCheckin', () => {
- const onClick = testedComponent.props.onClick;
- onClick();
- expect( toggleCheckin ).toHaveBeenCalledWith(
- registration.id,
- datetimeId
- );
- } );
- } );
-} );
diff --git a/assets/src/higher-order-components/with-latest-checkin.js b/assets/src/higher-order-components/with-latest-checkin.js
deleted file mode 100644
index 20ae0a89ca6..00000000000
--- a/assets/src/higher-order-components/with-latest-checkin.js
+++ /dev/null
@@ -1,75 +0,0 @@
-/**
- * External imports
- */
-import { withSelect, withDispatch } from '@wordpress/data';
-import { createHigherOrderComponent, compose } from '@wordpress/compose';
-import { isModelEntityOfModel } from '@eventespresso/validators';
-
-/**
- * Exposes properties related to the latest check-in entity for a given
- * registration and datetime.
- *
- * Properties passed through to wrapped component are:
- *
- * - checkInEntity {BaseEntity|null} The check-in entity that is related to the
- * given registration and datetime id.
- * - hasResolvedCheckin {boolean} Whether the check-in entity selector has
- * resolved. This is important because its possible there is no entity for
- * this registration and datetime if that registration hasn never been checked
- * in.
- * - onClick {function} A click handler which when invoked, will toggle the
- * check-in state for the given registration and datetimeId. Note: this will
- * replace the store latestCheckin record in the state for this given
- * registration and datetime id which will get picked up by the `withSelect`
- * HOC in the composed component.
- *
- * @type {WPComponent}
- */
-const withLatestCheckin = createHigherOrderComponent(
- compose( [
- withSelect(
- ( select, { registration, datetimeId } ) => {
- if ( ! isModelEntityOfModel(
- registration,
- 'registration'
- ) ) {
- return {};
- }
- const { getLatestCheckin } = select( 'eventespresso/core' );
- const { hasFinishedResolution } = select( 'core/data' );
- const checkInEntity = getLatestCheckin(
- registration.id,
- datetimeId
- );
- return {
- checkinEntity: checkInEntity || null,
- hasResolvedCheckin: hasFinishedResolution(
- 'eventespresso/core',
- 'getLatestCheckin',
- [ registration.id, datetimeId ]
- ),
- };
- }
- ),
- withDispatch(
- ( dispatch, { registration, datetimeId } ) => {
- const { toggleCheckin } = dispatch( 'eventespresso/core' );
- return {
- onClick() {
- if (
- isModelEntityOfModel(
- registration,
- 'registration'
- )
- ) {
- toggleCheckin( registration.id, datetimeId );
- }
- },
- };
- }
- ),
- ] ),
- 'withLatestCheckin'
-);
-
-export default withLatestCheckin;
diff --git a/assets/src/vo/currency.js b/assets/src/vo/currency.js
deleted file mode 100644
index 944e981a182..00000000000
--- a/assets/src/vo/currency.js
+++ /dev/null
@@ -1,269 +0,0 @@
-/**
- * External imports
- */
-import {
- isEmpty,
- isString,
- isNumber,
- isBoolean,
- isUndefined,
-} from 'lodash';
-import { Exception, CURRENCY_CONFIG } from '@eventespresso/eejs';
-import warning from 'warning';
-
-/**
- * A value object representing currency values
- */
-export class Currency {
- /**
- * because minification destroys class names and renders instaneOf useless
- *
- * @type {string}
- */
- displayName = 'Currency';
-
- /**
- * The ISO 4217 code identifying the currency (eg. 'USD')
- *
- * @type {string}
- */
- code = '';
-
- /**
- * The singular label for the currency (eg. 'Dollar');
- *
- * @type {string}
- */
- singularLabel = '';
-
- /**
- * The plural label for the currency (eg. 'Dollars');
- *
- * @type {string}
- */
- pluralLabel = '';
-
- /**
- * The currency symbol (eg. '$');
- *
- * @type {string}
- */
- sign = '';
-
- /**
- * Whether the currency symbol is displayed before or after the value.
- *
- * @type {boolean}
- */
- signB4 = true;
-
- /**
- * The precision for the value (eg. 10.02 is 2, 10.123 is 3). The number of
- * decimal places can be used to calculate the number of subunits for the
- * currency - subunits = pow( 10, decimalPlaces).
- *
- * @type {number}
- */
- decimalPlaces = 2;
-
- /**
- * The symbol used for the decimal mark (eg. '.')
- *
- * @type {string}
- */
- decimalMark = '.';
-
- /**
- * The symbol used to split up thousands in the value (eg. ',')
- *
- * @type {string}
- */
- thousandsSeparator = ',';
-
- /**
- * The number of fractional divisions of a currency's main unit. If not
- * provided, then it is automatically calculated from the decimalPlaces
- * value.
- *
- * @type {number}
- */
- subunits = 100;
-
- /**
- * Constructor
- *
- * @param {{}} currencyConfig An object containing the configuration for
- * this currency value object. On construction, the Currency object is
- * frozen so that it becomes immutable.
- */
- constructor( currencyConfig ) {
- Currency.validateCurrencyConfig( currencyConfig );
- this.displayName = 'Currency';
- this.code = currencyConfig.code;
- this.singularLabel = currencyConfig.singularLabel || '';
- this.pluralLabel = currencyConfig.pluralLabel || '';
- this.sign = currencyConfig.sign;
- this.signB4 = isUndefined( currencyConfig.signB4 ) ?
- this.signB4 :
- currencyConfig.signB4;
- this.decimalPlaces = isUndefined( currencyConfig.decimalPlaces ) ?
- this.decimalPlaces :
- currencyConfig.decimalPlaces;
- this.decimalMark = currencyConfig.decimalMark || this.decimalMark;
- this.thousandsSeparator = currencyConfig.thousandsSeparator || this.thousandsSeparator;
- this.subunits = currencyConfig.subunits ||
- Math.pow( 10, this.decimalPlaces );
- Object.freeze( this );
- }
-
- /**
- * Returns the currency properties as an object formatted for the
- * accounting-js library configuration.
- *
- * @return {{}} An object shaped for what the accounting-js library expects
- */
- toAccountingSettings() {
- const decimalInfo = {
- decimal: this.decimalMark,
- thousand: this.thousandsSeparator,
- precision: this.decimalPlaces,
- };
- return {
- currency: {
- symbol: this.sign,
- format: {
- pos: this.signB4 ? '%s%v' : '%v%s',
- neg: this.signB4 ? '- $s%v' : '- %v%s',
- zero: this.signB4 ? '%s%v' : '%v%s',
- },
- ...decimalInfo,
- },
- number: decimalInfo,
- };
- }
-
- /**
- * Returns JSON representation of this object.
- *
- * @return {Object} Function returning the object to be serialized by
- * JSON.stringify
- */
- toJSON() {
- return {
- code: this.code,
- singularLabel: this.singularLabel,
- pluralLabel: this.pluralLabel,
- sign: this.sign,
- signB4: this.signB4,
- decimalMark: this.decimalMark,
- thousandsSeparator: this.thousandsSeparator,
- subunits: this.subunits,
- decimalPlaces: this.decimalPlaces,
- };
- }
-
- /**
- * This validates whether the passed in config has the required properties
- * (and correct types) for constructing a Currency object.
- *
- * @param {Object} config
- * @throws {Exception}
- * @throws {TypeError}
- */
- static validateCurrencyConfig = ( config ) => {
- if ( isEmpty( config ) ) {
- throw new Exception(
- 'The configuration object provided to Currency must not' +
- ' be empty'
- );
- }
- if ( ! config.code || ! isString( config.code ) ) {
- throw new TypeError(
- 'The configuration object provided to Currency must have ' +
- 'a "code" property that is a string.'
- );
- }
-
- if ( ! config.sign || ! isString( config.sign ) ) {
- throw new TypeError(
- 'The configuration object provided to Currency must have a ' +
- '"sign" property that is a string.'
- );
- }
-
- if ( config.singularLabel && ! isString( config.singularLabel ) ) {
- throw new TypeError(
- 'The singularLabel property on the configuration object ' +
- 'must be a string primitive.'
- );
- }
-
- if ( config.pluralLabel && ! isString( config.pluralLabel ) ) {
- throw new TypeError(
- 'The pluralLabel property on the configuration object ' +
- 'must be a string primitive.'
- );
- }
-
- if ( config.signB4 && ! isBoolean( config.signB4 ) ) {
- throw new TypeError(
- 'The signB4 property on the configuration object ' +
- 'must be a boolean primitive.'
- );
- }
-
- if ( config.decimalPlaces && ! isNumber( config.decimalPlaces ) ) {
- throw new TypeError(
- 'The decimalPlaces property on the configuration object ' +
- 'must be a number primitive'
- );
- }
-
- if ( config.decimalMark && ! isString( config.decimalMark ) ) {
- throw new TypeError(
- 'The decimalMark property on the configuration object ' +
- 'must be a string primitive.'
- );
- }
-
- if ( config.thousandsSeparator &&
- ! isString( config.thousandsSeparator ) ) {
- throw new TypeError(
- 'The thousandsSeparator property on the configuration object ' +
- 'must be a string primitive.'
- );
- }
-
- if ( config.subunits && ! isNumber( config.subunits ) ) {
- throw new TypeError(
- 'The subunits property on the configuration object ' +
- 'must be a number primitive.'
- );
- }
- }
-}
-
-/**
- * Export of a Currency Value object created from a currency config provided.
- * This catches any exception and triggers a console error.
- *
- * @param {Object} config
- * @return {Currency|{}} If there's a problem constructing the currency object
- * an empty object is returned.
- */
-export const SiteCurrency = ( config = {} ) => {
- let currency;
- try {
- currency = new Currency( config );
- } catch ( e ) {
- currency = {};
- warning(
- false,
- 'The Site Currency object could not be created because ' +
- 'of this error: ' + e.message
- );
- }
- return currency;
-};
-
-export default SiteCurrency( CURRENCY_CONFIG );
diff --git a/assets/src/vo/date-time/assertions.js b/assets/src/vo/date-time/assertions.js
deleted file mode 100644
index 41da23d9c2e..00000000000
--- a/assets/src/vo/date-time/assertions.js
+++ /dev/null
@@ -1,161 +0,0 @@
-/**
- * External imports
- */
-import moment from 'moment-timezone';
-import { isString, isNumber } from 'lodash';
-
-/**
- * Internal imports
- */
-import {
- InvalidTimezone,
- InvalidISO8601String,
- InvalidLocale,
-} from '@eventespresso/eejs';
-
-/**
- * Validates whether the given locale string is a valid locale.
- *
- * @param {string} locale
- * @return {boolean} If given locale string is not valid this will return false.
- */
-export function validateLocale( locale ) {
- if ( ! isString( locale ) ) {
- return false;
- }
- const originalLocale = moment.locale();
- const validationLocale = moment.locale( locale );
- // reset back to original locale
- moment.locale( originalLocale );
- return ! ( locale !== 'en' && validationLocale === 'en' );
-}
-
-/**
- * Asserts whether given locale string is valid. If it's not an exception is
- * thrown.
- *
- * @param {string} locale
- * @throws InvalidLocale
- */
-export function assertLocaleIsValid( locale ) {
- if ( ! validateLocale( locale ) ) {
- throw new InvalidLocale( locale );
- }
-}
-
-/**
- * Validates whether the given string is a valid ISO8601 formatted date and
- * time string.
- *
- * Note: date regex pattern from
- * http://www.pelagodesign.com/blog/2009/05/20/iso-8601-date-validation-that-doesnt-suck/
- * Note: isDuration regex pattern from
- * https://github.com/cylc/cylc/issues/119#issuecomment-9435533
- *
- * @param {string} dateTimeString
- * @param {boolean} isDuration Whether to validate for a duration format or not.
- * @return {boolean} Returns false if the given string is not valid ISO8601
- * format
- */
-export function validateISO8601( dateTimeString, isDuration = false ) {
- if ( ! isString( dateTimeString ) ) {
- return false;
- }
- const regex = isDuration ?
- /^(R\d*\/)?P(?:\d+(?:\.\d+)?Y)?(?:\d+(?:\.\d+)?M)?(?:\d+(?:\.\d+)?W)?(?:\d+(?:\.\d+)?D)?(?:T(?:\d+(?:\.\d+)?H)?(?:\d+(?:\.\d+)?M)?(?:\d+(?:\.\d+)?S)?)?$/ :
- /^([\+-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))([T\s]((([01]\d|2[0-3])((:?)[0-5]\d)?|24\:?00)([\.,]\d+(?!:))?)?(\17[0-5]\d([\.,]\d+)?)?([zZ]|([\+-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)?$/;
- return regex.test( dateTimeString );
-}
-
-/**
- * Asserts whether the given string is a valid ISO8601 formatted date and time
- * string.
- *
- * @param {string} dateTimeString
- * @param {boolean} isDuration Whether to assert for a duration format or not.
- * @throws InvalidISO8601String
- */
-export function assertISO8601IsValid( dateTimeString, isDuration = false ) {
- if ( ! validateISO8601( dateTimeString, isDuration ) ) {
- throw new InvalidISO8601String( dateTimeString );
- }
-}
-
-/**
- * Validates whether the given string is a valid timezone string.
- *
- * @param {string} timezone
- * @return {boolean} Returns false if the given string is not a valid timezone
- * string
- */
-export function validateTimezone( timezone ) {
- if ( ! isString( timezone ) ) {
- return false;
- }
- const dt = moment.tz.zone( timezone );
- return dt !== null;
-}
-
-/**
- * Asserts whether the given string is a valid timezone string and throws an
- * exception if it isn't.
- *
- * @param {string} timezone
- * @throws InvalidTimezone
- */
-export function assertTimezoneIsValid( timezone ) {
- if ( ! validateTimezone( timezone ) ) {
- throw new InvalidTimezone( timezone );
- }
-}
-
-/**
- * Validates whether the given value is an instance of the javascript Date
- * object.
- *
- * @param {Date} date
- * @return {boolean} True means the value is an instance of Date
- */
-export function validateIsDate( date ) {
- return date instanceof Date;
-}
-
-/**
- * Asserts whether the given value is an instance of Date.
- * @param {Date} date
- * @throws TypeError
- */
-export function assertIsDate( date ) {
- if ( ! validateIsDate( date ) ) {
- throw new TypeError(
- 'The provided value is not an instance of Date'
- );
- }
-}
-
-/**
- * Validates whether the provided value is a valid offset
- *
- * Currently this just validates the provided value is a number. Eventually it
- * might check upper and lower limits.
- *
- * @param {number} offset
- * @return {boolean} true means its valid.
- */
-export function validateIsOffset( offset ) {
- return isNumber( offset );
-}
-
-/**
- * Asserts whether the provided value is a valid offset.
- *
- * @param {number} offset
- * @throws TypeError
- */
-export function assertIsOffset( offset ) {
- if ( ! validateIsOffset( offset ) ) {
- throw new TypeError(
- 'Offset is expected to be a number'
- );
- }
-}
diff --git a/assets/src/vo/date-time/datetime.js b/assets/src/vo/date-time/datetime.js
deleted file mode 100644
index 8785ef1ac17..00000000000
--- a/assets/src/vo/date-time/datetime.js
+++ /dev/null
@@ -1,1224 +0,0 @@
-/**
- * External imports
- */
-import moment from 'moment-timezone';
-import {
- capitalize,
- omit,
- isNumber,
- isEmpty,
- reduce,
- isObject,
- isUndefined,
- isFunction,
-} from 'lodash';
-import { instanceOf } from '@eventespresso/validators';
-
-/**
- * Internal imports
- */
-import {
- InvalidDateTime,
- InvalidArgument,
- InvalidISO8601String,
-} from '@eventespresso/eejs';
-import * as assertions from './assertions';
-import Duration from './duration';
-import {
- DEFAULT_TIMEZONE_STRING,
- DEFAULT_OFFSET,
- DEFAULT_VALID_LOCALE,
- DEFAULT_FORMAT,
-} from './defaults';
-
-/**
- * A collection of symbols used for "private" properties in the DateTime object.
- *
- * @type {
- * {
- * datetime: Symbol
- * }
- * }
- */
-const privateProperties = {
- datetime: Symbol( 'DateTimePropertyDateTime' ),
-};
-
-/**
- * A collection of symbols used for "private" methods in the DateTime object.
- *
- * @type {
- * {
- * getUnitNames: Symbol,
- * createGettersAndSetters: Symbol,
- * extractMomentsFromDateTimes: Symbol,
- * normalizeUnitName: Symbol,
- * normalizeUnitObject: Symbol,
- * normalizeUnitValue: Symbol,
- * }
- * }
- */
-const privateMethods = {
- getUnitNames: Symbol( 'DateTimeMethodGetUnitNames' ),
- createGettersAndSetters: Symbol( 'DateTimeMethodCreateGettersAndSetters' ),
- extractMomentsFromDateTimes: Symbol( 'DateTimeMethodExtractMomentsFromDateTimes' ),
- normalizeUnitName: Symbol( 'DateTimeMethodNormalizeUnitName' ),
- normalizeUnitObject: Symbol( 'DateTimeMethodNormalizeUnitObject' ),
- normalizeUnitValue: Symbol( 'DateTimeMethodNormalizeUnitValue' ),
- normalizeArguments: Symbol( 'DateTimeMethodNormalizeArguments' ),
-};
-
-const validDateTimeUnits = [
- 'year',
- 'month',
- 'day',
- 'hour',
- 'minute',
- 'second',
- 'millisecond',
-];
-
-/**
- * The DateTime value object represents a single point in time.
- *
- * Internally, the DateTime class here uses `moment`. This is an abstraction
- * loosely following the adapter pattern so that there is a common api that
- * can be depended on if in the future the internal library is switched to
- * something different (such as Luxon).
- */
-export default class DateTime {
- /**
- * because minification destroys class names and renders instaneOf useless
- *
- * @type {string}
- */
- displayName = 'DateTime';
-
- /**
- * The constructor for the DateTime class
- *
- * @param {string} iso8601DateString
- * @param {string|null} timezone If null, then timezone is not set.
- * @param {string} locale
- * @param {string} displayName
- */
- constructor(
- iso8601DateString = '',
- timezone = DEFAULT_TIMEZONE_STRING,
- locale = DEFAULT_VALID_LOCALE,
- displayName = 'DateTime'
- ) {
- this.displayName = displayName === 'DateTime' || displayName === 'ServerDateTime' ? displayName : 'DateTime';
- if ( iso8601DateString !== '' ) {
- this.constructor.assertISO8601IsValid( iso8601DateString );
- }
- this.constructor.assertLocaleIsValid( locale );
- if ( timezone === null ) {
- this[ privateProperties.datetime ] = iso8601DateString === '' ?
- moment.utc().locale( locale ) :
- moment( iso8601DateString )
- .utcOffset( iso8601DateString )
- .locale( locale );
- } else if ( timezone === this.constructor.TIMEZONE_LOCAL ) {
- this[ privateProperties.datetime ] = iso8601DateString === '' ?
- moment().locale( locale ) :
- moment( iso8601DateString ).locale( locale );
- } else {
- this.constructor.assertTimezoneIsValid( timezone );
- this[ privateProperties.datetime ] = iso8601DateString === '' ?
- moment().tz( timezone ).locale( locale ) :
- moment.tz(
- iso8601DateString,
- timezone
- ).locale( locale );
- }
- this[ privateMethods.createGettersAndSetters ]();
- Object.freeze( this );
- }
-
- /**
- * Indicates if the given locale is a valid locale.
- *
- * @param {string} locale
- * @return {boolean} true means it is valid
- */
- static validateLocale(locale) {
- return assertions.validateLocale( locale );
- }
-
- /**
- * Asserts if the given locale is valid and throws an error if not.
- *
- * @param {string} locale
- * @throws InvalidLocale
- */
- static assertLocaleIsValid(locale) {
- assertions.assertLocaleIsValid( locale );
- }
-
- /**
- * Indicates if the given ISO8601 string is valid.
- *
- * @param {string} dateTimeString
- * @return {boolean} true means it is valid.
- */
- static validateISO8601( dateTimeString ) {
- return assertions.validateISO8601( dateTimeString );
- }
-
- /**
- * Asserts if the given string is a valid ISO 8601 string.
- *
- * @param {string} dateTimeString
- * @throws InvalidISO8601String
- */
- static assertISO8601IsValid( dateTimeString ) {
- assertions.assertISO8601IsValid( dateTimeString );
- }
-
- /**
- * Indicates if the given string is a valid timezone
- *
- * @param {string} timezone
- * @return {boolean} true means it is valid.
- */
- static validateTimezone( timezone ) {
- return assertions.validateTimezone( timezone );
- }
-
- /**
- * Asserts whether the given string is a valid timezone string.
- *
- * @param {string} timezone
- * @throws InvalidTimezone
- */
- static assertTimezoneIsValid( timezone ) {
- assertions.assertTimezoneIsValid( timezone );
- }
-
- /**
- * Validates whether the provided value is a valid offset
- *
- * Currently this just validates the provided value is a number. Eventually it
- * might check upper and lower limits.
- *
- * @param {number} offset
- * @return {boolean} true means its valid.
- */
- static validateIsOffset( offset ) {
- return assertions.validateIsOffset( offset );
- }
-
- /**
- * Asserts whether the provided value is a valid offset.
- *
- * @param {number} offset
- * @throws TypeError
- */
- static assertIsOffset( offset ) {
- assertions.assertIsOffset( offset );
- }
-
- /**
- * Indicates whether the provided value is an instance of DateTime
- *
- * @param {DateTime} datetime
- * @return {boolean} returns true if it is an instance of DateTime
- */
- static validateIsDateTime(datetime) {
- return instanceOf( datetime, 'DateTime' ) || instanceOf( datetime, 'ServerDateTime' );
- }
-
- /**
- * Asserts whether the provided value is an instance of DateTime
- *
- * @param {DateTime} datetime
- * @throws TypeError
- */
- static assertIsDateTime( datetime ) {
- if ( ! this.validateIsDateTime( datetime ) ) {
- throw new TypeError(
- 'The provided value is not an instance of DateTime'
- );
- }
- }
-
- /**
- * Validates whether the given value is an instance of the javascript Date
- * object.
- *
- * @param {Date} date
- * @return {boolean} True means the value is an instance of Date
- */
- static validateIsDate( date ) {
- return assertions.validateIsDate( date );
- }
-
- /**
- * Asserts whether the given value is an instance of Date.
- *
- * @param {Date} date
- * @throws TypeError
- */
- static assertIsDate( date ) {
- assertions.assertIsDate( date );
- }
-
- /**
- * Indicates whether the provided value is an instance of DateTime and is
- * a "valid" datetime (meaning the instance was constructed with valid
- * arguments).
- *
- * @param {DateTime} datetime
- * @return {boolean} true means it is valid.
- */
- static isValid( datetime ) {
- return this.validateIsDateTime( datetime ) && datetime.isValid();
- }
-
- /**
- * Asserts whether the provided value is an instance of DateTime and is
- * a "valid" datetime (meaning the instance was constructed with valid
- * arguments)
- *
- * @param {DateTime} datetime
- * @throws InvalidDateTime
- */
- static assertIsValid( datetime ) {
- if ( ! this.isValid( datetime ) ) {
- throw new InvalidDateTime( datetime );
- }
- }
-
- static [privateMethods.normalizeArguments](dateValue, timezone, locale) {
- return [ dateValue, timezone, locale ];
- }
-
- /**
- * A private internal helper method that is used to extract all moment
- * instances from the provided DateTimes (passed in as arguments).
- *
- * @param {...DateTime} datetimes
- * @return {Moment[]} An array of moment instances extracted from the
- * DateTimes
- */
- static [ privateMethods.extractMomentsFromDateTimes ]( ...datetimes ) {
- return datetimes.map( ( datetime ) => {
- this.assertIsDateTime( datetime );
- return datetime[ privateProperties.datetime ];
- } );
- }
-
- /**
- * Given an indefinite number of DateTimes as arguments, this will return a
- * new DateTime that represents the latest point in time.
- *
- * @param {...DateTime} datetimes
- * @return {DateTime|ServerDateTime} A new DateTime representing the latest point of time.
- */
- static max( ...datetimes ) {
- return this.fromMoment(
- moment.max(
- this[ privateMethods.extractMomentsFromDateTimes ](
- ...datetimes
- )
- )
- );
- }
-
- /**
- * Given an indefinite number of DateTimes as arguments, this will return a
- * new DateTime that represents the earliest point in time.
- *
- * @param {...DateTime} datetimes
- * @return {DateTime|ServerDateTime} A new DateTime representing the earliest point in
- * time.
- */
- static min( ...datetimes ) {
- return this.fromMoment(
- moment.min(
- this[ privateMethods.extractMomentsFromDateTimes ](
- ...datetimes
- )
- )
- );
- }
-
- /**
- * Constructs a DateTime from an instance of moment.
- *
- * @param {moment} momentInstance
- * @return {DateTime|ServerDateTime} An instance of DateTime
- */
- static fromMoment( momentInstance ) {
- if ( ! moment.isMoment( momentInstance ) ) {
- throw new TypeError( 'Requires an instance of moment.' );
- }
-
- // this would account for client code that is using `moment` but not
- // using `moment-timezone`.
- return isFunction( momentInstance.tz ) &&
- ! isUndefined( momentInstance.tz() ) &&
- momentInstance.tz() !== 'UTC' ?
- new this(
- momentInstance.toISOString(),
- momentInstance.tz(),
- momentInstance.locale()
- ) :
- new this(
- momentInstance.toISOString( true ),
- null,
- momentInstance.locale()
- );
- }
-
- /**
- * Constructs a DateTime from an ISO 8601 string.
- *
- * @param {string} ISOString
- * @param {string} timezone
- * @param {string} locale
- * @return {DateTime|ServerDateTime} An instance of DateTime
- */
- static fromISO(
- ISOString,
- timezone = DEFAULT_TIMEZONE_STRING,
- locale = DEFAULT_VALID_LOCALE
- ) {
- if ( isEmpty( ISOString ) ) {
- throw new InvalidISO8601String( ISOString );
- }
- return new this(
- ISOString,
- timezone,
- locale
- );
- }
-
- /**
- * Constructs a DateTime from an ISO 8601 String
- * Differs with `fromISO` in that this allows passing a offset value
- * instead of a timezone string.
- *
- * @param {string} ISOString
- * @param {number} offset In minutes unless > -16 or < -16 in which case it
- * is treated as hours.
- * @param {string} locale
- * @return {DateTime|ServerDateTime} An instance of DateTime
- */
- static fromISOWithOffset(
- ISOString,
- offset = DEFAULT_OFFSET,
- locale = DEFAULT_VALID_LOCALE
- ) {
- this.assertISO8601IsValid( ISOString );
- this.assertIsOffset( offset );
- this.assertLocaleIsValid( locale );
- const datetime = moment.utc( ISOString )
- .utcOffset( offset, true )
- .locale( locale );
- return this.fromMoment( datetime );
- }
-
- /**
- * Constructs a DateTime from a javascript Date object.
- *
- * @param {Date} date
- * @param {string} timezone
- * @param {string} locale
- * @return {DateTime|ServerDateTime} Returns an instance of DateTime
- */
- static fromJSDate(
- date,
- timezone = DEFAULT_TIMEZONE_STRING,
- locale = DEFAULT_VALID_LOCALE
- ) {
- this.assertIsDate( date );
- this.assertTimezoneIsValid( timezone );
- this.assertLocaleIsValid( locale );
- return this.fromMoment(
- moment( date ).tz( timezone ).locale( locale )
- );
- }
-
- /**
- * Constructs a Datetime from a javascript Date object.
- *
- * The difference between this and fromJSDate is that this can be set with
- * an offset vs a timezone string.
- *
- * @param {Date} date
- * @param {number} offset
- * @param {string} locale
- * @return {DateTime|ServerDateTime} Returns an instance of DateTime
- */
- static fromJSDateWithOffset(
- date,
- offset = DEFAULT_OFFSET,
- locale = DEFAULT_VALID_LOCALE
- ) {
- this.assertIsDate( date );
- this.assertIsOffset( offset );
- this.assertLocaleIsValid( locale );
- return this.fromMoment(
- moment( date ).utcOffset( offset ).locale( locale )
- );
- }
-
- /**
- * Constructs a DateTime (in UTC) with milliseconds from epoch.
- *
- * @param {number} milliseconds
- * @param {string} locale
- * @return {DateTime|ServerDateTime} Returns an instance of DateTime
- * @throws TypeError
- */
- static fromMilliseconds( milliseconds, locale = DEFAULT_VALID_LOCALE ) {
- this.assertLocaleIsValid( locale );
- if ( ! isNumber( milliseconds ) ) {
- throw new TypeError( 'Provided value must be a number ' +
- 'representing milliseconds from the epoch' );
- }
- return this.fromMoment(
- moment( milliseconds ).utc().locale( locale )
- );
- }
-
- /**
- * Constructs a DateTime in UTC with seconds from the epoch.
- *
- * @param {number} seconds
- * @param {string} locale
- * @return {DateTime|ServerDateTime} An instance of DateTime
- * @throws TypeError
- */
- static fromUnix( seconds, locale = DEFAULT_VALID_LOCALE ) {
- this.assertLocaleIsValid( locale );
- if ( ! isNumber( seconds ) ) {
- throw new TypeError( 'Provided value must be a number ' +
- 'representing seconds from the epoch' );
- }
- return this.fromMoment(
- moment.unix( seconds ).utc().locale( locale )
- );
- }
-
- /**
- * Constructs a DateTime from an object of values assuming its in "local"
- * time (if run via browser or server if run server side).
- *
- * The object is expected to be a representation of this instance in time:
- * Eg.
- * { year: 2018, month: 12, day: 25, hour: 0, minute: 15, seconds: 0 }
- *
- * Pass an empty values value if you want the instance in time to represent
- * "now".
- *
- * @param {Object} values
- * @param {string} locale
- * @return {DateTime|ServerDateTime} An instance of DateTime
- * @throws InvalidArgument
- */
- static fromLocal( values, locale = DEFAULT_VALID_LOCALE ) {
- this.assertLocaleIsValid( locale );
- values = this[ privateMethods.normalizeUnitObject ]( values );
- const datetime = isEmpty( values ) ?
- moment().locale( locale ) :
- moment( values ).locale( locale );
- if ( datetime.isValid() !== true ) {
- throw new InvalidArgument(
- 'Double-check the values you sent in.',
- values
- );
- }
- return this.fromMoment( datetime );
- }
-
- /**
- * Constructs a DateTime from an object of values and assumes its in
- * 'UTC'.
- *
- * The object is expected to be a representation of this instance in time:
- * Eg.
- * { year: 2018, month: 12, day: 25, hour: 0, minute: 15, seconds: 0 }
- *
- * Any units not specified will be assumed to be `0`.
- *
- * Pass an empty values value if you want the instance in time to represent
- * "now".
- *
- * @param {Object} values
- * @param {string} locale
- * @return {DateTime|ServerDateTime} An instance of DateTime
- * @throws InvalidArgument
- */
- static utc( values, locale = DEFAULT_VALID_LOCALE ) {
- this.assertLocaleIsValid( locale );
- values = this[ privateMethods.normalizeUnitObject ]( values );
- const datetime = isEmpty( values ) ?
- moment.utc().locale( locale ) :
- moment.utc( values ).locale( locale );
- if ( datetime.isValid() !== true ) {
- throw new InvalidArgument(
- 'Double-check the values sent in.',
- values
- );
- }
- return this.fromMoment( datetime );
- }
-
- /**
- * Constructs a DateTime from a configuration object.
- *
- * The configuration object can have:
- * - any of the DateTime units ('year', 'month', etc)
- * - 'locale' a string representing the locale
- * - 'timezone' a string representing the timezone
- * - 'offset' a number representing the offset from UTC this instance in
- * time represents.
- *
- * @param {Object} values
- * @return {DateTime|ServerDateTime} An instance of DateTime
- */
- static fromObject( values ) {
- const locale = values.locale || DEFAULT_VALID_LOCALE;
- const timezone = values.timezone || DEFAULT_TIMEZONE_STRING;
- const offset = isUndefined( values.offset ) ?
- null :
- values.offset;
- let valuesForConstruct = omit(
- values,
- [ 'locale', 'timezone', 'offset' ]
- );
-
- this.assertLocaleIsValid( locale );
-
- if ( offset !== null ) {
- this.assertIsOffset( offset );
- valuesForConstruct = this[ privateMethods.normalizeUnitObject ](
- valuesForConstruct
- );
- const datetime = isEmpty( valuesForConstruct ) ?
- moment().utcOffset( offset, true ).locale( locale ) :
- moment.utc( valuesForConstruct )
- .utcOffset( offset, true )
- .locale( locale );
- if ( datetime.isValid() !== true ) {
- throw new InvalidArgument(
- 'Double-check the configuration object sent in.',
- values
- );
- }
- return this.fromMoment( datetime );
- }
-
- if ( timezone === this.TIMEZONE_LOCAL ) {
- return this.fromLocal( valuesForConstruct, locale );
- }
-
- this.assertTimezoneIsValid( timezone );
-
- valuesForConstruct = this[ privateMethods.normalizeUnitObject ](
- valuesForConstruct
- );
- const datetime = moment.tz( valuesForConstruct, timezone )
- .locale( locale );
- if ( datetime.isValid() !== true ) {
- throw new InvalidArgument(
- 'Double-check the configuration object sent in.',
- values
- );
- }
- return this.fromMoment( datetime );
- }
-
- /**
- * Moment uses different names for some unit getters/setters/properties so
- * this is used to normalize a given unit name to what moment uses.
- *
- * @param {string} nameToNormalize
- * @return {string} Normalized unit name.
- */
- static [ privateMethods.normalizeUnitName ]( nameToNormalize ) {
- const map = {
- day: 'date',
- days: 'day',
- date: 'day',
- years: 'year',
- months: 'month',
- milliseconds: 'millisecond',
- minutes: 'minute',
- seconds: 'second',
- hours: 'hour',
- };
- return map[ nameToNormalize ] ?
- map[ nameToNormalize ] :
- nameToNormalize;
- }
-
- /**
- * Handles normalizing unit values for internal library use.
- *
- * For example, moment zero indexes months. DateTime does not, so this
- * method helps with normalizing month values for both setting (used by
- * moment) and getting (returned to client). This allows client code
- * to expect months in DateTime to be handled with a non-zero index.
- *
- * @param {string} unit The unit to be normalized
- * @param {mixed} value The value for that unit
- * @param {boolean} set Whether this should normalize for setting or
- * getting.
- * @return {mixed} The normalized value.
- */
- static [ privateMethods.normalizeUnitValue ]( unit, value, set = true ) {
- if ( unit === 'month' ) {
- value = set ? value - 1 : value + 1;
- }
- return value;
- }
-
- /**
- * Given a simple object containing units, this normalizes the object to
- * what moment recognizes.
- *
- * @param {Object} setObject
- * @param {boolean} set true if setting the object, false if getting the
- * object
- * @return {Object} The normalized object.
- */
- static [ privateMethods.normalizeUnitObject ]( setObject, set = true ) {
- if ( ! isObject( setObject ) ) {
- throw new TypeError(
- 'The incoming value must be an object'
- );
- }
- return reduce( setObject, ( result, value, key ) => {
- key = this[ privateMethods.normalizeUnitName ]( key );
- result[ key ] = this[ privateMethods.normalizeUnitValue ](
- key,
- value,
- set
- );
- return result;
- }, {} );
- }
-
- /**
- * Returns the date and time unit names
- * @return {string[]} An array of unit names
- */
- [ privateMethods.getUnitNames ]() {
- return validDateTimeUnits;
- }
-
- /**
- * Creates the various getter and setters for the value object.
- */
- [ privateMethods.createGettersAndSetters ]() {
- this[ privateMethods.getUnitNames ]().forEach(
- ( unitName ) => {
- // creates accessor for getting the unit value via a
- // property (eg. instance.hour)
- Object.defineProperty( this, unitName, {
- get() {
- const methodName = this.constructor[ privateMethods.normalizeUnitName ]( unitName );
- const unitValue = this[ privateProperties.datetime ]
- [ methodName ]();
- return this.constructor[ privateMethods.normalizeUnitValue ](
- unitName,
- unitValue,
- false
- );
- },
- } );
- // creates a fluent setter for the value.
- Object.defineProperty( this, 'set' + capitalize( unitName ), {
- get() {
- return ( value ) => {
- return this.set( { [ unitName ]: value } );
- };
- },
- } );
- }
- );
- }
-
- /**
- * Used to set various parts of the datetime string and returns a NEW
- * instance of DateTime
- *
- * Note: this will construct a DateTime even with invalid units. Make use of
- * `isValid()` to determine whether the instance is a valid DateTime or not.
- *
- * @param {{}} setObject An object where keys are the units.
- * @return {DateTime|ServerDateTime} A new instance of DateTime.
- */
- set( setObject = {} ) {
- setObject = this.constructor[ privateMethods.normalizeUnitObject ]( setObject );
- return new this.constructor(
- this[ privateProperties.datetime ].clone().set( setObject ).toISOString(),
- this.timezone,
- this.locale
- );
- }
-
- /**
- * Accessor for the timezone string.
- *
- * @return {string} The timezone string
- */
- get timezone() {
- return this[ privateProperties.datetime ].tz();
- }
-
- /**
- * Fluent setter for the timezone property.
- *
- * @param {string} timezone
- * @return {DateTime|ServerDateTime} Returns a new instance of DateTime
- */
- setTimezone( timezone ) {
- this.constructor.assertTimezoneIsValid( timezone );
- return new this.constructor(
- this[ privateProperties.datetime ].toISOString(),
- timezone,
- this.locale
- );
- }
-
- /**
- * Returns the number of days for the month set in this instance.
- *
- * @return {number} The number of days in the month.
- */
- get daysInMonth() {
- return this[ privateProperties.datetime ].daysInMonth();
- }
-
- /**
- * Whether the current instance in time is currently in Daylight Savings
- * Time.
- *
- * @return {boolean} True means it is currently in Daylight Savings Time.
- */
- get isInDST() {
- return this[ privateProperties.datetime ].isDST();
- }
-
- /**
- * Whether the current instance in time is currently in a leap year.
- *
- * @return {boolean} True means this date time is in a leap year.
- */
- get isInLeapYear() {
- return this[ privateProperties.datetime ].isLeapYear();
- }
-
- /**
- * Returns the offset from UTC for the current instance in time (in minutes).
- * @return {number} The offset is in minutes
- */
- get offset() {
- return this[ privateProperties.datetime ].utcOffset();
- }
-
- /**
- * A fluent setter for the UTC offset.
- *
- * The offset provided defaults to expecting in minutes. However if the
- * input is less than 16 and greater than -16, it will interpret the input
- * as hours instead.
- *
- * @param {number} offset
- * @return {DateTime|ServerDateTime} returns a new instance of DateTime
- */
- setOffset( offset ) {
- this.constructor.assertIsOffset( offset );
- return this.constructor.fromMoment(
- this[ privateProperties.datetime ].clone().utcOffset( offset )
- );
- }
-
- /**
- * Exposes the day of the year for the date and time in the object.
- *
- *
- * @return {number} A number between 1 and 366 (depending on whether the
- * internal date and time is in a leap year or not).
- */
- get dayOfYear() {
- return this[ privateProperties.datetime ].dayOfYear();
- }
-
- /**
- * Exposes the quarter for the date and time in the object.
- *
- * @return {number} A number between 1 and 4
- */
- get quarter() {
- return this[ privateProperties.datetime ].quarter();
- }
-
- /**
- * Exposes the ISO number of the week for the date and time in the object.
- *
- * @link https://en.wikipedia.org/wiki/ISO_week_date
- * @return {number} Will be a number between 1 and 52ish
- */
- get isoWeekNumber() {
- return this[ privateProperties.datetime ].isoWeek();
- }
-
- /**
- * Exposes the ISO number for the week year for the date and time in the
- * object.
- *
- * @link https://en.wikipedia.org/wiki/ISO_week_date
- * @return {number} Will be a number representing a year.
- */
- get isoWeekYear() {
- return this[ privateProperties.datetime ].isoWeekYear();
- }
-
- /**
- * Exposes the ISO number for the day of the week for the date and time in
- * the object.
- *
- * @link https://en.wikipedia.org/wiki/ISO_week_date
- * @return {number} A number between 1 and 7 (Monday is 1 and Sunday is 7)
- */
- get isoWeekDay() {
- return this[ privateProperties.datetime ].isoWeekday();
- }
-
- /**
- * Exposes the number of weeks in this DateTime's year.
- *
- * @link https://en.wikipedia.org/wiki/ISO_week_date
- * @return {number} The number of weeks in the ISO year.
- */
- get isoWeeksInWeekYear() {
- return this[ privateProperties.datetime ].isoWeeksInYear();
- }
-
- /**
- * Returns what the set locale is for this DateTime
- *
- * @return {string} A locale string
- */
- get locale() {
- return this[ privateProperties.datetime ].locale();
- }
-
- /**
- * A fluent setter for setting the locale.
- *
- * @param {string} locale
- * @return {DateTime|ServerDateTime} a new instance of DateTime equivalent to this one but
- * with different locale.
- */
- setLocale( locale ) {
- this.constructor.assertLocaleIsValid( locale );
- return this.constructor.fromMoment(
- this[ privateProperties.datetime ]
- .clone()
- .locale( locale )
- );
- }
-
- /**
- * Whether this DateTime instance is valid.
- *
- * Typically an invalid state is achieved when the internal moment is
- * invalid. This can happen when the moment instance is created with
- * invalid parameters.
- *
- * Note: with moment.timezone (which is the internal library),
- * moment.isValid() could return true, false or a string for why it's
- * invalid. This is why a strict equality check is done for whether it is
- * true or not.
- *
- * @return {boolean} True means the instance is valid.
- */
- isValid() {
- return this[ privateProperties.datetime ].isValid() === true;
- }
-
- /**
- * Returns the difference between two DateTime instances as a Duration.
- *
- * @param {DateTime} otherDateTime
- * @return {Duration} An instance of Duration representing the difference
- * between the two DateTime objects.
- */
- diff( otherDateTime ) {
- this.constructor.assertIsDateTime( otherDateTime );
- return new Duration(
- moment.duration(
- this[ privateProperties.datetime ]
- .diff( otherDateTime[ privateProperties.datetime ] )
- )
- );
- }
-
- /**
- * Returns the difference between this DateTime and "now" as a Duration.
- *
- * @return {Duration} An instance of Duration representing the difference
- * between this DateTime and "now"
- */
- diffNow() {
- return new Duration(
- moment.duration(
- this[ privateProperties.datetime ]
- .diff( moment() )
- )
- );
- }
-
- /**
- * Set the value of this DateTime to the end (i.e. the last millisecond) of
- * a unit of time.
- *
- * @param {string} unit
- * @return {DateTime|ServerDateTime} Returns a new DateTime instance.
- */
- endOf( unit ) {
- return this.constructor.fromMoment(
- this[ privateProperties.datetime ].clone().endOf( unit )
- );
- }
-
- /**
- * Compares this DateTime with provided DateTime and returns whether they
- * are equal to each other.
- *
- * The two DateTimes are considered equal if they represent the same
- * millisecond, have the same zone and location, and are both valid.
- *
- * @param {DateTime} otherDateTime
- * @return {boolean} True means they are equal
- */
- equals( otherDateTime ) {
- this.constructor.assertIsDateTime( otherDateTime );
- return this[ privateProperties.datetime ]
- .isSame( otherDateTime[ privateProperties.datetime ] );
- }
-
- /**
- * Whether this DateTime is in the same unit of time as another DateTime
- *
- * eg. DateTime.fromLocal().hasSame( otherDT, 'day' ) //~> true if both the
- * same calendar day.
- *
- * Note: this will match all units equal or larger. For example, passing in
- * `month` will check `month` and `year`. So it's not only checking if the
- * two dates share the same month, but that they are the same month in the
- * same year. If you passed in day, it would return whether the provided
- * DateTime is in the same day, month and year as this DateTime.
- *
- * @param {DateTime} otherDateTime
- * @param {string} unit
- * @return {boolean} True means they are both in the same time for the
- * given unit.
- */
- hasSame( otherDateTime, unit ) {
- this.constructor.assertIsDateTime( otherDateTime );
- return this[ privateProperties.datetime ]
- .isSame( otherDateTime[ privateProperties.datetime ], unit );
- }
-
- /**
- * Subtract a period of time (represented by a Duration) from this DateTime
- * and return the resulting DateTime.
- *
- * @param {Duration} duration
- * @return {DateTime|ServerDateTime} A new instance of DateTime for the new date and time.
- */
- minus( duration ) {
- Duration.assertIsValidDuration( duration );
- return this.constructor.fromMoment(
- this[ privateProperties.datetime ]
- .clone()
- .subtract( duration.toObject() )
- );
- }
-
- /**
- * Add a period of time (represented by a Duration) to this DateTime and
- * return the resulting DateTime
- *
- * @param {Duration} duration
- * @return {DateTime|ServerDateTime} A new instance of DateTime for the new date and time.
- */
- plus( duration ) {
- Duration.assertIsValidDuration( duration );
- return this.constructor.fromMoment(
- this[ privateProperties.datetime ]
- .clone()
- .add( duration.toObject() )
- );
- }
-
- /**
- * Set the value of this DateTime to the beginning of a specified unit of
- * time and return a new DateTime representing that.
- *
- * eg.
- * startOf( DateTime.UNIT_YEAR ) //sets to January 1st, 12:00am this
- * year.
- * startOf( DateTime.UNIT_MONTH ) //sets to the first of this month, 12:00am
- *
- * @param {string} unit
- * @return {DateTime|ServerDateTime} A new instance of DateTime
- */
- startOf( unit ) {
- return this.constructor.fromMoment(
- this[ privateProperties.datetime ].clone().startOf( unit )
- );
- }
-
- /**
- * Returns a string representation of this DateTime formatted according to
- * the specified format string.
- *
- * @link https://momentjs.com/docs/#/displaying/format/
- * @see Moment format ^^ section for the available formats that can be used.
- *
- * An empty format value will return the string formatted in ISO 8601 with
- * any offset included.
- *
- * Without any argument passed, the format will be whatever string the
- * format is server side.
- *
- * @param {string} format
- * @return {string} The date and time displayed according to the provided
- * format.
- */
- toFormat( format = DEFAULT_FORMAT ) {
- return this[ privateProperties.datetime ].format( format );
- }
-
- /**
- * Returns a string representation of this DateTime formatted according to
- * the ISO 8601 standard.
- *
- * If `inUTC` is true (default) then `toISO` will return the ISO string in
- * UTC. Otherwise it will include the offset information for the internal
- * timezone/offset on the moment in time.
- *
- * @param {boolean} inUTC
- * @return {string} An ISO8601 string
- */
- toISO( inUTC = true ) {
- return inUTC ?
- this[ privateProperties.datetime ].toISOString() :
- this[ privateProperties.datetime ].toISOString( true );
- }
-
- /**
- * Returns the value for this DateTime as a javascript Date object.
- *
- * @return {Date} A javascript Date instance
- */
- toJSDate() {
- return this[ privateProperties.datetime ].toDate();
- }
-
- /**
- * When serializing an object to JSON, if there is a DateTime instance, it
- * will be represented as an ISO8601 string.
- *
- * @return {string} An ISO 8601 string
- */
- toJSON() {
- return this[ privateProperties.datetime ].toISOString();
- }
-
- /**
- * Converts a DateTime to whatever the "local" time is.
- *
- * @return {DateTime|ServerDateTime} a new instance of the DateTime
- */
- toLocal() {
- return this.constructor.fromMoment(
- this[ privateProperties.datetime ].clone().local()
- );
- }
-
- /**
- * Returns the milliseconds since the Unix Epoch for the current DateTime
- * instance.
- *
- * @return {number} Number of milliseconds since Unix Epoch
- */
- toMillis() {
- return this.valueOf();
- }
-
- /**
- * Returns a simple object containing year, month, day, hour,
- * minute, second, and millisecond.
- *
- * @return {Object} An object with year, month, day, hour, minute, second,
- * and millisecond.
- */
- toObject() {
- const datetime = this[ privateProperties.datetime ].toObject();
- return reduce( datetime, ( result, value, key ) => {
- key = this.constructor[ privateMethods.normalizeUnitName ]( key );
- result[ key ] = this.constructor[ privateMethods.normalizeUnitValue ](
- key,
- value,
- false
- );
- return result;
- }, {} );
- }
-
- /**
- * Converts the DateTime's timezone to UTC.
- *
- * @return {DateTime|ServerDateTime} A new instance of DateTime
- */
- toUTC() {
- return this.constructor.fromMoment(
- this[ privateProperties.datetime ].clone().utc()
- );
- }
-
- /**
- * Returns an english string representation of this DateTime when the instance is
- * coerced to a string (similar format to JS `Date.toString()`.
- *
- * eg `Tue Dec 25 2018 10:15:00 GMT+0000`
- *
- * @return {string} A string representation of this DateTime
- */
- toString() {
- return this[ privateProperties.datetime ].toString();
- }
-
- /**
- * When DateTime is coerced to number this will ensure its displayed as the
- * number of milliseconds since the Unix Epoch for the current DateTime
- *
- * @return {number} Amount of milliseconds since the Unix Epoch
- */
- valueOf() {
- return this[ privateProperties.datetime ].valueOf();
- }
-}
-
-/**
- * These static properties need to be defined outside of the class definition
- * because of compile issues.
- */
-DateTime.UNIT_YEAR = 'year';
-DateTime.UNIT_MONTH = 'month';
-DateTime.UNIT_DAY = 'day';
-DateTime.UNIT_HOUR = 'hour';
-DateTime.UNIT_MINUTE = 'minute';
-DateTime.UNIT_SECOND = 'second';
-DateTime.UNIT_MILLISECOND = 'millisecond';
-DateTime.TIMEZONE_LOCAL = 'local';
diff --git a/assets/src/vo/date-time/defaults.js b/assets/src/vo/date-time/defaults.js
deleted file mode 100644
index 7167d5bcf9e..00000000000
--- a/assets/src/vo/date-time/defaults.js
+++ /dev/null
@@ -1,63 +0,0 @@
-/**
- * External imports
- */
-import {
- TIMEZONE_CONFIG,
- SERVER_LOCALE,
-} from '@eventespresso/eejs';
-import {
- FORMAT_SITE_DATE,
- FORMAT_SITE_TIME,
-} from '@eventespresso/helpers';
-import { validateLocale } from './assertions';
-
-import { snakeCase } from 'lodash';
-/**
- * Default timezone string to use.
- *
- * @type {string}
- */
-export const DEFAULT_TIMEZONE_STRING = TIMEZONE_CONFIG.string === '' ?
- 'UTC' :
- TIMEZONE_CONFIG.string;
-
-/**
- * Default offset
- *
- * @type {number}
- */
-export const DEFAULT_OFFSET = TIMEZONE_CONFIG.offset;
-
-/**
- * Whether there is a default timezone string to use.
- * This helps with determining whether to use the offset or not for constructing
- * DateTime value objects.
- *
- * @type {boolean}
- */
-export const HAS_TIMEZONE_STRING = (
- DEFAULT_TIMEZONE_STRING !== 'UTC' ||
- ! ( DEFAULT_TIMEZONE_STRING === 'UTC' && DEFAULT_OFFSET !== 0 )
-);
-
-/**
- *
- * @type {string}
- */
-export const DEFAULT_FORMAT = FORMAT_SITE_DATE + ' ' + FORMAT_SITE_TIME;
-
-/**
- * Exposes what to use for the default locale.
- * @type {string}
- */
-export const DEFAULT_LOCALE = snakeCase( SERVER_LOCALE.user );
-
-/**
- * This ensures that the provided locale is valid. So if `DEFAULT_LOCALE` is
- * not valid for this environment, then a fallback of 'en' locale is used.
- *
- * @type {string}
- */
-export const DEFAULT_VALID_LOCALE = validateLocale( DEFAULT_LOCALE ) ?
- DEFAULT_LOCALE :
- 'en';
diff --git a/assets/src/vo/date-time/duration.js b/assets/src/vo/date-time/duration.js
deleted file mode 100644
index 3de56af623a..00000000000
--- a/assets/src/vo/date-time/duration.js
+++ /dev/null
@@ -1,636 +0,0 @@
-/**
- * External imports
- */
-import moment from 'moment-timezone';
-import momentDurationFormatSetup from 'moment-duration-format';
-import { capitalize, pick, keys, omit, mapValues } from 'lodash';
-import isShallowEqual from '@wordpress/is-shallow-equal';
-import warning from 'warning';
-import { instanceOf } from '@eventespresso/validators';
-
-/**
- * Internal imports
- */
-import * as assertions from './assertions';
-import {
- DEFAULT_VALID_LOCALE,
-} from './defaults';
-
-momentDurationFormatSetup( moment );
-
-/**
- * A collection of symbols used for "private" properties in the Duration object.
- * @type {
- * {
- * duration: Symbol,
- * values: Symbol,
- * isValid: Symbol,
- * }
- * }
- */
-const privateProperties = {
- duration: Symbol( 'DurationPrivatePropertiesDuration' ),
- durationValues: Symbol( 'DurationPrivatePropertiesDurationValues' ),
- isValid: Symbol( 'DurationPrivatePropertiesIsValid' ),
-};
-
-/**
- * A collection of symbols used for "private" methods in the Duration object.
- * @type {
- * {
- * createGettersAndSetters: Symbol,
- * getAllUnitNames: Symbol,
- * populateValuesFromDuration: Symbol,
- * setValues: Symbol,
- * filterValues: Symbol,
- * }
- * }
- */
-const privateMethods = {
- createGetters: Symbol( 'DurationPrivateMethodsCreateGetters' ),
- getAllUnitNames: Symbol( 'DurationPrivateMethodsGetAllUnitNames' ),
- populateValuesFromDuration: Symbol(
- 'DurationPrivateMethodsPopulateValuesFromDuration'
- ),
- setValues: Symbol( 'DurationPrivateMethodsSetValues' ),
- filterValues: Symbol( 'DurationPrivateMethodsFilterValues' ),
-};
-
-/**
- * An array of unit names for properties in the Duration object
- * @type {string[]}
- */
-const unitNames = [
- 'years',
- 'months',
- 'days',
- 'hours',
- 'minutes',
- 'seconds',
- 'milliseconds',
-];
-
-/**
- * An array of derivative unit names.
- * These are accessors that are derivatives of base units. For instance,
- * "weeks" ends up being a derivative (calculated from) the "days" unit.
- * @type {string[]}
- */
-const derivativeUnitNames = [
- 'weeks',
-];
-
-/**
- * Where a DateTime object represents a single point in time, a Duration object
- * represents a length of time.
- *
- * Durations do not have a defined beginning and end date. They are contextless.
- *
- * As an example, durations are representative of something like "2 hours" and
- * not representative of something like "between 1pm and 3pm".
- *
- * Internally, the Duration class here uses `moment.Duration`. This is an
- * abstraction loosely following the adapter pattern so that there is a common
- * api that can be depended on if in the future the internal library is switched
- * to something different (such as Luxon).
- */
-export default class Duration {
- static UNIT_YEARS = 'years';
- static UNIT_MONTHS = 'months';
- static UNIT_DAYS = 'days';
- static UNIT_HOURS = 'hours';
- static UNIT_MINUTES = 'minutes';
- static UNIT_SECONDS = 'seconds';
- static UNIT_MILLISECONDS = 'milliseconds';
- static UNIT_WEEKS = 'weeks';
-
- /**
- * because minification destroys class names and renders instaneOf useless
- *
- * @type {string}
- */
- displayName = 'Duration';
-
- /**
- * The constructor for the Duration class.
- *
- * @param {Object|moment.Duration|string|number} values
- * Receiving a moment.Duration object is something for internal use and should not be used directly via
- * client code.
- * @param {string} locale A valid locale string.
- * @link http://tools.ietf.org/html/rfc5646
- */
- constructor( values, locale = DEFAULT_VALID_LOCALE ) {
- this.displayName = 'Duration';
- this[ privateProperties.isValid ] = true;
- assertions.assertLocaleIsValid( locale );
- if ( typeof values !== 'object' ) {
- values = moment.duration( values ).locale( locale );
- }
- if ( moment.isDuration( values ) ) {
- this[ privateProperties.duration ] = values;
- this[ privateMethods.populateValuesFromDuration ]( values );
- } else {
- values = this[ privateMethods.filterValues ]( values );
- this[ privateMethods.setValues ]( values );
- this[ privateProperties.duration ] = moment.duration(
- values
- ).locale( locale );
- }
- this[ privateMethods.createGetters ]();
- Object.freeze( this );
- }
-
- /**
- * Create an instance of Duration from a number of milliseconds.
- *
- * @param {number} milliseconds
- * @param {string} locale
- * @return {Duration} An instance of Duration.
- */
- static fromMilliseconds( milliseconds, locale = DEFAULT_VALID_LOCALE ) {
- return new Duration( { milliseconds }, locale );
- }
-
- /**
- * Create an instance of Duration from a simple object.
- *
- * @param {Object} values Keys should be the units (eg 'years', 'days').
- * @param {string} locale
- * @return {Duration} An instance of Duration
- */
- static fromObject( values, locale = DEFAULT_VALID_LOCALE ) {
- return new Duration( values, locale );
- }
-
- /**
- * Create an instance of Duration from an ISO8601 string.
- *
- * @param {string} ISOString (eg. 'PT23H')
- * @param {string} locale
- * @return {Duration} An instance of Duration
- */
- static fromISO( ISOString, locale = DEFAULT_VALID_LOCALE ) {
- assertions.assertISO8601IsValid( ISOString, true );
- return new Duration( ISOString, locale );
- }
-
- /**
- * Indicate whether the provided locale argument is a valid locale.
- *
- * @param {string} locale
- * @return {boolean} True means it is valid.
- */
- static isValidLocale(locale) {
- return assertions.validateLocale( locale );
- }
-
- /**
- * Asserts whether the provided locale argument is a valid locale.
- *
- * @param {string} locale
- * @throws InvalidLocale
- */
- static assertIsValidLocale( locale ) {
- assertions.assertLocaleIsValid( locale );
- }
-
- /**
- * Indicate whether the provided string is a valid ISO 8601 Duration string.
- *
- * @param {string} isoString
- * @return {boolean} True means it is valid.
- */
- static isValidISO8601Duration( isoString ) {
- return assertions.validateISO8601( isoString, true );
- }
-
- /**
- * Assert whether the provided string is a valid ISO 8601 Duration string.
- *
- * @param {string} isoString
- * @throws InvalidISO8601String
- */
- static assertIsValidISO8601Duration( isoString ) {
- assertions.assertISO8601IsValid( isoString );
- }
-
- /**
- * Indicates whether the provided value is a valid instance of Duration.
- *
- * @param {Duration}duration
- * @return {boolean} True means it is a valid Duration object.
- */
- static isValidDuration( duration ) {
- return instanceOf( duration, 'Duration' ) &&
- duration.isValid;
- }
-
- /**
- * Asserts whether the provided value is a valid Duration and throws an
- * exception if not.
- *
- * @param {Duration} duration
- * @throws TypeError
- */
- static assertIsValidDuration( duration ) {
- if ( ! Duration.isValidDuration( duration ) ) {
- throw new TypeError(
- 'This Duration object is not valid.'
- );
- }
- }
-
- /**
- * Indicates whether the provided value is an instance of Duration.
- *
- * @param {Duration} duration
- * @return {boolean} True means the value is an instance of Duration.
- * Note: true may still mean that the Duration instance is not valid!
- */
- static isDuration( duration ) {
- return instanceOf( duration, 'Duration' );
- }
-
- /**
- * Asserts whether the provided value is an instance of Duration and if not
- * throws an exception.
- *
- * @param {Duration} duration
- * @throws TypeError
- */
- static assertIsDuration( duration ) {
- if ( ! Duration.isDuration( duration ) ) {
- throw new TypeError(
- 'The provided value is not an instance of Duration.'
- );
- }
- }
-
- /**
- * This filters the incoming values and returns only key/value pairs that
- * are acceptable as duration units.
- *
- * If a invalid duration unit is discovered, a console.error is generated
- * (in non-production mode).
- *
- * @param {any} values
- * @return {Object} Filtered values.
- * @throws TypeError if incoming values argument is not an object.
- */
- [ privateMethods.filterValues ]( values ) {
- if ( typeof values !== 'object' ) {
- throw new TypeError( 'Incoming values must be a simple object.' );
- }
- const valuesToSet = pick( values, unitNames );
- if ( ! isShallowEqual( values, valuesToSet ) ) {
- warning(
- false,
- 'The following unexpected keys were in the configuration ' +
- 'object for constructing the Duration: ' +
- keys( omit( values, unitNames ) ).join()
- );
- this[ privateProperties.isValid ] = false;
- }
- return valuesToSet;
- }
-
- /**
- * Used to set the internal "private" values property.
- *
- * @param {Object} values
- * @access private
- */
- [ privateMethods.setValues ]( values ) {
- this[ privateProperties.durationValues ] = {};
- unitNames.forEach( ( unit ) => {
- this[ privateProperties.durationValues ][ unit ] = values[ unit ] ||
- 0;
- } );
- }
-
- /**
- * Used to set the values "private" property from a moment.Duration object.
- *
- * @param {moment.Duration} duration
- * @access private
- */
- [ privateMethods.populateValuesFromDuration ]( duration ) {
- const setValues = {};
- unitNames.forEach( ( unit ) => {
- setValues[ unit ] = duration[ unit ]();
- } );
- this[ privateMethods.setValues ]( setValues );
- }
-
- /**
- * Returns an array of accessor names (that in turn are used for generating
- * private properties).
- *
- * @access private
- * @return {string[]} Array of accessor names.
- */
- [ privateMethods.getAllUnitNames ]() {
- return [
- ...unitNames,
- ...derivativeUnitNames,
- ];
- }
-
- /**
- * Creates getters for the Duration instance from the accessor names.
- *
- * @access private
- */
- [ privateMethods.createGetters ]() {
- this[ privateMethods.getAllUnitNames ]().forEach(
- ( accessorName ) => {
- // creates accessor for getting the value via a property
- // eg. instance.hours
- Object.defineProperty( this, accessorName, {
- get() {
- if ( derivativeUnitNames.indexOf( accessorName ) > -1 ) {
- return this[ privateProperties.duration ][ accessorName ]();
- }
- return this
- [ privateProperties.durationValues ]
- [ accessorName ] ||
- 0;
- },
- } );
- // creates `as*` methods.
- // eg `instance.asHours` would return the given duration
- // expressed as the hours unit.
- // note for units such as "years" and "months", this uses what
- // is termed as "longterm" calculation. Longterm is based on
- // a 400 year cycle averaging out the days in a month and
- // days in a year over that cycle.
- // @link https://github.com/moment/moment/blob/develop/src/lib/duration/bubble.js#L52
- const asMethodName = 'as' + capitalize( accessorName );
- Object.defineProperty( this, asMethodName, {
- get() {
- return () => {
- return this[ privateProperties.duration ]
- [ asMethodName ]();
- };
- },
- } );
- }
- );
- }
-
- /**
- * Exposes the value of locale.
- * eg. instance.locale
- *
- * @return {string} The locale string.
- */
- get locale() {
- return this[ privateProperties.duration ].locale();
- }
-
- /**
- * Indicates whether the current Duration instance represents a valid
- * duration.
- *
- * @return {boolean} True means the Duration instance is valid.
- */
- get isValid() {
- return this[ privateProperties.isValid ] &&
- this[ privateProperties.duration ].toISOString() !== 'P0D';
- }
-
- /**
- * Returns a new Duration instance that is identical to this except the
- * locale is changed to what was provided.
- *
- * @param {string} locale
- * @return {Duration} A new instance of Duration
- */
- setLocale( locale ) {
- return new Duration( this[ privateProperties.durationValues ], locale );
- }
-
- /**
- * Reduce this Duration to its canonical representation in its current units.
- *
- * For example:
- * Duration
- * .fromObject({ years: 2, days: 5000 })
- * .normalize()
- * .toObject() //=> { years: 15, months: 8, days: 12 }
- *
- * @return {Duration} A new instance of Duration
- */
- normalize() {
- return new Duration( this[ privateProperties.duration ] );
- }
-
- /**
- * Returns whether the provided Duration instance is the same as this
- * Duration instance.
- *
- * @param {Duration} otherDuration
- * @throws TypeError
- * @return {boolean} True means that the compared durations have the same
- * units and the same values for each unit (as well as same locale). This
- * means that a duration with{ minutes: 60 } would be considered not equal
- * to a duration with { hours: 1 }.
- */
- sameAs( otherDuration ) {
- Duration.assertIsDuration( otherDuration );
- if ( ! this.isValid || ! otherDuration.isValid ) {
- return false;
- }
- if ( this.locale !== otherDuration.locale ) {
- return false;
- }
- return isShallowEqual( this.toObject(), otherDuration.toObject() );
- }
-
- /**
- * Returns whether the provided Duration instance is equal to this Duration
- * instance.
- *
- * Equality is based on:
- * - locale is the same
- * - the normalized value of the duration is the same. eg a duration with
- * { hours: 24 } would be considered equal to a duration with { days: 1 }
- *
- * @param {Duration} otherDuration
- * @throws TypeError
- * @return {boolean} true if considered equal
- */
- equals( otherDuration ) {
- Duration.assertIsDuration( otherDuration );
- if ( ! this.isValid || ! otherDuration.isValid ) {
- return false;
- }
- if ( this.locale !== otherDuration.locale ) {
- return false;
- }
- return isShallowEqual(
- this.normalize().toObject(),
- otherDuration.normalize().toObject()
- );
- }
-
- /**
- * Make this duration longer by the specified amount.
- *
- * Note: the returned Duration will have the locale of the original
- * regardless what the locale was on any passed in duration.
- *
- * The new Duration returned will have normalized values (i.e. if addition
- * of one Duration with `{ hours: 10 }` is done with the other Duration
- * having `{ hours: 14 }` then the new Duration will have `{ days: 1 }`.
- * You can still get the total hours by calling `newDuration.asHours()`.
- *
- * @param {Duration|Object|number} value Either a Duration instance, a
- * number of milliseconds or an object in the same shape received by
- * Duration.fromObject()
- *
- * @return {Duration} A new instance of Duration
- */
- plus( value ) {
- if ( Duration.isDuration( value ) ) {
- return new Duration(
- this[ privateProperties.duration ]
- .clone()
- .add( value[ privateProperties.duration ] )
- );
- }
- if ( typeof value === 'object' ) {
- value = this[ privateMethods.filterValues ]( value );
- }
- return new Duration(
- this[ privateProperties.duration ]
- .clone()
- .add( value )
- );
- }
-
- /**
- * Make this duration shorter by the specified amount
- *
- * Note: the returned Duration will have the locale of the original
- * regardless what the locale was on any passed in duration.
- *
- * The new Duration returned will have normalized values (i.e. if subtraction
- * of one Duration with `{ hours: 34 }` is done with the other Duration
- * having `{ hours: 10 }` then the new Duration will have `{ days: 1 }`.
- * You can still get the total hours by calling `newDuration.asHours()`.
- *
- * @param {Duration|Object|number} value Either a duration instance, a
- * number of milliseconds or an object in the same shape as that received by
- * Duration.fromObject()
- *
- * @return {Duration} A new instance of Duration
- */
- minus( value ) {
- if ( Duration.isDuration( value ) ) {
- return new Duration(
- this[ privateProperties.duration ]
- .clone()
- .subtract( value[ privateProperties.duration ] )
- );
- }
- if ( typeof value === 'object' ) {
- value = this[ privateMethods.filterValues ]( value );
- }
- return new Duration(
- this[ privateProperties.duration ]
- .clone()
- .subtract( value )
- );
- }
-
- /**
- * Returns the negative of this Duration.
- *
- * @return {Duration} A new instance of Duration
- */
- negate() {
- return new Duration(
- mapValues( this.toObject(), function( value ) {
- return value * -1;
- } )
- );
- }
-
- /**
- * Returns a javascript object with this Duration's values.
- *
- * @return {*} Returns { years: number, hours: number ... }
- */
- toObject() {
- return this[ privateProperties.durationValues ];
- }
-
- /**
- * Returns an ISO 8601-compliant string representation of this Duration.
- *
- * @return {string} eg. "PT24H"
- */
- toISO() {
- return this[ privateProperties.duration ].toISOString();
- }
-
- /**
- * Returns an ISO 8601 representation of this Duration appropriate for use
- * in JSON.
- *
- * @return {string} eg. "PT24H"
- */
- toJSON() {
- return this[ privateProperties.duration ].toJSON();
- }
-
- /**
- * Returns an ISO 8601 representation of this Duration appropriate for use
- * in debugging.
- *
- * @return {string} eg. "PT24H"
- */
- toString() {
- return this.toISO();
- }
-
- /**
- * Returns an milliseconds value of this Duration.
- *
- * @return {number} The value of this duration represented in the number of
- * milliseconds.
- */
- valueOf() {
- return this.asMilliseconds();
- }
-
- /**
- * Returns a string representation of this Duration formatted according to
- * the specified format string.
- *
- * Currently this accepts the following tokens in the format string:
- *
- * years: Y or y
- * months: M
- * weeks: W or w
- * days: D or d
- * hours: H or h
- * minutes: m
- * seconds: s
- * ms: S
- *
- * You can use multiples of the same token together to add zero-length
- * padding: (eg hh -> 01 instead of h -> 1)
- *
- * Escape token characters within the format string using square brackets
- * (eg 'h [hrs], m [min]' -> '12 hrs, 3 min')
- *
- * @param {string}format
- * @return {string} A formatted string representation of this duration.
- */
- toFormat( format ) {
- return this.normalize()[ privateProperties.duration ].format( format );
- }
-}
diff --git a/assets/src/vo/date-time/index.js b/assets/src/vo/date-time/index.js
deleted file mode 100644
index a862e0c98de..00000000000
--- a/assets/src/vo/date-time/index.js
+++ /dev/null
@@ -1,3 +0,0 @@
-export { default as DateTime } from './datetime';
-export { default as Duration } from './duration';
-export { default as ServerDateTime } from './server-date-time';
diff --git a/assets/src/vo/date-time/server-date-time.js b/assets/src/vo/date-time/server-date-time.js
deleted file mode 100644
index 733949c33e8..00000000000
--- a/assets/src/vo/date-time/server-date-time.js
+++ /dev/null
@@ -1,114 +0,0 @@
-/**
- * Internal Imports.
- */
-import DateTime from './datetime';
-import {
- DEFAULT_TIMEZONE_STRING,
- HAS_TIMEZONE_STRING,
- DEFAULT_OFFSET,
- DEFAULT_VALID_LOCALE,
-} from './defaults';
-
-/**
- * External Imports.
- */
-import moment from 'moment-timezone';
-
-/**
- * Inheriting the DateTime Value object, this represents a single point in time
- * within the context of the timezone or offset the server is set at.
- *
- * Instantiating this instead of `DateTime` removes the need to pass along
- * timezone string or offset and instantiates according to what has been set as
- * the defaults for those from the server. Usage of this class is preferred
- * over DateTime to remove the need for client code to figure out if the server
- * has a timezone string set or is using a UTC offset.
- */
-export default class ServerDateTime extends DateTime {
-
- /**
- * The constructor for the ServerDateTime class
- *
- * @param {string} iso8601DateString
- * @param {string} timezone
- * @param {string} locale
- */
- constructor(
- iso8601DateString = '',
- timezone = DEFAULT_TIMEZONE_STRING,
- locale = DEFAULT_VALID_LOCALE,
- ) {
- // we only want to use the timezone value if the server indicates there
- // is a a timezone string or if constructing an instance for a non UTC
- // value timezone (HAS_TIMEZONE_STRING is just a shortcut check).
- if (
- HAS_TIMEZONE_STRING ||
- ( !! timezone && timezone !== 'UTC' )
- ) {
- super( iso8601DateString, timezone, locale, 'ServerDateTime' );
- } else {
- const datetime = !! iso8601DateString ?
- moment().utcOffset( DEFAULT_OFFSET, true ).locale( locale ) :
- moment( iso8601DateString )
- .utcOffset( DEFAULT_OFFSET, true )
- .locale( locale );
- super( datetime.toISOString( true ), null, locale, 'ServerDateTime' );
- }
- }
-
- /**
- * Instantiate ServerDateTime from an ISO string.
- * This overrides `DateTime.fromISO` removing the need to worry about
- * whether to use `timezone` or `offset`. This will simply use whatever is
- * provided by the server (preferring timezone if its available).
- *
- * @param {string} ISOString
- * @param {string} locale
- * @return {ServerDateTime} An instance of ServerDateTime
- */
- static fromISO( ISOString, locale = DEFAULT_VALID_LOCALE ) {
- return HAS_TIMEZONE_STRING ?
- new this(
- super
- .fromISO( ISOString, DEFAULT_TIMEZONE_STRING )
- .toISO(),
- DEFAULT_TIMEZONE_STRING,
- locale
- ) :
- new this(
- super
- .fromISOWithOffset( ISOString, DEFAULT_OFFSET )
- .toISO(),
- null,
- locale
- );
- }
-
- /**
- * Instantiate ServerDateTime from an ISO string.
- * This overrides `DateTime.fromJSDate` removing the need to worry about
- * whether to use `timezone` or `offset`. This will simply use whatever is
- * provided by the server (preferring timezone if its available).
- *
- * @param {Date} date
- * @param {string} locale
- * @return {ServerDateTime} An instance of ServerDateTime
- */
- static fromJSDate( date, locale = DEFAULT_VALID_LOCALE ) {
- return HAS_TIMEZONE_STRING ?
- new this(
- super
- .fromJSDate( date, DEFAULT_TIMEZONE_STRING )
- .toISO(),
- DEFAULT_TIMEZONE_STRING,
- locale
- ) :
- new this(
- super
- .fromJSDateWithOffset( date, DEFAULT_OFFSET )
- .toISO(),
- null,
- locale
- );
- }
-}
diff --git a/assets/src/vo/index.js b/assets/src/vo/index.js
deleted file mode 100644
index 5bcce502e24..00000000000
--- a/assets/src/vo/index.js
+++ /dev/null
@@ -1,7 +0,0 @@
-export { default as Money } from './money';
-export {
- default as SiteCurrency,
- Currency,
-} from './currency';
-export { default as Label } from './label';
-export { DateTime, Duration, ServerDateTime } from './date-time';
diff --git a/assets/src/vo/label.js b/assets/src/vo/label.js
deleted file mode 100644
index 9205e798a16..00000000000
--- a/assets/src/vo/label.js
+++ /dev/null
@@ -1,168 +0,0 @@
-/**
- * External imports
- */
-import { startCase, isString } from 'lodash';
-import warning from 'warning';
-
-/**
- * A value object for representing a label with singular and plural string
- * values.
- */
-export default class Label {
- static FORMAT_LOWERCASE = 'lower';
- static FORMAT_UPPERCASE = 'upper';
- static FORMAT_SENTENCE_CASE = 'sentence';
-
- /**
- * The string representing the singular form of the label.
- * @type {string}
- */
- singular = '';
-
- /**
- * The string representing the plural form of the label.
- * @type {string}
- */
- plural = '';
-
- /**
- * Constructor
- * @param {string} singular
- * @param {string} plural
- */
- constructor( singular, plural ) {
- this.setSingular( singular ).setPlural( plural );
- Object.freeze( this );
- }
-
- /**
- * Fluid setter for setting the singular property.
- *
- * If the singular property has already been set, this will return a new
- * instance of Label
- * @param {string} singular
- * @return {Label} An instance of Label
- */
- setSingular( singular ) {
- Label.assertString( singular );
- if ( this.singular !== '' ) {
- return new Label( singular, this.plural );
- }
- this.singular = singular;
- return this;
- }
-
- /**
- * Fluid setter for setting the plural property
- *
- * If the plural property has already been set, this will return a new
- * instance of label.
- *
- * @param {string} plural
- * @return {Label} An instance of Label
- */
- setPlural( plural ) {
- Label.assertString( plural );
- if ( this.plural !== '' ) {
- return new Label( this.singular, plural );
- }
- this.plural = plural;
- return this;
- }
-
- /**
- * Return the value for the property formatted in sentence case.
- *
- * Note, this strips any `-` in dashed labels. So for instance if your
- * label value was `something-else`, the value returned would be
- * `Something Else`
- *
- * @param {boolean} singular If true, return the formatted value of the
- * singular property otherwise return the formatted value of the plural
- * property.
- * @return {string} The string in sentence case
- */
- asSentenceCase( singular = true ) {
- return singular === true ?
- startCase( this.singular.toLowerCase() ) :
- startCase( this.plural.toLowerCase() );
- }
-
- /**
- * Return the value for the property formatted in lower case.
- *
- * @param {boolean} singular If true, return the formatted value of the
- * singular property otherwise return the formatted value of the plural
- * property.
- * @return {string} The string in lower case
- */
- asLowerCase( singular = true ) {
- return singular ?
- this.singular.toLowerCase() :
- this.plural.toLowerCase();
- }
-
- /**
- * Return the value for the property formatted in upper case.
- *
- * @param {boolean} singular If true, return the formatted value of the
- * singular property otherwise return the formatted value of the plural
- * property.
- * @return {string} The string in upper case
- */
- asUpperCase( singular = true ) {
- return singular ?
- this.singular.toUpperCase() :
- this.plural.toUpperCase();
- }
-
- /**
- * Return the value for the property formatted according to the provided
- * formatType.
- *
- * @param {boolean} singular If true, return the formatted value of the
- * singular property otherwise return the formatted value of the plural
- * property.
- * @param {('sentence'|'lower'|'upper')} formatType
- * @return {string} The string formatted according to formatType
- */
- asFormatted( singular = true, formatType = Label.FORMAT_SENTENCE_CASE ) {
- switch ( formatType ) {
- case Label.FORMAT_SENTENCE_CASE:
- return this.asSentenceCase( singular );
- case Label.FORMAT_LOWERCASE:
- return this.asLowerCase( singular );
- case Label.FORMAT_UPPERCASE:
- return this.asUpperCase( singular );
- default:
- warning( false, 'Format type must be one of ' +
- 'Label.FORMAT_SENTENCE_CASE, Label.FORMAT_UPPERCASE, ' +
- 'or Label.FORMAT_LOWERCASE' );
- return this.asSentenceCase( singular );
- }
- }
-
- /**
- * Asserts whether the provided value is a string or not.
- *
- * @param {*} value
- * @throws TypeError
- */
- static assertString( value ) {
- if ( ! isString( value ) ) {
- throw new TypeError( 'Incoming label value (' + value + ') must' +
- ' be a string' );
- }
- }
-
- /**
- * Creates an instance of Label that has the same value for singluar and
- * plural properties for the provided argument.
- *
- * @param {string} label
- * @return {Label} A Label instance
- */
- static fromSameSingleAndPlural = ( label ) => {
- return new Label( label, label );
- }
-}
diff --git a/assets/src/vo/money.js b/assets/src/vo/money.js
deleted file mode 100644
index a0faa7bafd4..00000000000
--- a/assets/src/vo/money.js
+++ /dev/null
@@ -1,592 +0,0 @@
-/**
- * External imports
- */
-import { Decimal } from 'decimal.js-light';
-import * as Accounting from 'accounting-js';
-import isShallowEqual from '@wordpress/is-shallow-equal';
-import { Exception } from '@eventespresso/eejs';
-import { isEmpty } from 'lodash';
-import { instanceOf } from '@eventespresso/validators';
-import { sprintf } from '@eventespresso/i18n';
-import { Currency } from './currency';
-
-/**
- * Asserts if incoming value is an instance of Money
- *
- * @param {Money} money
- * @throws {TypeError}
- */
-const assertMoney = ( money ) => {
- if ( ! ( instanceOf( money, 'Money' ) ) ) {
- throw new TypeError( 'Instance of Money required. Received: ' + JSON.stringify(money) );
- }
-};
-
-/**
- * Asserts if incoming value is an instance of Currency
- *
- * @param {Currency} currency
- * @throws {TypeError}
- */
-const assertCurrency = ( currency ) => {
- if (!(instanceOf(currency, 'Currency'))) {
- throw new TypeError( 'Instance of Currency required. Received: ' + JSON.stringify(currency) );
- }
-};
-
-/**
- * Asserts if two currencies are shallow equal.
- *
- * @param {Currency} currencyA
- * @param {Currency} currencyB
- * @throws {Exception}
- */
-const assertSameCurrency = ( currencyA, currencyB ) => {
- assertCurrency( currencyA );
- assertCurrency( currencyB );
- if ( ! isShallowEqual( currencyA.toJSON(), currencyB.toJSON() ) ) {
- throw new Exception( 'Provided currencies are not equivalent.' );
- }
-};
-
-/**
- * A Value object representing money values.
- */
-export default class Money {
- /**
- * because minification destroys class names and renders instaneOf useless
- *
- * @type {string}
- */
- displayName = 'Money';
-
- /**
- * Internally the amount is stored as a Decimal instance.
- *
- * @type {Decimal}
- */
- amount;
-
- /**
- * Internally the amount is stored as a Currency instance.
- *
- * @type {Currency}
- */
- currency;
-
- /**
- * Formatter object for money values.
- *
- * @type {{}}
- */
- formatter = {};
-
- /**
- * Rounds away from zero
- *
- * @type {number}
- */
- static ROUND_UP = Decimal.ROUND_UP;
-
- /**
- * Rounds towards zero
- *
- * @type {number}
- */
- static ROUND_DOWN = Decimal.ROUND_DOWN;
-
- /**
- * Rounds towards infinity
- *
- * @type {number}
- */
- static ROUND_CEIL = Decimal.ROUND_CEIL;
-
- /**
- * Rounds towards -Infinity
- *
- * @type {number}
- */
- static ROUND_FLOOR = Decimal.ROUND_FLOOR;
-
- /**
- * Rounds towards nearest neighbour. If equidistant, rounds away from zero.
- *
- * @type {number}
- */
- static ROUND_HALF_UP = Decimal.ROUND_HALF_UP;
-
- /**
- * Rounds towards nearest neighbour. If equidistant rounds towards zero.
- *
- * @type {number}
- */
- static ROUND_HALF_DOWN = Decimal.ROUND_HALF_DOWN;
-
- /**
- * Rounds towards nearest neighbour. If equidistant, rounds towards even
- * neighbour.
- *
- * @type {number}
- */
- static ROUND_HALF_EVEN = Decimal.ROUND_HALF_EVEN;
-
- /**
- * Class constructor
- *
- * @param {number|string|Decimal} amount
- * @param {Currency} currency
- */
- constructor(amount, currency) {
- this.displayName = 'Money';
- this.setCurrency( currency )
- .setAmount( amount )
- .setFormatter();
- Object.freeze( this );
- }
-
- /**
- * Set the currency property
- *
- * @param {Currency} currency
- * @return {Money} Either this Money or new Money depending on state of
- * property.
- */
- setCurrency( currency ) {
- Money.assertCurrency( currency );
- // if there's already a currency set, then return a new object.
- if ( instanceOf( this.currency, 'Currency' ) ) {
- return new Money( this.amount, currency );
- }
- this.currency = currency;
- return this;
- }
-
- /**
- * Set the amount property
- *
- * @param {Decimal|number|string} amount
- * @return {Money} Either this Money or new Money depending on state of the
- * property.
- */
- setAmount( amount ) {
- const value = instanceOf( amount, 'Decimal' ) ?
- amount.toNumber() :
- amount;
- // if there's already an amount set, then return a new object.
- if ( instanceOf( this.amount, 'Decimal' ) ) {
- return new Money( new Decimal( value ), this.currency );
- }
- this.amount = new Decimal( value );
- return this;
- }
-
- /**
- * Set the formatter for money values
- *
- * @return {Money} An instance of this object.
- */
- setFormatter() {
- // only initialize if its not already initialized
- if ( isEmpty( this.formatter ) ) {
- this.formatter = { ...Accounting };
- this.formatter.settings = {
- ...this.formatter.settings,
- ...this.currency.toAccountingSettings().currency,
- };
- }
- return this;
- }
-
- /**
- * Returns the value of this Money as its subunits.
- * @return {number} If the subunits is 100 and the value is .45,
- * this returns 450
- */
- toSubunits() {
- return this.amount.toNumber() * this.currency.subunits;
- }
-
- /**
- * Returns whether the provided money object equals this money object.
- * Compares both amount and currency.
- *
- * @param {Money} other
- * @return {boolean} True means this is equal. False means it isn't.
- */
- equals( other ) {
- Money.assertMoney( other );
- return this.amount.equals( other.amount ) &&
- this.hasSameCurrency( other );
- }
-
- /**
- * Returns whether provided Money object's Currency equals this Money
- * object's Currency.
- *
- * This does a shallow comparison on the serialized values for the currency
- * objects. That way if the currencies are different instances, but share
- * the same internal value, they are considered equal.
- *
- * @param {Money} other
- * @return {boolean} True means the currencies are equal.
- */
- hasSameCurrency( other ) {
- Money.assertMoney( other );
- return isShallowEqual(
- this.currency.toJSON(),
- other.currency.toJSON()
- );
- }
-
- /**
- * Add one Money object to this Money object
- *
- * @param {Money} other
- * @return {Money} Returns a new instance of Money.
- */
- add( other ) {
- Money.assertUsingSameCurrency( this, other );
- return new Money( this.amount.plus( other.amount ), this.currency );
- }
-
- /**
- * Subtract one Money object from this Money object
- *
- * @param {Money} other
- * @return {Money} Returns a new instance of Money
- */
- subtract( other ) {
- Money.assertUsingSameCurrency( this, other );
- return new Money( this.amount.minus( other.amount ), this.currency );
- }
-
- /**
- * Multiply this money object by the provided multiplier value.
- *
- * @param {number|string|Decimal} multiplier
- * @return {Money} Returns a new instance of Money
- */
- multiply( multiplier ) {
- return new Money( this.amount.times( multiplier ), this.currency );
- }
-
- /**
- * Divide this money object by the provided divisor value.
- *
- * @param {number|string|Decimal} divisor
- * @return {Money} Returns a new instance of Money
- */
- divide( divisor ) {
- return new Money( this.amount.dividedBy( divisor ), this.currency );
- }
-
- /**
- * Allocates fund bases on the ratios provided returning an array of Money
- * objects as a product of the allocation.
- *
- * Example: splitting a provided Money object three equal ways.
- *
- * ```
- * const splitMoney = moneyInstance.allocate( [ 1, 1, 1 ] );
- * ```
- *
- * Example: splitting a provided Money object two ways with one having 75%
- * of the allocation.
- *
- * ```
- * const splitMoney = moneyInstance.allocate( [ 75, 25 ] );
- * ```
- *
- * Note: Array values for ratios are simply totalled and then each element
- * is considered a fraction of the total value. So how you submit ratio
- * values is up to you for whatever is most clear to you.
- *
- * @param {number[]} ratios
- * @return {Money[]} An array of Money objects
- */
- allocate( ratios ) {
- const self = this;
- const results = [];
- const convertedRatios = [];
- let remainder = new Decimal( self.toSubunits() );
- let total = new Decimal( 0 );
- // convert ratios to decimal and generate total.
- ratios.forEach( ( ratio ) => {
- convertedRatios.push(
- instanceOf( ratio, 'Decimal' ) ? ratio : new Decimal( ratio )
- );
- total = total.plus( ratio );
- } );
- convertedRatios.forEach( ( ratio ) => {
- const share = new Decimal(
- Math.floor(
- self.toSubunits() * ratio.toNumber() / total.toNumber()
- )
- );
- results.push(
- new Money(
- share.dividedBy( this.currency.subunits ),
- this.currency
- )
- );
- remainder = remainder.minus( share );
- } );
- for ( let i = 0; remainder.greaterThan( 0 ); i++ ) {
- results[ i ] = new Money(
- ( new Decimal( results[ i ].toSubunits() ) )
- .plus( 1 )
- .dividedBy( this.currency.subunits ),
- this.currency
- );
- remainder = remainder.minus( 1 );
- }
- return results;
- }
-
- /**
- * Compares two instances of Money.
- *
- * Note: "same" means has equal value and equal currency. It does not mean
- * identical instances.
- *
- * @param {Money} other
- * @return {number} 0 if they are the same, 1 if this is greater than
- * other and -1 if other is greater than this.
- */
- compare( other ) {
- //quickly return 0 if identical
- if ( this === other ) {
- return 0;
- }
- Money.assertUsingSameCurrency( this, other );
- return this.amount.comparedTo( other.amount );
- }
-
- /**
- * Compares whether this Money object is greater than the other Money object.
- *
- * @param {Money} other
- * @return {boolean} If true then this is greater than other.
- */
- greaterThan( other ) {
- Money.assertUsingSameCurrency( this, other );
- return this.amount.greaterThan( other.amount );
- }
-
- /**
- * Compares whether this Money object is greater than or equal to the other
- * Money object.
- *
- * @param {Money} other
- * @return {boolean} If true then this is greater than or equal to the other.
- */
- greaterThanOrEqualTo( other ) {
- Money.assertUsingSameCurrency( this, other );
- return this.amount.greaterThanOrEqualTo( other.amount );
- }
-
- /**
- * Compares whether this Money object is less than the other Money object.
- *
- * @param {Money} other
- * @return {boolean} If true then this is less than other
- */
- lessThan( other ) {
- Money.assertUsingSameCurrency( this, other );
- return this.amount.lessThan( other.amount );
- }
-
- /**
- * Compares whether this Money object is less than or equal to the other
- * Money object.
- *
- * @param {Money} other
- * @return {boolean} If true then this is less than or equal to other.
- */
- lessThanOrEqualTo( other ) {
- Money.assertUsingSameCurrency( this, other );
- return this.amount.lessThanOrEqualTo( other.amount );
- }
-
- /**
- * Indicates if this object has the value of 0
- *
- * @return {boolean} If true then the value is 0.
- */
- isZero() {
- return this.amount.isZero();
- }
-
- /**
- * Indicates if the value in this Money object is negative.
- *
- * @return {boolean} If true then the value is negative.
- */
- isNegative() {
- return this.amount.isNegative();
- }
-
- /**
- * Indicates if the value in this Money object is positive.
- *
- * @return {boolean} If true then the value is positive.
- */
- isPositive() {
- return this.amount.isPositive();
- }
-
- /**
- * Returns the value of this Money object as a number primitive.
- *
- * @return {number} Returns a number.
- */
- toNumber() {
- return this.amount.toNumber();
- }
-
- /**
- * A string representing this Money object in normal (fixed-point) notation
- * rounded to `decimalPlaces` using `rounding` mode.
- *
- * If the value of this instance in normal notation has fewer than
- * decimalPlaces fraction digits, the return value will be appended with
- * zeros accordingly.
- *
- * @param {number} decimalPlaces The number of decimal places to round to.
- * If not provided uses the internal decimal place value.
- * @param {number} rounding What rounding type to use (0-8). Use Money ROUND
- * constants. Defaults to Money.ROUND_HALF_UP
- * @return {string} Returns a string representing the value of this Money
- * in normal (fixed-point) notation rounded to decimal places using
- * rounding mode.
- */
- toFixed( decimalPlaces, rounding = Money.ROUND_HALF_UP ) {
- decimalPlaces = decimalPlaces || this.currency.decimalPlaces;
- return this.amount.toFixed( decimalPlaces, rounding );
- }
-
- /**
- * Returns a new Money whose value is the value of this Money rounded
- * to a whole number using rounding mode rounding set on the original
- * Decimal amount.
- *
- * @return {Money} A new Money object
- */
- toIntegerMoney() {
- return new Money(
- this.amount.toInteger(),
- this.currency
- );
- }
-
- /**
- * Returns the value of this Money object as a formatted string according
- * to the currency configuration.
- *
- * @return {string} Returns a formatted string according to Currency.
- */
- toString() {
- return this.formatter.format(
- this.amount.toNumber(),
- this.formatter.settings
- );
- }
-
- /**
- * @return { Object } Returns an object that represents the serialized
- * value of this object.
- */
- toJSON() {
- return {
- amount: this.amount.toJSON(),
- currency: this.currency.toJSON(),
- };
- }
-
- /**
- * Asserts if the provided value is an instance of Money.
- *
- * @param {Money} money
- * @throws {TypeError}
- */
- static assertMoney = ( money ) => {
- assertMoney( money );
- };
-
- /**
- * Asserts if the provided value is an instance of Currency.
- *
- * @param {Currency} currency
- * @throws {TypeError}
- */
- static assertCurrency = ( currency ) => {
- assertCurrency( currency );
- };
-
- /**
- * Asserts if the provided values are both Money objects and have Equal
- * Currency objects.
- *
- * @param {Money} thisMoney
- * @param {Money} otherMoney
- * @throws {TypeError}
- */
- static assertUsingSameCurrency = ( thisMoney, otherMoney ) => {
- assertMoney( thisMoney );
- assertMoney( otherMoney );
- assertSameCurrency( thisMoney.currency, otherMoney.currency );
- };
-
- /**
- * Asserts if two currencies are shallow equal.
- *
- * @param {Currency} currencyA
- * @param {Currency} currencyB
- * @throws {Exception}
- */
- static assertSameCurrency = ( currencyA, currencyB ) => {
- assertSameCurrency( currencyA, currencyB );
- }
-
- /**
- * Receives an incoming value that could be a money formatted
- * string and returns a Money value object with the correct value
- * considering the provided currency.
- *
- * @param {string|number} moneyValue
- * @param {Currency} currency
- *
- * @return {Money} An instance of a money value object
- */
- static fromMoneyValue = ( moneyValue, currency ) => {
- assertCurrency( currency );
- // detect if incoming value has a currency sign not matching provided
- // currency. This doesn't provide full protection from improper
- // values sent in but is an initial safeguard.
- if ( typeof moneyValue === 'string' ) {
- const match = moneyValue.match( /[^\d\.\,\s]+/ );
- if ( match && match[ 0 ] !== currency.sign ) {
- // The first error message is used if we have just one character
- // returned which is likely the currency symbol. Otherwise,
- // give a more generic message.
- const message = match[ 0 ].length === 1 ?
- sprintf(
- 'The provided money value has a %1$s sign in it, but the provided currency value object defines %2$s as the currency sign.',
- match[ 0 ],
- currency.sign
- ) :
- sprintf(
- 'The provided money value has non numeric strings in it (%1$s), please double-check the value.',
- match[ 0 ]
- );
-
- throw new Error( message );
- }
- }
- // set the initial value object using the currency
- const money = new Money( 0, currency );
- // set a new value using the parse on the formatter.
- return money.setAmount( money.formatter.parse( moneyValue ) );
- }
-}
diff --git a/assets/src/vo/test/currency.js b/assets/src/vo/test/currency.js
deleted file mode 100644
index 785a0b881a2..00000000000
--- a/assets/src/vo/test/currency.js
+++ /dev/null
@@ -1,141 +0,0 @@
-import { Currency, SiteCurrency } from '../currency';
-import { CURRENCY_CONFIG } from '@eventespresso/eejs';
-
-jest.mock( '@eventespresso/eejs', () => ( {
- ...require.requireActual( '@eventespresso/eejs' ),
- CURRENCY_CONFIG: {
- code: 'USD',
- singularLabel: 'dollar',
- pluralLabel: 'dollars',
- sign: '$',
- signB4: true,
- decimalMark: '.',
- thousandsSeparator: ',',
- subunits: 100,
- },
-} ) );
-
-describe( 'Currency Value Object', () => {
- describe( 'When it is constructed', () => {
- const currency = () => new Currency( CURRENCY_CONFIG );
- it( 'throws an Exception with an empty config', () => {
- const expected = () => new Currency();
- expect( expected ).toThrow( Error );
- } );
- it( 'with a valid config has expected props', () => {
- expect( currency ).not.toThrow();
- Object.getOwnPropertyNames( CURRENCY_CONFIG ).forEach( ( property ) => {
- expect( currency()[ property ] )
- .toEqual( CURRENCY_CONFIG[ property ] );
- } );
- } );
- it( 'cannot have properties changed after construction', () => {
- const testCurrency = currency();
- const changeProperty = () => {
- testCurrency.code = 'CDN';
- };
- expect( changeProperty ).toThrow();
- expect( testCurrency.code ).toEqual( 'USD' );
- } );
- describe( 'returns expected default props', () => {
- const testCurrency = new Currency( {
- code: 'dolla',
- sign: '๐ฅ',
- } );
- [
- [ 'code', 'dolla' ],
- [ 'singularLabel', '' ],
- [ 'pluralLabel', '' ],
- [ 'sign', '๐ฅ' ],
- [ 'signB4', true ],
- [ 'decimalPlaces', 2 ],
- [ 'thousandsSeparator', ',' ],
- [ 'subunits', 100 ],
- ].forEach( ( [
- propertyName,
- expectedValue,
- ] ) => {
- it( 'has expected value for the ' + propertyName +
- ' property', () => {
- expect( testCurrency[ propertyName ] )
- .toBe( expectedValue );
- } );
- } );
- } );
- describe( 'toAccountingSettings()', () => {
- it( 'returns expected shape for object', () => {
- expect( currency().toAccountingSettings() ).toEqual(
- {
- currency: {
- symbol: '$',
- format: {
- pos: '%s%v',
- neg: '- $s%v',
- zero: '%s%v',
- },
- decimal: '.',
- thousand: ',',
- precision: 2,
- },
- number: {
- decimal: '.',
- thousand: ',',
- precision: 2,
- },
- }
- );
- } );
- } );
- describe( 'toJSON()', () => {
- it( 'returns expected string when converted to JSON', () => {
- expect( JSON.stringify( SiteCurrency( CURRENCY_CONFIG ) ) )
- .toEqual(
- JSON.stringify(
- { ...CURRENCY_CONFIG, decimalPlaces: 2 }
- )
- );
- } );
- } );
- } );
-
- describe( 'Currency.validateCurrencyConfig', () => {
- const testConfig = { ...CURRENCY_CONFIG };
- const getTestObject = () => {
- return new Currency( testConfig );
- };
- const propertiesToTest = {
- code: 2,
- sign: 2,
- singularLabel: 2,
- pluralLabel: 2,
- signB4: 'true',
- decimalPlaces: '2',
- thousandsSeparator: 2,
- subunits: '2',
- };
- Object.getOwnPropertyNames( propertiesToTest ).forEach(
- ( property ) => {
- describe( property + ' property validation', () => {
- it( 'throws TypeError for missing property', () => {
- delete testConfig[ property ];
- expect( getTestObject ).toThrow( TypeError );
- } );
- it( 'throws Type Error for invalid property', () => {
- testConfig[ property ] =
- propertiesToTest[ property ];
- expect( getTestObject ).toThrow( TypeError );
- } );
- } );
- } );
- } );
-} );
-
-describe( 'SiteCurrency', () => {
- it( 'triggers console.error when invalid CURRENCY_CONFIG provided', () => {
- const testCurrency = () => {
- SiteCurrency();
- };
- testCurrency();
- expect( console ).toHaveErrored();
- } );
-} );
diff --git a/assets/src/vo/test/datetime.js b/assets/src/vo/test/datetime.js
deleted file mode 100644
index e88b07be61f..00000000000
--- a/assets/src/vo/test/datetime.js
+++ /dev/null
@@ -1,841 +0,0 @@
-/**
- * Internal imports
- */
-import DateTime from '../date-time/datetime';
-import Duration from '../date-time/duration';
-
-/**
- * External imports
- */
-import {
- InvalidISO8601String,
- InvalidLocale,
- InvalidTimezone,
- InvalidArgument,
- InvalidDateTime,
-} from '@eventespresso/eejs';
-import { capitalize } from 'lodash';
-
-describe( 'DateTime Value Object', () => {
- const baseUnits = [
- 'year',
- 'month',
- 'day',
- 'hour',
- 'minute',
- 'second',
- 'millisecond',
- ];
- const testDateValues = {
- year: 2018,
- month: 12,
- day: 25,
- hour: 10,
- minute: 15,
- second: 0,
- millisecond: 200,
- };
-
- // this is the representation of the testDateValues object as milliseconds
- // from Unix Epoch (assuming testDateValues is in UTC).
- const testDateValueInMilliseconds = 1545732900200;
-
- // this is the representation of the testDateValues object as seconds from
- // Unix Epoch (assuming testDateValues is in UTC).
- const testDateValueInSeconds = 1545732900;
-
- const baseTestDate = DateTime.fromObject( testDateValues );
-
- describe( 'with Instance', () => {
- describe( 'constructors', () => {
- describe( 'DateTime.constructor', () => {
- it( 'throws an error when provided an invalid argument for ' +
- 'iso8601DateString parameter', () => {
- const throwsError = () => new DateTime( 'invalid' );
- expect( throwsError ).toThrow( InvalidISO8601String );
- } );
- it( 'throws an error when provided an invalid timezone string',
- () => {
- const throwsError = () => new DateTime(
- new Date().toISOString(), 'invalid'
- );
- expect( throwsError ).toThrow( InvalidTimezone );
- }
- );
- it( 'throws an error when provided an invalid locale', () => {
- const throwsError = () => new DateTime(
- new Date().toISOString(),
- 'UTC',
- 'invalid'
- );
- expect( throwsError ).toThrow( InvalidLocale );
- } );
- describe( 'create getters and setters on instantiation', () => {
- const newValues = {
- year: 2017,
- month: 11,
- day: 24,
- hour: 9,
- minute: 14,
- second: 10,
- millisecond: 201,
- };
- baseUnits.forEach( ( unit ) => {
- it( unit + ' accessor returns expected value', () => {
- expect( baseTestDate[ unit ] )
- .toBe( testDateValues[ unit ] );
- } );
- it( unit + ' is immutable', () => {
- const shouldThrow = () => baseTestDate[ unit ] = 10;
- expect( shouldThrow ).toThrow();
- } );
- const fluentSetter = 'set' + capitalize( unit );
- describe( fluentSetter + '()', () => {
- const newDateTime = baseTestDate[ fluentSetter ](
- newValues[ unit ]
- );
- it( 'returns a different instance of DateTime',
- () => {
- expect( baseTestDate )
- .not
- .toBe( newDateTime );
- }
- );
- it( 'original value for ' + unit + ' has not ' +
- 'changed', () => {
- expect( baseTestDate[ unit ] )
- .toBe( testDateValues[ unit ] );
- } );
- it( 'new DateTime has new Value for ' + unit,
- () => {
- expect( newDateTime[ unit ] ).toBe(
- newValues[ unit ]
- );
- }
- );
- } );
- } );
- } );
- } );
- describe( 'Static Constructor Tests', () => {
- const testConditions = [
- {
- method: 'fromISO',
- mainParam: 'ISOString',
- dateConstructedWith: () => {
- return new Date( testDateValueInMilliseconds )
- .toISOString();
- },
- expectedMethodError: InvalidISO8601String,
- timezoneTest: true,
- offsetTest: false,
- localeTest: true,
- offsetValue: null,
- expectedms: 200,
- },
- {
- method: 'fromISOWithOffset',
- mainParam: 'ISOString',
- dateConstructedWith: () => {
- return new Date(
- testDateValueInMilliseconds - 18000000
- ).toISOString();
- },
- expectedMethodError: InvalidISO8601String,
- timezoneTest: false,
- offsetTest: true,
- localeTest: true,
- offsetValue: -5,
- expectedms: 200,
- },
- {
- method: 'fromJSDate',
- mainParam: 'date',
- expectedMethodError: TypeError,
- dateConstructedWith: () => {
- return new Date( testDateValueInMilliseconds );
- },
- timezoneTest: true,
- offsetTest: false,
- localeTest: true,
- offsetValue: null,
- expectedms: 200,
- },
- {
- method: 'fromJSDateWithOffset',
- mainParam: 'date',
- expectedMethodError: TypeError,
- dateConstructedWith: () => {
- return new Date( testDateValueInMilliseconds );
- },
- timezoneTest: false,
- offsetTest: true,
- localeTest: true,
- offsetValue: -5,
- expectedms: 200,
- },
- {
- method: 'fromMilliseconds',
- mainParam: 'milliseconds',
- expectedMethodError: TypeError,
- dateConstructedWith: () => {
- return testDateValueInMilliseconds;
- },
- timezoneTest: false,
- offsetTest: false,
- localeTest: true,
- offsetValue: null,
- expectedms: 200,
- },
- {
- method: 'fromUnix',
- mainParam: 'seconds',
- expectedMethodError: TypeError,
- dateConstructedWith: () => {
- return testDateValueInSeconds;
- },
- timezoneTest: false,
- offsetTest: false,
- localeTest: true,
- offsetValue: null,
- expectedms: 0,
- },
- {
- method: 'fromLocal',
- mainParam: 'values',
- expectedMethodError: InvalidArgument,
- dateConstructedWith: () => {
- return testDateValues;
- },
- timezoneTest: false,
- offsetTest: false,
- localeTest: true,
- offsetValue: null,
- expectedms: 200,
- },
- {
- method: 'utc',
- mainParam: 'values',
- expectedMethodError: InvalidArgument,
- dateConstructedWith: () => {
- return testDateValues;
- },
- timezoneTest: false,
- offsetTest: false,
- localeTest: true,
- offsetValue: null,
- expectedms: 200,
- },
- ];
- testConditions.forEach( ( testCondition ) => {
- const METHOD = testCondition.method;
- const {
- mainParam,
- expectedMethodError,
- dateConstructedWith,
- timezoneTest,
- offsetTest,
- localeTest,
- offsetValue,
- expectedms,
- } = testCondition;
- describe( 'DateTime.' + METHOD, () => {
- it( 'throws an error when provided an invalid ' +
- 'argument for ' + mainParam +
- ' parameter', () => {
- const throwsError =
- () => DateTime[ METHOD ]( { month: 23 } );
- expect( throwsError ).toThrow(
- expectedMethodError
- );
- } );
- if ( timezoneTest ) {
- it( 'throws an error when provided an invalid ' +
- 'timezone string', () => {
- const throwsError =
- () => DateTime[ METHOD ](
- dateConstructedWith(),
- 'invalid'
- );
- expect( throwsError )
- .toThrow( InvalidTimezone );
- } );
- }
- if ( localeTest ) {
- it( 'throws an error when provided an invalid ' +
- 'locale', () => {
- const throwsError =
- () => offsetTest ?
- DateTime[ METHOD ](
- dateConstructedWith(),
- 0,
- 'invalid'
- ) :
- DateTime[ METHOD ](
- dateConstructedWith(),
- 'UTC',
- 'invalid'
- );
- expect( throwsError )
- .toThrow( InvalidLocale );
- } );
- }
- if ( offsetTest ) {
- it( 'throws an error when provided an invalid ' +
- 'offset', () => {
- const throwsError =
- () => DateTime[ METHOD ](
- dateConstructedWith(),
- 'invalid',
- );
- expect( throwsError ).toThrow( TypeError );
- } );
- }
- describe( 'Valid instantiation tests', () => {
- const testDateTime = offsetValue && offsetTest ?
- DateTime[ METHOD ](
- dateConstructedWith(),
- offsetValue
- ) :
- DateTime[ METHOD ](
- dateConstructedWith()
- );
- it( 'instantiates an instance of DateTime', () => {
- expect( testDateTime )
- .toBeInstanceOf( DateTime );
- } );
- baseUnits.forEach( ( unit ) => {
- it( 'has the expected value for the unit ' +
- unit, () => {
- let expectedValue = unit === 'millisecond' ?
- expectedms :
- testDateValues[ unit ];
- expectedValue = offsetTest &&
- unit === 'hour' ?
- testDateValues[ unit ] + offsetValue :
- expectedValue;
- expect( testDateTime[ unit ] )
- .toBe( expectedValue );
- } );
- } );
- } );
- } );
- } );
- describe( 'fromObject()', () => {
- it( 'throws an Error when values value provided is ' +
- 'not an object', () => {
- const throwsError = () => DateTime.fromObject( null );
- expect( throwsError ).toThrow( TypeError );
- } );
- it( 'throws an Error when invalid date values are ' +
- 'passed in', () => {
- const throwsError = () => DateTime.fromObject( {
- month: 23,
- } );
- expect( throwsError ).toThrow( InvalidArgument );
- } );
- it( 'throws an error with a invalid locale ' +
- 'provided', () => {
- const throwsError = () => DateTime.fromObject( {
- ...testDateValues,
- locale: 'invalid',
- } );
- expect( throwsError ).toThrow( InvalidLocale );
- } );
- it( 'throws an error with an invalid timezone ' +
- 'provided', () => {
- const throwsError = () => DateTime.fromObject( {
- ...testDateValues,
- timezone: 'invalid',
- offset: null,
- } );
- expect( throwsError ).toThrow( InvalidTimezone );
- } );
- it( 'throws an error with an invalid offset', () => {
- const throwsError = () => DateTime.fromObject( {
- ...testDateValues,
- offset: 'invalid',
- } );
- expect( throwsError ).toThrow( TypeError );
- } );
- describe( 'Has expected unit values on instantiation',
- () => {
- const testDateTime = DateTime.fromObject(
- testDateValues
- );
- it( 'returns an instance of DateTime', () => {
- expect( testDateTime ).toBeInstanceOf( DateTime );
- } );
- baseUnits.forEach( ( unit ) => {
- it( 'has the expected value for the unit: ' +
- unit, () => {
- expect( testDateTime[ unit ] )
- .toBe( testDateValues[ unit ] );
- } );
- } );
- } );
- } );
- } );
- } );
- describe( 'timezones, offset, and locale', () => {
- const testConditions = [
- {
- name: 'timezone',
- testDate: new DateTime( '', 'America/New_York' ),
- expectedOriginalValue: 'America/New_York',
- expectedNewValue: 'UTC',
- },
- {
- name: 'offset',
- testDate: DateTime.fromObject( {
- ...testDateValues,
- offset: 5,
- } ),
- expectedOriginalValue: 300,
- expectedNewValue: -300,
- },
- {
- name: 'locale',
- testDate: new DateTime(),
- expectedOriginalValue: 'en',
- expectedNewValue: 'en-ca',
- },
- ];
- testConditions.forEach( ( testCondition ) => {
- const {
- name,
- testDate,
- expectedOriginalValue,
- expectedNewValue,
- } = testCondition;
- const setter = 'set' + capitalize( name );
- describe( name + ' tests', () => {
- describe( name + ' accessor', () => {
- it( 'returns expected ' + name, () => {
- expect( testDate[ name ] )
- .toBe( expectedOriginalValue );
- } );
- } );
- describe( setter + '()', () => {
- const newDate = testDate[ setter ]( expectedNewValue );
- it( 'newDate is an instance of DateTime', () => {
- expect( newDate ).toBeInstanceOf( DateTime );
- } );
- it( 'newDate.' + name + ' is the ' +
- 'expected value', () => {
- expect( newDate[ name ] ).toBe( expectedNewValue );
- } );
- it( 'original DateTime has not been mutated', () => {
- expect( testDate[ name ] )
- .toBe( expectedOriginalValue );
- } );
- } );
- } );
- } );
- } );
- describe( 'various other getters', () => {
- const testDate = DateTime.fromObject( {
- ...testDateValues,
- timezone: 'America/New_York',
- } );
- const testConditions = [
- [ 'daysInMonth', 31 ],
- [ 'isInDST', false ],
- [ 'isInLeapYear', false ],
- [ 'dayOfYear', 359 ],
- [ 'quarter', 4 ],
- [ 'isoWeekNumber', 52 ],
- [ 'isoWeekYear', 2018 ],
- [ 'isoWeekDay', 2 ],
- [ 'isoWeeksInWeekYear', 52 ],
- ];
- testConditions.forEach( ( testCondition ) => {
- const [ name, expectedValue ] = testCondition;
- describe( name + ' getter', () => {
- it( 'returns expected value', () => {
- expect( testDate[ name ] ).toBe( expectedValue );
- } );
- } );
- } );
- } );
- describe( 'diff()', () => {
- const duration = baseTestDate.diff(
- DateTime.fromObject( {
- ...testDateValues,
- day: testDateValues.day - 1,
- } )
- );
- it( 'throws an error when a DateTime is not provided', () => {
- const newDate = () => baseTestDate.diff( null );
- expect( newDate ).toThrow( InvalidDateTime );
- } );
- it( 'returns an instance of Duration', () => {
- expect( duration ).toBeInstanceOf( Duration );
- } );
- it( 'duration has expected value', () => {
- expect( duration.toObject() ).toEqual(
- {
- years: 0,
- months: 0,
- days: 1,
- hours: 0,
- minutes: 0,
- seconds: 0,
- milliseconds: 0,
- }
- );
- } );
- } );
- describe( 'diffNow()', () => {
- // one day from now.
- const testDate = DateTime.fromMilliseconds( Date.now() + 86400000 );
- const duration = testDate.diffNow();
- it( 'returns an instance of Duration', () => {
- expect( duration ).toBeInstanceOf( Duration );
- } );
- it( 'duration has expected value', () => {
- // because of the precision involved, we allow a little leeway
- // in the passing test since the test may execute 1 or 2
- // milliseconds off.
- const passedTest = duration.days === 1 || (
- duration.hours === 23 &&
- duration.minutes === 59 &&
- duration.seconds === 59
- );
- expect( passedTest ).toBe( true );
- } );
- } );
- describe( 'endOf()', () => {
- const endOfDay = baseTestDate.endOf( DateTime.UNIT_MONTH );
-
- it( 'returns an instance of DateTime', () => {
- expect( endOfDay ).toBeInstanceOf( DateTime );
- } );
- it( 'returns a NEW instance of DateTime', () => {
- expect( endOfDay ).not.toBe( baseTestDate );
- } );
- it( 'does not change original DateTime', () => {
- expect( baseTestDate.toObject() ).toEqual( testDateValues );
- } );
- it( 'returns expected value for day', () => {
- expect( endOfDay.day ).toBe( 31 );
- } );
- } );
- describe( 'equals()', () => {
- const equalsDate = DateTime.fromObject( testDateValues );
- const nonEqualsDate = DateTime.fromObject( {
- ...testDateValues,
- hour: 15,
- } );
- it( 'throws an error if otherDateTime is not an instance of ' +
- 'DateTime', () => {
- expect( () => baseTestDate.equals( null ) )
- .toThrow( InvalidDateTime );
- } );
- it( 'returns true for equal dates', () => {
- expect( baseTestDate.equals( equalsDate ) ).toBe( true );
- } );
- it( 'returns false for non-equal dates', () => {
- expect( baseTestDate.equals( nonEqualsDate ) ).toBe( false );
- } );
- } );
- describe( 'hasSame()', () => {
- const hasSameHourDate = DateTime.fromObject( {
- ...testDateValues,
- minute: 55,
- } );
- it( 'throws an error if otherDateTime is not an instance of ' +
- 'DateTime', () => {
- expect( () => baseTestDate.hasSame( null ) )
- .toThrow( InvalidDateTime );
- } );
- it( 'returns true when dates have same unit', () => {
- expect(
- baseTestDate.hasSame( hasSameHourDate, DateTime.UNIT_HOUR )
- ).toBe( true );
- } );
- it( 'returns false when dates do not have same unit', () => {
- expect(
- baseTestDate.hasSame(
- hasSameHourDate,
- DateTime.UNIT_MINUTE
- )
- ).toBe( false );
- } );
- } );
- describe( 'minus()', () => {
- const durationToSubtract = Duration.fromObject(
- { [ Duration.UNIT_DAYS ]: 1 }
- );
- const balanceDateTime = baseTestDate.minus( durationToSubtract );
- it( 'throws an error if a Duration is not used', () => {
- expect( () => baseTestDate.minus( 3 ) )
- .toThrow( TypeError );
- } );
- it( 'returns a new instance of DateTime', () => {
- expect( balanceDateTime ).toBeInstanceOf( DateTime );
- expect( balanceDateTime ).not.toBe( baseTestDate );
- } );
- it( 'does not mutate original DateTime', () => {
- expect( baseTestDate.toObject() ).toEqual( testDateValues );
- } );
- it( 'returns expected value for new DateTime', () => {
- expect( balanceDateTime.toObject() ).toEqual( {
- ...testDateValues,
- day: 24,
- } );
- } );
- } );
- describe( 'plus()', () => {
- const durationToAdd = Duration.fromObject(
- { [ Duration.UNIT_DAYS ]: 1 }
- );
- const balanceDateTime = baseTestDate.plus( durationToAdd );
- it( 'throws an error if a Duration is not used', () => {
- expect( () => baseTestDate.add( 3 ) )
- .toThrow( TypeError );
- } );
- it( 'returns a new instance of DateTime', () => {
- expect( balanceDateTime ).toBeInstanceOf( DateTime );
- expect( balanceDateTime ).not.toBe( baseTestDate );
- } );
- it( 'does not mutate original DateTime', () => {
- expect( baseTestDate.toObject() ).toEqual( testDateValues );
- } );
- it( 'returns expected value for new DateTime', () => {
- expect( balanceDateTime.toObject() ).toEqual( {
- ...testDateValues,
- day: 26,
- } );
- } );
- } );
- describe( 'startOf()', () => {
- const startOfDay = baseTestDate.startOf( DateTime.UNIT_DAY );
- it( 'returns a new instance of DateTime', () => {
- expect( startOfDay ).toBeInstanceOf( DateTime );
- expect( startOfDay ).not.toBe( baseTestDate );
- } );
- it( 'does not mutate original DateTime', () => {
- expect( baseTestDate.toObject() ).toEqual( testDateValues );
- } );
- it( 'returns the expected unit values for the result', () => {
- expect( startOfDay.toObject() ).toEqual( {
- ...testDateValues,
- hour: 0,
- minute: 0,
- second: 0,
- millisecond: 0,
- } );
- } );
- } );
- describe( 'toFormat', () => {
- const testConditions = [
- [
- 'dddd, MMMM Do YYYY, h:mm:ss a',
- 'Tuesday, December 25th 2018, 10:15:00 am',
- ],
- [
- 'dddd, ha',
- 'Tuesday, 10am',
- ],
- [
- undefined,
- '2018-12-25 10:15:00',
- ],
- [
- null,
- '2018-12-25T10:15:00Z',
- ],
- [
- '',
- '2018-12-25T10:15:00Z',
- ],
- ];
- testConditions.forEach( ( testCondition ) => {
- const [ format, expectedResult ] = testCondition;
- it( 'returns expected value for the format: ' + format, () => {
- expect( baseTestDate.toFormat( format ) )
- .toBe( expectedResult );
- } );
- } );
- } );
- describe( 'toISO()', () => {
- const testConditions = [
- [ true, 0, '2018-12-25T10:15:00.200Z' ],
- [ false, 0, '2018-12-25T10:15:00.200+00:00' ],
- [ true, -1, '2018-12-25T11:15:00.200Z' ],
- [ false, -1, '2018-12-25T10:15:00.200-01:00' ],
- ];
- testConditions.forEach( ( testCondition ) => {
- const [ inUTC, offset, expectedValue ] = testCondition;
- const testDate = DateTime.fromObject( {
- ...testDateValues,
- offset,
- } );
- it( 'returns the expected value when offset is ' +
- offset + ' and inUTC argument is ' + inUTC, () => {
- expect( testDate.toISO( inUTC ) ).toBe( expectedValue );
- } );
- } );
- } );
- describe( 'toJSDate()', () => {
- const testDate = DateTime.fromObject( {
- ...testDateValues,
- offset: 0,
- } );
- it( 'returns an instance of Date', () => {
- expect( testDate.toJSDate() ).toBeInstanceOf( Date );
- } );
- it( 'the Date has the expected value', () => {
- expect( testDate.toJSDate().toISOString() )
- .toEqual( '2018-12-25T10:15:00.200Z' );
- } );
- } );
- describe( 'toJSON()', () => {
- const testDate = DateTime.fromObject( {
- ...testDateValues,
- timezone: 'UTC',
- } );
- it( 'returns the expected value', () => {
- expect( JSON.stringify( { date: testDate } ) )
- .toBe(
- '{"date":"2018-12-25T10:15:00.200Z"}'
- );
- } );
- } );
- describe( 'toLocal()', () => {
- // get current offset for local so we know what to expect for test.
- const offset = ( DateTime.fromObject( {
- ...testDateValues,
- timezone: 'local',
- } ) ).offset / 60;
- const testDate = DateTime.fromObject( {
- ...testDateValues,
- timezone: 'UTC',
- } );
- const expectedDate = testDate.setOffset( offset );
- //expected to have offset applied
- const localDate = testDate.toLocal();
- it( 'returns a new instance of DateTime', () => {
- expect( localDate ).toBeInstanceOf( DateTime );
- expect( localDate ).not.toBe( testDate );
- } );
- it( 'offset on local to be expected', () => {
- expect( localDate.offset ).toBe( offset * 60 );
- } );
- it( 'value for local date to be expected', () => {
- expect( localDate.toObject() )
- .toEqual( expectedDate.toObject() );
- } );
- } );
- describe( 'toMillis()', () => {
- it( 'returns expected value', () => {
- expect( ( DateTime.fromObject( {
- ...testDateValues,
- timezone: 'UTC',
- } ) ).toMillis() ).toBe( testDateValueInMilliseconds );
- } );
- } );
- describe( 'toUTC()', () => {
- const dateInOffset = DateTime.fromObject( {
- ...testDateValues,
- offset: 2,
- } );
- const utcDate = dateInOffset.toUTC();
-
- it( 'returns an instance of DateTime', () => {
- expect( utcDate ).toBeInstanceOf( DateTime );
- } );
- it( 'returns a new instance of DateTime', () => {
- expect( utcDate ).not.toBe( dateInOffset );
- } );
- it( 'does not change original DateTime', () => {
- expect( dateInOffset.toObject() ).toEqual(
- testDateValues
- );
- expect( dateInOffset.offset ).toBe( 120 );
- } );
- it( 'returns expected value for offset', () => {
- expect( utcDate.offset ).toBe( 0 );
- } );
- it( 'returns expected value', () => {
- expect( utcDate.toObject() ).toEqual( {
- ...testDateValues,
- hour: 8,
- } );
- } );
- } );
- describe( 'toString()', () => {
- const testDate = DateTime.fromObject( {
- ...testDateValues,
- timezone: 'UTC',
- } );
- const expectedValue = 'Date is: Tue Dec 25 2018 10:15:00 GMT+0000';
- it( 'returns expected value when coerced to string', () => {
- expect( `Date is: ${ testDate }` ).toBe( expectedValue );
- } );
- } );
- describe( 'valueOf()', () => {
- it( 'returns expected value when coerced to a number', () => {
- const testDate = DateTime.fromObject( {
- ...testDateValues,
- timezone: 'UTC',
- } );
- expect( 1 + testDate )
- .toBe( testDateValueInMilliseconds + 1 );
- } );
- } );
- } );
- describe( 'static methods', () => {
- const laterDateTime = DateTime.fromObject( {
- ...testDateValues,
- day: 31,
- } );
- describe( 'DateTime.max()', () => {
- const maxDateTime = DateTime.max(
- baseTestDate,
- laterDateTime
- );
- it( 'throws an error if any of the provided DateTimes are not a ' +
- 'datetime object', () => {
- expect(
- () => DateTime.max( baseTestDate, null )
- ).toThrow( TypeError );
- } );
- it( 'returns a new instance of DateTime', () => {
- expect( maxDateTime ).toBeInstanceOf( DateTime );
- expect( maxDateTime ).not.toBe( baseTestDate );
- expect( maxDateTime ).not.toBe( laterDateTime );
- } );
- it( 'returns a DateTime equivalent to the expected DateTime',
- () => {
- expect( maxDateTime.equals( laterDateTime ) )
- .toBe( true );
- expect( maxDateTime.equals( baseTestDate ) ).toBe( false );
- } );
- } );
- describe( 'DateTime.min()', () => {
- const minDateTime = DateTime.min(
- baseTestDate,
- laterDateTime,
- );
- it( 'throws an error if any of the provided DateTimes are not a ' +
- 'datetime object', () => {
- expect(
- () => DateTime.max( baseTestDate, null )
- ).toThrow( TypeError );
- } );
- it( 'returns a new instance of DateTime', () => {
- expect( minDateTime ).toBeInstanceOf( DateTime );
- expect( minDateTime ).not.toBe( baseTestDate );
- expect( minDateTime ).not.toBe( laterDateTime );
- } );
- it( 'returns a DateTime equivalent to the expected DateTime',
- () => {
- expect( minDateTime.equals( baseTestDate ) )
- .toBe( true );
- expect( minDateTime.equals( laterDateTime ) ).toBe( false );
- } );
- } );
- } );
-} );
diff --git a/assets/src/vo/test/duration.js b/assets/src/vo/test/duration.js
deleted file mode 100644
index 2fe54e998df..00000000000
--- a/assets/src/vo/test/duration.js
+++ /dev/null
@@ -1,616 +0,0 @@
-/**
- * Internal imports
- */
-import Duration from '../date-time/duration';
-
-/**
- * External imports
- */
-import { InvalidLocale, InvalidISO8601String } from '@eventespresso/eejs';
-import { forEach } from 'lodash';
-import moment from 'moment-timezone';
-
-describe( 'Duration Value Object', () => {
- const baseObjectValues = {
- days: 0,
- hours: 0,
- minutes: 0,
- months: 0,
- seconds: 0,
- years: 0,
- milliseconds: 0,
- };
- describe( 'with Instance', () => {
- it( 'Throws an InvalidLocale error with invalid locale on construction',
- () => {
- const testInvalidDuration = () => {
- return new Duration( { years: 1 }, 'invalid' );
- };
- expect( testInvalidDuration ).toThrow( InvalidLocale );
- } );
- it( 'Is Immutable', () => {
- const testDuration = new Duration( { hours: 10 } );
- const testChange = () => testDuration.hours = 30;
- expect( testChange ).toThrow();
- expect( testDuration.hours ).toBe( 10 );
- } );
- describe( 'Getter generation (privateMethods.createGetters symbol)',
- () => {
- const expectedProperties = {
- days: 0,
- hours: 10,
- milliseconds: 0,
- minutes: 0,
- months: 0,
- seconds: 0,
- years: 0,
- };
- // @link https://github.com/moment/moment/blob/develop/src/lib/duration/bubble.js#L52
- // for longterm calculation method that is used internally for
- // `asYears` and `asMonths` calculations
- const expectedFunctions = {
- asDays: 10 / 24,
- asHours: 10,
- asMilliseconds: 36000000,
- asMinutes: 600,
- asMonths: 10 / ( ( 146097 / 4800 ) * 24 ),
- asSeconds: 36000,
- asYears: 10 / ( 12 * ( 146097 / 4800 ) * 24 ),
- };
- const testRuns = ( DurationInstance ) => {
- forEach( expectedProperties, ( value, property ) => {
- it( 'creates expected property ' + property, () => {
- expect( DurationInstance[ property ] ).toBe( value );
- } );
- } );
- forEach( expectedFunctions, ( value, func ) => {
- it( 'creates expected function ' + func, () => {
- expect( DurationInstance[ func ]() ).toBe( value );
- } );
- } );
- };
- describe( 'with Duration constructed from basic object as' +
- ' values argument', () => {
- const testDuration = new Duration( { hours: 10 } );
- testRuns( testDuration );
- } );
- describe( 'with Duration constructed from moment.Duration' +
- ' instance as values argument', () => {
- const testDuration = new Duration(
- moment.duration( { hours: 10 } )
- );
- testRuns( testDuration );
- } );
- } );
- describe( 'locale property', () => {
- const testDuration = new Duration( { hours: 10 } );
- describe( 'getter', () => {
- it( 'returns the default locale', () => {
- expect( testDuration.locale ).toBe( 'en' );
- } );
- } );
- describe( 'setLocale()', () => {
- it( 'returns a new Duration with the new locale', () => {
- const newDuration = testDuration.setLocale( 'en-ca' );
- expect( testDuration ).not.toBe( newDuration );
- expect( testDuration.hours ).toEqual( newDuration.hours );
- expect( newDuration.locale ).toBe( 'en-ca' );
- expect( testDuration.locale ).toBe( 'en' );
- } );
- } );
- } );
- describe( 'normalize()', () => {
- const testRuns = [
- [
- {
- years: 2,
- days: 5000,
- },
- {
- days: 8,
- hours: 0,
- milliseconds: 0,
- minutes: 0,
- months: 8,
- seconds: 0,
- years: 15,
- },
- ],
- [
- { hours: 1346 },
- {
- days: 25,
- hours: 2,
- milliseconds: 0,
- minutes: 0,
- months: 1,
- seconds: 0,
- years: 0,
- },
- ],
- ];
- testRuns.forEach( ( testRun ) => {
- it( 'returns a new Duration with the expected normalized ' +
- 'values for the input of: ' +
- JSON.stringify( testRun[ 0 ] ), () => {
- const testDuration = new Duration( testRun[ 0 ] );
- const normalized = testDuration.normalize();
- expect( normalized ).not.toBe( testDuration );
- expect( normalized.toObject() ).toEqual( testRun[ 1 ] );
- } );
- } );
- } );
- describe( 'isValid getter', () => {
- it( 'returns false for an invalid duration', () => {
- const invalidDuration = new Duration( { cheeseburgers: 1 } );
- expect( invalidDuration.isValid ).toBe( false );
- expect( console ).toHaveErrored();
- } );
- it( 'returns true for a valid duration', () => {
- const validDuration = new Duration( { years: 10 } );
- expect( validDuration.isValid ).toBe( true );
- } );
- } );
- describe( 'sameAs()', () => {
- const testConditions = [
- [
- 'same years and hours for both durations',
- { years: 10, hours: 10 },
- { years: 10, hours: 10 },
- true,
- false,
- ],
- [
- 'one duration has hours, other has days',
- { hours: 24 },
- { days: 1 },
- false,
- false,
- ],
- [
- 'one duration is valid, the other is invalid and also ' +
- 'expect console error',
- { hours: 24 },
- { cheeseburgers: 3 },
- false,
- true,
- ],
- ];
- testConditions.forEach( ( testCondition ) => {
- const [
- description,
- durationAarg,
- durationBarg,
- expectSame,
- expectConsoleError,
- ] = testCondition;
- it( 'expected response is as expected for ' +
- description, () => {
- const durationA = new Duration( durationAarg );
- const durationB = new Duration( durationBarg );
- if ( expectConsoleError ) {
- expect( console ).toHaveErrored();
- }
- expect( durationA.sameAs( durationB ) )
- .toBe( expectSame );
- } );
- } );
- it( 'throws an error when Duration instance is not provided',
- () => {
- const duration = new Duration( { years: 10 } );
- const test = () => duration.sameAs( 'error error' );
- expect( test ).toThrow( TypeError );
- } );
- } );
- describe( 'equals()', () => {
- const testConditions = [
- [
- 'same years and hours for both durations',
- { years: 10, hours: 10 },
- { years: 10, hours: 10 },
- true,
- false,
- ],
- [
- 'one duration has hours, other has days',
- { hours: 24 },
- { days: 1 },
- true,
- false,
- ],
- [
- 'one duration is valid, the other is invalid and also ' +
- 'expect console error',
- { hours: 24 },
- { cheeseburgers: 3 },
- false,
- true,
- ],
- ];
- testConditions.forEach( ( testCondition ) => {
- const [
- description,
- durationAarg,
- durationBarg,
- expectEquals,
- expectConsoleError,
- ] = testCondition;
- it( 'expected equality response is as expected for ' +
- description, () => {
- const durationA = new Duration( durationAarg );
- const durationB = new Duration( durationBarg );
- if ( expectConsoleError ) {
- expect( console ).toHaveErrored();
- }
- expect( durationA.equals( durationB ) )
- .toBe( expectEquals );
- } );
- } );
- it( 'throws an error when Duration instance is not provided',
- () => {
- const duration = new Duration( { years: 10 } );
- const test = () => duration.equals( 'error error' );
- expect( test ).toThrow( TypeError );
- } );
- } );
- describe( 'plus()', () => {
- const testDuration = new Duration( { hours: 10 } );
-
- // 0 -> test Description
- // 1 -> passed in value
- // 2 -> expected `toObject()` on returned Duration
- // 3 -> expected return value for returnedDuration.asHours()
- const testConditions = [
- [
- 'adding a Duration',
- new Duration( { hours: 14 } ),
- { ...baseObjectValues, days: 1 },
- 24,
- ],
- [
- 'adding via milliseconds',
- 72000000, //20 hours
- { ...baseObjectValues, days: 1, hours: 6 },
- 30,
- ],
- [
- 'adding via object',
- { hours: 14 },
- { ...baseObjectValues, days: 1 },
- 24,
- ],
- ];
- testConditions.forEach( ( testCondition ) => {
- const [
- description,
- passedInArg,
- expectedObject,
- expectedAsHoursValue,
- ] = testCondition;
- describe( 'returns expected value when ' + description,
- () => {
- const newDuration = testDuration
- .plus( passedInArg );
- it( 'original Duration is not the same instance as ' +
- 'new Duration', () => {
- expect( testDuration ).not.toBe( newDuration );
- } );
- it( 'original Duration has not been mutated', () => {
- expect( testDuration.hours ).toBe( 10 );
- } );
- it( 'new Duration has expected toObject value', () => {
- expect( newDuration.toObject() )
- .toEqual( expectedObject );
- } );
- it( 'new Duration has expected asHours value', () => {
- expect( newDuration.asHours() )
- .toBe( expectedAsHoursValue );
- } );
- } );
- } );
- } );
- describe( 'minus()', () => {
- const testDuration = new Duration( { hours: 34 } );
-
- // 0 -> test Description
- // 1 -> passed in value
- // 2 -> expected `toObject()` on returned Duration
- // 3 -> expected return value for returnedDuration.asHours()
- const testConditions = [
- [
- 'subtracting a Duration',
- new Duration( { hours: 10 } ),
- { ...baseObjectValues, days: 1 },
- 24,
- ],
- [
- 'subtracting via milliseconds',
- 72000000, //20 hours
- { ...baseObjectValues, hours: 14 },
- 14,
- ],
- [
- 'subtracting via object',
- { hours: 10 },
- { ...baseObjectValues, days: 1 },
- 24,
- ],
- ];
- testConditions.forEach( ( testCondition ) => {
- const [
- description,
- passedInArg,
- expectedObject,
- expectedAsHoursValue,
- ] = testCondition;
- describe( 'returns expected value when ' + description,
- () => {
- const newDuration = testDuration
- .minus( passedInArg );
- it( 'original Duration is not the same instance as ' +
- 'new Duration', () => {
- expect( testDuration ).not.toBe( newDuration );
- } );
- it( 'original Duration has not been mutated', () => {
- expect( testDuration.hours ).toBe( 34 );
- } );
- it( 'new Duration has expected toObject value', () => {
- expect( newDuration.toObject() )
- .toEqual( expectedObject );
- } );
- it( 'new Duration has expected asHours value', () => {
- expect( newDuration.asHours() )
- .toBe( expectedAsHoursValue );
- } );
- } );
- } );
- } );
- describe( 'negate()', () => {
- describe( 'returns expected values for calling this method', () => {
- const testDuration = new Duration(
- {
- hours: 10,
- days: -1,
- }
- );
- const negatedDuration = testDuration.negate();
- it( 'results in new Duration', () => {
- expect( testDuration ).not.toBe( negatedDuration );
- } );
- it( 'does not mutate original Duration', () => {
- expect( testDuration.toObject() ).toEqual(
- {
- ...baseObjectValues,
- hours: 10,
- days: -1,
- }
- );
- } );
- it( 'has expected values on new Duration', () => {
- expect( negatedDuration.toObject() ).toEqual(
- {
- ...baseObjectValues,
- hours: -10,
- days: 1,
- }
- );
- expect( negatedDuration.normalize().toObject() ).toEqual(
- {
- ...baseObjectValues,
- hours: 14,
- }
- );
- } );
- } );
- } );
- describe( 'toISO()', () => {
- it( 'returns an ISO 8601-compliant string representation of a ' +
- 'Duration', () => {
- expect( new Duration( { hours: 10, days: 255 } ).toISO() )
- .toBe( 'P255DT10H' );
- } );
- } );
- describe( 'toJSON()', () => {
- it( 'returns an ISO 8601-compliant string representation of a ' +
- 'Duration appropriate for use in JSON', () => {
- const testDuration = new Duration( { hours: 10, days: 255 } );
- expect(
- JSON.stringify(
- {
- duration: testDuration,
- }
- )
- ).toBe( '{"duration":"P255DT10H"}' );
- } );
- } );
- describe( 'toString()', () => {
- it( 'returns an ISO 8601 representation of this Duration when the ' +
- 'object is coerced to a string', () => {
- const testDuration = new Duration( { hours: 10, days: 255 } );
- expect( `Duration: ${ testDuration }` )
- .toBe( 'Duration: P255DT10H' );
- } );
- } );
- describe( 'valueOf()', () => {
- it( 'returns the millisecond value of the Duration when coerced ' +
- 'to a number', () => {
- const testDuration = new Duration( { hours: 10, days: 255 } );
- expect( 1 + testDuration ).toBe( 22068000001 );
- } );
- } );
- describe( 'toFormat()', () => {
- const testHours = { hours: 24 };
- // 0 -> format string to test
- // 1 -> expected return value
- const testConditions = [
- [
- 'y',
- '0',
- ],
- [
- 'y m d',
- '0 1',
- ],
- [
- 'h',
- '24',
- ],
- [
- 'm',
- '1,440',
- ],
- [
- 's',
- '86,400',
- ],
- [
- 'S',
- '86,400,000',
- ],
- [
- 'h:mm:ss S',
- '24:00:00 0',
- ],
- ];
- testConditions.forEach( ( testCondition ) => {
- const [ format, expectedValue ] = testCondition;
- it( 'returns expected result for ' +
- JSON.stringify( testHours ) + ' and format ' +
- 'string ' + format, () => {
- expect(
- new Duration( testHours )
- .toFormat( format )
- ).toBe( expectedValue );
- } );
- } );
- } );
- } );
- describe( 'static methods', () => {
- describe( 'DateTime.fromMilliseconds', () => {
- describe( 'constructs an instance of Duration from milliseconds',
- () => {
- const testDuration = Duration.fromMilliseconds( 86400000 );
- it( 'is an instance of Duration', () => {
- expect( testDuration ).toBeInstanceOf( Duration );
- } );
- it( 'has the expected locale', () => {
- expect( testDuration.locale ).toBe( 'en' );
- } );
- it( 'has the expected milliseconds value', () => {
- expect( testDuration.milliseconds ).toBe( 86400000 );
- } );
- } );
- } );
- describe( 'DateTime.fromObject', () => {
- describe( 'constructs an instance of Duration from invalid object',
- () => {
- const testDuration = () => {
- return Duration.fromObject(
- {
- hours: 24,
- cheeseburgers: 1,
- }
- );
- };
- it( 'outputs a console error', () => {
- testDuration();
- expect( console ).toHaveErrored();
- } );
- it( 'is considered invalid', () => {
- const duration = testDuration();
- expect( console ).toHaveErrored();
- expect( duration.isValid ).toBe( false );
- } );
- it( 'has expected values', () => {
- const duration = testDuration();
- expect( console ).toHaveErrored();
- expect( duration.hours ).toBe( 24 );
- } );
- it( 'has expected locale', () => {
- const duration = testDuration();
- expect( console ).toHaveErrored();
- expect( duration.locale ).toBe( 'en' );
- } );
- } );
- describe( 'constructs an instance of Duration from a valid ' +
- 'object', () => {
- const testDuration = Duration.fromObject(
- {
- hours: 24,
- days: 1,
- }
- );
- it( 'has expected values', () => {
- expect( testDuration.toObject() ).toEqual(
- {
- ...baseObjectValues,
- hours: 24,
- days: 1,
- }
- );
- } );
- it( 'has expected locale', () => {
- expect( testDuration.locale ).toBe( 'en' );
- } );
- } );
- } );
- describe( 'DateTime.fromISO', () => {
- const testDuration = Duration.fromISO( 'P1DT24H30M' );
- it( 'returns an instance of Duration', () => {
- expect( testDuration ).toBeInstanceOf( Duration );
- } );
- it( 'has expected values', () => {
- expect( testDuration.toObject() ).toEqual(
- {
- ...baseObjectValues,
- days: 2,
- minutes: 30,
- }
- );
- } );
- it( 'has expected locale', () => {
- expect( testDuration.locale ).toBe( 'en' );
- } );
- it( 'throws a an InvalidISO8601String error for invalid duration ' +
- 'format', () => {
- const getDuration = () => Duration.fromISO( 'invalid' );
- expect( getDuration ).toThrow( InvalidISO8601String );
- } );
- } );
- describe( 'DateTime.isValidDuration', () => {
- it( 'returns true for a valid duration', () => {
- const testDuration = new Duration( { hours: 24 } );
- expect( Duration.isValidDuration( testDuration ) ).toBe( true );
- } );
- it( 'throws a console error and returns false for invalid ' +
- 'duration instance', () => {
- const testDuration = new Duration(
- { hours: 24, cheeseburgers: 1 }
- );
- expect( console ).toHaveErrored();
- expect( Duration.isValidDuration( testDuration ) ).toBe( false );
- } );
- it( 'returns false when value is not an instance of Duration',
- () => {
- expect( Duration.isValidDuration( 'invalid' ) ).toBe( false );
- } );
- } );
- describe( 'DateTime.isDuration', () => {
- it( 'returns true for a value that is an instance of ' +
- 'Duration', () => {
- expect( Duration.isDuration( new Duration ) ).toBe( true );
- } );
- it( 'returns false for a value that is not an instance of ' +
- 'Duration', () => {
- expect( Duration.isDuration( null ) ).toBe( false );
- } );
- } );
- describe( 'DateTime.assertIsDuration', () => {
- it( 'throws an error for a value that is not an instance of ' +
- 'Duration', () => {
- const invalidDuration = () => Duration.assertIsDuration( null );
- expect( invalidDuration ).toThrow( TypeError );
- } );
- } );
- } );
-} );
diff --git a/assets/src/vo/test/label.js b/assets/src/vo/test/label.js
deleted file mode 100644
index 98069a5c921..00000000000
--- a/assets/src/vo/test/label.js
+++ /dev/null
@@ -1,144 +0,0 @@
-import Label from '../label';
-
-describe( 'Label Value Object', () => {
- describe( 'when it is constructed', () => {
- const testInstance = new Label( 'singular', 'plural' );
- it( 'throws a TypeError if invalid arguments passed in', () => {
- const testDelayedInstance = ( singularLabel, pluralLabel ) => {
- return () => new Label( singularLabel, pluralLabel );
- };
- expect( testDelayedInstance( 20, 'something' ) ).toThrow( TypeError );
- expect( testDelayedInstance( 'something', 20 ) ).toThrow( TypeError );
- } );
- it( 'disallows changing of properties after construct', () => {
- expect( testInstance.singular ).toBe( 'singular' );
- expect( () => testInstance.singular = 'testChange' ).toThrow();
- expect( testInstance.singular ).toBe( 'singular' );
- expect( () => testInstance.plural = 'testChange' ).toThrow();
- expect( testInstance.plural ).toBe( 'plural' );
- } );
- describe( 'setSingular()', () => {
- it( 'returns a new Label instance and original is unchanged',
- () => {
- const newInstance = testInstance.setSingular( 'singularA' );
- expect( newInstance ).not.toBe( testInstance );
- expect( newInstance.singular ).toBe( 'singularA' );
- expect( testInstance.singular ).toBe( 'singular' );
- } );
- } );
- describe( 'setPlural()', () => {
- it( 'returns a new Label instance and original is unchanged',
- () => {
- const newInstance = testInstance.setPlural( 'pluralA' );
- expect( newInstance ).not.toBe( testInstance );
- expect( newInstance.plural ).toBe( 'pluralA' );
- expect( testInstance.plural ).toBe( 'plural' );
- } );
- } );
- describe( 'asSentenceCase()', () => {
- let newInstance = {};
- const testCases = [
- [ 'multiple word', 'Multiple Word' ],
- [ 'dashed-label', 'Dashed Label' ],
- [ 'wIerd Camel case', 'Wierd Camel Case' ],
- ];
- it( 'returns the singular label in Sentence Case', () => {
- testCases.forEach( ( testCase ) => {
- newInstance = testInstance.setSingular( testCase[ 0 ] );
- expect( newInstance.asSentenceCase() ).toBe( testCase[ 1 ] );
- } );
- } );
- it( 'returns the plural label in Sentence Case', () => {
- testCases.forEach( ( testCase ) => {
- newInstance = testInstance.setPlural( testCase[ 0 ] );
- expect( newInstance.asSentenceCase( false ) )
- .toBe( testCase[ 1 ] );
- } );
- } );
- } );
- describe( 'asLowerCase()', () => {
- let newInstance = {};
- const testCases = [
- [ 'Multiple Words', 'multiple words' ],
- [ 'DASHED-LABEL', 'dashed-label' ],
- [ 'wIerd Camel case', 'wierd camel case' ],
- ];
- it( 'returns the singular label in Lower Case', () => {
- testCases.forEach( ( testCase ) => {
- newInstance = testInstance.setSingular( testCase[ 0 ] );
- expect( newInstance.asLowerCase() ).toBe( testCase[ 1 ] );
- } );
- } );
- it( 'returns the plural label in Lower Case', () => {
- testCases.forEach( ( testCase ) => {
- newInstance = testInstance.setPlural( testCase[ 0 ] );
- expect( newInstance.asLowerCase( false ) )
- .toBe( testCase[ 1 ] );
- } );
- } );
- } );
- describe( 'asUpperCase()', () => {
- let newInstance = {};
- const testCases = [
- [ 'Multiple Words', 'MULTIPLE WORDS' ],
- [ 'dashed-label', 'DASHED-LABEL' ],
- [ 'wIerd Camel case', 'WIERD CAMEL CASE' ],
- ];
- it( 'returns the singular label in Upper Case', () => {
- testCases.forEach( ( testCase ) => {
- newInstance = testInstance.setSingular( testCase[ 0 ] );
- expect( newInstance.asUpperCase() ).toBe( testCase[ 1 ] );
- } );
- } );
- it( 'returns the plural label in Upper Case', () => {
- testCases.forEach( ( testCase ) => {
- newInstance = testInstance.setPlural( testCase[ 0 ] );
- expect( newInstance.asUpperCase( false ) )
- .toBe( testCase[ 1 ] );
- } );
- } );
- } );
- describe( 'asFormatted()', () => {
- it( 'throws a warning when invalid format type argument' +
- ' provided.', () => {
- testInstance.asFormatted( true, 'invalid' );
- expect( console ).toHaveErroredWith( 'Warning: Format type must' +
- ' be one of Label.FORMAT_SENTENCE_CASE,' +
- ' Label.FORMAT_UPPERCASE, or Label.FORMAT_LOWERCASE' );
- } );
- it( 'converts as expected for the provided format type', () => {
- expect(
- testInstance.asFormatted( true, Label.FORMAT_SENTENCE_CASE )
- ).toBe( 'Singular' );
- expect(
- testInstance.asFormatted( false, Label.FORMAT_SENTENCE_CASE )
- ).toBe( 'Plural' );
- expect(
- testInstance.asFormatted( true, Label.FORMAT_LOWERCASE )
- ).toBe( 'singular' );
- expect(
- testInstance.asFormatted( false, Label.FORMAT_LOWERCASE )
- ).toBe( 'plural' );
- expect(
- testInstance.asFormatted( true, Label.FORMAT_UPPERCASE )
- ).toBe( 'SINGULAR' );
- expect(
- testInstance.asFormatted( false, Label.FORMAT_UPPERCASE )
- ).toBe( 'PLURAL' );
- } );
- } );
- } );
- describe( 'Label.assertString()', () => {
- it( 'throws a TypeError if the provided value is not a' +
- ' string', () => {
- expect( () => Label.assertString( 20 ) ).toThrow( TypeError );
- } );
- } );
- describe( 'Label.fromSameSingleAndPlural()', () => {
- it( 'creates a new Label instance with the same value for singular' +
- ' and plural strings for the provided value', () => {
- const newInstance = Label.fromSameSingleAndPlural( 'same' );
- expect( newInstance.singular ).toBe( newInstance.plural );
- } );
- } );
-} );
diff --git a/assets/src/vo/test/money.js b/assets/src/vo/test/money.js
deleted file mode 100644
index d205e0884fc..00000000000
--- a/assets/src/vo/test/money.js
+++ /dev/null
@@ -1,527 +0,0 @@
-import Money from '../money';
-import DefaultCurrency, { Currency } from '../currency';
-import Decimal from 'decimal.js-light';
-import { CURRENCY_CONFIG } from '@eventespresso/eejs';
-import { settings } from 'accounting-js';
-
-jest.mock( '@eventespresso/eejs', () => ( {
- ...require.requireActual( '@eventespresso/eejs' ),
- CURRENCY_CONFIG: {
- code: 'USD',
- singularLabel: 'dollar',
- pluralLabel: 'dollars',
- sign: '$',
- signB4: true,
- decimalMark: '.',
- thousandsSeparator: ',',
- subunits: 100,
- },
-} ) );
-
-describe( 'Money Value Object', () => {
- describe( 'Constructing Money Value Object', () => {
- const testDecimal = new Decimal( 1.25 );
- const testMoney = new Money( testDecimal, DefaultCurrency );
- const assertEquivalencyTests = ( methodBeingTested ) => {
- it( 'throws a TypeError if a non valid object is passed in', () => {
- expect( () => testMoney[ methodBeingTested ]( {} ) )
- .toThrow( TypeError );
- } );
- it( 'throws an Error if the currencies for the two objects being ' +
- 'added are not equal.', () => {
- expect( () => {
- testMoney[ methodBeingTested ](
- new Money(
- testDecimal,
- new Currency( {
- ...CURRENCY_CONFIG,
- code: 'CAD',
- } )
- )
- );
- } ).toThrow();
- } );
- };
- it( 'throws TypeError with invalid DefaultCurrency', () => {
- const testFailMoney = () => {
- return new Money( testDecimal, {} );
- };
- expect( testFailMoney ).toThrow( TypeError );
- } );
- it( 'valid constructed Money object to have expected properties',
- () => {
- expect( testMoney ).toHaveProperty( 'amount', testDecimal );
- expect( testMoney )
- .toHaveProperty( 'currency', DefaultCurrency );
- expect( testMoney ).toHaveProperty( 'formatter' );
- expect( testMoney.formatter ).toHaveProperty(
- 'settings',
- {
- ...settings,
- ...DefaultCurrency.toAccountingSettings().currency,
- }
- );
- expect( testMoney.formatter ).toHaveProperty( 'format' );
- }
- );
- it( 'formatter has correct settings from currency', () => {
- const currency = new Currency(
- {
- code: 'dolla',
- sign: '๐ฅ',
- }
- );
- const money = new Money( testDecimal, currency );
- expect( money.formatter.settings.symbol ).toBe( '๐ฅ' );
- } );
- it( 'expects three Money objects constructed using various types' +
- ' of amounts that result in the same value are equal as ' +
- 'expected', () => {
- const testMoneyB = new Money( 1.25, DefaultCurrency );
- const testMoneyC = new Money( '1.25', DefaultCurrency );
- expect( testMoney.equals( testMoneyB ) ).toBe( true );
- expect( testMoney.equals( testMoneyC ) ).toBe( true );
- } );
- it( 'throws an Error when a property is reassigned after construction',
- () => {
- const reassignedProp = () => {
- testMoney.amount = null;
- };
- expect( reassignedProp ).toThrow();
- expect( testMoney.amount ).toEqual( testDecimal );
- }
- );
- describe( 'setCurrency()', () => {
- it( 'Returns a new Money object when called', () => {
- const newMoney = testMoney.setCurrency( DefaultCurrency );
- // should not be the same instance even though the internal objects
- // are the same.
- expect( newMoney ).not.toBe( testMoney );
- expect( testMoney.currency ).toEqual( DefaultCurrency );
- expect( newMoney.currency ).toEqual( DefaultCurrency );
- }, 'setCurrency()' );
- } );
- describe( 'setAmount()', () => {
- it( 'Returns a new Money object when called', () => {
- const newMoney = testMoney.setAmount( testDecimal );
- // should not be the same instance even though the internal objects
- // are the same.
- expect( newMoney ).not.toBe( testMoney );
- expect( testMoney.amount ).toEqual( testDecimal );
- expect( newMoney.amount ).toEqual( testDecimal );
- } );
- } );
- describe( 'setFormatter()', () => {
- it( 'returns the same instance when this is called.', () => {
- const newMoney = testMoney.setFormatter();
- expect( newMoney ).toBe( testMoney );
- expect( testMoney.formatter ).toHaveProperty( 'format' );
- } );
- } );
- describe( 'equals()', () => {
- it( 'throws a TypeError when the type of the argument received is ' +
- 'not a Money object', () => {
- expect( () => testMoney.equals( {} ) ).toThrow( TypeError );
- } );
- it( 'is equal with other when same Decimal and Currency objects are ' +
- 'used for other Money object', () => {
- expect( testMoney.equals(
- new Money( testDecimal, DefaultCurrency )
- ) ).toBe( true );
- } );
- it( 'is equal with other when new Decimal object with equivalent ' +
- 'value and same Currency object are used for other Money' +
- ' object', () => {
- expect( testMoney.equals(
- new Money(
- new Decimal( 1.25 ),
- DefaultCurrency
- )
- ) ).toBe( true );
- } );
- it( 'is not equal with other when new Decimal object with different' +
- ' amount and same Currency object are used for other Money ' +
- 'object', () => {
- expect( testMoney.equals(
- new Money(
- new Decimal( 2.00 ),
- DefaultCurrency
- )
- ) ).toBe( false );
- } );
- it( 'is not equal with other when same Decimal object with ' +
- 'different currency object are used for other Money ' +
- 'object', () => {
- expect( testMoney.equals(
- new Money(
- testDecimal,
- new Currency( { ...CURRENCY_CONFIG, code: 'CAD' } )
- )
- ) ).toBe( false );
- } );
- } );
- describe( 'hasSameCurrency()', () => {
- it( 'throws an error if invalid type provided for argument', () => {
- expect( () => testMoney.hasSameCurrency( {} ) )
- .toThrow( TypeError );
- } );
- it( 'is equal with other when exact same currency objects exist on ' +
- 'the compared money objects', () => {
- expect( testMoney.hasSameCurrency(
- new Money(
- testDecimal,
- DefaultCurrency
- )
- ) ).toBe( true );
- } );
- it( 'is equal with other when different currency objects exist' +
- ' on the compared money objects BUT the internal value of ' +
- 'the currencies is the same', () => {
- expect( testMoney.hasSameCurrency(
- new Money(
- testDecimal,
- new Currency(
- DefaultCurrency.toJSON()
- )
- )
- ) ).toBe( true );
- } );
- it( 'is not equal with other when different currency objects exist ' +
- 'on the compared money objects and the internal value for the ' +
- 'currencies is not the same', () => {
- expect( testMoney.hasSameCurrency(
- new Money(
- testDecimal,
- new Currency( { ...CURRENCY_CONFIG, code: 'CAD' } )
- )
- ) ).toBe( false );
- } );
- } );
- describe( 'add()', () => {
- assertEquivalencyTests( 'add' );
- it( 'returns a new Money Object for the expected result', () => {
- const added = testMoney.add(
- new Money( testDecimal, DefaultCurrency )
- );
- expect( added.amount.toNumber() ).toBe( 2.50 );
- expect( added ).not.toBe( testMoney );
- } );
- } );
- describe( 'subtract()', () => {
- assertEquivalencyTests( 'subtract' );
- it( 'returns a new Money Object for the expected result', () => {
- const subtracted = testMoney.subtract(
- new Money( testDecimal, DefaultCurrency )
- );
- expect( subtracted.amount.toNumber() ).toBe( 0 );
- expect( subtracted ).not.toBe( testMoney );
- } );
- } );
- describe( 'multiply()', () => {
- it( 'returns a new Money Object for the expected result', () => {
- const multiplied = testMoney.multiply( 2 );
- expect( multiplied.amount.toNumber() ).toBe( 2.50 );
- expect( testMoney.amount.toNumber() ).toBe( 1.25 );
- } );
- } );
- describe( 'divide()', () => {
- it( 'returns a new Money object for the expected result', () => {
- const divided = testMoney.divide( 2 );
- expect( divided.amount.toNumber() ).toBe( 0.625 );
- expect( testMoney.amount.toNumber() ).toBe( 1.25 );
- } );
- } );
- describe( 'allocate()', () => {
- it( 'returns expected array of Money objects with the values for the ' +
- 'described allocation with complex requirements', () => {
- const testComplexAllocation = testMoney.allocate( [ 1, 1, 1 ] );
- expect( testComplexAllocation ).toHaveLength( 3 );
- expect( testComplexAllocation[ 0 ].toNumber() ).toBe( .42 );
- expect( testComplexAllocation[ 1 ].toNumber() ).toBe( .42 );
- expect( testComplexAllocation[ 2 ].toNumber() ).toBe( .41 );
- } );
- it( 'returns expected array of Money objects with the values for the ' +
- 'described allocation with simple requirements', () => {
- const testMoneySimple = new Money(
- new Decimal( 5 ),
- DefaultCurrency
- );
- const testSimpleAllocation = testMoneySimple.allocate( [
- 3,
- 2,
- ] );
- expect( testSimpleAllocation ).toHaveLength( 2 );
- expect( testSimpleAllocation[ 0 ].toNumber() ).toBe( 3 );
- expect( testSimpleAllocation[ 1 ].toNumber() ).toBe( 2 );
- } );
- } );
- describe( 'compare()', () => {
- assertEquivalencyTests( 'compare' );
- it( 'returns 0 if they are the same', () => {
- expect( testMoney.compare(
- new Money(
- new Decimal( 1.25 ),
- new Currency( { ...CURRENCY_CONFIG } )
- )
- ) ).toBe( 0 );
- } );
- it( 'returns 1 when this is greater than other', () => {
- expect( testMoney.compare(
- new Money(
- new Decimal( 1 ),
- DefaultCurrency
- )
- ) ).toBe( 1 );
- } );
- it( 'returns -1 when this is less than other', () => {
- expect( testMoney.compare(
- new Money(
- new Decimal( 2 ),
- DefaultCurrency
- )
- ) ).toBe( -1 );
- } );
- } );
- describe( 'greaterThan()', () => {
- assertEquivalencyTests( 'greaterThan' );
- it( 'returns true if this object is greater than provided ' +
- 'object', () => {
- expect( testMoney.greaterThan(
- new Money( new Decimal( 1 ), DefaultCurrency )
- ) ).toBe( true );
- } );
- } );
- describe( 'greaterThanOrEqualTo()', () => {
- assertEquivalencyTests( 'greaterThanOrEqualTo' );
- it( 'returns true if this object is greater than provided ' +
- 'object', () => {
- expect( testMoney.greaterThanOrEqualTo(
- new Money( new Decimal( 1 ), DefaultCurrency )
- ) ).toBe( true );
- } );
- it( 'returns true if this object is equal to provided ' +
- 'object', () => {
- expect( testMoney.greaterThanOrEqualTo(
- new Money( new Decimal( 1.25 ), DefaultCurrency )
- ) ).toBe( true );
- } );
- } );
- describe( 'lessThan()', () => {
- assertEquivalencyTests( 'lessThan' );
- it( 'returns true if this object is less than provided ' +
- 'object', () => {
- expect( testMoney.lessThan(
- new Money( new Decimal( 2 ), DefaultCurrency )
- ) ).toBe( true );
- } );
- } );
- describe( 'lessThanOrEqualTo()', () => {
- assertEquivalencyTests( 'lessThanOrEqualTo' );
- it( 'returns true if this object is less than ' +
- 'the provided object', () => {
- expect( testMoney.lessThanOrEqualTo(
- new Money( new Decimal( 2 ), DefaultCurrency )
- ) ).toBe( true );
- } );
- it( 'returns true if this object is equal to the provided ' +
- 'object', () => {
- expect( testMoney.lessThanOrEqualTo(
- new Money( new Decimal( 1.25 ), DefaultCurrency )
- ) ).toBe( true );
- } );
- } );
- describe( 'isZero()', () => {
- it( 'returns true if this object has a value of zero', () => {
- expect( testMoney.setAmount( new Decimal( 0 ) ).isZero() )
- .toBe( true );
- } );
- it( 'returns false if this object does not have a value of ' +
- 'zero', () => {
- expect( testMoney.isZero() ).toBe( false );
- } );
- } );
- describe( 'isNegative()', () => {
- it( 'returns true if this object has a negative value', () => {
- expect( testMoney.setAmount( new Decimal( -1 ) ).isNegative() )
- .toBe( true );
- } );
- it( 'returns false if this object ahs a positive value', () => {
- expect( testMoney.isNegative() ).toBe( false );
- } );
- } );
- describe( 'isPositive()', () => {
- it( 'returns true if this object has a positive value', () => {
- expect( testMoney.isPositive() ).toBe( true );
- } );
- it( 'returns false if this object has a negative value', () => {
- expect( testMoney.setAmount( new Decimal( -1 ) ).isPositive() )
- .toBe( false );
- } );
- } );
- describe( 'toNumber()', () => {
- it( 'returns the value of the Money object as a number ' +
- 'primitive', () => {
- expect( testMoney.setAmount( new Decimal( '1.25' ) )
- .toNumber() )
- .toBe( 1.25 );
- } );
- } );
- describe( 'toFixed()', () => {
- const toFixedTestObject = testMoney
- .setAmount( new Decimal( '1.24563' ) );
- it( 'returns the value of the Money object as the expected value for ' +
- 'default config for the object', () => {
- expect( toFixedTestObject.toFixed() )
- .toBe( '1.25' );
- } );
- it( 'returns the value of the Money object as the expected value ' +
- 'for the provided decimalPlaces', () => {
- expect( toFixedTestObject.toFixed( 1 ) ).toBe( '1.2' );
- } );
- it( 'returns the value of the Money object as the expected value ' +
- 'for the provided Rounding type', () => {
- expect( toFixedTestObject.toFixed( 2, Money.ROUND_FLOOR ) )
- .toBe( '1.24' );
- } );
- } );
- describe( 'toIntegerMoney()', () => {
- it( 'returns a new Money object with a value that is the integer' +
- ' of the original', () => {
- expect( testMoney.toIntegerMoney().amount.toNumber() )
- .toBe( 1 );
- } );
- it( 'returns expected new Money object for changed rounding', () => {
- const differentRoundingMoney = new Money(
- 2.45,
- DefaultCurrency
- );
- Decimal.rounding = Money.ROUND_CEIL;
- expect( differentRoundingMoney.toIntegerMoney().toNumber() )
- .toBe( 3 );
- // return to default
- Decimal.rounding = Money.ROUND_HALF_UP;
- } );
- } );
- describe( 'toString()', () => {
- it( 'returns the expected formatted string for the currency value on ' +
- ' string output', () => {
- expect( testMoney + '' ).toBe( '$1.25' );
- } );
- it( 'returns expected formatted string for currency ' +
- 'settings', () => {
- const currency = new Currency(
- {
- code: 'dolla',
- sign: '๐ฅ',
- signB4: false,
- }
- );
- const money = new Money( testDecimal, currency );
- expect( money + '' ).toBe( '1.25๐ฅ' );
- } );
- it( 'returns correct decimal places when set to 0', () => {
- const currency = new Currency( {
- code: 'dolla',
- sign: '$',
- decimalPlaces: 0,
- } );
- const money = new Money( testDecimal, currency );
- expect( money + '' ).toBe( '$1' );
- } );
- } );
- describe( 'toJSON()', () => {
- it( 'returns the expected serialized JSON string representing the' +
- ' Money object', () => {
- expect( JSON.stringify( testMoney ) ).toEqual(
- '{"amount":"1.25","currency":' + JSON.stringify( testMoney.currency.toJSON() ) + '}'
- );
- } );
- } );
- } );
- describe( 'Money.assertMoney()', () => {
- it( 'throws a TypeError if invalid Money object provided', () => {
- expect( () => Money.assertMoney( {} ) ).toThrow( TypeError );
- } );
- } );
- describe( 'Money.assertCurrency()', () => {
- it( 'throws a TypeError if invalid Currency object provided', () => {
- expect( () => Money.assertCurrency( {} ) ).toThrow( TypeError );
- } );
- } );
- describe( 'Money.assertUsingSameCurrency()', () => {
- it( 'throws a TypeError if invalid Money object provided for this',
- () => {
- expect(
- () => Money.assertUsingSameCurrency( {}, {} )
- ).toThrow( TypeError );
- } );
- it( 'throws a TypeError if invalid Money object provided for other',
- () => {
- expect(
- () => Money.assertUsingSameCurrency(
- new Money( new Decimal( 1 ), DefaultCurrency ),
- { }
- )
- ).toThrow( TypeError );
- } );
- it( 'throws an Error if two currencies on provided Money objects ' +
- 'are not equal', () => {
- expect(
- () => Money.assertUsingSameCurrency(
- new Money( new Decimal( 1 ), DefaultCurrency ),
- new Money(
- new Decimal( 1 ),
- new Currency( {
- ...DefaultCurrency.toJSON(),
- code: 'CAD',
- } )
- )
- )
- ).toThrow();
- } );
- } );
- describe( 'Money.assertSameCurrency()', () => {
- it( 'throws a TypeError if provided values are not currencies', () => {
- expect( () => Money.assertSameCurrency( {}, {} ) )
- .toThrow( TypeError );
- } );
- it( 'throws an Error if provided values are not equal currencies', () => {
- expect( () => Money.assertSameCurrency(
- DefaultCurrency,
- new Currency(
- {
- ...DefaultCurrency.toJSON(),
- code: 'CAD',
- }
- )
- ) ).toThrow();
- } );
- } );
- describe( 'Money.fromMoneyValue', () => {
- it( 'throws a TypeError if provided currency is not a Currency ' +
- 'vo', () => {
- expect( () => Money.fromMoneyValue( '10.10' ) )
- .toThrow( TypeError );
- } );
- it( 'converts a number as expected', () => {
- expect( Money.fromMoneyValue( 10, DefaultCurrency ).toNumber() )
- .toBe( 10 );
- expect( Money.fromMoneyValue( 10.10, DefaultCurrency ).toNumber() )
- .toBe( 10.1 );
- } );
- it( 'converts a money value for the currency passed in as ' +
- 'expected', () => {
- expect( Money.fromMoneyValue( '$10.10', DefaultCurrency ).toNumber() )
- .toBe( 10.1 );
- } );
- it( 'throws an error with an invalid money value string', () => {
- expect( () => Money.fromMoneyValue( 'fail fail', DefaultCurrency ) )
- .toThrow();
- } );
- it( 'throws an error with a money value having a different currency ' +
- 'sign than the provided currency value object.', () => {
- expect( () => Money.fromMoneyValue( '10,10โฌ', DefaultCurrency ) )
- .toThrow();
- } );
- } );
-} );
diff --git a/assets/src/vo/test/server-datetime.js b/assets/src/vo/test/server-datetime.js
deleted file mode 100644
index c18edb92195..00000000000
--- a/assets/src/vo/test/server-datetime.js
+++ /dev/null
@@ -1,118 +0,0 @@
-import ServerDateTime from '../date-time/server-date-time';
-import * as defaults from '../date-time/defaults';
-
-describe( 'ServerDateTime', () => {
- beforeEach( () => resetDefaults() );
-
- // this is the representation of the testDateValues object as milliseconds
- // from Unix Epoch (assuming testDateValues is in UTC).
- const testDateValueInMilliseconds = 1545732900200;
-
- const resetDefaults = () => {
- // noinspection JSUnresolvedVariable
- defaults.HAS_TIMEZONE_STRING = true;
- // noinspection JSUnresolvedVariable
- defaults.DEFAULT_OFFSET = 0;
- };
-
- const setHasNoTimezoneString = () => {
- // noinspection JSUnresolvedVariable
- defaults.HAS_TIMEZONE_STRING = false;
- };
- const setDefaultOffsetTo = ( offset ) => {
- // noinspection JSUnresolvedVariable
- defaults.DEFAULT_OFFSET = offset;
- };
- describe( 'constructor with timezone string', () => {
- const testDate = new ServerDateTime(
- new Date( testDateValueInMilliseconds ).toISOString()
- );
- it( 'constructs an instance of ServerDateTime', () => {
- expect( testDate ).toBeInstanceOf( ServerDateTime );
- } );
- it( 'has set timezone string to expected value', () => {
- expect( testDate.timezone ).toBe( 'UTC' );
- } );
- it( 'has set locale to expected value', () => {
- expect( testDate.locale ).toBe( 'en' );
- } );
- it( 'has set offset to expected value', () => {
- expect( testDate.offset ).toBe( 0 );
- } );
- } );
- describe( 'constructor with offset', () => {
- setHasNoTimezoneString();
- const testDate = new ServerDateTime(
- new Date( testDateValueInMilliseconds ).toISOString()
- );
- it( 'constructs an instance of ServerDateTime', () => {
- expect( testDate ).toBeInstanceOf( ServerDateTime );
- } );
- it( 'has set timezone string to expected value', () => {
- expect( testDate.timezone ).toBe( undefined );
- } );
- it( 'has set offset to expected value', () => {
- expect( testDate.offset ).toBe( 0 );
- } );
- } );
- describe( 'Extended method tests', () => {
- const testConditions = [
- [
- 'fromISO',
- () => new Date( testDateValueInMilliseconds ).toISOString(),
- ],
- [
- 'fromJSDate',
- () => new Date( testDateValueInMilliseconds ),
- ],
- ];
- testConditions.forEach( ( testCondition ) => {
- const [ METHOD, getDate ] = testCondition;
- describe( METHOD + '() with default timezone', () => {
- resetDefaults();
- const testDate = ServerDateTime[ METHOD ]( getDate() );
- it( 'returns an instance of ServerDateTime', () => {
- expect( testDate ).toBeInstanceOf( ServerDateTime );
- } );
- it( 'has set timezone string to expected value', () => {
- expect( testDate.timezone ).toBe( 'UTC' );
- } );
- it( 'has set offset to be expected value', () => {
- expect( testDate.offset ).toBe( 0 );
- } );
- it( 'has set locale to be expected value', () => {
- expect( testDate.locale ).toBe( 'en' );
- } );
- } );
- describe( METHOD + '() with default offset', () => {
- setDefaultOffsetTo( -2 );
- setHasNoTimezoneString();
- const testDate = ServerDateTime[ METHOD ]( getDate() );
- it( 'returns an instance of ServerDateTime', () => {
- expect( testDate ).toBeInstanceOf( ServerDateTime );
- } );
- it( 'has set timezone string to expected value', () => {
- expect( testDate.timezone ).toBe( undefined );
- } );
- it( 'has set offset to be expected value', () => {
- expect( testDate.offset ).toBe( -120 );
- } );
- it( 'has set locale to be expected value', () => {
- expect( testDate.locale ).toBe( 'en' );
- } );
- } );
- } );
- } );
- describe( 'fluent setter tests', () => {
- const testDate = ServerDateTime.fromJSDate(
- new Date( testDateValueInMilliseconds )
- );
- describe( 'setTimezone', () => {
- const newDate = testDate.setTimezone( 'America/Vancouver' );
- it( 'returns instance of ServerDateTime', () => {
- expect( newDate ).toBeInstanceOf( ServerDateTime );
- expect( newDate.timezone ).toBe( 'America/Vancouver' );
- } );
- } );
- } );
-} );
diff --git a/assets/src/wp-plugins-page/index.js b/assets/src/wp-plugins-page/index.js
deleted file mode 100644
index f5dc17418b6..00000000000
--- a/assets/src/wp-plugins-page/index.js
+++ /dev/null
@@ -1,15 +0,0 @@
-/**
- * Internal imports
- */
-import '../exit-modal-survey';
-import './style.css';
-
-/**
- * External imports
- */
-import $ from 'jquery';
-
-if ( $( 'tr.ee-upsell-plugin-list-table' ).length > 0 ) {
- $( 'tr[data-slug="event-espresso"],tr[data-slug="event-espresso-decaf"]' )
- .addClass( 'update' );
-}
diff --git a/assets/src/wp-plugins-page/style.css b/assets/src/wp-plugins-page/style.css
deleted file mode 100644
index b85af1602e5..00000000000
--- a/assets/src/wp-plugins-page/style.css
+++ /dev/null
@@ -1,10 +0,0 @@
-/** styles for plugin upsells **/
-.ee-upsell-container {
- padding: 20px;
-}
-
-.ee-upsell-inner-container {
- float: left;
- display: inline-block;
- margin-right: 10px;
-}
\ No newline at end of file
diff --git a/bin/asset-dependency-maps.js b/bin/asset-dependency-maps.js
deleted file mode 100644
index 582f56190d0..00000000000
--- a/bin/asset-dependency-maps.js
+++ /dev/null
@@ -1,44 +0,0 @@
-const requestToExternal = ( request ) => {
- const eeDependenciesMap = {
- '@eventespresso/eejs': [ 'eejs' ],
- '@eventespresso/i18n': [ 'eejs', 'i18n' ],
- '@eventespresso/validators': [ 'eejs', 'validators' ],
- '@eventespresso/helpers': [ 'eejs', 'helpers' ],
- '@eventespresso/value-objects': [ 'eejs', 'valueObjects' ],
- '@eventespresso/model': [ 'eejs', 'model' ],
- '@eventespresso/higher-order-components': [ 'eejs', 'hocs' ],
- '@eventespresso/components': [ 'eejs', 'components' ],
- '@eventespresso/editor-hocs': [ 'eejs', 'editorHocs' ],
- classnames: [ 'eejs', 'vendor', 'classnames' ],
- 'moment-timezone': [ 'eejs', 'vendor', 'moment' ],
- cuid: [ 'eejs', 'vendor', 'cuid' ],
- };
- if ( eeDependenciesMap[ request ] ) {
- return eeDependenciesMap[ request ];
- }
-};
-
-const requestToHandle = ( request ) => {
- const handlesMap = {
- '@eventespresso/eejs': 'eejs-core',
- '@eventespresso/i18n': 'eventespresso-vendor',
- '@eventespresso/validators': 'eventespresso-validators',
- '@eventespresso/helpers': 'eventespresso-helpers',
- '@eventespresso/value-objects': 'eventespresso-value-objects',
- '@eventespresso/model': 'eventespresso-model',
- '@eventespresso/higher-order-components': 'eventespresso-hocs',
- '@eventespresso/components': 'eventespresso-components',
- '@eventespresso/editor-hocs': 'eventespresso-editor-hocs',
- classnames: 'eventespresso-vendor',
- 'moment-timezone': 'eventespresso-vendor',
- cuid: 'eventespresso-vendor',
- };
- if ( handlesMap[ request ] ) {
- return handlesMap[ request ];
- }
-};
-
-module.exports = {
- requestToExternal,
- requestToHandle,
-};
\ No newline at end of file
diff --git a/bin/css-builder/build-color-stylesheets.js b/bin/css-builder/build-color-stylesheets.js
deleted file mode 100644
index b07401989f5..00000000000
--- a/bin/css-builder/build-color-stylesheets.js
+++ /dev/null
@@ -1,215 +0,0 @@
-const path = require( 'path' );
-const { startCase } = require( 'lodash' );
-const colorUtils = require( './color-utils' );
-const fileUtils = require( './file-utils' );
-
-const TEMPLATES_PATH = path.resolve( __dirname, 'css-templates' );
-
-const {
- generateHighContrast,
- generateLowContrast,
- findContrastColor,
- generateGreyScale,
-} = colorUtils;
-
-const { getTemplateCompiler } = fileUtils;
-
-const colorTemplateCompiler = getTemplateCompiler(
- [ TEMPLATES_PATH, 'color.css.handlebars' ]
-);
-
-/**
- * builds the theme base colors stylesheet
- *
- * @param {Object} config The configuration object for the theme
- * @return {Array} The build content for writing to a final file.
- */
-function baseColors( config ) {
- let colors = [];
- for ( const colorName in config.colors ) {
- const colorHex = config.colors[ colorName ];
- colors.push( compileColorTemplate( config, colorHex, colorName ) );
- }
- return colors;
-}
-
-/**
- * builds the main theme colors stylesheet
- *
- * @param {Object} config The configuration object for the theme
- * @return {Array} The build content for writing to a final file.
- */
-function themeColors( config ) {
- let colors = [];
- const themeColors = [ 'primary', 'secondary', 'accent' ];
- themeColors.forEach( ( themeColor ) => {
- const colorHex = config.meta[ themeColor ];
- colors.push( compileColorTemplate( config, colorHex, themeColor ) );
- } );
- return colors;
-}
-
-/**
- * builds the template for the provided color
- *
- * @param {Object} config The configuration object for the theme
- * @param {string} colorHex
- * @param {string} colorName
- * @return {string} color content
- */
-function compileColorTemplate( config, colorHex, colorName ) {
- const highContrastColorHex = generateHighContrast(
- colorHex,
- config.meta.rgbModifier,
- config.meta.darkTheme
- );
- const superHighContrastColorHex = generateHighContrast(
- highContrastColorHex,
- config.meta.rgbModifier,
- config.meta.darkTheme
- );
- const lowContrastColorHex = generateLowContrast(
- colorHex,
- config.meta.rgbModifier,
- config.meta.darkTheme
- );
- const superLowContrastColorHex = generateLowContrast(
- lowContrastColorHex,
- config.meta.rgbModifier,
- config.meta.darkTheme
- );
- const textContrastColorHex = findContrastColor(
- colorHex,
- config.meta.blackAndWhiteContrast
- );
- const textHighContrastColorHex = findContrastColor(
- highContrastColorHex,
- config.meta.blackAndWhiteContrast
- );
- const textLowContrastColorHex = findContrastColor(
- lowContrastColorHex,
- config.meta.blackAndWhiteContrast
- );
- const textSuperHighContrastColorHex = findContrastColor(
- superHighContrastColorHex,
- config.meta.blackAndWhiteContrast
- );
- const textSuperLowContrastColorHex = findContrastColor(
- superLowContrastColorHex,
- config.meta.blackAndWhiteContrast
- );
- return colorName === 'black' || colorName === 'white' ?
- colorTemplateCompiler( {
- isBW: true,
- colorLabel: startCase( colorName ),
- colorName,
- colorHex,
- textContrastColorHex,
- } ) :
- colorTemplateCompiler( {
- isBW: false,
- colorLabel: startCase( colorName ),
- colorName,
- colorHex,
- highContrastColorHex,
- lowContrastColorHex,
- superHighContrastColorHex,
- superLowContrastColorHex,
- textContrastColorHex,
- textHighContrastColorHex,
- textLowContrastColorHex,
- textSuperHighContrastColorHex,
- textSuperLowContrastColorHex,
- } )
-}
-
-/**
- * builds the theme text colors stylesheet
- *
- * @param {Object} config The configuration object for the theme
- * @return {Array} The build content for writing to a final file.
- */
-function textColors( config ) {
- const templateCompiler = getTemplateCompiler(
- [ TEMPLATES_PATH, 'font-colors.css.handlebars' ]
- );
- const defaultText = findContrastColor(
- config.meta.background,
- config.meta.blackAndWhiteContrast
- );
- const highContrastText = generateHighContrast(
- defaultText,
- config.meta.rgbModifier,
- config.meta.darkTheme
- );
- const superHighContrastText = generateHighContrast(
- highContrastText,
- config.meta.rgbModifier,
- config.meta.darkTheme
- );
- const lowContrastText = generateLowContrast(
- defaultText,
- config.meta.rgbModifier,
- config.meta.darkTheme
- );
- const superLowContrastText = generateLowContrast(
- lowContrastText,
- config.meta.rgbModifier,
- config.meta.darkTheme
- );
- return [
- templateCompiler(
- {
- themeLabel: startCase( config.meta.name ),
- textType: 'default',
- defaultText,
- superHighContrast: superHighContrastText,
- highContrast: highContrastText,
- lowContrast: lowContrastText,
- superLowContrast: superLowContrastText,
- }
- )
- ];
-}
-
-/**
- * builds the extra text colors stylesheet
- *
- * @param {Object} config The configuration object for the theme
- * @return {Array} The build content for writing to a final file.
- */
-function extraColors( config ) {
- const templateCompiler = getTemplateCompiler(
- [ TEMPLATES_PATH, 'extra-colors.css.handlebars' ]
- );
- const background = config.meta.background;
- const greys = generateGreyScale(
- config.colors.black || '#000000',
- config.colors.white || '#FFFFFF',
- config.meta.darkTheme
- );
- const templateVars = {
- bgColorHex: background,
- borderColorHex: generateLowContrast(
- findContrastColor( background, false, 'AA' ),
- config.meta.rgbModifier,
- config.meta.darkTheme
- ),
- };
- for ( let x = 0; x < greys.length; x++ ) {
- const y = x + 1;
- templateVars[ `grey${ y }ColorHex` ] = greys[ x ];
- templateVars[ `textOnGrey${ y }ColorHex` ] = findContrastColor(
- greys[ x ],
- config.meta.blackAndWhiteContrast
- );
- }
- return [ templateCompiler( templateVars ) ];
-}
-
-module.exports = {
- baseColors,
- themeColors,
- textColors,
- extraColors,
-};
\ No newline at end of file
diff --git a/bin/css-builder/build-section-templates.js b/bin/css-builder/build-section-templates.js
deleted file mode 100644
index 9bf7ca0cad6..00000000000
--- a/bin/css-builder/build-section-templates.js
+++ /dev/null
@@ -1,269 +0,0 @@
-const fs = require( 'fs' );
-const path = require( 'path' );
-const { compile } = require( 'handlebars' );
-const { startCase } = require( 'lodash' );
-const { GREYSCALE_LEVELS } = require( './color-utils' );
-const {
- themeColors,
- themeColorDesc,
- defaultSizes,
- defaultRadii,
- fontSizeDesc,
- fontSizeColors,
- loremIpsum,
- entityStatusGroups,
-} = require( './default-data' );
-
-/**
- * Constant for the path holding all the handlebar demo templates.
- * @type {string}
- */
-const TEMPLATES_PATH = path.resolve( __dirname, 'demo-templates' );
-
-/**
- * A function that builds the colors section for css demo html.
- *
- * @param {Object} themeConfig The configuration object for the theme.
- * @return {string} Colors section html.
- */
-function buildColorsSection( themeConfig ) {
- const colorsSectionTemplate = fs.readFileSync(
- path.resolve( TEMPLATES_PATH, 'colors-section-template.html' ),
- 'utf8'
- );
- const baseColorsTemplate = fs.readFileSync(
- path.resolve( TEMPLATES_PATH, 'base-color-template.html' ),
- 'utf8'
- );
- const themeColorsTemplate = fs.readFileSync(
- path.resolve( TEMPLATES_PATH, 'theme-color-template.html' ),
- 'utf8'
- );
- const baseTemplate = compile( baseColorsTemplate );
- const themeTemplate = compile( themeColorsTemplate );
- const colorDemoItems = [];
- themeColors.map( ( color ) => {
- colorDemoItems.push(
- themeTemplate( {
- colorLabel: startCase( color ),
- color,
- desc: themeColorDesc[ color ],
- isDefault: color === 'default',
- } )
- );
- } );
- const baseColorItems = [];
- for ( const color in themeConfig.colors ) {
- baseColorItems.push(
- baseTemplate( {
- colorLabel: startCase( color ),
- color,
- isGrey: false,
- isBW: color === 'black' || color === 'white',
- } )
- );
- }
- /// now add grey scale levels
- const greys = [];
- for ( let x = 1; x <= GREYSCALE_LEVELS; x++ ) {
- const color = `grey-${ x }`;
- greys.push(
- baseTemplate( {
- colorLabel: startCase( color ),
- color,
- isGrey: true,
- } )
- );
- }
- const sectionTemplate = compile( colorsSectionTemplate );
- return sectionTemplate( {
- themeColors: colorDemoItems,
- baseColors: baseColorItems,
- greys,
- } );
-}
-
-/**
- * A function that builds the entity status section for the css demo html
- *
- * @return {string} Status section html.
- */
-function buildEntityStatusSection() {
- const sectionTemplate = compile( fs.readFileSync(
- path.resolve( TEMPLATES_PATH, 'entity-status-section.html' ),
- 'utf-8'
- ) );
- const sectionGroupTemplate = compile( fs.readFileSync(
- path.resolve( TEMPLATES_PATH, 'entity-status-group.html' ),
- 'utf-8'
- ) );
- const sectionItemTemplate = compile( fs.readFileSync(
- path.resolve( TEMPLATES_PATH, 'entity-status-template.html' ),
- 'utf8'
- ) );
- const entityGroups = [];
-
- for ( const entityName in entityStatusGroups ) {
- const entityStatuses = entityStatusGroups[ entityName ];
- entityGroups.push(
- sectionGroupTemplate(
- {
- entityName: startCase( entityName ),
- entityItems: entityStatuses.map(
- ( { label, code } ) => {
- return sectionItemTemplate(
- {
- statusLabel: `${ startCase( entityName ) } ${ startCase( label ) }`,
- statusCode: code
- }
- );
- } ),
- }
- )
- );
- };
- return sectionTemplate( { entityGroups } );
-}
-
-/**
- * A function that builds the button section for the css demo html.
- *
- * @return {string} The section html.
- */
-function buildButtonSection() {
- const sectionTemplate = compile( fs.readFileSync(
- path.resolve( TEMPLATES_PATH, 'button-section.html' ),
- 'utf-8'
- ) );
- const sectionItemTemplate = compile( fs.readFileSync(
- path.resolve( TEMPLATES_PATH, 'button-template.html' ),
- 'utf8'
- ) );
-
- const sectionItems = [];
- themeColors.map( ( color ) => {
- sectionItems.push(
- sectionItemTemplate( {
- colorLabel: startCase( color ),
- color,
- } )
- );
- } );
- return sectionTemplate( { sectionItems } );
-}
-
-/**
- * A function that builds the shadows section for the css demo html.
- *
- * @param {Array} colors An array of color configuration objects
- * @return {string} The section html
- */
-function buildShadowsSection( { colors } ) {
- const sectionTemplate = compile( fs.readFileSync(
- path.resolve( TEMPLATES_PATH, 'shadows-section.html' ),
- 'utf-8'
- ) );
- const sectionItemTemplate = compile( fs.readFileSync(
- path.resolve( TEMPLATES_PATH, 'shadows-template.html' ),
- 'utf8'
- ) );
- const boxShadowSizes = [ 'tiny', 'small', 'default', 'big' ];
- const sectionItems = boxShadowSizes.map( ( size ) => {
- return sectionItemTemplate( {
- size,
- notTiny: size !== 'tiny',
- } );
- } );
- return sectionTemplate( { sectionItems } );
-}
-
-/**
- * A function the builds the sizes section for the css demo html
- *
- * @param {Object} sizes
- * @return {string} The section html.
- */
-function buildSizesSection( { sizes } ) {
- const sectionTemplate = compile( fs.readFileSync(
- path.resolve( TEMPLATES_PATH, 'size-section-template.html' ),
- 'utf8'
- ) );
- const fontSizeTemplate = compile( fs.readFileSync(
- path.resolve( TEMPLATES_PATH, 'font-size-template.html' ),
- 'utf8'
- ) );
- const marginSizeTemplate = compile( fs.readFileSync(
- path.resolve( TEMPLATES_PATH, 'margin-size-template.html' ),
- 'utf8'
- ) );
- const paddingSizeTemplate = compile( fs.readFileSync(
- path.resolve( TEMPLATES_PATH, 'padding-size-template.html' ),
- 'utf8'
- ) );
- const borderSizeTemplate = compile( fs.readFileSync(
- path.resolve( TEMPLATES_PATH, 'border-radius-template.html' ),
- 'utf8'
- ) );
- const defaultFontSizes = defaultSizes.reverse();
- // const sizesCount = defaultFontSizes.length;
- const fontSizes = defaultFontSizes.map(
- ( size, index ) => {
- return fontSizeTemplate( {
- size,
- priority: index + 1,
- color: fontSizeColors[ size ],
- desc: fontSizeDesc[ size ],
- example: shorterIpsum( loremIpsum, index )
- } )
- }
- );
- defaultSizes.reverse();
- const marginSizes = defaultSizes.map(
- ( size ) => marginSizeTemplate( { size } )
- );
- const paddingSizes = defaultSizes.map(
- ( size ) => paddingSizeTemplate( { size } )
- );
- const radiusSizes = defaultRadii.map(
- ( size ) => borderSizeTemplate( { size } )
- );
- return sectionTemplate( {
- fontSizes,
- marginSizes,
- paddingSizes,
- radiusSizes,
- } );
-}
-
-function shorterIpsum( longerIpsum, index ) {
- const length = ( ( index + 5 ) * ( index + 5 ) * ( index + 1 ) ) + 5;
- return longerIpsum.length > length ?
- longerIpsum.substr( 0, longerIpsum.lastIndexOf( ' ', length ) ) :
- longerIpsum;
-}
-
-/**
- * A function that builds an returns an array of section templates for the
- * css demo html.
- *
- * @return {string[]} An array of sections html strings.
- */
-
-/**
- * A function that builds an returns an array of section templates for the
- * css demo html.
- *
- * @param {Object} themeConfig The configuration object for the theme.
- * @return {Array} An array of sections for the main template.
- */
-function buildSectionTemplates( themeConfig ) {
- return [
- buildColorsSection( themeConfig ),
- buildEntityStatusSection(),
- buildButtonSection(),
- buildSizesSection( themeConfig ),
- buildShadowsSection( themeConfig ),
- ];
-}
-
-module.exports = buildSectionTemplates;
\ No newline at end of file
diff --git a/bin/css-builder/build-sizes-stylesheets.js b/bin/css-builder/build-sizes-stylesheets.js
deleted file mode 100644
index 4626a7618ac..00000000000
--- a/bin/css-builder/build-sizes-stylesheets.js
+++ /dev/null
@@ -1,158 +0,0 @@
-const path = require( 'path' );
-const fileUtils = require( './file-utils' );
-
-const TEMPLATES_PATH = path.resolve( __dirname, 'css-templates' );
-
-const { getTemplateCompiler } = fileUtils;
-const templateCompiler = getTemplateCompiler(
- [ TEMPLATES_PATH, 'size.css.handlebars' ]
-);
-
-const defaultFontSizeModifiers = {
- micro: .06,
- tiny: .07,
- smaller: .08,
- small: .09,
- default: .1,
- big: .12,
- bigger: .15,
- huge: .2,
- extreme: .3,
-};
-const defaultSizeModifiers = {
- nano: .125,
- micro: .25,
- tiny: .5,
- smaller: .75,
- small: 1,
- default: 1.5,
- big: 2,
- bigger: 2.5,
- huge: 3,
- extreme: 4,
-};
-const defaultRadiusModifiers = {
- none: 0,
- small: 1,
- default: 2,
- big: 4,
- bigger: 8,
- huge: 16,
- full: 1000,
-};
-
-/**
- * Builds the font sizes variable css files for the given theme.
- *
- * @param {Object} config The configuration object for the theme
- * @return {Array} The build content for writing to a final file.
- */
-function fontSizes( config ) {
- const sizeModifiers = config.sizes.fontSizeModifiers ?
- config.sizes.fontSizeModifiers :
- defaultFontSizeModifiers;
- const fontSizeBase = config.sizes.fontSizeBase;
- const fontUnits = config.sizes.fontUnits || 'rem';
- let sizes = [];
- for ( const modifier in sizeModifiers ) {
- let value = sizeModifiers[ modifier ] * fontSizeBase;
- value = value.toFixed( 2 );
- sizes.push(
- templateCompiler( {
- modifier: `font-size-${ modifier }`,
- value: value + fontUnits,
- } )
- );
- }
- sizes.push(
- templateCompiler( {
- modifier: 'line-height-modifier',
- value: config.sizes.lineHeightModifier ?
- config.sizes.lineHeightModifier :
- 1.5,
- } )
- );
- return sizes;
-}
-
-/**
- * Builds the margin sizes variable css files for the given theme.
- *
- * @param {Object} config The configuration object for the theme
- * @return {Array} The build content for writing to a final file.
- */
-function marginSizes( config ) {
- const sizeModifiers = config.sizes.marginSizeModifiers ?
- config.sizes.marginSizeModifiers :
- defaultSizeModifiers;
- const marginDefault = config.sizes.marginDefault;
- const marginUnits = config.sizes.marginUnits || 'rem';
- let sizes = [];
- for ( const modifier in sizeModifiers ) {
- const value = sizeModifiers[ modifier ] * marginDefault;
- sizes.push(
- templateCompiler( {
- modifier: `margin-${ modifier }`,
- value: value + marginUnits,
- } )
- );
- }
- return sizes;
-}
-
-/**
- * Builds the padding sizes variable css files for the given theme.
- *
- * @param {Object} config The configuration object for the theme
- * @return {Array} The build content for writing to a final file.
- */
-function paddingSizes( config ) {
- const sizeModifiers = config.sizes.paddingSizeModifiers ?
- config.sizes.paddingSizeModifiers :
- defaultSizeModifiers;
- const paddingDefault = config.sizes.paddingDefault;
- const paddingUnits = config.sizes.paddingUnits || 'rem';
- let sizes = [];
- for ( const modifier in sizeModifiers ) {
- const value = sizeModifiers[ modifier ] * paddingDefault;
- sizes.push(
- templateCompiler( {
- modifier: `padding-${ modifier }`,
- value: value + paddingUnits,
- } )
- );
- }
- return sizes;
-}
-
-/**
- * Builds the border radius sizes variable css files for the given theme.
- *
- * @param {Object} config The configuration object for the theme
- * @return {Array} The build content for writing to a final file.
- */
-function radiusSizes( config ) {
- const sizeModifiers = config.sizes.radiusSizeModifiers ?
- config.sizes.radiusSizeModifiers :
- defaultRadiusModifiers;
- const radiusDefault = config.sizes.radiusDefault;
- const radiusUnits = config.sizes.radiusUnits || 'px';
- let sizes = [];
- for ( const modifier in sizeModifiers ) {
- const value = sizeModifiers[ modifier ] * radiusDefault;
- sizes.push(
- templateCompiler( {
- modifier: `border-radius-${ modifier }`,
- value: Math.round( value ) + radiusUnits,
- } )
- );
- }
- return sizes;
-}
-
-module.exports = {
- fontSizes,
- marginSizes,
- paddingSizes,
- radiusSizes,
-};
diff --git a/bin/css-builder/color-utils.js b/bin/css-builder/color-utils.js
deleted file mode 100644
index 184613c2f19..00000000000
--- a/bin/css-builder/color-utils.js
+++ /dev/null
@@ -1,320 +0,0 @@
-/* CONSTANTS */
-const REGEX_HEX = /^#?([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})$/i;
-const REGEX_HEX_SHORTHAND = /^#?([a-f\d])([a-f\d])([a-f\d])$/i;
-// how many shades of grey we want
-const GREYSCALE_LEVELS = 15;
-// as we approach the background color for the theme,
-// we want to reduce the amount of variation between greys
-// in order to allow for more subtle variations
-// which can have a huge affect on appearances.
-// this number determines when to reduce
-// the difference between the shades of grey
-const GREYSCALE_HALF_STEPS = 3;
-// 0.2122307574140552 is the color luminance for 7f7f7f grey
-// which is the exact middle of the hex color code spectrum
-// and although .5 is the middle of the luminance scale
-// it seemed to me that only really bright colors had values
-// above .25 or so, which is why I'm using this value
-const MID_LUMINANCE = .25;
-
-/**
- * converts RGB color code to HEX color code
- *
- * @param {Object} rgb ex: { r: 255, g: 255, b: 255 }
- * @return {string} color hex code ex: #FFFFFF
- */
-const rgbToHex = ( rgb ) => {
- return "#" + (
- ( 1 << 24 ) + ( rgb.r << 16 ) + ( rgb.g << 8 ) + rgb.b
- ).toString( 16 ).slice( 1 );
-};
-
-/**
- * converts HEX color code to RGB color code
- *
- * @param {string} hex color code ex: #FFFFFF
- * @return {Object} rgb color object ex: { r: 255, g: 255, b: 255 }
- */
-const hexToRgb = ( hex ) => {
- hex = convertHexTriplet( hex );
- const result = REGEX_HEX.exec( hex );
- return result ? {
- r: parseInt( result[ 1 ], 16 ),
- g: parseInt( result[ 2 ], 16 ),
- b: parseInt( result[ 3 ], 16 )
- } : null;
-};
-
-/**
- * converts shorthand HEX color code to full hex code
- *
- * @param {string} hex ex: #03F
- * @return {string} hex ex: #0033FF
- */
-const convertHexTriplet = ( hex ) => {
- return hex.replace( REGEX_HEX_SHORTHAND, ( m, r, g, b ) => {
- return r + r + g + g + b + b;
- } );
-};
-
-/**
- * don't know what this does because it is not explained
- * on the page I got it from: https://www.w3.org/TR/WCAG20-TECHS/G17.html
- * but it obviously imbues some sort of magic on the passed number
- *
- * @param {number} value single value from rgb object
- * @return {number} magic
- */
-const magicAdjustment = ( value ) => {
- return Math.pow( ( value + 0.055 ) / 1.055, 2.4 );
-};
-
-/**
- * see https://www.w3.org/TR/WCAG20-TECHS/G17.html
- *
- * @param {Object} rgb ex: { r: 255, g: 255, b: 255 }
- * @return {number} luminance value from 0 to 1
- */
-const relativeLuminance = ( rgb ) => {
- let r = rgb.r / 255;
- let g = rgb.g / 255;
- let b = rgb.b / 255;
- r = r <= 0.03928 ? r / 12.92 : magicAdjustment( r );
- g = g <= 0.03928 ? g / 12.92 : magicAdjustment( g );
- b = b <= 0.03928 ? b / 12.92 : magicAdjustment( b );
- return r * 0.2126 + g * 0.7152 + b * 0.0722;
-};
-
-/**
- * see https://www.w3.org/TR/WCAG20/#contrast-ratiodef
- *
- * @param {Object} rgb1 ex: { r: 255, g: 255, b: 255 }
- * @param {Object} rgb2 ex: { r: 0, g: 0, b: 0 }
- * @return {number} numerator value for contrast ratio
- */
-const contrastRatio = ( rgb1, rgb2 ) => {
- let rl1 = relativeLuminance( rgb1 );
- let rl2 = relativeLuminance( rgb2 );
- if ( rl1 < rl2 ) {
- // do the chevy shuffle if first color's luminance is lower
- const l1 = rl2;
- const l2 = rl1;
- rl1 = l1;
- rl2 = l2;
- }
- return ( rl1 + 0.05 ) / ( rl2 + 0.05 );
-};
-
-/**
- * see https://www.w3.org/TR/WCAG20/#visual-audio-contrast-contrast
- *
- * @param {number} contrastRatio numerator
- * @return {string} 'AAA', 'AA' or 'FAIL'
- */
-const wcagScore = ( contrastRatio ) => {
- return contrastRatio >= 7 ? 'AAA' : contrastRatio >= 4.5 ? 'AA' : 'FAIL';
-};
-
-/**
- * attempts to find a color that contrasts the provided color
- * and meets the designated WCAG score level
- *
- * @param {string|Object} color hex code or rgb object
- * @param {boolean} bw whether to only return black and white
- * @param {string} level desired WCAG score level of 'AAA' or 'AA'
- * @return {string} HEX color code
- */
-const findContrastColor = ( color, bw = false, level = 'AAA' ) => {
- color = typeof color === 'string' ? hexToRgb( color ) : color;
- level = level === 'AAA' ? 'AAA' : 'AA';
- let score = 'FAIL';
- const modRgb = { r: 1, g: 1, b: 1 };
- const colorLuminance = relativeLuminance( color );
- if ( bw ) {
- return colorLuminance < MID_LUMINANCE ? '#FFFFFF' : '#000000';
- }
- const add = colorLuminance < MID_LUMINANCE;
- let color2 = modifyRgb( color, modRgb, add );
- // keep modifying the color until score matches desired level
- // OR we hit pure black or pure white
- while ( score !== level && ! (
- ( color2.r === 0 && color2.g === 0 && color2.b === 0 ) ||
- ( color2.r === 255 && color2.g === 255 && color2.b === 255 )
- ) ) {
- color2 = modifyRgb( color2, modRgb, add );
- score = wcagScore( contrastRatio( color, color2 ) );
- }
- return rgbToHex( color2 );
-};
-
-/**
- * given the r, g, or b value from the theme's black and white colors,
- * will calculate the difference between the two
- *
- * @param {number } black single r, g, or b value for the theme's black color
- * @param {number } white single r, g, or b value for the theme's white color
- * @return {number} difference between supplied value and black or white
- */
-const calculateBwDifference = ( black, white ) => {
- // dark colors have low rgb values like 25 (or whatever)
- // whereas whites have higher rgb values like 255
- // so we'll subtract black from white to get 230 (or whatever)
- // and then divide that by the number of greyscale levels
- // to get a "step" value of 23 (or whatever)
- // which is what we will use to incrementally generate our greys
- return Math.round(
- ( white - black ) / ( GREYSCALE_LEVELS - GREYSCALE_HALF_STEPS )
- );
-};
-
-/**
- * given the hex code color for the theme's black and white colors,
- * will find set number (GREYSCALE_LEVELS) of incrementally darker or
- * lighter shades of grey that are evenly distributed between the two
- *
- * @param {string } black hex code for theme's black color
- * @param {string } white hex code for theme's black color
- * @param {boolean} darkTheme whether theme is dark
- * @return {Array} 9 grey HEX colors from near black to near white
- */
-const generateGreyScale = ( black, white, darkTheme = false ) => {
- const blackRgb = hexToRgb( black );
- const whiteRgb = hexToRgb( white );
- // compute step difference between black and white
- const rgbMod = {
- r: calculateBwDifference( blackRgb.r, whiteRgb.r ),
- g: calculateBwDifference( blackRgb.g, whiteRgb.g ),
- b: calculateBwDifference( blackRgb.b, whiteRgb.b ),
- };
- // add bg color to our array of greys
- let rgbGrey = darkTheme ? [ blackRgb ] : [ whiteRgb ];
- // add 10 steps towards background color
- for ( let x = 0; x < GREYSCALE_LEVELS; x++ ) {
- rgbGrey.push(
- modifyRgb(
- rgbGrey[ x ],
- rgbMod,
- darkTheme,
- x < GREYSCALE_HALF_STEPS + 1
- )
- );
- }
- // flip the array
- rgbGrey = rgbGrey.reverse();
- // convert 10 of the rgb colors to hex (this will skip the background)
- const hexGreys = [];
- for ( let x = 0; x < GREYSCALE_LEVELS; x++ ) {
- hexGreys.push( rgbToHex( rgbGrey[ x ] ) );
- }
- return hexGreys;
-};
-
-/**
- * adds or subtracts the values of one rgb object to or from the other
- *
- * @param {Object} color the rgb color object to be modified
- * @param {Object} rgbMod the rgb values to add or subtract
- * @param {boolean} add whether to add colors or subtract them
- * @param {boolean} halfStep if true, applies half of modRgb value
- * @return {Object} rgb ex: { r: 255, g: 255, b: 255 }
- */
-const modifyRgb = ( color, rgbMod, add = false, halfStep = false ) => {
- const modRgb = halfStep ? {
- r: Math.round( rgbMod.r / GREYSCALE_HALF_STEPS ),
- g: Math.round( rgbMod.g / GREYSCALE_HALF_STEPS ),
- b: Math.round( rgbMod.b / GREYSCALE_HALF_STEPS ),
- } : rgbMod;
- color = add ? {
- r: color.r + modRgb.r,
- g: color.g + modRgb.g,
- b: color.b + modRgb.b,
- } : {
- r: color.r - modRgb.r,
- g: color.g - modRgb.g,
- b: color.b - modRgb.b,
- };
- return add ? {
- r: color.r <= 255 ? color.r : 255,
- g: color.g <= 255 ? color.g : 255,
- b: color.b <= 255 ? color.b : 255,
- } : {
- r: color.r >= 0 ? color.r : 0,
- g: color.g >= 0 ? color.g : 0,
- b: color.b >= 0 ? color.b : 0,
- };
-};
-
-/**
- * modifies the supplied color and returns one that
- * has a higher contrast compared to the background
- * ie: returned color is farther from the background color
- *
- * @param {string} hex hex color code
- * @param {Object} modRgb the rgb values to add or subtract
- * @param {boolean} darkTheme will add modifiers if darkTheme
- * @return {string} hex ex: #FFFFFF
- */
-const generateHighContrast = ( hex, modRgb, darkTheme = false ) => {
- let color = hexToRgb( hex );
- color = modifyRgb( color, modRgb, darkTheme );
- return rgbToHex( color )
-};
-
-/**
- * modifies the supplied color and returns one that
- * has a lower contrast compared to the background
- * ie: returned color is closer to the background color
- *
- * @param {string} hex hex color code
- * @param {Object} modRgb the rgb values to add or subtract
- * @param {boolean} darkTheme will subtract modifiers if darkTheme
- * @return {string} hex ex: #FFFFFF
- */
-const generateLowContrast = ( hex, modRgb, darkTheme = false ) => {
- let color = hexToRgb( hex );
- color = modifyRgb( color, modRgb, ! darkTheme );
- return rgbToHex( color )
-};
-
-
-/**
- * @param {string} background hex color code for theme background
- * @return {boolean} true if theme background has a low luminance value
- */
-const isDarkTheme = ( background ) => {
- return relativeLuminance( hexToRgb( background ) ) < 0.5;
-};
-
-/**
- * returns an rgb color object whose values are the difference
- * between the values of the two supplied rgb color objects
- *
- * @param {Object} color1 rgb color object ex: { r: 255, g: 255, b: 255 }
- * @param {Object} color2 rgb color object ex: { r: 200, g: 200, b: 200 }
- * @return {Object} rgb color object difference ex: { r: 55, g: 55, b: 55 }
- */
-const difference = ( color1, color2 ) => {
- color1 = typeof color1 === 'string' ? hexToRgb( color1 ) : color1;
- color2 = typeof color2 === 'string' ? hexToRgb( color2 ) : color2;
- let rl1 = relativeLuminance( color1 );
- let rl2 = relativeLuminance( color2 );
- return rl1 > rl2 ? {
- r: color1.r - color2.r,
- g: color1.g - color2.g,
- b: color1.b - color2.b,
- } : {
- r: color2.r - color1.r,
- g: color2.g - color1.g,
- b: color2.b - color1.b,
- }
-};
-
-module.exports = {
- GREYSCALE_LEVELS,
- generateHighContrast,
- findContrastColor,
- generateGreyScale,
- generateLowContrast,
- isDarkTheme,
-};
-
diff --git a/bin/css-builder/css-builder.js b/bin/css-builder/css-builder.js
deleted file mode 100644
index f3a9e3f5044..00000000000
--- a/bin/css-builder/css-builder.js
+++ /dev/null
@@ -1,244 +0,0 @@
-const path = require( 'path' );
-const chalk = require( 'chalk' );
-const mkdirp = require( 'mkdirp' );
-const { startCase } = require( 'lodash' );
-
-// helper for getting Css files
-const colorUtils = require( './color-utils' );
-const fileUtils = require( './file-utils' );
-const buildColorStylesheets = require( './build-color-stylesheets' );
-const buildSizesStylesheets = require( './build-sizes-stylesheets' );
-const getCssFiles = require( './get-css-files' );
-const buildSectionTemplates = require( './build-section-templates' );
-const getIndexPaths = require( './get-index-paths' );
-
-// constants;
-const DEMO_TEMPLATES_PATH = path.resolve( __dirname, 'demo-templates' );
-const CSS_TEMPLATES_PATH = path.resolve( __dirname, 'css-templates' );
-const STYLES_DIRECTORY = path.resolve( __dirname, '../../assets/src/components/ui/styles' );
-const { readFile, parseCssTemplate, writeFile } = fileUtils;
-
-// @todo eventually the themes will be looped through, but for now we're just
-// setting up the main default theme.
-
-/**
- * Gets the configuration object for the given theme directory
- * and sets defaults for some properties
- *
- * @param {string} theme
- * @return {Object} The configuration object for that theme.
- */
-function getConfig( theme ) {
- const filePath = path.resolve( STYLES_DIRECTORY, 'themes', theme );
- return require( `${ filePath }/config` );
-}
-
-/**
- * Writes the stylesheet file
- *
- * @param {Object} config
- * @return {Object} config
- */
-function setDefaultValues( config ) {
- config.meta.background = config.meta.background ?
- config.meta.background :
- '#ffffff';
- config.meta.darkTheme = colorUtils.isDarkTheme(
- config.meta.background
- );
- config.meta.rgbModifier = config.meta.rgbModifier ?
- config.meta.rgbModifier :
- { r: 32, g: 32, b: 32 };
- config.meta.blackAndWhiteContrast
- = config.meta.blackAndWhiteContrast ?
- config.meta.blackAndWhiteContrast :
- false;
- return config;
-}
-
-/**
- * Writes the stylesheet file
- *
- * @param {string} theme
- * @param {string} fileName
- * @param {string} fileData
- */
-function buildStylesheet( theme, fileName, fileData ) {
- const filePath = path.resolve(
- STYLES_DIRECTORY,
- 'themes',
- theme,
- fileName
- );
- writeFile(
- filePath,
- fileData,
- path.relative( CSS_TEMPLATES_PATH, `${ fileName }.handlebars` ),
- path.relative( STYLES_DIRECTORY, filePath )
- );
-}
-
-
-/**
- * Writes the colors css stylesheet file
- *
- * Note: Currently this only builds and writes the colors.css (or
- * colors-variables) stylesheets for the default theme.
- * The main stylesheet for the default theme is the `root` colors.css
- * stylesheet.
- *
- * @param {string} theme
- * @param {Object} config
- */
-function writeColorsCss( theme, config ) {
- if ( ! theme ) {
- return;
- }
- const fileName = 'color-variables.css';
- const fileData = parseCssTemplate(
- [ CSS_TEMPLATES_PATH, `section-${ fileName }.handlebars` ],
- {
- themeName: startCase( config.meta.name ),
- baseColorVars: buildColorStylesheets.baseColors( config ),
- themeColorVars: buildColorStylesheets.themeColors( config ),
- textColors: buildColorStylesheets.textColors( config ),
- extraColors: buildColorStylesheets.extraColors( config ),
- }
- );
- buildStylesheet( theme, fileName, fileData );
-}
-
-/**
- * Writes the sizes and sizes-variables stylesheets for the given theme.
- *
- * Note: Currently this only builds the root sizes.css stylesheet and 'default'
- * sizes-variables.css stylesheet.
- *
- * @param {string} theme
- * @param {Object} config
- */
-function writeSizesCss( theme, config ) {
- if ( ! theme ) {
- return;
- }
- const fileName = 'size-variables.css';
- const fileData = parseCssTemplate(
- [ CSS_TEMPLATES_PATH, `section-${ fileName }.handlebars` ],
- {
- themeName: startCase( config.meta.name ),
- fontSizes: buildSizesStylesheets.fontSizes( config ),
- marginSizes: buildSizesStylesheets.marginSizes( config ),
- paddingSizes: buildSizesStylesheets.paddingSizes( config ),
- radiusSizes: buildSizesStylesheets.radiusSizes( config ),
- }
- );
- buildStylesheet( theme, fileName, fileData );
-}
-
-/**
- * Write the demo css file.
- *
- * @param {string} theme
- */
-function writeCssDemoFile( theme ) {
- const filePath = path.resolve(
- STYLES_DIRECTORY, 'themes', theme, 'demo', 'demo.css'
- );
- writeFile(
- filePath,
- readFile( [ DEMO_TEMPLATES_PATH, 'demo.css' ] ),
- path.relative( DEMO_TEMPLATES_PATH, 'demo.css' ),
- path.relative( STYLES_DIRECTORY, filePath )
- );
-}
-
-/**
- * Write the main demo file template (index.html)
- *
- * @param {string} theme
- * @param {Object} config
- */
-function writeCssDemoMainFile( theme, config ) {
- const variableStylesheets = getCssFiles( config.folder, true );
- const baseStylesheets = getCssFiles( 'root' );
- const overrideStylesheets = getCssFiles( config.folder );
- const fileData = parseCssTemplate(
- [ DEMO_TEMPLATES_PATH, 'main_template.html' ],
- {
- themeName: config.meta.name,
- variableStylesheets: variableStylesheets.map( fileUtils.fixSlashes ),
- baseStylesheets: baseStylesheets.map( fileUtils.fixSlashes ),
- overrideStylesheets: overrideStylesheets.map( fileUtils.fixSlashes ),
- demoSections: buildSectionTemplates( config ),
- }
- );
- const filePath = path.resolve(
- STYLES_DIRECTORY,
- 'themes',
- 'default',
- 'demo',
- 'index'
- ) + '.html';
- writeFile(
- filePath,
- fileData,
- path.relative( DEMO_TEMPLATES_PATH, 'main_template.html' ),
- path.relative( STYLES_DIRECTORY, filePath )
- );
-}
-
-/**
- * Create the demo files for the given theme.
- *
- * @param {string} theme
- * @param {Object} config
- */
-function createDemos( theme, config ) {
- const destPath = path.resolve( STYLES_DIRECTORY, 'themes', theme, 'demo' );
- process.stdout.write(
- chalk.magenta(
- `Writing css demo files: ${ path.basename( destPath ) }\n`
- )
- );
- mkdirp.sync( path.dirname( destPath ) );
- writeCssDemoFile( theme );
- writeCssDemoMainFile( theme, config );
-}
-
-/**
- * Writes the index.js file as the entry point for the webpack build process.
- *
- * @param {string} theme
- */
-function createIndexFile( theme ) {
- process.stdout.write( chalk.magenta( `Creating index.js for styles: \n` ) );
- const indexPaths = getIndexPaths( theme );
- writeFile(
- [ STYLES_DIRECTORY, 'themes', 'default', 'index.js' ],
- indexPaths.map(
- ( file ) => `import '${ file }';`
- ).join( '\n' )
- );
-}
-
-/**
- * Invoked for building the files.
- *
- * @param {string} theme
- */
-function buildFiles( theme = 'default' ) {
- process.stdout.write(
- chalk.magenta( '>> Building global CSS stylesheets (and demo) \n' )
- );
- let config = getConfig( theme );
- config = setDefaultValues( config );
- writeColorsCss( theme, config );
- writeSizesCss( theme, config );
- createDemos( theme, config );
- createIndexFile( theme );
- process.stdout.write(
- '\n' + chalk.reset.inverse.bold.green( 'DONE' ) + '\n'
- );
-}
-
-buildFiles();
diff --git a/bin/css-builder/css-templates/color.css.handlebars b/bin/css-builder/css-templates/color.css.handlebars
deleted file mode 100644
index 80a0ae9dee2..00000000000
--- a/bin/css-builder/css-templates/color.css.handlebars
+++ /dev/null
@@ -1,21 +0,0 @@
-{{#if isBW}}
-
- /** {{colorLabel}} **/
- --ee-color-{{colorName}}: {{colorHex}};
- --ee-text-on-{{colorName}}: {{textContrastColorHex}};
-
-{{else}}
-
- /** {{colorLabel}} **/
- --ee-color-{{colorName}}: {{colorHex}};
- --ee-color-{{colorName}}-super-high-contrast: {{superHighContrastColorHex}};
- --ee-color-{{colorName}}-high-contrast: {{highContrastColorHex}};
- --ee-color-{{colorName}}-low-contrast: {{lowContrastColorHex}};
- --ee-color-{{colorName}}-super-low-contrast: {{superLowContrastColorHex}};
- --ee-text-on-{{colorName}}: {{textContrastColorHex}};
- --ee-text-on-{{colorName}}-super-high-contrast: {{textSuperHighContrastColorHex}};
- --ee-text-on-{{colorName}}-high-contrast: {{textHighContrastColorHex}};
- --ee-text-on-{{colorName}}-low-contrast: {{textLowContrastColorHex}};
- --ee-text-on-{{colorName}}-super-low-contrast: {{textSuperLowContrastColorHex}};
-
-{{/if}}
\ No newline at end of file
diff --git a/bin/css-builder/css-templates/extra-colors.css.handlebars b/bin/css-builder/css-templates/extra-colors.css.handlebars
deleted file mode 100644
index dc13104a9c6..00000000000
--- a/bin/css-builder/css-templates/extra-colors.css.handlebars
+++ /dev/null
@@ -1,48 +0,0 @@
-
- --ee-background-color: {{bgColorHex}};
- --ee-border-color: {{borderColorHex}};
-
- --ee-color-grey-1: {{grey1ColorHex}};
- --ee-text-on-grey-1: {{textOnGrey1ColorHex}};
-
- --ee-color-grey-2: {{grey2ColorHex}};
- --ee-text-on-grey-2: {{textOnGrey2ColorHex}};
-
- --ee-color-grey-3: {{grey3ColorHex}};
- --ee-text-on-grey-3: {{textOnGrey3ColorHex}};
-
- --ee-color-grey-4: {{grey4ColorHex}};
- --ee-text-on-grey-4: {{textOnGrey4ColorHex}};
-
- --ee-color-grey-5: {{grey5ColorHex}};
- --ee-text-on-grey-5: {{textOnGrey5ColorHex}};
-
- --ee-color-grey-6: {{grey6ColorHex}};
- --ee-text-on-grey-6: {{textOnGrey6ColorHex}};
-
- --ee-color-grey-7: {{grey7ColorHex}};
- --ee-text-on-grey-7: {{textOnGrey7ColorHex}};
-
- --ee-color-grey-8: {{grey8ColorHex}};
- --ee-text-on-grey-8: {{textOnGrey8ColorHex}};
-
- --ee-color-grey-9: {{grey9ColorHex}};
- --ee-text-on-grey-9: {{textOnGrey9ColorHex}};
-
- --ee-color-grey-10: {{grey10ColorHex}};
- --ee-text-on-grey-10: {{textOnGrey10ColorHex}};
-
- --ee-color-grey-11: {{grey11ColorHex}};
- --ee-text-on-grey-11: {{textOnGrey11ColorHex}};
-
- --ee-color-grey-12: {{grey12ColorHex}};
- --ee-text-on-grey-12: {{textOnGrey12ColorHex}};
-
- --ee-color-grey-13: {{grey13ColorHex}};
- --ee-text-on-grey-13: {{textOnGrey13ColorHex}};
-
- --ee-color-grey-14: {{grey14ColorHex}};
- --ee-text-on-grey-14: {{textOnGrey14ColorHex}};
-
- --ee-color-grey-15: {{grey15ColorHex}};
- --ee-text-on-grey-15: {{textOnGrey15ColorHex}};
diff --git a/bin/css-builder/css-templates/font-colors.css.handlebars b/bin/css-builder/css-templates/font-colors.css.handlebars
deleted file mode 100644
index 220edce29a8..00000000000
--- a/bin/css-builder/css-templates/font-colors.css.handlebars
+++ /dev/null
@@ -1,6 +0,0 @@
-
- --ee-{{textType}}-text-color: {{defaultText}};
- --ee-{{textType}}-text-color-super-high-contrast: {{superHighContrast}};
- --ee-{{textType}}-text-color-high-contrast: {{highContrast}};
- --ee-{{textType}}-text-color-low-contrast: {{lowContrast}};
- --ee-{{textType}}-text-color-super-low-contrast: {{superLowContrast}};
diff --git a/bin/css-builder/css-templates/section-color-variables.css.handlebars b/bin/css-builder/css-templates/section-color-variables.css.handlebars
deleted file mode 100644
index 1d56326518a..00000000000
--- a/bin/css-builder/css-templates/section-color-variables.css.handlebars
+++ /dev/null
@@ -1,37 +0,0 @@
-/**
-* A useful tool for building color-safe palettes is http://colorsafe.co/
-* Also: https://webaim.org/resources/contrastchecker/
-*/
-
-:root {
-
- /** ----------------------------
- * Main Theme Color Variables
- * ------------------------------ */
-{{#each themeColorVars}}
- {{{this}}}
-{{/each}}
-
-
- /** ----------------------
- * Text Color Variables
- * ------------------------ */
-{{#each textColors}}
- {{{this}}}
-{{/each}}
-
- /** ----------------------------
- * Additional Color Variables
- * ------------------------------ */
-{{#each extraColors}}
- {{{this}}}
-{{/each}}
-
- /** ----------------------
- * Base Color Variables
- * ------------------------ */
-{{#each baseColorVars}}
- {{{this}}}
-{{/each}}
-
-}
diff --git a/bin/css-builder/css-templates/section-size-variables.css.handlebars b/bin/css-builder/css-templates/section-size-variables.css.handlebars
deleted file mode 100644
index 65ec5dbae30..00000000000
--- a/bin/css-builder/css-templates/section-size-variables.css.handlebars
+++ /dev/null
@@ -1,23 +0,0 @@
-:root {
-
- /** font sizes **/
-{{#each fontSizes}}
- {{{this}}}
-{{/each}}
-
- /** padding sizes **/
-{{#each paddingSizes}}
- {{{this}}}
-{{/each}}
-
- /** margin sizes **/
-{{#each marginSizes}}
- {{{this}}}
-{{/each}}
-
- /** border radius sizes **/
-{{#each radiusSizes}}
- {{{this}}}
-{{/each}}
-
-}
diff --git a/bin/css-builder/css-templates/size.css.handlebars b/bin/css-builder/css-templates/size.css.handlebars
deleted file mode 100644
index c8ee83b6987..00000000000
--- a/bin/css-builder/css-templates/size.css.handlebars
+++ /dev/null
@@ -1 +0,0 @@
---ee-{{modifier}}: {{value}};
\ No newline at end of file
diff --git a/bin/css-builder/default-data.js b/bin/css-builder/default-data.js
deleted file mode 100644
index 8aba86d8b5a..00000000000
--- a/bin/css-builder/default-data.js
+++ /dev/null
@@ -1,148 +0,0 @@
-const themeColors = [ 'primary', 'secondary', 'accent', 'default' ];
-
-const themeColorDesc = {
- primary: 'The "primary" color is the color that is used most' +
- ' frequently throughout the system. It utilizes the following css' +
- ' variables:',
- secondary: 'The "secondary" color is the second most used' +
- ' color throughout the system. It utilizes the following css' +
- ' variables:',
- accent: 'The "accent" color is a contrasting color and is' +
- ' intended to capture attention. It utilizes the following css' +
- ' variables:',
- default: 'The "default" color group is used for most elements ' +
- ' and utilizes the following css variables:',
-};
-
-const defaultSizes = [
- 'micro',
- 'tiny',
- 'smaller',
- 'small',
- 'default',
- 'big',
- 'bigger',
- 'huge',
- 'extreme',
-];
-
-const defaultRadii = [
- 'none',
- 'small',
- 'default',
- 'big',
- 'bigger',
- 'huge',
- 'full',
-];
-
-const fontSizeDesc = {
- micro: 'Uh-oh... the fine print! This is where you hide all of the' +
- ' really nasty legal stuff about hidden fees or lack of privacy' +
- ' that you don\'t want users to know about but are still legally' +
- ' obliged to inform them of.
LOLZ! just joking.
Try not' +
- ' to use this for anything important though because it can cause' +
- ' accessibility issues for users with impaired vision.
To' +
- ' increase the accessibility of this text, this class uses a "super' +
- ' high contrast" text color, with lots of extra spacing between the' +
- ' letters and words.
',
- tiny: 'Extremely anecdotal text of little importance. Should be used' +
- ' very sparingly throughout a page for accessibility reasons.
' +
- 'To increase the accessibility of this text, this class uses a' +
- ' "super high contrast" text color, and also has a tiny bit of' +
- ' extra spacing between the letters and words.
',
- smaller: 'Anything that is of far lesser importance than the default' +
- ' priority text. These should be used sparingly throughout a' +
- ' page.
To increase the accessibility of this text, this class' +
- ' uses a "high contrast" text color.
',
- small: 'Anything that is of slightly lesser importance than the default' +
- ' priority text. These can be used liberally throughout a page to' +
- ' support the default text.
To increase the accessibility of' +
- ' this text, this class uses a "high contrast" text color.
',
- default: 'The default priority that should make up the majority of text' +
- ' on a page, ie: the default text.
',
- big: 'A somewhat important heading that users should focus on before' +
- ' reading default text. There can be lots of these on a page.
',
- bigger: 'A fairly important heading that users should focus on after' +
- ' the more important headings. There is no problem using several of' +
- ' these on a page as long as you don\'t overdo it.
Although' +
- ' using the "bigger" font size, this class uses the "default" text' +
- ' color.
',
- huge: 'A very important heading that users should focus on second.' +
- ' Ideally there should not be more than a few of these on the' +
- ' page.
This class uses the "huge" font size and a "low' +
- ' contrast" text color.
',
- extreme: 'The highest priority heading on the screen that users should' +
- ' focus on first. Ideally there should not be more than one of these' +
- ' on the page.
Typically the page title.
Because we are' +
- ' using the "extreme" font size for this class, we can also use a ' +
- ' "super low contrast" text color without negatively affecting' +
- ' accessibility.
',
-};
-
-const fontSizeColors = {
- micro: '--ee-default-text-color-super-high-contrast',
- tiny: '--ee-default-text-color-super-high-contrast',
- smaller: '--ee-default-text-color-high-contrast',
- small: '--ee-default-text-color-high-contrast',
- default: '--ee-default-text-color',
- big: '--ee-default-text-color',
- bigger: '--ee-default-text-color',
- huge: '--ee-default-text-color-low-contrast',
- extreme: '--ee-default-text-color-super-low-contrast',
-};
-
-const loremIpsum = 'The approach will not be easy. You are required to maneuver straight down this trench and skim the surface to this point. The target area is only two meters wide. Itโs a small thermal exhaust port, right below the main port. The shaft leads directly to the reactor system. A precise hit will start a chain reaction which should destroy the station. Only a precise hit will set up a chain reaction. The shaft is ray-shielded, so youโll have to use proton torpedoes. Thatโs impossible, even for a computer. Itโs not impossible. I used to bullโs-eye womp rats in my T-sixteen back home. Theyโre not much bigger than two meters. Man your ships! And may the Force be with you!';
-
-const entityStatusGroups = {
- datetime: [
- { code: 'DTS', label: 'sold out' },
- { code: 'DTA', label: 'active' },
- { code: 'DTU', label: 'upcoming' },
- { code: 'DTI', label: 'inactive' },
- { code: 'DTP', label: 'postponed' },
- { code: 'DTC', label: 'cancelled' },
- { code: 'DTT', label: 'trashed' },
- ],
- payment: [
- { code: 'PAP', label: 'approved' },
- { code: 'PPN', label: 'pending' },
- { code: 'PDC', label: 'declined' },
- { code: 'PCN', label: 'cancelled' },
- { code: 'PFL', label: 'failed' },
- ],
- registration: [
- { code: 'RAP', label: 'approved' },
- { code: 'RPP', label: 'pending' },
- { code: 'RWL', label: 'wait list' },
- { code: 'RIC', label: 'incomplete' },
- { code: 'RNA', label: 'not approved' },
- { code: 'RDC', label: 'declined' },
- { code: 'RCN', label: 'cancelled' },
- ],
- ticket: [
- { code: 'TKS', label: 'sold out' },
- { code: 'TKO', label: 'on sale' },
- { code: 'TKP', label: 'pending' },
- { code: 'TKE', label: 'expired' },
- { code: 'TKA', label: 'archived' },
- ],
- transaction: [
- { code: 'TOP', label: 'overpaid' },
- { code: 'TCM', label: 'complete' },
- { code: 'TIN', label: 'incomplete' },
- { code: 'TAB', label: 'abandoned' },
- { code: 'TFL', label: 'failed' },
- ],
-};
-
-module.exports = {
- themeColors,
- themeColorDesc,
- defaultSizes,
- defaultRadii,
- fontSizeDesc,
- fontSizeColors,
- loremIpsum,
- entityStatusGroups,
-};
diff --git a/bin/css-builder/demo-templates/base-color-template.html b/bin/css-builder/demo-templates/base-color-template.html
deleted file mode 100644
index edc1f2a212d..00000000000
--- a/bin/css-builder/demo-templates/base-color-template.html
+++ /dev/null
@@ -1,35 +0,0 @@
-
-
{{colorLabel}}
- {{#if isGrey}}
-
-
base color:
--ee-color-{{color}}
-
WCAG compliant text color:
--ee-text-on-{{color}}
-
- {{else if isBW}}
-
-
base color:
--ee-color-{{color}}
-
WCAG compliant text color:
--ee-text-on-{{color}}
-
- {{else}}
-
-
base color:
--ee-color-{{color}}
-
WCAG compliant text color:
--ee-text-on-{{color}}
-
-
-
super-high-contrast:
--ee-color-{{color}}-super-high-contrast
-
WCAG compliant text color:
--ee-text-on-{{color}}-super-high-contrast
-
-
-
high-contrast:
--ee-color-{{color}}-high-contrast
-
WCAG compliant text color:
--ee-text-on-{{color}}-high-contrast
-
-
-
low-contrast:
--ee-color-{{color}}-low-contrast
-
WCAG compliant text color:
--ee-text-on-{{color}}-low-contrast
-
-
-
super-low-contrast:
--ee-color-{{color}}-super-low-contrast
-
WCAG compliant text color:
--ee-text-on-{{color}}-super-low-contrast
-
- {{/if}}
-
-
--ee-border-radius-{{size}}
-
-
- This demonstrates the basic button styles and how they are impacted by various modifier css classes.
-
-
- Note: WordPress styles are not loaded for this demo, so buttons will appear differently in the WordPress context.
-
-
- {{#each sectionItems}}
- {{{this}}}
- {{/each}}
-
-
\ No newline at end of file
diff --git a/bin/css-builder/demo-templates/button-template.html b/bin/css-builder/demo-templates/button-template.html
deleted file mode 100644
index f227448df94..00000000000
--- a/bin/css-builder/demo-templates/button-template.html
+++ /dev/null
@@ -1,18 +0,0 @@
-
-
{{colorLabel}} Button
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Theme Colors
-
- Themes define four main colors that are used to dynamically generate a large number of CSS variables
- for styling HTML components. CSS variables are combined into semantically useful CSS classes that can be used
- to apply multiple styles at once to an element. All colors have dynamically generated alternates that meet
- or exceed Web Content Accessibility Guidelines (WCAG) AA or AAA color contrast requirements that follow the
- utilize following naming schema:
-
-
- --ee-color-{ color } - primarily intended for setting the background color of an element--ee-text-on-{ color } - A WCAG compliant text color for the above.-
- high-contrast shades ie: darker than the default for lighter themes or lighter for dark themes
-
- --ee-color-{ color }-super-high-contrast - An much higher contrast shade of the default
- color--ee-text-on-{ color }-super-high-contrast - A WCAG compliant text color for the above.--ee-color-{ color }-high-contrast - A higher contrast shade of the default color--ee-text-on-{ color }-high-contrast - A WCAG compliant text color for the above.-
- low-contrast shades ie: lighter than the default for lighter themes or darker for dark themes
-
- --ee-color-{ color }-low-contrast - A lower contrast shade of the default color--ee-text-on-{ color }-low-contrast - A WCAG compliant text color for the above.--ee-color-{ color }-super-low-contrast - A much lower contrast shade of the default color--ee-text-on-{ color }-super-low-contrast - A WCAG compliant text color for the above.
-
- That said, not all colors work with each other, so be careful when applying colors to text that are not the
- designated contrast alternative for the background the text is on. Be sure to check your color combinations
- with tools like: http://colorsafe.co/ or
- https://webaim.org/resources/contrastchecker/
-
-
- {{#each themeColors}}
- {{{this}}}
- {{/each}}
-
- The default theme style also uses the --ee-background-color CSS variable
- for setting the default background color for containers, including the background for this entire page.
-
- Base Colors
-
- Themes can also define a full spectrum of colors that will be used to dynamically generate five pairs of CSS
- variables using the same naming schema as the theme colors above. So the defined color plus super high
- contrast, high contrast, low contrast, and super low contrast alternatives:
-
-
- On light themes the high contrast alternative will be darker in comparison to the
- theme's background color. On dark themes it will be reversed, so the high contrast alternative will now be
- lighter in shade, but still higher in contrast in comparison to the background color.
-
-
-
-
-
- {{#each baseColors}}
- {{{this}}}
- {{/each}}
-
- Greys
-
- Themes also dynamically generate 15 levels of grey scale colors using the black and white colors defined by
- the theme as the two extremes. Greys only have one corresponding text color and no high or low contrast
- alternatives. For dark themes the grey scale will be reversed, so --ee-color-grey-1 will be the
- lightest shade, since it is intended to have the highest contrast compared to the theme's background color.
-
-
- {{#each greys}}
- {{{this}}}
- {{/each}}
-
-
\ No newline at end of file
diff --git a/bin/css-builder/demo-templates/demo.css b/bin/css-builder/demo-templates/demo.css
deleted file mode 100644
index 50a74c2d81b..00000000000
--- a/bin/css-builder/demo-templates/demo.css
+++ /dev/null
@@ -1,1271 +0,0 @@
-div,
-body,
-header,
-#navigation,
-footer {
- box-sizing: border-box !important;
-}
-
-body {
- background-color: var(--ee-background-color);
- color: var(--ee-default-text-color);
- font-family: system, -apple-system, ".SFNSText-Regular", "San Francisco", "Roboto", "Segoe UI", "Helvetica Neue", "Lucida Grande", sans-serif;
- font-size: var(--ee-font-size-default);
- line-height: var(--ee-line-height-modifier);
- padding: calc(74px + var(--ee-padding-default)) 0 0;
- margin: 0;
- width: 100%;
- word-wrap: break-word;
-}
-
-.wrapper {
- margin: 0 auto;
- max-width: 1280px;
- padding: 0 var(--ee-padding-small);
- position: relative;
-}
-
-header {
- background-color: #302B30;
- border-bottom: 4px solid var(--ee-color-accent);
- color: var(--ee-color-white);
- height: auto;
- line-height: 1.2;
- min-height: 74px;
- padding: var(--ee-padding-smaller) 0;
- position: fixed;
- margin: 0;
- top: 0;
- width: 100%;
- z-index: 2;
-}
-
-header h4 {
- margin: var(--ee-padding-tiny) var(--ee-padding-smaller) 0;
- position: relative;
- white-space: nowrap;
- z-index: 5;
-}
-
-.logo,
-.title {
- position: relative;
- z-index: 1;
-}
-.espresso-icon {
- border: 2px solid var(--ee-color-white);
- border-radius: var(--ee-border-radius-bigger);
- float: left;
- margin: 0;
- padding: 3px;
- position: relative;
- z-index: 5;
-}
-
-footer {
- background-color: #302B30;
- color: var(--ee-color-white);
- padding: var(--ee-padding-smaller) 0;
- margin: var(--ee-padding-default) 0 0;
- width: 100%;
-}
-footer span {
- color: var(--ee-color-white);
-}
-
-header .wrapper {
- display: flex;
- flex-flow: row nowrap;
- justify-content: space-between;
-}
-
-header .wrapper::after {
- content: "";
- clear: both;
- display: table;
-}
-
-footer .wrapper,
-.demo-items {
- display: flex;
- flex-flow: row wrap;
- justify-content: space-between;
-}
-
-
-
-a { color: var(--ee-color-primary); font-weight: bold; text-decoration: none; }
-a:hover { color: var(--ee-color-secondary); }
-
-#menu a,
-footer a { color: var(--ee-color-blue-low-contrast); }
-
-#menu a:hover,
-footer a:hover{ color: var(--ee-color-green-low-contrast); }
-
-
-#navigation {
- display: block;
- height: auto;
- margin: 0;
- min-width: 48px;
- order: 3;
- width: auto;
- z-index: 10;
-}
-
-#menu {
- background-color: #302b30;
- color: var(--ee-color-white);
- display: none;
- height: auto;
- list-style: none;
- margin: 0;
- padding: var(--ee-padding-default) var(--ee-padding-bigger);
-}
-
-.isActive #menu {
- display: block;
- height: auto;
- left: 50%;
- margin-left: -160px;
- min-width: 320px;
- position: absolute;
- top: 100px;
- z-index: 10;
-}
-
-#close-menu,
-#toggle-menu {
- border: none;
- cursor: pointer;
- font: inherit;
- outline: inherit;
- padding: 0;
-}
-#close-menu {
- background: none;
- border: 2px solid var(--ee-color-grey-11);
- border-radius: var(--ee-border-radius-bigger);
- color: var(--ee-color-white);
- font-size: var(--ee-font-size-bigger);
- font-weight: bold;
- line-height: 1rem;
- padding: .5rem;
- position: absolute;
- right: .75rem;
- text-align: center;
- top: .75rem;
-}
-
-#close-menu:hover {
- background: var(--ee-color-accent);
- border-color: var(--ee-color-accent);
- color: var(--ee-text-on-accent-high-contrast);
-}
-
-#toggle-menu {
- background: url('menu-icon-48.png');
- color: var(--ee-text-on-grey-4);
- height: 48px;
- position: relative;
- width: 48px;
- z-index: 15;
-}
-
-#toggle-menu span {
- position: absolute;
- clip: rect(1px, 1px, 1px, 1px);
- padding: 0;
- border: 0;
- height: 1px;
- width: 1px;
- overflow: hidden;
-}
-
-h1, h2, h3, h4, h5, h6 {
- font-weight: normal;
- margin: 0;
-}
-
-h1 {
- margin: var(--ee-margin-bigger) 0 var(--ee-margin-small);
-}
-
-h2 {
- margin: var(--ee-margin-big) 0 var(--ee-margin-small);
-}
-
-h3 {
- font-family: Impact, Haettenschweiler, "Franklin Gothic Bold", Charcoal, "Helvetica Inserat", "Bitstream Vera Sans Bold", "Arial Black", sans-serif;
- margin: var(--ee-margin-default) 0 var(--ee-margin-micro);
-}
-
-h4 {
- margin: var(--ee-margin-small) 0 var(--ee-margin-smaller);
-}
-
-h5 {
- margin: var(--ee-margin-smaller) 0 var(--ee-margin-smaller);
-}
-
-h6 {
- margin: var(--ee-margin-tiny) 0 var(--ee-margin-tiny);
-}
-
-ul {
- list-style: none;
- padding-inline-start: 0;
-}
-
-
-li {
- margin: 0 0 var(--ee-padding-smaller);
-}
-
-.intro {
- color: var(--ee-default-text-color-low-contrast);
-}
-
-.ee-container-title {
- text-align: center;
-}
-
-code {
- background-color: var(--ee-color-grey-12);
- border-radius: var(--ee-border-radius-small);
- text-shadow: none !important;
- color: var(--ee-default-text-color-super-high-contrast);
- display: inline-block;
- font-family: Consolas, "Andale Mono WT", "Andale Mono", "Lucida Console", "Lucida Sans Typewriter", "DejaVu Sans Mono", "Bitstream Vera Sans Mono", "Liberation Mono", "Nimbus Mono L", Monaco, "Courier New", Courier, monospace;
- font-size: var(--ee-font-size-smaller);
- padding: var(--ee-padding-micro) var(--ee-padding-tiny);
- margin: var(--ee-padding-micro) var(--ee-padding-micro);
- white-space: nowrap;
-}
-
-h4 code {
- padding: var(--ee-padding-micro) var(--ee-padding-smaller);
-}
-
-.demo-section {
- padding: 0;
-}
-
-.demo-items {
- display: flex;
- flex-flow: row wrap;
- justify-content: space-between;
-}
-
-.one-column .demo-item {
- width: 100%;
-}
-
-
-.two-columns .demo-item {
- width: 45%;
-}
-
-.three-columns .demo-item {
- width: 30%;
-}
-
-.four-columns .demo-item {
- width: 22.5%;
-}
-
-.demo-item {
- margin-bottom: var(--ee-margin-default);
-}
-
-.demo-swatch {
- margin: var(--ee-margin-smaller) 0;
-}
-
-.demo-box h2 {
- margin: var(--ee-margin-default);
-}
-
-.demo-section.hidden {
- display: none;
-}
-
-.demo-square-wrapper {
- /*background: var(--ee-color-grey-9);*/
- display: flex;
- flex-flow: row wrap;
-}
-.demo-square {
- background: var(--ee-color-primary);
- min-height: 60px;
- min-width: 60px;
-}
-.border-radius-demo .demo-square {
- background: none;
- min-height: 120px;
-}
-.padding-demo .demo-square {
- width: 100%;
-}
-
-
-.clear-float {
- clear: both;
-}
-
-.theme-color,
-.entity-status-heading {
- font-weight: bold;
-}
-
-.ee-container h4 {
- margin-top: 0;
-}
-
-
-.ee-container p {
- margin: 0;
-}
-
-.ee-container p + p {
- margin: var(--ee-margin-default) 0 0;
-}
-
-.ee-with-primary-color {
- color: var(--ee-color-primary);
-}
-
-.ee-with-secondary-color {
- color: var(--ee-color-secondary);
-}
-
-.ee-with-accent-color {
- color: var(--ee-color-accent);
-}
-
-
-
-.with-default-border {
- border: 1px solid var(--ee-border-color);
-}
-
-.with-default-border h4 {
- margin: 0;
-}
-
-.with-default-padding {
- padding: var(--ee-padding-smaller) var(--ee-padding-default);
-}
-.with-default-margin {
- margin: var(--ee-padding-default);
-}
-
-
-.with-border-radius-none {
- border-radius: var(--ee-border-radius-none);
-}
-.with-border-radius-small {
- border-radius: var(--ee-border-radius-small);
-}
-.with-border-radius-default {
- border-radius: var(--ee-border-radius-default);
-}
-.with-border-radius-big {
- border-radius: var(--ee-border-radius-big);
-}
-.with-border-radius-bigger {
- border-radius: var(--ee-border-radius-bigger);
-}
-.with-border-radius-huge {
- border-radius: var(--ee-border-radius-huge);
-}
-.with-border-radius-full {
- border-radius: var(--ee-border-radius-full);
-}
-
-
-
-
-/** margin sizes **/
-
-.with-margin-size-none {
- margin: 0;
-}
-.with-margin-size-micro {
- margin: var(--ee-margin-micro);
-}
-.with-margin-size-tiny {
- margin: var(--ee-margin-tiny);
-}
-.with-margin-size-smaller {
- margin: var(--ee-margin-smaller);
-}
-.with-margin-size-small {
- margin: var(--ee-margin-small);
-}
-.with-margin-size-default {
- margin: var(--ee-margin-default);
-}
-.with-margin-size-big {
- margin: var(--ee-margin-big);
-}
-.with-margin-size-bigger {
- margin: var(--ee-margin-bigger);
-}
-.with-margin-size-huge {
- margin: var(--ee-margin-huge);
-}
-.with-margin-size-extreme {
- margin: var(--ee-margin-extreme);
-}
-
-
-/** padding sizes **/
-
-.with-padding-size-none {
- padding: 0;
-}
-.with-padding-size-micro {
- padding: var(--ee-padding-micro);
-}
-.with-padding-size-tiny {
- padding: var(--ee-padding-tiny);
-}
-.with-padding-size-smaller {
- padding: var(--ee-padding-smaller);
-}
-.with-padding-size-small {
- padding: var(--ee-padding-small);
-}
-.with-padding-size-default {
- padding: var(--ee-padding-default);
-}
-.with-padding-size-big {
- padding: var(--ee-padding-big);
-}
-.with-padding-size-bigger {
- padding: var(--ee-padding-bigger);
-}
-.with-padding-size-huge {
- padding: var(--ee-padding-huge);
-}
-.with-padding-size-extreme {
- padding: var(--ee-padding-extreme);
-}
-
-
-
-.with-box-shadow-tiny {
- box-shadow: var(--ee-box-shadow-tiny);
-}
-.with-box-shadow-small {
- box-shadow: var(--ee-box-shadow-small);
-}
-.with-box-shadow-default {
- box-shadow: var(--ee-box-shadow-default);
-}
-.with-box-shadow-big {
- box-shadow: var(--ee-box-shadow-big);
-}
-
-
-.with-text-shadow-small {
- text-shadow: var(--ee-text-shadow-small);
-}
-.with-text-shadow-default {
- text-shadow: var(--ee-text-shadow-default);
-}
-.with-text-shadow-big {
- text-shadow: var(--ee-text-shadow-big);
-}
-
-
-/* Base Colors */
-
-/* magenta */
-
-.ee-with-color-magenta {
- background: var(--ee-color-magenta);
- color: var(--ee-text-on-magenta);
-}
-
-.ee-with-color-magenta-super-high-contrast {
- background: var(--ee-color-magenta-super-high-contrast);
- color: var(--ee-text-on-magenta-super-high-contrast);
-}
-
-.ee-with-color-magenta-high-contrast {
- background: var(--ee-color-magenta-high-contrast);
- color: var(--ee-text-on-magenta-high-contrast);
-}
-
-.ee-with-color-magenta-low-contrast {
- background: var(--ee-color-magenta-low-contrast);
- color: var(--ee-text-on-magenta-low-contrast);
-}
-
-.ee-with-color-magenta-super-low-contrast {
- background: var(--ee-color-magenta-super-low-contrast);
- color: var(--ee-text-on-magenta-super-low-contrast);
-}
-
-
-/* red */
-
-.ee-with-color-red {
- background: var(--ee-color-red);
- color: var(--ee-text-on-red);
-}
-
-.ee-with-color-red-super-high-contrast {
- background: var(--ee-color-red-super-high-contrast);
- color: var(--ee-text-on-red-super-high-contrast);
-}
-
-.ee-with-color-red-high-contrast {
- background: var(--ee-color-red-high-contrast);
- color: var(--ee-text-on-red-high-contrast);
-}
-
-.ee-with-color-red-low-contrast {
- background: var(--ee-color-red-low-contrast);
- color: var(--ee-text-on-red-low-contrast);
-}
-
-.ee-with-color-red-super-low-contrast {
- background: var(--ee-color-red-super-low-contrast);
- color: var(--ee-text-on-red-super-low-contrast);
-}
-
-
-/* hot-pink */
-
-.ee-with-color-hot-pink {
- background: var(--ee-color-hot-pink);
- color: var(--ee-text-on-hot-pink);
-}
-
-.ee-with-color-hot-pink-super-high-contrast {
- background: var(--ee-color-hot-pink-super-high-contrast);
- color: var(--ee-text-on-hot-pink-super-high-contrast);
-}
-
-.ee-with-color-hot-pink-high-contrast {
- background: var(--ee-color-hot-pink-high-contrast);
- color: var(--ee-text-on-hot-pink-high-contrast);
-}
-
-.ee-with-color-hot-pink-low-contrast {
- background: var(--ee-color-hot-pink-low-contrast);
- color: var(--ee-text-on-hot-pink-low-contrast);
-}
-
-.ee-with-color-hot-pink-super-low-contrast {
- background: var(--ee-color-hot-pink-super-low-contrast);
- color: var(--ee-text-on-hot-pink-super-low-contrast);
-}
-
-
-/* pink */
-
-.ee-with-color-pink {
- background: var(--ee-color-pink);
- color: var(--ee-text-on-pink);
-}
-
-.ee-with-color-pink-super-high-contrast {
- background: var(--ee-color-pink-super-high-contrast);
- color: var(--ee-text-on-pink-super-high-contrast);
-}
-
-.ee-with-color-pink-high-contrast {
- background: var(--ee-color-pink-high-contrast);
- color: var(--ee-text-on-pink-high-contrast);
-}
-
-.ee-with-color-pink-low-contrast {
- background: var(--ee-color-pink-low-contrast);
- color: var(--ee-text-on-pink-low-contrast);
-}
-
-.ee-with-color-pink-super-low-contrast {
- background: var(--ee-color-pink-super-low-contrast);
- color: var(--ee-text-on-pink-super-low-contrast);
-}
-
-
-/* coral */
-
-.ee-with-color-coral {
- background: var(--ee-color-coral);
- color: var(--ee-text-on-coral);
-}
-
-.ee-with-color-coral-super-high-contrast {
- background: var(--ee-color-coral-super-high-contrast);
- color: var(--ee-text-on-coral-super-high-contrast);
-}
-
-.ee-with-color-coral-high-contrast {
- background: var(--ee-color-coral-high-contrast);
- color: var(--ee-text-on-coral-high-contrast);
-}
-
-.ee-with-color-coral-low-contrast {
- background: var(--ee-color-coral-low-contrast);
- color: var(--ee-text-on-coral-low-contrast);
-}
-
-.ee-with-color-coral-super-low-contrast {
- background: var(--ee-color-coral-super-low-contrast);
- color: var(--ee-text-on-coral-super-low-contrast);
-}
-
-
-/* orange */
-
-.ee-with-color-orange {
- background: var(--ee-color-orange);
- color: var(--ee-text-on-orange);
-}
-
-.ee-with-color-orange-super-high-contrast {
- background: var(--ee-color-orange-super-high-contrast);
- color: var(--ee-text-on-orange-super-high-contrast);
-}
-
-.ee-with-color-orange-high-contrast {
- background: var(--ee-color-orange-high-contrast);
- color: var(--ee-text-on-orange-high-contrast);
-}
-
-.ee-with-color-orange-low-contrast {
- background: var(--ee-color-orange-low-contrast);
- color: var(--ee-text-on-orange-low-contrast);
-}
-
-.ee-with-color-orange-super-low-contrast {
- background: var(--ee-color-orange-super-low-contrast);
- color: var(--ee-text-on-orange-super-low-contrast);
-}
-
-
-/* gold */
-
-.ee-with-color-gold {
- background: var(--ee-color-gold);
- color: var(--ee-text-on-gold);
-}
-
-.ee-with-color-gold-super-high-contrast {
- background: var(--ee-color-gold-super-high-contrast);
- color: var(--ee-text-on-gold-super-high-contrast);
-}
-
-.ee-with-color-gold-high-contrast {
- background: var(--ee-color-gold-high-contrast);
- color: var(--ee-text-on-gold-high-contrast);
-}
-
-.ee-with-color-gold-low-contrast {
- background: var(--ee-color-gold-low-contrast);
- color: var(--ee-text-on-gold-low-contrast);
-}
-
-.ee-with-color-gold-super-low-contrast {
- background: var(--ee-color-gold-super-low-contrast);
- color: var(--ee-text-on-gold-super-low-contrast);
-}
-
-
-/* yellow */
-
-.ee-with-color-yellow {
- background: var(--ee-color-yellow);
- color: var(--ee-text-on-yellow);
-}
-
-.ee-with-color-yellow-super-high-contrast {
- background: var(--ee-color-yellow-super-high-contrast);
- color: var(--ee-text-on-yellow-super-high-contrast);
-}
-
-.ee-with-color-yellow-high-contrast {
- background: var(--ee-color-yellow-high-contrast);
- color: var(--ee-text-on-yellow-high-contrast);
-}
-
-.ee-with-color-yellow-low-contrast {
- background: var(--ee-color-yellow-low-contrast);
- color: var(--ee-text-on-yellow-low-contrast);
-}
-
-.ee-with-color-yellow-super-low-contrast {
- background: var(--ee-color-yellow-super-low-contrast);
- color: var(--ee-text-on-yellow-super-low-contrast);
-}
-
-
-/* yellow-green */
-
-.ee-with-color-yellow-green {
- background: var(--ee-color-yellow-green);
- color: var(--ee-text-on-yellow-green);
-}
-
-.ee-with-color-yellow-green-super-high-contrast {
- background: var(--ee-color-yellow-green-super-high-contrast);
- color: var(--ee-text-on-yellow-green-super-high-contrast);
-}
-
-.ee-with-color-yellow-green-high-contrast {
- background: var(--ee-color-yellow-green-high-contrast);
- color: var(--ee-text-on-yellow-green-high-contrast);
-}
-
-.ee-with-color-yellow-green-low-contrast {
- background: var(--ee-color-yellow-green-low-contrast);
- color: var(--ee-text-on-yellow-green-low-contrast);
-}
-
-.ee-with-color-yellow-green-super-low-contrast {
- background: var(--ee-color-yellow-green-super-low-contrast);
- color: var(--ee-text-on-yellow-green-super-low-contrast);
-}
-
-
-/* light-green */
-
-.ee-with-color-light-green {
- background: var(--ee-color-light-green);
- color: var(--ee-text-on-light-green);
-}
-
-.ee-with-color-light-green-super-high-contrast {
- background: var(--ee-color-light-green-super-high-contrast);
- color: var(--ee-text-on-light-green-super-high-contrast);
-}
-
-.ee-with-color-light-green-high-contrast {
- background: var(--ee-color-light-green-high-contrast);
- color: var(--ee-text-on-light-green-high-contrast);
-}
-
-.ee-with-color-light-green-low-contrast {
- background: var(--ee-color-light-green-low-contrast);
- color: var(--ee-text-on-light-green-low-contrast);
-}
-
-.ee-with-color-light-green-super-low-contrast {
- background: var(--ee-color-light-green-super-low-contrast);
- color: var(--ee-text-on-light-green-super-low-contrast);
-}
-
-
-/* green */
-
-.ee-with-color-green {
- background: var(--ee-color-green);
- color: var(--ee-text-on-green);
-}
-
-.ee-with-color-green-super-high-contrast {
- background: var(--ee-color-green-super-high-contrast);
- color: var(--ee-text-on-green-super-high-contrast);
-}
-
-.ee-with-color-green-high-contrast {
- background: var(--ee-color-green-high-contrast);
- color: var(--ee-text-on-green-high-contrast);
-}
-
-.ee-with-color-green-low-contrast {
- background: var(--ee-color-green-low-contrast);
- color: var(--ee-text-on-green-low-contrast);
-}
-
-.ee-with-color-green-super-low-contrast {
- background: var(--ee-color-green-super-low-contrast);
- color: var(--ee-text-on-green-super-low-contrast);
-}
-
-
-/* bright-green */
-
-.ee-with-color-bright-green {
- background: var(--ee-color-bright-green);
- color: var(--ee-text-on-bright-green);
-}
-
-.ee-with-color-bright-green-super-high-contrast {
- background: var(--ee-color-bright-green-super-high-contrast);
- color: var(--ee-text-on-bright-green-super-high-contrast);
-}
-
-.ee-with-color-bright-green-high-contrast {
- background: var(--ee-color-bright-green-high-contrast);
- color: var(--ee-text-on-bright-green-high-contrast);
-}
-
-.ee-with-color-bright-green-low-contrast {
- background: var(--ee-color-bright-green-low-contrast);
- color: var(--ee-text-on-bright-green-low-contrast);
-}
-
-.ee-with-color-bright-green-super-low-contrast {
- background: var(--ee-color-bright-green-super-low-contrast);
- color: var(--ee-text-on-bright-green-super-low-contrast);
-}
-
-
-/* dark-green */
-
-.ee-with-color-dark-green {
- background: var(--ee-color-dark-green);
- color: var(--ee-text-on-dark-green);
-}
-
-.ee-with-color-dark-green-super-high-contrast {
- background: var(--ee-color-dark-green-super-high-contrast);
- color: var(--ee-text-on-dark-green-super-high-contrast);
-}
-
-.ee-with-color-dark-green-high-contrast {
- background: var(--ee-color-dark-green-high-contrast);
- color: var(--ee-text-on-dark-green-high-contrast);
-}
-
-.ee-with-color-dark-green-low-contrast {
- background: var(--ee-color-dark-green-low-contrast);
- color: var(--ee-text-on-dark-green-low-contrast);
-}
-
-.ee-with-color-dark-green-super-low-contrast {
- background: var(--ee-color-dark-green-super-low-contrast);
- color: var(--ee-text-on-dark-green-super-low-contrast);
-}
-
-
-/* blue-green */
-
-.ee-with-color-blue-green {
- background: var(--ee-color-blue-green);
- color: var(--ee-text-on-blue-green);
-}
-
-.ee-with-color-blue-green-super-high-contrast {
- background: var(--ee-color-blue-green-super-high-contrast);
- color: var(--ee-text-on-blue-green-super-high-contrast);
-}
-
-.ee-with-color-blue-green-high-contrast {
- background: var(--ee-color-blue-green-high-contrast);
- color: var(--ee-text-on-blue-green-high-contrast);
-}
-
-.ee-with-color-blue-green-low-contrast {
- background: var(--ee-color-blue-green-low-contrast);
- color: var(--ee-text-on-blue-green-low-contrast);
-}
-
-.ee-with-color-blue-green-super-low-contrast {
- background: var(--ee-color-blue-green-super-low-contrast);
- color: var(--ee-text-on-blue-green-super-low-contrast);
-}
-
-
-/* blue */
-
-.ee-with-color-blue {
- background: var(--ee-color-blue);
- color: var(--ee-text-on-blue);
-}
-
-.ee-with-color-blue-super-high-contrast {
- background: var(--ee-color-blue-super-high-contrast);
- color: var(--ee-text-on-blue-super-high-contrast);
-}
-
-.ee-with-color-blue-high-contrast {
- background: var(--ee-color-blue-high-contrast);
- color: var(--ee-text-on-blue-high-contrast);
-}
-
-.ee-with-color-blue-low-contrast {
- background: var(--ee-color-blue-low-contrast);
- color: var(--ee-text-on-blue-low-contrast);
-}
-
-.ee-with-color-blue-super-low-contrast {
- background: var(--ee-color-blue-super-low-contrast);
- color: var(--ee-text-on-blue-super-low-contrast);
-}
-
-
-/* dark-blue */
-
-.ee-with-color-dark-blue {
- background: var(--ee-color-dark-blue);
- color: var(--ee-text-on-dark-blue);
-}
-
-.ee-with-color-dark-blue-super-high-contrast {
- background: var(--ee-color-dark-blue-super-high-contrast);
- color: var(--ee-text-on-dark-blue-super-high-contrast);
-}
-
-.ee-with-color-dark-blue-high-contrast {
- background: var(--ee-color-dark-blue-high-contrast);
- color: var(--ee-text-on-dark-blue-high-contrast);
-}
-
-.ee-with-color-dark-blue-low-contrast {
- background: var(--ee-color-dark-blue-low-contrast);
- color: var(--ee-text-on-dark-blue-low-contrast);
-}
-
-.ee-with-color-dark-blue-super-low-contrast {
- background: var(--ee-color-dark-blue-super-low-contrast);
- color: var(--ee-text-on-dark-blue-super-low-contrast);
-}
-
-
-/* bright-blue */
-
-.ee-with-color-bright-blue {
- background: var(--ee-color-bright-blue);
- color: var(--ee-text-on-bright-blue);
-}
-
-.ee-with-color-bright-blue-super-high-contrast {
- background: var(--ee-color-bright-blue-super-high-contrast);
- color: var(--ee-text-on-bright-blue-super-high-contrast);
-}
-
-.ee-with-color-bright-blue-high-contrast {
- background: var(--ee-color-bright-blue-high-contrast);
- color: var(--ee-text-on-bright-blue-high-contrast);
-}
-
-.ee-with-color-bright-blue-low-contrast {
- background: var(--ee-color-bright-blue-low-contrast);
- color: var(--ee-text-on-bright-blue-low-contrast);
-}
-
-.ee-with-color-bright-blue-super-low-contrast {
- background: var(--ee-color-bright-blue-super-low-contrast);
- color: var(--ee-text-on-bright-blue-super-low-contrast);
-}
-
-
-/* light-blue */
-
-.ee-with-color-light-blue {
- background: var(--ee-color-light-blue);
- color: var(--ee-text-on-light-blue);
-}
-
-.ee-with-color-light-blue-super-high-contrast {
- background: var(--ee-color-light-blue-super-high-contrast);
- color: var(--ee-text-on-light-blue-super-high-contrast);
-}
-
-.ee-with-color-light-blue-high-contrast {
- background: var(--ee-color-light-blue-high-contrast);
- color: var(--ee-text-on-light-blue-high-contrast);
-}
-
-.ee-with-color-light-blue-low-contrast {
- background: var(--ee-color-light-blue-low-contrast);
- color: var(--ee-text-on-light-blue-low-contrast);
-}
-
-.ee-with-color-light-blue-super-low-contrast {
- background: var(--ee-color-light-blue-super-low-contrast);
- color: var(--ee-text-on-light-blue-super-low-contrast);
-}
-
-
-/* violet */
-
-.ee-with-color-violet {
- background: var(--ee-color-violet);
- color: var(--ee-text-on-violet);
-}
-
-.ee-with-color-violet-super-high-contrast {
- background: var(--ee-color-violet-super-high-contrast);
- color: var(--ee-text-on-violet-super-high-contrast);
-}
-
-.ee-with-color-violet-high-contrast {
- background: var(--ee-color-violet-high-contrast);
- color: var(--ee-text-on-violet-high-contrast);
-}
-
-.ee-with-color-violet-low-contrast {
- background: var(--ee-color-violet-low-contrast);
- color: var(--ee-text-on-violet-low-contrast);
-}
-
-.ee-with-color-violet-super-low-contrast {
- background: var(--ee-color-violet-super-low-contrast);
- color: var(--ee-text-on-violet-super-low-contrast);
-}
-
-
-/* purple */
-
-.ee-with-color-purple {
- background: var(--ee-color-purple);
- color: var(--ee-text-on-purple);
-}
-
-.ee-with-color-purple-super-high-contrast {
- background: var(--ee-color-purple-super-high-contrast);
- color: var(--ee-text-on-purple-super-high-contrast);
-}
-
-.ee-with-color-purple-high-contrast {
- background: var(--ee-color-purple-high-contrast);
- color: var(--ee-text-on-purple-high-contrast);
-}
-
-.ee-with-color-purple-low-contrast {
- background: var(--ee-color-purple-low-contrast);
- color: var(--ee-text-on-purple-low-contrast);
-}
-
-.ee-with-color-purple-super-low-contrast {
- background: var(--ee-color-purple-super-low-contrast);
- color: var(--ee-text-on-purple-super-low-contrast);
-}
-
-
-/* indigo */
-
-.ee-with-color-indigo {
- background: var(--ee-color-indigo);
- color: var(--ee-text-on-indigo);
-}
-
-.ee-with-color-indigo-super-high-contrast {
- background: var(--ee-color-indigo-super-high-contrast);
- color: var(--ee-text-on-indigo-super-high-contrast);
-}
-
-.ee-with-color-indigo-high-contrast {
- background: var(--ee-color-indigo-high-contrast);
- color: var(--ee-text-on-indigo-high-contrast);
-}
-
-.ee-with-color-indigo-low-contrast {
- background: var(--ee-color-indigo-low-contrast);
- color: var(--ee-text-on-indigo-low-contrast);
-}
-
-.ee-with-color-indigo-super-low-contrast {
- background: var(--ee-color-indigo-super-low-contrast);
- color: var(--ee-text-on-indigo-super-low-contrast);
-}
-
-
-/* black */
-
-.ee-with-color-black {
- background: var(--ee-color-black);
- color: var(--ee-text-on-black);
-}
-
-
-/* white */
-
-.ee-with-color-white {
- background: var(--ee-color-white);
- color: var(--ee-text-on-white);
-}
-
-
-.ee-with-color-grey-1 { background: var(--ee-color-grey-1); color: var(--ee-text-on-grey-1); }
-.ee-with-color-grey-2 { background: var(--ee-color-grey-2); color: var(--ee-text-on-grey-2); }
-.ee-with-color-grey-3 { background: var(--ee-color-grey-3); color: var(--ee-text-on-grey-3); }
-.ee-with-color-grey-4 { background: var(--ee-color-grey-4); color: var(--ee-text-on-grey-4); }
-.ee-with-color-grey-5 { background: var(--ee-color-grey-5); color: var(--ee-text-on-grey-5); }
-.ee-with-color-grey-6 { background: var(--ee-color-grey-6); color: var(--ee-text-on-grey-6); }
-.ee-with-color-grey-7 { background: var(--ee-color-grey-7); color: var(--ee-text-on-grey-7); }
-.ee-with-color-grey-8 { background: var(--ee-color-grey-8); color: var(--ee-text-on-grey-8); }
-.ee-with-color-grey-9 { background: var(--ee-color-grey-9); color: var(--ee-text-on-grey-9); }
-.ee-with-color-grey-10 { background: var(--ee-color-grey-10); color: var(--ee-text-on-grey-10); }
-.ee-with-color-grey-11 { background: var(--ee-color-grey-11); color: var(--ee-text-on-grey-11); }
-.ee-with-color-grey-12 { background: var(--ee-color-grey-12); color: var(--ee-text-on-grey-12); }
-.ee-with-color-grey-13 { background: var(--ee-color-grey-13); color: var(--ee-text-on-grey-13); }
-.ee-with-color-grey-14 { background: var(--ee-color-grey-14); color: var(--ee-text-on-grey-14); }
-.ee-with-color-grey-15 { background: var(--ee-color-grey-15); color: var(--ee-text-on-grey-15); }
-
-
-/* Media Queries for specific screen sizes
- * -------------------------------------------------------------------------*/
-
-@media only screen and (max-width: 1920px) {
-}
-
-@media only screen and (max-width: 1600px) {
-}
-
-@media only screen and (max-width: 1366px) {
-}
-
-@media only screen and (max-width: 1280px) {
-}
-
-@media only screen and (max-width: 1024px) {
-}
-
-/* WordPress Admin Media Query Breakpoint: Auto-folding of the admin menu */
-@media only screen and (max-width: 960px) {
-}
-
-/* WordPress Admin Media Query Breakpoint: one column on the post write/edit screen */
-@media only screen and (max-width: 850px) {
-}
-
-/* WordPress Admin Media Query Breakpoint: Tablet */
-@media screen and ( max-width: 782px ) {
-
- .two-columns .demo-item,
- .three-columns .demo-item {
- width: 100%;
- }
-
- .four-columns .demo-item {
- width: 48%;
- }
-}
-
-/* tall Smartphone in portrait mode */
-@media screen and ( min-width: 600px ) and ( max-height: 600px ) {
-
- .isActive #menu {
- box-shadow: unset;
- columns: 2;
- -webkit-columns: 2;
- -moz-columns: 2;
- height: 100vh;
- left: 0;
- margin: 0;
- top: 0;
- width: 100%;
- }
-
- #close-menu {
- display: none;
- }
-}
-
-/* WordPress Admin Media Query Breakpoint: Smartphone */
-@media screen and (max-width: 600px) {
-
- body {
- font-size: var(--ee-font-size-smaller);
- }
-
- .wrapper {
- max-width: 100%;
- padding: 0 var(--ee-padding-small);
- }
-
- header.isActive .wrapper {
- height: 100vh;
- overflow-y: scroll;
- -webkit-overflow-scrolling: touch;
- width: 100%
- }
-
- header h4 {
- text-align: center;
- white-space: normal;
- }
-
- h1 {
- font-size: var(--ee-font-size-huge);
- margin: var(--ee-padding-big) 0 var(--ee-padding-small);
- }
-
- h2 {
- font-size: var(--ee-font-size-bigger);
- margin: var(--ee-padding-default) 0 var(--ee-padding-micro);
- }
-
- h3 {
- font-size: var(--ee-font-size-big);
- margin: var(--ee-padding-small) 0 var(--ee-padding-smaller);
- }
-
- h4 {
- font-size: var(--ee-font-size-default);
- margin: var(--ee-padding-smaller) 0 var(--ee-padding-smaller);
- }
-
- .isActive #navigation {
- height: 100vh;
- left: 0;
- min-width: 320px;
- order: 1;
- overflow-y: scroll;
- -webkit-overflow-scrolling: touch;
- position: absolute;
- top: var(--ee-padding-smaller);
- width: 100%
- }
-
- .isActive #menu {
- box-shadow: unset;
- height: 100vh;
- left: unset;
- margin: 0;
- min-width: 320px;
- position: relative;
- top: unset;
- width: 100%
- }
-
- .isActive #toggle-menu {
- right: 1rem;
- position: absolute;
- top: 1rem;
- }
-
- #close-menu {
- display: none;
- }
-
- code {
- white-space: normal;
- }
- .demo-items {
- flex-flow: column nowrap;
- }
- .two-columns .demo-item,
- .three-columns .demo-item,
- .four-columns .demo-item {
- width: 100%;
- }
-
-}
-
-@media only screen and (max-width: 480px) {
-
- body {
- font-size: var(--ee-font-size-small);
- }
-
- .wrapper {
- padding: 0 var(--ee-padding-smaller);
- }
-
-}
-
-@media only screen and (max-width: 360px) {
-}
-
diff --git a/bin/css-builder/demo-templates/entity-status-group.html b/bin/css-builder/demo-templates/entity-status-group.html
deleted file mode 100644
index e1d55417372..00000000000
--- a/bin/css-builder/demo-templates/entity-status-group.html
+++ /dev/null
@@ -1,6 +0,0 @@
-{{entityName}} Status Colors
-
- {{#each entityItems}}
- {{{this}}}
- {{/each}}
-
\ No newline at end of file
diff --git a/bin/css-builder/demo-templates/entity-status-section.html b/bin/css-builder/demo-templates/entity-status-section.html
deleted file mode 100644
index cc6c5752927..00000000000
--- a/bin/css-builder/demo-templates/entity-status-section.html
+++ /dev/null
@@ -1,14 +0,0 @@
-
- Entity Status Colors
- These are status colors for various Event Espresso model entities. The following schema is used for the class names:
-
- .ee-status-color-{status_code}
- The text color will be set for the given status code..ee-status-background-color-{status_code}
- The background color will be set for the given status code and the text color will be set to a WCAG
- compliant contrast
- {{#each entityGroups}}
- {{{this}}}
- {{/each}}
-
\ No newline at end of file
diff --git a/bin/css-builder/demo-templates/entity-status-template.html b/bin/css-builder/demo-templates/entity-status-template.html
deleted file mode 100644
index d4bfdac71ca..00000000000
--- a/bin/css-builder/demo-templates/entity-status-template.html
+++ /dev/null
@@ -1,20 +0,0 @@
-
-
- {{ statusLabel }} ({{ statusCode }})
-
-
-
-
- .ee-status-color-{{ statusCode }}
- sets the text color to the corresponding color for an entity with a status code of "{{statusCode}}"
- just like the heading above this container.
-
-
- .ee-status-background-color-{{ statusCode }}
- sets the background color to the corresponding color for an entity with a status code of
- "{{statusCode}}" and sets the text color to a WCAG compliant contrast for this color, just like
- this container and text you are reading now.
-
-
-
-
-
-
.ee-focus-priority-{{ priority }}
- {{{ desc }}}
-
CSS variables used:
-
- --ee-font-size-{{ size }}{{ color }}
-
- {{ example }}
-
-
-
-
-
- Introduction
-
- With the arrival of the WordPress Gutenberg Editor, Event Espresso has been transitioning to a
- presentation layer powered by JavaScript and React. Part of this transition is the development of a new
- CSS foundation that utilizes theming and CSS variables for applying styles to HTML elements. This
- document is a demonstration of this new system and utilizes styles from the dynamically generated
- {{themeName}} Theme
-
- {{#each demoSections}}
- {{{this}}}
- {{/each}}
-
-
-
-
--ee-margin-size-{{size}}
-
-
-
--ee-padding-size-{{size}}
-
-
Shadows
-
- Themes have no capacity to control shadow sizes for text or boxes, so if you want to get fancy... just do it
- yourself ;p
But just because we're so nice (and getting paid) we have provided four sizes of box shadow and
- three sizes of text shadow you can use via the following CSS variables:
-
-
- {{#each sectionItems}}
- {{{this}}}
- {{/each}}
-
-
\ No newline at end of file
diff --git a/bin/css-builder/demo-templates/shadows-template.html b/bin/css-builder/demo-templates/shadows-template.html
deleted file mode 100644
index 79c82f079ff..00000000000
--- a/bin/css-builder/demo-templates/shadows-template.html
+++ /dev/null
@@ -1,10 +0,0 @@
-
-
--ee-box-shadow-{{size}}
-
- {{#if notTiny}}
-
this text has --ee-text-shadow-{{size}} applied to it
- {{else}}
-
sorry... no --ee-text-shadow-{{size}} size
- {{/if}}
-
-
Font-Sizes
-
- Having text that meets WCAG requirements does not just mean using contrasting colors, as there is
- also an interaction with the size of the font. Smaller fonts require colors that have a higher contrast
- compared to the background color they are placed on. Although not a technical requirement, line-height and
- spacing can also affect readability, especially with smaller font sizes.
-
-
- To make it as easy as possible to maintain accessibility as well as a harmonious design aesthetic, we have
- combined several CSS properties together using the semantically relevant "focus-priority" class name. The
- "focus-priority" classes range in value from .ee-focus-priority-1 to
- .ee-focus-priority-9 and represent the visual hierarchy that you wish to impart on your
- application. Elements with a higher "focus-priority" are ones that a user should see and read first and
- therefore use larger font sizes, but can get away with using lower contrast colors. Elements with a
- lower "focus-priority" are ones that a user should see or read after other elements and utilize smaller font
- sizes, but higher contrast colors to remain accessible. This of course is subjective and these styles can be
- applied solely to adjust appearance as desired.
-
-
- {{#each fontSizes}}
- {{{this}}}
- {{/each}}
-
- Margin Sizes
-
- Each theme can specify a marginDefault property which gets applied to a set of default margin
- sizes to dynamically generate a total of 9 margin sizes. If themes require more control, they can also define
- all of the marginSizeModifiers separately. The results are the following CSS variables:
-
-
- {{#each marginSizes}}
- {{{this}}}
- {{/each}}
-
- Padding Sizes
-
- Each theme can specify a paddingDefault property which gets applied to a set of default padding
- sizes to dynamically generate a total of 9 padding sizes. If themes require more control, they can also define
- all of the paddingSizeModifiers separately. The results are the following CSS variables:
-
-
- {{#each paddingSizes}}
- {{{this}}}
- {{/each}}
-
- Border Radius-Sizes
-
- Each theme can specify a radiusDefault property which gets applied to a set of default radius
- sizes to dynamically generate a total of 5 radius sizes. If themes require more control, they can also define
- all of the radiusSizeModifiers separately. The results are the following CSS variables:
-
-
- {{#each radiusSizes}}
- {{{this}}}
- {{/each}}
-
-
diff --git a/bin/css-builder/demo-templates/theme-color-template.html b/bin/css-builder/demo-templates/theme-color-template.html
deleted file mode 100644
index 16cd967767d..00000000000
--- a/bin/css-builder/demo-templates/theme-color-template.html
+++ /dev/null
@@ -1,8 +0,0 @@
-
-
{{colorLabel}} Theme Color
-
-
{{colorLabel}} background color
+ WCAG compliant text
- color
-
{{{desc}}}
-
-
- ex: if an optional method parameter is intended to be a string,
- then use `""` (empty string) for the default instead of `null` or `false`
- This is especially important for return types in order to minimize the amount of type checking that client
- code has to perform after receiving a value from a method
- * All comparisons should be using type safe equivalents
- ex: `===` vs `==` or `in_array($int, $array, true)` vs `in_array($int, $array)`
-
-
-### Formatting Overview
-
- * all files are formatted according to the PSR specifications
- * names for classes and interfaces follow StudlyCaps formatting (unless a legacy system requires a different naming convention). Interfaces should include the word "Interface" at the end (see: [PSR Naming Conventions](http://www.php-fig.org/bylaws/psr-naming-conventions/))
- * names for methods and functions follow camelCase formatting (unless a legacy system required a different naming convention)
- * names for variables follow snake_case formatting
- * classes and interfaces have phpdoc comment blocks that contain:
- * a brief description of their purpose
- * an @package tag to indicate the vendor or plugin that the code belongs to
- * an @author tag to indicate the specific dev that first created the class
- * an @since tag listing the version that the code was first added
- * methods and functions have phpdoc comment blocks that contain:
- * a brief description of their purpose (not always necessary for really simple/small blocks of code)
- * a list of all parameters and their data types
- * an @return tag if applicable
- * an @throws tag for each exception type that could be thrown as a result of calling the function
-
-
-### Translations
- * ALL strings displayed to users through PHP should be translated using `esc_html__()` or a suitable equivalent (avoid `__()` and `_e()` as they allow translators to add malicious Javascript); strings passed to client side Javascript (eg through `wp_localize_script()`) should instead be ran through `wp_strip_all_tags()` (as [client-side Javascript can sometimes UNescape the tags](https://github.com/eventespresso/event-espresso-core/pull/1278#issuecomment-544772217)).
- * Instead of putting "Event Espresso" in translated strings, use a placeholder and `EventEspresso\core\domain\Domain::brandName()`. Eg `printf(esc_html__('Thanks for installing %1$s!', 'event_espresso'), EventEspresso\core\domain\Domain::brandName());`.
- * You should almost never need to put HTML tags into a translated string. Put HTML outside of the translated string (eg ``) or use placeholders (eg `printf(esc_html__('Use %1$sthis link%2$s to get a special surprise!', 'event_espresso'), '', '');`
- * When translating strings with multiple placeholders, use [numbered placeholders (eg "$1$s")](https://codex.wordpress.org/I18n_for_WordPress_Developers#Placeholders) instead of simple placeholders (eg "%s").
- * Also when there are multiple placeholders, be sure to add a translators comment like so:
-
- ```php
-// translators: 1: group affiliation, eg "Rebel" or "Imperial", 2: name of planet, eg "Alderan" or "Tatooine".
-__('The %1$s base is on %2$s', 'event_espresso');
-```
- * Add translator comments to other strings where you think it would be helpful to a translator.
- * Use `esc_html_x()` (or other `_x()` family functions) where that string could be translated differently in different contexts. Eg
- ```php
-
- ...
-
- After the event is over, we're all going to Tim Horton's for some donuts...
- ```
-Notice it's the same translated string with different meanings depending on the context. In French, the first should be translated like "Publier l'รฉvรฉnement" and the second as "Aprรจs l'รฉvรฉnement". In order to allow translators to translate them differently, you must use `esc_html_x()`, like so:
-```php
-
- ...
-
- After the event is over, we're all going to Tim Horton's for some donuts...
- ```
- * Sometimes translated strings will be longer than the Code Sniffer's allowed line length. That's normal. Don't add line breaks to fix it, instead just add special comments to indicate the Code Sniffer line length rule should be disabled.
- ```php
-// ๐ like this
-//phpcs:disable Generic.Files.LineLength.TooLong
-echo esc_html__('This line is too long. But itโs ok. Donโt try breaking it into multiple lines. Just add that comment to tell the Code Sniffer to ignore that rule for now.', 'event_espresso');
-//phpcs:enable
-
-// ๐ก not like this!
-echo esc_html__('Itโs better than adding a bunch
- of line breaks which will probably
- drive translators nuts.',
- 'event_espresso'
- );
-```
- * Be kind to translators and avoid "breaking translations" (invalidating existing translations by changing the translated text). The following will break translations:
- * changing placeholders from "%s" to "$1$s"
- * changing `esc_html__()` calls to `esc_html_x()`
- * breaking a long string into multiple shorter ones (eg changing `esc_html__('some very very long string', 'event_espresso');` to `esc_html__('some' . ' very' . ' very' . ' long' . ' string', 'event_espresso');`)
- * changing an existing translation's context (eg changing `esc_html_x('Post event', 'after the event', 'event_espresso');` to `esc_html_x('Post event', 'subsequent the event', 'event_espresso');`)
- * But note that it's OK to change `__()` to `esc_html__()` (it won't break translations)
-
-### Design and Architecture
-
- * classes, methods, or functions should not be too large. Extract logic into more granular chunks if need be
- * dependencies that are required by a class should be injected into the constructor
- * optional dependencies can be injected into the constructor or via setters
- * static state should be avoided like the plague
- * non-legacy classes should follow PSR-4 compatible namespacing
- * folders are named using snake_case
- * use `use` statements for all classnames in a file and simplify namespaces in phpdocs. These should be before all other code except a `namespace` statement, if there is one. Do not add leading slashes to indicate global namespace.
- * can design patterns be utilized to provide a more eloquent versatile solution?
- * code should be DRY and not duplicate existing code
- * code should strive to follow the S.O.L.I.D. principles:
- * **S** - Single Responsibility Principle: each class should focus on doing ONE thing only and all functionality should be related to that one thing
- * **O** - Open-Closed Principle: Class internals should be hidden as much as possible. To add new functionality, write new class extensions instead of modifying existing code, ie: substitute OldClass with OldClassPlusLasers (which extends OldClass). Interfaces allow the substitution.
- * **L** - Liskov Substitution Principle: parent/child classes should be interchangeable, ie: OldClass parent or OldClassPlusLasers child class should both be usable by classes implementing their interface
- * **I** - Interface Segregation Principle: avoid big interfaces, use multiple smaller ones describing more granular behaviour so that classes don't have to implement methods they don't support.
- * **D** - Dependency Inversion Principle: inject dependencies into classes so they can be externally controlled. Required dependencies should use constructor injection, and optional dependencies can use setter injection.
-
-
-### Backwards Compatibility
-
- * code should strive to be backwards compatible
- * classes, interfaces, methods, or functions that are no longer required should be deprecated instead of removed, and logic should be forwarded to replacements where applicable
-
-
-
-### Yoda Conditionals.
-
-See the [WordPress handbook for an example and info on what this is](http://make.wordpress.org/core/handbook/coding-standards/php/#yoda-conditions). We have decided to not adopt the use of yoda conditionals in our code.
-
-### DRY (Don't Repeat Yourself)
-
-Most developers will be familiar with this principle. If you find yourself writing code repeatedly consider whether its something that can be abstracted for reusability.
-
-Consider the following bad example.
-
-```php
-function increment_foo($foo){
- return $foo++;
-}
-function increment_bar($bar){
- return $bar++;
-}
-```
-
-Notice how these two methods `increment_foo()` and `increment_bar()` are basically doing the same thing - take an incoming variable and increment it by one. The DRY way to do this is simply:
-
-```php
-function increment( $item ) {
- return $item+=1
-}
-```
-
-Now this is probably an overtly obvious example of the DRY principle but it does illustrate what we mean. The less code you write the less there is to maintain. In this example we have one function that does incrementation and thus we only have to maintain that one function going forward. DRY also leads to more bug free code, however when there are bugs, they are generally easier to fix because instead of fixing a bug in multiple places, you are more likely to only need to fix in one. ([more reading on DRY here](http://programmer.97things.oreilly.com/wiki/index.php/Don't_Repeat_Yourself))
-
-### Favor OOP over procedural
-
-One of the major decisions made early in the development of Event Espresso 4, was to use general OOP (Object Oriented Programming) principles in the refactor. What this means is that when designing and implementing systems, we favoured using classes and objects over global scope functions and global variables. This allows for clear separation of concerns and more testable and reusable code.
-
-## Naming Conventions
-
-### Function Naming
-
-Any functions not found in a class should be prefixed with `espresso_`. An example of this in use is the `espresso_version()` function.
-
-# Legacy Class Naming
-
-> This only applies to legacy class naming- all new classes should follow [Formatting Overview](#formatting-overview).
-
-All classes for Event Espresso should be prefixed with `EE_`. An example of this in use is the `EE_Base_Class`. Note, there are some other important naming schemas related to classes:
-
-Type of Class | Naming Schema | Description | Example
-------------- | ------------- | ----------- | -------
-Regular | EE_{class_name} | This is a class that is not a part of any system or library OR a core class. | EE_Registry
-DB Model | EEM_{class_name} | These are part of the EE model system. | EEM_Event
-DB Model Object (entity) | EE_{class_name} | These are part of the EE Model system. You can differentiate these from Regular classes in that Model Objects always extend the `EE_Base_Class` | EE_Event
-Helper | EEH_{class_name} | Helper Classes. These classes usually contain static methods and are typically used for "helper" type methods. | EEH_Template
-Admin | {class_name}_Admin_Page or {class_name}_Admin_Page_Init | These classes are a part of the EE Admin system | Event_Admin_Page or Event_Admin_Page_Init
-CPT Strategy | EE_CPT_{class_name}_Strategy | Any class related to CPT's and Custom Taxonomies | EE_CPT_Event_Strategy
-Data Migration | EE_DMS_{version_migration} | Classes used for Data Migration | EE_DMS_4_1_0
-Messages Data Handler | EE_Messages_{data_source}_incoming_data | These are the data handler classes for the Messages system. | EE_Messages_Gateways_incoming_data
-Messages Template Defaults | EE_Messages_{messenger}_{message_type}_Defaults | These classes define the defaults for the message templates | EE_Messages_Email_Cancelled_Registration_Defaults
-Messages Message Type | EE_{message_type}_message_type | These classes represent message types. | EE_Cancelled_Registration_message_type
-Messages Messenger | EE_{messenger}_messenger | These classes represent a messages system messenger | EE_Email_messenger
-Messages Validators | EE_Messages_{messenger}_{message_type}_Validator | These classes represent the messages system validators (validate fields and shortcodes in templates) | EE_Email_Cancelled_Registration_Validator
-Modules | EED_{Module_Name} | These classes are part of the EE Module system | EED_Event_Single
-General Shortcodes (using WordPress shortcodes system) | EES_{Shortcode_Name} | These classes define and handle the various EE shortcodes. | EES_Espresso_Cancelled
-Widgets | EEW_{Widget_Name} | These classes define and implement various EE Widgets for the WordPress widget system. | EEW_Upcoming_Events
-
-### Class Property Method and Property Schema
-
-> This only applies to legacy method and property naming- all new methods and properties should follow [Formatting Overview](#formatting-overview).
-
-All private or protected properties or methods are prefixed with an underscore. Example Property: `$this->_property`. Example method: `function _method()`.
-
-All public properties or methods are not prefixed with an underscore. Example property: `$this->property`. Example method: `function method() {}`.
-
-### File Naming Schema
-
-> This only applies to legacy file naming- all new classes should be the class' name followed with `.php`.
-
-File Type | Schema | Description | Example
---------- | ------ | ----------- | -------
-Regular | .php | As with normal php rules. All php files end with the `.php` extension | espresso.php
-Core | .core.php | Core Classes (usually parent or "main" classes) | EE_Error.core.php
-Template | template.php | Any template related code goes into a file with this extension | whats_new.template.php
-Help Tabs | .help_tab.php | Files containing classes for the EE Help Tab system. | event_editor.help_tab.php
-Non Specific Class | .class.php | Anything with a "class" extension contains a class (or classes). | Events_Admin.class.php
-Library | .lib.php | Used for classes that are a part of a library. | EE_Event_Editor_Decaf_Tips.lib.php
-Migration Scripts | .dms.php | Contains a data migration script class. | EE_DMS_4_1_0.dms.php
-Model | .model.php | Contains a model class. | EEM_Answer.model.php
-Helper | .helper.php | Contains a helper class. | EEH_DTT_Helper.helper.php
-Module | .module.php | Contains a module class. | EED_Event_Single.module.php
-Shortcodes | .shortcode.php | Contains an EE Shortcode Class | EES_Espresso_Events.shortcode.php
-Widgets | .widget.php | Contains a widget class. | EEW_Upcoming_Events.widget.php
-
-## White Space
-
-Please refer to the [PSR-2 Coding Standards](http://www.php-fig.org/psr/psr-2/) and use the [PSR Code Sniffer](https://github.com/squizlabs/PHP_CodeSniffer) to verify your code meets our coding standards.
-
-## PHP In Templates
-
-In general, try to restrict usage of PHP code in templates to only using: `if`, `else`, `foreach`, `echo`. Generally there should be no assigning of variables (except maybe an iteration counter). There should definitely be no SQL queries, requires, or definition of any functions. Also, define all the variables in the template requires at the beginning of the file and briefly explain what they are expected to contain.
-
-```php
-
-
-
get('EVT_name'); ?>
-
-
- - Ticket: get('TKT_name'); ?>
-
-
-