@grafana/scenes 0.0.32 → 0.1.0

package/dist/index.d.ts

@@ -131,7 +131,7 @@ interface SceneObject<TState extends SceneObjectState = SceneObjectState> {
     /** This abtractions declares what variables the scene object depends on and how to handle when they change value. **/
     readonly variableDependency?: SceneVariableDependencyConfigLike;
     /** This abstraction declares URL sync dependencies of a scene object. **/
-    readonly urlSync?: SceneObjectUrlSyncHandler<TState>;
+    readonly urlSync?: SceneObjectUrlSyncHandler;
     /** Subscribe to state changes */
     subscribeToState(handler: SceneStateChangedHandler<TState>): Unsubscribable;
     /** Subscribe to a scene event */
@@ -191,13 +191,13 @@ interface SceneObjectRef {
     ref: SceneObject;
 }
 declare function isSceneObject(obj: any): obj is SceneObject;
-interface SceneObjectWithUrlSync<TState> extends SceneObject {
-    getUrlState(state: TState): SceneObjectUrlValues;
+interface SceneObjectWithUrlSync extends SceneObject {
+    getUrlState(): SceneObjectUrlValues;
     updateFromUrl(values: SceneObjectUrlValues): void;
 }
-interface SceneObjectUrlSyncHandler<TState> {
+interface SceneObjectUrlSyncHandler {
     getKeys(): string[];
-    getUrlState(state: TState): SceneObjectUrlValues;
+    getUrlState(): SceneObjectUrlValues;
     updateFromUrl(values: SceneObjectUrlValues): void;
 }
 type SceneObjectUrlValue = string | string[] | undefined | null;
@@ -269,7 +269,7 @@ declare abstract class SceneObjectBase<TState extends SceneObjectState = SceneOb
     protected _parent?: SceneObject;
     protected _subs: Subscription;
     protected _variableDependency: SceneVariableDependencyConfigLike | undefined;
-    protected _urlSync: SceneObjectUrlSyncHandler<TState> | undefined;
+    protected _urlSync: SceneObjectUrlSyncHandler | undefined;
     constructor(state: TState);
     /** Current state */
     get state(): TState;
@@ -280,7 +280,7 @@ declare abstract class SceneObjectBase<TState extends SceneObjectState = SceneOb
     /** Returns variable dependency config */
     get variableDependency(): SceneVariableDependencyConfigLike | undefined;
     /** Returns url sync config */
-    get urlSync(): SceneObjectUrlSyncHandler<TState> | undefined;
+    get urlSync(): SceneObjectUrlSyncHandler | undefined;
     /**
      * Used in render functions when rendering a SceneObject.
      * Wraps the component in an EditWrapper that handles edit mode
@@ -334,21 +334,21 @@ declare class SceneDataNode extends SceneObjectBase<SceneDataNodeState> implemen
 interface SceneObjectUrlSyncConfigOptions {
     keys: string[];
 }
-declare class SceneObjectUrlSyncConfig<TState extends SceneObjectState> implements SceneObjectUrlSyncHandler<TState> {
+declare class SceneObjectUrlSyncConfig implements SceneObjectUrlSyncHandler {
     private _sceneObject;
     private _keys;
-    constructor(_sceneObject: SceneObjectWithUrlSync<TState>, _options: SceneObjectUrlSyncConfigOptions);
+    constructor(_sceneObject: SceneObjectWithUrlSync, _options: SceneObjectUrlSyncConfigOptions);
     getKeys(): string[];
-    getUrlState(state: TState): SceneObjectUrlValues;
+    getUrlState(): SceneObjectUrlValues;
     updateFromUrl(values: SceneObjectUrlValues): void;
 }
 
 declare class SceneTimeRange extends SceneObjectBase<SceneTimeRangeState> implements SceneTimeRangeLike {
-    protected _urlSync: SceneObjectUrlSyncConfig<SceneTimeRangeState>;
+    protected _urlSync: SceneObjectUrlSyncConfig;
     constructor(state?: Partial<SceneTimeRangeState>);
     onTimeRangeChange: (timeRange: TimeRange) => void;
     onRefresh: () => void;
-    getUrlState(state: SceneTimeRangeState): {
+    getUrlState(): {
         from: string;
         to: string;
     };
@@ -583,7 +583,7 @@ interface VariableGetOptionsArgs {
     searchFilter?: string;
 }
 declare abstract class MultiValueVariable<TState extends MultiValueVariableState = MultiValueVariableState> extends SceneObjectBase<TState> implements SceneVariable<TState> {
-    protected _urlSync: SceneObjectUrlSyncHandler<TState>;
+    protected _urlSync: SceneObjectUrlSyncHandler;
     /**
      * The source of value options.
      */
@@ -684,12 +684,12 @@ interface TextBoxVariableState extends SceneVariableState {
     value: string;
 }
 declare class TextBoxVariable extends SceneObjectBase<TextBoxVariableState> implements SceneVariable<TextBoxVariableState> {
-    protected _urlSync: SceneObjectUrlSyncHandler<TextBoxVariableState>;
+    protected _urlSync: SceneObjectUrlSyncHandler;
     constructor(initialState: Partial<TextBoxVariableState>);
     getValue(): VariableValue;
     setValue(newValue: string): void;
     private getKey;
-    getUrlState(state: TextBoxVariableState): {
+    getUrlState(): {
         [x: string]: string;
     };
     updateFromUrl(values: SceneObjectUrlValues): void;
@@ -840,7 +840,7 @@ interface SceneRefreshPickerState extends SceneObjectStatePlain {
 }
 declare class SceneRefreshPicker extends SceneObjectBase<SceneRefreshPickerState> {
     static Component: typeof SceneRefreshPickerRenderer;
-    protected _urlSync: SceneObjectUrlSyncConfig<SceneObjectState>;
+    protected _urlSync: SceneObjectUrlSyncConfig;
     private _intervalTimer;
     constructor(state: Partial<SceneRefreshPickerState>);
     onRefresh: () => void;
@@ -890,11 +890,11 @@ interface SceneGridRowState extends SceneLayoutChildState {
 }
 declare class SceneGridRow extends SceneObjectBase<SceneGridRowState> {
     static Component: typeof SceneGridRowRenderer;
-    protected _urlSync: SceneObjectUrlSyncConfig<SceneGridRowState>;
+    protected _urlSync: SceneObjectUrlSyncConfig;
     constructor(state: SceneGridRowState);
     getGridLayout(): SceneGridLayout;
     onCollapseToggle: () => void;
-    getUrlState(state: SceneGridRowState): {
+    getUrlState(): {
         rowc: string;
     };
     updateFromUrl(values: SceneObjectUrlValues): void;

package/dist/index.js

@@ -293,8 +293,8 @@ class SceneObjectUrlSyncConfig {
   getKeys() {
     return this._keys;
   }
-  getUrlState(state) {
-    return this._sceneObject.getUrlState(state);
+  getUrlState() {
+    return this._sceneObject.getUrlState();
   }
   updateFromUrl(values) {
     this._sceneObject.updateFromUrl(values);
@@ -345,8 +345,8 @@ class SceneTimeRange extends SceneObjectBase {
       this.setState({ value: evaluateTimeRange(this.state.from, this.state.to, this.state.timeZone) });
     };
   }
-  getUrlState(state) {
-    return { from: state.from, to: state.to };
+  getUrlState() {
+    return { from: this.state.from, to: this.state.to };
   }
   updateFromUrl(values) {
     var _a, _b;
@@ -797,7 +797,7 @@ class UrlTimeRangeMacro {
   getValue() {
     var _a;
     const timeRange = getTimeRange$1(this._sceneObject);
-    const urlState = (_a = timeRange.urlSync) == null ? void 0 : _a.getUrlState(timeRange.state);
+    const urlState = (_a = timeRange.urlSync) == null ? void 0 : _a.getUrlState();
     return new SkipFormattingValue(data.urlUtil.toUrlParams(urlState));
   }
   getValueText() {
@@ -1886,9 +1886,9 @@ class MultiValueUrlSyncHandler {
   getKeys() {
     return [this.getKey()];
   }
-  getUrlState(state) {
+  getUrlState() {
     let urlValue = null;
-    let value = state.value;
+    let value = this._sceneObject.state.value;
     if (Array.isArray(value)) {
       urlValue = value.map(String);
     } else {
@@ -2665,8 +2665,8 @@ class TextBoxVariable extends SceneObjectBase {
   getKey() {
     return `var-${this.state.name}`;
   }
-  getUrlState(state) {
-    return { [this.getKey()]: state.value };
+  getUrlState() {
+    return { [this.getKey()]: this.state.value };
   }
   updateFromUrl(values) {
     const update = {};
@@ -2695,7 +2695,7 @@ class UrlSyncManager {
     this.onStateChanged = ({ payload }) => {
       const changedObject = payload.changedObject;
       if (changedObject.urlSync) {
-        const newUrlState = changedObject.urlSync.getUrlState(payload.newState);
+        const newUrlState = changedObject.urlSync.getUrlState();
         const searchParams = runtime.locationService.getSearch();
         const mappedUpdated = {};
         this.urlKeyMapper.rebuldIndex(this.sceneRoot);
@@ -2728,7 +2728,7 @@ class UrlSyncManager {
   syncSceneStateFromUrl(sceneObject, urlParams) {
     if (sceneObject.urlSync) {
       const urlState = {};
-      const currentState = sceneObject.urlSync.getUrlState(sceneObject.state);
+      const currentState = sceneObject.urlSync.getUrlState();
       for (const key of sceneObject.urlSync.getKeys()) {
         const uniqueKey = this.urlKeyMapper.getUniqueKey(key, sceneObject);
         const newValue = urlParams.getAll(uniqueKey);
@@ -3553,8 +3553,8 @@ class SceneGridRow extends SceneObjectBase {
     }
     return layout;
   }
-  getUrlState(state) {
-    return { rowc: state.isCollapsed ? "1" : "0" };
+  getUrlState() {
+    return { rowc: this.state.isCollapsed ? "1" : "0" };
   }
   updateFromUrl(values) {
     const isCollapsed = values.rowc === "1";