feat: Composable utility for using @omnicajs/symfony-fouter

Author: cmath10

index.d.ts

@@ -24,6 +24,8 @@ import type {
   ContextStoreDefinition,
 } from '@retailcrm/embed-ui-v1-contexts/remote'
 
+import type { Router } from '@omnicajs/symfony-router'
+
 import type { Schema as CustomerCardSchema } from '@retailcrm/embed-ui-v1-contexts/types/customer/card'
 import type { Schema as CustomerCardPhoneSchema } from '@retailcrm/embed-ui-v1-contexts/types/customer/card-phone'
 import type { Schema as OrderCardSchema } from '@retailcrm/embed-ui-v1-contexts/types/order/card'
@@ -85,4 +87,6 @@ export declare const useCustomerCardContext: ContextStoreDefinition<'customer/ca
 export declare const useCustomerCardPhoneContext: ContextStoreDefinition<'customer/card:phone', CustomerCardPhoneSchema>
 export declare const useOrderCardContext: ContextStoreDefinition<'order/card', OrderCardSchema>
 export declare const useCurrentUserContext: ContextStoreDefinition<'user/current', CurrentUserSchema>
-export declare const useSettingsContext: ContextStoreDefinition<'settings', SettingsSchema>
+export declare const useSettingsContext: ContextStoreDefinition<'settings', SettingsSchema>
+
+export declare const useRouter: () => ComputedRef<Pick<Router, 'generate'>>

package.json

@@ -35,6 +35,7 @@
     "vue": "^3.5"
   },
   "dependencies": {
+    "@omnicajs/symfony-router": "^1.0.0",
     "@omnicajs/vue-remote": "^0.2.5",
     "@remote-ui/rpc": "^1.4.5",
     "@retailcrm/embed-ui-v1-contexts": "^0.5.14",

src/composables.ts

@@ -1,5 +1,7 @@
 import type { Callable } from '~types/host/callable'
 
+import type { RouteParams } from '@omnicajs/symfony-router'
+
 import {
   Context,
   ContextAccessor,
@@ -17,14 +19,23 @@ import type { CustomContextStore } from '@retailcrm/embed-ui-v1-contexts/remote/
 
 import type { Endpoint, RemoteCallable } from '@remote-ui/rpc'
 
+import { Router } from '@omnicajs/symfony-router'
+
 import type {
   ComputedRef,
   WritableComputedRef,
 } from 'vue'
 
-import { computed } from 'vue'
+import {
+  computed,
+  shallowRef,
+  watch,
+} from 'vue'
+
 import { defineStore } from 'pinia'
 
+import { useContext as useSettings } from '@retailcrm/embed-ui-v1-contexts/remote/settings'
+
 type Computed<S extends ContextSchema, F extends keyof S> = IsReadonly<S[F]> extends true
   ? ComputedRef<TypeOf<S[F]>>
   : WritableComputedRef<TypeOf<S[F]>>
@@ -98,3 +109,27 @@ export const useHost = (): RemoteCallable<Callable> => {
     },
   }
 }
+
+export const useRouter = (): ComputedRef<Pick<Router, 'generate'>> => {
+  const stringify = JSON.stringify
+  const clone = <T>(pojo: T) => JSON.parse(stringify(pojo)) as T
+
+  const settings = useSettings()
+  const routing = shallowRef(clone(settings['system.routing']))
+
+  watch(() => settings['system.routing'], (changed) => {
+    if (stringify(changed) !== stringify(routing.value)) {
+      routing.value = clone(changed)
+    }
+  })
+
+  return computed(() => {
+    Router.setData(clone(routing.value))
+
+    return {
+      generate: (name: string, params: RouteParams = {}, absolute = false) => {
+        return Router.getInstance().generate(name, params, absolute)
+      },
+    }
+  })
+}

yarn.lock

@@ -1026,6 +1026,7 @@ __metadata:
   dependencies:
     "@eslint/eslintrc": "npm:^3.0.2"
     "@eslint/js": "npm:^9.13.0"
+    "@omnicajs/symfony-router": "npm:^1.0.0"
     "@omnicajs/vue-remote": "npm:^0.2.5"
     "@remote-ui/rpc": "npm:^1.4.5"
     "@retailcrm/embed-ui-v1-contexts": "npm:^0.5.14"