@limetech/lime-web-components-interfaces
Advanced tools
Comparing version 4.47.4 to 4.49.1-alpha.0
@@ -6,2 +6,83 @@ # Change Log | ||
## [4.49.1-alpha.0](https://github.com/Lundalogik/lime-web-components/compare/v4.49.0-alpha.0...v4.49.1-alpha.0) (2022-07-04) | ||
**Note:** Version bump only for package @limetech/lime-web-components-interfaces | ||
# [4.49.0-alpha.0](https://github.com/Lundalogik/lime-web-components/compare/v4.48.1...v4.49.0-alpha.0) (2022-06-29) | ||
# [4.46.0-alpha.2](https://github.com/Lundalogik/lime-web-components/compare/v4.46.0...v4.46.0-alpha.2) (2022-05-25) | ||
### Bug Fixes | ||
* **docs:** add deprecation note ([a7bf0c5](https://github.com/Lundalogik/lime-web-components/commit/a7bf0c5dedb1dfb2b1452be370b543374b9809cc)) | ||
# [4.46.0-alpha.0](https://github.com/Lundalogik/lime-web-components/compare/v4.45.3...v4.46.0-alpha.0) (2022-05-12) | ||
# [4.42.0-alpha.0](https://github.com/Lundalogik/lime-web-components/compare/v4.41.10...v4.42.0-alpha.0) (2022-04-14) | ||
# [4.24.0-alpha.0](https://github.com/Lundalogik/lime-web-components/compare/v4.41.6...v4.24.0-alpha.0) (2022-03-25) | ||
### Bug Fixes | ||
* **interfaces:** revert unintentional breaking changes ([bbb08f7](https://github.com/Lundalogik/lime-web-components/commit/bbb08f704d0a22f49f3bb457180d1641b023b2d6)) | ||
### Features | ||
* **config:** move interface to `@limetech/lime-web-components` ([d6b12bd](https://github.com/Lundalogik/lime-web-components/commit/d6b12bdf49b0a0a39f542d7899e3db67f5f38840)) | ||
* **device:** move interface to `@limetech/lime-web-components` ([3ec207b](https://github.com/Lundalogik/lime-web-components/commit/3ec207b4737e6c1592bd46125e4bdd8160ff8be0)) | ||
* **dialog:** move interface to `@limetech/lime-web-components` ([ce8f8fc](https://github.com/Lundalogik/lime-web-components/commit/ce8f8fca810e649cda82c6bb152d9959898dbf89)) | ||
* **filter:** move interface to `@limetech/lime-web-components` ([624afa4](https://github.com/Lundalogik/lime-web-components/commit/624afa4e78dd89da4140b0c74f3a82928dcf6936)) | ||
* **keybindings:** move interface to `@limetech/lime-web-components` ([c867376](https://github.com/Lundalogik/lime-web-components/commit/c86737653045fd2123345bde0123e92a384b9205)) | ||
* **limeobject:** move interface to `@limetech/lime-web-components` ([167d5a2](https://github.com/Lundalogik/lime-web-components/commit/167d5a24d2bbb51632be64a1271e66f957bd9458)) | ||
* **limeobject:** move interface to `@limetech/lime-web-components` ([ab608b3](https://github.com/Lundalogik/lime-web-components/commit/ab608b38288aa24289f1486bed6eabe0189f1174)) | ||
* **navigator:** move interface to `@limetech/lime-web-components` ([603510e](https://github.com/Lundalogik/lime-web-components/commit/603510e57a09b8e2faedeb464e7a1206388f93fe)) | ||
* **notifications:** move interface to `@limetech/lime-web-components` ([f69a1fc](https://github.com/Lundalogik/lime-web-components/commit/f69a1fcf7be22409e35381b278cb74c9199bbe87)) | ||
* **query:** move interface to `@limetech/lime-web-components` ([e2f5c9f](https://github.com/Lundalogik/lime-web-components/commit/e2f5c9faa38041150161ee71d1ec315fead147e4)) | ||
* **router:** move interface to `@limetech/lime-web-components` ([fa3d83c](https://github.com/Lundalogik/lime-web-components/commit/fa3d83c8291bf08b68b99d5d3fa78154d88c26a8)) | ||
* **session:** move interface to `@limetech/lime-web-components` ([1b005c8](https://github.com/Lundalogik/lime-web-components/commit/1b005c842d555b097c32114f7a8f1a5d064ae86a)) | ||
* **state:** move interface to `@limetech/lime-web-components` ([91970f4](https://github.com/Lundalogik/lime-web-components/commit/91970f4a150708a20afb292eeb9d740b47ff416b)) | ||
* **task:** move interface to `@limetech/lime-web-components` ([65a6f46](https://github.com/Lundalogik/lime-web-components/commit/65a6f46d30da7971ef5d5f6d746632b0f808ea76)) | ||
* **translator:** move interface to `@limetech/lime-web-components` ([38b2890](https://github.com/Lundalogik/lime-web-components/commit/38b2890833e06736cd0d02f40f3e3f3635018212)) | ||
* **user:** move interface to `@limetech/lime-web-components` ([0c75aa5](https://github.com/Lundalogik/lime-web-components/commit/0c75aa5bd4e2b9c7fa35407a91a383c18edb7ce3)) | ||
* **userdata:** move interface to `@limetech/lime-web-components` ([b4adf23](https://github.com/Lundalogik/lime-web-components/commit/b4adf238bc0013d23331a718a210f823705a8358)) | ||
## [4.23.3-alpha.3](https://github.com/Lundalogik/lime-web-components/compare/v4.41.3...v4.23.3-alpha.3) (2022-03-21) | ||
## [4.23.3-alpha.2](https://github.com/Lundalogik/lime-web-components/compare/v4.29.2...v4.23.3-alpha.2) (2021-11-15) | ||
## [4.23.3-alpha.1](https://github.com/Lundalogik/lime-web-components/compare/v4.24.0...v4.23.3-alpha.1) (2021-09-28) | ||
## [4.23.3-alpha.0](https://github.com/Lundalogik/lime-web-components/compare/v4.23.3...v4.23.3-alpha.0) (2021-09-27) | ||
## [4.13.3-alpha.0](https://github.com/Lundalogik/lime-web-components/compare/v4.13.2...v4.13.3-alpha.0) (2021-02-26) | ||
## [4.47.4](https://github.com/Lundalogik/lime-web-components/compare/v4.47.3...v4.47.4) (2022-06-17) | ||
@@ -8,0 +89,0 @@ |
/** | ||
* Service for creating and displaying dialogs containing a web component | ||
* | ||
* @emits dialog.destroyed - When the dialog is beeing externally destroyed, | ||
* e.g. by closing a popup window (depending on platform), a | ||
* {@link DialogDestroyedEvent} will be emitted using | ||
* {@link EventDispatcherService} | ||
*/ | ||
export interface DialogService { | ||
/** | ||
* Create a new dialog and render its contents. Depending on what kind of | ||
* platform the service is used on, the dialog might be rendered in the | ||
* current {@link Document} or opened in a new popup window. | ||
* Create a new dialog | ||
* | ||
* @param name the name of the web component to render in the dialog | ||
* @param name the name of the dialog. The name is the same as the tag name for the web component | ||
* @param properties any properties to send to the dialog | ||
@@ -41,6 +34,1 @@ * @param listeners any event listeners to register on the dialog | ||
} | ||
/** | ||
* @event dialog.destroyed - Emitted when a dialog is externally destroyed, e.g. | ||
* by closing a popup window | ||
*/ | ||
export declare type DialogDestroyedEvent = CustomEvent<number>; |
@@ -37,12 +37,5 @@ /** | ||
* | ||
* By default, it is automatically decided whether to replace the current | ||
* history entry or push a new one. If no new path is provided, or if it | ||
* resolves to an unchanged path of the URL (not including the query string | ||
* or fragment), the current history entry will be updated with the | ||
* provided location data. | ||
* If no new path is provided, the current history entry will be updated | ||
* with the provided location data. | ||
* | ||
* You can also set `location.method` to push or replace instead. | ||
* When pushing a new entry, `location.state` defaults to `null`. | ||
* When replacing, state will only be changed if a new value is provided. | ||
* | ||
* @emits navigate - When the location has been changed the | ||
@@ -53,3 +46,3 @@ * {@link EventDispatcherService} will emit a {@link NavigationEvent} | ||
*/ | ||
navigate(location: LocationChange): void; | ||
navigate(location: Partial<Location>): void; | ||
/** | ||
@@ -61,47 +54,2 @@ * Get the current location | ||
getLocation(): Location; | ||
/** | ||
* Add a blocker that can prevent navigation away from the current page, for | ||
* example when there is some unsaved data that would otherwise be discarded. | ||
* | ||
* If the blocker function returns true navigation is blocked. If it returns | ||
* false navigation will proceed as normal, if not blocked by other blockers. | ||
* | ||
* To later on resume navigation that was blocked, you can call the supplied | ||
* {@link Transition.retry} method. | ||
* | ||
* @note Blockers are not guaranteed to be executed upon a navigation event. | ||
* Blockers will be executed until either all returns false or up until one | ||
* of them returns true. | ||
* | ||
* @example | ||
* navigator.addBlocker(myBlocker); | ||
* | ||
* function myBlocker(transition) { | ||
* showConfirmDialog().then((shouldNavigate) => { | ||
* if (shouldNavigate) { | ||
* navigator.removeBlocker(myBlocker); | ||
* transition.retry() | ||
* } | ||
* }); | ||
* return true; | ||
* } | ||
* | ||
* @param {Blocker} blocker function to be called before navigation | ||
*/ | ||
addBlocker(blocker: Blocker): void; | ||
/** | ||
* Removes a previously configured blocker. | ||
* | ||
* @param {Blocker} blocker previously added blocker function | ||
*/ | ||
removeBlocker(blocker: Blocker): void; | ||
/** | ||
* Create a URL for the given location | ||
* | ||
* @param {Partial<Location>} location the location to create a URL for. | ||
* Any `state` of the location will be ignored. | ||
* | ||
* @return {URL} the URL to the location | ||
*/ | ||
createUrl(location: Partial<Location>): URL; | ||
} | ||
@@ -126,9 +74,2 @@ export declare type Location = { | ||
}; | ||
export declare type LocationChange = Partial<Location> & { | ||
/** | ||
* Specifies whether to push a new entry or replace the current entry in | ||
* the history stack | ||
*/ | ||
method?: 'push' | 'replace'; | ||
}; | ||
/** | ||
@@ -139,25 +80,1 @@ * @event navigate - Emitted when a new location is navigated to or the current | ||
export declare type NavigationEvent = CustomEvent<Location>; | ||
/** | ||
* Function to retry navigation | ||
*/ | ||
export declare type Retry = () => void; | ||
/** | ||
* {@link Transition} describes the transition when navigating from a | ||
* {@link Location} to another {@link Location}. | ||
* | ||
* @param {Location} to location to navigate to | ||
* @param {Location} from current location before navigation | ||
* @param {Retry} retry function to retry navigation | ||
*/ | ||
export declare type Transition = { | ||
to: Location; | ||
from: Location; | ||
retry: Retry; | ||
}; | ||
/** | ||
* Function to determine if navigation should be blocked or not. | ||
* | ||
* @param {Transition} transition the transition to evaluate | ||
* @returns true if navigation should be blocked | ||
*/ | ||
export declare type Blocker = (transition: Transition) => boolean; |
@@ -1,2 +0,2 @@ | ||
import { Subscribable } from 'rxjs'; | ||
import { Observable } from 'rxjs'; | ||
import { LimeWebComponentContext } from '../lime-web-component-context.interface'; | ||
@@ -38,3 +38,3 @@ /** | ||
*/ | ||
context?: Subscribable<LimeWebComponentContext> | null; | ||
context?: Observable<LimeWebComponentContext>; | ||
} | ||
@@ -41,0 +41,0 @@ export * from './state/config-service.interface'; |
@@ -63,6 +63,2 @@ export interface Session { | ||
workstation: string; | ||
/** | ||
* Application service number | ||
*/ | ||
serviceNumber?: number; | ||
} |
{ | ||
"name": "@limetech/lime-web-components-interfaces", | ||
"version": "4.47.4", | ||
"version": "4.49.1-alpha.0", | ||
"author": "Lime Technologies", | ||
@@ -33,3 +33,3 @@ "homepage": "https://github.com/Lundalogik/lime-web-components", | ||
}, | ||
"gitHead": "12630f12008e7edbf643917778f0327e598aa92f" | ||
"gitHead": "baa2a8b9297e122c337cdd78307cd6536cedd55a" | ||
} |
# Lime Web Components Interfaces | ||
**Has been deprecated! All code moved to `@limetech/lime-web-components`** | ||
Part of [Lime Web Components](https://www.npmjs.com/package/@limetech/lime-web-components). |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
259752
457
6898
6
2
1