refactor: remove global md key, stringkeyof (#200)

* refactor: remove global md key, stringkeyof

* chore: add readonly to metadata provider set

Author: davidlj95

projects/ngx-meta/src/core/public-api.ts

@@ -8,7 +8,6 @@ export {
 } from './src/provide-core'
 export * from './src/global-metadata'
 export * from './src/global-metadata-image'
-export * from './src/global-metadata-key'
 export * from './src/head-element-upsert-or-remove'
 export * from './src/make-composed-meta-property'
 export * from './src/make-metadata'
@@ -17,8 +16,6 @@ export * from './src/meta-property'
 export * from './src/meta.service'
 export * from './src/metadata'
 export * from './src/metadata-provider'
-export * from './src/metadata-setter'
 export * from './src/metadata-values'
 export * from './src/metadata.service'
 export * from './src/provide-metadata-factory'
-export * from './src/string-key-of'

projects/ngx-meta/src/core/src/__tests__/make-metadata-provider.ts

@@ -1,16 +1,13 @@
-import { MetadataProvider } from '../metadata-provider'
 import { makeMetadata } from '../make-metadata'
 
-export function makeMetadataProvider<T, Id extends string>(
+export function makeMetadataProvider<Id extends string>(
   opts: {
     id?: Id
     spyName?: string
   } = {},
 ) {
-  const id = opts.id ?? 'dummy'
-  const metadata: MetadataProvider<T> = {
-    metadata: makeMetadata([id]),
-    set: jasmine.createSpy(opts.spyName ?? id),
+  return {
+    metadata: makeMetadata([opts.id ?? 'dummy']),
+    set: jasmine.createSpy(opts.spyName ?? opts.id ?? 'dummy'),
   }
-  return metadata
 }

projects/ngx-meta/src/core/src/global-metadata-key.ts

@@ -1,5 +1,4 @@
 import { GlobalMetadataImage } from './global-metadata-image'
-import { GlobalMetadataKey } from './global-metadata-key'
 
 export interface GlobalMetadata {
   /**
@@ -72,11 +71,12 @@ export interface GlobalMetadata {
   readonly image?: GlobalMetadataImage | null
 }
 
-export const GLOBAL_TITLE = 'title' satisfies GlobalMetadataKey
-export const GLOBAL_DESCRIPTION = 'description' satisfies GlobalMetadataKey
+export const GLOBAL_TITLE = 'title' satisfies keyof GlobalMetadata
+export const GLOBAL_DESCRIPTION = 'description' satisfies keyof GlobalMetadata
 export const GLOBAL_APPLICATION_NAME =
-  'applicationName' satisfies GlobalMetadataKey
+  'applicationName' satisfies keyof GlobalMetadata
 
-export const GLOBAL_CANONICAL_URL = 'canonicalUrl' satisfies GlobalMetadataKey
-export const GLOBAL_LOCALE = 'locale' satisfies GlobalMetadataKey
-export const GLOBAL_IMAGE = 'image' satisfies GlobalMetadataKey
+export const GLOBAL_CANONICAL_URL =
+  'canonicalUrl' satisfies keyof GlobalMetadata
+export const GLOBAL_LOCALE = 'locale' satisfies keyof GlobalMetadata
+export const GLOBAL_IMAGE = 'image' satisfies keyof GlobalMetadata

projects/ngx-meta/src/core/src/global-metadata.ts

@@ -1,6 +1,8 @@
 import { Metadata } from './metadata'
 
+export type MetadataSetter<T> = (value: T) => void
+
 export abstract class MetadataProvider<Value, Global extends string = string> {
   abstract readonly metadata: Metadata<Global>
-  abstract set(value: Value | null): void
+  abstract readonly set: MetadataSetter<Value>
 }

projects/ngx-meta/src/core/src/metadata-provider.ts

@@ -1,20 +1,11 @@
-import { MetadataProvider } from './metadata-provider'
+import { MetadataProvider, MetadataSetter } from './metadata-provider'
 import { FactoryProvider } from '@angular/core'
 import { Metadata } from './metadata'
-import { MetadataSetter } from './metadata-setter'
 
 export type MetadataSetterFactory<T> = (
   ...deps: Exclude<FactoryProvider['deps'], undefined>
 ) => MetadataSetter<T>
 
-const makeMetadataProvider = <T>(
-  metadata: Metadata,
-  set: MetadataSetter<T>,
-): MetadataProvider<T> => ({
-  metadata,
-  set,
-})
-
 export function provideMetadataFactory<T>(
   definition: Metadata,
   setterFactory: MetadataSetterFactory<T>,
@@ -28,3 +19,11 @@ export function provideMetadataFactory<T>(
     deps,
   }
 }
+
+const makeMetadataProvider = <T>(
+  metadata: Metadata,
+  set: MetadataSetter<T>,
+): MetadataProvider<T> => ({
+  metadata,
+  set,
+})

projects/ngx-meta/src/core/src/metadata-setter.ts

@@ -1,10 +1,9 @@
 import {
-  GlobalMetadataKey,
+  GlobalMetadata,
   makeMetadata,
   MetadataSetterFactory,
   MetaService,
   provideMetadataFactory,
-  StringKeyOf,
 } from '@davidlj95/ngx-meta/core'
 import { OpenGraph } from './open-graph'
 import { FactoryProvider } from '@angular/core'
@@ -13,15 +12,13 @@ import { makeOpenGraphMetaProperty } from './make-open-graph-meta-property'
 
 export const OPEN_GRAPH_KEY: keyof OpenGraphMetadata = 'openGraph'
 
-export const makeOpenGraphMetadataProvider = <
-  Key extends StringKeyOf<OpenGraph>,
->(
+export const makeOpenGraphMetadataProvider = <Key extends keyof OpenGraph>(
   key: Key,
   opts: {
     // Open Graph property name. Defaults to key
     p?: string
     // Global key. Defaults to nothing
-    g?: GlobalMetadataKey
+    g?: keyof GlobalMetadata
     // Setter factory. Defaults to setting the property to the given value.
     s?: MetadataSetterFactory<OpenGraph[typeof key]>
   } = {},

projects/ngx-meta/src/core/src/provide-metadata-factory.ts

@@ -2,7 +2,6 @@ import {
   makeMetadata,
   MetaService,
   provideMetadataFactory,
-  StringKeyOf,
 } from '@davidlj95/ngx-meta/core'
 import { FactoryProvider } from '@angular/core'
 import { OpenGraphProfile } from './open-graph-profile'
@@ -13,7 +12,7 @@ import { OpenGraph } from './open-graph'
 export const OPEN_GRAPH_PROFILE_KEY: keyof OpenGraph = 'profile'
 
 export const makeOpenGraphProfileMetadataProvider = <
-  Key extends StringKeyOf<OpenGraphProfile>,
+  Key extends keyof OpenGraphProfile,
 >(
   key: Key,
   opts: {

projects/ngx-meta/src/core/src/string-key-of.ts

@@ -1,10 +1,9 @@
 import {
-  GlobalMetadataKey,
+  GlobalMetadata,
   makeMetadata,
   MetadataSetterFactory,
   MetaService,
   provideMetadataFactory,
-  StringKeyOf,
 } from '@davidlj95/ngx-meta/core'
 import { FactoryProvider } from '@angular/core'
 import { Standard } from './standard'
@@ -13,13 +12,13 @@ import { makeStandardMetaProperty } from './make-standard-meta-property'
 
 const STANDARD_KEY: keyof StandardMetadata = 'standard'
 
-export const makeStandardMetadataProvider = <Key extends StringKeyOf<Standard>>(
+export const makeStandardMetadataProvider = <Key extends keyof Standard>(
   key: Key,
   opts: {
     // Standard metadata name. Defaults to key
     n?: string
     // Global key. Defaults to nothing
-    g?: GlobalMetadataKey
+    g?: keyof GlobalMetadata
     // Setter factory. Defaults to setting the meta name to the given value.
     s?: MetadataSetterFactory<Standard[typeof key]>
     // Deps for the setter factory

projects/ngx-meta/src/open-graph/src/make-open-graph-metadata-provider.ts

@@ -1,10 +1,9 @@
 import {
-  GlobalMetadataKey,
+  GlobalMetadata,
   makeMetadata,
   MetadataSetterFactory,
   MetaService,
   provideMetadataFactory,
-  StringKeyOf,
 } from '@davidlj95/ngx-meta/core'
 import { FactoryProvider } from '@angular/core'
 import { TwitterCard } from './twitter-card'
@@ -13,15 +12,13 @@ import { makeTwitterCardMetaProperty } from './make-twitter-card-meta-property'
 
 const TWITTER_KEY: keyof TwitterCardMetadata = `twitterCard`
 
-export const makeTwitterCardMetadataProvider = <
-  Key extends StringKeyOf<TwitterCard>,
->(
+export const makeTwitterCardMetadataProvider = <Key extends keyof TwitterCard>(
   key: Key,
   opts: {
     // Twitter card property name. Defaults to key
     p?: string
     // Global key. Defaults to nothing
-    g?: GlobalMetadataKey
+    g?: keyof GlobalMetadata
     // Setter factory. Defaults to setting the property to the given value.
     s?: MetadataSetterFactory<TwitterCard[typeof key]>
   } = {},