@eide/foir-proto-ts 0.21.0 → 0.22.0

package/src/apps/v1/apps_pb.d.ts

@@ -0,0 +1,722 @@
+// @generated by protoc-gen-es v2.11.0 with parameter "import_extension=js"
+// @generated from file apps/v1/apps.proto (package apps.v1, syntax proto3)
+/* eslint-disable */
+
+import type { GenEnum, GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
+import type { JsonObject, Message } from "@bufbuild/protobuf";
+
+/**
+ * Describes the file apps/v1/apps.proto.
+ */
+export declare const file_apps_v1_apps: GenFile;
+
+/**
+ * Top-level manifest.
+ *
+ * @generated from message apps.v1.AppConfig
+ */
+export declare type AppConfig = Message<"apps.v1.AppConfig"> & {
+  /**
+   * REQUIRED. Kebab-case globally unique within a project. Matches the key
+   * under apps.<name> in foir.config.ts.
+   *
+   * @generated from field: string name = 1;
+   */
+  name: string;
+
+  /**
+   * REQUIRED. Semver-like free-text version string. Used only for display
+   * and update-diff context; not interpreted by the platform for ordering.
+   *
+   * @generated from field: string version = 2;
+   */
+  version: string;
+
+  /**
+   * OPTIONAL. Display metadata for admin UI.
+   *
+   * @generated from field: apps.v1.Metadata metadata = 3;
+   */
+  metadata?: Metadata;
+
+  /**
+   * OPTIONAL. If present, the app has a runtime service. Absent for pure
+   * iframe-only apps.
+   *
+   * @generated from field: apps.v1.Middleware middleware = 4;
+   */
+  middleware?: Middleware;
+
+  /**
+   * OPTIONAL. Credential strategy and schema. Absent for apps that need no
+   * external-service credentials (CSV importer, color picker).
+   *
+   * @generated from field: apps.v1.Credentials credentials = 5;
+   */
+  credentials?: Credentials;
+
+  /**
+   * OPTIONAL. JSON Schema describing per-project settings. Shape, not values.
+   *
+   * @generated from field: google.protobuf.Struct settings_schema = 6;
+   */
+  settingsSchema?: JsonObject;
+
+  /**
+   * OPTIONAL. Inbound data shapes the app can deliver. Each source type is
+   * mapped onto a project model at install time.
+   *
+   * @generated from field: map<string, apps.v1.SourceType> sources = 7;
+   */
+  sources: { [key: string]: SourceType };
+
+  /**
+   * OPTIONAL. Outbound data requirements. Each sink is mapped onto a
+   * project model at install time.
+   *
+   * @generated from field: map<string, apps.v1.SinkContract> sinks = 8;
+   */
+  sinks: { [key: string]: SinkContract };
+
+  /**
+   * OPTIONAL. Operations contributed by the app. Keys starting with `__`
+   * are platform-reserved (__uninstall, __validate_credentials).
+   *
+   * @generated from field: repeated apps.v1.Operation operations = 9;
+   */
+  operations: Operation[];
+
+  /**
+   * OPTIONAL. Hooks contributed by the app. Filters use source-type or
+   * sink-contract names; platform resolves to mapped model keys at install.
+   *
+   * @generated from field: repeated apps.v1.Hook hooks = 10;
+   */
+  hooks: Hook[];
+
+  /**
+   * OPTIONAL. UI placements the app contributes.
+   *
+   * @generated from field: apps.v1.UI ui = 11;
+   */
+  ui?: UI;
+
+  /**
+   * OPTIONAL. Inbound webhook declaration. If present, the gateway routes
+   * webhooks for this app to `${middleware.url}${inbound.webhook.path}`.
+   *
+   * @generated from field: apps.v1.Inbound inbound = 12;
+   */
+  inbound?: Inbound;
+};
+
+/**
+ * Describes the message apps.v1.AppConfig.
+ * Use `create(AppConfigSchema)` to create a new message.
+ */
+export declare const AppConfigSchema: GenMessage<AppConfig>;
+
+/**
+ * @generated from message apps.v1.Metadata
+ */
+export declare type Metadata = Message<"apps.v1.Metadata"> & {
+  /**
+   * e.g. "Shopify"
+   *
+   * @generated from field: string display_name = 1;
+   */
+  displayName: string;
+
+  /**
+   * @generated from field: string description = 2;
+   */
+  description: string;
+
+  /**
+   * icon key or URL
+   *
+   * @generated from field: string icon = 3;
+   */
+  icon: string;
+
+  /**
+   * @generated from field: string author = 4;
+   */
+  author: string;
+
+  /**
+   * public docs URL, optional
+   *
+   * @generated from field: string homepage = 5;
+   */
+  homepage: string;
+};
+
+/**
+ * Describes the message apps.v1.Metadata.
+ * Use `create(MetadataSchema)` to create a new message.
+ */
+export declare const MetadataSchema: GenMessage<Metadata>;
+
+/**
+ * @generated from message apps.v1.Middleware
+ */
+export declare type Middleware = Message<"apps.v1.Middleware"> & {
+  /**
+   * REQUIRED within Middleware. https URL of the app's service.
+   *
+   * @generated from field: string url = 1;
+   */
+  url: string;
+};
+
+/**
+ * Describes the message apps.v1.Middleware.
+ * Use `create(MiddlewareSchema)` to create a new message.
+ */
+export declare const MiddlewareSchema: GenMessage<Middleware>;
+
+/**
+ * @generated from message apps.v1.Credentials
+ */
+export declare type Credentials = Message<"apps.v1.Credentials"> & {
+  /**
+   * @generated from field: apps.v1.Credentials.Strategy strategy = 1;
+   */
+  strategy: Credentials_Strategy;
+
+  /**
+   * Shape of the admin form for strategies that take structured values.
+   * JSON Schema.
+   *
+   * @generated from field: optional google.protobuf.Struct schema = 2;
+   */
+  schema?: JsonObject;
+
+  /**
+   * Required only when strategy is OAUTH.
+   *
+   * @generated from field: optional apps.v1.OAuthConfig oauth = 3;
+   */
+  oauth?: OAuthConfig;
+};
+
+/**
+ * Describes the message apps.v1.Credentials.
+ * Use `create(CredentialsSchema)` to create a new message.
+ */
+export declare const CredentialsSchema: GenMessage<Credentials>;
+
+/**
+ * @generated from enum apps.v1.Credentials.Strategy
+ */
+export enum Credentials_Strategy {
+  /**
+   * @generated from enum value: STRATEGY_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * @generated from enum value: STRATEGY_OAUTH = 1;
+   */
+  OAUTH = 1,
+
+  /**
+   * @generated from enum value: STRATEGY_API_KEY = 2;
+   */
+  API_KEY = 2,
+
+  /**
+   * @generated from enum value: STRATEGY_SHARED_SECRET = 3;
+   */
+  SHARED_SECRET = 3,
+
+  /**
+   * @generated from enum value: STRATEGY_SSH_KEY = 4;
+   */
+  SSH_KEY = 4,
+
+  /**
+   * @generated from enum value: STRATEGY_NONE = 5;
+   */
+  NONE = 5,
+
+  /**
+   * @generated from enum value: STRATEGY_MANAGED = 6;
+   */
+  MANAGED = 6,
+}
+
+/**
+ * Describes the enum apps.v1.Credentials.Strategy.
+ */
+export declare const Credentials_StrategySchema: GenEnum<Credentials_Strategy>;
+
+/**
+ * @generated from message apps.v1.OAuthConfig
+ */
+export declare type OAuthConfig = Message<"apps.v1.OAuthConfig"> & {
+  /**
+   * e.g. "/authorize/start"
+   *
+   * @generated from field: string authorize_start_path = 1;
+   */
+  authorizeStartPath: string;
+
+  /**
+   * e.g. "/authorize/callback"
+   *
+   * @generated from field: string authorize_callback_path = 2;
+   */
+  authorizeCallbackPath: string;
+};
+
+/**
+ * Describes the message apps.v1.OAuthConfig.
+ * Use `create(OAuthConfigSchema)` to create a new message.
+ */
+export declare const OAuthConfigSchema: GenMessage<OAuthConfig>;
+
+/**
+ * @generated from message apps.v1.Inbound
+ */
+export declare type Inbound = Message<"apps.v1.Inbound"> & {
+  /**
+   * @generated from field: apps.v1.Webhook webhook = 1;
+   */
+  webhook?: Webhook;
+};
+
+/**
+ * Describes the message apps.v1.Inbound.
+ * Use `create(InboundSchema)` to create a new message.
+ */
+export declare const InboundSchema: GenMessage<Inbound>;
+
+/**
+ * @generated from message apps.v1.Webhook
+ */
+export declare type Webhook = Message<"apps.v1.Webhook"> & {
+  /**
+   * Path on middleware.url that receives webhook deliveries. The gateway
+   * proxies deliveries with an attached scoped token.
+   *
+   * @generated from field: string path = 1;
+   */
+  path: string;
+};
+
+/**
+ * Describes the message apps.v1.Webhook.
+ * Use `create(WebhookSchema)` to create a new message.
+ */
+export declare const WebhookSchema: GenMessage<Webhook>;
+
+/**
+ * A source type the app can deliver inbound. At install, admin maps this
+ * type onto a project model key and maps each suggested field onto a model
+ * field key.
+ *
+ * @generated from message apps.v1.SourceType
+ */
+export declare type SourceType = Message<"apps.v1.SourceType"> & {
+  /**
+   * @generated from field: string label = 1;
+   */
+  label: string;
+
+  /**
+   * @generated from field: map<string, apps.v1.SuggestedField> fields = 2;
+   */
+  fields: { [key: string]: SuggestedField };
+
+  /**
+   * @generated from field: string natural_key = 3;
+   */
+  naturalKey: string;
+};
+
+/**
+ * Describes the message apps.v1.SourceType.
+ * Use `create(SourceTypeSchema)` to create a new message.
+ */
+export declare const SourceTypeSchema: GenMessage<SourceType>;
+
+/**
+ * A sink contract the app needs outbound. At install, admin maps this
+ * contract onto a project model and maps each field onto a model field.
+ *
+ * @generated from message apps.v1.SinkContract
+ */
+export declare type SinkContract = Message<"apps.v1.SinkContract"> & {
+  /**
+   * @generated from field: string label = 1;
+   */
+  label: string;
+
+  /**
+   * Fields the app needs. Individual entries can be required: false.
+   *
+   * @generated from field: map<string, apps.v1.SinkField> fields = 2;
+   */
+  fields: { [key: string]: SinkField };
+
+  /**
+   * Which mapped field is the natural key for the external system's upsert.
+   *
+   * @generated from field: string natural_key = 3;
+   */
+  naturalKey: string;
+};
+
+/**
+ * Describes the message apps.v1.SinkContract.
+ * Use `create(SinkContractSchema)` to create a new message.
+ */
+export declare const SinkContractSchema: GenMessage<SinkContract>;
+
+/**
+ * @generated from message apps.v1.SuggestedField
+ */
+export declare type SuggestedField = Message<"apps.v1.SuggestedField"> & {
+  /**
+   * resolves to platform FieldType enum
+   *
+   * @generated from field: string type = 1;
+   */
+  type: string;
+
+  /**
+   * @generated from field: optional string label = 2;
+   */
+  label?: string;
+
+  /**
+   * @generated from field: optional bool required = 3;
+   */
+  required?: boolean;
+
+  /**
+   * @generated from field: optional google.protobuf.Struct config = 4;
+   */
+  config?: JsonObject;
+};
+
+/**
+ * Describes the message apps.v1.SuggestedField.
+ * Use `create(SuggestedFieldSchema)` to create a new message.
+ */
+export declare const SuggestedFieldSchema: GenMessage<SuggestedField>;
+
+/**
+ * A field in a SinkContract. Renamed from the older RequiredField — individual
+ * entries can still be required: false; the message name now reflects the
+ * surrounding contract, not the required flag.
+ *
+ * @generated from message apps.v1.SinkField
+ */
+export declare type SinkField = Message<"apps.v1.SinkField"> & {
+  /**
+   * Type hint only. Sink fields never carry field-type-specific configuration
+   * (select options, defaults, validation ranges). That belongs on the
+   * mapped project model field.
+   *
+   * @generated from field: string type = 1;
+   */
+  type: string;
+
+  /**
+   * e.g. "source-url", "target-url", "status-code"
+   *
+   * @generated from field: string semantic = 2;
+   */
+  semantic: string;
+
+  /**
+   * @generated from field: bool required = 3;
+   */
+  required: boolean;
+
+  /**
+   * @generated from field: optional string label = 4;
+   */
+  label?: string;
+};
+
+/**
+ * Describes the message apps.v1.SinkField.
+ * Use `create(SinkFieldSchema)` to create a new message.
+ */
+export declare const SinkFieldSchema: GenMessage<SinkField>;
+
+/**
+ * @generated from message apps.v1.Operation
+ */
+export declare type Operation = Message<"apps.v1.Operation"> & {
+  /**
+   * REQUIRED. Kebab-case, unique within the manifest. Keys starting with
+   * `__` are platform-reserved (currently __uninstall, __validate_credentials).
+   * On install the platform prefixes the stored key as `<appName>/<key>`
+   * for namespace isolation across apps.
+   *
+   * @generated from field: string key = 1;
+   */
+  key: string;
+
+  /**
+   * @generated from field: string name = 2;
+   */
+  name: string;
+
+  /**
+   * @generated from field: optional string description = 3;
+   */
+  description?: string;
+
+  /**
+   * REQUIRED. Path on middleware.url that handles invocation.
+   *
+   * @generated from field: string endpoint = 4;
+   */
+  endpoint: string;
+
+  /**
+   * REQUIRED. Capability set the platform mints the scoped token with.
+   * Each string resolves to a known capability; bare records:read /
+   * records:write (no :<model> suffix) are rejected at install.
+   * Placeholders `$<sourceType>` / `$<sinkContract>` inside model-scoped
+   * capabilities are resolved to concrete model keys at ConfirmInstallApp.
+   *
+   * @generated from field: repeated string capabilities = 5;
+   */
+  capabilities: string[];
+
+  /**
+   * @generated from field: optional int32 timeout_ms = 6;
+   */
+  timeoutMs?: number;
+
+  /**
+   * @generated from field: optional google.protobuf.Struct retry_policy = 7;
+   */
+  retryPolicy?: JsonObject;
+
+  /**
+   * @generated from field: optional google.protobuf.Struct input_schema = 8;
+   */
+  inputSchema?: JsonObject;
+
+  /**
+   * @generated from field: optional google.protobuf.Struct output_schema = 9;
+   */
+  outputSchema?: JsonObject;
+
+  /**
+   * @generated from field: optional bool supports_async = 10;
+   */
+  supportsAsync?: boolean;
+};
+
+/**
+ * Describes the message apps.v1.Operation.
+ * Use `create(OperationSchema)` to create a new message.
+ */
+export declare const OperationSchema: GenMessage<Operation>;
+
+/**
+ * @generated from message apps.v1.Hook
+ */
+export declare type Hook = Message<"apps.v1.Hook"> & {
+  /**
+   * @generated from field: string key = 1;
+   */
+  key: string;
+
+  /**
+   * @generated from field: string name = 2;
+   */
+  name: string;
+
+  /**
+   * REQUIRED. Record-event identifier: RECORD_CREATED, RECORD_UPDATED,
+   * RECORD_DELETED, RECORD_PUBLISHED, ...
+   *
+   * @generated from field: string event = 3;
+   */
+  event: string;
+
+  /**
+   * REQUIRED. Filter. `{ sourceType: "product" }`, `{ sinkContract: "redirect" }`,
+   * or `{ modelKey: "..." }`. Resolved to concrete modelKey at install.
+   *
+   * @generated from field: google.protobuf.Struct filter = 4;
+   */
+  filter?: JsonObject;
+
+  /**
+   * REQUIRED. Operation key from the same manifest's operations list.
+   * Resolved to the namespaced form (<appName>/<key>) at install.
+   *
+   * @generated from field: string operation = 5;
+   */
+  operation: string;
+};
+
+/**
+ * Describes the message apps.v1.Hook.
+ * Use `create(HookSchema)` to create a new message.
+ */
+export declare const HookSchema: GenMessage<Hook>;
+
+/**
+ * @generated from message apps.v1.UI
+ */
+export declare type UI = Message<"apps.v1.UI"> & {
+  /**
+   * @generated from field: repeated apps.v1.PlacementDeclaration placements = 1;
+   */
+  placements: PlacementDeclaration[];
+};
+
+/**
+ * Describes the message apps.v1.UI.
+ * Use `create(UISchema)` to create a new message.
+ */
+export declare const UISchema: GenMessage<UI>;
+
+/**
+ * The manifest-time declaration of a placement. At install, ConfirmInstallApp
+ * translates each declaration into a placements.v1.CreatePlacementRequest
+ * against the first-class PlacementsService. The persisted row has
+ * additional platform-assigned fields (id, tenant_id, project_id, config_id,
+ * timestamps) that aren't in the manifest.
+ *
+ * @generated from message apps.v1.PlacementDeclaration
+ */
+export declare type PlacementDeclaration = Message<"apps.v1.PlacementDeclaration"> & {
+  /**
+   * REQUIRED. Kebab-case. Unique within this manifest's ui.placements.
+   * Stable identifier used by admin UI for keying mapping choices
+   * (field_selected_at_install), by update-diff matching, and by the
+   * persisted placements row's UNIQUE (config_id, key).
+   *
+   * @generated from field: string key = 1;
+   */
+  key: string;
+
+  /**
+   * @generated from field: apps.v1.PlacementDeclaration.Target target = 2;
+   */
+  target: PlacementDeclaration_Target;
+
+  /**
+   * REQUIRED for MAIN_EDITOR, SIDEBAR, FIELD. Model key. Use "*" for
+   * placements that apply to every record. May reference a sourceType /
+   * sinkContract name from this manifest (resolved at install) OR a
+   * literal model key ("*" or a known project model).
+   *
+   * @generated from field: optional string model = 3;
+   */
+  model?: string;
+
+  /**
+   * REQUIRED for FIELD when field_selected_at_install is false. Must be
+   * empty when field_selected_at_install is true.
+   *
+   * @generated from field: optional string field = 4;
+   */
+  field?: string;
+
+  /**
+   * FIELD-only. When true, the admin chooses the specific field during
+   * the mapping step (keyed by placement.key).
+   *
+   * @generated from field: bool field_selected_at_install = 5;
+   */
+  fieldSelectedAtInstall: boolean;
+
+  /**
+   * REQUIRED for MAIN_EDITOR, SIDEBAR. Tab slug.
+   *
+   * @generated from field: optional string tab = 6;
+   */
+  tab?: string;
+
+  /**
+   * REQUIRED for all. Human-readable title.
+   *
+   * @generated from field: string title = 7;
+   */
+  title: string;
+
+  /**
+   * REQUIRED. https URL the iframe loads.
+   *
+   * @generated from field: string url = 8;
+   */
+  url: string;
+
+  /**
+   * MAIN_EDITOR only. If true, replaces the default record editor.
+   *
+   * @generated from field: optional bool replaces_default = 9;
+   */
+  replacesDefault?: boolean;
+
+  /**
+   * Free-form hints (icon, ordering, badge text).
+   *
+   * @generated from field: optional google.protobuf.Struct hints = 10;
+   */
+  hints?: JsonObject;
+};
+
+/**
+ * Describes the message apps.v1.PlacementDeclaration.
+ * Use `create(PlacementDeclarationSchema)` to create a new message.
+ */
+export declare const PlacementDeclarationSchema: GenMessage<PlacementDeclaration>;
+
+/**
+ * @generated from enum apps.v1.PlacementDeclaration.Target
+ */
+export enum PlacementDeclaration_Target {
+  /**
+   * @generated from enum value: TARGET_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * top-level admin page
+   *
+   * @generated from enum value: TARGET_FULL_PAGE = 1;
+   */
+  FULL_PAGE = 1,
+
+  /**
+   * record's primary editor
+   *
+   * @generated from enum value: TARGET_MAIN_EDITOR = 2;
+   */
+  MAIN_EDITOR = 2,
+
+  /**
+   * panel attached to a record editor
+   *
+   * @generated from enum value: TARGET_SIDEBAR = 3;
+   */
+  SIDEBAR = 3,
+
+  /**
+   * inline iframe for a specific field
+   *
+   * @generated from enum value: TARGET_FIELD = 4;
+   */
+  FIELD = 4,
+}
+
+/**
+ * Describes the enum apps.v1.PlacementDeclaration.Target.
+ */
+export declare const PlacementDeclaration_TargetSchema: GenEnum<PlacementDeclaration_Target>;
+