feat(ui/typescript): align Quasar export type with implementation (qu…

…asarframework#8632) Closes quasarframework#8552
pdanpdan · Mar 16, 2021 · d2b2a11 · d2b2a11
1 parent 535c9dd
commit d2b2a11
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 11 deletions.
diff --git a/ui/build/build.types.js b/ui/build/build.types.js
@@ -366,7 +366,7 @@ function writeIndexDTS (apis) {
     const injectionDefs = injections[key]
     if (injectionDefs) {
       const injectionName = `${key.toUpperCase().replace('$', '')}VueGlobals`
-      writeLine(contents, `import { ${injectionName} } from "./globals";`)
+      writeLine(contents, `import { ${injectionName}, BaseQGlobals } from "./globals";`)
       writeLine(contents, `declare module "./globals" {`)
       writeLine(contents, `export interface ${injectionName} {`)
       for (const defKey in injectionDefs) {
@@ -395,7 +395,7 @@ function writeIndexDTS (apis) {
 
   quasarTypeContents.forEach(line => write(contents, line))
 
-  writeLine(contents, `export const Quasar: PluginObject<Partial<QuasarPluginOptions>>`)
+  writeLine(contents, `export const Quasar: PluginObject<Partial<QuasarPluginOptions>> & BaseQGlobals`)
   writeLine(contents, `export default Quasar`)
   writeLine(contents)
 

diff --git a/ui/types/globals.d.ts b/ui/types/globals.d.ts
@@ -1,5 +1,11 @@
 import { QuasarIconSet } from "./extras/icon-set";
-import { HasCapacitor, HasCordova, HasElectron, HasSsr, HasBex } from './feature-flag'
+import {
+  HasCapacitor,
+  HasCordova,
+  HasElectron,
+  HasSsr,
+  HasBex,
+} from "./feature-flag";
 import { QuasarLanguage } from "./lang";
 
 // We cannot reference directly Capacitor/Cordova/Electron types
@@ -20,14 +26,24 @@ export interface GlobalQuasarLanguage extends QuasarLanguage {
   getLocale(): string | undefined;
 }
 
-export interface GlobalQuasarIconSet extends QuasarIconSet {
-  set(iconSet: QuasarIconSet): void;
-}
+export interface GlobalQuasarIconSet
+  extends QuasarIconSet,
+    HasSsr<
+      // QSsrContext interface depends on q/app, making it available into UI package adds complexity without any real benefit
+      { set(iconSet: QuasarIconSet, ssrContext: any): void },
+      { set(iconSet: QuasarIconSet): void }
+    > {}
 
 type GlobalQuasarIconMapFn = (
   iconName: string
 ) => { icon: string } | { cls: string; content?: string } | void;
 
+export interface BaseQGlobals {
+  version: string;
+  lang: GlobalQuasarLanguage;
+  iconSet: GlobalQuasarIconSet;
+}
+
 export interface QVueGlobals
   extends HasCapacitor<{ capacitor: any }>,
     HasBex<{ bex: GlobalsTypesHolder["bex"] }>,
@@ -36,8 +52,5 @@ export interface QVueGlobals
     HasSsr<
       { iconMapFn?: GlobalQuasarIconMapFn },
       { iconMapFn: GlobalQuasarIconMapFn }
-    > {
-  version: string;
-  lang: GlobalQuasarLanguage;
-  iconSet: GlobalQuasarIconSet;
-}
+    >,
+    BaseQGlobals {}