@foir/sdk 0.10.0 → 0.12.0

package/dist/app/contract/proto/apps/v1/discovery_pb.d.ts

@@ -0,0 +1,678 @@
+// @generated by protoc-gen-es v2.12.1 with parameter "import_extension=js"
+// @generated from file apps/v1/discovery.proto (package apps.v1, syntax proto3)
+/* eslint-disable */
+
+import type { GenEnum, GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
+import type { JsonObject, Message } from "@bufbuild/protobuf";
+import type { Timestamp } from "@bufbuild/protobuf/wkt";
+
+/**
+ * Describes the file apps/v1/discovery.proto.
+ */
+export declare const file_apps_v1_discovery: GenFile;
+
+/**
+ * What the setup screen tells an app's discovery, so that what it suggests
+ * fits this project rather than an empty one.
+ *
+ * @generated from message apps.v1.DiscoveryRequest
+ */
+export declare type DiscoveryRequest = Message<"apps.v1.DiscoveryRequest"> & {
+  /**
+   * The project's locale codes. An app suggesting locales can say which of its
+   * own the project already has.
+   *
+   * @generated from field: repeated string project_locales = 1;
+   */
+  projectLocales: string[];
+
+  /**
+   * The install's current settings, when it has any. A discovery run again
+   * keeps what the operator already confirmed as its suggestion, rather than
+   * proposing something new each time.
+   *
+   * @generated from field: google.protobuf.Struct current_settings = 2;
+   */
+  currentSettings?: JsonObject | undefined;
+};
+
+/**
+ * Describes the message apps.v1.DiscoveryRequest.
+ * Use `create(DiscoveryRequestSchema)` to create a new message.
+ */
+export declare const DiscoveryRequestSchema: GenMessage<DiscoveryRequest>;
+
+/**
+ * @generated from message apps.v1.DiscoveryResult
+ */
+export declare type DiscoveryResult = Message<"apps.v1.DiscoveryResult"> & {
+  /**
+   * @generated from field: google.protobuf.Timestamp discovered_at = 1;
+   */
+  discoveredAt?: Timestamp | undefined;
+
+  /**
+   * True only when everything below is the whole picture: nothing truncated,
+   * no availability undetermined, every request answered. A screen offering
+   * choices from an incomplete result says so.
+   *
+   * @generated from field: bool complete = 2;
+   */
+  complete: boolean;
+
+  /**
+   * The account the app is connected to, as the operator knows it.
+   *
+   * @generated from field: apps.v1.DiscoveredAccount account = 3;
+   */
+  account?: DiscoveredAccount | undefined;
+
+  /**
+   * Keyed by the manifest's source name. A name the manifest does not declare
+   * is ignored by the reader, since it has no source to map it onto.
+   *
+   * @generated from field: map<string, apps.v1.DiscoveredSource> sources = 4;
+   */
+  sources: { [key: string]: DiscoveredSource };
+
+  /**
+   * The account's own locales.
+   *
+   * @generated from field: repeated apps.v1.DiscoveredLocale locales = 5;
+   */
+  locales: DiscoveredLocale[];
+
+  /**
+   * Values for the app's own settings (its manifest's settings_schema),
+   * suggested from what was found. The operator confirms each; nothing here is
+   * applied on its own.
+   *
+   * @generated from field: google.protobuf.Struct suggested_settings = 6;
+   */
+  suggestedSettings?: JsonObject | undefined;
+
+  /**
+   * What the operator should know, most severe first.
+   *
+   * @generated from field: repeated apps.v1.DiscoveryNotice notices = 7;
+   */
+  notices: DiscoveryNotice[];
+
+  /**
+   * Access the app asked the account for and was not granted, in the vendor's
+   * own words (an OAuth scope, say). Reconnecting the account asks again.
+   *
+   * @generated from field: repeated string missing_access = 8;
+   */
+  missingAccess: string[];
+};
+
+/**
+ * Describes the message apps.v1.DiscoveryResult.
+ * Use `create(DiscoveryResultSchema)` to create a new message.
+ */
+export declare const DiscoveryResultSchema: GenMessage<DiscoveryResult>;
+
+/**
+ * @generated from message apps.v1.DiscoveredAccount
+ */
+export declare type DiscoveredAccount = Message<"apps.v1.DiscoveredAccount"> & {
+  /**
+   * The account's own name for itself.
+   *
+   * @generated from field: string name = 1;
+   */
+  name: string;
+
+  /**
+   * Where the account lives, for the operator to recognise it: a store's
+   * domain, a workspace's address.
+   *
+   * @generated from field: string url = 2;
+   */
+  url: string;
+};
+
+/**
+ * Describes the message apps.v1.DiscoveredAccount.
+ * Use `create(DiscoveredAccountSchema)` to create a new message.
+ */
+export declare const DiscoveredAccountSchema: GenMessage<DiscoveredAccount>;
+
+/**
+ * @generated from message apps.v1.DiscoveredSource
+ */
+export declare type DiscoveredSource = Message<"apps.v1.DiscoveredSource"> & {
+  /**
+   * @generated from field: apps.v1.Availability availability = 1;
+   */
+  availability?: Availability | undefined;
+
+  /**
+   * How many records the account holds. Absent when the app did not count.
+   *
+   * @generated from field: optional apps.v1.DiscoveredCount record_count = 2;
+   */
+  recordCount?: DiscoveredCount | undefined;
+
+  /**
+   * The fields a record can be keyed by, the app's recommendation first. The
+   * setup offers the first unless the operator chooses another.
+   *
+   * @generated from field: repeated apps.v1.NaturalKeyCandidate natural_keys = 3;
+   */
+  naturalKeys: NaturalKeyCandidate[];
+
+  /**
+   * How the fields below are grouped for the operator, in order.
+   *
+   * @generated from field: repeated apps.v1.DiscoveredFieldGroup field_groups = 4;
+   */
+  fieldGroups: DiscoveredFieldGroup[];
+
+  /**
+   * The source's fields, in the order the app would show them.
+   *
+   * @generated from field: repeated apps.v1.DiscoveredField fields = 5;
+   */
+  fields: DiscoveredField[];
+
+  /**
+   * The app stopped listing fields before the end. The list is a prefix.
+   *
+   * @generated from field: bool truncated = 6;
+   */
+  truncated: boolean;
+
+  /**
+   * For an optional source: the app recommends syncing it by default.
+   *
+   * @generated from field: bool recommended = 7;
+   */
+  recommended: boolean;
+};
+
+/**
+ * Describes the message apps.v1.DiscoveredSource.
+ * Use `create(DiscoveredSourceSchema)` to create a new message.
+ */
+export declare const DiscoveredSourceSchema: GenMessage<DiscoveredSource>;
+
+/**
+ * @generated from message apps.v1.NaturalKeyCandidate
+ */
+export declare type NaturalKeyCandidate = Message<"apps.v1.NaturalKeyCandidate"> & {
+  /**
+   * @generated from field: string key = 1;
+   */
+  key: string;
+
+  /**
+   * @generated from field: string label = 2;
+   */
+  label: string;
+
+  /**
+   * The value never changes for a record, so it can key one.
+   *
+   * @generated from field: bool stable = 3;
+   */
+  stable: boolean;
+
+  /**
+   * @generated from field: string note = 4;
+   */
+  note: string;
+};
+
+/**
+ * Describes the message apps.v1.NaturalKeyCandidate.
+ * Use `create(NaturalKeyCandidateSchema)` to create a new message.
+ */
+export declare const NaturalKeyCandidateSchema: GenMessage<NaturalKeyCandidate>;
+
+/**
+ * @generated from message apps.v1.DiscoveredFieldGroup
+ */
+export declare type DiscoveredFieldGroup = Message<"apps.v1.DiscoveredFieldGroup"> & {
+  /**
+   * @generated from field: string id = 1;
+   */
+  id: string;
+
+  /**
+   * @generated from field: string label = 2;
+   */
+  label: string;
+
+  /**
+   * @generated from field: string description = 3;
+   */
+  description: string;
+
+  /**
+   * @generated from field: bool collapsed_by_default = 4;
+   */
+  collapsedByDefault: boolean;
+};
+
+/**
+ * Describes the message apps.v1.DiscoveredFieldGroup.
+ * Use `create(DiscoveredFieldGroupSchema)` to create a new message.
+ */
+export declare const DiscoveredFieldGroupSchema: GenMessage<DiscoveredFieldGroup>;
+
+/**
+ * @generated from message apps.v1.DiscoveredField
+ */
+export declare type DiscoveredField = Message<"apps.v1.DiscoveredField"> & {
+  /**
+   * The app's own name for the field: the key the mapping names.
+   *
+   * @generated from field: string key = 1;
+   */
+  key: string;
+
+  /**
+   * @generated from field: string label = 2;
+   */
+  label: string;
+
+  /**
+   * @generated from field: string help = 3;
+   */
+  help: string;
+
+  /**
+   * The id of the DiscoveredFieldGroup it belongs to.
+   *
+   * @generated from field: string group = 4;
+   */
+  group: string;
+
+  /**
+   * The account's owner defined it (a custom field), as against one the
+   * vendor's system always has.
+   *
+   * @generated from field: bool custom = 5;
+   */
+  custom: boolean;
+
+  /**
+   * @generated from field: apps.v1.Availability availability = 6;
+   */
+  availability?: Availability | undefined;
+
+  /**
+   * How to create a model field for it. Absent when no platform type holds
+   * it, in which case its availability says so.
+   *
+   * @generated from field: optional apps.v1.FieldProvision provision = 7;
+   */
+  provision?: FieldProvision | undefined;
+
+  /**
+   * The model field key the app would give it.
+   *
+   * @generated from field: string suggested_model_field = 8;
+   */
+  suggestedModelField: string;
+
+  /**
+   * The value differs by locale.
+   *
+   * @generated from field: bool localized = 9;
+   */
+  localized: boolean;
+
+  /**
+   * How many records hold a value. Absent when the app did not count.
+   *
+   * @generated from field: optional int64 usage_count = 10;
+   */
+  usageCount?: bigint | undefined;
+};
+
+/**
+ * Describes the message apps.v1.DiscoveredField.
+ * Use `create(DiscoveredFieldSchema)` to create a new message.
+ */
+export declare const DiscoveredFieldSchema: GenMessage<DiscoveredField>;
+
+/**
+ * @generated from message apps.v1.FieldProvision
+ */
+export declare type FieldProvision = Message<"apps.v1.FieldProvision"> & {
+  /**
+   * A platform field type.
+   *
+   * @generated from field: string type = 1;
+   */
+  type: string;
+
+  /**
+   * For a list: the type of its items.
+   *
+   * @generated from field: string item_type = 2;
+   */
+  itemType: string;
+
+  /**
+   * @generated from field: bool required = 3;
+   */
+  required: boolean;
+
+  /**
+   * @generated from field: apps.v1.Fidelity fidelity = 4;
+   */
+  fidelity: Fidelity;
+
+  /**
+   * Why the fidelity is not EXACT.
+   *
+   * @generated from field: string note = 5;
+   */
+  note: string;
+};
+
+/**
+ * Describes the message apps.v1.FieldProvision.
+ * Use `create(FieldProvisionSchema)` to create a new message.
+ */
+export declare const FieldProvisionSchema: GenMessage<FieldProvision>;
+
+/**
+ * @generated from message apps.v1.Availability
+ */
+export declare type Availability = Message<"apps.v1.Availability"> & {
+  /**
+   * @generated from field: apps.v1.AvailabilityState state = 1;
+   */
+  state: AvailabilityState;
+
+  /**
+   * Why, whenever the state is not AVAILABLE.
+   *
+   * @generated from field: apps.v1.DiscoveryNotice reason = 2;
+   */
+  reason?: DiscoveryNotice | undefined;
+};
+
+/**
+ * Describes the message apps.v1.Availability.
+ * Use `create(AvailabilitySchema)` to create a new message.
+ */
+export declare const AvailabilitySchema: GenMessage<Availability>;
+
+/**
+ * @generated from message apps.v1.DiscoveredCount
+ */
+export declare type DiscoveredCount = Message<"apps.v1.DiscoveredCount"> & {
+  /**
+   * @generated from field: int64 value = 1;
+   */
+  value: bigint;
+
+  /**
+   * The account counts no higher: the true number is at least `value`.
+   *
+   * @generated from field: bool at_least = 2;
+   */
+  atLeast: boolean;
+};
+
+/**
+ * Describes the message apps.v1.DiscoveredCount.
+ * Use `create(DiscoveredCountSchema)` to create a new message.
+ */
+export declare const DiscoveredCountSchema: GenMessage<DiscoveredCount>;
+
+/**
+ * @generated from message apps.v1.DiscoveredLocale
+ */
+export declare type DiscoveredLocale = Message<"apps.v1.DiscoveredLocale"> & {
+  /**
+   * A BCP 47 tag.
+   *
+   * @generated from field: string code = 1;
+   */
+  code: string;
+
+  /**
+   * @generated from field: string name = 2;
+   */
+  name: string;
+
+  /**
+   * The account's primary locale.
+   *
+   * @generated from field: bool primary = 3;
+   */
+  primary: boolean;
+
+  /**
+   * Offered to the account's own audience.
+   *
+   * @generated from field: bool published = 4;
+   */
+  published: boolean;
+};
+
+/**
+ * Describes the message apps.v1.DiscoveredLocale.
+ * Use `create(DiscoveredLocaleSchema)` to create a new message.
+ */
+export declare const DiscoveredLocaleSchema: GenMessage<DiscoveredLocale>;
+
+/**
+ * @generated from message apps.v1.DiscoveryNotice
+ */
+export declare type DiscoveryNotice = Message<"apps.v1.DiscoveryNotice"> & {
+  /**
+   * The app's own code for it, stable across discoveries, so a screen can tell
+   * two notices apart without reading their words.
+   *
+   * @generated from field: string code = 1;
+   */
+  code: string;
+
+  /**
+   * @generated from field: apps.v1.NoticeSeverity severity = 2;
+   */
+  severity: NoticeSeverity;
+
+  /**
+   * @generated from field: string title = 3;
+   */
+  title: string;
+
+  /**
+   * @generated from field: string detail = 4;
+   */
+  detail: string;
+
+  /**
+   * What it is about: a source or field name, when it is about one.
+   *
+   * @generated from field: string subject = 5;
+   */
+  subject: string;
+
+  /**
+   * What the operator can do about it, when there is something.
+   *
+   * @generated from field: optional apps.v1.NoticeRemedy remedy = 6;
+   */
+  remedy?: NoticeRemedy | undefined;
+};
+
+/**
+ * Describes the message apps.v1.DiscoveryNotice.
+ * Use `create(DiscoveryNoticeSchema)` to create a new message.
+ */
+export declare const DiscoveryNoticeSchema: GenMessage<DiscoveryNotice>;
+
+/**
+ * @generated from message apps.v1.NoticeRemedy
+ */
+export declare type NoticeRemedy = Message<"apps.v1.NoticeRemedy"> & {
+  /**
+   * @generated from field: apps.v1.RemedyAction action = 1;
+   */
+  action: RemedyAction;
+
+  /**
+   * @generated from field: string label = 2;
+   */
+  label: string;
+};
+
+/**
+ * Describes the message apps.v1.NoticeRemedy.
+ * Use `create(NoticeRemedySchema)` to create a new message.
+ */
+export declare const NoticeRemedySchema: GenMessage<NoticeRemedy>;
+
+/**
+ * How faithfully a created field holds the account's value.
+ *
+ * @generated from enum apps.v1.Fidelity
+ */
+export enum Fidelity {
+  /**
+   * @generated from enum value: FIDELITY_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * Held exactly as the account holds it.
+   *
+   * @generated from enum value: FIDELITY_EXACT = 1;
+   */
+  EXACT = 1,
+
+  /**
+   * Held in another form that loses nothing, as the note says: HTML parsed
+   * into the platform's rich text, say.
+   *
+   * @generated from enum value: FIDELITY_CONVERTED = 2;
+   */
+  CONVERTED = 2,
+
+  /**
+   * Held, losing something the note names: a unit, a reference's target.
+   *
+   * @generated from enum value: FIDELITY_LOSSY = 3;
+   */
+  LOSSY = 3,
+}
+
+/**
+ * Describes the enum apps.v1.Fidelity.
+ */
+export declare const FidelitySchema: GenEnum<Fidelity>;
+
+/**
+ * @generated from enum apps.v1.AvailabilityState
+ */
+export enum AvailabilityState {
+  /**
+   * @generated from enum value: AVAILABILITY_STATE_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * The account can give it.
+   *
+   * @generated from enum value: AVAILABILITY_STATE_AVAILABLE = 1;
+   */
+  AVAILABLE = 1,
+
+  /**
+   * The account cannot give it until something changes: access not granted,
+   * an approval the vendor has not given. The reason names what.
+   *
+   * @generated from enum value: AVAILABILITY_STATE_BLOCKED = 2;
+   */
+  BLOCKED = 2,
+
+  /**
+   * The app could not tell. The reason says why, and the operator decides.
+   *
+   * @generated from enum value: AVAILABILITY_STATE_UNDETERMINED = 3;
+   */
+  UNDETERMINED = 3,
+}
+
+/**
+ * Describes the enum apps.v1.AvailabilityState.
+ */
+export declare const AvailabilityStateSchema: GenEnum<AvailabilityState>;
+
+/**
+ * @generated from enum apps.v1.NoticeSeverity
+ */
+export enum NoticeSeverity {
+  /**
+   * @generated from enum value: NOTICE_SEVERITY_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * @generated from enum value: NOTICE_SEVERITY_INFO = 1;
+   */
+  INFO = 1,
+
+  /**
+   * @generated from enum value: NOTICE_SEVERITY_WARNING = 2;
+   */
+  WARNING = 2,
+
+  /**
+   * @generated from enum value: NOTICE_SEVERITY_ERROR = 3;
+   */
+  ERROR = 3,
+}
+
+/**
+ * Describes the enum apps.v1.NoticeSeverity.
+ */
+export declare const NoticeSeveritySchema: GenEnum<NoticeSeverity>;
+
+/**
+ * @generated from enum apps.v1.RemedyAction
+ */
+export enum RemedyAction {
+  /**
+   * @generated from enum value: REMEDY_ACTION_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * Connect the account again, asking for the access it lacks.
+   *
+   * @generated from enum value: REMEDY_ACTION_RECONNECT = 1;
+   */
+  RECONNECT = 1,
+
+  /**
+   * Run discovery again, once something outside has changed: an approval the
+   * vendor gives the app, say, which nothing here can hurry.
+   *
+   * @generated from enum value: REMEDY_ACTION_RERUN_DISCOVERY = 2;
+   */
+  RERUN_DISCOVERY = 2,
+
+  /**
+   * Nothing the operator can do here; the app's support can.
+   *
+   * @generated from enum value: REMEDY_ACTION_CONTACT_SUPPORT = 3;
+   */
+  CONTACT_SUPPORT = 3,
+}
+
+/**
+ * Describes the enum apps.v1.RemedyAction.
+ */
+export declare const RemedyActionSchema: GenEnum<RemedyAction>;
+