arlas-web-core 18.1.0 → 19.3.0-dev0

package/jsconfig.json

@@ -0,0 +1,13 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=759670
+    // for the documentation about the jsconfig.json format
+    "compilerOptions": {
+        "target": "es6",
+        "module": "commonjs",
+        "allowSyntheticDefaultImports": true
+    },
+    "exclude": [
+        "node_modules",
+        "dist"
+    ]
+}

package/mkDocs.sh

@@ -0,0 +1,18 @@
+#!/bin/sh -e
+
+## CREATE TARGET DIRECTORY ##
+rm -rf target
+mkdir target
+mkdir target/generated-docs
+
+## GENERATE THE DOCUMENTATION ##
+docker run -a STDERR --rm  -i -v `pwd`:/docs gisaia/typedocgen:0.0.5 generatedoc src
+
+## MOVE ALL THE DOCUMENTATION TO THE 'generated-docs' FOLDER ##
+mv typedoc_docs/* target/generated-docs
+cp CHANGELOG.md target/generated-docs/CHANGELOG_ARLAS-web-core.md
+if [ -d ./docs ] ; then
+    cp -r docs/* target/generated-docs
+fi
+
+

package/package-release.json

@@ -0,0 +1,25 @@
+{
+  "name": "***update during release***/arlas-web-core",
+  "version": "***update during release***",
+  "description": "Core Service Library for ARLAS Web App",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/gisaia/ARLAS-web-core.git"
+  },
+  "author": "gisaia-team",
+  "license": "Apache-2.0",
+  "dependencies": {
+    "arlas-api": "19.0.0",
+    "rxjs": "~7.4.0"
+  },
+  "devDependencies": {
+    "@types/node": "^12.11.1",
+    "rimraf": "^2.6.2",
+    "tslint": "~5.11.0",
+    "typescript": "~4.4.3"
+  },
+  "bugs": {
+    "url": "https://github.com/gisaia/ARLAS-web-core/issues"
+  },
+  "homepage": "https://github.com/gisaia/ARLAS-web-core/blob/master/README.md"
+}

package/package.json

@@ -1,22 +1,28 @@
 {
   "name": "arlas-web-core",
-  "version": "18.1.0",
+  "version": "19.3.0-dev0",
   "description": "Core Service Library for ARLAS Web App",
+  "scripts": {
+    "build-release": "tsc -p tsconfig-build.json",
+    "clean": "npm cache clear && rimraf -- dist",
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "tslint": "tslint -c tslint.json 'src/**/*.ts?(x)'"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/gisaia/ARLAS-web-core.git"
   },
-  "author": "gisaia-team",
+  "author": "gisaia",
   "license": "Apache-2.0",
   "dependencies": {
-    "arlas-api": "18.0.0",
-    "rxjs": "~6.5.3"
+    "arlas-api": "19.0.0",
+    "rxjs": "~7.4.0"
   },
   "devDependencies": {
-    "@types/node": "^8.0.0",
+    "@types/node": "^12.11.1",
     "rimraf": "^2.6.2",
-    "tslint": "~5.11.0",
-    "typescript": "~3.5.3"
+    "tslint": "~5.16.0",
+    "typescript": "~4.4.3"
   },
   "bugs": {
     "url": "https://github.com/gisaia/ARLAS-web-core/issues"

package/release.sh

@@ -0,0 +1,429 @@
+#!/bin/bash
+set -e
+if  [ -z "$GITHUB_CHANGELOG_TOKEN"  ] ; then echo "Please set GITHUB_CHANGELOG_TOKEN environment variable"; exit -1; fi
+
+if [[ ! -d ../ARLAS-web-contributors/ ]] ; then
+    echo 'Directory "../ARLAS-web-contributors/" is not there, aborting.'
+    exit
+fi
+
+if [[ ! -d ../ARLAS-web-components/ ]] ; then
+    echo 'Directory "../ARLAS-web-components/" is not there, aborting.'
+    exit
+fi
+
+if [[ ! -d ../ARLAS-wui-toolkit/ ]] ; then
+    echo 'Directory "../ARLAS-wui-toolkit/" is not there, aborting.'
+    exit
+fi
+
+if [[ ! -d ../ARLAS-d3/ ]] ; then
+    echo 'Directory "../ARLAS-d3/" is not there, aborting.'
+    exit
+fi
+
+npmlogin=`npm whoami`
+if  [ -z "$npmlogin"  ] ; then echo "your are not logged on npm"; exit -1; else  echo "logged as "$npmlogin ; fi
+
+level_version=("major" "minor" "patch")
+
+usage(){
+	echo "Usage: ./release.sh -core='1.0.0;major' -cont='1.1.0;minor' -comp='1.1.1;patch' -prod -ref_branch=develop"
+	echo "Usage: ./release.sh -all='1.0.0-dev0;minor'"
+	echo "Usage: ./release.sh -all='1.0.0;major' -cont='1.1.0;minor'"
+	echo " -core|--arlas-web-core     arlas-web-core version release,level of evolution"
+	echo " -cont|--arlas-web-contributors      arlas-web-contributors version release, level of evolution"
+	echo " -comp|--arlas-web-components    arlas-web-components version release, level of evolution"
+	echo " -d3|--arlas-d3    arlas-d3 version release, level of evolution"
+    echo " -tool|--arlas-wui-toolkit    arlas-wui-toolkit version release, level of evolution"
+	echo " -all|--global    all project have same version release, level of evolution"
+    echo " -prod|--production    if present publish on public npm and tag from master git branch, if not publish on gisaia private npm and tag from develop, not present by defaut"
+	echo " if -all and -core or -cont or -comp or -d3 parametes are mixed, the specified version is released"
+	echo " -ref_branch | --reference_branch  from which branch to start the release."
+    echo "    Add -ref_branch=develop for a new official release"
+    echo "    Add -ref_branch=x.x.x for a maintenance release"
+	exit 1
+}
+
+contains(){
+    local n=$#
+    local value=${!n}
+    for ((i=1;i < $#;i++)) {
+        if [ "${!i}" == "${value}" ]; then
+            echo "y"
+            return 0
+        fi
+    }
+    echo "n"
+    return 1
+}
+
+checkInput(){
+    IFS=';' read -ra TAB <<< "$1"
+    TABLEN=${#TAB[@]}
+    TWO=2
+    if [ "$TABLEN" -ne "$TWO" ];
+        then
+            usage;
+    else
+        if [ $(contains "${level_version[@]}" "${TAB[1]}") == "n" ];
+            then
+                echo "Unknown level of evolution value : ${TAB[1]}"
+                echo "Possible values : "
+                echo "   level for versions : ${level_version[*]}"
+                usage;
+        elif [ "$2" == "true" ];
+            then
+                if ! [[ ${TAB[0]} =~ ^[0-9]*\.[0-9]*\.[0-9]*$ ]]
+                    then
+                    echo ""${TAB[0]}" version value is not valid. Format : vX.Y.Z in --prod mode"
+                    usage;
+                fi
+        else
+            if ! [[ ${TAB[0]} =~ ^[0-9]*\.[0-9]*\.[0-9]*-dev[0-9]*$ ]];
+                then
+                    echo ""${TAB[0]}" version value is not valid. Format :  vX.Y.Z-devN in dev mode"
+                    usage;
+            fi
+        fi
+    fi
+
+}
+
+checkfilesize(){
+    file=$1
+    minimumsize=1
+    actualsize=$(wc -c <"$file")
+    if [ $actualsize -ge $minimumsize ]; then
+        echo  "$file" size is over $minimumsize bytes
+    else
+        echo "Dist build contains empty js or ts file,  "$file" try again"
+        exit 1
+    fi
+}
+
+
+
+releaseProd(){
+    local folder="web-core"
+    if [ "$3" == "components" ];
+        then
+        cd ../ARLAS-web-components/
+        local folder="web-components"
+    elif [ "$3" == "d3" ];
+        then
+        cd ../ARLAS-d3/
+        local folder="d3"
+    elif [ "$3" == "contributors" ];
+        then
+        cd ../ARLAS-web-contributors/
+        local folder="web-contributors"
+    elif [ "$3" == "toolkit" ];
+        then
+        cd ../ARLAS-wui-toolkit/
+        local folder="wui-toolkit"
+    fi
+
+    echo "=> Get "$4" branch of ARLAS-$folder project"
+    git checkout "$4"
+    git pull origin "$4"
+    echo "=> Test to lint and build the project on "$4" branch"
+    npm install
+    npm run tslint
+    npm run build-release
+    rm -rf dist
+
+    jq  '.name = "arlas-'$folder'"' package.json > tmp.$$.json && mv tmp.$$.json package.json
+    jq  '.version = "'"$1"'"' package.json > tmp.$$.json && mv tmp.$$.json package.json
+    git add .
+    commit_message_release="Release prod version $1"
+
+    echo "=> Tag version $1"
+    npm install
+    npm run tslint
+    npm run build-release
+    #check dist files size
+    for file in $(find dist -name '*.js' -or -name '*.ts');
+    do
+    checkfilesize $file
+    done
+    cp package-release.json  dist/package.json
+    cp README-NPM.md dist/README.md
+    cp LICENSE.txt dist/LICENSE
+    git tag -a v"$1" -m "$commit_message_release"
+    git push origin v"$1"
+
+    echo "=> Generate CHANGELOG"
+    docker run -it --rm -v "$(pwd)":/usr/local/src/your-app gisaia/github-changelog-generator:latest github_changelog_generator \
+      -u gisaia -p ARLAS-"$folder" --token ${GITHUB_CHANGELOG_TOKEN} --no-pr-wo-labels --no-issues-wo-labels --no-unreleased \
+      --issue-line-labels conf,documentation,CI,ALL,DONUT,RESULTLIST,POWERBARS,HISTOGRAM,MAP \
+      --exclude-labels type:duplicate,type:question,type:wontfix,type:invalid \
+      --bug-labels type:bug --enhancement-labels type:enhancement --breaking-labels type:breaking \
+      --enhancement-label "**New stuff:**" --issues-label "**Miscellaneous:**" \
+      --exclude-tags v3.1.2 --since-tag v4.0.0
+
+    echo "  -- Remove tag to add generated CHANGELOG"
+    git tag -d v"$1"
+    git push origin :v"$1"
+
+    echo "  -- Commit release version"
+    git commit -a -m "$commit_message_release" --allow-empty
+    git tag v"$1"
+    git push origin v"$1"
+    git push origin "$4"
+
+    cd dist
+    jq  '.name = "arlas-'$folder'"' package.json > tmp.$$.json && mv tmp.$$.json package.json
+    jq  '.version = "'"$1"'"' package.json > tmp.$$.json && mv tmp.$$.json package.json
+    echo "=> Publish to npm"
+    npm publish
+    cd ..
+    rm -rf dist
+    if [ "$4" == "develop" ];
+        then
+        echo "=> Merge develop into master"
+        git checkout master
+        git pull origin master
+        git merge origin/develop
+        git push origin master
+
+        git checkout develop
+        git pull origin develop
+        git rebase origin/master
+    fi
+    IFS='.' read -ra TAB <<< "$1"
+    major=${TAB[0]}
+    minor=${TAB[1]}
+    newminor=$(( $minor + 1 ))
+    newDevVersion=${major}.${newminor}.0
+    jq  '.version = "'"$newDevVersion"'-dev0"' package.json > tmp.$$.json && mv tmp.$$.json package.json
+    git add .
+    commit_message="update package.json to"-"$newDevVersion"
+    git commit -m "$commit_message" --allow-empty
+    git push origin "$4"
+    echo "Well done :)"
+
+}
+
+releaseDev(){
+    local folder="web-core"
+    if [ "$3" == "components" ];
+        then
+        cd ../ARLAS-web-components/
+        local folder="web-components"
+    elif [ "$3" == "d3" ];
+        then
+        cd ../ARLAS-d3/
+        local folder="d3"
+    elif [ "$3" == "contributors" ];
+        then
+        cd ../ARLAS-web-contributors/
+        local folder="web-contributors"
+    elif [ "$3" == "toolkit" ];
+        then
+        cd ../ARLAS-wui-toolkit/
+        local folder="wui-toolkit"
+    fi
+    echo "=> Get develop branch of ARLAS-$folder project"
+    git checkout  develop
+    git pull origin develop
+    echo "=> Test to lint and build the project on develop branch"
+    npm install
+    if [[ -d ./node_modules/@gisaia-team/arlas-web-core ]] ; then
+    mv node_modules/@gisaia-team/arlas-web-core node_modules 2>/dev/null
+    fi
+    npm run tslint
+    npm run build-release
+    #check dist files size
+    for file in $(find dist -name '*.js' -or -name '*.ts');
+    do
+    checkfilesize $file
+    done
+    cp package-release.json  dist/package.json
+    cp README-NPM.md dist/README.md
+    cd dist
+    jq  '.name = "@gisaia-team/arlas-'$folder'"' package.json > tmp.$$.json && mv tmp.$$.json package.json
+    jq  '.version = "'"$1"'"' package.json > tmp.$$.json && mv tmp.$$.json package.json
+    npm publish
+    cd ..
+    jq  '.version = "'"$1"'"' package.json > tmp.$$.json && mv tmp.$$.json package.json
+    rm -rf dist
+    git add .
+    commit_message_develop="dev automatic release update package.json to"-"$1"
+    git commit -m"$commit_message_develop" --allow-empty
+    git push origin develop
+}
+
+release(){
+    if [ "$4" == "true" ];
+        then
+        releaseProd $1 $2 $3 $5
+    else
+        releaseDev $1 $2 $3
+    fi
+
+}
+
+ARLAS_PROD="false"
+
+for i in "$@"
+do
+case $i in
+    -core=*|--arlas-web-core=*)
+    ARLAS_CORE="${i#*=}"
+    shift # past argument=value
+    ;;
+    -cont=*|--arlas-web-contributors=*)
+    ARLAS_CONT="${i#*=}"
+    shift # past argument=value
+    ;;
+    -comp=*|--arlas-web-components=*)
+    ARLAS_COMP="${i#*=}"
+    shift # past argument=value
+    ;;
+    -d3=*|--arlas-d3=*)
+    ARLAS_D3="${i#*=}"
+    shift # past argument=value
+    ;;
+    -tool=*|--arlas-wui-toolkit=*)
+    ARLAS_TOOL="${i#*=}"
+    shift # past argument=value
+    ;;
+    -all=*|--global=*)
+    ARLAS_ALL="${i#*=}"
+    shift # past argument=value
+    ;;
+    -h|--help)
+    ARLAS_HELP="true"
+    shift # past argument=value
+    ;;
+    -prod|--production)
+    ARLAS_PROD="true"
+    shift # past argument=value
+    ;;
+    -ref_branch=*|--reference_branch=*)
+    REF_BRANCH="${i#*=}"
+    shift # past argument=value
+    ;;
+    *)
+            # unknown option
+    ;;
+esac
+done
+
+if [ -z ${REF_BRANCH+x} ];
+    then
+        echo ""
+        echo "###########"
+        echo "-ref_branch is missing."
+        echo "  Add -ref_branch=develop for a new official release"
+        echo "  Add -ref_branch=x.x.x for a maintenance release"
+        echo "###########"
+        echo ""
+        usage;
+fi
+
+if [ ! -z ${ARLAS_HELP+x} ];
+    then
+        usage;
+fi
+
+if [ ! -z ${ARLAS_CORE+x} ];
+    then
+        checkInput ${ARLAS_CORE} ${ARLAS_PROD}
+        IFS=';' read -ra TABCORE <<< "$ARLAS_CORE"
+        ARLAS_CORE_VERS="${TABCORE[0]}";
+        ARLAS_CORE_LEVEL="${TABCORE[1]}";
+elif [ ! -z ${ARLAS_ALL+x} ];
+    then
+        checkInput ${ARLAS_ALL} ${ARLAS_PROD}
+        IFS=';' read -ra TABCORE <<< "$ARLAS_ALL"
+        ARLAS_CORE_VERS="${TABCORE[0]}";
+        ARLAS_CORE_LEVEL="${TABCORE[1]}";
+fi
+
+if [ ! -z ${ARLAS_CONT+x} ];
+    then
+        checkInput ${ARLAS_CONT} ${ARLAS_PROD}
+        IFS=';' read -ra TABCONT <<< "$ARLAS_CONT"
+        ARLAS_CONT_VERS="${TABCONT[0]}";
+        ARLAS_CONT_LEVEL="${TABCONT[1]}";
+elif [ ! -z ${ARLAS_ALL+x} ];
+    then
+        checkInput ${ARLAS_ALL} ${ARLAS_PROD}
+        IFS=';' read -ra TABCONT <<< "$ARLAS_ALL"
+        ARLAS_CONT_VERS="${TABCONT[0]}";
+        ARLAS_CONT_LEVEL="${TABCONT[1]}";
+fi
+
+if [ ! -z ${ARLAS_COMP+x} ];
+    then
+        checkInput ${ARLAS_COMP} ${ARLAS_PROD}
+        IFS=';' read -ra TABCOMP <<< "$ARLAS_COMP"
+        ARLAS_COMP_VERS="${TABCOMP[0]}";
+        ARLAS_COMP_LEVEL="${TABCOMP[1]}";
+elif [ ! -z ${ARLAS_ALL+x} ];
+    then
+        checkInput ${ARLAS_ALL} ${ARLAS_PROD}
+        IFS=';' read -ra TABCOMP <<< "$ARLAS_ALL"
+        ARLAS_COMP_VERS="${TABCOMP[0]}";
+        ARLAS_COMP_LEVEL="${TABCOMP[1]}";
+fi
+
+if [ ! -z ${ARLAS_D3+x} ];
+    then
+        checkInput ${ARLAS_D3} ${ARLAS_PROD}
+        IFS=';' read -ra TABD3 <<< "$ARLAS_D3"
+        ARLAS_D3_VERS="${TABD3[0]}";
+        ARLAS_D3_LEVEL="${TABD3[1]}";
+elif [ ! -z ${ARLAS_ALL+x} ];
+    then
+        checkInput ${ARLAS_ALL} ${ARLAS_PROD}
+        IFS=';' read -ra TABD3 <<< "$ARLAS_ALL"
+        ARLAS_D3_VERS="${TABD3[0]}";
+        ARLAS_D3_LEVEL="${TABD3[1]}";
+fi
+
+if [ ! -z ${ARLAS_TOOL+x} ];
+    then
+        checkInput ${ARLAS_TOOL} ${ARLAS_PROD}
+        IFS=';' read -ra TABCOMP <<< "$ARLAS_TOOL"
+        ARLAS_TOOL_VERS="${TABCOMP[0]}";
+        ARLAS_TOOL_LEVEL="${TABCOMP[1]}";
+elif [ ! -z ${ARLAS_ALL+x} ];
+    then
+        checkInput ${ARLAS_ALL} ${ARLAS_PROD}
+        IFS=';' read -ra TABCOMP <<< "$ARLAS_ALL"
+        ARLAS_TOOL_VERS="${TABCOMP[0]}";
+        ARLAS_TOOL_LEVEL="${TABCOMP[1]}";
+fi
+
+if [ ! -z ${ARLAS_CORE_VERS+x} ] && [ ! -z ${ARLAS_CORE_LEVEL+x} ];
+    then
+        echo "Release ARLAS-web-core  ${ARLAS_CORE_LEVEL} version                    : ${ARLAS_CORE_VERS}";
+        release ${ARLAS_CORE_VERS} ${ARLAS_CORE_LEVEL} "core" ${ARLAS_PROD} ${REF_BRANCH}
+fi
+
+if [ ! -z ${ARLAS_CONT_VERS+x} ] && [ ! -z ${ARLAS_CONT_LEVEL+x} ];
+    then
+        echo "Release ARLAS-web-contributors  ${ARLAS_CONT_VERS} version                    : ${ARLAS_CONT_LEVEL}";
+        release ${ARLAS_CONT_VERS} ${ARLAS_CONT_LEVEL} "contributors" ${ARLAS_PROD} ${REF_BRANCH}
+fi
+
+if [ ! -z ${ARLAS_COMP_VERS+x} ] && [ ! -z ${ARLAS_COMP_LEVEL+x} ];
+    then
+        echo "Release ARLAS-web-components  ${ARLAS_COMP_VERS} version                    : ${ARLAS_COMP_LEVEL}";
+        release ${ARLAS_COMP_VERS} ${ARLAS_COMP_LEVEL} "components" ${ARLAS_PROD} ${REF_BRANCH}
+fi
+
+if [ ! -z ${ARLAS_D3_VERS+x} ] && [ ! -z ${ARLAS_D3_LEVEL+x} ];
+    then
+        echo "Release ARLAS-d3  ${ARLAS_D3_VERS} version                    : ${ARLAS_D3_LEVEL}";
+        release ${ARLAS_D3_VERS} ${ARLAS_D3_LEVEL} "d3" ${ARLAS_PROD} ${REF_BRANCH}
+fi
+
+if [ ! -z ${ARLAS_TOOL_VERS+x} ] && [ ! -z ${ARLAS_TOOL_LEVEL+x} ];
+    then
+        echo "Release ARLAS-wui-toolkit  ${ARLAS_TOOL_VERS} version                    : ${ARLAS_TOOL_LEVEL}";
+        release ${ARLAS_TOOL_VERS} ${ARLAS_TOOL_LEVEL} "toolkit" ${ARLAS_PROD} ${REF_BRANCH}
+fi

package/{index.js → src/index.ts}

@@ -1,3 +1,4 @@
+import { GeoTileAggregation } from './models/projections';
 /*
  * Licensed to Gisaïa under one or more contributor
  * license agreements. See the NOTICE.txt file distributed with
@@ -16,10 +17,12 @@
  * specific language governing permissions and limitations
  * under the License.
  */
+
 export { CollaborativesearchService } from './services/collaborativesearch.service';
 export { ConfigService } from './services/config.service';
-export { projType } from './models/projections';
+export { projType, TiledSearch, GeohashAggregation, GeoTileAggregation } from './models/projections';
 export { Contributor } from './models/contributor';
-export { OperationEnum } from './models/collaboration';
-export { fromEntries } from './utils/utils';
-//# sourceMappingURL=index.js.map
+export { Collaboration, OperationEnum, CollaborationEvent } from './models/collaboration';
+export { fromEntries, CollectionCount, CollectionAggField } from './utils/utils';
+
+

package/{models/collaboration.js → src/models/collaboration.ts}

@@ -16,12 +16,36 @@
  * specific language governing permissions and limitations
  * under the License.
  */
+
+import { Filter } from 'arlas-api';
+
+/**
+* - A filter object from ARLAS API.
+* - A boolean to know if the filter of the collaboration is enabled.
+*/
+export interface Collaboration {
+  filters: Map<string, Filter[]>;
+  enabled: boolean;
+}
+
+export interface FilterOnCollection extends Filter {
+  collection: string;
+}
+
+/**
+* - An id of a contributor.
+* - An operation add/remove.
+* - If the operation is for all the contributors
+*/
+export interface CollaborationEvent {
+  id: string;
+  operation: OperationEnum;
+  all: boolean;
+}
+
 /**
 * - Enum of operation.
 */
-export var OperationEnum;
-(function (OperationEnum) {
-    OperationEnum[OperationEnum["add"] = 0] = "add";
-    OperationEnum[OperationEnum["remove"] = 1] = "remove";
-})(OperationEnum || (OperationEnum = {}));
-//# sourceMappingURL=collaboration.js.map
+export enum OperationEnum {
+  add, remove
+}