feat: use metadata manager provider APIs v2 around

[davidlj95]

Issue or need

New APIs (v2) were introduced to provide metadata managers in #926

Proposed changes

Let's start using them around for the built-in metadata modules

Some internal APIs have been added to create a metadata manager that belongs to a set of metadata values. Like the ones for built-in modules: Open Graph, standard...

export const provideOpenGraphManager = <Key extends keyof OpenGraph>(
  key: Key,
  ...options: ReadonlyArray<_ProvideNgxMetaModuleManagerOptions<OpenGraph[Key]>>
) =>
  _provideNgxMetaModuleManager<OpenGraph, Key>(
    key,
    [OPEN_GRAPH_KEY],
    withOptions(
      _withModuleManagerNameAttribute(withOpenGraphPropertyAttribute(key)),
      ...options,
    ),
  )

Where key is the key of the object of metadata values that can be set to provide a manager for.

This helper allows abstracting logic for all those kind of modules:

• Default is setting a <meta> element with same name
  • Despite a custom one may be needed. Like in Open Graph / Twitter Card.
• JSON Path will be some scope and the key. For instance, Open Graph's url is openGraph scope in the JSON of metadata values (keys to access the module's JSON of values), with the url key in that object. Scope can be multiple keys like in Open Graph profile, under openGraph profile
• Default is to provide NgxMetaElementsService as dependency (for previous point)
  • Custom dependencies may be needed

Those above are also customized further by every module. For instance, Open Graph sets a custom scope and property attribute to use by default.

The implementation has gone through several rounds of optimizations to improve uncompressed bundle size:

• Shorten option names in internal objects to be just 1/2 chars.
• Add utility to indicate key is same as global. To avoid repeat passing the global name around.
• Remove util to specify Open Graph profile property. Inline it.

Following bundle size optimizations were thought of, but weren't performed:

• JSON Path to be an array instead of a string. Avoids the utility to convert to it (plus then having to split it back). But nothing much else. Would save 10 bytes. But having first argument as a string is more developer friendly. Worth those 10 bytes.
• Remove internal module manager withX APIs. It would save 45 bytes of defining them. But eventually just shave 20 bytes of the bundle size. Code is more expressive this way. Worth 20 bytes.

Docs have been updated: custom metadata manager guide.

APIs from #926 are now marked as public. Changing scope to feat

Quick reminders

• 🤝 I will follow Code of Conduct
• ✅ No existing pull request already does almost same changes
• 👁️ Contributing docs are something I've taken a look at
• 📝 Commit messages convention has been followed
• 💬 TSDoc comments have been added or updated indicating API visibility if API surface has changed.
• 🧪 Tests have been added if needed. For instance, if adding new features or fixing a bug. Or removed if removing features.
• ⚙️ API Report has been updated if API surface is altered.

[davidlj95]

• feat: use metadata manager provider APIs v2 around #927 👈
• feat: add metadata manager provider APIs v2 #926
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @davidlj95 and the rest of your teammates on Graphite

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.34%. Comparing base (f66dd3f) to head (1463577).
Report is 2 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #927      +/-   ##
==========================================
- Coverage   98.16%   97.34%   -0.83%     
==========================================
  Files          85       87       +2     
  Lines         382      376       -6     
  Branches       70       61       -9     
==========================================
- Hits          375      366       -9     
- Misses          3        6       +3     
  Partials        4        4              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[github-actions]

📦 Bundle size (Angular v17)

Git ref: 1463577965cf98d4ea3fa9dc467580b3e2ec170d

Module file	Size	Base size	Difference
ngx-meta-core.mjs	3209 bytes (3.2KiB)	2982 bytes (3.0KiB)	7.61%: 227 bytes (227B)
ngx-meta-json-ld.mjs	217 bytes (217B)	220 bytes (220B)	-1.36%: -3 bytes (-3B)
ngx-meta-open-graph.mjs	931 bytes (931B)	985 bytes (985B)	-5.48%: -54 bytes (-54B)
ngx-meta-routing.mjs	394 bytes (394B)	394 bytes (394B)	No change
ngx-meta-standard.mjs	857 bytes (857B)	907 bytes (907B)	-5.51%: -50 bytes (-50B)
ngx-meta-twitter-card.mjs	487 bytes (487B)	534 bytes (534B)	-8.80%: -47 bytes (-47B)
Total	6095 bytes (6.0KiB)	6022 bytes (5.9KiB)	1.21%: 73 bytes (73B)

[github-actions]

📦 Bundle size (Angular v15)

Git ref: 1463577965cf98d4ea3fa9dc467580b3e2ec170d

Module file	Size	Base size	Difference
ngx-meta-core.mjs	3661 bytes (3.6KiB)	3346 bytes (3.3KiB)	9.41%: 315 bytes (315B)
ngx-meta-json-ld.mjs	352 bytes (352B)	355 bytes (355B)	-.84%: -3 bytes (-3B)
ngx-meta-open-graph.mjs	1172 bytes (1.2KiB)	1254 bytes (1.3KiB)	-6.53%: -82 bytes (-82B)
ngx-meta-routing.mjs	557 bytes (557B)	557 bytes (557B)	No change
ngx-meta-standard.mjs	959 bytes (959B)	1039 bytes (1.1KiB)	-7.69%: -80 bytes (-80B)
ngx-meta-twitter-card.mjs	599 bytes (599B)	664 bytes (664B)	-9.78%: -65 bytes (-65B)
Total	7300 bytes (7.2KiB)	7215 bytes (7.1KiB)	1.17%: 85 bytes (85B)

[github-actions]

📦 Bundle size (Angular v18)

Git ref: 1463577965cf98d4ea3fa9dc467580b3e2ec170d

Module file	Size	Base size	Difference
ngx-meta-core.mjs	3209 bytes (3.2KiB)	2982 bytes (3.0KiB)	7.61%: 227 bytes (227B)
ngx-meta-json-ld.mjs	217 bytes (217B)	220 bytes (220B)	-1.36%: -3 bytes (-3B)
ngx-meta-open-graph.mjs	931 bytes (931B)	985 bytes (985B)	-5.48%: -54 bytes (-54B)
ngx-meta-routing.mjs	394 bytes (394B)	394 bytes (394B)	No change
ngx-meta-standard.mjs	857 bytes (857B)	907 bytes (907B)	-5.51%: -50 bytes (-50B)
ngx-meta-twitter-card.mjs	487 bytes (487B)	534 bytes (534B)	-8.80%: -47 bytes (-47B)
Total	6095 bytes (6.0KiB)	6022 bytes (5.9KiB)	1.21%: 73 bytes (73B)

[github-actions]

📦 Bundle size (Angular v16)

Git ref: 1463577965cf98d4ea3fa9dc467580b3e2ec170d

Module file	Size	Base size	Difference
ngx-meta-core.mjs	3701 bytes (3.7KiB)	3386 bytes (3.4KiB)	9.30%: 315 bytes (315B)
ngx-meta-json-ld.mjs	367 bytes (367B)	370 bytes (370B)	-.81%: -3 bytes (-3B)
ngx-meta-open-graph.mjs	1202 bytes (1.2KiB)	1284 bytes (1.3KiB)	-6.38%: -82 bytes (-82B)
ngx-meta-routing.mjs	572 bytes (572B)	572 bytes (572B)	No change
ngx-meta-standard.mjs	974 bytes (974B)	1054 bytes (1.1KiB)	-7.59%: -80 bytes (-80B)
ngx-meta-twitter-card.mjs	614 bytes (614B)	679 bytes (679B)	-9.57%: -65 bytes (-65B)
Total	7430 bytes (7.3KiB)	7345 bytes (7.2KiB)	1.15%: 85 bytes (85B)

[github-actions]

🎉 This PR is included in version 1.0.0-beta.22 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀