Compare commits
42 Commits
Author | SHA1 | Date | |
---|---|---|---|
84cf226d42 | |||
63f56da150 | |||
3559453579 | |||
ea509d4246 | |||
c13a125ac7 | |||
8f6949b1b8 | |||
9b698c6dea | |||
157bcff7c4 | |||
934423f0ad | |||
e6d7fdced6 | |||
2fc4e691ac | |||
7e8035ea61 | |||
1bc3112bb7 | |||
4a177fd166 | |||
c1cf019af2 | |||
9ecf7c81d4 | |||
8fa40087d4 | |||
a5576410cd | |||
dff08ed54b | |||
fe4dd5c1ee | |||
7f146b547f | |||
4ee936035c | |||
2e95f1db7f | |||
35e5ded808 | |||
f2430d095f | |||
d79a5af51a | |||
318bdd1bd8 | |||
54a0ec6c71 | |||
8853eecbb9 | |||
1bfca4456c | |||
b337e4c779 | |||
53d56d2d8a | |||
e3781cfd4d | |||
eca90bdf64 | |||
b35b3f6c0b | |||
d3509b8834 | |||
246037aaae | |||
3fc91bc0c1 | |||
6c3991f6bc | |||
cfcba1aa01 | |||
b8a7f02b97 | |||
d6a7fd6c8c |
21
.gitignore
vendored
21
.gitignore
vendored
@ -1,3 +1,20 @@
|
|||||||
node_modules/
|
.nogit/
|
||||||
pages/
|
|
||||||
|
# artifacts
|
||||||
|
coverage/
|
||||||
public/
|
public/
|
||||||
|
pages/
|
||||||
|
|
||||||
|
# installs
|
||||||
|
node_modules/
|
||||||
|
|
||||||
|
# caches
|
||||||
|
.yarn/
|
||||||
|
.cache/
|
||||||
|
.rpt2_cache
|
||||||
|
|
||||||
|
# builds
|
||||||
|
dist/
|
||||||
|
dist_*/
|
||||||
|
|
||||||
|
# custom
|
118
.gitlab-ci.yml
118
.gitlab-ci.yml
@ -1,38 +1,80 @@
|
|||||||
# gitzone standard
|
# gitzone ci_default
|
||||||
image: hosttoday/ht-docker-node:npmci
|
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
|
|
||||||
cache:
|
cache:
|
||||||
paths:
|
paths:
|
||||||
- .yarn/
|
- .npmci_cache/
|
||||||
key: "$CI_BUILD_STAGE"
|
key: '$CI_BUILD_STAGE'
|
||||||
|
|
||||||
stages:
|
stages:
|
||||||
- test
|
- security
|
||||||
- release
|
- test
|
||||||
- trigger
|
- release
|
||||||
- pages
|
- metadata
|
||||||
|
|
||||||
testLEGACY:
|
before_script:
|
||||||
stage: test
|
- npm install -g @shipzone/npmci
|
||||||
|
|
||||||
|
# ====================
|
||||||
|
# security stage
|
||||||
|
# ====================
|
||||||
|
mirror:
|
||||||
|
stage: security
|
||||||
script:
|
script:
|
||||||
- npmci test legacy
|
- npmci git mirror
|
||||||
coverage: /\d+.?\d+?\%\s*coverage/
|
only:
|
||||||
|
- tags
|
||||||
|
tags:
|
||||||
|
- lossless
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
|
auditProductionDependencies:
|
||||||
|
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
|
stage: security
|
||||||
|
script:
|
||||||
|
- npmci npm prepare
|
||||||
|
- npmci command npm install --production --ignore-scripts
|
||||||
|
- npmci command npm config set registry https://registry.npmjs.org
|
||||||
|
- npmci command npm audit --audit-level=high --only=prod --production
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- docker
|
||||||
allow_failure: true
|
allow_failure: true
|
||||||
|
|
||||||
testLTS:
|
auditDevDependencies:
|
||||||
|
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
|
stage: security
|
||||||
|
script:
|
||||||
|
- npmci npm prepare
|
||||||
|
- npmci command npm install --ignore-scripts
|
||||||
|
- npmci command npm config set registry https://registry.npmjs.org
|
||||||
|
- npmci command npm audit --audit-level=high --only=dev
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
allow_failure: true
|
||||||
|
|
||||||
|
# ====================
|
||||||
|
# test stage
|
||||||
|
# ====================
|
||||||
|
|
||||||
|
testStable:
|
||||||
stage: test
|
stage: test
|
||||||
script:
|
script:
|
||||||
- npmci test lts
|
- npmci npm prepare
|
||||||
|
- npmci node install stable
|
||||||
|
- npmci npm install
|
||||||
|
- npmci npm test
|
||||||
coverage: /\d+.?\d+?\%\s*coverage/
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- docker
|
||||||
|
|
||||||
testSTABLE:
|
testBuild:
|
||||||
stage: test
|
stage: test
|
||||||
script:
|
script:
|
||||||
- npmci test stable
|
- npmci npm prepare
|
||||||
|
- npmci node install stable
|
||||||
|
- npmci npm install
|
||||||
|
- npmci command npm run build
|
||||||
coverage: /\d+.?\d+?\%\s*coverage/
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- docker
|
||||||
@ -40,32 +82,60 @@ testSTABLE:
|
|||||||
release:
|
release:
|
||||||
stage: release
|
stage: release
|
||||||
script:
|
script:
|
||||||
- npmci publish
|
- npmci node install stable
|
||||||
|
- npmci npm publish
|
||||||
only:
|
only:
|
||||||
- tags
|
- tags
|
||||||
tags:
|
tags:
|
||||||
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
|
# ====================
|
||||||
|
# metadata stage
|
||||||
|
# ====================
|
||||||
|
codequality:
|
||||||
|
stage: metadata
|
||||||
|
allow_failure: true
|
||||||
|
only:
|
||||||
|
- tags
|
||||||
|
script:
|
||||||
|
- npmci command npm install -g tslint typescript
|
||||||
|
- npmci npm prepare
|
||||||
|
- npmci npm install
|
||||||
|
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
|
||||||
|
tags:
|
||||||
|
- lossless
|
||||||
|
- docker
|
||||||
|
- priv
|
||||||
|
|
||||||
trigger:
|
trigger:
|
||||||
stage: trigger
|
stage: metadata
|
||||||
script:
|
script:
|
||||||
- npmci trigger
|
- npmci trigger
|
||||||
only:
|
only:
|
||||||
- tags
|
- tags
|
||||||
tags:
|
tags:
|
||||||
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
pages:
|
pages:
|
||||||
image: hosttoday/ht-docker-node:npmci
|
stage: metadata
|
||||||
stage: pages
|
|
||||||
script:
|
script:
|
||||||
- npmci command yarn global add npmpage
|
- npmci node install lts
|
||||||
- npmci command npmpage --publish gitlab
|
- npmci command npm install -g @gitzone/tsdoc
|
||||||
|
- npmci npm prepare
|
||||||
|
- npmci npm install
|
||||||
|
- npmci command tsdoc
|
||||||
tags:
|
tags:
|
||||||
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
|
- notpriv
|
||||||
only:
|
only:
|
||||||
- tags
|
- tags
|
||||||
artifacts:
|
artifacts:
|
||||||
expire_in: 1 week
|
expire_in: 1 week
|
||||||
paths:
|
paths:
|
||||||
- public
|
- public
|
||||||
|
allow_failure: true
|
||||||
|
11
.vscode/launch.json
vendored
Normal file
11
.vscode/launch.json
vendored
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
{
|
||||||
|
"version": "0.2.0",
|
||||||
|
"configurations": [
|
||||||
|
{
|
||||||
|
"command": "npm test",
|
||||||
|
"name": "Run npm test",
|
||||||
|
"request": "launch",
|
||||||
|
"type": "node-terminal"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
26
.vscode/settings.json
vendored
Normal file
26
.vscode/settings.json
vendored
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
{
|
||||||
|
"json.schemas": [
|
||||||
|
{
|
||||||
|
"fileMatch": ["/npmextra.json"],
|
||||||
|
"schema": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"npmci": {
|
||||||
|
"type": "object",
|
||||||
|
"description": "settings for npmci"
|
||||||
|
},
|
||||||
|
"gitzone": {
|
||||||
|
"type": "object",
|
||||||
|
"description": "settings for gitzone",
|
||||||
|
"properties": {
|
||||||
|
"projectType": {
|
||||||
|
"type": "string",
|
||||||
|
"enum": ["website", "element", "service", "npm", "wcc"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
29
README.md
29
README.md
@ -1,29 +0,0 @@
|
|||||||
# smartbrowser
|
|
||||||
wraps browser-sync
|
|
||||||
|
|
||||||
## Availabililty
|
|
||||||
[](https://www.npmjs.com/package/smartbrowser)
|
|
||||||
[](https://GitLab.com/pushrocks/smartbrowser)
|
|
||||||
[](https://github.com/pushrocks/smartbrowser)
|
|
||||||
[](https://pushrocks.gitlab.io/smartbrowser/)
|
|
||||||
|
|
||||||
## Status for master
|
|
||||||
[](https://GitLab.com/pushrocks/smartbrowser/commits/master)
|
|
||||||
[](https://GitLab.com/pushrocks/smartbrowser/commits/master)
|
|
||||||
[](https://www.npmjs.com/package/smartbrowser)
|
|
||||||
[](https://david-dm.org/pushrocks/smartbrowser)
|
|
||||||
[](https://www.bithound.io/github/pushrocks/smartbrowser/master/dependencies/npm)
|
|
||||||
[](https://www.bithound.io/github/pushrocks/smartbrowser)
|
|
||||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
||||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
||||||
[](http://standardjs.com/)
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
Use TypeScript for best in class instellisense.
|
|
||||||
|
|
||||||
For further information read the linked docs at the top of this README.
|
|
||||||
|
|
||||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
|
||||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
|
||||||
|
|
||||||
[](https://push.rocks)
|
|
31
dist/index.d.ts
vendored
31
dist/index.d.ts
vendored
@ -1,31 +0,0 @@
|
|||||||
/// <reference types="browser-sync" />
|
|
||||||
import * as plugins from './smartbrowser.plugins';
|
|
||||||
/**
|
|
||||||
* the options interface of a Smartbrowser instance
|
|
||||||
*/
|
|
||||||
export interface ISmartbrowserOptions {
|
|
||||||
webroot: string;
|
|
||||||
watchFiles: string[];
|
|
||||||
}
|
|
||||||
/**
|
|
||||||
* Type of status that a bsInstance can have
|
|
||||||
*/
|
|
||||||
export declare type bsStatus = 'idle' | 'starting' | 'running';
|
|
||||||
/**
|
|
||||||
* class smartbrowser controls a browser-sync instance for you
|
|
||||||
*/
|
|
||||||
export declare class Smartbrowser {
|
|
||||||
bsInstance: plugins.browserSync.BrowserSyncInstance;
|
|
||||||
bsConfig: plugins.browserSync.Options;
|
|
||||||
bsStatus: bsStatus;
|
|
||||||
bsStarted: Promise<void>;
|
|
||||||
constructor(optionsArg: ISmartbrowserOptions);
|
|
||||||
/**
|
|
||||||
* starts the server and returns the browserSync instance in a resolved Promise
|
|
||||||
*/
|
|
||||||
start(): Promise<plugins.browserSync.BrowserSyncInstance>;
|
|
||||||
/**
|
|
||||||
* stops the smartbrowser instance
|
|
||||||
*/
|
|
||||||
stop(): Promise<void>;
|
|
||||||
}
|
|
49
dist/index.js
vendored
49
dist/index.js
vendored
@ -1,49 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
|
||||||
const plugins = require("./smartbrowser.plugins");
|
|
||||||
/**
|
|
||||||
* class smartbrowser controls a browser-sync instance for you
|
|
||||||
*/
|
|
||||||
class Smartbrowser {
|
|
||||||
constructor(optionsArg) {
|
|
||||||
this.bsInstance = plugins.browserSync.create();
|
|
||||||
this.bsConfig = {
|
|
||||||
server: {}
|
|
||||||
};
|
|
||||||
this.bsStatus = 'idle';
|
|
||||||
this.bsConfig.server.baseDir = optionsArg.webroot;
|
|
||||||
this.bsConfig.files = optionsArg.watchFiles;
|
|
||||||
}
|
|
||||||
/**
|
|
||||||
* starts the server and returns the browserSync instance in a resolved Promise
|
|
||||||
*/
|
|
||||||
start() {
|
|
||||||
let done = plugins.smartq.defer();
|
|
||||||
if (this.bsStatus === 'idle') {
|
|
||||||
this.bsStatus = 'starting';
|
|
||||||
let localDone = plugins.smartq.defer();
|
|
||||||
this.bsStarted = localDone.promise;
|
|
||||||
this.bsInstance.init(this.bsConfig, () => {
|
|
||||||
this.bsStatus = 'running';
|
|
||||||
localDone.resolve();
|
|
||||||
done.resolve(this.bsInstance);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
this.bsStarted.then(() => { done.resolve(this.bsInstance); });
|
|
||||||
}
|
|
||||||
return done.promise;
|
|
||||||
}
|
|
||||||
/**
|
|
||||||
* stops the smartbrowser instance
|
|
||||||
*/
|
|
||||||
stop() {
|
|
||||||
let done = plugins.smartq.defer();
|
|
||||||
this.bsInstance.exit();
|
|
||||||
this.bsStatus = 'idle';
|
|
||||||
done.resolve();
|
|
||||||
return done.promise;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
exports.Smartbrowser = Smartbrowser;
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFBLGtEQUFpRDtBQWdCakQ7O0dBRUc7QUFDSDtJQU9FLFlBQWEsVUFBZ0M7UUFON0MsZUFBVSxHQUFHLE9BQU8sQ0FBQyxXQUFXLENBQUMsTUFBTSxFQUFFLENBQUE7UUFDekMsYUFBUSxHQUFnQztZQUN0QyxNQUFNLEVBQUUsRUFBRTtTQUNYLENBQUE7UUFDRCxhQUFRLEdBQWEsTUFBTSxDQUFBO1FBR3pCLElBQUksQ0FBQyxRQUFRLENBQUMsTUFBTSxDQUFDLE9BQU8sR0FBRyxVQUFVLENBQUMsT0FBTyxDQUFBO1FBQ2pELElBQUksQ0FBQyxRQUFRLENBQUMsS0FBSyxHQUFHLFVBQVUsQ0FBQyxVQUFVLENBQUE7SUFDN0MsQ0FBQztJQUVEOztPQUVHO0lBQ0gsS0FBSztRQUNILElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUMsS0FBSyxFQUEyQyxDQUFBO1FBQzFFLEVBQUUsQ0FBQyxDQUFDLElBQUksQ0FBQyxRQUFRLEtBQUssTUFBTSxDQUFDLENBQUMsQ0FBQztZQUM3QixJQUFJLENBQUMsUUFBUSxHQUFHLFVBQVUsQ0FBQTtZQUMxQixJQUFJLFNBQVMsR0FBRyxPQUFPLENBQUMsTUFBTSxDQUFDLEtBQUssRUFBUSxDQUFBO1lBQzVDLElBQUksQ0FBQyxTQUFTLEdBQUcsU0FBUyxDQUFDLE9BQU8sQ0FBQTtZQUNsQyxJQUFJLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsUUFBUSxFQUFFO2dCQUNsQyxJQUFJLENBQUMsUUFBUSxHQUFHLFNBQVMsQ0FBQTtnQkFDekIsU0FBUyxDQUFDLE9BQU8sRUFBRSxDQUFBO2dCQUNuQixJQUFJLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxVQUFVLENBQUMsQ0FBQTtZQUMvQixDQUFDLENBQUMsQ0FBQTtRQUNKLENBQUM7UUFBQyxJQUFJLENBQUMsQ0FBQztZQUNOLElBQUksQ0FBQyxTQUFTLENBQUMsSUFBSSxDQUFDLFFBQVEsSUFBSSxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUFDLENBQUEsQ0FBQyxDQUFDLENBQUMsQ0FBQTtRQUM5RCxDQUFDO1FBQ0QsTUFBTSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUE7SUFDckIsQ0FBQztJQUVEOztPQUVHO0lBQ0gsSUFBSTtRQUNGLElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUMsS0FBSyxFQUFRLENBQUE7UUFDdkMsSUFBSSxDQUFDLFVBQVUsQ0FBQyxJQUFJLEVBQUUsQ0FBQTtRQUN0QixJQUFJLENBQUMsUUFBUSxHQUFHLE1BQU0sQ0FBQTtRQUN0QixJQUFJLENBQUMsT0FBTyxFQUFFLENBQUE7UUFDZCxNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQTtJQUNyQixDQUFDO0NBQ0Y7QUExQ0Qsb0NBMENDIn0=
|
|
3
dist/smartbrowser.plugins.d.ts
vendored
3
dist/smartbrowser.plugins.d.ts
vendored
@ -1,3 +0,0 @@
|
|||||||
import 'typings-global';
|
|
||||||
export import browserSync = require('browser-sync');
|
|
||||||
export import smartq = require('smartq');
|
|
6
dist/smartbrowser.plugins.js
vendored
6
dist/smartbrowser.plugins.js
vendored
@ -1,6 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
|
||||||
require("typings-global");
|
|
||||||
exports.browserSync = require("browser-sync");
|
|
||||||
exports.smartq = require("smartq");
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRicm93c2VyLnBsdWdpbnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydGJyb3dzZXIucGx1Z2lucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFBLDBCQUF1QjtBQUN2Qiw4Q0FBbUQ7QUFDbkQsbUNBQXdDIn0=
|
|
@ -1,7 +1,16 @@
|
|||||||
{
|
{
|
||||||
"npmci": {
|
"npmci": {
|
||||||
"globalNpmTools": [
|
"npmAccessLevel": "public"
|
||||||
"npmts"
|
},
|
||||||
]
|
"gitzone": {
|
||||||
|
"projectType": "npm",
|
||||||
|
"module": {
|
||||||
|
"githost": "gitlab.com",
|
||||||
|
"gitscope": "pushrocks",
|
||||||
|
"gitrepo": "smartbrowser",
|
||||||
|
"shortDescription": "puppeteer wrapper for easy tasks",
|
||||||
|
"npmPackagename": "@pushrocks/smartbrowser",
|
||||||
|
"license": "MIT"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
17972
package-lock.json
generated
Normal file
17972
package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
45
package.json
45
package.json
@ -1,11 +1,13 @@
|
|||||||
{
|
{
|
||||||
"name": "smartbrowser",
|
"name": "@pushrocks/smartbrowser",
|
||||||
"version": "1.0.4",
|
"version": "2.0.2",
|
||||||
"description": "wraps browser-sync",
|
"description": "simplified puppeteer",
|
||||||
"main": "dist/index.js",
|
"main": "dist_ts/index.js",
|
||||||
"typings": "dist/index.d.ts",
|
"typings": "dist_ts/index.d.ts",
|
||||||
|
"type": "module",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "(npmts)"
|
"test": "(tstest test/ --web)",
|
||||||
|
"build": "(tsbuild --web --allowimplicitany)"
|
||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
@ -18,13 +20,30 @@
|
|||||||
},
|
},
|
||||||
"homepage": "https://gitlab.com/pushrocks/smartbrowser#README",
|
"homepage": "https://gitlab.com/pushrocks/smartbrowser#README",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@types/browser-sync": "0.0.34",
|
"@pushrocks/smartdelay": "^2.0.13",
|
||||||
"browser-sync": "^2.18.8",
|
"@pushrocks/smartpdf": "^3.0.2",
|
||||||
"smartq": "^1.1.1",
|
"@pushrocks/smartpuppeteer": "^2.0.0",
|
||||||
"typings-global": "^1.0.14"
|
"@pushrocks/smartunique": "^3.0.3"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"smartdelay": "^1.0.1",
|
"@gitzone/tsbuild": "^2.1.61",
|
||||||
"tapbundle": "^1.0.5"
|
"@gitzone/tstest": "^1.0.69",
|
||||||
}
|
"@pushrocks/tapbundle": "^5.0.3"
|
||||||
|
},
|
||||||
|
"private": false,
|
||||||
|
"files": [
|
||||||
|
"ts/**/*",
|
||||||
|
"ts_web/**/*",
|
||||||
|
"dist/**/*",
|
||||||
|
"dist_*/**/*",
|
||||||
|
"dist_ts/**/*",
|
||||||
|
"dist_ts_web/**/*",
|
||||||
|
"assets/**/*",
|
||||||
|
"cli.js",
|
||||||
|
"npmextra.json",
|
||||||
|
"readme.md"
|
||||||
|
],
|
||||||
|
"browserslist": [
|
||||||
|
"last 1 chrome versions"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
|
39
readme.md
Normal file
39
readme.md
Normal file
@ -0,0 +1,39 @@
|
|||||||
|
# @pushrocks/smartbrowser
|
||||||
|
puppeteer wrapper for easy tasks
|
||||||
|
|
||||||
|
## Availabililty and Links
|
||||||
|
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartbrowser)
|
||||||
|
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartbrowser)
|
||||||
|
* [github.com (source mirror)](https://github.com/pushrocks/smartbrowser)
|
||||||
|
* [docs (typedoc)](https://pushrocks.gitlab.io/smartbrowser/)
|
||||||
|
|
||||||
|
## Status for master
|
||||||
|
|
||||||
|
Status Category | Status Badge
|
||||||
|
-- | --
|
||||||
|
GitLab Pipelines | [](https://lossless.cloud)
|
||||||
|
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||||
|
npm | [](https://lossless.cloud)
|
||||||
|
Snyk | [](https://lossless.cloud)
|
||||||
|
TypeScript Support | [](https://lossless.cloud)
|
||||||
|
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||||
|
Code Style | [](https://lossless.cloud)
|
||||||
|
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||||
|
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||||
|
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||||
|
Platform support | [](https://lossless.cloud) [](https://lossless.cloud)
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
Use TypeScript for best in class instellisense.
|
||||||
|
|
||||||
|
## Contribution
|
||||||
|
|
||||||
|
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
||||||
|
|
||||||
|
For further information read the linked docs at the top of this readme.
|
||||||
|
|
||||||
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||||
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||||||
|
|
||||||
|
[](https://maintainedby.lossless.com)
|
@ -1,6 +0,0 @@
|
|||||||
<head>
|
|
||||||
<title>Test</title>
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
Test
|
|
||||||
</body>
|
|
33
test/test.js
33
test/test.js
@ -1,33 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
require("typings-test");
|
|
||||||
const should = require("should");
|
|
||||||
const smartbrowser = require("../dist/index");
|
|
||||||
let testSmartBrowser;
|
|
||||||
describe('smartbrowser', () => {
|
|
||||||
it('should instanstiate a new browser ', function () {
|
|
||||||
testSmartBrowser = new smartbrowser.Smartbrowser({
|
|
||||||
webroot: './test/assets/',
|
|
||||||
watchFiles: ['./test/assets/']
|
|
||||||
});
|
|
||||||
should(testSmartBrowser).be.instanceof(smartbrowser.Smartbrowser);
|
|
||||||
});
|
|
||||||
it('should start the browser ', function (done) {
|
|
||||||
testSmartBrowser.start().then((bsInstance) => {
|
|
||||||
done();
|
|
||||||
}).catch((err) => { console.log(err); });
|
|
||||||
});
|
|
||||||
it('should stop the browser ', function (done) {
|
|
||||||
this.timeout(10000);
|
|
||||||
setTimeout(() => {
|
|
||||||
testSmartBrowser.stop().then(() => {
|
|
||||||
done();
|
|
||||||
}).catch((err) => { console.log(err); });
|
|
||||||
}, 2000);
|
|
||||||
});
|
|
||||||
it('should exit correctly', function () {
|
|
||||||
setTimeout(() => {
|
|
||||||
process.exit(0);
|
|
||||||
}, 2000);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLHdCQUFxQjtBQUNyQixpQ0FBZ0M7QUFFaEMsOENBQTZDO0FBRTdDLElBQUksZ0JBQTJDLENBQUE7QUFFL0MsUUFBUSxDQUFDLGNBQWMsRUFBRTtJQUNyQixFQUFFLENBQUMsb0NBQW9DLEVBQUU7UUFDckMsZ0JBQWdCLEdBQUcsSUFBSSxZQUFZLENBQUMsWUFBWSxDQUFDO1lBQzdDLE9BQU8sRUFBRSxnQkFBZ0I7WUFDekIsVUFBVSxFQUFFLENBQUMsZ0JBQWdCLENBQUM7U0FDakMsQ0FBQyxDQUFBO1FBQ0YsTUFBTSxDQUFDLGdCQUFnQixDQUFDLENBQUMsRUFBRSxDQUFDLFVBQVUsQ0FBQyxZQUFZLENBQUMsWUFBWSxDQUFDLENBQUE7SUFDckUsQ0FBQyxDQUFDLENBQUE7SUFDRixFQUFFLENBQUMsMkJBQTJCLEVBQUUsVUFBVSxJQUFJO1FBQzFDLGdCQUFnQixDQUFDLEtBQUssRUFBRSxDQUFDLElBQUksQ0FBQyxDQUFDLFVBQVU7WUFDckMsSUFBSSxFQUFFLENBQUE7UUFDVixDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUMsQ0FBQyxHQUFHLE9BQU8sT0FBTyxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMsQ0FBQSxDQUFDLENBQUMsQ0FBQyxDQUFBO0lBQzNDLENBQUMsQ0FBQyxDQUFBO0lBQ0YsRUFBRSxDQUFDLDBCQUEwQixFQUFFLFVBQVUsSUFBSTtRQUN6QyxJQUFJLENBQUMsT0FBTyxDQUFDLEtBQUssQ0FBQyxDQUFBO1FBQ25CLFVBQVUsQ0FBQztZQUNQLGdCQUFnQixDQUFDLElBQUksRUFBRSxDQUFDLElBQUksQ0FBQztnQkFDekIsSUFBSSxFQUFFLENBQUE7WUFDVixDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUMsQ0FBQyxHQUFHLE9BQU8sT0FBTyxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMsQ0FBQSxDQUFDLENBQUMsQ0FBQyxDQUFBO1FBQzNDLENBQUMsRUFBRSxJQUFJLENBQUMsQ0FBQTtJQUNaLENBQUMsQ0FBQyxDQUFBO0lBQ0YsRUFBRSxDQUFDLHVCQUF1QixFQUFDO1FBQ3ZCLFVBQVUsQ0FBQztZQUNQLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUE7UUFDbkIsQ0FBQyxFQUFDLElBQUksQ0FBQyxDQUFBO0lBQ1gsQ0FBQyxDQUFDLENBQUE7QUFDTixDQUFDLENBQUMsQ0FBQSJ9
|
|
51
test/test.ts
51
test/test.ts
@ -1,29 +1,36 @@
|
|||||||
import { tap, expect } from 'tapbundle'
|
import { tap, expect, expectAsync } from '@pushrocks/tapbundle';
|
||||||
import * as smartdelay from 'smartdelay'
|
|
||||||
|
|
||||||
import * as smartbrowser from '../dist/index'
|
|
||||||
let testSmartBrowser: smartbrowser.Smartbrowser
|
|
||||||
|
|
||||||
|
import * as smartbrowser from '../ts/index.js';
|
||||||
|
let testSmartBrowser: smartbrowser.SmartBrowser;
|
||||||
|
|
||||||
tap.test('should instanstiate a new browser ', async () => {
|
tap.test('should instanstiate a new browser ', async () => {
|
||||||
testSmartBrowser = new smartbrowser.Smartbrowser({
|
testSmartBrowser = new smartbrowser.SmartBrowser();
|
||||||
webroot: './test/assets/',
|
return expect(testSmartBrowser).toBeInstanceOf(smartbrowser.SmartBrowser);
|
||||||
watchFiles: [ './test/assets/' ]
|
});
|
||||||
})
|
|
||||||
return expect(testSmartBrowser).to.be.instanceof(smartbrowser.Smartbrowser)
|
|
||||||
}).catch(tap.threw)
|
|
||||||
|
|
||||||
tap.test('should start the browser ', async () => {
|
tap.test('should start the browser ', async () => {
|
||||||
return await expect(testSmartBrowser.start()).to.eventually.be.fulfilled
|
await testSmartBrowser.start();
|
||||||
}).catch(tap.threw)
|
});
|
||||||
|
|
||||||
|
tap.test('should create a PDF from a page', async (tools) => {
|
||||||
|
const result = await testSmartBrowser.pdfFromPage('https://lossless.com');
|
||||||
|
expect(result.buffer).toBeInstanceOf(Buffer);
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should produce a valid screenshot', async (tools) => {
|
||||||
|
const result = await testSmartBrowser.screenshotFromPage('https://lossless.com');
|
||||||
|
expect(result.buffer).toBeInstanceOf(Buffer);
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should evalute something in the browser', async () => {
|
||||||
|
const result = await testSmartBrowser.evaluateOnPage('https://lossless.com', async () => {
|
||||||
|
return window.location.toString();
|
||||||
|
});
|
||||||
|
console.log(result);
|
||||||
|
});
|
||||||
|
|
||||||
tap.test('should stop the browser ', async () => {
|
tap.test('should stop the browser ', async () => {
|
||||||
return await smartdelay.delayFor(2000).then(() => {
|
await testSmartBrowser.stop();
|
||||||
return expect(testSmartBrowser.stop()).to.eventually.be.fulfilled
|
});
|
||||||
})
|
|
||||||
})
|
tap.start();
|
||||||
tap.test('should exit correctly', async () => {
|
|
||||||
smartdelay.delayFor(2000).then(() => {
|
|
||||||
process.exit(0)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
107
ts/index.ts
107
ts/index.ts
@ -1,62 +1,73 @@
|
|||||||
import * as plugins from './smartbrowser.plugins'
|
import * as plugins from './smartbrowser.plugins.js';
|
||||||
|
|
||||||
|
import * as interfaces from './interfaces/index.js';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* the options interface of a Smartbrowser instance
|
* SmartBrowser
|
||||||
*/
|
*/
|
||||||
export interface ISmartbrowserOptions {
|
export class SmartBrowser {
|
||||||
webroot: string
|
public headlessBrowser: plugins.smartpuppeteer.puppeteer.Browser;
|
||||||
watchFiles: string[]
|
public smartpdf: plugins.smartpdf.SmartPdf;
|
||||||
|
|
||||||
}
|
/**
|
||||||
|
* start the SmartBrowser instance
|
||||||
/**
|
*/
|
||||||
* Type of status that a bsInstance can have
|
public async start() {
|
||||||
*/
|
this.headlessBrowser = await plugins.smartpuppeteer.getEnvAwareBrowserInstance();
|
||||||
export type bsStatus = 'idle' | 'starting' | 'running'
|
this.smartpdf = new plugins.smartpdf.SmartPdf();
|
||||||
|
await this.smartpdf.start(this.headlessBrowser);
|
||||||
/**
|
|
||||||
* class smartbrowser controls a browser-sync instance for you
|
|
||||||
*/
|
|
||||||
export class Smartbrowser {
|
|
||||||
bsInstance = plugins.browserSync.create()
|
|
||||||
bsConfig: plugins.browserSync.Options = {
|
|
||||||
server: {}
|
|
||||||
}
|
|
||||||
bsStatus: bsStatus = 'idle'
|
|
||||||
bsStarted: Promise<void>
|
|
||||||
constructor (optionsArg: ISmartbrowserOptions) {
|
|
||||||
this.bsConfig.server.baseDir = optionsArg.webroot
|
|
||||||
this.bsConfig.files = optionsArg.watchFiles
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* starts the server and returns the browserSync instance in a resolved Promise
|
* stop the SmartBrowser instance
|
||||||
*/
|
*/
|
||||||
start (): Promise<plugins.browserSync.BrowserSyncInstance> {
|
public async stop() {
|
||||||
let done = plugins.smartq.defer<plugins.browserSync.BrowserSyncInstance>()
|
await this.headlessBrowser.close();
|
||||||
if (this.bsStatus === 'idle') {
|
await this.smartpdf.stop();
|
||||||
this.bsStatus = 'starting'
|
|
||||||
let localDone = plugins.smartq.defer<void>()
|
|
||||||
this.bsStarted = localDone.promise
|
|
||||||
this.bsInstance.init(this.bsConfig, () => {
|
|
||||||
this.bsStatus = 'running'
|
|
||||||
localDone.resolve()
|
|
||||||
done.resolve(this.bsInstance)
|
|
||||||
})
|
|
||||||
} else {
|
|
||||||
this.bsStarted.then(() => { done.resolve(this.bsInstance) })
|
|
||||||
}
|
|
||||||
return done.promise
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* stops the smartbrowser instance
|
* create a pdf from page
|
||||||
|
* @param urlArg
|
||||||
*/
|
*/
|
||||||
stop (): Promise<void> {
|
public async pdfFromPage(urlArg: string) {
|
||||||
let done = plugins.smartq.defer<void>()
|
const result = await this.smartpdf.getFullWebsiteAsSinglePdf(urlArg);
|
||||||
this.bsInstance.exit()
|
return result;
|
||||||
this.bsStatus = 'idle'
|
}
|
||||||
done.resolve()
|
|
||||||
return done.promise
|
/**
|
||||||
|
* make a screenshot from a page
|
||||||
|
* @param urlArg
|
||||||
|
*/
|
||||||
|
public async screenshotFromPage(urlArg: string): Promise<interfaces.IScreenShotResult> {
|
||||||
|
const pageId = plugins.smartunique.shortId();
|
||||||
|
const page = await this.headlessBrowser.newPage();
|
||||||
|
await page.goto(urlArg, {
|
||||||
|
waitUntil: 'networkidle2',
|
||||||
|
});
|
||||||
|
const screenshotBuffer = await page.screenshot({
|
||||||
|
encoding: 'binary',
|
||||||
|
}) as Buffer;
|
||||||
|
await page.close();
|
||||||
|
return {
|
||||||
|
name: pageId,
|
||||||
|
id: `${pageId}.js`,
|
||||||
|
buffer: screenshotBuffer,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* evalutes an expression on a page
|
||||||
|
* @param urlArg
|
||||||
|
* @param funcArg
|
||||||
|
*/
|
||||||
|
public async evaluateOnPage<T>(urlArg: string, funcArg: () => Promise<T>) {
|
||||||
|
const page = await this.headlessBrowser.newPage();
|
||||||
|
await page.goto(urlArg, {
|
||||||
|
waitUntil: 'networkidle2',
|
||||||
|
});
|
||||||
|
const result = await page.evaluate(funcArg);
|
||||||
|
await page.close();
|
||||||
|
return result;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
1
ts/interfaces/index.ts
Normal file
1
ts/interfaces/index.ts
Normal file
@ -0,0 +1 @@
|
|||||||
|
export * from './interfaces.screenshotresult.js';
|
5
ts/interfaces/interfaces.screenshotresult.ts
Normal file
5
ts/interfaces/interfaces.screenshotresult.ts
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
export interface IScreenShotResult {
|
||||||
|
name: string;
|
||||||
|
id: string;
|
||||||
|
buffer: Buffer;
|
||||||
|
}
|
@ -1,3 +1,8 @@
|
|||||||
import 'typings-global'
|
// pushrocks scope
|
||||||
export import browserSync = require('browser-sync')
|
import * as smartpdf from '@pushrocks/smartpdf';
|
||||||
export import smartq = require('smartq')
|
import * as smartpuppeteer from '@pushrocks/smartpuppeteer';
|
||||||
|
import * as smartunique from '@pushrocks/smartunique';
|
||||||
|
|
||||||
|
export { smartpdf, smartpuppeteer, smartunique };
|
||||||
|
|
||||||
|
// third party
|
||||||
|
9
tsconfig.json
Normal file
9
tsconfig.json
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"experimentalDecorators": true,
|
||||||
|
"useDefineForClassFields": false,
|
||||||
|
"target": "ES2022",
|
||||||
|
"module": "ES2022",
|
||||||
|
"moduleResolution": "nodenext"
|
||||||
|
}
|
||||||
|
}
|
@ -1,3 +0,0 @@
|
|||||||
{
|
|
||||||
"extends": "tslint-config-standard"
|
|
||||||
}
|
|
Reference in New Issue
Block a user