@perses-dev/core 0.46.0 → 0.47.0

package/dist/cjs/index.js

@@ -16,6 +16,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 _export_star(require("./constants"), exports);
 _export_star(require("./model"), exports);
+_export_star(require("./schema"), exports);
 _export_star(require("./utils"), exports);
 function _export_star(from, to) {
     Object.keys(from).forEach(function(k) {

package/dist/cjs/model/index.js

@@ -39,6 +39,7 @@ _export_star(require("./time-series-data"), exports);
 _export_star(require("./time-series-queries"), exports);
 _export_star(require("./trace-data"), exports);
 _export_star(require("./units"), exports);
+_export_star(require("./user"), exports);
 _export_star(require("./variables"), exports);
 function _export_star(from, to) {
     Object.keys(from).forEach(function(k) {

package/dist/cjs/model/resource.js

@@ -14,12 +14,23 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
-Object.defineProperty(exports, "getMetadataProject", {
-    enumerable: true,
-    get: function() {
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    getMetadataProject: function() {
         return getMetadataProject;
+    },
+    isProjectMetadata: function() {
+        return isProjectMetadata;
     }
 });
+function isProjectMetadata(metadata) {
+    return 'project' in metadata;
+}
 function getMetadataProject(metadata) {
     return 'project' in metadata ? metadata.project : undefined;
 }

package/dist/cjs/model/time.js

@@ -1,4 +1,4 @@
-// Copyright 2023 The Perses Authors
+// Copyright 2024 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
@@ -144,7 +144,7 @@ function formatDuration(duration) {
         if (seconds) {
             result.push(`${seconds}s`);
         }
-        const ms = (duration.seconds - seconds) * 1000;
+        const ms = Math.round((duration.seconds - seconds) * 1000);
         if (ms) {
             result.push(`${ms}ms`);
         }

package/dist/cjs/model/trace-data.js

@@ -10,7 +10,35 @@
 // 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.
-"use strict";
+/**
+ * Common types
+ */ "use strict";
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    SpanStatusError: function() {
+        return SpanStatusError;
+    },
+    SpanStatusOk: function() {
+        return SpanStatusOk;
+    },
+    SpanStatusUnset: function() {
+        return SpanStatusUnset;
+    },
+    isValidTraceId: function() {
+        return isValidTraceId;
+    }
+});
+const SpanStatusUnset = 'STATUS_CODE_UNSET';
+const SpanStatusOk = 'STATUS_CODE_OK';
+const SpanStatusError = 'STATUS_CODE_ERROR';
+function isValidTraceId(traceId) {
+    return /^[0-9a-fA-F]+$/.test(traceId);
+}

package/dist/cjs/model/user.js

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

package/dist/cjs/schema/datasource.js

@@ -0,0 +1,85 @@
+// Copyright 2023 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.
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    buildDatasourceDefinitionSchema: function() {
+        return buildDatasourceDefinitionSchema;
+    },
+    buildDatasourceSpecSchema: function() {
+        return buildDatasourceSpecSchema;
+    },
+    datasourceDefinitionSchema: function() {
+        return datasourceDefinitionSchema;
+    },
+    datasourceSchema: function() {
+        return datasourceSchema;
+    },
+    datasourceSpecSchema: function() {
+        return datasourceSpecSchema;
+    },
+    datasourcesSchema: function() {
+        return datasourcesSchema;
+    },
+    globalDatasourceSchema: function() {
+        return globalDatasourceSchema;
+    }
+});
+const _zod = require("zod");
+const _metadata = require("./metadata");
+const _plugin = require("./plugin");
+const _display = require("./display");
+const datasourceSpecSchema = _zod.z.object({
+    display: _display.displaySchema.optional(),
+    default: _zod.z.boolean(),
+    plugin: _plugin.pluginSchema
+});
+function buildDatasourceSpecSchema(pluginSchema) {
+    return _zod.z.object({
+        display: _display.displaySchema.optional(),
+        default: _zod.z.boolean(),
+        plugin: pluginSchema
+    });
+}
+const datasourceSchema = _zod.z.object({
+    kind: _zod.z.literal('Datasource'),
+    metadata: _metadata.projectMetadataSchema,
+    spec: datasourceSpecSchema
+});
+const globalDatasourceSchema = _zod.z.object({
+    kind: _zod.z.literal('GlobalDatasource'),
+    metadata: _metadata.metadataSchema,
+    spec: datasourceSpecSchema
+});
+const datasourcesSchema = _zod.z.discriminatedUnion('kind', [
+    datasourceSchema,
+    globalDatasourceSchema
+]);
+const datasourceDefinitionSchema = _zod.z.object({
+    name: _zod.z.string().min(1),
+    spec: datasourceSpecSchema
+});
+function buildDatasourceDefinitionSchema(pluginSchema) {
+    return _zod.z.object({
+        name: _zod.z.string().min(1),
+        spec: buildDatasourceSpecSchema(pluginSchema)
+    });
+}

package/dist/cjs/schema/display.js

@@ -0,0 +1,27 @@
+// Copyright 2024 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.
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "displaySchema", {
+    enumerable: true,
+    get: function() {
+        return displaySchema;
+    }
+});
+const _zod = require("zod");
+const displaySchema = _zod.z.object({
+    name: _zod.z.string().optional(),
+    description: _zod.z.string().optional()
+});

package/dist/cjs/schema/duration.js

@@ -0,0 +1,25 @@
+// Copyright 2024 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.
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "durationValidationSchema", {
+    enumerable: true,
+    get: function() {
+        return durationValidationSchema;
+    }
+});
+const _zod = require("zod");
+const _model = require("../model");
+const durationValidationSchema = _zod.z.string().min(1, 'Required').regex(_model.DURATION_REGEX, 'Must be a valid duration string');

package/dist/cjs/schema/index.js

@@ -0,0 +1,40 @@
+// Copyright 2024 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.
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+_export_star(require("./datasource"), exports);
+_export_star(require("./display"), exports);
+_export_star(require("./duration"), exports);
+_export_star(require("./metadata"), exports);
+_export_star(require("./panel"), exports);
+_export_star(require("./plugin"), exports);
+_export_star(require("./role"), exports);
+_export_star(require("./rolebinding"), exports);
+_export_star(require("./secret"), exports);
+_export_star(require("./user"), exports);
+_export_star(require("./variable"), exports);
+function _export_star(from, to) {
+    Object.keys(from).forEach(function(k) {
+        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
+            Object.defineProperty(to, k, {
+                enumerable: true,
+                get: function() {
+                    return from[k];
+                }
+            });
+        }
+    });
+    return from;
+}

package/dist/cjs/schema/metadata.js

@@ -0,0 +1,41 @@
+// Copyright 2024 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.
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    metadataSchema: function() {
+        return metadataSchema;
+    },
+    nameSchema: function() {
+        return nameSchema;
+    },
+    projectMetadataSchema: function() {
+        return projectMetadataSchema;
+    }
+});
+const _zod = require("zod");
+const nameSchema = _zod.z.string().min(1, 'Required').max(75, 'Must be 75 or fewer characters long').regex(/^[a-zA-Z0-9_.-]+$/, 'Must only contains alphanumerical characters and special characters _ . -');
+const metadataSchema = _zod.z.object({
+    name: nameSchema
+});
+const projectMetadataSchema = metadataSchema.extend({
+    project: nameSchema
+});

package/dist/cjs/schema/panel.js

@@ -0,0 +1,104 @@
+// Copyright 2024 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.
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    buildPanelDefinitionSchema: function() {
+        return buildPanelDefinitionSchema;
+    },
+    buildPanelEditorSchema: function() {
+        return buildPanelEditorSchema;
+    },
+    buildPanelSpecSchema: function() {
+        return buildPanelSpecSchema;
+    },
+    linkSchema: function() {
+        return linkSchema;
+    },
+    panelDefinitionSchema: function() {
+        return panelDefinitionSchema;
+    },
+    panelDisplaySpec: function() {
+        return panelDisplaySpec;
+    },
+    panelEditorSchema: function() {
+        return panelEditorSchema;
+    },
+    panelSpecSchema: function() {
+        return panelSpecSchema;
+    },
+    querySpecSchema: function() {
+        return querySpecSchema;
+    }
+});
+const _zod = require("zod");
+const _plugin = require("./plugin");
+const panelDisplaySpec = _zod.z.object({
+    name: _zod.z.string(),
+    description: _zod.z.string().optional()
+});
+const querySpecSchema = _zod.z.object({
+    kind: _zod.z.string().min(1),
+    spec: _zod.z.object({
+        plugin: _plugin.pluginSchema
+    })
+});
+const linkSchema = _zod.z.object({
+    name: _zod.z.string().optional(),
+    url: _zod.z.string().min(1),
+    tooltip: _zod.z.string().optional(),
+    renderVariables: _zod.z.boolean().optional(),
+    targetBlank: _zod.z.boolean().optional()
+});
+const panelSpecSchema = _zod.z.object({
+    display: panelDisplaySpec,
+    plugin: _plugin.pluginSchema,
+    queries: _zod.z.array(querySpecSchema).optional(),
+    links: _zod.z.array(linkSchema).optional()
+});
+function buildPanelSpecSchema(pluginSchema) {
+    return _zod.z.object({
+        display: panelDisplaySpec,
+        plugin: pluginSchema,
+        queries: _zod.z.array(querySpecSchema).optional(),
+        links: _zod.z.array(linkSchema).optional()
+    });
+}
+const panelDefinitionSchema = _zod.z.object({
+    kind: _zod.z.literal('Panel'),
+    spec: panelSpecSchema
+});
+function buildPanelDefinitionSchema(pluginSchema) {
+    return _zod.z.object({
+        kind: _zod.z.literal('Panel'),
+        spec: buildPanelSpecSchema(pluginSchema)
+    });
+}
+const panelEditorSchema = _zod.z.object({
+    groupId: _zod.z.number(),
+    panelDefinition: panelDefinitionSchema
+});
+function buildPanelEditorSchema(pluginSchema) {
+    return _zod.z.object({
+        groupId: _zod.z.number(),
+        panelDefinition: buildPanelDefinitionSchema(pluginSchema)
+    });
+}

package/dist/cjs/schema/plugin.js

@@ -0,0 +1,27 @@
+// Copyright 2024 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.
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "pluginSchema", {
+    enumerable: true,
+    get: function() {
+        return pluginSchema;
+    }
+});
+const _zod = require("zod");
+const pluginSchema = _zod.z.object({
+    kind: _zod.z.string().min(1, 'Required'),
+    spec: _zod.z.record(_zod.z.string(), _zod.z.any())
+});

package/dist/cjs/schema/role.js

@@ -0,0 +1,86 @@
+// Copyright 2023 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.
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    globalRoleSchema: function() {
+        return globalRoleSchema;
+    },
+    permissionSchema: function() {
+        return permissionSchema;
+    },
+    roleSchema: function() {
+        return roleSchema;
+    },
+    roleSpecSchema: function() {
+        return roleSpecSchema;
+    },
+    rolesEditorSchema: function() {
+        return rolesEditorSchema;
+    }
+});
+const _zod = require("zod");
+const _metadata = require("./metadata");
+const permissionSchema = _zod.z.object({
+    // TODO: use SCOPE & ACTIONS constants
+    actions: _zod.z.array(_zod.z.enum([
+        '*',
+        'create',
+        'read',
+        'update',
+        'delete'
+    ])).nonempty('Must contains at least 1 action'),
+    scopes: _zod.z.array(_zod.z.enum([
+        '*',
+        'Dashboard',
+        'Datasource',
+        'EphemeralDashboard',
+        'Folder',
+        'GlobalDatasource',
+        'GlobalRole',
+        'GlobalRoleBinding',
+        'GlobalSecret',
+        'GlobalVariable',
+        'Project',
+        'Role',
+        'RoleBinding',
+        'Secret',
+        'User',
+        'Variable'
+    ])).nonempty('Must contains at least 1 scope')
+});
+const roleSpecSchema = _zod.z.object({
+    permissions: _zod.z.array(permissionSchema)
+});
+const roleSchema = _zod.z.object({
+    kind: _zod.z.literal('Role'),
+    metadata: _metadata.projectMetadataSchema,
+    spec: roleSpecSchema
+});
+const globalRoleSchema = _zod.z.object({
+    kind: _zod.z.literal('GlobalRole'),
+    metadata: _metadata.metadataSchema,
+    spec: roleSpecSchema
+});
+const rolesEditorSchema = _zod.z.discriminatedUnion('kind', [
+    roleSchema,
+    globalRoleSchema
+]);

package/dist/cjs/schema/rolebinding.js

@@ -0,0 +1,65 @@
+// Copyright 2023 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.
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    globalRoleBindingSchema: function() {
+        return globalRoleBindingSchema;
+    },
+    roleBindingSchema: function() {
+        return roleBindingSchema;
+    },
+    roleBindingSpecSchema: function() {
+        return roleBindingSpecSchema;
+    },
+    roleBindingsEditorSchema: function() {
+        return roleBindingsEditorSchema;
+    },
+    subjectSchema: function() {
+        return subjectSchema;
+    }
+});
+const _zod = require("zod");
+const _metadata = require("./metadata");
+const subjectSchema = _zod.z.object({
+    kind: _zod.z.enum([
+        'User'
+    ]),
+    name: _metadata.nameSchema
+});
+const roleBindingSpecSchema = _zod.z.object({
+    role: _metadata.nameSchema,
+    subjects: _zod.z.array(subjectSchema).nonempty()
+});
+const roleBindingSchema = _zod.z.object({
+    kind: _zod.z.literal('RoleBinding'),
+    metadata: _metadata.projectMetadataSchema,
+    spec: roleBindingSpecSchema
+});
+const globalRoleBindingSchema = _zod.z.object({
+    kind: _zod.z.literal('GlobalRoleBinding'),
+    metadata: _metadata.metadataSchema,
+    spec: roleBindingSpecSchema
+});
+const roleBindingsEditorSchema = _zod.z.discriminatedUnion('kind', [
+    roleBindingSchema,
+    globalRoleBindingSchema
+]);