@liquid-state/docviewer - npm Package Compare versions

Comparing version 0.0.7 to 0.1.0

dist/esm/definitions.d.ts

@@ -1,6 +0,1 @@
-declare module '@capacitor/core' {
-    interface PluginRegistry {
-        Docviewer: DocviewerPlugin;
-    }
-}
 export interface DocviewerPlugin {
@@ -7,0 +2,0 @@ echo(options: {

dist/esm/definitions.js

@@ -0,1 +1,2 @@
+export {};
 //# sourceMappingURL=definitions.js.map

dist/esm/index.d.ts

@@ -0,2 +1,4 @@
+import type { DocviewerPlugin } from './definitions';
+declare const Docviewer: DocviewerPlugin;
 export * from './definitions';
-export * from './web';
+export { Docviewer };

dist/esm/index.js

@@ -1,2 +0,7 @@
-export * from './web';
+import { registerPlugin } from '@capacitor/core';
+const Docviewer = registerPlugin('Docviewer', {
+    web: () => import('./web').then(m => new m.DocviewerWeb()),
+});
+export * from './definitions';
+export { Docviewer };
 //# sourceMappingURL=index.js.map

dist/esm/web.d.ts

 import { WebPlugin } from '@capacitor/core';
-import { DocviewerPlugin } from './definitions';
+import type { DocviewerPlugin } from './definitions';
 export declare class DocviewerWeb extends WebPlugin implements DocviewerPlugin {
-    constructor();
     echo(options: {
@@ -25,3 +24,1 @@ value: string;
 }
-declare const Docviewer: DocviewerWeb;
-export { Docviewer };

dist/esm/web.js

@@ -1,41 +0,16 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 import { WebPlugin } from '@capacitor/core';
 export class DocviewerWeb extends WebPlugin {
-    constructor() {
-        super({
-            name: 'Docviewer',
-            platforms: ['web'],
-        });
+    async echo(options) {
+        console.log('ECHO', options);
+        return options;
     }
-    echo(options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            console.log('ECHO', options);
-            return options;
-        });
+    async launchNamedDocument(options) {
+        console.log('launchDocument', options);
+        return { viewer_id: "-1" };
     }
-    launchNamedDocument(options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            console.log('launchDocument', options);
-            return { viewer_id: "-1" };
-        });
+    async launchDocument(options) {
+        console.log('launchDocument', options);
+        return { viewer_id: "-1" };
     }
-    launchDocument(options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            console.log('launchDocument', options);
-            return { viewer_id: "-1" };
-        });
-    }
 }
-const Docviewer = new DocviewerWeb();
-export { Docviewer };
-import { registerWebPlugin } from '@capacitor/core';
-registerWebPlugin(Docviewer);
 //# sourceMappingURL=web.js.map

dist/plugin.js

@@ -1,44 +0,29 @@
-var capacitorPlugin = (function (exports, core) {
+var capacitorDocviewer = (function (exports, core) {
     'use strict';
 
-    var __awaiter = (undefined && undefined.__awaiter) || function (thisArg, _arguments, P, generator) {
-        function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-        return new (P || (P = Promise))(function (resolve, reject) {
-            function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-            function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-            function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-            step((generator = generator.apply(thisArg, _arguments || [])).next());
-        });
-    };
+    const Docviewer = core.registerPlugin('Docviewer', {
+        web: () => Promise.resolve().then(function () { return web; }).then(m => new m.DocviewerWeb()),
+    });
+
     class DocviewerWeb extends core.WebPlugin {
-        constructor() {
-            super({
-                name: 'Docviewer',
-                platforms: ['web'],
-            });
+        async echo(options) {
+            console.log('ECHO', options);
+            return options;
         }
-        echo(options) {
-            return __awaiter(this, void 0, void 0, function* () {
-                console.log('ECHO', options);
-                return options;
-            });
+        async launchNamedDocument(options) {
+            console.log('launchDocument', options);
+            return { viewer_id: "-1" };
         }
-        launchNamedDocument(options) {
-            return __awaiter(this, void 0, void 0, function* () {
-                console.log('launchDocument', options);
-                return { viewer_id: "-1" };
-            });
+        async launchDocument(options) {
+            console.log('launchDocument', options);
+            return { viewer_id: "-1" };
         }
-        launchDocument(options) {
-            return __awaiter(this, void 0, void 0, function* () {
-                console.log('launchDocument', options);
-                return { viewer_id: "-1" };
-            });
-        }
     }
-    const Docviewer = new DocviewerWeb();
-    core.registerWebPlugin(Docviewer);
 
+    var web = /*#__PURE__*/Object.freeze({
+        __proto__: null,
+        DocviewerWeb: DocviewerWeb
+    });
+
     exports.Docviewer = Docviewer;
-    exports.DocviewerWeb = DocviewerWeb;
 
@@ -45,0 +30,0 @@ Object.defineProperty(exports, '__esModule', { value: true });

package.json

 {
   "name": "@liquid-state/docviewer",
-  "version": "0.0.7",
+  "version": "0.1.0",
   "description": "Plugin to launch and run the Liquid State Document Viewer",
@@ -8,7 +8,15 @@ "main": "dist/plugin.js",
   "types": "dist/esm/index.d.ts",
+  "unpkg": "dist/plugin.js",
   "scripts": {
-    "lint": "npm run prettier -- --check && npm run swiftlint -- lint",
+    "verify": "npm run verify:ios && npm run verify:android && npm run verify:web",
+    "verify:ios": "cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin && cd ..",
+    "verify:android": "cd android && ./gradlew clean build test && cd ..",
+    "verify:web": "npm run build",
+    "lint": "npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint",
+    "fmt": "npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- autocorrect --format",
+    "eslint": "eslint . --ext ts",
     "prettier": "prettier \"**/*.{css,html,ts,js,java}\"",
     "swiftlint": "node-swiftlint",
-    "build": "npm run clean && tsc && rollup -c rollup.config.js",
+    "docgen": "docgen --api DocviewerPlugin --output-readme README.md --output-json dist/docs.json",
+    "build": "npm run clean && npm run docgen && tsc && rollup -c rollup.config.js",
     "clean": "rimraf ./dist",
@@ -21,22 +29,25 @@ "watch": "tsc --watch",
   "devDependencies": {
-    "@capacitor/android": "^2.4.6",
-    "@capacitor/core": "^2.4.6",
-    "@capacitor/ios": "^2.4.6",
-    "@ionic/prettier-config": "^1.0.0",
-    "@ionic/swiftlint-config": "^1.0.0",
-    "@rollup/plugin-node-resolve": "^8.1.0",
-    "prettier": "^2.0.5",
-    "prettier-plugin-java": "^0.8.0",
-    "rimraf": "^3.0.0",
-    "rollup": "^2.21.0",
+    "@capacitor/android": "^3.0.0",
+    "@capacitor/core": "^3.0.0",
+    "@capacitor/docgen": "^0.0.10",
+    "@capacitor/ios": "^3.0.0",
+    "@ionic/eslint-config": "^0.3.0",
+    "@ionic/prettier-config": "^1.0.1",
+    "@ionic/swiftlint-config": "^1.1.2",
+    "eslint": "^7.11.0",
+    "prettier": "~2.2.0",
+    "prettier-plugin-java": "~1.0.0",
+    "rimraf": "^3.0.2",
+    "rollup": "^2.32.0",
     "swiftlint": "^1.0.1",
-    "typescript": "~3.8.3"
+    "typescript": "~4.0.3"
   },
   "peerDependencies": {
-    "@capacitor/core": "^2.4.6"
+    "@capacitor/core": "^3.0.0"
   },
   "files": [
     "dist/",
-    "ios/",
-    "android/",
+    "ios/Plugin/",
+    "android/src/main/",
+    "android/build.gradle",
     "LiquidStateDocviewer.podspec"
@@ -61,3 +72,8 @@ ],
   "bugs": {},
-  "dependencies": {}
+  "eslintConfig": {
+    "extends": "@ionic/eslint-config/recommended"
+  },
+  "dependencies": {
+    "@capacitor/cli": "^3.0.0"
+  }
 }

README.md

@@ -1,3 +0,69 @@
-**How to use this plugin**
+# @liquid-state/docviewer
 
-See repo 
+Liquid State Docviewer Plugin
+
+## Install
+
+```bash
+npm install @liquid-state/docviewer
+npx cap sync
+```
+
+## API
+
+<docgen-index>
+
+* [`echo(...)`](#echo)
+* [`launchNamedDocument(...)`](#launchnameddocument)
+* [`launchDocument(...)`](#launchdocument)
+
+</docgen-index>
+
+<docgen-api>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+
+### echo(...)
+
+```typescript
+echo(options: { value: string; }) => any
+```
+
+| Param         | Type                            |
+| ------------- | ------------------------------- |
+| **`options`** | <code>{ value: string; }</code> |
+
+**Returns:** <code>any</code>
+
+--------------------
+
+
+### launchNamedDocument(...)
+
+```typescript
+launchNamedDocument(options: { name: string; page_slug?: string; config?: {}; }) => any
+```
+
+| Param         | Type                                                            |
+| ------------- | --------------------------------------------------------------- |
+| **`options`** | <code>{ name: string; page_slug?: string; config?: {}; }</code> |
+
+**Returns:** <code>any</code>
+
+--------------------
+
+
+### launchDocument(...)
+
+```typescript
+launchDocument(options: { url: string; page_slug?: string; config?: {}; }) => any
+```
+
+| Param         | Type                                                           |
+| ------------- | -------------------------------------------------------------- |
+| **`options`** | <code>{ url: string; page_slug?: string; config?: {}; }</code> |
+
+**Returns:** <code>any</code>
+
+--------------------
+
+</docgen-api>

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

62963

increased by0.31%

Lines of code

184

increased by5.14%

Number of lines in readme file

70

increased by1650%

Worsened metrics

Dependency count

2

increased by100%

Dev dependency count

14

increased by16.67%

Number of package files

25

decreased by-16.67%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Added@capacitor/cli@^3.0.0

• + Added@capacitor/cli@3.9.0(transitive)

• + Added@capacitor/core@3.9.0(transitive)

• + Added@ionic/cli-framework-output@2.2.8(transitive)

• + Added@ionic/utils-array@2.1.6(transitive)

• + Added@ionic/utils-fs@3.1.7(transitive)

• + Added@ionic/utils-object@2.1.6(transitive)

• + Added@ionic/utils-process@2.1.11(transitive)

• + Added@ionic/utils-stream@3.1.6(transitive)

• + Added@ionic/utils-subprocess@2.1.14(transitive)

• + Added@ionic/utils-terminal@2.3.42.3.5(transitive)

• + Added@types/fs-extra@8.1.5(transitive)

• + Added@types/node@22.13.1(transitive)

• + Added@types/slice-ansi@4.0.0(transitive)

• + Added@xmldom/xmldom@0.8.10(transitive)

• + Addedansi-regex@5.0.1(transitive)

• + Addedansi-styles@4.3.0(transitive)

• + Addedastral-regex@2.0.0(transitive)

• + Addedat-least-node@1.0.0(transitive)

• + Addedbase64-js@1.5.1(transitive)

• + Addedbig-integer@1.6.52(transitive)

• + Addedbplist-parser@0.3.2(transitive)

• + Addedbuffer-crc32@0.2.13(transitive)

• + Addedchownr@2.0.0(transitive)

• + Addedcolor-convert@2.0.1(transitive)

• + Addedcolor-name@1.1.4(transitive)

• + Addedcommander@6.2.1(transitive)

• + Addedcross-spawn@7.0.6(transitive)

• + Addeddebug@4.4.0(transitive)

• + Addedelementtree@0.1.7(transitive)

• + Addedemoji-regex@8.0.0(transitive)

• + Addedenv-paths@2.2.1(transitive)

• + Addedfd-slicer@1.1.0(transitive)

• + Addedfs-extra@9.1.0(transitive)

• + Addedfs-minipass@2.1.0(transitive)

• + Addedgraceful-fs@4.2.11(transitive)

• + Addedinherits@2.0.4(transitive)

• + Addedini@3.0.1(transitive)

• + Addedis-docker@2.2.1(transitive)

• + Addedis-fullwidth-code-point@3.0.0(transitive)

• + Addedis-wsl@2.2.0(transitive)

• + Addedisexe@2.0.0(transitive)

• + Addedjsonfile@6.1.0(transitive)

• + Addedkleur@3.0.34.1.5(transitive)

• + Addedminipass@3.3.65.0.0(transitive)

• + Addedminizlib@2.1.2(transitive)

• + Addedmkdirp@1.0.4(transitive)

• + Addedms@2.1.3(transitive)

• + Addednative-run@1.7.4(transitive)

• + Addedopen@7.4.2(transitive)

• + Addedpath-key@3.1.1(transitive)

• + Addedpend@1.2.0(transitive)

• + Addedplist@3.1.0(transitive)

• + Addedprompts@2.4.2(transitive)

• + Addedreadable-stream@3.6.2(transitive)

• + Addedsafe-buffer@5.2.1(transitive)

• + Addedsax@1.1.4(transitive)

• + Addedsemver@7.7.1(transitive)

• + Addedshebang-command@2.0.0(transitive)

• + Addedshebang-regex@3.0.0(transitive)

• + Addedsignal-exit@3.0.7(transitive)

• + Addedsisteransi@1.0.5(transitive)

• + Addedslice-ansi@4.0.0(transitive)

• + Addedsplit2@4.2.0(transitive)

• + Addedstring-width@4.2.3(transitive)

• + Addedstring_decoder@1.3.0(transitive)

• + Addedstrip-ansi@6.0.1(transitive)

• + Addedtar@6.2.1(transitive)

• + Addedthrough2@4.0.2(transitive)

• + Addedtree-kill@1.2.2(transitive)

• + Addedtslib@2.8.1(transitive)

• + Addedundici-types@6.20.0(transitive)

• + Addeduniversalify@2.0.1(transitive)

• + Addeduntildify@4.0.0(transitive)

• + Addedutil-deprecate@1.0.2(transitive)

• + Addedwhich@2.0.2(transitive)

• + Addedwrap-ansi@7.0.0(transitive)

• + Addedxml2js@0.4.23(transitive)

• + Addedxmlbuilder@11.0.115.1.1(transitive)

• + Addedyallist@4.0.0(transitive)

• + Addedyauzl@2.10.0(transitive)

• - Removed@capacitor/core@2.5.0(transitive)

• - Removedtslib@1.14.1(transitive)