@mochabug/adapt-sdk 0.1.1

package/dist/genproto/mochabugapis/adapt/plugins/v1/variable_service_pb.d.ts

@@ -0,0 +1,190 @@
+import type { GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
+import type { Value, ValueJson } from "@bufbuild/protobuf/wkt";
+import type { JTDSchema, JTDSchemaJson } from "../../graph/jtd_schema_pb";
+import type { Message } from "@bufbuild/protobuf";
+/**
+ * Describes the file mochabugapis/adapt/plugins/v1/variable_service.proto.
+ */
+export declare const file_mochabugapis_adapt_plugins_v1_variable_service: GenFile;
+/**
+ * A definition of a JSON variable
+ *
+ * This message represents a variable used within the hosting platform.
+ * Variables are essential for configuring applications and services hosted on the platform.
+ * They store values that can be accessed by the application or service during runtime.
+ *
+ * @generated from message mochabugapis.adapt.plugins.v1.VariableDefinition
+ */
+export type VariableDefinition = Message<"mochabugapis.adapt.plugins.v1.VariableDefinition"> & {
+    /**
+     * The schema that the variable must adhere to
+     *
+     * @generated from field: mochabugapis.adapt.graph.JTDSchema schema = 1;
+     */
+    schema?: JTDSchema;
+    /**
+     * The optional default value.
+     *
+     * ## Default Behavior: System Settings vs User Settings
+     *
+     * **System Settings** (Manifest.system_services):
+     * - Defaults are automatically applied when the plugin is installed
+     * - The service is marked as "configured" if all required bindings have defaults
+     * - Plugin creators define and approve these defaults
+     *
+     * **User Settings** (Vertex.user_services):
+     * - Defaults are UI hints only and NOT automatically applied
+     * - The service is NOT marked as "configured" until the user explicitly submits settings
+     * - Users must review and approve all settings, even with defaults present
+     * - This ensures users actively consent to configuration values
+     *
+     * ## Rationale
+     *
+     * System settings use automatic defaults because the plugin creator (who defines
+     * the defaults) is also the one approving them during plugin development.
+     *
+     * User settings require explicit submission because end users need to review and
+     * consciously approve configuration values, even if reasonable defaults exist.
+     *
+     * IF the default value is pointing to a file with .json ending it's content will be
+     * loaded and parsed as JSON.
+     *
+     * @generated from field: optional google.protobuf.Value default = 2;
+     */
+    default?: Value;
+    /**
+     * If true, the variable value is NOT treated as a secret.
+     *
+     * ## When plaintext = false (default):
+     * - Values are encrypted at rest
+     * - Values are treated as sensitive secrets
+     *
+     * ## When plaintext = true:
+     * - Values are stored normally (not encrypted)
+     * - Values are treated as non-sensitive data
+     *
+     * ## Use Cases for plaintext = false (default):
+     * - API keys, access tokens, passwords
+     * - Database connection strings with credentials
+     * - Encryption keys, signing secrets
+     * - OAuth client secrets
+     * - Any credential material
+     *
+     * ## Use Cases for plaintext = true:
+     * - Public configuration values
+     * - Feature flags
+     * - API endpoints (URLs without credentials)
+     * - User IDs, tenant IDs, organization IDs
+     * - Public identifiers
+     *
+     * ## Security Best Practices
+     *
+     * ALWAYS leave plaintext = false (default) for:
+     * - Anything that grants access or authorization
+     * - Anything that could be used to impersonate a user or service
+     * - Any sensitive user-provided data
+     *
+     * Only set plaintext = true when the value contains non-sensitive
+     * user-provided information.
+     *
+     * Default: false (variables are secrets by default)
+     *
+     * @generated from field: bool plaintext = 3;
+     */
+    plaintext: boolean;
+};
+/**
+ * A definition of a JSON variable
+ *
+ * This message represents a variable used within the hosting platform.
+ * Variables are essential for configuring applications and services hosted on the platform.
+ * They store values that can be accessed by the application or service during runtime.
+ *
+ * @generated from message mochabugapis.adapt.plugins.v1.VariableDefinition
+ */
+export type VariableDefinitionJson = {
+    /**
+     * The schema that the variable must adhere to
+     *
+     * @generated from field: mochabugapis.adapt.graph.JTDSchema schema = 1;
+     */
+    schema?: JTDSchemaJson;
+    /**
+     * The optional default value.
+     *
+     * ## Default Behavior: System Settings vs User Settings
+     *
+     * **System Settings** (Manifest.system_services):
+     * - Defaults are automatically applied when the plugin is installed
+     * - The service is marked as "configured" if all required bindings have defaults
+     * - Plugin creators define and approve these defaults
+     *
+     * **User Settings** (Vertex.user_services):
+     * - Defaults are UI hints only and NOT automatically applied
+     * - The service is NOT marked as "configured" until the user explicitly submits settings
+     * - Users must review and approve all settings, even with defaults present
+     * - This ensures users actively consent to configuration values
+     *
+     * ## Rationale
+     *
+     * System settings use automatic defaults because the plugin creator (who defines
+     * the defaults) is also the one approving them during plugin development.
+     *
+     * User settings require explicit submission because end users need to review and
+     * consciously approve configuration values, even if reasonable defaults exist.
+     *
+     * IF the default value is pointing to a file with .json ending it's content will be
+     * loaded and parsed as JSON.
+     *
+     * @generated from field: optional google.protobuf.Value default = 2;
+     */
+    default?: ValueJson;
+    /**
+     * If true, the variable value is NOT treated as a secret.
+     *
+     * ## When plaintext = false (default):
+     * - Values are encrypted at rest
+     * - Values are treated as sensitive secrets
+     *
+     * ## When plaintext = true:
+     * - Values are stored normally (not encrypted)
+     * - Values are treated as non-sensitive data
+     *
+     * ## Use Cases for plaintext = false (default):
+     * - API keys, access tokens, passwords
+     * - Database connection strings with credentials
+     * - Encryption keys, signing secrets
+     * - OAuth client secrets
+     * - Any credential material
+     *
+     * ## Use Cases for plaintext = true:
+     * - Public configuration values
+     * - Feature flags
+     * - API endpoints (URLs without credentials)
+     * - User IDs, tenant IDs, organization IDs
+     * - Public identifiers
+     *
+     * ## Security Best Practices
+     *
+     * ALWAYS leave plaintext = false (default) for:
+     * - Anything that grants access or authorization
+     * - Anything that could be used to impersonate a user or service
+     * - Any sensitive user-provided data
+     *
+     * Only set plaintext = true when the value contains non-sensitive
+     * user-provided information.
+     *
+     * Default: false (variables are secrets by default)
+     *
+     * @generated from field: bool plaintext = 3;
+     */
+    plaintext?: boolean;
+};
+/**
+ * Describes the message mochabugapis.adapt.plugins.v1.VariableDefinition.
+ * Use `create(VariableDefinitionSchema)` to create a new message.
+ */
+export declare const VariableDefinitionSchema: GenMessage<VariableDefinition, {
+    jsonType: VariableDefinitionJson;
+}>;
+//# sourceMappingURL=variable_service_pb.d.ts.map

package/dist/genproto/mochabugapis/adapt/plugins/v1/variable_service_pb.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"variable_service_pb.d.ts","sourceRoot":"","sources":["../../../../../../src/genproto/mochabugapis/adapt/plugins/v1/variable_service_pb.ts"],"names":[],"mappings":"AAmBA,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAGxE,OAAO,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAE/D,OAAO,KAAK,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAE1E,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAElD;;GAEG;AACH,eAAO,MAAM,mDAAmD,EAAE,OACoY,CAAC;AAEvc;;;;;;;;GAQG;AACH,MAAM,MAAM,kBAAkB,GAAG,OAAO,CAAC,kDAAkD,CAAC,GAAG;IAC7F;;;;OAIG;IACH,MAAM,CAAC,EAAE,SAAS,CAAC;IAEnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC;IAEhB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACH,SAAS,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;;;OAIG;IACH,MAAM,CAAC,EAAE,aAAa,CAAC;IAEvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,OAAO,CAAC,EAAE,SAAS,CAAC;IAEpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,wBAAwB,EAAE,UAAU,CAAC,kBAAkB,EAAE;IAAC,QAAQ,EAAE,sBAAsB,CAAA;CAAC,CACnC,CAAC"}

package/dist/genproto/mochabugapis/adapt/plugins/v1/vertex_pb.d.ts

@@ -0,0 +1,269 @@
+import type { GenEnum, GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
+import type { Message } from "@bufbuild/protobuf";
+/**
+ * Describes the file mochabugapis/adapt/plugins/v1/vertex.proto.
+ */
+export declare const file_mochabugapis_adapt_plugins_v1_vertex: GenFile;
+/**
+ * Vertex represents a graph vertex that defines a plugin.
+ * Note: Be aware of potential security implications when dealing with
+ * user-provided data, such as file paths, and ensure proper input validation
+ * and sanitization.
+ *
+ * @generated from message mochabugapis.adapt.plugins.v1.Vertex
+ */
+export type Vertex = Message<"mochabugapis.adapt.plugins.v1.Vertex"> & {
+    /**
+     * 'name' represents the vertex name.
+     *
+     * @generated from field: string name = 1;
+     */
+    name: string;
+    /**
+     * 'label' is a human-friendly label displayed in the UI.
+     *
+     * @generated from field: string label = 2;
+     */
+    label: string;
+    /**
+     * 'description' is a human-friendly short description of the vertex displayed
+     * in UI.
+     *
+     * @generated from field: optional string description = 3;
+     */
+    description?: string;
+    /**
+     * 'logo' is the file path to the vertex logo, which will be resized to a
+     * maximum of 40x40 pixels. Ensure that the logo files are from trusted
+     * sources to avoid security risks.
+     * - Supported file formats:
+     *   - GIF: .gif
+     *   - JPEG: .jpg, .jpeg, .jfif, .pjpeg, .pjp
+     *   - PNG: .png
+     *   - SVG: .svg
+     *   - WEBP: .webp
+     *   - AVIF: .avif
+     *
+     * @generated from field: optional string logo = 4;
+     */
+    logo?: string;
+    /**
+     * 'capabilities' specifies the capabilities of the vertex
+     *
+     * @generated from field: repeated mochabugapis.adapt.plugins.v1.Capability capabilities = 5;
+     */
+    capabilities: Capability[];
+    /**
+     * 'config' is an field that contains a Unix file path.
+     * This can be any type of file, this is only intepreted for the vertex itself
+     * Restrictions:
+     *
+     *
+     * @generated from field: optional string config = 6;
+     */
+    config?: string;
+    /**
+     * 'metadata' is an field that contains a Unix file path.
+     * This determines which receivers, transmitters etc... the vertex has to begin with
+     * Restrictions:
+     *
+     *
+     * @generated from field: string metadata = 7;
+     */
+    metadata: string;
+    /**
+     * 'user_services' are vertex-level services configured per vertex instance.
+     *
+     * This is a string array where each string directly references a ServiceDefinition by its name
+     * from Manifest.service_definitions. These services are configured by end users for each
+     * specific vertex instance in their workflow.
+     *
+     * The `optional` field in the ServiceDefinition controls whether configuration is required:
+     * - If ServiceDefinition.optional = false (default): User MUST configure this service
+     * - If ServiceDefinition.optional = true: User MAY skip configuring this service
+     *
+     * Example:
+     *   service_definitions: [
+     *     { name: "api_key", variable: {...} },
+     *     { name: "webhook_url", variable: {...}, optional: true }
+     *   ]
+     *   user_services: ["api_key", "webhook_url"]
+     *
+     * @generated from field: repeated string user_services = 8;
+     */
+    userServices: string[];
+    /**
+     * 'deprecated' is a boolean that indicates if the vertex is deprecated
+     * this means that it will be removed in the next major version
+     * and should be migrated asap
+     *
+     * @generated from field: optional bool deprecated = 9;
+     */
+    deprecated?: boolean;
+};
+/**
+ * Vertex represents a graph vertex that defines a plugin.
+ * Note: Be aware of potential security implications when dealing with
+ * user-provided data, such as file paths, and ensure proper input validation
+ * and sanitization.
+ *
+ * @generated from message mochabugapis.adapt.plugins.v1.Vertex
+ */
+export type VertexJson = {
+    /**
+     * 'name' represents the vertex name.
+     *
+     * @generated from field: string name = 1;
+     */
+    name?: string;
+    /**
+     * 'label' is a human-friendly label displayed in the UI.
+     *
+     * @generated from field: string label = 2;
+     */
+    label?: string;
+    /**
+     * 'description' is a human-friendly short description of the vertex displayed
+     * in UI.
+     *
+     * @generated from field: optional string description = 3;
+     */
+    description?: string;
+    /**
+     * 'logo' is the file path to the vertex logo, which will be resized to a
+     * maximum of 40x40 pixels. Ensure that the logo files are from trusted
+     * sources to avoid security risks.
+     * - Supported file formats:
+     *   - GIF: .gif
+     *   - JPEG: .jpg, .jpeg, .jfif, .pjpeg, .pjp
+     *   - PNG: .png
+     *   - SVG: .svg
+     *   - WEBP: .webp
+     *   - AVIF: .avif
+     *
+     * @generated from field: optional string logo = 4;
+     */
+    logo?: string;
+    /**
+     * 'capabilities' specifies the capabilities of the vertex
+     *
+     * @generated from field: repeated mochabugapis.adapt.plugins.v1.Capability capabilities = 5;
+     */
+    capabilities?: CapabilityJson[];
+    /**
+     * 'config' is an field that contains a Unix file path.
+     * This can be any type of file, this is only intepreted for the vertex itself
+     * Restrictions:
+     *
+     *
+     * @generated from field: optional string config = 6;
+     */
+    config?: string;
+    /**
+     * 'metadata' is an field that contains a Unix file path.
+     * This determines which receivers, transmitters etc... the vertex has to begin with
+     * Restrictions:
+     *
+     *
+     * @generated from field: string metadata = 7;
+     */
+    metadata?: string;
+    /**
+     * 'user_services' are vertex-level services configured per vertex instance.
+     *
+     * This is a string array where each string directly references a ServiceDefinition by its name
+     * from Manifest.service_definitions. These services are configured by end users for each
+     * specific vertex instance in their workflow.
+     *
+     * The `optional` field in the ServiceDefinition controls whether configuration is required:
+     * - If ServiceDefinition.optional = false (default): User MUST configure this service
+     * - If ServiceDefinition.optional = true: User MAY skip configuring this service
+     *
+     * Example:
+     *   service_definitions: [
+     *     { name: "api_key", variable: {...} },
+     *     { name: "webhook_url", variable: {...}, optional: true }
+     *   ]
+     *   user_services: ["api_key", "webhook_url"]
+     *
+     * @generated from field: repeated string user_services = 8;
+     */
+    userServices?: string[];
+    /**
+     * 'deprecated' is a boolean that indicates if the vertex is deprecated
+     * this means that it will be removed in the next major version
+     * and should be migrated asap
+     *
+     * @generated from field: optional bool deprecated = 9;
+     */
+    deprecated?: boolean;
+};
+/**
+ * Describes the message mochabugapis.adapt.plugins.v1.Vertex.
+ * Use `create(VertexSchema)` to create a new message.
+ */
+export declare const VertexSchema: GenMessage<Vertex, {
+    jsonType: VertexJson;
+}>;
+/**
+ * The capabilities of a vertex defines how the vertex is interracted with
+ * If the vertex has the cron capabilitiy, then a cron-scheduler will call the
+ * cron endpoint periodically until the vertex has finished or stopped
+ * If the vertex has external browser capabiltity, there will be an external endpoint
+ * where a third-party can communicate with the vertex
+ * If the vertex has a configurator, then the vertex will be able to be configured dynamically
+ *
+ * @generated from enum mochabugapis.adapt.plugins.v1.Capability
+ */
+export declare enum Capability {
+    /**
+     * Unspecified capability (default value, should not be used).
+     *
+     * @generated from enum value: CAPABILITY_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * Cron capability, indicating that the vertex can be triggered at specific
+     * intervals.
+     *
+     * @generated from enum value: CAPABILITY_CRON = 1;
+     */
+    CRON = 1,
+    /**
+     * The external capability, indicating that the vertex can be accessed via a
+     * publicly routable address.
+     *
+     * @generated from enum value: CAPABILITY_EXTERNAL = 2;
+     */
+    EXTERNAL = 2,
+    /**
+     * Configurator capability, indicating that the vertex can be configured
+     * dynamically by a vertex-defined interface.
+     *
+     * @generated from enum value: CAPABILITY_CONFIGURATOR = 3;
+     */
+    CONFIGURATOR = 3,
+    /**
+     * Browser capability, indicating that the vertex can be accessed via a
+     * browser context.
+     *
+     * @generated from enum value: CAPABILITY_BROWSER = 4;
+     */
+    BROWSER = 4
+}
+/**
+ * The capabilities of a vertex defines how the vertex is interracted with
+ * If the vertex has the cron capabilitiy, then a cron-scheduler will call the
+ * cron endpoint periodically until the vertex has finished or stopped
+ * If the vertex has external browser capabiltity, there will be an external endpoint
+ * where a third-party can communicate with the vertex
+ * If the vertex has a configurator, then the vertex will be able to be configured dynamically
+ *
+ * @generated from enum mochabugapis.adapt.plugins.v1.Capability
+ */
+export type CapabilityJson = "CAPABILITY_UNSPECIFIED" | "CAPABILITY_CRON" | "CAPABILITY_EXTERNAL" | "CAPABILITY_CONFIGURATOR" | "CAPABILITY_BROWSER";
+/**
+ * Describes the enum mochabugapis.adapt.plugins.v1.Capability.
+ */
+export declare const CapabilitySchema: GenEnum<Capability, CapabilityJson>;
+//# sourceMappingURL=vertex_pb.d.ts.map

package/dist/genproto/mochabugapis/adapt/plugins/v1/vertex_pb.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vertex_pb.d.ts","sourceRoot":"","sources":["../../../../../../src/genproto/mochabugapis/adapt/plugins/v1/vertex_pb.ts"],"names":[],"mappings":"AAmBA,OAAO,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAGjF,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAElD;;GAEG;AACH,eAAO,MAAM,yCAAyC,EAAE,OACw+B,CAAC;AAEjiC;;;;;;;GAOG;AACH,MAAM,MAAM,MAAM,GAAG,OAAO,CAAC,sCAAsC,CAAC,GAAG;IACrE;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;;;;;;;;OAaG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,YAAY,EAAE,UAAU,EAAE,CAAC;IAE3B;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;;;OAOG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,YAAY,EAAE,MAAM,EAAE,CAAC;IAEvB;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;;;;;;;;OAaG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,YAAY,CAAC,EAAE,cAAc,EAAE,CAAC;IAEhC;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IAExB;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,YAAY,EAAE,UAAU,CAAC,MAAM,EAAE;IAAC,QAAQ,EAAE,UAAU,CAAA;CAAC,CACT,CAAC;AAE5D;;;;;;;;;GASG;AACH,oBAAY,UAAU;IACpB;;;;OAIG;IACH,WAAW,IAAI;IAEf;;;;;OAKG;IACH,IAAI,IAAI;IAER;;;;;OAKG;IACH,QAAQ,IAAI;IAEZ;;;;;OAKG;IACH,YAAY,IAAI;IAEhB;;;;;OAKG;IACH,OAAO,IAAI;CACZ;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,cAAc,GAAG,wBAAwB,GAAG,iBAAiB,GAAG,qBAAqB,GAAG,yBAAyB,GAAG,oBAAoB,CAAC;AAErJ;;GAEG;AACH,eAAO,MAAM,gBAAgB,EAAE,OAAO,CAAC,UAAU,EAAE,cAAc,CACT,CAAC"}