(fix) Include common module type declarations in framework (#983)

openmrs · Apr 29, 2024 · a5725bd · a5725bd
1 parent cc953e8
commit a5725bd
Show file tree

Hide file tree

Showing 12 changed files with 12 additions and 41 deletions.
diff --git a/packages/apps/esm-devtools-app/src/declarations.d.ts b/packages/apps/esm-devtools-app/src/declarations.d.ts
diff --git a/packages/apps/esm-implementer-tools-app/src/declarations.d.ts b/packages/apps/esm-implementer-tools-app/src/declarations.d.ts
diff --git a/packages/apps/esm-login-app/src/declarations.d.ts b/packages/apps/esm-login-app/src/declarations.d.ts
diff --git a/packages/apps/esm-offline-tools-app/src/declarations.d.ts b/packages/apps/esm-offline-tools-app/src/declarations.d.ts
@@ -1,7 +1 @@
-declare module '*.svg';
-declare module '*.css';
-declare module '*.scss';
-
-declare module '@carbon/react';
-declare type SideNavProps = {};
 declare type TileProps = {};
diff --git a/packages/apps/esm-primary-navigation-app/src/declarations.d.ts b/packages/apps/esm-primary-navigation-app/src/declarations.d.ts
@@ -1,7 +1 @@
-declare module '*.css';
-declare module '*.scss';
-declare module '@carbon/react';
 declare type HeaderPanelProps = {};
-declare type SideNavProps = {
-  isChildOfHeader?: boolean;
-};
diff --git a/packages/framework/esm-framework/docs/API.md b/packages/framework/esm-framework/docs/API.md
@@ -4541,7 +4541,7 @@ invalid key to this function will result in a type error.
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `key` | ``"error"`` \| ``"change"`` \| ``"close"`` \| ``"other"`` \| ``"actions"`` \| ``"address"`` \| ``"cancel"`` \| ``"confirm"`` \| ``"contactDetails"`` \| ``"errorCopy"`` \| ``"female"`` \| ``"hideDetails"`` \| ``"loading"`` \| ``"male"`` \| ``"patientLists"`` \| ``"relationships"`` \| ``"seeMoreLists"`` \| ``"showDetails"`` \| ``"unknown"`` \| ``"closeAllOpenedWorkspaces"`` \| ``"closingAllWorkspacesPromptBody"`` \| ``"closingAllWorkspacesPromptTitle"`` \| ``"discard"`` \| ``"openAnyway"`` \| ``"unsavedChangesInOpenedWorkspace"`` \| ``"unsavedChangesInWorkspace"`` \| ``"unsavedChangesTitleText"`` \| ``"address1"`` \| ``"address2"`` \| ``"city"`` \| ``"cityVillage"`` \| ``"country"`` \| ``"countyDistrict"`` \| ``"postalCode"`` \| ``"state"`` \| ``"stateProvince"`` | - |
+| `key` | ``"error"`` \| ``"change"`` \| ``"close"`` \| ``"other"`` \| ``"actions"`` \| ``"address"`` \| ``"cancel"`` \| ``"confirm"`` \| ``"contactDetails"`` \| ``"errorCopy"`` \| ``"female"`` \| ``"hideDetails"`` \| ``"loading"`` \| ``"male"`` \| ``"patientLists"`` \| ``"relationships"`` \| ``"seeMoreLists"`` \| ``"showDetails"`` \| ``"unknown"`` \| ``"closeAllOpenedWorkspaces"`` \| ``"closingAllWorkspacesPromptBody"`` \| ``"closingAllWorkspacesPromptTitle"`` \| ``"discard"`` \| ``"hide"`` \| ``"maximize"`` \| ``"minimize"`` \| ``"openAnyway"`` \| ``"unsavedChangesInOpenedWorkspace"`` \| ``"unsavedChangesInWorkspace"`` \| ``"unsavedChangesTitleText"`` \| ``"workspaceHeader"`` \| ``"address1"`` \| ``"address2"`` \| ``"city"`` \| ``"cityVillage"`` \| ``"country"`` \| ``"countyDistrict"`` \| ``"postalCode"`` \| ``"state"`` \| ``"stateProvince"`` | - |
 | `defaultText?` | `string` | - |
 | `options?` | `object` | Object passed to the i18next `t` function. See https://www.i18next.com/translation-function/essentials#overview-options           for more information. `ns` and `defaultValue` are already set and may not be used. |
 
@@ -5604,7 +5604,7 @@ For the patient chart, this is `workspace-header-patient-chart-slot`.
 
 #### Defined in
 
-[packages/framework/esm-styleguide/src/workspaces/window/workspace-window.component.tsx:48](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/window/workspace-window.component.tsx#L48)
+[packages/framework/esm-styleguide/src/workspaces/window/workspace-window.component.tsx:55](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/window/workspace-window.component.tsx#L55)
 
 ___
 

diff --git a/packages/framework/esm-framework/docs/interfaces/WorkspaceWindowProps.md b/packages/framework/esm-framework/docs/interfaces/WorkspaceWindowProps.md
@@ -17,7 +17,7 @@
 
 #### Defined in
 
-[packages/framework/esm-styleguide/src/workspaces/window/workspace-window.component.tsx:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/window/workspace-window.component.tsx#L16)
+[packages/framework/esm-styleguide/src/workspaces/window/workspace-window.component.tsx:23](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/window/workspace-window.component.tsx#L23)
 
 ___
 
@@ -27,4 +27,4 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-styleguide/src/workspaces/window/workspace-window.component.tsx:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/window/workspace-window.component.tsx#L15)
+[packages/framework/esm-styleguide/src/workspaces/window/workspace-window.component.tsx:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/window/workspace-window.component.tsx#L22)
diff --git a/...work/esm-styleguide/src/declarations.d.ts → ...ework/esm-framework/src/declarations.d.ts b/...work/esm-styleguide/src/declarations.d.ts → ...ework/esm-framework/src/declarations.d.ts
@@ -1,10 +1,11 @@
 declare module '@carbon/react';
+declare type SideNavProps = {
+  isChildOfHeader?: boolean;
+};
+declare module '*.css';
+declare module '*.scss';
 declare module '*.svg' {
   const content: string;
   export = content;
 }
-declare module '*.css';
-declare module '*.scss';
-declare type SideNavProps = {
-  isChildOfHeader?: boolean;
-};
+declare module '*.png';
diff --git a/packages/framework/esm-framework/src/index.ts b/packages/framework/esm-framework/src/index.ts
@@ -1,3 +1,5 @@
+/// <reference path="./declarations.d.ts" />
+
 export * from '@openmrs/esm-api/src/public';
 export * from '@openmrs/esm-config/src/public';
 export * from '@openmrs/esm-dynamic-loading/src/public';

diff --git a/packages/framework/esm-styleguide/src/icons/index.ts b/packages/framework/esm-styleguide/src/icons/index.ts
@@ -1,5 +1,3 @@
-/// <reference path="../declarations.d.ts" />
-
 import visibility from './svgs/visibility_24px_rounded.svg';
 import menu from './svgs/menu_24px_rounded.svg';
 import search from './svgs/search_24px_rounded.svg';

diff --git a/packages/framework/esm-styleguide/src/logo/index.ts b/packages/framework/esm-styleguide/src/logo/index.ts
@@ -1,5 +1,3 @@
-/// <reference path="../declarations.d.ts" />
-
 import fullLogo from './openmrs-logo-full.svg';
 import partialLogo from './openmrs-logo-partial.svg';
 import iconLogo from './openmrs-logo-icon.svg';

diff --git a/packages/shell/esm-app-shell/src/declarations.d.ts b/packages/shell/esm-app-shell/src/declarations.d.ts
@@ -1,5 +1,3 @@
-declare module '*.css';
-declare module '*.scss';
 declare const __webpack_share_scopes__: Record<
   string,
   Record<string, { loaded?: 1; get: () => Promise<unknown>; from: string; eager: boolean }>