@sentio/api 1.0.5-rc.4 → 1.0.5-rc.6

package/dist/src/types.gen.d.ts

@@ -1671,128 +1671,79 @@ export declare namespace google {
      * `Any` contains an arbitrary serialized protocol buffer message along with a
      * URL that describes the type of the serialized message.
      *
-     * Protobuf library provides support to pack/unpack Any values in the form
-     * of utility functions or additional generated methods of the Any type.
+     * In its binary encoding, an `Any` is an ordinary message; but in other wire
+     * forms like JSON, it has a special encoding. The format of the type URL is
+     * described on the `type_url` field.
      *
-     * Example 1: Pack and unpack a message in C++.
+     * Protobuf APIs provide utilities to interact with `Any` values:
      *
-     * Foo foo = ...;
-     * Any any;
-     * any.PackFrom(foo);
-     * ...
-     * if (any.UnpackTo(&foo)) {
-     * ...
-     * }
+     * - A 'pack' operation accepts a message and constructs a generic `Any` wrapper
+     * around it.
+     * - An 'unpack' operation reads the content of an `Any` message, either into an
+     * existing message or a new one. Unpack operations must check the type of the
+     * value they unpack against the declared `type_url`.
+     * - An 'is' operation decides whether an `Any` contains a message of the given
+     * type, i.e. whether it can 'unpack' that type.
      *
-     * Example 2: Pack and unpack a message in Java.
+     * The JSON format representation of an `Any` follows one of these cases:
      *
-     * Foo foo = ...;
-     * Any any = Any.pack(foo);
-     * ...
-     * if (any.is(Foo.class)) {
-     * foo = any.unpack(Foo.class);
-     * }
-     * // or ...
-     * if (any.isSameTypeAs(Foo.getDefaultInstance())) {
-     * foo = any.unpack(Foo.getDefaultInstance());
-     * }
+     * - For types without special-cased JSON encodings, the JSON format
+     * representation of the `Any` is the same as that of the message, with an
+     * additional `@type` field which contains the type URL.
+     * - For types with special-cased JSON encodings (typically called 'well-known'
+     * types, listed in https://protobuf.dev/programming-guides/json/#any), the
+     * JSON format representation has a key `@type` which contains the type URL
+     * and a key `value` which contains the JSON-serialized value.
      *
-     * Example 3: Pack and unpack a message in Python.
-     *
-     * foo = Foo(...)
-     * any = Any()
-     * any.Pack(foo)
-     * ...
-     * if any.Is(Foo.DESCRIPTOR):
-     * any.Unpack(foo)
-     * ...
-     *
-     * Example 4: Pack and unpack a message in Go
-     *
-     * foo := &pb.Foo{...}
-     * any, err := anypb.New(foo)
-     * if err != nil {
-     * ...
-     * }
-     * ...
-     * foo := &pb.Foo{}
-     * if err := any.UnmarshalTo(foo); err != nil {
-     * ...
-     * }
-     *
-     * The pack methods provided by protobuf library will by default use
-     * 'type.googleapis.com/full.type.name' as the type URL and the unpack
-     * methods only use the fully qualified type name after the last '/'
-     * in the type URL, for example "foo.bar.com/x/y.z" will yield type
-     * name "y.z".
-     *
-     * JSON
-     * ====
-     * The JSON representation of an `Any` value uses the regular
-     * representation of the deserialized, embedded message, with an
-     * additional field `@type` which contains the type URL. Example:
-     *
-     * package google.profile;
-     * message Person {
-     * string first_name = 1;
-     * string last_name = 2;
-     * }
-     *
-     * {
-     * "@type": "type.googleapis.com/google.profile.Person",
-     * "firstName": <string>,
-     * "lastName": <string>
-     * }
-     *
-     * If the embedded message type is well-known and has a custom JSON
-     * representation, that representation will be embedded adding a field
-     * `value` which holds the custom JSON in addition to the `@type`
-     * field. Example (for message [google.protobuf.Duration][]):
-     *
-     * {
-     * "@type": "type.googleapis.com/google.protobuf.Duration",
-     * "value": "1.212s"
-     * }
+     * The text format representation of an `Any` is like a message with one field
+     * whose name is the type URL in brackets. For example, an `Any` containing a
+     * `foo.Bar` message may be written `[type.googleapis.com/foo.Bar] { a: 2 }`.
      */
     type ProtobufAny = {
         /**
-         * A URL/resource name that uniquely identifies the type of the serialized
-         * protocol buffer message. This string must contain at least
-         * one "/" character. The last segment of the URL's path must represent
-         * the fully qualified name of the type (as in
-         * `path/google.protobuf.Duration`). The name should be in a canonical form
-         * (e.g., leading "." is not accepted).
+         * Identifies the type of the serialized Protobuf message with a URI reference
+         * consisting of a prefix ending in a slash and the fully-qualified type name.
          *
-         * In practice, teams usually precompile into the binary all types that they
-         * expect it to use in the context of Any. However, for URLs which use the
-         * scheme `http`, `https`, or no scheme, one can optionally set up a type
-         * server that maps type URLs to message definitions as follows:
+         * Example: type.googleapis.com/google.protobuf.StringValue
          *
-         * * If no scheme is provided, `https` is assumed.
-         * * An HTTP GET on the URL must yield a [google.protobuf.Type][]
-         * value in binary format, or produce an error.
-         * * Applications are allowed to cache lookup results based on the
-         * URL, or have them precompiled into a binary to avoid any
-         * lookup. Therefore, binary compatibility needs to be preserved
-         * on changes to types. (Use versioned type names to manage
-         * breaking changes.)
+         * This string must contain at least one `/` character, and the content after
+         * the last `/` must be the fully-qualified name of the type in canonical
+         * form, without a leading dot. Do not write a scheme on these URI references
+         * so that clients do not attempt to contact them.
          *
-         * Note: this functionality is not currently available in the official
-         * protobuf release, and it is not used for type URLs beginning with
-         * type.googleapis.com. As of May 2023, there are no widely used type server
-         * implementations and no plans to implement one.
+         * The prefix is arbitrary and Protobuf implementations are expected to
+         * simply strip off everything up to and including the last `/` to identify
+         * the type. `type.googleapis.com/` is a common default prefix that some
+         * legacy implementations require. This prefix does not indicate the origin of
+         * the type, and URIs containing it are not expected to respond to any
+         * requests.
          *
-         * Schemes other than `http`, `https` (or the empty scheme) might be
-         * used with implementation specific semantics.
+         * All type URL strings must be legal URI references with the additional
+         * restriction (for the text format) that the content of the reference
+         * must consist only of alphanumeric characters, percent-encoded escapes, and
+         * characters in the following set (not including the outer backticks):
+         * `/-.~_!$&()*+,;=`. Despite our allowing percent encodings, implementations
+         * should not unescape them to prevent confusion with existing parsers. For
+         * example, `type.googleapis.com%2FFoo` should be rejected.
+         *
+         * In the original design of `Any`, the possibility of launching a type
+         * resolution service at these type URLs was considered but Protobuf never
+         * implemented one and considers contacting these URLs to be problematic and
+         * a potential security issue. Do not attempt to contact type URLs.
          */
         '@type'?: string;
         [key: string]: unknown | string | undefined;
     };
     /**
-     * `NullValue` is a singleton enumeration to represent the null value for the
-     * `Value` type union.
+     * Represents a JSON `null`.
+     *
+     * `NullValue` is a sentinel, using an enum with only one value to represent
+     * the null value for the `Value` type union.
      *
-     * The JSON representation for `NullValue` is JSON `null`.
+     * A field of type `NullValue` with any value other than `0` is considered
+     * invalid. Most ProtoJSON serializers will emit a Value with a `null_value` set
+     * as a JSON `null` regardless of the integer value, and so will round trip to
+     * a `0` value.
      *
      * - NULL_VALUE: Null value.
      */
@@ -3104,8 +3055,9 @@ export declare namespace web_service {
         sqlExecuteEngine?: analytic_service.ExecuteEngine;
         enableExperimentalFeatures?: boolean;
         overlayGraphs?: Array<OverlayGraph>;
+        group?: Group;
     };
-    type ChartDataSourceType = 'METRICS' | 'NOTES' | 'ANALYTICS' | 'INSIGHTS' | 'EVENTS' | 'RETENTION' | 'SQL';
+    type ChartDataSourceType = 'METRICS' | 'NOTES' | 'ANALYTICS' | 'INSIGHTS' | 'EVENTS' | 'RETENTION' | 'SQL' | 'GROUP';
     type ChartConfig = {
         yAxis?: ChartConfigYAxisConfig;
         barGauge?: ChartConfigBarGaugeConfig;
@@ -3263,7 +3215,7 @@ export declare namespace web_service {
         column?: string;
         name?: string;
     };
-    type ChartType2 = 'LINE' | 'AREA' | 'BAR' | 'BAR_GAUGE' | 'TABLE' | 'QUERY_VALUE' | 'PIE' | 'NOTE' | 'SCATTER';
+    type ChartType2 = 'LINE' | 'AREA' | 'BAR' | 'BAR_GAUGE' | 'TABLE' | 'QUERY_VALUE' | 'PIE' | 'NOTE' | 'SCATTER' | 'GROUP';
     type Dashboard = {
         id?: string;
         name?: string;
@@ -3367,6 +3319,15 @@ export declare namespace web_service {
         dashboards?: Array<Dashboard>;
         permissions?: Array<common.Permission>;
     };
+    /**
+     * Configuration for a GROUP-typed Panel — a collapsible container that holds
+     * other panels referencing it via Panel.group_id. Groups cannot nest.
+     */
+    type Group = {
+        title?: string;
+        collapsed?: boolean;
+        childLayouts?: DashboardResponsiveLayouts;
+    };
     type ImportDashboardRequest = {
         /**
          * The id of the target dashboard to import into.
@@ -3419,6 +3380,11 @@ export declare namespace web_service {
         chart?: Chart;
         creator?: common.UserInfo;
         updater?: common.UserInfo;
+        /**
+         * When non-empty, this panel renders inside the Group panel identified by group_id.
+         * GROUP-typed panels must keep this field empty (groups cannot nest).
+         */
+        groupId?: string;
     };
     type SharingConfig = {
         isReadonly?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentio/api",
-  "version": "1.0.5-rc.4",
+  "version": "1.0.5-rc.6",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",

package/src/types.gen.ts

@@ -1678,128 +1678,79 @@ export namespace google {
      * `Any` contains an arbitrary serialized protocol buffer message along with a
      * URL that describes the type of the serialized message.
      *
-     * Protobuf library provides support to pack/unpack Any values in the form
-     * of utility functions or additional generated methods of the Any type.
+     * In its binary encoding, an `Any` is an ordinary message; but in other wire
+     * forms like JSON, it has a special encoding. The format of the type URL is
+     * described on the `type_url` field.
      *
-     * Example 1: Pack and unpack a message in C++.
+     * Protobuf APIs provide utilities to interact with `Any` values:
      *
-     * Foo foo = ...;
-     * Any any;
-     * any.PackFrom(foo);
-     * ...
-     * if (any.UnpackTo(&foo)) {
-     * ...
-     * }
+     * - A 'pack' operation accepts a message and constructs a generic `Any` wrapper
+     * around it.
+     * - An 'unpack' operation reads the content of an `Any` message, either into an
+     * existing message or a new one. Unpack operations must check the type of the
+     * value they unpack against the declared `type_url`.
+     * - An 'is' operation decides whether an `Any` contains a message of the given
+     * type, i.e. whether it can 'unpack' that type.
      *
-     * Example 2: Pack and unpack a message in Java.
+     * The JSON format representation of an `Any` follows one of these cases:
      *
-     * Foo foo = ...;
-     * Any any = Any.pack(foo);
-     * ...
-     * if (any.is(Foo.class)) {
-     * foo = any.unpack(Foo.class);
-     * }
-     * // or ...
-     * if (any.isSameTypeAs(Foo.getDefaultInstance())) {
-     * foo = any.unpack(Foo.getDefaultInstance());
-     * }
+     * - For types without special-cased JSON encodings, the JSON format
+     * representation of the `Any` is the same as that of the message, with an
+     * additional `@type` field which contains the type URL.
+     * - For types with special-cased JSON encodings (typically called 'well-known'
+     * types, listed in https://protobuf.dev/programming-guides/json/#any), the
+     * JSON format representation has a key `@type` which contains the type URL
+     * and a key `value` which contains the JSON-serialized value.
      *
-     * Example 3: Pack and unpack a message in Python.
-     *
-     * foo = Foo(...)
-     * any = Any()
-     * any.Pack(foo)
-     * ...
-     * if any.Is(Foo.DESCRIPTOR):
-     * any.Unpack(foo)
-     * ...
-     *
-     * Example 4: Pack and unpack a message in Go
-     *
-     * foo := &pb.Foo{...}
-     * any, err := anypb.New(foo)
-     * if err != nil {
-     * ...
-     * }
-     * ...
-     * foo := &pb.Foo{}
-     * if err := any.UnmarshalTo(foo); err != nil {
-     * ...
-     * }
-     *
-     * The pack methods provided by protobuf library will by default use
-     * 'type.googleapis.com/full.type.name' as the type URL and the unpack
-     * methods only use the fully qualified type name after the last '/'
-     * in the type URL, for example "foo.bar.com/x/y.z" will yield type
-     * name "y.z".
-     *
-     * JSON
-     * ====
-     * The JSON representation of an `Any` value uses the regular
-     * representation of the deserialized, embedded message, with an
-     * additional field `@type` which contains the type URL. Example:
-     *
-     * package google.profile;
-     * message Person {
-     * string first_name = 1;
-     * string last_name = 2;
-     * }
-     *
-     * {
-     * "@type": "type.googleapis.com/google.profile.Person",
-     * "firstName": <string>,
-     * "lastName": <string>
-     * }
-     *
-     * If the embedded message type is well-known and has a custom JSON
-     * representation, that representation will be embedded adding a field
-     * `value` which holds the custom JSON in addition to the `@type`
-     * field. Example (for message [google.protobuf.Duration][]):
-     *
-     * {
-     * "@type": "type.googleapis.com/google.protobuf.Duration",
-     * "value": "1.212s"
-     * }
+     * The text format representation of an `Any` is like a message with one field
+     * whose name is the type URL in brackets. For example, an `Any` containing a
+     * `foo.Bar` message may be written `[type.googleapis.com/foo.Bar] { a: 2 }`.
      */
     export type ProtobufAny = {
         /**
-         * A URL/resource name that uniquely identifies the type of the serialized
-         * protocol buffer message. This string must contain at least
-         * one "/" character. The last segment of the URL's path must represent
-         * the fully qualified name of the type (as in
-         * `path/google.protobuf.Duration`). The name should be in a canonical form
-         * (e.g., leading "." is not accepted).
+         * Identifies the type of the serialized Protobuf message with a URI reference
+         * consisting of a prefix ending in a slash and the fully-qualified type name.
          *
-         * In practice, teams usually precompile into the binary all types that they
-         * expect it to use in the context of Any. However, for URLs which use the
-         * scheme `http`, `https`, or no scheme, one can optionally set up a type
-         * server that maps type URLs to message definitions as follows:
+         * Example: type.googleapis.com/google.protobuf.StringValue
          *
-         * * If no scheme is provided, `https` is assumed.
-         * * An HTTP GET on the URL must yield a [google.protobuf.Type][]
-         * value in binary format, or produce an error.
-         * * Applications are allowed to cache lookup results based on the
-         * URL, or have them precompiled into a binary to avoid any
-         * lookup. Therefore, binary compatibility needs to be preserved
-         * on changes to types. (Use versioned type names to manage
-         * breaking changes.)
+         * This string must contain at least one `/` character, and the content after
+         * the last `/` must be the fully-qualified name of the type in canonical
+         * form, without a leading dot. Do not write a scheme on these URI references
+         * so that clients do not attempt to contact them.
          *
-         * Note: this functionality is not currently available in the official
-         * protobuf release, and it is not used for type URLs beginning with
-         * type.googleapis.com. As of May 2023, there are no widely used type server
-         * implementations and no plans to implement one.
+         * The prefix is arbitrary and Protobuf implementations are expected to
+         * simply strip off everything up to and including the last `/` to identify
+         * the type. `type.googleapis.com/` is a common default prefix that some
+         * legacy implementations require. This prefix does not indicate the origin of
+         * the type, and URIs containing it are not expected to respond to any
+         * requests.
          *
-         * Schemes other than `http`, `https` (or the empty scheme) might be
-         * used with implementation specific semantics.
+         * All type URL strings must be legal URI references with the additional
+         * restriction (for the text format) that the content of the reference
+         * must consist only of alphanumeric characters, percent-encoded escapes, and
+         * characters in the following set (not including the outer backticks):
+         * `/-.~_!$&()*+,;=`. Despite our allowing percent encodings, implementations
+         * should not unescape them to prevent confusion with existing parsers. For
+         * example, `type.googleapis.com%2FFoo` should be rejected.
+         *
+         * In the original design of `Any`, the possibility of launching a type
+         * resolution service at these type URLs was considered but Protobuf never
+         * implemented one and considers contacting these URLs to be problematic and
+         * a potential security issue. Do not attempt to contact type URLs.
          */
         '@type'?: string;
         [key: string]: unknown | string | undefined;
     };
     /**
-     * `NullValue` is a singleton enumeration to represent the null value for the
-     * `Value` type union.
+     * Represents a JSON `null`.
+     *
+     * `NullValue` is a sentinel, using an enum with only one value to represent
+     * the null value for the `Value` type union.
      *
-     * The JSON representation for `NullValue` is JSON `null`.
+     * A field of type `NullValue` with any value other than `0` is considered
+     * invalid. Most ProtoJSON serializers will emit a Value with a `null_value` set
+     * as a JSON `null` regardless of the integer value, and so will round trip to
+     * a `0` value.
      *
      * - NULL_VALUE: Null value.
      */
@@ -3118,8 +3069,9 @@ export namespace web_service {
         sqlExecuteEngine?: analytic_service.ExecuteEngine;
         enableExperimentalFeatures?: boolean;
         overlayGraphs?: Array<OverlayGraph>;
+        group?: Group;
     };
-    export type ChartDataSourceType = 'METRICS' | 'NOTES' | 'ANALYTICS' | 'INSIGHTS' | 'EVENTS' | 'RETENTION' | 'SQL';
+    export type ChartDataSourceType = 'METRICS' | 'NOTES' | 'ANALYTICS' | 'INSIGHTS' | 'EVENTS' | 'RETENTION' | 'SQL' | 'GROUP';
     export type ChartConfig = {
         yAxis?: ChartConfigYAxisConfig;
         barGauge?: ChartConfigBarGaugeConfig;
@@ -3277,7 +3229,7 @@ export namespace web_service {
         column?: string;
         name?: string;
     };
-    export type ChartType2 = 'LINE' | 'AREA' | 'BAR' | 'BAR_GAUGE' | 'TABLE' | 'QUERY_VALUE' | 'PIE' | 'NOTE' | 'SCATTER';
+    export type ChartType2 = 'LINE' | 'AREA' | 'BAR' | 'BAR_GAUGE' | 'TABLE' | 'QUERY_VALUE' | 'PIE' | 'NOTE' | 'SCATTER' | 'GROUP';
     export type Dashboard = {
         id?: string;
         name?: string;
@@ -3381,6 +3333,15 @@ export namespace web_service {
         dashboards?: Array<Dashboard>;
         permissions?: Array<common.Permission>;
     };
+    /**
+     * Configuration for a GROUP-typed Panel — a collapsible container that holds
+     * other panels referencing it via Panel.group_id. Groups cannot nest.
+     */
+    export type Group = {
+        title?: string;
+        collapsed?: boolean;
+        childLayouts?: DashboardResponsiveLayouts;
+    };
     export type ImportDashboardRequest = {
         /**
          * The id of the target dashboard to import into.
@@ -3433,6 +3394,11 @@ export namespace web_service {
         chart?: Chart;
         creator?: common.UserInfo;
         updater?: common.UserInfo;
+        /**
+         * When non-empty, this panel renders inside the Group panel identified by group_id.
+         * GROUP-typed panels must keep this field empty (groups cannot nest).
+         */
+        groupId?: string;
     };
     export type SharingConfig = {
         isReadonly?: boolean;