@perses-dev/core 0.2.1 → 0.4.0

package/dist/cjs/index.js

@@ -0,0 +1,30 @@
+"use strict";
+// Copyright 2021 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.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./model"), exports);
+__exportStar(require("./utils"), exports);

package/dist/cjs/model/dashboard.js

@@ -0,0 +1,14 @@
+"use strict";
+// Copyright 2021 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.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/model/datasource.js

@@ -0,0 +1,14 @@
+"use strict";
+// Copyright 2021 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.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/model/definitions.js

@@ -0,0 +1,14 @@
+"use strict";
+// Copyright 2021 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.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/model/http.js

@@ -0,0 +1,19 @@
+"use strict";
+// Copyright 2021 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.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildDatasourceURL = void 0;
+function buildDatasourceURL(datasourceName, config) {
+    return config.access === 'server' ? `/proxy/globaldatasources/${datasourceName}` : config.url;
+}
+exports.buildDatasourceURL = buildDatasourceURL;

package/dist/cjs/model/index.js

@@ -0,0 +1,37 @@
+"use strict";
+// Copyright 2021 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.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./dashboard"), exports);
+__exportStar(require("./datasource"), exports);
+__exportStar(require("./definitions"), exports);
+__exportStar(require("./http"), exports);
+__exportStar(require("./layout"), exports);
+__exportStar(require("./panels"), exports);
+__exportStar(require("./resource"), exports);
+__exportStar(require("./time"), exports);
+__exportStar(require("./variables"), exports);

package/dist/cjs/model/layout.js

@@ -0,0 +1,14 @@
+"use strict";
+// Copyright 2021 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.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/model/panels.js

@@ -0,0 +1,14 @@
+"use strict";
+// Copyright 2021 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.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/model/resource.js

@@ -0,0 +1,14 @@
+"use strict";
+// Copyright 2021 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.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/model/time.js

@@ -0,0 +1,69 @@
+"use strict";
+// Copyright 2021 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.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSuggestedStepMs = exports.isDurationString = exports.parseDurationString = exports.toAbsoluteTimeRange = void 0;
+const date_fns_1 = require("date-fns");
+/**
+ * Returns an absolute time range from a RelativeTimeRange.
+ */
+function toAbsoluteTimeRange(timeRange) {
+    var _a;
+    const end = (_a = timeRange.end) !== null && _a !== void 0 ? _a : new Date();
+    return {
+        start: (0, date_fns_1.sub)(end, parseDurationString(timeRange.pastDuration)),
+        end,
+    };
+}
+exports.toAbsoluteTimeRange = toAbsoluteTimeRange;
+const DURATION_REGEX = /^(?:(\d+)y)?(?:(\d+)w)?(?:(\d+)d)?(?:(\d+)h)?(?:(\d+)m)?(?:(\d+)s)?(?:(\d+)ms)?$/;
+/**
+ * Parses a DurationString into a Duration object with numeric values that can
+ * be used to do Date math. Throws if not a valid duration string.
+ */
+function parseDurationString(durationString) {
+    var _a, _b, _c, _d, _e, _f, _g;
+    const matches = DURATION_REGEX.exec(durationString);
+    if (matches === null) {
+        throw new Error(`Invalid duration string '${durationString}'`);
+    }
+    return {
+        years: parseInt((_a = matches[1]) !== null && _a !== void 0 ? _a : '0'),
+        months: 0,
+        weeks: parseInt((_b = matches[2]) !== null && _b !== void 0 ? _b : '0'),
+        days: parseInt((_c = matches[3]) !== null && _c !== void 0 ? _c : '0'),
+        hours: parseInt((_d = matches[4]) !== null && _d !== void 0 ? _d : '0'),
+        minutes: parseInt((_e = matches[5]) !== null && _e !== void 0 ? _e : '0'),
+        seconds: parseInt((_f = matches[6]) !== null && _f !== void 0 ? _f : '0') + parseInt((_g = matches[7]) !== null && _g !== void 0 ? _g : '0') / 1000,
+    };
+}
+exports.parseDurationString = parseDurationString;
+/**
+ * Returns true if the given string is a valid DurationString.
+ */
+function isDurationString(maybeDuration) {
+    if (maybeDuration === '')
+        return false;
+    return DURATION_REGEX.test(maybeDuration);
+}
+exports.isDurationString = isDurationString;
+/**
+ * Gets a suggested step/interval size for a time range based on the width of a visual component.
+ */
+function getSuggestedStepMs(timeRange, width) {
+    // TODO: Should we try to suggest more "rounded" step values based around
+    // time increments that make sense (e.g. 15s, 30s, 1m, 5m, etc.)
+    const queryRangeMs = timeRange.end.valueOf() - timeRange.start.valueOf();
+    return Math.floor(queryRangeMs / width);
+}
+exports.getSuggestedStepMs = getSuggestedStepMs;

package/dist/cjs/model/variables.js

@@ -0,0 +1,16 @@
+"use strict";
+// Copyright 2021 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.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_ALL_VALUE = void 0;
+exports.DEFAULT_ALL_VALUE = '$__all';

package/dist/cjs/utils/fetch.js

@@ -0,0 +1,48 @@
+"use strict";
+// Copyright 2021 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.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FetchError = exports.fetchJson = exports.fetch = void 0;
+/**
+ * Calls `global.fetch`, but throws a `FetchError` for non-200 responses.
+ */
+async function fetch(...args) {
+    const response = await global.fetch(...args);
+    if (response.ok === false) {
+        throw new FetchError(response);
+    }
+    return response;
+}
+exports.fetch = fetch;
+/**
+ * Calls `global.fetch` and throws a `FetchError` on non-200 responses, but also
+ * decodes the response body as JSON, casting it to type `T`. Returns the
+ * decoded body.
+ */
+async function fetchJson(...args) {
+    const response = await fetch(...args);
+    const json = await response.json();
+    return json;
+}
+exports.fetchJson = fetchJson;
+/**
+ * Error thrown when fetch returns a non-200 response.
+ */
+class FetchError extends Error {
+    constructor(response) {
+        super(`${response.status} ${response.statusText}`);
+        this.response = response;
+        Object.setPrototypeOf(this, FetchError.prototype);
+    }
+}
+exports.FetchError = FetchError;

package/dist/cjs/utils/index.js

@@ -0,0 +1,31 @@
+"use strict";
+// Copyright 2021 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.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./fetch"), exports);
+__exportStar(require("./memo"), exports);
+__exportStar(require("./panel-refs"), exports);

package/dist/cjs/utils/memo.js

@@ -0,0 +1,50 @@
+"use strict";
+// Copyright 2021 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.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useDeepMemo = exports.useMemoized = void 0;
+const react_1 = require("react");
+const lodash_es_1 = require("lodash-es");
+/**
+ * Like React's useMemo, but guarantees the value will only be recalulated if
+ * a dependency changes. Uses strict equality (===) for comparison. (React's
+ * useMemo does not offer this guarantee, it's only a performance optimization).
+ */
+function useMemoized(factory, deps) {
+    var _a;
+    const ref = (0, react_1.useRef)();
+    let areEqual = true;
+    for (let i = 0; i < deps.length; i++) {
+        if (((_a = ref.current) === null || _a === void 0 ? void 0 : _a.deps[i]) !== deps[i]) {
+            areEqual = false;
+            break;
+        }
+    }
+    if (ref.current === undefined || areEqual === false) {
+        ref.current = { value: factory(), deps: deps };
+    }
+    return ref.current.value;
+}
+exports.useMemoized = useMemoized;
+/**
+ * Like React's useMemo, except it does a deep equality comparison with lodash's
+ * isEqual on the dependency list.
+ */
+function useDeepMemo(factory, deps) {
+    const ref = (0, react_1.useRef)();
+    if (ref.current === undefined || (0, lodash_es_1.isEqual)(deps, ref.current.deps) === false) {
+        ref.current = { value: factory(), deps };
+    }
+    return ref.current.value;
+}
+exports.useDeepMemo = useDeepMemo;

package/dist/cjs/utils/panel-refs.js

@@ -0,0 +1,28 @@
+"use strict";
+// Copyright 2021 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.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolvePanelRef = void 0;
+/**
+ * Resolve a PanelRef (JSON reference) against the provided DashboardSpec to
+ * a PanelDefinition.
+ */
+function resolvePanelRef(spec, panelRef) {
+    const panelsKey = panelRef.$ref.substring(9);
+    const panelDefinition = spec.panels[panelsKey];
+    if (panelDefinition === undefined) {
+        throw new Error(`Could not resolve panels reference ${panelRef.$ref}`);
+    }
+    return panelDefinition;
+}
+exports.resolvePanelRef = resolvePanelRef;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@perses-dev/core",
-  "version": "0.2.1",
+  "version": "0.4.0",
   "description": "Core functionality consumed by both the Perses UI and plugins",
   "license": "Apache-2.0",
   "homepage": "https://github.com/perses/perses/blob/main/README.md",
@@ -12,15 +12,18 @@
     "url": "https://github.com/perses/perses/issues"
   },
   "module": "dist/index.js",
+  "main": "dist/cjs/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
     "clean": "rimraf dist/",
-    "build": "tsc",
+    "build": "tsc --build",
+    "build:cjs": "tsc --project ./tsconfig.cjs.json",
     "test": "echo 'no test to run' && exit 0",
     "lint": "eslint src --ext .ts,.tsx",
     "lint:fix": "eslint --fix src --ext .ts,.tsx"
   },
   "dependencies": {
+    "@perses-dev/core": "^0.4.0",
     "date-fns": "^2.28.0",
     "lodash-es": "^4.17.21"
   },