@spine-event-engine/proto 2.0.0-snapshot.2

package/proto/spine/ui/language.proto

@@ -0,0 +1,417 @@
+/*
+ * Copyright 2023, TeamDev. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Redistribution and use in source and/or binary forms, with or without
+ * modification, must retain the above copyright notice and the following
+ * disclaimer.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+syntax = "proto3";
+
+package spine.ui;
+
+import "spine/options.proto";
+
+option (type_url_prefix) = "type.spine.io";
+option java_multiple_files = true;
+option java_outer_classname = "LanguageProto";
+option java_package = "io.spine.ui";
+
+// A human language as defined by ISO 639-1.
+//
+// See https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes
+//
+enum Language {
+
+    UNDEFINED = 0;
+
+    // Abkhazian
+    ab = 1;
+    // Afar
+    aa = 2;
+    // Afrikaans
+    af = 3;
+    // Akan
+    ak = 4;
+    // Albanian
+    sq = 5;
+    // Amharic
+    am = 6;
+    // Arabic
+    ar = 7;
+    // Aragonese
+    an = 8;
+    // Armenian
+    hy = 9;
+    // Assamese
+    as = 10;
+    // Avaric
+    av = 11;
+    // Avestan
+    ae = 12;
+    // Aymara
+    ay = 13;
+    // Azerbaijani
+    az = 14;
+    // Bambara
+    bm = 15;
+    // Bashkir
+    ba = 16;
+    // Basque
+    eu = 17;
+    // Belarusian
+    be = 18;
+    // Bengali
+    bn = 19;
+    // Bihari languages
+    bh = 20;
+    // Bislama
+    bi = 21;
+    // Bosnian
+    bs = 22;
+    // Breton
+    br = 23;
+    // Bulgarian
+    bg = 24;
+    // Burmese
+    my = 25;
+    // Catalan, Valencian
+    ca = 26;
+    // Central Khmer
+    km = 27;
+    // Chamorro
+    ch = 28;
+    // Chechen
+    ce = 29;
+    // Chichewa, Chewa, Nyanja
+    ny = 30;
+    // Chinese
+    zh = 31;
+    // Church Slavic, Old Slavonic, Church Slavonic, Old Bulgarian, Old Church Slavonic
+    cu = 32;
+    // Chuvash
+    cv = 33;
+    // Cornish
+    kw = 34;
+    // Corsican
+    co = 35;
+    // Cree
+    cr = 36;
+    // Croatian
+    hr = 37;
+    // Czech
+    cs = 38;
+    // Danish
+    da = 39;
+    // Divehi, Dhivehi, Maldivian
+    dv = 40;
+    // Dutch, Flemish
+    nl = 41;
+    // Dzongkha
+    dz = 42;
+    // English
+    en = 43;
+    // Esperanto
+    eo = 44;
+    // Estonian
+    et = 45;
+    // Ewe
+    ee = 46;
+    // Faroese
+    fo = 47;
+    // Fijian
+    fj = 48;
+    // Finnish
+    fi = 49;
+    // French
+    fr = 50;
+    // Fulah
+    ff = 51;
+    // Gaelic, Scottish Gaelic
+    gd = 52;
+    // Galician
+    gl = 53;
+    // Ganda
+    lg = 54;
+    // Georgian
+    ka = 55;
+    // German
+    de = 56;
+    // Greek, Modern (1453-)
+    el = 57;
+    // Guarani
+    gn = 58;
+    // Gujarati
+    gu = 59;
+    // Haitian, Haitian Creole
+    ht = 60;
+    // Hausa
+    ha = 61;
+    // Hebrew
+    he = 62;
+    // Herero
+    hz = 63;
+    // Hindi
+    hi = 64;
+    // Hiri Motu
+    ho = 65;
+    // Hungarian
+    hu = 66;
+    // Icelandic
+    is = 67;
+    // Ido
+    //
+    // This member has the underscore suffix to avoid the name clash with the top package name "io"
+    // of the generated Java code.
+    //
+    io_ = 68;
+    // Igbo
+    ig = 69;
+    // Indonesian
+    id = 70;
+    // Interlingua (International Auxiliary Language Association)
+    ia = 71;
+    // Interlingue, Occidental
+    ie = 72;
+    // Inuktitut
+    iu = 73;
+    // Inupiaq
+    ik = 74;
+    // Irish
+    ga = 75;
+    // Italian
+    it = 76;
+    // Japanese
+    ja = 77;
+    // Javanese
+    jv = 78;
+    // Kalaallisut, Greenlandic
+    kl = 79;
+    // Kannada
+    kn = 80;
+    // Kanuri
+    kr = 81;
+    // Kashmiri
+    ks = 82;
+    // Kazakh
+    kk = 83;
+    // Kikuyu, Gikuyu
+    ki = 84;
+    // Kinyarwanda
+    rw = 85;
+    // Kirghiz, Kyrgyz
+    ky = 86;
+    // Komi
+    kv = 87;
+    // Kongo
+    kg = 88;
+    // Korean
+    ko = 89;
+    // Kuanyama, Kwanyama
+    kj = 90;
+    // Kurdish
+    ku = 91;
+    // Lao
+    lo = 92;
+    // Latin
+    la = 93;
+    // Latvian
+    lv = 94;
+    // Limburgan, Limburger, Limburgish
+    li = 95;
+    // Lingala
+    ln = 96;
+    // Lithuanian
+    lt = 97;
+    // Luba-Katanga
+    lu = 98;
+    // Luxembourgish, Letzeburgesch
+    lb = 99;
+    // Macedonian
+    mk = 100;
+    // Malagasy
+    mg = 101;
+    // Malay
+    ms = 102;
+    // Malayalam
+    ml = 103;
+    // Maltese
+    mt = 104;
+    // Manx
+    gv = 105;
+    // Maori
+    mi = 106;
+    // Marathi
+    mr = 107;
+    // Marshallese
+    mh = 108;
+    // Mongolian
+    mn = 109;
+    // Nauru
+    na = 110;
+    // Navajo, Navaho
+    nv = 111;
+    // Ndonga
+    ng = 112;
+    // Nepali
+    ne = 113;
+    // North Ndebele
+    nd = 114;
+    // Northern Sami
+    se = 115;
+    // Norwegian
+    no = 116;
+    // Norwegian Bokmal
+    nb = 117;
+    // Norwegian Nynorsk
+    nn = 118;
+    // Occitan
+    oc = 119;
+    // Ojibwa
+    oj = 120;
+    // Oriya
+    or = 121;
+    // Oromo
+    om = 122;
+    // Ossetian, Ossetic
+    os = 123;
+    // Pali
+    pi = 124;
+    // Pashto, Pushto
+    ps = 125;
+    // Persian
+    fa = 126;
+    // Polish
+    pl = 127;
+    // Portuguese
+    pt = 128;
+    // Punjabi, Panjabi
+    pa = 129;
+    // Quechua
+    qu = 130;
+    // Romanian, Moldavian, Moldovan
+    ro = 131;
+    // Romansh
+    rm = 132;
+    // Rundi
+    rn = 133;
+    // Russian
+    ru = 134;
+    // Samoan
+    sm = 135;
+    // Sango
+    sg = 136;
+    // Sanskrit
+    sa = 137;
+    // Sardinian
+    sc = 138;
+    // Serbian
+    sr = 139;
+    // Shona
+    sn = 140;
+    // Sichuan Yi, Nuosu
+    ii = 141;
+    // Sindhi
+    sd = 142;
+    // Sinhala, Sinhalese
+    si = 143;
+    // Slovak
+    sk = 144;
+    // Slovenian
+    sl = 145;
+    // Somali
+    so = 146;
+    // South Ndebele
+    nr = 147;
+    // Southern Sotho
+    st = 148;
+    // Spanish, Castilian
+    es = 149;
+    // Sundanese
+    su = 150;
+    // Swahili
+    sw = 151;
+    // Swati
+    ss = 152;
+    // Swedish
+    sv = 153;
+    // Tagalog
+    tl = 154;
+    // Tahitian
+    ty = 155;
+    // Tajik
+    tg = 156;
+    // Tamil
+    ta = 157;
+    // Tatar
+    tt = 158;
+    // Telugu
+    te = 159;
+    // Thai
+    th = 160;
+    // Tibetan
+    bo = 161;
+    // Tigrinya
+    ti = 162;
+    // Tonga (Tonga Islands)
+    to = 163;
+    // Tsonga
+    ts = 164;
+    // Tswana
+    tn = 165;
+    // Turkish
+    tr = 166;
+    // Turkmen
+    tk = 167;
+    // Twi
+    tw = 168;
+    // Uighur, Uyghur
+    ug = 169;
+    // Ukrainian
+    uk = 170;
+    // Urdu
+    ur = 171;
+    // Uzbek
+    uz = 172;
+    // Venda
+    ve = 173;
+    // Vietnamese
+    vi = 174;
+    // Volapuk
+    vo = 175;
+    // Walloon
+    wa = 176;
+    // Welsh
+    cy = 177;
+    // Western Frisian
+    fy = 178;
+    // Wolof
+    wo = 179;
+    // Xhosa
+    xh = 180;
+    // Yiddish
+    yi = 181;
+    // Yoruba
+    yo = 182;
+    // Zhuang, Chuang
+    za = 183;
+    // Zulu
+    zu = 184;
+}

package/proto/spine/validation/validation_error.proto

@@ -0,0 +1,133 @@
+/*
+ * Copyright 2023, TeamDev. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Redistribution and use in source and/or binary forms, with or without
+ * modification, must retain the above copyright notice and the following
+ * disclaimer.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+syntax = "proto3";
+
+package spine.validation;
+
+import "spine/options.proto";
+
+option (type_url_prefix) = "type.spine.io";
+option java_multiple_files = true;
+option java_outer_classname = "ValidationErrorProto";
+option java_package = "io.spine.validation";
+
+import "google/protobuf/any.proto";
+
+import "spine/string/template_string.proto";
+import "spine/base/field_path.proto";
+
+// An error indicating that a message did not pass validation.
+message ValidationError {
+
+    // Validation constraint violations found by validator.
+    repeated ConstraintViolation constraint_violation = 1;
+}
+
+// Describes the violation of a validation constraint found in a message.
+message ConstraintViolation {
+
+    // Deprecated: use `message` field to access the error message.
+    string msg_format = 1 [deprecated = true];
+
+    // Deprecated: use `message` field to access the error message.
+    repeated string param = 2 [deprecated = true];
+
+    // An error message for this violation.
+    //
+    // The returned message can be formatted using one of the following approaches:
+    //
+    // 1. In Kotlin, use the `TemplateString.format()` extension.
+    // 2. In Java, use the `io.spine.string.TemplateStrings.format()` static method.
+    //
+    spine.string.TemplateString message = 8;
+
+    // The name of the validated message type.
+    //
+    // If the `(validate)` option is applied and a nested field contains an invalid value,
+    // this property holds the name of the root message, which triggered the validation.
+    //
+    // Example:
+    //
+    // ```
+    // message AddressBook {
+    //     Contacts contacts = 1 [(validate) = true];
+    // }
+    //
+    // message Contacts {
+    //     Email email = 1 [(validate) = true];
+    // }
+    //
+    // message Email {
+    //     string value = 1 [(pattern).regex = "^[\\w.-]+@[\\w.-]+\\.[a-zA-Z]{2,}$"];
+    // }
+    // ```
+    //
+    // When the `AddressBook` message is validated and the `value` field in the nested `Email`
+    // message is invalid, this property will contain the `AddressBook` type name, not `Email`.
+    // This is so because this type is an entry point to the nested validation.
+    //
+    string type_name = 7;
+
+    // A path to the field containing an invalid value.
+    //
+    // If the `(validate)` option is applied and a nested field contains an invalid value,
+    // this property holds the path to the invalid field. If there is no nesting, the path
+    // consists only of the field name.
+    //
+    // Example:
+    //
+    // ```
+    // message Student {
+    //     Contacts contacts = 1 [(validate) = true];
+    // }
+    //
+    // message Contacts {
+    //     Email email = 1 [(validate) = true];
+    // }
+    //
+    // message Email {
+    //     string value = 1 [(pattern).regex = "^[\\w.-]+@[\\w.-]+\\.[a-zA-Z]{2,}$"];
+    // }
+    // ```
+    //
+    // When the `Student` message is validated and the `value` field in the nested `Email` message
+    // is invalid, this property will contain the full path to the invalid field: `contacts.email.value`.
+    // However, if the `Email` message is validated independently (not as part of `Student`),
+    // the path will consist only of the field name: `value`.
+    //
+    base.FieldPath field_path = 3;
+
+    // The value of the field which violates the validation constraint.
+    //
+    // Contains a corresponding wrapper message for primitives
+    // (google.protobuf.StringValue for "string" field type and so on).
+    //
+    google.protobuf.Any field_value = 4;
+
+    // Deprecated: all violations are top-level now. Their nesting is reflected in the value
+    // of `field_path` field.
+    repeated ConstraintViolation violation = 5 [deprecated = true];
+}