Made connect methods private

Author: fancyDevelopment

README.md

@@ -8,5 +8,12 @@ The repository provides the library itself, a playground app and a dummy backend
 
 To run the playground app clone the repository and run an ```npm install``. Then start the backend with ``npm run server`` and the playground app with ``npm start``.
 
-## Sample Application
+## Playground applicaiton
+
+Use and review the playground application inside the repository to understand how to use the library. Also you can review the http responses and requests in the browser network tab to get an impression of how hypermedia json can look like. 
+
+## Documentation
+Will be done soon - I promise!
+
+## Real World Sample Application
 There is a sample application [Fancy.ResourceLinker.Sample](https://github.com/fancyDevelopment/Fancy.ResourceLinker.Sample) which demonstrates end to end real world usage of hypermedia in Angular and also some other aspects of a real wold system.

angular.json

@@ -117,5 +117,8 @@
         }
       }
     }
+  },
+  "cli": {
+    "analytics": false
   }
 }

apps/playground/src/app/app.state.ts

@@ -7,7 +7,7 @@ export const AppState = signalStore(
   withLinkedHypermediaResource('userInfo', { name: '', preferred_username: '' }),
   withHooks({
     onInit(store) {
-        store.connectUserInfo(store.rootApi, 'userinfo')
+        store._connectUserInfo(store.rootApi, 'userinfo')
     }
   })
 );

apps/playground/src/app/core/core.state.ts

@@ -9,7 +9,7 @@ export const CoreState = signalStore(
   withLinkedHypermediaResource('homeVm', initialHomeVm),
   withHooks({
     onInit(store) {
-      store.connectHomeVm(inject(AppState).rootApi, 'homeVm')
+      store._connectHomeVm(inject(AppState).rootApi, 'homeVm')
     }
   })
 );

apps/playground/src/app/flight/flight.state.ts

@@ -14,12 +14,12 @@ export const FlightState = signalStore(
   withHypermediaAction('createFlight'),
   withHooks({
     onInit(store) {
-        store.connectUpdateFlightConnection(store.flightEditVm.flight.connection, 'update');
-        store.connectUpdateFlightTimes(store.flightEditVm.flight.times, 'update');
-        store.connectUpdateFlightOperator(store.flightEditVm.flight.operator, 'update');
-        store.connectUpdateFlightPrice(store.flightEditVm.flight.price, 'update');
-        store.connectFlightCreateVm(store.flightSearchVm, 'flightCreateVm');
-        store.connectCreateFlight(store.flightCreateVm.template, 'create');
+        store._connectUpdateFlightConnection(store.flightEditVm.flight.connection, 'update');
+        store._connectUpdateFlightTimes(store.flightEditVm.flight.times, 'update');
+        store._connectUpdateFlightOperator(store.flightEditVm.flight.operator, 'update');
+        store._connectUpdateFlightPrice(store.flightEditVm.flight.price, 'update');
+        store._connectFlightCreateVm(store.flightSearchVm, 'flightCreateVm');
+        store._connectCreateFlight(store.flightCreateVm.template, 'create');
     }
 })
 );

libs/ngrx-hateoas/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@angular-architects/ngrx-hateoas",
-  "version": "18.0.0-rc.3",
+  "version": "18.0.0-rc.4",
   "peerDependencies": {
     "@angular/common": "^18.0.0",
     "@angular/core": "^18.0.0",

libs/ngrx-hateoas/src/lib/store-features/with-hypermedia-action.ts

@@ -32,11 +32,11 @@ export function generateExecuteHypermediaActionMethodName(actionName: string) {
 }
 
 export type ConnectHypermediaActionMethod<ActionName extends string> = { 
-    [K in ActionName as `connect${Capitalize<ActionName>}`]: (linkRoot: Signal<unknown>, action: string) => void
+    [K in ActionName as `_connect${Capitalize<ActionName>}`]: (linkRoot: Signal<unknown>, action: string) => void
 };
 
 export function generateConnectHypermediaActionMethodName(actionName: string) {
-    return `connect${actionName.charAt(0).toUpperCase() + actionName.slice(1)}`;
+    return `_connect${actionName.charAt(0).toUpperCase() + actionName.slice(1)}`;
 }
 
 export type HypermediaActionMethods<ActionName extends string> = 

libs/ngrx-hateoas/src/lib/store-features/with-linked-hypermedia-resource.ts

@@ -27,11 +27,11 @@ export type LinkedHypermediaResourceStoreState<ResourceName extends string, TRes
     & LinkedHypermediaResourceState<ResourceName>;
 
 export type ConnectLinkedHypermediaResourceMethod<ResourceName extends string> = { 
-    [K in ResourceName as `connect${Capitalize<ResourceName>}`]: (linkRoot: Signal<unknown>, linkName: string) => void
+    [K in ResourceName as `_connect${Capitalize<ResourceName>}`]: (linkRoot: Signal<unknown>, linkName: string) => void
 };
 
 export function generateConnectLinkedHypermediaResourceMethodName(resourceName: string) {
-    return `connect${resourceName.charAt(0).toUpperCase() + resourceName.slice(1)}`;
+    return `_connect${resourceName.charAt(0).toUpperCase() + resourceName.slice(1)}`;
 }
 
 export type ReloadLinkedHypermediaResourceMethod<ResourceName extends string> = {