web-push-notifications 3.40.3 → 3.44.2

package/.editorconfig

@@ -0,0 +1,11 @@
+# editorconfig.org
+root = true
+
+[*]
+
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true

package/.gitlab-ci.yml

@@ -0,0 +1,190 @@
+include:
+  - project: 'platform/tools/gitlab-ci-commons'
+    ref: master
+    file: '/cdn-release.yml'
+  - project: 'platform/tools/gitlab-ci-commons'
+    ref: master
+    file: '/github-release.yml'
+
+stages:
+  - assets
+  - build
+  - test
+  - deploy
+  - release
+  - release-cdn
+  - build-github
+  - release-github
+
+variables:
+  CONTAINER_NAME: websdk
+
+Install:assets:
+  stage: assets
+  image: node:18.19
+  before_script:
+    - npm install -d
+  script:
+    - npm run release
+  cache:
+    key: "$CI_COMMIT_REF_NAME"
+    paths:
+      - node_modules/
+  artifacts:
+    expire_in: 1 hour
+    paths:
+      - output/
+
+Deploy:
+  stage: deploy
+  image: docker:latest
+  before_script:
+    - docker login -u gitlab-ci-token -p $CI_JOB_TOKEN $CI_REGISTRY
+  script:
+    - docker build --pull -t $CI_REGISTRY_IMAGE/dev:$CI_COMMIT_REF_SLUG-$CI_PIPELINE_ID -f ci/dev/Dockerfile .
+    - docker rm --force $CONTAINER_NAME-$CI_ENVIRONMENT_SLUG || true
+    - >
+      docker run --restart=always -d -p 80
+      -e PW_initParams__applicationCode=$PW_initParams__applicationCode
+      -e PW_initParams__autoSubscribe=$PW_initParams__autoSubscribe
+      -e PW_initParams__safariWebsitePushID=$PW_initParams__safariWebsitePushID
+      -e PW_manifest__gcm_sender_id=$PW_manifest__gcm_sender_id
+      --name $CONTAINER_NAME-$CI_ENVIRONMENT_SLUG $CI_REGISTRY_IMAGE/dev:$CI_COMMIT_REF_SLUG-$CI_PIPELINE_ID
+  after_script:
+    - sh /home/gitlab-runner/tools/nginx/vhost.sh $CONTAINER_NAME-$CI_ENVIRONMENT_SLUG
+  environment:
+    name: websdk
+    url: https://websdk-gitlab.corp.pushwoosh.com
+  only:
+    - branches
+
+Test:
+  stage: test
+  image: node:18.19
+  cache:
+    key: "$CI_COMMIT_REF_NAME"
+    paths:
+      - node_modules/
+  before_script:
+    - npm install -d
+  script:
+    - npm run check:types
+    - npm run check:lint
+  allow_failure: true
+  only:
+    - branches
+
+# npm
+
+Build:npm:
+  stage: build
+  image: docker:latest
+  before_script:
+    - docker login -u gitlab-ci-token -p $CI_JOB_TOKEN $CI_REGISTRY
+  script:
+    - >
+      docker build --pull
+      -t $CI_REGISTRY_IMAGE/npm:$CI_COMMIT_REF_SLUG-$CI_PIPELINE_ID
+      --build-arg NPM_TOKEN=${NPM_TOKEN}
+      -f ci/npm/Dockerfile .
+    - docker push $CI_REGISTRY_IMAGE/npm:$CI_COMMIT_REF_SLUG-$CI_PIPELINE_ID
+  only:
+    - /.*-prod$/
+    - /.*-next$/ # тестовая версия будущих фич в гитхаб
+  except:
+    - branches
+
+Release:npm:production:
+  stage: release
+  image: $CI_REGISTRY_IMAGE/npm:$CI_COMMIT_REF_SLUG-$CI_PIPELINE_ID
+  script:
+    - npm publish --tag latest
+  when: manual
+  only:
+    - /.*-prod$/
+  except:
+    - branches
+
+Release:npm:next:
+  stage: release
+  image: $CI_REGISTRY_IMAGE/npm:$CI_COMMIT_REF_SLUG-$CI_PIPELINE_ID
+  script:
+    - npm publish --tag next
+  when: manual
+  only:
+    - /.*-next$/
+  except:
+    - branches
+
+# cdn
+
+build:cdn:
+  stage: build
+  image: docker:latest
+  before_script:
+    - docker login -u gitlab-ci-token -p $CI_JOB_TOKEN $CI_REGISTRY
+  script:
+    - docker build --pull -t $CI_REGISTRY_IMAGE/cdn:$CI_COMMIT_REF_SLUG-$CI_PIPELINE_ID -f ci/cdn/Dockerfile .
+    - docker push $CI_REGISTRY_IMAGE/cdn:$CI_COMMIT_REF_SLUG-$CI_PIPELINE_ID
+  rules:
+    - if: $CI_COMMIT_TAG =~ /^v.*-next$/
+    - if: $CI_COMMIT_TAG =~ /^v.*-prod$/
+
+release:cdn-prod:
+  extends: .release:cdn
+  variables:
+    PUBLIC_PATH: "/webpush/v3/"
+    DIST_PATH: "/dist/"
+  stage: release-cdn
+  image: $CI_REGISTRY_IMAGE/cdn:$CI_COMMIT_REF_SLUG-$CI_PIPELINE_ID
+  dependencies:
+    - build:cdn
+  rules:
+    - if: $CI_COMMIT_TAG =~ /^v.*-prod$/
+
+release:cdn-next:
+  extends: .release:cdn
+  variables:
+    PUBLIC_PATH: "/webpush/next/"
+    DIST_PATH: "/dist/"
+  stage: release-cdn
+  image: $CI_REGISTRY_IMAGE/cdn:$CI_COMMIT_REF_SLUG-$CI_PIPELINE_ID
+  dependencies:
+    - build:cdn
+  rules:
+    - if: $CI_COMMIT_TAG =~ /^v.*-next$/
+
+#github
+
+build:github-prod:
+  extends: .build:github
+  stage: build-github
+  image: docker:latest
+  variables:
+    GITHUB_PATH_DOCKERFILE: ci/github/Dockerfile
+    GITHUB_IMAGE_NAME: $CI_REGISTRY_IMAGE/github:$CI_COMMIT_REF_SLUG-$CI_PIPELINE_ID
+
+release:github:prod:
+  extends: .release:github
+  stage: release-github
+  variables:
+    GITHUB_HEAD: prod
+  image: $CI_REGISTRY_IMAGE/github:$CI_COMMIT_REF_SLUG-$CI_PIPELINE_ID
+  rules:
+    - if: $CI_COMMIT_TAG =~ /^v.*$"{GITHUB_HEAD}"$/
+
+release:github:next:
+  extends: .release:github
+  stage: release-github
+  variables:
+    GITHUB_HEAD: next
+  image: $CI_REGISTRY_IMAGE/github:$CI_COMMIT_REF_SLUG-$CI_PIPELINE_ID
+  rules:
+    - if: $CI_COMMIT_TAG =~ /^v.*$"{GITHUB_HEAD}"$/
+
+release:github:zip:
+  extends: .release:githubzip
+  stage: release-github
+  image: $CI_REGISTRY_IMAGE/github:$CI_COMMIT_REF_SLUG-$CI_PIPELINE_ID
+  variables:
+    PATH_TAG_MESSAGE: "/tag-message.txt"

package/babel.config.js

@@ -0,0 +1,7 @@
+// dont rename to .babelrc, because if rename babel not transpiler node_modules
+
+module.exports = {
+  "presets": [
+    "@babel/env",
+  ]
+};

package/ci/cdn/Dockerfile

@@ -0,0 +1,12 @@
+FROM alpine
+
+LABEL vendor="Pushwoosh Inc." \
+      name="WebSDK" \
+      version="1.0"
+
+RUN apk update
+RUN apk --update --no-cache add python3 py-pip py-setuptools git ca-certificates
+RUN pip install --break-system-packages pip
+RUN pip install --break-system-packages python-dateutil s3cmd
+
+COPY output/cdn /dist

package/ci/dev/Dockerfile

@@ -0,0 +1,30 @@
+FROM alpine
+
+LABEL vendor="Pushwoosh Inc." \
+      name="WebSDK" \
+      version="1.0"
+
+
+RUN apk --no-cache add nginx supervisor
+
+COPY ci/dev/rootfs/ /
+COPY output/cdn /var/www/html/
+
+# Configure supervisor
+RUN sed -e 's|^;\?\(file\s*=\s*\)[^ ]*|\1/dev/shm/supervisor.sock|' \
+    -e 's|^;\?\(serverurl\s*=\s*unix://\)[^ ]*|\1/dev/shm/supervisor.sock|' \
+    -e 's|^;\?\(logfile_maxbytes\s*=\s*\)[^ ]*|\150MB|' \
+    -e 's|^;\?\(logfile_backups\s*=\s*\)[^ ]*|\110|' \
+    -e 's|^;\?\(pidfile\s*=\s*\)[^ ]*|\1/dev/shm/supervisord.pid|' \
+    -e 's|^;\?\(nodaemon\s*=\s*\)[^ ]*|\1false|' \
+    -e '/^\[supervisord\]$/,/^;\?user\s*=.\+/{/^;\?user\s*=.\+/ s/^;\?\(user\s*=\s*\)[^ ]*/\1root/}' \
+    -i /etc/supervisord.conf
+
+# Forward nginx request and error logs to docker log collector
+RUN ln -sf /dev/stdout /var/log/nginx/access.log \
+    && ln -sf /dev/stderr /var/log/nginx/error.log
+
+EXPOSE 80
+
+# Start supervisord
+CMD ["/entrypoint.sh"]

package/ci/dev/rootfs/entrypoint.sh

@@ -0,0 +1,18 @@
+#!/bin/sh
+
+[ -n "$DEBUG" ] && set -x
+
+# Run custom scripts
+if [ -d "/entrypoint.sh.d/" ]; then
+    for f in /entrypoint.sh.d/*; do
+        case "$f" in
+            *.sh) echo "$0 INFO   : running $f"; . "$f" ;;
+            *) echo "$0 INFO   : ignoring $f" ;;
+        esac
+    done
+else
+    echo "ERROR  : Can't find script directory"
+fi
+
+# Start supervisord
+exec /usr/bin/supervisord -n -c /etc/supervisord.conf

package/ci/dev/rootfs/entrypoint.sh.d/nginx.sh

@@ -0,0 +1,6 @@
+#!/bin/sh
+
+# Create runtime directories
+install -o nginx -g nginx -m 755 -d /run/nginx
+
+[ -f /etc/nginx/_real_ip.conf ] || touch /etc/nginx/_real_ip.conf

package/ci/dev/rootfs/entrypoint.sh.d/supervisor.sh

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+sed -e 's|^;\?\(logfile_maxbytes\s*=\s*\)[^ ]*|\1'${SUPERVISOR_LOGFILE_MAXBYTES:-50MB}'|' \
+    -e 's|^;\?\(logfile_backups\s*=\s*\)[^ ]*|\1'${SUPERVISOR_LOGFILE_BACKUPS:-10}'|' \
+    -i /etc/supervisord.conf

package/ci/dev/rootfs/etc/nginx/_real_ip.conf

@@ -0,0 +1,2 @@
+set_real_ip_from  172.17.0.1;
+real_ip_header    X-Real-IP;

package/ci/dev/rootfs/etc/nginx/conf.d/default.conf

@@ -0,0 +1,20 @@
+server {
+    listen 80;
+    server_name localhost default_server;
+    server_name _;
+
+    root /var/www/html/;
+    sendfile on;
+
+    add_header X-Frame-Options DENY;
+    add_header X-Content-Type-Options nosniff;
+    add_header X-XSS-Protection "1; mode=block";
+
+    # Add stdout logging
+    error_log /dev/stderr info;
+    access_log /dev/stdout;
+
+    location / {
+        try_files $uri $uri/ /index.html;
+    }
+}

package/ci/dev/rootfs/etc/supervisor.d/nginx.ini

@@ -0,0 +1,11 @@
+[program:nginx]
+command = /usr/sbin/nginx -g "daemon off; error_log /dev/stderr info;"
+autostart = true
+autorestart = true
+priority = 10
+stdout_events_enabled = true
+stderr_events_enabled = true
+stdout_logfile = /dev/stdout
+stdout_logfile_maxbytes = 0
+stderr_logfile = /dev/stderr
+stderr_logfile_maxbytes = 0

package/ci/github/Dockerfile

@@ -0,0 +1,59 @@
+FROM alpine
+
+LABEL vendor="Pushwoosh Inc." \
+      name="WebSDK" \
+      version="1.0"
+
+RUN apk add --update git jq curl nodejs npm
+
+ARG GITHUB_OWNER
+ARG GITHUB_REPO
+ARG GITHUB_USERNAME
+ARG GITHUB_TOKEN
+ARG GITLAB_TOKEN
+ARG CI_PROJECT_ID
+ARG CI_COMMIT_TAG
+
+ENV GITHUB_OWNER=${GITHUB_OWNER}
+ENV GITHUB_REPO=${GITHUB_REPO}
+ENV GITHUB_USERNAME=${GITHUB_USERNAME}
+ENV GITHUB_TOKEN=${GITHUB_TOKEN}
+ENV GITLAB_TOKEN=${GITLAB_TOKEN}
+ENV CI_PROJECT_ID=${CI_PROJECT_ID}
+ENV CI_COMMIT_TAG=${CI_COMMIT_TAG}
+
+RUN git config --global user.email "help@pushwoosh.com"
+RUN git config --global user.name "${GITHUB_USERNAME}"
+RUN git config --global user.password "${GITHUB_TOKEN}"
+
+RUN mkdir -p github
+RUN cd /github && git init && git remote add origin https://${GITHUB_USERNAME}:${GITHUB_TOKEN}@github.com/${GITHUB_OWNER}/${GITHUB_REPO}.git
+
+RUN touch /tag-message.txt
+RUN chmod +x /tag-message.txt
+RUN echo $(curl --header "Private-Token: $GITLAB_TOKEN" https://gitlab.corp.pushwoosh.com/api/v4/projects/${CI_PROJECT_ID}/repository/tags/${CI_COMMIT_TAG} | jq ".message") > /tag-message.txt
+
+COPY config /github/config
+COPY develop /github/develop
+COPY public /github/public
+COPY scripts /github/scripts
+COPY src /github/src
+# COPY types /github/types
+COPY output/cdn /github/dist
+
+COPY package.json /github/package.json
+COPY .gitignore /github/.gitignore
+
+# COPY tslint.json /github/babel.config.json
+COPY tsconfig.json /github/tsconfig.json
+# COPY tslint.json /github/tslint.json
+
+COPY webpack.config.js /github/webpack.config.js
+# COPY webpack.lib.config.js /github/webpack.lib.config.js
+
+COPY README.md /github/README.md
+COPY LICENSE.md /github/LICENSE.md
+
+COPY ci/github/release-zip.js /ci/release-zip.js
+
+RUN echo RELEASE_NOTE=$(cat /tag-message.txt)

package/ci/github/release-zip.js

@@ -0,0 +1,61 @@
+#!/usr/bin/env node
+
+const exec = require('child_process').exec;
+const fs = require('fs');
+
+const repo = process.env.GITHUB_REPO;
+const owner = process.env.GITHUB_OWNER;
+const token = process.env.GITHUB_TOKEN;
+const branch = process.env.BRANCH;
+const releaseNote = process.env.RELEASE_NOTE;
+
+fs.readFile('/github/package.json', 'utf8', (err, packageJSON) => {
+  const currentVersion = JSON.parse(packageJSON).version;
+
+  const data = JSON.stringify({
+    tag_name: `v${currentVersion}`,
+    name: `Pushwoosh Web SDK v${currentVersion}`,
+    body: releaseNote,
+    target_commitish: branch,
+    draft: false,
+    prerelease: false,
+  });
+
+  exec(`curl -H 'Authorization: token ${token}' --data '${data}' https://api.github.com/repos/${owner}/${repo}/releases`,
+    (err, stdout, stderr) => {
+      if (err) {
+        console.log(err);
+        return process.exit(1);
+      }
+      if (stderr) {
+        console.log(stderr);
+      }
+
+      stdout = JSON.parse(stdout);
+
+      if (stdout.upload_url) {
+        const zipFileName = `PushwooshWebSDK-${currentVersion}.zip`;
+        const url = stdout.upload_url.replace('{?name,label}', `?name=${zipFileName}`);
+        const upload = `curl -H 'Authorization: token ${token}' \\
+                             -H 'Accept: application/vnd.github.v3+json' \\
+                             -H 'Content-Type: application/zip' \\
+                             --data-binary '@/github/dist/${zipFileName}' \\
+                             ${url}`;
+        exec(upload, (err, stdout, stderr) => {
+          if (err) {
+            console.log(err);
+            return process.exit(1);
+          }
+          if (stderr) {
+            console.log(stderr);
+          }
+          console.log(stdout);
+          return process.exit(0);
+        });
+      } else {
+        console.log(stdout);
+        return process.exit(1);
+      }
+    },
+  );
+});

package/ci/npm/Dockerfile

@@ -0,0 +1,19 @@
+FROM node:18-alpine
+
+LABEL vendor="Pushwoosh Inc." \
+      name="WebSDK" \
+      version="1.0"
+
+ARG NPM_TOKEN
+
+ENV NPM_TOKEN=${NPM_TOKEN}
+
+# COPY output/npm /publish/
+
+COPY .npmrc /publish/.npmrc
+COPY package.json /publish/package.json
+
+COPY README.md /publish/README.md
+COPY LICENSE.md /publish/LICENSE.md
+
+WORKDIR /publish

package/config/config.js

@@ -0,0 +1,24 @@
+module.exports = {
+  initParams: {
+    logLevel: 'info',
+    applicationCode: 'XXXXX-XXXXX',
+    apiToken: 'abcdxyz',
+    safariWebsitePushID: 'web.com.example.test',
+    defaultNotificationTitle: 'Pushwoosh',
+    defaultNotificationImage: 'https://cp.pushwoosh.com/img/logo-medium.png',
+    autoSubscribe: false,
+    userId: 'user_id',
+    serviceWorkerUrl: 'pushwoosh-service-worker.js',
+    tags: {
+      Name: 'John Doe',
+    },
+    subscribeWidget: {
+      enable: true,
+    },
+  },
+
+  ssl: {
+    key: '', // absolute path to key
+    cert: '', // absolute path to cert
+  },
+};

package/config/configBuilder.js

@@ -0,0 +1,126 @@
+const fs = require('fs');
+const path = require('path');
+
+const BASE_PATH = '__base__';
+
+// Utils
+function parseEnvKey(key) {
+  return key
+    .slice(3)
+    .replace(/__/g, '.')
+    .split('.');
+}
+
+function castEnvValueTypes(value) {
+  switch (value) {
+    case 'true':
+      return true;
+    case 'false':
+      return false;
+    default:
+      return value;
+  }
+}
+
+function setValueByPath(path, obj, value) {
+  let tmpConfig = obj;
+  path.forEach((pathPart, i) => {
+    if (!(pathPart in tmpConfig)) {
+      tmpConfig[pathPart] = {};
+    }
+
+    if (i === path.length - 1) {
+      tmpConfig[pathPart] = value;
+    } else {
+      tmpConfig = tmpConfig[pathPart];
+    }
+  });
+}
+
+function buildObjectsMap(object, path = BASE_PATH) {
+  const objMap = { [path]: Object.assign({}, object) };
+  Object.keys(object).forEach((key) => {
+    if (object[key] !== null && !Array.isArray(object[key]) && typeof object[key] === 'object') {
+      delete objMap[path][key];
+      Object.assign(objMap, buildObjectsMap(object[key], `${path}.${key}`));
+    }
+  });
+  return objMap;
+}
+
+function configDeepAssign(...configs) {
+  const [baseConfig, ...anotherConfigs] = configs;
+
+  // Make result config map
+  const resConfigMap = buildObjectsMap(baseConfig);
+  anotherConfigs.forEach((config) => {
+    const configMap = buildObjectsMap(config);
+    Object.keys(configMap).forEach((key) => {
+      if (key in resConfigMap) {
+        Object.assign(resConfigMap[key], configMap[key]);
+        delete configMap[key];
+      }
+    });
+    Object.assign(resConfigMap, configMap);
+  });
+
+  // Make config from map
+  const result = {};
+  Object.keys(resConfigMap).forEach((key) => {
+    if (key === BASE_PATH) {
+      Object.assign(result, resConfigMap[key]);
+    } else {
+      const path = key.replace(`${BASE_PATH}.`, '').split('.');
+      setValueByPath(path, result, resConfigMap[key]);
+    }
+  });
+
+  return result;
+}
+
+// Config Getters
+function getEnvironmentConfig() {
+  const envConfig = {};
+  Object.keys(process.env).forEach((envKey) => {
+    if (!envKey.startsWith('PW_')) {
+      return;
+    }
+
+    const path = parseEnvKey(envKey);
+    const value = castEnvValueTypes(process.env[envKey]);
+    setValueByPath(path, envConfig, value);
+  });
+  return envConfig;
+}
+
+// Configs
+const defaultConfig = require(path.resolve(__dirname, 'config.js')); // Default
+
+const configPath = process.env.GUI_CONFIG_PRESET_NAME
+  ? path.resolve(__dirname, `config.${process.env.GUI_CONFIG_PRESET_NAME}.js`)
+  : '';
+const presetConfig = fs.existsSync(configPath) ? require(configPath) : {}; // Preset
+
+const LOCAL_CONFIG_PATH = path.resolve(__dirname, 'config.local.js');
+const localConfig = fs.existsSync(LOCAL_CONFIG_PATH) && process.env.NODE_ENV !== 'production'
+  ? require(LOCAL_CONFIG_PATH)
+  : {}; // Local
+
+const fileConfig = {}; // Custom file
+
+const envConfig = getEnvironmentConfig(); // Environment
+
+const QA_CONFIG_PATH = path.resolve(__dirname, 'config.qa.js');
+const qaConfig = fs.existsSync(QA_CONFIG_PATH) ? require(QA_CONFIG_PATH) : {}; // QA
+
+// Build result config
+const config = configDeepAssign(
+  defaultConfig,
+  presetConfig,
+  localConfig,
+  fileConfig,
+  envConfig,
+  qaConfig,
+);
+
+module.exports = config;

package/config/helpers.js

@@ -0,0 +1,9 @@
+function mapValues(obj, mapFn) {
+  return Object.fromEntries(
+    Object.entries(obj).map(([key, value]) => {
+      return [key, mapFn(value, key)];
+    }),
+  );
+}
+
+module.exports.mapValues = mapValues;

package/config/index.js

@@ -0,0 +1 @@
+module.exports.configBuilder = require('./configBuilder');

package/develop/README.md

@@ -0,0 +1,42 @@
+# Change init params
+
+#### Clone the `config/config.js` to a `config/config.local.js` and edit it
+
+```js
+module.exports = {
+  initParams: {
+    applicationCode: 'XXXXX-XXXXX',
+    safariWebsitePushID: 'web.com.example.test',
+    serviceWorkerUrl: 'pushwoosh-service-worker.uncompress.js'
+  },
+
+  ssl: {
+    key: '', // absolute path to key
+    cert: '' // absolute path to cert
+  }
+};
+```
+
+## Build development
+
+```bash
+npm run build
+```
+
+## Build production
+
+```bash
+npm run build:prod
+```
+
+## Run server
+
+```bash
+npm run start
+```
+
+## Prepare release files
+
+```bash
+npm run release
+```