CHANGELOG.md

Changelog

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

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

Added

Changed

Fixed

[3.3.3] - 2023-12-18

Added

• Shipment API voidWaybillShipment and voidReturnWaybillShipment

[3.3.2] - 2023-12-14

Added

• Shipment API refreshShippingShipment and createReturnWaybillShipment

[3.3.1] - 2023-10-30

Added

• Added create documents for shipping API - ripe-pulse/#396

[3.3.0] - 2023-10-18

Added

• Added waybill and invoice creation methods to the ShipmentAPI - #4853
• Added shipment attachment methods to the ShipmentAPI - #4853
• Added shipment status change methods to the ShipmentAPI - #4853
• Added shipment notes and issues methods - ripe-pulse/#396

[3.2.0] - 2023-08-22

Added

• Admin Event API module - ripe-core/#4828

[3.1.0] - 2023-08-22

Added

• Added composeUrl option to allow custom for composition endpoints - products/#132

Changed

• Change API testing provider from httpbin to postman-echo

[3.0.1] - 2023-05-19

Added

• Added sku and domain fields to import order - ripe-core/#4798

Changed

• Remove Travis CI - products/#97

Fixed

• Fixed configurator ignoring size even with passing useDefaultSize with false - #511

[3.0.0] - 2023-03-30

Added

• Add browserify, esmify, babelify, vinyl-buffer and vinyl-source-stream dev dependencies - #491
• Support ES Modules - #491

Changed

• Upgrade workflows's node engine version
• Reduced import hacks - #491
• Remove __VERSION__ references - #491
• Remove mark script - #491
• Update Three.js version to 150.1 - #491
• Update @babel/core to 7.21.0 - #491
• Removed unused gulp-babel, gulp-concat and gulp-replace dev dependencies - #491

Fixed

• Fix package not loading Three.js - #491
• Fix build not including all code when generating the bundle - #491

[2.40.0] - 2023-03-08

Added

• Add CSR base documentation - #478
• Add CSR documentation Dockerfile - #478

Changed

• Update initialsConfig() to match remote logic - #429
• Update .gitignore to ignore CSR documentation compilation files - #478
• Update CSR documentation with proper configuration with title and logo - #478
• Improve CSR deinitialization logic - #493
• Load environment file based on config - 499

Fixed

• Fix div tag outside code block in CSR documentation - #478

[2.39.0] - 2023-02-24

Added

• Allowing set initials extra of empty or single group initials in configurator csr - ripe-white/#1098

[2.38.0] - 2023-02-24

Added

• Add id and origin to ready event params to distinguish events from configurator prc and csr - ripe-white/#1098
• Add initialsConfig method - #479
• Add #initialsConfig() tests - #479

Changed

• Reuse Draco loader instance - #481
• Removed draco_decoder.js dependency - #481
• Use initialsConfig() in CSR - #479

Fixed

• Fix meshes compressed with Draco not loading properly - #481

[2.37.0] - 2023-02-14

Added

• Support font format in CSR strategy - #429

Changed

• Updated CSR strategy to follow the changes of the updated config - #429
• Improve CSR loading methodology - #429

[2.36.0] - 2023-02-10

Added

• Add support for post render callback - #429
• Add support for param imagesDefault - ripe-core/#4778
• Add support for global option authCallback and improve overall behavior, allowing one request authentication - ripe-robin-revamp/#416
• Add getInitialsConfig , getInitialsConfigP and _getInitialsConfigOptions methods - #429
• Load enriched initials config in CSR - #429
• Support loading of external fonts - #429

Changed

• Returning authCallback when requests fails authentication to allow one auth call. - ripe-robin-revamp/#416

Fixed

• Fix failing tests by using imagesDefault set to false - ripe-core/#4778

[2.35.1] - 2023-01-10

Fixed

• Fix stateChatLinesOrderP reference method - ripe-robin-revamp/#340

[2.35.0] - 2023-01-04

Added

• Added SDK methods for orders' issue API endpoints - ripe-core/#4700

[2.34.0] - 2023-01-02

Added

• Support curve_type and curve_tension config values - #429
• Add get3dSceneEnvironmentUrl, getInitials3dBaseTextureUrl and getInitials3dDisplacementTextureUrl methods - #429
• Set CSR mesh url default variant value to "$base" - #429
• Add getTextureMapUrl method - #429
• Support metallic, normal and roughness textures - #429

Changed

• Use config in CSR - #429
• Change default test timeout to 60 seconds
• Revert ripe-sdk-demo variant value to "" - #429
• Generalize CsrRenderedInitials textures logic - #429
• Improve getTextureMapUrl method - #429

Fixed

• If no masks are to be used, create the mask buffers but don't load them, avoiding network requests - #446
• Fix CSR initials control points debug boxes being too small - #429
• Set optional status change params in the request params

[2.33.0] - 2022-12-13

Added

• Add quantity param to _importOrder method - ripe-pulse/#271

[2.32.0] - 2022-11-10

Added

• Add new variant and size params to _getConfigOptions method - ripe-core/#4745
• Add variant passing through onConfig and onPart - #429
• Add CSS link to README.md
• Add hasStrategy method - #429
• Add CsrAnimation, CsrChangeFrameAnimation and CsrUtils - #429
• Add changeFrame and flushPending methods to CSR configurator - #429
• Add click binds to ripe-sdk-demo that allows to match CSR to the PRC frames - #429
• Add syncFromCSR method to ConfiguratorPrc - #429
• Add syncFromPRC and prcFrame methods to ConfiguratorCsr - #429
• Add bilateral synchronization between PRC and CSR configurators in ripe-sdk-demo when changing configurator - #429
• Add CSR debug support - #429
• Add CSR framerate, world axis and model axis debug tools - #429
• Add CSR zoom support - #429
• Add CsrTextureRenderer - #429
• Add CsrRenderedInitials - #429
• Support CsrRenderedInitials mesh morphing - #429
• Setup CsrRenderedInitials - #429
• Add loadFBX and loadEnvironment methods to utils - #429
• Add import order simple methods
• Reset CSR configurator zoom when syncing from PRC - #429
• Added method for the GET /api/info endpoint
• Added test-coverage npm script
• Add loadMesh method to utils - #429
• Add tone mapping support to CSR - #429
• Add support for .glb in _loadMesh - #429
• Add toXYZObject, toVector3 and toToneMappingValue utils - #429
• Increase number of curve types supported by CsrRenderedInitials - #429

Changed

• Avoid warnings by not using var in ripe-sdk-demo .js files - #429
• Set renderer output encoding to sRGBEncoding - #429
• Set ripe-sdk-demo brand and model to dummy cube - #429
• Set CSR camera default values standard - #429
• Use THREE.Group to manipulate positions and rotations instead of directly changing mesh axis - #429
• Improve animation loop so it can tick animations - #429
• Greatly improve CSR scene loading time - #429
• Removed unused format variable from ConfiguratorCsr - #429
• Reorder ConfiguratorCsr methods - #429
• Remove dracoLoaderDecoderPath and dracoLoaderDecoderFallbackPath - #429
• Remove dependency on external draco loader files - #429

Fixed

• Add dku to request options for import order
• Add contents to params of import order only if filled with some value
• Fix ConfiguratorCsr sizes and resize() logic - #429
• Fix CSR configurator no being hidden at the demo start - #429
• Fix not being able to override camera transforms on CSR configurator initialization - #429
• Fix errors when trying to initialize CSR debug mode when no CSR initials points are set - #429
• Fix CSR debug line points boxes wrong size - #429

[2.31.2] - 2022-06-08

Added

• Add param tenant_id to updateTagOrder method - ripe-robin-revamp/#363

[2.31.1] - 2022-06-07

Fixed

• Fix initialsSpec profile spread fallback value in image

[2.31.0] - 2022-06-01

Added

• Added deleteTagOrder methods - ripe-robin-revamp/#363
• Added deactivateTagOrder methods - ripe-robin-revamp/#363

Changed

• Removed node 10 and 11 from github workflows

Fixed

• Fix eslint dependencies problems

[2.30.0] - 2022-05-20

Added

• Add fromArrayBuffer and fromBlob to FileTuple - hermes-proxy/135
• Added safe param to be passed in importOrder - ripe-util-vue/#259
• Support profile overriding in image - ripe-white/#978

[2.29.0] - 2022-04-28

Added

• Added activateTagOrderP and updateTagOrderP methods to set the tag of an order and activate it

[2.28.0] - 2022-04-18

Added

• Added new compose composeOptions to allow passing composition options such as dpi and quality.

[2.26.0] - 2022-04-11

Added

• Added method resolveJustification to find the matching justification given context and code or full code - ripe-pulse/#317
• Added composeLogic option to specify if the (initials builder) logic should run on server-side.
• Added noAwaitLayout option so that current updates don't wait for the previous ones to be complete.

[2.25.1] - 2022-03-31

Fixed

• Support no faces in a dimension from spec in ´getDimension`
• Fix _getOrderReportURL, _getOrderReportPDFURL, _getOrderReportPNGURL logic and tests - #381

[2.25.0] - 2022-03-24

Added

• Add methods getVideoP and getVideoThumbnailP that return the video and video thumbnail for a given model and its customization - ripe-white/#996
• Add methods _getVideoURL and _getVideoThumbnailURL that return the URL of a video and video thumbnail, respectively, for a given model and its customization - ripe-white/#996
• General order chat methods - ripe-core/#4702
• Support for external image URL providers and frame validators for image - ripe-white/#996
• Validator function hasVideo that verifies if a video exists in the build spec - ripe-white/#996
• New image bind method bindVideoThumbnail specific for binding to an image tag the video thumbnail image - ripe-white/#996
• Add method _getOrderImageURL - #380

Changed

• Always loading default bundle locales for scales and sizes

[2.24.0] - 2022-03-14

Added

• Added methods getSkusCsvP and getSkusCsv that return a CSV document containing SKUs - ripe-white/#979
• Added methods countSkusP and countSkus that returns the number of SKUs - ripe-white/#979

Changed

• Improve update cancellation strategy by adding a cancel event to cancel ongoing update promises - #363

Fixed

• Payload brand field for importBulkOrder optional - ripe-pulse/#281

[2.23.0] - 2022-03-07

Added

• Added methods for waybill deletion (void) - ripe-util-vue/#301
• Methods to unset order tracking info - ripe-pulse/#301

[2.22.0] - 2022-03-03

Added

• Added support for invoicingInfo field in importOrder - ripe-util-vue/#247
• Added configurator configuration variable useDefaultSize that forces the configurator to use images with the default dimensions of the current face

Fixed

• Use pixelRatio in configurator applied to the image but do not allow getting images bigger than the default dimensions for the current face

[2.21.0] - 2022-02-28

Added

• Add create order bulk methods - ripe-pulse/#281

Changed

• Make brand for importBulkOrder optional - ripe-pulse/#281

[2.20.0] - 2022-02-02

Added

• Add resolveInvoiceRuleP and resolveInvoiceRule methods that return an invoice rule for the given brand, model and country - ripe-pulse/#291
• Added getShipments/getShipmentsP and createShipment/createShipmentsP - ripe-pulse/#276

[2.19.0] - 2022-02-02

Added

• Support for trigger of message event after initialsBuilder() call

[2.18.0] - 2022-01-27

Added

• setPickupNumber and setPickupNumberP in the Order API - #33

[2.17.0] - 2022-01-27

Fixed

• Fixed method name for signinPidP

[2.16.0] - 2022-01-24

Added

• Add lineBreakP and lineBreak methods to get the lines of text after line breaking logic is applied - 3db/#195

Fixed

• Remove default width and height for configurator-prc

[2.15.1] - 2022-01-17

Fixed

• Fixed non integer aspect ratio in image

[2.15.0] - 2022-01-12

Added

• Use pixel ratio in image - ripe-white/#948

[2.14.0] - 2022-01-12

Added

• Method getDimension that returns the size of a specific dimension and face - ripe-white/#948

Changed

• Image resize now support width and height - ripe-white/#943

[2.13.0] - 2022-01-07

Added

• Add missing params to _getImageOptions
• Support for images not 1:1 in configurator, where the resize operation take into account the width and height instead of size - ripe-white/#943

[2.12.0] - 2021-12-05

Added

• Add localeToNative, localeToNativeP, localeToNativeB and localeToNativeBP methods to convert locale sizes to native sizes and unit tests - #4638
• Add Invoice Rules API methods - peri-invoicing/#3
• Add textLengthP and textLength to get the length of the value of the initials

Changed

• Made the initialsBuilder function async to support async calls in external initials builder logic
• Added ctx to initialsBuilder call so that there is parity between the Javascript and Python initials builders

[2.11.0] - 2021-12-03

Added

• Add Bulk Order API methods - ripe-util-vue/#218
• Add initials builder ctx message dispatcher for build's js logic

[2.10.0] - 2021-11-19

Added

• Add setProofOfDeliveryP and setProofOfDelivery methods to set proof of delivery info of an order - #34
• Add createReturnWaybillOrder as part of the Order API

[2.9.0] - 2021-11-12

Added

• Support for size parameter in _getMaskURL request
• Add refreshShippingOrder and refreshShippingOrderP - #260
• Add blockOrderP and blockOrder methods to block an order - #263

[2.8.0] - 2021-11-05

Added

• Support for the Order touch API endpoint
• Support for scale in import order
• Add test should be able to set the price in #importOrder() tests

Fixed

• Fix price not being correctly set in importOrderP()
• Problem relates with invalid hasTag()

[2.7.1] - 2021-09-27

Fixed

• useMasks calculation on init and usage in order to allow usage of an undefined value that defaults to true

[2.7.0] - 2021-09-13

Added

• Added itertools.js to gulpfile build files in order to be bundled
• Support for no_masks tag
• getPrices which consumes /api/config/prices for getting prices for several configs in a single batch call

[2.6.0] - 2021-08-27

Added

• notify option to endpoints for changing an order's status, to allow triggering notifications upon a status change

[2.5.1] - 2021-08-26

Fixed

• Small terminate() issue
• Attribute stability for the canceled preload images

[2.5.0] - 2021-08-25

Added

• Added itertools.js to gulpfile build files in order to be bundled

Changed

• Improved performance by allowing cancelling image loading for images that are not needed (quick setFrame changes)
• Created structures that prevented concurrent update() at a Visual class level

Fixed

• Issue where the changeFrame operation was being incorrectly canceled

[2.4.2] - 2021-08-14

Fixed

• Removed warnings for node.js requireSafe() hack under webpack

[2.4.1] - 2021-08-09

Fixed

• Issue related to problem in loading front mask image

[2.4.0] - 2021-08-05

Added

• Endpoints for creating order notes

[2.3.1] - 2021-07-26

Changed

• Made requireSafe() sa safer method allowing auto catching of import errors.

[2.3.0] - 2021-07-26

Changed

• When doing a configurator resize use the defined size option, if defined, otherwise fallsback to the old behavior of using the "binded" element's width

[2.2.3] - 2021-07-26

Fixed

• Use of the SDK in a react-native environment

[2.2.2] - 2021-07-26

Added

• Support for multiple character escaping in escape()
• Add method to retrieve the URL for an attachment
• Support for retry in API requests when receiving authentication related errors (eg: 403)
• Add size argument to resolveInvoiceRule - ripe-core/#4703
• Add missing resolveTransportRule and resolveTransportRuleP methods - ripe-core/#4703

[2.2.1] - 2021-06-13

Fixed

• Addition of attachments to a specific order state (stateCreateAttachmentOrder) - #230

[2.2.0] - 2021-07-06

Added

• Ability to override name and meta for attachments - #282
• Added method to issue a create waybill command for a given order - ripe-pulse/211
• Add rejectOrderP and rejectOrder methods - ripe-pulse/#219
• Passing locale and country arguments in ctx when doing initials builder to allow localized sanitization of initials - build-static/#2075

Fixed

• Set order status takes relevant params from options and populates request params
• Multipart encoding extended to classes that implement toString
• Multipart encoding no longer sends an extra newline separator on the last field

[2.1.0] - 2021-06-22

Changed

• Import order method propagates shipping info
• Made image support the best file format by default

Fixed

• Initials builder initialization when useInitialsBuilderLogic was false

[2.0.1] - 2021-06-22

Fixed

• Small issue fix

[2.0.0] - 2021-06-01

Added

• [BREAKING CHANGES] Support for dynamic initialsBuilder logic sourced from server side 3DB ⚠️ (requires initialsBuilder signature change)

[1.26.0] - 2021-06-01

Added

• setTracking method to the Order entity
• setReturnTracking method to the Order entity
• setMeta method allowing dynamic set of metadata attributes for the Order entity
• Method for generating an image URL from a query (_queryToImageUrl)

[1.25.9] - 2021-05-24

Added

• Transport Rule API
• getTransportOrder method
• attachmentOrder method
• qualityAssureOrder method

[1.25.8] - 2021-05-14

Added

• getDefaultsP - the promise based version of getDefaults
• changePriority Order API method
• tenancyAccountMe endpoint

Fixed

• lowlight when the mouse leaves the configurator area

[1.25.7] - 2021-04-29

Fixed

• Take variant into account in update operations

[1.25.6] - 2021-04-01

Added

• Small changes in the code

[1.25.5] - 2021-04-01

Added

• Added typing for getBuildsP

[1.25.4] - 2021-03-23

Added

• Added typing for getBuildP

Changed

• Fixed jsdoc by removing unused parameter

[1.25.3] - 2021-03-03

Added

• Added typing for native to size

[1.25.2] - 2021-02-23

Added

• Support for validation of SKU in API calls
• More locale utility methods

[1.25.1] - 2021-02-22

Changed

• Support for count methods added to the API level

[1.25.0] - 2021-02-20

Changed

• Added extra param ´override´ to setInitials and setInitialsExtra