AdorneeData

Bridges attributes and serialization

Installation

npm install @quenty/adorneedata --save

Requirements

These are the requirements for this attribute data library.

• Not like Tie in that it is focused on serialization/boundary between Roblox and our stuff (tie is interfaces separated by network boundary)
• Easy to transform between data and attributes
• No service bag requirements

Centralized definition with no server/client information

return AdorneeData.new({
  CurrencyColor = Color3.new();
  CurrencyNameTranslationKey = "";
  CurrencyFormatTranslationKey = "";
  CurrencyImageId = "";
  CurrencyShowType = CurrencyShowTypes.NONE;
  GivePlayerCurrency = false;
  CurrencySaves = false;
})

Easy to write/author

We should be able to create new data that is validated

CurrencyDefinitionData:CreateData({
  CurrencyKey = CurrencyDefinitionConstants.DEFAULT_CURRENCY_KEY
  CurrencyColor = Color3.fromRGB(55, 180, 74)
  CurrencyTranslationKey = "currency.default.name"
  CurrencyFormatTranslationKey = "currency.default.format"
  DoesSave = true
  ImageId = "rbxassetid://10049671651"
})

We should be able to create partial data

CurrencyDefinitionData:CreatePartialData({
  CurrencyKey = CurrencyDefinitionConstants.DEFAULT_CURRENCY_KEY
  CurrencyColor = Color3.fromRGB(55, 180, 74)
  CurrencyTranslationKey = "currency.default.name"
  CurrencyFormatTranslationKey = "currency.default.format"
  DoesSave = true
  ImageId = "rbxassetid://10049671651"
})

Additional authorship requirements

• Should be able to set optional values

Easy to validate/assert/assign

We should be able to check data types

function CurrencyService:InitCurrencyDefinition(currencyDefinitionData)
  assert(CurrencyDefinitionData:IsData(currencyDefinitionData), "Bad currencyDefinitionData")

  local currencyDefinition = CurrencyDefinition:Create("Folder")
  CurrencyDefinitionData:SetAttributes(currencyDefinition, currencyDefinitionData)

  return currencyDefinition
end

Replacement files

Should replace following files:

• CurrencyDefinitionDataUtils - Files with t interface asserting type
• CurrencyDefinitionConstants - Files with constant attribute names
• CurrencyDefinitionUtils - File that sets certain properties or attributes and do validation

Easy to serialize

Should be able to flash to constant

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

7.19.0 (2025-05-10)

Bug Fixes

• Additional type checking updates (05ba29a)

7.18.3 (2025-04-10)

Note: Version bump only for package @quenty/adorneedata

7.18.2 (2025-04-07)

Bug Fixes

• Add types to packages (2374fb2)
• Bump package versions for republishing (ba47c62)

7.18.1 (2025-04-07)

Bug Fixes

• Add types to packages (2374fb2)

7.18.0 (2025-04-02)

Note: Version bump only for package @quenty/adorneedata

7.17.2 (2025-03-31)

Note: Version bump only for package @quenty/adorneedata

7.17.1 (2025-03-21)

Note: Version bump only for package @quenty/adorneedata

7.17.0 (2025-02-18)

Note: Version bump only for package @quenty/adorneedata

7.16.0 (2024-12-15)

Note: Version bump only for package @quenty/adorneedata

7.15.0 (2024-12-03)

Note: Version bump only for package @quenty/adorneedata

7.14.0 (2024-11-13)

Note: Version bump only for package @quenty/adorneedata

7.13.0 (2024-11-06)

Note: Version bump only for package @quenty/adorneedata

7.12.2 (2024-11-04)

Note: Version bump only for package @quenty/adorneedata

7.12.1 (2024-11-04)

Bug Fixes

• Fix aliases (70af87e)

7.12.0 (2024-11-03)

Note: Version bump only for package @quenty/adorneedata

7.11.0 (2024-10-23)

Note: Version bump only for package @quenty/adorneedata

7.10.1 (2024-10-09)

Note: Version bump only for package @quenty/adorneedata

7.10.0 (2024-10-06)

Note: Version bump only for package @quenty/adorneedata

7.9.1 (2024-10-04)

Note: Version bump only for package @quenty/adorneedata

7.9.0 (2024-10-04)

Note: Version bump only for package @quenty/adorneedata

7.8.0 (2024-09-25)

Note: Version bump only for package @quenty/adorneedata

7.7.0 (2024-09-25)

Note: Version bump only for package @quenty/adorneedata

7.6.0 (2024-09-12)

Features

• Add AdorneeData:Unset(adornee) (214b490)
• Add AdorneeDataEntry supporting optional attributes (b840805)

7.5.0 (2024-08-09)

Note: Version bump only for package @quenty/adorneedata

7.4.0 (2024-05-18)

Features

• Add AdorneeData docs and ability to use indirectly (8df4e84)

7.3.0 (2024-05-09)

Bug Fixes

• Fix .package-lock.json replicating in packages (75d0efe)

7.2.0 (2024-04-27)

Note: Version bump only for package @quenty/adorneedata

7.1.0 (2024-03-09)

Note: Version bump only for package @quenty/adorneedata

7.0.0 (2024-02-14)

Note: Version bump only for package @quenty/adorneedata

6.0.0 (2024-02-13)

Note: Version bump only for package @quenty/adorneedata

5.0.0 (2024-02-13)

Note: Version bump only for package @quenty/adorneedata

4.0.0 (2024-02-13)

Features

• New loader (breaking changes), fixing loader issues (#439) (3534345)

BREAKING CHANGES

• Standard loader

Adds new loader version which replicates full structure instead of some partial structure. This allows us to have hot-reloading (in the future), as well as generally do less computation, handle dependencies more carefully, and other changes.

This means you'll need to change you how require client-side modules, as we export a simple loader module instead of all modules available.

Signed-off-by: James Onnen jonnen0@gmail.com

• fix: Fix missing dependency in ResetService

• feat: Add RxPhysicsUtils.observePartMass

• fix: Fix package discovery for games

• feat: Add UIAlignmentUtils.verticalToHorizontalAlignment(verticalAlignment) and UIAlignmentUtils.horizontalToVerticalAlignment(horizontalAlignment)

• feat: AdorneeData:InitAttributes() does not require data as a secondparameter

• ci: Upgrade to new rojo 7.4.0

• fix: Update loader to handle hoarcekat properly

• docs: Fix spacing in Maid

• fix: Add new ragdoll constants

• fix: Compress influxDB sends

• style: Errors use string.format

• fix: Handle motor animations

• ci: Upgrade rojo version

• feat!: Maid no longer is includd in ValueObject.Changed event

• docs: Fix docs

3.0.0 (2024-01-10)

Note: Version bump only for package @quenty/adorneedata

2.0.0 (2024-01-08)

Note: Version bump only for package @quenty/adorneedata

1.3.0 (2024-01-08)

Bug Fixes

• InitAttributes works on partial data (a5831f6)

1.2.0 (2023-12-28)

Bug Fixes

• Adornee attribute retrieval includes default values (577691d)

1.1.0 (2023-12-14)

Note: Version bump only for package @quenty/adorneedata

v1.1.0 (Thu Dec 14 2023)

🚀 Enhancement

• users/quenty/updates #433 (@Quenty)

🐛 Bug Fix

• docs: Fix docs and style (@Quenty)
• refactor: Rename AdorneeData to AttributeData (@Quenty)

Authors: 1

• James Onnen (@Quenty)