@toshicloud/sdk 0.4.0 → 0.5.0

package/dist/gen/toshi/workspace/v1/discovery_pb.d.ts

@@ -0,0 +1,676 @@
+import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
+import type { Message } from "@bufbuild/protobuf";
+/**
+ * Describes the file toshi/workspace/v1/discovery.proto.
+ */
+export declare const file_toshi_workspace_v1_discovery: GenFile;
+/**
+ * @generated from message toshi.workspace.v1.DiscoverRequest
+ */
+export type DiscoverRequest = Message<"toshi.workspace.v1.DiscoverRequest"> & {
+    /**
+     * project names one of the workspace's projects: the permissions are the
+     * caller's in it. Empty is the whole workspace, or for a token limited to
+     * a project or environment, that part of it. A token limited to a project
+     * names no other.
+     *
+     * @generated from field: string project = 1;
+     */
+    project: string;
+    /**
+     * environment names an environment of project, and needs project.
+     *
+     * @generated from field: string environment = 2;
+     */
+    environment: string;
+};
+/**
+ * @generated from message toshi.workspace.v1.DiscoverRequest
+ */
+export type DiscoverRequestJson = {
+    /**
+     * project names one of the workspace's projects: the permissions are the
+     * caller's in it. Empty is the whole workspace, or for a token limited to
+     * a project or environment, that part of it. A token limited to a project
+     * names no other.
+     *
+     * @generated from field: string project = 1;
+     */
+    project?: string;
+    /**
+     * environment names an environment of project, and needs project.
+     *
+     * @generated from field: string environment = 2;
+     */
+    environment?: string;
+};
+/**
+ * Describes the message toshi.workspace.v1.DiscoverRequest.
+ * Use `create(DiscoverRequestSchema)` to create a new message.
+ */
+export declare const DiscoverRequestSchema: GenMessage<DiscoverRequest, {
+    jsonType: DiscoverRequestJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.DiscoverResponse
+ */
+export type DiscoverResponse = Message<"toshi.workspace.v1.DiscoverResponse"> & {
+    /**
+     * products are the products the build includes, by id.
+     *
+     * @generated from field: repeated toshi.workspace.v1.DiscoveredProduct products = 1;
+     */
+    products: DiscoveredProduct[];
+    /**
+     * permissions are the caller's, sorted: what its roles in the workspace
+     * give it at the request's project and environment. Each is
+     * "<area>.<level>", as docs/api/permissions.md lists them, or a
+     * product's own, "<product id>.<level>".
+     *
+     * @generated from field: repeated string permissions = 2;
+     */
+    permissions: string[];
+    /**
+     * @generated from field: toshi.workspace.v1.APIVersions versions = 3;
+     */
+    versions?: APIVersions | undefined;
+};
+/**
+ * @generated from message toshi.workspace.v1.DiscoverResponse
+ */
+export type DiscoverResponseJson = {
+    /**
+     * products are the products the build includes, by id.
+     *
+     * @generated from field: repeated toshi.workspace.v1.DiscoveredProduct products = 1;
+     */
+    products?: DiscoveredProductJson[];
+    /**
+     * permissions are the caller's, sorted: what its roles in the workspace
+     * give it at the request's project and environment. Each is
+     * "<area>.<level>", as docs/api/permissions.md lists them, or a
+     * product's own, "<product id>.<level>".
+     *
+     * @generated from field: repeated string permissions = 2;
+     */
+    permissions?: string[];
+    /**
+     * @generated from field: toshi.workspace.v1.APIVersions versions = 3;
+     */
+    versions?: APIVersionsJson;
+};
+/**
+ * Describes the message toshi.workspace.v1.DiscoverResponse.
+ * Use `create(DiscoverResponseSchema)` to create a new message.
+ */
+export declare const DiscoverResponseSchema: GenMessage<DiscoverResponse, {
+    jsonType: DiscoverResponseJson;
+}>;
+/**
+ * DiscoveredProduct is one product the build includes.
+ *
+ * @generated from message toshi.workspace.v1.DiscoveredProduct
+ */
+export type DiscoveredProduct = Message<"toshi.workspace.v1.DiscoveredProduct"> & {
+    /**
+     * id names the product, such as "runners": its config section and the
+     * prefix of its features and permissions.
+     *
+     * @generated from field: string id = 1;
+     */
+    id: string;
+    /**
+     * @generated from field: string version = 2;
+     */
+    version: string;
+    /**
+     * docs is where the product's documentation lives: a path in the Toshi
+     * repository, or a URL.
+     *
+     * @generated from field: string docs = 3;
+     */
+    docs: string;
+    /**
+     * enabled reports whether the deployment's config turns the product on.
+     * A product that is off serves no calls.
+     *
+     * @generated from field: bool enabled = 4;
+     */
+    enabled: boolean;
+    /**
+     * features are the product's typed keys, by key.
+     *
+     * @generated from field: repeated toshi.workspace.v1.ProductFeature features = 5;
+     */
+    features: ProductFeature[];
+    /**
+     * state is where the product is in the deployment's lifecycle.
+     *
+     * @generated from field: toshi.workspace.v1.ProductState state = 6;
+     */
+    state: ProductState;
+    /**
+     * switch says whether the product is on for the workspace and, when it is
+     * off, which switch turned it off: the switch a refused call to the
+     * product names in its ErrorInfo detail.
+     *
+     * @generated from field: toshi.workspace.v1.ProductSwitch switch = 7;
+     */
+    switch: ProductSwitch;
+};
+/**
+ * DiscoveredProduct is one product the build includes.
+ *
+ * @generated from message toshi.workspace.v1.DiscoveredProduct
+ */
+export type DiscoveredProductJson = {
+    /**
+     * id names the product, such as "runners": its config section and the
+     * prefix of its features and permissions.
+     *
+     * @generated from field: string id = 1;
+     */
+    id?: string;
+    /**
+     * @generated from field: string version = 2;
+     */
+    version?: string;
+    /**
+     * docs is where the product's documentation lives: a path in the Toshi
+     * repository, or a URL.
+     *
+     * @generated from field: string docs = 3;
+     */
+    docs?: string;
+    /**
+     * enabled reports whether the deployment's config turns the product on.
+     * A product that is off serves no calls.
+     *
+     * @generated from field: bool enabled = 4;
+     */
+    enabled?: boolean;
+    /**
+     * features are the product's typed keys, by key.
+     *
+     * @generated from field: repeated toshi.workspace.v1.ProductFeature features = 5;
+     */
+    features?: ProductFeatureJson[];
+    /**
+     * state is where the product is in the deployment's lifecycle.
+     *
+     * @generated from field: toshi.workspace.v1.ProductState state = 6;
+     */
+    state?: ProductStateJson;
+    /**
+     * switch says whether the product is on for the workspace and, when it is
+     * off, which switch turned it off: the switch a refused call to the
+     * product names in its ErrorInfo detail.
+     *
+     * @generated from field: toshi.workspace.v1.ProductSwitch switch = 7;
+     */
+    switch?: ProductSwitchJson;
+};
+/**
+ * Describes the message toshi.workspace.v1.DiscoveredProduct.
+ * Use `create(DiscoveredProductSchema)` to create a new message.
+ */
+export declare const DiscoveredProductSchema: GenMessage<DiscoveredProduct, {
+    jsonType: DiscoveredProductJson;
+}>;
+/**
+ * ProductFeature is a typed key a product declares.
+ *
+ * @generated from message toshi.workspace.v1.ProductFeature
+ */
+export type ProductFeature = Message<"toshi.workspace.v1.ProductFeature"> & {
+    /**
+     * key is "<product id>.<name>".
+     *
+     * @generated from field: string key = 1;
+     */
+    key: string;
+    /**
+     * @generated from field: toshi.workspace.v1.ProductFeatureType type = 2;
+     */
+    type: ProductFeatureType;
+    /**
+     * values are an enum's values; empty for the other types.
+     *
+     * @generated from field: repeated string values = 3;
+     */
+    values: string[];
+    /**
+     * narrowable reports whether a workspace's settings may narrow the
+     * feature within its entitlement: turn it off, or set a lower limit.
+     *
+     * @generated from field: bool narrowable = 4;
+     */
+    narrowable: boolean;
+    /**
+     * entitlement is the most the workspace may have of the feature: the
+     * operator's override for the workspace, else its plan's value, else the
+     * feature's default. Unset when the config turns the product off.
+     *
+     * @generated from field: toshi.workspace.v1.FeatureValue entitlement = 5;
+     */
+    entitlement?: FeatureValue | undefined;
+    /**
+     * setting is the workspace's own value of the feature, unset when it has
+     * none or when its entitlements leave the product, or this bool feature,
+     * out. A setting the entitlement no longer contains, after the plan or
+     * an override lowered it, is kept and not applied.
+     *
+     * @generated from field: toshi.workspace.v1.FeatureValue setting = 6;
+     */
+    setting?: FeatureValue | undefined;
+    /**
+     * effective is the value that applies: the setting when the feature is
+     * narrowable and the entitlement contains it, else the entitlement.
+     * Unset when the config turns the product off.
+     *
+     * @generated from field: toshi.workspace.v1.FeatureValue effective = 7;
+     */
+    effective?: FeatureValue | undefined;
+};
+/**
+ * ProductFeature is a typed key a product declares.
+ *
+ * @generated from message toshi.workspace.v1.ProductFeature
+ */
+export type ProductFeatureJson = {
+    /**
+     * key is "<product id>.<name>".
+     *
+     * @generated from field: string key = 1;
+     */
+    key?: string;
+    /**
+     * @generated from field: toshi.workspace.v1.ProductFeatureType type = 2;
+     */
+    type?: ProductFeatureTypeJson;
+    /**
+     * values are an enum's values; empty for the other types.
+     *
+     * @generated from field: repeated string values = 3;
+     */
+    values?: string[];
+    /**
+     * narrowable reports whether a workspace's settings may narrow the
+     * feature within its entitlement: turn it off, or set a lower limit.
+     *
+     * @generated from field: bool narrowable = 4;
+     */
+    narrowable?: boolean;
+    /**
+     * entitlement is the most the workspace may have of the feature: the
+     * operator's override for the workspace, else its plan's value, else the
+     * feature's default. Unset when the config turns the product off.
+     *
+     * @generated from field: toshi.workspace.v1.FeatureValue entitlement = 5;
+     */
+    entitlement?: FeatureValueJson;
+    /**
+     * setting is the workspace's own value of the feature, unset when it has
+     * none or when its entitlements leave the product, or this bool feature,
+     * out. A setting the entitlement no longer contains, after the plan or
+     * an override lowered it, is kept and not applied.
+     *
+     * @generated from field: toshi.workspace.v1.FeatureValue setting = 6;
+     */
+    setting?: FeatureValueJson;
+    /**
+     * effective is the value that applies: the setting when the feature is
+     * narrowable and the entitlement contains it, else the entitlement.
+     * Unset when the config turns the product off.
+     *
+     * @generated from field: toshi.workspace.v1.FeatureValue effective = 7;
+     */
+    effective?: FeatureValueJson;
+};
+/**
+ * Describes the message toshi.workspace.v1.ProductFeature.
+ * Use `create(ProductFeatureSchema)` to create a new message.
+ */
+export declare const ProductFeatureSchema: GenMessage<ProductFeature, {
+    jsonType: ProductFeatureJson;
+}>;
+/**
+ * FeatureValue is a value of a feature, of the feature's type.
+ *
+ * @generated from message toshi.workspace.v1.FeatureValue
+ */
+export type FeatureValue = Message<"toshi.workspace.v1.FeatureValue"> & {
+    /**
+     * @generated from oneof toshi.workspace.v1.FeatureValue.value
+     */
+    value: {
+        /**
+         * A bool feature's value.
+         *
+         * @generated from field: bool bool = 1;
+         */
+        value: boolean;
+        case: "bool";
+    } | {
+        /**
+         * A count feature's value, never negative.
+         *
+         * @generated from field: int64 count = 2;
+         */
+        value: bigint;
+        case: "count";
+    } | {
+        /**
+         * A range feature's value.
+         *
+         * @generated from field: toshi.workspace.v1.FeatureRange range = 3;
+         */
+        value: FeatureRange;
+        case: "range";
+    } | {
+        /**
+         * An enum feature's value, one of its values, or a string feature's.
+         *
+         * @generated from field: string text = 4;
+         */
+        value: string;
+        case: "text";
+    } | {
+        case: undefined;
+        value?: undefined;
+    };
+};
+/**
+ * FeatureValue is a value of a feature, of the feature's type.
+ *
+ * @generated from message toshi.workspace.v1.FeatureValue
+ */
+export type FeatureValueJson = {
+    /**
+     * A bool feature's value.
+     *
+     * @generated from field: bool bool = 1;
+     */
+    bool?: boolean;
+    /**
+     * A count feature's value, never negative.
+     *
+     * @generated from field: int64 count = 2;
+     */
+    count?: string;
+    /**
+     * A range feature's value.
+     *
+     * @generated from field: toshi.workspace.v1.FeatureRange range = 3;
+     */
+    range?: FeatureRangeJson;
+    /**
+     * An enum feature's value, one of its values, or a string feature's.
+     *
+     * @generated from field: string text = 4;
+     */
+    text?: string;
+};
+/**
+ * Describes the message toshi.workspace.v1.FeatureValue.
+ * Use `create(FeatureValueSchema)` to create a new message.
+ */
+export declare const FeatureValueSchema: GenMessage<FeatureValue, {
+    jsonType: FeatureValueJson;
+}>;
+/**
+ * FeatureRange is a range feature's value: from min to max, both included.
+ *
+ * @generated from message toshi.workspace.v1.FeatureRange
+ */
+export type FeatureRange = Message<"toshi.workspace.v1.FeatureRange"> & {
+    /**
+     * @generated from field: int64 min = 1;
+     */
+    min: bigint;
+    /**
+     * @generated from field: int64 max = 2;
+     */
+    max: bigint;
+};
+/**
+ * FeatureRange is a range feature's value: from min to max, both included.
+ *
+ * @generated from message toshi.workspace.v1.FeatureRange
+ */
+export type FeatureRangeJson = {
+    /**
+     * @generated from field: int64 min = 1;
+     */
+    min?: string;
+    /**
+     * @generated from field: int64 max = 2;
+     */
+    max?: string;
+};
+/**
+ * Describes the message toshi.workspace.v1.FeatureRange.
+ * Use `create(FeatureRangeSchema)` to create a new message.
+ */
+export declare const FeatureRangeSchema: GenMessage<FeatureRange, {
+    jsonType: FeatureRangeJson;
+}>;
+/**
+ * APIVersions are the versions a client checks itself against.
+ *
+ * @generated from message toshi.workspace.v1.APIVersions
+ */
+export type APIVersions = Message<"toshi.workspace.v1.APIVersions"> & {
+    /**
+     * api is the Toshi API's version, MAJOR.MINOR.PATCH: the version of the
+     * toshi-api module the SDKs are built from.
+     *
+     * @generated from field: string api = 1;
+     */
+    api: string;
+    /**
+     * control_plane is the control plane's release, as GetVersion returns it.
+     *
+     * @generated from field: string control_plane = 2;
+     */
+    controlPlane: string;
+};
+/**
+ * APIVersions are the versions a client checks itself against.
+ *
+ * @generated from message toshi.workspace.v1.APIVersions
+ */
+export type APIVersionsJson = {
+    /**
+     * api is the Toshi API's version, MAJOR.MINOR.PATCH: the version of the
+     * toshi-api module the SDKs are built from.
+     *
+     * @generated from field: string api = 1;
+     */
+    api?: string;
+    /**
+     * control_plane is the control plane's release, as GetVersion returns it.
+     *
+     * @generated from field: string control_plane = 2;
+     */
+    controlPlane?: string;
+};
+/**
+ * Describes the message toshi.workspace.v1.APIVersions.
+ * Use `create(APIVersionsSchema)` to create a new message.
+ */
+export declare const APIVersionsSchema: GenMessage<APIVersions, {
+    jsonType: APIVersionsJson;
+}>;
+/**
+ * ProductState is where a product is in the deployment's lifecycle. A
+ * product the config turns off goes from no new work through draining to
+ * stopped as its work ends, and back to enabled when the config turns it on
+ * again. None of the states deletes the product's data.
+ *
+ * @generated from enum toshi.workspace.v1.ProductState
+ */
+export declare enum ProductState {
+    /**
+     * @generated from enum value: PRODUCT_STATE_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * The config turns the product on: it takes new work.
+     *
+     * @generated from enum value: PRODUCT_STATE_ENABLED = 1;
+     */
+    ENABLED = 1,
+    /**
+     * Turned off, with work it accepted that has not started: it takes no new
+     * work, and that work still runs.
+     *
+     * @generated from enum value: PRODUCT_STATE_NO_NEW_WORK = 2;
+     */
+    NO_NEW_WORK = 2,
+    /**
+     * Turned off, with its last work running: that work ends as it would
+     * have.
+     *
+     * @generated from enum value: PRODUCT_STATE_DRAINING = 3;
+     */
+    DRAINING = 3,
+    /**
+     * Turned off, with nothing left to finish.
+     *
+     * @generated from enum value: PRODUCT_STATE_STOPPED = 4;
+     */
+    STOPPED = 4
+}
+/**
+ * ProductState is where a product is in the deployment's lifecycle. A
+ * product the config turns off goes from no new work through draining to
+ * stopped as its work ends, and back to enabled when the config turns it on
+ * again. None of the states deletes the product's data.
+ *
+ * @generated from enum toshi.workspace.v1.ProductState
+ */
+export type ProductStateJson = "PRODUCT_STATE_UNSPECIFIED" | "PRODUCT_STATE_ENABLED" | "PRODUCT_STATE_NO_NEW_WORK" | "PRODUCT_STATE_DRAINING" | "PRODUCT_STATE_STOPPED";
+/**
+ * Describes the enum toshi.workspace.v1.ProductState.
+ */
+export declare const ProductStateSchema: GenEnum<ProductState, ProductStateJson>;
+/**
+ * ProductSwitch is the switch that decides whether a product is on for a
+ * workspace. The deployment's config decides first, then the workspace's
+ * entitlements, then its settings; the first that turns the product off is
+ * the one named.
+ *
+ * @generated from enum toshi.workspace.v1.ProductSwitch
+ */
+export declare enum ProductSwitch {
+    /**
+     * @generated from enum value: PRODUCT_SWITCH_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * No switch turns the product off: it is on for the workspace.
+     *
+     * @generated from enum value: PRODUCT_SWITCH_ON = 1;
+     */
+    ON = 1,
+    /**
+     * The deployment's config turns the product off ("disabled").
+     *
+     * @generated from enum value: PRODUCT_SWITCH_DISABLED = 2;
+     */
+    DISABLED = 2,
+    /**
+     * The workspace's entitlements leave the product out ("not_entitled").
+     *
+     * @generated from enum value: PRODUCT_SWITCH_NOT_ENTITLED = 3;
+     */
+    NOT_ENTITLED = 3,
+    /**
+     * The workspace's settings turn the product off ("turned_off").
+     *
+     * @generated from enum value: PRODUCT_SWITCH_TURNED_OFF = 4;
+     */
+    TURNED_OFF = 4
+}
+/**
+ * ProductSwitch is the switch that decides whether a product is on for a
+ * workspace. The deployment's config decides first, then the workspace's
+ * entitlements, then its settings; the first that turns the product off is
+ * the one named.
+ *
+ * @generated from enum toshi.workspace.v1.ProductSwitch
+ */
+export type ProductSwitchJson = "PRODUCT_SWITCH_UNSPECIFIED" | "PRODUCT_SWITCH_ON" | "PRODUCT_SWITCH_DISABLED" | "PRODUCT_SWITCH_NOT_ENTITLED" | "PRODUCT_SWITCH_TURNED_OFF";
+/**
+ * Describes the enum toshi.workspace.v1.ProductSwitch.
+ */
+export declare const ProductSwitchSchema: GenEnum<ProductSwitch, ProductSwitchJson>;
+/**
+ * ProductFeatureType is the type of a feature's value.
+ *
+ * @generated from enum toshi.workspace.v1.ProductFeatureType
+ */
+export declare enum ProductFeatureType {
+    /**
+     * @generated from enum value: PRODUCT_FEATURE_TYPE_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * @generated from enum value: PRODUCT_FEATURE_TYPE_BOOL = 1;
+     */
+    BOOL = 1,
+    /**
+     * @generated from enum value: PRODUCT_FEATURE_TYPE_COUNT = 2;
+     */
+    COUNT = 2,
+    /**
+     * @generated from enum value: PRODUCT_FEATURE_TYPE_RANGE = 3;
+     */
+    RANGE = 3,
+    /**
+     * @generated from enum value: PRODUCT_FEATURE_TYPE_ENUM = 4;
+     */
+    ENUM = 4,
+    /**
+     * @generated from enum value: PRODUCT_FEATURE_TYPE_STRING = 5;
+     */
+    STRING = 5
+}
+/**
+ * ProductFeatureType is the type of a feature's value.
+ *
+ * @generated from enum toshi.workspace.v1.ProductFeatureType
+ */
+export type ProductFeatureTypeJson = "PRODUCT_FEATURE_TYPE_UNSPECIFIED" | "PRODUCT_FEATURE_TYPE_BOOL" | "PRODUCT_FEATURE_TYPE_COUNT" | "PRODUCT_FEATURE_TYPE_RANGE" | "PRODUCT_FEATURE_TYPE_ENUM" | "PRODUCT_FEATURE_TYPE_STRING";
+/**
+ * Describes the enum toshi.workspace.v1.ProductFeatureType.
+ */
+export declare const ProductFeatureTypeSchema: GenEnum<ProductFeatureType, ProductFeatureTypeJson>;
+/**
+ * DiscoveryService tells a client what this deployment serves and what the
+ * caller may do in the workspace, in one call: the products the build
+ * includes, where each is in the deployment's lifecycle and whether the
+ * workspace has it on, each feature's entitlement, setting and effective
+ * value, the caller's permissions and the versions of the API and the
+ * control plane. A client
+ * reads it to decide what to show and what to call.
+ *
+ * The caller's credential names the workspace, as for WorkloadService.
+ *
+ * @generated from service toshi.workspace.v1.DiscoveryService
+ */
+export declare const DiscoveryService: GenService<{
+    /**
+     * Discover returns the products, the caller's permissions in the
+     * workspace, or in one of its projects or environments, and the
+     * versions. A suspended workspace answers it.
+     *
+     * @generated from rpc toshi.workspace.v1.DiscoveryService.Discover
+     */
+    discover: {
+        methodKind: "unary";
+        input: typeof DiscoverRequestSchema;
+        output: typeof DiscoverResponseSchema;
+    };
+}>;