feat(lib): lazy url config

Author: ChristopherPHolder

README.md

@@ -13,7 +13,7 @@ This library covers next aspects that developers should consider for their proje
 - SVG reusability
 - Optimized bundle size
 - SSR
-- Edge ready (only edge save APIs are used)
+- Edge ready (only edge safe APIs are used)
 
 ## Getting started
 
@@ -103,7 +103,8 @@ During setup phase you can provide additional optional settings such as:
   svgLoadStrategy?: Type<SvgLoadStrategy>;
 ```
 
-`svgLoadStrategy` can be any injectable class that has `load` method that accepts url and returns observable string:
+`svgLoadStrategy` can be any injectable class that has `config` that excepts method that accepts url and returns observable string,
+and `load` which accepts the configured url as an observable and returns the svg as an observable string.
 
 ```typescript
 @Injectable()
@@ -196,6 +197,36 @@ And then just provide it in you server module.
 export class AppServerModule {}
 ```
 
+#### Providing a lazy configuration
+
+If you need to provide a lazy configuration you can use the config method in the `SvgLoadStrategy`:
+
+```typescript
+@Injectable()
+class LazyConfigSvgLoadStrategy extends SvgLoadStrategyImpl {
+  dummyLazyConfig$ = timer(5_000).pipe(map(() => 'assets/svg-icons'))
+  override config(url: string): Observable<string> {
+    return this.dummyLazyConfig$.pipe(map((svgConfig) => `${svgConfig}/${url}`));
+  }
+}
+```
+
+And pass it to the provider function:
+
+```typescript
+import { provideFastSVG } from '@push-based/ngx-fast-svg';
+
+bootstrapApplication(AppComponent, {
+  providers: [
+    // ... other providers
+    provideFastSVG({
+      url: (name: string) => `${name}.svg`,
+      svgLoadStrategy: LazyConfigSvgLoadStrategy,
+    })
+  ]
+});
+```
+
 ## Features
 
 ### :sloth: Lazy loading for SVGs
@@ -273,4 +304,3 @@ To display (render) SVGs the browser takes time. We can reduce that time by addi
 ---
 
 made with ❤ by [push-based.io](https://www.push-based.io)
-

packages/ngx-fast-lib/README.md

@@ -13,6 +13,7 @@ This library covers next aspects that developers should consider for their proje
 - SVG reusability
 - Optimized bundle size
 - SSR
+- Edge ready (only edge safe APIs are used)
 
 ## Getting started
 
@@ -166,7 +167,9 @@ You can provide your own SSR loading strategy that can look like this:
 ```typescript
 @Injectable()
 export class SvgLoadStrategySsr implements SvgLoadStrategy {
-  config = (url: string) => of(join(cwd(), 'path', 'to', 'svg', 'assets', url));
+  config(url: string) {
+    return of(join(cwd(), 'path', 'to', 'svg', 'assets', url));
+  }
   load(iconPath$: Observable<string>) {
     return iconPath$.pipe(switchMap((iconPath) => from(readFile(iconPath, { encoding: 'utf8' }))));
   }
@@ -203,9 +206,9 @@ If you need to provide a lazy configuration you can use the config method in the
 ```typescript
 @Injectable()
 class LazyConfigSvgLoadStrategy extends SvgLoadStrategyImpl {
-  lazyConfigService = inject(SvgConfigService);
-  override config(url: string) {
-    return this.lazyConfigService.urlConfig(url);
+  dummyLazyConfig$ = timer(5_000).pipe(map(() => 'assets/svg-icons'))
+  override config(url: string): Observable<string> {
+    return this.dummyLazyConfig$.pipe(map((svgConfig) => `${svgConfig}/${url}`));
   }
 }
 ```
@@ -219,7 +222,7 @@ bootstrapApplication(AppComponent, {
   providers: [
     // ... other providers
     provideFastSVG({
-      url: (name: string): Observable<string> => inject(ConfigService).svgUrl(name),
+      url: (name: string) => `${name}.svg`,
       svgLoadStrategy: LazyConfigSvgLoadStrategy,
     })
   ]