@vannizhang/living-atlas-content-validator 1.0.1 → 1.2.0

package/dist/locale/pt-br.json

@@ -7,8 +7,7 @@
         "LABEL": "Adicionar créditos",
         "MINIMUM_WORD_COUNT_CODE": "",
         "EMPTY_STRING_MESSAGE": "Adicionar créditos",
-        "MINIMUM_WORD_COUNT_MESSAGE": "",
-        "WEIGHT": 7
+        "MINIMUM_WORD_COUNT_MESSAGE": ""
     },
     "description": {
         "TOOLTIP_GUIDANCE_DEFAULT": "Uma boa descrição responde diretamente a pergunta \"O que é isso?”, como também, \"O que mostra esta camada/mapa/aplicativo?” Alguns parágrafos curtos geralmente são muito para cobrir as perguntas básicas de \"quem, o que, quando, onde, por que e como?” (não necessariamente nesta ordem, é claro). Evite utilizar jargões ou abreviações. Forneça informações de origem e explicações detalhadas através de links da web.<br/><br/>Ao adicionar hiperlinks, utilize o editor de links no ArcGIS Online.",
@@ -20,8 +19,7 @@
         "CONTAINS_LINKS_CODE": "",
         "EMPTY_STRING_MESSAGE": "Uma descrição é exigida",
         "MINIMUM_WORD_COUNT_MESSAGE": "Descrição muito curta",
-        "CONTAINS_LINKS_MESSAGE": "A descrição não tem nenhum link",
-        "WEIGHT": 3
+        "CONTAINS_LINKS_MESSAGE": "A descrição não tem nenhum link"
     },
     "layers": {
         "TOOLTIP_GUIDANCE_DEFAULT": "De um modo geral, leva cerca de 1-5 camadas para criar um mapa limpo e focado. Quando um item exige mais e mais camadas, geralmente indica que o produto da informação não está totalmente formado nas mentes dos criadores ainda. É necessário mais tempo para esclarecer o que precisa ser construído e destilar isto.",
@@ -35,8 +33,7 @@
         "EMPTY_STRING_MESSAGE": "Não há nenhuma camada para validar e deve haver pelo menos uma camada para este tipo de item.",
         "GOOD_MESSAGE": "Excede 7 camadas",
         "BETTER_MESSAGE": "Há entre 4 e 7 camadas",
-        "BEST_MESSAGE": "",
-        "WEIGHT": 5
+        "BEST_MESSAGE": ""
     },
     "licenseInfo": {
         "TOOLTIP_GUIDANCE_DEFAULT": "Comunique qualquer restrição de uso e acesso exigido por sua organização ou pelo provedor de dados. <p>Ao adicionar hiperlinks, utilize o editor de links no ArcGIS Online.</p>",
@@ -46,8 +43,7 @@
         "LABEL": "Melhorar restrições de uso e acesso",
         "EMPTY_STRING_MESSAGE": "Adicionar restrições de uso e acesso",
         "MINIMUM_WORD_COUNT_MESSAGE": "Informações de uso/acesso muito curtas",
-        "CONTAINS_NO_LINKS_MESSAGE": "As informações de uso/acesso não contém nenhum link",
-        "WEIGHT": 8
+        "CONTAINS_NO_LINKS_MESSAGE": "As informações de uso/acesso não contém nenhum link"
     },
     "sharing": {
         "TOOLTIP_GUIDANCE_DEFAULT": "Quando estiver pronto, compartilhe publicamente seu item para que ele possa fazer parte do Living Atlas.",
@@ -57,8 +53,7 @@
         "LABEL": "Deve ser público",
         "EMPTY_STRING_MESSAGE": "",
         "PRIVATE_MESSAGE": "Deve ser público",
-        "ORG_MESSAGE": "Deve ser público",
-        "WEIGHT": 4
+        "ORG_MESSAGE": "Deve ser público"
     },
     "ssl": {
         "TOOLTIP_GUIDANCE_DEFAULT": "HTTPS é um protocolo que fornece transações de internet seguras entre navegadores e servidores da web. Recomendamos que suas camadas, mapas da web e aplicativos de mapeamento da web utilizem HTTPS em suas URLs. Consulte <a href=\"https://doc.arcgis.com/en/arcgis-online/administer/configure-security.htm\" target=\"_blank\">este artigo</a> para detalhes em configurações de segurança para sua organização.",
@@ -68,8 +63,7 @@
         "LABEL": "Utilize HTTPS na URL",
         "EMPTY_STRING_MESSAGE": "",
         "IS_SSL_DISABLED_MESSAGE": "Atualize o item para utilizar HTTPS.",
-        "SSL_FAIL_INSTR": "Para habilitar https em seu navegador da web, você deve instalar um certificado SSL. A presença de um certificado SSL confiável permite a criptografia de dados transmitidos a partir do servidor da web. Contacte seu administrador de sistemas e peça para ter um certificado SSL instalado no Gerenciador de Serviços de Informações de Internet (IIS).<br /><br/>Após o SSL estar habilitado, republique esta camada, remova a camada antiga do Mapa da Web e adicione a camada republicada recentemente e salvar seu Mapa da Web.",
-        "WEIGHT": 9
+        "SSL_FAIL_INSTR": "Para habilitar https em seu navegador da web, você deve instalar um certificado SSL. A presença de um certificado SSL confiável permite a criptografia de dados transmitidos a partir do servidor da web. Contacte seu administrador de sistemas e peça para ter um certificado SSL instalado no Gerenciador de Serviços de Informações de Internet (IIS).<br /><br/>Após o SSL estar habilitado, republique esta camada, remova a camada antiga do Mapa da Web e adicione a camada republicada recentemente e salvar seu Mapa da Web."
     },
     "summary": {
         "TOOLTIP_GUIDANCE_DEFAULT": "Digite uma ou duas frases para responder à pergunta <b>O que é isto?<b> Este resumo é uma versão muito mais curta da descrição completa abaixo.",
@@ -80,8 +74,7 @@
         "EMPTY_STRING_MESSAGE": "O resumo é exigido",
         "MINIMUM_WORD_COUNT_MESSAGE": "Resumo muito curto",
         "BLACKLISTED_CHARS_MESSAGE": "O resumo contém caracteres proibidos",
-        "BLACKLISTED_WORDS_MESSAGE": "Cópia, demo, teste ou eval são utilizados no resumo",
-        "WEIGHT": 2
+        "BLACKLISTED_WORDS_MESSAGE": "Cópia, demo, teste ou eval são utilizados no resumo"
     },
     "tags": {
         "TOOLTIP_GUIDANCE_DEFAULT": "<p>Clique no botão Editar para melhorar as tags.</p> Insira pelo menos três tags que ajudam as pessoas a encontrar seu trabalho. Você não precisa duplicar palavras encontradas em seu título, resumo ou descrição, uma vez que elas já são utilizadas em operações de Pesquisa. Pense mais amplamente sobre tags que ajudam a conectar seu item com as pessoas. Tags extras ajudam a responder a pergunta \"Como alguém pode encontrar este item se não souber o título ou o setor?\" Por exemplo, se o mapa for intitulado \"Densidade da População\", talvez você também queira tags como \"aglomeração” ou \"superlotação\" em seu item, já que isto é algo que ele mede.",
@@ -92,8 +85,7 @@
         "LABEL": "Melhorar tags",
         "EMPTY_STRING_MESSAGE": "Deve haver pelo menos uma tag",
         "MINIMUM_NUM_TAGS_MESSAGE": "Adicione pelo menos três tags",
-        "BLACKLISTED_WORDS_MESSAGE": "Cópia, demo, teste ou eval são utilizados como tags.",
-        "WEIGHT": 6
+        "BLACKLISTED_WORDS_MESSAGE": "Cópia, demo, teste ou eval são utilizados como tags."
     },
     "thumbnail": {
         "TOOLTIP_GUIDANCE_DEFAULT": "Transfira uma miniatura que mostre a camada, mapa ou aplicativo em suas melhores formas. Amplie para uma escala em que seu item aparece ótimo e capture a tela. Então recorte ou redimensione para o tamanho de imagem de miniatura padrão, dimensão de 600 x 400 pixels.",
@@ -104,8 +96,7 @@
         "EMPTY_STRING_MESSAGE": "",
         "BAD_THUMBNAIL_ERROR_MESSAGE": "Há um problema com o formato de miniatura.",
         "SMALL_THUMBNAIL_FILENAME_ISSUE_MESSAGE": "A miniatura de tamanho padrão personalizada é exigida",
-        "THUMBNAIL_SIZE_MESSAGE": "A miniatura de alta resolução é exigida",
-        "WEIGHT": 0
+        "THUMBNAIL_SIZE_MESSAGE": "A miniatura de alta resolução é exigida"
     },
     "title": {
         "TOOLTIP_GUIDANCE_DEFAULT": "Digite um título fácil de ler e evite o uso de jargões ou abreviações. O título do item responde a pergunta, <b>O que é isto?</b>",
@@ -117,8 +108,7 @@
         "STRING_COUNT_MESSAGE": "Título muito curto",
         "UPPER_CASE_MESSAGE": "O título não pode ser todo em caixa alta",
         "BLACKLISTED_CHARS_MESSAGE": "O título contém um caractere proibido",
-        "BLACKLISTED_WORDS_MESSAGE": "O título contém uma palavra proibida",
-        "WEIGHT": 1
+        "BLACKLISTED_WORDS_MESSAGE": "O título contém uma palavra proibida"
     },
     "userProfileDescription": {
         "TOOLTIP_GUIDANCE_DEFAULT": "Descreva-se, sua equipe, sua organização e como chegar ao seu e-mail.  Leia<a href=\"https://www.esri.com/arcgis-blog/products/arcgis-online/sharing-collaboration/create-a-great-profile/\" target=\"_blank\">este blog sobre as melhores práticas para o seu perfil do ArcGIS Online.</a>",
@@ -131,8 +121,7 @@
         "NO_VALID_EMAIL_MESSAGE": "A descrição do perfil não contém um e-mail",
         "NO_VALID_URL_MESSAGE": "A descrição do perfil não contém um link",
         "MIN_NUM_WORDS_MESSAGE": "A descrição do perfil não contém o número mínimo de palavras",
-        "MIN_NUM_SENTENCES_MESSAGE": "A descrição do perfil não contém o número mínimo de sentenças",
-        "WEIGHT": 12
+        "MIN_NUM_SENTENCES_MESSAGE": "A descrição do perfil não contém o número mínimo de sentenças"
     },
     "userProfileName": {
         "TOOLTIP_GUIDANCE_DEFAULT": "Insira seu nome. Se alguém tiver uma pergunta, com quem deverá entrar em contato? Leia<a href=\"https://www.esri.com/arcgis-blog/products/arcgis-online/sharing-collaboration/create-a-great-profile/\" target=\"_blank\">este blog sobre as melhores práticas para o seu perfil do ArcGIS Online.</a>",
@@ -141,8 +130,7 @@
         "TOOLTIP_SCORING_MSG_INTL": "",
         "LABEL": "Melhorar nome de perfil completo",
         "EMPTY_STRING_MESSAGE": "O nome completo do perfil não atende o comprimento mínimo",
-        "BLACKLISTED_CHARS_MESSAGE": "O nome completo do perfil contém um caractere proibido",
-        "WEIGHT": 11
+        "BLACKLISTED_CHARS_MESSAGE": "O nome completo do perfil contém um caractere proibido"
     },
     "userProfileThumbnail": {
         "TOOLTIP_GUIDANCE_DEFAULT": "As pessoas desejam saber quem está por trás de um mapa ou aplicativo. Compartilhe sua imagem ou logotipo da organização — algo visual para lembrar. Leia<a href=\"https://www.esri.com/arcgis-blog/products/arcgis-online/sharing-collaboration/create-a-great-profile/\" target=\"_blank\">este blog sobre as melhores práticas para o seu perfil do ArcGIS Online.</a>",
@@ -150,8 +138,7 @@
         "TOOLTIP_SCORING_MSG_DEFAULT": "Qualquer imagem além do padrão é atribuída aos pontos. Pontos de bônus se corresponder às dimensões exigidas.",
         "TOOLTIP_SCORING_MSG_INTL": "",
         "LABEL": "Melhorar miniatura de perfil",
-        "EMPTY_STRING_MESSAGE": "Miniatura do perfil ausente",
-        "WEIGHT": 11
+        "EMPTY_STRING_MESSAGE": "Miniatura do perfil ausente"
     },
     "tooltips": {
         "tooltip_section_label_suggestion_label": "Sugestões",

package/dist/types/index.d.ts

@@ -66,13 +66,38 @@ export type ValidationMessage = {
     message: string;
 };
 export type ValidationInfo = {
+    /**
+     * name of the validation rule
+     */
+    property: string;
+    /**
+     * if true, this is a critical validation rule
+     */
     critical: boolean;
+    /**
+     * label of this validation rule
+     */
     label: string;
-    maxScore: number;
+    /**
+     * array of validation messages
+     */
     messages: ValidationMessage[];
-    property: string;
+    /**
+     * maximum score this validation rule can receive
+     */
+    maxScore: number;
+    /**
+     * final score that the item received for this validation rule
+     */
     score: number;
+    /**
+     * weight assigned to this validation rule
+     */
     weight: number;
+    /**
+     * a factor ranges between 0 and 1 and is used to calculate the final score by multiplying it with a weight number
+     */
+    weightFactor: number;
 };
 /**
  * Validation result returned by the `validate` function
@@ -140,20 +165,3 @@ export type ValidationResult = {
      */
     totalScore?: number;
 };
-export type ScoringRules = {
-    [key: string]: number;
-};
-export type ScoringRulesType = 'WEB_MAP' | 'WEB_SCENE' | 'APPLICATION';
-export type ScoringRulesByType = Record<ScoringRulesType, ScoringRules>;
-export type ScoringRulesConfig = {
-    SCORING: {
-        /**
-         * scoring rules for English item
-         */
-        DEFAULT: ScoringRulesByType;
-        /**
-         * scoring rules for international item
-         */
-        INTERNATIONAL: ScoringRulesByType;
-    };
-};

package/dist/types/index.js

@@ -13,4 +13,58 @@
  * @see https://stackoverflow.com/questions/56018167/typescript-does-not-copy-d-ts-files-to-build
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+// type Config = {
+//     STRINGS: {
+//         [key: string]: {
+//             TOOLTIP_GUIDANCE_DEFAULT: string;
+//             TOOLTIP_GUIDANCE_INTL: string;
+//             TOOLTIP_SCORING_MSG_DEFAULT: string;
+//             TOOLTIP_SCORING_MSG_INTL: string;
+//             LABEL: string;
+//             EMPTY_STRING_MESSAGE: string;
+//             MINIMUM_WORD_COUNT_MESSAGE: string;
+//             CONTAINS_NO_LINKS_MESSAGE: string;
+//         };
+//     };
+// };
+// export type ScoringRules = {
+//     [key: string]: number;
+// };
+// export type ScoringRulesType = 'WEB_MAP' | 'WEB_SCENE' | 'APPLICATION';
+// export type ScoringRulesByType = Record<ScoringRulesType, ScoringRules>;
+// export type ScoringRulesConfig = {
+//     SCORING: {
+//         /**
+//          * scoring rules for English item
+//          */
+//         DEFAULT: ScoringRulesByType;
+//         /**
+//          * scoring rules for international item
+//          */
+//         INTERNATIONAL: ScoringRulesByType;
+//     };
+// };
+// export type ScoringConfig = {
+//     /**
+//      * weight assigned to this validation rule
+//      */
+//     weight: number;
+//     /**
+//      * factors that will be used to calculate the final score
+//      */
+//     weightFactors: {
+//         /**
+//          * weight factors for English item
+//          */
+//         DEFAULT: {
+//             [key: string]: number;
+//         };
+//         /**
+//          * weight factors for international item
+//          */
+//         INTERNATIONAL: {
+//             [key: string]: number;
+//         };
+//     };
+// };
 //# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;GAYG"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;GAYG;;AAkKH,kBAAkB;AAClB,iBAAiB;AACjB,2BAA2B;AAC3B,gDAAgD;AAChD,6CAA6C;AAC7C,mDAAmD;AACnD,gDAAgD;AAChD,6BAA6B;AAC7B,4CAA4C;AAC5C,kDAAkD;AAClD,iDAAiD;AACjD,aAAa;AACb,SAAS;AACT,KAAK;AAEL,+BAA+B;AAC/B,6BAA6B;AAC7B,KAAK;AAEL,0EAA0E;AAE1E,2EAA2E;AAE3E,qCAAqC;AACrC,iBAAiB;AACjB,cAAc;AACd,4CAA4C;AAC5C,cAAc;AACd,uCAAuC;AACvC,cAAc;AACd,kDAAkD;AAClD,cAAc;AACd,6CAA6C;AAC7C,SAAS;AACT,KAAK;AAEL,gCAAgC;AAChC,UAAU;AACV,iDAAiD;AACjD,UAAU;AACV,sBAAsB;AACtB,UAAU;AACV,gEAAgE;AAChE,UAAU;AACV,uBAAuB;AACvB,cAAc;AACd,6CAA6C;AAC7C,cAAc;AACd,qBAAqB;AACrB,qCAAqC;AACrC,aAAa;AACb,cAAc;AACd,mDAAmD;AACnD,cAAc;AACd,2BAA2B;AAC3B,qCAAqC;AACrC,aAAa;AACb,SAAS;AACT,KAAK"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vannizhang/living-atlas-content-validator",
-  "version": "1.0.1",
+  "version": "1.2.0",
   "description": "Validation and Scoring rules for curating content in the ArcGIS Living Atlas",
   "repository": {
     "type": "git",

package/dist/lib/util/getNumberOfStrings.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"getNumberOfStrings.js","sourceRoot":"","sources":["../../../src/lib/util/getNumberOfStrings.ts"],"names":[],"mappings":";;;AAAA,iDAA8C;AAE9C;;;;GAIG;AACI,MAAM,kBAAkB,GAAG,CAAC,CAAS,EAAU,EAAE;IACpD,IAAI,CAAC,IAAA,2BAAY,EAAC,CAAC,CAAC,EAAE;QAClB,OAAO,CAAC,CAAC;KACZ;IAED,sBAAsB;IACtB,IAAI,GAAG,GAAG,CAAC,CAAC,OAAO,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC;IAC3C,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;IAEpC,4CAA4C;IAC5C,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAE/B,IAAI,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,KAAK,CAAC,IAAI,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;QAClD,OAAO,CAAC,CAAC;KACZ;IAED,OAAO,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC;AACjC,CAAC,CAAC;AAjBW,QAAA,kBAAkB,sBAiB7B"}