@perses-dev/dashboards 0.16.0 → 0.18.0

package/dist/context/TimeRangeProvider/query-params.js

@@ -1,149 +0,0 @@
-// Copyright 2022 The Perses Authors
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-import { useMemo, useCallback, useEffect, useState } from 'react';
-import { useQueryParams } from 'use-query-params';
-import { getUnixTime, isDate } from 'date-fns';
-import { isRelativeTimeRange, isDurationString } from '@perses-dev/core';
-/* Interprets an encoded string and returns either the string or null/undefined if not available */ function getEncodedValue(input, allowEmptyString) {
-    if (input == null) {
-        return input;
-    }
-    // '' or []
-    if (input.length === 0 && (!allowEmptyString || allowEmptyString && input !== '')) {
-        return null;
-    }
-    const str = input instanceof Array ? input[0] : input;
-    if (str == null) {
-        return str;
-    }
-    if (!allowEmptyString && str === '') {
-        return null;
-    }
-    return str;
-}
-/* Encodes individual TimeRangeValue as a string, depends on whether start is relative or absolute */ export function encodeTimeRangeValue(timeOptionValue) {
-    if (!timeOptionValue) {
-        return timeOptionValue;
-    }
-    if (typeof timeOptionValue === 'string') {
-        if (isDurationString(timeOptionValue)) {
-            return timeOptionValue;
-        }
-    }
-    return (getUnixTime(timeOptionValue) * 1000).toString();
-}
-/* Converts param input to supported relative or absolute time range format */ export function decodeTimeRangeValue(input) {
-    const paramString = getEncodedValue(input);
-    if (paramString == null) return paramString;
-    return isDurationString(paramString) ? paramString : new Date(Number(paramString));
-}
-/**
- * Custom TimeRangeValue param type
- * See: https://github.com/pbeshai/use-query-params/tree/master/packages/serialize-query-params#param-types
- */ export const TimeRangeParam = {
-    encode: encodeTimeRangeValue,
-    decode: decodeTimeRangeValue,
-    equals: (valueA, valueB)=>{
-        if (valueA === valueB) return true;
-        if (valueA == null || valueB == null) return valueA === valueB;
-        return valueA.valueOf() === valueB.valueOf();
-    }
-};
-export const timeRangeQueryConfig = {
-    start: TimeRangeParam,
-    end: TimeRangeParam
-};
-/**
- * Gets the initial time range taking into account URL params and dashboard JSON duration
- * Sets start query param if it is empty on page load
- */ export function useInitialTimeRange(dashboardDuration) {
-    const [query] = useQueryParams(timeRangeQueryConfig);
-    const { start , end  } = query;
-    return useMemo(()=>{
-        let initialTimeRange = {
-            pastDuration: dashboardDuration
-        };
-        if (!start) {
-            return initialTimeRange;
-        }
-        const startStr = start.toString();
-        if (isDurationString(startStr)) {
-            initialTimeRange = {
-                pastDuration: startStr
-            };
-        } else if (isDate(start) && isDate(end)) {
-            initialTimeRange = {
-                start: start,
-                end: end
-            };
-        }
-        return initialTimeRange;
-    }, [
-        start,
-        end,
-        dashboardDuration
-    ]);
-}
-/**
- * Returns time range getter and setter, set enabledURLParams to false to disable query string serialization
- */ export function useSetTimeRangeParams(initialTimeRange, enabledURLParams = true) {
-    const [query, setQuery] = useQueryParams(timeRangeQueryConfig);
-    // determine whether initial param had previously been populated to fix back btn
-    const [paramsLoaded, setParamsLoaded] = useState(false);
-    // optional fallback when app does not want query string as source of truth
-    // this occurs when enabledURLParams is set to false on TimeRangeProvider
-    const [timeRangeState, setTimeRangeState] = useState(initialTimeRange);
-    const { start  } = query;
-    useEffect(()=>{
-        // when dashboard loaded with no params, default to dashboard duration
-        if (enabledURLParams && !paramsLoaded && !start) {
-            if (isRelativeTimeRange(initialTimeRange)) {
-                setQuery({
-                    start: initialTimeRange.pastDuration,
-                    end: undefined
-                });
-                setParamsLoaded(true);
-            }
-        }
-    }, [
-        initialTimeRange,
-        enabledURLParams,
-        paramsLoaded,
-        start,
-        setQuery
-    ]);
-    const setTimeRange = useCallback((value)=>{
-        if (isRelativeTimeRange(value)) {
-            setQuery({
-                start: value.pastDuration,
-                end: undefined
-            });
-        } else {
-            setQuery(value);
-        }
-    }, [
-        setQuery
-    ]);
-    if (!enabledURLParams) {
-        return {
-            timeRange: timeRangeState,
-            setTimeRange: setTimeRangeState
-        };
-    }
-    return {
-        timeRange: initialTimeRange,
-        setTimeRange: setTimeRange
-    };
-}
-
-//# sourceMappingURL=query-params.js.map

package/dist/context/TimeRangeProvider/query-params.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../src/context/TimeRangeProvider/query-params.ts"],"sourcesContent":["// Copyright 2022 The Perses Authors\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\nimport { useMemo, useCallback, useEffect, useState } from 'react';\nimport { useQueryParams, QueryParamConfig } from 'use-query-params';\nimport { getUnixTime, isDate } from 'date-fns';\nimport {\n  TimeRangeValue,\n  isRelativeTimeRange,\n  isDurationString,\n  DurationString,\n  AbsoluteTimeRange,\n} from '@perses-dev/core';\nimport { TimeRange } from '@perses-dev/plugin-system';\n\nexport type TimeOptionValue = Date | DurationString | null | undefined;\n\n/* Interprets an encoded string and returns either the string or null/undefined if not available */\nfunction getEncodedValue(\n  input: string | Array<string | null> | null | undefined,\n  allowEmptyString?: boolean\n): string | null | undefined {\n  if (input == null) {\n    return input;\n  }\n  // '' or []\n  if (input.length === 0 && (!allowEmptyString || (allowEmptyString && input !== ''))) {\n    return null;\n  }\n\n  const str = input instanceof Array ? input[0] : input;\n  if (str == null) {\n    return str;\n  }\n  if (!allowEmptyString && str === '') {\n    return null;\n  }\n\n  return str;\n}\n\n/* Encodes individual TimeRangeValue as a string, depends on whether start is relative or absolute */\nexport function encodeTimeRangeValue(timeOptionValue: TimeOptionValue): string | null | undefined {\n  if (!timeOptionValue) {\n    return timeOptionValue;\n  }\n\n  if (typeof timeOptionValue === 'string') {\n    if (isDurationString(timeOptionValue)) {\n      return timeOptionValue;\n    }\n  }\n  return (getUnixTime(timeOptionValue) * 1000).toString();\n}\n\n/* Converts param input to supported relative or absolute time range format */\nexport function decodeTimeRangeValue(\n  input: string | Array<string | null> | null | undefined\n): Date | DurationString | null | undefined {\n  const paramString = getEncodedValue(input);\n  if (paramString == null) return paramString;\n  return isDurationString(paramString) ? paramString : new Date(Number(paramString));\n}\n\n/**\n * Custom TimeRangeValue param type\n * See: https://github.com/pbeshai/use-query-params/tree/master/packages/serialize-query-params#param-types\n */\nexport const TimeRangeParam: QueryParamConfig<TimeOptionValue, TimeOptionValue> = {\n  encode: encodeTimeRangeValue,\n  decode: decodeTimeRangeValue,\n  equals: (valueA: TimeOptionValue, valueB: TimeOptionValue) => {\n    if (valueA === valueB) return true;\n    if (valueA == null || valueB == null) return valueA === valueB;\n    return valueA.valueOf() === valueB.valueOf();\n  },\n};\n\nexport const timeRangeQueryConfig = {\n  start: TimeRangeParam,\n  end: TimeRangeParam,\n};\n\n/**\n * Gets the initial time range taking into account URL params and dashboard JSON duration\n * Sets start query param if it is empty on page load\n */\nexport function useInitialTimeRange(dashboardDuration: DurationString): TimeRangeValue {\n  const [query] = useQueryParams(timeRangeQueryConfig);\n  const { start, end } = query;\n  return useMemo(() => {\n    let initialTimeRange: TimeRangeValue = { pastDuration: dashboardDuration };\n    if (!start) {\n      return initialTimeRange;\n    }\n    const startStr = start.toString();\n    if (isDurationString(startStr)) {\n      initialTimeRange = { pastDuration: startStr };\n    } else if (isDate(start) && isDate(end)) {\n      initialTimeRange = { start: start, end: end } as AbsoluteTimeRange;\n    }\n    return initialTimeRange;\n  }, [start, end, dashboardDuration]);\n}\n\n/**\n * Returns time range getter and setter, set enabledURLParams to false to disable query string serialization\n */\nexport function useSetTimeRangeParams(initialTimeRange: TimeRangeValue, enabledURLParams = true): TimeRange {\n  const [query, setQuery] = useQueryParams(timeRangeQueryConfig);\n\n  // determine whether initial param had previously been populated to fix back btn\n  const [paramsLoaded, setParamsLoaded] = useState<boolean>(false);\n\n  // optional fallback when app does not want query string as source of truth\n  // this occurs when enabledURLParams is set to false on TimeRangeProvider\n  const [timeRangeState, setTimeRangeState] = useState<TimeRangeValue>(initialTimeRange);\n\n  const { start } = query;\n\n  useEffect(() => {\n    // when dashboard loaded with no params, default to dashboard duration\n    if (enabledURLParams && !paramsLoaded && !start) {\n      if (isRelativeTimeRange(initialTimeRange)) {\n        setQuery({ start: initialTimeRange.pastDuration, end: undefined });\n        setParamsLoaded(true);\n      }\n    }\n  }, [initialTimeRange, enabledURLParams, paramsLoaded, start, setQuery]);\n\n  const setTimeRange: TimeRange['setTimeRange'] = useCallback(\n    (value: TimeRangeValue) => {\n      if (isRelativeTimeRange(value)) {\n        setQuery({ start: value.pastDuration, end: undefined });\n      } else {\n        setQuery(value);\n      }\n    },\n    [setQuery]\n  );\n\n  if (!enabledURLParams) {\n    return { timeRange: timeRangeState, setTimeRange: setTimeRangeState };\n  }\n  return { timeRange: initialTimeRange, setTimeRange: setTimeRange };\n}\n"],"names":["useMemo","useCallback","useEffect","useState","useQueryParams","getUnixTime","isDate","isRelativeTimeRange","isDurationString","getEncodedValue","input","allowEmptyString","length","str","Array","encodeTimeRangeValue","timeOptionValue","toString","decodeTimeRangeValue","paramString","Date","Number","TimeRangeParam","encode","decode","equals","valueA","valueB","valueOf","timeRangeQueryConfig","start","end","useInitialTimeRange","dashboardDuration","query","initialTimeRange","pastDuration","startStr","useSetTimeRangeParams","enabledURLParams","setQuery","paramsLoaded","setParamsLoaded","timeRangeState","setTimeRangeState","undefined","setTimeRange","value","timeRange"],"mappings":"AAAA,oCAAoC;AACpC,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,6CAA6C;AAC7C,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AAEjC,SAASA,OAAO,EAAEC,WAAW,EAAEC,SAAS,EAAEC,QAAQ,QAAQ,OAAO,CAAC;AAClE,SAASC,cAAc,QAA0B,kBAAkB,CAAC;AACpE,SAASC,WAAW,EAAEC,MAAM,QAAQ,UAAU,CAAC;AAC/C,SAEEC,mBAAmB,EACnBC,gBAAgB,QAGX,kBAAkB,CAAC;AAK1B,iGAAiG,GACjG,SAASC,eAAe,CACtBC,KAAuD,EACvDC,gBAA0B,EACC;IAC3B,IAAID,KAAK,IAAI,IAAI,EAAE;QACjB,OAAOA,KAAK,CAAC;IACf,CAAC;IACD,WAAW;IACX,IAAIA,KAAK,CAACE,MAAM,KAAK,CAAC,IAAK,CAAA,CAACD,gBAAgB,IAAKA,gBAAgB,IAAID,KAAK,KAAK,EAAE,AAAC,CAAA,AAAC,EAAE;QACnF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAMG,GAAG,GAAGH,KAAK,YAAYI,KAAK,GAAGJ,KAAK,CAAC,CAAC,CAAC,GAAGA,KAAK,AAAC;IACtD,IAAIG,GAAG,IAAI,IAAI,EAAE;QACf,OAAOA,GAAG,CAAC;IACb,CAAC;IACD,IAAI,CAACF,gBAAgB,IAAIE,GAAG,KAAK,EAAE,EAAE;QACnC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAOA,GAAG,CAAC;AACb,CAAC;AAED,mGAAmG,GACnG,OAAO,SAASE,oBAAoB,CAACC,eAAgC,EAA6B;IAChG,IAAI,CAACA,eAAe,EAAE;QACpB,OAAOA,eAAe,CAAC;IACzB,CAAC;IAED,IAAI,OAAOA,eAAe,KAAK,QAAQ,EAAE;QACvC,IAAIR,gBAAgB,CAACQ,eAAe,CAAC,EAAE;YACrC,OAAOA,eAAe,CAAC;QACzB,CAAC;IACH,CAAC;IACD,OAAO,AAACX,CAAAA,WAAW,CAACW,eAAe,CAAC,GAAG,IAAI,CAAA,CAAEC,QAAQ,EAAE,CAAC;AAC1D,CAAC;AAED,4EAA4E,GAC5E,OAAO,SAASC,oBAAoB,CAClCR,KAAuD,EACb;IAC1C,MAAMS,WAAW,GAAGV,eAAe,CAACC,KAAK,CAAC,AAAC;IAC3C,IAAIS,WAAW,IAAI,IAAI,EAAE,OAAOA,WAAW,CAAC;IAC5C,OAAOX,gBAAgB,CAACW,WAAW,CAAC,GAAGA,WAAW,GAAG,IAAIC,IAAI,CAACC,MAAM,CAACF,WAAW,CAAC,CAAC,CAAC;AACrF,CAAC;AAED;;;CAGC,GACD,OAAO,MAAMG,cAAc,GAAuD;IAChFC,MAAM,EAAER,oBAAoB;IAC5BS,MAAM,EAAEN,oBAAoB;IAC5BO,MAAM,EAAE,CAACC,MAAuB,EAAEC,MAAuB,GAAK;QAC5D,IAAID,MAAM,KAAKC,MAAM,EAAE,OAAO,IAAI,CAAC;QACnC,IAAID,MAAM,IAAI,IAAI,IAAIC,MAAM,IAAI,IAAI,EAAE,OAAOD,MAAM,KAAKC,MAAM,CAAC;QAC/D,OAAOD,MAAM,CAACE,OAAO,EAAE,KAAKD,MAAM,CAACC,OAAO,EAAE,CAAC;IAC/C,CAAC;CACF,CAAC;AAEF,OAAO,MAAMC,oBAAoB,GAAG;IAClCC,KAAK,EAAER,cAAc;IACrBS,GAAG,EAAET,cAAc;CACpB,CAAC;AAEF;;;CAGC,GACD,OAAO,SAASU,mBAAmB,CAACC,iBAAiC,EAAkB;IACrF,MAAM,CAACC,KAAK,CAAC,GAAG9B,cAAc,CAACyB,oBAAoB,CAAC,AAAC;IACrD,MAAM,EAAEC,KAAK,CAAA,EAAEC,GAAG,CAAA,EAAE,GAAGG,KAAK,AAAC;IAC7B,OAAOlC,OAAO,CAAC,IAAM;QACnB,IAAImC,gBAAgB,GAAmB;YAAEC,YAAY,EAAEH,iBAAiB;SAAE,AAAC;QAC3E,IAAI,CAACH,KAAK,EAAE;YACV,OAAOK,gBAAgB,CAAC;QAC1B,CAAC;QACD,MAAME,QAAQ,GAAGP,KAAK,CAACb,QAAQ,EAAE,AAAC;QAClC,IAAIT,gBAAgB,CAAC6B,QAAQ,CAAC,EAAE;YAC9BF,gBAAgB,GAAG;gBAAEC,YAAY,EAAEC,QAAQ;aAAE,CAAC;QAChD,OAAO,IAAI/B,MAAM,CAACwB,KAAK,CAAC,IAAIxB,MAAM,CAACyB,GAAG,CAAC,EAAE;YACvCI,gBAAgB,GAAG;gBAAEL,KAAK,EAAEA,KAAK;gBAAEC,GAAG,EAAEA,GAAG;aAAE,AAAqB,CAAC;QACrE,CAAC;QACD,OAAOI,gBAAgB,CAAC;IAC1B,CAAC,EAAE;QAACL,KAAK;QAAEC,GAAG;QAAEE,iBAAiB;KAAC,CAAC,CAAC;AACtC,CAAC;AAED;;CAEC,GACD,OAAO,SAASK,qBAAqB,CAACH,gBAAgC,EAAEI,gBAAgB,GAAG,IAAI,EAAa;IAC1G,MAAM,CAACL,KAAK,EAAEM,QAAQ,CAAC,GAAGpC,cAAc,CAACyB,oBAAoB,CAAC,AAAC;IAE/D,gFAAgF;IAChF,MAAM,CAACY,YAAY,EAAEC,eAAe,CAAC,GAAGvC,QAAQ,CAAU,KAAK,CAAC,AAAC;IAEjE,2EAA2E;IAC3E,yEAAyE;IACzE,MAAM,CAACwC,cAAc,EAAEC,iBAAiB,CAAC,GAAGzC,QAAQ,CAAiBgC,gBAAgB,CAAC,AAAC;IAEvF,MAAM,EAAEL,KAAK,CAAA,EAAE,GAAGI,KAAK,AAAC;IAExBhC,SAAS,CAAC,IAAM;QACd,sEAAsE;QACtE,IAAIqC,gBAAgB,IAAI,CAACE,YAAY,IAAI,CAACX,KAAK,EAAE;YAC/C,IAAIvB,mBAAmB,CAAC4B,gBAAgB,CAAC,EAAE;gBACzCK,QAAQ,CAAC;oBAAEV,KAAK,EAAEK,gBAAgB,CAACC,YAAY;oBAAEL,GAAG,EAAEc,SAAS;iBAAE,CAAC,CAAC;gBACnEH,eAAe,CAAC,IAAI,CAAC,CAAC;YACxB,CAAC;QACH,CAAC;IACH,CAAC,EAAE;QAACP,gBAAgB;QAAEI,gBAAgB;QAAEE,YAAY;QAAEX,KAAK;QAAEU,QAAQ;KAAC,CAAC,CAAC;IAExE,MAAMM,YAAY,GAA8B7C,WAAW,CACzD,CAAC8C,KAAqB,GAAK;QACzB,IAAIxC,mBAAmB,CAACwC,KAAK,CAAC,EAAE;YAC9BP,QAAQ,CAAC;gBAAEV,KAAK,EAAEiB,KAAK,CAACX,YAAY;gBAAEL,GAAG,EAAEc,SAAS;aAAE,CAAC,CAAC;QAC1D,OAAO;YACLL,QAAQ,CAACO,KAAK,CAAC,CAAC;QAClB,CAAC;IACH,CAAC,EACD;QAACP,QAAQ;KAAC,CACX,AAAC;IAEF,IAAI,CAACD,gBAAgB,EAAE;QACrB,OAAO;YAAES,SAAS,EAAEL,cAAc;YAAEG,YAAY,EAAEF,iBAAiB;SAAE,CAAC;IACxE,CAAC;IACD,OAAO;QAAEI,SAAS,EAAEb,gBAAgB;QAAEW,YAAY,EAAEA,YAAY;KAAE,CAAC;AACrE,CAAC"}